Get POS Entry | NaviPartner | NP Retail API Documentation

curl https://api.npretail.app/01234567-89ab-cdef-0123-456789abcdef/production/CRONUS%2520International%2520Ltd./pos/entry/7f8e9d6c-5a4b-3c2d-1e0f-9a8b7c6d5e4f \
     -H "x-np-api-key: <NaviPartner API Key>"

{
  "entryId": "7f8e9d6c-5a4b-3c2d-1e0f-9a8b7c6d5e4f",
  "entryNo": 12345,
  "documentNo": "STORE01-001-00123",
  "entryDate": "2024-01-15",
  "startingTime": "14:30:00",
  "endingTime": "14:32:00",
  "posStore": "STORE01",
  "posUnit": "POS001",
  "entryType": "Direct Sale",
  "totalAmountInclVat": 180,
  "taxAmount": 36,
  "postEntryStatus": "Posted",
  "postItemEntryStatus": "Posted",
  "postingDate": "2024-01-15",
  "documentDate": "2024-01-15",
  "fiscalNo": "FIS-2024-00123",
  "description": "Regular Sale",
  "customerNo": "C10001",
  "customerId": "a1b2c3d4-e5f6-47a8-b9c0-d1e2f3a4b5c6",
  "salespersonCode": "SP001",
  "salesLines": [
    {
      "lineId": "8c3f4dbe-d927-4e8a-89ab-12345678abcd",
      "sortKey": 10000,
      "type": "Item",
      "code": "ITEM-001",
      "description": "Premium Widget",
      "quantity": 2,
      "unitPrice": 100,
      "vatPercent": 25,
      "discountPct": 10,
      "discountAmount": 20,
      "amountInclVat": 180,
      "taxAmount": 36,
      "variantCode": "RED",
      "unitOfMeasure": "PCS",
      "locationCode": "MAIN"
    }
  ],
  "paymentLines": [
    {
      "lineId": "2b5a9c4e-f123-4d56-78ab-98765432fedc",
      "sortKey": 10000,
      "paymentMethodCode": "CASH",
      "description": "Cash Payment",
      "amountInclVat": 180,
      "isEFT": false
    }
  ],
  "taxLines": [
    {
      "taxPercent": 25,
      "taxBaseAmount": 144,
      "taxAmount": 36,
      "taxIdentifier": "STANDARD"
    }
  ]
}

Get a single POS Entry by its ID, including all sales lines, payment lines, and tax lines

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.

entryIdUUIDRequired

The unique identifier of a POS Entry

Headers

x-api-versiondateOptional

Used for API versioning. More details.

Response

This endpoint returns an object.

entryIdUUID

The unique identifier of a POS Entry

entryNointeger

documentNostring

entryDatedate

startingTimestring

Time when the transaction started (format HH:MM:SS)

endingTimestring

Time when the transaction ended (format HH:MM:SS)

posStorestring

posUnitstring

entryTypeenum

totalAmountInclVatdouble

taxAmountdouble

postEntryStatusenum

Allowed values:

postItemEntryStatusenum

Allowed values:

postingDatedate

documentDatedate

fiscalNostring

descriptionstring

customerNostring

customerIdUUID

salespersonCodestring

externalDocumentNostring

rowVersionstring

Row version for sync operations (only present when sync=true in request)

salesLineslist of objects

paymentLineslist of objects

taxLineslist of objects