GET agreements

get

https://api.bookingexperts.com/v3/administrations/{administration_id}/agreements

Returns agreements of the administration

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

administration_id

string

required

Administration ID

Query Params

page[number]

integer

≥ 1

Page number

page[size]

integer

1 to 100

Page size

sort

string

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

include

string

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-Language

string

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

Responses

Language

Credentials

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/vnd.api+json

200AgreementCollectionResponse

429Error

defaultError