Vouchers
GET voucher
Changed onReturns the Voucher for the given ID
get/v3/administrations/{administration_id}/vouchers/{id}
Request
- Base URLhttps://api.bookingexperts.com
- Auth
- API key in header X-API-KEY
- or OAuth 2Authorization code/oauth/authorizeToken URL/oauth/token
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
administration_idstring required
Administration ID
idstring required
Resource ID
Query parameters
fields[voucher]string
Fieldset. Specify a comma separated list of attributes to return
includestring
Includes list. Specify a comma separated list of resources to include.
Headers
Accept-Languagestring
Supported languages. A comma separated list with one or more of the following locales: 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. Default: 'en'.
Response
VoucherResponse
Example response
{
"data": {
"id": "1",
"type": "voucher",
"attributes": {
"locale": "cs",
"masked_code": "********1234"
},
"relationships": {
"payments": {
"data": [
{
"type": "payment"
}
]
}
}
},
"included": [
{
"id": "1",
"type": "payment",
"relationships": {
"payment_method": {
"data": {
"type": "payment_method"
}
},
"booking": {
"data": {
"type": "booking"
}
},
"invoice": {
"data": {
"type": "invoice"
}
},
"register": {
"data": {
"type": "register"
}
},
"administration": {
"data": {
"type": "administration"
}
},
"receipt": {
"data": {
"type": "receipt"
}
},
"settled_with": {
"data": {
"type": "payment"
}
}
}
}
]
}Changes
- warning
added the new
da-DKenum value to the//response property for the response status - warning
added the new
en-GBenum value to the//response property for the response status - warning
added the new
en-USenum value to the//response property for the response status
- warning