POSPOS Sale

Search POS Sale

Returns active POS sales matching the supplied POS unit and optional user filter as an array, or HTTP 404 when no sale matches. GET /pos/sale is a backward-compatible alias with identical behavior. Query parameter names are case-sensitive. The optional userId and filterToCurrentUserId query parameters are mutually exclusive; supplying both returns HTTP 400.

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.

Headers

x-api-versiondateOptional

Used for API versioning. More details.

Query parameters

posunitstringRequired

The POS unit number to search for (required)

userIdstringOptional

Restrict returned sales to this user ID. The maximum length is 50 characters; longer values return HTTP 400. Cannot be combined with filterToCurrentUserId.

filterToCurrentUserIdbooleanOptional
When true, restrict returned sales to the current Business Central AL user. When false, do not apply a user filter. Cannot be combined with userId.
withLinesbooleanOptional
Include sale lines and payment lines in the response

Response

This endpoint returns a list of objects.
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
genBusinessPostingGroupstring
saleLineslist of objectsOptional
paymentLineslist of objectsOptional
totalSalesAmountInclVatdoubleOptional

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

totalPaymentAmountdoubleOptional

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