factpulse 0.1.0 → 1.0.0

data/docs/FacturXPDFInfo.md

@@ -1,22 +0,0 @@
-# FactPulse::FacturXPDFInfo
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **size** | **Integer** | PDF size in bytes |  |
-| **profile** | **String** | Factur-X profile used |  |
-| **signed** | **Boolean** | PDF electronically signed | [optional][default to false] |
-
-## Example
-
-```ruby
-require 'factpulse'
-
-instance = FactPulse::FacturXPDFInfo.new(
-  size: null,
-  profile: null,
-  signed: null
-)
-```
-

data/docs/FacturXPDFXMLVerificationApi.md

@@ -1,240 +0,0 @@
-# FactPulse::FacturXPDFXMLVerificationApi
-
-All URIs are relative to *https://factpulse.fr*
-
-| Method | HTTP request | Description |
-| ------ | ------------ | ----------- |
-| [**get_verification_status_api_v1_verification_verify_async_task_id_status_get**](FacturXPDFXMLVerificationApi.md#get_verification_status_api_v1_verification_verify_async_task_id_status_get) | **GET** /api/v1/verification/verify-async/{task_id}/status | Get status of an asynchronous verification |
-| [**verify_pdf_async_api_v1_verification_verify_async_post**](FacturXPDFXMLVerificationApi.md#verify_pdf_async_api_v1_verification_verify_async_post) | **POST** /api/v1/verification/verify-async | Verify PDF/XML Factur-X compliance (asynchronous) |
-| [**verify_pdf_sync_api_v1_verification_verify_post**](FacturXPDFXMLVerificationApi.md#verify_pdf_sync_api_v1_verification_verify_post) | **POST** /api/v1/verification/verify | Verify PDF/XML Factur-X compliance (synchronous) |
-
-
-## get_verification_status_api_v1_verification_verify_async_task_id_status_get
-
-> <AsyncTaskStatus> get_verification_status_api_v1_verification_verify_async_task_id_status_get(task_id)
-
-Get status of an asynchronous verification
-
-Retrieves the status and result of an asynchronous verification task.  **Possible statuses:** - `PENDING`: Task waiting in queue - `STARTED`: Task currently running - `SUCCESS`: Task completed successfully (see `result`) - `FAILURE`: System error (unhandled exception)  **Note:** The `result.status` field can be \"SUCCESS\" or \"ERROR\" independently of Celery status (which will always be SUCCESS if the task ran).
-
-### 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::FacturXPDFXMLVerificationApi.new
-task_id = 'task_id_example' # String | Celery task ID returned by /verify-async endpoint
-
-begin
-  # Get status of an asynchronous verification
-  result = api_instance.get_verification_status_api_v1_verification_verify_async_task_id_status_get(task_id)
-  p result
-rescue FactPulse::ApiError => e
-  puts "Error when calling FacturXPDFXMLVerificationApi->get_verification_status_api_v1_verification_verify_async_task_id_status_get: #{e}"
-end
-```
-
-#### Using the get_verification_status_api_v1_verification_verify_async_task_id_status_get_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(<AsyncTaskStatus>, Integer, Hash)> get_verification_status_api_v1_verification_verify_async_task_id_status_get_with_http_info(task_id)
-
-```ruby
-begin
-  # Get status of an asynchronous verification
-  data, status_code, headers = api_instance.get_verification_status_api_v1_verification_verify_async_task_id_status_get_with_http_info(task_id)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => <AsyncTaskStatus>
-rescue FactPulse::ApiError => e
-  puts "Error when calling FacturXPDFXMLVerificationApi->get_verification_status_api_v1_verification_verify_async_task_id_status_get_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **task_id** | **String** | Celery task ID returned by /verify-async endpoint |  |
-
-### Return type
-
-[**AsyncTaskStatus**](AsyncTaskStatus.md)
-
-### Authorization
-
-[APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## verify_pdf_async_api_v1_verification_verify_async_post
-
-> <TaskResponse> verify_pdf_async_api_v1_verification_verify_async_post(pdf_file, opts)
-
-Verify PDF/XML Factur-X compliance (asynchronous)
-
-Verifies PDF/XML Factur-X compliance asynchronously.  **IMPORTANT**: Only Factur-X PDFs (with embedded XML) are accepted. PDFs without Factur-X XML will return a `NOT_FACTURX` error in the result.  This version uses a Celery task and can call the OCR service if the PDF is an image or if `force_ocr=true`.  **Returns immediately** a task ID. Use `/verify-async/{task_id}/status` to retrieve the result.  **Verification principle (Factur-X 1.08):** - Principle #2: XML can only contain info present in the PDF - Principle #4: All XML info must be present and compliant in the PDF  **Verified fields:** - Identification: BT-1 (invoice #), BT-2 (date), BT-3 (type), BT-5 (currency), BT-23 (framework) - Seller: BT-27 (name), BT-29 (SIRET), BT-30 (SIREN), BT-31 (VAT) - Buyer: BT-44 (name), BT-46 (SIRET), BT-47 (SIREN), BT-48 (VAT) - Amounts: BT-109 (excl. tax), BT-110 (VAT), BT-112 (incl. tax), BT-115 (amount due) - VAT breakdown: BT-116, BT-117, BT-118, BT-119 - Invoice lines: BT-153, BT-129, BT-146, BT-131 - Mandatory notes: PMT, PMD, AAB - Rule BR-FR-09: SIRET/SIREN consistency  **Advantages over synchronous version:** - OCR support for image PDFs (via DocTR service) - Longer timeout for large documents - Doesn't block the server  ## Webhook notification (recommended)  Instead of polling, you can receive a webhook notification when verification completes:  ``` callback_url=https://your-server.com/webhook ```  The webhook will POST a JSON payload with: - `event_type`: `verification.completed` or `verification.failed` - `data.is_compliant`: Whether the PDF/XML are consistent - `data.compliance_score`: Compliance score (0-1) - `X-Webhook-Signature` header for HMAC verification
-
-### 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::FacturXPDFXMLVerificationApi.new
-pdf_file = File.new('/path/to/some/file') # File | Factur-X PDF file to verify
-opts = {
-  force_ocr: true, # Boolean | Force OCR usage even if PDF contains native text
-  callback_url: 'callback_url_example', # String | 
-  webhook_mode: 'webhook_mode_example' # String | Webhook content delivery: 'inline' (base64 in payload) or 'download_url' (temporary URL, 1h TTL)
-}
-
-begin
-  # Verify PDF/XML Factur-X compliance (asynchronous)
-  result = api_instance.verify_pdf_async_api_v1_verification_verify_async_post(pdf_file, opts)
-  p result
-rescue FactPulse::ApiError => e
-  puts "Error when calling FacturXPDFXMLVerificationApi->verify_pdf_async_api_v1_verification_verify_async_post: #{e}"
-end
-```
-
-#### Using the verify_pdf_async_api_v1_verification_verify_async_post_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(<TaskResponse>, Integer, Hash)> verify_pdf_async_api_v1_verification_verify_async_post_with_http_info(pdf_file, opts)
-
-```ruby
-begin
-  # Verify PDF/XML Factur-X compliance (asynchronous)
-  data, status_code, headers = api_instance.verify_pdf_async_api_v1_verification_verify_async_post_with_http_info(pdf_file, opts)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => <TaskResponse>
-rescue FactPulse::ApiError => e
-  puts "Error when calling FacturXPDFXMLVerificationApi->verify_pdf_async_api_v1_verification_verify_async_post_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **pdf_file** | **File** | Factur-X PDF file to verify |  |
-| **force_ocr** | **Boolean** | Force OCR usage even if PDF contains native text | [optional][default to false] |
-| **callback_url** | **String** |  | [optional] |
-| **webhook_mode** | **String** | Webhook content delivery: &#39;inline&#39; (base64 in payload) or &#39;download_url&#39; (temporary URL, 1h TTL) | [optional][default to &#39;inline&#39;] |
-
-### 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
-
-
-## verify_pdf_sync_api_v1_verification_verify_post
-
-> <VerificationSuccessResponse> verify_pdf_sync_api_v1_verification_verify_post(pdf_file)
-
-Verify PDF/XML Factur-X compliance (synchronous)
-
-Verifies compliance between the PDF and its embedded Factur-X XML.  **IMPORTANT**: Only Factur-X PDFs (with embedded XML) are accepted. PDFs without Factur-X XML will be rejected with a 400 error.  This synchronous version uses only native PDF extraction (pdfplumber). For image PDFs requiring OCR, use the `/verify-async` endpoint.  **Verification principle (Factur-X 1.08):** - Principle #2: XML can only contain info present in the PDF - Principle #4: All XML info must be present and compliant in the PDF  **Verified fields:** - Identification: BT-1 (invoice #), BT-2 (date), BT-3 (type), BT-5 (currency), BT-23 (framework) - Seller: BT-27 (name), BT-29 (SIRET), BT-30 (SIREN), BT-31 (VAT) - Buyer: BT-44 (name), BT-46 (SIRET), BT-47 (SIREN), BT-48 (VAT) - Amounts: BT-109 (excl. tax), BT-110 (VAT), BT-112 (incl. tax), BT-115 (amount due) - VAT breakdown: BT-116, BT-117, BT-118, BT-119 - Invoice lines: BT-153, BT-129, BT-146, BT-131 - Mandatory notes: PMT, PMD, AAB - Rule BR-FR-09: SIRET/SIREN consistency
-
-### 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::FacturXPDFXMLVerificationApi.new
-pdf_file = File.new('/path/to/some/file') # File | Factur-X PDF file to verify
-
-begin
-  # Verify PDF/XML Factur-X compliance (synchronous)
-  result = api_instance.verify_pdf_sync_api_v1_verification_verify_post(pdf_file)
-  p result
-rescue FactPulse::ApiError => e
-  puts "Error when calling FacturXPDFXMLVerificationApi->verify_pdf_sync_api_v1_verification_verify_post: #{e}"
-end
-```
-
-#### Using the verify_pdf_sync_api_v1_verification_verify_post_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(<VerificationSuccessResponse>, Integer, Hash)> verify_pdf_sync_api_v1_verification_verify_post_with_http_info(pdf_file)
-
-```ruby
-begin
-  # Verify PDF/XML Factur-X compliance (synchronous)
-  data, status_code, headers = api_instance.verify_pdf_sync_api_v1_verification_verify_post_with_http_info(pdf_file)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => <VerificationSuccessResponse>
-rescue FactPulse::ApiError => e
-  puts "Error when calling FacturXPDFXMLVerificationApi->verify_pdf_sync_api_v1_verification_verify_post_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **pdf_file** | **File** | Factur-X PDF file to verify |  |
-
-### Return type
-
-[**VerificationSuccessResponse**](VerificationSuccessResponse.md)
-
-### Authorization
-
-[APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
-
-### HTTP request headers
-
-- **Content-Type**: multipart/form-data
-- **Accept**: application/json
-

data/docs/FacturXValidationApi.md

@@ -1,256 +0,0 @@
-# FactPulse::FacturXValidationApi
-
-All URIs are relative to *https://factpulse.fr*
-
-| Method | HTTP request | Description |
-| ------ | ------------ | ----------- |
-| [**validate_facturx_pdf_api_v1_processing_validate_facturx_pdf_post**](FacturXValidationApi.md#validate_facturx_pdf_api_v1_processing_validate_facturx_pdf_post) | **POST** /api/v1/processing/validate-facturx-pdf | Validate a complete Factur-X PDF |
-| [**validate_facturx_pdf_async_api_v1_processing_validate_facturx_async_post**](FacturXValidationApi.md#validate_facturx_pdf_async_api_v1_processing_validate_facturx_async_post) | **POST** /api/v1/processing/validate-facturx-async | Validate a Factur-X PDF (asynchronous with polling) |
-| [**validate_xml_api_v1_processing_validate_xml_post**](FacturXValidationApi.md#validate_xml_api_v1_processing_validate_xml_post) | **POST** /api/v1/processing/validate-xml | Validate an existing Factur-X XML |
-
-
-## validate_facturx_pdf_api_v1_processing_validate_facturx_pdf_post
-
-> <PDFValidationResultAPI> validate_facturx_pdf_api_v1_processing_validate_facturx_pdf_post(pdf_file, opts)
-
-Validate a complete Factur-X PDF
-
-Validates a complete Factur-X PDF according to European and French standards.  ## Applied validation standards  - **EN 16931**: European semantic standard (directive 2014/55/EU) - **ISO 19005-3** (PDF/A-3): Long-term electronic archiving - **Factur-X / ZUGFeRD**: Franco-German specification - **Schematron**: XML business rules validation - **eIDAS**: European regulation on electronic identification (signatures)  ## Checks performed  ### 1. Factur-X XML extraction and validation **Checks performed:** - Presence of embedded XML file (`factur-x.xml` or `zugferd-invoice.xml`) - Automatic profile detection (MINIMUM, BASIC, EN16931, EXTENDED) - XML parsing with UTF-8 validation - GuidelineSpecifiedDocumentContextParameter/ID extraction  **Schematron validation:** - Business rules for detected profile (MINIMUM: 45 rules, EN16931: 178 rules) - Cardinality of required elements - Calculation consistency (net, VAT, gross amounts, discounts) - Identifier formats (SIRET, intra-EU VAT, IBAN) - Standardized codes (ISO country codes, UN/ECE units, VAT codes)  **What is verified:** - ✅ XML structure conforming to Cross Industry Invoice XSD - ✅ Correct UN/CEFACT namespace - ✅ European business rules (BR-xx) - ✅ French-specific rules (FR-xx)  ### 2. PDF/A-3 compliance **Basic validation (metadata):** - Presence of `/Type` field set to `Catalog` - Metadata `pdfaid:part` = 3 (PDF/A-3) - Metadata `pdfaid:conformance` = B or U - PDF version >= 1.4  **Strict VeraPDF validation (if use_verapdf=True):** - 146+ ISO 19005-3 rules (PDF/A-3B) - Absence of forbidden content (JavaScript, multimedia, dynamic forms) - Correctly embedded fonts and subsets - Compliant color spaces (sRGB, DeviceGray) - Valid file structure (cross-reference table) - XMP metadata conforming to ISO 16684-1  **What is verified:** - ✅ Long-term archivable file (20+ years) - ✅ Guaranteed readability (embedded fonts) - ✅ Legal compliance (France, Germany, EU)  ### 3. XMP metadata (eXtensible Metadata Platform) **Checks performed:** - Presence of `<?xpacket>` block with XMP metadata - `fx:` namespace for Factur-X: `urn:factur-x:pdfa:CrossIndustryDocument:invoice:1p0#` - Required Factur-X fields:   - `fx:ConformanceLevel`: Profile (MINIMUM, BASIC, EN16931, EXTENDED)   - `fx:DocumentFileName`: Embedded XML name   - `fx:DocumentType`: \"INVOICE\"   - `fx:Version`: Factur-X version (1.0.07)  **What is verified:** - ✅ Metadata conforming to ISO 16684-1 - ✅ Correct declared Factur-X profile - ✅ Supported Factur-X version  ### 4. Electronic signatures **Detection and analysis:** - Presence of `/Sig` dictionaries in PDF - Signature type: PAdES (PDF Advanced Electronic Signature) - Information extraction:   - Signer name (`/Name`)   - Signing date (`/M`)   - Signature reason (`/Reason`)   - Signature location (`/Location`)   - Signature type (approval, certification)  **What is verified:** - ✅ Presence of signatures or seals - ✅ Number of signatures (single or multi-signature) - ℹ️ No cryptographic verification (requires certificates)  ## Parameters  - **pdf_file** (required): The Factur-X PDF file to validate - **profile** (optional): Expected profile. If absent, auto-detected from XML - **use_verapdf** (optional, default=false): Enable strict PDF/A validation with VeraPDF   - `false`: Fast metadata validation (2-3 seconds)   - `true`: Complete ISO 19005-3 validation (15-30 seconds, **recommended for production**)  ## Detailed response  ```json {   \"isCompliant\": true,   \"xml\": {     \"present\": true,     \"compliant\": true,     \"profile\": \"EN16931\",     \"errors\": []   },   \"pdfa\": {     \"compliant\": true,     \"version\": \"PDF/A-3B\",     \"method\": \"verapdf\",     \"errors\": []   },   \"xmp\": {     \"present\": true,     \"compliant\": true,     \"metadata\": {...}   },   \"signatures\": {     \"present\": true,     \"count\": 1,     \"details\": [...]   } } ```  ## Use cases  - **Before sending**: Validate generated invoice before transmission to client - **On reception**: Verify compliance of invoice received from supplier - **Audit**: Check quality of invoice batches - **Legal compliance**: Ensure B2B/B2G obligations are met in France - **Debugging**: Identify issues in generation process - **Archiving**: Guarantee long-term validity (PDF/A-3)  ## Processing time  - Basic validation: 2-3 seconds - VeraPDF validation: 15-30 seconds (depends on PDF size)
-
-### 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::FacturXValidationApi.new
-pdf_file = File.new('/path/to/some/file') # File | Factur-X PDF file to validate (.pdf format).
-opts = {
-  profile: FactPulse::APIProfile::MINIMUM, # APIProfile | 
-  use_verapdf: true, # Boolean | Enable strict PDF/A validation with VeraPDF (recommended for production). If False, uses basic metadata validation.
-  skip_br_fr: true # Boolean | 
-}
-
-begin
-  # Validate a complete Factur-X PDF
-  result = api_instance.validate_facturx_pdf_api_v1_processing_validate_facturx_pdf_post(pdf_file, opts)
-  p result
-rescue FactPulse::ApiError => e
-  puts "Error when calling FacturXValidationApi->validate_facturx_pdf_api_v1_processing_validate_facturx_pdf_post: #{e}"
-end
-```
-
-#### Using the validate_facturx_pdf_api_v1_processing_validate_facturx_pdf_post_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(<PDFValidationResultAPI>, Integer, Hash)> validate_facturx_pdf_api_v1_processing_validate_facturx_pdf_post_with_http_info(pdf_file, opts)
-
-```ruby
-begin
-  # Validate a complete Factur-X PDF
-  data, status_code, headers = api_instance.validate_facturx_pdf_api_v1_processing_validate_facturx_pdf_post_with_http_info(pdf_file, opts)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => <PDFValidationResultAPI>
-rescue FactPulse::ApiError => e
-  puts "Error when calling FacturXValidationApi->validate_facturx_pdf_api_v1_processing_validate_facturx_pdf_post_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **pdf_file** | **File** | Factur-X PDF file to validate (.pdf format). |  |
-| **profile** | [**APIProfile**](APIProfile.md) |  | [optional] |
-| **use_verapdf** | **Boolean** | Enable strict PDF/A validation with VeraPDF (recommended for production). If False, uses basic metadata validation. | [optional][default to false] |
-| **skip_br_fr** | **Boolean** |  | [optional] |
-
-### Return type
-
-[**PDFValidationResultAPI**](PDFValidationResultAPI.md)
-
-### Authorization
-
-[APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
-
-### HTTP request headers
-
-- **Content-Type**: multipart/form-data
-- **Accept**: application/json
-
-
-## validate_facturx_pdf_async_api_v1_processing_validate_facturx_async_post
-
-> <TaskResponse> validate_facturx_pdf_async_api_v1_processing_validate_facturx_async_post(pdf_file, opts)
-
-Validate a Factur-X PDF (asynchronous with polling)
-
-Validates a Factur-X PDF asynchronously with polling system.  ## How it works  1. **Submission**: PDF is queued for asynchronous validation 2. **Immediate return**: You receive a `task_id` (HTTP 202) 3. **Tracking**: Use the `/tasks/{task_id}/status` endpoint to track progress  ## Advantages of asynchronous mode  - **No timeout**: Ideal for large PDFs or VeraPDF validation (which can take several seconds) - **Scalability**: Validations are processed by dedicated Celery workers - **Status tracking**: Allows you to monitor validation progress - **Non-blocking**: Your client doesn't wait during validation  ## Webhook notification (recommended)  Instead of polling, you can receive a webhook notification when validation completes:  ``` callback_url=https://your-server.com/webhook webhook_mode=download_url  # Optional: get download URL instead of base64 ```  The webhook will POST a JSON payload with: - `event_type`: `validation.completed` or `validation.failed` - `data.is_compliant`: Whether the PDF is Factur-X compliant - `data.detected_profile`: The detected Factur-X profile - `X-Webhook-Signature` header for HMAC verification  ## When to use this mode?  - **VeraPDF validation enabled** (`use_verapdf=True`): Strict validation can take 2-10 seconds - **Large PDF files**: PDFs > 1 MB - **Batch processing**: Validating multiple invoices in parallel - **Asynchronous integration**: Your system supports polling  ## Checks performed  ### 1. Factur-X XML extraction and validation - Verifies presence of Factur-X compliant embedded XML file - Automatically detects profile used (MINIMUM, BASIC, EN16931, EXTENDED) - Validates XML against detected profile's Schematron rules  ### 2. PDF/A compliance - **Without VeraPDF**: Basic metadata validation (fast, ~100ms) - **With VeraPDF**: Strict ISO 19005 validation (146+ rules, 2-10s)   - Detects PDF/A version (PDF/A-1, PDF/A-3, etc.)   - Detailed non-compliance reports  ### 3. XMP metadata - Verifies presence of XMP metadata in PDF - Validates Factur-X metadata compliance (profile, version) - Extracts all available XMP metadata  ### 4. Electronic signatures - Detects presence of electronic signatures or seals - Extracts information about each signature (signer, date, reason) - Counts number of signatures present  ## Parameters  - **pdf_file**: The Factur-X PDF file to validate - **profile**: Expected Factur-X profile (optional). If not specified, profile   will be auto-detected from embedded XML file. - **use_verapdf**: Enable strict PDF/A validation with VeraPDF.   ⚠️ **Warning**: VeraPDF can take 2-10 seconds depending on PDF size.   Recommended only in asynchronous mode to avoid timeouts.  ## Retrieving results  After submission, use `GET /tasks/{task_id}/status` endpoint to retrieve the result.  **Polling example**: ```python import requests import time  # 1. Submit task response = requests.post(\"/validate-facturx-async\", files={\"pdf_file\": pdf_file}) task_id = response.json()[\"taskId\"]  # 2. Poll every 2 seconds while True:     status_response = requests.get(f\"/tasks/{task_id}/status\")     status = status_response.json()      if status[\"status\"] == \"SUCCESS\":         result = status[\"result\"][\"validation_result\"]         print(f\"Compliant: {result['is_compliant']}\")         break     elif status[\"status\"] == \"FAILURE\":         print(f\"Error: {status['result']['errorMessage']}\")         break      time.sleep(2)  # Wait 2 seconds before next check ```  ## Use cases  - Validate invoices before sending with VeraPDF (strict validation) - Process invoice batches in parallel - Integrate validation into an asynchronous pipeline - Validate large PDFs without timeout risk
-
-### 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::FacturXValidationApi.new
-pdf_file = File.new('/path/to/some/file') # File | Factur-X PDF file to validate (.pdf format).
-opts = {
-  profile: FactPulse::APIProfile::MINIMUM, # APIProfile | 
-  use_verapdf: true, # Boolean | Enable strict PDF/A validation with VeraPDF (recommended for production). May take several seconds.
-  callback_url: 'callback_url_example', # String | 
-  webhook_mode: 'webhook_mode_example' # String | Webhook content delivery: 'inline' (base64 in payload) or 'download_url' (temporary URL, 1h TTL)
-}
-
-begin
-  # Validate a Factur-X PDF (asynchronous with polling)
-  result = api_instance.validate_facturx_pdf_async_api_v1_processing_validate_facturx_async_post(pdf_file, opts)
-  p result
-rescue FactPulse::ApiError => e
-  puts "Error when calling FacturXValidationApi->validate_facturx_pdf_async_api_v1_processing_validate_facturx_async_post: #{e}"
-end
-```
-
-#### Using the validate_facturx_pdf_async_api_v1_processing_validate_facturx_async_post_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(<TaskResponse>, Integer, Hash)> validate_facturx_pdf_async_api_v1_processing_validate_facturx_async_post_with_http_info(pdf_file, opts)
-
-```ruby
-begin
-  # Validate a Factur-X PDF (asynchronous with polling)
-  data, status_code, headers = api_instance.validate_facturx_pdf_async_api_v1_processing_validate_facturx_async_post_with_http_info(pdf_file, opts)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => <TaskResponse>
-rescue FactPulse::ApiError => e
-  puts "Error when calling FacturXValidationApi->validate_facturx_pdf_async_api_v1_processing_validate_facturx_async_post_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **pdf_file** | **File** | Factur-X PDF file to validate (.pdf format). |  |
-| **profile** | [**APIProfile**](APIProfile.md) |  | [optional] |
-| **use_verapdf** | **Boolean** | Enable strict PDF/A validation with VeraPDF (recommended for production). May take several seconds. | [optional][default to false] |
-| **callback_url** | **String** |  | [optional] |
-| **webhook_mode** | **String** | Webhook content delivery: &#39;inline&#39; (base64 in payload) or &#39;download_url&#39; (temporary URL, 1h TTL) | [optional][default to &#39;inline&#39;] |
-
-### 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
-
-
-## validate_xml_api_v1_processing_validate_xml_post
-
-> <ValidationSuccessResponse> validate_xml_api_v1_processing_validate_xml_post(xml_file, opts)
-
-Validate an existing Factur-X XML
-
-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
-
-### 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::FacturXValidationApi.new
-xml_file = File.new('/path/to/some/file') # File | Factur-X XML file to validate (.xml format).
-opts = {
-  profile: FactPulse::APIProfile::MINIMUM, # APIProfile | Validation profile (MINIMUM, BASIC, EN16931, EXTENDED).
-  skip_br_fr: true # Boolean | 
-}
-
-begin
-  # Validate an existing Factur-X XML
-  result = api_instance.validate_xml_api_v1_processing_validate_xml_post(xml_file, opts)
-  p result
-rescue FactPulse::ApiError => e
-  puts "Error when calling FacturXValidationApi->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 an existing Factur-X XML
-  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 FacturXValidationApi->validate_xml_api_v1_processing_validate_xml_post_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **xml_file** | **File** | Factur-X XML file to validate (.xml format). |  |
-| **profile** | [**APIProfile**](APIProfile.md) | Validation profile (MINIMUM, BASIC, EN16931, EXTENDED). | [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/FactureElectroniqueRestApiSchemasEreportingInvoiceTypeCode.md

@@ -1,15 +0,0 @@
-# FactPulse::FactureElectroniqueRestApiSchemasEreportingInvoiceTypeCode
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-
-## Example
-
-```ruby
-require 'factpulse'
-
-instance = FactPulse::FactureElectroniqueRestApiSchemasEreportingInvoiceTypeCode.new()
-```
-

data/docs/FactureElectroniqueRestApiSchemasValidationValidationErrorResponse.md

@@ -1,18 +0,0 @@
-# FactPulse::FactureElectroniqueRestApiSchemasValidationValidationErrorResponse
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **detail** | **Array<String>** | List of detected validation errors. |  |
-
-## Example
-
-```ruby
-require 'factpulse'
-
-instance = FactPulse::FactureElectroniqueRestApiSchemasValidationValidationErrorResponse.new(
-  detail: null
-)
-```
-

data/docs/FieldStatus.md

@@ -1,15 +0,0 @@
-# FactPulse::FieldStatus
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-
-## Example
-
-```ruby
-require 'factpulse'
-
-instance = FactPulse::FieldStatus.new()
-```
-

data/docs/FileInfo.md

@@ -1,20 +0,0 @@
-# FactPulse::FileInfo
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **content_b64** | **String** |  | [optional] |
-| **size_bytes** | **Integer** | Taille en bytes | [optional][default to 0] |
-
-## Example
-
-```ruby
-require 'factpulse'
-
-instance = FactPulse::FileInfo.new(
-  content_b64: null,
-  size_bytes: null
-)
-```
-

data/docs/FilesInfo.md

@@ -1,20 +0,0 @@
-# FactPulse::FilesInfo
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **facturx_pdf** | [**FileInfo**](FileInfo.md) |  | [optional] |
-| **xml** | [**FileInfo**](FileInfo.md) |  | [optional] |
-
-## Example
-
-```ruby
-require 'factpulse'
-
-instance = FactPulse::FilesInfo.new(
-  facturx_pdf: null,
-  xml: null
-)
-```
-

data/docs/FlowDirection.md

@@ -1,15 +0,0 @@
-# FactPulse::FlowDirection
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-
-## Example
-
-```ruby
-require 'factpulse'
-
-instance = FactPulse::FlowDirection.new()
-```
-

data/docs/FlowProfile.md

@@ -1,15 +0,0 @@
-# FactPulse::FlowProfile
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-
-## Example
-
-```ruby
-require 'factpulse'
-
-instance = FactPulse::FlowProfile.new()
-```
-