🔒 Create delivery note V3

post

https://{xentralId}.xentral.biz/api/v3/deliveryNotes

This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues.

This endpoint requires the following scopes: deliveryNote:create.

Create a new delivery note.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

address

object

required

project

documentDate

date

Date of the document. Current date is used when omitted.

language

string

Language of the document in an ISO-639-1 format.

tags

customFields

array of objects

Custom field values for the document. Only custom fields configured for this document in your Xentral instance are accepted here; the customField1 to customField40 keys exist on line items only. Listed keys are written, keys that are not listed are left untouched.

customFields

documentAddress

object

The recipients postal address of the document. If not provided, the address of the business partner will be used.

internalDesignation

string

length ≤ 255

Internal designation, might be displayed in the letterhead

bodyIntroduction

string

Introduction text for the body of the document

bodyOutroduction

string

Outroduction text for the body of the document

vatId

string

VAT ID of the business partner. Defaults to the VAT ID of the address when omitted.

deliveryTerms

string

Delivery terms for the document. Defaults to the delivery terms of the address when omitted.

internalComment

string

Internal comment for the document

printSettings

object

editor

object

Editor information

costCenter

string

length ≤ 255

Cost center for the document

financials

object

preferredWarehouse

object

The preferred warehouse.

sales

object

Sales information

shippingMethod

object

Reference to the shipping method used for this document. Defaults to the address, project or company shipping method when omitted.

salesOrder

object

orderPicking

object

masterReferenceNumber

string

length ≤ 255

Master reference number for the delivery note.

customerOrderNumber

string

length ≤ 255

Purchase order number provided by the customer, typically used in a B2B context.

commissionConsignmentWarehouse

object | null

Commission/consignment warehouse for the delivery note. This is used by the commission/consignment module.

lineItems

array of objects

List of line items for the delivery note.

lineItems

isDeliveryNoteToSupplier

boolean

Marks the document address as a supplier rather than a customer. The address must have a supplier number.

noInvoice

boolean

If true, the delivery note is excluded from invoicing: the collective invoice run skips it, and its sales order counts as invoiced - so that order no longer shows up as waiting for an invoice.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

401

Unauthorized

403

Forbidden

Language

Credentials

Bearer

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/problem+json

201Create a new delivery note.

400Failed validation

429Too Many Requests