Lister les folios (par stayId, reservationId, ou établissement+businessDate)

GET

/v1/folios

curl --request GET \
  --url 'https://example.com/v1/folios?pageSize=20&page=1' \
  --header 'X-API-Key: <X-API-Key>'

Authorizations

• ApiKeyAuth
• BearerAuth

Parameters

Query Parameters

pageSize

integer

>= 1 <= 100

Example

20

page

integer

>= 1

Example

1

businessDate

string format: date

establishmentId

string format: uuid

reservationId

string format: uuid

stayId

string format: uuid

Responses

200

Page de folios avec leurs entrées postées

Media type application/json

object

data

required

Array<object>

object

id

required

string format: uuid

stayId

string format: uuid

nullable

reservationId

string format: uuid

nullable

operatingMandateId

string format: uuid

nullable

kind

string

status

required

string

Allowed values: open settled closed archived

currency

required

string

Allowed values: EUR GBP

openedAt

required

string format: date-time

closedAt

string format: date-time

nullable

totalHtCents

required

Total HT des entrées postées (bigint string)

string

totalTaxCents

required

Total TVA des entrées postées (bigint string)

string

entries

Array<object>

object

id

required

string format: uuid

chargeType

required

string

chargeNature

required

string

Allowed values: revenue disbursement

amountHtCents

required

string

taxAmountCents

required

string

taxRate

string

currency

required

string

businessDate

required

string format: date

status

required

string

meta

required

object

page

required

integer

>= 1

pageSize

required

integer

>= 1

total

required

integer

Example

{
  "data": [
    {
      "kind": "stay",
      "status": "open",
      "currency": "EUR",
      "entries": [
        {
          "chargeNature": "revenue"
        }
      ]
    }
  ],
  "meta": {
    "page": 1,
    "pageSize": 20,
    "total": 42
  }
}

400

Scope manquant ou paramètres invalides

Media type application/json

object

code

required

Code machine de l’erreur

string

message

required

Message lisible

string

origin

Origine domaine de l’erreur (optionnel)

object

boundedContext

string

module

string

status

required

integer

traceId

required

Identifiant de corrélation pour le support

string

Example

{
  "code": "RESERVATION_NOT_FOUND",
  "message": "Réservation introuvable",
  "status": 404
}

401

Non authentifié

Media type application/json

object

code

required

Code machine de l’erreur

string

message

required

Message lisible

string

origin

Origine domaine de l’erreur (optionnel)

object

boundedContext

string

module

string

status

required

integer

traceId

required

Identifiant de corrélation pour le support

string

Example

{
  "code": "RESERVATION_NOT_FOUND",
  "message": "Réservation introuvable",
  "status": 404
}

403

Permission refusée ou scope IDOR

Media type application/json

object

code

required

Code machine de l’erreur

string

message

required

Message lisible

string

origin

Origine domaine de l’erreur (optionnel)

object

boundedContext

string

module

string

status

required

integer

traceId

required

Identifiant de corrélation pour le support

string

Example

{
  "code": "RESERVATION_NOT_FOUND",
  "message": "Réservation introuvable",
  "status": 404
}