Get POS Entry

GET

https://api.npretail.app/:tenant/:environment/:company/pos/entry/:entryId

GET

/:tenant/:environment/:company/pos/entry/:entryId

$ 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>"

200ExampleGetPOSEntry

1 {
2   "entryId": "7f8e9d6c-5a4b-3c2d-1e0f-9a8b7c6d5e4f",
3   "entryNo": 12345,
4   "documentNo": "STORE01-001-00123",
5   "entryDate": "2024-01-15",
6   "startingTime": "14:30:00",
7   "endingTime": "14:32:00",
8   "posStore": "STORE01",
9   "posUnit": "POS001",
10   "entryType": "Direct Sale",
11   "totalAmountInclVat": 180,
12   "taxAmount": 36,
13   "postEntryStatus": "Posted",
14   "postItemEntryStatus": "Posted",
15   "postingDate": "2024-01-15",
16   "documentDate": "2024-01-15",
17   "fiscalNo": "FIS-2024-00123",
18   "description": "Regular Sale",
19   "customerNo": "C10001",
20   "customerId": "a1b2c3d4-e5f6-47a8-b9c0-d1e2f3a4b5c6",
21   "salespersonCode": "SP001",
22   "salesLines": [
23     {
24       "lineId": "8c3f4dbe-d927-4e8a-89ab-12345678abcd",
25       "sortKey": 10000,
26       "type": "Item",
27       "code": "ITEM-001",
28       "description": "Premium Widget",
29       "quantity": 2,
30       "unitPrice": 100,
31       "vatPercent": 25,
32       "discountPct": 10,
33       "discountAmount": 20,
34       "amountInclVat": 180,
35       "taxAmount": 36,
36       "excludeFromPosting": false,
37       "variantCode": "RED",
38       "unitOfMeasure": "PCS",
39       "locationCode": "MAIN"
40     }
41   ],
42   "paymentLines": [
43     {
44       "lineId": "2b5a9c4e-f123-4d56-78ab-98765432fedc",
45       "sortKey": 10000,
46       "paymentMethodCode": "CASH",
47       "description": "Cash Payment",
48       "amountInclVat": 180,
49       "isEFT": false
50     }
51   ],
52   "taxLines": [
53     {
54       "taxPercent": 25,
55       "taxBaseAmount": 144,
56       "taxAmount": 36,
57       "taxIdentifier": "STANDARD"
58     }
59   ]
60 }

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

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

postItemEntryStatusenum

postingDatedate

documentDatedate

fiscalNostringOptional

descriptionstringOptional

customerNostringOptional

customerIdUUIDOptional

salespersonCodestringOptional

externalDocumentNostringOptional

rowVersionstringOptional

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

salesLineslist of objectsOptional

paymentLineslist of objectsOptional

taxLineslist of objectsOptional

Authentication

Path parameters

Headers

Response