Chilkat Tools

delphiDll / Fatture in Cloud API v2 - API Reference / List Clients

var
http: HCkHttp;
success: Boolean;
queryParams: HCkJsonObject;
resp: HCkHttpResponse;
sbResponseBody: HCkStringBuilder;
jResp: HCkJsonObject;
respStatusCode: Integer;
id: PWideChar;
code: PWideChar;
name: PWideChar;
v_type: PWideChar;
first_name: PWideChar;
last_name: PWideChar;
contact_person: PWideChar;
vat_number: PWideChar;
tax_code: PWideChar;
address_street: PWideChar;
address_postal_code: PWideChar;
address_city: PWideChar;
address_province: PWideChar;
address_extra: PWideChar;
country: PWideChar;
email: PWideChar;
certified_email: PWideChar;
phone: PWideChar;
fax: PWideChar;
notes: PWideChar;
Id: PWideChar;
Value: PWideChar;
Description: PWideChar;
Notes: PWideChar;
E_invoice: PWideChar;
Ei_type: PWideChar;
Ei_description: PWideChar;
Editable: PWideChar;
Is_disabled: PWideChar;
default_payment_terms: PWideChar;
default_payment_terms_type: PWideChar;
default_payment_methodId: PWideChar;
Name: PWideChar;
v_Type: PWideChar;
Is_default: PWideChar;
Default_payment_accountId: PWideChar;
Default_payment_accountName: PWideChar;
Default_payment_accountType: PWideChar;
Iban: PWideChar;
Sia: PWideChar;
Cuc: PWideChar;
v_Virtual: PWideChar;
Bank_iban: PWideChar;
Bank_name: PWideChar;
Bank_beneficiary: PWideChar;
Ei_payment_method: PWideChar;
bank_name: PWideChar;
bank_iban: PWideChar;
bank_swift_code: PWideChar;
shipping_address: PWideChar;
e_invoice: PWideChar;
ei_code: PWideChar;
discount_highlight: PWideChar;
default_discount: PWideChar;
has_intent_declaration: PWideChar;
intent_declaration_protocol_number: PWideChar;
intent_declaration_protocol_date: PWideChar;
created_at: PWideChar;
updated_at: PWideChar;
j: Integer;
count_j: Integer;
title: PWideChar;
description: PWideChar;
current_page: PWideChar;
first_page_url: PWideChar;
from: PWideChar;
last_page: PWideChar;
last_page_url: PWideChar;
next_page_url: PWideChar;
path: PWideChar;
per_page: PWideChar;
prev_page_url: PWideChar;
v_to: PWideChar;
total: 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,'fields','<string>');
CkJsonObject_UpdateString(queryParams,'fieldset','basic');
CkJsonObject_UpdateString(queryParams,'sort','<string>');
CkJsonObject_UpdateInt(queryParams,'page',1);
CkJsonObject_UpdateInt(queryParams,'per_page',5);
CkJsonObject_UpdateString(queryParams,'q','<string>');

// 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/entities/clients',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)

// {
//   "current_page": "<integer>",
//   "first_page_url": "<uri>",
//   "from": "<integer>",
//   "last_page": "<integer>",
//   "last_page_url": "<uri>",
//   "next_page_url": "<uri>",
//   "path": "<uri>",
//   "per_page": "<integer>",
//   "prev_page_url": "<uri>",
//   "to": "<integer>",
//   "total": "<integer>",
//   "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>"
//     },
//     {
//       "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

