Chilkat Online Tools

C / Fatture in Cloud API v2 - API Reference / Get Receipt

Back to Collection Items

#include <C_CkHttp.h>
#include <C_CkJsonObject.h>
#include <C_CkHttpResponse.h>
#include <C_CkStringBuilder.h>

void ChilkatSample(void)
    {
    HCkHttp http;
    BOOL success;
    HCkJsonObject queryParams;
    HCkHttpResponse resp;
    HCkStringBuilder sbResponseBody;
    HCkJsonObject jResp;
    int respStatusCode;
    const char *id;
    const char *amount_net;
    const char *amount_gross;
    const char *category;
    const char *vatId;
    const char *Value;
    const char *vatDescription;
    const char *Notes;
    const char *E_invoice;
    const char *Ei_type;
    const char *Ei_description;
    const char *Editable;
    const char *Is_disabled;
    const char *Id;
    const char *Date;
    const char *v_Number;
    const char *Numeration;
    const char *Amount_net;
    const char *Amount_vat;
    const char *Amount_gross;
    const char *Use_gross_prices;
    const char *v_Type;
    const char *Description;
    const char *Rc_center;
    const char *Created_at;
    const char *Updated_at;
    const char *Payment_accountId;
    const char *Name;
    const char *Payment_accountType;
    const char *Iban;
    const char *Sia;
    const char *Cuc;
    const char *v_Virtual;
    int i;
    int count_i;

    // 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,"fields","<string>");
    CkJsonObject_UpdateString(queryParams,"fieldset","basic");

    // 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/receipts/:document_id",queryParams);
    if (CkHttp_getLastMethodSuccess(http) == FALSE) {
        printf("%s\n",CkHttp_lastErrorText(http));
        CkHttp_Dispose(http);
        CkJsonObject_Dispose(queryParams);
        return;
    }

    sbResponseBody = CkStringBuilder_Create();
    CkHttpResponse_GetBodySb(resp,sbResponseBody);

    jResp = CkJsonObject_Create();
    CkJsonObject_LoadSb(jResp,sbResponseBody);
    CkJsonObject_putEmitCompact(jResp,FALSE);

    printf("Response Body:\n");
    printf("%s\n",CkJsonObject_emit(jResp));

    respStatusCode = CkHttpResponse_getStatusCode(resp);
    printf("Response Status Code = %d\n",respStatusCode);
    if (respStatusCode >= 400) {
        printf("Response Header:\n");
        printf("%s\n",CkHttpResponse_header(resp));
        printf("Failed.\n");
        CkHttpResponse_Dispose(resp);
        CkHttp_Dispose(http);
        CkJsonObject_Dispose(queryParams);
        CkStringBuilder_Dispose(sbResponseBody);
        CkJsonObject_Dispose(jResp);
        return;
    }

    CkHttpResponse_Dispose(resp);

    // Sample JSON response:
    // (Sample code for parsing the JSON response is shown below)

    // {
    //   "data": {
    //     "id": "<integer>",
    //     "date": "<date>",
    //     "number": "<number>",
    //     "numeration": "<string>",
    //     "amount_net": "<number>",
    //     "amount_vat": "<number>",
    //     "amount_gross": "<number>",
    //     "use_gross_prices": "<boolean>",
    //     "type": "till_receipt",
    //     "description": "<string>",
    //     "rc_center": "<string>",
    //     "created_at": "<string>",
    //     "updated_at": "<string>",
    //     "payment_account": {
    //       "id": "<integer>",
    //       "name": "<string>",
    //       "type": "standard",
    //       "iban": "<string>",
    //       "sia": "<string>",
    //       "cuc": "<string>",
    //       "virtual": "<boolean>"
    //     },
    //     "items_list": [
    //       {
    //         "id": "<integer>",
    //         "amount_net": "<number>",
    //         "amount_gross": "<number>",
    //         "category": "<string>",
    //         "vat": {
    //           "id": "<integer>",
    //           "value": "<number>",
    //           "description": "<string>",
    //           "notes": "<string>",
    //           "e_invoice": "<boolean>",
    //           "ei_type": "<string>",
    //           "ei_description": "<string>",
    //           "editable": "<boolean>",
    //           "is_disabled": "<boolean>"
    //         }
    //       },
    //       {
    //         "id": "<integer>",
    //         "amount_net": "<number>",
    //         "amount_gross": "<number>",
    //         "category": "<string>",
    //         "vat": {
    //           "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.

    Id = CkJsonObject_stringOf(jResp,"data.id");
    Date = CkJsonObject_stringOf(jResp,"data.date");
    v_Number = CkJsonObject_stringOf(jResp,"data.number");
    Numeration = CkJsonObject_stringOf(jResp,"data.numeration");
    Amount_net = CkJsonObject_stringOf(jResp,"data.amount_net");
    Amount_vat = CkJsonObject_stringOf(jResp,"data.amount_vat");
    Amount_gross = CkJsonObject_stringOf(jResp,"data.amount_gross");
    Use_gross_prices = CkJsonObject_stringOf(jResp,"data.use_gross_prices");
    v_Type = CkJsonObject_stringOf(jResp,"data.type");
    Description = CkJsonObject_stringOf(jResp,"data.description");
    Rc_center = CkJsonObject_stringOf(jResp,"data.rc_center");
    Created_at = CkJsonObject_stringOf(jResp,"data.created_at");
    Updated_at = CkJsonObject_stringOf(jResp,"data.updated_at");
    Payment_accountId = CkJsonObject_stringOf(jResp,"data.payment_account.id");
    Name = CkJsonObject_stringOf(jResp,"data.payment_account.name");
    Payment_accountType = CkJsonObject_stringOf(jResp,"data.payment_account.type");
    Iban = CkJsonObject_stringOf(jResp,"data.payment_account.iban");
    Sia = CkJsonObject_stringOf(jResp,"data.payment_account.sia");
    Cuc = CkJsonObject_stringOf(jResp,"data.payment_account.cuc");
    v_Virtual = CkJsonObject_stringOf(jResp,"data.payment_account.virtual");
    i = 0;
    count_i = CkJsonObject_SizeOfArray(jResp,"data.items_list");
    while (i < count_i) {
        CkJsonObject_putI(jResp,i);
        id = CkJsonObject_stringOf(jResp,"data.items_list[i].id");
        amount_net = CkJsonObject_stringOf(jResp,"data.items_list[i].amount_net");
        amount_gross = CkJsonObject_stringOf(jResp,"data.items_list[i].amount_gross");
        category = CkJsonObject_stringOf(jResp,"data.items_list[i].category");
        vatId = CkJsonObject_stringOf(jResp,"data.items_list[i].vat.id");
        Value = CkJsonObject_stringOf(jResp,"data.items_list[i].vat.value");
        vatDescription = CkJsonObject_stringOf(jResp,"data.items_list[i].vat.description");
        Notes = CkJsonObject_stringOf(jResp,"data.items_list[i].vat.notes");
        E_invoice = CkJsonObject_stringOf(jResp,"data.items_list[i].vat.e_invoice");
        Ei_type = CkJsonObject_stringOf(jResp,"data.items_list[i].vat.ei_type");
        Ei_description = CkJsonObject_stringOf(jResp,"data.items_list[i].vat.ei_description");
        Editable = CkJsonObject_stringOf(jResp,"data.items_list[i].vat.editable");
        Is_disabled = CkJsonObject_stringOf(jResp,"data.items_list[i].vat.is_disabled");
        i = i + 1;
    }



    CkHttp_Dispose(http);
    CkJsonObject_Dispose(queryParams);
    CkStringBuilder_Dispose(sbResponseBody);
    CkJsonObject_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/receipts/:document_id

Postman Collection Item JSON

{
  "name": "Get Receipt",
  "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/receipts/:document_id?fields=<string>&fieldset=basic",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "c",
        ":company_id",
        "receipts",
        ":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": "<integer>"
        }
      ]
    },
    "description": "Gets the specified receipt."
  },
  "response": [
    {
      "name": "Receipt Details.",
      "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/receipts/:document_id?fields=<string>&fieldset=basic",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "c",
            ":company_id",
            "receipts",
            ":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\": \"<integer>\",\n    \"date\": \"<date>\",\n    \"number\": \"<number>\",\n    \"numeration\": \"<string>\",\n    \"amount_net\": \"<number>\",\n    \"amount_vat\": \"<number>\",\n    \"amount_gross\": \"<number>\",\n    \"use_gross_prices\": \"<boolean>\",\n    \"type\": \"till_receipt\",\n    \"description\": \"<string>\",\n    \"rc_center\": \"<string>\",\n    \"created_at\": \"<string>\",\n    \"updated_at\": \"<string>\",\n    \"payment_account\": {\n      \"id\": \"<integer>\",\n      \"name\": \"<string>\",\n      \"type\": \"standard\",\n      \"iban\": \"<string>\",\n      \"sia\": \"<string>\",\n      \"cuc\": \"<string>\",\n      \"virtual\": \"<boolean>\"\n    },\n    \"items_list\": [\n      {\n        \"id\": \"<integer>\",\n        \"amount_net\": \"<number>\",\n        \"amount_gross\": \"<number>\",\n        \"category\": \"<string>\",\n        \"vat\": {\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        \"id\": \"<integer>\",\n        \"amount_net\": \"<number>\",\n        \"amount_gross\": \"<number>\",\n        \"category\": \"<string>\",\n        \"vat\": {\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  }\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/receipts/:document_id?fields=<string>&fieldset=basic",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "c",
            ":company_id",
            "receipts",
            ":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/receipts/:document_id?fields=<string>&fieldset=basic",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "c",
            ":company_id",
            "receipts",
            ":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": ""
    }
  ]
}