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 *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 *email;
const wchar_t *certified_email;
const wchar_t *phone;
const wchar_t *fax;
const wchar_t *notes;
const wchar_t *Id;
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 *default_payment_terms;
const wchar_t *default_payment_terms_type;
const wchar_t *default_payment_methodId;
const wchar_t *Name;
const wchar_t *v_Type;
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 *bank_name;
const wchar_t *bank_iban;
const wchar_t *bank_swift_code;
const wchar_t *shipping_address;
const wchar_t *e_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 j;
int count_j;
const wchar_t *title;
const wchar_t *description;
const wchar_t *current_page;
const wchar_t *first_page_url;
const wchar_t *from;
const wchar_t *last_page;
const wchar_t *last_page_url;
const wchar_t *next_page_url;
const wchar_t *path;
const wchar_t *per_page;
const wchar_t *prev_page_url;
const wchar_t *v_to;
const wchar_t *total;
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");
CkJsonObjectW_UpdateString(queryParams,L"sort",L"<string>");
CkJsonObjectW_UpdateInt(queryParams,L"page",1);
CkJsonObjectW_UpdateInt(queryParams,L"per_page",5);
CkJsonObjectW_UpdateString(queryParams,L"q",L"<string>");
// 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",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)
// {
// "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
// Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.
current_page = CkJsonObjectW_stringOf(jResp,L"current_page");
first_page_url = CkJsonObjectW_stringOf(jResp,L"first_page_url");
from = CkJsonObjectW_stringOf(jResp,L"from");
last_page = CkJsonObjectW_stringOf(jResp,L"last_page");
last_page_url = CkJsonObjectW_stringOf(jResp,L"last_page_url");
next_page_url = CkJsonObjectW_stringOf(jResp,L"next_page_url");
path = CkJsonObjectW_stringOf(jResp,L"path");
per_page = CkJsonObjectW_stringOf(jResp,L"per_page");
prev_page_url = CkJsonObjectW_stringOf(jResp,L"prev_page_url");
v_to = CkJsonObjectW_stringOf(jResp,L"to");
total = CkJsonObjectW_stringOf(jResp,L"total");
i = 0;
count_i = CkJsonObjectW_SizeOfArray(jResp,L"data");
while (i < count_i) {
CkJsonObjectW_putI(jResp,i);
id = CkJsonObjectW_stringOf(jResp,L"data[i].id");
code = CkJsonObjectW_stringOf(jResp,L"data[i].code");
name = CkJsonObjectW_stringOf(jResp,L"data[i].name");
v_type = CkJsonObjectW_stringOf(jResp,L"data[i].type");
first_name = CkJsonObjectW_stringOf(jResp,L"data[i].first_name");
last_name = CkJsonObjectW_stringOf(jResp,L"data[i].last_name");
contact_person = CkJsonObjectW_stringOf(jResp,L"data[i].contact_person");
vat_number = CkJsonObjectW_stringOf(jResp,L"data[i].vat_number");
tax_code = CkJsonObjectW_stringOf(jResp,L"data[i].tax_code");
address_street = CkJsonObjectW_stringOf(jResp,L"data[i].address_street");
address_postal_code = CkJsonObjectW_stringOf(jResp,L"data[i].address_postal_code");
address_city = CkJsonObjectW_stringOf(jResp,L"data[i].address_city");
address_province = CkJsonObjectW_stringOf(jResp,L"data[i].address_province");
address_extra = CkJsonObjectW_stringOf(jResp,L"data[i].address_extra");
country = CkJsonObjectW_stringOf(jResp,L"data[i].country");
email = CkJsonObjectW_stringOf(jResp,L"data[i].email");
certified_email = CkJsonObjectW_stringOf(jResp,L"data[i].certified_email");
phone = CkJsonObjectW_stringOf(jResp,L"data[i].phone");
fax = CkJsonObjectW_stringOf(jResp,L"data[i].fax");
notes = CkJsonObjectW_stringOf(jResp,L"data[i].notes");
Id = CkJsonObjectW_stringOf(jResp,L"data[i].default_vat.id");
Value = CkJsonObjectW_stringOf(jResp,L"data[i].default_vat.value");
Description = CkJsonObjectW_stringOf(jResp,L"data[i].default_vat.description");
Notes = CkJsonObjectW_stringOf(jResp,L"data[i].default_vat.notes");
E_invoice = CkJsonObjectW_stringOf(jResp,L"data[i].default_vat.e_invoice");
Ei_type = CkJsonObjectW_stringOf(jResp,L"data[i].default_vat.ei_type");
Ei_description = CkJsonObjectW_stringOf(jResp,L"data[i].default_vat.ei_description");
Editable = CkJsonObjectW_stringOf(jResp,L"data[i].default_vat.editable");
Is_disabled = CkJsonObjectW_stringOf(jResp,L"data[i].default_vat.is_disabled");
default_payment_terms = CkJsonObjectW_stringOf(jResp,L"data[i].default_payment_terms");
default_payment_terms_type = CkJsonObjectW_stringOf(jResp,L"data[i].default_payment_terms_type");
default_payment_methodId = CkJsonObjectW_stringOf(jResp,L"data[i].default_payment_method.id");
Name = CkJsonObjectW_stringOf(jResp,L"data[i].default_payment_method.name");
v_Type = CkJsonObjectW_stringOf(jResp,L"data[i].default_payment_method.type");
Is_default = CkJsonObjectW_stringOf(jResp,L"data[i].default_payment_method.is_default");
Default_payment_accountId = CkJsonObjectW_stringOf(jResp,L"data[i].default_payment_method.default_payment_account.id");
Default_payment_accountName = CkJsonObjectW_stringOf(jResp,L"data[i].default_payment_method.default_payment_account.name");
Default_payment_accountType = CkJsonObjectW_stringOf(jResp,L"data[i].default_payment_method.default_payment_account.type");
Iban = CkJsonObjectW_stringOf(jResp,L"data[i].default_payment_method.default_payment_account.iban");
Sia = CkJsonObjectW_stringOf(jResp,L"data[i].default_payment_method.default_payment_account.sia");
Cuc = CkJsonObjectW_stringOf(jResp,L"data[i].default_payment_method.default_payment_account.cuc");
v_Virtual = CkJsonObjectW_stringOf(jResp,L"data[i].default_payment_method.default_payment_account.virtual");
Bank_iban = CkJsonObjectW_stringOf(jResp,L"data[i].default_payment_method.bank_iban");
Bank_name = CkJsonObjectW_stringOf(jResp,L"data[i].default_payment_method.bank_name");
Bank_beneficiary = CkJsonObjectW_stringOf(jResp,L"data[i].default_payment_method.bank_beneficiary");
Ei_payment_method = CkJsonObjectW_stringOf(jResp,L"data[i].default_payment_method.ei_payment_method");
bank_name = CkJsonObjectW_stringOf(jResp,L"data[i].bank_name");
bank_iban = CkJsonObjectW_stringOf(jResp,L"data[i].bank_iban");
bank_swift_code = CkJsonObjectW_stringOf(jResp,L"data[i].bank_swift_code");
shipping_address = CkJsonObjectW_stringOf(jResp,L"data[i].shipping_address");
e_invoice = CkJsonObjectW_stringOf(jResp,L"data[i].e_invoice");
ei_code = CkJsonObjectW_stringOf(jResp,L"data[i].ei_code");
discount_highlight = CkJsonObjectW_stringOf(jResp,L"data[i].discount_highlight");
default_discount = CkJsonObjectW_stringOf(jResp,L"data[i].default_discount");
has_intent_declaration = CkJsonObjectW_stringOf(jResp,L"data[i].has_intent_declaration");
intent_declaration_protocol_number = CkJsonObjectW_stringOf(jResp,L"data[i].intent_declaration_protocol_number");
intent_declaration_protocol_date = CkJsonObjectW_stringOf(jResp,L"data[i].intent_declaration_protocol_date");
created_at = CkJsonObjectW_stringOf(jResp,L"data[i].created_at");
updated_at = CkJsonObjectW_stringOf(jResp,L"data[i].updated_at");
j = 0;
count_j = CkJsonObjectW_SizeOfArray(jResp,L"data[i].default_payment_method.details");
while (j < count_j) {
CkJsonObjectW_putJ(jResp,j);
title = CkJsonObjectW_stringOf(jResp,L"data[i].default_payment_method.details[j].title");
description = CkJsonObjectW_stringOf(jResp,L"data[i].default_payment_method.details[j].description");
j = j + 1;
}
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"
-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": ""
}
]
}
