BObookingexperts
Vouchers

POST voucher

Changed on

Create a new Voucher.

post/v3/administrations/{administration_id}/vouchers

Request

Path parameters

administration_idstring required

Administration 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'.

Request body

Example request

{
  "data": {
    "type": "voucher",
    "attributes": {
      "locale": "cs"
    },
    "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"
          }
        }
      }
    }
  ]
}

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

  • 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

    • info

      added the new da-DK enum value to the request property //

    • info

      added the new en-GB enum value to the request property //

    • info

      added the new en-US enum value to the request property //