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("type","passive_delivery_note")
queryParams.UpdateString("fields","<string>")
queryParams.UpdateString("fieldset","basic")
queryParams.UpdateString("sort","<string>")
queryParams.UpdateInt("page",1)
queryParams.UpdateInt("per_page",5)
queryParams.UpdateString("q","<string>")
' 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/received_documents",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)
' {
' "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
Dim id As String
Dim v_type As String
Dim Id As String
Dim Code As String
Dim Name As String
Dim v_Type As String
Dim First_name As String
Dim Last_name As String
Dim Contact_person As String
Dim Vat_number As String
Dim Tax_code As String
Dim Address_street As String
Dim Address_postal_code As String
Dim Address_city As String
Dim Address_province As String
Dim Address_extra As String
Dim Country As String
Dim Country_iso As String
Dim v_Email As String
Dim Certified_email As String
Dim Phone As String
Dim Fax As String
Dim Notes As String
Dim Default_payment_terms As String
Dim Default_vatId As String
Dim Value As String
Dim Description As String
Dim Default_vatNotes As String
Dim E_invoice As String
Dim Ei_type As String
Dim Ei_description As String
Dim Editable As String
Dim Is_disabled As String
Dim Default_payment_terms_type As String
Dim Default_payment_methodId As String
Dim Default_payment_methodName As String
Dim Default_payment_methodType As String
Dim Is_default As String
Dim Default_payment_accountId As String
Dim Default_payment_accountName As String
Dim Default_payment_accountType As String
Dim Iban As String
Dim Sia As String
Dim Cuc As String
Dim v_Virtual As String
Dim Bank_iban As String
Dim Bank_name As String
Dim Bank_beneficiary As String
Dim Ei_payment_method As String
Dim entityBank_name As String
Dim entityBank_iban As String
Dim Bank_swift_code As String
Dim Shipping_address As String
Dim entityE_invoice As String
Dim Ei_code As String
Dim Has_intent_declaration As String
Dim Intent_declaration_protocol_number As String
Dim Intent_declaration_protocol_date As String
Dim Created_at As String
Dim Updated_at As String
Dim date As String
Dim category As String
Dim description As String
Dim amount_net As String
Dim amount_vat As String
Dim amount_withholding_tax As String
Dim amount_other_withholding_tax As String
Dim amount_gross As String
Dim amortization As String
Dim rc_center As String
Dim invoice_number As String
Dim is_marked As String
Dim is_detailed As String
Dim e_invoice As String
Dim next_due_date As String
Dim currencyId As String
Dim Symbol As String
Dim Exchange_rate As String
Dim Html_symbol As String
Dim tax_deductibility As String
Dim vat_deductibility As String
Dim attachment_url As String
Dim attachment_preview_url As String
Dim auto_calculate As String
Dim attachment_token As String
Dim created_at As String
Dim updated_at As String
Dim j As Integer
Dim count_j As Integer
Dim title As String
Dim product_id As String
Dim code As String
Dim name As String
Dim measure As String
Dim net_price As String
Dim qty As String
Dim vatId As String
Dim vatValue As String
Dim vatDescription As String
Dim vatNotes As String
Dim vatE_invoice As String
Dim vatEi_type As String
Dim vatEi_description As String
Dim vatEditable As String
Dim vatIs_disabled As String
Dim stock As String
Dim amount As String
Dim due_date As String
Dim paid_date As String
Dim Days As String
Dim payment_termsType As String
Dim status As String
Dim payment_accountId As String
Dim payment_accountName As String
Dim payment_accountType As String
Dim payment_accountIban As String
Dim payment_accountSia As String
Dim payment_accountCuc As String
Dim payment_accountVirtual As String
Dim current_page As String = jResp.StringOf("current_page")
Dim first_page_url As String = jResp.StringOf("first_page_url")
Dim from As String = jResp.StringOf("from")
Dim last_page As String = jResp.StringOf("last_page")
Dim last_page_url As String = jResp.StringOf("last_page_url")
Dim next_page_url As String = jResp.StringOf("next_page_url")
Dim path As String = jResp.StringOf("path")
Dim per_page As String = jResp.StringOf("per_page")
Dim prev_page_url As String = jResp.StringOf("prev_page_url")
Dim v_to As String = jResp.StringOf("to")
Dim total As String = jResp.StringOf("total")
Dim i As Integer = 0
Dim count_i As Integer = jResp.SizeOfArray("data")
While i < count_i
jResp.I = i
id = jResp.StringOf("data[i].id")
v_type = jResp.StringOf("data[i].type")
Id = jResp.StringOf("data[i].entity.id")
Code = jResp.StringOf("data[i].entity.code")
Name = jResp.StringOf("data[i].entity.name")
v_Type = jResp.StringOf("data[i].entity.type")
First_name = jResp.StringOf("data[i].entity.first_name")
Last_name = jResp.StringOf("data[i].entity.last_name")
Contact_person = jResp.StringOf("data[i].entity.contact_person")
Vat_number = jResp.StringOf("data[i].entity.vat_number")
Tax_code = jResp.StringOf("data[i].entity.tax_code")
Address_street = jResp.StringOf("data[i].entity.address_street")
Address_postal_code = jResp.StringOf("data[i].entity.address_postal_code")
Address_city = jResp.StringOf("data[i].entity.address_city")
Address_province = jResp.StringOf("data[i].entity.address_province")
Address_extra = jResp.StringOf("data[i].entity.address_extra")
Country = jResp.StringOf("data[i].entity.country")
Country_iso = jResp.StringOf("data[i].entity.country_iso")
v_Email = jResp.StringOf("data[i].entity.email")
Certified_email = jResp.StringOf("data[i].entity.certified_email")
Phone = jResp.StringOf("data[i].entity.phone")
Fax = jResp.StringOf("data[i].entity.fax")
Notes = jResp.StringOf("data[i].entity.notes")
Default_payment_terms = jResp.StringOf("data[i].entity.default_payment_terms")
Default_vatId = jResp.StringOf("data[i].entity.default_vat.id")
Value = jResp.StringOf("data[i].entity.default_vat.value")
Description = jResp.StringOf("data[i].entity.default_vat.description")
Default_vatNotes = jResp.StringOf("data[i].entity.default_vat.notes")
E_invoice = jResp.StringOf("data[i].entity.default_vat.e_invoice")
Ei_type = jResp.StringOf("data[i].entity.default_vat.ei_type")
Ei_description = jResp.StringOf("data[i].entity.default_vat.ei_description")
Editable = jResp.StringOf("data[i].entity.default_vat.editable")
Is_disabled = jResp.StringOf("data[i].entity.default_vat.is_disabled")
Default_payment_terms_type = jResp.StringOf("data[i].entity.default_payment_terms_type")
Default_payment_methodId = jResp.StringOf("data[i].entity.default_payment_method.id")
Default_payment_methodName = jResp.StringOf("data[i].entity.default_payment_method.name")
Default_payment_methodType = jResp.StringOf("data[i].entity.default_payment_method.type")
Is_default = jResp.StringOf("data[i].entity.default_payment_method.is_default")
Default_payment_accountId = jResp.StringOf("data[i].entity.default_payment_method.default_payment_account.id")
Default_payment_accountName = jResp.StringOf("data[i].entity.default_payment_method.default_payment_account.name")
Default_payment_accountType = jResp.StringOf("data[i].entity.default_payment_method.default_payment_account.type")
Iban = jResp.StringOf("data[i].entity.default_payment_method.default_payment_account.iban")
Sia = jResp.StringOf("data[i].entity.default_payment_method.default_payment_account.sia")
Cuc = jResp.StringOf("data[i].entity.default_payment_method.default_payment_account.cuc")
v_Virtual = jResp.StringOf("data[i].entity.default_payment_method.default_payment_account.virtual")
Bank_iban = jResp.StringOf("data[i].entity.default_payment_method.bank_iban")
Bank_name = jResp.StringOf("data[i].entity.default_payment_method.bank_name")
Bank_beneficiary = jResp.StringOf("data[i].entity.default_payment_method.bank_beneficiary")
Ei_payment_method = jResp.StringOf("data[i].entity.default_payment_method.ei_payment_method")
entityBank_name = jResp.StringOf("data[i].entity.bank_name")
entityBank_iban = jResp.StringOf("data[i].entity.bank_iban")
Bank_swift_code = jResp.StringOf("data[i].entity.bank_swift_code")
Shipping_address = jResp.StringOf("data[i].entity.shipping_address")
entityE_invoice = jResp.StringOf("data[i].entity.e_invoice")
Ei_code = jResp.StringOf("data[i].entity.ei_code")
Has_intent_declaration = jResp.StringOf("data[i].entity.has_intent_declaration")
Intent_declaration_protocol_number = jResp.StringOf("data[i].entity.intent_declaration_protocol_number")
Intent_declaration_protocol_date = jResp.StringOf("data[i].entity.intent_declaration_protocol_date")
Created_at = jResp.StringOf("data[i].entity.created_at")
Updated_at = jResp.StringOf("data[i].entity.updated_at")
date = jResp.StringOf("data[i].date")
category = jResp.StringOf("data[i].category")
description = jResp.StringOf("data[i].description")
amount_net = jResp.StringOf("data[i].amount_net")
amount_vat = jResp.StringOf("data[i].amount_vat")
amount_withholding_tax = jResp.StringOf("data[i].amount_withholding_tax")
amount_other_withholding_tax = jResp.StringOf("data[i].amount_other_withholding_tax")
amount_gross = jResp.StringOf("data[i].amount_gross")
amortization = jResp.StringOf("data[i].amortization")
rc_center = jResp.StringOf("data[i].rc_center")
invoice_number = jResp.StringOf("data[i].invoice_number")
is_marked = jResp.StringOf("data[i].is_marked")
is_detailed = jResp.StringOf("data[i].is_detailed")
e_invoice = jResp.StringOf("data[i].e_invoice")
next_due_date = jResp.StringOf("data[i].next_due_date")
currencyId = jResp.StringOf("data[i].currency.id")
Symbol = jResp.StringOf("data[i].currency.symbol")
Exchange_rate = jResp.StringOf("data[i].currency.exchange_rate")
Html_symbol = jResp.StringOf("data[i].currency.html_symbol")
tax_deductibility = jResp.StringOf("data[i].tax_deductibility")
vat_deductibility = jResp.StringOf("data[i].vat_deductibility")
attachment_url = jResp.StringOf("data[i].attachment_url")
attachment_preview_url = jResp.StringOf("data[i].attachment_preview_url")
auto_calculate = jResp.StringOf("data[i].auto_calculate")
attachment_token = jResp.StringOf("data[i].attachment_token")
created_at = jResp.StringOf("data[i].created_at")
updated_at = jResp.StringOf("data[i].updated_at")
j = 0
count_j = jResp.SizeOfArray("data[i].entity.default_payment_method.details")
While j < count_j
jResp.J = j
title = jResp.StringOf("data[i].entity.default_payment_method.details[j].title")
description = jResp.StringOf("data[i].entity.default_payment_method.details[j].description")
j = j + 1
End While
j = 0
count_j = jResp.SizeOfArray("data[i].items_list")
While j < count_j
jResp.J = j
id = jResp.StringOf("data[i].items_list[j].id")
product_id = jResp.StringOf("data[i].items_list[j].product_id")
code = jResp.StringOf("data[i].items_list[j].code")
name = jResp.StringOf("data[i].items_list[j].name")
measure = jResp.StringOf("data[i].items_list[j].measure")
net_price = jResp.StringOf("data[i].items_list[j].net_price")
category = jResp.StringOf("data[i].items_list[j].category")
qty = jResp.StringOf("data[i].items_list[j].qty")
vatId = jResp.StringOf("data[i].items_list[j].vat.id")
vatValue = jResp.StringOf("data[i].items_list[j].vat.value")
vatDescription = jResp.StringOf("data[i].items_list[j].vat.description")
vatNotes = jResp.StringOf("data[i].items_list[j].vat.notes")
vatE_invoice = jResp.StringOf("data[i].items_list[j].vat.e_invoice")
vatEi_type = jResp.StringOf("data[i].items_list[j].vat.ei_type")
vatEi_description = jResp.StringOf("data[i].items_list[j].vat.ei_description")
vatEditable = jResp.StringOf("data[i].items_list[j].vat.editable")
vatIs_disabled = jResp.StringOf("data[i].items_list[j].vat.is_disabled")
stock = jResp.StringOf("data[i].items_list[j].stock")
j = j + 1
End While
j = 0
count_j = jResp.SizeOfArray("data[i].payments_list")
While j < count_j
jResp.J = j
id = jResp.StringOf("data[i].payments_list[j].id")
amount = jResp.StringOf("data[i].payments_list[j].amount")
due_date = jResp.StringOf("data[i].payments_list[j].due_date")
paid_date = jResp.StringOf("data[i].payments_list[j].paid_date")
Days = jResp.StringOf("data[i].payments_list[j].payment_terms.days")
payment_termsType = jResp.StringOf("data[i].payments_list[j].payment_terms.type")
status = jResp.StringOf("data[i].payments_list[j].status")
payment_accountId = jResp.StringOf("data[i].payments_list[j].payment_account.id")
payment_accountName = jResp.StringOf("data[i].payments_list[j].payment_account.name")
payment_accountType = jResp.StringOf("data[i].payments_list[j].payment_account.type")
payment_accountIban = jResp.StringOf("data[i].payments_list[j].payment_account.iban")
payment_accountSia = jResp.StringOf("data[i].payments_list[j].payment_account.sia")
payment_accountCuc = jResp.StringOf("data[i].payments_list[j].payment_account.cuc")
payment_accountVirtual = jResp.StringOf("data[i].payments_list[j].payment_account.virtual")
j = j + 1
End While
i = i + 1
End While
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": ""
}
]
}
