--- title: "GET voucher" method: GET path: "/v3/administrations/{administration_id}/vouchers/{id}" tags: ["Vouchers"] --- # GET voucher `GET /v3/administrations/{administration_id}/vouchers/{id}` ## Request - Base URL: `https://api.bookingexperts.com` - URL: `https://api.bookingexperts.com/v3/administrations/{administration_id}/vouchers/{id}` - Auth: one of: - API key in header `X-API-KEY` - OAuth 2 - Authorization code: `/oauth/authorize` - Token URL: `/oauth/token` - TypeScript: (a function with typed inputs; its response is checked against the schema) Returns the Voucher for the given ID ## Path parameters - `administration_id` string, required - `id` string, required ## Query parameters - `fields[voucher]` string - `include` string ## Headers - `Accept-Language` string ## Response `200` VoucherResponse - object - `data` Voucher: A Voucher can be used as a (partial) payment method for a booking. It contains a balance that can be used to pay for a booking. - `id` string: ID - `type` string: Type - `attributes` object: Attributes - `code` string: You can either specify a code here (when your own system creates a code), or leave this empty and let the PMS generate a code. - `amount` object, required: The total amount of money of this voucher when issued - `currency` string - `value` string - `email` string: Email address used for communication with the guest. - `locale` 'cs' | 'da-DK' | 'de' | 'de-AT' | 'de-CH' | 'en-US' | 'en-GB' | 'es' | 'fr' | 'fr-BE' | 'fr-LU' | 'it' | 'nb' | 'nl' | 'nl-BE' | 'pl' | 'pt' | 'tr' | 'en' | 'da': Locale of guest, used for communication. - `expires_at` string, date - `masked_code` string: Code with all but the last 4 characters masked - `balance` object: The current amount of money on this voucher (amount minus the money already spent) - `currency` string - `value` string - `relationships` object: Relationships - `payments` object: Payments that have been made with this voucher. Include "payments.booking,payments.invoice.booking" to get all the bookings which were paid with the voucher. - `data` object[] - `id` string: payments ID - `type` string - `meta` object - `temp_id` string: UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known. - `method` string: Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update. - `meta` object: Metadata - `temp_id` string: UUID for internal resource linking. Should be omitted when the relationship ID is known. - `included` Payment[] - `id` string: ID - `type` string: Type - `attributes` object: Attributes - `paid_at` string, date: Local payment date - `amount` object: Paid amount - `currency` string - `value` string - `payment_type` 'cash' | 'pos' | 'psp' | 'batch' | 'transfer' | 'transfered_from_invoice' | 'transfered_to_invoice' | 'credited' | 'credit' | 'voucher' | 'transfered_to_voucher' | 'imported': Payment type. On create, this must be one of: cash, pin, psp, batch, transfer - `memo` string: An optional note - `terminal_identifier` string: An optional terminal identifier for POS payments - `description` string: A short description of this payment - `created_at` string, date-time - `updated_at` string, date-time - `relationships` object: Relationships - `payment_method` object - `data` object - `id` string: payment_method ID - `type` string - `meta` object - `temp_id` string: UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known. - `method` string: Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update. - `booking` object - `data` object - `id` string: booking ID - `type` string - `meta` object - `temp_id` string: UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known. - `method` string: Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update. - `invoice` object - `data` object - `id` string: invoice ID - `type` string - `meta` object - `temp_id` string: UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known. - `method` string: Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update. - `register` object: Register is required when linked with a payment_method (through payment_type) that has pos_enabled, like cash or pin payments. - `data` object - `id` string: register ID - `type` string - `meta` object - `temp_id` string: UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known. - `method` string: Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update. - `administration` object - `data` object - `id` string: administration ID - `type` string - `meta` object - `temp_id` string: UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known. - `method` string: Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update. - `receipt` object - `data` object - `id` string: receipt ID - `type` string - `meta` object - `temp_id` string: UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known. - `method` string: Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update. - `settled_with` object: Yields the payment on the settled invoice or receipt (if any) - `data` object - `id` string: settled_with ID - `type` string - `meta` object - `temp_id` string: UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known. - `method` string: Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update. - `meta` object: Metadata - `temp_id` string: UUID for internal resource linking. Should be omitted when the relationship ID is known. ## Other responses - `429`: Error - `default`: Error ## Changes - **2026-11-03** `ff81bc4fefa9`: 3 warning - added the new `da-DK` enum value to the `data/attributes/locale` response property for the response status `200` - added the new `en-GB` enum value to the `data/attributes/locale` response property for the response status `200` - added the new `en-US` enum value to the `data/attributes/locale` response property for the response status `200` [Operation history](https://skmtc.dev/bookingexperts/apis/booking-experts-api-v3/changes/v3/administrations/:administration_id/vouchers/:id/get.md) --- [API](https://skmtc.dev/bookingexperts/apis/booking-experts-api-v3.md) - [All operations](https://skmtc.dev/bookingexperts/apis/booking-experts-api-v3/llms.txt) - [OpenAPI document](https://skmtc.dev/bookingexperts/apis/booking-experts-api-v3/revisions/ff81bc4fefa9?raw)