Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
LOCAL loQueryParams
LOCAL loResp
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcTitle
LOCAL lcDescription
LOCAL lcId
LOCAL lcCode
LOCAL lcName
LOCAL lcV_Type
LOCAL lcFirst_name
LOCAL lcLast_name
LOCAL lcContact_person
LOCAL lcVat_number
LOCAL lcTax_code
LOCAL lcAddress_street
LOCAL lcAddress_postal_code
LOCAL lcAddress_city
LOCAL lcAddress_province
LOCAL lcAddress_extra
LOCAL lcCountry
LOCAL lcV_Email
LOCAL lcCertified_email
LOCAL lcPhone
LOCAL lcFax
LOCAL lcNotes
LOCAL lcDefault_vatId
LOCAL lcValue
LOCAL lcDescription
LOCAL lcDefault_vatNotes
LOCAL lcE_invoice
LOCAL lcEi_type
LOCAL lcEi_description
LOCAL lcEditable
LOCAL lcIs_disabled
LOCAL lcDefault_payment_terms
LOCAL lcDefault_payment_terms_type
LOCAL lcDefault_payment_methodId
LOCAL lcDefault_payment_methodName
LOCAL lcDefault_payment_methodType
LOCAL lcIs_default
LOCAL lcDefault_payment_accountId
LOCAL lcDefault_payment_accountName
LOCAL lcDefault_payment_accountType
LOCAL lcIban
LOCAL lcSia
LOCAL lcCuc
LOCAL lcV_Virtual
LOCAL lcBank_iban
LOCAL lcBank_name
LOCAL lcBank_beneficiary
LOCAL lcEi_payment_method
LOCAL lcDataBank_name
LOCAL lcDataBank_iban
LOCAL lcBank_swift_code
LOCAL lcShipping_address
LOCAL lcDataE_invoice
LOCAL lcEi_code
LOCAL lcDiscount_highlight
LOCAL lcDefault_discount
LOCAL lcHas_intent_declaration
LOCAL lcIntent_declaration_protocol_number
LOCAL lcIntent_declaration_protocol_date
LOCAL lcCreated_at
LOCAL lcUpdated_at
LOCAL i
LOCAL lnCount_i
* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.
loHttp = CreateObject('Chilkat_9_5_0.Http')
loQueryParams = CreateObject('Chilkat_9_5_0.JsonObject')
loQueryParams.UpdateString("fields","<string>")
loQueryParams.UpdateString("fieldset","basic")
* Adds the "Authorization: Bearer <access_token>" header.
loHttp.AuthToken = "<access_token>"
loHttp.SetRequestHeader("Accept","application/json")
loResp = loHttp.QuickRequestParams("GET","https://api-v2.fattureincloud.it/c/:company_id/entities/clients/:client_id",loQueryParams)
IF (loHttp.LastMethodSuccess = 0) THEN
? loHttp.LastErrorText
RELEASE loHttp
RELEASE loQueryParams
CANCEL
ENDIF
loSbResponseBody = CreateObject('Chilkat_9_5_0.StringBuilder')
loResp.GetBodySb(loSbResponseBody)
loJResp = CreateObject('Chilkat_9_5_0.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
? "Response Header:"
? loResp.Header
? "Failed."
RELEASE loResp
RELEASE loHttp
RELEASE loQueryParams
RELEASE loSbResponseBody
RELEASE loJResp
CANCEL
ENDIF
RELEASE loResp
* 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
lcId = loJResp.StringOf("data.id")
lcCode = loJResp.StringOf("data.code")
lcName = loJResp.StringOf("data.name")
lcV_Type = loJResp.StringOf("data.type")
lcFirst_name = loJResp.StringOf("data.first_name")
lcLast_name = loJResp.StringOf("data.last_name")
lcContact_person = loJResp.StringOf("data.contact_person")
lcVat_number = loJResp.StringOf("data.vat_number")
lcTax_code = loJResp.StringOf("data.tax_code")
lcAddress_street = loJResp.StringOf("data.address_street")
lcAddress_postal_code = loJResp.StringOf("data.address_postal_code")
lcAddress_city = loJResp.StringOf("data.address_city")
lcAddress_province = loJResp.StringOf("data.address_province")
lcAddress_extra = loJResp.StringOf("data.address_extra")
lcCountry = loJResp.StringOf("data.country")
lcV_Email = loJResp.StringOf("data.email")
lcCertified_email = loJResp.StringOf("data.certified_email")
lcPhone = loJResp.StringOf("data.phone")
lcFax = loJResp.StringOf("data.fax")
lcNotes = loJResp.StringOf("data.notes")
lcDefault_vatId = loJResp.StringOf("data.default_vat.id")
lcValue = loJResp.StringOf("data.default_vat.value")
lcDescription = loJResp.StringOf("data.default_vat.description")
lcDefault_vatNotes = loJResp.StringOf("data.default_vat.notes")
lcE_invoice = loJResp.StringOf("data.default_vat.e_invoice")
lcEi_type = loJResp.StringOf("data.default_vat.ei_type")
lcEi_description = loJResp.StringOf("data.default_vat.ei_description")
lcEditable = loJResp.StringOf("data.default_vat.editable")
lcIs_disabled = loJResp.StringOf("data.default_vat.is_disabled")
lcDefault_payment_terms = loJResp.StringOf("data.default_payment_terms")
lcDefault_payment_terms_type = loJResp.StringOf("data.default_payment_terms_type")
lcDefault_payment_methodId = loJResp.StringOf("data.default_payment_method.id")
lcDefault_payment_methodName = loJResp.StringOf("data.default_payment_method.name")
lcDefault_payment_methodType = loJResp.StringOf("data.default_payment_method.type")
lcIs_default = loJResp.StringOf("data.default_payment_method.is_default")
lcDefault_payment_accountId = loJResp.StringOf("data.default_payment_method.default_payment_account.id")
lcDefault_payment_accountName = loJResp.StringOf("data.default_payment_method.default_payment_account.name")
lcDefault_payment_accountType = loJResp.StringOf("data.default_payment_method.default_payment_account.type")
lcIban = loJResp.StringOf("data.default_payment_method.default_payment_account.iban")
lcSia = loJResp.StringOf("data.default_payment_method.default_payment_account.sia")
lcCuc = loJResp.StringOf("data.default_payment_method.default_payment_account.cuc")
lcV_Virtual = loJResp.StringOf("data.default_payment_method.default_payment_account.virtual")
lcBank_iban = loJResp.StringOf("data.default_payment_method.bank_iban")
lcBank_name = loJResp.StringOf("data.default_payment_method.bank_name")
lcBank_beneficiary = loJResp.StringOf("data.default_payment_method.bank_beneficiary")
lcEi_payment_method = loJResp.StringOf("data.default_payment_method.ei_payment_method")
lcDataBank_name = loJResp.StringOf("data.bank_name")
lcDataBank_iban = loJResp.StringOf("data.bank_iban")
lcBank_swift_code = loJResp.StringOf("data.bank_swift_code")
lcShipping_address = loJResp.StringOf("data.shipping_address")
lcDataE_invoice = loJResp.StringOf("data.e_invoice")
lcEi_code = loJResp.StringOf("data.ei_code")
lcDiscount_highlight = loJResp.StringOf("data.discount_highlight")
lcDefault_discount = loJResp.StringOf("data.default_discount")
lcHas_intent_declaration = loJResp.StringOf("data.has_intent_declaration")
lcIntent_declaration_protocol_number = loJResp.StringOf("data.intent_declaration_protocol_number")
lcIntent_declaration_protocol_date = loJResp.StringOf("data.intent_declaration_protocol_date")
lcCreated_at = loJResp.StringOf("data.created_at")
lcUpdated_at = loJResp.StringOf("data.updated_at")
i = 0
lnCount_i = loJResp.SizeOfArray("data.default_payment_method.details")
DO WHILE i < lnCount_i
loJResp.I = i
lcTitle = loJResp.StringOf("data.default_payment_method.details[i].title")
lcDescription = loJResp.StringOf("data.default_payment_method.details[i].description")
i = i + 1
ENDDO
RELEASE loHttp
RELEASE loQueryParams
RELEASE loSbResponseBody
RELEASE loJResp
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": ""
}
]
}
