Chilkat Online Tools

unicodeC / Fatture in Cloud API v2 - API Reference / Get Client

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 *title;
    const wchar_t *description;
    const wchar_t *Id;
    const wchar_t *Code;
    const wchar_t *Name;
    const wchar_t *v_Type;
    const wchar_t *First_name;
    const wchar_t *Last_name;
    const wchar_t *Contact_person;
    const wchar_t *Vat_number;
    const wchar_t *Tax_code;
    const wchar_t *Address_street;
    const wchar_t *Address_postal_code;
    const wchar_t *Address_city;
    const wchar_t *Address_province;
    const wchar_t *Address_extra;
    const wchar_t *Country;
    const wchar_t *v_Email;
    const wchar_t *Certified_email;
    const wchar_t *Phone;
    const wchar_t *Fax;
    const wchar_t *Notes;
    const wchar_t *Default_vatId;
    const wchar_t *Value;
    const wchar_t *Description;
    const wchar_t *Default_vatNotes;
    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 *Default_payment_terms;
    const wchar_t *Default_payment_terms_type;
    const wchar_t *Default_payment_methodId;
    const wchar_t *Default_payment_methodName;
    const wchar_t *Default_payment_methodType;
    const wchar_t *Is_default;
    const wchar_t *Default_payment_accountId;
    const wchar_t *Default_payment_accountName;
    const wchar_t *Default_payment_accountType;
    const wchar_t *Iban;
    const wchar_t *Sia;
    const wchar_t *Cuc;
    const wchar_t *v_Virtual;
    const wchar_t *Bank_iban;
    const wchar_t *Bank_name;
    const wchar_t *Bank_beneficiary;
    const wchar_t *Ei_payment_method;
    const wchar_t *dataBank_name;
    const wchar_t *dataBank_iban;
    const wchar_t *Bank_swift_code;
    const wchar_t *Shipping_address;
    const wchar_t *dataE_invoice;
    const wchar_t *Ei_code;
    const wchar_t *Discount_highlight;
    const wchar_t *Default_discount;
    const wchar_t *Has_intent_declaration;
    const wchar_t *Intent_declaration_protocol_number;
    const wchar_t *Intent_declaration_protocol_date;
    const wchar_t *Created_at;
    const wchar_t *Updated_at;
    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"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/entities/clients/:client_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": "<integer>",
    //     "code": "<string>",
    //     "name": "<string>",
    //     "type": null,
    //     "first_name": "<string>",
    //     "last_name": "<string>",
    //     "contact_person": "<string>",
    //     "vat_number": "<string>",
    //     "tax_code": "<string>",
    //     "address_street": "<string>",
    //     "address_postal_code": "<string>",
    //     "address_city": "<string>",
    //     "address_province": "<string>",
    //     "address_extra": "<string>",
    //     "country": "<string>",
    //     "email": "<string>",
    //     "certified_email": "<string>",
    //     "phone": "<string>",
    //     "fax": "<string>",
    //     "notes": "<string>",
    //     "default_vat": {
    //       "id": "<integer>",
    //       "value": "<number>",
    //       "description": "<string>",
    //       "notes": "<string>",
    //       "e_invoice": "<boolean>",
    //       "ei_type": "<string>",
    //       "ei_description": "<string>",
    //       "editable": "<boolean>",
    //       "is_disabled": "<boolean>"
    //     },
    //     "default_payment_terms": "<integer>",
    //     "default_payment_terms_type": "standard",
    //     "default_payment_method": {
    //       "id": "<integer>",
    //       "name": "<string>",
    //       "type": "standard",
    //       "is_default": "<boolean>",
    //       "default_payment_account": {
    //         "id": "<integer>",
    //         "name": "<string>",
    //         "type": "standard",
    //         "iban": "<string>",
    //         "sia": "<string>",
    //         "cuc": "<string>",
    //         "virtual": "<boolean>"
    //       },
    //       "details": [
    //         {
    //           "title": "<string>",
    //           "description": "<string>"
    //         },
    //         {
    //           "title": "<string>",
    //           "description": "<string>"
    //         }
    //       ],
    //       "bank_iban": "<string>",
    //       "bank_name": "<string>",
    //       "bank_beneficiary": "<string>",
    //       "ei_payment_method": "<string>"
    //     },
    //     "bank_name": "<string>",
    //     "bank_iban": "<string>",
    //     "bank_swift_code": "<string>",
    //     "shipping_address": "<string>",
    //     "e_invoice": "<boolean>",
    //     "ei_code": "<string>",
    //     "discount_highlight": "<boolean>",
    //     "default_discount": "<number>",
    //     "has_intent_declaration": "<boolean>",
    //     "intent_declaration_protocol_number": "<string>",
    //     "intent_declaration_protocol_date": "<date>",
    //     "created_at": "<string>",
    //     "updated_at": "<string>"
    //   }
    // }

    // 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");
    Code = CkJsonObjectW_stringOf(jResp,L"data.code");
    Name = CkJsonObjectW_stringOf(jResp,L"data.name");
    v_Type = CkJsonObjectW_stringOf(jResp,L"data.type");
    First_name = CkJsonObjectW_stringOf(jResp,L"data.first_name");
    Last_name = CkJsonObjectW_stringOf(jResp,L"data.last_name");
    Contact_person = CkJsonObjectW_stringOf(jResp,L"data.contact_person");
    Vat_number = CkJsonObjectW_stringOf(jResp,L"data.vat_number");
    Tax_code = CkJsonObjectW_stringOf(jResp,L"data.tax_code");
    Address_street = CkJsonObjectW_stringOf(jResp,L"data.address_street");
    Address_postal_code = CkJsonObjectW_stringOf(jResp,L"data.address_postal_code");
    Address_city = CkJsonObjectW_stringOf(jResp,L"data.address_city");
    Address_province = CkJsonObjectW_stringOf(jResp,L"data.address_province");
    Address_extra = CkJsonObjectW_stringOf(jResp,L"data.address_extra");
    Country = CkJsonObjectW_stringOf(jResp,L"data.country");
    v_Email = CkJsonObjectW_stringOf(jResp,L"data.email");
    Certified_email = CkJsonObjectW_stringOf(jResp,L"data.certified_email");
    Phone = CkJsonObjectW_stringOf(jResp,L"data.phone");
    Fax = CkJsonObjectW_stringOf(jResp,L"data.fax");
    Notes = CkJsonObjectW_stringOf(jResp,L"data.notes");
    Default_vatId = CkJsonObjectW_stringOf(jResp,L"data.default_vat.id");
    Value = CkJsonObjectW_stringOf(jResp,L"data.default_vat.value");
    Description = CkJsonObjectW_stringOf(jResp,L"data.default_vat.description");
    Default_vatNotes = CkJsonObjectW_stringOf(jResp,L"data.default_vat.notes");
    E_invoice = CkJsonObjectW_stringOf(jResp,L"data.default_vat.e_invoice");
    Ei_type = CkJsonObjectW_stringOf(jResp,L"data.default_vat.ei_type");
    Ei_description = CkJsonObjectW_stringOf(jResp,L"data.default_vat.ei_description");
    Editable = CkJsonObjectW_stringOf(jResp,L"data.default_vat.editable");
    Is_disabled = CkJsonObjectW_stringOf(jResp,L"data.default_vat.is_disabled");
    Default_payment_terms = CkJsonObjectW_stringOf(jResp,L"data.default_payment_terms");
    Default_payment_terms_type = CkJsonObjectW_stringOf(jResp,L"data.default_payment_terms_type");
    Default_payment_methodId = CkJsonObjectW_stringOf(jResp,L"data.default_payment_method.id");
    Default_payment_methodName = CkJsonObjectW_stringOf(jResp,L"data.default_payment_method.name");
    Default_payment_methodType = CkJsonObjectW_stringOf(jResp,L"data.default_payment_method.type");
    Is_default = CkJsonObjectW_stringOf(jResp,L"data.default_payment_method.is_default");
    Default_payment_accountId = CkJsonObjectW_stringOf(jResp,L"data.default_payment_method.default_payment_account.id");
    Default_payment_accountName = CkJsonObjectW_stringOf(jResp,L"data.default_payment_method.default_payment_account.name");
    Default_payment_accountType = CkJsonObjectW_stringOf(jResp,L"data.default_payment_method.default_payment_account.type");
    Iban = CkJsonObjectW_stringOf(jResp,L"data.default_payment_method.default_payment_account.iban");
    Sia = CkJsonObjectW_stringOf(jResp,L"data.default_payment_method.default_payment_account.sia");
    Cuc = CkJsonObjectW_stringOf(jResp,L"data.default_payment_method.default_payment_account.cuc");
    v_Virtual = CkJsonObjectW_stringOf(jResp,L"data.default_payment_method.default_payment_account.virtual");
    Bank_iban = CkJsonObjectW_stringOf(jResp,L"data.default_payment_method.bank_iban");
    Bank_name = CkJsonObjectW_stringOf(jResp,L"data.default_payment_method.bank_name");
    Bank_beneficiary = CkJsonObjectW_stringOf(jResp,L"data.default_payment_method.bank_beneficiary");
    Ei_payment_method = CkJsonObjectW_stringOf(jResp,L"data.default_payment_method.ei_payment_method");
    dataBank_name = CkJsonObjectW_stringOf(jResp,L"data.bank_name");
    dataBank_iban = CkJsonObjectW_stringOf(jResp,L"data.bank_iban");
    Bank_swift_code = CkJsonObjectW_stringOf(jResp,L"data.bank_swift_code");
    Shipping_address = CkJsonObjectW_stringOf(jResp,L"data.shipping_address");
    dataE_invoice = CkJsonObjectW_stringOf(jResp,L"data.e_invoice");
    Ei_code = CkJsonObjectW_stringOf(jResp,L"data.ei_code");
    Discount_highlight = CkJsonObjectW_stringOf(jResp,L"data.discount_highlight");
    Default_discount = CkJsonObjectW_stringOf(jResp,L"data.default_discount");
    Has_intent_declaration = CkJsonObjectW_stringOf(jResp,L"data.has_intent_declaration");
    Intent_declaration_protocol_number = CkJsonObjectW_stringOf(jResp,L"data.intent_declaration_protocol_number");
    Intent_declaration_protocol_date = CkJsonObjectW_stringOf(jResp,L"data.intent_declaration_protocol_date");
    Created_at = CkJsonObjectW_stringOf(jResp,L"data.created_at");
    Updated_at = CkJsonObjectW_stringOf(jResp,L"data.updated_at");
    i = 0;
    count_i = CkJsonObjectW_SizeOfArray(jResp,L"data.default_payment_method.details");
    while (i < count_i) {
        CkJsonObjectW_putI(jResp,i);
        title = CkJsonObjectW_stringOf(jResp,L"data.default_payment_method.details[i].title");
        description = CkJsonObjectW_stringOf(jResp,L"data.default_payment_method.details[i].description");
        i = i + 1;
    }



    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/entities/clients/:client_id

