Back to Collection Items
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loHttp = createobject("CkHttp")
loQueryParams = createobject("CkJsonObject")
loQueryParams.UpdateString("type","passive_delivery_note")
loQueryParams.UpdateString("fields","<string>")
loQueryParams.UpdateString("fieldset","basic")
loQueryParams.UpdateString("sort","<string>")
loQueryParams.UpdateInt("page",1)
loQueryParams.UpdateInt("per_page",5)
loQueryParams.UpdateString("q","<string>")
// Adds the "Authorization: Bearer <access_token>" header.
loHttp.AuthToken = "<access_token>"
loHttp.SetRequestHeader("Accept","application/json")
loResp = loHttp.QuickRequestParams("GET","https://api-v2.fattureincloud.it/c/:company_id/received_documents",loQueryParams)
if (loHttp.LastMethodSuccess = .F.) then
? loHttp.LastErrorText
release loHttp
release loQueryParams
return
endif
loSbResponseBody = createobject("CkStringBuilder")
loResp.GetBodySb(loSbResponseBody)
loJResp = createobject("CkJsonObject")
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = .F.
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + str(lnRespStatusCode)
if (lnRespStatusCode >= 400) then
? "Response Header:"
? loResp.Header
? "Failed."
release loResp
release loHttp
release loQueryParams
release loSbResponseBody
release loJResp
return
endif
release loResp
// 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
lcCurrent_page = loJResp.StringOf("current_page")
lcFirst_page_url = loJResp.StringOf("first_page_url")
lcFrom = loJResp.StringOf("from")
lcLast_page = loJResp.StringOf("last_page")
lcLast_page_url = loJResp.StringOf("last_page_url")
lcNext_page_url = loJResp.StringOf("next_page_url")
lcPath = loJResp.StringOf("path")
lcPer_page = loJResp.StringOf("per_page")
lcPrev_page_url = loJResp.StringOf("prev_page_url")
lcV_to = loJResp.StringOf("to")
lcTotal = loJResp.StringOf("total")
i = 0
lnCount_i = loJResp.SizeOfArray("data")
do while i < lnCount_i
loJResp.I = i
lcId = loJResp.StringOf("data[i].id")
lcV_type = loJResp.StringOf("data[i].type")
lcId = loJResp.StringOf("data[i].entity.id")
lcCode = loJResp.StringOf("data[i].entity.code")
lcName = loJResp.StringOf("data[i].entity.name")
lcV_Type = loJResp.StringOf("data[i].entity.type")
lcFirst_name = loJResp.StringOf("data[i].entity.first_name")
lcLast_name = loJResp.StringOf("data[i].entity.last_name")
lcContact_person = loJResp.StringOf("data[i].entity.contact_person")
lcVat_number = loJResp.StringOf("data[i].entity.vat_number")
lcTax_code = loJResp.StringOf("data[i].entity.tax_code")
lcAddress_street = loJResp.StringOf("data[i].entity.address_street")
lcAddress_postal_code = loJResp.StringOf("data[i].entity.address_postal_code")
lcAddress_city = loJResp.StringOf("data[i].entity.address_city")
lcAddress_province = loJResp.StringOf("data[i].entity.address_province")
lcAddress_extra = loJResp.StringOf("data[i].entity.address_extra")
lcCountry = loJResp.StringOf("data[i].entity.country")
lcCountry_iso = loJResp.StringOf("data[i].entity.country_iso")
lcV_Email = loJResp.StringOf("data[i].entity.email")
lcCertified_email = loJResp.StringOf("data[i].entity.certified_email")
lcPhone = loJResp.StringOf("data[i].entity.phone")
lcFax = loJResp.StringOf("data[i].entity.fax")
lcNotes = loJResp.StringOf("data[i].entity.notes")
lcDefault_payment_terms = loJResp.StringOf("data[i].entity.default_payment_terms")
lcDefault_vatId = loJResp.StringOf("data[i].entity.default_vat.id")
lcValue = loJResp.StringOf("data[i].entity.default_vat.value")
lcDescription = loJResp.StringOf("data[i].entity.default_vat.description")
lcDefault_vatNotes = loJResp.StringOf("data[i].entity.default_vat.notes")
lcE_invoice = loJResp.StringOf("data[i].entity.default_vat.e_invoice")
lcEi_type = loJResp.StringOf("data[i].entity.default_vat.ei_type")
lcEi_description = loJResp.StringOf("data[i].entity.default_vat.ei_description")
lcEditable = loJResp.StringOf("data[i].entity.default_vat.editable")
lcIs_disabled = loJResp.StringOf("data[i].entity.default_vat.is_disabled")
lcDefault_payment_terms_type = loJResp.StringOf("data[i].entity.default_payment_terms_type")
lcDefault_payment_methodId = loJResp.StringOf("data[i].entity.default_payment_method.id")
lcDefault_payment_methodName = loJResp.StringOf("data[i].entity.default_payment_method.name")
lcDefault_payment_methodType = loJResp.StringOf("data[i].entity.default_payment_method.type")
lcIs_default = loJResp.StringOf("data[i].entity.default_payment_method.is_default")
lcDefault_payment_accountId = loJResp.StringOf("data[i].entity.default_payment_method.default_payment_account.id")
lcDefault_payment_accountName = loJResp.StringOf("data[i].entity.default_payment_method.default_payment_account.name")
lcDefault_payment_accountType = loJResp.StringOf("data[i].entity.default_payment_method.default_payment_account.type")
lcIban = loJResp.StringOf("data[i].entity.default_payment_method.default_payment_account.iban")
lcSia = loJResp.StringOf("data[i].entity.default_payment_method.default_payment_account.sia")
lcCuc = loJResp.StringOf("data[i].entity.default_payment_method.default_payment_account.cuc")
lcV_Virtual = loJResp.StringOf("data[i].entity.default_payment_method.default_payment_account.virtual")
lcBank_iban = loJResp.StringOf("data[i].entity.default_payment_method.bank_iban")
lcBank_name = loJResp.StringOf("data[i].entity.default_payment_method.bank_name")
lcBank_beneficiary = loJResp.StringOf("data[i].entity.default_payment_method.bank_beneficiary")
lcEi_payment_method = loJResp.StringOf("data[i].entity.default_payment_method.ei_payment_method")
lcEntityBank_name = loJResp.StringOf("data[i].entity.bank_name")
lcEntityBank_iban = loJResp.StringOf("data[i].entity.bank_iban")
lcBank_swift_code = loJResp.StringOf("data[i].entity.bank_swift_code")
lcShipping_address = loJResp.StringOf("data[i].entity.shipping_address")
lcEntityE_invoice = loJResp.StringOf("data[i].entity.e_invoice")
lcEi_code = loJResp.StringOf("data[i].entity.ei_code")
lcHas_intent_declaration = loJResp.StringOf("data[i].entity.has_intent_declaration")
lcIntent_declaration_protocol_number = loJResp.StringOf("data[i].entity.intent_declaration_protocol_number")
lcIntent_declaration_protocol_date = loJResp.StringOf("data[i].entity.intent_declaration_protocol_date")
lcCreated_at = loJResp.StringOf("data[i].entity.created_at")
lcUpdated_at = loJResp.StringOf("data[i].entity.updated_at")
lcDate = loJResp.StringOf("data[i].date")
lcCategory = loJResp.StringOf("data[i].category")
lcDescription = loJResp.StringOf("data[i].description")
lcAmount_net = loJResp.StringOf("data[i].amount_net")
lcAmount_vat = loJResp.StringOf("data[i].amount_vat")
lcAmount_withholding_tax = loJResp.StringOf("data[i].amount_withholding_tax")
lcAmount_other_withholding_tax = loJResp.StringOf("data[i].amount_other_withholding_tax")
lcAmount_gross = loJResp.StringOf("data[i].amount_gross")
lcAmortization = loJResp.StringOf("data[i].amortization")
lcRc_center = loJResp.StringOf("data[i].rc_center")
lcInvoice_number = loJResp.StringOf("data[i].invoice_number")
lcIs_marked = loJResp.StringOf("data[i].is_marked")
lcIs_detailed = loJResp.StringOf("data[i].is_detailed")
lcE_invoice = loJResp.StringOf("data[i].e_invoice")
lcNext_due_date = loJResp.StringOf("data[i].next_due_date")
lcCurrencyId = loJResp.StringOf("data[i].currency.id")
lcSymbol = loJResp.StringOf("data[i].currency.symbol")
lcExchange_rate = loJResp.StringOf("data[i].currency.exchange_rate")
lcHtml_symbol = loJResp.StringOf("data[i].currency.html_symbol")
lcTax_deductibility = loJResp.StringOf("data[i].tax_deductibility")
lcVat_deductibility = loJResp.StringOf("data[i].vat_deductibility")
lcAttachment_url = loJResp.StringOf("data[i].attachment_url")
lcAttachment_preview_url = loJResp.StringOf("data[i].attachment_preview_url")
lcAuto_calculate = loJResp.StringOf("data[i].auto_calculate")
lcAttachment_token = loJResp.StringOf("data[i].attachment_token")
lcCreated_at = loJResp.StringOf("data[i].created_at")
lcUpdated_at = loJResp.StringOf("data[i].updated_at")
j = 0
lnCount_j = loJResp.SizeOfArray("data[i].entity.default_payment_method.details")
do while j < lnCount_j
loJResp.J = j
lcTitle = loJResp.StringOf("data[i].entity.default_payment_method.details[j].title")
lcDescription = loJResp.StringOf("data[i].entity.default_payment_method.details[j].description")
j = j + 1
enddo
j = 0
lnCount_j = loJResp.SizeOfArray("data[i].items_list")
do while j < lnCount_j
loJResp.J = j
lcId = loJResp.StringOf("data[i].items_list[j].id")
lcProduct_id = loJResp.StringOf("data[i].items_list[j].product_id")
lcCode = loJResp.StringOf("data[i].items_list[j].code")
lcName = loJResp.StringOf("data[i].items_list[j].name")
lcMeasure = loJResp.StringOf("data[i].items_list[j].measure")
lcNet_price = loJResp.StringOf("data[i].items_list[j].net_price")
lcCategory = loJResp.StringOf("data[i].items_list[j].category")
lcQty = loJResp.StringOf("data[i].items_list[j].qty")
lcVatId = loJResp.StringOf("data[i].items_list[j].vat.id")
lcVatValue = loJResp.StringOf("data[i].items_list[j].vat.value")
lcVatDescription = loJResp.StringOf("data[i].items_list[j].vat.description")
lcVatNotes = loJResp.StringOf("data[i].items_list[j].vat.notes")
lcVatE_invoice = loJResp.StringOf("data[i].items_list[j].vat.e_invoice")
lcVatEi_type = loJResp.StringOf("data[i].items_list[j].vat.ei_type")
lcVatEi_description = loJResp.StringOf("data[i].items_list[j].vat.ei_description")
lcVatEditable = loJResp.StringOf("data[i].items_list[j].vat.editable")
lcVatIs_disabled = loJResp.StringOf("data[i].items_list[j].vat.is_disabled")
lcStock = loJResp.StringOf("data[i].items_list[j].stock")
j = j + 1
enddo
j = 0
lnCount_j = loJResp.SizeOfArray("data[i].payments_list")
do while j < lnCount_j
loJResp.J = j
lcId = loJResp.StringOf("data[i].payments_list[j].id")
lcAmount = loJResp.StringOf("data[i].payments_list[j].amount")
lcDue_date = loJResp.StringOf("data[i].payments_list[j].due_date")
lcPaid_date = loJResp.StringOf("data[i].payments_list[j].paid_date")
lcDays = loJResp.StringOf("data[i].payments_list[j].payment_terms.days")
lcPayment_termsType = loJResp.StringOf("data[i].payments_list[j].payment_terms.type")
lcStatus = loJResp.StringOf("data[i].payments_list[j].status")
lcPayment_accountId = loJResp.StringOf("data[i].payments_list[j].payment_account.id")
lcPayment_accountName = loJResp.StringOf("data[i].payments_list[j].payment_account.name")
lcPayment_accountType = loJResp.StringOf("data[i].payments_list[j].payment_account.type")
lcPayment_accountIban = loJResp.StringOf("data[i].payments_list[j].payment_account.iban")
lcPayment_accountSia = loJResp.StringOf("data[i].payments_list[j].payment_account.sia")
lcPayment_accountCuc = loJResp.StringOf("data[i].payments_list[j].payment_account.cuc")
lcPayment_accountVirtual = loJResp.StringOf("data[i].payments_list[j].payment_account.virtual")
j = j + 1
enddo
i = i + 1
enddo
release loHttp
release loQueryParams
release loSbResponseBody
release loJResp
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": ""
}
]
}
