Skip to main content
POST
/
api
/
documents
/
Create Document
curl --request POST \
  --url https://api.e-invoice.be/api/documents/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "document_type": "INVOICE",
  "state": "DRAFT",
  "direction": "OUTBOUND",
  "customer_name": "<string>",
  "customer_id": "<string>",
  "customer_email": "<string>",
  "purchase_order": "<string>",
  "invoice_id": "<string>",
  "invoice_date": "2023-12-25",
  "due_date": "2023-12-25",
  "note": "<string>",
  "vendor_name": "<string>",
  "vendor_email": "<string>",
  "vendor_address": "<string>",
  "vendor_address_recipient": "<string>",
  "customer_address": "<string>",
  "customer_address_recipient": "<string>",
  "billing_address": "<string>",
  "billing_address_recipient": "<string>",
  "shipping_address": "<string>",
  "shipping_address_recipient": "<string>",
  "currency": "EUR",
  "tax_code": "S",
  "vatex_note": "<string>",
  "subtotal": 123,
  "total_discount": 123,
  "total_tax": 123,
  "invoice_total": 123,
  "amount_due": 123,
  "previous_unpaid_balance": 123,
  "remittance_address": "<string>",
  "remittance_address_recipient": "<string>",
  "service_address": "<string>",
  "service_address_recipient": "<string>",
  "service_start_date": "2023-12-25",
  "service_end_date": "2023-12-25",
  "vendor_tax_id": "BE1018265814",
  "vendor_company_id": "1018265814",
  "customer_tax_id": "BE1018265814",
  "customer_company_id": "1018265814",
  "customer_peppol_id": "0208:0123456789",
  "payment_term": "<string>",
  "payment_details": [
    {
      "iban": "<string>",
      "swift": "<string>",
      "bank_account_number": "<string>",
      "payment_reference": "<string>"
    }
  ],
  "tax_details": [
    {
      "amount": 123,
      "rate": "<string>"
    }
  ],
  "items": [
    {
      "amount": 123,
      "date": null,
      "description": "<string>",
      "quantity": 123,
      "product_code": "<string>",
      "tax": 123,
      "tax_rate": "21.00",
      "unit_price": 123,
      "allowances": [
        {
          "reason": "<string>",
          "multiplier_factor": 50,
          "amount": 123,
          "base_amount": 123,
          "tax_rate": 21,
          "tax_code": "S"
        }
      ],
      "charges": [
        {
          "reason": "<string>",
          "multiplier_factor": 50,
          "amount": 123,
          "base_amount": 123,
          "tax_rate": "21.00",
          "tax_code": "S"
        }
      ]
    }
  ],
  "attachments": [
    {
      "file_name": "<string>",
      "file_type": "application/pdf",
      "file_size": 0,
      "file_data": "<string>"
    }
  ],
  "allowances": [
    {
      "reason": "<string>",
      "multiplier_factor": 50,
      "amount": 123,
      "base_amount": 123,
      "tax_rate": 21,
      "tax_code": "S"
    }
  ],
  "charges": [
    {
      "reason": "<string>",
      "multiplier_factor": 50,
      "amount": 123,
      "base_amount": 123,
      "tax_rate": "21.00",
      "tax_code": "S"
    }
  ]
}
'
import requests

url = "https://api.e-invoice.be/api/documents/"

