Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
LOCAL loQueryParams
LOCAL loResp
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcId
LOCAL lcDate
LOCAL lcV_number
LOCAL lcNumeration
LOCAL lcAmount_net
LOCAL lcAmount_vat
LOCAL lcAmount_gross
LOCAL lcUse_gross_prices
LOCAL lcV_type
LOCAL lcDescription
LOCAL lcRc_center
LOCAL lcCreated_at
LOCAL lcUpdated_at
LOCAL lcId
LOCAL lcName
LOCAL lcV_Type
LOCAL lcIban
LOCAL lcSia
LOCAL lcCuc
LOCAL lcV_Virtual
LOCAL j
LOCAL lnCount_j
LOCAL lcCategory
LOCAL lcVatId
LOCAL lcValue
LOCAL lcDescription
LOCAL lcNotes
LOCAL lcE_invoice
LOCAL lcEi_type
LOCAL lcEi_description
LOCAL lcEditable
LOCAL lcIs_disabled
LOCAL lcCurrent_page
LOCAL lcFirst_page_url
LOCAL lcFrom
LOCAL lcLast_page
LOCAL lcLast_page_url
LOCAL lcNext_page_url
LOCAL lcPath
LOCAL lcPer_page
LOCAL lcPrev_page_url
LOCAL lcV_to
LOCAL lcTotal
LOCAL i
LOCAL lnCount_i
* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loQueryParams = CreateObject('Chilkat.JsonObject')
loQueryParams.UpdateString("fields","<string>")
loQueryParams.UpdateString("fieldset","basic")
loQueryParams.UpdateInt("page",1)
loQueryParams.UpdateInt("per_page",5)
loQueryParams.UpdateString("sort","<string>")
loQueryParams.UpdateString("q","<string>")
* Adds the "Authorization: Bearer <access_token>" header.
loHttp.AuthToken = "<access_token>"
loHttp.SetRequestHeader("Accept","application/json")
loResp = loHttp.QuickRequestParams("GET","https://api-v2.fattureincloud.it/c/:company_id/receipts",loQueryParams)
IF (loHttp.LastMethodSuccess = 0) THEN
? loHttp.LastErrorText
RELEASE loHttp
RELEASE loQueryParams
CANCEL
ENDIF
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
loResp.GetBodySb(loSbResponseBody)
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJResp = CreateObject('Chilkat.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
? "Response Header:"
? loResp.Header
? "Failed."
RELEASE loResp
RELEASE loHttp
RELEASE loQueryParams
RELEASE loSbResponseBody
RELEASE loJResp
CANCEL
ENDIF
RELEASE loResp
* 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
lcCurrent_page = loJResp.StringOf("current_page")
lcFirst_page_url = loJResp.StringOf("first_page_url")
lcFrom = loJResp.StringOf("from")
lcLast_page = loJResp.StringOf("last_page")
lcLast_page_url = loJResp.StringOf("last_page_url")
lcNext_page_url = loJResp.StringOf("next_page_url")
lcPath = loJResp.StringOf("path")
lcPer_page = loJResp.StringOf("per_page")
lcPrev_page_url = loJResp.StringOf("prev_page_url")
lcV_to = loJResp.StringOf("to")
lcTotal = loJResp.StringOf("total")
i = 0
lnCount_i = loJResp.SizeOfArray("data")
DO WHILE i < lnCount_i
loJResp.I = i
lcId = loJResp.StringOf("data[i].id")
lcDate = loJResp.StringOf("data[i].date")
lcV_number = loJResp.StringOf("data[i].number")
lcNumeration = loJResp.StringOf("data[i].numeration")
lcAmount_net = loJResp.StringOf("data[i].amount_net")
lcAmount_vat = loJResp.StringOf("data[i].amount_vat")
lcAmount_gross = loJResp.StringOf("data[i].amount_gross")
lcUse_gross_prices = loJResp.StringOf("data[i].use_gross_prices")
lcV_type = loJResp.StringOf("data[i].type")
lcDescription = loJResp.StringOf("data[i].description")
lcRc_center = loJResp.StringOf("data[i].rc_center")
lcCreated_at = loJResp.StringOf("data[i].created_at")
lcUpdated_at = loJResp.StringOf("data[i].updated_at")
lcId = loJResp.StringOf("data[i].payment_account.id")
lcName = loJResp.StringOf("data[i].payment_account.name")
lcV_Type = loJResp.StringOf("data[i].payment_account.type")
lcIban = loJResp.StringOf("data[i].payment_account.iban")
lcSia = loJResp.StringOf("data[i].payment_account.sia")
lcCuc = loJResp.StringOf("data[i].payment_account.cuc")
lcV_Virtual = loJResp.StringOf("data[i].payment_account.virtual")
j = 0
lnCount_j = loJResp.SizeOfArray("data[i].items_list")
DO WHILE j < lnCount_j
loJResp.J = j
lcId = loJResp.StringOf("data[i].items_list[j].id")
lcAmount_net = loJResp.StringOf("data[i].items_list[j].amount_net")
lcAmount_gross = loJResp.StringOf("data[i].items_list[j].amount_gross")
lcCategory = loJResp.StringOf("data[i].items_list[j].category")
lcVatId = loJResp.StringOf("data[i].items_list[j].vat.id")
lcValue = loJResp.StringOf("data[i].items_list[j].vat.value")
lcDescription = loJResp.StringOf("data[i].items_list[j].vat.description")
lcNotes = loJResp.StringOf("data[i].items_list[j].vat.notes")
lcE_invoice = loJResp.StringOf("data[i].items_list[j].vat.e_invoice")
lcEi_type = loJResp.StringOf("data[i].items_list[j].vat.ei_type")
lcEi_description = loJResp.StringOf("data[i].items_list[j].vat.ei_description")
lcEditable = loJResp.StringOf("data[i].items_list[j].vat.editable")
lcIs_disabled = loJResp.StringOf("data[i].items_list[j].vat.is_disabled")
j = j + 1
ENDDO
i = i + 1
ENDDO
RELEASE loHttp
RELEASE loQueryParams
RELEASE loSbResponseBody
RELEASE loJResp
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": ""
}
]
}
