Back to Collection Items
load ./chilkat.dll
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
set http [new_CkHttp]
set queryParams [new_CkJsonObject]
CkJsonObject_UpdateString $queryParams "fields" "<string>"
CkJsonObject_UpdateString $queryParams "fieldset" "basic"
# Adds the "Authorization: Bearer <access_token>" header.
CkHttp_put_AuthToken $http "<access_token>"
CkHttp_SetRequestHeader $http "Accept" "application/json"
# resp is a CkHttpResponse
set resp [CkHttp_QuickRequestParams $http "GET" "https://api-v2.fattureincloud.it/c/:company_id/entities/clients/:client_id" $queryParams]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
delete_CkJsonObject $queryParams
exit
}
set sbResponseBody [new_CkStringBuilder]
CkHttpResponse_GetBodySb $resp $sbResponseBody
set jResp [new_CkJsonObject]
CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0
puts "Response Body:"
puts [CkJsonObject_emit $jResp]
set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
puts "Response Header:"
puts [CkHttpResponse_header $resp]
puts "Failed."
delete_CkHttpResponse $resp
delete_CkHttp $http
delete_CkJsonObject $queryParams
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
exit
}
delete_CkHttpResponse $resp
# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)
# {
# "data": {
# "id": "<integer>",
# "code": "<string>",
# "name": "<string>",
# "type": null,
# "first_name": "<string>",
# "last_name": "<string>",
# "contact_person": "<string>",
# "vat_number": "<string>",
# "tax_code": "<string>",
# "address_street": "<string>",
# "address_postal_code": "<string>",
# "address_city": "<string>",
# "address_province": "<string>",
# "address_extra": "<string>",
# "country": "<string>",
# "email": "<string>",
# "certified_email": "<string>",
# "phone": "<string>",
# "fax": "<string>",
# "notes": "<string>",
# "default_vat": {
# "id": "<integer>",
# "value": "<number>",
# "description": "<string>",
# "notes": "<string>",
# "e_invoice": "<boolean>",
# "ei_type": "<string>",
# "ei_description": "<string>",
# "editable": "<boolean>",
# "is_disabled": "<boolean>"
# },
# "default_payment_terms": "<integer>",
# "default_payment_terms_type": "standard",
# "default_payment_method": {
# "id": "<integer>",
# "name": "<string>",
# "type": "standard",
# "is_default": "<boolean>",
# "default_payment_account": {
# "id": "<integer>",
# "name": "<string>",
# "type": "standard",
# "iban": "<string>",
# "sia": "<string>",
# "cuc": "<string>",
# "virtual": "<boolean>"
# },
# "details": [
# {
# "title": "<string>",
# "description": "<string>"
# },
# {
# "title": "<string>",
# "description": "<string>"
# }
# ],
# "bank_iban": "<string>",
# "bank_name": "<string>",
# "bank_beneficiary": "<string>",
# "ei_payment_method": "<string>"
# },
# "bank_name": "<string>",
# "bank_iban": "<string>",
# "bank_swift_code": "<string>",
# "shipping_address": "<string>",
# "e_invoice": "<boolean>",
# "ei_code": "<string>",
# "discount_highlight": "<boolean>",
# "default_discount": "<number>",
# "has_intent_declaration": "<boolean>",
# "intent_declaration_protocol_number": "<string>",
# "intent_declaration_protocol_date": "<date>",
# "created_at": "<string>",
# "updated_at": "<string>"
# }
# }
# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
set Id [CkJsonObject_stringOf $jResp "data.id"]
set Code [CkJsonObject_stringOf $jResp "data.code"]
set Name [CkJsonObject_stringOf $jResp "data.name"]
set v_Type [CkJsonObject_stringOf $jResp "data.type"]
set First_name [CkJsonObject_stringOf $jResp "data.first_name"]
set Last_name [CkJsonObject_stringOf $jResp "data.last_name"]
set Contact_person [CkJsonObject_stringOf $jResp "data.contact_person"]
set Vat_number [CkJsonObject_stringOf $jResp "data.vat_number"]
set Tax_code [CkJsonObject_stringOf $jResp "data.tax_code"]
set Address_street [CkJsonObject_stringOf $jResp "data.address_street"]
set Address_postal_code [CkJsonObject_stringOf $jResp "data.address_postal_code"]
set Address_city [CkJsonObject_stringOf $jResp "data.address_city"]
set Address_province [CkJsonObject_stringOf $jResp "data.address_province"]
set Address_extra [CkJsonObject_stringOf $jResp "data.address_extra"]
set Country [CkJsonObject_stringOf $jResp "data.country"]
set v_Email [CkJsonObject_stringOf $jResp "data.email"]
set Certified_email [CkJsonObject_stringOf $jResp "data.certified_email"]
set Phone [CkJsonObject_stringOf $jResp "data.phone"]
set Fax [CkJsonObject_stringOf $jResp "data.fax"]
set Notes [CkJsonObject_stringOf $jResp "data.notes"]
set Default_vatId [CkJsonObject_stringOf $jResp "data.default_vat.id"]
set Value [CkJsonObject_stringOf $jResp "data.default_vat.value"]
set Description [CkJsonObject_stringOf $jResp "data.default_vat.description"]
set Default_vatNotes [CkJsonObject_stringOf $jResp "data.default_vat.notes"]
set E_invoice [CkJsonObject_stringOf $jResp "data.default_vat.e_invoice"]
set Ei_type [CkJsonObject_stringOf $jResp "data.default_vat.ei_type"]
set Ei_description [CkJsonObject_stringOf $jResp "data.default_vat.ei_description"]
set Editable [CkJsonObject_stringOf $jResp "data.default_vat.editable"]
set Is_disabled [CkJsonObject_stringOf $jResp "data.default_vat.is_disabled"]
set Default_payment_terms [CkJsonObject_stringOf $jResp "data.default_payment_terms"]
set Default_payment_terms_type [CkJsonObject_stringOf $jResp "data.default_payment_terms_type"]
set Default_payment_methodId [CkJsonObject_stringOf $jResp "data.default_payment_method.id"]
set Default_payment_methodName [CkJsonObject_stringOf $jResp "data.default_payment_method.name"]
set Default_payment_methodType [CkJsonObject_stringOf $jResp "data.default_payment_method.type"]
set Is_default [CkJsonObject_stringOf $jResp "data.default_payment_method.is_default"]
set Default_payment_accountId [CkJsonObject_stringOf $jResp "data.default_payment_method.default_payment_account.id"]
set Default_payment_accountName [CkJsonObject_stringOf $jResp "data.default_payment_method.default_payment_account.name"]
set Default_payment_accountType [CkJsonObject_stringOf $jResp "data.default_payment_method.default_payment_account.type"]
set Iban [CkJsonObject_stringOf $jResp "data.default_payment_method.default_payment_account.iban"]
set Sia [CkJsonObject_stringOf $jResp "data.default_payment_method.default_payment_account.sia"]
set Cuc [CkJsonObject_stringOf $jResp "data.default_payment_method.default_payment_account.cuc"]
set v_Virtual [CkJsonObject_stringOf $jResp "data.default_payment_method.default_payment_account.virtual"]
set Bank_iban [CkJsonObject_stringOf $jResp "data.default_payment_method.bank_iban"]
set Bank_name [CkJsonObject_stringOf $jResp "data.default_payment_method.bank_name"]
set Bank_beneficiary [CkJsonObject_stringOf $jResp "data.default_payment_method.bank_beneficiary"]
set Ei_payment_method [CkJsonObject_stringOf $jResp "data.default_payment_method.ei_payment_method"]
set dataBank_name [CkJsonObject_stringOf $jResp "data.bank_name"]
set dataBank_iban [CkJsonObject_stringOf $jResp "data.bank_iban"]
set Bank_swift_code [CkJsonObject_stringOf $jResp "data.bank_swift_code"]
set Shipping_address [CkJsonObject_stringOf $jResp "data.shipping_address"]
set dataE_invoice [CkJsonObject_stringOf $jResp "data.e_invoice"]
set Ei_code [CkJsonObject_stringOf $jResp "data.ei_code"]
set Discount_highlight [CkJsonObject_stringOf $jResp "data.discount_highlight"]
set Default_discount [CkJsonObject_stringOf $jResp "data.default_discount"]
set Has_intent_declaration [CkJsonObject_stringOf $jResp "data.has_intent_declaration"]
set Intent_declaration_protocol_number [CkJsonObject_stringOf $jResp "data.intent_declaration_protocol_number"]
set Intent_declaration_protocol_date [CkJsonObject_stringOf $jResp "data.intent_declaration_protocol_date"]
set Created_at [CkJsonObject_stringOf $jResp "data.created_at"]
set Updated_at [CkJsonObject_stringOf $jResp "data.updated_at"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "data.default_payment_method.details"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set title [CkJsonObject_stringOf $jResp "data.default_payment_method.details[i].title"]
set description [CkJsonObject_stringOf $jResp "data.default_payment_method.details[i].description"]
set i [expr $i + 1]
}
delete_CkHttp $http
delete_CkJsonObject $queryParams
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
Curl Command
curl -G -d "fields=%3Cstring%3E"
-d "fieldset=basic"
-H "Authorization: Bearer <access_token>"
-H "Accept: application/json"
https://api-v2.fattureincloud.it/c/:company_id/entities/clients/:client_id
Postman Collection Item JSON
{
"name": "Get Client",
"request": {
"auth": {
"type": "oauth2",
"oauth2": [
{
"key": "scope",
"value": "entity.clients:r entity.clients:a entity.suppliers:r entity.suppliers:a products:r products:a issued_documents.invoices:r issued_documents.credit_notes:r issued_documents.receipts:r issued_documents.orders:r issued_documents.quotes:r issued_documents.proformas:r issued_documents.delivery_notes:r issued_documents.work_reports:r issued_documents.supplier_orders:r issued_documents.self_invoices:r issued_documents.invoices:a issued_documents.credit_notes:a issued_documents.receipts:a issued_documents.orders:a issued_documents.quotes:a issued_documents.proformas:a issued_documents.delivery_notes:a issued_documents.work_reports:a issued_documents.supplier_orders:a issued_documents.self_invoices:a received_documents:r received_documents:a stock:r stock:a receipts:r receipts:a taxes:r taxes:a archive:r archive:a cashbook:r cashbook:a settings:r settings:a situation:r",
"type": "string"
},
{
"key": "redirect_uri",
"value": "https://api-v2.fattureincloud.it/oauth/token",
"type": "string"
},
{
"key": "accessTokenUrl",
"value": "https://api-v2.fattureincloud.it/oauth/token",
"type": "string"
},
{
"key": "authUrl",
"value": "https://api-v2.fattureincloud.it/oauth/authorize",
"type": "string"
},
{
"key": "grant_type",
"value": "authorization_code",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/c/:company_id/entities/clients/:client_id?fields=<string>&fieldset=basic",
"host": [
"{{baseUrl}}"
],
"path": [
"c",
":company_id",
"entities",
"clients",
":client_id"
],
"query": [
{
"key": "fields",
"value": "<string>",
"description": "List of comma-separated fields."
},
{
"key": "fieldset",
"value": "basic",
"description": "Name of the fieldset."
}
],
"variable": [
{
"key": "company_id",
"value": "<integer>"
},
{
"key": "client_id",
"value": "<integer>"
}
]
},
"description": "Gets the specified client."
},
"response": [
{
"name": "Client Details.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/c/:company_id/entities/clients/:client_id?fields=<string>&fieldset=basic",
"host": [
"{{baseUrl}}"
],
"path": [
"c",
":company_id",
"entities",
"clients",
":client_id"
],
"query": [
{
"key": "fields",
"value": "<string>",
"description": "List of comma-separated fields."
},
{
"key": "fieldset",
"value": "basic",
"description": "Name of the fieldset."
}
],
"variable": [
{
"key": "company_id"
},
{
"key": "client_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"data\": {\n \"id\": \"<integer>\",\n \"code\": \"<string>\",\n \"name\": \"<string>\",\n \"type\": null,\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"contact_person\": \"<string>\",\n \"vat_number\": \"<string>\",\n \"tax_code\": \"<string>\",\n \"address_street\": \"<string>\",\n \"address_postal_code\": \"<string>\",\n \"address_city\": \"<string>\",\n \"address_province\": \"<string>\",\n \"address_extra\": \"<string>\",\n \"country\": \"<string>\",\n \"email\": \"<string>\",\n \"certified_email\": \"<string>\",\n \"phone\": \"<string>\",\n \"fax\": \"<string>\",\n \"notes\": \"<string>\",\n \"default_vat\": {\n \"id\": \"<integer>\",\n \"value\": \"<number>\",\n \"description\": \"<string>\",\n \"notes\": \"<string>\",\n \"e_invoice\": \"<boolean>\",\n \"ei_type\": \"<string>\",\n \"ei_description\": \"<string>\",\n \"editable\": \"<boolean>\",\n \"is_disabled\": \"<boolean>\"\n },\n \"default_payment_terms\": \"<integer>\",\n \"default_payment_terms_type\": \"standard\",\n \"default_payment_method\": {\n \"id\": \"<integer>\",\n \"name\": \"<string>\",\n \"type\": \"standard\",\n \"is_default\": \"<boolean>\",\n \"default_payment_account\": {\n \"id\": \"<integer>\",\n \"name\": \"<string>\",\n \"type\": \"standard\",\n \"iban\": \"<string>\",\n \"sia\": \"<string>\",\n \"cuc\": \"<string>\",\n \"virtual\": \"<boolean>\"\n },\n \"details\": [\n {\n \"title\": \"<string>\",\n \"description\": \"<string>\"\n },\n {\n \"title\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"bank_iban\": \"<string>\",\n \"bank_name\": \"<string>\",\n \"bank_beneficiary\": \"<string>\",\n \"ei_payment_method\": \"<string>\"\n },\n \"bank_name\": \"<string>\",\n \"bank_iban\": \"<string>\",\n \"bank_swift_code\": \"<string>\",\n \"shipping_address\": \"<string>\",\n \"e_invoice\": \"<boolean>\",\n \"ei_code\": \"<string>\",\n \"discount_highlight\": \"<boolean>\",\n \"default_discount\": \"<number>\",\n \"has_intent_declaration\": \"<boolean>\",\n \"intent_declaration_protocol_number\": \"<string>\",\n \"intent_declaration_protocol_date\": \"<date>\",\n \"created_at\": \"<string>\",\n \"updated_at\": \"<string>\"\n }\n}"
},
{
"name": "Unauthorized",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/c/:company_id/entities/clients/:client_id?fields=<string>&fieldset=basic",
"host": [
"{{baseUrl}}"
],
"path": [
"c",
":company_id",
"entities",
"clients",
":client_id"
],
"query": [
{
"key": "fields",
"value": "<string>",
"description": "List of comma-separated fields."
},
{
"key": "fieldset",
"value": "basic",
"description": "Name of the fieldset."
}
],
"variable": [
{
"key": "company_id"
},
{
"key": "client_id"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "text",
"header": [
],
"cookie": [
],
"body": ""
},
{
"name": "Not Found",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/c/:company_id/entities/clients/:client_id?fields=<string>&fieldset=basic",
"host": [
"{{baseUrl}}"
],
"path": [
"c",
":company_id",
"entities",
"clients",
":client_id"
],
"query": [
{
"key": "fields",
"value": "<string>",
"description": "List of comma-separated fields."
},
{
"key": "fieldset",
"value": "basic",
"description": "Name of the fieldset."
}
],
"variable": [
{
"key": "company_id"
},
{
"key": "client_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "text",
"header": [
],
"cookie": [
],
"body": ""
}
]
}
