EInvoicing

E-invoicing networks, registration, validation, and document submission

Get identifier requirements for a country#

GET /api/v1/einvoicing/identifiers/requirements

Requires authentication (Bearer token) and the X-Organization-Id header.

Parameters#

Responses#

Example request#

curl -X GET "https://app.encryptinvoice.com/api/v1/einvoicing/identifiers/requirements" \
  -H "Authorization: Bearer {{access_token}}" \
  -H "X-Organization-Id: {{organization_id}}" \
  -H "Accept: application/json"

List e-invoicing invoices#

GET /api/v1/einvoicing/invoices

Requires authentication (Bearer token) and the X-Organization-Id header.

Parameters#

Responses#

Example request#

curl -X GET "https://app.encryptinvoice.com/api/v1/einvoicing/invoices" \
  -H "Authorization: Bearer {{access_token}}" \
  -H "X-Organization-Id: {{organization_id}}" \
  -H "Accept: application/json"

Submit an invoice to the e-invoicing network#

POST /api/v1/einvoicing/invoices

Requires authentication (Bearer token) and the X-Organization-Id header.

Request body#

Responses#

Example request#

curl -X POST "https://app.encryptinvoice.com/api/v1/einvoicing/invoices" \
  -H "Authorization: Bearer {{access_token}}" \
  -H "X-Organization-Id: {{organization_id}}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "organization_id": 1,
    "invoice_id": 1,
    "recipient_identifier_scheme": "string",
    "recipient_identifier_value": "string",
    "recipient_name": "string",
    "recipient_country_code": "string",
    "provider": "string"
}'

Get e-invoicing invoice details#

GET /api/v1/einvoicing/invoices/{id}

Requires authentication (Bearer token) and the X-Organization-Id header.

Parameters#

Responses#

Example request#

curl -X GET "https://app.encryptinvoice.com/api/v1/einvoicing/invoices/{id}" \
  -H "Authorization: Bearer {{access_token}}" \
  -H "X-Organization-Id: {{organization_id}}" \
  -H "Accept: application/json"

Get document evidence for an e-invoice#

GET /api/v1/einvoicing/invoices/{id}/evidence

Requires authentication (Bearer token) and the X-Organization-Id header.

Parameters#

Responses#

Example request#

curl -X GET "https://app.encryptinvoice.com/api/v1/einvoicing/invoices/{id}/evidence" \
  -H "Authorization: Bearer {{access_token}}" \
  -H "X-Organization-Id: {{organization_id}}" \
  -H "Accept: application/json"

Get e-invoice status and tracking information#

GET /api/v1/einvoicing/invoices/{id}/status

Requires authentication (Bearer token) and the X-Organization-Id header.

Parameters#

Responses#

Example request#

curl -X GET "https://app.encryptinvoice.com/api/v1/einvoicing/invoices/{id}/status" \
  -H "Authorization: Bearer {{access_token}}" \
  -H "X-Organization-Id: {{organization_id}}" \
  -H "Accept: application/json"

Get available e-invoicing networks#

GET /api/v1/einvoicing/networks

Requires authentication (Bearer token) and the X-Organization-Id header.

Responses#

Example request#

curl -X GET "https://app.encryptinvoice.com/api/v1/einvoicing/networks" \
  -H "Authorization: Bearer {{access_token}}" \
  -H "X-Organization-Id: {{organization_id}}" \
  -H "Accept: application/json"

Search for a participant on the e-invoicing network#

GET /api/v1/einvoicing/participants/search

Requires authentication (Bearer token) and the X-Organization-Id header.

Parameters#

Responses#

Example request#

curl -X GET "https://app.encryptinvoice.com/api/v1/einvoicing/participants/search" \
  -H "Authorization: Bearer {{access_token}}" \
  -H "X-Organization-Id: {{organization_id}}" \
  -H "Accept: application/json"

Get available e-invoicing providers#

GET /api/v1/einvoicing/providers

Requires authentication (Bearer token) and the X-Organization-Id header.

Responses#

Example request#

curl -X GET "https://app.encryptinvoice.com/api/v1/einvoicing/providers" \
  -H "Authorization: Bearer {{access_token}}" \
  -H "X-Organization-Id: {{organization_id}}" \
  -H "Accept: application/json"

