E-e-invoice-be
Documents

Send Document

Changed on

Send an invoice or credit note via Peppol. By default, the sender and receiver Peppol IDs are derived from the company (tax) IDs in the document, regardless of whether the document was created from a UBL with a different endpoint ID. To explicitly set the sender or receiver Peppol ID, provide them via the query parameters (sender_peppol_scheme, sender_peppol_id, receiver_peppol_scheme, receiver_peppol_id).

post/api/documents/{document_id}/send

Request

Path parameters

document_idstring required

Query parameters

sender_peppol_schemestring nullable
sender_peppol_idstring nullable
receiver_peppol_schemestring nullable
receiver_peppol_idstring nullable
emailstring nullable

Response

Successful Response

document_type'INVOICE' | 'CREDIT_NOTE' | 'DEBIT_NOTE' | 'SELFBILLING_INVOICE' | 'SELFBILLING_CREDIT_NOTE'
state'DRAFT' | 'TRANSIT' | 'FAILED' | 'SENT' | 'RECEIVED'
direction'INBOUND' | 'OUTBOUND'
customer_namestring nullable

The company name of the customer/buyer

customer_idstring nullable

The unique identifier for the customer in your system

customer_emailstring nullable

The email address of the customer

purchase_orderstring nullable

The purchase order reference number

invoice_idstring nullable

The unique invoice identifier/number

invoice_datestring date nullable

The date when the invoice was issued

due_datestring date nullable

The date when payment is due

notestring nullable

Additional notes or comments for the invoice

vendor_namestring nullable

The name of the vendor/seller/supplier

vendor_emailstring nullable

The email address of the vendor

vendor_addressstring nullable

The address of the vendor/seller

vendor_address_recipientstring nullable

The recipient name at the vendor address

customer_addressstring nullable

The address of the customer/buyer

customer_address_recipientstring nullable

The recipient name at the customer address

billing_addressstring nullable

The billing address (if different from customer address)

billing_address_recipientstring nullable

The recipient name at the billing address

shipping_addressstring nullable

The shipping/delivery address

shipping_address_recipientstring nullable

The recipient name at the shipping address

currency'EUR' | 'USD' | 'GBP' | 'JPY' | 'CHF' | 'CAD' | 'AUD' | 'NZD' | 'CNY' | 'INR' | 'SEK' | 'NOK' | 'DKK' | 'SGD' | 'HKD'
tax_code'AE' | 'E' | 'S' | 'Z' | 'G' | 'O' | 'K' | 'L' | 'M' | 'B'

Duty or tax or fee category codes (Subset of UNCL5305)

Agency: UN/CEFACT Version: D.16B Subset: OpenPEPPOL

vatex'VATEX-EU-79-C' | 'VATEX-EU-132' | 'VATEX-EU-132-1A' | 'VATEX-EU-132-1B' | 'VATEX-EU-132-1C' | 'VATEX-EU-132-1D' | 'VATEX-EU-132-1E' | 'VATEX-EU-132-1F' | 'VATEX-EU-132-1G' | 'VATEX-EU-132-1H' | 'VATEX-EU-132-1I' | 'VATEX-EU-132-1J' | 'VATEX-EU-132-1K' | 'VATEX-EU-132-1L' | 'VATEX-EU-132-1M' | 'VATEX-EU-132-1N' | 'VATEX-EU-132-1O' | 'VATEX-EU-132-1P' | 'VATEX-EU-132-1Q' | 'VATEX-EU-143' | 'VATEX-EU-143-1A' | 'VATEX-EU-143-1B' | 'VATEX-EU-143-1C' | 'VATEX-EU-143-1D' | 'VATEX-EU-143-1E' | 'VATEX-EU-143-1F' | 'VATEX-EU-143-1FA' | 'VATEX-EU-143-1G' | 'VATEX-EU-143-1H' | 'VATEX-EU-143-1I' | 'VATEX-EU-143-1J' | 'VATEX-EU-143-1K' | 'VATEX-EU-143-1L' | 'VATEX-EU-144' | 'VATEX-EU-146-1E' | 'VATEX-EU-148' | 'VATEX-EU-148-A' | 'VATEX-EU-148-B' | 'VATEX-EU-148-C' | 'VATEX-EU-148-D' | 'VATEX-EU-148-E' | 'VATEX-EU-148-F' | 'VATEX-EU-148-G' | 'VATEX-EU-151' | 'VATEX-EU-151-1A' | 'VATEX-EU-151-1AA' | 'VATEX-EU-151-1B' | 'VATEX-EU-151-1C' | 'VATEX-EU-151-1D' | 'VATEX-EU-151-1E' | 'VATEX-EU-159' | 'VATEX-EU-309' | 'VATEX-EU-AE' | 'VATEX-EU-D' | 'VATEX-EU-F' | 'VATEX-EU-G' | 'VATEX-EU-I' | 'VATEX-EU-IC' | 'VATEX-EU-O' | 'VATEX-EU-J' | 'VATEX-FR-FRANCHISE' | 'VATEX-FR-CNWVAT'

VATEX code list for VAT exemption reasons

Agency: CEF Identifier: vatex

vatex_notestring nullable

Textual explanation for VAT exemption

subtotalstring nullable

The taxable base of the invoice. Should be the sum of all line items - allowances (for example commercial discounts) + charges with impact on VAT. Must be positive and rounded to maximum 2 decimals

total_discountstring nullable

The net financial discount/charge of the invoice (non-VAT charges minus non-VAT allowances). Can be positive (net charge), negative (net discount), or zero. Must be rounded to maximum 2 decimals

total_taxstring nullable

The total tax amount of the invoice. Must be positive and rounded to maximum 2 decimals

invoice_totalstring nullable

The total amount of the invoice including tax (invoice_total = subtotal + total_tax + total_discount). Must be positive and rounded to maximum 2 decimals

amount_duestring nullable

The amount due for payment. Must be positive and rounded to maximum 2 decimals

remittance_addressstring nullable

The address where payment should be sent or remitted to

remittance_address_recipientstring nullable

The recipient name at the remittance address

service_addressstring nullable

The address where services were performed or goods were delivered

service_address_recipientstring nullable

The recipient name at the service address

service_start_datestring date nullable

The start date of the service period or delivery period

service_end_datestring date nullable

The end date of the service period or delivery period

vendor_tax_idstring nullable

Vendor tax ID. For Belgium this is the VAT number. Must include the country prefix

vendor_company_idstring nullable

Vendor company ID. For Belgium this is the CBE number or their EUID (European Unique Identifier) number. In the Netherlands this is the KVK number.

customer_tax_idstring nullable

Customer tax ID. For Belgium this is the VAT number. Must include the country prefix

customer_company_idstring nullable

Customer company ID. For Belgium this is the CBE number or their EUID (European Unique Identifier) number. In the Netherlands this is the KVK number.

customer_peppol_idstring nullable

Customer Peppol ID

payment_termstring nullable

The payment terms (e.g., 'Net 30', 'Due on receipt', '2/10 Net 30')

idstring required
created_atstring date-time required

Example response

{
  "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

  • 15e09b0714d6Revision 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

  • 363bc8c2b1ddRevision changes
    • info

      query request parameter email was deprecated