factpulse 4.3.0 → 4.5.0
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 +11 -5
- data/Gemfile.lock +15 -13
- data/README.md +7 -1
- data/docs/AFNORContainsOrStartWithOperator.md +15 -0
- data/docs/AFNORContainsOrStrictOrStartWithOperator.md +15 -0
- data/docs/AFNORDirectoryLinePayloadLegalUnitFacilityRoutingCode.md +4 -0
- data/docs/AFNORDirectoryLinePayloadStatusLegalUnitFacilityRoutingCode.md +2 -0
- data/docs/AFNORDirectoryLineSearchPost200Response.md +1 -1
- data/docs/AFNORFacilityPayloadIncluded.md +2 -0
- data/docs/AFNORFlow.md +2 -2
- data/docs/AFNORLegalUnitPayloadIncluded.md +3 -1
- data/docs/AFNORPDPPAFlowServiceApi.md +3 -133
- data/docs/AFNORRoutingCodeSearch.md +2 -2
- data/docs/AFNORRoutingCodeSearchPost200Response.md +1 -1
- data/docs/AFNORSearchDirectoryLine.md +4 -2
- data/docs/AFNORSearchDirectoryLineSortingInner.md +2 -2
- data/docs/AFNORSearchFlowContent.md +3 -1
- data/docs/AFNORSearchFlowParams.md +3 -1
- data/docs/AFNORSearchSiren.md +1 -1
- data/docs/AFNORSearchSirenFiltersBusinessName.md +1 -1
- data/docs/AFNORSearchSirenSortingInner.md +2 -2
- data/docs/AFNORSearchSiret.md +1 -1
- data/docs/AFNORSearchSiretFiltersAddressLines.md +1 -1
- data/docs/AFNORSearchSiretFiltersLocality.md +1 -1
- data/docs/AFNORSearchSiretFiltersName.md +1 -1
- data/docs/AFNORSearchSiretSortingInner.md +2 -2
- data/docs/AFNORSirenSearchPost200Response.md +1 -1
- data/docs/AFNORSiretSearchPost200Response.md +1 -1
- data/docs/AFNORUniqueDirectoryLineStatus.md +15 -0
- data/docs/AFNORWebhook.md +12 -4
- data/docs/AFNORWebhookIdParam.md +5 -1
- data/docs/AFNORWebhookParams.md +8 -4
- data/docs/AllowanceCharge.md +1 -1
- data/docs/{AFNORAlgorithm.md → Amount3.md} +2 -2
- data/docs/{AFNORContainsOperator.md → Amounteur.md} +2 -2
- data/docs/ClientManagementApi.md +383 -0
- data/docs/CreateCDARRequest.md +7 -1
- data/docs/DeliveryParty.md +2 -2
- data/docs/ElectronicAddressInput.md +20 -0
- data/docs/ElectronicAddressOutput.md +20 -0
- data/docs/ElectronicSignatureApi.md +6 -6
- data/docs/EncaisseAmountByRate.md +20 -0
- data/docs/EncaisseeRequest.md +8 -2
- data/docs/FacturXConversionApi.md +2 -2
- data/docs/FacturXPDFXMLVerificationApi.md +4 -4
- data/docs/FacturXValidationApi.md +4 -4
- data/docs/FactureElectroniqueModelsInvoiceTypeCode.md +15 -0
- data/docs/{ChorusProCredentials.md → FactureElectroniqueRestApiSchemasChorusProChorusProCredentials.md} +2 -2
- data/docs/{ValidationErrorResponse.md → FactureElectroniqueRestApiSchemasValidationValidationErrorResponse.md} +2 -2
- data/docs/Flux10EReportingApi.md +22 -12
- data/docs/Flux6InvoiceLifecycleCDARApi.md +45 -21
- data/docs/GetChorusProIdRequest.md +1 -1
- data/docs/GetInvoiceRequest.md +1 -1
- data/docs/GetStructureRequest.md +1 -1
- data/docs/IncomingSupplier.md +4 -2
- data/docs/InvoiceGenerationApi.md +16 -10
- data/docs/InvoiceInput.md +4 -0
- data/docs/{AFNORCallbackAuthentication.md → Invoicedata.md} +9 -9
- data/docs/LifecycleEvent.md +2 -0
- data/docs/LifecycleResponse.md +9 -1
- data/docs/ParseApi.md +4 -4
- data/docs/Payee.md +2 -2
- data/docs/PaymentAmountByRate.md +4 -2
- data/docs/PostalAddressInput.md +30 -0
- data/docs/PostalAddressOutput.md +30 -0
- data/docs/ProcessingOptions.md +1 -1
- data/docs/Recipient.md +3 -3
- data/docs/ReportSender.md +2 -0
- data/docs/SearchStructureRequest.md +1 -1
- data/docs/SimplifiedInvoiceData.md +3 -3
- data/docs/SubmitCDARRequest.md +6 -0
- data/docs/SubmitCompleteInvoiceRequest.md +1 -1
- data/docs/SubmitInvoiceRequest.md +1 -1
- data/docs/SuperPDPConnectURLResponse.md +18 -0
- data/docs/SuperPDPDisconnectResponse.md +20 -0
- data/docs/SuperPDPStatusResponse.md +26 -0
- data/docs/SuperPDPVatRegimeResponse.md +20 -0
- data/docs/SuperPDPVatRegimeUpdateRequest.md +20 -0
- data/docs/Supplier.md +5 -3
- data/docs/TaxBreakdownInput.md +7 -1
- data/docs/TaxRepresentative.md +1 -1
- data/docs/Taxamounteur.md +15 -0
- data/docs/ValidateCDARRequest.md +3 -1
- data/docs/ValidationApi.md +3 -3
- data/docs/ValidationError.md +5 -1
- 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 +7 -133
- data/lib/factpulse/api/async_tasks_api.rb +1 -1
- data/lib/factpulse/api/chorus_pro_api.rb +1 -1
- data/lib/factpulse/api/client_management_api.rb +333 -1
- data/lib/factpulse/api/downloads_api.rb +1 -1
- data/lib/factpulse/api/electronic_signature_api.rb +7 -7
- data/lib/factpulse/api/factur_x_conversion_api.rb +3 -3
- data/lib/factpulse/api/factur_x_validation_api.rb +5 -5
- data/lib/factpulse/api/factur_xpdfxml_verification_api.rb +5 -5
- data/lib/factpulse/api/flux10_e_reporting_api.rb +14 -5
- data/lib/factpulse/api/flux6_invoice_lifecycle_cdar_api.rb +33 -5
- data/lib/factpulse/api/health_api.rb +1 -1
- data/lib/factpulse/api/invoice_generation_api.rb +11 -5
- data/lib/factpulse/api/parse_api.rb +5 -5
- data/lib/factpulse/api/references_api.rb +1 -1
- data/lib/factpulse/api/validation_api.rb +5 -5
- 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/helpers/client.rb +42 -5
- data/lib/factpulse/models/acknowledgment_status.rb +1 -1
- data/lib/factpulse/models/action_code_info.rb +1 -1
- data/lib/factpulse/models/action_codes_response.rb +1 -1
- data/lib/factpulse/models/additional_document.rb +1 -1
- data/lib/factpulse/models/afnor_acknowledgement.rb +1 -1
- data/lib/factpulse/models/afnor_acknowledgement_detail.rb +1 -1
- data/lib/factpulse/models/afnor_address_read.rb +1 -1
- data/lib/factpulse/models/{afnor_contains_operator.rb → afnor_contains_or_start_with_operator.rb} +6 -5
- data/lib/factpulse/models/afnor_contains_or_strict_operator.rb +1 -1
- data/lib/factpulse/models/{afnor_algorithm.rb → afnor_contains_or_strict_or_start_with_operator.rb} +8 -11
- data/lib/factpulse/models/afnor_core_flow_info.rb +6 -6
- data/lib/factpulse/models/afnor_credentials.rb +1 -1
- data/lib/factpulse/models/afnor_destination.rb +1 -1
- data/lib/factpulse/models/afnor_directory_line_field.rb +1 -1
- data/lib/factpulse/models/afnor_directory_line_payload_history_legal_unit_facility_routing_code_routing_code.rb +1 -1
- data/lib/factpulse/models/afnor_directory_line_payload_legal_unit_facility_routing_code.rb +51 -2
- data/lib/factpulse/models/afnor_directory_line_payload_status_legal_unit_facility_routing_code.rb +42 -2
- data/lib/factpulse/models/afnor_directory_line_search_post200_response.rb +4 -2
- data/lib/factpulse/models/afnor_directory_line_status.rb +1 -1
- data/lib/factpulse/models/afnor_entity_type.rb +1 -1
- data/lib/factpulse/models/afnor_error.rb +1 -1
- data/lib/factpulse/models/afnor_error_detail.rb +1 -1
- data/lib/factpulse/models/afnor_facility_administrative_status.rb +1 -1
- data/lib/factpulse/models/afnor_facility_payload_history.rb +1 -1
- data/lib/factpulse/models/afnor_facility_payload_history_ule_b2g_additional_data.rb +1 -1
- data/lib/factpulse/models/afnor_facility_payload_included.rb +11 -2
- data/lib/factpulse/models/afnor_facility_type.rb +1 -1
- data/lib/factpulse/models/afnor_flow.rb +45 -11
- data/lib/factpulse/models/afnor_flow_ack_status.rb +1 -1
- data/lib/factpulse/models/afnor_flow_direction.rb +1 -1
- data/lib/factpulse/models/afnor_flow_extension.rb +1 -1
- data/lib/factpulse/models/afnor_flow_info.rb +6 -6
- data/lib/factpulse/models/afnor_flow_info_extension.rb +1 -1
- data/lib/factpulse/models/afnor_flow_profile.rb +3 -2
- data/lib/factpulse/models/afnor_flow_syntax.rb +1 -1
- data/lib/factpulse/models/afnor_flow_type.rb +9 -3
- data/lib/factpulse/models/afnor_full_flow_info.rb +11 -11
- data/lib/factpulse/models/afnor_full_flow_info_extension.rb +7 -7
- data/lib/factpulse/models/afnor_health_check_response.rb +1 -1
- data/lib/factpulse/models/afnor_legal_unit_administrative_status.rb +1 -1
- data/lib/factpulse/models/afnor_legal_unit_payload_history.rb +1 -1
- data/lib/factpulse/models/afnor_legal_unit_payload_included.rb +14 -5
- data/lib/factpulse/models/afnor_processing_rule.rb +3 -2
- data/lib/factpulse/models/afnor_reason_code.rb +1 -1
- data/lib/factpulse/models/afnor_reason_code_enum.rb +1 -1
- data/lib/factpulse/models/afnor_recipient_platform_type.rb +1 -1
- data/lib/factpulse/models/afnor_result.rb +1 -1
- data/lib/factpulse/models/afnor_routing_code_administrative_status.rb +1 -1
- data/lib/factpulse/models/afnor_routing_code_field.rb +1 -1
- data/lib/factpulse/models/afnor_routing_code_payload_history_legal_unit_facility.rb +1 -1
- data/lib/factpulse/models/afnor_routing_code_search.rb +1 -1
- data/lib/factpulse/models/afnor_routing_code_search_filters.rb +1 -1
- data/lib/factpulse/models/afnor_routing_code_search_filters_administrative_status.rb +1 -1
- data/lib/factpulse/models/afnor_routing_code_search_filters_routing_code_name.rb +1 -1
- data/lib/factpulse/models/afnor_routing_code_search_filters_routing_identifier.rb +1 -1
- data/lib/factpulse/models/afnor_routing_code_search_post200_response.rb +4 -2
- data/lib/factpulse/models/afnor_routing_code_search_sorting_inner.rb +1 -1
- data/lib/factpulse/models/afnor_search_directory_line.rb +35 -2
- data/lib/factpulse/models/afnor_search_directory_line_filters.rb +1 -1
- data/lib/factpulse/models/afnor_search_directory_line_filters_addressing_identifier.rb +1 -1
- data/lib/factpulse/models/afnor_search_directory_line_filters_addressing_suffix.rb +1 -1
- data/lib/factpulse/models/afnor_search_directory_line_sorting_inner.rb +8 -8
- data/lib/factpulse/models/afnor_search_flow_content.rb +34 -2
- data/lib/factpulse/models/afnor_search_flow_filters.rb +6 -6
- data/lib/factpulse/models/afnor_search_flow_params.rb +13 -3
- data/lib/factpulse/models/afnor_search_siren.rb +1 -1
- data/lib/factpulse/models/afnor_search_siren_filters.rb +1 -1
- data/lib/factpulse/models/afnor_search_siren_filters_administrative_status.rb +1 -1
- data/lib/factpulse/models/afnor_search_siren_filters_business_name.rb +2 -2
- data/lib/factpulse/models/afnor_search_siren_filters_entity_type.rb +1 -1
- data/lib/factpulse/models/afnor_search_siren_filters_siren.rb +1 -1
- data/lib/factpulse/models/afnor_search_siren_sorting_inner.rb +8 -8
- data/lib/factpulse/models/afnor_search_siret.rb +1 -1
- data/lib/factpulse/models/afnor_search_siret_filters.rb +1 -1
- data/lib/factpulse/models/afnor_search_siret_filters_address_lines.rb +2 -2
- data/lib/factpulse/models/afnor_search_siret_filters_administrative_status.rb +1 -1
- data/lib/factpulse/models/afnor_search_siret_filters_country_subdivision.rb +1 -1
- data/lib/factpulse/models/afnor_search_siret_filters_facility_type.rb +1 -1
- data/lib/factpulse/models/afnor_search_siret_filters_locality.rb +2 -2
- data/lib/factpulse/models/afnor_search_siret_filters_name.rb +2 -2
- data/lib/factpulse/models/afnor_search_siret_filters_postal_code.rb +1 -1
- data/lib/factpulse/models/afnor_search_siret_filters_siret.rb +1 -1
- data/lib/factpulse/models/afnor_search_siret_sorting_inner.rb +8 -8
- data/lib/factpulse/models/afnor_siren_field.rb +1 -1
- data/lib/factpulse/models/afnor_siren_instructions.rb +1 -1
- data/lib/factpulse/models/afnor_siren_search_post200_response.rb +4 -2
- data/lib/factpulse/models/afnor_siret_field.rb +1 -1
- data/lib/factpulse/models/afnor_siret_instructions.rb +1 -1
- data/lib/factpulse/models/afnor_siret_search_post200_response.rb +4 -2
- data/lib/factpulse/models/afnor_sorting_order.rb +1 -1
- data/lib/factpulse/models/afnor_strict_operator.rb +1 -1
- data/lib/factpulse/models/afnor_strict_or_start_with_operator.rb +1 -1
- data/lib/factpulse/models/afnor_unique_directory_line_status.rb +40 -0
- data/lib/factpulse/models/afnor_webhook.rb +83 -40
- data/lib/factpulse/models/afnor_webhook_id_param.rb +23 -5
- data/lib/factpulse/models/afnor_webhook_params.rb +65 -40
- data/lib/factpulse/models/aggregated_payment_input.rb +1 -1
- data/lib/factpulse/models/aggregated_transaction_input.rb +1 -1
- data/lib/factpulse/models/allowance_charge.rb +2 -2
- data/lib/factpulse/models/allowance_charge_reason_code.rb +1 -1
- data/lib/factpulse/models/allowance_reason_code.rb +1 -1
- data/lib/factpulse/models/allowance_total_amount.rb +1 -1
- data/lib/factpulse/models/amount.rb +2 -2
- data/lib/factpulse/models/amount1.rb +2 -2
- data/lib/factpulse/models/amount2.rb +2 -2
- data/lib/factpulse/models/amount3.rb +104 -0
- data/lib/factpulse/models/amount_due.rb +1 -1
- data/lib/factpulse/models/amounteur.rb +104 -0
- data/lib/factpulse/models/api_error.rb +1 -1
- data/lib/factpulse/models/api_profile.rb +1 -1
- data/lib/factpulse/models/async_task_status.rb +1 -1
- data/lib/factpulse/models/base_amount.rb +1 -1
- data/lib/factpulse/models/bounding_box_schema.rb +1 -1
- data/lib/factpulse/models/buyercountry.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 +1 -1
- data/lib/factpulse/models/chorus_pro_destination.rb +1 -1
- data/lib/factpulse/models/chorus_pro_result.rb +1 -1
- data/lib/factpulse/models/client_activate_response.rb +1 -1
- data/lib/factpulse/models/client_create_request.rb +1 -1
- data/lib/factpulse/models/client_detail.rb +1 -1
- data/lib/factpulse/models/client_list_response.rb +1 -1
- data/lib/factpulse/models/client_summary.rb +1 -1
- data/lib/factpulse/models/client_update_request.rb +1 -1
- data/lib/factpulse/models/contact.rb +1 -1
- data/lib/factpulse/models/conversion_error_result.rb +1 -1
- data/lib/factpulse/models/conversion_extraction_info.rb +1 -1
- data/lib/factpulse/models/conversion_pending_input_result.rb +1 -1
- data/lib/factpulse/models/conversion_success_task_result.rb +1 -1
- data/lib/factpulse/models/conversion_task_status.rb +1 -1
- data/lib/factpulse/models/conversion_task_status_result.rb +1 -1
- data/lib/factpulse/models/conversion_validation_failed_result.rb +1 -1
- data/lib/factpulse/models/convert_resume_request.rb +1 -1
- data/lib/factpulse/models/convert_success_response.rb +1 -1
- data/lib/factpulse/models/convert_validation_failed_response.rb +1 -1
- data/lib/factpulse/models/country_code.rb +1 -1
- data/lib/factpulse/models/create_aggregated_report_request.rb +1 -1
- data/lib/factpulse/models/create_cdar_request.rb +70 -6
- data/lib/factpulse/models/create_e_reporting_request.rb +1 -1
- data/lib/factpulse/models/currency.rb +1 -1
- data/lib/factpulse/models/currency_code.rb +1 -1
- data/lib/factpulse/models/delivery_party.rb +3 -3
- data/lib/factpulse/models/destination.rb +1 -1
- data/lib/factpulse/models/doc_type.rb +1 -1
- data/lib/factpulse/models/document_type_info.rb +1 -1
- data/lib/factpulse/models/e_reporting_flow_type.rb +1 -1
- data/lib/factpulse/models/e_reporting_validation_error.rb +1 -1
- data/lib/factpulse/models/electronic_address.rb +2 -2
- data/lib/factpulse/models/{afnor_callback_signature.rb → electronic_address_input.rb} +29 -44
- data/lib/factpulse/models/{afnor_callback_parameters.rb → electronic_address_output.rb} +51 -46
- data/lib/factpulse/models/{afnor_basic_authentication.rb → encaisse_amount_by_rate.rb} +37 -35
- data/lib/factpulse/models/encaisseamount.rb +2 -2
- data/lib/factpulse/models/encaisseamount1.rb +1 -1
- data/lib/factpulse/models/encaissee_request.rb +54 -23
- 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 +1 -1
- data/lib/factpulse/models/factur_x_invoice.rb +1 -1
- data/lib/factpulse/models/factur_xpdf_info.rb +1 -1
- data/lib/factpulse/models/facture_electronique_models_invoice_type_code.rb +54 -0
- data/lib/factpulse/models/facture_electronique_rest_api_schemas_cdar_validation_error_response.rb +1 -1
- data/lib/factpulse/models/{chorus_pro_credentials.rb → facture_electronique_rest_api_schemas_chorus_pro_chorus_pro_credentials.rb} +4 -4
- data/lib/factpulse/models/facture_electronique_rest_api_schemas_ereporting_invoice_type_code.rb +1 -1
- data/lib/factpulse/models/facture_electronique_rest_api_schemas_processing_chorus_pro_credentials.rb +1 -1
- data/lib/factpulse/models/{validation_error_response.rb → facture_electronique_rest_api_schemas_validation_validation_error_response.rb} +4 -4
- data/lib/factpulse/models/field_status.rb +1 -1
- data/lib/factpulse/models/file_info.rb +1 -1
- data/lib/factpulse/models/files_info.rb +1 -1
- data/lib/factpulse/models/flow_direction.rb +1 -1
- data/lib/factpulse/models/flow_profile.rb +3 -2
- 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 +9 -3
- data/lib/factpulse/models/generate_aggregated_report_response.rb +1 -1
- data/lib/factpulse/models/generate_cdar_response.rb +1 -1
- data/lib/factpulse/models/generate_certificate_request.rb +1 -1
- data/lib/factpulse/models/generate_certificate_response.rb +1 -1
- data/lib/factpulse/models/generate_e_reporting_response.rb +1 -1
- data/lib/factpulse/models/generation_success_result.rb +1 -1
- data/lib/factpulse/models/generation_task_status.rb +1 -1
- data/lib/factpulse/models/generation_task_status_result.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 +2 -2
- data/lib/factpulse/models/get_structure_response.rb +1 -1
- data/lib/factpulse/models/global_allowance_amount.rb +1 -1
- data/lib/factpulse/models/gross_unit_price.rb +1 -1
- data/lib/factpulse/models/http_validation_error.rb +1 -1
- data/lib/factpulse/models/incoming_invoice.rb +1 -1
- data/lib/factpulse/models/incoming_supplier.rb +14 -4
- data/lib/factpulse/models/invoice_format.rb +1 -1
- data/lib/factpulse/models/invoice_input.rb +22 -2
- data/lib/factpulse/models/invoice_lifecycle.rb +1 -1
- data/lib/factpulse/models/invoice_line.rb +1 -1
- data/lib/factpulse/models/invoice_line_allowance_amount.rb +1 -1
- data/lib/factpulse/models/invoice_note.rb +1 -1
- data/lib/factpulse/models/invoice_payment_input.rb +1 -1
- data/lib/factpulse/models/invoice_references.rb +1 -1
- data/lib/factpulse/models/invoice_status.rb +1 -1
- data/lib/factpulse/models/invoice_totals.rb +1 -1
- data/lib/factpulse/models/invoice_totals_prepayment.rb +1 -1
- data/lib/factpulse/models/invoice_type_code.rb +1 -1
- data/lib/factpulse/models/invoice_type_code_output.rb +1 -1
- data/lib/factpulse/models/{afnor_callback_authentication.rb → invoicedata.rb} +5 -5
- data/lib/factpulse/models/invoicing_framework.rb +1 -1
- data/lib/factpulse/models/invoicing_framework_code.rb +1 -1
- data/lib/factpulse/models/issuer_role_code.rb +1 -1
- data/lib/factpulse/models/key_rotation_request.rb +1 -1
- data/lib/factpulse/models/key_rotation_response.rb +1 -1
- data/lib/factpulse/models/lifecycle_event.rb +12 -2
- data/lib/factpulse/models/lifecycle_response.rb +49 -5
- data/lib/factpulse/models/line_net_amount.rb +1 -1
- data/lib/factpulse/models/line_sub_type.rb +1 -1
- data/lib/factpulse/models/line_total_amount.rb +1 -1
- data/lib/factpulse/models/location_inner.rb +1 -1
- data/lib/factpulse/models/mandatory_note_schema.rb +1 -1
- data/lib/factpulse/models/manual_rate.rb +1 -1
- data/lib/factpulse/models/manual_vat_rate.rb +1 -1
- data/lib/factpulse/models/missing_field.rb +1 -1
- 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/parse_factur_x_response.rb +1 -1
- data/lib/factpulse/models/payee.rb +3 -3
- data/lib/factpulse/models/payment_amount_by_rate.rb +15 -5
- data/lib/factpulse/models/payment_card.rb +1 -1
- data/lib/factpulse/models/payment_means.rb +3 -2
- data/lib/factpulse/models/pdf_validation_result_api.rb +1 -1
- data/lib/factpulse/models/pdp_config_response.rb +1 -1
- data/lib/factpulse/models/pdp_config_update_request.rb +1 -1
- data/lib/factpulse/models/pdp_credentials.rb +1 -1
- data/lib/factpulse/models/percentage.rb +1 -1
- data/lib/factpulse/models/postal_address.rb +7 -7
- data/lib/factpulse/models/postal_address_input.rb +209 -0
- data/lib/factpulse/models/postal_address_output.rb +209 -0
- data/lib/factpulse/models/price_allowance_amount.rb +1 -1
- data/lib/factpulse/models/price_basis_quantity.rb +1 -1
- data/lib/factpulse/models/processing_options.rb +2 -2
- data/lib/factpulse/models/processing_rule.rb +3 -2
- data/lib/factpulse/models/product_characteristic.rb +1 -1
- data/lib/factpulse/models/product_classification.rb +1 -1
- data/lib/factpulse/models/quantity.rb +1 -1
- data/lib/factpulse/models/rate.rb +1 -1
- data/lib/factpulse/models/rate1.rb +1 -1
- data/lib/factpulse/models/reason_code_info.rb +1 -1
- data/lib/factpulse/models/reason_codes_response.rb +1 -1
- data/lib/factpulse/models/recipient.rb +4 -4
- data/lib/factpulse/models/recipient_input.rb +1 -1
- data/lib/factpulse/models/refusee_request.rb +1 -1
- data/lib/factpulse/models/report_issuer.rb +1 -1
- data/lib/factpulse/models/report_period.rb +1 -1
- data/lib/factpulse/models/report_sender.rb +12 -2
- data/lib/factpulse/models/rounding_amount.rb +1 -1
- data/lib/factpulse/models/schematron_validation_error.rb +1 -1
- data/lib/factpulse/models/scheme_id.rb +1 -1
- data/lib/factpulse/models/search_flow_request.rb +1 -1
- 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 +2 -2
- data/lib/factpulse/models/search_structure_response.rb +1 -1
- data/lib/factpulse/models/secret_status.rb +1 -1
- data/lib/factpulse/models/sellercountry.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/signature_success_result.rb +1 -1
- data/lib/factpulse/models/signature_task_status.rb +1 -1
- data/lib/factpulse/models/signature_task_status_result.rb +1 -1
- data/lib/factpulse/models/simplified_cdar_response.rb +1 -1
- data/lib/factpulse/models/simplified_invoice_data.rb +5 -5
- data/lib/factpulse/models/status_code_info.rb +1 -1
- data/lib/factpulse/models/status_codes_response.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_aggregated_report_request.rb +1 -1
- data/lib/factpulse/models/submit_cdar_request.rb +66 -2
- data/lib/factpulse/models/submit_cdar_response.rb +1 -1
- data/lib/factpulse/models/submit_cdarxml_request.rb +1 -1
- data/lib/factpulse/models/submit_complete_invoice_request.rb +2 -3
- data/lib/factpulse/models/submit_complete_invoice_response.rb +1 -1
- data/lib/factpulse/models/submit_e_reporting_request.rb +1 -1
- data/lib/factpulse/models/submit_e_reporting_response.rb +1 -1
- data/lib/factpulse/models/submit_flow_request.rb +1 -1
- 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 +2 -2
- 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/{afnor_webhook_patch_payload.rb → super_pdp_connect_url_response.rb} +30 -31
- data/lib/factpulse/models/{afnor_callback_header.rb → super_pdp_disconnect_response.rb} +38 -35
- data/lib/factpulse/models/super_pdp_status_response.rb +208 -0
- data/lib/factpulse/models/super_pdp_vat_regime_response.rb +195 -0
- data/lib/factpulse/models/{afnor_webhook_metadata.rb → super_pdp_vat_regime_update_request.rb} +33 -63
- data/lib/factpulse/models/supplementary_attachment.rb +1 -1
- data/lib/factpulse/models/supplier.rb +15 -5
- data/lib/factpulse/models/task_error_result.rb +1 -1
- data/lib/factpulse/models/task_response.rb +1 -1
- data/lib/factpulse/models/tax_breakdown_input.rb +35 -5
- data/lib/factpulse/models/tax_due_date_type.rb +1 -1
- data/lib/factpulse/models/tax_representative.rb +2 -2
- data/lib/factpulse/models/taxable_amount.rb +1 -1
- data/lib/factpulse/models/taxableamount.rb +1 -1
- data/lib/factpulse/models/taxamount.rb +1 -1
- data/lib/factpulse/models/taxamount1.rb +1 -1
- data/lib/factpulse/models/taxamount2.rb +1 -1
- data/lib/factpulse/models/taxamounteur.rb +104 -0
- data/lib/factpulse/models/taxexclusiveamount.rb +1 -1
- data/lib/factpulse/models/taxexclusiveamount1.rb +1 -1
- data/lib/factpulse/models/total_gross_amount.rb +1 -1
- data/lib/factpulse/models/total_net_amount.rb +1 -1
- data/lib/factpulse/models/total_vat_amount.rb +1 -1
- data/lib/factpulse/models/transaction_category.rb +1 -1
- data/lib/factpulse/models/transmission_type_code.rb +1 -1
- data/lib/factpulse/models/unit_net_price.rb +1 -1
- data/lib/factpulse/models/unit_of_measure.rb +1 -1
- data/lib/factpulse/models/validate_cdar_request.rb +18 -6
- data/lib/factpulse/models/validate_cdar_response.rb +1 -1
- data/lib/factpulse/models/validate_e_reporting_request.rb +1 -1
- data/lib/factpulse/models/validate_e_reporting_response.rb +1 -1
- data/lib/factpulse/models/validation_error.rb +24 -5
- data/lib/factpulse/models/validation_error_detail.rb +1 -1
- data/lib/factpulse/models/validation_info.rb +1 -1
- data/lib/factpulse/models/validation_success_response.rb +1 -1
- data/lib/factpulse/models/validation_success_task_result.rb +1 -1
- data/lib/factpulse/models/validation_task_status.rb +1 -1
- data/lib/factpulse/models/validation_task_status_result.rb +1 -1
- data/lib/factpulse/models/vat_accounting_code.rb +1 -1
- data/lib/factpulse/models/vat_amount.rb +1 -1
- data/lib/factpulse/models/vat_category.rb +1 -1
- data/lib/factpulse/models/vat_line.rb +1 -1
- data/lib/factpulse/models/vat_point_date_code.rb +1 -1
- data/lib/factpulse/models/vat_rate.rb +1 -1
- data/lib/factpulse/models/vatex_code_info.rb +1 -1
- data/lib/factpulse/models/vatex_codes_response.rb +1 -1
- data/lib/factpulse/models/verification_success_response.rb +1 -1
- data/lib/factpulse/models/verification_success_task_result.rb +1 -1
- data/lib/factpulse/models/verification_typed_task_status.rb +1 -1
- data/lib/factpulse/models/verification_typed_task_status_result.rb +1 -1
- data/lib/factpulse/models/verified_field_schema.rb +1 -1
- data/lib/factpulse/models/webhook_secret_delete_response.rb +1 -1
- data/lib/factpulse/models/webhook_secret_generate_response.rb +1 -1
- data/lib/factpulse/models/webhook_secret_status_response.rb +1 -1
- data/lib/factpulse/version.rb +2 -2
- data/lib/factpulse.rb +21 -13
- metadata +42 -26
- data/docs/AFNORBasicAuthentication.md +0 -20
- data/docs/AFNORCallbackHeader.md +0 -20
- data/docs/AFNORCallbackParameters.md +0 -24
- data/docs/AFNORCallbackSignature.md +0 -20
- data/docs/AFNOROAuth2Authentication.md +0 -22
- data/docs/AFNORWebhookMetadata.md +0 -24
- data/docs/AFNORWebhookPatchPayload.md +0 -22
- data/lib/factpulse/models/afnoro_auth2_authentication.rb +0 -216
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
The version of the OpenAPI document: 1.0.0
|
|
7
7
|
Contact: contact@factpulse.fr
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
|
-
Generator version: 7.21.0
|
|
9
|
+
Generator version: 7.21.0
|
|
10
10
|
|
|
11
11
|
=end
|
|
12
12
|
|
|
@@ -276,6 +276,69 @@ module FactPulse
|
|
|
276
276
|
return data, status_code, headers
|
|
277
277
|
end
|
|
278
278
|
|
|
279
|
+
# Disconnect SuperPDP
|
|
280
|
+
# Disconnect SuperPDP for a client. **Scope**: Client level (JWT with client_uid that must match {uid}) Revokes the stored refresh token with SuperPDP (RFC 7009) and deletes the stored tokens. The client can reconnect later via the connect-url endpoint.
|
|
281
|
+
# @param uid [String] Client unique identifier (UUID)
|
|
282
|
+
# @param [Hash] opts the optional parameters
|
|
283
|
+
# @return [SuperPDPDisconnectResponse]
|
|
284
|
+
def disconnect_superpdp_api_v1_clients_uid_superpdp_delete(uid, opts = {})
|
|
285
|
+
data, _status_code, _headers = disconnect_superpdp_api_v1_clients_uid_superpdp_delete_with_http_info(uid, opts)
|
|
286
|
+
data
|
|
287
|
+
end
|
|
288
|
+
|
|
289
|
+
# Disconnect SuperPDP
|
|
290
|
+
# Disconnect SuperPDP for a client. **Scope**: Client level (JWT with client_uid that must match {uid}) Revokes the stored refresh token with SuperPDP (RFC 7009) and deletes the stored tokens. The client can reconnect later via the connect-url endpoint.
|
|
291
|
+
# @param uid [String] Client unique identifier (UUID)
|
|
292
|
+
# @param [Hash] opts the optional parameters
|
|
293
|
+
# @return [Array<(SuperPDPDisconnectResponse, Integer, Hash)>] SuperPDPDisconnectResponse data, response status code and response headers
|
|
294
|
+
def disconnect_superpdp_api_v1_clients_uid_superpdp_delete_with_http_info(uid, opts = {})
|
|
295
|
+
if @api_client.config.debugging
|
|
296
|
+
@api_client.config.logger.debug 'Calling API: ClientManagementApi.disconnect_superpdp_api_v1_clients_uid_superpdp_delete ...'
|
|
297
|
+
end
|
|
298
|
+
# verify the required parameter 'uid' is set
|
|
299
|
+
if @api_client.config.client_side_validation && uid.nil?
|
|
300
|
+
fail ArgumentError, "Missing the required parameter 'uid' when calling ClientManagementApi.disconnect_superpdp_api_v1_clients_uid_superpdp_delete"
|
|
301
|
+
end
|
|
302
|
+
# resource path
|
|
303
|
+
local_var_path = '/api/v1/clients/{uid}/superpdp'.sub('{' + 'uid' + '}', CGI.escape(uid.to_s))
|
|
304
|
+
|
|
305
|
+
# query parameters
|
|
306
|
+
query_params = opts[:query_params] || {}
|
|
307
|
+
|
|
308
|
+
# header parameters
|
|
309
|
+
header_params = opts[:header_params] || {}
|
|
310
|
+
# HTTP header 'Accept' (if needed)
|
|
311
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
312
|
+
|
|
313
|
+
# form parameters
|
|
314
|
+
form_params = opts[:form_params] || {}
|
|
315
|
+
|
|
316
|
+
# http body (model)
|
|
317
|
+
post_body = opts[:debug_body]
|
|
318
|
+
|
|
319
|
+
# return_type
|
|
320
|
+
return_type = opts[:debug_return_type] || 'SuperPDPDisconnectResponse'
|
|
321
|
+
|
|
322
|
+
# auth_names
|
|
323
|
+
auth_names = opts[:debug_auth_names] || ['APIKeyHeader', 'HTTPBearer']
|
|
324
|
+
|
|
325
|
+
new_options = opts.merge(
|
|
326
|
+
:operation => :"ClientManagementApi.disconnect_superpdp_api_v1_clients_uid_superpdp_delete",
|
|
327
|
+
:header_params => header_params,
|
|
328
|
+
:query_params => query_params,
|
|
329
|
+
:form_params => form_params,
|
|
330
|
+
:body => post_body,
|
|
331
|
+
:auth_names => auth_names,
|
|
332
|
+
:return_type => return_type
|
|
333
|
+
)
|
|
334
|
+
|
|
335
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
|
336
|
+
if @api_client.config.debugging
|
|
337
|
+
@api_client.config.logger.debug "API called: ClientManagementApi#disconnect_superpdp_api_v1_clients_uid_superpdp_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
338
|
+
end
|
|
339
|
+
return data, status_code, headers
|
|
340
|
+
end
|
|
341
|
+
|
|
279
342
|
# Generate webhook secret
|
|
280
343
|
# Generate or regenerate the webhook secret for a client. **Scope**: Client level (JWT with client_uid that must match {uid}) **Important**: Save the returned secret immediately - it will never be shown again. The secret is used to sign webhooks sent by the server (HMAC-SHA256). **If a secret already exists**: It will be replaced by the new one.
|
|
281
344
|
# @param uid [String] Client unique identifier (UUID)
|
|
@@ -465,6 +528,201 @@ module FactPulse
|
|
|
465
528
|
return data, status_code, headers
|
|
466
529
|
end
|
|
467
530
|
|
|
531
|
+
# Get SuperPDP connection URL
|
|
532
|
+
# Generate the SuperPDP OAuth2 authorization URL for a client. **Scope**: Client level (JWT with client_uid that must match {uid}) Redirect the end user to the returned `authorizeUrl` so they can connect their own SuperPDP account to FactPulse (OAuth2 Authorization Code). **Query parameters**: - `modeSandbox` (default `true`): connect via the SuperPDP sandbox app (fictitious data) or the production app. - `returnUrl` (optional): absolute http(s) URL of your own portal. Once the SuperPDP authorization flow is over, the end user is redirected there with `superpdp_connected=true|false` (and `superpdp_error=<code>` on failure) appended to the query string. Without it, FactPulse displays its own confirmation page. Returns `400 invalid_return_url` if the URL is not an absolute http(s) URL.
|
|
533
|
+
# @param uid [String] Client unique identifier (UUID)
|
|
534
|
+
# @param [Hash] opts the optional parameters
|
|
535
|
+
# @option opts [Boolean] :mode_sandbox True for the SuperPDP sandbox app (default), False for production (default to true)
|
|
536
|
+
# @option opts [String] :return_url Absolute http(s) URL to redirect the end user to once the SuperPDP connection is done. Defaults to the FactPulse confirmation page.
|
|
537
|
+
# @return [SuperPDPConnectURLResponse]
|
|
538
|
+
def get_superpdp_connect_url_api_v1_clients_uid_superpdp_connect_url_post(uid, opts = {})
|
|
539
|
+
data, _status_code, _headers = get_superpdp_connect_url_api_v1_clients_uid_superpdp_connect_url_post_with_http_info(uid, opts)
|
|
540
|
+
data
|
|
541
|
+
end
|
|
542
|
+
|
|
543
|
+
# Get SuperPDP connection URL
|
|
544
|
+
# Generate the SuperPDP OAuth2 authorization URL for a client. **Scope**: Client level (JWT with client_uid that must match {uid}) Redirect the end user to the returned `authorizeUrl` so they can connect their own SuperPDP account to FactPulse (OAuth2 Authorization Code). **Query parameters**: - `modeSandbox` (default `true`): connect via the SuperPDP sandbox app (fictitious data) or the production app. - `returnUrl` (optional): absolute http(s) URL of your own portal. Once the SuperPDP authorization flow is over, the end user is redirected there with `superpdp_connected=true|false` (and `superpdp_error=<code>` on failure) appended to the query string. Without it, FactPulse displays its own confirmation page. Returns `400 invalid_return_url` if the URL is not an absolute http(s) URL.
|
|
545
|
+
# @param uid [String] Client unique identifier (UUID)
|
|
546
|
+
# @param [Hash] opts the optional parameters
|
|
547
|
+
# @option opts [Boolean] :mode_sandbox True for the SuperPDP sandbox app (default), False for production (default to true)
|
|
548
|
+
# @option opts [String] :return_url Absolute http(s) URL to redirect the end user to once the SuperPDP connection is done. Defaults to the FactPulse confirmation page.
|
|
549
|
+
# @return [Array<(SuperPDPConnectURLResponse, Integer, Hash)>] SuperPDPConnectURLResponse data, response status code and response headers
|
|
550
|
+
def get_superpdp_connect_url_api_v1_clients_uid_superpdp_connect_url_post_with_http_info(uid, opts = {})
|
|
551
|
+
if @api_client.config.debugging
|
|
552
|
+
@api_client.config.logger.debug 'Calling API: ClientManagementApi.get_superpdp_connect_url_api_v1_clients_uid_superpdp_connect_url_post ...'
|
|
553
|
+
end
|
|
554
|
+
# verify the required parameter 'uid' is set
|
|
555
|
+
if @api_client.config.client_side_validation && uid.nil?
|
|
556
|
+
fail ArgumentError, "Missing the required parameter 'uid' when calling ClientManagementApi.get_superpdp_connect_url_api_v1_clients_uid_superpdp_connect_url_post"
|
|
557
|
+
end
|
|
558
|
+
# resource path
|
|
559
|
+
local_var_path = '/api/v1/clients/{uid}/superpdp/connect-url'.sub('{' + 'uid' + '}', CGI.escape(uid.to_s))
|
|
560
|
+
|
|
561
|
+
# query parameters
|
|
562
|
+
query_params = opts[:query_params] || {}
|
|
563
|
+
query_params[:'modeSandbox'] = opts[:'mode_sandbox'] if !opts[:'mode_sandbox'].nil?
|
|
564
|
+
query_params[:'returnUrl'] = opts[:'return_url'] if !opts[:'return_url'].nil?
|
|
565
|
+
|
|
566
|
+
# header parameters
|
|
567
|
+
header_params = opts[:header_params] || {}
|
|
568
|
+
# HTTP header 'Accept' (if needed)
|
|
569
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
570
|
+
|
|
571
|
+
# form parameters
|
|
572
|
+
form_params = opts[:form_params] || {}
|
|
573
|
+
|
|
574
|
+
# http body (model)
|
|
575
|
+
post_body = opts[:debug_body]
|
|
576
|
+
|
|
577
|
+
# return_type
|
|
578
|
+
return_type = opts[:debug_return_type] || 'SuperPDPConnectURLResponse'
|
|
579
|
+
|
|
580
|
+
# auth_names
|
|
581
|
+
auth_names = opts[:debug_auth_names] || ['APIKeyHeader', 'HTTPBearer']
|
|
582
|
+
|
|
583
|
+
new_options = opts.merge(
|
|
584
|
+
:operation => :"ClientManagementApi.get_superpdp_connect_url_api_v1_clients_uid_superpdp_connect_url_post",
|
|
585
|
+
:header_params => header_params,
|
|
586
|
+
:query_params => query_params,
|
|
587
|
+
:form_params => form_params,
|
|
588
|
+
:body => post_body,
|
|
589
|
+
:auth_names => auth_names,
|
|
590
|
+
:return_type => return_type
|
|
591
|
+
)
|
|
592
|
+
|
|
593
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
594
|
+
if @api_client.config.debugging
|
|
595
|
+
@api_client.config.logger.debug "API called: ClientManagementApi#get_superpdp_connect_url_api_v1_clients_uid_superpdp_connect_url_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
596
|
+
end
|
|
597
|
+
return data, status_code, headers
|
|
598
|
+
end
|
|
599
|
+
|
|
600
|
+
# Get SuperPDP connection status
|
|
601
|
+
# Check whether a client has connected its SuperPDP account. **Scope**: Client level (JWT with client_uid that must match {uid}) **Response**: - `connected`: Whether the client has an active SuperPDP connection - `connectedAt`: When the connection was established (if any) - `expiresAt`: When the current access token expires (if any) - `modeSandbox`: True if connected via the sandbox app, False for production, null if not connected - `lastError`: Last token refresh error, if any
|
|
602
|
+
# @param uid [String] Client unique identifier (UUID)
|
|
603
|
+
# @param [Hash] opts the optional parameters
|
|
604
|
+
# @return [SuperPDPStatusResponse]
|
|
605
|
+
def get_superpdp_status_api_v1_clients_uid_superpdp_status_get(uid, opts = {})
|
|
606
|
+
data, _status_code, _headers = get_superpdp_status_api_v1_clients_uid_superpdp_status_get_with_http_info(uid, opts)
|
|
607
|
+
data
|
|
608
|
+
end
|
|
609
|
+
|
|
610
|
+
# Get SuperPDP connection status
|
|
611
|
+
# Check whether a client has connected its SuperPDP account. **Scope**: Client level (JWT with client_uid that must match {uid}) **Response**: - `connected`: Whether the client has an active SuperPDP connection - `connectedAt`: When the connection was established (if any) - `expiresAt`: When the current access token expires (if any) - `modeSandbox`: True if connected via the sandbox app, False for production, null if not connected - `lastError`: Last token refresh error, if any
|
|
612
|
+
# @param uid [String] Client unique identifier (UUID)
|
|
613
|
+
# @param [Hash] opts the optional parameters
|
|
614
|
+
# @return [Array<(SuperPDPStatusResponse, Integer, Hash)>] SuperPDPStatusResponse data, response status code and response headers
|
|
615
|
+
def get_superpdp_status_api_v1_clients_uid_superpdp_status_get_with_http_info(uid, opts = {})
|
|
616
|
+
if @api_client.config.debugging
|
|
617
|
+
@api_client.config.logger.debug 'Calling API: ClientManagementApi.get_superpdp_status_api_v1_clients_uid_superpdp_status_get ...'
|
|
618
|
+
end
|
|
619
|
+
# verify the required parameter 'uid' is set
|
|
620
|
+
if @api_client.config.client_side_validation && uid.nil?
|
|
621
|
+
fail ArgumentError, "Missing the required parameter 'uid' when calling ClientManagementApi.get_superpdp_status_api_v1_clients_uid_superpdp_status_get"
|
|
622
|
+
end
|
|
623
|
+
# resource path
|
|
624
|
+
local_var_path = '/api/v1/clients/{uid}/superpdp/status'.sub('{' + 'uid' + '}', CGI.escape(uid.to_s))
|
|
625
|
+
|
|
626
|
+
# query parameters
|
|
627
|
+
query_params = opts[:query_params] || {}
|
|
628
|
+
|
|
629
|
+
# header parameters
|
|
630
|
+
header_params = opts[:header_params] || {}
|
|
631
|
+
# HTTP header 'Accept' (if needed)
|
|
632
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
633
|
+
|
|
634
|
+
# form parameters
|
|
635
|
+
form_params = opts[:form_params] || {}
|
|
636
|
+
|
|
637
|
+
# http body (model)
|
|
638
|
+
post_body = opts[:debug_body]
|
|
639
|
+
|
|
640
|
+
# return_type
|
|
641
|
+
return_type = opts[:debug_return_type] || 'SuperPDPStatusResponse'
|
|
642
|
+
|
|
643
|
+
# auth_names
|
|
644
|
+
auth_names = opts[:debug_auth_names] || ['APIKeyHeader', 'HTTPBearer']
|
|
645
|
+
|
|
646
|
+
new_options = opts.merge(
|
|
647
|
+
:operation => :"ClientManagementApi.get_superpdp_status_api_v1_clients_uid_superpdp_status_get",
|
|
648
|
+
:header_params => header_params,
|
|
649
|
+
:query_params => query_params,
|
|
650
|
+
:form_params => form_params,
|
|
651
|
+
:body => post_body,
|
|
652
|
+
:auth_names => auth_names,
|
|
653
|
+
:return_type => return_type
|
|
654
|
+
)
|
|
655
|
+
|
|
656
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
657
|
+
if @api_client.config.debugging
|
|
658
|
+
@api_client.config.logger.debug "API called: ClientManagementApi#get_superpdp_status_api_v1_clients_uid_superpdp_status_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
659
|
+
end
|
|
660
|
+
return data, status_code, headers
|
|
661
|
+
end
|
|
662
|
+
|
|
663
|
+
# Get the SuperPDP VAT regime
|
|
664
|
+
# Read the VAT regime of the client's company at SuperPDP (`vatRegime` is null when not set). SuperPDP refuses e-reporting (\"The VAT regime needs to be setup at the company level\") until the VAT regime of the company is set: it defines the e-reporting transmission periods, and the Flux 10 file does not carry it. This setting is not part of the AFNOR API; FactPulse sets it with the client's SuperPDP connection. **Scope**: Client level (JWT with client_uid that must match {uid}) **Errors**: - `404 not_connected`: the client has not connected its SuperPDP account - `400 superpdp_error`: SuperPDP refused the request (`superpdp_status`, `message`) - `502`: SuperPDP unreachable, or the SuperPDP connection must be redone
|
|
665
|
+
# @param uid [String] Client unique identifier (UUID)
|
|
666
|
+
# @param [Hash] opts the optional parameters
|
|
667
|
+
# @return [SuperPDPVatRegimeResponse]
|
|
668
|
+
def get_superpdp_vat_regime_api_v1_clients_uid_superpdp_vat_regime_get(uid, opts = {})
|
|
669
|
+
data, _status_code, _headers = get_superpdp_vat_regime_api_v1_clients_uid_superpdp_vat_regime_get_with_http_info(uid, opts)
|
|
670
|
+
data
|
|
671
|
+
end
|
|
672
|
+
|
|
673
|
+
# Get the SuperPDP VAT regime
|
|
674
|
+
# Read the VAT regime of the client's company at SuperPDP (`vatRegime` is null when not set). SuperPDP refuses e-reporting (\"The VAT regime needs to be setup at the company level\") until the VAT regime of the company is set: it defines the e-reporting transmission periods, and the Flux 10 file does not carry it. This setting is not part of the AFNOR API; FactPulse sets it with the client's SuperPDP connection. **Scope**: Client level (JWT with client_uid that must match {uid}) **Errors**: - `404 not_connected`: the client has not connected its SuperPDP account - `400 superpdp_error`: SuperPDP refused the request (`superpdp_status`, `message`) - `502`: SuperPDP unreachable, or the SuperPDP connection must be redone
|
|
675
|
+
# @param uid [String] Client unique identifier (UUID)
|
|
676
|
+
# @param [Hash] opts the optional parameters
|
|
677
|
+
# @return [Array<(SuperPDPVatRegimeResponse, Integer, Hash)>] SuperPDPVatRegimeResponse data, response status code and response headers
|
|
678
|
+
def get_superpdp_vat_regime_api_v1_clients_uid_superpdp_vat_regime_get_with_http_info(uid, opts = {})
|
|
679
|
+
if @api_client.config.debugging
|
|
680
|
+
@api_client.config.logger.debug 'Calling API: ClientManagementApi.get_superpdp_vat_regime_api_v1_clients_uid_superpdp_vat_regime_get ...'
|
|
681
|
+
end
|
|
682
|
+
# verify the required parameter 'uid' is set
|
|
683
|
+
if @api_client.config.client_side_validation && uid.nil?
|
|
684
|
+
fail ArgumentError, "Missing the required parameter 'uid' when calling ClientManagementApi.get_superpdp_vat_regime_api_v1_clients_uid_superpdp_vat_regime_get"
|
|
685
|
+
end
|
|
686
|
+
# resource path
|
|
687
|
+
local_var_path = '/api/v1/clients/{uid}/superpdp/vat-regime'.sub('{' + 'uid' + '}', CGI.escape(uid.to_s))
|
|
688
|
+
|
|
689
|
+
# query parameters
|
|
690
|
+
query_params = opts[:query_params] || {}
|
|
691
|
+
|
|
692
|
+
# header parameters
|
|
693
|
+
header_params = opts[:header_params] || {}
|
|
694
|
+
# HTTP header 'Accept' (if needed)
|
|
695
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
696
|
+
|
|
697
|
+
# form parameters
|
|
698
|
+
form_params = opts[:form_params] || {}
|
|
699
|
+
|
|
700
|
+
# http body (model)
|
|
701
|
+
post_body = opts[:debug_body]
|
|
702
|
+
|
|
703
|
+
# return_type
|
|
704
|
+
return_type = opts[:debug_return_type] || 'SuperPDPVatRegimeResponse'
|
|
705
|
+
|
|
706
|
+
# auth_names
|
|
707
|
+
auth_names = opts[:debug_auth_names] || ['APIKeyHeader', 'HTTPBearer']
|
|
708
|
+
|
|
709
|
+
new_options = opts.merge(
|
|
710
|
+
:operation => :"ClientManagementApi.get_superpdp_vat_regime_api_v1_clients_uid_superpdp_vat_regime_get",
|
|
711
|
+
:header_params => header_params,
|
|
712
|
+
:query_params => query_params,
|
|
713
|
+
:form_params => form_params,
|
|
714
|
+
:body => post_body,
|
|
715
|
+
:auth_names => auth_names,
|
|
716
|
+
:return_type => return_type
|
|
717
|
+
)
|
|
718
|
+
|
|
719
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
720
|
+
if @api_client.config.debugging
|
|
721
|
+
@api_client.config.logger.debug "API called: ClientManagementApi#get_superpdp_vat_regime_api_v1_clients_uid_superpdp_vat_regime_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
722
|
+
end
|
|
723
|
+
return data, status_code, headers
|
|
724
|
+
end
|
|
725
|
+
|
|
468
726
|
# Get webhook secret status
|
|
469
727
|
# Check if a webhook secret is configured for a client. **Scope**: Client level (JWT with client_uid that must match {uid}) **Response**: - `hasSecret`: Whether a webhook secret is configured - `createdAt`: When the secret was created (if exists) **Note**: The secret value is never returned, only its status.
|
|
470
728
|
# @param uid [String] Client unique identifier (UUID)
|
|
@@ -827,5 +1085,79 @@ module FactPulse
|
|
|
827
1085
|
end
|
|
828
1086
|
return data, status_code, headers
|
|
829
1087
|
end
|
|
1088
|
+
|
|
1089
|
+
# Set the SuperPDP VAT regime
|
|
1090
|
+
# Set the VAT regime of the client's company at SuperPDP. When `hasVatOnDebits` is omitted, its current value is kept. SuperPDP refuses e-reporting (\"The VAT regime needs to be setup at the company level\") until the VAT regime of the company is set: it defines the e-reporting transmission periods, and the Flux 10 file does not carry it. This setting is not part of the AFNOR API; FactPulse sets it with the client's SuperPDP connection. **Scope**: Client level (JWT with client_uid that must match {uid}) **Errors**: - `404 not_connected`: the client has not connected its SuperPDP account - `400 superpdp_error`: SuperPDP refused the request (`superpdp_status`, `message`) - `502`: SuperPDP unreachable, or the SuperPDP connection must be redone
|
|
1091
|
+
# @param uid [String] Client unique identifier (UUID)
|
|
1092
|
+
# @param super_pdp_vat_regime_update_request [SuperPDPVatRegimeUpdateRequest]
|
|
1093
|
+
# @param [Hash] opts the optional parameters
|
|
1094
|
+
# @return [SuperPDPVatRegimeResponse]
|
|
1095
|
+
def update_superpdp_vat_regime_api_v1_clients_uid_superpdp_vat_regime_patch(uid, super_pdp_vat_regime_update_request, opts = {})
|
|
1096
|
+
data, _status_code, _headers = update_superpdp_vat_regime_api_v1_clients_uid_superpdp_vat_regime_patch_with_http_info(uid, super_pdp_vat_regime_update_request, opts)
|
|
1097
|
+
data
|
|
1098
|
+
end
|
|
1099
|
+
|
|
1100
|
+
# Set the SuperPDP VAT regime
|
|
1101
|
+
# Set the VAT regime of the client's company at SuperPDP. When `hasVatOnDebits` is omitted, its current value is kept. SuperPDP refuses e-reporting (\"The VAT regime needs to be setup at the company level\") until the VAT regime of the company is set: it defines the e-reporting transmission periods, and the Flux 10 file does not carry it. This setting is not part of the AFNOR API; FactPulse sets it with the client's SuperPDP connection. **Scope**: Client level (JWT with client_uid that must match {uid}) **Errors**: - `404 not_connected`: the client has not connected its SuperPDP account - `400 superpdp_error`: SuperPDP refused the request (`superpdp_status`, `message`) - `502`: SuperPDP unreachable, or the SuperPDP connection must be redone
|
|
1102
|
+
# @param uid [String] Client unique identifier (UUID)
|
|
1103
|
+
# @param super_pdp_vat_regime_update_request [SuperPDPVatRegimeUpdateRequest]
|
|
1104
|
+
# @param [Hash] opts the optional parameters
|
|
1105
|
+
# @return [Array<(SuperPDPVatRegimeResponse, Integer, Hash)>] SuperPDPVatRegimeResponse data, response status code and response headers
|
|
1106
|
+
def update_superpdp_vat_regime_api_v1_clients_uid_superpdp_vat_regime_patch_with_http_info(uid, super_pdp_vat_regime_update_request, opts = {})
|
|
1107
|
+
if @api_client.config.debugging
|
|
1108
|
+
@api_client.config.logger.debug 'Calling API: ClientManagementApi.update_superpdp_vat_regime_api_v1_clients_uid_superpdp_vat_regime_patch ...'
|
|
1109
|
+
end
|
|
1110
|
+
# verify the required parameter 'uid' is set
|
|
1111
|
+
if @api_client.config.client_side_validation && uid.nil?
|
|
1112
|
+
fail ArgumentError, "Missing the required parameter 'uid' when calling ClientManagementApi.update_superpdp_vat_regime_api_v1_clients_uid_superpdp_vat_regime_patch"
|
|
1113
|
+
end
|
|
1114
|
+
# verify the required parameter 'super_pdp_vat_regime_update_request' is set
|
|
1115
|
+
if @api_client.config.client_side_validation && super_pdp_vat_regime_update_request.nil?
|
|
1116
|
+
fail ArgumentError, "Missing the required parameter 'super_pdp_vat_regime_update_request' when calling ClientManagementApi.update_superpdp_vat_regime_api_v1_clients_uid_superpdp_vat_regime_patch"
|
|
1117
|
+
end
|
|
1118
|
+
# resource path
|
|
1119
|
+
local_var_path = '/api/v1/clients/{uid}/superpdp/vat-regime'.sub('{' + 'uid' + '}', CGI.escape(uid.to_s))
|
|
1120
|
+
|
|
1121
|
+
# query parameters
|
|
1122
|
+
query_params = opts[:query_params] || {}
|
|
1123
|
+
|
|
1124
|
+
# header parameters
|
|
1125
|
+
header_params = opts[:header_params] || {}
|
|
1126
|
+
# HTTP header 'Accept' (if needed)
|
|
1127
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
1128
|
+
# HTTP header 'Content-Type'
|
|
1129
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
1130
|
+
if !content_type.nil?
|
|
1131
|
+
header_params['Content-Type'] = content_type
|
|
1132
|
+
end
|
|
1133
|
+
|
|
1134
|
+
# form parameters
|
|
1135
|
+
form_params = opts[:form_params] || {}
|
|
1136
|
+
|
|
1137
|
+
# http body (model)
|
|
1138
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(super_pdp_vat_regime_update_request)
|
|
1139
|
+
|
|
1140
|
+
# return_type
|
|
1141
|
+
return_type = opts[:debug_return_type] || 'SuperPDPVatRegimeResponse'
|
|
1142
|
+
|
|
1143
|
+
# auth_names
|
|
1144
|
+
auth_names = opts[:debug_auth_names] || ['APIKeyHeader', 'HTTPBearer']
|
|
1145
|
+
|
|
1146
|
+
new_options = opts.merge(
|
|
1147
|
+
:operation => :"ClientManagementApi.update_superpdp_vat_regime_api_v1_clients_uid_superpdp_vat_regime_patch",
|
|
1148
|
+
:header_params => header_params,
|
|
1149
|
+
:query_params => query_params,
|
|
1150
|
+
:form_params => form_params,
|
|
1151
|
+
:body => post_body,
|
|
1152
|
+
:auth_names => auth_names,
|
|
1153
|
+
:return_type => return_type
|
|
1154
|
+
)
|
|
1155
|
+
|
|
1156
|
+
data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
|
|
1157
|
+
if @api_client.config.debugging
|
|
1158
|
+
@api_client.config.logger.debug "API called: ClientManagementApi#update_superpdp_vat_regime_api_v1_clients_uid_superpdp_vat_regime_patch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1159
|
+
end
|
|
1160
|
+
return data, status_code, headers
|
|
1161
|
+
end
|
|
830
1162
|
end
|
|
831
1163
|
end
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
The version of the OpenAPI document: 1.0.0
|
|
7
7
|
Contact: contact@factpulse.fr
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
|
-
Generator version: 7.21.0
|
|
9
|
+
Generator version: 7.21.0
|
|
10
10
|
|
|
11
11
|
=end
|
|
12
12
|
|
|
@@ -89,7 +89,7 @@ module FactPulse
|
|
|
89
89
|
|
|
90
90
|
# Sign a PDF with client's certificate (PAdES-B-LT)
|
|
91
91
|
# Signs an uploaded PDF with the electronic certificate configured for the client (via client_uid from JWT). **Supported standards**: PAdES-B-B, PAdES-B-T (timestamping), PAdES-B-LT (long-term archiving). **eIDAS levels**: SES (self-signed), AdES (commercial CA), QES (PSCO - out of scope). **Security**: Double authentication X-Internal-Secret + JWT Bearer to retrieve the certificate. **⚠️ Legal disclaimer**: Generated signatures are electronic seals as defined by the eIDAS regulation. The level of legal validity depends on the certificate used (SES/AdES/QES). FactPulse does not provide QES qualified certificates - you must obtain a certificate from a PSCO (qualified Trust Service Provider) for maximum legal validity.
|
|
92
|
-
# @param pdf_file [
|
|
92
|
+
# @param pdf_file [String] PDF file to sign (will be processed and returned signed in base64)
|
|
93
93
|
# @param [Hash] opts the optional parameters
|
|
94
94
|
# @option opts [String] :reason
|
|
95
95
|
# @option opts [String] :location
|
|
@@ -105,7 +105,7 @@ module FactPulse
|
|
|
105
105
|
|
|
106
106
|
# Sign a PDF with client's certificate (PAdES-B-LT)
|
|
107
107
|
# Signs an uploaded PDF with the electronic certificate configured for the client (via client_uid from JWT). **Supported standards**: PAdES-B-B, PAdES-B-T (timestamping), PAdES-B-LT (long-term archiving). **eIDAS levels**: SES (self-signed), AdES (commercial CA), QES (PSCO - out of scope). **Security**: Double authentication X-Internal-Secret + JWT Bearer to retrieve the certificate. **⚠️ Legal disclaimer**: Generated signatures are electronic seals as defined by the eIDAS regulation. The level of legal validity depends on the certificate used (SES/AdES/QES). FactPulse does not provide QES qualified certificates - you must obtain a certificate from a PSCO (qualified Trust Service Provider) for maximum legal validity.
|
|
108
|
-
# @param pdf_file [
|
|
108
|
+
# @param pdf_file [String] PDF file to sign (will be processed and returned signed in base64)
|
|
109
109
|
# @param [Hash] opts the optional parameters
|
|
110
110
|
# @option opts [String] :reason
|
|
111
111
|
# @option opts [String] :location
|
|
@@ -176,7 +176,7 @@ module FactPulse
|
|
|
176
176
|
|
|
177
177
|
# Sign a PDF asynchronously (Celery)
|
|
178
178
|
# Signs an uploaded PDF asynchronously via a Celery task. **Difference with /sign-pdf**: - `/sign-pdf`: Synchronous signature (blocking until completion) - `/sign-pdf-async`: Asynchronous signature (returns immediately with task_id) **Async advantages**: - No timeout for large files - No blocking of FastAPI worker - Progress tracking via task_id - Ideal for batch processing **Supported standards**: PAdES-B-B, PAdES-B-T (timestamping), PAdES-B-LT (long-term archiving). **⚠️ Legal disclaimer**: Same as /sign-pdf (see that endpoint's documentation).
|
|
179
|
-
# @param pdf_file [
|
|
179
|
+
# @param pdf_file [String] PDF file to sign (processed asynchronously)
|
|
180
180
|
# @param [Hash] opts the optional parameters
|
|
181
181
|
# @option opts [String] :callback_url
|
|
182
182
|
# @option opts [String] :webhook_mode Webhook content delivery: 'inline' (base64 in payload) or 'download_url' (temporary URL, 1h TTL) (default to 'inline')
|
|
@@ -194,7 +194,7 @@ module FactPulse
|
|
|
194
194
|
|
|
195
195
|
# Sign a PDF asynchronously (Celery)
|
|
196
196
|
# Signs an uploaded PDF asynchronously via a Celery task. **Difference with /sign-pdf**: - `/sign-pdf`: Synchronous signature (blocking until completion) - `/sign-pdf-async`: Asynchronous signature (returns immediately with task_id) **Async advantages**: - No timeout for large files - No blocking of FastAPI worker - Progress tracking via task_id - Ideal for batch processing **Supported standards**: PAdES-B-B, PAdES-B-T (timestamping), PAdES-B-LT (long-term archiving). **⚠️ Legal disclaimer**: Same as /sign-pdf (see that endpoint's documentation).
|
|
197
|
-
# @param pdf_file [
|
|
197
|
+
# @param pdf_file [String] PDF file to sign (processed asynchronously)
|
|
198
198
|
# @param [Hash] opts the optional parameters
|
|
199
199
|
# @option opts [String] :callback_url
|
|
200
200
|
# @option opts [String] :webhook_mode Webhook content delivery: 'inline' (base64 in payload) or 'download_url' (temporary URL, 1h TTL) (default to 'inline')
|
|
@@ -269,7 +269,7 @@ module FactPulse
|
|
|
269
269
|
|
|
270
270
|
# Validate electronic signatures of a PDF
|
|
271
271
|
# Validates electronic signatures present in an uploaded PDF. **Verifications performed**: - Presence of signatures - Document integrity (not modified since signing) - Certificate validity - Chain of trust (if available) - Presence of timestamp (PAdES-B-T) - Validation data (PAdES-B-LT) **Supported standards**: PAdES-B-B, PAdES-B-T, PAdES-B-LT, ISO 32000-2. **⚠️ Note**: This validation is technical (cryptographic integrity). Legal validity depends on the eIDAS level of the certificate (SES/AdES/QES) and the context of use.
|
|
272
|
-
# @param pdf_file [
|
|
272
|
+
# @param pdf_file [String] PDF file to validate (will be analyzed to detect and validate signatures)
|
|
273
273
|
# @param [Hash] opts the optional parameters
|
|
274
274
|
# @return [Object]
|
|
275
275
|
def validate_pdf_signature_endpoint_api_v1_processing_validate_pdf_signature_post(pdf_file, opts = {})
|
|
@@ -279,7 +279,7 @@ module FactPulse
|
|
|
279
279
|
|
|
280
280
|
# Validate electronic signatures of a PDF
|
|
281
281
|
# Validates electronic signatures present in an uploaded PDF. **Verifications performed**: - Presence of signatures - Document integrity (not modified since signing) - Certificate validity - Chain of trust (if available) - Presence of timestamp (PAdES-B-T) - Validation data (PAdES-B-LT) **Supported standards**: PAdES-B-B, PAdES-B-T, PAdES-B-LT, ISO 32000-2. **⚠️ Note**: This validation is technical (cryptographic integrity). Legal validity depends on the eIDAS level of the certificate (SES/AdES/QES) and the context of use.
|
|
282
|
-
# @param pdf_file [
|
|
282
|
+
# @param pdf_file [String] PDF file to validate (will be analyzed to detect and validate signatures)
|
|
283
283
|
# @param [Hash] opts the optional parameters
|
|
284
284
|
# @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
|
|
285
285
|
def validate_pdf_signature_endpoint_api_v1_processing_validate_pdf_signature_post_with_http_info(pdf_file, opts = {})
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
The version of the OpenAPI document: 1.0.0
|
|
7
7
|
Contact: contact@factpulse.fr
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
|
-
Generator version: 7.21.0
|
|
9
|
+
Generator version: 7.21.0
|
|
10
10
|
|
|
11
11
|
=end
|
|
12
12
|
|
|
@@ -21,7 +21,7 @@ module FactPulse
|
|
|
21
21
|
end
|
|
22
22
|
# Convert a document to Factur-X (async mode)
|
|
23
23
|
# Launch an asynchronous conversion via Celery. ## Workflow 1. **Upload**: Document is sent as multipart/form-data 2. **Celery Task**: Task is queued for processing 3. **Callback**: Webhook notification on completion ## Possible responses - **202**: Task accepted, processing - **400**: Invalid file
|
|
24
|
-
# @param file [
|
|
24
|
+
# @param file [String] Document to convert (PDF, DOCX, XLSX, JPG, PNG)
|
|
25
25
|
# @param [Hash] opts the optional parameters
|
|
26
26
|
# @option opts [String] :output Output format: pdf, xml, both (default to 'pdf')
|
|
27
27
|
# @option opts [String] :callback_url
|
|
@@ -34,7 +34,7 @@ module FactPulse
|
|
|
34
34
|
|
|
35
35
|
# Convert a document to Factur-X (async mode)
|
|
36
36
|
# Launch an asynchronous conversion via Celery. ## Workflow 1. **Upload**: Document is sent as multipart/form-data 2. **Celery Task**: Task is queued for processing 3. **Callback**: Webhook notification on completion ## Possible responses - **202**: Task accepted, processing - **400**: Invalid file
|
|
37
|
-
# @param file [
|
|
37
|
+
# @param file [String] Document to convert (PDF, DOCX, XLSX, JPG, PNG)
|
|
38
38
|
# @param [Hash] opts the optional parameters
|
|
39
39
|
# @option opts [String] :output Output format: pdf, xml, both (default to 'pdf')
|
|
40
40
|
# @option opts [String] :callback_url
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
The version of the OpenAPI document: 1.0.0
|
|
7
7
|
Contact: contact@factpulse.fr
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
|
-
Generator version: 7.21.0
|
|
9
|
+
Generator version: 7.21.0
|
|
10
10
|
|
|
11
11
|
=end
|
|
12
12
|
|
|
@@ -21,7 +21,7 @@ module FactPulse
|
|
|
21
21
|
end
|
|
22
22
|
# Validate a complete Factur-X PDF
|
|
23
23
|
# 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)
|
|
24
|
-
# @param pdf_file [
|
|
24
|
+
# @param pdf_file [String] Factur-X PDF file to validate (.pdf format).
|
|
25
25
|
# @param [Hash] opts the optional parameters
|
|
26
26
|
# @option opts [APIProfile] :profile
|
|
27
27
|
# @option opts [Boolean] :use_verapdf Enable strict PDF/A validation with VeraPDF (recommended for production). If False, uses basic metadata validation. (default to false)
|
|
@@ -34,7 +34,7 @@ module FactPulse
|
|
|
34
34
|
|
|
35
35
|
# Validate a complete Factur-X PDF
|
|
36
36
|
# 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)
|
|
37
|
-
# @param pdf_file [
|
|
37
|
+
# @param pdf_file [String] Factur-X PDF file to validate (.pdf format).
|
|
38
38
|
# @param [Hash] opts the optional parameters
|
|
39
39
|
# @option opts [APIProfile] :profile
|
|
40
40
|
# @option opts [Boolean] :use_verapdf Enable strict PDF/A validation with VeraPDF (recommended for production). If False, uses basic metadata validation. (default to false)
|
|
@@ -99,7 +99,7 @@ module FactPulse
|
|
|
99
99
|
|
|
100
100
|
# Validate a Factur-X PDF (asynchronous with polling)
|
|
101
101
|
# 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
|
|
102
|
-
# @param pdf_file [
|
|
102
|
+
# @param pdf_file [String] Factur-X PDF file to validate (.pdf format).
|
|
103
103
|
# @param [Hash] opts the optional parameters
|
|
104
104
|
# @option opts [APIProfile] :profile
|
|
105
105
|
# @option opts [Boolean] :use_verapdf Enable strict PDF/A validation with VeraPDF (recommended for production). May take several seconds. (default to false)
|
|
@@ -113,7 +113,7 @@ module FactPulse
|
|
|
113
113
|
|
|
114
114
|
# Validate a Factur-X PDF (asynchronous with polling)
|
|
115
115
|
# 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
|
|
116
|
-
# @param pdf_file [
|
|
116
|
+
# @param pdf_file [String] Factur-X PDF file to validate (.pdf format).
|
|
117
117
|
# @param [Hash] opts the optional parameters
|
|
118
118
|
# @option opts [APIProfile] :profile
|
|
119
119
|
# @option opts [Boolean] :use_verapdf Enable strict PDF/A validation with VeraPDF (recommended for production). May take several seconds. (default to false)
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
The version of the OpenAPI document: 1.0.0
|
|
7
7
|
Contact: contact@factpulse.fr
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
|
-
Generator version: 7.21.0
|
|
9
|
+
Generator version: 7.21.0
|
|
10
10
|
|
|
11
11
|
=end
|
|
12
12
|
|
|
@@ -147,7 +147,7 @@ module FactPulse
|
|
|
147
147
|
|
|
148
148
|
# Verify PDF/XML Factur-X compliance (asynchronous)
|
|
149
149
|
# 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
|
|
150
|
-
# @param pdf_file [
|
|
150
|
+
# @param pdf_file [String] Factur-X PDF file to verify
|
|
151
151
|
# @param [Hash] opts the optional parameters
|
|
152
152
|
# @option opts [Boolean] :force_ocr Force OCR usage even if PDF contains native text (default to false)
|
|
153
153
|
# @option opts [String] :callback_url
|
|
@@ -160,7 +160,7 @@ module FactPulse
|
|
|
160
160
|
|
|
161
161
|
# Verify PDF/XML Factur-X compliance (asynchronous)
|
|
162
162
|
# 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
|
|
163
|
-
# @param pdf_file [
|
|
163
|
+
# @param pdf_file [String] Factur-X PDF file to verify
|
|
164
164
|
# @param [Hash] opts the optional parameters
|
|
165
165
|
# @option opts [Boolean] :force_ocr Force OCR usage even if PDF contains native text (default to false)
|
|
166
166
|
# @option opts [String] :callback_url
|
|
@@ -225,7 +225,7 @@ module FactPulse
|
|
|
225
225
|
|
|
226
226
|
# Verify PDF/XML Factur-X compliance (synchronous)
|
|
227
227
|
# 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
|
|
228
|
-
# @param pdf_file [
|
|
228
|
+
# @param pdf_file [String] Factur-X PDF file to verify
|
|
229
229
|
# @param [Hash] opts the optional parameters
|
|
230
230
|
# @return [VerificationSuccessResponse]
|
|
231
231
|
def verify_pdf_sync_api_v1_verification_verify_post(pdf_file, opts = {})
|
|
@@ -235,7 +235,7 @@ module FactPulse
|
|
|
235
235
|
|
|
236
236
|
# Verify PDF/XML Factur-X compliance (synchronous)
|
|
237
237
|
# 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
|
|
238
|
-
# @param pdf_file [
|
|
238
|
+
# @param pdf_file [String] Factur-X PDF file to verify
|
|
239
239
|
# @param [Hash] opts the optional parameters
|
|
240
240
|
# @return [Array<(VerificationSuccessResponse, Integer, Hash)>] VerificationSuccessResponse data, response status code and response headers
|
|
241
241
|
def verify_pdf_sync_api_v1_verification_verify_post_with_http_info(pdf_file, opts = {})
|