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 *strVal;
const wchar_t *id;
const wchar_t *symbol;
const wchar_t *exchange_rate;
const wchar_t *html_symbol;
const wchar_t *name;
const wchar_t *v_type;
const wchar_t *iban;
const wchar_t *sia;
const wchar_t *cuc;
const wchar_t *v_virtual;
const wchar_t *value;
const wchar_t *description;
const wchar_t *notes;
const wchar_t *e_invoice;
const wchar_t *ei_type;
const wchar_t *ei_description;
const wchar_t *editable;
const wchar_t *is_disabled;
const wchar_t *Detailed;
const wchar_t *Vat;
int i;
int count_i;
// 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"type",L"passive_delivery_note");
// 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/received_documents/info",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": {
// "default_values": {
// "detailed": "<boolean>"
// },
// "items_default_values": {
// "vat": "<number>"
// },
// "countries_list": [
// "<string>",
// "<string>"
// ],
// "currencies_list": [
// {
// "id": "<string>",
// "symbol": "<string>",
// "exchange_rate": "<string>",
// "html_symbol": "<string>"
// },
// {
// "id": "<string>",
// "symbol": "<string>",
// "exchange_rate": "<string>",
// "html_symbol": "<string>"
// }
// ],
// "categories_list": [
// "<string>",
// "<string>"
// ],
// "payment_accounts_list": [
// {
// "id": "<integer>",
// "name": "<string>",
// "type": "standard",
// "iban": "<string>",
// "sia": "<string>",
// "cuc": "<string>",
// "virtual": "<boolean>"
// },
// {
// "id": "<integer>",
// "name": "<string>",
// "type": "standard",
// "iban": "<string>",
// "sia": "<string>",
// "cuc": "<string>",
// "virtual": "<boolean>"
// }
// ],
// "vat_types_list": [
// {
// "id": "<integer>",
// "value": "<number>",
// "description": "<string>",
// "notes": "<string>",
// "e_invoice": "<boolean>",
// "ei_type": "<string>",
// "ei_description": "<string>",
// "editable": "<boolean>",
// "is_disabled": "<boolean>"
// },
// {
// "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
// Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.
Detailed = CkJsonObjectW_stringOf(jResp,L"data.default_values.detailed");
Vat = CkJsonObjectW_stringOf(jResp,L"data.items_default_values.vat");
i = 0;
count_i = CkJsonObjectW_SizeOfArray(jResp,L"data.countries_list");
while (i < count_i) {
CkJsonObjectW_putI(jResp,i);
strVal = CkJsonObjectW_stringOf(jResp,L"data.countries_list[i]");
i = i + 1;
}
i = 0;
count_i = CkJsonObjectW_SizeOfArray(jResp,L"data.currencies_list");
while (i < count_i) {
CkJsonObjectW_putI(jResp,i);
id = CkJsonObjectW_stringOf(jResp,L"data.currencies_list[i].id");
symbol = CkJsonObjectW_stringOf(jResp,L"data.currencies_list[i].symbol");
exchange_rate = CkJsonObjectW_stringOf(jResp,L"data.currencies_list[i].exchange_rate");
html_symbol = CkJsonObjectW_stringOf(jResp,L"data.currencies_list[i].html_symbol");
i = i + 1;
}
i = 0;
count_i = CkJsonObjectW_SizeOfArray(jResp,L"data.categories_list");
while (i < count_i) {
CkJsonObjectW_putI(jResp,i);
strVal = CkJsonObjectW_stringOf(jResp,L"data.categories_list[i]");
i = i + 1;
}
i = 0;
count_i = CkJsonObjectW_SizeOfArray(jResp,L"data.payment_accounts_list");
while (i < count_i) {
CkJsonObjectW_putI(jResp,i);
id = CkJsonObjectW_stringOf(jResp,L"data.payment_accounts_list[i].id");
name = CkJsonObjectW_stringOf(jResp,L"data.payment_accounts_list[i].name");
v_type = CkJsonObjectW_stringOf(jResp,L"data.payment_accounts_list[i].type");
iban = CkJsonObjectW_stringOf(jResp,L"data.payment_accounts_list[i].iban");
sia = CkJsonObjectW_stringOf(jResp,L"data.payment_accounts_list[i].sia");
cuc = CkJsonObjectW_stringOf(jResp,L"data.payment_accounts_list[i].cuc");
v_virtual = CkJsonObjectW_stringOf(jResp,L"data.payment_accounts_list[i].virtual");
i = i + 1;
}
i = 0;
count_i = CkJsonObjectW_SizeOfArray(jResp,L"data.vat_types_list");
while (i < count_i) {
CkJsonObjectW_putI(jResp,i);
id = CkJsonObjectW_stringOf(jResp,L"data.vat_types_list[i].id");
value = CkJsonObjectW_stringOf(jResp,L"data.vat_types_list[i].value");
description = CkJsonObjectW_stringOf(jResp,L"data.vat_types_list[i].description");
notes = CkJsonObjectW_stringOf(jResp,L"data.vat_types_list[i].notes");
e_invoice = CkJsonObjectW_stringOf(jResp,L"data.vat_types_list[i].e_invoice");
ei_type = CkJsonObjectW_stringOf(jResp,L"data.vat_types_list[i].ei_type");
ei_description = CkJsonObjectW_stringOf(jResp,L"data.vat_types_list[i].ei_description");
editable = CkJsonObjectW_stringOf(jResp,L"data.vat_types_list[i].editable");
is_disabled = CkJsonObjectW_stringOf(jResp,L"data.vat_types_list[i].is_disabled");
i = i + 1;
}
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(queryParams);
CkStringBuilderW_Dispose(sbResponseBody);
CkJsonObjectW_Dispose(jResp);
}
Curl Command
curl -G -d "type=passive_delivery_note"
-H "Authorization: Bearer <access_token>"
-H "Accept: application/json"
https://api-v2.fattureincloud.it/c/:company_id/received_documents/info
Postman Collection Item JSON
{
"name": "Get Received Document Pre-Create Info",
"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/received_documents/info?type=passive_delivery_note",
"host": [
"{{baseUrl}}"
],
"path": [
"c",
":company_id",
"received_documents",
"info"
],
"query": [
{
"key": "type",
"value": "passive_delivery_note",
"description": "(Required) The type of the received document."
}
],
"variable": [
{
"key": "company_id",
"value": "<integer>"
}
]
},
"description": "Retrieves the information useful while creating a new document."
},
"response": [
{
"name": "Pre-create info",
"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/received_documents/info?type=passive_delivery_note",
"host": [
"{{baseUrl}}"
],
"path": [
"c",
":company_id",
"received_documents",
"info"
],
"query": [
{
"key": "type",
"value": "passive_delivery_note",
"description": "(Required) The type of the received document."
}
],
"variable": [
{
"key": "company_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"data\": {\n \"default_values\": {\n \"detailed\": \"<boolean>\"\n },\n \"items_default_values\": {\n \"vat\": \"<number>\"\n },\n \"countries_list\": [\n \"<string>\",\n \"<string>\"\n ],\n \"currencies_list\": [\n {\n \"id\": \"<string>\",\n \"symbol\": \"<string>\",\n \"exchange_rate\": \"<string>\",\n \"html_symbol\": \"<string>\"\n },\n {\n \"id\": \"<string>\",\n \"symbol\": \"<string>\",\n \"exchange_rate\": \"<string>\",\n \"html_symbol\": \"<string>\"\n }\n ],\n \"categories_list\": [\n \"<string>\",\n \"<string>\"\n ],\n \"payment_accounts_list\": [\n {\n \"id\": \"<integer>\",\n \"name\": \"<string>\",\n \"type\": \"standard\",\n \"iban\": \"<string>\",\n \"sia\": \"<string>\",\n \"cuc\": \"<string>\",\n \"virtual\": \"<boolean>\"\n },\n {\n \"id\": \"<integer>\",\n \"name\": \"<string>\",\n \"type\": \"standard\",\n \"iban\": \"<string>\",\n \"sia\": \"<string>\",\n \"cuc\": \"<string>\",\n \"virtual\": \"<boolean>\"\n }\n ],\n \"vat_types_list\": [\n {\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 \"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}"
}
]
}
