Chilkat Online Tools

delphiDll / Fatture in Cloud API v2 - API Reference / Get Received Document Pre-Create Info

Back to Collection Items

var
http: HCkHttp;
success: Boolean;
queryParams: HCkJsonObject;
resp: HCkHttpResponse;
sbResponseBody: HCkStringBuilder;
jResp: HCkJsonObject;
respStatusCode: Integer;
strVal: PWideChar;
id: PWideChar;
symbol: PWideChar;
exchange_rate: PWideChar;
html_symbol: PWideChar;
name: PWideChar;
v_type: PWideChar;
iban: PWideChar;
sia: PWideChar;
cuc: PWideChar;
v_virtual: PWideChar;
value: PWideChar;
description: PWideChar;
notes: PWideChar;
e_invoice: PWideChar;
ei_type: PWideChar;
ei_description: PWideChar;
editable: PWideChar;
is_disabled: PWideChar;
Detailed: PWideChar;
Vat: 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,'type','passive_delivery_note');

// 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/received_documents/info',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": {
//     "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

Detailed := CkJsonObject__stringOf(jResp,'data.default_values.detailed');
Vat := CkJsonObject__stringOf(jResp,'data.items_default_values.vat');
i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'data.countries_list');
while i < count_i do
  begin
    CkJsonObject_putI(jResp,i);
    strVal := CkJsonObject__stringOf(jResp,'data.countries_list[i]');
    i := i + 1;
  end;

i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'data.currencies_list');
while i < count_i do
  begin
    CkJsonObject_putI(jResp,i);
    id := CkJsonObject__stringOf(jResp,'data.currencies_list[i].id');
    symbol := CkJsonObject__stringOf(jResp,'data.currencies_list[i].symbol');
    exchange_rate := CkJsonObject__stringOf(jResp,'data.currencies_list[i].exchange_rate');
    html_symbol := CkJsonObject__stringOf(jResp,'data.currencies_list[i].html_symbol');
    i := i + 1;
  end;

i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'data.categories_list');
while i < count_i do
  begin
    CkJsonObject_putI(jResp,i);
    strVal := CkJsonObject__stringOf(jResp,'data.categories_list[i]');
    i := i + 1;
  end;

i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'data.payment_accounts_list');
while i < count_i do
  begin
    CkJsonObject_putI(jResp,i);
    id := CkJsonObject__stringOf(jResp,'data.payment_accounts_list[i].id');
    name := CkJsonObject__stringOf(jResp,'data.payment_accounts_list[i].name');
    v_type := CkJsonObject__stringOf(jResp,'data.payment_accounts_list[i].type');
    iban := CkJsonObject__stringOf(jResp,'data.payment_accounts_list[i].iban');
    sia := CkJsonObject__stringOf(jResp,'data.payment_accounts_list[i].sia');
    cuc := CkJsonObject__stringOf(jResp,'data.payment_accounts_list[i].cuc');
    v_virtual := CkJsonObject__stringOf(jResp,'data.payment_accounts_list[i].virtual');
    i := i + 1;
  end;

i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'data.vat_types_list');
while i < count_i do
  begin
    CkJsonObject_putI(jResp,i);
    id := CkJsonObject__stringOf(jResp,'data.vat_types_list[i].id');
    value := CkJsonObject__stringOf(jResp,'data.vat_types_list[i].value');
    description := CkJsonObject__stringOf(jResp,'data.vat_types_list[i].description');
    notes := CkJsonObject__stringOf(jResp,'data.vat_types_list[i].notes');
    e_invoice := CkJsonObject__stringOf(jResp,'data.vat_types_list[i].e_invoice');
    ei_type := CkJsonObject__stringOf(jResp,'data.vat_types_list[i].ei_type');
    ei_description := CkJsonObject__stringOf(jResp,'data.vat_types_list[i].ei_description');
    editable := CkJsonObject__stringOf(jResp,'data.vat_types_list[i].editable');
    is_disabled := CkJsonObject__stringOf(jResp,'data.vat_types_list[i].is_disabled');
    i := i + 1;
  end;

CkHttp_Dispose(http);
CkJsonObject_Dispose(queryParams);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_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}"
    }
  ]
}