Back to Collection Items
#include <C_CkHttpW.h>
#include <C_CkJsonObjectW.h>
#include <C_CkHttpResponseW.h>
#include <C_CkStringBuilderW.h>
void ChilkatSample(void)
{
HCkHttpW http;
BOOL success;
HCkJsonObjectW queryParams;
HCkHttpResponseW resp;
HCkStringBuilderW sbResponseBody;
HCkJsonObjectW jResp;
int respStatusCode;
const wchar_t *Id;
const wchar_t *Date;
const wchar_t *Description;
const wchar_t *Kind;
const wchar_t *v_Type;
const wchar_t *Entity_name;
const wchar_t *DocumentId;
const wchar_t *DocumentType;
const wchar_t *Path;
const wchar_t *Amount_in;
const wchar_t *Payment_account_inId;
const wchar_t *Name;
const wchar_t *Payment_account_inType;
const wchar_t *Iban;
const wchar_t *Sia;
const wchar_t *Cuc;
const wchar_t *v_Virtual;
const wchar_t *Amount_out;
const wchar_t *Payment_account_outId;
const wchar_t *Payment_account_outName;
const wchar_t *Payment_account_outType;
const wchar_t *Payment_account_outIban;
const wchar_t *Payment_account_outSia;
const wchar_t *Payment_account_outCuc;
const wchar_t *Payment_account_outVirtual;
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http = CkHttpW_Create();
queryParams = CkJsonObjectW_Create();
CkJsonObjectW_UpdateString(queryParams,L"fields",L"<string>");
CkJsonObjectW_UpdateString(queryParams,L"fieldset",L"basic");
// Adds the "Authorization: Bearer <access_token>" header.
CkHttpW_putAuthToken(http,L"<access_token>");
CkHttpW_SetRequestHeader(http,L"Accept",L"application/json");
resp = CkHttpW_QuickRequestParams(http,L"GET",L"https://api-v2.fattureincloud.it/c/:company_id/cashbook/:document_id",queryParams);
if (CkHttpW_getLastMethodSuccess(http) == FALSE) {
wprintf(L"%s\n",CkHttpW_lastErrorText(http));
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(queryParams);
return;
}
sbResponseBody = CkStringBuilderW_Create();
CkHttpResponseW_GetBodySb(resp,sbResponseBody);
jResp = CkJsonObjectW_Create();
CkJsonObjectW_LoadSb(jResp,sbResponseBody);
CkJsonObjectW_putEmitCompact(jResp,FALSE);
wprintf(L"Response Body:\n");
wprintf(L"%s\n",CkJsonObjectW_emit(jResp));
respStatusCode = CkHttpResponseW_getStatusCode(resp);
wprintf(L"Response Status Code = %d\n",respStatusCode);
if (respStatusCode >= 400) {
wprintf(L"Response Header:\n");
wprintf(L"%s\n",CkHttpResponseW_header(resp));
wprintf(L"Failed.\n");
CkHttpResponseW_Dispose(resp);
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(queryParams);
CkStringBuilderW_Dispose(sbResponseBody);
CkJsonObjectW_Dispose(jResp);
return;
}
CkHttpResponseW_Dispose(resp);
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "data": {
// "id": "<string>",
// "date": "<date>",
// "description": "<string>",
// "kind": "receipt",
// "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
// Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.
Id = CkJsonObjectW_stringOf(jResp,L"data.id");
Date = CkJsonObjectW_stringOf(jResp,L"data.date");
Description = CkJsonObjectW_stringOf(jResp,L"data.description");
Kind = CkJsonObjectW_stringOf(jResp,L"data.kind");
v_Type = CkJsonObjectW_stringOf(jResp,L"data.type");
Entity_name = CkJsonObjectW_stringOf(jResp,L"data.entity_name");
DocumentId = CkJsonObjectW_stringOf(jResp,L"data.document.id");
DocumentType = CkJsonObjectW_stringOf(jResp,L"data.document.type");
Path = CkJsonObjectW_stringOf(jResp,L"data.document.path");
Amount_in = CkJsonObjectW_stringOf(jResp,L"data.amount_in");
Payment_account_inId = CkJsonObjectW_stringOf(jResp,L"data.payment_account_in.id");
Name = CkJsonObjectW_stringOf(jResp,L"data.payment_account_in.name");
Payment_account_inType = CkJsonObjectW_stringOf(jResp,L"data.payment_account_in.type");
Iban = CkJsonObjectW_stringOf(jResp,L"data.payment_account_in.iban");
Sia = CkJsonObjectW_stringOf(jResp,L"data.payment_account_in.sia");
Cuc = CkJsonObjectW_stringOf(jResp,L"data.payment_account_in.cuc");
v_Virtual = CkJsonObjectW_stringOf(jResp,L"data.payment_account_in.virtual");
Amount_out = CkJsonObjectW_stringOf(jResp,L"data.amount_out");
Payment_account_outId = CkJsonObjectW_stringOf(jResp,L"data.payment_account_out.id");
Payment_account_outName = CkJsonObjectW_stringOf(jResp,L"data.payment_account_out.name");
Payment_account_outType = CkJsonObjectW_stringOf(jResp,L"data.payment_account_out.type");
Payment_account_outIban = CkJsonObjectW_stringOf(jResp,L"data.payment_account_out.iban");
Payment_account_outSia = CkJsonObjectW_stringOf(jResp,L"data.payment_account_out.sia");
Payment_account_outCuc = CkJsonObjectW_stringOf(jResp,L"data.payment_account_out.cuc");
Payment_account_outVirtual = CkJsonObjectW_stringOf(jResp,L"data.payment_account_out.virtual");
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(queryParams);
CkStringBuilderW_Dispose(sbResponseBody);
CkJsonObjectW_Dispose(jResp);
}
Curl Command
curl -G -d "fields=%3Cstring%3E"
-d "fieldset=basic"
-H "Authorization: Bearer <access_token>"
-H "Accept: application/json"
https://api-v2.fattureincloud.it/c/:company_id/cashbook/:document_id
Postman Collection Item JSON
{
"name": "Get Cashbook Entry",
"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/:document_id?fields=<string>&fieldset=basic",
"host": [
"{{baseUrl}}"
],
"path": [
"c",
":company_id",
"cashbook",
":document_id"
],
"query": [
{
"key": "fields",
"value": "<string>",
"description": "List of comma-separated fields."
},
{
"key": "fieldset",
"value": "basic",
"description": "Name of the fieldset."
}
],
"variable": [
{
"key": "company_id",
"value": "<integer>"
},
{
"key": "document_id",
"value": "<string>"
}
]
},
"description": "Gets the specified cashbook entry."
},
"response": [
{
"name": "Cashbook Entry.",
"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/:document_id?fields=<string>&fieldset=basic",
"host": [
"{{baseUrl}}"
],
"path": [
"c",
":company_id",
"cashbook",
":document_id"
],
"query": [
{
"key": "fields",
"value": "<string>",
"description": "List of comma-separated fields."
},
{
"key": "fieldset",
"value": "basic",
"description": "Name of the fieldset."
}
],
"variable": [
{
"key": "company_id"
},
{
"key": "document_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"data\": {\n \"id\": \"<string>\",\n \"date\": \"<date>\",\n \"description\": \"<string>\",\n \"kind\": \"receipt\",\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}"
},
{
"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/:document_id?fields=<string>&fieldset=basic",
"host": [
"{{baseUrl}}"
],
"path": [
"c",
":company_id",
"cashbook",
":document_id"
],
"query": [
{
"key": "fields",
"value": "<string>",
"description": "List of comma-separated fields."
},
{
"key": "fieldset",
"value": "basic",
"description": "Name of the fieldset."
}
],
"variable": [
{
"key": "company_id"
},
{
"key": "document_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/:document_id?fields=<string>&fieldset=basic",
"host": [
"{{baseUrl}}"
],
"path": [
"c",
":company_id",
"cashbook",
":document_id"
],
"query": [
{
"key": "fields",
"value": "<string>",
"description": "List of comma-separated fields."
},
{
"key": "fieldset",
"value": "basic",
"description": "Name of the fieldset."
}
],
"variable": [
{
"key": "company_id"
},
{
"key": "document_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "text",
"header": [
],
"cookie": [
],
"body": ""
}
]
}