current_page := CkJsonObject__stringOf(jResp,'current_page');
first_page_url := CkJsonObject__stringOf(jResp,'first_page_url');
from := CkJsonObject__stringOf(jResp,'from');
last_page := CkJsonObject__stringOf(jResp,'last_page');
last_page_url := CkJsonObject__stringOf(jResp,'last_page_url');
next_page_url := CkJsonObject__stringOf(jResp,'next_page_url');
path := CkJsonObject__stringOf(jResp,'path');
per_page := CkJsonObject__stringOf(jResp,'per_page');
prev_page_url := CkJsonObject__stringOf(jResp,'prev_page_url');
v_to := CkJsonObject__stringOf(jResp,'to');
total := CkJsonObject__stringOf(jResp,'total');
i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'data');
while i < count_i do
  begin
    CkJsonObject_putI(jResp,i);
    id := CkJsonObject__stringOf(jResp,'data[i].id');
    code := CkJsonObject__stringOf(jResp,'data[i].code');
    name := CkJsonObject__stringOf(jResp,'data[i].name');
    v_type := CkJsonObject__stringOf(jResp,'data[i].type');
    first_name := CkJsonObject__stringOf(jResp,'data[i].first_name');
    last_name := CkJsonObject__stringOf(jResp,'data[i].last_name');
    contact_person := CkJsonObject__stringOf(jResp,'data[i].contact_person');
    vat_number := CkJsonObject__stringOf(jResp,'data[i].vat_number');
    tax_code := CkJsonObject__stringOf(jResp,'data[i].tax_code');
    address_street := CkJsonObject__stringOf(jResp,'data[i].address_street');
    address_postal_code := CkJsonObject__stringOf(jResp,'data[i].address_postal_code');
    address_city := CkJsonObject__stringOf(jResp,'data[i].address_city');
    address_province := CkJsonObject__stringOf(jResp,'data[i].address_province');
    address_extra := CkJsonObject__stringOf(jResp,'data[i].address_extra');
    country := CkJsonObject__stringOf(jResp,'data[i].country');
    email := CkJsonObject__stringOf(jResp,'data[i].email');
    certified_email := CkJsonObject__stringOf(jResp,'data[i].certified_email');
    phone := CkJsonObject__stringOf(jResp,'data[i].phone');
    fax := CkJsonObject__stringOf(jResp,'data[i].fax');
    notes := CkJsonObject__stringOf(jResp,'data[i].notes');
    Id := CkJsonObject__stringOf(jResp,'data[i].default_vat.id');
    Value := CkJsonObject__stringOf(jResp,'data[i].default_vat.value');
    Description := CkJsonObject__stringOf(jResp,'data[i].default_vat.description');
    Notes := CkJsonObject__stringOf(jResp,'data[i].default_vat.notes');
    E_invoice := CkJsonObject__stringOf(jResp,'data[i].default_vat.e_invoice');
    Ei_type := CkJsonObject__stringOf(jResp,'data[i].default_vat.ei_type');
    Ei_description := CkJsonObject__stringOf(jResp,'data[i].default_vat.ei_description');
    Editable := CkJsonObject__stringOf(jResp,'data[i].default_vat.editable');
    Is_disabled := CkJsonObject__stringOf(jResp,'data[i].default_vat.is_disabled');
    default_payment_terms := CkJsonObject__stringOf(jResp,'data[i].default_payment_terms');
    default_payment_terms_type := CkJsonObject__stringOf(jResp,'data[i].default_payment_terms_type');
    default_payment_methodId := CkJsonObject__stringOf(jResp,'data[i].default_payment_method.id');
    Name := CkJsonObject__stringOf(jResp,'data[i].default_payment_method.name');
    v_Type := CkJsonObject__stringOf(jResp,'data[i].default_payment_method.type');
    Is_default := CkJsonObject__stringOf(jResp,'data[i].default_payment_method.is_default');
    Default_payment_accountId := CkJsonObject__stringOf(jResp,'data[i].default_payment_method.default_payment_account.id');
    Default_payment_accountName := CkJsonObject__stringOf(jResp,'data[i].default_payment_method.default_payment_account.name');
    Default_payment_accountType := CkJsonObject__stringOf(jResp,'data[i].default_payment_method.default_payment_account.type');
    Iban := CkJsonObject__stringOf(jResp,'data[i].default_payment_method.default_payment_account.iban');
    Sia := CkJsonObject__stringOf(jResp,'data[i].default_payment_method.default_payment_account.sia');
    Cuc := CkJsonObject__stringOf(jResp,'data[i].default_payment_method.default_payment_account.cuc');
    v_Virtual := CkJsonObject__stringOf(jResp,'data[i].default_payment_method.default_payment_account.virtual');
    Bank_iban := CkJsonObject__stringOf(jResp,'data[i].default_payment_method.bank_iban');
    Bank_name := CkJsonObject__stringOf(jResp,'data[i].default_payment_method.bank_name');
    Bank_beneficiary := CkJsonObject__stringOf(jResp,'data[i].default_payment_method.bank_beneficiary');
    Ei_payment_method := CkJsonObject__stringOf(jResp,'data[i].default_payment_method.ei_payment_method');
    bank_name := CkJsonObject__stringOf(jResp,'data[i].bank_name');
    bank_iban := CkJsonObject__stringOf(jResp,'data[i].bank_iban');
    bank_swift_code := CkJsonObject__stringOf(jResp,'data[i].bank_swift_code');
    shipping_address := CkJsonObject__stringOf(jResp,'data[i].shipping_address');
    e_invoice := CkJsonObject__stringOf(jResp,'data[i].e_invoice');
    ei_code := CkJsonObject__stringOf(jResp,'data[i].ei_code');
    discount_highlight := CkJsonObject__stringOf(jResp,'data[i].discount_highlight');
    default_discount := CkJsonObject__stringOf(jResp,'data[i].default_discount');
    has_intent_declaration := CkJsonObject__stringOf(jResp,'data[i].has_intent_declaration');
    intent_declaration_protocol_number := CkJsonObject__stringOf(jResp,'data[i].intent_declaration_protocol_number');
    intent_declaration_protocol_date := CkJsonObject__stringOf(jResp,'data[i].intent_declaration_protocol_date');
    created_at := CkJsonObject__stringOf(jResp,'data[i].created_at');
    updated_at := CkJsonObject__stringOf(jResp,'data[i].updated_at');
    j := 0;
    count_j := CkJsonObject_SizeOfArray(jResp,'data[i].default_payment_method.details');
    while j < count_j do
      begin
        CkJsonObject_putJ(jResp,j);
        title := CkJsonObject__stringOf(jResp,'data[i].default_payment_method.details[j].title');
        description := CkJsonObject__stringOf(jResp,'data[i].default_payment_method.details[j].description');
        j := j + 1;
      end;

    i := i + 1;
  end;

