BObookingexperts
Register Receipts

GET receipts

Returns receipts of the given App managed register

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

Request

Path parameters

administration_idstring required

Administration ID

register_idstring required

Register 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, created_at

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.

filter[id]string

Filter on ID

filter[created_at]string

Filter on created_at

filter[type]string

Filter on type

filter[register]string

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

filter[credited_receipt]string

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

filter[receipt_items]string

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

filter[payments]string

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

filter[signatures]string

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

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

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.