Back to Collection Items
Use ChilkatAx-9.5.0-win32.pkg
Procedure Test
Handle hoHttp
Boolean iSuccess
Variant vQueryParams
Handle hoQueryParams
Variant vResp
Handle hoResp
Variant vSbResponseBody
Handle hoSbResponseBody
Handle hoJResp
Integer iRespStatusCode
String sTitle
String sDescription
String sId
String sProduct_id
String sCode
String sName
String sMeasure
String sNet_price
String sCategory
String sQty
String sVatId
String sVatValue
String sVatDescription
String sVatNotes
String sVatE_invoice
String sVatEi_type
String sVatEi_description
String sVatEditable
String sVatIs_disabled
String sStock
String sAmount
String sDue_date
String sPaid_date
String sDays
String sPayment_termsType
String sStatus
String sPayment_accountId
String sPayment_accountName
String sPayment_accountType
String sPayment_accountIban
String sPayment_accountSia
String sPayment_accountCuc
String sPayment_accountVirtual
String sId
String sV_Type
String sEntityId
String sCode
String sName
String sEntityType
String sFirst_name
String sLast_name
String sContact_person
String sVat_number
String sTax_code
String sAddress_street
String sAddress_postal_code
String sAddress_city
String sAddress_province
String sAddress_extra
String sCountry
String sCountry_iso
String sV_Email
String sCertified_email
String sPhone
String sFax
String sNotes
String sDefault_payment_terms
String sDefault_vatId
String sValue
String sDescription
String sDefault_vatNotes
String sE_invoice
String sEi_type
String sEi_description
String sEditable
String sIs_disabled
String sDefault_payment_terms_type
String sDefault_payment_methodId
String sDefault_payment_methodName
String sDefault_payment_methodType
String sIs_default
String sDefault_payment_accountId
String sDefault_payment_accountName
String sDefault_payment_accountType
String sIban
String sSia
String sCuc
String sV_Virtual
String sBank_iban
String sBank_name
String sBank_beneficiary
String sEi_payment_method
String sEntityBank_name
String sEntityBank_iban
String sBank_swift_code
String sShipping_address
String sEntityE_invoice
String sEi_code
String sHas_intent_declaration
String sIntent_declaration_protocol_number
String sIntent_declaration_protocol_date
String sCreated_at
String sUpdated_at
String sDate
String sCategory
String sDataDescription
String sAmount_net
String sAmount_vat
String sAmount_withholding_tax
String sAmount_other_withholding_tax
String sAmount_gross
String sAmortization
String sRc_center
String sInvoice_number
String sIs_marked
String sIs_detailed
String sDataE_invoice
String sNext_due_date
String sCurrencyId
String sSymbol
String sExchange_rate
String sHtml_symbol
String sTax_deductibility
String sVat_deductibility
String sAttachment_url
String sAttachment_preview_url
String sAuto_calculate
String sAttachment_token
String sDataCreated_at
String sDataUpdated_at
Integer i
Integer iCount_i
String sTemp1
Boolean bTemp1
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Get Create (RefClass(cComChilkatHttp)) To hoHttp
If (Not(IsComObjectCreated(hoHttp))) Begin
Send CreateComObject of hoHttp
End
Get Create (RefClass(cComChilkatJsonObject)) To hoQueryParams
If (Not(IsComObjectCreated(hoQueryParams))) Begin
Send CreateComObject of hoQueryParams
End
Get ComUpdateString Of hoQueryParams "fields" "<string>" To iSuccess
Get ComUpdateString Of hoQueryParams "fieldset" "basic" To iSuccess
// Adds the "Authorization: Bearer <access_token>" header.
Set ComAuthToken Of hoHttp To "<access_token>"
Send ComSetRequestHeader To hoHttp "Accept" "application/json"
Get pvComObject of hoQueryParams to vQueryParams
Get ComQuickRequestParams Of hoHttp "GET" "https://api-v2.fattureincloud.it/c/:company_id/received_documents/:document_id" vQueryParams To vResp
If (IsComObject(vResp)) Begin
Get Create (RefClass(cComChilkatHttpResponse)) To hoResp
Set pvComObject Of hoResp To vResp
End
Get ComLastMethodSuccess Of hoHttp To bTemp1
If (bTemp1 = False) Begin
Get ComLastErrorText Of hoHttp To sTemp1
Showln sTemp1
Procedure_Return
End
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
Send CreateComObject of hoSbResponseBody
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComGetBodySb Of hoResp vSbResponseBody To iSuccess
Get Create (RefClass(cComChilkatJsonObject)) To hoJResp
If (Not(IsComObjectCreated(hoJResp))) Begin
Send CreateComObject of hoJResp
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComLoadSb Of hoJResp vSbResponseBody To iSuccess
Set ComEmitCompact Of hoJResp To False
Showln "Response Body:"
Get ComEmit Of hoJResp To sTemp1
Showln sTemp1
Get ComStatusCode Of hoResp To iRespStatusCode
Showln "Response Status Code = " iRespStatusCode
If (iRespStatusCode >= 400) Begin
Showln "Response Header:"
Get ComHeader Of hoResp To sTemp1
Showln sTemp1
Showln "Failed."
Send Destroy of hoResp
Procedure_Return
End
Send Destroy of hoResp
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "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>"
// }
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Get ComStringOf Of hoJResp "data.id" To sId
Get ComStringOf Of hoJResp "data.type" To sV_Type
Get ComStringOf Of hoJResp "data.entity.id" To sEntityId
Get ComStringOf Of hoJResp "data.entity.code" To sCode
Get ComStringOf Of hoJResp "data.entity.name" To sName
Get ComStringOf Of hoJResp "data.entity.type" To sEntityType
Get ComStringOf Of hoJResp "data.entity.first_name" To sFirst_name
Get ComStringOf Of hoJResp "data.entity.last_name" To sLast_name
Get ComStringOf Of hoJResp "data.entity.contact_person" To sContact_person
Get ComStringOf Of hoJResp "data.entity.vat_number" To sVat_number
Get ComStringOf Of hoJResp "data.entity.tax_code" To sTax_code
Get ComStringOf Of hoJResp "data.entity.address_street" To sAddress_street
Get ComStringOf Of hoJResp "data.entity.address_postal_code" To sAddress_postal_code
Get ComStringOf Of hoJResp "data.entity.address_city" To sAddress_city
Get ComStringOf Of hoJResp "data.entity.address_province" To sAddress_province
Get ComStringOf Of hoJResp "data.entity.address_extra" To sAddress_extra
Get ComStringOf Of hoJResp "data.entity.country" To sCountry
Get ComStringOf Of hoJResp "data.entity.country_iso" To sCountry_iso
Get ComStringOf Of hoJResp "data.entity.email" To sV_Email
Get ComStringOf Of hoJResp "data.entity.certified_email" To sCertified_email
Get ComStringOf Of hoJResp "data.entity.phone" To sPhone
Get ComStringOf Of hoJResp "data.entity.fax" To sFax
Get ComStringOf Of hoJResp "data.entity.notes" To sNotes
Get ComStringOf Of hoJResp "data.entity.default_payment_terms" To sDefault_payment_terms
Get ComStringOf Of hoJResp "data.entity.default_vat.id" To sDefault_vatId
Get ComStringOf Of hoJResp "data.entity.default_vat.value" To sValue
Get ComStringOf Of hoJResp "data.entity.default_vat.description" To sDescription
Get ComStringOf Of hoJResp "data.entity.default_vat.notes" To sDefault_vatNotes
Get ComStringOf Of hoJResp "data.entity.default_vat.e_invoice" To sE_invoice
Get ComStringOf Of hoJResp "data.entity.default_vat.ei_type" To sEi_type
Get ComStringOf Of hoJResp "data.entity.default_vat.ei_description" To sEi_description
Get ComStringOf Of hoJResp "data.entity.default_vat.editable" To sEditable
Get ComStringOf Of hoJResp "data.entity.default_vat.is_disabled" To sIs_disabled
Get ComStringOf Of hoJResp "data.entity.default_payment_terms_type" To sDefault_payment_terms_type
Get ComStringOf Of hoJResp "data.entity.default_payment_method.id" To sDefault_payment_methodId
Get ComStringOf Of hoJResp "data.entity.default_payment_method.name" To sDefault_payment_methodName
Get ComStringOf Of hoJResp "data.entity.default_payment_method.type" To sDefault_payment_methodType
Get ComStringOf Of hoJResp "data.entity.default_payment_method.is_default" To sIs_default
Get ComStringOf Of hoJResp "data.entity.default_payment_method.default_payment_account.id" To sDefault_payment_accountId
Get ComStringOf Of hoJResp "data.entity.default_payment_method.default_payment_account.name" To sDefault_payment_accountName
Get ComStringOf Of hoJResp "data.entity.default_payment_method.default_payment_account.type" To sDefault_payment_accountType
Get ComStringOf Of hoJResp "data.entity.default_payment_method.default_payment_account.iban" To sIban
Get ComStringOf Of hoJResp "data.entity.default_payment_method.default_payment_account.sia" To sSia
Get ComStringOf Of hoJResp "data.entity.default_payment_method.default_payment_account.cuc" To sCuc
Get ComStringOf Of hoJResp "data.entity.default_payment_method.default_payment_account.virtual" To sV_Virtual
Get ComStringOf Of hoJResp "data.entity.default_payment_method.bank_iban" To sBank_iban
Get ComStringOf Of hoJResp "data.entity.default_payment_method.bank_name" To sBank_name
Get ComStringOf Of hoJResp "data.entity.default_payment_method.bank_beneficiary" To sBank_beneficiary
Get ComStringOf Of hoJResp "data.entity.default_payment_method.ei_payment_method" To sEi_payment_method
Get ComStringOf Of hoJResp "data.entity.bank_name" To sEntityBank_name
Get ComStringOf Of hoJResp "data.entity.bank_iban" To sEntityBank_iban
Get ComStringOf Of hoJResp "data.entity.bank_swift_code" To sBank_swift_code
Get ComStringOf Of hoJResp "data.entity.shipping_address" To sShipping_address
Get ComStringOf Of hoJResp "data.entity.e_invoice" To sEntityE_invoice
Get ComStringOf Of hoJResp "data.entity.ei_code" To sEi_code
Get ComStringOf Of hoJResp "data.entity.has_intent_declaration" To sHas_intent_declaration
Get ComStringOf Of hoJResp "data.entity.intent_declaration_protocol_number" To sIntent_declaration_protocol_number
Get ComStringOf Of hoJResp "data.entity.intent_declaration_protocol_date" To sIntent_declaration_protocol_date
Get ComStringOf Of hoJResp "data.entity.created_at" To sCreated_at
Get ComStringOf Of hoJResp "data.entity.updated_at" To sUpdated_at
Get ComStringOf Of hoJResp "data.date" To sDate
Get ComStringOf Of hoJResp "data.category" To sCategory
Get ComStringOf Of hoJResp "data.description" To sDataDescription
Get ComStringOf Of hoJResp "data.amount_net" To sAmount_net
Get ComStringOf Of hoJResp "data.amount_vat" To sAmount_vat
Get ComStringOf Of hoJResp "data.amount_withholding_tax" To sAmount_withholding_tax
Get ComStringOf Of hoJResp "data.amount_other_withholding_tax" To sAmount_other_withholding_tax
Get ComStringOf Of hoJResp "data.amount_gross" To sAmount_gross
Get ComStringOf Of hoJResp "data.amortization" To sAmortization
Get ComStringOf Of hoJResp "data.rc_center" To sRc_center
Get ComStringOf Of hoJResp "data.invoice_number" To sInvoice_number
Get ComStringOf Of hoJResp "data.is_marked" To sIs_marked
Get ComStringOf Of hoJResp "data.is_detailed" To sIs_detailed
Get ComStringOf Of hoJResp "data.e_invoice" To sDataE_invoice
Get ComStringOf Of hoJResp "data.next_due_date" To sNext_due_date
Get ComStringOf Of hoJResp "data.currency.id" To sCurrencyId
Get ComStringOf Of hoJResp "data.currency.symbol" To sSymbol
Get ComStringOf Of hoJResp "data.currency.exchange_rate" To sExchange_rate
Get ComStringOf Of hoJResp "data.currency.html_symbol" To sHtml_symbol
Get ComStringOf Of hoJResp "data.tax_deductibility" To sTax_deductibility
Get ComStringOf Of hoJResp "data.vat_deductibility" To sVat_deductibility
Get ComStringOf Of hoJResp "data.attachment_url" To sAttachment_url
Get ComStringOf Of hoJResp "data.attachment_preview_url" To sAttachment_preview_url
Get ComStringOf Of hoJResp "data.auto_calculate" To sAuto_calculate
Get ComStringOf Of hoJResp "data.attachment_token" To sAttachment_token
Get ComStringOf Of hoJResp "data.created_at" To sDataCreated_at
Get ComStringOf Of hoJResp "data.updated_at" To sDataUpdated_at
Move 0 To i
Get ComSizeOfArray Of hoJResp "data.entity.default_payment_method.details" To iCount_i
While (i < iCount_i)
Set ComI Of hoJResp To i
Get ComStringOf Of hoJResp "data.entity.default_payment_method.details[i].title" To sTitle
Get ComStringOf Of hoJResp "data.entity.default_payment_method.details[i].description" To sDescription
Move (i + 1) To i
Loop
Move 0 To i
Get ComSizeOfArray Of hoJResp "data.items_list" To iCount_i
While (i < iCount_i)
Set ComI Of hoJResp To i
Get ComStringOf Of hoJResp "data.items_list[i].id" To sId
Get ComStringOf Of hoJResp "data.items_list[i].product_id" To sProduct_id
Get ComStringOf Of hoJResp "data.items_list[i].code" To sCode
Get ComStringOf Of hoJResp "data.items_list[i].name" To sName
Get ComStringOf Of hoJResp "data.items_list[i].measure" To sMeasure
Get ComStringOf Of hoJResp "data.items_list[i].net_price" To sNet_price
Get ComStringOf Of hoJResp "data.items_list[i].category" To sCategory
Get ComStringOf Of hoJResp "data.items_list[i].qty" To sQty
Get ComStringOf Of hoJResp "data.items_list[i].vat.id" To sVatId
Get ComStringOf Of hoJResp "data.items_list[i].vat.value" To sVatValue
Get ComStringOf Of hoJResp "data.items_list[i].vat.description" To sVatDescription
Get ComStringOf Of hoJResp "data.items_list[i].vat.notes" To sVatNotes
Get ComStringOf Of hoJResp "data.items_list[i].vat.e_invoice" To sVatE_invoice
Get ComStringOf Of hoJResp "data.items_list[i].vat.ei_type" To sVatEi_type
Get ComStringOf Of hoJResp "data.items_list[i].vat.ei_description" To sVatEi_description
Get ComStringOf Of hoJResp "data.items_list[i].vat.editable" To sVatEditable
Get ComStringOf Of hoJResp "data.items_list[i].vat.is_disabled" To sVatIs_disabled
Get ComStringOf Of hoJResp "data.items_list[i].stock" To sStock
Move (i + 1) To i
Loop
Move 0 To i
Get ComSizeOfArray Of hoJResp "data.payments_list" To iCount_i
While (i < iCount_i)
Set ComI Of hoJResp To i
Get ComStringOf Of hoJResp "data.payments_list[i].id" To sId
Get ComStringOf Of hoJResp "data.payments_list[i].amount" To sAmount
Get ComStringOf Of hoJResp "data.payments_list[i].due_date" To sDue_date
Get ComStringOf Of hoJResp "data.payments_list[i].paid_date" To sPaid_date
Get ComStringOf Of hoJResp "data.payments_list[i].payment_terms.days" To sDays
Get ComStringOf Of hoJResp "data.payments_list[i].payment_terms.type" To sPayment_termsType
Get ComStringOf Of hoJResp "data.payments_list[i].status" To sStatus
Get ComStringOf Of hoJResp "data.payments_list[i].payment_account.id" To sPayment_accountId
Get ComStringOf Of hoJResp "data.payments_list[i].payment_account.name" To sPayment_accountName
Get ComStringOf Of hoJResp "data.payments_list[i].payment_account.type" To sPayment_accountType
Get ComStringOf Of hoJResp "data.payments_list[i].payment_account.iban" To sPayment_accountIban
Get ComStringOf Of hoJResp "data.payments_list[i].payment_account.sia" To sPayment_accountSia
Get ComStringOf Of hoJResp "data.payments_list[i].payment_account.cuc" To sPayment_accountCuc
Get ComStringOf Of hoJResp "data.payments_list[i].payment_account.virtual" To sPayment_accountVirtual
Move (i + 1) To i
Loop
End_Procedure
Curl Command
curl -G -d "fields=%3Cstring%3E"
-d "fieldset=basic"
-H "Authorization: Bearer <access_token>"
-H "Accept: application/json"
https://api-v2.fattureincloud.it/c/:company_id/received_documents/:document_id
Postman Collection Item JSON
{
"name": "Get Received Document",
"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/:document_id?fields=<string>&fieldset=basic",
"host": [
"{{baseUrl}}"
],
"path": [
"c",
":company_id",
"received_documents",
":document_id"
],
"query": [
{
"key": "fields",
"value": "<string>",
"description": "List of comma-separated fields."
},
{
"key": "fieldset",
"value": "basic",
"description": "Name of the fieldset."
}
],
"variable": [
{
"key": "company_id",
"value": "<integer>"
},
{
"key": "document_id",
"value": "<integer>"
}
]
},
"description": "Gets the specified document."
},
"response": [
{
"name": "Document details.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/c/:company_id/received_documents/:document_id?fields=<string>&fieldset=basic",
"host": [
"{{baseUrl}}"
],
"path": [
"c",
":company_id",
"received_documents",
":document_id"
],
"query": [
{
"key": "fields",
"value": "<string>",
"description": "List of comma-separated fields."
},
{
"key": "fieldset",
"value": "basic",
"description": "Name of the fieldset."
}
],
"variable": [
{
"key": "company_id"
},
{
"key": "document_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"data\": {\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}"
},
{
"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/:document_id?fields=<string>&fieldset=basic",
"host": [
"{{baseUrl}}"
],
"path": [
"c",
":company_id",
"received_documents",
":document_id"
],
"query": [
{
"key": "fields",
"value": "<string>",
"description": "List of comma-separated fields."
},
{
"key": "fieldset",
"value": "basic",
"description": "Name of the fieldset."
}
],
"variable": [
{
"key": "company_id"
},
{
"key": "document_id"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "text",
"header": [
],
"cookie": [
],
"body": ""
},
{
"name": "Not Found",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/c/:company_id/received_documents/:document_id?fields=<string>&fieldset=basic",
"host": [
"{{baseUrl}}"
],
"path": [
"c",
":company_id",
"received_documents",
":document_id"
],
"query": [
{
"key": "fields",
"value": "<string>",
"description": "List of comma-separated fields."
},
{
"key": "fieldset",
"value": "basic",
"description": "Name of the fieldset."
}
],
"variable": [
{
"key": "company_id"
},
{
"key": "document_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "text",
"header": [
],
"cookie": [
],
"body": ""
}
]
}
