Get POS Sale | NaviPartner | NP Retail API Documentation

Retrieves a POS sale by its ID with optional line details

x-np-api-keystring

API Key authentication via header

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 a POS sale. This can be provided by the API consumer when creating a new sale.

withLinesbooleanOptional

Include sale lines and payment lines in the response

This endpoint returns an object.

saleIdUUID

The id of a POS sale. This can be provided by the API consumer when creating a new sale.

receiptNostring

posUnitstring

posStorestring

datedate

startTimedatetime

customerNostring

salespersonCodestring

vatBusinessPostingGroupstring

saleLineslist of objects or null

paymentLineslist of objects or null

totalSalesAmountInclVatdouble or null

Total amount of all sale lines including VAT (only present when withLines=true)

totalPaymentAmountdouble or null

Total amount of all payment lines (only present when withLines=true)

1	import requests
2
3	url = "https://api.npretail.app/01234567-89ab-cdef-0123-456789abcdef/production/CRONUS%2520International%2520Ltd./pos/sale/0d200aa6-aacd-4b78-b673-c4fb7461f5ea"
4
5	querystring = {"withLines":"true"}
6
7	headers = {"x-np-api-key": "<NaviPartner API Key>"}
8
9	response = requests.get(url, headers=headers, params=querystring)
10
11	print(response.json())

1	{
2	"saleId": "0d200aa6-aacd-4b78-b673-c4fb7461f5ea",
3	"receiptNo": "12345678",
4	"posUnit": "QR_FOOD_APP",
5	"posStore": "STORE01",
6	"date": "2024-01-01",
7	"startTime": "2024-01-01T17:00:00Z",
8	"customerNo": "C12345",
9	"salespersonCode": "SP001",
10	"vatBusinessPostingGroup": "DOMESTIC"
11	}