EInvoicing

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

Get identifier requirements for a country#

GET /api/v1/einvoicing/identifiers/requirements

Nécessite une authentification (jeton Bearer) et l’en-tête X-Organization-Id.

Paramètres#

Réponses#

Exemple de requête#

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

Nécessite une authentification (jeton Bearer) et l’en-tête X-Organization-Id.

Paramètres#

Réponses#

Exemple de requête#

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

Nécessite une authentification (jeton Bearer) et l’en-tête X-Organization-Id.

Corps de la requête#

Réponses#

Exemple de requête#

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}

Nécessite une authentification (jeton Bearer) et l’en-tête X-Organization-Id.

Paramètres#

Réponses#

Exemple de requête#

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

Nécessite une authentification (jeton Bearer) et l’en-tête X-Organization-Id.

Paramètres#

Réponses#

Exemple de requête#

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

Nécessite une authentification (jeton Bearer) et l’en-tête X-Organization-Id.

Paramètres#

Réponses#

Exemple de requête#

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

Nécessite une authentification (jeton Bearer) et l’en-tête X-Organization-Id.

Réponses#

Exemple de requête#

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

Nécessite une authentification (jeton Bearer) et l’en-tête X-Organization-Id.

Paramètres#

Réponses#

Exemple de requête#

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

Nécessite une authentification (jeton Bearer) et l’en-tête X-Organization-Id.

Réponses#

Exemple de requête#

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"

Inscrire l'organisation à la facturation électronique#

POST /api/v1/einvoicing/register

Nécessite une authentification (jeton Bearer) et l’en-tête X-Organization-Id.

Crée l'entité légale et ses identifiants réseau via le service d'inscription partagé (même chemin que l'interface). Requiert identifier_scheme + identifier_value (p. ex. 0208, FR:SIRET, ou FR:CTC pour le maillage SIREN du CTC français) ainsi que legal_name, country_code et l'adresse ; vat_number (optionnel) ajoute l'identifiant TVA du pays. Les identifiants FR:CTC portent l'annuaire DGFiP : annuaire_start_date fixe la date à partir de laquelle la ligne est routable pour la transmission et doit être au moins à deux jours (défaut et minimum : aujourd'hui + 2 ; une date antérieure renvoie 422), et les maillages avec code routage (SIREN_SIRET_coderoutage) exigent en plus routing_code_label + routing_code_address sous forme d'objet {line1, zip, city, country} — line1, zip et city sont obligatoires, country vaut FR par défaut (422 sinon). Le prestataire est résolu depuis le pays — un provider divergent renvoie 422. Les inscriptions en modèle réseau restent pending jusqu'à l'approbation superadmin. Renvoie la même forme que GET /einvoicing/registration. (#956)

Corps de la requête#

Réponses#

Exemple de requête#

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

Nécessite une authentification (jeton Bearer) et l’en-tête X-Organization-Id.

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)

Réponses#

Exemple de requête#

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

Nécessite une authentification (jeton Bearer) et l’en-tête X-Organization-Id.

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)

Corps de la requête#

Réponses#

Exemple de requête#

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

Nécessite une authentification (jeton Bearer) et l’en-tête X-Organization-Id.

Corps de la requête#

Réponses#

Exemple de requête#

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"
}'