v24

latestOpenAPI 3.1.0raw.githubusercontent.com2025-12-1152106250.5 KB

Inbox

List Received Documents

Retrieve a paginated list of received documents with filtering options including state, type, sender, date range, and text search.

get/api/inbox/

Query parameters

pageinteger

Page number

page_sizeinteger

Number of items per page

state'DRAFT' | 'TRANSIT' | 'FAILED' | 'SENT' | 'RECEIVED'

Filter by document state

type'INVOICE' | 'CREDIT_NOTE' | 'DEBIT_NOTE'

Filter by document type

senderstring nullable

Filter by sender ID

date_fromstring date-time nullable

Filter by issue date (from)

date_tostring date-time nullable

Filter by issue date (to)

searchstring nullable

Search in invoice number, seller/buyer names

Response

Successful Response

totalinteger required

pageinteger required

page_sizeinteger required

pagesinteger required

Example response

{
  "items": [
    {
      "vendor_tax_id": "BE1018265814",
      "vendor_company_id": "1018265814",
      "customer_tax_id": "BE1018265814",
      "customer_company_id": "1018265814",
      "items": [
        {
          "tax_rate": "21.00",
          "charges": [
            {
              "tax_rate": "21.00"
            }
          ]
        }
      ],
      "charges": [
        {
          "tax_rate": "21.00"
        }
      ]
    }
  ]
}