Postman Collection Item JSON

{
  "name": "Get Client",
  "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/entities/clients/:client_id?fields=<string>&fieldset=basic",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "c",
        ":company_id",
        "entities",
        "clients",
        ":client_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": "client_id",
          "value": "<integer>"
        }
      ]
    },
    "description": "Gets the specified client."
  },
  "response": [
    {
      "name": "Client 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/entities/clients/:client_id?fields=<string>&fieldset=basic",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "c",
            ":company_id",
            "entities",
            "clients",
            ":client_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": "client_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"data\": {\n    \"id\": \"<integer>\",\n    \"code\": \"<string>\",\n    \"name\": \"<string>\",\n    \"type\": null,\n    \"first_name\": \"<string>\",\n    \"last_name\": \"<string>\",\n    \"contact_person\": \"<string>\",\n    \"vat_number\": \"<string>\",\n    \"tax_code\": \"<string>\",\n    \"address_street\": \"<string>\",\n    \"address_postal_code\": \"<string>\",\n    \"address_city\": \"<string>\",\n    \"address_province\": \"<string>\",\n    \"address_extra\": \"<string>\",\n    \"country\": \"<string>\",\n    \"email\": \"<string>\",\n    \"certified_email\": \"<string>\",\n    \"phone\": \"<string>\",\n    \"fax\": \"<string>\",\n    \"notes\": \"<string>\",\n    \"default_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    \"default_payment_terms\": \"<integer>\",\n    \"default_payment_terms_type\": \"standard\",\n    \"default_payment_method\": {\n      \"id\": \"<integer>\",\n      \"name\": \"<string>\",\n      \"type\": \"standard\",\n      \"is_default\": \"<boolean>\",\n      \"default_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      \"details\": [\n        {\n          \"title\": \"<string>\",\n          \"description\": \"<string>\"\n        },\n        {\n          \"title\": \"<string>\",\n          \"description\": \"<string>\"\n        }\n      ],\n      \"bank_iban\": \"<string>\",\n      \"bank_name\": \"<string>\",\n      \"bank_beneficiary\": \"<string>\",\n      \"ei_payment_method\": \"<string>\"\n    },\n    \"bank_name\": \"<string>\",\n    \"bank_iban\": \"<string>\",\n    \"bank_swift_code\": \"<string>\",\n    \"shipping_address\": \"<string>\",\n    \"e_invoice\": \"<boolean>\",\n    \"ei_code\": \"<string>\",\n    \"discount_highlight\": \"<boolean>\",\n    \"default_discount\": \"<number>\",\n    \"has_intent_declaration\": \"<boolean>\",\n    \"intent_declaration_protocol_number\": \"<string>\",\n    \"intent_declaration_protocol_date\": \"<date>\",\n    \"created_at\": \"<string>\",\n    \"updated_at\": \"<string>\"\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/entities/clients/:client_id?fields=<string>&fieldset=basic",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "c",
            ":company_id",
            "entities",
            "clients",
            ":client_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": "client_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/entities/clients/:client_id?fields=<string>&fieldset=basic",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "c",
            ":company_id",
            "entities",
            "clients",
            ":client_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": "client_id"
            }
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_postman_previewlanguage": "text",
      "header": [
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}