Outbox

List Draft Documents

Changed on Oct 11, 2026

Retrieve a paginated list of draft documents with filtering options including state and text search.

get/api/outbox/drafts

Request

Base URL
https://api.e-invoice.be
Auth
HTTP bearer
TypeScript
https://skmtc.dev/e-invoice-be/apis/e-invoice-be-peppol-access-point-api/docs/api/outbox/drafts/get.ts
A function with typed inputs. Its response is checked against the schema.

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' | 'SELFBILLING_INVOICE' | 'SELFBILLING_CREDIT_NOTE'

Filter by document type

searchstring nullable

Search in invoice number, seller/buyer names

Sort field options for document listing.

Field to sort by

sort_order'asc' | 'desc'

Sort order options.

Sort direction (asc/desc)

Response

Successful Response

totalinteger required

pageinteger required

page_sizeinteger required

pagesinteger required

has_next_pageboolean required

Example response

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

Changes

Oct 11, 202615e09b0714d6 Revision changes
- info
  added the optional property ///// to the response with the status
- info
  the ////// response's property pattern ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ was added for the status
- info
  the ////// response's property pattern ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ was added for the status
- info
  the ////// response's property pattern ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ was added for the status
- info
  the ////// response's property pattern ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ was added for the status
- info
  the /// response's property pattern ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ was added for the status
- info
  the ////// response's property pattern ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ was added for the status
- info
  the ////// response's property pattern ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ was added for the status
- info
  the ////// response's property pattern ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ was added for the status
- info
  the ////// response's property pattern ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ was added for the status
- info
  the /// response's property pattern ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ was added for the status
- info
  the ///////// response's property pattern ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ was added for the status
- info
  the ///////// response's property pattern ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ was added for the status
- info
  the ///////// response's property pattern ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ was added for the status
- info
  the ///////// response's property pattern ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ was added for the status
- info
  the ////// response's property pattern ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ was added for the status
- info
  the ///////// response's property pattern ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ was added for the status
- info
  the ///////// response's property pattern ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ was added for the status
- info
  the ///////// response's property pattern ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ was added for the status
- info
  the ///////// response's property pattern ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ was added for the status
- info
  the ////// response's property pattern ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ was added for the status
- info
  the ////// response's property pattern ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ was added for the status
- info
  the ////// response's property pattern ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ was added for the status
- info
  the ////// response's property pattern ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ was added for the status
- info
  the /// response's property pattern ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ was added for the status
- info
  the ////// response's property pattern ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ was added for the status
- info
  the /// response's property pattern ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ was added for the status
- info
  the /// response's property pattern ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ was added for the status
Oct 11, 20261bb0867bdfdf Revision changes
- warning
  added the new SELFBILLING_CREDIT_NOTE enum value to the // response property for the response status
- warning
  added the new SELFBILLING_INVOICE enum value to the // response property for the response status
- info
  api operation id get_drafts removed and replaced with get_outbox_drafts
- info
  endpoint deprecated
- info
  added the new optional query request parameter search
- info
  added the new optional query request parameter sort_by
- info
  added the new optional query request parameter sort_order
- info
  added the new optional query request parameter state
- info
  added the new optional query request parameter type
- info
  added the optional property // to the response with the status
- info
  the response's property default value changed from 21 to 0 for the status
- info
  added the required property to the response with the status
- info
  added the required property // to the response with the status

Operation history (22 revisions)