CkHttp_Dispose(http);
CkJsonObject_Dispose(queryParams);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);

Curl Command

curl -G -d "fields=%3Cstring%3E"
	-d "fieldset=basic"
	-d "sort=%3Cstring%3E"
	-d "page=1"
	-d "per_page=5"
	-d "q=%3Cstring%3E"
	-H "Authorization: Bearer <access_token>"
	-H "Accept: application/json"
https://api-v2.fattureincloud.it/c/:company_id/entities/clients

Postman Collection Item JSON

{
  "name": "List Clients",
  "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?fields=<string>&fieldset=basic&sort=<string>&page=1&per_page=5&q=<string>",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "c",
        ":company_id",
        "entities",
        "clients"
      ],
      "query": [
        {
          "key": "fields",
          "value": "<string>",
          "description": "List of comma-separated fields."
        },
        {
          "key": "fieldset",
          "value": "basic",
          "description": "Name of the fieldset."
        },
        {
          "key": "sort",
          "value": "<string>",
          "description": "List of comma-separated fields for result sorting (minus for desc sorting)."
        },
        {
          "key": "page",
          "value": "1",
          "description": "The page to retrieve."
        },
        {
          "key": "per_page",
          "value": "5",
          "description": "The size of the page."
        },
        {
          "key": "q",
          "value": "<string>",
          "description": "Query for filtering the results."
        }
      ],
      "variable": [
        {
          "key": "company_id",
          "value": "<integer>"
        }
      ]
    },
    "description": "Lists the clients."
  },
  "response": [
    {
      "name": "Example response",
      "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?fields=<string>&fieldset=basic&sort=<string>&page=1&per_page=5&q=<string>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "c",
            ":company_id",
            "entities",
            "clients"
          ],
          "query": [
            {
              "key": "fields",
              "value": "<string>",
              "description": "List of comma-separated fields."
            },
            {
              "key": "fieldset",
              "value": "basic",
              "description": "Name of the fieldset."
            },
            {
              "key": "sort",
              "value": "<string>",
              "description": "List of comma-separated fields for result sorting (minus for desc sorting)."
            },
            {
              "key": "page",
              "value": "1",
              "description": "The page to retrieve."
            },
            {
              "key": "per_page",
              "value": "5",
              "description": "The size of the page."
            },
            {
              "key": "q",
              "value": "<string>",
              "description": "Query for filtering the results."
            }
          ],
          "variable": [
            {
              "key": "company_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"current_page\": \"<integer>\",\n  \"first_page_url\": \"<uri>\",\n  \"from\": \"<integer>\",\n  \"last_page\": \"<integer>\",\n  \"last_page_url\": \"<uri>\",\n  \"next_page_url\": \"<uri>\",\n  \"path\": \"<uri>\",\n  \"per_page\": \"<integer>\",\n  \"prev_page_url\": \"<uri>\",\n  \"to\": \"<integer>\",\n  \"total\": \"<integer>\",\n  \"data\": [\n    {\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    {\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  ]\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?fields=<string>&fieldset=basic&sort=<string>&page=1&per_page=5&q=<string>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "c",
            ":company_id",
            "entities",
            "clients"
          ],
          "query": [
            {
              "key": "fields",
              "value": "<string>",
              "description": "List of comma-separated fields."
            },
            {
              "key": "fieldset",
              "value": "basic",
              "description": "Name of the fieldset."
            },
            {
              "key": "sort",
              "value": "<string>",
              "description": "List of comma-separated fields for result sorting (minus for desc sorting)."
            },
            {
              "key": "page",
              "value": "1",
              "description": "The page to retrieve."
            },
            {
              "key": "per_page",
              "value": "5",
              "description": "The size of the page."
            },
            {
              "key": "q",
              "value": "<string>",
              "description": "Query for filtering the results."
            }
          ],
          "variable": [
            {
              "key": "company_id"
            }
          ]
        }
      },
      "status": "Unauthorized",
      "code": 401,
      "_postman_previewlanguage": "text",
      "header": [
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}

Chilkat Online Tools

delphiDll / Fatture in Cloud API v2 - API Reference / List Clients

Curl Command

Postman Collection Item JSON