factpulse 3.0.9 → 3.0.13
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +3 -3
- data/Gemfile.lock +3 -3
- data/LICENSE +1 -1
- data/docs/AFNORAcknowledgement.md +20 -0
- data/docs/AFNORAcknowledgementDetail.md +24 -0
- data/docs/AFNORAddressEdit.md +30 -0
- data/docs/AFNORAddressPatch.md +30 -0
- data/docs/AFNORAddressPut.md +30 -0
- data/docs/AFNORAddressRead.md +32 -0
- data/docs/{ValidationErrorLocInner.md → AFNORAlgorithm.md} +2 -2
- data/docs/AFNORContainsOperator.md +15 -0
- data/docs/AFNORCreateDirectoryLineBody.md +20 -0
- data/docs/AFNORCreateDirectoryLineBodyAddressingInformation.md +24 -0
- data/docs/AFNORCreateDirectoryLineBodyPeriod.md +20 -0
- data/docs/AFNORCreateRoutingCodeBody.md +32 -0
- data/docs/AFNORDestination.md +4 -2
- data/docs/AFNORDiffusionStatus.md +15 -0
- data/docs/AFNORDirectoryLineField.md +15 -0
- data/docs/AFNORDirectoryLinePayloadHistoryLegalUnitFacilityRoutingCode.md +32 -0
- data/docs/AFNORDirectoryLinePayloadHistoryLegalUnitFacilityRoutingCodePlatform.md +20 -0
- data/docs/AFNORDirectoryLinePayloadHistoryLegalUnitFacilityRoutingCodeRoutingCode.md +28 -0
- data/docs/AFNORDirectoryLinePost201Response.md +22 -0
- data/docs/AFNORDirectoryLineSearchPost200Response.md +22 -0
- data/docs/AFNOREntityType.md +15 -0
- data/docs/AFNORError.md +26 -0
- data/docs/AFNORFacilityAdministrativeStatus.md +15 -0
- data/docs/AFNORFacilityNature.md +15 -0
- data/docs/AFNORFacilityPayloadHistory.md +34 -0
- data/docs/AFNORFacilityPayloadHistoryUleB2gAdditionalData.md +28 -0
- data/docs/AFNORFacilityPayloadIncluded.md +32 -0
- data/docs/AFNORFacilityType.md +15 -0
- data/docs/AFNORFlow.md +38 -0
- data/docs/AFNORFlowAckStatus.md +15 -0
- data/docs/AFNORFlowDirection.md +15 -0
- data/docs/AFNORFlowInfo.md +28 -0
- data/docs/AFNORFlowProfile.md +15 -0
- data/docs/AFNORFlowSyntax.md +15 -0
- data/docs/AFNORFlowType.md +15 -0
- data/docs/AFNORFullFlowInfo.md +32 -0
- data/docs/AFNORLegalUnitAdministrativeStatus.md +15 -0
- data/docs/AFNORLegalUnitPayloadHistory.md +24 -0
- data/docs/AFNORLegalUnitPayloadIncluded.md +24 -0
- data/docs/AFNORLegalUnitPayloadIncludedNoSiren.md +22 -0
- data/docs/AFNORPDPPAApi.md +5 -5
- data/docs/AFNORPDPPADirectoryServiceApi.md +278 -178
- data/docs/AFNORPDPPAFlowServiceApi.md +39 -27
- data/docs/AFNORPlatformStatus.md +15 -0
- data/docs/AFNORProcessingRule.md +15 -0
- data/docs/AFNORReasonCode.md +49 -0
- data/docs/AFNORReasonCodeEnum.md +15 -0
- data/docs/AFNORRecipientPlatformType.md +15 -0
- data/docs/AFNORResult.md +7 -1
- data/docs/AFNORRoutingCodeAdministrativeStatus.md +15 -0
- data/docs/AFNORRoutingCodeField.md +15 -0
- data/docs/AFNORRoutingCodePayloadHistoryLegalUnitFacility.md +34 -0
- data/docs/AFNORRoutingCodePost201Response.md +22 -0
- data/docs/AFNORRoutingCodeSearch.md +28 -0
- data/docs/AFNORRoutingCodeSearchFilters.md +30 -0
- data/docs/AFNORRoutingCodeSearchFiltersAdministrativeStatus.md +20 -0
- data/docs/AFNORRoutingCodeSearchFiltersRoutingCodeName.md +20 -0
- data/docs/AFNORRoutingCodeSearchFiltersRoutingIdentifier.md +20 -0
- data/docs/AFNORRoutingCodeSearchPost200Response.md +22 -0
- data/docs/AFNORRoutingCodeSearchSortingInner.md +20 -0
- data/docs/AFNORSearchDirectoryLine.md +26 -0
- data/docs/AFNORSearchDirectoryLineFilters.md +26 -0
- data/docs/AFNORSearchDirectoryLineFiltersAddressingIdentifier.md +20 -0
- data/docs/AFNORSearchDirectoryLineFiltersAddressingSuffix.md +20 -0
- data/docs/AFNORSearchDirectoryLineSortingInner.md +20 -0
- data/docs/AFNORSearchFlowContent.md +22 -0
- data/docs/AFNORSearchFlowFilters.md +30 -0
- data/docs/AFNORSearchFlowParams.md +20 -0
- data/docs/AFNORSearchSiren.md +26 -0
- data/docs/AFNORSearchSirenFilters.md +24 -0
- data/docs/AFNORSearchSirenFiltersAdministrativeStatus.md +20 -0
- data/docs/AFNORSearchSirenFiltersBusinessName.md +20 -0
- data/docs/AFNORSearchSirenFiltersEntityType.md +20 -0
- data/docs/AFNORSearchSirenFiltersSiren.md +20 -0
- data/docs/AFNORSearchSirenSortingInner.md +20 -0
- data/docs/AFNORSearchSiret.md +28 -0
- data/docs/AFNORSearchSiretFilters.md +34 -0
- data/docs/AFNORSearchSiretFiltersAddressLines.md +20 -0
- data/docs/AFNORSearchSiretFiltersAdministrativeStatus.md +20 -0
- data/docs/AFNORSearchSiretFiltersCountrySubdivision.md +20 -0
- data/docs/AFNORSearchSiretFiltersFacilityType.md +20 -0
- data/docs/AFNORSearchSiretFiltersLocality.md +20 -0
- data/docs/AFNORSearchSiretFiltersName.md +20 -0
- data/docs/AFNORSearchSiretFiltersPostalCode.md +20 -0
- data/docs/AFNORSearchSiretFiltersSiret.md +20 -0
- data/docs/AFNORSearchSiretSortingInner.md +20 -0
- data/docs/AFNORSirenField.md +15 -0
- data/docs/AFNORSirenSearchPost200Response.md +22 -0
- data/docs/AFNORSiretField.md +15 -0
- data/docs/AFNORSiretSearchPost200Response.md +22 -0
- data/docs/AFNORSortingOrder.md +15 -0
- data/docs/AFNORStrictOperator.md +15 -0
- data/docs/AFNORUpdatePatchDirectoryLineBody.md +18 -0
- data/docs/AFNORUpdatePatchRoutingCodeBody.md +24 -0
- data/docs/AFNORUpdatePutRoutingCodeBody.md +24 -0
- data/docs/AFNORWebhookCallbackContent.md +18 -0
- data/docs/AcceptLanguage.md +15 -0
- data/docs/AggregatedPaymentInput.md +22 -0
- data/docs/AggregatedTransactionInput.md +32 -0
- data/docs/AllowanceCharge.md +3 -3
- data/docs/AllowanceChargeReasonCode.md +15 -0
- data/docs/Amount1.md +15 -0
- data/docs/Buyercountry.md +15 -0
- data/docs/ChorusProApi.md +5 -3
- data/docs/{FactureElectroniqueRestApiSchemasChorusProChorusProCredentials.md → ChorusProCredentials.md} +2 -2
- data/docs/ConvertValidationFailedResponse.md +5 -5
- data/docs/CountryCode.md +15 -0
- data/docs/CreateAggregatedReportRequest.md +34 -0
- data/docs/CreateEReportingRequest.md +36 -0
- data/docs/Currency.md +15 -0
- data/docs/CurrencyCode.md +15 -0
- data/docs/DirectoryLineInclude.md +15 -0
- data/docs/DocType.md +15 -0
- data/docs/DocumentConversionApi.md +12 -86
- data/docs/DownloadsApi.md +295 -0
- data/docs/EReportingApi.md +782 -0
- data/docs/EReportingFlowType.md +15 -0
- data/docs/ElectronicAddress.md +2 -2
- data/docs/EnrichedInvoiceInfo.md +6 -6
- data/docs/FactureElectroniqueModelsInvoiceTypeCode.md +15 -0
- data/docs/FactureElectroniqueRestApiSchemasConvertValidationError.md +32 -0
- data/docs/FlowSummary.md +2 -2
- data/docs/GenerateAggregatedReportResponse.md +30 -0
- data/docs/GenerateEReportingResponse.md +26 -0
- data/docs/GetChorusProIdRequest.md +1 -1
- data/docs/GetInvoiceRequest.md +1 -1
- data/docs/GetInvoiceResponse.md +2 -2
- data/docs/GetStructureRequest.md +1 -1
- data/docs/GetStructureResponse.md +2 -2
- data/docs/HealthApi.md +1 -1
- data/docs/IncomingInvoice.md +1 -1
- data/docs/InvoiceInput.md +48 -0
- data/docs/InvoiceLine.md +4 -0
- data/docs/InvoiceNote.md +1 -1
- data/docs/InvoicePaymentInput.md +26 -0
- data/docs/InvoiceProcessingApi.md +41 -17
- data/docs/InvoiceTypeCodeOutput.md +15 -0
- data/docs/InvoicingFramework.md +1 -1
- data/docs/LineSubType.md +15 -0
- data/docs/LocationInner.md +15 -0
- data/docs/PDFXMLVerificationApi.md +17 -9
- data/docs/PaymentAmountByRate.md +20 -0
- data/docs/ProcessingRule.md +15 -0
- data/docs/Rate.md +15 -0
- data/docs/Rate1.md +15 -0
- data/docs/ReportPeriod.md +20 -0
- data/docs/ReportSender.md +22 -0
- data/docs/RoutingCodeInclude.md +15 -0
- data/docs/SearchServicesResponse.md +3 -3
- data/docs/SearchStructureRequest.md +1 -1
- data/docs/Sellercountry.md +15 -0
- data/docs/SimplifiedInvoiceData.md +9 -1
- data/docs/SiretInclude.md +15 -0
- data/docs/SubmitAggregatedReportRequest.md +28 -0
- data/docs/SubmitEReportingRequest.md +28 -0
- data/docs/SubmitEReportingResponse.md +32 -0
- data/docs/SubmitInvoiceRequest.md +1 -1
- data/docs/SupplementaryAttachment.md +5 -5
- data/docs/TaxBreakdownInput.md +22 -0
- data/docs/TaxDueDateType.md +15 -0
- data/docs/Taxableamount.md +15 -0
- data/docs/Taxamount.md +15 -0
- data/docs/Taxamount1.md +15 -0
- data/docs/Taxamount2.md +15 -0
- data/docs/Taxexclusiveamount.md +15 -0
- data/docs/Taxexclusiveamount1.md +15 -0
- data/docs/TransactionCategory.md +15 -0
- data/docs/TransmissionTypeCode.md +15 -0
- data/docs/UserApi.md +1 -1
- data/docs/ValidateEReportingRequest.md +18 -0
- data/docs/ValidateEReportingResponse.md +28 -0
- data/docs/ValidationError.md +1 -1
- data/docs/ValidationInfo.md +1 -1
- data/factpulse.gemspec +4 -4
- data/lib/factpulse/api/afnorpdppa_api.rb +6 -6
- data/lib/factpulse/api/afnorpdppa_directory_service_api.rb +210 -123
- data/lib/factpulse/api/afnorpdppa_flow_service_api.rb +57 -24
- data/lib/factpulse/api/chorus_pro_api.rb +6 -4
- data/lib/factpulse/api/document_conversion_api.rb +13 -85
- data/lib/factpulse/api/downloads_api.rb +280 -0
- data/lib/factpulse/api/e_reporting_api.rb +774 -0
- data/lib/factpulse/api/health_api.rb +2 -2
- data/lib/factpulse/api/invoice_processing_api.rb +47 -14
- data/lib/factpulse/api/pdfxml_verification_api.rb +22 -10
- data/lib/factpulse/api/user_api.rb +2 -2
- data/lib/factpulse/api_client.rb +2 -2
- data/lib/factpulse/api_error.rb +2 -2
- data/lib/factpulse/api_model_base.rb +2 -2
- data/lib/factpulse/configuration.rb +10 -6
- data/lib/factpulse/models/accept_language.rb +40 -0
- data/lib/factpulse/models/acknowledgment_status.rb +2 -2
- data/lib/factpulse/models/additional_document.rb +2 -2
- data/lib/factpulse/models/afnor_acknowledgement.rb +216 -0
- data/lib/factpulse/models/afnor_acknowledgement_detail.rb +267 -0
- data/lib/factpulse/models/afnor_address_edit.rb +353 -0
- data/lib/factpulse/models/afnor_address_patch.rb +386 -0
- data/lib/factpulse/models/afnor_address_put.rb +435 -0
- data/lib/factpulse/models/afnor_address_read.rb +382 -0
- data/lib/factpulse/models/afnor_algorithm.rb +43 -0
- data/lib/factpulse/models/afnor_contains_operator.rb +39 -0
- data/lib/factpulse/models/afnor_create_directory_line_body.rb +156 -0
- data/lib/factpulse/models/afnor_create_directory_line_body_addressing_information.rb +294 -0
- data/lib/factpulse/models/afnor_create_directory_line_body_period.rb +175 -0
- data/lib/factpulse/models/afnor_create_routing_code_body.rb +412 -0
- data/lib/factpulse/models/afnor_credentials.rb +2 -2
- data/lib/factpulse/models/afnor_destination.rb +19 -23
- data/lib/factpulse/models/afnor_diffusion_status.rb +40 -0
- data/lib/factpulse/models/afnor_directory_line_field.rb +44 -0
- data/lib/factpulse/models/afnor_directory_line_payload_history_legal_unit_facility_routing_code.rb +312 -0
- data/lib/factpulse/models/afnor_directory_line_payload_history_legal_unit_facility_routing_code_platform.rb +178 -0
- data/lib/factpulse/models/afnor_directory_line_payload_history_legal_unit_facility_routing_code_routing_code.rb +308 -0
- data/lib/factpulse/models/afnor_directory_line_post201_response.rb +187 -0
- data/lib/factpulse/models/afnor_directory_line_search_post200_response.rb +168 -0
- data/lib/factpulse/models/afnor_entity_type.rb +40 -0
- data/lib/factpulse/models/{convert_error_response.rb → afnor_error.rb} +51 -61
- data/lib/factpulse/models/afnor_facility_administrative_status.rb +40 -0
- data/lib/factpulse/models/afnor_facility_nature.rb +40 -0
- data/lib/factpulse/models/afnor_facility_payload_history.rb +323 -0
- data/lib/factpulse/models/afnor_facility_payload_history_ule_b2g_additional_data.rb +198 -0
- data/lib/factpulse/models/afnor_facility_payload_included.rb +314 -0
- data/lib/factpulse/models/afnor_facility_type.rb +40 -0
- data/lib/factpulse/models/afnor_flow.rb +315 -0
- data/lib/factpulse/models/afnor_flow_ack_status.rb +41 -0
- data/lib/factpulse/models/afnor_flow_direction.rb +40 -0
- data/lib/factpulse/models/afnor_flow_info.rb +293 -0
- data/lib/factpulse/models/afnor_flow_profile.rb +41 -0
- data/lib/factpulse/models/afnor_flow_syntax.rb +43 -0
- data/lib/factpulse/models/afnor_flow_type.rb +51 -0
- data/lib/factpulse/models/afnor_full_flow_info.rb +339 -0
- data/lib/factpulse/models/afnor_health_check_response.rb +2 -2
- data/lib/factpulse/models/afnor_legal_unit_administrative_status.rb +40 -0
- data/lib/factpulse/models/afnor_legal_unit_payload_history.rb +247 -0
- data/lib/factpulse/models/afnor_legal_unit_payload_included.rb +247 -0
- data/lib/factpulse/models/afnor_legal_unit_payload_included_no_siren.rb +207 -0
- data/lib/factpulse/models/afnor_platform_status.rb +40 -0
- data/lib/factpulse/models/afnor_processing_rule.rb +44 -0
- data/lib/factpulse/models/afnor_reason_code.rb +105 -0
- data/lib/factpulse/models/afnor_reason_code_enum.rb +53 -0
- data/lib/factpulse/models/afnor_recipient_platform_type.rb +40 -0
- data/lib/factpulse/models/afnor_result.rb +37 -7
- data/lib/factpulse/models/afnor_routing_code_administrative_status.rb +40 -0
- data/lib/factpulse/models/afnor_routing_code_field.rb +46 -0
- data/lib/factpulse/models/afnor_routing_code_payload_history_legal_unit_facility.rb +366 -0
- data/lib/factpulse/models/afnor_routing_code_post201_response.rb +228 -0
- data/lib/factpulse/models/afnor_routing_code_search.rb +224 -0
- data/lib/factpulse/models/afnor_routing_code_search_filters.rb +201 -0
- data/lib/factpulse/models/afnor_routing_code_search_filters_administrative_status.rb +178 -0
- data/lib/factpulse/models/afnor_routing_code_search_filters_routing_code_name.rb +209 -0
- data/lib/factpulse/models/afnor_routing_code_search_filters_routing_identifier.rb +209 -0
- data/lib/factpulse/models/afnor_routing_code_search_post200_response.rb +168 -0
- data/lib/factpulse/models/afnor_routing_code_search_sorting_inner.rb +179 -0
- data/lib/factpulse/models/afnor_search_directory_line.rb +191 -0
- data/lib/factpulse/models/afnor_search_directory_line_filters.rb +183 -0
- data/lib/factpulse/models/afnor_search_directory_line_filters_addressing_identifier.rb +198 -0
- data/lib/factpulse/models/afnor_search_directory_line_filters_addressing_suffix.rb +198 -0
- data/lib/factpulse/models/afnor_search_directory_line_sorting_inner.rb +179 -0
- data/lib/factpulse/models/afnor_search_flow_content.rb +168 -0
- data/lib/factpulse/models/afnor_search_flow_filters.rb +250 -0
- data/lib/factpulse/models/afnor_search_flow_params.rb +195 -0
- data/lib/factpulse/models/afnor_search_siren.rb +191 -0
- data/lib/factpulse/models/afnor_search_siren_filters.rb +174 -0
- data/lib/factpulse/models/afnor_search_siren_filters_administrative_status.rb +178 -0
- data/lib/factpulse/models/afnor_search_siren_filters_business_name.rb +198 -0
- data/lib/factpulse/models/afnor_search_siren_filters_entity_type.rb +178 -0
- data/lib/factpulse/models/afnor_search_siren_filters_siren.rb +209 -0
- data/lib/factpulse/models/afnor_search_siren_sorting_inner.rb +179 -0
- data/lib/factpulse/models/afnor_search_siret.rb +224 -0
- data/lib/factpulse/models/afnor_search_siret_filters.rb +219 -0
- data/lib/factpulse/models/afnor_search_siret_filters_address_lines.rb +198 -0
- data/lib/factpulse/models/afnor_search_siret_filters_administrative_status.rb +178 -0
- data/lib/factpulse/models/afnor_search_siret_filters_country_subdivision.rb +198 -0
- data/lib/factpulse/models/afnor_search_siret_filters_facility_type.rb +178 -0
- data/lib/factpulse/models/afnor_search_siret_filters_locality.rb +198 -0
- data/lib/factpulse/models/afnor_search_siret_filters_name.rb +198 -0
- data/lib/factpulse/models/afnor_search_siret_filters_postal_code.rb +209 -0
- data/lib/factpulse/models/afnor_search_siret_filters_siret.rb +209 -0
- data/lib/factpulse/models/afnor_search_siret_sorting_inner.rb +179 -0
- data/lib/factpulse/models/afnor_siren_field.rb +43 -0
- data/lib/factpulse/models/afnor_siren_search_post200_response.rb +168 -0
- data/lib/factpulse/models/afnor_siret_field.rb +52 -0
- data/lib/factpulse/models/afnor_siret_search_post200_response.rb +168 -0
- data/lib/factpulse/models/afnor_sorting_order.rb +40 -0
- data/lib/factpulse/models/afnor_strict_operator.rb +39 -0
- data/lib/factpulse/models/afnor_update_patch_directory_line_body.rb +148 -0
- data/lib/factpulse/models/afnor_update_patch_routing_code_body.rb +258 -0
- data/lib/factpulse/models/afnor_update_put_routing_code_body.rb +289 -0
- data/lib/factpulse/models/afnor_webhook_callback_content.rb +148 -0
- data/lib/factpulse/models/aggregated_payment_input.rb +213 -0
- data/lib/factpulse/models/aggregated_transaction_input.rb +349 -0
- data/lib/factpulse/models/allowance_charge.rb +27 -5
- data/lib/factpulse/models/allowance_charge_reason_code.rb +76 -0
- data/lib/factpulse/models/allowance_reason_code.rb +2 -2
- data/lib/factpulse/models/allowance_total_amount.rb +2 -2
- data/lib/factpulse/models/amount.rb +3 -3
- data/lib/factpulse/models/amount1.rb +104 -0
- data/lib/factpulse/models/amount_due.rb +2 -2
- data/lib/factpulse/models/api_error.rb +2 -2
- data/lib/factpulse/models/api_profile.rb +4 -3
- data/lib/factpulse/models/async_task_status.rb +2 -2
- data/lib/factpulse/models/base_amount.rb +2 -2
- data/lib/factpulse/models/bounding_box_schema.rb +2 -2
- data/lib/factpulse/models/buyercountry.rb +104 -0
- data/lib/factpulse/models/celery_status.rb +2 -2
- data/lib/factpulse/models/certificate_info_response.rb +2 -2
- data/lib/factpulse/models/charge_total_amount.rb +2 -2
- data/lib/factpulse/models/{facture_electronique_rest_api_schemas_chorus_pro_chorus_pro_credentials.rb → chorus_pro_credentials.rb} +5 -5
- data/lib/factpulse/models/chorus_pro_destination.rb +2 -2
- data/lib/factpulse/models/chorus_pro_result.rb +2 -2
- data/lib/factpulse/models/contact.rb +2 -2
- data/lib/factpulse/models/convert_resume_request.rb +2 -2
- data/lib/factpulse/models/convert_success_response.rb +2 -2
- data/lib/factpulse/models/convert_validation_failed_response.rb +7 -2
- data/lib/factpulse/models/country_code.rb +208 -0
- data/lib/factpulse/models/create_aggregated_report_request.rb +310 -0
- data/lib/factpulse/models/create_e_reporting_request.rb +337 -0
- data/lib/factpulse/models/currency.rb +104 -0
- data/lib/factpulse/models/currency_code.rb +91 -0
- data/lib/factpulse/models/delivery_party.rb +2 -2
- data/lib/factpulse/models/destination.rb +2 -2
- data/lib/factpulse/models/directory_line_include.rb +42 -0
- data/lib/factpulse/models/doc_type.rb +42 -0
- data/lib/factpulse/models/document_type_info.rb +2 -2
- data/lib/factpulse/models/e_reporting_flow_type.rb +42 -0
- data/lib/factpulse/models/electronic_address.rb +4 -2
- data/lib/factpulse/models/enriched_invoice_info.rb +8 -2
- data/lib/factpulse/models/error_level.rb +2 -2
- data/lib/factpulse/models/error_source.rb +2 -2
- data/lib/factpulse/models/extraction_info.rb +2 -2
- data/lib/factpulse/models/factur_x_invoice.rb +2 -2
- data/lib/factpulse/models/factur_xpdf_info.rb +2 -2
- data/lib/factpulse/models/facture_electronique_models_invoice_type_code.rb +54 -0
- data/lib/factpulse/models/facture_electronique_rest_api_schemas_convert_validation_error.rb +294 -0
- data/lib/factpulse/models/facture_electronique_rest_api_schemas_processing_chorus_pro_credentials.rb +2 -2
- data/lib/factpulse/models/field_status.rb +2 -2
- data/lib/factpulse/models/file_info.rb +2 -2
- data/lib/factpulse/models/files_info.rb +2 -2
- data/lib/factpulse/models/flow_direction.rb +2 -2
- data/lib/factpulse/models/flow_profile.rb +2 -2
- data/lib/factpulse/models/flow_summary.rb +4 -2
- data/lib/factpulse/models/flow_syntax.rb +2 -2
- data/lib/factpulse/models/flow_type.rb +12 -4
- data/lib/factpulse/models/generate_aggregated_report_response.rb +330 -0
- data/lib/factpulse/models/generate_certificate_request.rb +2 -2
- data/lib/factpulse/models/generate_certificate_response.rb +2 -2
- data/lib/factpulse/models/generate_e_reporting_response.rb +274 -0
- data/lib/factpulse/models/get_chorus_pro_id_request.rb +3 -3
- data/lib/factpulse/models/get_chorus_pro_id_response.rb +2 -2
- data/lib/factpulse/models/get_invoice_request.rb +3 -3
- data/lib/factpulse/models/get_invoice_response.rb +4 -2
- data/lib/factpulse/models/get_structure_request.rb +3 -3
- data/lib/factpulse/models/get_structure_response.rb +4 -2
- data/lib/factpulse/models/global_allowance_amount.rb +2 -2
- data/lib/factpulse/models/gross_unit_price.rb +2 -2
- data/lib/factpulse/models/http_validation_error.rb +2 -2
- data/lib/factpulse/models/incoming_invoice.rb +3 -36
- data/lib/factpulse/models/incoming_supplier.rb +2 -2
- data/lib/factpulse/models/invoice_format.rb +2 -2
- data/lib/factpulse/models/invoice_input.rb +446 -0
- data/lib/factpulse/models/invoice_line.rb +23 -3
- data/lib/factpulse/models/invoice_line_allowance_amount.rb +2 -2
- data/lib/factpulse/models/invoice_note.rb +3 -2
- data/lib/factpulse/models/invoice_payment_input.rb +267 -0
- data/lib/factpulse/models/invoice_references.rb +2 -2
- data/lib/factpulse/models/invoice_status.rb +2 -2
- data/lib/factpulse/models/invoice_totals.rb +2 -2
- data/lib/factpulse/models/invoice_totals_prepayment.rb +2 -2
- data/lib/factpulse/models/invoice_type_code.rb +8 -19
- data/lib/factpulse/models/invoice_type_code_output.rb +54 -0
- data/lib/factpulse/models/invoicing_framework.rb +3 -2
- data/lib/factpulse/models/invoicing_framework_code.rb +2 -2
- data/lib/factpulse/models/line_net_amount.rb +2 -2
- data/lib/factpulse/models/line_sub_type.rb +41 -0
- data/lib/factpulse/models/line_total_amount.rb +2 -2
- data/lib/factpulse/models/{validation_error_loc_inner.rb → location_inner.rb} +3 -3
- data/lib/factpulse/models/mandatory_note_schema.rb +2 -2
- data/lib/factpulse/models/manual_rate.rb +2 -2
- data/lib/factpulse/models/manual_vat_rate.rb +2 -2
- data/lib/factpulse/models/missing_field.rb +2 -2
- data/lib/factpulse/models/operation_nature.rb +2 -2
- data/lib/factpulse/models/output_format.rb +2 -2
- data/lib/factpulse/models/page_dimensions_schema.rb +2 -2
- data/lib/factpulse/models/payee.rb +2 -2
- data/lib/factpulse/models/payment_amount_by_rate.rb +191 -0
- data/lib/factpulse/models/payment_card.rb +2 -2
- data/lib/factpulse/models/payment_means.rb +2 -2
- data/lib/factpulse/models/pdf_validation_result_api.rb +2 -2
- data/lib/factpulse/models/pdp_credentials.rb +2 -2
- data/lib/factpulse/models/percentage.rb +2 -2
- data/lib/factpulse/models/postal_address.rb +2 -2
- data/lib/factpulse/models/price_allowance_amount.rb +2 -2
- data/lib/factpulse/models/price_basis_quantity.rb +2 -2
- data/lib/factpulse/models/processing_options.rb +2 -2
- data/lib/factpulse/models/processing_rule.rb +44 -0
- data/lib/factpulse/models/product_characteristic.rb +2 -2
- data/lib/factpulse/models/product_classification.rb +2 -2
- data/lib/factpulse/models/quantity.rb +2 -2
- data/lib/factpulse/models/rate.rb +104 -0
- data/lib/factpulse/models/rate1.rb +104 -0
- data/lib/factpulse/models/recipient.rb +2 -2
- data/lib/factpulse/models/report_period.rb +193 -0
- data/lib/factpulse/models/report_sender.rb +221 -0
- data/lib/factpulse/models/rounding_amount.rb +2 -2
- data/lib/factpulse/models/routing_code_include.rb +40 -0
- data/lib/factpulse/models/scheme_id.rb +10 -3
- data/lib/factpulse/models/search_flow_request.rb +2 -2
- data/lib/factpulse/models/search_flow_response.rb +2 -2
- data/lib/factpulse/models/search_services_response.rb +5 -2
- data/lib/factpulse/models/search_structure_request.rb +3 -3
- data/lib/factpulse/models/search_structure_response.rb +2 -2
- data/lib/factpulse/models/sellercountry.rb +104 -0
- data/lib/factpulse/models/signature_info.rb +2 -2
- data/lib/factpulse/models/signature_info_api.rb +2 -2
- data/lib/factpulse/models/signature_parameters.rb +2 -2
- data/lib/factpulse/models/simplified_invoice_data.rb +69 -7
- data/lib/factpulse/models/siret_include.rb +39 -0
- data/lib/factpulse/models/structure_info.rb +2 -2
- data/lib/factpulse/models/structure_parameters.rb +2 -2
- data/lib/factpulse/models/structure_service.rb +2 -2
- data/lib/factpulse/models/submission_mode.rb +2 -2
- data/lib/factpulse/models/submit_aggregated_report_request.rb +216 -0
- data/lib/factpulse/models/submit_complete_invoice_request.rb +2 -2
- data/lib/factpulse/models/submit_complete_invoice_response.rb +2 -2
- data/lib/factpulse/models/submit_e_reporting_request.rb +216 -0
- data/lib/factpulse/models/submit_e_reporting_response.rb +306 -0
- data/lib/factpulse/models/submit_flow_request.rb +2 -2
- data/lib/factpulse/models/submit_flow_response.rb +2 -2
- data/lib/factpulse/models/submit_gross_amount.rb +2 -2
- data/lib/factpulse/models/submit_invoice_request.rb +3 -3
- data/lib/factpulse/models/submit_invoice_response.rb +2 -2
- data/lib/factpulse/models/submit_net_amount.rb +2 -2
- data/lib/factpulse/models/submit_vat_amount.rb +2 -2
- data/lib/factpulse/models/supplementary_attachment.rb +7 -2
- data/lib/factpulse/models/supplier.rb +2 -2
- data/lib/factpulse/models/task_response.rb +2 -2
- data/lib/factpulse/models/tax_breakdown_input.rb +217 -0
- data/lib/factpulse/models/tax_due_date_type.rb +44 -0
- data/lib/factpulse/models/tax_representative.rb +2 -2
- data/lib/factpulse/models/taxable_amount.rb +2 -2
- data/lib/factpulse/models/taxableamount0.rb +104 -0
- data/lib/factpulse/models/taxamount.rb +104 -0
- data/lib/factpulse/models/taxamount1.rb +104 -0
- data/lib/factpulse/models/taxamount2.rb +104 -0
- data/lib/factpulse/models/taxexclusiveamount.rb +104 -0
- data/lib/factpulse/models/taxexclusiveamount1.rb +104 -0
- data/lib/factpulse/models/total_gross_amount.rb +2 -2
- data/lib/factpulse/models/total_net_amount.rb +2 -2
- data/lib/factpulse/models/total_vat_amount.rb +2 -2
- data/lib/factpulse/models/transaction_category.rb +42 -0
- data/lib/factpulse/models/transmission_type_code.rb +40 -0
- data/lib/factpulse/models/unit_net_price.rb +2 -2
- data/lib/factpulse/models/unit_of_measure.rb +2 -2
- data/lib/factpulse/models/validate_e_reporting_request.rb +166 -0
- data/lib/factpulse/models/validate_e_reporting_response.rb +271 -0
- data/lib/factpulse/models/validation_error.rb +3 -3
- data/lib/factpulse/models/validation_error_detail.rb +2 -2
- data/lib/factpulse/models/validation_error_response.rb +2 -2
- data/lib/factpulse/models/validation_info.rb +3 -3
- data/lib/factpulse/models/validation_success_response.rb +2 -2
- data/lib/factpulse/models/vat_accounting_code.rb +2 -2
- data/lib/factpulse/models/vat_amount.rb +2 -2
- data/lib/factpulse/models/vat_category.rb +2 -2
- data/lib/factpulse/models/vat_line.rb +2 -2
- data/lib/factpulse/models/vat_point_date_code.rb +2 -2
- data/lib/factpulse/models/vat_rate.rb +2 -2
- data/lib/factpulse/models/verification_success_response.rb +2 -2
- data/lib/factpulse/models/verified_field_schema.rb +2 -2
- data/lib/factpulse/version.rb +3 -3
- data/lib/factpulse.rb +143 -6
- metadata +291 -17
- data/docs/ConvertErrorResponse.md +0 -26
- data/docs/ConvertPendingInputResponse.md +0 -32
- data/lib/factpulse/models/convert_pending_input_response.rb +0 -322
|
@@ -0,0 +1,782 @@
|
|
|
1
|
+
# FactPulse::EReportingApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://factpulse.fr*
|
|
4
|
+
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
| ------ | ------------ | ----------- |
|
|
7
|
+
| [**generate_aggregated_ereporting_api_v1_ereporting_generate_aggregated_post**](EReportingApi.md#generate_aggregated_ereporting_api_v1_ereporting_generate_aggregated_post) | **POST** /api/v1/ereporting/generate-aggregated | Generate aggregated e-reporting XML (PPF-compliant) |
|
|
8
|
+
| [**generate_ereporting_api_v1_ereporting_generate_post**](EReportingApi.md#generate_ereporting_api_v1_ereporting_generate_post) | **POST** /api/v1/ereporting/generate | Generate e-reporting XML |
|
|
9
|
+
| [**generate_ereporting_download_api_v1_ereporting_generate_download_post**](EReportingApi.md#generate_ereporting_download_api_v1_ereporting_generate_download_post) | **POST** /api/v1/ereporting/generate/download | Generate and download e-reporting XML |
|
|
10
|
+
| [**list_category_codes_api_v1_ereporting_category_codes_get**](EReportingApi.md#list_category_codes_api_v1_ereporting_category_codes_get) | **GET** /api/v1/ereporting/category-codes | List PPF-compliant category codes |
|
|
11
|
+
| [**list_flow_types_api_v1_ereporting_flow_types_get**](EReportingApi.md#list_flow_types_api_v1_ereporting_flow_types_get) | **GET** /api/v1/ereporting/flow-types | List available flow types |
|
|
12
|
+
| [**submit_aggregated_ereporting_api_v1_ereporting_submit_aggregated_post**](EReportingApi.md#submit_aggregated_ereporting_api_v1_ereporting_submit_aggregated_post) | **POST** /api/v1/ereporting/submit-aggregated | Submit aggregated e-reporting to PA/PDP |
|
|
13
|
+
| [**submit_ereporting_api_v1_ereporting_submit_post**](EReportingApi.md#submit_ereporting_api_v1_ereporting_submit_post) | **POST** /api/v1/ereporting/submit | Submit e-reporting to PA/PDP |
|
|
14
|
+
| [**submit_xml_ereporting_api_v1_ereporting_submit_xml_post**](EReportingApi.md#submit_xml_ereporting_api_v1_ereporting_submit_xml_post) | **POST** /api/v1/ereporting/submit-xml | Submit pre-generated e-reporting XML |
|
|
15
|
+
| [**validate_aggregated_ereporting_api_v1_ereporting_validate_aggregated_post**](EReportingApi.md#validate_aggregated_ereporting_api_v1_ereporting_validate_aggregated_post) | **POST** /api/v1/ereporting/validate-aggregated | Validate aggregated e-reporting data |
|
|
16
|
+
| [**validate_ereporting_api_v1_ereporting_validate_post**](EReportingApi.md#validate_ereporting_api_v1_ereporting_validate_post) | **POST** /api/v1/ereporting/validate | Validate e-reporting data |
|
|
17
|
+
| [**validate_xml_ereporting_api_v1_ereporting_validate_xml_post**](EReportingApi.md#validate_xml_ereporting_api_v1_ereporting_validate_xml_post) | **POST** /api/v1/ereporting/validate-xml | Validate e-reporting XML against PPF XSD schemas and business rules |
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
## generate_aggregated_ereporting_api_v1_ereporting_generate_aggregated_post
|
|
21
|
+
|
|
22
|
+
> <GenerateAggregatedReportResponse> generate_aggregated_ereporting_api_v1_ereporting_generate_aggregated_post(create_aggregated_report_request)
|
|
23
|
+
|
|
24
|
+
Generate aggregated e-reporting XML (PPF-compliant)
|
|
25
|
+
|
|
26
|
+
Generate a PPF-compliant aggregated e-reporting XML containing multiple flux types in a single file. This endpoint creates a Report XML that can contain: - **TransactionsReport**: Invoice (10.1) AND/OR Transactions (10.3) - **PaymentsReport**: Invoice payments (10.2) AND/OR Transaction payments (10.4) The AFNOR FlowType is automatically determined based on content: - Single type → Specific FlowType (e.g., AggregatedCustomerTransactionReport) - Multiple types → MultiFlowReport **CategoryCode (TT-81)** must use PPF-compliant values: - TLB1: Goods deliveries - TPS1: Service provisions - TNT1: Non-taxed transactions - TMA1: Mixed transactions
|
|
27
|
+
|
|
28
|
+
### Examples
|
|
29
|
+
|
|
30
|
+
```ruby
|
|
31
|
+
require 'time'
|
|
32
|
+
require 'factpulse'
|
|
33
|
+
# setup authorization
|
|
34
|
+
FactPulse.configure do |config|
|
|
35
|
+
# Configure Bearer authorization: HTTPBearer
|
|
36
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
37
|
+
end
|
|
38
|
+
|
|
39
|
+
api_instance = FactPulse::EReportingApi.new
|
|
40
|
+
create_aggregated_report_request = FactPulse::CreateAggregatedReportRequest.new({report_id: 'EREPORT-2025-001', sender: FactPulse::ReportSender.new({siren: '123456789', name: 'Ma Société SARL'}), period: FactPulse::ReportPeriod.new({start_date: Date.parse('2025-01-01'), end_date: Date.parse('2025-01-31')})}) # CreateAggregatedReportRequest |
|
|
41
|
+
|
|
42
|
+
begin
|
|
43
|
+
# Generate aggregated e-reporting XML (PPF-compliant)
|
|
44
|
+
result = api_instance.generate_aggregated_ereporting_api_v1_ereporting_generate_aggregated_post(create_aggregated_report_request)
|
|
45
|
+
p result
|
|
46
|
+
rescue FactPulse::ApiError => e
|
|
47
|
+
puts "Error when calling EReportingApi->generate_aggregated_ereporting_api_v1_ereporting_generate_aggregated_post: #{e}"
|
|
48
|
+
end
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
#### Using the generate_aggregated_ereporting_api_v1_ereporting_generate_aggregated_post_with_http_info variant
|
|
52
|
+
|
|
53
|
+
This returns an Array which contains the response data, status code and headers.
|
|
54
|
+
|
|
55
|
+
> <Array(<GenerateAggregatedReportResponse>, Integer, Hash)> generate_aggregated_ereporting_api_v1_ereporting_generate_aggregated_post_with_http_info(create_aggregated_report_request)
|
|
56
|
+
|
|
57
|
+
```ruby
|
|
58
|
+
begin
|
|
59
|
+
# Generate aggregated e-reporting XML (PPF-compliant)
|
|
60
|
+
data, status_code, headers = api_instance.generate_aggregated_ereporting_api_v1_ereporting_generate_aggregated_post_with_http_info(create_aggregated_report_request)
|
|
61
|
+
p status_code # => 2xx
|
|
62
|
+
p headers # => { ... }
|
|
63
|
+
p data # => <GenerateAggregatedReportResponse>
|
|
64
|
+
rescue FactPulse::ApiError => e
|
|
65
|
+
puts "Error when calling EReportingApi->generate_aggregated_ereporting_api_v1_ereporting_generate_aggregated_post_with_http_info: #{e}"
|
|
66
|
+
end
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
### Parameters
|
|
70
|
+
|
|
71
|
+
| Name | Type | Description | Notes |
|
|
72
|
+
| ---- | ---- | ----------- | ----- |
|
|
73
|
+
| **create_aggregated_report_request** | [**CreateAggregatedReportRequest**](CreateAggregatedReportRequest.md) | | |
|
|
74
|
+
|
|
75
|
+
### Return type
|
|
76
|
+
|
|
77
|
+
[**GenerateAggregatedReportResponse**](GenerateAggregatedReportResponse.md)
|
|
78
|
+
|
|
79
|
+
### Authorization
|
|
80
|
+
|
|
81
|
+
[HTTPBearer](../README.md#HTTPBearer)
|
|
82
|
+
|
|
83
|
+
### HTTP request headers
|
|
84
|
+
|
|
85
|
+
- **Content-Type**: application/json
|
|
86
|
+
- **Accept**: application/json
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
## generate_ereporting_api_v1_ereporting_generate_post
|
|
90
|
+
|
|
91
|
+
> <GenerateEReportingResponse> generate_ereporting_api_v1_ereporting_generate_post(create_e_reporting_request)
|
|
92
|
+
|
|
93
|
+
Generate e-reporting XML
|
|
94
|
+
|
|
95
|
+
Generate e-reporting XML (FRR format) from structured data. Supports all four flow types: - **10.1**: Unitary B2B international transactions (use `invoices` field) - **10.2**: Payments for B2B international invoices (use `invoicePayments` field) - **10.3**: Aggregated B2C transactions (use `transactions` field) - **10.4**: Aggregated B2C payments (use `aggregatedPayments` field) The generated XML is compliant with DGFIP specifications and ready for submission to a PA (Plateforme Agréée).
|
|
96
|
+
|
|
97
|
+
### Examples
|
|
98
|
+
|
|
99
|
+
```ruby
|
|
100
|
+
require 'time'
|
|
101
|
+
require 'factpulse'
|
|
102
|
+
# setup authorization
|
|
103
|
+
FactPulse.configure do |config|
|
|
104
|
+
# Configure Bearer authorization: HTTPBearer
|
|
105
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
106
|
+
end
|
|
107
|
+
|
|
108
|
+
api_instance = FactPulse::EReportingApi.new
|
|
109
|
+
create_e_reporting_request = FactPulse::CreateEReportingRequest.new({report_id: 'EREPORT-2025-001', flow_type: FactPulse::EReportingFlowType::N10_1, sender: FactPulse::ReportSender.new({siren: '123456789', name: 'Ma Société SARL'}), period: FactPulse::ReportPeriod.new({start_date: Date.parse('2025-01-01'), end_date: Date.parse('2025-01-31')})}) # CreateEReportingRequest |
|
|
110
|
+
|
|
111
|
+
begin
|
|
112
|
+
# Generate e-reporting XML
|
|
113
|
+
result = api_instance.generate_ereporting_api_v1_ereporting_generate_post(create_e_reporting_request)
|
|
114
|
+
p result
|
|
115
|
+
rescue FactPulse::ApiError => e
|
|
116
|
+
puts "Error when calling EReportingApi->generate_ereporting_api_v1_ereporting_generate_post: #{e}"
|
|
117
|
+
end
|
|
118
|
+
```
|
|
119
|
+
|
|
120
|
+
#### Using the generate_ereporting_api_v1_ereporting_generate_post_with_http_info variant
|
|
121
|
+
|
|
122
|
+
This returns an Array which contains the response data, status code and headers.
|
|
123
|
+
|
|
124
|
+
> <Array(<GenerateEReportingResponse>, Integer, Hash)> generate_ereporting_api_v1_ereporting_generate_post_with_http_info(create_e_reporting_request)
|
|
125
|
+
|
|
126
|
+
```ruby
|
|
127
|
+
begin
|
|
128
|
+
# Generate e-reporting XML
|
|
129
|
+
data, status_code, headers = api_instance.generate_ereporting_api_v1_ereporting_generate_post_with_http_info(create_e_reporting_request)
|
|
130
|
+
p status_code # => 2xx
|
|
131
|
+
p headers # => { ... }
|
|
132
|
+
p data # => <GenerateEReportingResponse>
|
|
133
|
+
rescue FactPulse::ApiError => e
|
|
134
|
+
puts "Error when calling EReportingApi->generate_ereporting_api_v1_ereporting_generate_post_with_http_info: #{e}"
|
|
135
|
+
end
|
|
136
|
+
```
|
|
137
|
+
|
|
138
|
+
### Parameters
|
|
139
|
+
|
|
140
|
+
| Name | Type | Description | Notes |
|
|
141
|
+
| ---- | ---- | ----------- | ----- |
|
|
142
|
+
| **create_e_reporting_request** | [**CreateEReportingRequest**](CreateEReportingRequest.md) | | |
|
|
143
|
+
|
|
144
|
+
### Return type
|
|
145
|
+
|
|
146
|
+
[**GenerateEReportingResponse**](GenerateEReportingResponse.md)
|
|
147
|
+
|
|
148
|
+
### Authorization
|
|
149
|
+
|
|
150
|
+
[HTTPBearer](../README.md#HTTPBearer)
|
|
151
|
+
|
|
152
|
+
### HTTP request headers
|
|
153
|
+
|
|
154
|
+
- **Content-Type**: application/json
|
|
155
|
+
- **Accept**: application/json
|
|
156
|
+
|
|
157
|
+
|
|
158
|
+
## generate_ereporting_download_api_v1_ereporting_generate_download_post
|
|
159
|
+
|
|
160
|
+
> generate_ereporting_download_api_v1_ereporting_generate_download_post(create_e_reporting_request, opts)
|
|
161
|
+
|
|
162
|
+
Generate and download e-reporting XML
|
|
163
|
+
|
|
164
|
+
Generate e-reporting XML and return as downloadable file.
|
|
165
|
+
|
|
166
|
+
### Examples
|
|
167
|
+
|
|
168
|
+
```ruby
|
|
169
|
+
require 'time'
|
|
170
|
+
require 'factpulse'
|
|
171
|
+
# setup authorization
|
|
172
|
+
FactPulse.configure do |config|
|
|
173
|
+
# Configure Bearer authorization: HTTPBearer
|
|
174
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
175
|
+
end
|
|
176
|
+
|
|
177
|
+
api_instance = FactPulse::EReportingApi.new
|
|
178
|
+
create_e_reporting_request = FactPulse::CreateEReportingRequest.new({report_id: 'EREPORT-2025-001', flow_type: FactPulse::EReportingFlowType::N10_1, sender: FactPulse::ReportSender.new({siren: '123456789', name: 'Ma Société SARL'}), period: FactPulse::ReportPeriod.new({start_date: Date.parse('2025-01-01'), end_date: Date.parse('2025-01-31')})}) # CreateEReportingRequest |
|
|
179
|
+
opts = {
|
|
180
|
+
filename: 'filename_example' # String | Output filename (default: ereporting_{reportId}.xml)
|
|
181
|
+
}
|
|
182
|
+
|
|
183
|
+
begin
|
|
184
|
+
# Generate and download e-reporting XML
|
|
185
|
+
api_instance.generate_ereporting_download_api_v1_ereporting_generate_download_post(create_e_reporting_request, opts)
|
|
186
|
+
rescue FactPulse::ApiError => e
|
|
187
|
+
puts "Error when calling EReportingApi->generate_ereporting_download_api_v1_ereporting_generate_download_post: #{e}"
|
|
188
|
+
end
|
|
189
|
+
```
|
|
190
|
+
|
|
191
|
+
#### Using the generate_ereporting_download_api_v1_ereporting_generate_download_post_with_http_info variant
|
|
192
|
+
|
|
193
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
194
|
+
|
|
195
|
+
> <Array(nil, Integer, Hash)> generate_ereporting_download_api_v1_ereporting_generate_download_post_with_http_info(create_e_reporting_request, opts)
|
|
196
|
+
|
|
197
|
+
```ruby
|
|
198
|
+
begin
|
|
199
|
+
# Generate and download e-reporting XML
|
|
200
|
+
data, status_code, headers = api_instance.generate_ereporting_download_api_v1_ereporting_generate_download_post_with_http_info(create_e_reporting_request, opts)
|
|
201
|
+
p status_code # => 2xx
|
|
202
|
+
p headers # => { ... }
|
|
203
|
+
p data # => nil
|
|
204
|
+
rescue FactPulse::ApiError => e
|
|
205
|
+
puts "Error when calling EReportingApi->generate_ereporting_download_api_v1_ereporting_generate_download_post_with_http_info: #{e}"
|
|
206
|
+
end
|
|
207
|
+
```
|
|
208
|
+
|
|
209
|
+
### Parameters
|
|
210
|
+
|
|
211
|
+
| Name | Type | Description | Notes |
|
|
212
|
+
| ---- | ---- | ----------- | ----- |
|
|
213
|
+
| **create_e_reporting_request** | [**CreateEReportingRequest**](CreateEReportingRequest.md) | | |
|
|
214
|
+
| **filename** | **String** | Output filename (default: ereporting_{reportId}.xml) | [optional] |
|
|
215
|
+
|
|
216
|
+
### Return type
|
|
217
|
+
|
|
218
|
+
nil (empty response body)
|
|
219
|
+
|
|
220
|
+
### Authorization
|
|
221
|
+
|
|
222
|
+
[HTTPBearer](../README.md#HTTPBearer)
|
|
223
|
+
|
|
224
|
+
### HTTP request headers
|
|
225
|
+
|
|
226
|
+
- **Content-Type**: application/json
|
|
227
|
+
- **Accept**: application/json
|
|
228
|
+
|
|
229
|
+
|
|
230
|
+
## list_category_codes_api_v1_ereporting_category_codes_get
|
|
231
|
+
|
|
232
|
+
> Hash<String, Object> list_category_codes_api_v1_ereporting_category_codes_get
|
|
233
|
+
|
|
234
|
+
List PPF-compliant category codes
|
|
235
|
+
|
|
236
|
+
Returns the list of valid CategoryCode values (TT-81) for e-reporting transactions. Source: Annexe 6 - Format sémantique FE e-reporting v1.9
|
|
237
|
+
|
|
238
|
+
### Examples
|
|
239
|
+
|
|
240
|
+
```ruby
|
|
241
|
+
require 'time'
|
|
242
|
+
require 'factpulse'
|
|
243
|
+
|
|
244
|
+
api_instance = FactPulse::EReportingApi.new
|
|
245
|
+
|
|
246
|
+
begin
|
|
247
|
+
# List PPF-compliant category codes
|
|
248
|
+
result = api_instance.list_category_codes_api_v1_ereporting_category_codes_get
|
|
249
|
+
p result
|
|
250
|
+
rescue FactPulse::ApiError => e
|
|
251
|
+
puts "Error when calling EReportingApi->list_category_codes_api_v1_ereporting_category_codes_get: #{e}"
|
|
252
|
+
end
|
|
253
|
+
```
|
|
254
|
+
|
|
255
|
+
#### Using the list_category_codes_api_v1_ereporting_category_codes_get_with_http_info variant
|
|
256
|
+
|
|
257
|
+
This returns an Array which contains the response data, status code and headers.
|
|
258
|
+
|
|
259
|
+
> <Array(Hash<String, Object>, Integer, Hash)> list_category_codes_api_v1_ereporting_category_codes_get_with_http_info
|
|
260
|
+
|
|
261
|
+
```ruby
|
|
262
|
+
begin
|
|
263
|
+
# List PPF-compliant category codes
|
|
264
|
+
data, status_code, headers = api_instance.list_category_codes_api_v1_ereporting_category_codes_get_with_http_info
|
|
265
|
+
p status_code # => 2xx
|
|
266
|
+
p headers # => { ... }
|
|
267
|
+
p data # => Hash<String, Object>
|
|
268
|
+
rescue FactPulse::ApiError => e
|
|
269
|
+
puts "Error when calling EReportingApi->list_category_codes_api_v1_ereporting_category_codes_get_with_http_info: #{e}"
|
|
270
|
+
end
|
|
271
|
+
```
|
|
272
|
+
|
|
273
|
+
### Parameters
|
|
274
|
+
|
|
275
|
+
This endpoint does not need any parameter.
|
|
276
|
+
|
|
277
|
+
### Return type
|
|
278
|
+
|
|
279
|
+
**Hash<String, Object>**
|
|
280
|
+
|
|
281
|
+
### Authorization
|
|
282
|
+
|
|
283
|
+
No authorization required
|
|
284
|
+
|
|
285
|
+
### HTTP request headers
|
|
286
|
+
|
|
287
|
+
- **Content-Type**: Not defined
|
|
288
|
+
- **Accept**: application/json
|
|
289
|
+
|
|
290
|
+
|
|
291
|
+
## list_flow_types_api_v1_ereporting_flow_types_get
|
|
292
|
+
|
|
293
|
+
> Hash<String, Object> list_flow_types_api_v1_ereporting_flow_types_get
|
|
294
|
+
|
|
295
|
+
List available flow types
|
|
296
|
+
|
|
297
|
+
Returns the list of supported e-reporting flow types with descriptions.
|
|
298
|
+
|
|
299
|
+
### Examples
|
|
300
|
+
|
|
301
|
+
```ruby
|
|
302
|
+
require 'time'
|
|
303
|
+
require 'factpulse'
|
|
304
|
+
|
|
305
|
+
api_instance = FactPulse::EReportingApi.new
|
|
306
|
+
|
|
307
|
+
begin
|
|
308
|
+
# List available flow types
|
|
309
|
+
result = api_instance.list_flow_types_api_v1_ereporting_flow_types_get
|
|
310
|
+
p result
|
|
311
|
+
rescue FactPulse::ApiError => e
|
|
312
|
+
puts "Error when calling EReportingApi->list_flow_types_api_v1_ereporting_flow_types_get: #{e}"
|
|
313
|
+
end
|
|
314
|
+
```
|
|
315
|
+
|
|
316
|
+
#### Using the list_flow_types_api_v1_ereporting_flow_types_get_with_http_info variant
|
|
317
|
+
|
|
318
|
+
This returns an Array which contains the response data, status code and headers.
|
|
319
|
+
|
|
320
|
+
> <Array(Hash<String, Object>, Integer, Hash)> list_flow_types_api_v1_ereporting_flow_types_get_with_http_info
|
|
321
|
+
|
|
322
|
+
```ruby
|
|
323
|
+
begin
|
|
324
|
+
# List available flow types
|
|
325
|
+
data, status_code, headers = api_instance.list_flow_types_api_v1_ereporting_flow_types_get_with_http_info
|
|
326
|
+
p status_code # => 2xx
|
|
327
|
+
p headers # => { ... }
|
|
328
|
+
p data # => Hash<String, Object>
|
|
329
|
+
rescue FactPulse::ApiError => e
|
|
330
|
+
puts "Error when calling EReportingApi->list_flow_types_api_v1_ereporting_flow_types_get_with_http_info: #{e}"
|
|
331
|
+
end
|
|
332
|
+
```
|
|
333
|
+
|
|
334
|
+
### Parameters
|
|
335
|
+
|
|
336
|
+
This endpoint does not need any parameter.
|
|
337
|
+
|
|
338
|
+
### Return type
|
|
339
|
+
|
|
340
|
+
**Hash<String, Object>**
|
|
341
|
+
|
|
342
|
+
### Authorization
|
|
343
|
+
|
|
344
|
+
No authorization required
|
|
345
|
+
|
|
346
|
+
### HTTP request headers
|
|
347
|
+
|
|
348
|
+
- **Content-Type**: Not defined
|
|
349
|
+
- **Accept**: application/json
|
|
350
|
+
|
|
351
|
+
|
|
352
|
+
## submit_aggregated_ereporting_api_v1_ereporting_submit_aggregated_post
|
|
353
|
+
|
|
354
|
+
> <SubmitEReportingResponse> submit_aggregated_ereporting_api_v1_ereporting_submit_aggregated_post(submit_aggregated_report_request)
|
|
355
|
+
|
|
356
|
+
Submit aggregated e-reporting to PA/PDP
|
|
357
|
+
|
|
358
|
+
Generate and submit a PPF-compliant aggregated e-reporting to a PA/PDP. Combines generation and submission in a single call. Automatically determines the AFNOR FlowType based on content.
|
|
359
|
+
|
|
360
|
+
### Examples
|
|
361
|
+
|
|
362
|
+
```ruby
|
|
363
|
+
require 'time'
|
|
364
|
+
require 'factpulse'
|
|
365
|
+
# setup authorization
|
|
366
|
+
FactPulse.configure do |config|
|
|
367
|
+
# Configure Bearer authorization: HTTPBearer
|
|
368
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
369
|
+
end
|
|
370
|
+
|
|
371
|
+
api_instance = FactPulse::EReportingApi.new
|
|
372
|
+
submit_aggregated_report_request = FactPulse::SubmitAggregatedReportRequest.new({data: FactPulse::CreateAggregatedReportRequest.new({report_id: 'EREPORT-2025-001', sender: FactPulse::ReportSender.new({siren: '123456789', name: 'Ma Société SARL'}), period: FactPulse::ReportPeriod.new({start_date: Date.parse('2025-01-01'), end_date: Date.parse('2025-01-31')})})}) # SubmitAggregatedReportRequest |
|
|
373
|
+
|
|
374
|
+
begin
|
|
375
|
+
# Submit aggregated e-reporting to PA/PDP
|
|
376
|
+
result = api_instance.submit_aggregated_ereporting_api_v1_ereporting_submit_aggregated_post(submit_aggregated_report_request)
|
|
377
|
+
p result
|
|
378
|
+
rescue FactPulse::ApiError => e
|
|
379
|
+
puts "Error when calling EReportingApi->submit_aggregated_ereporting_api_v1_ereporting_submit_aggregated_post: #{e}"
|
|
380
|
+
end
|
|
381
|
+
```
|
|
382
|
+
|
|
383
|
+
#### Using the submit_aggregated_ereporting_api_v1_ereporting_submit_aggregated_post_with_http_info variant
|
|
384
|
+
|
|
385
|
+
This returns an Array which contains the response data, status code and headers.
|
|
386
|
+
|
|
387
|
+
> <Array(<SubmitEReportingResponse>, Integer, Hash)> submit_aggregated_ereporting_api_v1_ereporting_submit_aggregated_post_with_http_info(submit_aggregated_report_request)
|
|
388
|
+
|
|
389
|
+
```ruby
|
|
390
|
+
begin
|
|
391
|
+
# Submit aggregated e-reporting to PA/PDP
|
|
392
|
+
data, status_code, headers = api_instance.submit_aggregated_ereporting_api_v1_ereporting_submit_aggregated_post_with_http_info(submit_aggregated_report_request)
|
|
393
|
+
p status_code # => 2xx
|
|
394
|
+
p headers # => { ... }
|
|
395
|
+
p data # => <SubmitEReportingResponse>
|
|
396
|
+
rescue FactPulse::ApiError => e
|
|
397
|
+
puts "Error when calling EReportingApi->submit_aggregated_ereporting_api_v1_ereporting_submit_aggregated_post_with_http_info: #{e}"
|
|
398
|
+
end
|
|
399
|
+
```
|
|
400
|
+
|
|
401
|
+
### Parameters
|
|
402
|
+
|
|
403
|
+
| Name | Type | Description | Notes |
|
|
404
|
+
| ---- | ---- | ----------- | ----- |
|
|
405
|
+
| **submit_aggregated_report_request** | [**SubmitAggregatedReportRequest**](SubmitAggregatedReportRequest.md) | | |
|
|
406
|
+
|
|
407
|
+
### Return type
|
|
408
|
+
|
|
409
|
+
[**SubmitEReportingResponse**](SubmitEReportingResponse.md)
|
|
410
|
+
|
|
411
|
+
### Authorization
|
|
412
|
+
|
|
413
|
+
[HTTPBearer](../README.md#HTTPBearer)
|
|
414
|
+
|
|
415
|
+
### HTTP request headers
|
|
416
|
+
|
|
417
|
+
- **Content-Type**: application/json
|
|
418
|
+
- **Accept**: application/json
|
|
419
|
+
|
|
420
|
+
|
|
421
|
+
## submit_ereporting_api_v1_ereporting_submit_post
|
|
422
|
+
|
|
423
|
+
> <SubmitEReportingResponse> submit_ereporting_api_v1_ereporting_submit_post(submit_e_reporting_request)
|
|
424
|
+
|
|
425
|
+
Submit e-reporting to PA/PDP
|
|
426
|
+
|
|
427
|
+
Generate and submit e-reporting to a PA (Plateforme Agréée). Authentication strategies (same as invoices): 1. **JWT with client_uid** (recommended): PDP credentials fetched from backend 2. **Zero-storage**: Provide pdpFlowServiceUrl, pdpClientId, pdpClientSecret in request The e-reporting is submitted using the AFNOR Flow Service API with syntax=FRR (FRench Reporting).
|
|
428
|
+
|
|
429
|
+
### Examples
|
|
430
|
+
|
|
431
|
+
```ruby
|
|
432
|
+
require 'time'
|
|
433
|
+
require 'factpulse'
|
|
434
|
+
# setup authorization
|
|
435
|
+
FactPulse.configure do |config|
|
|
436
|
+
# Configure Bearer authorization: HTTPBearer
|
|
437
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
438
|
+
end
|
|
439
|
+
|
|
440
|
+
api_instance = FactPulse::EReportingApi.new
|
|
441
|
+
submit_e_reporting_request = FactPulse::SubmitEReportingRequest.new({data: FactPulse::CreateEReportingRequest.new({report_id: 'EREPORT-2025-001', flow_type: FactPulse::EReportingFlowType::N10_1, sender: FactPulse::ReportSender.new({siren: '123456789', name: 'Ma Société SARL'}), period: FactPulse::ReportPeriod.new({start_date: Date.parse('2025-01-01'), end_date: Date.parse('2025-01-31')})})}) # SubmitEReportingRequest |
|
|
442
|
+
|
|
443
|
+
begin
|
|
444
|
+
# Submit e-reporting to PA/PDP
|
|
445
|
+
result = api_instance.submit_ereporting_api_v1_ereporting_submit_post(submit_e_reporting_request)
|
|
446
|
+
p result
|
|
447
|
+
rescue FactPulse::ApiError => e
|
|
448
|
+
puts "Error when calling EReportingApi->submit_ereporting_api_v1_ereporting_submit_post: #{e}"
|
|
449
|
+
end
|
|
450
|
+
```
|
|
451
|
+
|
|
452
|
+
#### Using the submit_ereporting_api_v1_ereporting_submit_post_with_http_info variant
|
|
453
|
+
|
|
454
|
+
This returns an Array which contains the response data, status code and headers.
|
|
455
|
+
|
|
456
|
+
> <Array(<SubmitEReportingResponse>, Integer, Hash)> submit_ereporting_api_v1_ereporting_submit_post_with_http_info(submit_e_reporting_request)
|
|
457
|
+
|
|
458
|
+
```ruby
|
|
459
|
+
begin
|
|
460
|
+
# Submit e-reporting to PA/PDP
|
|
461
|
+
data, status_code, headers = api_instance.submit_ereporting_api_v1_ereporting_submit_post_with_http_info(submit_e_reporting_request)
|
|
462
|
+
p status_code # => 2xx
|
|
463
|
+
p headers # => { ... }
|
|
464
|
+
p data # => <SubmitEReportingResponse>
|
|
465
|
+
rescue FactPulse::ApiError => e
|
|
466
|
+
puts "Error when calling EReportingApi->submit_ereporting_api_v1_ereporting_submit_post_with_http_info: #{e}"
|
|
467
|
+
end
|
|
468
|
+
```
|
|
469
|
+
|
|
470
|
+
### Parameters
|
|
471
|
+
|
|
472
|
+
| Name | Type | Description | Notes |
|
|
473
|
+
| ---- | ---- | ----------- | ----- |
|
|
474
|
+
| **submit_e_reporting_request** | [**SubmitEReportingRequest**](SubmitEReportingRequest.md) | | |
|
|
475
|
+
|
|
476
|
+
### Return type
|
|
477
|
+
|
|
478
|
+
[**SubmitEReportingResponse**](SubmitEReportingResponse.md)
|
|
479
|
+
|
|
480
|
+
### Authorization
|
|
481
|
+
|
|
482
|
+
[HTTPBearer](../README.md#HTTPBearer)
|
|
483
|
+
|
|
484
|
+
### HTTP request headers
|
|
485
|
+
|
|
486
|
+
- **Content-Type**: application/json
|
|
487
|
+
- **Accept**: application/json
|
|
488
|
+
|
|
489
|
+
|
|
490
|
+
## submit_xml_ereporting_api_v1_ereporting_submit_xml_post
|
|
491
|
+
|
|
492
|
+
> <SubmitEReportingResponse> submit_xml_ereporting_api_v1_ereporting_submit_xml_post(xml_file, opts)
|
|
493
|
+
|
|
494
|
+
Submit pre-generated e-reporting XML
|
|
495
|
+
|
|
496
|
+
Submit a pre-generated e-reporting XML file directly to a PA/PDP. This endpoint is designed for clients who generate their own PPF-compliant XML and only need FactPulse for the PDP submission. **Process:** 1. Validates the XML against PPF XSD schemas 2. Determines the appropriate AFNOR FlowType 3. Submits to the configured PDP/PA 4. Returns the flowId for tracking **Authentication:** Same strategies as /submit endpoint (JWT or zero-storage credentials).
|
|
497
|
+
|
|
498
|
+
### Examples
|
|
499
|
+
|
|
500
|
+
```ruby
|
|
501
|
+
require 'time'
|
|
502
|
+
require 'factpulse'
|
|
503
|
+
# setup authorization
|
|
504
|
+
FactPulse.configure do |config|
|
|
505
|
+
# Configure Bearer authorization: HTTPBearer
|
|
506
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
507
|
+
end
|
|
508
|
+
|
|
509
|
+
api_instance = FactPulse::EReportingApi.new
|
|
510
|
+
xml_file = File.new('/path/to/some/file') # File | E-reporting XML file
|
|
511
|
+
opts = {
|
|
512
|
+
tracking_id: 'tracking_id_example', # String |
|
|
513
|
+
skip_validation: true, # Boolean | Skip XSD validation
|
|
514
|
+
pdp_flow_service_url: 'pdp_flow_service_url_example', # String |
|
|
515
|
+
pdp_token_url: 'pdp_token_url_example', # String |
|
|
516
|
+
pdp_client_id: 'pdp_client_id_example', # String |
|
|
517
|
+
pdp_client_secret: 'pdp_client_secret_example' # String |
|
|
518
|
+
}
|
|
519
|
+
|
|
520
|
+
begin
|
|
521
|
+
# Submit pre-generated e-reporting XML
|
|
522
|
+
result = api_instance.submit_xml_ereporting_api_v1_ereporting_submit_xml_post(xml_file, opts)
|
|
523
|
+
p result
|
|
524
|
+
rescue FactPulse::ApiError => e
|
|
525
|
+
puts "Error when calling EReportingApi->submit_xml_ereporting_api_v1_ereporting_submit_xml_post: #{e}"
|
|
526
|
+
end
|
|
527
|
+
```
|
|
528
|
+
|
|
529
|
+
#### Using the submit_xml_ereporting_api_v1_ereporting_submit_xml_post_with_http_info variant
|
|
530
|
+
|
|
531
|
+
This returns an Array which contains the response data, status code and headers.
|
|
532
|
+
|
|
533
|
+
> <Array(<SubmitEReportingResponse>, Integer, Hash)> submit_xml_ereporting_api_v1_ereporting_submit_xml_post_with_http_info(xml_file, opts)
|
|
534
|
+
|
|
535
|
+
```ruby
|
|
536
|
+
begin
|
|
537
|
+
# Submit pre-generated e-reporting XML
|
|
538
|
+
data, status_code, headers = api_instance.submit_xml_ereporting_api_v1_ereporting_submit_xml_post_with_http_info(xml_file, opts)
|
|
539
|
+
p status_code # => 2xx
|
|
540
|
+
p headers # => { ... }
|
|
541
|
+
p data # => <SubmitEReportingResponse>
|
|
542
|
+
rescue FactPulse::ApiError => e
|
|
543
|
+
puts "Error when calling EReportingApi->submit_xml_ereporting_api_v1_ereporting_submit_xml_post_with_http_info: #{e}"
|
|
544
|
+
end
|
|
545
|
+
```
|
|
546
|
+
|
|
547
|
+
### Parameters
|
|
548
|
+
|
|
549
|
+
| Name | Type | Description | Notes |
|
|
550
|
+
| ---- | ---- | ----------- | ----- |
|
|
551
|
+
| **xml_file** | **File** | E-reporting XML file | |
|
|
552
|
+
| **tracking_id** | **String** | | [optional] |
|
|
553
|
+
| **skip_validation** | **Boolean** | Skip XSD validation | [optional][default to false] |
|
|
554
|
+
| **pdp_flow_service_url** | **String** | | [optional] |
|
|
555
|
+
| **pdp_token_url** | **String** | | [optional] |
|
|
556
|
+
| **pdp_client_id** | **String** | | [optional] |
|
|
557
|
+
| **pdp_client_secret** | **String** | | [optional] |
|
|
558
|
+
|
|
559
|
+
### Return type
|
|
560
|
+
|
|
561
|
+
[**SubmitEReportingResponse**](SubmitEReportingResponse.md)
|
|
562
|
+
|
|
563
|
+
### Authorization
|
|
564
|
+
|
|
565
|
+
[HTTPBearer](../README.md#HTTPBearer)
|
|
566
|
+
|
|
567
|
+
### HTTP request headers
|
|
568
|
+
|
|
569
|
+
- **Content-Type**: multipart/form-data
|
|
570
|
+
- **Accept**: application/json
|
|
571
|
+
|
|
572
|
+
|
|
573
|
+
## validate_aggregated_ereporting_api_v1_ereporting_validate_aggregated_post
|
|
574
|
+
|
|
575
|
+
> Hash<String, Object> validate_aggregated_ereporting_api_v1_ereporting_validate_aggregated_post(create_aggregated_report_request)
|
|
576
|
+
|
|
577
|
+
Validate aggregated e-reporting data
|
|
578
|
+
|
|
579
|
+
Validates aggregated e-reporting data without generating XML.
|
|
580
|
+
|
|
581
|
+
### Examples
|
|
582
|
+
|
|
583
|
+
```ruby
|
|
584
|
+
require 'time'
|
|
585
|
+
require 'factpulse'
|
|
586
|
+
# setup authorization
|
|
587
|
+
FactPulse.configure do |config|
|
|
588
|
+
# Configure Bearer authorization: HTTPBearer
|
|
589
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
590
|
+
end
|
|
591
|
+
|
|
592
|
+
api_instance = FactPulse::EReportingApi.new
|
|
593
|
+
create_aggregated_report_request = FactPulse::CreateAggregatedReportRequest.new({report_id: 'EREPORT-2025-001', sender: FactPulse::ReportSender.new({siren: '123456789', name: 'Ma Société SARL'}), period: FactPulse::ReportPeriod.new({start_date: Date.parse('2025-01-01'), end_date: Date.parse('2025-01-31')})}) # CreateAggregatedReportRequest |
|
|
594
|
+
|
|
595
|
+
begin
|
|
596
|
+
# Validate aggregated e-reporting data
|
|
597
|
+
result = api_instance.validate_aggregated_ereporting_api_v1_ereporting_validate_aggregated_post(create_aggregated_report_request)
|
|
598
|
+
p result
|
|
599
|
+
rescue FactPulse::ApiError => e
|
|
600
|
+
puts "Error when calling EReportingApi->validate_aggregated_ereporting_api_v1_ereporting_validate_aggregated_post: #{e}"
|
|
601
|
+
end
|
|
602
|
+
```
|
|
603
|
+
|
|
604
|
+
#### Using the validate_aggregated_ereporting_api_v1_ereporting_validate_aggregated_post_with_http_info variant
|
|
605
|
+
|
|
606
|
+
This returns an Array which contains the response data, status code and headers.
|
|
607
|
+
|
|
608
|
+
> <Array(Hash<String, Object>, Integer, Hash)> validate_aggregated_ereporting_api_v1_ereporting_validate_aggregated_post_with_http_info(create_aggregated_report_request)
|
|
609
|
+
|
|
610
|
+
```ruby
|
|
611
|
+
begin
|
|
612
|
+
# Validate aggregated e-reporting data
|
|
613
|
+
data, status_code, headers = api_instance.validate_aggregated_ereporting_api_v1_ereporting_validate_aggregated_post_with_http_info(create_aggregated_report_request)
|
|
614
|
+
p status_code # => 2xx
|
|
615
|
+
p headers # => { ... }
|
|
616
|
+
p data # => Hash<String, Object>
|
|
617
|
+
rescue FactPulse::ApiError => e
|
|
618
|
+
puts "Error when calling EReportingApi->validate_aggregated_ereporting_api_v1_ereporting_validate_aggregated_post_with_http_info: #{e}"
|
|
619
|
+
end
|
|
620
|
+
```
|
|
621
|
+
|
|
622
|
+
### Parameters
|
|
623
|
+
|
|
624
|
+
| Name | Type | Description | Notes |
|
|
625
|
+
| ---- | ---- | ----------- | ----- |
|
|
626
|
+
| **create_aggregated_report_request** | [**CreateAggregatedReportRequest**](CreateAggregatedReportRequest.md) | | |
|
|
627
|
+
|
|
628
|
+
### Return type
|
|
629
|
+
|
|
630
|
+
**Hash<String, Object>**
|
|
631
|
+
|
|
632
|
+
### Authorization
|
|
633
|
+
|
|
634
|
+
[HTTPBearer](../README.md#HTTPBearer)
|
|
635
|
+
|
|
636
|
+
### HTTP request headers
|
|
637
|
+
|
|
638
|
+
- **Content-Type**: application/json
|
|
639
|
+
- **Accept**: application/json
|
|
640
|
+
|
|
641
|
+
|
|
642
|
+
## validate_ereporting_api_v1_ereporting_validate_post
|
|
643
|
+
|
|
644
|
+
> <ValidateEReportingResponse> validate_ereporting_api_v1_ereporting_validate_post(validate_e_reporting_request)
|
|
645
|
+
|
|
646
|
+
Validate e-reporting data
|
|
647
|
+
|
|
648
|
+
Validate e-reporting data without generating or submitting. Performs: - Schema validation - Business rule validation (correct flux type vs data) - Data consistency checks (tax totals, dates, etc.) Returns validation errors and warnings.
|
|
649
|
+
|
|
650
|
+
### Examples
|
|
651
|
+
|
|
652
|
+
```ruby
|
|
653
|
+
require 'time'
|
|
654
|
+
require 'factpulse'
|
|
655
|
+
# setup authorization
|
|
656
|
+
FactPulse.configure do |config|
|
|
657
|
+
# Configure Bearer authorization: HTTPBearer
|
|
658
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
659
|
+
end
|
|
660
|
+
|
|
661
|
+
api_instance = FactPulse::EReportingApi.new
|
|
662
|
+
validate_e_reporting_request = FactPulse::ValidateEReportingRequest.new({data: FactPulse::CreateEReportingRequest.new({report_id: 'EREPORT-2025-001', flow_type: FactPulse::EReportingFlowType::N10_1, sender: FactPulse::ReportSender.new({siren: '123456789', name: 'Ma Société SARL'}), period: FactPulse::ReportPeriod.new({start_date: Date.parse('2025-01-01'), end_date: Date.parse('2025-01-31')})})}) # ValidateEReportingRequest |
|
|
663
|
+
|
|
664
|
+
begin
|
|
665
|
+
# Validate e-reporting data
|
|
666
|
+
result = api_instance.validate_ereporting_api_v1_ereporting_validate_post(validate_e_reporting_request)
|
|
667
|
+
p result
|
|
668
|
+
rescue FactPulse::ApiError => e
|
|
669
|
+
puts "Error when calling EReportingApi->validate_ereporting_api_v1_ereporting_validate_post: #{e}"
|
|
670
|
+
end
|
|
671
|
+
```
|
|
672
|
+
|
|
673
|
+
#### Using the validate_ereporting_api_v1_ereporting_validate_post_with_http_info variant
|
|
674
|
+
|
|
675
|
+
This returns an Array which contains the response data, status code and headers.
|
|
676
|
+
|
|
677
|
+
> <Array(<ValidateEReportingResponse>, Integer, Hash)> validate_ereporting_api_v1_ereporting_validate_post_with_http_info(validate_e_reporting_request)
|
|
678
|
+
|
|
679
|
+
```ruby
|
|
680
|
+
begin
|
|
681
|
+
# Validate e-reporting data
|
|
682
|
+
data, status_code, headers = api_instance.validate_ereporting_api_v1_ereporting_validate_post_with_http_info(validate_e_reporting_request)
|
|
683
|
+
p status_code # => 2xx
|
|
684
|
+
p headers # => { ... }
|
|
685
|
+
p data # => <ValidateEReportingResponse>
|
|
686
|
+
rescue FactPulse::ApiError => e
|
|
687
|
+
puts "Error when calling EReportingApi->validate_ereporting_api_v1_ereporting_validate_post_with_http_info: #{e}"
|
|
688
|
+
end
|
|
689
|
+
```
|
|
690
|
+
|
|
691
|
+
### Parameters
|
|
692
|
+
|
|
693
|
+
| Name | Type | Description | Notes |
|
|
694
|
+
| ---- | ---- | ----------- | ----- |
|
|
695
|
+
| **validate_e_reporting_request** | [**ValidateEReportingRequest**](ValidateEReportingRequest.md) | | |
|
|
696
|
+
|
|
697
|
+
### Return type
|
|
698
|
+
|
|
699
|
+
[**ValidateEReportingResponse**](ValidateEReportingResponse.md)
|
|
700
|
+
|
|
701
|
+
### Authorization
|
|
702
|
+
|
|
703
|
+
[HTTPBearer](../README.md#HTTPBearer)
|
|
704
|
+
|
|
705
|
+
### HTTP request headers
|
|
706
|
+
|
|
707
|
+
- **Content-Type**: application/json
|
|
708
|
+
- **Accept**: application/json
|
|
709
|
+
|
|
710
|
+
|
|
711
|
+
## validate_xml_ereporting_api_v1_ereporting_validate_xml_post
|
|
712
|
+
|
|
713
|
+
> Hash<String, Object> validate_xml_ereporting_api_v1_ereporting_validate_xml_post(xml_file, opts)
|
|
714
|
+
|
|
715
|
+
Validate e-reporting XML against PPF XSD schemas and business rules
|
|
716
|
+
|
|
717
|
+
Validates an e-reporting XML file against: 1. **XSD schemas**: Official PPF e-reporting XSD (structure, types, cardinality) 2. **Business rules**: ISO codes and enum validation - Currency codes (ISO 4217: EUR, USD, GBP, etc.) - Country codes (ISO 3166-1 alpha-2: FR, DE, US, etc.) - Scheme IDs (0009=SIRET, 0002=SIREN, etc.) - Role codes (UNCL 3035: SE=Seller, BY=Buyer, WK=Working party, etc.) Returns validation status and detailed error messages if invalid.
|
|
718
|
+
|
|
719
|
+
### Examples
|
|
720
|
+
|
|
721
|
+
```ruby
|
|
722
|
+
require 'time'
|
|
723
|
+
require 'factpulse'
|
|
724
|
+
# setup authorization
|
|
725
|
+
FactPulse.configure do |config|
|
|
726
|
+
# Configure Bearer authorization: HTTPBearer
|
|
727
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
728
|
+
end
|
|
729
|
+
|
|
730
|
+
api_instance = FactPulse::EReportingApi.new
|
|
731
|
+
xml_file = File.new('/path/to/some/file') # File | E-reporting XML file to validate
|
|
732
|
+
opts = {
|
|
733
|
+
validate_business_rules: true # Boolean | Also validate business rules (ISO codes, enums)
|
|
734
|
+
}
|
|
735
|
+
|
|
736
|
+
begin
|
|
737
|
+
# Validate e-reporting XML against PPF XSD schemas and business rules
|
|
738
|
+
result = api_instance.validate_xml_ereporting_api_v1_ereporting_validate_xml_post(xml_file, opts)
|
|
739
|
+
p result
|
|
740
|
+
rescue FactPulse::ApiError => e
|
|
741
|
+
puts "Error when calling EReportingApi->validate_xml_ereporting_api_v1_ereporting_validate_xml_post: #{e}"
|
|
742
|
+
end
|
|
743
|
+
```
|
|
744
|
+
|
|
745
|
+
#### Using the validate_xml_ereporting_api_v1_ereporting_validate_xml_post_with_http_info variant
|
|
746
|
+
|
|
747
|
+
This returns an Array which contains the response data, status code and headers.
|
|
748
|
+
|
|
749
|
+
> <Array(Hash<String, Object>, Integer, Hash)> validate_xml_ereporting_api_v1_ereporting_validate_xml_post_with_http_info(xml_file, opts)
|
|
750
|
+
|
|
751
|
+
```ruby
|
|
752
|
+
begin
|
|
753
|
+
# Validate e-reporting XML against PPF XSD schemas and business rules
|
|
754
|
+
data, status_code, headers = api_instance.validate_xml_ereporting_api_v1_ereporting_validate_xml_post_with_http_info(xml_file, opts)
|
|
755
|
+
p status_code # => 2xx
|
|
756
|
+
p headers # => { ... }
|
|
757
|
+
p data # => Hash<String, Object>
|
|
758
|
+
rescue FactPulse::ApiError => e
|
|
759
|
+
puts "Error when calling EReportingApi->validate_xml_ereporting_api_v1_ereporting_validate_xml_post_with_http_info: #{e}"
|
|
760
|
+
end
|
|
761
|
+
```
|
|
762
|
+
|
|
763
|
+
### Parameters
|
|
764
|
+
|
|
765
|
+
| Name | Type | Description | Notes |
|
|
766
|
+
| ---- | ---- | ----------- | ----- |
|
|
767
|
+
| **xml_file** | **File** | E-reporting XML file to validate | |
|
|
768
|
+
| **validate_business_rules** | **Boolean** | Also validate business rules (ISO codes, enums) | [optional][default to true] |
|
|
769
|
+
|
|
770
|
+
### Return type
|
|
771
|
+
|
|
772
|
+
**Hash<String, Object>**
|
|
773
|
+
|
|
774
|
+
### Authorization
|
|
775
|
+
|
|
776
|
+
[HTTPBearer](../README.md#HTTPBearer)
|
|
777
|
+
|
|
778
|
+
### HTTP request headers
|
|
779
|
+
|
|
780
|
+
- **Content-Type**: multipart/form-data
|
|
781
|
+
- **Accept**: application/json
|
|
782
|
+
|