Détail d'un compte débiteur (mouvements + relances)

GET

/v1/accounts-receivable/accounts/{id}

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

Créances imputées, encaissements, lettrage (append-only) et relances envoyées. 404 si le compte est introuvable.

Authorizations

• ApiKeyAuth
• BearerAuth

Parameters

Path Parameters

id

required

string format: uuid

Identifiant du compte débiteur

Query Parameters

asOf

string format: date

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

Responses

200

Détail du compte

Media type application/json

object

data

required

object

accountId

required

string format: uuid

partyKind

required

string

Allowed values: organization guest

organizationId

string

nullable

guestId

string

nullable

partyName

string

nullable

currency

required

string

Allowed values: EUR GBP

status

required

string

Allowed values: active on_hold closed

dunningState

string

Allowed values: none in_progress escalated litigation

dunningRegime

string

Allowed values: b2b b2c

openedAt

string format: date-time

closedAt

string format: date-time

nullable

balanceCents

required

Montant en centimes (bigint string)

string

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

receivables

required

Array<object>

object

id

string format: uuid

sourceKind

string

Allowed values: invoice long_stay_installment vacaf_aid

sourceInvoiceId

string

nullable

sourceInstallmentId

string

nullable

sourceVacafClaimId

string

nullable

originalCents

Montant en centimes (bigint string)

string

remainingCents

Montant en centimes (bigint string)

string

currency

string

Allowed values: EUR GBP

issuedAt

string format: date-time

dueDate

string format: date

overdueDays

integer

status

string

Allowed values: open partially_paid settled written_off

receipts

required

Array<object>

object

id

string format: uuid

method

string

Allowed values: transfer cheque direct_debit card cash other

settlementChannel

string

Allowed values: pos_cash off_ledger

amountCents

Montant en centimes (bigint string)

string

allocatedCents

Montant en centimes (bigint string)

string

currency

string

Allowed values: EUR GBP

receivedAt

string format: date-time

externalRef

string

nullable

status

string

Allowed values: unapplied partially_applied applied

allocations

required

Array<object>

object

id

string format: uuid

paymentReceiptId

string format: uuid

receivableId

string format: uuid

amountCents

Montant en centimes (bigint string)

string

allocatedAt

string format: date-time

reversalOf

string

nullable

dunningEvents

required

Array<object>

object

id

string format: uuid

receivableId

string format: uuid

dunningPolicyId

string format: uuid

levelNo

integer

channel

string

Allowed values: email postal sms phone_task

sentAt

string format: date-time

outcome

string

Allowed values: sent failed acknowledged paid_after

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"
    },
    "receivables": [
      {
        "sourceKind": "invoice",
        "originalCents": "12500",
        "remainingCents": "12500",
        "currency": "EUR",
        "status": "open"
      }
    ],
    "receipts": [
      {
        "method": "transfer",
        "settlementChannel": "pos_cash",
        "amountCents": "12500",
        "allocatedCents": "12500",
        "currency": "EUR",
        "status": "unapplied"
      }
    ],
    "allocations": [
      {
        "amountCents": "12500"
      }
    ],
    "dunningEvents": [
      {
        "channel": "email",
        "outcome": "sent"
      }
    ]
  }
}

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
}

404

Compte débiteur 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
}