BObookingexperts
Vouchers

GET vouchers

Changed on

Returns Vouchers of the administration

get/v3/administrations/{administration_id}/vouchers

Request

Path parameters

administration_idstring required

Administration ID

Query parameters

page[number]integer

Page number

page[size]integer

Page size

sortstring

Sort. Specify a comma separated list of attributes to sort on. Prefix attribute with a - to sort in descending order. Allowed attributes: id

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.

filter[id]string

Filter on ID

filter[code]string

Filter on code

filter[email]string

Filter on email

filter[locale]string

Filter on locale

filter[expires_at]string

Filter on expires_at

filter[payments]string

Filter on payments. Specify a comma separated list of IDs to filter on.

include_without_balanceboolean

When true, also returns vouchers that have been fully spent.

include_expiredboolean

When true, also returns vouchers that are expired.

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

VoucherCollectionResponse

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

  • ff81bc4fefa9Revision changes
    • warning

      added the new da-DK enum value to the /// response property for the response status

    • warning

      added the new en-GB enum value to the /// response property for the response status

    • warning

      added the new en-US enum value to the /// response property for the response status