Sign in
OpenAPI 3.0.42026-08-132058862.1 MB

4bf95cbc375f

Vouchers

Get all vouchers

Returns all rate vouchers filtered by Service, voucher code or voucher identifier. Note this operation uses Pagination and supports Portfolio Access Tokens.

post/api/connector/v1/vouchers/getAll

Request body

ClientTokenstring required

Token identifying the client application.

AccessTokenstring required

Access token of the client application.

Clientstring required

Name and version of the client application.

EnterpriseIdsstring[] nullable

Unique identifiers of the Enterprises. If not specified, the operation returns data for all enterprises within scope of the Access Token.

ServiceIdsstring[] required

Unique identifiers of Services where the vouchers belong to.

VoucherIdsstring[] nullable

Unique identifiers of vouchers.

CompanyIdsstring[] nullable

Unique identifiers of the companies.

VoucherCodeValuesstring[] nullable

Value of voucher codes used by customers.

ActivityStatesActivityStates[] nullable

Whether to return only active, only deleted, or both types of record. If not specified, both active and deleted records will be returned.

ExternalIdentifiersstring[] nullable

Identifiers of Voucher from external systems.

Response

OK

Cursorstring uuid nullable

Unique identifier of the item one newer in time order than the items to be returned. If Cursor is not specified, i.e. null, then the latest or most recent items will be returned.