🔒 Update voucher V3

patch

https://{xentralId}.xentral.biz/api/v3/vouchers/{id}

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:update.

Correct a voucher. The code cannot be changed - a customer already holds it - and neither can the remaining balance, which follows from the redemptions of the voucher.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

Body Params

The fields of a voucher that can be corrected after it was issued. Neither the code nor the remaining balance is among them: a code is what a customer already holds, and a balance changes by redeeming the voucher, not by describing the result.

faceValue

object

The value the voucher was issued with. It can only be corrected while the voucher has not been redeemed yet, and not once the invoice it was sold with has been sent. At most 1000000.00, with at most two decimal places.

validFrom

date | null

The first day the voucher can be redeemed. Pass null for a validity that has no start.

expiresAt

date | null

The last day the voucher can be redeemed. Pass null for a voucher that does not expire.

onlyForCustomer

boolean

When true, only the customer the voucher is bound to may redeem it. Turning it on requires the voucher to be bound to a customer, either already or through the same request.

printSettings

object

customer

The customer the voucher is bound to. Pass null to unbind it. Every redemption rebinds the voucher to the customer of the document it was redeemed on.

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

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/problem+json

200Correct a voucher. The code cannot be changed - a customer already holds it - and neither can the remaining balance, which follows from the redemptions of the voucher.

400Failed validation

409Problem occurred

429Too Many Requests