POS Sale

GET

Get a POS Sale by saleId

Path parameters

tenantstringRequired

Your Entra Tenant ID. More details.

environmentstringRequired

Your Business Central Environment. More details.

companystringRequired

Your Business Central Company. More details.

saleIdUUIDRequired

The id of an active POS sale. This value can also be used to find the sale later when it’s either parked or completed as a POS Entry.

Headers

x-api-versiondateOptional

Used for API versioning. More details.

Query parameters

withLinesbooleanRequired

Response

This endpoint returns an object.

saleIdUUID

The id of an active POS sale. This value can also be used to find the sale later when it’s either parked or completed as a POS Entry.

receiptNostring

posUnitstring

startTimedatetime

customerNostring

saleLineslist of objectsOptional

paymentLineslist of objectsOptional

GET

1 curl -G https://api.npretail.app/01234567-89ab-cdef-0123-456789abcdef/production/CRONUS%20International%20Ltd./pos/sale/0d200aa6-aacd-4b78-b673-c4fb7461f5ea \
2      -H "Authorization: Bearer <apiKey>" \
3      -d withLines=true

200Retrieved

1 {
2   "saleId": "0d200aa6-aacd-4b78-b673-c4fb7461f5ea",
3   "receiptNo": "12345678",
4   "posUnit": "POS-031",
5   "startTime": "2024-01-01T17:00:00Z",
6   "customerNo": "C12345",
7   "saleLines": [
8     {
9       "sortKey": 10000,
10       "type": "Item",
11       "code": "M12345",
12       "variantCode": "SKU-12345",
13       "description": "Item Description",
14       "quantity": 2,
15       "unitPrice": 100,
16       "discountPct": 50,
17       "discountAmount": 100,
18       "vatPercent": 25,
19       "amountInclVat": 100,
20       "amount": 80
21     }
22   ],
23   "paymentLines": [
24     {
25       "sortKey": 20000,
26       "code": "CASH",
27       "description": "Cash",
28       "amountInclVat": 50
29     }
30   ]
31 }

Built with

1	curl -G https://api.npretail.app/01234567-89ab-cdef-0123-456789abcdef/production/CRONUS%20International%20Ltd./pos/sale/0d200aa6-aacd-4b78-b673-c4fb7461f5ea \
2	-H "Authorization: Bearer <apiKey>" \
3	-d withLines=true

1	{
2	"saleId": "0d200aa6-aacd-4b78-b673-c4fb7461f5ea",
3	"receiptNo": "12345678",
4	"posUnit": "POS-031",
5	"startTime": "2024-01-01T17:00:00Z",
6	"customerNo": "C12345",
7	"saleLines": [
8	{
9	"sortKey": 10000,
10	"type": "Item",
11	"code": "M12345",
12	"variantCode": "SKU-12345",
13	"description": "Item Description",
14	"quantity": 2,
15	"unitPrice": 100,
16	"discountPct": 50,
17	"discountAmount": 100,
18	"vatPercent": 25,
19	"amountInclVat": 100,
20	"amount": 80
21	}
22	],
23	"paymentLines": [
24	{
25	"sortKey": 20000,
26	"code": "CASH",
27	"description": "Cash",
28	"amountInclVat": 50
29	}
30	]
31	}