CouponCoupon

Redeem Coupon

Beta
Redeems a coupon by reference number against a specific transaction. Consumes one unit of the coupon's remaining quantity and removes the caller's reservation if one exists.

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.

Request

This endpoint expects an object.
referenceNostringRequired
The reference number identifying the coupon to redeem.
documentNostringRequired
The external document number that links the redemption to a specific transaction.

Response

This endpoint returns an object.
redemptionobject