@factpulse/sdk 4.0.2 → 4.1.2

package/docs/OutputFormat.md

@@ -1,11 +1,15 @@
 # OutputFormat
 
-Output format for invoice generation.
+Output format for invoice generation.  - ``xml``: CII XML (Cross-Industry Invoice, Factur-X syntax) — backward-compatible alias - ``cii``: CII XML — explicit alias, same as ``xml`` - ``ubl``: UBL 2.1 XML (OASIS Universal Business Language) - ``pdf``: Factur-X PDF/A-3 with embedded CII XML
 
 ## Enum
 
 * `Xml` (value: `'xml'`)
 
+* `Cii` (value: `'cii'`)
+
+* `Ubl` (value: `'ubl'`)
+
 * `Pdf` (value: `'pdf'`)
 
 [[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/PDPConfigResponse.md

@@ -13,6 +13,7 @@ Name | Type | Description | Notes
 **flowServiceUrl** | **string** |  | [optional] [default to undefined]
 **tokenUrl** | **string** |  | [optional] [default to undefined]
 **oauthClientId** | **string** |  | [optional] [default to undefined]
+**encryptionMode** | **string** |  | [optional] [default to undefined]
 **secretStatus** | [**SecretStatus**](SecretStatus.md) |  | [optional] [default to undefined]
 **lastTestAt** | **string** |  | [optional] [default to undefined]
 **lastTestSuccess** | **boolean** |  | [optional] [default to undefined]
@@ -34,6 +35,7 @@ const instance: PDPConfigResponse = {
     flowServiceUrl,
     tokenUrl,
     oauthClientId,
+    encryptionMode,
     secretStatus,
     lastTestAt,
     lastTestSuccess,

package/docs/PDPConfigUpdateRequest.md

@@ -1,6 +1,6 @@
 # PDPConfigUpdateRequest
 
-PDP configuration update request.
+PDP configuration update request.  For encryption_mode=\'double\', the X-Encryption-Key header must also be provided containing a base64-encoded AES-256 key (32 bytes).
 
 ## Properties
 
@@ -12,6 +12,7 @@ Name | Type | Description | Notes
 **tokenUrl** | **string** | PDP OAuth token URL | [default to undefined]
 **oauthClientId** | **string** | OAuth Client ID | [default to undefined]
 **clientSecret** | **string** | OAuth Client Secret (sent but never returned) | [default to undefined]
+**encryptionMode** | **string** |  | [optional] [default to undefined]
 
 ## Example
 
@@ -25,6 +26,7 @@ const instance: PDPConfigUpdateRequest = {
     tokenUrl,
     oauthClientId,
     clientSecret,
+    encryptionMode,
 };
 ```
 

package/docs/ParseApi.md

@@ -0,0 +1,119 @@
+# ParseApi
+
+All URIs are relative to *https://factpulse.fr*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**parseFacturxAsyncApiV1ProcessingParseFacturxAsyncPost**](#parsefacturxasyncapiv1processingparsefacturxasyncpost) | **POST** /api/v1/processing/parse-facturx/async | Parse Factur-X XML or PDF (async)|
+|[**parseFacturxSyncApiV1ProcessingParseFacturxPost**](#parsefacturxsyncapiv1processingparsefacturxpost) | **POST** /api/v1/processing/parse-facturx | Parse CII, UBL or Factur-X PDF (sync)|
+
+# **parseFacturxAsyncApiV1ProcessingParseFacturxAsyncPost**
+> TaskResponse parseFacturxAsyncApiV1ProcessingParseFacturxAsyncPost()
+
+Parse a Factur-X file asynchronously using a Celery task.  **Use case:** For large files or when you want non-blocking processing.  **Workflow:** 1. Submit file with this endpoint -> receive `task_id` 2. Poll `/tasks/{task_id}/status` for result 3. Result contains `invoice` and `detected_profile`  **Optional:** Provide `callback_url` to receive a webhook when parsing completes.
+
+### Example
+
+```typescript
+import {
+    ParseApi,
+    Configuration
+} from '@factpulse/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ParseApi(configuration);
+
+let file: File; //Factur-X PDF or XML file to parse (default to undefined)
+let callbackUrl: string; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.parseFacturxAsyncApiV1ProcessingParseFacturxAsyncPost(
+    file,
+    callbackUrl
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **file** | [**File**] | Factur-X PDF or XML file to parse | defaults to undefined|
+| **callbackUrl** | [**string**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**TaskResponse**
+
+### 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 |
+|-------------|-------------|------------------|
+|**202** | Task created |  -  |
+|**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)
+
+# **parseFacturxSyncApiV1ProcessingParseFacturxPost**
+> ParseFacturXResponse parseFacturxSyncApiV1ProcessingParseFacturxPost()
+
+Parse a CII XML, UBL XML, or Factur-X PDF and extract the invoice data as a FacturXInvoice model.  **Use cases:** - Extract invoice data from received invoices (any format) - Round-trip: parse an existing invoice, modify it, and regenerate in another format - Convert between CII and UBL via the FacturXInvoice pivot model  **Supported formats:** - Factur-X PDF (PDF/A-3 with embedded CII XML) - CII XML (UN/CEFACT Cross-Industry Invoice) - UBL 2.1 XML (OASIS Invoice or CreditNote)  **Returns:** - `invoice`: Complete FacturXInvoice data (can be used with /generate-invoice) - `detected_profile`: Factur-X profile (MINIMUM, BASIC, EN16931, EXTENDED)
+
+### Example
+
+```typescript
+import {
+    ParseApi,
+    Configuration
+} from '@factpulse/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ParseApi(configuration);
+
+let file: File; //Factur-X PDF or XML file to parse (default to undefined)
+
+const { status, data } = await apiInstance.parseFacturxSyncApiV1ProcessingParseFacturxPost(
+    file
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **file** | [**File**] | Factur-X PDF or XML file to parse | defaults to undefined|
+
+
+### Return type
+
+**ParseFacturXResponse**
+
+### 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** | Invoice successfully parsed |  -  |
+|**400** | Invalid file format or parsing error |  -  |
+|**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/ParseFacturXResponse.md

@@ -0,0 +1,29 @@
+# ParseFacturXResponse
+
+Response from the /parse-facturx endpoint.  Contains the parsed invoice data, plus metadata about the detected format and profile.  **Response schema depends on source format:** - **CII / Factur-X**: ``invoice`` contains a ``FacturXInvoice`` dict — round-trip compatible   with ``/generate-invoice``. - **UBL**: ``invoice`` contains an ``IncomingInvoice`` dict (simplified extraction with   supplier, amounts, dates). Not directly compatible with ``/generate-invoice``.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **string** | Parsing status | [default to undefined]
+**invoice** | **{ [key: string]: any; }** | Parsed invoice data. For CII/Factur-X: FacturXInvoice format (round-trip with /generate-invoice). For UBL: IncomingInvoice format (summary extraction). | [default to undefined]
+**detectedFormat** | **string** |  | [optional] [default to undefined]
+**detectedProfile** | **string** |  | [optional] [default to undefined]
+**error** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ParseFacturXResponse } from '@factpulse/sdk';
+
+const instance: ParseFacturXResponse = {
+    status,
+    invoice,
+    detectedFormat,
+    detectedProfile,
+    error,
+};
+```
+
+[[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/PaymentMeans.md

@@ -1,6 +1,6 @@
 # PaymentMeans
 
-Accepted payment methods.
+Payment methods - Chorus Pro API codes (modePaiement).  Values are official Chorus Pro enum values, automatically mapped to UNTDID 4461 codes for Factur-X/UBL XML generation.  | Chorus Pro code | Name | UNTDID 4461 | |-----------------|------|-------------| | CHEQUE | CHECK | 20 | | PRELEVEMENT | DIRECT_DEBIT | 49 | | VIREMENT | CREDIT_TRANSFER | 30 | | ESPECE | CASH | 10 | | AUTRE | OTHER | 57 | | REPORT | CLEARING | 97 |
 
 ## Enum
 

package/docs/ReferencesApi.md

@@ -0,0 +1,60 @@
+# ReferencesApi
+
+All URIs are relative to *https://factpulse.fr*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**getVatexCodesApiV1ReferencesVatexCodesGet**](#getvatexcodesapiv1referencesvatexcodesget) | **GET** /api/v1/references/vatex-codes | VATEX exemption reason codes|
+
+# **getVatexCodesApiV1ReferencesVatexCodesGet**
+> VATEXCodesResponse getVatexCodesApiV1ReferencesVatexCodesGet()
+
+Returns the list of VATEX (VAT exemption reason) codes from the Peppol BIS Billing 3.0 code list. Source: https://docs.peppol.eu/poacc/billing/3.0/codelist/vatex/
+
+### Example
+
+```typescript
+import {
+    ReferencesApi,
+    Configuration
+} from '@factpulse/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ReferencesApi(configuration);
+
+let category: string; //Filter by VAT category code (E, AE, K, G, O). (optional) (default to undefined)
+
+const { status, data } = await apiInstance.getVatexCodesApiV1ReferencesVatexCodesGet(
+    category
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **category** | [**string**] | Filter by VAT category code (E, AE, K, G, O). | (optional) defaults to undefined|
+
+
+### Return type
+
+**VATEXCodesResponse**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | List of VATEX codes with their descriptions and associated VAT categories. |  -  |
+|**422** | Validation 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/SecretStatus.md

@@ -8,6 +8,8 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **status** | **string** | Secret status: \'active\', \'missing\', etc. | [default to undefined]
 **message** | **string** | Descriptive status message | [default to undefined]
+**encryptionMode** | **string** |  | [optional] [default to undefined]
+**requiresClientKey** | **boolean** |  | [optional] [default to undefined]
 
 ## Example
 
@@ -17,6 +19,8 @@ import { SecretStatus } from '@factpulse/sdk';
 const instance: SecretStatus = {
     status,
     message,
+    encryptionMode,
+    requiresClientKey,
 };
 ```
 

package/docs/SignatureSuccessResult.md

@@ -0,0 +1,37 @@
+# SignatureSuccessResult
+
+Successful result from task_sign_pdf_from_bytes.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **string** |  | [optional] [default to StatusEnum_Success]
+**content_b64** | **string** |  | [default to undefined]
+**filename** | **string** |  | [default to undefined]
+**size_bytes** | **number** |  | [default to undefined]
+**is_signed** | **boolean** |  | [default to undefined]
+**signature_count** | **number** |  | [default to undefined]
+**signer_cn** | **string** |  | [default to undefined]
+**signing_date** | **string** |  | [default to undefined]
+**validation_details** | **{ [key: string]: any; }** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { SignatureSuccessResult } from '@factpulse/sdk';
+
+const instance: SignatureSuccessResult = {
+    status,
+    content_b64,
+    filename,
+    size_bytes,
+    is_signed,
+    signature_count,
+    signer_cn,
+    signing_date,
+    validation_details,
+};
+```
+
+[[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/SignatureTaskStatus.md

@@ -0,0 +1,25 @@
+# SignatureTaskStatus
+
+Typed task status for PDF signing.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**taskId** | **string** |  | [default to undefined]
+**status** | [**CeleryStatus**](CeleryStatus.md) |  | [default to undefined]
+**result** | [**SignatureTaskStatusResult**](SignatureTaskStatusResult.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { SignatureTaskStatus } from '@factpulse/sdk';
+
+const instance: SignatureTaskStatus = {
+    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/SignatureTaskStatusResult.md

@@ -0,0 +1,44 @@
+# SignatureTaskStatusResult
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **string** |  | [optional] [default to StatusEnum_Error]
+**content_b64** | **string** |  | [default to undefined]
+**filename** | **string** |  | [default to undefined]
+**size_bytes** | **number** |  | [default to undefined]
+**is_signed** | **boolean** |  | [default to undefined]
+**signature_count** | **number** |  | [default to undefined]
+**signer_cn** | **string** |  | [default to undefined]
+**signing_date** | **string** |  | [default to undefined]
+**validation_details** | **{ [key: string]: any; }** |  | [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 { SignatureTaskStatusResult } from '@factpulse/sdk';
+
+const instance: SignatureTaskStatusResult = {
+    status,
+    content_b64,
+    filename,
+    size_bytes,
+    is_signed,
+    signature_count,
+    signer_cn,
+    signing_date,
+    validation_details,
+    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/SimplifiedInvoiceData.md

@@ -15,7 +15,7 @@ Name | Type | Description | Notes
 **comment** | **string** |  | [optional] [default to undefined]
 **purchaseOrderReference** | **string** |  | [optional] [default to undefined]
 **contractReference** | **string** |  | [optional] [default to undefined]
-**invoiceType** | [**InvoiceTypeCode**](InvoiceTypeCode.md) | Document type (UNTDID 1001). Default: 380 (Invoice). | [optional] [default to undefined]
+**invoiceType** | [**FactureElectroniqueModelsInvoiceTypeCode**](FactureElectroniqueModelsInvoiceTypeCode.md) | Document type (UNTDID 1001). Default: 380 (Invoice). | [optional] [default to undefined]
 **precedingInvoiceReference** | **string** |  | [optional] [default to undefined]
 **operationNature** | [**OperationNature**](OperationNature.md) |  | [optional] [default to undefined]
 **invoicingFramework** | [**InvoicingFrameworkCode**](InvoicingFrameworkCode.md) |  | [optional] [default to undefined]

package/docs/SubmitCompleteInvoiceResponse.md

@@ -10,7 +10,8 @@ Name | Type | Description | Notes
 **destinationType** | **string** | Destination type | [default to undefined]
 **chorusResult** | [**ChorusProResult**](ChorusProResult.md) |  | [optional] [default to undefined]
 **afnorResult** | [**AFNORResult**](AFNORResult.md) |  | [optional] [default to undefined]
-**enrichedInvoice** | [**EnrichedInvoiceInfo**](EnrichedInvoiceInfo.md) | Enriched invoice data | [default to undefined]
+**enrichedInvoice** | [**EnrichedInvoiceInfo**](EnrichedInvoiceInfo.md) | Enriched invoice data (summary) | [default to undefined]
+**invoice** | **{ [key: string]: any; }** | Complete enriched invoice data (FacturXInvoice format). Use this to regenerate the same invoice. | [default to undefined]
 **facturxPdf** | [**FacturXPDFInfo**](FacturXPDFInfo.md) | Generated PDF information | [default to undefined]
 **signature** | [**SignatureInfo**](SignatureInfo.md) |  | [optional] [default to undefined]
 **contentB64** | **string** | Generated Factur-X PDF (and signed if requested) base64-encoded | [default to undefined]
@@ -27,6 +28,7 @@ const instance: SubmitCompleteInvoiceResponse = {
     chorusResult,
     afnorResult,
     enrichedInvoice,
+    invoice,
     facturxPdf,
     signature,
     contentB64,

package/docs/Supplier.md

@@ -7,7 +7,7 @@ Information about the supplier / seller (BG-4).
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **electronic_address** | [**ElectronicAddress**](ElectronicAddress.md) |  | [optional] [default to undefined]
-**supplier_id** | **number** |  | [default to undefined]
+**supplier_id** | **number** | Chorus Pro supplier structure ID (idFournisseur). Only required for B2G. | [optional] [default to 0]
 **private_id** | **string** |  | [optional] [default to undefined]
 **supplier_bank_account_code** | **number** |  | [optional] [default to undefined]
 **supplier_service_id** | **number** |  | [optional] [default to undefined]

package/docs/TaskErrorResult.md

@@ -0,0 +1,29 @@
+# TaskErrorResult
+
+Common error result returned by all task domains.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **string** |  | [optional] [default to StatusEnum_Error]
+**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 { TaskErrorResult } from '@factpulse/sdk';
+
+const instance: TaskErrorResult = {
+    status,
+    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/UnitOfMeasure.md

@@ -1,6 +1,6 @@
 # UnitOfMeasure
 
-Enumeration of invoicing units of measure.
+Units of measure for invoice lines (BT-130).  Accepts both legacy French labels and UN/ECE Recommendation 20 codes. UN/ECE codes are preferred for new integrations.  | UN/ECE code | Legacy alias | Description | |-------------|--------------|-------------| | C62 | PIECE | Unit / piece | | H87 | - | Piece (ISO synonym) | | HUR | HEURE | Hour | | DAY | JOUR | Day | | MON | - | Month | | MIN | - | Minute | | KGM | KILOGRAMME | Kilogram | | LTR | LITRE | Litre | | MTR | - | Metre | | MTK | - | Square metre | | TNE | - | Metric ton | | KWH | - | Kilowatt-hour | | SET | - | Set | | LS | FORFAIT | Lump sum |
 
 ## Enum
 
@@ -16,4 +16,32 @@ Enumeration of invoicing units of measure.
 
 * `Forfait` (value: `'FORFAIT'`)
 
+* `C62` (value: `'C62'`)
+
+* `H87` (value: `'H87'`)
+
+* `Hur` (value: `'HUR'`)
+
+* `Day` (value: `'DAY'`)
+
+* `Mon` (value: `'MON'`)
+
+* `Min` (value: `'MIN'`)
+
+* `Kgm` (value: `'KGM'`)
+
+* `Ltr` (value: `'LTR'`)
+
+* `Mtr` (value: `'MTR'`)
+
+* `Mtk` (value: `'MTK'`)
+
+* `Tne` (value: `'TNE'`)
+
+* `Kwh` (value: `'KWH'`)
+
+* `Set` (value: `'SET'`)
+
+* `Ls` (value: `'LS'`)
+
 [[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/VATAccountingCode.md

@@ -1,6 +1,6 @@
 # VATAccountingCode
 
-VAT accounting regime.
+VAT accounting regime - Chorus Pro API codes (typeTva).  Values are official Chorus Pro enum values, automatically mapped to UNTDID 2005 codes for Factur-X XML generation (BT-8 DueDateTypeCode).  | Chorus Pro code | Name | UNTDID 2005 | |-----------------|------|-------------| | TVA_SUR_DEBIT | ON_INVOICE | 5 (due on invoice date) | | TVA_SUR_ENCAISSEMENT | ON_PAYMENT | 72 (due on payment date) | | EXONERATION | EXEMPTION | - | | SANS_TVA | NO_VAT | - |
 
 ## Enum
 

package/docs/VATEXCodeInfo.md

@@ -0,0 +1,27 @@
+# VATEXCodeInfo
+
+Single VATEX code entry.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **string** | VATEX code (e.g. VATEX-EU-IC) | [default to undefined]
+**name** | **string** | Short name (e.g. \'Intra-Community supply\') | [default to undefined]
+**description** | **string** | Detailed description / remark | [default to undefined]
+**category** | **string** | Associated VAT category code (E, AE, K, G, O) | [default to undefined]
+
+## Example
+
+```typescript
+import { VATEXCodeInfo } from '@factpulse/sdk';
+
+const instance: VATEXCodeInfo = {
+    code,
+    name,
+    description,
+    category,
+};
+```
+
+[[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/VATEXCodesResponse.md

@@ -0,0 +1,25 @@
+# VATEXCodesResponse
+
+Response for the VATEX codes endpoint.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**codes** | [**Array<VATEXCodeInfo>**](VATEXCodeInfo.md) |  | [default to undefined]
+**count** | **number** |  | [default to undefined]
+**source** | **string** |  | [optional] [default to 'https://docs.peppol.eu/poacc/billing/3.0/codelist/vatex/']
+
+## Example
+
+```typescript
+import { VATEXCodesResponse } from '@factpulse/sdk';
+
+const instance: VATEXCodesResponse = {
+    codes,
+    count,
+    source,
+};
+```
+
+[[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/ValidateCDARResponse.md

@@ -7,8 +7,8 @@ Réponse de validation CDAR.
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **valid** | **boolean** | Résultat de validation | [default to undefined]
-**errors** | [**Array<FactureElectroniqueRestApiSchemasCdarValidationErrorResponse>**](FactureElectroniqueRestApiSchemasCdarValidationErrorResponse.md) | Liste des erreurs | [optional] [default to undefined]
-**warnings** | [**Array<FactureElectroniqueRestApiSchemasCdarValidationErrorResponse>**](FactureElectroniqueRestApiSchemasCdarValidationErrorResponse.md) | Liste des avertissements | [optional] [default to undefined]
+**errors** | [**Array<ValidationErrorResponse>**](ValidationErrorResponse.md) | Liste des erreurs | [optional] [default to undefined]
+**warnings** | [**Array<ValidationErrorResponse>**](ValidationErrorResponse.md) | Liste des avertissements | [optional] [default to undefined]
 
 ## Example
 

package/docs/ValidationApi.md

@@ -0,0 +1,68 @@
+# ValidationApi
+
+All URIs are relative to *https://factpulse.fr*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**validateXmlApiV1ProcessingValidateXmlPost**](#validatexmlapiv1processingvalidatexmlpost) | **POST** /api/v1/processing/validate-xml | Validate a CII or UBL XML against Schematron rules|
+
+# **validateXmlApiV1ProcessingValidateXmlPost**
+> ValidationSuccessResponse validateXmlApiV1ProcessingValidateXmlPost()
+
+Validates a CII (Factur-X) or UBL XML file against Schematron business rules.  The XML format is **auto-detected** from namespace: - CII XML → validated with EN16931-CII + profile-specific + BR-FR-CII Schematrons - UBL XML → validated with EN16931-UBL + BR-FR-UBL Schematrons  ## 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 rules (BR-FR-CII or BR-FR-UBL) - Arithmetic calculations and data consistency  ## Profiles and validated rules (CII only)  ### 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 {
+    ValidationApi,
+    Configuration
+} from '@factpulse/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ValidationApi(configuration);
+
+let xmlFile: File; //CII (Factur-X) or UBL XML file to validate (.xml format). Format is auto-detected. (default to undefined)
+let profile: APIProfile; //Validation profile (MINIMUM, BASIC, EN16931, EXTENDED). Used for CII only; ignored for UBL (always EN16931). (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**] | CII (Factur-X) or UBL XML file to validate (.xml format). Format is auto-detected. | defaults to undefined|
+| **profile** | **APIProfile** | Validation profile (MINIMUM, BASIC, EN16931, EXTENDED). Used for CII only; ignored for UBL (always EN16931). | (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 validation 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)
+