Back to Collection Items
integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_QueryParams
oleobject loo_Resp
oleobject loo_SbResponseBody
oleobject loo_JResp
integer li_RespStatusCode
string ls_Title
string ls_Description
string ls_Id
string ls_Code
string ls_Name
string ls_V_Type
string ls_First_name
string ls_Last_name
string ls_Contact_person
string ls_Vat_number
string ls_Tax_code
string ls_Address_street
string ls_Address_postal_code
string ls_Address_city
string ls_Address_province
string ls_Address_extra
string ls_Country
string ls_V_Email
string ls_Certified_email
string ls_Phone
string ls_Fax
string ls_Notes
string ls_Default_vatId
string ls_Value
string ls_Description
string ls_Default_vatNotes
string ls_E_invoice
string ls_Ei_type
string ls_Ei_description
string ls_Editable
string ls_Is_disabled
string ls_Default_payment_terms
string ls_Default_payment_terms_type
string ls_Default_payment_methodId
string ls_Default_payment_methodName
string ls_Default_payment_methodType
string ls_Is_default
string ls_Default_payment_accountId
string ls_Default_payment_accountName
string ls_Default_payment_accountType
string ls_Iban
string ls_Sia
string ls_Cuc
string ls_V_Virtual
string ls_Bank_iban
string ls_Bank_name
string ls_Bank_beneficiary
string ls_Ei_payment_method
string ls_DataBank_name
string ls_DataBank_iban
string ls_Bank_swift_code
string ls_Shipping_address
string ls_DataE_invoice
string ls_Ei_code
string ls_Discount_highlight
string ls_Default_discount
string ls_Has_intent_declaration
string ls_Intent_declaration_protocol_number
string ls_Intent_declaration_protocol_date
string ls_Created_at
string ls_Updated_at
integer i
integer li_Count_i
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loo_Http = create oleobject
li_rc = loo_Http.ConnectToNewObject("Chilkat_9_5_0.Http")
if li_rc < 0 then
destroy loo_Http
MessageBox("Error","Connecting to COM object failed")
return
end if
loo_QueryParams = create oleobject
li_rc = loo_QueryParams.ConnectToNewObject("Chilkat_9_5_0.JsonObject")
loo_QueryParams.UpdateString("fields","<string>")
loo_QueryParams.UpdateString("fieldset","basic")
// Adds the "Authorization: Bearer <access_token>" header.
loo_Http.AuthToken = "<access_token>"
loo_Http.SetRequestHeader("Accept","application/json")
loo_Resp = loo_Http.QuickRequestParams("GET","https://api-v2.fattureincloud.it/c/:company_id/entities/clients/:client_id",loo_QueryParams)
if loo_Http.LastMethodSuccess = 0 then
Write-Debug loo_Http.LastErrorText
destroy loo_Http
destroy loo_QueryParams
return
end if
loo_SbResponseBody = create oleobject
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat_9_5_0.StringBuilder")
loo_Resp.GetBodySb(loo_SbResponseBody)
loo_JResp = create oleobject
li_rc = loo_JResp.ConnectToNewObject("Chilkat_9_5_0.JsonObject")
loo_JResp.LoadSb(loo_SbResponseBody)
loo_JResp.EmitCompact = 0
Write-Debug "Response Body:"
Write-Debug loo_JResp.Emit()
li_RespStatusCode = loo_Resp.StatusCode
Write-Debug "Response Status Code = " + string(li_RespStatusCode)
if li_RespStatusCode >= 400 then
Write-Debug "Response Header:"
Write-Debug loo_Resp.Header
Write-Debug "Failed."
destroy loo_Resp
destroy loo_Http
destroy loo_QueryParams
destroy loo_SbResponseBody
destroy loo_JResp
return
end if
destroy loo_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
ls_Id = loo_JResp.StringOf("data.id")
ls_Code = loo_JResp.StringOf("data.code")
ls_Name = loo_JResp.StringOf("data.name")
ls_V_Type = loo_JResp.StringOf("data.type")
ls_First_name = loo_JResp.StringOf("data.first_name")
ls_Last_name = loo_JResp.StringOf("data.last_name")
ls_Contact_person = loo_JResp.StringOf("data.contact_person")
ls_Vat_number = loo_JResp.StringOf("data.vat_number")
ls_Tax_code = loo_JResp.StringOf("data.tax_code")
ls_Address_street = loo_JResp.StringOf("data.address_street")
ls_Address_postal_code = loo_JResp.StringOf("data.address_postal_code")
ls_Address_city = loo_JResp.StringOf("data.address_city")
ls_Address_province = loo_JResp.StringOf("data.address_province")
ls_Address_extra = loo_JResp.StringOf("data.address_extra")
ls_Country = loo_JResp.StringOf("data.country")
ls_V_Email = loo_JResp.StringOf("data.email")
ls_Certified_email = loo_JResp.StringOf("data.certified_email")
ls_Phone = loo_JResp.StringOf("data.phone")
ls_Fax = loo_JResp.StringOf("data.fax")
ls_Notes = loo_JResp.StringOf("data.notes")
ls_Default_vatId = loo_JResp.StringOf("data.default_vat.id")
ls_Value = loo_JResp.StringOf("data.default_vat.value")
ls_Description = loo_JResp.StringOf("data.default_vat.description")
ls_Default_vatNotes = loo_JResp.StringOf("data.default_vat.notes")
ls_E_invoice = loo_JResp.StringOf("data.default_vat.e_invoice")
ls_Ei_type = loo_JResp.StringOf("data.default_vat.ei_type")
ls_Ei_description = loo_JResp.StringOf("data.default_vat.ei_description")
ls_Editable = loo_JResp.StringOf("data.default_vat.editable")
ls_Is_disabled = loo_JResp.StringOf("data.default_vat.is_disabled")
ls_Default_payment_terms = loo_JResp.StringOf("data.default_payment_terms")
ls_Default_payment_terms_type = loo_JResp.StringOf("data.default_payment_terms_type")
ls_Default_payment_methodId = loo_JResp.StringOf("data.default_payment_method.id")
ls_Default_payment_methodName = loo_JResp.StringOf("data.default_payment_method.name")
ls_Default_payment_methodType = loo_JResp.StringOf("data.default_payment_method.type")
ls_Is_default = loo_JResp.StringOf("data.default_payment_method.is_default")
ls_Default_payment_accountId = loo_JResp.StringOf("data.default_payment_method.default_payment_account.id")
ls_Default_payment_accountName = loo_JResp.StringOf("data.default_payment_method.default_payment_account.name")
ls_Default_payment_accountType = loo_JResp.StringOf("data.default_payment_method.default_payment_account.type")
ls_Iban = loo_JResp.StringOf("data.default_payment_method.default_payment_account.iban")
ls_Sia = loo_JResp.StringOf("data.default_payment_method.default_payment_account.sia")
ls_Cuc = loo_JResp.StringOf("data.default_payment_method.default_payment_account.cuc")
ls_V_Virtual = loo_JResp.StringOf("data.default_payment_method.default_payment_account.virtual")
ls_Bank_iban = loo_JResp.StringOf("data.default_payment_method.bank_iban")
ls_Bank_name = loo_JResp.StringOf("data.default_payment_method.bank_name")
ls_Bank_beneficiary = loo_JResp.StringOf("data.default_payment_method.bank_beneficiary")
ls_Ei_payment_method = loo_JResp.StringOf("data.default_payment_method.ei_payment_method")
ls_DataBank_name = loo_JResp.StringOf("data.bank_name")
ls_DataBank_iban = loo_JResp.StringOf("data.bank_iban")
ls_Bank_swift_code = loo_JResp.StringOf("data.bank_swift_code")
ls_Shipping_address = loo_JResp.StringOf("data.shipping_address")
ls_DataE_invoice = loo_JResp.StringOf("data.e_invoice")
ls_Ei_code = loo_JResp.StringOf("data.ei_code")
ls_Discount_highlight = loo_JResp.StringOf("data.discount_highlight")
ls_Default_discount = loo_JResp.StringOf("data.default_discount")
ls_Has_intent_declaration = loo_JResp.StringOf("data.has_intent_declaration")
ls_Intent_declaration_protocol_number = loo_JResp.StringOf("data.intent_declaration_protocol_number")
ls_Intent_declaration_protocol_date = loo_JResp.StringOf("data.intent_declaration_protocol_date")
ls_Created_at = loo_JResp.StringOf("data.created_at")
ls_Updated_at = loo_JResp.StringOf("data.updated_at")
i = 0
li_Count_i = loo_JResp.SizeOfArray("data.default_payment_method.details")
do while i < li_Count_i
loo_JResp.I = i
ls_Title = loo_JResp.StringOf("data.default_payment_method.details[i].title")
ls_Description = loo_JResp.StringOf("data.default_payment_method.details[i].description")
i = i + 1
loop
destroy loo_Http
destroy loo_QueryParams
destroy loo_SbResponseBody
destroy loo_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": ""
}
]
}
