factpulse 4.0.1 → 4.0.2
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 +4 -4
- data/Gemfile.lock +1 -1
- data/docs/AFNORPDPPAApi.md +5 -72
- data/docs/AsyncTasksApi.md +77 -0
- data/docs/ChorusProCredentials.md +8 -8
- data/docs/ChorusProDestination.md +1 -1
- data/docs/CreateAggregatedReportRequest.md +3 -1
- data/docs/CreateEReportingRequest.md +3 -1
- data/docs/ElectronicSignatureApi.md +319 -0
- data/docs/EncaisseeRequest.md +10 -6
- data/docs/{DocumentConversionApi.md → FacturXConversionApi.md} +39 -39
- data/docs/FacturXGenerationApi.md +239 -0
- data/docs/FacturXInvoice.md +1 -1
- data/docs/FacturXPDFXMLVerificationApi.md +225 -0
- data/docs/FacturXValidationApi.md +241 -0
- data/docs/FactureElectroniqueRestApiSchemasChorusProChorusProCredentials.md +26 -0
- data/docs/{EReportingApi.md → Flux10EReportingApi.md} +53 -51
- data/docs/{CDARCycleDeVieApi.md → Flux6InvoiceLifecycleCDARApi.md} +145 -75
- data/docs/GetChorusProIdRequest.md +1 -1
- data/docs/GetInvoiceRequest.md +1 -1
- data/docs/GetStructureRequest.md +1 -1
- data/docs/HealthApi.md +67 -0
- data/docs/InvoiceInput.md +4 -2
- data/docs/IssuerRoleCode.md +15 -0
- data/docs/RefuseeRequest.md +10 -6
- data/docs/ReportIssuer.md +24 -0
- data/docs/ReportSender.md +1 -1
- data/docs/SearchStructureRequest.md +1 -1
- data/docs/SubmitInvoiceRequest.md +1 -1
- data/factpulse.gemspec +2 -2
- data/lib/factpulse/api/afnorpdppa_api.rb +5 -62
- 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/async_tasks_api.rb +85 -0
- data/lib/factpulse/api/chorus_pro_api.rb +1 -1
- data/lib/factpulse/api/client_management_api.rb +1 -1
- data/lib/factpulse/api/downloads_api.rb +1 -1
- data/lib/factpulse/api/electronic_signature_api.rb +339 -0
- data/lib/factpulse/api/{document_conversion_api.rb → factur_x_conversion_api.rb} +42 -42
- data/lib/factpulse/api/factur_x_generation_api.rb +254 -0
- data/lib/factpulse/api/factur_x_validation_api.rb +256 -0
- data/lib/factpulse/api/factur_xpdfxml_verification_api.rb +232 -0
- data/lib/factpulse/api/{e_reporting_api.rb → flux10_e_reporting_api.rb} +54 -51
- data/lib/factpulse/api/flux6_invoice_lifecycle_cdar_api.rb +670 -0
- data/lib/factpulse/api/health_api.rb +58 -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/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_edit.rb +1 -1
- data/lib/factpulse/models/afnor_address_patch.rb +1 -1
- data/lib/factpulse/models/afnor_address_put.rb +1 -1
- data/lib/factpulse/models/afnor_address_read.rb +1 -1
- data/lib/factpulse/models/afnor_algorithm.rb +1 -1
- data/lib/factpulse/models/afnor_contains_operator.rb +1 -1
- data/lib/factpulse/models/afnor_create_directory_line_body.rb +1 -1
- data/lib/factpulse/models/afnor_create_directory_line_body_addressing_information.rb +1 -1
- data/lib/factpulse/models/afnor_create_directory_line_body_period.rb +1 -1
- data/lib/factpulse/models/afnor_create_routing_code_body.rb +1 -1
- data/lib/factpulse/models/afnor_credentials.rb +1 -1
- data/lib/factpulse/models/afnor_destination.rb +1 -1
- data/lib/factpulse/models/afnor_diffusion_status.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.rb +1 -1
- data/lib/factpulse/models/afnor_directory_line_payload_history_legal_unit_facility_routing_code_platform.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_post201_response.rb +1 -1
- data/lib/factpulse/models/afnor_directory_line_search_post200_response.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_facility_administrative_status.rb +1 -1
- data/lib/factpulse/models/afnor_facility_nature.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 +1 -1
- data/lib/factpulse/models/afnor_facility_type.rb +1 -1
- data/lib/factpulse/models/afnor_flow.rb +1 -1
- 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_info.rb +1 -1
- data/lib/factpulse/models/afnor_flow_profile.rb +1 -1
- data/lib/factpulse/models/afnor_flow_syntax.rb +1 -1
- data/lib/factpulse/models/afnor_flow_type.rb +1 -1
- data/lib/factpulse/models/afnor_full_flow_info.rb +1 -1
- 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 +1 -1
- data/lib/factpulse/models/afnor_legal_unit_payload_included_no_siren.rb +1 -1
- data/lib/factpulse/models/afnor_platform_status.rb +1 -1
- data/lib/factpulse/models/afnor_processing_rule.rb +1 -1
- 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_post201_response.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 +1 -1
- data/lib/factpulse/models/afnor_routing_code_search_sorting_inner.rb +1 -1
- data/lib/factpulse/models/afnor_search_directory_line.rb +1 -1
- 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 +1 -1
- data/lib/factpulse/models/afnor_search_flow_content.rb +1 -1
- data/lib/factpulse/models/afnor_search_flow_filters.rb +1 -1
- data/lib/factpulse/models/afnor_search_flow_params.rb +1 -1
- 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 +1 -1
- 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 +1 -1
- 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 +1 -1
- 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 +1 -1
- data/lib/factpulse/models/afnor_search_siret_filters_name.rb +1 -1
- 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 +1 -1
- data/lib/factpulse/models/afnor_siren_field.rb +1 -1
- data/lib/factpulse/models/afnor_siren_search_post200_response.rb +1 -1
- data/lib/factpulse/models/afnor_siret_field.rb +1 -1
- data/lib/factpulse/models/afnor_siret_search_post200_response.rb +1 -1
- 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_update_patch_directory_line_body.rb +1 -1
- data/lib/factpulse/models/afnor_update_patch_routing_code_body.rb +1 -1
- data/lib/factpulse/models/afnor_update_put_routing_code_body.rb +1 -1
- data/lib/factpulse/models/afnor_webhook_callback_content.rb +1 -1
- 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 +1 -1
- 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 +1 -1
- data/lib/factpulse/models/amount1.rb +1 -1
- data/lib/factpulse/models/amount2.rb +1 -1
- data/lib/factpulse/models/amount_due.rb +1 -1
- 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 +2 -2
- 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_credentials.rb +27 -95
- data/lib/factpulse/models/chorus_pro_destination.rb +2 -2
- 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/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 +13 -3
- data/lib/factpulse/models/create_cdar_request.rb +1 -1
- data/lib/factpulse/models/create_e_reporting_request.rb +13 -3
- data/lib/factpulse/models/currency.rb +1 -1
- data/lib/factpulse/models/currency_code.rb +1 -1
- data/lib/factpulse/models/delivery_party.rb +1 -1
- 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 +1 -1
- data/lib/factpulse/models/encaisseamount.rb +1 -1
- data/lib/factpulse/models/encaisseamount1.rb +1 -1
- data/lib/factpulse/models/encaissee_request.rb +86 -32
- 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 +3 -2
- data/lib/factpulse/models/extraction_info.rb +1 -1
- data/lib/factpulse/models/factur_x_invoice.rb +1 -18
- data/lib/factpulse/models/factur_xpdf_info.rb +1 -1
- data/lib/factpulse/models/facture_electronique_rest_api_schemas_cdar_validation_error_response.rb +1 -1
- data/lib/factpulse/models/facture_electronique_rest_api_schemas_chorus_pro_chorus_pro_credentials.rb +259 -0
- data/lib/factpulse/models/facture_electronique_rest_api_schemas_ereporting_invoice_type_code.rb +1 -1
- 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 +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_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/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 +1 -1
- data/lib/factpulse/models/invoice_format.rb +1 -1
- data/lib/factpulse/models/invoice_input.rb +14 -21
- 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/invoicing_framework.rb +1 -1
- data/lib/factpulse/models/invoicing_framework_code.rb +1 -1
- data/lib/factpulse/models/issuer_role_code.rb +40 -0
- 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/payee.rb +1 -1
- data/lib/factpulse/models/payment_amount_by_rate.rb +1 -1
- data/lib/factpulse/models/payment_card.rb +1 -1
- 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_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 +1 -1
- 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 +1 -1
- data/lib/factpulse/models/processing_rule.rb +1 -1
- 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 +1 -1
- data/lib/factpulse/models/recipient_input.rb +1 -1
- data/lib/factpulse/models/refusee_request.rb +84 -30
- data/lib/factpulse/models/report_issuer.rb +236 -0
- data/lib/factpulse/models/report_period.rb +1 -1
- data/lib/factpulse/models/report_sender.rb +3 -3
- 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 +2 -2
- 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_cdar_response.rb +1 -1
- data/lib/factpulse/models/simplified_invoice_data.rb +1 -1
- 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 +1 -1
- 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 +1 -1
- 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/supplementary_attachment.rb +1 -1
- data/lib/factpulse/models/supplier.rb +1 -1
- data/lib/factpulse/models/task_response.rb +1 -1
- data/lib/factpulse/models/tax_breakdown_input.rb +1 -1
- data/lib/factpulse/models/tax_due_date_type.rb +1 -1
- data/lib/factpulse/models/tax_representative.rb +1 -1
- 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/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 +1 -1
- 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 +1 -1
- data/lib/factpulse/models/validation_error_detail.rb +1 -1
- data/lib/factpulse/models/validation_error_response.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/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/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 +12 -8
- metadata +46 -37
- data/docs/FactureElectroniqueRestApiSchemasProcessingChorusProCredentials.md +0 -26
- data/docs/InvoiceProcessingApi.md +0 -855
- data/docs/PDFXMLVerificationApi.md +0 -443
- data/docs/UserApi.md +0 -74
- data/lib/factpulse/api/cdar_cycle_de_vie_api.rb +0 -601
- data/lib/factpulse/api/invoice_processing_api.rb +0 -868
- data/lib/factpulse/api/pdfxml_verification_api.rb +0 -442
- data/lib/factpulse/api/user_api.rb +0 -79
- data/lib/factpulse/models/facture_electronique_rest_api_schemas_processing_chorus_pro_credentials.rb +0 -191
|
@@ -1,27 +1,28 @@
|
|
|
1
|
-
# FactPulse::
|
|
1
|
+
# FactPulse::Flux6InvoiceLifecycleCDARApi
|
|
2
2
|
|
|
3
3
|
All URIs are relative to *https://factpulse.fr*
|
|
4
4
|
|
|
5
5
|
| Method | HTTP request | Description |
|
|
6
6
|
| ------ | ------------ | ----------- |
|
|
7
|
-
| [**generate_cdar_api_v1_cdar_generate_post**](
|
|
8
|
-
| [**get_action_codes_api_v1_cdar_action_codes_get**](
|
|
9
|
-
| [**get_reason_codes_api_v1_cdar_reason_codes_get**](
|
|
10
|
-
| [**get_status_codes_api_v1_cdar_status_codes_get**](
|
|
11
|
-
| [**submit_cdar_api_v1_cdar_submit_post**](
|
|
12
|
-
| [**submit_cdar_xml_api_v1_cdar_submit_xml_post**](
|
|
13
|
-
| [**submit_encaissee_api_v1_cdar_encaissee_post**](
|
|
14
|
-
| [**submit_refusee_api_v1_cdar_refusee_post**](
|
|
15
|
-
| [**validate_cdar_api_v1_cdar_validate_post**](
|
|
7
|
+
| [**generate_cdar_api_v1_cdar_generate_post**](Flux6InvoiceLifecycleCDARApi.md#generate_cdar_api_v1_cdar_generate_post) | **POST** /api/v1/cdar/generate | Generate a CDAR message |
|
|
8
|
+
| [**get_action_codes_api_v1_cdar_action_codes_get**](Flux6InvoiceLifecycleCDARApi.md#get_action_codes_api_v1_cdar_action_codes_get) | **GET** /api/v1/cdar/action-codes | List of CDAR action codes |
|
|
9
|
+
| [**get_reason_codes_api_v1_cdar_reason_codes_get**](Flux6InvoiceLifecycleCDARApi.md#get_reason_codes_api_v1_cdar_reason_codes_get) | **GET** /api/v1/cdar/reason-codes | List of CDAR reason codes |
|
|
10
|
+
| [**get_status_codes_api_v1_cdar_status_codes_get**](Flux6InvoiceLifecycleCDARApi.md#get_status_codes_api_v1_cdar_status_codes_get) | **GET** /api/v1/cdar/status-codes | List of CDAR status codes |
|
|
11
|
+
| [**submit_cdar_api_v1_cdar_submit_post**](Flux6InvoiceLifecycleCDARApi.md#submit_cdar_api_v1_cdar_submit_post) | **POST** /api/v1/cdar/submit | Generate and submit a CDAR message |
|
|
12
|
+
| [**submit_cdar_xml_api_v1_cdar_submit_xml_post**](Flux6InvoiceLifecycleCDARApi.md#submit_cdar_xml_api_v1_cdar_submit_xml_post) | **POST** /api/v1/cdar/submit-xml | Submit a pre-generated CDAR XML |
|
|
13
|
+
| [**submit_encaissee_api_v1_cdar_encaissee_post**](Flux6InvoiceLifecycleCDARApi.md#submit_encaissee_api_v1_cdar_encaissee_post) | **POST** /api/v1/cdar/encaissee | [Simplified] Submit PAID status (212) - Issued invoice |
|
|
14
|
+
| [**submit_refusee_api_v1_cdar_refusee_post**](Flux6InvoiceLifecycleCDARApi.md#submit_refusee_api_v1_cdar_refusee_post) | **POST** /api/v1/cdar/refusee | [Simplified] Submit REFUSED status (210) - Received invoice |
|
|
15
|
+
| [**validate_cdar_api_v1_cdar_validate_post**](Flux6InvoiceLifecycleCDARApi.md#validate_cdar_api_v1_cdar_validate_post) | **POST** /api/v1/cdar/validate | Validate CDAR structured data |
|
|
16
|
+
| [**validate_xml_cdar_api_v1_cdar_validate_xml_post**](Flux6InvoiceLifecycleCDARApi.md#validate_xml_cdar_api_v1_cdar_validate_xml_post) | **POST** /api/v1/cdar/validate-xml | Validate CDAR XML against XSD and Schematron BR-FR-CDV |
|
|
16
17
|
|
|
17
18
|
|
|
18
19
|
## generate_cdar_api_v1_cdar_generate_post
|
|
19
20
|
|
|
20
21
|
> <GenerateCDARResponse> generate_cdar_api_v1_cdar_generate_post(create_cdar_request)
|
|
21
22
|
|
|
22
|
-
|
|
23
|
+
Generate a CDAR message
|
|
23
24
|
|
|
24
|
-
|
|
25
|
+
Generate a CDAR XML message (Cross Domain Acknowledgement and Response) to communicate the status of an invoice. **Message types:** - **23** (Processing): Standard lifecycle message - **305** (Transmission): Inter-platform transmission message **Business rules:** - BR-FR-CDV-14: Status 212 (PAID) requires a paid amount - BR-FR-CDV-15: Statuses 206/207/208/210/213/501 require a reason code
|
|
25
26
|
|
|
26
27
|
### Examples
|
|
27
28
|
|
|
@@ -34,15 +35,15 @@ FactPulse.configure do |config|
|
|
|
34
35
|
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
35
36
|
end
|
|
36
37
|
|
|
37
|
-
api_instance = FactPulse::
|
|
38
|
+
api_instance = FactPulse::Flux6InvoiceLifecycleCDARApi.new
|
|
38
39
|
create_cdar_request = FactPulse::CreateCDARRequest.new({document_id: 'document_id_example', sender_siren: 'sender_siren_example', invoice_id: 'invoice_id_example', invoice_issue_date: Date.today, status: 'status_example'}) # CreateCDARRequest |
|
|
39
40
|
|
|
40
41
|
begin
|
|
41
|
-
#
|
|
42
|
+
# Generate a CDAR message
|
|
42
43
|
result = api_instance.generate_cdar_api_v1_cdar_generate_post(create_cdar_request)
|
|
43
44
|
p result
|
|
44
45
|
rescue FactPulse::ApiError => e
|
|
45
|
-
puts "Error when calling
|
|
46
|
+
puts "Error when calling Flux6InvoiceLifecycleCDARApi->generate_cdar_api_v1_cdar_generate_post: #{e}"
|
|
46
47
|
end
|
|
47
48
|
```
|
|
48
49
|
|
|
@@ -54,13 +55,13 @@ This returns an Array which contains the response data, status code and headers.
|
|
|
54
55
|
|
|
55
56
|
```ruby
|
|
56
57
|
begin
|
|
57
|
-
#
|
|
58
|
+
# Generate a CDAR message
|
|
58
59
|
data, status_code, headers = api_instance.generate_cdar_api_v1_cdar_generate_post_with_http_info(create_cdar_request)
|
|
59
60
|
p status_code # => 2xx
|
|
60
61
|
p headers # => { ... }
|
|
61
62
|
p data # => <GenerateCDARResponse>
|
|
62
63
|
rescue FactPulse::ApiError => e
|
|
63
|
-
puts "Error when calling
|
|
64
|
+
puts "Error when calling Flux6InvoiceLifecycleCDARApi->generate_cdar_api_v1_cdar_generate_post_with_http_info: #{e}"
|
|
64
65
|
end
|
|
65
66
|
```
|
|
66
67
|
|
|
@@ -88,9 +89,9 @@ end
|
|
|
88
89
|
|
|
89
90
|
> <ActionCodesResponse> get_action_codes_api_v1_cdar_action_codes_get
|
|
90
91
|
|
|
91
|
-
|
|
92
|
+
List of CDAR action codes
|
|
92
93
|
|
|
93
|
-
|
|
94
|
+
Returns the complete list of action codes (BR-FR-CDV-CL-10). These codes indicate the requested action on the invoice.
|
|
94
95
|
|
|
95
96
|
### Examples
|
|
96
97
|
|
|
@@ -98,14 +99,14 @@ Retourne la liste complète des codes action (BR-FR-CDV-CL-10). Ces codes indiq
|
|
|
98
99
|
require 'time'
|
|
99
100
|
require 'factpulse'
|
|
100
101
|
|
|
101
|
-
api_instance = FactPulse::
|
|
102
|
+
api_instance = FactPulse::Flux6InvoiceLifecycleCDARApi.new
|
|
102
103
|
|
|
103
104
|
begin
|
|
104
|
-
#
|
|
105
|
+
# List of CDAR action codes
|
|
105
106
|
result = api_instance.get_action_codes_api_v1_cdar_action_codes_get
|
|
106
107
|
p result
|
|
107
108
|
rescue FactPulse::ApiError => e
|
|
108
|
-
puts "Error when calling
|
|
109
|
+
puts "Error when calling Flux6InvoiceLifecycleCDARApi->get_action_codes_api_v1_cdar_action_codes_get: #{e}"
|
|
109
110
|
end
|
|
110
111
|
```
|
|
111
112
|
|
|
@@ -117,13 +118,13 @@ This returns an Array which contains the response data, status code and headers.
|
|
|
117
118
|
|
|
118
119
|
```ruby
|
|
119
120
|
begin
|
|
120
|
-
#
|
|
121
|
+
# List of CDAR action codes
|
|
121
122
|
data, status_code, headers = api_instance.get_action_codes_api_v1_cdar_action_codes_get_with_http_info
|
|
122
123
|
p status_code # => 2xx
|
|
123
124
|
p headers # => { ... }
|
|
124
125
|
p data # => <ActionCodesResponse>
|
|
125
126
|
rescue FactPulse::ApiError => e
|
|
126
|
-
puts "Error when calling
|
|
127
|
+
puts "Error when calling Flux6InvoiceLifecycleCDARApi->get_action_codes_api_v1_cdar_action_codes_get_with_http_info: #{e}"
|
|
127
128
|
end
|
|
128
129
|
```
|
|
129
130
|
|
|
@@ -149,9 +150,9 @@ No authorization required
|
|
|
149
150
|
|
|
150
151
|
> <ReasonCodesResponse> get_reason_codes_api_v1_cdar_reason_codes_get
|
|
151
152
|
|
|
152
|
-
|
|
153
|
+
List of CDAR reason codes
|
|
153
154
|
|
|
154
|
-
|
|
155
|
+
Returns the complete list of status reason codes (BR-FR-CDV-CL-09). These codes explain the reason for a particular status.
|
|
155
156
|
|
|
156
157
|
### Examples
|
|
157
158
|
|
|
@@ -159,14 +160,14 @@ Retourne la liste complète des codes motif de statut (BR-FR-CDV-CL-09). Ces co
|
|
|
159
160
|
require 'time'
|
|
160
161
|
require 'factpulse'
|
|
161
162
|
|
|
162
|
-
api_instance = FactPulse::
|
|
163
|
+
api_instance = FactPulse::Flux6InvoiceLifecycleCDARApi.new
|
|
163
164
|
|
|
164
165
|
begin
|
|
165
|
-
#
|
|
166
|
+
# List of CDAR reason codes
|
|
166
167
|
result = api_instance.get_reason_codes_api_v1_cdar_reason_codes_get
|
|
167
168
|
p result
|
|
168
169
|
rescue FactPulse::ApiError => e
|
|
169
|
-
puts "Error when calling
|
|
170
|
+
puts "Error when calling Flux6InvoiceLifecycleCDARApi->get_reason_codes_api_v1_cdar_reason_codes_get: #{e}"
|
|
170
171
|
end
|
|
171
172
|
```
|
|
172
173
|
|
|
@@ -178,13 +179,13 @@ This returns an Array which contains the response data, status code and headers.
|
|
|
178
179
|
|
|
179
180
|
```ruby
|
|
180
181
|
begin
|
|
181
|
-
#
|
|
182
|
+
# List of CDAR reason codes
|
|
182
183
|
data, status_code, headers = api_instance.get_reason_codes_api_v1_cdar_reason_codes_get_with_http_info
|
|
183
184
|
p status_code # => 2xx
|
|
184
185
|
p headers # => { ... }
|
|
185
186
|
p data # => <ReasonCodesResponse>
|
|
186
187
|
rescue FactPulse::ApiError => e
|
|
187
|
-
puts "Error when calling
|
|
188
|
+
puts "Error when calling Flux6InvoiceLifecycleCDARApi->get_reason_codes_api_v1_cdar_reason_codes_get_with_http_info: #{e}"
|
|
188
189
|
end
|
|
189
190
|
```
|
|
190
191
|
|
|
@@ -210,9 +211,9 @@ No authorization required
|
|
|
210
211
|
|
|
211
212
|
> <StatusCodesResponse> get_status_codes_api_v1_cdar_status_codes_get
|
|
212
213
|
|
|
213
|
-
|
|
214
|
+
List of CDAR status codes
|
|
214
215
|
|
|
215
|
-
|
|
216
|
+
Returns the complete list of invoice status codes (BR-FR-CDV-CL-06). These codes indicate the lifecycle state of an invoice.
|
|
216
217
|
|
|
217
218
|
### Examples
|
|
218
219
|
|
|
@@ -220,14 +221,14 @@ Retourne la liste complète des codes statut de facture (BR-FR-CDV-CL-06). Ces
|
|
|
220
221
|
require 'time'
|
|
221
222
|
require 'factpulse'
|
|
222
223
|
|
|
223
|
-
api_instance = FactPulse::
|
|
224
|
+
api_instance = FactPulse::Flux6InvoiceLifecycleCDARApi.new
|
|
224
225
|
|
|
225
226
|
begin
|
|
226
|
-
#
|
|
227
|
+
# List of CDAR status codes
|
|
227
228
|
result = api_instance.get_status_codes_api_v1_cdar_status_codes_get
|
|
228
229
|
p result
|
|
229
230
|
rescue FactPulse::ApiError => e
|
|
230
|
-
puts "Error when calling
|
|
231
|
+
puts "Error when calling Flux6InvoiceLifecycleCDARApi->get_status_codes_api_v1_cdar_status_codes_get: #{e}"
|
|
231
232
|
end
|
|
232
233
|
```
|
|
233
234
|
|
|
@@ -239,13 +240,13 @@ This returns an Array which contains the response data, status code and headers.
|
|
|
239
240
|
|
|
240
241
|
```ruby
|
|
241
242
|
begin
|
|
242
|
-
#
|
|
243
|
+
# List of CDAR status codes
|
|
243
244
|
data, status_code, headers = api_instance.get_status_codes_api_v1_cdar_status_codes_get_with_http_info
|
|
244
245
|
p status_code # => 2xx
|
|
245
246
|
p headers # => { ... }
|
|
246
247
|
p data # => <StatusCodesResponse>
|
|
247
248
|
rescue FactPulse::ApiError => e
|
|
248
|
-
puts "Error when calling
|
|
249
|
+
puts "Error when calling Flux6InvoiceLifecycleCDARApi->get_status_codes_api_v1_cdar_status_codes_get_with_http_info: #{e}"
|
|
249
250
|
end
|
|
250
251
|
```
|
|
251
252
|
|
|
@@ -271,9 +272,9 @@ No authorization required
|
|
|
271
272
|
|
|
272
273
|
> <SubmitCDARResponse> submit_cdar_api_v1_cdar_submit_post(submit_cdar_request)
|
|
273
274
|
|
|
274
|
-
|
|
275
|
+
Generate and submit a CDAR message
|
|
275
276
|
|
|
276
|
-
|
|
277
|
+
Generate a CDAR message and submit it to the PA/PDP platform. **Authentication strategies:** 1. **JWT with client_uid** (recommended): PDP credentials retrieved from backend 2. **Zero-storage**: Provide pdpFlowServiceUrl, pdpClientId, pdpClientSecret in the request **Flow types (flowType):** - `CustomerInvoiceLC`: Client-side lifecycle (buyer) - `SupplierInvoiceLC`: Supplier-side lifecycle (seller)
|
|
277
278
|
|
|
278
279
|
### Examples
|
|
279
280
|
|
|
@@ -286,15 +287,15 @@ FactPulse.configure do |config|
|
|
|
286
287
|
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
287
288
|
end
|
|
288
289
|
|
|
289
|
-
api_instance = FactPulse::
|
|
290
|
+
api_instance = FactPulse::Flux6InvoiceLifecycleCDARApi.new
|
|
290
291
|
submit_cdar_request = FactPulse::SubmitCDARRequest.new({document_id: 'document_id_example', sender_siren: 'sender_siren_example', invoice_id: 'invoice_id_example', invoice_issue_date: Date.today, status: 'status_example'}) # SubmitCDARRequest |
|
|
291
292
|
|
|
292
293
|
begin
|
|
293
|
-
#
|
|
294
|
+
# Generate and submit a CDAR message
|
|
294
295
|
result = api_instance.submit_cdar_api_v1_cdar_submit_post(submit_cdar_request)
|
|
295
296
|
p result
|
|
296
297
|
rescue FactPulse::ApiError => e
|
|
297
|
-
puts "Error when calling
|
|
298
|
+
puts "Error when calling Flux6InvoiceLifecycleCDARApi->submit_cdar_api_v1_cdar_submit_post: #{e}"
|
|
298
299
|
end
|
|
299
300
|
```
|
|
300
301
|
|
|
@@ -306,13 +307,13 @@ This returns an Array which contains the response data, status code and headers.
|
|
|
306
307
|
|
|
307
308
|
```ruby
|
|
308
309
|
begin
|
|
309
|
-
#
|
|
310
|
+
# Generate and submit a CDAR message
|
|
310
311
|
data, status_code, headers = api_instance.submit_cdar_api_v1_cdar_submit_post_with_http_info(submit_cdar_request)
|
|
311
312
|
p status_code # => 2xx
|
|
312
313
|
p headers # => { ... }
|
|
313
314
|
p data # => <SubmitCDARResponse>
|
|
314
315
|
rescue FactPulse::ApiError => e
|
|
315
|
-
puts "Error when calling
|
|
316
|
+
puts "Error when calling Flux6InvoiceLifecycleCDARApi->submit_cdar_api_v1_cdar_submit_post_with_http_info: #{e}"
|
|
316
317
|
end
|
|
317
318
|
```
|
|
318
319
|
|
|
@@ -340,9 +341,9 @@ end
|
|
|
340
341
|
|
|
341
342
|
> <SubmitCDARResponse> submit_cdar_xml_api_v1_cdar_submit_xml_post(submit_cdarxml_request)
|
|
342
343
|
|
|
343
|
-
|
|
344
|
+
Submit a pre-generated CDAR XML
|
|
344
345
|
|
|
345
|
-
|
|
346
|
+
Submit a pre-generated CDAR XML message to the PA/PDP platform. Useful for submitting XML generated by other systems. **Validation:** The XML is validated against XSD and Schematron BR-FR-CDV rules BEFORE submission. Invalid XML will be rejected with detailed error messages. **Authentication strategies:** 1. **JWT with client_uid** (recommended): PDP credentials retrieved from backend 2. **Zero-storage**: Provide pdpFlowServiceUrl, pdpClientId, pdpClientSecret in the request
|
|
346
347
|
|
|
347
348
|
### Examples
|
|
348
349
|
|
|
@@ -355,15 +356,15 @@ FactPulse.configure do |config|
|
|
|
355
356
|
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
356
357
|
end
|
|
357
358
|
|
|
358
|
-
api_instance = FactPulse::
|
|
359
|
+
api_instance = FactPulse::Flux6InvoiceLifecycleCDARApi.new
|
|
359
360
|
submit_cdarxml_request = FactPulse::SubmitCDARXMLRequest.new({xml: 'xml_example'}) # SubmitCDARXMLRequest |
|
|
360
361
|
|
|
361
362
|
begin
|
|
362
|
-
#
|
|
363
|
+
# Submit a pre-generated CDAR XML
|
|
363
364
|
result = api_instance.submit_cdar_xml_api_v1_cdar_submit_xml_post(submit_cdarxml_request)
|
|
364
365
|
p result
|
|
365
366
|
rescue FactPulse::ApiError => e
|
|
366
|
-
puts "Error when calling
|
|
367
|
+
puts "Error when calling Flux6InvoiceLifecycleCDARApi->submit_cdar_xml_api_v1_cdar_submit_xml_post: #{e}"
|
|
367
368
|
end
|
|
368
369
|
```
|
|
369
370
|
|
|
@@ -375,13 +376,13 @@ This returns an Array which contains the response data, status code and headers.
|
|
|
375
376
|
|
|
376
377
|
```ruby
|
|
377
378
|
begin
|
|
378
|
-
#
|
|
379
|
+
# Submit a pre-generated CDAR XML
|
|
379
380
|
data, status_code, headers = api_instance.submit_cdar_xml_api_v1_cdar_submit_xml_post_with_http_info(submit_cdarxml_request)
|
|
380
381
|
p status_code # => 2xx
|
|
381
382
|
p headers # => { ... }
|
|
382
383
|
p data # => <SubmitCDARResponse>
|
|
383
384
|
rescue FactPulse::ApiError => e
|
|
384
|
-
puts "Error when calling
|
|
385
|
+
puts "Error when calling Flux6InvoiceLifecycleCDARApi->submit_cdar_xml_api_v1_cdar_submit_xml_post_with_http_info: #{e}"
|
|
385
386
|
end
|
|
386
387
|
```
|
|
387
388
|
|
|
@@ -409,9 +410,9 @@ end
|
|
|
409
410
|
|
|
410
411
|
> <SimplifiedCDARResponse> submit_encaissee_api_v1_cdar_encaissee_post(encaissee_request)
|
|
411
412
|
|
|
412
|
-
[
|
|
413
|
+
[Simplified] Submit PAID status (212) - Issued invoice
|
|
413
414
|
|
|
414
|
-
**
|
|
415
|
+
**Simplified endpoint for OD** - Submit a PAID status (212) for an **ISSUED** invoice. This status is **mandatory for PPF** (BR-FR-CDV-14 requires the paid amount). **Use case:** The **seller** confirms payment receipt for an invoice they issued. **Who issues this status?** - **Issuer (IssuerTradeParty):** The seller (SE = Seller) who received payment - **Recipient (RecipientTradeParty):** The buyer (BY = Buyer) who paid **Reference:** XP Z12-014 Annex B, example UC1_F202500003_07-CDV-212_Encaissee.xml **Authentication:** JWT Bearer (recommended) or PDP credentials in request.
|
|
415
416
|
|
|
416
417
|
### Examples
|
|
417
418
|
|
|
@@ -424,15 +425,15 @@ FactPulse.configure do |config|
|
|
|
424
425
|
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
425
426
|
end
|
|
426
427
|
|
|
427
|
-
api_instance = FactPulse::
|
|
428
|
-
encaissee_request = FactPulse::EncaisseeRequest.new({invoice_id: 'invoice_id_example', invoice_issue_date: Date.today, amount: FactPulse::Amount.new}) # EncaisseeRequest |
|
|
428
|
+
api_instance = FactPulse::Flux6InvoiceLifecycleCDARApi.new
|
|
429
|
+
encaissee_request = FactPulse::EncaisseeRequest.new({invoice_id: 'invoice_id_example', invoice_issue_date: Date.today, invoice_buyer_siren: 'invoice_buyer_siren_example', invoice_buyer_electronic_address: 'invoice_buyer_electronic_address_example', amount: FactPulse::Amount.new}) # EncaisseeRequest |
|
|
429
430
|
|
|
430
431
|
begin
|
|
431
|
-
# [
|
|
432
|
+
# [Simplified] Submit PAID status (212) - Issued invoice
|
|
432
433
|
result = api_instance.submit_encaissee_api_v1_cdar_encaissee_post(encaissee_request)
|
|
433
434
|
p result
|
|
434
435
|
rescue FactPulse::ApiError => e
|
|
435
|
-
puts "Error when calling
|
|
436
|
+
puts "Error when calling Flux6InvoiceLifecycleCDARApi->submit_encaissee_api_v1_cdar_encaissee_post: #{e}"
|
|
436
437
|
end
|
|
437
438
|
```
|
|
438
439
|
|
|
@@ -444,13 +445,13 @@ This returns an Array which contains the response data, status code and headers.
|
|
|
444
445
|
|
|
445
446
|
```ruby
|
|
446
447
|
begin
|
|
447
|
-
# [
|
|
448
|
+
# [Simplified] Submit PAID status (212) - Issued invoice
|
|
448
449
|
data, status_code, headers = api_instance.submit_encaissee_api_v1_cdar_encaissee_post_with_http_info(encaissee_request)
|
|
449
450
|
p status_code # => 2xx
|
|
450
451
|
p headers # => { ... }
|
|
451
452
|
p data # => <SimplifiedCDARResponse>
|
|
452
453
|
rescue FactPulse::ApiError => e
|
|
453
|
-
puts "Error when calling
|
|
454
|
+
puts "Error when calling Flux6InvoiceLifecycleCDARApi->submit_encaissee_api_v1_cdar_encaissee_post_with_http_info: #{e}"
|
|
454
455
|
end
|
|
455
456
|
```
|
|
456
457
|
|
|
@@ -478,9 +479,9 @@ end
|
|
|
478
479
|
|
|
479
480
|
> <SimplifiedCDARResponse> submit_refusee_api_v1_cdar_refusee_post(refusee_request)
|
|
480
481
|
|
|
481
|
-
[
|
|
482
|
+
[Simplified] Submit REFUSED status (210) - Received invoice
|
|
482
483
|
|
|
483
|
-
**
|
|
484
|
+
**Simplified endpoint for OD** - Submit a REFUSED status (210) for a **RECEIVED** invoice. This status is **mandatory for PPF** (BR-FR-CDV-15 requires a reason code). **Use case:** The **buyer** refuses an invoice they received. **Who issues this status?** - **Issuer (IssuerTradeParty):** The buyer (BY = Buyer) refusing the invoice - **Recipient (RecipientTradeParty):** The seller (SE = Seller) who issued the invoice **Reference:** XP Z12-014 Annex B, example UC3_F202500005_04-CDV-210_Refusee.xml **Allowed reason codes (BR-FR-CDV-CL-09):** - `TX_TVA_ERR`: Incorrect VAT rate - `MONTANTTOTAL_ERR`: Incorrect total amount - `CALCUL_ERR`: Calculation error - `NON_CONFORME`: Non-compliant - `DOUBLON`: Duplicate - `DEST_ERR`: Wrong recipient - `TRANSAC_INC`: Incomplete transaction - `EMMET_INC`: Unknown issuer - `CONTRAT_TERM`: Contract terminated - `DOUBLE_FACT`: Double billing - `CMD_ERR`: Order error - `ADR_ERR`: Address error - `REF_CT_ABSENT`: Missing contract reference **Authentication:** JWT Bearer (recommended) or PDP credentials in request.
|
|
484
485
|
|
|
485
486
|
### Examples
|
|
486
487
|
|
|
@@ -493,15 +494,15 @@ FactPulse.configure do |config|
|
|
|
493
494
|
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
494
495
|
end
|
|
495
496
|
|
|
496
|
-
api_instance = FactPulse::
|
|
497
|
-
refusee_request = FactPulse::RefuseeRequest.new({invoice_id: 'invoice_id_example', invoice_issue_date: Date.today, reason_code: 'reason_code_example'}) # RefuseeRequest |
|
|
497
|
+
api_instance = FactPulse::Flux6InvoiceLifecycleCDARApi.new
|
|
498
|
+
refusee_request = FactPulse::RefuseeRequest.new({invoice_id: 'invoice_id_example', invoice_issue_date: Date.today, invoice_seller_siren: 'invoice_seller_siren_example', invoice_seller_electronic_address: 'invoice_seller_electronic_address_example', reason_code: 'reason_code_example'}) # RefuseeRequest |
|
|
498
499
|
|
|
499
500
|
begin
|
|
500
|
-
# [
|
|
501
|
+
# [Simplified] Submit REFUSED status (210) - Received invoice
|
|
501
502
|
result = api_instance.submit_refusee_api_v1_cdar_refusee_post(refusee_request)
|
|
502
503
|
p result
|
|
503
504
|
rescue FactPulse::ApiError => e
|
|
504
|
-
puts "Error when calling
|
|
505
|
+
puts "Error when calling Flux6InvoiceLifecycleCDARApi->submit_refusee_api_v1_cdar_refusee_post: #{e}"
|
|
505
506
|
end
|
|
506
507
|
```
|
|
507
508
|
|
|
@@ -513,13 +514,13 @@ This returns an Array which contains the response data, status code and headers.
|
|
|
513
514
|
|
|
514
515
|
```ruby
|
|
515
516
|
begin
|
|
516
|
-
# [
|
|
517
|
+
# [Simplified] Submit REFUSED status (210) - Received invoice
|
|
517
518
|
data, status_code, headers = api_instance.submit_refusee_api_v1_cdar_refusee_post_with_http_info(refusee_request)
|
|
518
519
|
p status_code # => 2xx
|
|
519
520
|
p headers # => { ... }
|
|
520
521
|
p data # => <SimplifiedCDARResponse>
|
|
521
522
|
rescue FactPulse::ApiError => e
|
|
522
|
-
puts "Error when calling
|
|
523
|
+
puts "Error when calling Flux6InvoiceLifecycleCDARApi->submit_refusee_api_v1_cdar_refusee_post_with_http_info: #{e}"
|
|
523
524
|
end
|
|
524
525
|
```
|
|
525
526
|
|
|
@@ -547,9 +548,9 @@ end
|
|
|
547
548
|
|
|
548
549
|
> <ValidateCDARResponse> validate_cdar_api_v1_cdar_validate_post(validate_cdar_request)
|
|
549
550
|
|
|
550
|
-
|
|
551
|
+
Validate CDAR structured data
|
|
551
552
|
|
|
552
|
-
|
|
553
|
+
Validate CDAR structured data without generating XML. **Note:** This endpoint validates structured data fields only. Use `/validate-xml` to validate a pre-generated CDAR XML file against XSD and Schematron. Checks: - Field formats (SIREN, dates, etc.) - Enum codes (status, reason, action) - Business rules BR-FR-CDV-*
|
|
553
554
|
|
|
554
555
|
### Examples
|
|
555
556
|
|
|
@@ -562,15 +563,15 @@ FactPulse.configure do |config|
|
|
|
562
563
|
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
563
564
|
end
|
|
564
565
|
|
|
565
|
-
api_instance = FactPulse::
|
|
566
|
+
api_instance = FactPulse::Flux6InvoiceLifecycleCDARApi.new
|
|
566
567
|
validate_cdar_request = FactPulse::ValidateCDARRequest.new # ValidateCDARRequest |
|
|
567
568
|
|
|
568
569
|
begin
|
|
569
|
-
#
|
|
570
|
+
# Validate CDAR structured data
|
|
570
571
|
result = api_instance.validate_cdar_api_v1_cdar_validate_post(validate_cdar_request)
|
|
571
572
|
p result
|
|
572
573
|
rescue FactPulse::ApiError => e
|
|
573
|
-
puts "Error when calling
|
|
574
|
+
puts "Error when calling Flux6InvoiceLifecycleCDARApi->validate_cdar_api_v1_cdar_validate_post: #{e}"
|
|
574
575
|
end
|
|
575
576
|
```
|
|
576
577
|
|
|
@@ -582,13 +583,13 @@ This returns an Array which contains the response data, status code and headers.
|
|
|
582
583
|
|
|
583
584
|
```ruby
|
|
584
585
|
begin
|
|
585
|
-
#
|
|
586
|
+
# Validate CDAR structured data
|
|
586
587
|
data, status_code, headers = api_instance.validate_cdar_api_v1_cdar_validate_post_with_http_info(validate_cdar_request)
|
|
587
588
|
p status_code # => 2xx
|
|
588
589
|
p headers # => { ... }
|
|
589
590
|
p data # => <ValidateCDARResponse>
|
|
590
591
|
rescue FactPulse::ApiError => e
|
|
591
|
-
puts "Error when calling
|
|
592
|
+
puts "Error when calling Flux6InvoiceLifecycleCDARApi->validate_cdar_api_v1_cdar_validate_post_with_http_info: #{e}"
|
|
592
593
|
end
|
|
593
594
|
```
|
|
594
595
|
|
|
@@ -611,3 +612,72 @@ end
|
|
|
611
612
|
- **Content-Type**: application/json
|
|
612
613
|
- **Accept**: application/json
|
|
613
614
|
|
|
615
|
+
|
|
616
|
+
## validate_xml_cdar_api_v1_cdar_validate_xml_post
|
|
617
|
+
|
|
618
|
+
> Hash<String, Object> validate_xml_cdar_api_v1_cdar_validate_xml_post(xml_file)
|
|
619
|
+
|
|
620
|
+
Validate CDAR XML against XSD and Schematron BR-FR-CDV
|
|
621
|
+
|
|
622
|
+
Validates a CDAR XML file against: 1. **XSD schema**: UN/CEFACT D22B CrossDomainAcknowledgementAndResponse 2. **Schematron BR-FR-CDV**: French business rules for invoice lifecycle Returns validation status and detailed error messages if invalid. **Note:** Use `/validate` to validate structured data fields (JSON).
|
|
623
|
+
|
|
624
|
+
### Examples
|
|
625
|
+
|
|
626
|
+
```ruby
|
|
627
|
+
require 'time'
|
|
628
|
+
require 'factpulse'
|
|
629
|
+
# setup authorization
|
|
630
|
+
FactPulse.configure do |config|
|
|
631
|
+
# Configure Bearer authorization: HTTPBearer
|
|
632
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
633
|
+
end
|
|
634
|
+
|
|
635
|
+
api_instance = FactPulse::Flux6InvoiceLifecycleCDARApi.new
|
|
636
|
+
xml_file = File.new('/path/to/some/file') # File | CDAR XML file to validate
|
|
637
|
+
|
|
638
|
+
begin
|
|
639
|
+
# Validate CDAR XML against XSD and Schematron BR-FR-CDV
|
|
640
|
+
result = api_instance.validate_xml_cdar_api_v1_cdar_validate_xml_post(xml_file)
|
|
641
|
+
p result
|
|
642
|
+
rescue FactPulse::ApiError => e
|
|
643
|
+
puts "Error when calling Flux6InvoiceLifecycleCDARApi->validate_xml_cdar_api_v1_cdar_validate_xml_post: #{e}"
|
|
644
|
+
end
|
|
645
|
+
```
|
|
646
|
+
|
|
647
|
+
#### Using the validate_xml_cdar_api_v1_cdar_validate_xml_post_with_http_info variant
|
|
648
|
+
|
|
649
|
+
This returns an Array which contains the response data, status code and headers.
|
|
650
|
+
|
|
651
|
+
> <Array(Hash<String, Object>, Integer, Hash)> validate_xml_cdar_api_v1_cdar_validate_xml_post_with_http_info(xml_file)
|
|
652
|
+
|
|
653
|
+
```ruby
|
|
654
|
+
begin
|
|
655
|
+
# Validate CDAR XML against XSD and Schematron BR-FR-CDV
|
|
656
|
+
data, status_code, headers = api_instance.validate_xml_cdar_api_v1_cdar_validate_xml_post_with_http_info(xml_file)
|
|
657
|
+
p status_code # => 2xx
|
|
658
|
+
p headers # => { ... }
|
|
659
|
+
p data # => Hash<String, Object>
|
|
660
|
+
rescue FactPulse::ApiError => e
|
|
661
|
+
puts "Error when calling Flux6InvoiceLifecycleCDARApi->validate_xml_cdar_api_v1_cdar_validate_xml_post_with_http_info: #{e}"
|
|
662
|
+
end
|
|
663
|
+
```
|
|
664
|
+
|
|
665
|
+
### Parameters
|
|
666
|
+
|
|
667
|
+
| Name | Type | Description | Notes |
|
|
668
|
+
| ---- | ---- | ----------- | ----- |
|
|
669
|
+
| **xml_file** | **File** | CDAR XML file to validate | |
|
|
670
|
+
|
|
671
|
+
### Return type
|
|
672
|
+
|
|
673
|
+
**Hash<String, Object>**
|
|
674
|
+
|
|
675
|
+
### Authorization
|
|
676
|
+
|
|
677
|
+
[HTTPBearer](../README.md#HTTPBearer)
|
|
678
|
+
|
|
679
|
+
### HTTP request headers
|
|
680
|
+
|
|
681
|
+
- **Content-Type**: multipart/form-data
|
|
682
|
+
- **Accept**: application/json
|
|
683
|
+
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **credentials** | [**
|
|
7
|
+
| **credentials** | [**FactureElectroniqueRestApiSchemasChorusProChorusProCredentials**](FactureElectroniqueRestApiSchemasChorusProChorusProCredentials.md) | | [optional] |
|
|
8
8
|
| **siret** | **String** | Structure SIRET (14 digits) | |
|
|
9
9
|
| **identifier_type** | **String** | Identifier type (SIRET, SIREN, UE_HORS_FRANCE, etc.) | [optional][default to 'SIRET'] |
|
|
10
10
|
|
data/docs/GetInvoiceRequest.md
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **credentials** | [**
|
|
7
|
+
| **credentials** | [**FactureElectroniqueRestApiSchemasChorusProChorusProCredentials**](FactureElectroniqueRestApiSchemasChorusProChorusProCredentials.md) | | [optional] |
|
|
8
8
|
| **chorus_invoice_id** | **Integer** | Chorus Pro invoice ID | |
|
|
9
9
|
|
|
10
10
|
## Example
|
data/docs/GetStructureRequest.md
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **credentials** | [**
|
|
7
|
+
| **credentials** | [**FactureElectroniqueRestApiSchemasChorusProChorusProCredentials**](FactureElectroniqueRestApiSchemasChorusProChorusProCredentials.md) | | [optional] |
|
|
8
8
|
| **structure_id** | **Integer** | Chorus Pro structure ID | |
|
|
9
9
|
| **language_code** | **String** | Language code (fr, en) | [optional][default to 'fr'] |
|
|
10
10
|
|
data/docs/HealthApi.md
CHANGED
|
@@ -4,10 +4,77 @@ All URIs are relative to *https://factpulse.fr*
|
|
|
4
4
|
|
|
5
5
|
| Method | HTTP request | Description |
|
|
6
6
|
| ------ | ------------ | ----------- |
|
|
7
|
+
| [**get_user_info_api_v1_me_get**](HealthApi.md#get_user_info_api_v1_me_get) | **GET** /api/v1/me | Get current user information |
|
|
7
8
|
| [**healthcheck_healthcheck_get**](HealthApi.md#healthcheck_healthcheck_get) | **GET** /healthcheck | Docker healthcheck endpoint |
|
|
8
9
|
| [**root_get**](HealthApi.md#root_get) | **GET** / | Check API status |
|
|
9
10
|
|
|
10
11
|
|
|
12
|
+
## get_user_info_api_v1_me_get
|
|
13
|
+
|
|
14
|
+
> Object get_user_info_api_v1_me_get
|
|
15
|
+
|
|
16
|
+
Get current user information
|
|
17
|
+
|
|
18
|
+
Returns information about the authenticated user. This endpoint allows you to: - Verify that authentication works - Get connected account details - Test JWT token validity - Check your consumption quota **Requires valid authentication.**
|
|
19
|
+
|
|
20
|
+
### Examples
|
|
21
|
+
|
|
22
|
+
```ruby
|
|
23
|
+
require 'time'
|
|
24
|
+
require 'factpulse'
|
|
25
|
+
# setup authorization
|
|
26
|
+
FactPulse.configure do |config|
|
|
27
|
+
# Configure Bearer authorization: HTTPBearer
|
|
28
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
29
|
+
end
|
|
30
|
+
|
|
31
|
+
api_instance = FactPulse::HealthApi.new
|
|
32
|
+
|
|
33
|
+
begin
|
|
34
|
+
# Get current user information
|
|
35
|
+
result = api_instance.get_user_info_api_v1_me_get
|
|
36
|
+
p result
|
|
37
|
+
rescue FactPulse::ApiError => e
|
|
38
|
+
puts "Error when calling HealthApi->get_user_info_api_v1_me_get: #{e}"
|
|
39
|
+
end
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
#### Using the get_user_info_api_v1_me_get_with_http_info variant
|
|
43
|
+
|
|
44
|
+
This returns an Array which contains the response data, status code and headers.
|
|
45
|
+
|
|
46
|
+
> <Array(Object, Integer, Hash)> get_user_info_api_v1_me_get_with_http_info
|
|
47
|
+
|
|
48
|
+
```ruby
|
|
49
|
+
begin
|
|
50
|
+
# Get current user information
|
|
51
|
+
data, status_code, headers = api_instance.get_user_info_api_v1_me_get_with_http_info
|
|
52
|
+
p status_code # => 2xx
|
|
53
|
+
p headers # => { ... }
|
|
54
|
+
p data # => Object
|
|
55
|
+
rescue FactPulse::ApiError => e
|
|
56
|
+
puts "Error when calling HealthApi->get_user_info_api_v1_me_get_with_http_info: #{e}"
|
|
57
|
+
end
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
### Parameters
|
|
61
|
+
|
|
62
|
+
This endpoint does not need any parameter.
|
|
63
|
+
|
|
64
|
+
### Return type
|
|
65
|
+
|
|
66
|
+
**Object**
|
|
67
|
+
|
|
68
|
+
### Authorization
|
|
69
|
+
|
|
70
|
+
[HTTPBearer](../README.md#HTTPBearer)
|
|
71
|
+
|
|
72
|
+
### HTTP request headers
|
|
73
|
+
|
|
74
|
+
- **Content-Type**: Not defined
|
|
75
|
+
- **Accept**: application/json
|
|
76
|
+
|
|
77
|
+
|
|
11
78
|
## healthcheck_healthcheck_get
|
|
12
79
|
|
|
13
80
|
> Object healthcheck_healthcheck_get
|