/v1/peppol/sendOrder

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

The sendOrder Endpoint

This endpoints allows you to send an E-Invoice over the Peppol network. We use a JSON object similar to our Order object used in the Order endpoints.

This endpoint will create the valid UBL from the JSON provided and will directly send it on the Peppol network.

The minimum you have to provide the API is the following:

  • All data of the company used has to be filled in. You can this under Profile in the application
Field NameField ValueField Definition
Customer (Object)Customer Data PartyThe data from the customer
OrderDateDateTimeThe date from the order
ExpiryDateDateTimeThe expiry date from the order
OrderTypeTypesThe type of invoice
OrderDirectionTypesThe Direction of the invoice
OrderLinesOrderlinesThe items that are billed
PaidBooleanIf the invoice is already paid
PaidDateDateTimeThe date when the order was paid
CurrencyISO Standardthe currency of the invoice

Below you can find a JSON example of the table above

{
  "Customer": {
    "Name": "A customer name",
    "Street": "A street",
    "StreetNumber": "25",
    "Box": "",
    "Zipcode": "9000",
    "City": "Gent",
    "CountryCode": "BE",
    "IBAN": "BE0000001",
    "BIC": "KREDBEBB",
    "Mobile": "01234242",
    "Email": "[email protected]",
    "Contact": "Contact",
    "VATNumber": "BE0563846944",
    "PartyType": "Customer",
    "VATLiable": true,
  },
  "OrderNumber": "20220001",
  "OrderDate": "2019-12-03T18:51:21.261Z",
  "ExpiryDate": "2019-12-15T18:51:21.262Z",
  "OrderType": "Invoice",
  "OrderDirection": "Income",
  "OrderLines": [
    {
      "Quantity": 1,
      "UnitPriceExcl": 100.0,
      "Description": "my order line",
      "VATPercentage": 21.0
    }
  ],
  "Paid": true,
  "PaidDate": "2019-12-03T18:51:21.262Z",
  "Currency": "EUR",
}
//Only possible when you have signed the PeppolAnySender Contract
{
    "Supplier":{
    "Name": "A customer name",
    "Street": "A street",
    "StreetNumber": "25",
    "Box": "",
    "Zipcode": "9000",
    "City": "Gent",
    "CountryCode": "BE",
    "IBAN": "BE0000001",
    "BIC": "KREDBEBB",
    "Mobile": "01234242",
    "Email": "[email protected]",
    "Contact": "Contact",
    "VATNumber": "BE0563846944",
    "PartyType": "Customer",
  },
  "Customer": {
    "Name": "A customer name",
    "Street": "A street",
    "StreetNumber": "25",
    "Box": "",
    "Zipcode": "9000",
    "City": "Gent",
    "CountryCode": "BE",
    "IBAN": "BE0000001",
    "BIC": "KREDBEBB",
    "Mobile": "01234242",
    "Email": "[email protected]",
    "Contact": "Contact",
    "VATNumber": "BE0563846944",
    "PartyType": "Customer",
    "VATLiable": true,
  },
  "OrderNumber": "20220001",
  "OrderDate": "2019-12-03T18:51:21.261Z",
  "ExpiryDate": "2019-12-15T18:51:21.262Z",
  "OrderType": "Invoice",
  "OrderDirection": "Income",
  "OrderLines": [
    {
      "Quantity": 1,
      "UnitPriceExcl": 100.0,
      "Description": "my order line",
      "VATPercentage": 21.0
    }
  ],
  "Paid": true,
  "PaidDate": "2019-12-03T18:51:21.262Z",
  "Currency": "EUR",
}
Body Params
int32
int32
OrderPDF
object
Attachments
array of objects
Attachments
string
int32
int32
int32
Customer
object
Supplier
object
CounterParty
object
date-time
date-time
string
date-time
date-time
string
OrderLines
array of objects
OrderLines
BookingEntries
array of objects
BookingEntries
string
string
double
double
date-time
VatGroups
array of objects
VatGroups
string
double
double
double
string
Tags
array of strings
Tags
int32
string
string
boolean
date-time
string
string
ExternalProviderReferences
array of objects
ExternalProviderReferences
string
string
double
string
boolean
boolean
CustomFields
object
date-time
date-time
int32
date-time
int32
double
string
string
boolean
int32
double
string
date-time
boolean
PaymentLinks
array of objects
int32
string
string
boolean
CurrentDocumentDeliveryDetails
object
Messages
array of objects
Messages
AdditionalDocumentReference
array of objects
AdditionalDocumentReference
string
ContractDocumentReference
array of objects
ContractDocumentReference
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Response

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here!