Back to Collection Items
' This example assumes the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.
Dim http As New Chilkat.Http
Dim success As Boolean
Dim queryParams As New Chilkat.JsonObject
queryParams.UpdateString("fields","<string>")
queryParams.UpdateString("fieldset","basic")
' Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = "<access_token>"
http.SetRequestHeader("Accept","application/json")
Dim resp As Chilkat.HttpResponse = http.QuickRequestParams("GET","https://api-v2.fattureincloud.it/c/:company_id/entities/clients/:client_id",queryParams)
If (http.LastMethodSuccess = False) Then
Debug.WriteLine(http.LastErrorText)
Exit Sub
End If
Dim sbResponseBody As New Chilkat.StringBuilder
resp.GetBodySb(sbResponseBody)
Dim jResp As New Chilkat.JsonObject
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False
Debug.WriteLine("Response Body:")
Debug.WriteLine(jResp.Emit())
Dim respStatusCode As Integer = resp.StatusCode
Debug.WriteLine("Response Status Code = " & respStatusCode)
If (respStatusCode >= 400) Then
Debug.WriteLine("Response Header:")
Debug.WriteLine(resp.Header)
Debug.WriteLine("Failed.")
Exit Sub
End If
' 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
Dim title As String
Dim description As String
Dim Id As String = jResp.StringOf("data.id")
Dim Code As String = jResp.StringOf("data.code")
Dim Name As String = jResp.StringOf("data.name")
Dim v_Type As String = jResp.StringOf("data.type")
Dim First_name As String = jResp.StringOf("data.first_name")
Dim Last_name As String = jResp.StringOf("data.last_name")
Dim Contact_person As String = jResp.StringOf("data.contact_person")
Dim Vat_number As String = jResp.StringOf("data.vat_number")
Dim Tax_code As String = jResp.StringOf("data.tax_code")
Dim Address_street As String = jResp.StringOf("data.address_street")
Dim Address_postal_code As String = jResp.StringOf("data.address_postal_code")
Dim Address_city As String = jResp.StringOf("data.address_city")
Dim Address_province As String = jResp.StringOf("data.address_province")
Dim Address_extra As String = jResp.StringOf("data.address_extra")
Dim Country As String = jResp.StringOf("data.country")
Dim v_Email As String = jResp.StringOf("data.email")
Dim Certified_email As String = jResp.StringOf("data.certified_email")
Dim Phone As String = jResp.StringOf("data.phone")
Dim Fax As String = jResp.StringOf("data.fax")
Dim Notes As String = jResp.StringOf("data.notes")
Dim Default_vatId As String = jResp.StringOf("data.default_vat.id")
Dim Value As String = jResp.StringOf("data.default_vat.value")
Dim Description As String = jResp.StringOf("data.default_vat.description")
Dim Default_vatNotes As String = jResp.StringOf("data.default_vat.notes")
Dim E_invoice As String = jResp.StringOf("data.default_vat.e_invoice")
Dim Ei_type As String = jResp.StringOf("data.default_vat.ei_type")
Dim Ei_description As String = jResp.StringOf("data.default_vat.ei_description")
Dim Editable As String = jResp.StringOf("data.default_vat.editable")
Dim Is_disabled As String = jResp.StringOf("data.default_vat.is_disabled")
Dim Default_payment_terms As String = jResp.StringOf("data.default_payment_terms")
Dim Default_payment_terms_type As String = jResp.StringOf("data.default_payment_terms_type")
Dim Default_payment_methodId As String = jResp.StringOf("data.default_payment_method.id")
Dim Default_payment_methodName As String = jResp.StringOf("data.default_payment_method.name")
Dim Default_payment_methodType As String = jResp.StringOf("data.default_payment_method.type")
Dim Is_default As String = jResp.StringOf("data.default_payment_method.is_default")
Dim Default_payment_accountId As String = jResp.StringOf("data.default_payment_method.default_payment_account.id")
Dim Default_payment_accountName As String = jResp.StringOf("data.default_payment_method.default_payment_account.name")
Dim Default_payment_accountType As String = jResp.StringOf("data.default_payment_method.default_payment_account.type")
Dim Iban As String = jResp.StringOf("data.default_payment_method.default_payment_account.iban")
Dim Sia As String = jResp.StringOf("data.default_payment_method.default_payment_account.sia")
Dim Cuc As String = jResp.StringOf("data.default_payment_method.default_payment_account.cuc")
Dim v_Virtual As String = jResp.StringOf("data.default_payment_method.default_payment_account.virtual")
Dim Bank_iban As String = jResp.StringOf("data.default_payment_method.bank_iban")
Dim Bank_name As String = jResp.StringOf("data.default_payment_method.bank_name")
Dim Bank_beneficiary As String = jResp.StringOf("data.default_payment_method.bank_beneficiary")
Dim Ei_payment_method As String = jResp.StringOf("data.default_payment_method.ei_payment_method")
Dim dataBank_name As String = jResp.StringOf("data.bank_name")
Dim dataBank_iban As String = jResp.StringOf("data.bank_iban")
Dim Bank_swift_code As String = jResp.StringOf("data.bank_swift_code")
Dim Shipping_address As String = jResp.StringOf("data.shipping_address")
Dim dataE_invoice As String = jResp.StringOf("data.e_invoice")
Dim Ei_code As String = jResp.StringOf("data.ei_code")
Dim Discount_highlight As String = jResp.StringOf("data.discount_highlight")
Dim Default_discount As String = jResp.StringOf("data.default_discount")
Dim Has_intent_declaration As String = jResp.StringOf("data.has_intent_declaration")
Dim Intent_declaration_protocol_number As String = jResp.StringOf("data.intent_declaration_protocol_number")
Dim Intent_declaration_protocol_date As String = jResp.StringOf("data.intent_declaration_protocol_date")
Dim Created_at As String = jResp.StringOf("data.created_at")
Dim Updated_at As String = jResp.StringOf("data.updated_at")
Dim i As Integer = 0
Dim count_i As Integer = jResp.SizeOfArray("data.default_payment_method.details")
While i < count_i
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 While
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": ""
}
]
}
