factpulse 2.0.42 → 3.0.0

data/docs/InvoiceReferences.md

@@ -0,0 +1,32 @@
+# FactPulse::InvoiceReferences
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **invoice_currency** | **String** |  | [optional][default to 'EUR'] |
+| **payment_means** | [**PaymentMeans**](PaymentMeans.md) |  |  |
+| **invoice_type** | [**InvoiceTypeCode**](InvoiceTypeCode.md) |  |  |
+| **vat_accounting_code** | [**VATAccountingCode**](VATAccountingCode.md) |  |  |
+| **contract_reference** | **String** |  | [optional] |
+| **vat_exemption_reason** | **String** |  | [optional] |
+| **purchase_order_reference** | **String** |  | [optional] |
+| **preceding_invoice_reference** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::InvoiceReferences.new(
+  invoice_currency: null,
+  payment_means: null,
+  invoice_type: null,
+  vat_accounting_code: null,
+  contract_reference: null,
+  vat_exemption_reason: null,
+  purchase_order_reference: null,
+  preceding_invoice_reference: null
+)
+```
+

data/docs/{StatutFacture.md → InvoiceStatus.md}

@@ -1,11 +1,11 @@
-# FactPulse::StatutFacture
+# FactPulse::InvoiceStatus
 
 ## Properties
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **code** | **String** | Code statut (SOUMISE, VALIDEE, REJETEE, SUSPENDUE, MANDATEE, MISE_EN_PAIEMENT, etc.) |  |
-| **libelle** | **String** | Libellé du statut |  |
+| **code** | **String** | Status code (SOUMISE, VALIDEE, REJETEE, SUSPENDUE, MANDATEE, MISE_EN_PAIEMENT, etc.) |  |
+| **label** | **String** | Status label |  |
 | **date** | **String** |  | [optional] |
 
 ## Example
@@ -13,9 +13,9 @@
 ```ruby
 require 'factpulse'
 
