Aller au contenu

Lire une facture émise

GET
/v1/invoices/{invoiceId}
curl --request GET \
--url https://example.com/v1/invoices/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
--header 'X-API-Key: <X-API-Key>'
invoiceId
required
string format: uuid

Facture

Media type application/json
object
data
required
object
id
required
string format: uuid
invoiceNumber
required
string
invoiceKind
required
string
Allowed values: standard deposit final
invoiceDate
required
string format: date
status
required
string
Allowed values: draft finalized issued cancelled
totalHt
required
object
amountCents
required

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

string
currency
required
string
Allowed values: EUR GBP
totalTax
required
object
amountCents
required

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

string
currency
required
string
Allowed values: EUR GBP
totalTtc
required
object
amountCents
required

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

string
currency
required
string
Allowed values: EUR GBP
operatingMandateId
required
string format: uuid
folioId
required
string format: uuid
billToName
required
string
servicePeriodFrom
string format: date
nullable
servicePeriodTo
string format: date
nullable
Example
{
"data": {
"invoiceNumber": "FAC-2026-0000001",
"invoiceKind": "standard",
"status": "draft",
"totalHt": {
"amountCents": "12000",
"currency": "EUR"
},
"totalTax": {
"amountCents": "12000",
"currency": "EUR"
},
"totalTtc": {
"amountCents": "12000",
"currency": "EUR"
},
"billToName": "Jean Dupont"
}
}

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
}

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
}

Ressource 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
}