Chilkat Online Tools

VBScript / Fatture in Cloud API v2 - API Reference / List Received Documents

Back to Collection Items

Dim fso, outFile
Set fso = CreateObject("Scripting.FileSystemObject")
'Create a Unicode (utf-16) output text file.
Set outFile = fso.CreateTextFile("output.txt", True, True)

' This example assumes the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.

' For versions of Chilkat < 10.0.0, use CreateObject("Chilkat_9_5_0.Http")
set http = CreateObject("Chilkat.Http")

' For versions of Chilkat < 10.0.0, use CreateObject("Chilkat_9_5_0.JsonObject")
set queryParams = CreateObject("Chilkat.JsonObject")
success = queryParams.UpdateString("type","passive_delivery_note")
success = queryParams.UpdateString("fields","<string>")
success = queryParams.UpdateString("fieldset","basic")
success = queryParams.UpdateString("sort","<string>")
success = queryParams.UpdateInt("page",1)
success = queryParams.UpdateInt("per_page",5)
success = queryParams.UpdateString("q","<string>")

' Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = "<access_token>"
http.SetRequestHeader "Accept","application/json"

' resp is a Chilkat.HttpResponse
Set resp = http.QuickRequestParams("GET","https://api-v2.fattureincloud.it/c/:company_id/received_documents",queryParams)
If (http.LastMethodSuccess = 0) Then
    outFile.WriteLine(http.LastErrorText)
    WScript.Quit
End If

' For versions of Chilkat < 10.0.0, use CreateObject("Chilkat_9_5_0.StringBuilder")
set sbResponseBody = CreateObject("Chilkat.StringBuilder")
success = resp.GetBodySb(sbResponseBody)

' For versions of Chilkat < 10.0.0, use CreateObject("Chilkat_9_5_0.JsonObject")
set jResp = CreateObject("Chilkat.JsonObject")
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = 0

outFile.WriteLine("Response Body:")
outFile.WriteLine(jResp.Emit())

respStatusCode = resp.StatusCode
outFile.WriteLine("Response Status Code = " & respStatusCode)
If (respStatusCode >= 400) Then
    outFile.WriteLine("Response Header:")
    outFile.WriteLine(resp.Header)
    outFile.WriteLine("Failed.")

    WScript.Quit
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

current_page = jResp.StringOf("current_page")
first_page_url = jResp.StringOf("first_page_url")
from = jResp.StringOf("from")
last_page = jResp.StringOf("last_page")
last_page_url = jResp.StringOf("last_page_url")
next_page_url = jResp.StringOf("next_page_url")
path = jResp.StringOf("path")
per_page = jResp.StringOf("per_page")
prev_page_url = jResp.StringOf("prev_page_url")
v_to = jResp.StringOf("to")
total = jResp.StringOf("total")
i = 0
count_i = jResp.SizeOfArray("data")
Do 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")
    Do 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
    Loop
    j = 0
    count_j = jResp.SizeOfArray("data[i].items_list")
    Do 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
    Loop
    j = 0
    count_j = jResp.SizeOfArray("data[i].payments_list")
    Do 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
    Loop
    i = i + 1
Loop

outFile.Close

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": ""
    }
  ]
}