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")
; 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/:client_id",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)
; {
; "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
title.s
description.s
Id.s = CkJsonObject::ckStringOf(jResp,"data.id")
Code.s = CkJsonObject::ckStringOf(jResp,"data.code")
Name.s = CkJsonObject::ckStringOf(jResp,"data.name")
v_Type.s = CkJsonObject::ckStringOf(jResp,"data.type")
First_name.s = CkJsonObject::ckStringOf(jResp,"data.first_name")
Last_name.s = CkJsonObject::ckStringOf(jResp,"data.last_name")
Contact_person.s = CkJsonObject::ckStringOf(jResp,"data.contact_person")
Vat_number.s = CkJsonObject::ckStringOf(jResp,"data.vat_number")
Tax_code.s = CkJsonObject::ckStringOf(jResp,"data.tax_code")
Address_street.s = CkJsonObject::ckStringOf(jResp,"data.address_street")
Address_postal_code.s = CkJsonObject::ckStringOf(jResp,"data.address_postal_code")
Address_city.s = CkJsonObject::ckStringOf(jResp,"data.address_city")
Address_province.s = CkJsonObject::ckStringOf(jResp,"data.address_province")
Address_extra.s = CkJsonObject::ckStringOf(jResp,"data.address_extra")
Country.s = CkJsonObject::ckStringOf(jResp,"data.country")
v_Email.s = CkJsonObject::ckStringOf(jResp,"data.email")
Certified_email.s = CkJsonObject::ckStringOf(jResp,"data.certified_email")
Phone.s = CkJsonObject::ckStringOf(jResp,"data.phone")
Fax.s = CkJsonObject::ckStringOf(jResp,"data.fax")
Notes.s = CkJsonObject::ckStringOf(jResp,"data.notes")
Default_vatId.s = CkJsonObject::ckStringOf(jResp,"data.default_vat.id")
Value.s = CkJsonObject::ckStringOf(jResp,"data.default_vat.value")
Description.s = CkJsonObject::ckStringOf(jResp,"data.default_vat.description")
Default_vatNotes.s = CkJsonObject::ckStringOf(jResp,"data.default_vat.notes")
E_invoice.s = CkJsonObject::ckStringOf(jResp,"data.default_vat.e_invoice")
Ei_type.s = CkJsonObject::ckStringOf(jResp,"data.default_vat.ei_type")
Ei_description.s = CkJsonObject::ckStringOf(jResp,"data.default_vat.ei_description")
Editable.s = CkJsonObject::ckStringOf(jResp,"data.default_vat.editable")
Is_disabled.s = CkJsonObject::ckStringOf(jResp,"data.default_vat.is_disabled")
Default_payment_terms.s = CkJsonObject::ckStringOf(jResp,"data.default_payment_terms")
Default_payment_terms_type.s = CkJsonObject::ckStringOf(jResp,"data.default_payment_terms_type")
Default_payment_methodId.s = CkJsonObject::ckStringOf(jResp,"data.default_payment_method.id")
Default_payment_methodName.s = CkJsonObject::ckStringOf(jResp,"data.default_payment_method.name")
Default_payment_methodType.s = CkJsonObject::ckStringOf(jResp,"data.default_payment_method.type")
Is_default.s = CkJsonObject::ckStringOf(jResp,"data.default_payment_method.is_default")
Default_payment_accountId.s = CkJsonObject::ckStringOf(jResp,"data.default_payment_method.default_payment_account.id")
Default_payment_accountName.s = CkJsonObject::ckStringOf(jResp,"data.default_payment_method.default_payment_account.name")
Default_payment_accountType.s = CkJsonObject::ckStringOf(jResp,"data.default_payment_method.default_payment_account.type")
Iban.s = CkJsonObject::ckStringOf(jResp,"data.default_payment_method.default_payment_account.iban")
Sia.s = CkJsonObject::ckStringOf(jResp,"data.default_payment_method.default_payment_account.sia")
Cuc.s = CkJsonObject::ckStringOf(jResp,"data.default_payment_method.default_payment_account.cuc")
v_Virtual.s = CkJsonObject::ckStringOf(jResp,"data.default_payment_method.default_payment_account.virtual")
Bank_iban.s = CkJsonObject::ckStringOf(jResp,"data.default_payment_method.bank_iban")
Bank_name.s = CkJsonObject::ckStringOf(jResp,"data.default_payment_method.bank_name")
Bank_beneficiary.s = CkJsonObject::ckStringOf(jResp,"data.default_payment_method.bank_beneficiary")
Ei_payment_method.s = CkJsonObject::ckStringOf(jResp,"data.default_payment_method.ei_payment_method")
dataBank_name.s = CkJsonObject::ckStringOf(jResp,"data.bank_name")
dataBank_iban.s = CkJsonObject::ckStringOf(jResp,"data.bank_iban")
Bank_swift_code.s = CkJsonObject::ckStringOf(jResp,"data.bank_swift_code")
Shipping_address.s = CkJsonObject::ckStringOf(jResp,"data.shipping_address")
dataE_invoice.s = CkJsonObject::ckStringOf(jResp,"data.e_invoice")
Ei_code.s = CkJsonObject::ckStringOf(jResp,"data.ei_code")
Discount_highlight.s = CkJsonObject::ckStringOf(jResp,"data.discount_highlight")
Default_discount.s = CkJsonObject::ckStringOf(jResp,"data.default_discount")
Has_intent_declaration.s = CkJsonObject::ckStringOf(jResp,"data.has_intent_declaration")
Intent_declaration_protocol_number.s = CkJsonObject::ckStringOf(jResp,"data.intent_declaration_protocol_number")
Intent_declaration_protocol_date.s = CkJsonObject::ckStringOf(jResp,"data.intent_declaration_protocol_date")
Created_at.s = CkJsonObject::ckStringOf(jResp,"data.created_at")
Updated_at.s = CkJsonObject::ckStringOf(jResp,"data.updated_at")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"data.default_payment_method.details")
While i < count_i
CkJsonObject::setCkI(jResp, i)
title = CkJsonObject::ckStringOf(jResp,"data.default_payment_method.details[i].title")
description = CkJsonObject::ckStringOf(jResp,"data.default_payment_method.details[i].description")
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"
-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": ""
}
]
}
