Get Sales Document

Beta

GET

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

GET

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

curl https://api.npretail.app/01234567-89ab-cdef-0123-456789abcdef/production/CRONUS%2520International%2520Ltd./ecommerce/documents/e2cfea9f-385e-4d83-8b50-42256885b03a \
     -H "x-np-api-key: <NaviPartner API Key>"

200Example Sales Document Response

{
  "externalNo": "WEBP000000001",
  "id": "4ca28ccc-e84b-4788-973c-c8ce5a59383b",
  "documentType": "order",
  "creationStatus": "created",
  "postingStatus": "invoiced",
  "currencyCode": "DKK",
  "currencyExchangeRate": 1,
  "externalDocumentNo": "WEBORD-123",
  "locationCode": "",
  "yourReference": "REF-789",
  "languageTag": "da-DK",
  "pricesExcludingVat": false,
  "ticketReservationToken": "ABC123456DEF789GHI",
  "captureProcessingStatus": "pending",
  "lastCaptureErrorMessage": "",
  "createdAt": "2026-09-09T08:14:22Z",
  "createdDocumentNo": "SO-104213",
  "postedDocumentNos": [
    "PSI-100871"
  ],
  "sellToCustomer": {
    "no": "CUST-10001",
    "name": "Acme Corporation",
    "name2": "Corporation",
    "address": "123 Main Street",
    "address2": "Suite 400",
    "postCode": "10001",
    "county": "New York",
    "city": "New York",
    "countryCode": "US",
    "contact": "Jane Doe",
    "email": "jane.doe@acme.com",
    "phone": "+1-555-123-4567",
    "ean": "1234567890123",
    "vatRegistrationNo": "US123456789",
    "invoiceEmail": "invoices@acme.com",
    "customerTemplate": "DOMESTIC",
    "configurationTemplate": "CUST000001"
  },
  "shipToCustomer": {
    "name": "John Smith",
    "name2": "Smith Enterprises",
    "address": "456 Shipping Avenue",
    "address2": "Floor 2",
    "postCode": "10002",
    "county": "New York",
    "city": "New York City",
    "countryCode": "US",
    "contact": "John Smith"
  },
  "shipment": {
    "shipmentMethod": "",
    "shipmentService": ""
  },
  "comments": [
    {
      "id": "59a2cbc4-503d-f011-a8fe-b571460f09c4",
      "comment": "This is a comment."
    }
  ],
  "salesDocumentLines": [
    {
      "id": "241e349d-2a3e-f011-a8fe-b571460f09c4",
      "type": "item",
      "no": "1100",
      "variantCode": "",
      "barcodeNo": "",
      "description": "test item",
      "unitPrice": 2000,
      "quantity": 2,
      "unitOfMeasure": "",
      "vatPercent": 25,
      "lineAmount": 2000,
      "requestedDeliveryDate": "2025-06-01",
      "invoicedQuantity": 0,
      "invoicedAmount": 0,
      "captured": true,
      "virtualItemProcessStatus": "processed",
      "virtualItemProcessErrorMessage": "",
      "attractionWalletProcessStatus": "processed",
      "attractionWalletProcessErrorMessage": "",
      "ticketReservationLineId": "bbe793c7-2489-43b7-ab77-23577d59ae71",
      "membershipId": "3a8b7c47-3228-4985-8bf0-bba09653f063",
      "membershipOperation": "renewMembership",
      "memberFirstName": "Jane",
      "memberLastName": "Doe",
      "memberMiddleName": "",
      "memberEmail": "jane.doe@example.com",
      "memberPhoneNo": "",
      "memberBirthday": "1985-04-12",
      "memberGender": "female",
      "memberAddress": "",
      "memberCity": "",
      "memberCountry": "",
      "memberPostCode": "",
      "memberNewsletter": "yes",
      "memberGdprApproval": "accepted",
      "membershipActivationDate": "2027-01-01",
      "subscription": false,
      "externalLineId": "ABCDEFGH-1234567890",
      "parentExternalLineId": "",
      "dimensions": [
        {
          "code": "PROJECT",
          "valueCode": "P-001"
        }
      ],
      "issuedAssets": [
        {
          "id": "8f9c2e1d-3a5b-4c6d-7e8f-9a0b1c2d3e4f",
          "type": "voucher",
          "referenceNo": "V-2807000107658"
        },
        {
          "id": "1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
          "type": "coupon",
          "referenceNo": "C-123456"
        }
      ],
      "customFields": {
        "myCustomField1": "myCustomField1Value",
        "myCustomField2": "myCustomField2Value"
      }
    }
  ],
  "payments": [
    {
      "id": "3c4543d0-d43e-f011-a8fe-b571460f09c4",
      "paymentMethodType": "paymentGateway",
      "externalPaymentMethodCode": "adyen_cc",
      "externalPaymentType": "mc",
      "paymentReference": "Z3ZR6HT5BNVPZQT5",
      "paymentAmount": 2000,
      "parToken": "",
      "pspToken": "",
      "cardBrand": "",
      "maskedCardNumber": "",
      "cardExpiryDate": "",
      "cardAliasToken": "",
      "capturedPaymentAmount": 0,
      "customFields": {
        "myCustomField1": "myCustomField1Value",
        "myCustomField2": "myCustomField2Value"
      }
    },
    {
      "id": "be02c86c-44fb-4c59-8dd2-84bfa136be93",
      "paymentMethodType": "voucher",
      "externalPaymentMethodCode": "",
      "externalPaymentType": "",
      "paymentReference": "2807000107658",
      "paymentAmount": 500,
      "parToken": "",
      "pspToken": "",
      "cardBrand": "",
      "maskedCardNumber": "",
      "cardExpiryDate": "",
      "cardAliasToken": "",
      "capturedPaymentAmount": 0,
      "customFields": {
        "myCustomField1": "myCustomField1Value",
        "myCustomField2": "myCustomField2Value"
      }
    }
  ],
  "dimensions": [
    {
      "code": "DEPARTMENT",
      "valueCode": "SALES"
    },
    {
      "code": "PROJECT",
      "valueCode": "P-001"
    }
  ],
  "customFields": {
    "myCustomField1": "myCustomField1Value",
    "myCustomField2": "myCustomField2Value"
  }
}

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.

documentIdUUIDRequired

Response

This endpoint returns an object.

externalNostring

idUUID

documentTypeenum

creationStatusenum

postingStatusenum

currencyCodestring

currencyExchangeRatedouble

externalDocumentNostring

locationCodestring

yourReferencestring

languageTagstring

pricesExcludingVatboolean

ticketReservationTokenstring

captureProcessingStatusenum

lastCaptureErrorMessagestring

createdAtdatetime

createdDocumentNostring

postedDocumentNoslist of strings

sellToCustomerobject

shipToCustomerobject

shipmentobject

commentslist of objects

salesDocumentLineslist of objects

paymentslist of objectsOptional

Present on Get Sales Document when the document has payment lines. Never present on Find Sales Documents hits, which carry no payment details.

dimensionslist of objectsOptional

List of dimensions stored on the document header, as supplied when the document was created or added by an extension to the incoming document. This is the document’s own dimension set, not the effective set the created sales header posts with: dimensions that come from default dimension setup are not included, and neither are dimensions an extension put directly on the created sales header.

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 serialization logic.

Authentication

Path parameters

Headers

Response