Back to Collection Items
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
$oHttp = ObjCreate("Chilkat_9_5_0.Http")
Local $bSuccess
$oQueryParams = ObjCreate("Chilkat_9_5_0.JsonObject")
$oQueryParams.UpdateString("fields","<string>")
$oQueryParams.UpdateString("fieldset","basic")
$oQueryParams.UpdateInt("page",1)
$oQueryParams.UpdateInt("per_page",5)
$oQueryParams.UpdateString("sort","<string>")
$oQueryParams.UpdateString("q","<string>")
; Adds the "Authorization: Bearer <access_token>" header.
$oHttp.AuthToken = "<access_token>"
$oHttp.SetRequestHeader "Accept","application/json"
Local $oResp = $oHttp.QuickRequestParams("GET","https://api-v2.fattureincloud.it/c/:company_id/receipts",$oQueryParams)
If ($oHttp.LastMethodSuccess = False) Then
ConsoleWrite($oHttp.LastErrorText & @CRLF)
Exit
EndIf
$oSbResponseBody = ObjCreate("Chilkat_9_5_0.StringBuilder")
$oResp.GetBodySb($oSbResponseBody)
$oJResp = ObjCreate("Chilkat_9_5_0.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False
ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)
Local $iRespStatusCode = $oResp.StatusCode
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
ConsoleWrite("Response Header:" & @CRLF)
ConsoleWrite($oResp.Header & @CRLF)
ConsoleWrite("Failed." & @CRLF)
Exit
EndIf
; 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
Local $sId
Local $sDate
Local $sV_number
Local $sNumeration
Local $sAmount_net
Local $sAmount_vat
Local $sAmount_gross
Local $sUse_gross_prices
Local $sV_type
Local $sDescription
Local $sRc_center
Local $sCreated_at
Local $sUpdated_at
Local $sId
Local $sName
Local $sV_Type
Local $sIban
Local $sSia
Local $sCuc
Local $sV_Virtual
Local $iJ
Local $iCount_j
Local $sCategory
Local $sVatId
Local $sValue
Local $sDescription
Local $sNotes
Local $sE_invoice
Local $sEi_type
Local $sEi_description
Local $sEditable
Local $sIs_disabled
Local $sCurrent_page = $oJResp.StringOf("current_page")
Local $sFirst_page_url = $oJResp.StringOf("first_page_url")
Local $sFrom = $oJResp.StringOf("from")
Local $sLast_page = $oJResp.StringOf("last_page")
Local $sLast_page_url = $oJResp.StringOf("last_page_url")
Local $sNext_page_url = $oJResp.StringOf("next_page_url")
Local $sPath = $oJResp.StringOf("path")
Local $sPer_page = $oJResp.StringOf("per_page")
Local $sPrev_page_url = $oJResp.StringOf("prev_page_url")
Local $sV_to = $oJResp.StringOf("to")
Local $sTotal = $oJResp.StringOf("total")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("data")
While $i < $iCount_i
$oJResp.I = $i
$sId = $oJResp.StringOf("data[i].id")
$sDate = $oJResp.StringOf("data[i].date")
$sV_number = $oJResp.StringOf("data[i].number")
$sNumeration = $oJResp.StringOf("data[i].numeration")
$sAmount_net = $oJResp.StringOf("data[i].amount_net")
$sAmount_vat = $oJResp.StringOf("data[i].amount_vat")
$sAmount_gross = $oJResp.StringOf("data[i].amount_gross")
$sUse_gross_prices = $oJResp.StringOf("data[i].use_gross_prices")
$sV_type = $oJResp.StringOf("data[i].type")
$sDescription = $oJResp.StringOf("data[i].description")
$sRc_center = $oJResp.StringOf("data[i].rc_center")
$sCreated_at = $oJResp.StringOf("data[i].created_at")
$sUpdated_at = $oJResp.StringOf("data[i].updated_at")
$sId = $oJResp.StringOf("data[i].payment_account.id")
$sName = $oJResp.StringOf("data[i].payment_account.name")
$sV_Type = $oJResp.StringOf("data[i].payment_account.type")
$sIban = $oJResp.StringOf("data[i].payment_account.iban")
$sSia = $oJResp.StringOf("data[i].payment_account.sia")
$sCuc = $oJResp.StringOf("data[i].payment_account.cuc")
$sV_Virtual = $oJResp.StringOf("data[i].payment_account.virtual")
$iJ = 0
$iCount_j = $oJResp.SizeOfArray("data[i].items_list")
While $iJ < $iCount_j
$oJResp.J = $iJ
$sId = $oJResp.StringOf("data[i].items_list[j].id")
$sAmount_net = $oJResp.StringOf("data[i].items_list[j].amount_net")
$sAmount_gross = $oJResp.StringOf("data[i].items_list[j].amount_gross")
$sCategory = $oJResp.StringOf("data[i].items_list[j].category")
$sVatId = $oJResp.StringOf("data[i].items_list[j].vat.id")
$sValue = $oJResp.StringOf("data[i].items_list[j].vat.value")
$sDescription = $oJResp.StringOf("data[i].items_list[j].vat.description")
$sNotes = $oJResp.StringOf("data[i].items_list[j].vat.notes")
$sE_invoice = $oJResp.StringOf("data[i].items_list[j].vat.e_invoice")
$sEi_type = $oJResp.StringOf("data[i].items_list[j].vat.ei_type")
$sEi_description = $oJResp.StringOf("data[i].items_list[j].vat.ei_description")
$sEditable = $oJResp.StringOf("data[i].items_list[j].vat.editable")
$sIs_disabled = $oJResp.StringOf("data[i].items_list[j].vat.is_disabled")
$iJ = $iJ + 1
Wend
$i = $i + 1
Wend
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": ""
}
]
}