payload = {
    "document_type": "INVOICE",
    "state": "DRAFT",
    "direction": "OUTBOUND",
    "customer_name": "<string>",
    "customer_id": "<string>",
    "customer_email": "<string>",
    "purchase_order": "<string>",
    "invoice_id": "<string>",
    "invoice_date": "2023-12-25",
    "due_date": "2023-12-25",
    "note": "<string>",
    "vendor_name": "<string>",
    "vendor_email": "<string>",
    "vendor_address": "<string>",
    "vendor_address_recipient": "<string>",
    "customer_address": "<string>",
    "customer_address_recipient": "<string>",
    "billing_address": "<string>",
    "billing_address_recipient": "<string>",
    "shipping_address": "<string>",
    "shipping_address_recipient": "<string>",
    "currency": "EUR",
    "tax_code": "S",
    "vatex_note": "<string>",
    "subtotal": 123,
    "total_discount": 123,
    "total_tax": 123,
    "invoice_total": 123,
    "amount_due": 123,
    "previous_unpaid_balance": 123,
    "remittance_address": "<string>",
    "remittance_address_recipient": "<string>",
    "service_address": "<string>",
    "service_address_recipient": "<string>",
    "service_start_date": "2023-12-25",
    "service_end_date": "2023-12-25",
    "vendor_tax_id": "BE1018265814",
    "vendor_company_id": "1018265814",
    "customer_tax_id": "BE1018265814",
    "customer_company_id": "1018265814",
    "customer_peppol_id": "0208:0123456789",
    "payment_term": "<string>",
    "payment_details": [
        {
            "iban": "<string>",
            "swift": "<string>",
            "bank_account_number": "<string>",
            "payment_reference": "<string>"
        }
    ],
    "tax_details": [
        {
            "amount": 123,
            "rate": "<string>"
        }
    ],
    "items": [
        {
            "amount": 123,
            "date": None,
            "description": "<string>",
            "quantity": 123,
            "product_code": "<string>",
            "tax": 123,
            "tax_rate": "21.00",
            "unit_price": 123,
            "allowances": [
                {
                    "reason": "<string>",
                    "multiplier_factor": 50,
                    "amount": 123,
                    "base_amount": 123,
                    "tax_rate": 21,
                    "tax_code": "S"
                }
            ],
            "charges": [
                {
                    "reason": "<string>",
                    "multiplier_factor": 50,
                    "amount": 123,
                    "base_amount": 123,
                    "tax_rate": "21.00",
                    "tax_code": "S"
                }
            ]
        }
    ],
    "attachments": [
        {
            "file_name": "<string>",
            "file_type": "application/pdf",
            "file_size": 0,
            "file_data": "<string>"
        }
    ],
    "allowances": [
        {
            "reason": "<string>",
            "multiplier_factor": 50,
            "amount": 123,
            "base_amount": 123,
            "tax_rate": 21,
            "tax_code": "S"
        }
    ],
    "charges": [
        {
            "reason": "<string>",
            "multiplier_factor": 50,
            "amount": 123,
            "base_amount": 123,
            "tax_rate": "21.00",
            "tax_code": "S"
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    document_type: 'INVOICE',
    state: 'DRAFT',
    direction: 'OUTBOUND',
    customer_name: '<string>',
    customer_id: '<string>',
    customer_email: '<string>',
    purchase_order: '<string>',
    invoice_id: '<string>',
    invoice_date: '2023-12-25',
    due_date: '2023-12-25',
    note: '<string>',
    vendor_name: '<string>',
    vendor_email: '<string>',
    vendor_address: '<string>',
    vendor_address_recipient: '<string>',
    customer_address: '<string>',
    customer_address_recipient: '<string>',
    billing_address: '<string>',
    billing_address_recipient: '<string>',
    shipping_address: '<string>',
    shipping_address_recipient: '<string>',
    currency: 'EUR',
    tax_code: 'S',
    vatex_note: '<string>',
    subtotal: 123,
    total_discount: 123,
    total_tax: 123,
    invoice_total: 123,
    amount_due: 123,
    previous_unpaid_balance: 123,
    remittance_address: '<string>',
    remittance_address_recipient: '<string>',
    service_address: '<string>',
    service_address_recipient: '<string>',
    service_start_date: '2023-12-25',
    service_end_date: '2023-12-25',
    vendor_tax_id: 'BE1018265814',
    vendor_company_id: '1018265814',
    customer_tax_id: 'BE1018265814',
    customer_company_id: '1018265814',
    customer_peppol_id: '0208:0123456789',
    payment_term: '<string>',
    payment_details: [
      {
        iban: '<string>',
        swift: '<string>',
        bank_account_number: '<string>',
        payment_reference: '<string>'
      }
    ],
    tax_details: [{amount: 123, rate: '<string>'}],
    items: [
      {
        amount: 123,
        date: null,
        description: '<string>',
        quantity: 123,
        product_code: '<string>',
        tax: 123,
        tax_rate: '21.00',
        unit_price: 123,
        allowances: [
          {
            reason: '<string>',
            multiplier_factor: 50,
            amount: 123,
            base_amount: 123,
            tax_rate: 21,
            tax_code: 'S'
          }
        ],
        charges: [
          {
            reason: '<string>',
            multiplier_factor: 50,
            amount: 123,
            base_amount: 123,
            tax_rate: '21.00',
            tax_code: 'S'
          }
        ]
      }
    ],
    attachments: [
      {
        file_name: '<string>',
        file_type: 'application/pdf',
        file_size: 0,
        file_data: '<string>'
      }
    ],
    allowances: [
      {
        reason: '<string>',
        multiplier_factor: 50,
        amount: 123,
        base_amount: 123,
        tax_rate: 21,
        tax_code: 'S'
      }
    ],
    charges: [
      {
        reason: '<string>',
        multiplier_factor: 50,
        amount: 123,
        base_amount: 123,
        tax_rate: '21.00',
        tax_code: 'S'
      }
    ]
  })
};