Register the organization for e-invoicing#

POST /api/v1/einvoicing/register

Requires authentication (Bearer token) and the X-Organization-Id header.

Creates the legal entity and its network identifiers through the shared registration service (same path as the app UI). Requires identifier_scheme + identifier_value (e.g. 0208, FR:SIRET, or FR:CTC for the French CTC SIREN mesh) plus legal_name, country_code and address fields; optional vat_number adds the country VAT identifier. FR:CTC identifiers carry the DGFiP annuaire: annuaire_start_date sets when the line becomes routable and must be at least two days out (default and minimum: today + 2; earlier dates return 422), and routing-code meshes (SIREN_SIRET_routingcode) additionally require routing_code_label + routing_code_address as an object {line1, zip, city, country} — line1, zip and city are mandatory, country defaults to FR (422 without them). The provider is resolved from the country — a mismatching provider returns 422. Network-model registrations stay pending until superadmin approval; the provider is never called at this point. Returns the same shape as GET /einvoicing/registration. (#956)

Request body#

Responses#

Example request#

curl -X POST "https://app.encryptinvoice.com/api/v1/einvoicing/register" \
  -H "Authorization: Bearer {{access_token}}" \
  -H "X-Organization-Id: {{organization_id}}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "organization_id": 1,
    "legal_name": "string",
    "country_code": "string",
    "city": "string",
    "postal_code": "string",
    "address_line1": "string",
    "address_line2": "string",
    "state": "string",
    "identifier_scheme": "string",
    "identifier_value": "string",
    "vat_number": "string",
    "tax_reference_id": "string",
    "acts_as_sender": true,
    "acts_as_receiver": true,
    "tax_registered": true,
    "document_types": [],
    "provider": "string",
    "annuaire_start_date": "string",
    "routing_code_label": "string",
    "es_sii_registered": true,
    "es_foral_territory": "string",
    "routing_code_address": {}
}'

Get the e-invoicing registration status#

GET /api/v1/einvoicing/registration

Requires authentication (Bearer token) and the X-Organization-Id header.

Registration status, roles and the network identifiers of the organization's legal entity. Each identifier row carries scheme, identifier, status and the verbatim networks_specification — for FR:CTC that is the dual peppol+dgfip block including the annuaire start_date. (#763, #956)

Responses#

Example request#

curl -X GET "https://app.encryptinvoice.com/api/v1/einvoicing/registration" \
  -H "Authorization: Bearer {{access_token}}" \
  -H "X-Organization-Id: {{organization_id}}" \
  -H "Accept: application/json"

Update the e-invoicing registration scope/roles#

PATCH /api/v1/einvoicing/registration

Requires authentication (Bearer token) and the X-Organization-Id header.

Accepts acts_as_sender / acts_as_receiver and pushes the change to the network provider server-side (Storecove PATCH) when the entity is registered there; a failed provider push reverts the local change and returns 502. At least one role must stay enabled (422 otherwise). provider is accepted but must match the resolved provider — switching providers is a re-registration, not a scope update (422). Returns the same shape as the GET. (#923)

Request body#

Responses#

Example request#

curl -X PATCH "https://app.encryptinvoice.com/api/v1/einvoicing/registration" \
  -H "Authorization: Bearer {{access_token}}" \
  -H "X-Organization-Id: {{organization_id}}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "organization_id": 1,
    "acts_as_sender": true,
    "acts_as_receiver": true,
    "provider": "string",
    "es_sii_registered": true,
    "es_foral_territory": "string"
}'

Validate invoice before sending (preflight check)#

POST /api/v1/einvoicing/validate

Requires authentication (Bearer token) and the X-Organization-Id header.

Request body#

Responses#

Example request#

curl -X POST "https://app.encryptinvoice.com/api/v1/einvoicing/validate" \
  -H "Authorization: Bearer {{access_token}}" \
  -H "X-Organization-Id: {{organization_id}}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "organization_id": 1,
    "invoice_id": 1,
    "recipient_identifier_scheme": "string",
    "recipient_identifier_value": "string",
    "recipient_name": "string",
    "recipient_country_code": "string",
    "provider": "string"
}'