Back to Collection Items
var
http: HCkHttp;
success: Boolean;
queryParams: HCkJsonObject;
resp: HCkHttpResponse;
sbResponseBody: HCkStringBuilder;
jResp: HCkJsonObject;
respStatusCode: Integer;
id: PWideChar;
date: PWideChar;
description: PWideChar;
kind: PWideChar;
v_type: PWideChar;
entity_name: PWideChar;
Id: PWideChar;
v_Type: PWideChar;
Path: PWideChar;
amount_in: PWideChar;
payment_account_inId: PWideChar;
Name: PWideChar;
payment_account_inType: PWideChar;
Iban: PWideChar;
Sia: PWideChar;
Cuc: PWideChar;
v_Virtual: PWideChar;
amount_out: PWideChar;
payment_account_outId: PWideChar;
payment_account_outName: PWideChar;
payment_account_outType: PWideChar;
payment_account_outIban: PWideChar;
payment_account_outSia: PWideChar;
payment_account_outCuc: PWideChar;
payment_account_outVirtual: PWideChar;
i: Integer;
count_i: Integer;
begin
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http := CkHttp_Create();
queryParams := CkJsonObject_Create();
CkJsonObject_UpdateString(queryParams,'date_from','<string>');
CkJsonObject_UpdateString(queryParams,'date_to','<string>');
CkJsonObject_UpdateString(queryParams,'year','<integer>');
CkJsonObject_UpdateString(queryParams,'type','all');
CkJsonObject_UpdateString(queryParams,'payment_account_id','<integer>');
// Adds the "Authorization: Bearer <access_token>" header.
CkHttp_putAuthToken(http,'<access_token>');
CkHttp_SetRequestHeader(http,'Accept','application/json');
resp := CkHttp_QuickRequestParams(http,'GET','https://api-v2.fattureincloud.it/c/:company_id/cashbook',queryParams);
if (CkHttp_getLastMethodSuccess(http) = False) then
begin
Memo1.Lines.Add(CkHttp__lastErrorText(http));
Exit;
end;
sbResponseBody := CkStringBuilder_Create();
CkHttpResponse_GetBodySb(resp,sbResponseBody);
jResp := CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,False);
Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(CkJsonObject__emit(jResp));
respStatusCode := CkHttpResponse_getStatusCode(resp);
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
begin
Memo1.Lines.Add('Response Header:');
Memo1.Lines.Add(CkHttpResponse__header(resp));
Memo1.Lines.Add('Failed.');
CkHttpResponse_Dispose(resp);
Exit;
end;
CkHttpResponse_Dispose(resp);
// 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;
count_i := CkJsonObject_SizeOfArray(jResp,'data');
while i < count_i do
begin
CkJsonObject_putI(jResp,i);
id := CkJsonObject__stringOf(jResp,'data[i].id');
date := CkJsonObject__stringOf(jResp,'data[i].date');
description := CkJsonObject__stringOf(jResp,'data[i].description');
kind := CkJsonObject__stringOf(jResp,'data[i].kind');
v_type := CkJsonObject__stringOf(jResp,'data[i].type');
entity_name := CkJsonObject__stringOf(jResp,'data[i].entity_name');
Id := CkJsonObject__stringOf(jResp,'data[i].document.id');
v_Type := CkJsonObject__stringOf(jResp,'data[i].document.type');
Path := CkJsonObject__stringOf(jResp,'data[i].document.path');
amount_in := CkJsonObject__stringOf(jResp,'data[i].amount_in');
payment_account_inId := CkJsonObject__stringOf(jResp,'data[i].payment_account_in.id');
Name := CkJsonObject__stringOf(jResp,'data[i].payment_account_in.name');
payment_account_inType := CkJsonObject__stringOf(jResp,'data[i].payment_account_in.type');
Iban := CkJsonObject__stringOf(jResp,'data[i].payment_account_in.iban');
Sia := CkJsonObject__stringOf(jResp,'data[i].payment_account_in.sia');
Cuc := CkJsonObject__stringOf(jResp,'data[i].payment_account_in.cuc');
v_Virtual := CkJsonObject__stringOf(jResp,'data[i].payment_account_in.virtual');
amount_out := CkJsonObject__stringOf(jResp,'data[i].amount_out');
payment_account_outId := CkJsonObject__stringOf(jResp,'data[i].payment_account_out.id');
payment_account_outName := CkJsonObject__stringOf(jResp,'data[i].payment_account_out.name');
payment_account_outType := CkJsonObject__stringOf(jResp,'data[i].payment_account_out.type');
payment_account_outIban := CkJsonObject__stringOf(jResp,'data[i].payment_account_out.iban');
payment_account_outSia := CkJsonObject__stringOf(jResp,'data[i].payment_account_out.sia');
payment_account_outCuc := CkJsonObject__stringOf(jResp,'data[i].payment_account_out.cuc');
payment_account_outVirtual := CkJsonObject__stringOf(jResp,'data[i].payment_account_out.virtual');
i := i + 1;
end;
CkHttp_Dispose(http);
CkJsonObject_Dispose(queryParams);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
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": ""
}
]
}