-instance = FactPulse::StatutFacture.new(
+instance = FactPulse::InvoiceStatus.new(
   code: null,
-  libelle: null,
+  label: null,
   date: null
 )
 ```

data/docs/InvoiceTotals.md

@@ -0,0 +1,30 @@
+# FactPulse::InvoiceTotals
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **total_net_amount** | [**TotalNetAmount**](TotalNetAmount.md) |  |  |
+| **vat_amount** | [**TotalVATAmount**](TotalVATAmount.md) |  |  |
+| **total_gross_amount** | [**TotalGrossAmount**](TotalGrossAmount.md) |  |  |
+| **amount_due** | [**AmountDue**](AmountDue.md) |  |  |
+| **prepayment** | [**InvoiceTotalsPrepayment**](InvoiceTotalsPrepayment.md) |  | [optional] |
+| **global_allowance_amount** | [**GlobalAllowanceAmount**](GlobalAllowanceAmount.md) |  | [optional] |
+| **global_allowance_reason** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::InvoiceTotals.new(
+  total_net_amount: null,
+  vat_amount: null,
+  total_gross_amount: null,
+  amount_due: null,
+  prepayment: null,
+  global_allowance_amount: null,
+  global_allowance_reason: null
+)
+```
+

data/docs/InvoiceTotalsPrepayment.md

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

data/docs/InvoiceTypeCode.md

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

data/docs/InvoicingFramework.md

@@ -0,0 +1,24 @@
+# FactPulse::InvoicingFramework
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **invoicing_framework_code** | [**InvoicingFrameworkCode**](InvoicingFrameworkCode.md) |  |  |
+| **operation_nature** | [**OperationNature**](OperationNature.md) |  | [optional] |
+| **approver_service_code** | **String** |  | [optional] |
+| **approver_structure_code** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::InvoicingFramework.new(
+  invoicing_framework_code: null,
+  operation_nature: null,
+  approver_service_code: null,
+  approver_structure_code: null
+)
+```
+

data/docs/InvoicingFrameworkCode.md

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

data/docs/LineNetAmount.md

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

data/docs/MandatoryNoteSchema.md

@@ -0,0 +1,30 @@
+# FactPulse::MandatoryNoteSchema
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **subject_code** | **String** | Subject code (PMT, PMD, AAB) |  |
+| **label** | **String** | Label (e.g., Recovery indemnity) |  |
+| **pdf_value** | **String** |  | [optional] |
+| **xml_value** | **String** |  | [optional] |
+| **status** | [**FieldStatus**](FieldStatus.md) | Compliance status (COMPLIANT if XML found in PDF) | [optional] |
+| **message** | **String** |  | [optional] |
+| **bbox** | [**BoundingBoxSchema**](BoundingBoxSchema.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::MandatoryNoteSchema.new(
+  subject_code: null,
+  label: null,
+  pdf_value: null,
+  xml_value: null,
+  status: null,
+  message: null,
+  bbox: null
+)
+```
+

data/docs/ManualRate.md

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

data/docs/ManualVatRate.md

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

data/docs/OperationNature.md

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

data/docs/{FormatSortie.md → OutputFormat.md}

@@ -1,4 +1,4 @@
-# FactPulse::FormatSortie
+# FactPulse::OutputFormat
 
 ## Properties
 
@@ -10,6 +10,6 @@
 ```ruby
 require 'factpulse'
 
-instance = FactPulse::FormatSortie.new()
+instance = FactPulse::OutputFormat.new()
 ```
 

data/docs/PDFValidationResultAPI.md

@@ -0,0 +1,62 @@
+# FactPulse::PDFValidationResultAPI
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **is_compliant** | **Boolean** | True if PDF complies with all criteria (XML, PDF/A, XMP) |  |
+| **xml_present** | **Boolean** | True if a Factur-X XML is embedded in the PDF |  |
+| **xml_compliant** | **Boolean** | True if Factur-X XML complies with Schematron rules |  |
+| **detected_profile** | **String** |  | [optional] |
+| **xml_errors** | **Array<String>** | List of XML validation errors | [optional] |
+| **pdfa_compliant** | **Boolean** | True if PDF is PDF/A compliant |  |
+| **pdfa_version** | **String** |  | [optional] |
+| **pdfa_validation_method** | **String** | Method used for PDF/A validation (metadata or verapdf) | [optional][default to 'metadata'] |
+| **validated_rules** | **Integer** |  | [optional] |
+| **failed_rules** | **Integer** |  | [optional] |
+| **pdfa_errors** | **Array<String>** | List of PDF/A compliance errors | [optional] |
+| **pdfa_warnings** | **Array<String>** | List of PDF/A warnings | [optional] |
+| **xmp_present** | **Boolean** | True if XMP metadata is present |  |
+| **xmp_facturx_compliant** | **Boolean** | True if XMP metadata contains Factur-X information |  |
+| **xmp_profile** | **String** |  | [optional] |
+| **xmp_version** | **String** |  | [optional] |
+| **xmp_errors** | **Array<String>** | List of XMP metadata errors | [optional] |
+| **xmp_metadata** | **Hash<String, Object>** | XMP metadata extracted from PDF | [optional] |
+| **is_signed** | **Boolean** | True if PDF contains at least one signature |  |
+| **signature_count** | **Integer** | Number of electronic signatures found | [optional][default to 0] |
+| **signatures** | [**Array<SignatureInfoAPI>**](SignatureInfoAPI.md) | List of found signatures with their information | [optional] |
+| **signature_errors** | **Array<String>** | List of errors during signature analysis | [optional] |
+| **summary_message** | **String** | Message summarizing the validation result |  |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::PDFValidationResultAPI.new(
+  is_compliant: null,
+  xml_present: null,
+  xml_compliant: null,
+  detected_profile: null,
+  xml_errors: null,
+  pdfa_compliant: null,
+  pdfa_version: null,
+  pdfa_validation_method: null,
+  validated_rules: null,
+  failed_rules: null,
+  pdfa_errors: null,
+  pdfa_warnings: null,
+  xmp_present: null,
+  xmp_facturx_compliant: null,
+  xmp_profile: null,
+  xmp_version: null,
+  xmp_errors: null,
+  xmp_metadata: null,
+  is_signed: null,
+  signature_count: null,
+  signatures: null,
+  signature_errors: null,
+  summary_message: null
+)
+```
+