Create Sales Document

Beta

POST

https://api.npretail.app/:tenant/:environment/:company/ecommerce/documents

POST

/:tenant/:environment/:company/ecommerce/documents

$ curl -X POST https://api.npretail.app/01234567-89ab-cdef-0123-456789abcdef/production/CRONUS%2520International%2520Ltd./ecommerce/documents \
>      -H "x-np-api-key: <NaviPartner API Key>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "externalNo": "WEBP000000001",
>   "documentType": "order",
>   "sellToCustomer": {
>     "name": "Acme Corporation",
>     "address": "123 Main Street",
>     "postCode": "10001",
>     "city": "New York",
>     "email": "jane.doe@acme.com",
>     "no": "CUST-10001",
>     "address2": "Suite 400",
>     "county": "New York",
>     "countryCode": "US",
>     "contact": "Jane Doe",
>     "phone": "+1-555-123-4567",
>     "ean": "1234567890123",
>     "vatRegistrationNo": "US123456789",
>     "invoiceEmail": "invoices@acme.com",
>     "customerTemplate": "DOMESTIC",
>     "configurationTemplate": "CUST000001"
>   },
>   "payments": [
>     {
>       "paymentMethodType": "paymentGateway",
>       "externalPaymentMethodCode": "adyen_cc",
>       "paymentReference": "Z3ZR6HT5BNVPZQT5",
>       "paymentAmount": 2000,
>       "externalPaymentType": "mc",
>       "customFields": {
>         "myCustomField1": "myCustomField1Value",
>         "myCustomField2": "myCustomField2Value"
>       }
>     },
>     {
>       "paymentMethodType": "voucher",
>       "externalPaymentMethodCode": "",
>       "paymentReference": "2807000107658",
>       "paymentAmount": 500,
>       "externalPaymentType": "",
>       "customFields": {
>         "myCustomField1": "myCustomField1Value",
>         "myCustomField2": "myCustomField2Value"
>       }
>     }
>   ],
>   "salesDocumentLines": [
>     {
>       "type": "item",
>       "unitPrice": 2000,
>       "quantity": 2,
>       "vatPercent": 25,
>       "lineAmount": 2000,
>       "no": "1100",
>       "variantCode": "",
>       "barcodeNo": "",
>       "description": "test item",
>       "unitOfMeasure": "",
>       "externalLineId": "ABCDEFGH-1234567890",
>       "parentExternalLineId": "",
>       "customFields": {
>         "myCustomField1": "myCustomField1Value",
>         "myCustomField2": "myCustomField2Value"
>       }
>     }
>   ],
>   "currencyCode": "DKK",
>   "currencyExchangeRate": 1,
>   "externalDocumentNo": "WEBORD-123",
>   "yourReference": "REF-789",
>   "languageTag": "da-DK",
>   "pricesExcludingVat": false,
>   "customFields": {
>     "myCustomField1": "myCustomField1Value",
>     "myCustomField2": "myCustomField2Value"
>   },
>   "shipToCustomer": {
>     "name": "John Smith",
>     "address": "456 Shipping Avenue",
>     "postCode": "10002",
>     "city": "New York City",
>     "address2": "Floor 2",
>     "county": "New York",
>     "countryCode": "US",
>     "contact": "John Smith"
>   },
>   "comments": [
>     {
>       "comment": "This is a comment."
>     }
>   ],
>   "dimensions": [
>     {
>       "code": "DEPARTMENT",
>       "valueCode": "SALES"
>     },
>     {
>       "code": "PROJECT",
>       "valueCode": "P-001"
>     }
>   ]
> }'

201Example Sales Document Response

1 {
2   "id": "4ca28ccc-e84b-4788-973c-c8ce5a59383b"
3 }

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.

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.

Response

This endpoint returns an object.

idUUID

Authentication

Path parameters

Headers

Request

Response