Skip to navigation
POSPOS Sale

Complete POS Sale

Finalizes a POS sale and moves it to POS Entry. The sale must be fully paid. Optionally creates a kitchen order if kitchenRequest is provided in the request body. The optional productType tells which self-service app completes the sale. Returns error if sale is not fully paid or payment validation fails.

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.

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

Headers

x-api-versiondateOptional

Used for API versioning. More details.

Request

This endpoint expects an optional object.
kitchenRequestobjectOptional
If provided, creates a kitchen order linked to this sale
productTypestringOptional

The self-service app that completes the sale. Known values are qr-food-order, self-service-food-order and retail-self-service. If it is missing, null or has another value, a sale with kitchenRequest counts as self-service-food-order and a sale without it counts as retail-self-service.

Response

This endpoint returns an object.
entryNointeger
entryIdUUID
documentNostring
totalAmountInclVatdouble
kitchenOrderNolongOptional

The kitchen order number if one was created during end-of-sale

kitchenOrderIdUUIDOptional

SystemId of the kitchen order, for use with GET /restaurant/{restaurantId}/orders/{orderId}