MembershipsPoints

Register Sale

Beta
Registers a sale, with points being added to membership based on the contents of it. Reservations on the membership can be finalized.

Path parameters

tenantstringRequired

Your Entra Tenant ID. More details.

environmentstringRequired

Your Business Central Environment. More details.

companystringRequired

Your Business Central Company. More details.

membershipIdUUIDRequired
Unique identifier for a membership.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

x-api-versiondateOptional

Used for API versioning. More details.

Request

This endpoint expects an object.
requestIdUUIDRequired
A unique identifier for the request. If you send the same requestId twice, it will be guaranteed to only trigger once.
externalReferenceNostringRequired
Your external reference number, such as a POS Receipt number, invoice number etc.
externalSystemIdentifierstringRequired
An identifier of your external system. This together with the entra app name identifies the external system that is making the operation.
externalSystemUserIdentifierstringOptional
An identifier for the user in the external system, e.g. a POS UnitId, a salesperson code in an external POS or a user ID in a customer support tool.
externalBusinessUnitIdentifierstringOptional
An identifier for the business unit of the external system.
itemslist of objectsOptional
reservationslist of objectsOptional

Response

This endpoint returns an object.
pointsEarnedinteger
The total points earned by the transaction
pointsCapturedinteger
the total amount of points captured by the transaction
newBalanceinteger
The points balance on the membership after the transaction