Lister le registre des factures fournisseurs entrantes d'un mandat

GET

/v1/inbound-invoices

const url = 'https://example.com/v1/inbound-invoices?pageSize=20&page=1&operatingMandateId=2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';
const options = {method: 'GET', headers: {'X-API-Key': '<X-API-Key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://example.com/v1/inbound-invoices?pageSize=20&page=1&operatingMandateId=2489E9AD-2EE2-8E00-8EC9-32D5F69181C0' \
  --header 'X-API-Key: <X-API-Key>'

Tri received_at DESC (déterministe). Le XML source n’est jamais renvoyé.

Authorizations

ApiKeyAuth
BearerAuth

Parameters

Query Parameters

pageSize

integer

>= 1 <= 100

Example

page

integer

>= 1

Example

operatingMandateId

required

string format: uuid

Responses

200

Page du registre

application/json

object

data

required

Array<object>

object

required

string format: uuid

operatingMandateId

required

string format: uuid

status

required

string

Allowed values: received rejected

syntax

required

string

nullable

Allowed values: cii ubl

sourceHash

required

SHA-256 hex du document source (dédup octet-identique)

string

supplierName

required

BT-27 — null si rejet

string

nullable

supplierSiren

required

BT-30 quand SIREN français (9 chiffres)

string

nullable

supplierVatNumber

required

BT-31

string

nullable

buyerName

required

BT-44

string

nullable

invoiceNumber

required

BT-1

string

nullable

typeCode

required

BT-3 (UNTDID 1001)

string

nullable

Allowed values: 380 381 386

issueDate

required

BT-2

string format: date

nullable

currency

required

BT-5 (ISO 4217)

string

nullable

totalLineNet

required

object

amountCents

required

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

string

currency

required

string

Allowed values: EUR GBP

totalTaxExclusive

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

totalGrand

required

object

amountCents

required

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

string

currency

required

string

Allowed values: EUR GBP

totalDue

required

object

amountCents

required

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

string

currency

required

string

Allowed values: EUR GBP

vatBreakdown

required

Ventilation TVA BG-23 (vide si rejet)

Array<object>

object

categoryCode

required

BT-118 (UNTDID 5305)

string

ratePercent

required

BT-119 (%)

string

nullable

taxable

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

rejectionReasons

required

Raisons structurées de non-conformité (vide si received)

Array<object>

object

rule

required

string

detail

required

string

receivedAt

required

string format: date-time

nullable

meta

required

object

page

required

integer

>= 1

pageSize

required

integer

>= 1

total

required

integer

Example

{
  "data": [
    {
      "status": "received",
      "syntax": "cii",
      "typeCode": "380",
      "totalLineNet": {
        "amountCents": "12000",
        "currency": "EUR"
      },
      "totalTaxExclusive": {
        "amountCents": "12000",
        "currency": "EUR"
      },
      "totalTax": {
        "amountCents": "12000",
        "currency": "EUR"
      },
      "totalGrand": {
        "amountCents": "12000",
        "currency": "EUR"
      },
      "totalDue": {
        "amountCents": "12000",
        "currency": "EUR"
      },
      "vatBreakdown": [
        {
          "ratePercent": "20.00",
          "taxable": {
            "amountCents": "12000",
            "currency": "EUR"
          },
          "tax": {
            "amountCents": "12000",
            "currency": "EUR"
          }
        }
      ],
      "rejectionReasons": [
        {
          "rule": "BR-CO-15"
        }
      ]
    }
  ],
  "meta": {
    "page": 1,
    "pageSize": 20,
    "total": 42
  }
}

400

Corps ou paramètres invalides

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é

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

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
}