fetch('https://api.e-invoice.be/api/documents/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.e-invoice.be/api/documents/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'document_type' => 'INVOICE',
    'state' => 'DRAFT',
    'direction' => 'OUTBOUND',
    'customer_name' => '<string>',
    'customer_id' => '<string>',
    'customer_email' => '<string>',
    'purchase_order' => '<string>',
    'invoice_id' => '<string>',
    'invoice_date' => '2023-12-25',
    'due_date' => '2023-12-25',
    'note' => '<string>',
    'vendor_name' => '<string>',
    'vendor_email' => '<string>',
    'vendor_address' => '<string>',
    'vendor_address_recipient' => '<string>',
    'customer_address' => '<string>',
    'customer_address_recipient' => '<string>',
    'billing_address' => '<string>',
    'billing_address_recipient' => '<string>',
    'shipping_address' => '<string>',
    'shipping_address_recipient' => '<string>',
    'currency' => 'EUR',
    'tax_code' => 'S',
    'vatex_note' => '<string>',
    'subtotal' => 123,
    'total_discount' => 123,
    'total_tax' => 123,
    'invoice_total' => 123,
    'amount_due' => 123,
    'previous_unpaid_balance' => 123,
    'remittance_address' => '<string>',
    'remittance_address_recipient' => '<string>',
    'service_address' => '<string>',
    'service_address_recipient' => '<string>',
    'service_start_date' => '2023-12-25',
    'service_end_date' => '2023-12-25',
    'vendor_tax_id' => 'BE1018265814',
    'vendor_company_id' => '1018265814',
    'customer_tax_id' => 'BE1018265814',
    'customer_company_id' => '1018265814',
    'customer_peppol_id' => '0208:0123456789',
    'payment_term' => '<string>',
    'payment_details' => [
        [
                'iban' => '<string>',
                'swift' => '<string>',
                'bank_account_number' => '<string>',
                'payment_reference' => '<string>'
        ]
    ],
    'tax_details' => [
        [
                'amount' => 123,
                'rate' => '<string>'
        ]
    ],
    'items' => [
        [
                'amount' => 123,
                'date' => null,
                'description' => '<string>',
                'quantity' => 123,
                'product_code' => '<string>',
                'tax' => 123,
                'tax_rate' => '21.00',
                'unit_price' => 123,
                'allowances' => [
                                [
                                                                'reason' => '<string>',
                                                                'multiplier_factor' => 50,
                                                                'amount' => 123,
                                                                'base_amount' => 123,
                                                                'tax_rate' => 21,
                                                                'tax_code' => 'S'
                                ]
                ],
                'charges' => [
                                [
                                                                'reason' => '<string>',
                                                                'multiplier_factor' => 50,
                                                                'amount' => 123,
                                                                'base_amount' => 123,
                                                                'tax_rate' => '21.00',
                                                                'tax_code' => 'S'
                                ]
                ]
        ]
    ],
    'attachments' => [
        [
                'file_name' => '<string>',
                'file_type' => 'application/pdf',
                'file_size' => 0,
                'file_data' => '<string>'
        ]
    ],
    'allowances' => [
        [
                'reason' => '<string>',
                'multiplier_factor' => 50,
                'amount' => 123,
                'base_amount' => 123,
                'tax_rate' => 21,
                'tax_code' => 'S'
        ]
    ],
    'charges' => [
        [
                'reason' => '<string>',
                'multiplier_factor' => 50,
                'amount' => 123,
                'base_amount' => 123,
                'tax_rate' => '21.00',
                'tax_code' => 'S'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.e-invoice.be/api/documents/"

	payload := strings.NewReader("{\n  \"document_type\": \"INVOICE\",\n  \"state\": \"DRAFT\",\n  \"direction\": \"OUTBOUND\",\n  \"customer_name\": \"<string>\",\n  \"customer_id\": \"<string>\",\n  \"customer_email\": \"<string>\",\n  \"purchase_order\": \"<string>\",\n  \"invoice_id\": \"<string>\",\n  \"invoice_date\": \"2023-12-25\",\n  \"due_date\": \"2023-12-25\",\n  \"note\": \"<string>\",\n  \"vendor_name\": \"<string>\",\n  \"vendor_email\": \"<string>\",\n  \"vendor_address\": \"<string>\",\n  \"vendor_address_recipient\": \"<string>\",\n  \"customer_address\": \"<string>\",\n  \"customer_address_recipient\": \"<string>\",\n  \"billing_address\": \"<string>\",\n  \"billing_address_recipient\": \"<string>\",\n  \"shipping_address\": \"<string>\",\n  \"shipping_address_recipient\": \"<string>\",\n  \"currency\": \"EUR\",\n  \"tax_code\": \"S\",\n  \"vatex_note\": \"<string>\",\n  \"subtotal\": 123,\n  \"total_discount\": 123,\n  \"total_tax\": 123,\n  \"invoice_total\": 123,\n  \"amount_due\": 123,\n  \"previous_unpaid_balance\": 123,\n  \"remittance_address\": \"<string>\",\n  \"remittance_address_recipient\": \"<string>\",\n  \"service_address\": \"<string>\",\n  \"service_address_recipient\": \"<string>\",\n  \"service_start_date\": \"2023-12-25\",\n  \"service_end_date\": \"2023-12-25\",\n  \"vendor_tax_id\": \"BE1018265814\",\n  \"vendor_company_id\": \"1018265814\",\n  \"customer_tax_id\": \"BE1018265814\",\n  \"customer_company_id\": \"1018265814\",\n  \"customer_peppol_id\": \"0208:0123456789\",\n  \"payment_term\": \"<string>\",\n  \"payment_details\": [\n    {\n      \"iban\": \"<string>\",\n      \"swift\": \"<string>\",\n      \"bank_account_number\": \"<string>\",\n      \"payment_reference\": \"<string>\"\n    }\n  ],\n  \"tax_details\": [\n    {\n      \"amount\": 123,\n      \"rate\": \"<string>\"\n    }\n  ],\n  \"items\": [\n    {\n      \"amount\": 123,\n      \"date\": null,\n      \"description\": \"<string>\",\n      \"quantity\": 123,\n      \"product_code\": \"<string>\",\n      \"tax\": 123,\n      \"tax_rate\": \"21.00\",\n      \"unit_price\": 123,\n      \"allowances\": [\n        {\n          \"reason\": \"<string>\",\n          \"multiplier_factor\": 50,\n          \"amount\": 123,\n          \"base_amount\": 123,\n          \"tax_rate\": 21,\n          \"tax_code\": \"S\"\n        }\n      ],\n      \"charges\": [\n        {\n          \"reason\": \"<string>\",\n          \"multiplier_factor\": 50,\n          \"amount\": 123,\n          \"base_amount\": 123,\n          \"tax_rate\": \"21.00\",\n          \"tax_code\": \"S\"\n        }\n      ]\n    }\n  ],\n  \"attachments\": [\n    {\n      \"file_name\": \"<string>\",\n      \"file_type\": \"application/pdf\",\n      \"file_size\": 0,\n      \"file_data\": \"<string>\"\n    }\n  ],\n  \"allowances\": [\n    {\n      \"reason\": \"<string>\",\n      \"multiplier_factor\": 50,\n      \"amount\": 123,\n      \"base_amount\": 123,\n      \"tax_rate\": 21,\n      \"tax_code\": \"S\"\n    }\n  ],\n  \"charges\": [\n    {\n      \"reason\": \"<string>\",\n      \"multiplier_factor\": 50,\n      \"amount\": 123,\n      \"base_amount\": 123,\n      \"tax_rate\": \"21.00\",\n      \"tax_code\": \"S\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.e-invoice.be/api/documents/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"document_type\": \"INVOICE\",\n  \"state\": \"DRAFT\",\n  \"direction\": \"OUTBOUND\",\n  \"customer_name\": \"<string>\",\n  \"customer_id\": \"<string>\",\n  \"customer_email\": \"<string>\",\n  \"purchase_order\": \"<string>\",\n  \"invoice_id\": \"<string>\",\n  \"invoice_date\": \"2023-12-25\",\n  \"due_date\": \"2023-12-25\",\n  \"note\": \"<string>\",\n  \"vendor_name\": \"<string>\",\n  \"vendor_email\": \"<string>\",\n  \"vendor_address\": \"<string>\",\n  \"vendor_address_recipient\": \"<string>\",\n  \"customer_address\": \"<string>\",\n  \"customer_address_recipient\": \"<string>\",\n  \"billing_address\": \"<string>\",\n  \"billing_address_recipient\": \"<string>\",\n  \"shipping_address\": \"<string>\",\n  \"shipping_address_recipient\": \"<string>\",\n  \"currency\": \"EUR\",\n  \"tax_code\": \"S\",\n  \"vatex_note\": \"<string>\",\n  \"subtotal\": 123,\n  \"total_discount\": 123,\n  \"total_tax\": 123,\n  \"invoice_total\": 123,\n  \"amount_due\": 123,\n  \"previous_unpaid_balance\": 123,\n  \"remittance_address\": \"<string>\",\n  \"remittance_address_recipient\": \"<string>\",\n  \"service_address\": \"<string>\",\n  \"service_address_recipient\": \"<string>\",\n  \"service_start_date\": \"2023-12-25\",\n  \"service_end_date\": \"2023-12-25\",\n  \"vendor_tax_id\": \"BE1018265814\",\n  \"vendor_company_id\": \"1018265814\",\n  \"customer_tax_id\": \"BE1018265814\",\n  \"customer_company_id\": \"1018265814\",\n  \"customer_peppol_id\": \"0208:0123456789\",\n  \"payment_term\": \"<string>\",\n  \"payment_details\": [\n    {\n      \"iban\": \"<string>\",\n      \"swift\": \"<string>\",\n      \"bank_account_number\": \"<string>\",\n      \"payment_reference\": \"<string>\"\n    }\n  ],\n  \"tax_details\": [\n    {\n      \"amount\": 123,\n      \"rate\": \"<string>\"\n    }\n  ],\n  \"items\": [\n    {\n      \"amount\": 123,\n      \"date\": null,\n      \"description\": \"<string>\",\n      \"quantity\": 123,\n      \"product_code\": \"<string>\",\n      \"tax\": 123,\n      \"tax_rate\": \"21.00\",\n      \"unit_price\": 123,\n      \"allowances\": [\n        {\n          \"reason\": \"<string>\",\n          \"multiplier_factor\": 50,\n          \"amount\": 123,\n          \"base_amount\": 123,\n          \"tax_rate\": 21,\n          \"tax_code\": \"S\"\n        }\n      ],\n      \"charges\": [\n        {\n          \"reason\": \"<string>\",\n          \"multiplier_factor\": 50,\n          \"amount\": 123,\n          \"base_amount\": 123,\n          \"tax_rate\": \"21.00\",\n          \"tax_code\": \"S\"\n        }\n      ]\n    }\n  ],\n  \"attachments\": [\n    {\n      \"file_name\": \"<string>\",\n      \"file_type\": \"application/pdf\",\n      \"file_size\": 0,\n      \"file_data\": \"<string>\"\n    }\n  ],\n  \"allowances\": [\n    {\n      \"reason\": \"<string>\",\n      \"multiplier_factor\": 50,\n      \"amount\": 123,\n      \"base_amount\": 123,\n      \"tax_rate\": 21,\n      \"tax_code\": \"S\"\n    }\n  ],\n  \"charges\": [\n    {\n      \"reason\": \"<string>\",\n      \"multiplier_factor\": 50,\n      \"amount\": 123,\n      \"base_amount\": 123,\n      \"tax_rate\": \"21.00\",\n      \"tax_code\": \"S\"\n    }\n  ]\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.e-invoice.be/api/documents/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"document_type\": \"INVOICE\",\n  \"state\": \"DRAFT\",\n  \"direction\": \"OUTBOUND\",\n  \"customer_name\": \"<string>\",\n  \"customer_id\": \"<string>\",\n  \"customer_email\": \"<string>\",\n  \"purchase_order\": \"<string>\",\n  \"invoice_id\": \"<string>\",\n  \"invoice_date\": \"2023-12-25\",\n  \"due_date\": \"2023-12-25\",\n  \"note\": \"<string>\",\n  \"vendor_name\": \"<string>\",\n  \"vendor_email\": \"<string>\",\n  \"vendor_address\": \"<string>\",\n  \"vendor_address_recipient\": \"<string>\",\n  \"customer_address\": \"<string>\",\n  \"customer_address_recipient\": \"<string>\",\n  \"billing_address\": \"<string>\",\n  \"billing_address_recipient\": \"<string>\",\n  \"shipping_address\": \"<string>\",\n  \"shipping_address_recipient\": \"<string>\",\n  \"currency\": \"EUR\",\n  \"tax_code\": \"S\",\n  \"vatex_note\": \"<string>\",\n  \"subtotal\": 123,\n  \"total_discount\": 123,\n  \"total_tax\": 123,\n  \"invoice_total\": 123,\n  \"amount_due\": 123,\n  \"previous_unpaid_balance\": 123,\n  \"remittance_address\": \"<string>\",\n  \"remittance_address_recipient\": \"<string>\",\n  \"service_address\": \"<string>\",\n  \"service_address_recipient\": \"<string>\",\n  \"service_start_date\": \"2023-12-25\",\n  \"service_end_date\": \"2023-12-25\",\n  \"vendor_tax_id\": \"BE1018265814\",\n  \"vendor_company_id\": \"1018265814\",\n  \"customer_tax_id\": \"BE1018265814\",\n  \"customer_company_id\": \"1018265814\",\n  \"customer_peppol_id\": \"0208:0123456789\",\n  \"payment_term\": \"<string>\",\n  \"payment_details\": [\n    {\n      \"iban\": \"<string>\",\n      \"swift\": \"<string>\",\n      \"bank_account_number\": \"<string>\",\n      \"payment_reference\": \"<string>\"\n    }\n  ],\n  \"tax_details\": [\n    {\n      \"amount\": 123,\n      \"rate\": \"<string>\"\n    }\n  ],\n  \"items\": [\n    {\n      \"amount\": 123,\n      \"date\": null,\n      \"description\": \"<string>\",\n      \"quantity\": 123,\n      \"product_code\": \"<string>\",\n      \"tax\": 123,\n      \"tax_rate\": \"21.00\",\n      \"unit_price\": 123,\n      \"allowances\": [\n        {\n          \"reason\": \"<string>\",\n          \"multiplier_factor\": 50,\n          \"amount\": 123,\n          \"base_amount\": 123,\n          \"tax_rate\": 21,\n          \"tax_code\": \"S\"\n        }\n      ],\n      \"charges\": [\n        {\n          \"reason\": \"<string>\",\n          \"multiplier_factor\": 50,\n          \"amount\": 123,\n          \"base_amount\": 123,\n          \"tax_rate\": \"21.00\",\n          \"tax_code\": \"S\"\n        }\n      ]\n    }\n  ],\n  \"attachments\": [\n    {\n      \"file_name\": \"<string>\",\n      \"file_type\": \"application/pdf\",\n      \"file_size\": 0,\n      \"file_data\": \"<string>\"\n    }\n  ],\n  \"allowances\": [\n    {\n      \"reason\": \"<string>\",\n      \"multiplier_factor\": 50,\n      \"amount\": 123,\n      \"base_amount\": 123,\n      \"tax_rate\": 21,\n      \"tax_code\": \"S\"\n    }\n  ],\n  \"charges\": [\n    {\n      \"reason\": \"<string>\",\n      \"multiplier_factor\": 50,\n      \"amount\": 123,\n      \"base_amount\": 123,\n      \"tax_rate\": \"21.00\",\n      \"tax_code\": \"S\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body
{
  "id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "document_type": "INVOICE",
  "state": "DRAFT",
  "direction": "OUTBOUND",
  "customer_name": "<string>",
  "customer_id": "<string>",
  "customer_email": "<string>",
  "purchase_order": "<string>",
  "invoice_id": "<string>",
  "invoice_date": "2023-12-25",
  "due_date": "2023-12-25",
  "note": "<string>",
  "vendor_name": "<string>",
  "vendor_email": "<string>",
  "vendor_address": "<string>",
  "vendor_address_recipient": "<string>",
  "customer_address": "<string>",
  "customer_address_recipient": "<string>",
  "billing_address": "<string>",
  "billing_address_recipient": "<string>",
  "shipping_address": "<string>",
  "shipping_address_recipient": "<string>",
  "currency": "EUR",
  "tax_code": "S",
  "vatex_note": "<string>",
  "subtotal": "<string>",
  "total_discount": "<string>",
  "total_tax": "<string>",
  "invoice_total": "<string>",
  "amount_due": "<string>",
  "remittance_address": "<string>",
  "remittance_address_recipient": "<string>",
  "service_address": "<string>",
  "service_address_recipient": "<string>",
  "service_start_date": "2023-12-25",
  "service_end_date": "2023-12-25",
  "vendor_tax_id": "BE1018265814",
  "vendor_company_id": "1018265814",
  "customer_tax_id": "BE1018265814",
  "customer_company_id": "1018265814",
  "customer_peppol_id": "0208:0123456789",
  "payment_term": "<string>",
  "payment_details": [
    {
      "iban": "<string>",
      "swift": "<string>",
      "bank_account_number": "<string>",
      "payment_reference": "<string>"
    }
  ],
  "tax_details": [
    {
      "amount": "<string>",
      "rate": "<string>"
    }
  ],
  "items": [
    {
      "amount": "<string>",
      "date": null,
      "description": "<string>",
      "quantity": "<string>",
      "product_code": "<string>",
      "tax": "<string>",
      "tax_rate": "21.00",
      "unit_price": "<string>",
      "allowances": [
        {
          "reason": "<string>",
          "multiplier_factor": "<string>",
          "amount": "<string>",
          "base_amount": "<string>",
          "tax_rate": 21,
          "tax_code": "S"
        }
      ],
      "charges": [
        {
          "reason": "<string>",
          "multiplier_factor": "<string>",
          "amount": "<string>",
          "base_amount": "<string>",
          "tax_rate": "21.00",
          "tax_code": "S"
        }
      ]
    }
  ],
  "attachments": [
    {
      "file_name": "<string>",
      "id": "<string>",
      "file_type": "application/pdf",
      "file_size": 0,
      "file_url": "<string>"
    }
  ],
  "allowances": [
    {
      "reason": "<string>",
      "multiplier_factor": "<string>",
      "amount": "<string>",
      "base_amount": "<string>",
      "tax_rate": 21,
      "tax_code": "S"
    }
  ],
  "charges": [
    {
      "reason": "<string>",
      "multiplier_factor": "<string>",
      "amount": "<string>",
      "base_amount": "<string>",
      "tax_rate": "21.00",
      "tax_code": "S"
    }
  ]
}
{
  "detail": "<string>"
}
{
  "detail": "<string>"
}
{
  "detail": "<string>"
}
{
  "detail": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
construct_pdf
boolean
default:false

If true, generate a constructed PDF from the document and include it both as document attachment and embedded in the UBL.

Body

application/json
​
document_type
enum<string>
default:INVOICE

The type of document: INVOICE, CREDIT_NOTE, or DEBIT_NOTE

Available options:
INVOICE,
CREDIT_NOTE,
DEBIT_NOTE,
SELFBILLING_INVOICE,
SELFBILLING_CREDIT_NOTE
​
state
enum<string>
default:DRAFT

The current state of the document: DRAFT, TRANSIT, FAILED, SENT, or RECEIVED

Available options:
DRAFT,
TRANSIT,
FAILED,
SENT,
RECEIVED
​
direction
enum<string>
default:OUTBOUND

The direction of the document: INBOUND (purchases) or OUTBOUND (sales)

Available options:
INBOUND,
OUTBOUND
​
customer_name
string | null

The company name of the customer/buyer

​
customer_id
string | null

The unique identifier for the customer in your system

​
customer_email
string | null

The email address of the customer

​
purchase_order
string | null

The purchase order reference number

​
invoice_id
string | null

The unique invoice identifier/number

​
invoice_date
string<date> | null

The date when the invoice was issued

​
due_date
string<date> | null

The date when payment is due

​
note
string | null

Additional notes or comments for the invoice

​
vendor_name
string | null

The name of the vendor/seller/supplier

​
vendor_email
string | null

The email address of the vendor

​
vendor_address
string | null

The address of the vendor/seller

​
vendor_address_recipient
string | null

The recipient name at the vendor address

​
customer_address
string | null

The address of the customer/buyer

​
customer_address_recipient
string | null

The recipient name at the customer address

​
billing_address
string | null

The billing address (if different from customer address)

​
billing_address_recipient
string | null

The recipient name at the billing address

​
shipping_address
string | null

The shipping/delivery address

​
shipping_address_recipient
string | null

The recipient name at the shipping address

​
currency
enum<string>
default:EUR

Currency of the invoice (ISO 4217 currency code)

Available options:
EUR,
USD,
GBP,
JPY,
CHF,
CAD,
AUD,
NZD,
CNY,
INR,
SEK,
NOK,
DKK,
SGD,
HKD
​
tax_code
enum<string>
default:S

Tax category code of the invoice (e.g., S for standard rate, Z for zero rate, E for exempt)

Available options:
AE,
E,
S,
Z,
G,
O,
K,
L,
M,
B
​
vatex
enum<string> | null

VAT exemption reason code (required when tax_code is E or other exempt categories)

Available options:
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_note
string | null

Textual explanation for VAT exemption

​
subtotal

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_discount

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_tax

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

​
invoice_total

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_due

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

​
previous_unpaid_balance

The previous unpaid balance from prior invoices, if any. Must be positive and rounded to maximum 2 decimals

​
remittance_address
string | null

The address where payment should be sent or remitted to

​
remittance_address_recipient
string | null

The recipient name at the remittance address

​
service_address
string | null

The address where services were performed or goods were delivered

​
service_address_recipient
string | null

The recipient name at the service address

​
service_start_date
string<date> | null

The start date of the service period or delivery period

​
service_end_date
string<date> | null

The end date of the service period or delivery period

​
vendor_tax_id
string | null

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

Example:

"BE1018265814"

​
vendor_company_id
string | null

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.

Example:

"1018265814"

​
customer_tax_id
string | null

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

Example:

"BE1018265814"

​
customer_company_id
string | null

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.

Example:

"1018265814"

​
customer_peppol_id
string | null

Customer Peppol ID

Example:

"0208:0123456789"

​
payment_term
string | null

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

​
payment_details
PaymentDetailCreate · object[] | null
​
tax_details
TaxDetailCreate · object[] | null
​
items
LineItemCreate · object[]

At least one line item is required

Minimum array length: 1
​
attachments
DocumentAttachmentCreate · object[] | null
​
allowances
Allowance · object[] | null
​
charges
Charge · object[] | null

Response

Successful Response

​
id
string
required
​
created_at
string<date-time>
required
​
document_type
enum<string>
default:INVOICE

The type of document: INVOICE, CREDIT_NOTE, or DEBIT_NOTE

Available options:
INVOICE,
CREDIT_NOTE,
DEBIT_NOTE,
SELFBILLING_INVOICE,
SELFBILLING_CREDIT_NOTE
​
state
enum<string>
default:DRAFT

The current state of the document: DRAFT, TRANSIT, FAILED, SENT, or RECEIVED

Available options:
DRAFT,
TRANSIT,
FAILED,
SENT,
RECEIVED
​
direction
enum<string>
default:OUTBOUND

The direction of the document: INBOUND (purchases) or OUTBOUND (sales)

Available options:
INBOUND,
OUTBOUND
​
customer_name
string | null

The company name of the customer/buyer

​
customer_id
string | null

The unique identifier for the customer in your system

​
customer_email
string | null

The email address of the customer

​
purchase_order
string | null

The purchase order reference number

​
invoice_id
string | null

The unique invoice identifier/number

​
invoice_date
string<date> | null

The date when the invoice was issued

​
due_date
string<date> | null

The date when payment is due

​
note
string | null

Additional notes or comments for the invoice

​
vendor_name
string | null

The name of the vendor/seller/supplier

​
vendor_email
string | null

The email address of the vendor

​
vendor_address
string | null

The address of the vendor/seller

​
vendor_address_recipient
string | null

The recipient name at the vendor address

​
customer_address
string | null

The address of the customer/buyer

​
customer_address_recipient
string | null

The recipient name at the customer address

​
billing_address
string | null

The billing address (if different from customer address)

​
billing_address_recipient
string | null

The recipient name at the billing address

​
shipping_address
string | null

The shipping/delivery address

​
shipping_address_recipient
string | null

The recipient name at the shipping address

​
currency
enum<string>
default:EUR

Currency of the invoice (ISO 4217 currency code)

Available options:
EUR,
USD,
GBP,
JPY,
CHF,
CAD,
AUD,
NZD,
CNY,
INR,
SEK,
NOK,
DKK,
SGD,
HKD
​
tax_code
enum<string>
default:S

Tax category code of the invoice (e.g., S for standard rate, Z for zero rate, E for exempt)

Available options:
AE,
E,
S,
Z,
G,
O,
K,
L,
M,
B
​
vatex
enum<string> | null

VAT exemption reason code (required when tax_code is E or other exempt categories)

Available options:
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_note
string | null

Textual explanation for VAT exemption

​
subtotal
string | null

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_discount
string | null

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_tax
string | null

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

​
invoice_total
string | null

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_due
string | null

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

​
remittance_address
string | null

The address where payment should be sent or remitted to

​
remittance_address_recipient
string | null

The recipient name at the remittance address

​
service_address
string | null

The address where services were performed or goods were delivered

​
service_address_recipient
string | null

The recipient name at the service address

​
service_start_date
string<date> | null

The start date of the service period or delivery period

​
service_end_date
string<date> | null

The end date of the service period or delivery period

​
vendor_tax_id
string | null

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

Example:

"BE1018265814"

​
vendor_company_id
string | null

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.

Example:

"1018265814"

​
customer_tax_id
string | null

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

Example:

"BE1018265814"

​
customer_company_id
string | null

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.

Example:

"1018265814"

​
customer_peppol_id
string | null

Customer Peppol ID

Example:

"0208:0123456789"

​
payment_term
string | null

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

​
payment_details
PaymentDetail · object[] | null
​
tax_details
TaxDetail · object[] | null
​
items
LineItem · object[] | null
​
attachments
DocumentAttachment · object[] | null
​
allowances
AllowanceBase · object[] | null
​
charges
ChargeBase · object[] | null