🔍 List invoices with filtering

Requête

List invoices with status, direction, mandate, and time-based filtering options.

This endpoint allows you to query invoices using various filters to find invoices that match your criteria.

Sécurité

APIKeyHeader

Requête

statusInvoiceStatus (string) or null(Status)

Any of:

Invoice lifecycle status.

Aligned with DGFIP e-invoicing status codes (statuts de cycle de vie):

draft — Pre-submission state
submitted (200) — Invoice deposited and validated by the sending PDP (mandatory)
received (202) — Invoice received by the receiving PDP
processed — Invoice accepted for routing
accepted (205) — Recipient accepted the invoice
partially_accepted (206) — Recipient approved only part of the invoice
refused (210) — Recipient refused the invoice (mandatory)
paid (211) — Buyer marked the invoice as paid
rejected (213) — PDP detected an anomaly on the invoice (mandatory)
cashed (212) — Supplier confirmed receipt of payment (mandatory)

string(InvoiceStatus)

Enum:"draft""submitted""received""processed""accepted""partially_accepted""refused""paid""rejected""cashed"

directionDirection (string) or null(Direction)

Any of:

Filter by direction (incoming or outgoing)

string(Direction)

Enum:"incoming""outgoing"

mandate_idstring or null(Mandate Id)

Any of:

Filter by mandate - returns invoices whose seller or buyer electronic address matches the Peppol address of the given mandate (must belong to this client)

string

invoice_numberstring or null(Invoice Number)

Any of:

Filter by invoice number

string

updated_afterstring or null(Updated After)

Any of:

ISO timestamp to get invoices updated after this time

string

updated_beforestring or null(Updated Before)

Any of:

ISO timestamp to get invoices updated before this time

string

created_afterstring or null(Created After)

Any of:

ISO timestamp to get invoices created after this time

string

created_beforestring or null(Created Before)

Any of:

ISO timestamp to get invoices created before this time

string

limitinteger, [ 0 .. 100 ](Limit)

Maximum number of invoices to return

Par défaut:50

offsetinteger, >= 0(Offset)

Number of invoices to skip for pagination

Par défaut:0

X-PDP-Client-Idstring(X-Pdp-Client-Id)obligatoire

ID of the PDP Client for which the operation is performed

Examples:

Sandbox client

client_abc123

curl -i -X GET \
  'https://pdp.seqino.dev/api/invoicing/invoices?status=draft&direction=incoming&mandate_id=string&invoice_number=string&updated_after=string&updated_before=string&created_after=string&created_before=string&limit=50&offset=0' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'X-PDP-Client-Id: client_abc123'

Réponses

List of invoices matching filters

Corpsapplication/json

invoicesArray of objects(Invoices)obligatoire

total_countinteger(Total Count)obligatoire

limitinteger(Limit)obligatoire

offsetinteger(Offset)obligatoire

filters_appliedobject(InvoiceQueryFilter)obligatoire

queried_atstring(Queried At)obligatoire

Response

{
  "invoices": [
    { … }
  ],
  "total_count": 0,
  "limit": 0,
  "offset": 0,
  "filters_applied": {
    "status": "string",
    "direction": "string",
    "mandate_id": "string",
    "invoice_number": "string",
    "updated_after": "2019-08-24T14:15:22Z",
    "updated_before": "2019-08-24T14:15:22Z",
    "created_after": "2019-08-24T14:15:22Z",
    "created_before": "2019-08-24T14:15:22Z"
  },
  "queried_at": "string"
}