E-Reporting
How to get “API Key” from Portal?
To obtain the API key used with /auth/login, navigate to Settings → ERP Management → API Management in the Portal and use Generate. See Authentication.
France — E-Reporting
E-Reporting is mandatory in France for B2C transactions and cross-border B2B transactions not covered by e-invoicing.
Configure company for E-Reporting POST
Purpose of use: Run once per company before sending any reports.
Endpoint Information
| Property | Value |
|---|---|
| URL | /reporting/FR/config |
| Method | POST |
| Content-Type | application/json |
| Base URL | Stage Environment URLhttps://app-stage.docnova.ai/ Production Environment URLhttps://api.docnova.ai/ |
| Authorization | Bearer JWT |
Get company E-Reporting config GET
Endpoint Information
| Property | Value |
|---|---|
| URL | /reporting/FR/config/{companyId} |
| Method | GET |
| Base URL | Stage Environment URLhttps://app-stage.docnova.ai/ Production Environment URLhttps://api.docnova.ai/ |
| Authorization | Bearer JWT |
Update company E-Reporting config PUT
Endpoint Information
| Property | Value |
|---|---|
| URL | /reporting/FR/config/{companyId} |
| Method | PUT |
| Content-Type | application/json |
| Base URL | Stage Environment URLhttps://app-stage.docnova.ai/ Production Environment URLhttps://api.docnova.ai/ |
| Authorization | Bearer JWT |
Submit report (ERP flow — recommended) POST
Purpose of use: Single-step save + send to PPF.
Endpoint Information
| Property | Value |
|---|---|
| URL | /reporting/FR/submit |
| Method | POST |
| Content-Type | application/json |
| Base URL | Stage Environment URLhttps://app-stage.docnova.ai/ Production Environment URLhttps://api.docnova.ai/ |
| Authorization | Bearer JWT |
Request body (JSON)
{
"structure": "TRANSACTION_B2C",
"companyId": "uuid",
"apiKey": "optional-api-key",
"siren": "123456789",
"siret": "12345678901234",
"vatId": "FR12345678901",
"companyName": "Acme France SAS",
"declarantRoleCode": "FR:1",
"addressCountry": "FR",
"data": [
{
"invoiceNumber": "INV-2025-001",
"invoiceDate": "2025-04-01",
"invoiceDueDate": "2025-05-01",
"invoiceType": "380",
"currency": "EUR",
"category": "B2C",
"taxableAmount": 1000.00,
"vatRate": 20.0,
"vatAmount": 200.00,
"totalAmountInclVat": 1200.00
}
]
}
structure values
| Value | Description |
|---|---|
| TRANSACTION_B2C | B2C transaction e-reporting |
| TRANSACTION_B2B | International B2B e-reporting |
| PAYMENT_B2B | B2B payment data |
| PAYMENT_B2C | B2C payment data |
Responses
200 — Submitted to PPF
400 / 401 / 500
Get report status GET
Endpoint Information
| Property | Value |
|---|---|
| URL | /reporting/FR/status/{reportId} |
| Method | GET |
| Base URL | Stage Environment URLhttps://app-stage.docnova.ai/ Production Environment URLhttps://api.docnova.ai/ |
| Authorization | Bearer JWT |
List reports GET
Endpoint Information
| Property | Value |
|---|---|
| URL | /reporting/FR/list |
| Method | GET |
| Base URL | Stage Environment URLhttps://app-stage.docnova.ai/ Production Environment URLhttps://api.docnova.ai/ |
| Authorization | Bearer JWT |
Query parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| companyId | UUID | Yes | Company ID |
| reportType | String | No | Filter by structure type |
| status | String | No | PENDING, SENT, … |
| dateFrom | Date | No | YYYY-MM-DD |
| dateTo | Date | No | To date |
| siren | String | No | Filter by SIREN |
| page | Integer | No | 0-based |
| size | Integer | No | Page size |
Retry failed report POST
Endpoint Information
| Property | Value |
|---|---|
| URL | /reporting/FR/retry/{reportId} |
| Method | POST |
| Content-Type | application/json |
| Base URL | Stage Environment URLhttps://app-stage.docnova.ai/ Production Environment URLhttps://api.docnova.ai/ |
| Authorization | Bearer JWT |