Back to Collection Items
' This example assumes the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.
Dim http As New ChilkatHttp
Dim success As Long
Dim queryParams As New ChilkatJsonObject
success = queryParams.UpdateString("fields","<string>")
success = queryParams.UpdateString("fieldset","basic")
success = queryParams.UpdateInt("page",1)
success = queryParams.UpdateInt("per_page",5)
success = queryParams.UpdateString("sort","<string>")
success = queryParams.UpdateString("q","<string>")
' Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = "<access_token>"
http.SetRequestHeader "Accept","application/json"
Dim resp As ChilkatHttpResponse
Set resp = http.QuickRequestParams("GET","https://api-v2.fattureincloud.it/c/:company_id/receipts",queryParams)
If (http.LastMethodSuccess = 0) Then
Debug.Print http.LastErrorText
Exit Sub
End If
Dim sbResponseBody As New ChilkatStringBuilder
success = resp.GetBodySb(sbResponseBody)
Dim jResp As New ChilkatJsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = 0
Debug.Print "Response Body:"
Debug.Print jResp.Emit()
Dim respStatusCode As Long
respStatusCode = resp.StatusCode
Debug.Print "Response Status Code = " & respStatusCode
If (respStatusCode >= 400) Then
Debug.Print "Response Header:"
Debug.Print resp.Header
Debug.Print "Failed."
Exit Sub
End If
' Sample JSON response:
' (Sample code for parsing the JSON response is shown below)
' {
' "current_page": "<integer>",
' "first_page_url": "<uri>",
' "from": "<integer>",
' "last_page": "<integer>",
' "last_page_url": "<uri>",
' "next_page_url": "<uri>",
' "path": "<uri>",
' "per_page": "<integer>",
' "prev_page_url": "<uri>",
' "to": "<integer>",
' "total": "<integer>",
' "data": [
' {
' "id": "<integer>",
' "date": "<date>",
' "number": "<number>",
' "numeration": "<string>",
' "amount_net": "<number>",
' "amount_vat": "<number>",
' "amount_gross": "<number>",
' "use_gross_prices": "<boolean>",
' "type": "till_receipt",
' "description": "<string>",
' "rc_center": "<string>",
' "created_at": "<string>",
' "updated_at": "<string>",
' "payment_account": {
' "id": "<integer>",
' "name": "<string>",
' "type": "standard",
' "iban": "<string>",
' "sia": "<string>",
' "cuc": "<string>",
' "virtual": "<boolean>"
' },
' "items_list": [
' {
' "id": "<integer>",
' "amount_net": "<number>",
' "amount_gross": "<number>",
' "category": "<string>",
' "vat": {
' "id": "<integer>",
' "value": "<number>",
' "description": "<string>",
' "notes": "<string>",
' "e_invoice": "<boolean>",
' "ei_type": "<string>",
' "ei_description": "<string>",
' "editable": "<boolean>",
' "is_disabled": "<boolean>"
' }
' },
' {
' "id": "<integer>",
' "amount_net": "<number>",
' "amount_gross": "<number>",
' "category": "<string>",
' "vat": {
' "id": "<integer>",
' "value": "<number>",
' "description": "<string>",
' "notes": "<string>",
' "e_invoice": "<boolean>",
' "ei_type": "<string>",
' "ei_description": "<string>",
' "editable": "<boolean>",
' "is_disabled": "<boolean>"
' }
' }
' ]
' },
' {
' "id": "<integer>",
' "date": "<date>",
' "number": "<number>",
' "numeration": "<string>",
' "amount_net": "<number>",
' "amount_vat": "<number>",
' "amount_gross": "<number>",
' "use_gross_prices": "<boolean>",
' "type": "sales_receipt",
' "description": "<string>",
' "rc_center": "<string>",
' "created_at": "<string>",
' "updated_at": "<string>",
' "payment_account": {
' "id": "<integer>",
' "name": "<string>",
' "type": "standard",
' "iban": "<string>",
' "sia": "<string>",
' "cuc": "<string>",
' "virtual": "<boolean>"
' },
' "items_list": [
' {
' "id": "<integer>",
' "amount_net": "<number>",
' "amount_gross": "<number>",
' "category": "<string>",
' "vat": {
' "id": "<integer>",
' "value": "<number>",
' "description": "<string>",
' "notes": "<string>",
' "e_invoice": "<boolean>",
' "ei_type": "<string>",
' "ei_description": "<string>",
' "editable": "<boolean>",
' "is_disabled": "<boolean>"
' }
' },
' {
' "id": "<integer>",
' "amount_net": "<number>",
' "amount_gross": "<number>",
' "category": "<string>",
' "vat": {
' "id": "<integer>",
' "value": "<number>",
' "description": "<string>",
' "notes": "<string>",
' "e_invoice": "<boolean>",
' "ei_type": "<string>",
' "ei_description": "<string>",
' "editable": "<boolean>",
' "is_disabled": "<boolean>"
' }
' }
' ]
' }
' ]
' }
' Sample code for parsing the JSON response...
' Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Dim id As String
Dim date As String
Dim v_number As String
Dim numeration As String
Dim amount_net As String
Dim amount_vat As String
Dim amount_gross As String
Dim use_gross_prices As String
Dim v_type As String
Dim description As String
Dim rc_center As String
Dim created_at As String
Dim updated_at As String
Dim Id As String
Dim Name As String
Dim v_Type As String
Dim Iban As String
Dim Sia As String
Dim Cuc As String
Dim v_Virtual As String
Dim j As Long
Dim count_j As Long
Dim category As String
Dim vatId As String
Dim Value As String
Dim Description As String
Dim Notes As String
Dim E_invoice As String
Dim Ei_type As String
Dim Ei_description As String
Dim Editable As String
Dim Is_disabled As String
Dim current_page As String
current_page = jResp.StringOf("current_page")
Dim first_page_url As String
first_page_url = jResp.StringOf("first_page_url")
Dim from As String
from = jResp.StringOf("from")
Dim last_page As String
last_page = jResp.StringOf("last_page")
Dim last_page_url As String
last_page_url = jResp.StringOf("last_page_url")
Dim next_page_url As String
next_page_url = jResp.StringOf("next_page_url")
Dim path As String
path = jResp.StringOf("path")
Dim per_page As String
per_page = jResp.StringOf("per_page")
Dim prev_page_url As String
prev_page_url = jResp.StringOf("prev_page_url")
Dim v_to As String
v_to = jResp.StringOf("to")
Dim total As String
total = jResp.StringOf("total")
Dim i As Long
i = 0
Dim count_i As Long
count_i = jResp.SizeOfArray("data")
Do While i < count_i
jResp.I = i
id = jResp.StringOf("data[i].id")
date = jResp.StringOf("data[i].date")
v_number = jResp.StringOf("data[i].number")
numeration = jResp.StringOf("data[i].numeration")
amount_net = jResp.StringOf("data[i].amount_net")
amount_vat = jResp.StringOf("data[i].amount_vat")
amount_gross = jResp.StringOf("data[i].amount_gross")
use_gross_prices = jResp.StringOf("data[i].use_gross_prices")
v_type = jResp.StringOf("data[i].type")
description = jResp.StringOf("data[i].description")
rc_center = jResp.StringOf("data[i].rc_center")
created_at = jResp.StringOf("data[i].created_at")
updated_at = jResp.StringOf("data[i].updated_at")
Id = jResp.StringOf("data[i].payment_account.id")
Name = jResp.StringOf("data[i].payment_account.name")
v_Type = jResp.StringOf("data[i].payment_account.type")
Iban = jResp.StringOf("data[i].payment_account.iban")
Sia = jResp.StringOf("data[i].payment_account.sia")
Cuc = jResp.StringOf("data[i].payment_account.cuc")
v_Virtual = jResp.StringOf("data[i].payment_account.virtual")
j = 0
count_j = jResp.SizeOfArray("data[i].items_list")
Do While j < count_j
jResp.J = j
id = jResp.StringOf("data[i].items_list[j].id")
amount_net = jResp.StringOf("data[i].items_list[j].amount_net")
amount_gross = jResp.StringOf("data[i].items_list[j].amount_gross")
category = jResp.StringOf("data[i].items_list[j].category")
vatId = jResp.StringOf("data[i].items_list[j].vat.id")
Value = jResp.StringOf("data[i].items_list[j].vat.value")
Description = jResp.StringOf("data[i].items_list[j].vat.description")
Notes = jResp.StringOf("data[i].items_list[j].vat.notes")
E_invoice = jResp.StringOf("data[i].items_list[j].vat.e_invoice")
Ei_type = jResp.StringOf("data[i].items_list[j].vat.ei_type")
Ei_description = jResp.StringOf("data[i].items_list[j].vat.ei_description")
Editable = jResp.StringOf("data[i].items_list[j].vat.editable")
Is_disabled = jResp.StringOf("data[i].items_list[j].vat.is_disabled")
j = j + 1
Loop
i = i + 1
Loop
Curl Command
curl -G -d "fields=%3Cstring%3E"
-d "fieldset=basic"
-d "page=1"
-d "per_page=5"
-d "sort=%3Cstring%3E"
-d "q=%3Cstring%3E"
-H "Authorization: Bearer <access_token>"
-H "Accept: application/json"
https://api-v2.fattureincloud.it/c/:company_id/receipts
Postman Collection Item JSON
{
"name": "List Receipts",
"request": {
"auth": {
"type": "oauth2",
"oauth2": [
{
"key": "scope",
"value": "entity.clients:r entity.clients:a entity.suppliers:r entity.suppliers:a products:r products:a issued_documents.invoices:r issued_documents.credit_notes:r issued_documents.receipts:r issued_documents.orders:r issued_documents.quotes:r issued_documents.proformas:r issued_documents.delivery_notes:r issued_documents.work_reports:r issued_documents.supplier_orders:r issued_documents.self_invoices:r issued_documents.invoices:a issued_documents.credit_notes:a issued_documents.receipts:a issued_documents.orders:a issued_documents.quotes:a issued_documents.proformas:a issued_documents.delivery_notes:a issued_documents.work_reports:a issued_documents.supplier_orders:a issued_documents.self_invoices:a received_documents:r received_documents:a stock:r stock:a receipts:r receipts:a taxes:r taxes:a archive:r archive:a cashbook:r cashbook:a settings:r settings:a situation:r",
"type": "string"
},
{
"key": "redirect_uri",
"value": "https://api-v2.fattureincloud.it/oauth/token",
"type": "string"
},
{
"key": "accessTokenUrl",
"value": "https://api-v2.fattureincloud.it/oauth/token",
"type": "string"
},
{
"key": "authUrl",
"value": "https://api-v2.fattureincloud.it/oauth/authorize",
"type": "string"
},
{
"key": "grant_type",
"value": "authorization_code",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/c/:company_id/receipts?fields=<string>&fieldset=basic&page=1&per_page=5&sort=<string>&q=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"c",
":company_id",
"receipts"
],
"query": [
{
"key": "fields",
"value": "<string>",
"description": "List of comma-separated fields."
},
{
"key": "fieldset",
"value": "basic",
"description": "Name of the fieldset."
},
{
"key": "page",
"value": "1",
"description": "The page to retrieve."
},
{
"key": "per_page",
"value": "5",
"description": "The size of the page."
},
{
"key": "sort",
"value": "<string>",
"description": "List of comma-separated fields for result sorting (minus for desc sorting)."
},
{
"key": "q",
"value": "<string>",
"description": "Query for filtering the results."
}
],
"variable": [
{
"key": "company_id",
"value": "<integer>"
}
]
},
"description": "Lists the receipts."
},
"response": [
{
"name": "Receipts list.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/c/:company_id/receipts?fields=<string>&fieldset=basic&page=1&per_page=5&sort=<string>&q=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"c",
":company_id",
"receipts"
],
"query": [
{
"key": "fields",
"value": "<string>",
"description": "List of comma-separated fields."
},
{
"key": "fieldset",
"value": "basic",
"description": "Name of the fieldset."
},
{
"key": "page",
"value": "1",
"description": "The page to retrieve."
},
{
"key": "per_page",
"value": "5",
"description": "The size of the page."
},
{
"key": "sort",
"value": "<string>",
"description": "List of comma-separated fields for result sorting (minus for desc sorting)."
},
{
"key": "q",
"value": "<string>",
"description": "Query for filtering the results."
}
],
"variable": [
{
"key": "company_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"current_page\": \"<integer>\",\n \"first_page_url\": \"<uri>\",\n \"from\": \"<integer>\",\n \"last_page\": \"<integer>\",\n \"last_page_url\": \"<uri>\",\n \"next_page_url\": \"<uri>\",\n \"path\": \"<uri>\",\n \"per_page\": \"<integer>\",\n \"prev_page_url\": \"<uri>\",\n \"to\": \"<integer>\",\n \"total\": \"<integer>\",\n \"data\": [\n {\n \"id\": \"<integer>\",\n \"date\": \"<date>\",\n \"number\": \"<number>\",\n \"numeration\": \"<string>\",\n \"amount_net\": \"<number>\",\n \"amount_vat\": \"<number>\",\n \"amount_gross\": \"<number>\",\n \"use_gross_prices\": \"<boolean>\",\n \"type\": \"till_receipt\",\n \"description\": \"<string>\",\n \"rc_center\": \"<string>\",\n \"created_at\": \"<string>\",\n \"updated_at\": \"<string>\",\n \"payment_account\": {\n \"id\": \"<integer>\",\n \"name\": \"<string>\",\n \"type\": \"standard\",\n \"iban\": \"<string>\",\n \"sia\": \"<string>\",\n \"cuc\": \"<string>\",\n \"virtual\": \"<boolean>\"\n },\n \"items_list\": [\n {\n \"id\": \"<integer>\",\n \"amount_net\": \"<number>\",\n \"amount_gross\": \"<number>\",\n \"category\": \"<string>\",\n \"vat\": {\n \"id\": \"<integer>\",\n \"value\": \"<number>\",\n \"description\": \"<string>\",\n \"notes\": \"<string>\",\n \"e_invoice\": \"<boolean>\",\n \"ei_type\": \"<string>\",\n \"ei_description\": \"<string>\",\n \"editable\": \"<boolean>\",\n \"is_disabled\": \"<boolean>\"\n }\n },\n {\n \"id\": \"<integer>\",\n \"amount_net\": \"<number>\",\n \"amount_gross\": \"<number>\",\n \"category\": \"<string>\",\n \"vat\": {\n \"id\": \"<integer>\",\n \"value\": \"<number>\",\n \"description\": \"<string>\",\n \"notes\": \"<string>\",\n \"e_invoice\": \"<boolean>\",\n \"ei_type\": \"<string>\",\n \"ei_description\": \"<string>\",\n \"editable\": \"<boolean>\",\n \"is_disabled\": \"<boolean>\"\n }\n }\n ]\n },\n {\n \"id\": \"<integer>\",\n \"date\": \"<date>\",\n \"number\": \"<number>\",\n \"numeration\": \"<string>\",\n \"amount_net\": \"<number>\",\n \"amount_vat\": \"<number>\",\n \"amount_gross\": \"<number>\",\n \"use_gross_prices\": \"<boolean>\",\n \"type\": \"sales_receipt\",\n \"description\": \"<string>\",\n \"rc_center\": \"<string>\",\n \"created_at\": \"<string>\",\n \"updated_at\": \"<string>\",\n \"payment_account\": {\n \"id\": \"<integer>\",\n \"name\": \"<string>\",\n \"type\": \"standard\",\n \"iban\": \"<string>\",\n \"sia\": \"<string>\",\n \"cuc\": \"<string>\",\n \"virtual\": \"<boolean>\"\n },\n \"items_list\": [\n {\n \"id\": \"<integer>\",\n \"amount_net\": \"<number>\",\n \"amount_gross\": \"<number>\",\n \"category\": \"<string>\",\n \"vat\": {\n \"id\": \"<integer>\",\n \"value\": \"<number>\",\n \"description\": \"<string>\",\n \"notes\": \"<string>\",\n \"e_invoice\": \"<boolean>\",\n \"ei_type\": \"<string>\",\n \"ei_description\": \"<string>\",\n \"editable\": \"<boolean>\",\n \"is_disabled\": \"<boolean>\"\n }\n },\n {\n \"id\": \"<integer>\",\n \"amount_net\": \"<number>\",\n \"amount_gross\": \"<number>\",\n \"category\": \"<string>\",\n \"vat\": {\n \"id\": \"<integer>\",\n \"value\": \"<number>\",\n \"description\": \"<string>\",\n \"notes\": \"<string>\",\n \"e_invoice\": \"<boolean>\",\n \"ei_type\": \"<string>\",\n \"ei_description\": \"<string>\",\n \"editable\": \"<boolean>\",\n \"is_disabled\": \"<boolean>\"\n }\n }\n ]\n }\n ]\n}"
},
{
"name": "Unauthorized",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/c/:company_id/receipts?fields=<string>&fieldset=basic&page=1&per_page=5&sort=<string>&q=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"c",
":company_id",
"receipts"
],
"query": [
{
"key": "fields",
"value": "<string>",
"description": "List of comma-separated fields."
},
{
"key": "fieldset",
"value": "basic",
"description": "Name of the fieldset."
},
{
"key": "page",
"value": "1",
"description": "The page to retrieve."
},
{
"key": "per_page",
"value": "5",
"description": "The size of the page."
},
{
"key": "sort",
"value": "<string>",
"description": "List of comma-separated fields for result sorting (minus for desc sorting)."
},
{
"key": "q",
"value": "<string>",
"description": "Query for filtering the results."
}
],
"variable": [
{
"key": "company_id"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "text",
"header": [
],
"cookie": [
],
"body": ""
}
]
}
