Sales DocumentsEcommerce

Create Sales Document

Beta

Authentication

x-np-api-keystring
API Key authentication via header

Path parameters

tenantstringRequired

Your Entra Tenant ID. More details.

environmentstringRequired

Your Business Central Environment. More details.

companystringRequired

Your Business Central Company. More details.

Headers

x-api-versiondateOptional

Used for API versioning. More details.

Request

This endpoint expects an object.
externalNostringRequired
Max. length 20 symbols.
documentTypeenumRequired
sellToCustomerobjectRequired
paymentslist of objectsRequired
salesDocumentLineslist of objectsRequired
currencyCodestringOptional
Max. length 10 symbols.
currencyExchangeRatedoubleOptional
externalDocumentNostringOptional
Max. length 35 symbols.
locationCodestringOptional
Max. length 10 symbols.
yourReferencestringOptional
languageTagstringOptional

IETF BCP 47 / RFC 5646 language tag (e.g. “da-DK”, “en-US”).

pricesExcludingVatbooleanOptional
ticketReservationTokenstringOptional

Used to link the sales document to a ticket reservation, enabling the system to associate ordered ticket items with their pre-reserved admissions. Obtained as the token from the Ticket Reservation API.

customFieldsobjectOptional

This section allows you to add custom fields as key-value pairs. You can handle these fields by subscribing to our extension publishers and implementing custom deserialization logic.

shipToCustomerobjectOptional
shipmentobjectOptional
commentslist of objectsOptional
dimensionslist of objectsOptional

List of dimensions to attach to the created document. Item, shipment fee and voucher lines inherit these unless the line supplies the same dimension code itself; comment lines do not inherit them. An empty or omitted array attaches nothing; a null value is treated the same as omitting the property. Supplying the same dimension code twice in one array rejects the whole request.

Response

This endpoint returns an object.
idUUID