Make the owner statement of a period from the stays that left in it

post/lodging/owner-statements

Make the owner statement of a period from the stays that left in it: earnings, commission, deductions and what is owed to the owner. A draft until a person issues it.

Before you call

Credential: Authorization: Bearer $KEY
Scope: bookings:admin
Sdk: bookings.ownerStatement.generate
Cli: bookings owner statement generate

Request bodyapplication/json, required

propertyIdstring (uuid)required
fromstringrequired
Pattern: ^\d{4}-\d{2}-\d{2}$.
tostringrequired
Pattern: ^\d{4}-\d{2}-\d{2}$.
adjustmentslist of object
Default: [].
- labelstringrequired
  At most 120 characters.
- amountMinorintegerrequired
  At least 0. At most 1000000000000.

Responses

201application/json
Success
400application/json
The request was malformed
- errorstringrequired
- messagestring
401application/json
No valid credential
- errorstringrequired
- messagestring
403application/json
The credential lacks the scope, origin or address
- errorstringrequired
- messagestring
429application/json
Over the key's rate limit; see Retry-After
- errorstringrequired
- messagestring

Example request

curl -X POST 'https://api.rivier.ai/lodging/owner-statements' \
  -H 'Authorization: Bearer $KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "propertyId": "string",
  "from": "string",
  "to": "string"
}'

$KEY stands for your own key. No key is shown or kept on this site.

This page as Markdown