Liste des comptes débiteurs (solde recouvrable + balance âgée)

GET

/v1/accounts-receivable/accounts

curl --request GET \
  --url https://example.com/v1/accounts-receivable/accounts \
  --header 'X-API-Key: <X-API-Key>'

Comptes ordonnés par ancienneté décroissante. Par défaut, seuls les comptes avec solde recouvrable non nul sont retournés (includeSettled=true pour tout inclure). L’aging est calculé à la date asOf (défaut : aujourd’hui).

Authorizations

• ApiKeyAuth
• BearerAuth

Parameters

Query Parameters

asOf

string format: date

Date de référence de l’aging (YYYY-MM-DD, défaut : aujourd’hui)

includeSettled

boolean

Inclure les comptes soldés (défaut : false)

Responses

200

Liste des comptes débiteurs

Media type application/json

object

data

required

Array<object>

object

accountId

required

string format: uuid

partyKind

required

string

Allowed values: organization guest

organizationId

string format: uuid

nullable

guestId

string format: uuid

nullable

partyName

Nom d’affichage résolu (guest) — null si non résoluble

string

nullable

currency

required

string

Allowed values: EUR GBP

status

required

string

Allowed values: active on_hold closed

dunningState

required

string

Allowed values: none in_progress escalated litigation

dunningRegime

required

string

Allowed values: b2b b2c

balanceCents

required

Montant en centimes (bigint string)

string

oldestDueDate

string format: date

nullable

oldestOverdueDays

required

Jours de retard de la plus ancienne créance ouverte (≤ 0 si non échu)

integer

openReceivableCount

required

integer

aging

required

object

notDueCents

required

Montant en centimes (bigint string)

string

days0To30Cents

required

Montant en centimes (bigint string)

string

days31To60Cents

required

Montant en centimes (bigint string)

string

days61To90Cents

required

Montant en centimes (bigint string)

string

days90PlusCents

required

Montant en centimes (bigint string)

string

totalOverdueCents

required

Montant en centimes (bigint string)

string

totalCents

required

Montant en centimes (bigint string)

string

meta

required

object

page

required

integer

>= 1

pageSize

required

integer

>= 1

total

required

integer

Example

{
  "data": [
    {
      "partyKind": "organization",
      "currency": "EUR",
      "status": "active",
      "dunningState": "none",
      "dunningRegime": "b2b",
      "balanceCents": "12500",
      "aging": {
        "notDueCents": "12500",
        "days0To30Cents": "12500",
        "days31To60Cents": "12500",
        "days61To90Cents": "12500",
        "days90PlusCents": "12500",
        "totalOverdueCents": "12500",
        "totalCents": "12500"
      }
    }
  ],
  "meta": {
    "page": 1,
    "pageSize": 20,
    "total": 42
  }
}

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 périmètre non vérifiable

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
}