BObookingexperts
Register Receipts

POST receipt

Create a new receipt for a register. You can only create receipts for registers that have been added via POST register (App Managed).

post/v3/administrations/{administration_id}/registers/{register_id}/receipts

Request

Path parameters

administration_idstring required

Administration ID

register_idstring required

Register ID

Query parameters

fields[receipt]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": "receipt",
    "relationships": {
      "register": {
        "data": {
          "type": "register"
        }
      },
      "credited_receipt": {
        "data": {
          "type": "receipt"
        }
      },
      "receipt_items": {
        "data": [
          {
            "type": "receipt_item"
          }
        ]
      },
      "payments": {
        "data": [
          {
            "type": "payment"
          }
        ]
      },
      "signatures": {
        "data": [
          {
            "type": "signature"
          }
        ]
      }
    }
  },
  "included": [
    {
      "id": "1",
      "type": "register"
    }
  ]
}

Response

ReceiptCollectionResponse

Example response

{
  "data": [
    {
      "id": "1",
      "type": "receipt",
      "relationships": {
        "register": {
          "data": {
            "type": "register"
          }
        },
        "credited_receipt": {
          "data": {
            "type": "receipt"
          }
        },
        "receipt_items": {
          "data": [
            {
              "type": "receipt_item"
            }
          ]
        },
        "payments": {
          "data": [
            {
              "type": "payment"
            }
          ]
        },
        "signatures": {
          "data": [
            {
              "type": "signature"
            }
          ]
        }
      }
    }
  ],
  "included": [
    {
      "id": "1",
      "type": "register"
    }
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.