v1

latestOpenAPI 3.0.02026-07-243271291.7 MB

Payments

GET payments

Returns payments of the administration

get/v3/administrations/{administration_id}/payments

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

fields[payment]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[paid_at]string

Filter on paid_at

filter[memo]string

Filter on memo

filter[terminal_identifier]string

Filter on terminal_identifier

filter[created_at]string

Filter on created_at

filter[updated_at]string

Filter on updated_at

filter[payment_method]string

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

filter[booking]string

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

filter[invoice]string

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

filter[register]string

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

filter[administration]string

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

filter[receipt]string

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

filter[settled_with]string

Filter on settled_with. 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, de, de-AT, de-CH, en, es, fr, fr-BE, fr-LU, it, nb, nl, nl-BE, pl, pt, tr. Default: 'en'.

Response

PaymentCollectionResponse