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 "type" "passive_delivery_note"
CkJsonObject_UpdateString $queryParams "fields" "<string>"
CkJsonObject_UpdateString $queryParams "fieldset" "basic"
CkJsonObject_UpdateString $queryParams "sort" "<string>"
CkJsonObject_UpdateInt $queryParams "page" 1
CkJsonObject_UpdateInt $queryParams "per_page" 5
CkJsonObject_UpdateString $queryParams "q" "<string>"
# 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/received_documents" $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)
# {
# "current_page": "<integer>",
# "first_page_url": "<uri>",
# "from": "<integer>",
# "last_page": "<integer>",
# "last_page_url": "<uri>",
# "next_page_url": "<uri>",
# "path": "<uri>",
# "per_page": "<integer>",
# "prev_page_url": "<uri>",
# "to": "<integer>",
# "total": "<integer>",
# "data": [
# {
# "id": "<integer>",
# "type": "expense",
# "entity": {
# "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>",
# "country_iso": "<string>",
# "email": "<string>",
# "certified_email": "<string>",
# "phone": "<string>",
# "fax": "<string>",
# "notes": "<string>",
# "default_payment_terms": "<integer>",
# "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_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>",
# "has_intent_declaration": "<boolean>",
# "intent_declaration_protocol_number": "<string>",
# "intent_declaration_protocol_date": "<date>",
# "created_at": "<string>",
# "updated_at": "<string>"
# },
# "date": "<date>",
# "category": "<string>",
# "description": "<string>",
# "amount_net": "<number>",
# "amount_vat": "<number>",
# "amount_withholding_tax": "<number>",
# "amount_other_withholding_tax": "<number>",
# "amount_gross": "<number>",
# "amortization": "<number>",
# "rc_center": "<string>",
# "invoice_number": "<string>",
# "is_marked": "<boolean>",
# "is_detailed": "<boolean>",
# "e_invoice": "<boolean>",
# "next_due_date": "<date>",
# "currency": {
# "id": "<string>",
# "symbol": "<string>",
# "exchange_rate": "<string>",
# "html_symbol": "<string>"
# },
# "tax_deductibility": "<number>",
# "vat_deductibility": "<number>",
# "items_list": [
# {
# "id": "<integer>",
# "product_id": "<integer>",
# "code": "<string>",
# "name": "<string>",
# "measure": "<string>",
# "net_price": "<number>",
# "category": "<string>",
# "qty": "<number>",
# "vat": {
# "id": "<integer>",
# "value": "<number>",
# "description": "<string>",
# "notes": "<string>",
# "e_invoice": "<boolean>",
# "ei_type": "<string>",
# "ei_description": "<string>",
# "editable": "<boolean>",
# "is_disabled": "<boolean>"
# },
# "stock": "<number>"
# },
# {
# "id": "<integer>",
# "product_id": "<integer>",
# "code": "<string>",
# "name": "<string>",
# "measure": "<string>",
# "net_price": "<number>",
# "category": "<string>",
# "qty": "<number>",
# "vat": {
# "id": "<integer>",
# "value": "<number>",
# "description": "<string>",
# "notes": "<string>",
# "e_invoice": "<boolean>",
# "ei_type": "<string>",
# "ei_description": "<string>",
# "editable": "<boolean>",
# "is_disabled": "<boolean>"
# },
# "stock": "<number>"
# }
# ],
# "payments_list": [
# {
# "id": "<integer>",
# "amount": "<number>",
# "due_date": "<date>",
# "paid_date": "<date>",
# "payment_terms": {
# "days": "<integer>",
# "type": "standard"
# },
# "status": "<string>",
# "payment_account": {
# "id": "<integer>",
# "name": "<string>",
# "type": "standard",
# "iban": "<string>",
# "sia": "<string>",
# "cuc": "<string>",
# "virtual": "<boolean>"
# }
# },
# {
# "id": "<integer>",
# "amount": "<number>",
# "due_date": "<date>",
# "paid_date": "<date>",
# "payment_terms": {
# "days": "<integer>",
# "type": "standard"
# },
# "status": "<string>",
# "payment_account": {
# "id": "<integer>",
# "name": "<string>",
# "type": "standard",
# "iban": "<string>",
# "sia": "<string>",
# "cuc": "<string>",
# "virtual": "<boolean>"
# }
# }
# ],
# "attachment_url": "<string>",
# "attachment_preview_url": "<string>",
# "auto_calculate": "<boolean>",
# "attachment_token": "<string>",
# "created_at": "<string>",
# "updated_at": "<string>"
# },
# {
# "id": "<integer>",
# "type": "expense",
# "entity": {
# "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>",
# "country_iso": "<string>",
# "email": "<string>",
# "certified_email": "<string>",
# "phone": "<string>",
# "fax": "<string>",
# "notes": "<string>",
# "default_payment_terms": "<integer>",
# "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_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>",
# "has_intent_declaration": "<boolean>",
# "intent_declaration_protocol_number": "<string>",
# "intent_declaration_protocol_date": "<date>",
# "created_at": "<string>",
# "updated_at": "<string>"
# },
# "date": "<date>",
# "category": "<string>",
# "description": "<string>",
# "amount_net": "<number>",
# "amount_vat": "<number>",
# "amount_withholding_tax": "<number>",
# "amount_other_withholding_tax": "<number>",
# "amount_gross": "<number>",
# "amortization": "<number>",
# "rc_center": "<string>",
# "invoice_number": "<string>",
# "is_marked": "<boolean>",
# "is_detailed": "<boolean>",
# "e_invoice": "<boolean>",
# "next_due_date": "<date>",
# "currency": {
# "id": "<string>",
# "symbol": "<string>",
# "exchange_rate": "<string>",
# "html_symbol": "<string>"
# },
# "tax_deductibility": "<number>",
# "vat_deductibility": "<number>",
# "items_list": [
# {
# "id": "<integer>",
# "product_id": "<integer>",
# "code": "<string>",
# "name": "<string>",
# "measure": "<string>",
# "net_price": "<number>",
# "category": "<string>",
# "qty": "<number>",
# "vat": {
# "id": "<integer>",
# "value": "<number>",
# "description": "<string>",
# "notes": "<string>",
# "e_invoice": "<boolean>",
# "ei_type": "<string>",
# "ei_description": "<string>",
# "editable": "<boolean>",
# "is_disabled": "<boolean>"
# },
# "stock": "<number>"
# },
# {
# "id": "<integer>",
# "product_id": "<integer>",
# "code": "<string>",
# "name": "<string>",
# "measure": "<string>",
# "net_price": "<number>",
# "category": "<string>",
# "qty": "<number>",
# "vat": {
# "id": "<integer>",
# "value": "<number>",
# "description": "<string>",
# "notes": "<string>",
# "e_invoice": "<boolean>",
# "ei_type": "<string>",
# "ei_description": "<string>",
# "editable": "<boolean>",
# "is_disabled": "<boolean>"
# },
# "stock": "<number>"
# }
# ],
# "payments_list": [
# {
# "id": "<integer>",
# "amount": "<number>",
# "due_date": "<date>",
# "paid_date": "<date>",
# "payment_terms": {
# "days": "<integer>",
# "type": "standard"
# },
# "status": "<string>",
# "payment_account": {
# "id": "<integer>",
# "name": "<string>",
# "type": "standard",
# "iban": "<string>",
# "sia": "<string>",
# "cuc": "<string>",
# "virtual": "<boolean>"
# }
# },
# {
# "id": "<integer>",
# "amount": "<number>",
# "due_date": "<date>",
# "paid_date": "<date>",
# "payment_terms": {
# "days": "<integer>",
# "type": "standard"
# },
# "status": "<string>",
# "payment_account": {
# "id": "<integer>",
# "name": "<string>",
# "type": "standard",
# "iban": "<string>",
# "sia": "<string>",
# "cuc": "<string>",
# "virtual": "<boolean>"
# }
# }
# ],
# "attachment_url": "<string>",
# "attachment_preview_url": "<string>",
# "auto_calculate": "<boolean>",
# "attachment_token": "<string>",
# "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 current_page [CkJsonObject_stringOf $jResp "current_page"]
set first_page_url [CkJsonObject_stringOf $jResp "first_page_url"]
set from [CkJsonObject_stringOf $jResp "from"]
set last_page [CkJsonObject_stringOf $jResp "last_page"]
set last_page_url [CkJsonObject_stringOf $jResp "last_page_url"]
set next_page_url [CkJsonObject_stringOf $jResp "next_page_url"]
set path [CkJsonObject_stringOf $jResp "path"]
set per_page [CkJsonObject_stringOf $jResp "per_page"]
set prev_page_url [CkJsonObject_stringOf $jResp "prev_page_url"]
set v_to [CkJsonObject_stringOf $jResp "to"]
set total [CkJsonObject_stringOf $jResp "total"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "data"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set id [CkJsonObject_stringOf $jResp "data[i].id"]
set v_type [CkJsonObject_stringOf $jResp "data[i].type"]
set Id [CkJsonObject_stringOf $jResp "data[i].entity.id"]
set Code [CkJsonObject_stringOf $jResp "data[i].entity.code"]
set Name [CkJsonObject_stringOf $jResp "data[i].entity.name"]
set v_Type [CkJsonObject_stringOf $jResp "data[i].entity.type"]
set First_name [CkJsonObject_stringOf $jResp "data[i].entity.first_name"]
set Last_name [CkJsonObject_stringOf $jResp "data[i].entity.last_name"]
set Contact_person [CkJsonObject_stringOf $jResp "data[i].entity.contact_person"]
set Vat_number [CkJsonObject_stringOf $jResp "data[i].entity.vat_number"]
set Tax_code [CkJsonObject_stringOf $jResp "data[i].entity.tax_code"]
set Address_street [CkJsonObject_stringOf $jResp "data[i].entity.address_street"]
set Address_postal_code [CkJsonObject_stringOf $jResp "data[i].entity.address_postal_code"]
set Address_city [CkJsonObject_stringOf $jResp "data[i].entity.address_city"]
set Address_province [CkJsonObject_stringOf $jResp "data[i].entity.address_province"]
set Address_extra [CkJsonObject_stringOf $jResp "data[i].entity.address_extra"]
set Country [CkJsonObject_stringOf $jResp "data[i].entity.country"]
set Country_iso [CkJsonObject_stringOf $jResp "data[i].entity.country_iso"]
set v_Email [CkJsonObject_stringOf $jResp "data[i].entity.email"]
set Certified_email [CkJsonObject_stringOf $jResp "data[i].entity.certified_email"]
set Phone [CkJsonObject_stringOf $jResp "data[i].entity.phone"]
set Fax [CkJsonObject_stringOf $jResp "data[i].entity.fax"]
set Notes [CkJsonObject_stringOf $jResp "data[i].entity.notes"]
set Default_payment_terms [CkJsonObject_stringOf $jResp "data[i].entity.default_payment_terms"]
set Default_vatId [CkJsonObject_stringOf $jResp "data[i].entity.default_vat.id"]
set Value [CkJsonObject_stringOf $jResp "data[i].entity.default_vat.value"]
set Description [CkJsonObject_stringOf $jResp "data[i].entity.default_vat.description"]
set Default_vatNotes [CkJsonObject_stringOf $jResp "data[i].entity.default_vat.notes"]
set E_invoice [CkJsonObject_stringOf $jResp "data[i].entity.default_vat.e_invoice"]
set Ei_type [CkJsonObject_stringOf $jResp "data[i].entity.default_vat.ei_type"]
set Ei_description [CkJsonObject_stringOf $jResp "data[i].entity.default_vat.ei_description"]
set Editable [CkJsonObject_stringOf $jResp "data[i].entity.default_vat.editable"]
set Is_disabled [CkJsonObject_stringOf $jResp "data[i].entity.default_vat.is_disabled"]
set Default_payment_terms_type [CkJsonObject_stringOf $jResp "data[i].entity.default_payment_terms_type"]
set Default_payment_methodId [CkJsonObject_stringOf $jResp "data[i].entity.default_payment_method.id"]
set Default_payment_methodName [CkJsonObject_stringOf $jResp "data[i].entity.default_payment_method.name"]
set Default_payment_methodType [CkJsonObject_stringOf $jResp "data[i].entity.default_payment_method.type"]
set Is_default [CkJsonObject_stringOf $jResp "data[i].entity.default_payment_method.is_default"]
set Default_payment_accountId [CkJsonObject_stringOf $jResp "data[i].entity.default_payment_method.default_payment_account.id"]
set Default_payment_accountName [CkJsonObject_stringOf $jResp "data[i].entity.default_payment_method.default_payment_account.name"]
set Default_payment_accountType [CkJsonObject_stringOf $jResp "data[i].entity.default_payment_method.default_payment_account.type"]
set Iban [CkJsonObject_stringOf $jResp "data[i].entity.default_payment_method.default_payment_account.iban"]
set Sia [CkJsonObject_stringOf $jResp "data[i].entity.default_payment_method.default_payment_account.sia"]
set Cuc [CkJsonObject_stringOf $jResp "data[i].entity.default_payment_method.default_payment_account.cuc"]
set v_Virtual [CkJsonObject_stringOf $jResp "data[i].entity.default_payment_method.default_payment_account.virtual"]
set Bank_iban [CkJsonObject_stringOf $jResp "data[i].entity.default_payment_method.bank_iban"]
set Bank_name [CkJsonObject_stringOf $jResp "data[i].entity.default_payment_method.bank_name"]
set Bank_beneficiary [CkJsonObject_stringOf $jResp "data[i].entity.default_payment_method.bank_beneficiary"]
set Ei_payment_method [CkJsonObject_stringOf $jResp "data[i].entity.default_payment_method.ei_payment_method"]
set entityBank_name [CkJsonObject_stringOf $jResp "data[i].entity.bank_name"]
set entityBank_iban [CkJsonObject_stringOf $jResp "data[i].entity.bank_iban"]
set Bank_swift_code [CkJsonObject_stringOf $jResp "data[i].entity.bank_swift_code"]
set Shipping_address [CkJsonObject_stringOf $jResp "data[i].entity.shipping_address"]
set entityE_invoice [CkJsonObject_stringOf $jResp "data[i].entity.e_invoice"]
set Ei_code [CkJsonObject_stringOf $jResp "data[i].entity.ei_code"]
set Has_intent_declaration [CkJsonObject_stringOf $jResp "data[i].entity.has_intent_declaration"]
set Intent_declaration_protocol_number [CkJsonObject_stringOf $jResp "data[i].entity.intent_declaration_protocol_number"]
set Intent_declaration_protocol_date [CkJsonObject_stringOf $jResp "data[i].entity.intent_declaration_protocol_date"]
set Created_at [CkJsonObject_stringOf $jResp "data[i].entity.created_at"]
set Updated_at [CkJsonObject_stringOf $jResp "data[i].entity.updated_at"]
set date [CkJsonObject_stringOf $jResp "data[i].date"]
set category [CkJsonObject_stringOf $jResp "data[i].category"]
set description [CkJsonObject_stringOf $jResp "data[i].description"]
set amount_net [CkJsonObject_stringOf $jResp "data[i].amount_net"]
set amount_vat [CkJsonObject_stringOf $jResp "data[i].amount_vat"]
set amount_withholding_tax [CkJsonObject_stringOf $jResp "data[i].amount_withholding_tax"]
set amount_other_withholding_tax [CkJsonObject_stringOf $jResp "data[i].amount_other_withholding_tax"]
set amount_gross [CkJsonObject_stringOf $jResp "data[i].amount_gross"]
set amortization [CkJsonObject_stringOf $jResp "data[i].amortization"]
set rc_center [CkJsonObject_stringOf $jResp "data[i].rc_center"]
set invoice_number [CkJsonObject_stringOf $jResp "data[i].invoice_number"]
set is_marked [CkJsonObject_stringOf $jResp "data[i].is_marked"]
set is_detailed [CkJsonObject_stringOf $jResp "data[i].is_detailed"]
set e_invoice [CkJsonObject_stringOf $jResp "data[i].e_invoice"]
set next_due_date [CkJsonObject_stringOf $jResp "data[i].next_due_date"]
set currencyId [CkJsonObject_stringOf $jResp "data[i].currency.id"]
set Symbol [CkJsonObject_stringOf $jResp "data[i].currency.symbol"]
set Exchange_rate [CkJsonObject_stringOf $jResp "data[i].currency.exchange_rate"]
set Html_symbol [CkJsonObject_stringOf $jResp "data[i].currency.html_symbol"]
set tax_deductibility [CkJsonObject_stringOf $jResp "data[i].tax_deductibility"]
set vat_deductibility [CkJsonObject_stringOf $jResp "data[i].vat_deductibility"]
set attachment_url [CkJsonObject_stringOf $jResp "data[i].attachment_url"]
set attachment_preview_url [CkJsonObject_stringOf $jResp "data[i].attachment_preview_url"]
set auto_calculate [CkJsonObject_stringOf $jResp "data[i].auto_calculate"]
set attachment_token [CkJsonObject_stringOf $jResp "data[i].attachment_token"]
set created_at [CkJsonObject_stringOf $jResp "data[i].created_at"]
set updated_at [CkJsonObject_stringOf $jResp "data[i].updated_at"]
set j 0
set count_j [CkJsonObject_SizeOfArray $jResp "data[i].entity.default_payment_method.details"]
while {$j < $count_j} {
CkJsonObject_put_J $jResp $j
set title [CkJsonObject_stringOf $jResp "data[i].entity.default_payment_method.details[j].title"]
set description [CkJsonObject_stringOf $jResp "data[i].entity.default_payment_method.details[j].description"]
set j [expr $j + 1]
}
set j 0
set count_j [CkJsonObject_SizeOfArray $jResp "data[i].items_list"]
while {$j < $count_j} {
CkJsonObject_put_J $jResp $j
set id [CkJsonObject_stringOf $jResp "data[i].items_list[j].id"]
set product_id [CkJsonObject_stringOf $jResp "data[i].items_list[j].product_id"]
set code [CkJsonObject_stringOf $jResp "data[i].items_list[j].code"]
set name [CkJsonObject_stringOf $jResp "data[i].items_list[j].name"]
set measure [CkJsonObject_stringOf $jResp "data[i].items_list[j].measure"]
set net_price [CkJsonObject_stringOf $jResp "data[i].items_list[j].net_price"]
set category [CkJsonObject_stringOf $jResp "data[i].items_list[j].category"]
set qty [CkJsonObject_stringOf $jResp "data[i].items_list[j].qty"]
set vatId [CkJsonObject_stringOf $jResp "data[i].items_list[j].vat.id"]
set vatValue [CkJsonObject_stringOf $jResp "data[i].items_list[j].vat.value"]
set vatDescription [CkJsonObject_stringOf $jResp "data[i].items_list[j].vat.description"]
set vatNotes [CkJsonObject_stringOf $jResp "data[i].items_list[j].vat.notes"]
set vatE_invoice [CkJsonObject_stringOf $jResp "data[i].items_list[j].vat.e_invoice"]
set vatEi_type [CkJsonObject_stringOf $jResp "data[i].items_list[j].vat.ei_type"]
set vatEi_description [CkJsonObject_stringOf $jResp "data[i].items_list[j].vat.ei_description"]
set vatEditable [CkJsonObject_stringOf $jResp "data[i].items_list[j].vat.editable"]
set vatIs_disabled [CkJsonObject_stringOf $jResp "data[i].items_list[j].vat.is_disabled"]
set stock [CkJsonObject_stringOf $jResp "data[i].items_list[j].stock"]
set j [expr $j + 1]
}
set j 0
set count_j [CkJsonObject_SizeOfArray $jResp "data[i].payments_list"]
while {$j < $count_j} {
CkJsonObject_put_J $jResp $j
set id [CkJsonObject_stringOf $jResp "data[i].payments_list[j].id"]
set amount [CkJsonObject_stringOf $jResp "data[i].payments_list[j].amount"]
set due_date [CkJsonObject_stringOf $jResp "data[i].payments_list[j].due_date"]
set paid_date [CkJsonObject_stringOf $jResp "data[i].payments_list[j].paid_date"]
set Days [CkJsonObject_stringOf $jResp "data[i].payments_list[j].payment_terms.days"]
set payment_termsType [CkJsonObject_stringOf $jResp "data[i].payments_list[j].payment_terms.type"]
set status [CkJsonObject_stringOf $jResp "data[i].payments_list[j].status"]
set payment_accountId [CkJsonObject_stringOf $jResp "data[i].payments_list[j].payment_account.id"]
set payment_accountName [CkJsonObject_stringOf $jResp "data[i].payments_list[j].payment_account.name"]
set payment_accountType [CkJsonObject_stringOf $jResp "data[i].payments_list[j].payment_account.type"]
set payment_accountIban [CkJsonObject_stringOf $jResp "data[i].payments_list[j].payment_account.iban"]
set payment_accountSia [CkJsonObject_stringOf $jResp "data[i].payments_list[j].payment_account.sia"]
set payment_accountCuc [CkJsonObject_stringOf $jResp "data[i].payments_list[j].payment_account.cuc"]
set payment_accountVirtual [CkJsonObject_stringOf $jResp "data[i].payments_list[j].payment_account.virtual"]
set j [expr $j + 1]
}
set i [expr $i + 1]
}
delete_CkHttp $http
delete_CkJsonObject $queryParams
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
Curl Command
curl -G -d "type=passive_delivery_note"
-d "fields=%3Cstring%3E"
-d "fieldset=basic"
-d "sort=%3Cstring%3E"
-d "page=1"
-d "per_page=5"
-d "q=%3Cstring%3E"
-H "Authorization: Bearer <access_token>"
-H "Accept: application/json"
https://api-v2.fattureincloud.it/c/:company_id/received_documents
Postman Collection Item JSON
{
"name": "List Received Documents",
"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/received_documents?type=passive_delivery_note&fields=<string>&fieldset=basic&sort=<string>&page=1&per_page=5&q=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"c",
":company_id",
"received_documents"
],
"query": [
{
"key": "type",
"value": "passive_delivery_note",
"description": "(Required) The type of the received document."
},
{
"key": "fields",
"value": "<string>",
"description": "List of comma-separated fields."
},
{
"key": "fieldset",
"value": "basic",
"description": "Name of the fieldset."
},
{
"key": "sort",
"value": "<string>",
"description": "List of comma-separated fields for result sorting (minus for desc sorting)."
},
{
"key": "page",
"value": "1",
"description": "The page to retrieve."
},
{
"key": "per_page",
"value": "5",
"description": "The size of the page."
},
{
"key": "q",
"value": "<string>",
"description": "Query for filtering the results."
}
],
"variable": [
{
"key": "company_id",
"value": "<integer>"
}
]
},
"description": "Lists the received documents."
},
"response": [
{
"name": "Results list.",
"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/received_documents?type=passive_delivery_note&fields=<string>&fieldset=basic&sort=<string>&page=1&per_page=5&q=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"c",
":company_id",
"received_documents"
],
"query": [
{
"key": "type",
"value": "passive_delivery_note",
"description": "(Required) The type of the received document."
},
{
"key": "fields",
"value": "<string>",
"description": "List of comma-separated fields."
},
{
"key": "fieldset",
"value": "basic",
"description": "Name of the fieldset."
},
{
"key": "sort",
"value": "<string>",
"description": "List of comma-separated fields for result sorting (minus for desc sorting)."
},
{
"key": "page",
"value": "1",
"description": "The page to retrieve."
},
{
"key": "per_page",
"value": "5",
"description": "The size of the page."
},
{
"key": "q",
"value": "<string>",
"description": "Query for filtering the results."
}
],
"variable": [
{
"key": "company_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"current_page\": \"<integer>\",\n \"first_page_url\": \"<uri>\",\n \"from\": \"<integer>\",\n \"last_page\": \"<integer>\",\n \"last_page_url\": \"<uri>\",\n \"next_page_url\": \"<uri>\",\n \"path\": \"<uri>\",\n \"per_page\": \"<integer>\",\n \"prev_page_url\": \"<uri>\",\n \"to\": \"<integer>\",\n \"total\": \"<integer>\",\n \"data\": [\n {\n \"id\": \"<integer>\",\n \"type\": \"expense\",\n \"entity\": {\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 \"country_iso\": \"<string>\",\n \"email\": \"<string>\",\n \"certified_email\": \"<string>\",\n \"phone\": \"<string>\",\n \"fax\": \"<string>\",\n \"notes\": \"<string>\",\n \"default_payment_terms\": \"<integer>\",\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_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 \"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 \"date\": \"<date>\",\n \"category\": \"<string>\",\n \"description\": \"<string>\",\n \"amount_net\": \"<number>\",\n \"amount_vat\": \"<number>\",\n \"amount_withholding_tax\": \"<number>\",\n \"amount_other_withholding_tax\": \"<number>\",\n \"amount_gross\": \"<number>\",\n \"amortization\": \"<number>\",\n \"rc_center\": \"<string>\",\n \"invoice_number\": \"<string>\",\n \"is_marked\": \"<boolean>\",\n \"is_detailed\": \"<boolean>\",\n \"e_invoice\": \"<boolean>\",\n \"next_due_date\": \"<date>\",\n \"currency\": {\n \"id\": \"<string>\",\n \"symbol\": \"<string>\",\n \"exchange_rate\": \"<string>\",\n \"html_symbol\": \"<string>\"\n },\n \"tax_deductibility\": \"<number>\",\n \"vat_deductibility\": \"<number>\",\n \"items_list\": [\n {\n \"id\": \"<integer>\",\n \"product_id\": \"<integer>\",\n \"code\": \"<string>\",\n \"name\": \"<string>\",\n \"measure\": \"<string>\",\n \"net_price\": \"<number>\",\n \"category\": \"<string>\",\n \"qty\": \"<number>\",\n \"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 \"stock\": \"<number>\"\n },\n {\n \"id\": \"<integer>\",\n \"product_id\": \"<integer>\",\n \"code\": \"<string>\",\n \"name\": \"<string>\",\n \"measure\": \"<string>\",\n \"net_price\": \"<number>\",\n \"category\": \"<string>\",\n \"qty\": \"<number>\",\n \"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 \"stock\": \"<number>\"\n }\n ],\n \"payments_list\": [\n {\n \"id\": \"<integer>\",\n \"amount\": \"<number>\",\n \"due_date\": \"<date>\",\n \"paid_date\": \"<date>\",\n \"payment_terms\": {\n \"days\": \"<integer>\",\n \"type\": \"standard\"\n },\n \"status\": \"<string>\",\n \"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 },\n {\n \"id\": \"<integer>\",\n \"amount\": \"<number>\",\n \"due_date\": \"<date>\",\n \"paid_date\": \"<date>\",\n \"payment_terms\": {\n \"days\": \"<integer>\",\n \"type\": \"standard\"\n },\n \"status\": \"<string>\",\n \"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 }\n ],\n \"attachment_url\": \"<string>\",\n \"attachment_preview_url\": \"<string>\",\n \"auto_calculate\": \"<boolean>\",\n \"attachment_token\": \"<string>\",\n \"created_at\": \"<string>\",\n \"updated_at\": \"<string>\"\n },\n {\n \"id\": \"<integer>\",\n \"type\": \"expense\",\n \"entity\": {\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 \"country_iso\": \"<string>\",\n \"email\": \"<string>\",\n \"certified_email\": \"<string>\",\n \"phone\": \"<string>\",\n \"fax\": \"<string>\",\n \"notes\": \"<string>\",\n \"default_payment_terms\": \"<integer>\",\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_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 \"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 \"date\": \"<date>\",\n \"category\": \"<string>\",\n \"description\": \"<string>\",\n \"amount_net\": \"<number>\",\n \"amount_vat\": \"<number>\",\n \"amount_withholding_tax\": \"<number>\",\n \"amount_other_withholding_tax\": \"<number>\",\n \"amount_gross\": \"<number>\",\n \"amortization\": \"<number>\",\n \"rc_center\": \"<string>\",\n \"invoice_number\": \"<string>\",\n \"is_marked\": \"<boolean>\",\n \"is_detailed\": \"<boolean>\",\n \"e_invoice\": \"<boolean>\",\n \"next_due_date\": \"<date>\",\n \"currency\": {\n \"id\": \"<string>\",\n \"symbol\": \"<string>\",\n \"exchange_rate\": \"<string>\",\n \"html_symbol\": \"<string>\"\n },\n \"tax_deductibility\": \"<number>\",\n \"vat_deductibility\": \"<number>\",\n \"items_list\": [\n {\n \"id\": \"<integer>\",\n \"product_id\": \"<integer>\",\n \"code\": \"<string>\",\n \"name\": \"<string>\",\n \"measure\": \"<string>\",\n \"net_price\": \"<number>\",\n \"category\": \"<string>\",\n \"qty\": \"<number>\",\n \"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 \"stock\": \"<number>\"\n },\n {\n \"id\": \"<integer>\",\n \"product_id\": \"<integer>\",\n \"code\": \"<string>\",\n \"name\": \"<string>\",\n \"measure\": \"<string>\",\n \"net_price\": \"<number>\",\n \"category\": \"<string>\",\n \"qty\": \"<number>\",\n \"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 \"stock\": \"<number>\"\n }\n ],\n \"payments_list\": [\n {\n \"id\": \"<integer>\",\n \"amount\": \"<number>\",\n \"due_date\": \"<date>\",\n \"paid_date\": \"<date>\",\n \"payment_terms\": {\n \"days\": \"<integer>\",\n \"type\": \"standard\"\n },\n \"status\": \"<string>\",\n \"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 },\n {\n \"id\": \"<integer>\",\n \"amount\": \"<number>\",\n \"due_date\": \"<date>\",\n \"paid_date\": \"<date>\",\n \"payment_terms\": {\n \"days\": \"<integer>\",\n \"type\": \"standard\"\n },\n \"status\": \"<string>\",\n \"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 }\n ],\n \"attachment_url\": \"<string>\",\n \"attachment_preview_url\": \"<string>\",\n \"auto_calculate\": \"<boolean>\",\n \"attachment_token\": \"<string>\",\n \"created_at\": \"<string>\",\n \"updated_at\": \"<string>\"\n }\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/received_documents?type=passive_delivery_note&fields=<string>&fieldset=basic&sort=<string>&page=1&per_page=5&q=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"c",
":company_id",
"received_documents"
],
"query": [
{
"key": "type",
"value": "passive_delivery_note",
"description": "(Required) The type of the received document."
},
{
"key": "fields",
"value": "<string>",
"description": "List of comma-separated fields."
},
{
"key": "fieldset",
"value": "basic",
"description": "Name of the fieldset."
},
{
"key": "sort",
"value": "<string>",
"description": "List of comma-separated fields for result sorting (minus for desc sorting)."
},
{
"key": "page",
"value": "1",
"description": "The page to retrieve."
},
{
"key": "per_page",
"value": "5",
"description": "The size of the page."
},
{
"key": "q",
"value": "<string>",
"description": "Query for filtering the results."
}
],
"variable": [
{
"key": "company_id"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "text",
"header": [
],
"cookie": [
],
"body": ""
}
]
}
