factpulse 4.0.2 → 4.1.2

data/docs/ParseApi.md

@@ -0,0 +1,161 @@
+# FactPulse::ParseApi
+
+All URIs are relative to *https://factpulse.fr*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**parse_facturx_async_api_v1_processing_parse_facturx_async_post**](ParseApi.md#parse_facturx_async_api_v1_processing_parse_facturx_async_post) | **POST** /api/v1/processing/parse-facturx/async | Parse Factur-X XML or PDF (async) |
+| [**parse_facturx_sync_api_v1_processing_parse_facturx_post**](ParseApi.md#parse_facturx_sync_api_v1_processing_parse_facturx_post) | **POST** /api/v1/processing/parse-facturx | Parse CII, UBL or Factur-X PDF (sync) |
+
+
+## parse_facturx_async_api_v1_processing_parse_facturx_async_post
+
+> <TaskResponse> parse_facturx_async_api_v1_processing_parse_facturx_async_post(file, opts)
+
+Parse Factur-X XML or PDF (async)
+
+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.
+
+### Examples
+
+```ruby
+require 'time'
+require 'factpulse'
+# setup authorization
+FactPulse.configure do |config|
+  # Configure API key authorization: APIKeyHeader
+  config.api_key['X-API-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['X-API-Key'] = 'Bearer'
+
+  # Configure Bearer authorization: HTTPBearer
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = FactPulse::ParseApi.new
+file = File.new('/path/to/some/file') # File | Factur-X PDF or XML file to parse
+opts = {
+  callback_url: 'callback_url_example' # String | 
+}
+
+begin
+  # Parse Factur-X XML or PDF (async)
+  result = api_instance.parse_facturx_async_api_v1_processing_parse_facturx_async_post(file, opts)
+  p result
+rescue FactPulse::ApiError => e
+  puts "Error when calling ParseApi->parse_facturx_async_api_v1_processing_parse_facturx_async_post: #{e}"
+end
+```
+
+#### Using the parse_facturx_async_api_v1_processing_parse_facturx_async_post_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<TaskResponse>, Integer, Hash)> parse_facturx_async_api_v1_processing_parse_facturx_async_post_with_http_info(file, opts)
+
+```ruby
+begin
+  # Parse Factur-X XML or PDF (async)
+  data, status_code, headers = api_instance.parse_facturx_async_api_v1_processing_parse_facturx_async_post_with_http_info(file, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <TaskResponse>
+rescue FactPulse::ApiError => e
+  puts "Error when calling ParseApi->parse_facturx_async_api_v1_processing_parse_facturx_async_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **file** | **File** | Factur-X PDF or XML file to parse |  |
+| **callback_url** | **String** |  | [optional] |
+
+### Return type
+
+[**TaskResponse**](TaskResponse.md)
+
+### Authorization
+
+[APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
+
+### HTTP request headers
+
+- **Content-Type**: multipart/form-data
+- **Accept**: application/json
+
+
+## parse_facturx_sync_api_v1_processing_parse_facturx_post
+
+> <ParseFacturXResponse> parse_facturx_sync_api_v1_processing_parse_facturx_post(file)
+
+Parse CII, UBL or Factur-X PDF (sync)
+
+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)
+
+### Examples
+
+```ruby
+require 'time'
+require 'factpulse'
+# setup authorization
+FactPulse.configure do |config|
+  # Configure API key authorization: APIKeyHeader
+  config.api_key['X-API-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['X-API-Key'] = 'Bearer'
+
+  # Configure Bearer authorization: HTTPBearer
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = FactPulse::ParseApi.new
+file = File.new('/path/to/some/file') # File | Factur-X PDF or XML file to parse
+
+begin
+  # Parse CII, UBL or Factur-X PDF (sync)
+  result = api_instance.parse_facturx_sync_api_v1_processing_parse_facturx_post(file)
+  p result
+rescue FactPulse::ApiError => e
+  puts "Error when calling ParseApi->parse_facturx_sync_api_v1_processing_parse_facturx_post: #{e}"
+end
+```
+
+#### Using the parse_facturx_sync_api_v1_processing_parse_facturx_post_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ParseFacturXResponse>, Integer, Hash)> parse_facturx_sync_api_v1_processing_parse_facturx_post_with_http_info(file)
+
+```ruby
+begin
+  # Parse CII, UBL or Factur-X PDF (sync)
+  data, status_code, headers = api_instance.parse_facturx_sync_api_v1_processing_parse_facturx_post_with_http_info(file)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ParseFacturXResponse>
+rescue FactPulse::ApiError => e
+  puts "Error when calling ParseApi->parse_facturx_sync_api_v1_processing_parse_facturx_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **file** | **File** | Factur-X PDF or XML file to parse |  |
+
+### Return type
+
+[**ParseFacturXResponse**](ParseFacturXResponse.md)
+
+### Authorization
+
+[APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
+
+### HTTP request headers
+
+- **Content-Type**: multipart/form-data
+- **Accept**: application/json
+

data/docs/ParseFacturXResponse.md

@@ -0,0 +1,26 @@
+# FactPulse::ParseFacturXResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **status** | **String** | Parsing status |  |
+| **invoice** | **Hash<String, Object>** | Parsed invoice data. For CII/Factur-X: FacturXInvoice format (round-trip with /generate-invoice). For UBL: IncomingInvoice format (summary extraction). |  |
+| **detected_format** | **String** |  | [optional] |
+| **detected_profile** | **String** |  | [optional] |
+| **error** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::ParseFacturXResponse.new(
+  status: null,
+  invoice: null,
+  detected_format: null,
+  detected_profile: null,
+  error: null
+)
+```
+

data/docs/ReferencesApi.md

@@ -0,0 +1,74 @@
+# FactPulse::ReferencesApi
+
+All URIs are relative to *https://factpulse.fr*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_vatex_codes_api_v1_references_vatex_codes_get**](ReferencesApi.md#get_vatex_codes_api_v1_references_vatex_codes_get) | **GET** /api/v1/references/vatex-codes | VATEX exemption reason codes |
+
+
+## get_vatex_codes_api_v1_references_vatex_codes_get
+
+> <VATEXCodesResponse> get_vatex_codes_api_v1_references_vatex_codes_get(opts)
+
+VATEX exemption reason codes
+
+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/
+
+### Examples
+
+```ruby
+require 'time'
+require 'factpulse'
+
+api_instance = FactPulse::ReferencesApi.new
+opts = {
+  category: 'category_example' # String | Filter by VAT category code (E, AE, K, G, O).
+}
+
+begin
+  # VATEX exemption reason codes
+  result = api_instance.get_vatex_codes_api_v1_references_vatex_codes_get(opts)
+  p result
+rescue FactPulse::ApiError => e
+  puts "Error when calling ReferencesApi->get_vatex_codes_api_v1_references_vatex_codes_get: #{e}"
+end
+```
+
+#### Using the get_vatex_codes_api_v1_references_vatex_codes_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<VATEXCodesResponse>, Integer, Hash)> get_vatex_codes_api_v1_references_vatex_codes_get_with_http_info(opts)
+
+```ruby
+begin
+  # VATEX exemption reason codes
+  data, status_code, headers = api_instance.get_vatex_codes_api_v1_references_vatex_codes_get_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <VATEXCodesResponse>
+rescue FactPulse::ApiError => e
+  puts "Error when calling ReferencesApi->get_vatex_codes_api_v1_references_vatex_codes_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **category** | **String** | Filter by VAT category code (E, AE, K, G, O). | [optional] |
+
+### Return type
+
+[**VATEXCodesResponse**](VATEXCodesResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/SecretStatus.md

@@ -6,6 +6,8 @@
 | ---- | ---- | ----------- | ----- |
 | **status** | **String** | Secret status: 'active', 'missing', etc. |  |
 | **message** | **String** | Descriptive status message |  |
+| **encryption_mode** | **String** |  | [optional] |
+| **requires_client_key** | **Boolean** |  | [optional] |
 
 ## Example
 
@@ -14,7 +16,9 @@ require 'factpulse'
 
 instance = FactPulse::SecretStatus.new(
   status: null,
-  message: null
+  message: null,
+  encryption_mode: null,
+  requires_client_key: null
 )
 ```
 

data/docs/SignatureSuccessResult.md

@@ -0,0 +1,34 @@
+# FactPulse::SignatureSuccessResult
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **status** | **String** |  | [optional][default to 'SUCCESS'] |
+| **content_b64** | **String** |  |  |
+| **filename** | **String** |  |  |
+| **size_bytes** | **Integer** |  |  |
+| **is_signed** | **Boolean** |  |  |
+| **signature_count** | **Integer** |  |  |
+| **signer_cn** | **String** |  |  |
+| **signing_date** | **String** |  |  |
+| **validation_details** | **Hash<String, Object>** |  |  |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::SignatureSuccessResult.new(
+  status: null,
+  content_b64: null,
+  filename: null,
+  size_bytes: null,
+  is_signed: null,
+  signature_count: null,
+  signer_cn: null,
+  signing_date: null,
+  validation_details: null
+)
+```
+

data/docs/SignatureTaskStatus.md

@@ -0,0 +1,22 @@
+# FactPulse::SignatureTaskStatus
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **task_id** | **String** |  |  |
+| **status** | [**CeleryStatus**](CeleryStatus.md) |  |  |
+| **result** | [**SignatureTaskStatusResult**](SignatureTaskStatusResult.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::SignatureTaskStatus.new(
+  task_id: null,
+  status: null,
+  result: null
+)
+```
+

data/docs/SignatureTaskStatusResult.md

@@ -0,0 +1,79 @@
+# FactPulse::SignatureTaskStatusResult
+
+## Class instance methods
+
+### `openapi_one_of`
+
+Returns the list of classes defined in oneOf.
+
+#### Example
+
+```ruby
+require 'factpulse'
+
+FactPulse::SignatureTaskStatusResult.openapi_one_of
+# =>
+# [
+#   :'SignatureSuccessResult',
+#   :'TaskErrorResult'
+# ]
+```
+
+### `openapi_discriminator_name`
+
+Returns the discriminator's property name.
+
+#### Example
+
+```ruby
+require 'factpulse'
+
+FactPulse::SignatureTaskStatusResult.openapi_discriminator_name
+# => :'status'
+```
+
+### `openapi_discriminator_name`
+
+Returns the discriminator's mapping.
+
+#### Example
+
+```ruby
+require 'factpulse'
+
+FactPulse::SignatureTaskStatusResult.openapi_discriminator_mapping
+# =>
+# {
+#   :'ERROR' => :'TaskErrorResult',
+#   :'SUCCESS' => :'SignatureSuccessResult'
+# }
+```
+
+### build
+
+Find the appropriate object from the `openapi_one_of` list and casts the data into it.
+
+#### Example
+
+```ruby
+require 'factpulse'
+
+FactPulse::SignatureTaskStatusResult.build(data)
+# => #<SignatureSuccessResult:0x00007fdd4aab02a0>
+
+FactPulse::SignatureTaskStatusResult.build(data_that_doesnt_match)
+# => nil
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| **data** | **Mixed** | data to be matched against the list of oneOf items |
+
+#### Return type
+
+- `SignatureSuccessResult`
+- `TaskErrorResult`
+- `nil` (if no type matches)
+

data/docs/SimplifiedInvoiceData.md

@@ -13,7 +13,7 @@
 | **comment** | **String** |  | [optional] |
 | **purchase_order_reference** | **String** |  | [optional] |
 | **contract_reference** | **String** |  | [optional] |
-| **invoice_type** | [**InvoiceTypeCode**](InvoiceTypeCode.md) | Document type (UNTDID 1001). Default: 380 (Invoice). | [optional] |
+| **invoice_type** | [**FactureElectroniqueModelsInvoiceTypeCode**](FactureElectroniqueModelsInvoiceTypeCode.md) | Document type (UNTDID 1001). Default: 380 (Invoice). | [optional] |
 | **preceding_invoice_reference** | **String** |  | [optional] |
 | **operation_nature** | [**OperationNature**](OperationNature.md) |  | [optional] |
 | **invoicing_framework** | [**InvoicingFrameworkCode**](InvoicingFrameworkCode.md) |  | [optional] |

data/docs/SubmitCompleteInvoiceResponse.md

@@ -8,7 +8,8 @@
 | **destination_type** | **String** | Destination type |  |
 | **chorus_result** | [**ChorusProResult**](ChorusProResult.md) |  | [optional] |
 | **afnor_result** | [**AFNORResult**](AFNORResult.md) |  | [optional] |
-| **enriched_invoice** | [**EnrichedInvoiceInfo**](EnrichedInvoiceInfo.md) | Enriched invoice data |  |
+| **enriched_invoice** | [**EnrichedInvoiceInfo**](EnrichedInvoiceInfo.md) | Enriched invoice data (summary) |  |
+| **invoice** | **Hash<String, Object>** | Complete enriched invoice data (FacturXInvoice format). Use this to regenerate the same invoice. |  |
 | **facturx_pdf** | [**FacturXPDFInfo**](FacturXPDFInfo.md) | Generated PDF information |  |
 | **signature** | [**SignatureInfo**](SignatureInfo.md) |  | [optional] |
 | **content_b64** | **String** | Generated Factur-X PDF (and signed if requested) base64-encoded |  |
@@ -25,6 +26,7 @@ instance = FactPulse::SubmitCompleteInvoiceResponse.new(
   chorus_result: null,
   afnor_result: null,
   enriched_invoice: null,
+  invoice: null,
   facturx_pdf: null,
   signature: null,
   content_b64: null,

data/docs/Supplier.md

@@ -5,7 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **electronic_address** | [**ElectronicAddress**](ElectronicAddress.md) |  | [optional] |
-| **supplier_id** | **Integer** |  |  |
+| **supplier_id** | **Integer** | Chorus Pro supplier structure ID (idFournisseur). Only required for B2G. | [optional][default to 0] |
 | **private_id** | **String** |  | [optional] |
 | **supplier_bank_account_code** | **Integer** |  | [optional] |
 | **supplier_service_id** | **Integer** |  | [optional] |

data/docs/TaskErrorResult.md

@@ -0,0 +1,26 @@
+# FactPulse::TaskErrorResult
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **status** | **String** |  | [optional][default to 'ERROR'] |
+| **error_code** | **String** |  |  |
+| **error_message** | **String** |  |  |
+| **details** | [**Array<AFNORErrorDetail>**](AFNORErrorDetail.md) |  | [optional] |
+| **traceback** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::TaskErrorResult.new(
+  status: null,
+  error_code: null,
+  error_message: null,
+  details: null,
+  traceback: null
+)
+```
+

data/docs/VATEXCodeInfo.md

@@ -0,0 +1,24 @@
+# FactPulse::VATEXCodeInfo
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **code** | **String** | VATEX code (e.g. VATEX-EU-IC) |  |
+| **name** | **String** | Short name (e.g. 'Intra-Community supply') |  |
+| **description** | **String** | Detailed description / remark |  |
+| **category** | **String** | Associated VAT category code (E, AE, K, G, O) |  |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::VATEXCodeInfo.new(
+  code: null,
+  name: null,
+  description: null,
+  category: null
+)
+```
+

data/docs/VATEXCodesResponse.md

@@ -0,0 +1,22 @@
+# FactPulse::VATEXCodesResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **codes** | [**Array<VATEXCodeInfo>**](VATEXCodeInfo.md) |  |  |
+| **count** | **Integer** |  |  |
+| **source** | **String** |  | [optional][default to 'https://docs.peppol.eu/poacc/billing/3.0/codelist/vatex/'] |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::VATEXCodesResponse.new(
+  codes: null,
+  count: null,
+  source: null
+)
+```
+

data/docs/ValidateCDARResponse.md

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

data/docs/ValidationApi.md

@@ -0,0 +1,88 @@
+# FactPulse::ValidationApi
+
+All URIs are relative to *https://factpulse.fr*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**validate_xml_api_v1_processing_validate_xml_post**](ValidationApi.md#validate_xml_api_v1_processing_validate_xml_post) | **POST** /api/v1/processing/validate-xml | Validate a CII or UBL XML against Schematron rules |
+
+
+## validate_xml_api_v1_processing_validate_xml_post
+
+> <ValidationSuccessResponse> validate_xml_api_v1_processing_validate_xml_post(xml_file, opts)
+
+Validate a CII or UBL XML against Schematron rules
+
+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
+
+### Examples
+
+```ruby
+require 'time'
+require 'factpulse'
+# setup authorization
+FactPulse.configure do |config|
+  # Configure API key authorization: APIKeyHeader
+  config.api_key['X-API-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['X-API-Key'] = 'Bearer'
+
+  # Configure Bearer authorization: HTTPBearer
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = FactPulse::ValidationApi.new
+xml_file = File.new('/path/to/some/file') # File | CII (Factur-X) or UBL XML file to validate (.xml format). Format is auto-detected.
+opts = {
+  profile: FactPulse::APIProfile::MINIMUM, # APIProfile | Validation profile (MINIMUM, BASIC, EN16931, EXTENDED). Used for CII only; ignored for UBL (always EN16931).
+  skip_br_fr: true # Boolean | 
+}
+
+begin
+  # Validate a CII or UBL XML against Schematron rules
+  result = api_instance.validate_xml_api_v1_processing_validate_xml_post(xml_file, opts)
+  p result
+rescue FactPulse::ApiError => e
+  puts "Error when calling ValidationApi->validate_xml_api_v1_processing_validate_xml_post: #{e}"
+end
+```
+
+#### Using the validate_xml_api_v1_processing_validate_xml_post_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ValidationSuccessResponse>, Integer, Hash)> validate_xml_api_v1_processing_validate_xml_post_with_http_info(xml_file, opts)
+
+```ruby
+begin
+  # Validate a CII or UBL XML against Schematron rules
+  data, status_code, headers = api_instance.validate_xml_api_v1_processing_validate_xml_post_with_http_info(xml_file, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ValidationSuccessResponse>
+rescue FactPulse::ApiError => e
+  puts "Error when calling ValidationApi->validate_xml_api_v1_processing_validate_xml_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **xml_file** | **File** | CII (Factur-X) or UBL XML file to validate (.xml format). Format is auto-detected. |  |
+| **profile** | [**APIProfile**](APIProfile.md) | Validation profile (MINIMUM, BASIC, EN16931, EXTENDED). Used for CII only; ignored for UBL (always EN16931). | [optional] |
+| **skip_br_fr** | **Boolean** |  | [optional] |
+
+### Return type
+
+[**ValidationSuccessResponse**](ValidationSuccessResponse.md)
+
+### Authorization
+
+[APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
+
+### HTTP request headers
+
+- **Content-Type**: multipart/form-data
+- **Accept**: application/json
+

data/docs/ValidationErrorResponse.md

@@ -4,7 +4,10 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **detail** | **Array<String>** | List of detected validation errors. |  |
+| **field** | **String** | Champ concerné |  |
+| **message** | **String** | Message d'erreur |  |
+| **rule** | **String** |  | [optional] |
+| **severity** | **String** | Sévérité (error/warning) | [optional][default to 'error'] |
 
 ## Example
 
@@ -12,7 +15,10 @@
 require 'factpulse'
 
 instance = FactPulse::ValidationErrorResponse.new(
-  detail: null
+  field: null,
+  message: null,
+  rule: null,
+  severity: null
 )
 ```