Back to Collection Items
var
http: TChilkatHttp;
success: Integer;
queryParams: TChilkatJsonObject;
resp: IChilkatHttpResponse;
sbResponseBody: TChilkatStringBuilder;
jResp: TChilkatJsonObject;
respStatusCode: Integer;
title: WideString;
description: WideString;
Id: WideString;
Code: WideString;
Name: WideString;
v_Type: WideString;
First_name: WideString;
Last_name: WideString;
Contact_person: WideString;
Vat_number: WideString;
Tax_code: WideString;
Address_street: WideString;
Address_postal_code: WideString;
Address_city: WideString;
Address_province: WideString;
Address_extra: WideString;
Country: WideString;
v_Email: WideString;
Certified_email: WideString;
Phone: WideString;
Fax: WideString;
Notes: WideString;
Default_vatId: WideString;
Value: WideString;
Description: WideString;
Default_vatNotes: WideString;
E_invoice: WideString;
Ei_type: WideString;
Ei_description: WideString;
Editable: WideString;
Is_disabled: WideString;
Default_payment_terms: WideString;
Default_payment_terms_type: WideString;
Default_payment_methodId: WideString;
Default_payment_methodName: WideString;
Default_payment_methodType: WideString;
Is_default: WideString;
Default_payment_accountId: WideString;
Default_payment_accountName: WideString;
Default_payment_accountType: WideString;
Iban: WideString;
Sia: WideString;
Cuc: WideString;
v_Virtual: WideString;
Bank_iban: WideString;
Bank_name: WideString;
Bank_beneficiary: WideString;
Ei_payment_method: WideString;
dataBank_name: WideString;
dataBank_iban: WideString;
Bank_swift_code: WideString;
Shipping_address: WideString;
dataE_invoice: WideString;
Ei_code: WideString;
Discount_highlight: WideString;
Default_discount: WideString;
Has_intent_declaration: WideString;
Intent_declaration_protocol_number: WideString;
Intent_declaration_protocol_date: WideString;
Created_at: WideString;
Updated_at: WideString;
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 := TChilkatHttp.Create(Self);
queryParams := TChilkatJsonObject.Create(Self);
queryParams.UpdateString('fields','<string>');
queryParams.UpdateString('fieldset','basic');
// Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken := '<access_token>';
http.SetRequestHeader('Accept','application/json');
resp := http.QuickRequestParams('GET','https://api-v2.fattureincloud.it/c/:company_id/entities/clients/:client_id',queryParams.ControlInterface);
if (http.LastMethodSuccess = 0) then
begin
Memo1.Lines.Add(http.LastErrorText);
Exit;
end;
sbResponseBody := TChilkatStringBuilder.Create(Self);
resp.GetBodySb(sbResponseBody.ControlInterface);
jResp := TChilkatJsonObject.Create(Self);
jResp.LoadSb(sbResponseBody.ControlInterface);
jResp.EmitCompact := 0;
Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(jResp.Emit());
respStatusCode := resp.StatusCode;
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
begin
Memo1.Lines.Add('Response Header:');
Memo1.Lines.Add(resp.Header);
Memo1.Lines.Add('Failed.');
Exit;
end;
// 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
Id := jResp.StringOf('data.id');
Code := jResp.StringOf('data.code');
Name := jResp.StringOf('data.name');
v_Type := jResp.StringOf('data.type');
First_name := jResp.StringOf('data.first_name');
Last_name := jResp.StringOf('data.last_name');
Contact_person := jResp.StringOf('data.contact_person');
Vat_number := jResp.StringOf('data.vat_number');
Tax_code := jResp.StringOf('data.tax_code');
Address_street := jResp.StringOf('data.address_street');
Address_postal_code := jResp.StringOf('data.address_postal_code');
Address_city := jResp.StringOf('data.address_city');
Address_province := jResp.StringOf('data.address_province');
Address_extra := jResp.StringOf('data.address_extra');
Country := jResp.StringOf('data.country');
v_Email := jResp.StringOf('data.email');
Certified_email := jResp.StringOf('data.certified_email');
Phone := jResp.StringOf('data.phone');
Fax := jResp.StringOf('data.fax');
Notes := jResp.StringOf('data.notes');
Default_vatId := jResp.StringOf('data.default_vat.id');
Value := jResp.StringOf('data.default_vat.value');
Description := jResp.StringOf('data.default_vat.description');
Default_vatNotes := jResp.StringOf('data.default_vat.notes');
E_invoice := jResp.StringOf('data.default_vat.e_invoice');
Ei_type := jResp.StringOf('data.default_vat.ei_type');
Ei_description := jResp.StringOf('data.default_vat.ei_description');
Editable := jResp.StringOf('data.default_vat.editable');
Is_disabled := jResp.StringOf('data.default_vat.is_disabled');
Default_payment_terms := jResp.StringOf('data.default_payment_terms');
Default_payment_terms_type := jResp.StringOf('data.default_payment_terms_type');
Default_payment_methodId := jResp.StringOf('data.default_payment_method.id');
Default_payment_methodName := jResp.StringOf('data.default_payment_method.name');
Default_payment_methodType := jResp.StringOf('data.default_payment_method.type');
Is_default := jResp.StringOf('data.default_payment_method.is_default');
Default_payment_accountId := jResp.StringOf('data.default_payment_method.default_payment_account.id');
Default_payment_accountName := jResp.StringOf('data.default_payment_method.default_payment_account.name');
Default_payment_accountType := jResp.StringOf('data.default_payment_method.default_payment_account.type');
Iban := jResp.StringOf('data.default_payment_method.default_payment_account.iban');
Sia := jResp.StringOf('data.default_payment_method.default_payment_account.sia');
Cuc := jResp.StringOf('data.default_payment_method.default_payment_account.cuc');
v_Virtual := jResp.StringOf('data.default_payment_method.default_payment_account.virtual');
Bank_iban := jResp.StringOf('data.default_payment_method.bank_iban');
Bank_name := jResp.StringOf('data.default_payment_method.bank_name');
Bank_beneficiary := jResp.StringOf('data.default_payment_method.bank_beneficiary');
Ei_payment_method := jResp.StringOf('data.default_payment_method.ei_payment_method');
dataBank_name := jResp.StringOf('data.bank_name');
dataBank_iban := jResp.StringOf('data.bank_iban');
Bank_swift_code := jResp.StringOf('data.bank_swift_code');
Shipping_address := jResp.StringOf('data.shipping_address');
dataE_invoice := jResp.StringOf('data.e_invoice');
Ei_code := jResp.StringOf('data.ei_code');
Discount_highlight := jResp.StringOf('data.discount_highlight');
Default_discount := jResp.StringOf('data.default_discount');
Has_intent_declaration := jResp.StringOf('data.has_intent_declaration');
Intent_declaration_protocol_number := jResp.StringOf('data.intent_declaration_protocol_number');
Intent_declaration_protocol_date := jResp.StringOf('data.intent_declaration_protocol_date');
Created_at := jResp.StringOf('data.created_at');
Updated_at := jResp.StringOf('data.updated_at');
i := 0;
count_i := jResp.SizeOfArray('data.default_payment_method.details');
while i < count_i do
begin
jResp.I := i;
title := jResp.StringOf('data.default_payment_method.details[i].title');
description := jResp.StringOf('data.default_payment_method.details[i].description');
i := i + 1;
end;
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": ""
}
]
}
