factpulse 3.0.4 → 3.0.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +3 -3
- data/Gemfile.lock +1 -1
- data/docs/AdditionalDocument.md +26 -0
- data/docs/AllowanceCharge.md +32 -0
- data/docs/AllowanceTotalAmount.md +15 -0
- data/docs/{APIProfile.md → Amount.md} +2 -2
- data/docs/{DocumentType.md → BaseAmount.md} +2 -2
- data/docs/ChargeTotalAmount.md +15 -0
- data/docs/Contact.md +24 -0
- data/docs/ConvertErrorResponse.md +26 -0
- data/docs/ConvertPendingInputResponse.md +32 -0
- data/docs/ConvertResumeRequest.md +18 -0
- data/docs/ConvertSuccessResponse.md +36 -0
- data/docs/ConvertValidationFailedResponse.md +34 -0
- data/docs/DeliveryParty.md +24 -0
- data/docs/DocumentConversionApi.md +373 -0
- data/docs/DocumentTypeInfo.md +22 -0
- data/docs/ExtractionInfo.md +24 -0
- data/docs/FacturXInvoice.md +29 -1
- data/docs/FacturXProfile.md +15 -0
- data/docs/FileInfo.md +20 -0
- data/docs/FilesInfo.md +20 -0
- data/docs/GrossUnitPrice.md +15 -0
- data/docs/IncomingInvoice.md +1 -1
- data/docs/InvoiceLine.md +43 -9
- data/docs/InvoiceProcessingApi.md +8 -8
- data/docs/InvoiceReferences.md +26 -6
- data/docs/InvoiceTotals.md +10 -2
- data/docs/LineTotalAmount.md +15 -0
- data/docs/MissingField.md +28 -0
- data/docs/Payee.md +5 -1
- data/docs/PaymentCard.md +20 -0
- data/docs/Percentage.md +15 -0
- data/docs/PostalAddress.md +5 -1
- data/docs/PriceAllowanceAmount.md +15 -0
- data/docs/PriceBasisQuantity.md +15 -0
- data/docs/ProcessingOptions.md +3 -3
- data/docs/ProductCharacteristic.md +20 -0
- data/docs/ProductClassification.md +22 -0
- data/docs/Recipient.md +7 -1
- data/docs/RoundingAmount.md +15 -0
- data/docs/Supplier.md +17 -1
- data/docs/TaxRepresentative.md +22 -0
- data/docs/VATLine.md +2 -0
- data/docs/VATPointDateCode.md +15 -0
- data/docs/ValidationInfo.md +28 -0
- data/docs/VatRate.md +15 -0
- data/factpulse.gemspec +1 -1
- data/lib/factpulse/api/afnorpdppa_api.rb +1 -1
- data/lib/factpulse/api/afnorpdppa_directory_service_api.rb +1 -1
- data/lib/factpulse/api/afnorpdppa_flow_service_api.rb +1 -1
- data/lib/factpulse/api/chorus_pro_api.rb +1 -1
- data/lib/factpulse/api/document_conversion_api.rb +378 -0
- data/lib/factpulse/api/health_api.rb +1 -1
- data/lib/factpulse/api/invoice_processing_api.rb +9 -9
- data/lib/factpulse/api/pdfxml_verification_api.rb +1 -1
- data/lib/factpulse/api/user_api.rb +1 -1
- data/lib/factpulse/api_client.rb +1 -1
- data/lib/factpulse/api_error.rb +1 -1
- data/lib/factpulse/api_model_base.rb +1 -1
- data/lib/factpulse/configuration.rb +1 -1
- data/lib/factpulse/models/acknowledgment_status.rb +1 -1
- data/lib/factpulse/models/additional_document.rb +206 -0
- data/lib/factpulse/models/afnor_credentials.rb +1 -1
- data/lib/factpulse/models/afnor_destination.rb +1 -1
- data/lib/factpulse/models/afnor_health_check_response.rb +1 -1
- data/lib/factpulse/models/afnor_result.rb +1 -1
- data/lib/factpulse/models/allowance_charge.rb +252 -0
- data/lib/factpulse/models/allowance_reason_code.rb +1 -1
- data/lib/factpulse/models/allowance_total_amount.rb +104 -0
- data/lib/factpulse/models/amount.rb +104 -0
- data/lib/factpulse/models/amount_due.rb +2 -2
- data/lib/factpulse/models/api_error.rb +1 -1
- data/lib/factpulse/models/async_task_status.rb +1 -1
- data/lib/factpulse/models/base_amount.rb +104 -0
- data/lib/factpulse/models/bounding_box_schema.rb +1 -1
- data/lib/factpulse/models/celery_status.rb +1 -1
- data/lib/factpulse/models/certificate_info_response.rb +1 -1
- data/lib/factpulse/models/charge_total_amount.rb +104 -0
- data/lib/factpulse/models/chorus_pro_destination.rb +1 -1
- data/lib/factpulse/models/chorus_pro_result.rb +1 -1
- data/lib/factpulse/models/contact.rb +179 -0
- data/lib/factpulse/models/convert_error_response.rb +224 -0
- data/lib/factpulse/models/convert_pending_input_response.rb +322 -0
- data/lib/factpulse/models/convert_resume_request.rb +151 -0
- data/lib/factpulse/models/convert_success_response.rb +360 -0
- data/lib/factpulse/models/convert_validation_failed_response.rb +334 -0
- data/lib/factpulse/models/delivery_party.rb +179 -0
- data/lib/factpulse/models/destination.rb +1 -1
- data/lib/factpulse/models/document_type_info.rb +220 -0
- data/lib/factpulse/models/electronic_address.rb +1 -1
- data/lib/factpulse/models/enriched_invoice_info.rb +1 -1
- data/lib/factpulse/models/error_level.rb +1 -1
- data/lib/factpulse/models/error_source.rb +1 -1
- data/lib/factpulse/models/extraction_info.rb +217 -0
- data/lib/factpulse/models/factur_x_invoice.rb +150 -6
- data/lib/factpulse/models/{api_profile.rb → factur_x_profile.rb} +4 -4
- data/lib/factpulse/models/factur_xpdf_info.rb +1 -1
- data/lib/factpulse/models/facture_electronique_rest_api_schemas_chorus_pro_chorus_pro_credentials.rb +5 -5
- data/lib/factpulse/models/facture_electronique_rest_api_schemas_processing_chorus_pro_credentials.rb +1 -1
- data/lib/factpulse/models/field_status.rb +1 -1
- data/lib/factpulse/models/file_info.rb +161 -0
- data/lib/factpulse/models/files_info.rb +159 -0
- data/lib/factpulse/models/flow_direction.rb +1 -1
- data/lib/factpulse/models/flow_profile.rb +1 -1
- data/lib/factpulse/models/flow_summary.rb +1 -1
- data/lib/factpulse/models/flow_syntax.rb +1 -1
- data/lib/factpulse/models/flow_type.rb +1 -1
- data/lib/factpulse/models/generate_certificate_request.rb +6 -6
- data/lib/factpulse/models/generate_certificate_response.rb +1 -1
- data/lib/factpulse/models/get_chorus_pro_id_request.rb +2 -2
- data/lib/factpulse/models/get_chorus_pro_id_response.rb +1 -1
- data/lib/factpulse/models/get_invoice_request.rb +2 -2
- data/lib/factpulse/models/get_invoice_response.rb +1 -1
- data/lib/factpulse/models/get_structure_request.rb +3 -3
- data/lib/factpulse/models/get_structure_response.rb +1 -1
- data/lib/factpulse/models/global_allowance_amount.rb +2 -2
- data/lib/factpulse/models/gross_unit_price.rb +104 -0
- data/lib/factpulse/models/http_validation_error.rb +1 -1
- data/lib/factpulse/models/incoming_invoice.rb +2 -2
- data/lib/factpulse/models/incoming_supplier.rb +1 -1
- data/lib/factpulse/models/invoice_format.rb +1 -1
- data/lib/factpulse/models/invoice_line.rb +209 -25
- data/lib/factpulse/models/invoice_line_allowance_amount.rb +2 -2
- data/lib/factpulse/models/invoice_note.rb +1 -1
- data/lib/factpulse/models/invoice_references.rb +119 -16
- data/lib/factpulse/models/invoice_status.rb +1 -1
- data/lib/factpulse/models/invoice_totals.rb +52 -12
- data/lib/factpulse/models/invoice_totals_prepayment.rb +2 -2
- data/lib/factpulse/models/invoice_type_code.rb +1 -1
- data/lib/factpulse/models/invoicing_framework.rb +1 -1
- data/lib/factpulse/models/invoicing_framework_code.rb +1 -1
- data/lib/factpulse/models/line_net_amount.rb +2 -2
- data/lib/factpulse/models/line_total_amount.rb +104 -0
- data/lib/factpulse/models/mandatory_note_schema.rb +1 -1
- data/lib/factpulse/models/manual_rate.rb +2 -2
- data/lib/factpulse/models/manual_vat_rate.rb +2 -2
- data/lib/factpulse/models/missing_field.rb +269 -0
- data/lib/factpulse/models/operation_nature.rb +1 -1
- data/lib/factpulse/models/output_format.rb +1 -1
- data/lib/factpulse/models/page_dimensions_schema.rb +1 -1
- data/lib/factpulse/models/payee.rb +28 -6
- data/lib/factpulse/models/payment_card.rb +159 -0
- data/lib/factpulse/models/payment_means.rb +1 -1
- data/lib/factpulse/models/pdf_validation_result_api.rb +1 -1
- data/lib/factpulse/models/pdp_credentials.rb +6 -6
- data/lib/factpulse/models/percentage.rb +104 -0
- data/lib/factpulse/models/postal_address.rb +27 -7
- data/lib/factpulse/models/price_allowance_amount.rb +104 -0
- data/lib/factpulse/models/price_basis_quantity.rb +104 -0
- data/lib/factpulse/models/processing_options.rb +10 -10
- data/lib/factpulse/models/product_characteristic.rb +193 -0
- data/lib/factpulse/models/product_classification.rb +186 -0
- data/lib/factpulse/models/quantity.rb +2 -2
- data/lib/factpulse/models/recipient.rb +39 -7
- data/lib/factpulse/models/rounding_amount.rb +104 -0
- data/lib/factpulse/models/scheme_id.rb +12 -6
- data/lib/factpulse/models/search_flow_request.rb +8 -8
- data/lib/factpulse/models/search_flow_response.rb +1 -1
- data/lib/factpulse/models/search_services_response.rb +1 -1
- data/lib/factpulse/models/search_structure_request.rb +5 -5
- data/lib/factpulse/models/search_structure_response.rb +1 -1
- data/lib/factpulse/models/signature_info.rb +1 -1
- data/lib/factpulse/models/signature_info_api.rb +1 -1
- data/lib/factpulse/models/signature_parameters.rb +1 -1
- data/lib/factpulse/models/simplified_invoice_data.rb +1 -1
- data/lib/factpulse/models/structure_info.rb +1 -1
- data/lib/factpulse/models/structure_parameters.rb +1 -1
- data/lib/factpulse/models/structure_service.rb +1 -1
- data/lib/factpulse/models/submission_mode.rb +1 -1
- data/lib/factpulse/models/submit_complete_invoice_request.rb +1 -1
- data/lib/factpulse/models/submit_complete_invoice_response.rb +1 -1
- data/lib/factpulse/models/submit_flow_request.rb +7 -7
- data/lib/factpulse/models/submit_flow_response.rb +1 -1
- data/lib/factpulse/models/submit_gross_amount.rb +1 -1
- data/lib/factpulse/models/submit_invoice_request.rb +14 -14
- data/lib/factpulse/models/submit_invoice_response.rb +1 -1
- data/lib/factpulse/models/submit_net_amount.rb +1 -1
- data/lib/factpulse/models/submit_vat_amount.rb +1 -1
- data/lib/factpulse/models/supplementary_attachment.rb +1 -1
- data/lib/factpulse/models/supplier.rb +89 -7
- data/lib/factpulse/models/task_response.rb +1 -1
- data/lib/factpulse/models/tax_representative.rb +220 -0
- data/lib/factpulse/models/taxable_amount.rb +2 -2
- data/lib/factpulse/models/total_gross_amount.rb +2 -2
- data/lib/factpulse/models/total_net_amount.rb +2 -2
- data/lib/factpulse/models/total_vat_amount.rb +2 -2
- data/lib/factpulse/models/unit_net_price.rb +2 -2
- data/lib/factpulse/models/unit_of_measure.rb +1 -1
- data/lib/factpulse/models/validation_error.rb +1 -1
- data/lib/factpulse/models/validation_error_detail.rb +1 -1
- data/lib/factpulse/models/validation_error_loc_inner.rb +1 -1
- data/lib/factpulse/models/validation_error_response.rb +1 -1
- data/lib/factpulse/models/validation_info.rb +255 -0
- data/lib/factpulse/models/validation_success_response.rb +1 -1
- data/lib/factpulse/models/vat_accounting_code.rb +1 -1
- data/lib/factpulse/models/vat_amount.rb +2 -2
- data/lib/factpulse/models/vat_category.rb +1 -1
- data/lib/factpulse/models/vat_line.rb +13 -3
- data/lib/factpulse/models/{document_type.rb → vat_point_date_code.rb} +8 -10
- data/lib/factpulse/models/vat_rate.rb +104 -0
- data/lib/factpulse/models/verification_success_response.rb +1 -1
- data/lib/factpulse/models/verified_field_schema.rb +1 -1
- data/lib/factpulse/version.rb +2 -2
- data/lib/factpulse.rb +34 -3
- metadata +68 -6
|
@@ -39,7 +39,7 @@ end
|
|
|
39
39
|
api_instance = FactPulse::InvoiceProcessingApi.new
|
|
40
40
|
invoice_data = 'invoice_data_example' # String | Invoice data in JSON format. Two formats accepted: 1. **Classic format**: Complete FactureFacturX structure (all fields) 2. **Simplified format** (🆕 P0.1): Minimal structure with auto-enrichment Format is detected automatically!
|
|
41
41
|
opts = {
|
|
42
|
-
profile: FactPulse::
|
|
42
|
+
profile: FactPulse::FacturXProfile::MINIMUM, # FacturXProfile | Factur-X profile: MINIMUM, BASIC, EN16931 or EXTENDED.
|
|
43
43
|
output_format: FactPulse::OutputFormat::XML, # OutputFormat | Output format: 'xml' (XML only) or 'pdf' (Factur-X PDF with embedded XML).
|
|
44
44
|
auto_enrich: true, # Boolean | 🆕 Enable auto-enrichment from SIRET/SIREN (simplified format only)
|
|
45
45
|
source_pdf: File.new('/path/to/some/file') # File |
|
|
@@ -77,7 +77,7 @@ end
|
|
|
77
77
|
| Name | Type | Description | Notes |
|
|
78
78
|
| ---- | ---- | ----------- | ----- |
|
|
79
79
|
| **invoice_data** | **String** | Invoice data in JSON format. Two formats accepted: 1. **Classic format**: Complete FactureFacturX structure (all fields) 2. **Simplified format** (🆕 P0.1): Minimal structure with auto-enrichment Format is detected automatically! | |
|
|
80
|
-
| **profile** | [**
|
|
80
|
+
| **profile** | [**FacturXProfile**](FacturXProfile.md) | Factur-X profile: MINIMUM, BASIC, EN16931 or EXTENDED. | [optional] |
|
|
81
81
|
| **output_format** | [**OutputFormat**](OutputFormat.md) | Output format: 'xml' (XML only) or 'pdf' (Factur-X PDF with embedded XML). | [optional] |
|
|
82
82
|
| **auto_enrich** | **Boolean** | 🆕 Enable auto-enrichment from SIRET/SIREN (simplified format only) | [optional][default to true] |
|
|
83
83
|
| **source_pdf** | **File** | | [optional] |
|
|
@@ -560,7 +560,7 @@ end
|
|
|
560
560
|
api_instance = FactPulse::InvoiceProcessingApi.new
|
|
561
561
|
pdf_file = File.new('/path/to/some/file') # File | Factur-X PDF file to validate (.pdf format).
|
|
562
562
|
opts = {
|
|
563
|
-
profile: FactPulse::
|
|
563
|
+
profile: FactPulse::FacturXProfile::MINIMUM, # FacturXProfile |
|
|
564
564
|
use_verapdf: true # Boolean | Enable strict PDF/A validation with VeraPDF (recommended for production). If False, uses basic metadata validation.
|
|
565
565
|
}
|
|
566
566
|
|
|
@@ -596,7 +596,7 @@ end
|
|
|
596
596
|
| Name | Type | Description | Notes |
|
|
597
597
|
| ---- | ---- | ----------- | ----- |
|
|
598
598
|
| **pdf_file** | **File** | Factur-X PDF file to validate (.pdf format). | |
|
|
599
|
-
| **profile** | [**
|
|
599
|
+
| **profile** | [**FacturXProfile**](FacturXProfile.md) | | [optional] |
|
|
600
600
|
| **use_verapdf** | **Boolean** | Enable strict PDF/A validation with VeraPDF (recommended for production). If False, uses basic metadata validation. | [optional][default to false] |
|
|
601
601
|
|
|
602
602
|
### Return type
|
|
@@ -635,7 +635,7 @@ end
|
|
|
635
635
|
api_instance = FactPulse::InvoiceProcessingApi.new
|
|
636
636
|
pdf_file = File.new('/path/to/some/file') # File | Factur-X PDF file to validate (.pdf format).
|
|
637
637
|
opts = {
|
|
638
|
-
profile: FactPulse::
|
|
638
|
+
profile: FactPulse::FacturXProfile::MINIMUM, # FacturXProfile |
|
|
639
639
|
use_verapdf: true # Boolean | Enable strict PDF/A validation with VeraPDF (recommended for production). May take several seconds.
|
|
640
640
|
}
|
|
641
641
|
|
|
@@ -671,7 +671,7 @@ end
|
|
|
671
671
|
| Name | Type | Description | Notes |
|
|
672
672
|
| ---- | ---- | ----------- | ----- |
|
|
673
673
|
| **pdf_file** | **File** | Factur-X PDF file to validate (.pdf format). | |
|
|
674
|
-
| **profile** | [**
|
|
674
|
+
| **profile** | [**FacturXProfile**](FacturXProfile.md) | | [optional] |
|
|
675
675
|
| **use_verapdf** | **Boolean** | Enable strict PDF/A validation with VeraPDF (recommended for production). May take several seconds. | [optional][default to false] |
|
|
676
676
|
|
|
677
677
|
### Return type
|
|
@@ -779,7 +779,7 @@ end
|
|
|
779
779
|
api_instance = FactPulse::InvoiceProcessingApi.new
|
|
780
780
|
xml_file = File.new('/path/to/some/file') # File | Factur-X XML file to validate (.xml format).
|
|
781
781
|
opts = {
|
|
782
|
-
profile: FactPulse::
|
|
782
|
+
profile: FactPulse::FacturXProfile::MINIMUM # FacturXProfile | Validation profile (MINIMUM, BASIC, EN16931, EXTENDED).
|
|
783
783
|
}
|
|
784
784
|
|
|
785
785
|
begin
|
|
@@ -814,7 +814,7 @@ end
|
|
|
814
814
|
| Name | Type | Description | Notes |
|
|
815
815
|
| ---- | ---- | ----------- | ----- |
|
|
816
816
|
| **xml_file** | **File** | Factur-X XML file to validate (.xml format). | |
|
|
817
|
-
| **profile** | [**
|
|
817
|
+
| **profile** | [**FacturXProfile**](FacturXProfile.md) | Validation profile (MINIMUM, BASIC, EN16931, EXTENDED). | [optional] |
|
|
818
818
|
|
|
819
819
|
### Return type
|
|
820
820
|
|
data/docs/InvoiceReferences.md
CHANGED
|
@@ -4,14 +4,24 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **
|
|
8
|
-
| **
|
|
7
|
+
| **business_process_id** | **String** | | [optional] |
|
|
8
|
+
| **invoice_currency** | **String** | Invoice currency code (BT-5). ISO 4217. | [optional][default to 'EUR'] |
|
|
9
|
+
| **payment_means** | [**PaymentMeans**](PaymentMeans.md) | Payment means type code (BT-81). | |
|
|
10
|
+
| **payment_means_text** | **String** | | [optional] |
|
|
9
11
|
| **invoice_type** | [**InvoiceTypeCode**](InvoiceTypeCode.md) | | |
|
|
10
|
-
| **vat_accounting_code** | [**VATAccountingCode**](VATAccountingCode.md) |
|
|
12
|
+
| **vat_accounting_code** | [**VATAccountingCode**](VATAccountingCode.md) | VAT accounting code. | |
|
|
13
|
+
| **buyer_reference** | **String** | | [optional] |
|
|
11
14
|
| **contract_reference** | **String** | | [optional] |
|
|
12
|
-
| **vat_exemption_reason** | **String** | | [optional] |
|
|
13
15
|
| **purchase_order_reference** | **String** | | [optional] |
|
|
16
|
+
| **seller_order_reference** | **String** | | [optional] |
|
|
17
|
+
| **receiving_advice_reference** | **String** | | [optional] |
|
|
18
|
+
| **despatch_advice_reference** | **String** | | [optional] |
|
|
19
|
+
| **tender_reference** | **String** | | [optional] |
|
|
14
20
|
| **preceding_invoice_reference** | **String** | | [optional] |
|
|
21
|
+
| **preceding_invoice_date** | **String** | | [optional] |
|
|
22
|
+
| **project_reference** | **String** | | [optional] |
|
|
23
|
+
| **project_name** | **String** | | [optional] |
|
|
24
|
+
| **vat_exemption_reason** | **String** | | [optional] |
|
|
15
25
|
|
|
16
26
|
## Example
|
|
17
27
|
|
|
@@ -19,14 +29,24 @@
|
|
|
19
29
|
require 'factpulse'
|
|
20
30
|
|
|
21
31
|
instance = FactPulse::InvoiceReferences.new(
|
|
32
|
+
business_process_id: null,
|
|
22
33
|
invoice_currency: null,
|
|
23
34
|
payment_means: null,
|
|
35
|
+
payment_means_text: null,
|
|
24
36
|
invoice_type: null,
|
|
25
37
|
vat_accounting_code: null,
|
|
38
|
+
buyer_reference: null,
|
|
26
39
|
contract_reference: null,
|
|
27
|
-
vat_exemption_reason: null,
|
|
28
40
|
purchase_order_reference: null,
|
|
29
|
-
|
|
41
|
+
seller_order_reference: null,
|
|
42
|
+
receiving_advice_reference: null,
|
|
43
|
+
despatch_advice_reference: null,
|
|
44
|
+
tender_reference: null,
|
|
45
|
+
preceding_invoice_reference: null,
|
|
46
|
+
preceding_invoice_date: null,
|
|
47
|
+
project_reference: null,
|
|
48
|
+
project_name: null,
|
|
49
|
+
vat_exemption_reason: null
|
|
30
50
|
)
|
|
31
51
|
```
|
|
32
52
|
|
data/docs/InvoiceTotals.md
CHANGED
|
@@ -4,11 +4,15 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **line_total_amount** | [**LineTotalAmount**](LineTotalAmount.md) | | [optional] |
|
|
8
|
+
| **allowance_total_amount** | [**AllowanceTotalAmount**](AllowanceTotalAmount.md) | | [optional] |
|
|
9
|
+
| **charge_total_amount** | [**ChargeTotalAmount**](ChargeTotalAmount.md) | | [optional] |
|
|
7
10
|
| **total_net_amount** | [**TotalNetAmount**](TotalNetAmount.md) | | |
|
|
8
11
|
| **vat_amount** | [**TotalVATAmount**](TotalVATAmount.md) | | |
|
|
9
12
|
| **total_gross_amount** | [**TotalGrossAmount**](TotalGrossAmount.md) | | |
|
|
10
|
-
| **amount_due** | [**AmountDue**](AmountDue.md) | | |
|
|
11
13
|
| **prepayment** | [**InvoiceTotalsPrepayment**](InvoiceTotalsPrepayment.md) | | [optional] |
|
|
14
|
+
| **rounding_amount** | [**RoundingAmount**](RoundingAmount.md) | | [optional] |
|
|
15
|
+
| **amount_due** | [**AmountDue**](AmountDue.md) | | |
|
|
12
16
|
| **global_allowance_amount** | [**GlobalAllowanceAmount**](GlobalAllowanceAmount.md) | | [optional] |
|
|
13
17
|
| **global_allowance_reason** | **String** | | [optional] |
|
|
14
18
|
|
|
@@ -18,11 +22,15 @@
|
|
|
18
22
|
require 'factpulse'
|
|
19
23
|
|
|
20
24
|
instance = FactPulse::InvoiceTotals.new(
|
|
25
|
+
line_total_amount: null,
|
|
26
|
+
allowance_total_amount: null,
|
|
27
|
+
charge_total_amount: null,
|
|
21
28
|
total_net_amount: null,
|
|
22
29
|
vat_amount: null,
|
|
23
30
|
total_gross_amount: null,
|
|
24
|
-
amount_due: null,
|
|
25
31
|
prepayment: null,
|
|
32
|
+
rounding_amount: null,
|
|
33
|
+
amount_due: null,
|
|
26
34
|
global_allowance_amount: null,
|
|
27
35
|
global_allowance_reason: null
|
|
28
36
|
)
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# FactPulse::MissingField
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **field** | **String** | Nom du champ | |
|
|
8
|
+
| **bt_code** | **String** | Code Business Term (BT-XX) | |
|
|
9
|
+
| **description** | **String** | Description du champ | |
|
|
10
|
+
| **required_for** | **Array<String>** | Profils necessitant ce champ | |
|
|
11
|
+
| **suggested_value** | **String** | | [optional] |
|
|
12
|
+
| **confidence** | **Float** | | [optional] |
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```ruby
|
|
17
|
+
require 'factpulse'
|
|
18
|
+
|
|
19
|
+
instance = FactPulse::MissingField.new(
|
|
20
|
+
field: null,
|
|
21
|
+
bt_code: null,
|
|
22
|
+
description: null,
|
|
23
|
+
required_for: null,
|
|
24
|
+
suggested_value: null,
|
|
25
|
+
confidence: null
|
|
26
|
+
)
|
|
27
|
+
```
|
|
28
|
+
|
data/docs/Payee.md
CHANGED
|
@@ -5,11 +5,13 @@
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **nom** | **String** | Payee name (BT-59). Mandatory. | |
|
|
8
|
+
| **payee_id** | **String** | | [optional] |
|
|
8
9
|
| **siret** | **String** | | [optional] |
|
|
9
10
|
| **siren** | **String** | | [optional] |
|
|
10
11
|
| **electronic_address** | [**ElectronicAddress**](ElectronicAddress.md) | | [optional] |
|
|
11
12
|
| **iban** | **String** | | [optional] |
|
|
12
13
|
| **bic** | **String** | | [optional] |
|
|
14
|
+
| **global_ids** | [**Array<ElectronicAddress>**](ElectronicAddress.md) | | [optional] |
|
|
13
15
|
|
|
14
16
|
## Example
|
|
15
17
|
|
|
@@ -18,11 +20,13 @@ require 'factpulse'
|
|
|
18
20
|
|
|
19
21
|
instance = FactPulse::Payee.new(
|
|
20
22
|
nom: null,
|
|
23
|
+
payee_id: null,
|
|
21
24
|
siret: null,
|
|
22
25
|
siren: null,
|
|
23
26
|
electronic_address: null,
|
|
24
27
|
iban: null,
|
|
25
|
-
bic: null
|
|
28
|
+
bic: null,
|
|
29
|
+
global_ids: null
|
|
26
30
|
)
|
|
27
31
|
```
|
|
28
32
|
|
data/docs/PaymentCard.md
ADDED
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# FactPulse::PaymentCard
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **card_id** | **String** | | [optional] |
|
|
8
|
+
| **cardholder_name** | **String** | | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'factpulse'
|
|
14
|
+
|
|
15
|
+
instance = FactPulse::PaymentCard.new(
|
|
16
|
+
card_id: null,
|
|
17
|
+
cardholder_name: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
data/docs/Percentage.md
ADDED
data/docs/PostalAddress.md
CHANGED
|
@@ -7,8 +7,10 @@
|
|
|
7
7
|
| **postal_code** | **String** | | [optional] |
|
|
8
8
|
| **line_one** | **String** | | [optional] |
|
|
9
9
|
| **line_two** | **String** | | [optional] |
|
|
10
|
+
| **line_three** | **String** | | [optional] |
|
|
10
11
|
| **city** | **String** | | [optional] |
|
|
11
12
|
| **country_code** | **String** | | [optional] |
|
|
13
|
+
| **country_subdivision** | **String** | | [optional] |
|
|
12
14
|
|
|
13
15
|
## Example
|
|
14
16
|
|
|
@@ -19,8 +21,10 @@ instance = FactPulse::PostalAddress.new(
|
|
|
19
21
|
postal_code: null,
|
|
20
22
|
line_one: null,
|
|
21
23
|
line_two: null,
|
|
24
|
+
line_three: null,
|
|
22
25
|
city: null,
|
|
23
|
-
country_code: null
|
|
26
|
+
country_code: null,
|
|
27
|
+
country_subdivision: null
|
|
24
28
|
)
|
|
25
29
|
```
|
|
26
30
|
|
data/docs/ProcessingOptions.md
CHANGED
|
@@ -4,9 +4,9 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **facturx_profile** | [**
|
|
7
|
+
| **facturx_profile** | [**FacturXProfile**](FacturXProfile.md) | Factur-X profile to use | [optional] |
|
|
8
8
|
| **auto_enrich** | **Boolean** | Auto-enrich data (Company APIs, Chorus Pro, etc.) | [optional][default to true] |
|
|
9
|
-
| **
|
|
9
|
+
| **validate_xml** | **Boolean** | Validate Factur-X XML with Schematron | [optional][default to true] |
|
|
10
10
|
| **verify_destination_parameters** | **Boolean** | Verify required parameters for destination (e.g., service_code for Chorus) | [optional][default to true] |
|
|
11
11
|
|
|
12
12
|
## Example
|
|
@@ -17,7 +17,7 @@ require 'factpulse'
|
|
|
17
17
|
instance = FactPulse::ProcessingOptions.new(
|
|
18
18
|
facturx_profile: null,
|
|
19
19
|
auto_enrich: null,
|
|
20
|
-
|
|
20
|
+
validate_xml: null,
|
|
21
21
|
verify_destination_parameters: null
|
|
22
22
|
)
|
|
23
23
|
```
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# FactPulse::ProductCharacteristic
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **name** | **String** | Attribute name (BT-160). | |
|
|
8
|
+
| **value** | **String** | Attribute value (BT-161). | |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'factpulse'
|
|
14
|
+
|
|
15
|
+
instance = FactPulse::ProductCharacteristic.new(
|
|
16
|
+
name: null,
|
|
17
|
+
value: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# FactPulse::ProductClassification
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **class_code** | **String** | Classification code (BT-158). | |
|
|
8
|
+
| **list_id** | **String** | | [optional] |
|
|
9
|
+
| **list_version_id** | **String** | | [optional] |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'factpulse'
|
|
15
|
+
|
|
16
|
+
instance = FactPulse::ProductClassification.new(
|
|
17
|
+
class_code: null,
|
|
18
|
+
list_id: null,
|
|
19
|
+
list_version_id: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
data/docs/Recipient.md
CHANGED
|
@@ -9,7 +9,10 @@
|
|
|
9
9
|
| **name** | **String** | | [optional] |
|
|
10
10
|
| **siren** | **String** | | [optional] |
|
|
11
11
|
| **siret** | **String** | | [optional] |
|
|
12
|
+
| **vat_number** | **String** | | [optional] |
|
|
12
13
|
| **postal_address** | [**PostalAddress**](PostalAddress.md) | | [optional] |
|
|
14
|
+
| **contact** | [**Contact**](Contact.md) | | [optional] |
|
|
15
|
+
| **global_ids** | [**Array<ElectronicAddress>**](ElectronicAddress.md) | | [optional] |
|
|
13
16
|
|
|
14
17
|
## Example
|
|
15
18
|
|
|
@@ -22,7 +25,10 @@ instance = FactPulse::Recipient.new(
|
|
|
22
25
|
name: null,
|
|
23
26
|
siren: null,
|
|
24
27
|
siret: null,
|
|
25
|
-
|
|
28
|
+
vat_number: null,
|
|
29
|
+
postal_address: null,
|
|
30
|
+
contact: null,
|
|
31
|
+
global_ids: null
|
|
26
32
|
)
|
|
27
33
|
```
|
|
28
34
|
|
data/docs/Supplier.md
CHANGED
|
@@ -6,14 +6,22 @@
|
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **electronic_address** | [**ElectronicAddress**](ElectronicAddress.md) | | |
|
|
8
8
|
| **supplier_id** | **Integer** | | |
|
|
9
|
+
| **private_id** | **String** | | [optional] |
|
|
9
10
|
| **supplier_bank_account_code** | **Integer** | | [optional] |
|
|
10
11
|
| **supplier_service_id** | **Integer** | | [optional] |
|
|
11
12
|
| **name** | **String** | | [optional] |
|
|
13
|
+
| **trading_business_name** | **String** | | [optional] |
|
|
14
|
+
| **legal_description** | **String** | | [optional] |
|
|
12
15
|
| **siren** | **String** | | [optional] |
|
|
13
16
|
| **siret** | **String** | | [optional] |
|
|
14
17
|
| **vat_number** | **String** | | [optional] |
|
|
15
18
|
| **iban** | **String** | | [optional] |
|
|
19
|
+
| **bic** | **String** | | [optional] |
|
|
20
|
+
| **bank_account_name** | **String** | | [optional] |
|
|
21
|
+
| **proprietary_id** | **String** | | [optional] |
|
|
16
22
|
| **postal_address** | [**PostalAddress**](PostalAddress.md) | | [optional] |
|
|
23
|
+
| **contact** | [**Contact**](Contact.md) | | [optional] |
|
|
24
|
+
| **global_ids** | [**Array<ElectronicAddress>**](ElectronicAddress.md) | | [optional] |
|
|
17
25
|
|
|
18
26
|
## Example
|
|
19
27
|
|
|
@@ -23,14 +31,22 @@ require 'factpulse'
|
|
|
23
31
|
instance = FactPulse::Supplier.new(
|
|
24
32
|
electronic_address: null,
|
|
25
33
|
supplier_id: null,
|
|
34
|
+
private_id: null,
|
|
26
35
|
supplier_bank_account_code: null,
|
|
27
36
|
supplier_service_id: null,
|
|
28
37
|
name: null,
|
|
38
|
+
trading_business_name: null,
|
|
39
|
+
legal_description: null,
|
|
29
40
|
siren: null,
|
|
30
41
|
siret: null,
|
|
31
42
|
vat_number: null,
|
|
32
43
|
iban: null,
|
|
33
|
-
|
|
44
|
+
bic: null,
|
|
45
|
+
bank_account_name: null,
|
|
46
|
+
proprietary_id: null,
|
|
47
|
+
postal_address: null,
|
|
48
|
+
contact: null,
|
|
49
|
+
global_ids: null
|
|
34
50
|
)
|
|
35
51
|
```
|
|
36
52
|
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# FactPulse::TaxRepresentative
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **name** | **String** | Tax representative name (BT-62). | |
|
|
8
|
+
| **vat_number** | **String** | Tax representative VAT identifier (BT-63). | |
|
|
9
|
+
| **postal_address** | [**PostalAddress**](PostalAddress.md) | Tax representative postal address (BG-12). | |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'factpulse'
|
|
15
|
+
|
|
16
|
+
instance = FactPulse::TaxRepresentative.new(
|
|
17
|
+
name: null,
|
|
18
|
+
vat_number: null,
|
|
19
|
+
postal_address: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
data/docs/VATLine.md
CHANGED
|
@@ -9,6 +9,7 @@
|
|
|
9
9
|
| **rate** | **String** | | [optional] |
|
|
10
10
|
| **manual_rate** | [**ManualRate**](ManualRate.md) | | [optional] |
|
|
11
11
|
| **category** | [**VATCategory**](VATCategory.md) | | [optional] |
|
|
12
|
+
| **due_date_type_code** | [**VATPointDateCode**](VATPointDateCode.md) | | [optional] |
|
|
12
13
|
| **exemption_reason** | **String** | | [optional] |
|
|
13
14
|
| **vatex_code** | **String** | | [optional] |
|
|
14
15
|
|
|
@@ -23,6 +24,7 @@ instance = FactPulse::VATLine.new(
|
|
|
23
24
|
rate: null,
|
|
24
25
|
manual_rate: null,
|
|
25
26
|
category: null,
|
|
27
|
+
due_date_type_code: null,
|
|
26
28
|
exemption_reason: null,
|
|
27
29
|
vatex_code: null
|
|
28
30
|
)
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# FactPulse::ValidationInfo
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **profile** | **String** | Profil Factur-X utilise | |
|
|
8
|
+
| **schematron_rules_passed** | **Integer** | Regles passees | |
|
|
9
|
+
| **schematron_rules_total** | **Integer** | Total regles | |
|
|
10
|
+
| **pdfa_compliant** | **Boolean** | PDF/A-3 conforme | [optional][default to true] |
|
|
11
|
+
| **xml_embedded** | **Boolean** | XML embarque dans PDF | [optional][default to true] |
|
|
12
|
+
| **errors** | [**Array<ValidationError>**](ValidationError.md) | | [optional] |
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```ruby
|
|
17
|
+
require 'factpulse'
|
|
18
|
+
|
|
19
|
+
instance = FactPulse::ValidationInfo.new(
|
|
20
|
+
profile: null,
|
|
21
|
+
schematron_rules_passed: null,
|
|
22
|
+
schematron_rules_total: null,
|
|
23
|
+
pdfa_compliant: null,
|
|
24
|
+
xml_embedded: null,
|
|
25
|
+
errors: null
|
|
26
|
+
)
|
|
27
|
+
```
|
|
28
|
+
|
data/docs/VatRate.md
ADDED
data/factpulse.gemspec
CHANGED