@factpulse/sdk 4.0.3 → 4.1.2

package/docs/FacturXConversionApi.md

@@ -7,6 +7,7 @@ All URIs are relative to *https://factpulse.fr*
 |[**convertDocumentAsyncApiV1ConvertAsyncPost**](#convertdocumentasyncapiv1convertasyncpost) | **POST** /api/v1/convert/async | Convert a document to Factur-X (async mode)|
 |[**downloadFileApiV1ConvertConversionIdDownloadFilenameGet**](#downloadfileapiv1convertconversioniddownloadfilenameget) | **GET** /api/v1/convert/{conversion_id}/download/{filename} | Download a generated file|
 |[**getConversionStatusApiV1ConvertConversionIdStatusGet**](#getconversionstatusapiv1convertconversionidstatusget) | **GET** /api/v1/convert/{conversion_id}/status | Check conversion status|
+|[**getConversionTaskStatusApiV1ConvertTasksTaskIdConversionStatusGet**](#getconversiontaskstatusapiv1converttaskstaskidconversionstatusget) | **GET** /api/v1/convert/tasks/{task_id}/conversion-status | Get typed conversion task status|
 |[**resumeConversionApiV1ConvertConversionIdResumePost**](#resumeconversionapiv1convertconversionidresumepost) | **POST** /api/v1/convert/{conversion_id}/resume | Resume a conversion with corrections|
 |[**resumeConversionAsyncApiV1ConvertConversionIdResumeAsyncPost**](#resumeconversionasyncapiv1convertconversionidresumeasyncpost) | **POST** /api/v1/convert/{conversion_id}/resume/async | Resume a conversion asynchronously|
 
@@ -175,6 +176,59 @@ const { status, data } = await apiInstance.getConversionStatusApiV1ConvertConver
  - **Accept**: application/json
 
 
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successful Response |  -  |
+|**422** | Validation Error |  -  |
+|**401** | Authentication required - Invalid or missing JWT token |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **getConversionTaskStatusApiV1ConvertTasksTaskIdConversionStatusGet**
+> ConversionTaskStatus getConversionTaskStatusApiV1ConvertTasksTaskIdConversionStatusGet()
+
+Typed status endpoint for document conversion tasks.  Returns a strongly-typed `result` discriminated on `result.status`: - **SUCCESS**: `ConversionSuccessTaskResult` - **PENDING_INPUT**: `ConversionPendingInputResult` (missing fields) - **VALIDATION_FAILED**: `ConversionValidationFailedResult` - **ERROR**: `ConversionErrorResult`
+
+### Example
+
+```typescript
+import {
+    FacturXConversionApi,
+    Configuration
+} from '@factpulse/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new FacturXConversionApi(configuration);
+
+let taskId: string; //Celery task ID returned by POST /convert (default to undefined)
+
+const { status, data } = await apiInstance.getConversionTaskStatusApiV1ConvertTasksTaskIdConversionStatusGet(
+    taskId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **taskId** | [**string**] | Celery task ID returned by POST /convert | defaults to undefined|
+
+
+### Return type
+
+**ConversionTaskStatus**
+
+### Authorization
+
+[APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|

package/docs/FacturXInvoice.md

@@ -12,7 +12,7 @@ Name | Type | Description | Notes
 **submission_mode** | [**SubmissionMode**](SubmissionMode.md) |  | [optional] [default to undefined]
 **recipient** | [**Recipient**](Recipient.md) |  | [default to undefined]
 **supplier** | [**Supplier**](Supplier.md) |  | [default to undefined]
-**invoicing_framework** | [**InvoicingFramework**](InvoicingFramework.md) |  | [default to undefined]
+**invoicing_framework** | [**InvoicingFramework**](InvoicingFramework.md) |  | [optional] [default to undefined]
 **references** | [**InvoiceReferences**](InvoiceReferences.md) |  | [default to undefined]
 **totals** | [**InvoiceTotals**](InvoiceTotals.md) |  | [default to undefined]
 **invoice_lines** | [**Array<InvoiceLine>**](InvoiceLine.md) |  | [optional] [default to undefined]

package/docs/FacturXPDFXMLVerificationApi.md

@@ -5,6 +5,7 @@ All URIs are relative to *https://factpulse.fr*
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
 |[**getVerificationStatusApiV1VerificationVerifyAsyncTaskIdStatusGet**](#getverificationstatusapiv1verificationverifyasynctaskidstatusget) | **GET** /api/v1/verification/verify-async/{task_id}/status | Get status of an asynchronous verification|
+|[**getVerificationTypedStatusApiV1VerificationVerifyAsyncTaskIdTypedStatusGet**](#getverificationtypedstatusapiv1verificationverifyasynctaskidtypedstatusget) | **GET** /api/v1/verification/verify-async/{task_id}/typed-status | Get typed status of an asynchronous verification|
 |[**verifyPdfAsyncApiV1VerificationVerifyAsyncPost**](#verifypdfasyncapiv1verificationverifyasyncpost) | **POST** /api/v1/verification/verify-async | Verify PDF/XML Factur-X compliance (asynchronous)|
 |[**verifyPdfSyncApiV1VerificationVerifyPost**](#verifypdfsyncapiv1verificationverifypost) | **POST** /api/v1/verification/verify | Verify PDF/XML Factur-X compliance (synchronous)|
 
@@ -52,6 +53,59 @@ const { status, data } = await apiInstance.getVerificationStatusApiV1Verificatio
  - **Accept**: application/json
 
 
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successful Response |  -  |
+|**422** | Validation Error |  -  |
+|**401** | Authentication required - Invalid or missing JWT token |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **getVerificationTypedStatusApiV1VerificationVerifyAsyncTaskIdTypedStatusGet**
+> VerificationTypedTaskStatus getVerificationTypedStatusApiV1VerificationVerifyAsyncTaskIdTypedStatusGet()
+
+Typed status endpoint for async verification tasks.  Returns a strongly-typed `result` (discriminated on `result.status`): - **SUCCESS**: `VerificationSuccessTaskResult` with `verification_result` - **ERROR**: `TaskErrorResult` in AFNOR format
+
+### Example
+
+```typescript
+import {
+    FacturXPDFXMLVerificationApi,
+    Configuration
+} from '@factpulse/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new FacturXPDFXMLVerificationApi(configuration);
+
+let taskId: string; //Celery task ID returned by /verify-async endpoint (default to undefined)
+
+const { status, data } = await apiInstance.getVerificationTypedStatusApiV1VerificationVerifyAsyncTaskIdTypedStatusGet(
+    taskId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **taskId** | [**string**] | Celery task ID returned by /verify-async endpoint | defaults to undefined|
+
+
+### Return type
+
+**VerificationTypedTaskStatus**
+
+### Authorization
+
+[APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|

package/docs/FacturXValidationApi.md

@@ -6,7 +6,6 @@ All URIs are relative to *https://factpulse.fr*
 |------------- | ------------- | -------------|
 |[**validateFacturxPdfApiV1ProcessingValidateFacturxPdfPost**](#validatefacturxpdfapiv1processingvalidatefacturxpdfpost) | **POST** /api/v1/processing/validate-facturx-pdf | Validate a complete Factur-X PDF|
 |[**validateFacturxPdfAsyncApiV1ProcessingValidateFacturxAsyncPost**](#validatefacturxpdfasyncapiv1processingvalidatefacturxasyncpost) | **POST** /api/v1/processing/validate-facturx-async | Validate a Factur-X PDF (asynchronous with polling)|
-|[**validateXmlApiV1ProcessingValidateXmlPost**](#validatexmlapiv1processingvalidatexmlpost) | **POST** /api/v1/processing/validate-xml | Validate an existing Factur-X XML|
 
 # **validateFacturxPdfApiV1ProcessingValidateFacturxPdfPost**
 > PDFValidationResultAPI validateFacturxPdfApiV1ProcessingValidateFacturxPdfPost()
@@ -137,63 +136,3 @@ const { status, data } = await apiInstance.validateFacturxPdfAsyncApiV1Processin
 
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
-# **validateXmlApiV1ProcessingValidateXmlPost**
-> ValidationSuccessResponse validateXmlApiV1ProcessingValidateXmlPost()
-
-Validates a Factur-X XML file against Schematron business rules according to EN 16931 standard.  ## Applied Standard  **Schematron ISO/IEC 19757-3**: Business rules validation language for XML - Semantic validation (beyond XSD syntax) - European EN 16931 business rules - French-specific Factur-X rules - Arithmetic calculations and data consistency  ## Profiles and validated rules  ### MINIMUM (45 rules) - Unique invoice identifier - Dates (issue, due date) - Party identifiers (SIRET/SIREN) - Total gross amount  ### BASIC (102 rules) - All MINIMUM rules - Detailed invoice lines - Basic VAT calculations - Payment methods - References (order, contract)  ### EN16931 (178 rules) - All BASIC rules - **European rules (BR-xx)**: 81 business rules - **French rules (FR-xx)**: 12 France-specific rules - **Advanced calculations (CR-xx)**: 32 calculation rules - **Standardized codes (CL-xx)**: 52 code lists  ### EXTENDED (210+ rules) - All EN16931 rules - Logistics information - Advanced accounting data - Multiple external references  ## Checks performed  ### 1. Syntax validation - Correct XML parsing (UTF-8, well-formed) - UN/CEFACT namespaces present - Hierarchical structure respected  ### 2. Business rules (BR-xx) Examples: - `BR-1`: Invoice total must equal sum of line totals + document-level amounts - `BR-CO-10`: Sum of VAT base amounts must equal invoice net total - `BR-16`: Invoice currency code must be in ISO 4217 list  ### 3. French rules (FR-xx) Examples: - `FR-1`: Supplier SIRET must have 14 digits - `FR-2`: Customer SIRET must have 14 digits (if present) - `FR-5`: Intra-EU VAT number must be in format FRxx999999999  ### 4. Calculation rules (CR-xx) - Net + VAT = Gross amounts - Sum of lines = Document total - Discounts and surcharges correctly applied - Compliant rounding (2 decimals for amounts)  ### 5. Standardized codes (CL-xx) - ISO 3166-1 alpha-2 country codes - ISO 4217 currency codes - UN/ECE Rec 20 measurement units - VAT codes (types, categories, exemptions) - SchemeID for identifiers (0002=SIREN, 0009=SIRET, etc.)  ## Validation process  1. **XSLT loading**: Schematron file converted to XSLT (Saxon-HE) 2. **Transformation**: Rules applied to XML 3. **Results analysis**: Extraction of errors (`failed-assert`) and warnings (`successful-report`) 4. **Report**: Structured list of non-conformities  ## Responses  **200 OK**: Compliant XML ```json {   \"message\": \"XML is compliant with EN16931 profile\" } ```  **400 Bad Request**: Non-compliant XML ```json {   \"detail\": [     \"[BR-1] Invoice total (120.00) does not match calculated sum (100.00 + 20.00)\",     \"[FR-1] Supplier SIRET must contain exactly 14 digits\"   ] } ```  ## Use cases  - **Pre-validation**: Verify XML before PDF/A integration - **Debugging**: Precisely identify generation errors - **Testing**: Validate test or example XMLs - **Compliance**: Ensure European and French rules are met - **Development**: Quick testing without PDF generation  ## Processing time  - MINIMUM profile: ~0.5 second - EN16931 profile: ~1-2 seconds - EXTENDED profile: ~2-3 seconds
-
-### Example
-
-```typescript
-import {
-    FacturXValidationApi,
-    Configuration
-} from '@factpulse/sdk';
-
-const configuration = new Configuration();
-const apiInstance = new FacturXValidationApi(configuration);
-
-let xmlFile: File; //Factur-X XML file to validate (.xml format). (default to undefined)
-let profile: APIProfile; //Validation profile (MINIMUM, BASIC, EN16931, EXTENDED). (optional) (default to undefined)
-let skipBrFr: boolean; // (optional) (default to undefined)
-
-const { status, data } = await apiInstance.validateXmlApiV1ProcessingValidateXmlPost(
-    xmlFile,
-    profile,
-    skipBrFr
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **xmlFile** | [**File**] | Factur-X XML file to validate (.xml format). | defaults to undefined|
-| **profile** | **APIProfile** | Validation profile (MINIMUM, BASIC, EN16931, EXTENDED). | (optional) defaults to undefined|
-| **skipBrFr** | [**boolean**] |  | (optional) defaults to undefined|
-
-
-### Return type
-
-**ValidationSuccessResponse**
-
-### Authorization
-
-[APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
-
-### HTTP request headers
-
- - **Content-Type**: multipart/form-data
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Successful Response |  -  |
-|**400** | XML does not comply with Factur-X profile rules |  -  |
-|**422** | Validation Error |  -  |
-|**401** | Authentication required - Invalid or missing JWT token |  -  |
-
-[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
-

package/docs/FactureElectroniqueModelsInvoiceTypeCode.md

@@ -0,0 +1,39 @@
+# FactureElectroniqueModelsInvoiceTypeCode
+
+Document type according to BR-FR-04 (UNTDID 1001 codes).  | Code | Name | Description | |------|------|-------------| | 380 | INVOICE | Commercial invoice | | 389 | SELF_BILLED_INVOICE | Self-billed invoice | | 393 | FACTORED_INVOICE | Factored invoice | | 501 | SELF_BILLED_FACTORED_INVOICE | Self-billed factored invoice | | 386 | PREPAYMENT_INVOICE | Prepayment invoice | | 500 | SELF_BILLED_PREPAYMENT_INVOICE | Self-billed prepayment invoice | | 384 | CORRECTIVE_INVOICE | Corrective invoice | | 471 | SELF_BILLED_CORRECTIVE_INVOICE | Self-billed corrective invoice | | 472 | FACTORED_CORRECTIVE_INVOICE | Factored corrective invoice | | 473 | SELF_BILLED_FACTORED_CORRECTIVE_INVOICE | Self-billed factored corrective invoice | | 381 | CREDIT_NOTE | Credit note | | 261 | SELF_BILLED_CREDIT_NOTE | Self-billed credit note | | 262 | GLOBAL_ALLOWANCE_CREDIT_NOTE | Credit note for global allowance | | 396 | FACTORED_CREDIT_NOTE | Factored credit note | | 502 | SELF_BILLED_FACTORED_CREDIT_NOTE | Self-billed factored credit note | | 503 | PREPAYMENT_CREDIT_NOTE | Credit note for prepayment invoice |
+
+## Enum
+
+* `INVOICE` (value: `'380'`)
+
+* `SELF_BILLED_INVOICE` (value: `'389'`)
+
+* `FACTORED_INVOICE` (value: `'393'`)
+
+* `SELF_BILLED_FACTORED_INVOICE` (value: `'501'`)
+
+* `PREPAYMENT_INVOICE` (value: `'386'`)
+
+* `SELF_BILLED_PREPAYMENT_INVOICE` (value: `'500'`)
+
+* `CORRECTIVE_INVOICE` (value: `'384'`)
+
+* `SELF_BILLED_CORRECTIVE_INVOICE` (value: `'471'`)
+
+* `FACTORED_CORRECTIVE_INVOICE` (value: `'472'`)
+
+* `SELF_BILLED_FACTORED_CORRECTIVE_INVOICE` (value: `'473'`)
+
+* `CREDIT_NOTE` (value: `'381'`)
+
+* `SELF_BILLED_CREDIT_NOTE` (value: `'261'`)
+
+* `GLOBAL_ALLOWANCE_CREDIT_NOTE` (value: `'262'`)
+
+* `FACTORED_CREDIT_NOTE` (value: `'396'`)
+
+* `SELF_BILLED_FACTORED_CREDIT_NOTE` (value: `'502'`)
+
+* `PREPAYMENT_CREDIT_NOTE` (value: `'503'`)
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/Flux6InvoiceLifecycleCDARApi.md

@@ -6,6 +6,7 @@ All URIs are relative to *https://factpulse.fr*
 |------------- | ------------- | -------------|
 |[**generateCdarApiV1CdarGeneratePost**](#generatecdarapiv1cdargeneratepost) | **POST** /api/v1/cdar/generate | Generate a CDAR message|
 |[**getActionCodesApiV1CdarActionCodesGet**](#getactioncodesapiv1cdaractioncodesget) | **GET** /api/v1/cdar/action-codes | List of CDAR action codes|
+|[**getLifecycleApiV1CdarLifecycleGet**](#getlifecycleapiv1cdarlifecycleget) | **GET** /api/v1/cdar/lifecycle | [Simplified] Get lifecycle events for invoices|
 |[**getReasonCodesApiV1CdarReasonCodesGet**](#getreasoncodesapiv1cdarreasoncodesget) | **GET** /api/v1/cdar/reason-codes | List of CDAR reason codes|
 |[**getStatusCodesApiV1CdarStatusCodesGet**](#getstatuscodesapiv1cdarstatuscodesget) | **GET** /api/v1/cdar/status-codes | List of CDAR status codes|
 |[**submitCdarApiV1CdarSubmitPost**](#submitcdarapiv1cdarsubmitpost) | **POST** /api/v1/cdar/submit | Generate and submit a CDAR message|
@@ -118,6 +119,76 @@ No authorization required
 
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
+# **getLifecycleApiV1CdarLifecycleGet**
+> LifecycleResponse getLifecycleApiV1CdarLifecycleGet()
+
+Returns lifecycle events (CDAR) grouped by invoice reference.  **How it works (AFNOR XP Z12-013 compliant):** 1. Searches lifecycle flows on the PDP by flowType + flowDirection + date range 2. Downloads and parses each CDAR XML to extract the invoice reference 3. Groups events by invoice, sorted chronologically  **Parameters:** - `days`: Number of days to look back (default: 7) - `invoiceId`: Optional filter on a specific invoice reference  **Authentication:** JWT Bearer (recommended) or PDP credentials as query parameters.
+
+### Example
+
+```typescript
+import {
+    Flux6InvoiceLifecycleCDARApi,
+    Configuration
+} from '@factpulse/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new Flux6InvoiceLifecycleCDARApi(configuration);
+
+let days: number; //Number of days to look back (optional) (default to 7)
+let invoiceId: string; //Filter by invoice reference (optional) (default to undefined)
+let pdpFlowServiceUrl: string; //PDP Flow Service URL (optional) (default to undefined)
+let pdpTokenUrl: string; //PDP OAuth token URL (optional) (default to undefined)
+let pdpClientId: string; //PDP Client ID (optional) (default to undefined)
+let pdpClientSecret: string; //PDP Client Secret (optional) (default to undefined)
+
+const { status, data } = await apiInstance.getLifecycleApiV1CdarLifecycleGet(
+    days,
+    invoiceId,
+    pdpFlowServiceUrl,
+    pdpTokenUrl,
+    pdpClientId,
+    pdpClientSecret
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **days** | [**number**] | Number of days to look back | (optional) defaults to 7|
+| **invoiceId** | [**string**] | Filter by invoice reference | (optional) defaults to undefined|
+| **pdpFlowServiceUrl** | [**string**] | PDP Flow Service URL | (optional) defaults to undefined|
+| **pdpTokenUrl** | [**string**] | PDP OAuth token URL | (optional) defaults to undefined|
+| **pdpClientId** | [**string**] | PDP Client ID | (optional) defaults to undefined|
+| **pdpClientSecret** | [**string**] | PDP Client Secret | (optional) defaults to undefined|
+
+
+### Return type
+
+**LifecycleResponse**
+
+### Authorization
+
+[HTTPBearer](../README.md#HTTPBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successful Response |  -  |
+|**400** | Invalid request |  -  |
+|**422** | Validation error |  -  |
+|**500** | Server error |  -  |
+|**401** | Authentication required - Invalid or missing JWT token |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
 # **getReasonCodesApiV1CdarReasonCodesGet**
 > ReasonCodesResponse getReasonCodesApiV1CdarReasonCodesGet()
 

package/docs/GenerationSuccessResult.md

@@ -0,0 +1,27 @@
+# GenerationSuccessResult
+
+Successful result from task_generate_invoice.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **string** |  | [optional] [default to StatusEnum_Success]
+**content_b64** | **string** |  | [optional] [default to undefined]
+**xml_content** | **string** |  | [optional] [default to undefined]
+**filename** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { GenerationSuccessResult } from '@factpulse/sdk';
+
+const instance: GenerationSuccessResult = {
+    status,
+    content_b64,
+    xml_content,
+    filename,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/GenerationTaskStatus.md

@@ -0,0 +1,25 @@
+# GenerationTaskStatus
+
+Typed task status for invoice generation.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**taskId** | **string** |  | [default to undefined]
+**status** | [**CeleryStatus**](CeleryStatus.md) |  | [default to undefined]
+**result** | [**GenerationTaskStatusResult**](GenerationTaskStatusResult.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { GenerationTaskStatus } from '@factpulse/sdk';
+
+const instance: GenerationTaskStatus = {
+    taskId,
+    status,
+    result,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/GenerationTaskStatusResult.md

@@ -0,0 +1,34 @@
+# GenerationTaskStatusResult
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **string** |  | [optional] [default to StatusEnum_Error]
+**content_b64** | **string** |  | [optional] [default to undefined]
+**xml_content** | **string** |  | [optional] [default to undefined]
+**filename** | **string** |  | [default to undefined]
+**errorCode** | **string** |  | [default to undefined]
+**errorMessage** | **string** |  | [default to undefined]
+**details** | [**Array<AFNORErrorDetail>**](AFNORErrorDetail.md) |  | [optional] [default to undefined]
+**traceback** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { GenerationTaskStatusResult } from '@factpulse/sdk';
+
+const instance: GenerationTaskStatusResult = {
+    status,
+    content_b64,
+    xml_content,
+    filename,
+    errorCode,
+    errorMessage,
+    details,
+    traceback,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/HealthApi.md

@@ -5,8 +5,6 @@ All URIs are relative to *https://factpulse.fr*
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
 |[**getUserInfoApiV1MeGet**](#getuserinfoapiv1meget) | **GET** /api/v1/me | Get current user information|
-|[**healthcheckHealthcheckGet**](#healthcheckhealthcheckget) | **GET** /healthcheck | Docker healthcheck endpoint|
-|[**rootGet**](#rootget) | **GET** / | Check API status|
 
 # **getUserInfoApiV1MeGet**
 > any getUserInfoApiV1MeGet()
@@ -53,93 +51,3 @@ This endpoint does not have any parameters.
 
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
-# **healthcheckHealthcheckGet**
-> any healthcheckHealthcheckGet()
-
-Healthcheck endpoint for Docker and load balancers.  Useful for: - Docker healthcheck - Kubernetes liveness/readiness probes - Load balancers (Nginx, HAProxy) - Availability monitoring - Zero downtime deployment  Returns a 200 code if the API is operational.
-
-### Example
-
-```typescript
-import {
-    HealthApi,
-    Configuration
-} from '@factpulse/sdk';
-
-const configuration = new Configuration();
-const apiInstance = new HealthApi(configuration);
-
-const { status, data } = await apiInstance.healthcheckHealthcheckGet();
-```
-
-### Parameters
-This endpoint does not have any parameters.
-
-
-### Return type
-
-**any**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | API is healthy |  -  |
-|**500** | Internal server error |  -  |
-
-[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
-
-# **rootGet**
-> any rootGet()
-
-Health check endpoint to verify the API is responding.  Useful for: - Availability monitoring - Integration tests - Load balancers
-
-### Example
-
-```typescript
-import {
-    HealthApi,
-    Configuration
-} from '@factpulse/sdk';
-
-const configuration = new Configuration();
-const apiInstance = new HealthApi(configuration);
-
-const { status, data } = await apiInstance.rootGet();
-```
-
-### Parameters
-This endpoint does not have any parameters.
-
-
-### Return type
-
-**any**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | API is operational |  -  |
-|**500** | Internal server error |  -  |
-
-[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
-

package/docs/{FacturXGenerationApi.md → InvoiceGenerationApi.md}

@@ -1,32 +1,32 @@
-# FacturXGenerationApi
+# InvoiceGenerationApi
 
 All URIs are relative to *https://factpulse.fr*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
-|[**generateInvoiceApiV1ProcessingGenerateInvoicePost**](#generateinvoiceapiv1processinggenerateinvoicepost) | **POST** /api/v1/processing/generate-invoice | Generate a Factur-X invoice|
+|[**generateInvoiceApiV1ProcessingGenerateInvoicePost**](#generateinvoiceapiv1processinggenerateinvoicepost) | **POST** /api/v1/processing/generate-invoice | Generate an electronic invoice (CII / UBL / Factur-X PDF)|
 |[**submitCompleteInvoiceApiV1ProcessingInvoicesSubmitCompletePost**](#submitcompleteinvoiceapiv1processinginvoicessubmitcompletepost) | **POST** /api/v1/processing/invoices/submit-complete | Submit a complete invoice (generation + signature + submission)|
 |[**submitCompleteInvoiceAsyncApiV1ProcessingInvoicesSubmitCompleteAsyncPost**](#submitcompleteinvoiceasyncapiv1processinginvoicessubmitcompleteasyncpost) | **POST** /api/v1/processing/invoices/submit-complete-async | Submit a complete invoice (asynchronous with Celery)|
 
 # **generateInvoiceApiV1ProcessingGenerateInvoicePost**
 > TaskResponse generateInvoiceApiV1ProcessingGenerateInvoicePost()
 
-Generates an electronic invoice in Factur-X format compliant with European standards.  ## Applied Standards  - **Factur-X** (France): FNFE-MPE standard (Forum National de la Facture Électronique) - **ZUGFeRD** (Germany): German format compatible with Factur-X - **EN 16931**: European semantic standard for electronic invoicing - **ISO 19005-3** (PDF/A-3): Long-term electronic archiving - **Cross Industry Invoice (CII)**: UN/CEFACT XML syntax  ## 🆕 New: Simplified format with auto-enrichment (P0.1)  You can now create an invoice by providing only: - An invoice number - A supplier SIRET + **IBAN** (required) - A recipient SIRET - Invoice lines (description, quantity, net price)  **Simplified format example**: ```json {   \"number\": \"FACT-2025-001\",   \"supplier\": {     \"siret\": \"92019522900017\",     \"iban\": \"FR7630001007941234567890185\"   },   \"recipient\": {\"siret\": \"35600000000048\"},   \"lines\": [     {\"description\": \"Service\", \"quantity\": 10, \"unitPrice\": 100.00, \"vatRate\": 20.0}   ] } ```  **⚠️ Required fields (simplified format)**: - `number`: Unique invoice number - `supplier.siret`: Supplier\'s SIRET (14 digits) - `supplier.iban`: Bank account IBAN (no public API to retrieve it) - `recipient.siret`: Recipient\'s SIRET - `lines[]`: At least one invoice line  **What happens automatically with `auto_enrich=True`**: - ✅ Name enrichment from Chorus Pro API - ✅ Address enrichment from Business Search API (free, public) - ✅ Automatic intra-EU VAT calculation (FR + key + SIREN) - ✅ Chorus Pro ID retrieval for electronic invoicing - ✅ Net/VAT/Gross totals calculation - ✅ Date generation (today + 30-day due date) - ✅ Multi-rate VAT handling  **Supported identifiers**: - SIRET (14 digits): Specific establishment ⭐ Recommended - SIREN (9 digits): Company (auto-selection of headquarters) - Special types: UE_HORS_FRANCE, RIDET, TAHITI, etc.  ## Checks performed during generation  ### 1. Data validation (Pydantic) - Data types (amounts as Decimal, ISO 8601 dates) - Formats (14-digit SIRET, 9-digit SIREN, IBAN) - Required fields per profile - Amount consistency (Net + VAT = Gross)  ### 2. CII-compliant XML generation - Serialization according to Cross Industry Invoice XSD schema - Correct UN/CEFACT namespaces - Hierarchical structure respected - UTF-8 encoding without BOM  ### 3. Schematron validation - Business rules for selected profile (MINIMUM, BASIC, EN16931, EXTENDED) - Element cardinality (required, optional, repeatable) - Calculation rules (totals, VAT, discounts) - European EN 16931 compliance  ### 4. PDF/A-3 conversion (if output_format=\'pdf\') - Source PDF conversion to PDF/A-3 via Ghostscript - Factur-X XML embedding in PDF - Compliant XMP metadata - ICC sRGB color profile - Removal of forbidden elements (JavaScript, forms)  ## How it works  1. **Submission**: Invoice is queued in Celery for asynchronous processing 2. **Immediate return**: You receive a `task_id` (HTTP 202 Accepted) 3. **Tracking**: Use the `/tasks/{task_id}/status` endpoint to track progress  ## Webhook notification (recommended)  Instead of polling, you can receive a webhook notification when the task completes:  ``` callback_url=https://your-server.com/webhook ```  The webhook will POST a JSON payload with: - `event_type`: `generation.completed` or `generation.failed` - `data.task_id`: The Celery task ID - `data.content_b64` or `data.xml_content`: The generated content - `X-Webhook-Signature` header for HMAC verification  See `/docs/WEBHOOKS.md` for full documentation.  ## Output formats  - **xml**: Generates only Factur-X XML (recommended for testing) - **pdf**: Generates PDF/A-3 with embedded XML (requires `source_pdf`)  ## Factur-X profiles  - **MINIMUM**: Minimal data (simplified invoice) - **BASIC**: Basic information (SMEs) - **EN16931**: European standard (recommended, compliant with directive 2014/55/EU) - **EXTENDED**: All available data (large accounts)  ## What you get  After successful processing (status `completed`): - **XML only**: Base64-encoded Factur-X compliant XML file - **PDF/A-3**: PDF with embedded XML, ready for sending/archiving - **Metadata**: Profile, Factur-X version, file size - **Validation**: Schematron compliance confirmation  ## Validation  Data is automatically validated according to detected format. On error, a 422 status is returned with invalid field details.
+Generates an electronic invoice compliant with European standards.  Supports **two XML syntaxes** defined by EN 16931: - **CII** (Cross-Industry Invoice, UN/CEFACT) — the Factur-X / ZUGFeRD syntax - **UBL 2.1** (Universal Business Language, OASIS) — the Peppol BIS Billing syntax  ## Applied Standards  - **EN 16931**: European semantic standard for electronic invoicing - **Factur-X / ZUGFeRD** (CII syntax): Franco-German standard - **UBL 2.1** (OASIS): International standard, used by Peppol - **ISO 19005-3** (PDF/A-3): Long-term electronic archiving (PDF output only) - **Schematron**: Business rules validation (EN16931-CII, EN16931-UBL, BR-FR)  ## 🆕 New: Simplified format with auto-enrichment (P0.1)  You can now create an invoice by providing only: - An invoice number - A supplier SIRET + **IBAN** (required) - A recipient SIRET - Invoice lines (description, quantity, net price)  **Simplified format example**: ```json {   \"number\": \"FACT-2025-001\",   \"supplier\": {     \"siret\": \"92019522900017\",     \"iban\": \"FR7630001007941234567890185\"   },   \"recipient\": {\"siret\": \"35600000000048\"},   \"lines\": [     {\"description\": \"Service\", \"quantity\": 10, \"unitPrice\": 100.00, \"vatRate\": 20.0}   ] } ```  **⚠️ Required fields (simplified format)**: - `number`: Unique invoice number - `supplier.siret`: Supplier\'s SIRET (14 digits) - `supplier.iban`: Bank account IBAN (no public API to retrieve it) - `recipient.siret`: Recipient\'s SIRET - `lines[]`: At least one invoice line  **What happens automatically with `auto_enrich=True`**: - ✅ Name enrichment from Chorus Pro API - ✅ Address enrichment from Business Search API (free, public) - ✅ Automatic intra-EU VAT calculation (FR + key + SIREN) - ✅ Chorus Pro ID retrieval for electronic invoicing - ✅ Net/VAT/Gross totals calculation - ✅ Date generation (today + 30-day due date) - ✅ Multi-rate VAT handling  **Supported identifiers**: - SIRET (14 digits): Specific establishment ⭐ Recommended - SIREN (9 digits): Company (auto-selection of headquarters) - Special types: UE_HORS_FRANCE, RIDET, TAHITI, etc.  ## Checks performed during generation  ### 1. Data validation (Pydantic) - Data types (amounts as Decimal, ISO 8601 dates) - Formats (14-digit SIRET, 9-digit SIREN, IBAN) - Required fields per profile - Amount consistency (Net + VAT = Gross)  ### 2. CII-compliant XML generation - Serialization according to Cross Industry Invoice XSD schema - Correct UN/CEFACT namespaces - Hierarchical structure respected - UTF-8 encoding without BOM  ### 3. Schematron validation - Business rules for selected profile (MINIMUM, BASIC, EN16931, EXTENDED) - Element cardinality (required, optional, repeatable) - Calculation rules (totals, VAT, discounts) - European EN 16931 compliance  ### 4. PDF/A-3 conversion (if output_format=\'pdf\') - Source PDF conversion to PDF/A-3 via Ghostscript - Factur-X XML embedding in PDF - Compliant XMP metadata - ICC sRGB color profile - Removal of forbidden elements (JavaScript, forms)  ## How it works  1. **Submission**: Invoice is queued in Celery for asynchronous processing 2. **Immediate return**: You receive a `task_id` (HTTP 202 Accepted) 3. **Tracking**: Use the `/tasks/{task_id}/status` endpoint to track progress  ## Webhook notification (recommended)  Instead of polling, you can receive a webhook notification when the task completes:  ``` callback_url=https://your-server.com/webhook ```  The webhook will POST a JSON payload with: - `event_type`: `generation.completed` or `generation.failed` - `data.task_id`: The Celery task ID - `data.content_b64` or `data.xml_content`: The generated content - `X-Webhook-Signature` header for HMAC verification  See `/docs/WEBHOOKS.md` for full documentation.  ## Output formats  - **xml** / **cii**: CII XML (Factur-X syntax, UN/CEFACT) - **ubl**: UBL 2.1 XML (OASIS, Peppol BIS Billing 3.0) - **pdf**: Factur-X PDF/A-3 with embedded CII XML (requires `source_pdf`)  ## Factur-X profiles (CII only)  - **MINIMUM**: Minimal data (simplified invoice) - **BASIC**: Basic information (SMEs) - **EN16931**: European standard (recommended, compliant with directive 2014/55/EU) - **EXTENDED**: All available data (large accounts)  When `output_format=ubl`, the profile parameter is ignored (UBL always uses EN16931).  ## What you get  After successful processing (status `completed`): - **XML only**: Base64-encoded Factur-X compliant XML file - **PDF/A-3**: PDF with embedded XML, ready for sending/archiving - **Metadata**: Profile, Factur-X version, file size - **Validation**: Schematron compliance confirmation  ## Validation  Data is automatically validated according to detected format. On error, a 422 status is returned with invalid field details.
 
 ### Example
 
 ```typescript
 import {
-    FacturXGenerationApi,
+    InvoiceGenerationApi,
     Configuration
 } from '@factpulse/sdk';
 
 const configuration = new Configuration();
-const apiInstance = new FacturXGenerationApi(configuration);
+const apiInstance = new InvoiceGenerationApi(configuration);
 
 let invoiceData: string; //Invoice data in JSON format.              Two formats accepted:             1. **Classic format**: Complete FacturXInvoice structure (all fields)             2. **Simplified format** (🆕 P0.1): Minimal structure with auto-enrichment              Format is detected automatically!              (default to undefined)
-let profile: APIProfile; //Factur-X profile: MINIMUM, BASIC, EN16931 or EXTENDED. (optional) (default to undefined)
-let outputFormat: OutputFormat; //Output format: \\\'xml\\\' (XML only) or \\\'pdf\\\' (Factur-X PDF with embedded XML). (optional) (default to undefined)
+let profile: APIProfile; //Factur-X/CII profile: MINIMUM, BASIC, EN16931 or EXTENDED. Ignored when output_format=\\\'ubl\\\' (always EN16931). (optional) (default to undefined)
+let outputFormat: OutputFormat; //Output format: \\\'xml\\\' or \\\'cii\\\' (CII/Factur-X XML), \\\'ubl\\\' (UBL 2.1 XML), \\\'pdf\\\' (Factur-X PDF/A-3). (optional) (default to undefined)
 let autoEnrich: boolean; //🆕 Enable auto-enrichment from SIRET/SIREN (simplified format only) (optional) (default to true)
 let sourcePdf: File; // (optional) (default to undefined)
 let callbackUrl: string; // (optional) (default to undefined)
@@ -50,8 +50,8 @@ const { status, data } = await apiInstance.generateInvoiceApiV1ProcessingGenerat
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
 | **invoiceData** | [**string**] | Invoice data in JSON format.              Two formats accepted:             1. **Classic format**: Complete FacturXInvoice structure (all fields)             2. **Simplified format** (🆕 P0.1): Minimal structure with auto-enrichment              Format is detected automatically!              | defaults to undefined|
-| **profile** | **APIProfile** | Factur-X profile: MINIMUM, BASIC, EN16931 or EXTENDED. | (optional) defaults to undefined|
-| **outputFormat** | **OutputFormat** | Output format: \\\'xml\\\' (XML only) or \\\'pdf\\\' (Factur-X PDF with embedded XML). | (optional) defaults to undefined|
+| **profile** | **APIProfile** | Factur-X/CII profile: MINIMUM, BASIC, EN16931 or EXTENDED. Ignored when output_format=\\\'ubl\\\' (always EN16931). | (optional) defaults to undefined|
+| **outputFormat** | **OutputFormat** | Output format: \\\'xml\\\' or \\\'cii\\\' (CII/Factur-X XML), \\\'ubl\\\' (UBL 2.1 XML), \\\'pdf\\\' (Factur-X PDF/A-3). | (optional) defaults to undefined|
 | **autoEnrich** | [**boolean**] | 🆕 Enable auto-enrichment from SIRET/SIREN (simplified format only) | (optional) defaults to true|
 | **sourcePdf** | [**File**] |  | (optional) defaults to undefined|
 | **callbackUrl** | [**string**] |  | (optional) defaults to undefined|
@@ -92,13 +92,13 @@ Unified endpoint to submit a complete invoice to different destinations.     **F
 
 ```typescript
 import {
-    FacturXGenerationApi,
+    InvoiceGenerationApi,
     Configuration,
     SubmitCompleteInvoiceRequest
 } from '@factpulse/sdk';
 
 const configuration = new Configuration();
-const apiInstance = new FacturXGenerationApi(configuration);
+const apiInstance = new InvoiceGenerationApi(configuration);
 
 let submitCompleteInvoiceRequest: SubmitCompleteInvoiceRequest; //
 
@@ -146,13 +146,13 @@ Asynchronous version of the `/invoices/submit-complete` endpoint using Celery fo
 
 ```typescript
 import {
-    FacturXGenerationApi,
+    InvoiceGenerationApi,
     Configuration,
     SubmitCompleteInvoiceRequest
 } from '@factpulse/sdk';
 
 const configuration = new Configuration();
-const apiInstance = new FacturXGenerationApi(configuration);
+const apiInstance = new InvoiceGenerationApi(configuration);
 
 let submitCompleteInvoiceRequest: SubmitCompleteInvoiceRequest; //
 let callbackUrl: string; //Webhook URL for async notification when submission completes. (optional) (default to undefined)

package/docs/InvoiceInput.md

@@ -8,7 +8,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **invoiceId** | **string** | Invoice identifier | [default to undefined]
 **issueDate** | **string** | Invoice issue date | [default to undefined]
-**typeCode** | [**FactureElectroniqueRestApiSchemasEreportingInvoiceTypeCode**](FactureElectroniqueRestApiSchemasEreportingInvoiceTypeCode.md) | Invoice type code | [optional] [default to undefined]
+**typeCode** | [**InvoiceTypeCode**](InvoiceTypeCode.md) | Invoice type code | [optional] [default to undefined]
 **currency** | [**Currency**](Currency.md) |  | [optional] [default to undefined]
 **dueDate** | **string** |  | [optional] [default to undefined]
 **sellerId** | **string** |  | [optional] [default to undefined]