📄 Get invoice status and file download links

Requête

Get an invoice's current status, its status details, and file download links.

Returns the invoice's lifecycle status and status details, plus download URLs for the requested format(s). If no format is specified, links for all available formats are returned.

Supported formats:

facturx: FacturX PDF with embedded XML (French standard)
ubl: Universal Business Language XML
cii: Cross Industry Invoice XML

Sécurité

APIKeyHeader

Chemin

invoice_idstring(Invoice Id)obligatoire

Requête

formatEInvoicingFormat (string) or null(Format)

Any of:

Supported e-invoicing formats for file downloads.

string(EInvoicingFormat)

Enum:"facturx""ubl""cii"

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/{invoice_id}?format=facturx' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'X-PDP-Client-Id: client_abc123'

Réponses

Successful Response

Corpsapplication/json

invoice_idstring(Invoice Id)obligatoire

Invoice ID

statusstring or null(Status)

Any of:

Current invoice status

string

directionstring or null(Direction)

Any of:

Invoice direction (incoming/outgoing)

string

invoice_numberstring or null(Invoice Number)

Any of:

Invoice number

string

created_atstring or null(Created At)

Any of:

When the invoice was created

string (date-time)

sellerobject or null(Seller)

Any of:

Seller information

buyerobject or null(Buyer)

Any of:

Buyer information

currency_codestring or null(Currency Code)

Any of:

Currency code

string

total_amountnumber or null(Total Amount)

Any of:

Total invoice amount

number

available_formatsArray of objects(Available Formats)obligatoire

List of available download formats

generated_atstring, (date-time)(Generated At)obligatoire

When the download links were generated

status_detailsSubmittedStatusDetails (object) or AcceptStatusDetails (object) or RefuseStatusDetails (object) or RejectionStatusDetails (object) or PaidStatusDetails (object) or CashedStatusDetails (object) or null(Status Details)

Any of:

status_details shape when status == submitted (200 Déposée).

Response

{
  "invoice_id": "string",
  "status": "string",
  "direction": "string",
  "invoice_number": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "seller": {},
  "buyer": {},
  "currency_code": "string",
  "total_amount": 0,
  "available_formats": [
    { … }
  ],
  "generated_at": "2019-08-24T14:15:22Z",
  "status_details": {
    "PeppolSendingFailed": "string",
    "NotPeppolRoutable": "string",
    "InvoiceSerializationFailed": "string",
    "InvalidInputError": "string",
    "reason_code": "NON_TRANSMISE",
    "reason_text": "string"
  }
}