Back to Collection Items
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loHttp = createobject("CkHttp")
loQueryParams = createobject("CkJsonObject")
loQueryParams.UpdateString("date_from","<string>")
loQueryParams.UpdateString("date_to","<string>")
loQueryParams.UpdateString("year","<integer>")
loQueryParams.UpdateString("type","all")
loQueryParams.UpdateString("payment_account_id","<integer>")
// 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/cashbook",loQueryParams)
if (loHttp.LastMethodSuccess = .F.) then
? loHttp.LastErrorText
release loHttp
release loQueryParams
return
endif
loSbResponseBody = createobject("CkStringBuilder")
loResp.GetBodySb(loSbResponseBody)
loJResp = createobject("CkJsonObject")
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = .F.
? "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
return
endif
release loResp
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "data": [
// {
// "id": "<string>",
// "date": "<date>",
// "description": "<string>",
// "kind": "tax",
// "type": "in",
// "entity_name": "<string>",
// "document": {
// "id": "<integer>",
// "type": "<string>",
// "path": "<string>"
// },
// "amount_in": "<number>",
// "payment_account_in": {
// "id": "<integer>",
// "name": "<string>",
// "type": "standard",
// "iban": "<string>",
// "sia": "<string>",
// "cuc": "<string>",
// "virtual": "<boolean>"
// },
// "amount_out": "<number>",
// "payment_account_out": {
// "id": "<integer>",
// "name": "<string>",
// "type": "standard",
// "iban": "<string>",
// "sia": "<string>",
// "cuc": "<string>",
// "virtual": "<boolean>"
// }
// },
// {
// "id": "<string>",
// "date": "<date>",
// "description": "<string>",
// "kind": "received_document",
// "type": "in",
// "entity_name": "<string>",
// "document": {
// "id": "<integer>",
// "type": "<string>",
// "path": "<string>"
// },
// "amount_in": "<number>",
// "payment_account_in": {
// "id": "<integer>",
// "name": "<string>",
// "type": "standard",
// "iban": "<string>",
// "sia": "<string>",
// "cuc": "<string>",
// "virtual": "<boolean>"
// },
// "amount_out": "<number>",
// "payment_account_out": {
// "id": "<integer>",
// "name": "<string>",
// "type": "standard",
// "iban": "<string>",
// "sia": "<string>",
// "cuc": "<string>",
// "virtual": "<boolean>"
// }
// }
// ]
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
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")
lcDescription = loJResp.StringOf("data[i].description")
lcKind = loJResp.StringOf("data[i].kind")
lcV_type = loJResp.StringOf("data[i].type")
lcEntity_name = loJResp.StringOf("data[i].entity_name")
lcId = loJResp.StringOf("data[i].document.id")
lcV_Type = loJResp.StringOf("data[i].document.type")
lcPath = loJResp.StringOf("data[i].document.path")
lcAmount_in = loJResp.StringOf("data[i].amount_in")
lcPayment_account_inId = loJResp.StringOf("data[i].payment_account_in.id")
lcName = loJResp.StringOf("data[i].payment_account_in.name")
lcPayment_account_inType = loJResp.StringOf("data[i].payment_account_in.type")
lcIban = loJResp.StringOf("data[i].payment_account_in.iban")
lcSia = loJResp.StringOf("data[i].payment_account_in.sia")
lcCuc = loJResp.StringOf("data[i].payment_account_in.cuc")
lcV_Virtual = loJResp.StringOf("data[i].payment_account_in.virtual")
lcAmount_out = loJResp.StringOf("data[i].amount_out")
lcPayment_account_outId = loJResp.StringOf("data[i].payment_account_out.id")
lcPayment_account_outName = loJResp.StringOf("data[i].payment_account_out.name")
lcPayment_account_outType = loJResp.StringOf("data[i].payment_account_out.type")
lcPayment_account_outIban = loJResp.StringOf("data[i].payment_account_out.iban")
lcPayment_account_outSia = loJResp.StringOf("data[i].payment_account_out.sia")
lcPayment_account_outCuc = loJResp.StringOf("data[i].payment_account_out.cuc")
lcPayment_account_outVirtual = loJResp.StringOf("data[i].payment_account_out.virtual")
i = i + 1
enddo
release loHttp
release loQueryParams
release loSbResponseBody
release loJResp
Curl Command
curl -G -d "date_from=%3Cstring%3E"
-d "date_to=%3Cstring%3E"
-d "year=%3Cinteger%3E"
-d "type=all"
-d "payment_account_id=%3Cinteger%3E"
-H "Authorization: Bearer <access_token>"
-H "Accept: application/json"
https://api-v2.fattureincloud.it/c/:company_id/cashbook
Postman Collection Item JSON
{
"name": "List Cashbook Entries",
"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/cashbook?date_from=<string>&date_to=<string>&year=<integer>&type=all&payment_account_id=<integer>",
"host": [
"{{baseUrl}}"
],
"path": [
"c",
":company_id",
"cashbook"
],
"query": [
{
"key": "date_from",
"value": "<string>",
"description": "(Required) Start date."
},
{
"key": "date_to",
"value": "<string>",
"description": "(Required) End date."
},
{
"key": "year",
"value": "<integer>",
"description": "Filter cashbook by year."
},
{
"key": "type",
"value": "all",
"description": "Filter cashbook by type."
},
{
"key": "payment_account_id",
"value": "<integer>",
"description": "Filter by payment account."
}
],
"variable": [
{
"key": "company_id",
"value": "<integer>"
}
]
},
"description": "Lists the cashbook entries."
},
"response": [
{
"name": "Results 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/cashbook?date_from=<string>&date_to=<string>&year=<integer>&type=all&payment_account_id=<integer>",
"host": [
"{{baseUrl}}"
],
"path": [
"c",
":company_id",
"cashbook"
],
"query": [
{
"key": "date_from",
"value": "<string>",
"description": "(Required) Start date."
},
{
"key": "date_to",
"value": "<string>",
"description": "(Required) End date."
},
{
"key": "year",
"value": "<integer>",
"description": "Filter cashbook by year."
},
{
"key": "type",
"value": "all",
"description": "Filter cashbook by type."
},
{
"key": "payment_account_id",
"value": "<integer>",
"description": "Filter by payment account."
}
],
"variable": [
{
"key": "company_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"data\": [\n {\n \"id\": \"<string>\",\n \"date\": \"<date>\",\n \"description\": \"<string>\",\n \"kind\": \"tax\",\n \"type\": \"in\",\n \"entity_name\": \"<string>\",\n \"document\": {\n \"id\": \"<integer>\",\n \"type\": \"<string>\",\n \"path\": \"<string>\"\n },\n \"amount_in\": \"<number>\",\n \"payment_account_in\": {\n \"id\": \"<integer>\",\n \"name\": \"<string>\",\n \"type\": \"standard\",\n \"iban\": \"<string>\",\n \"sia\": \"<string>\",\n \"cuc\": \"<string>\",\n \"virtual\": \"<boolean>\"\n },\n \"amount_out\": \"<number>\",\n \"payment_account_out\": {\n \"id\": \"<integer>\",\n \"name\": \"<string>\",\n \"type\": \"standard\",\n \"iban\": \"<string>\",\n \"sia\": \"<string>\",\n \"cuc\": \"<string>\",\n \"virtual\": \"<boolean>\"\n }\n },\n {\n \"id\": \"<string>\",\n \"date\": \"<date>\",\n \"description\": \"<string>\",\n \"kind\": \"received_document\",\n \"type\": \"in\",\n \"entity_name\": \"<string>\",\n \"document\": {\n \"id\": \"<integer>\",\n \"type\": \"<string>\",\n \"path\": \"<string>\"\n },\n \"amount_in\": \"<number>\",\n \"payment_account_in\": {\n \"id\": \"<integer>\",\n \"name\": \"<string>\",\n \"type\": \"standard\",\n \"iban\": \"<string>\",\n \"sia\": \"<string>\",\n \"cuc\": \"<string>\",\n \"virtual\": \"<boolean>\"\n },\n \"amount_out\": \"<number>\",\n \"payment_account_out\": {\n \"id\": \"<integer>\",\n \"name\": \"<string>\",\n \"type\": \"standard\",\n \"iban\": \"<string>\",\n \"sia\": \"<string>\",\n \"cuc\": \"<string>\",\n \"virtual\": \"<boolean>\"\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/cashbook?date_from=<string>&date_to=<string>&year=<integer>&type=all&payment_account_id=<integer>",
"host": [
"{{baseUrl}}"
],
"path": [
"c",
":company_id",
"cashbook"
],
"query": [
{
"key": "date_from",
"value": "<string>",
"description": "(Required) Start date."
},
{
"key": "date_to",
"value": "<string>",
"description": "(Required) End date."
},
{
"key": "year",
"value": "<integer>",
"description": "Filter cashbook by year."
},
{
"key": "type",
"value": "all",
"description": "Filter cashbook by type."
},
{
"key": "payment_account_id",
"value": "<integer>",
"description": "Filter by payment account."
}
],
"variable": [
{
"key": "company_id"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "text",
"header": [
],
"cookie": [
],
"body": ""
},
{
"name": "Not Found",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/c/:company_id/cashbook?date_from=<string>&date_to=<string>&year=<integer>&type=all&payment_account_id=<integer>",
"host": [
"{{baseUrl}}"
],
"path": [
"c",
":company_id",
"cashbook"
],
"query": [
{
"key": "date_from",
"value": "<string>",
"description": "(Required) Start date."
},
{
"key": "date_to",
"value": "<string>",
"description": "(Required) End date."
},
{
"key": "year",
"value": "<integer>",
"description": "Filter cashbook by year."
},
{
"key": "type",
"value": "all",
"description": "Filter cashbook by type."
},
{
"key": "payment_account_id",
"value": "<integer>",
"description": "Filter by payment account."
}
],
"variable": [
{
"key": "company_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "text",
"header": [
],
"cookie": [
],
"body": ""
}
]
}
