v1

latestOpenAPI 3.0.02026-07-243271291.7 MB

Agreements

GET agreements

Returns agreements of the administration

get/v3/administrations/{administration_id}/agreements

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[agreement]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[active_from]string

Filter on active_from

filter[active_till]string

Filter on active_till

filter[apply_rent_earned_account_to_costs]string

Filter on apply_rent_earned_account_to_costs

filter[discount_mode]string

Filter on discount_mode

filter[created_at]string

Filter on created_at

filter[updated_at]string

Filter on updated_at

filter[owner]string

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

filter[inventory_object]string

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

filter[owners_profile]string

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

filter[commission_agreement]string

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

filter[poule_based_discounts]string

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

filter[rentable_identity]string

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

filter[rent_earned_account]string

Filter on rent_earned_account. 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

AgreementCollectionResponse