🔒 Redeem voucher V3

This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues.

This endpoint requires the following scopes: voucher:redeem.

Redeem a voucher on a sales order or an invoice. The voucher is added to the document as a negative line item that carries the voucher code, priced at the net equivalent of the amount for the tax treatment of the voucher, and the amount is taken from the voucher balance. The voucher is then bound to the customer of the document. The response carries the balance that is left. A voucher can be redeemed in several parts, on the same document or on different ones. Besides the scope, the user behind the token needs the permission to edit sales orders or invoices, depending on the document.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Body Params

Redeems part or all of the remaining balance of a voucher on a sales order or an invoice.

redeemedOn
object
required

The sales order or invoice the voucher is redeemed on. Create the document first, then redeem the voucher on it.

amount
object
required

The gross amount to redeem, in the currency of the voucher. It has to be greater than 0 and carries at most two decimal places. It may exceed neither the remaining balance of the voucher nor what the document carries in the tax class of the voucher - the gross value of its line items in that class, or of all line items for an exempt voucher, without line discounts. A line item the redemption is booked on does not count towards it.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

401

Unauthorized

403

Forbidden

404

Not Found

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json