Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
queryParams.i = CkJsonObject::ckCreate()
If queryParams.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(queryParams,"fields","<string>")
CkJsonObject::ckUpdateString(queryParams,"fieldset","basic")
CkJsonObject::ckUpdateString(queryParams,"sort","<string>")
CkJsonObject::ckUpdateInt(queryParams,"page",1)
CkJsonObject::ckUpdateInt(queryParams,"per_page",5)
CkJsonObject::ckUpdateString(queryParams,"q","<string>")
; Adds the "Authorization: Bearer <access_token>" header.
CkHttp::setCkAuthToken(http, "<access_token>")
CkHttp::ckSetRequestHeader(http,"Accept","application/json")
resp.i = CkHttp::ckQuickRequestParams(http,"GET","https://api-v2.fattureincloud.it/c/:company_id/entities/clients",queryParams)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(queryParams)
ProcedureReturn
EndIf
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkHttpResponse::ckGetBodySb(resp,sbResponseBody)
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
CkJsonObject::setCkEmitCompact(jResp, 0)
Debug "Response Body:"
Debug CkJsonObject::ckEmit(jResp)
respStatusCode.i = CkHttpResponse::ckStatusCode(resp)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttpResponse::ckHeader(resp)
Debug "Failed."
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(queryParams)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
CkHttpResponse::ckDispose(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
id.s
code.s
name.s
v_type.s
first_name.s
last_name.s
contact_person.s
vat_number.s
tax_code.s
address_street.s
address_postal_code.s
address_city.s
address_province.s
address_extra.s
country.s
email.s
certified_email.s
phone.s
fax.s
notes.s
Id.s
Value.s
Description.s
Notes.s
E_invoice.s
Ei_type.s
Ei_description.s
Editable.s
Is_disabled.s
default_payment_terms.s
default_payment_terms_type.s
default_payment_methodId.s
Name.s
v_Type.s
Is_default.s
Default_payment_accountId.s
Default_payment_accountName.s
Default_payment_accountType.s
Iban.s
Sia.s
Cuc.s
v_Virtual.s
Bank_iban.s
Bank_name.s
Bank_beneficiary.s
Ei_payment_method.s
bank_name.s
bank_iban.s
bank_swift_code.s
shipping_address.s
e_invoice.s
ei_code.s
discount_highlight.s
default_discount.s
has_intent_declaration.s
intent_declaration_protocol_number.s
intent_declaration_protocol_date.s
created_at.s
updated_at.s
j.i
count_j.i
title.s
description.s
current_page.s = CkJsonObject::ckStringOf(jResp,"current_page")
first_page_url.s = CkJsonObject::ckStringOf(jResp,"first_page_url")
from.s = CkJsonObject::ckStringOf(jResp,"from")
last_page.s = CkJsonObject::ckStringOf(jResp,"last_page")
last_page_url.s = CkJsonObject::ckStringOf(jResp,"last_page_url")
next_page_url.s = CkJsonObject::ckStringOf(jResp,"next_page_url")
path.s = CkJsonObject::ckStringOf(jResp,"path")
per_page.s = CkJsonObject::ckStringOf(jResp,"per_page")
prev_page_url.s = CkJsonObject::ckStringOf(jResp,"prev_page_url")
v_to.s = CkJsonObject::ckStringOf(jResp,"to")
total.s = CkJsonObject::ckStringOf(jResp,"total")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"data")
While i < count_i
CkJsonObject::setCkI(jResp, i)
id = CkJsonObject::ckStringOf(jResp,"data[i].id")
code = CkJsonObject::ckStringOf(jResp,"data[i].code")
name = CkJsonObject::ckStringOf(jResp,"data[i].name")
v_type = CkJsonObject::ckStringOf(jResp,"data[i].type")
first_name = CkJsonObject::ckStringOf(jResp,"data[i].first_name")
last_name = CkJsonObject::ckStringOf(jResp,"data[i].last_name")
contact_person = CkJsonObject::ckStringOf(jResp,"data[i].contact_person")
vat_number = CkJsonObject::ckStringOf(jResp,"data[i].vat_number")
tax_code = CkJsonObject::ckStringOf(jResp,"data[i].tax_code")
address_street = CkJsonObject::ckStringOf(jResp,"data[i].address_street")
address_postal_code = CkJsonObject::ckStringOf(jResp,"data[i].address_postal_code")
address_city = CkJsonObject::ckStringOf(jResp,"data[i].address_city")
address_province = CkJsonObject::ckStringOf(jResp,"data[i].address_province")
address_extra = CkJsonObject::ckStringOf(jResp,"data[i].address_extra")
country = CkJsonObject::ckStringOf(jResp,"data[i].country")
email = CkJsonObject::ckStringOf(jResp,"data[i].email")
certified_email = CkJsonObject::ckStringOf(jResp,"data[i].certified_email")
phone = CkJsonObject::ckStringOf(jResp,"data[i].phone")
fax = CkJsonObject::ckStringOf(jResp,"data[i].fax")
notes = CkJsonObject::ckStringOf(jResp,"data[i].notes")
Id = CkJsonObject::ckStringOf(jResp,"data[i].default_vat.id")
Value = CkJsonObject::ckStringOf(jResp,"data[i].default_vat.value")
Description = CkJsonObject::ckStringOf(jResp,"data[i].default_vat.description")
Notes = CkJsonObject::ckStringOf(jResp,"data[i].default_vat.notes")
E_invoice = CkJsonObject::ckStringOf(jResp,"data[i].default_vat.e_invoice")
Ei_type = CkJsonObject::ckStringOf(jResp,"data[i].default_vat.ei_type")
Ei_description = CkJsonObject::ckStringOf(jResp,"data[i].default_vat.ei_description")
Editable = CkJsonObject::ckStringOf(jResp,"data[i].default_vat.editable")
Is_disabled = CkJsonObject::ckStringOf(jResp,"data[i].default_vat.is_disabled")
default_payment_terms = CkJsonObject::ckStringOf(jResp,"data[i].default_payment_terms")
default_payment_terms_type = CkJsonObject::ckStringOf(jResp,"data[i].default_payment_terms_type")
default_payment_methodId = CkJsonObject::ckStringOf(jResp,"data[i].default_payment_method.id")
Name = CkJsonObject::ckStringOf(jResp,"data[i].default_payment_method.name")
v_Type = CkJsonObject::ckStringOf(jResp,"data[i].default_payment_method.type")
Is_default = CkJsonObject::ckStringOf(jResp,"data[i].default_payment_method.is_default")
Default_payment_accountId = CkJsonObject::ckStringOf(jResp,"data[i].default_payment_method.default_payment_account.id")
Default_payment_accountName = CkJsonObject::ckStringOf(jResp,"data[i].default_payment_method.default_payment_account.name")
Default_payment_accountType = CkJsonObject::ckStringOf(jResp,"data[i].default_payment_method.default_payment_account.type")
Iban = CkJsonObject::ckStringOf(jResp,"data[i].default_payment_method.default_payment_account.iban")
Sia = CkJsonObject::ckStringOf(jResp,"data[i].default_payment_method.default_payment_account.sia")
Cuc = CkJsonObject::ckStringOf(jResp,"data[i].default_payment_method.default_payment_account.cuc")
v_Virtual = CkJsonObject::ckStringOf(jResp,"data[i].default_payment_method.default_payment_account.virtual")
Bank_iban = CkJsonObject::ckStringOf(jResp,"data[i].default_payment_method.bank_iban")
Bank_name = CkJsonObject::ckStringOf(jResp,"data[i].default_payment_method.bank_name")
Bank_beneficiary = CkJsonObject::ckStringOf(jResp,"data[i].default_payment_method.bank_beneficiary")
Ei_payment_method = CkJsonObject::ckStringOf(jResp,"data[i].default_payment_method.ei_payment_method")
bank_name = CkJsonObject::ckStringOf(jResp,"data[i].bank_name")
bank_iban = CkJsonObject::ckStringOf(jResp,"data[i].bank_iban")
bank_swift_code = CkJsonObject::ckStringOf(jResp,"data[i].bank_swift_code")
shipping_address = CkJsonObject::ckStringOf(jResp,"data[i].shipping_address")
e_invoice = CkJsonObject::ckStringOf(jResp,"data[i].e_invoice")
ei_code = CkJsonObject::ckStringOf(jResp,"data[i].ei_code")
discount_highlight = CkJsonObject::ckStringOf(jResp,"data[i].discount_highlight")
default_discount = CkJsonObject::ckStringOf(jResp,"data[i].default_discount")
has_intent_declaration = CkJsonObject::ckStringOf(jResp,"data[i].has_intent_declaration")
intent_declaration_protocol_number = CkJsonObject::ckStringOf(jResp,"data[i].intent_declaration_protocol_number")
intent_declaration_protocol_date = CkJsonObject::ckStringOf(jResp,"data[i].intent_declaration_protocol_date")
created_at = CkJsonObject::ckStringOf(jResp,"data[i].created_at")
updated_at = CkJsonObject::ckStringOf(jResp,"data[i].updated_at")
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"data[i].default_payment_method.details")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
title = CkJsonObject::ckStringOf(jResp,"data[i].default_payment_method.details[j].title")
description = CkJsonObject::ckStringOf(jResp,"data[i].default_payment_method.details[j].description")
j = j + 1
Wend
i = i + 1
Wend
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(queryParams)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
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": ""
}
]
}
