Obtenir le détail d'un folio (charges + règlements + solde)

GET

/v1/folios/{id}

curl --request GET \
  --url https://example.com/v1/folios/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'X-API-Key: <X-API-Key>'

Authorizations

• ApiKeyAuth
• BearerAuth

Parameters

Path Parameters

id

required

string format: uuid

Identifiant du folio

Responses

200

Détail du folio

Media type application/json

object

data

required

object

id

required

string format: uuid

stayId

string format: uuid

nullable

currency

required

string

Allowed values: EUR GBP

status

required

string

Allowed values: open settled deferred closed

balance

required

object

ht

required

object

amountCents

required

Montant en centimes (bigint sérialisé en string)

string

currency

required

string

Allowed values: EUR GBP

tax

required

object

amountCents

required

Montant en centimes (bigint sérialisé en string)

string

currency

required

string

Allowed values: EUR GBP

total

required

object

amountCents

required

Montant en centimes (bigint sérialisé en string)

string

currency

required

string

Allowed values: EUR GBP

dueBalance

required

object

amountCents

required

Montant en centimes (bigint sérialisé en string)

string

currency

required

string

Allowed values: EUR GBP

entries

required

Array<object>

object

id

required

string format: uuid

amountHt

required

object

amountCents

required

Montant en centimes (bigint sérialisé en string)

string

currency

required

string

Allowed values: EUR GBP

taxRate

required

string

taxAmount

required

object

amountCents

required

Montant en centimes (bigint sérialisé en string)

string

currency

required

string

Allowed values: EUR GBP

chargeType

required

string

chargeNature

required

string

Allowed values: revenue disbursement collected_tax penalty

description

string

nullable

businessDate

required

string format: date

status

required

string

Allowed values: posted voided transferred

voidRef

string format: uuid

nullable

postedAt

required

string format: date-time

settlements

required

Array<object>

object

id

required

string format: uuid

method

required

string

amount

required

object

amountCents

required

Montant en centimes (bigint sérialisé en string)

string

currency

required

string

Allowed values: EUR GBP

paymentReference

string

nullable

externalRef

string

nullable

businessDate

required

string format: date

reversalRef

string

nullable

postedAt

required

string format: date-time

settledAt

string format: date-time

nullable

closedAt

string format: date-time

nullable

deferredReceivableRef

string

nullable

Example

{
  "data": {
    "currency": "EUR",
    "status": "open",
    "balance": {
      "ht": {
        "amountCents": "12000",
        "currency": "EUR"
      },
      "tax": {
        "amountCents": "12000",
        "currency": "EUR"
      },
      "total": {
        "amountCents": "12000",
        "currency": "EUR"
      }
    },
    "dueBalance": {
      "amountCents": "12000",
      "currency": "EUR"
    },
    "entries": [
      {
        "amountHt": {
          "amountCents": "12000",
          "currency": "EUR"
        },
        "taxRate": "0.10",
        "taxAmount": {
          "amountCents": "12000",
          "currency": "EUR"
        },
        "chargeType": "room_night",
        "chargeNature": "revenue",
        "status": "posted"
      }
    ],
    "settlements": [
      {
        "method": "card",
        "amount": {
          "amountCents": "12000",
          "currency": "EUR"
        }
      }
    ]
  }
}

403

Périmètre fiscal du folio non vérifiable (operatingMandateId absent ou inconnu)

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
}

404

Folio introuvable

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
}