Back to Collection Items
var
http: TChilkatHttp;
success: Integer;
queryParams: TChilkatJsonObject;
resp: IChilkatHttpResponse;
sbResponseBody: TChilkatStringBuilder;
jResp: TChilkatJsonObject;
respStatusCode: Integer;
id: WideString;
date: WideString;
description: WideString;
kind: WideString;
v_type: WideString;
entity_name: WideString;
Id: WideString;
v_Type: WideString;
Path: WideString;
amount_in: WideString;
payment_account_inId: WideString;
Name: WideString;
payment_account_inType: WideString;
Iban: WideString;
Sia: WideString;
Cuc: WideString;
v_Virtual: WideString;
amount_out: WideString;
payment_account_outId: WideString;
payment_account_outName: WideString;
payment_account_outType: WideString;
payment_account_outIban: WideString;
payment_account_outSia: WideString;
payment_account_outCuc: WideString;
payment_account_outVirtual: WideString;
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 := TChilkatHttp.Create(Self);
queryParams := TChilkatJsonObject.Create(Self);
queryParams.UpdateString('date_from','<string>');
queryParams.UpdateString('date_to','<string>');
queryParams.UpdateString('year','<integer>');
queryParams.UpdateString('type','all');
queryParams.UpdateString('payment_account_id','<integer>');
// Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken := '<access_token>';
http.SetRequestHeader('Accept','application/json');
resp := http.QuickRequestParams('GET','https://api-v2.fattureincloud.it/c/:company_id/cashbook',queryParams.ControlInterface);
if (http.LastMethodSuccess = 0) then
begin
Memo1.Lines.Add(http.LastErrorText);
Exit;
end;
sbResponseBody := TChilkatStringBuilder.Create(Self);
resp.GetBodySb(sbResponseBody.ControlInterface);
jResp := TChilkatJsonObject.Create(Self);
jResp.LoadSb(sbResponseBody.ControlInterface);
jResp.EmitCompact := 0;
Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(jResp.Emit());
respStatusCode := resp.StatusCode;
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
begin
Memo1.Lines.Add('Response Header:');
Memo1.Lines.Add(resp.Header);
Memo1.Lines.Add('Failed.');
Exit;
end;
// 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 := jResp.SizeOfArray('data');
while i < count_i do
begin
jResp.I := i;
id := jResp.StringOf('data[i].id');
date := jResp.StringOf('data[i].date');
description := jResp.StringOf('data[i].description');
kind := jResp.StringOf('data[i].kind');
v_type := jResp.StringOf('data[i].type');
entity_name := jResp.StringOf('data[i].entity_name');
Id := jResp.StringOf('data[i].document.id');
v_Type := jResp.StringOf('data[i].document.type');
Path := jResp.StringOf('data[i].document.path');
amount_in := jResp.StringOf('data[i].amount_in');
payment_account_inId := jResp.StringOf('data[i].payment_account_in.id');
Name := jResp.StringOf('data[i].payment_account_in.name');
payment_account_inType := jResp.StringOf('data[i].payment_account_in.type');
Iban := jResp.StringOf('data[i].payment_account_in.iban');
Sia := jResp.StringOf('data[i].payment_account_in.sia');
Cuc := jResp.StringOf('data[i].payment_account_in.cuc');
v_Virtual := jResp.StringOf('data[i].payment_account_in.virtual');
amount_out := jResp.StringOf('data[i].amount_out');
payment_account_outId := jResp.StringOf('data[i].payment_account_out.id');
payment_account_outName := jResp.StringOf('data[i].payment_account_out.name');
payment_account_outType := jResp.StringOf('data[i].payment_account_out.type');
payment_account_outIban := jResp.StringOf('data[i].payment_account_out.iban');
payment_account_outSia := jResp.StringOf('data[i].payment_account_out.sia');
payment_account_outCuc := jResp.StringOf('data[i].payment_account_out.cuc');
payment_account_outVirtual := jResp.StringOf('data[i].payment_account_out.virtual');
i := i + 1;
end;
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": ""
}
]
}
