factpulse 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/CHANGELOG.md +17 -0
- data/Gemfile +9 -0
- data/Gemfile.lock +74 -0
- data/LICENSE +21 -0
- data/README.md +220 -0
- data/Rakefile +10 -0
- 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/AFNORAlgorithm.md +15 -0
- 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/AFNORCredentials.md +22 -0
- data/docs/AFNORDestination.md +26 -0
- 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/AFNORHealthCheckResponse.md +22 -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 +150 -0
- data/docs/AFNORPDPPADirectoryServiceApi.md +1223 -0
- data/docs/AFNORPDPPAFlowServiceApi.md +270 -0
- 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 +32 -0
- 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/APIError.md +22 -0
- data/docs/APIProfile.md +15 -0
- data/docs/AcknowledgmentStatus.md +15 -0
- data/docs/ActionCodeInfo.md +22 -0
- data/docs/ActionCodesResponse.md +22 -0
- data/docs/AdditionalDocument.md +26 -0
- data/docs/AggregatedPaymentInput.md +22 -0
- data/docs/AggregatedTransactionInput.md +32 -0
- data/docs/AllowanceCharge.md +32 -0
- data/docs/AllowanceChargeReasonCode.md +15 -0
- data/docs/AllowanceReasonCode.md +15 -0
- data/docs/AllowanceTotalAmount.md +15 -0
- data/docs/Amount.md +15 -0
- data/docs/Amount1.md +15 -0
- data/docs/Amount2.md +15 -0
- data/docs/AmountDue.md +15 -0
- data/docs/AsyncTaskStatus.md +22 -0
- data/docs/AsyncTasksApi.md +82 -0
- data/docs/BaseAmount.md +15 -0
- data/docs/BoundingBoxSchema.md +30 -0
- data/docs/Buyercountry.md +15 -0
- data/docs/CeleryStatus.md +15 -0
- data/docs/CertificateInfoResponse.md +40 -0
- data/docs/ChargeTotalAmount.md +15 -0
- data/docs/ChorusProApi.md +1207 -0
- data/docs/ChorusProCredentials.md +26 -0
- data/docs/ChorusProDestination.md +20 -0
- data/docs/ChorusProResult.md +22 -0
- data/docs/ClientActivateResponse.md +22 -0
- data/docs/ClientCreateRequest.md +22 -0
- data/docs/ClientDetail.md +38 -0
- data/docs/ClientListResponse.md +24 -0
- data/docs/ClientManagementApi.md +921 -0
- data/docs/ClientSummary.md +38 -0
- data/docs/ClientUpdateRequest.md +22 -0
- data/docs/Contact.md +24 -0
- data/docs/ConvertResumeRequest.md +18 -0
- data/docs/ConvertSuccessResponse.md +36 -0
- data/docs/ConvertValidationFailedResponse.md +34 -0
- data/docs/CountryCode.md +15 -0
- data/docs/CreateAggregatedReportRequest.md +36 -0
- data/docs/CreateCDARRequest.md +52 -0
- data/docs/CreateEReportingRequest.md +38 -0
- data/docs/Currency.md +15 -0
- data/docs/CurrencyCode.md +15 -0
- data/docs/DeliveryParty.md +24 -0
- data/docs/Destination.md +79 -0
- data/docs/DocType.md +15 -0
- data/docs/DocumentTypeInfo.md +22 -0
- data/docs/DownloadsApi.md +161 -0
- data/docs/EReportingFlowType.md +15 -0
- data/docs/EReportingValidationError.md +22 -0
- data/docs/ElectronicAddress.md +20 -0
- data/docs/ElectronicSignatureApi.md +339 -0
- data/docs/Encaisseamount.md +15 -0
- data/docs/Encaisseamount1.md +15 -0
- data/docs/EncaisseeRequest.md +40 -0
- data/docs/EnrichedInvoiceInfo.md +32 -0
- data/docs/ErrorLevel.md +15 -0
- data/docs/ErrorSource.md +15 -0
- data/docs/ExtractionInfo.md +24 -0
- data/docs/FacturXConversionApi.md +319 -0
- data/docs/FacturXGenerationApi.md +254 -0
- data/docs/FacturXInvoice.md +76 -0
- data/docs/FacturXPDFInfo.md +22 -0
- data/docs/FacturXPDFXMLVerificationApi.md +240 -0
- data/docs/FacturXValidationApi.md +256 -0
- data/docs/FactureElectroniqueRestApiSchemasEreportingInvoiceTypeCode.md +15 -0
- data/docs/FactureElectroniqueRestApiSchemasProcessingChorusProCredentials.md +26 -0
- data/docs/FactureElectroniqueRestApiSchemasValidationValidationErrorResponse.md +18 -0
- data/docs/FieldStatus.md +15 -0
- data/docs/FileInfo.md +20 -0
- data/docs/FilesInfo.md +20 -0
- data/docs/FlowDirection.md +15 -0
- data/docs/FlowProfile.md +15 -0
- data/docs/FlowSummary.md +32 -0
- data/docs/FlowSyntax.md +15 -0
- data/docs/FlowType.md +15 -0
- data/docs/Flux10EReportingApi.md +814 -0
- data/docs/Flux6InvoiceLifecycleCDARApi.md +698 -0
- data/docs/GenerateAggregatedReportResponse.md +30 -0
- data/docs/GenerateCDARResponse.md +26 -0
- data/docs/GenerateCertificateRequest.md +38 -0
- data/docs/GenerateCertificateResponse.md +32 -0
- data/docs/GenerateEReportingResponse.md +26 -0
- data/docs/GetChorusProIdRequest.md +22 -0
- data/docs/GetChorusProIdResponse.md +24 -0
- data/docs/GetInvoiceRequest.md +20 -0
- data/docs/GetInvoiceResponse.md +34 -0
- data/docs/GetStructureRequest.md +22 -0
- data/docs/GetStructureResponse.md +34 -0
- data/docs/GlobalAllowanceAmount.md +15 -0
- data/docs/GrossUnitPrice.md +15 -0
- data/docs/HTTPValidationError.md +18 -0
- data/docs/HealthApi.md +203 -0
- data/docs/IncomingInvoice.md +54 -0
- data/docs/IncomingSupplier.md +32 -0
- data/docs/InvoiceFormat.md +15 -0
- data/docs/InvoiceInput.md +50 -0
- data/docs/InvoiceLine.md +84 -0
- data/docs/InvoiceLineAllowanceAmount.md +15 -0
- data/docs/InvoiceNote.md +20 -0
- data/docs/InvoicePaymentInput.md +26 -0
- data/docs/InvoiceReferences.md +52 -0
- data/docs/InvoiceStatus.md +22 -0
- data/docs/InvoiceTotals.md +38 -0
- data/docs/InvoiceTotalsPrepayment.md +15 -0
- data/docs/InvoiceTypeCode.md +15 -0
- data/docs/InvoiceTypeCodeOutput.md +15 -0
- data/docs/InvoicingFramework.md +24 -0
- data/docs/InvoicingFrameworkCode.md +15 -0
- data/docs/IssuerRoleCode.md +15 -0
- data/docs/KeyRotationRequest.md +20 -0
- data/docs/KeyRotationResponse.md +24 -0
- data/docs/LineNetAmount.md +15 -0
- data/docs/LineSubType.md +15 -0
- data/docs/LineTotalAmount.md +15 -0
- data/docs/LocationInner.md +15 -0
- data/docs/MandatoryNoteSchema.md +30 -0
- data/docs/ManualRate.md +15 -0
- data/docs/ManualVatRate.md +15 -0
- data/docs/MissingField.md +28 -0
- data/docs/OperationNature.md +15 -0
- data/docs/OutputFormat.md +15 -0
- data/docs/PDFValidationResultAPI.md +62 -0
- data/docs/PDPConfigResponse.md +46 -0
- data/docs/PDPConfigUpdateRequest.md +30 -0
- data/docs/PDPCredentials.md +26 -0
- data/docs/PageDimensionsSchema.md +20 -0
- data/docs/Payee.md +32 -0
- data/docs/PaymentAmountByRate.md +20 -0
- data/docs/PaymentCard.md +20 -0
- data/docs/PaymentMeans.md +15 -0
- data/docs/Percentage.md +15 -0
- data/docs/PostalAddress.md +30 -0
- data/docs/PriceAllowanceAmount.md +15 -0
- data/docs/PriceBasisQuantity.md +15 -0
- data/docs/ProcessingOptions.md +24 -0
- data/docs/ProcessingRule.md +15 -0
- data/docs/ProductCharacteristic.md +20 -0
- data/docs/ProductClassification.md +22 -0
- data/docs/Quantity.md +15 -0
- data/docs/Rate.md +15 -0
- data/docs/Rate1.md +15 -0
- data/docs/ReasonCodeInfo.md +22 -0
- data/docs/ReasonCodesResponse.md +22 -0
- data/docs/Recipient.md +34 -0
- data/docs/RecipientInput.md +26 -0
- data/docs/RefuseeRequest.md +40 -0
- data/docs/ReportIssuer.md +24 -0
- data/docs/ReportPeriod.md +20 -0
- data/docs/ReportSender.md +22 -0
- data/docs/RoundingAmount.md +15 -0
- data/docs/SchematronValidationError.md +32 -0
- data/docs/SchemeID.md +15 -0
- data/docs/SearchFlowRequest.md +34 -0
- data/docs/SearchFlowResponse.md +24 -0
- data/docs/SearchServicesResponse.md +24 -0
- data/docs/SearchStructureRequest.md +26 -0
- data/docs/SearchStructureResponse.md +24 -0
- data/docs/SecretStatus.md +24 -0
- data/docs/Sellercountry.md +15 -0
- data/docs/SignatureInfo.md +22 -0
- data/docs/SignatureInfoAPI.md +28 -0
- data/docs/SignatureParameters.md +34 -0
- data/docs/SimplifiedCDARResponse.md +26 -0
- data/docs/SimplifiedInvoiceData.md +42 -0
- data/docs/StatusCodeInfo.md +22 -0
- data/docs/StatusCodesResponse.md +22 -0
- data/docs/StructureInfo.md +26 -0
- data/docs/StructureParameters.md +22 -0
- data/docs/StructureService.md +24 -0
- data/docs/SubmissionMode.md +15 -0
- data/docs/SubmitAggregatedReportRequest.md +28 -0
- data/docs/SubmitCDARRequest.md +62 -0
- data/docs/SubmitCDARResponse.md +24 -0
- data/docs/SubmitCDARXMLRequest.md +30 -0
- data/docs/SubmitCompleteInvoiceRequest.md +26 -0
- data/docs/SubmitCompleteInvoiceResponse.md +34 -0
- data/docs/SubmitEReportingRequest.md +28 -0
- data/docs/SubmitEReportingResponse.md +32 -0
- data/docs/SubmitFlowRequest.md +28 -0
- data/docs/SubmitFlowResponse.md +30 -0
- data/docs/SubmitGrossAmount.md +15 -0
- data/docs/SubmitInvoiceRequest.md +46 -0
- data/docs/SubmitInvoiceResponse.md +24 -0
- data/docs/SubmitNetAmount.md +15 -0
- data/docs/SubmitVatAmount.md +15 -0
- data/docs/SupplementaryAttachment.md +26 -0
- data/docs/Supplier.md +52 -0
- data/docs/TaskResponse.md +18 -0
- data/docs/TaxBreakdownInput.md +22 -0
- data/docs/TaxDueDateType.md +15 -0
- data/docs/TaxRepresentative.md +22 -0
- data/docs/TaxableAmount.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/TotalGrossAmount.md +15 -0
- data/docs/TotalNetAmount.md +15 -0
- data/docs/TotalVATAmount.md +15 -0
- data/docs/TransactionCategory.md +15 -0
- data/docs/TransmissionTypeCode.md +15 -0
- data/docs/UnitNetPrice.md +15 -0
- data/docs/UnitOfMeasure.md +15 -0
- data/docs/VATAccountingCode.md +15 -0
- data/docs/VATAmount.md +15 -0
- data/docs/VATCategory.md +15 -0
- data/docs/VATLine.md +32 -0
- data/docs/VATPointDateCode.md +15 -0
- data/docs/ValidateCDARRequest.md +32 -0
- data/docs/ValidateCDARResponse.md +22 -0
- data/docs/ValidateEReportingRequest.md +18 -0
- data/docs/ValidateEReportingResponse.md +28 -0
- data/docs/ValidationError.md +22 -0
- data/docs/ValidationErrorDetail.md +26 -0
- data/docs/ValidationErrorResponse.md +24 -0
- data/docs/ValidationInfo.md +28 -0
- data/docs/ValidationSuccessResponse.md +18 -0
- data/docs/VatRate.md +15 -0
- data/docs/VerificationSuccessResponse.md +36 -0
- data/docs/VerifiedFieldSchema.md +34 -0
- data/docs/WebhookSecretDeleteResponse.md +20 -0
- data/docs/WebhookSecretGenerateResponse.md +24 -0
- data/docs/WebhookSecretStatusResponse.md +20 -0
- data/factpulse.gemspec +39 -0
- data/git_push.sh +57 -0
- data/lib/factpulse/api/afnorpdppa_api.rb +148 -0
- data/lib/factpulse/api/afnorpdppa_directory_service_api.rb +1183 -0
- data/lib/factpulse/api/afnorpdppa_flow_service_api.rb +289 -0
- data/lib/factpulse/api/async_tasks_api.rb +85 -0
- data/lib/factpulse/api/chorus_pro_api.rb +1105 -0
- data/lib/factpulse/api/client_management_api.rb +831 -0
- data/lib/factpulse/api/downloads_api.rb +151 -0
- data/lib/factpulse/api/electronic_signature_api.rb +339 -0
- data/lib/factpulse/api/factur_x_conversion_api.rb +306 -0
- 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/flux10_e_reporting_api.rb +777 -0
- data/lib/factpulse/api/flux6_invoice_lifecycle_cdar_api.rb +670 -0
- data/lib/factpulse/api/health_api.rb +193 -0
- data/lib/factpulse/api_client.rb +397 -0
- data/lib/factpulse/api_error.rb +58 -0
- data/lib/factpulse/api_model_base.rb +88 -0
- data/lib/factpulse/configuration.rb +319 -0
- data/lib/factpulse/helpers/client.rb +272 -0
- data/lib/factpulse/helpers/exceptions.rb +45 -0
- data/lib/factpulse/helpers/helpers.rb +14 -0
- data/lib/factpulse/models/acknowledgment_status.rb +41 -0
- data/lib/factpulse/models/action_code_info.rb +220 -0
- data/lib/factpulse/models/action_codes_response.rb +207 -0
- data/lib/factpulse/models/additional_document.rb +206 -0
- 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 +169 -0
- data/lib/factpulse/models/afnor_destination.rb +224 -0
- 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/afnor_error.rb +214 -0
- 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 +220 -0
- 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 +270 -0
- 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 +274 -0
- data/lib/factpulse/models/allowance_charge_reason_code.rb +76 -0
- data/lib/factpulse/models/allowance_reason_code.rb +45 -0
- data/lib/factpulse/models/allowance_total_amount.rb +104 -0
- data/lib/factpulse/models/amount.rb +104 -0
- data/lib/factpulse/models/amount1.rb +104 -0
- data/lib/factpulse/models/amount2.rb +104 -0
- data/lib/factpulse/models/amount_due.rb +104 -0
- data/lib/factpulse/models/api_error.rb +205 -0
- data/lib/factpulse/models/api_profile.rb +43 -0
- data/lib/factpulse/models/async_task_status.rb +227 -0
- data/lib/factpulse/models/base_amount.rb +104 -0
- data/lib/factpulse/models/bounding_box_schema.rb +332 -0
- data/lib/factpulse/models/buyercountry.rb +104 -0
- data/lib/factpulse/models/celery_status.rb +43 -0
- data/lib/factpulse/models/certificate_info_response.rb +446 -0
- data/lib/factpulse/models/charge_total_amount.rb +104 -0
- data/lib/factpulse/models/chorus_pro_credentials.rb +259 -0
- data/lib/factpulse/models/chorus_pro_destination.rb +194 -0
- data/lib/factpulse/models/chorus_pro_result.rb +186 -0
- data/lib/factpulse/models/client_activate_response.rb +220 -0
- data/lib/factpulse/models/client_create_request.rb +236 -0
- data/lib/factpulse/models/client_detail.rb +368 -0
- data/lib/factpulse/models/client_list_response.rb +249 -0
- data/lib/factpulse/models/client_summary.rb +368 -0
- data/lib/factpulse/models/client_update_request.rb +225 -0
- data/lib/factpulse/models/contact.rb +179 -0
- data/lib/factpulse/models/convert_resume_request.rb +151 -0
- data/lib/factpulse/models/convert_success_response.rb +360 -0
- data/lib/factpulse/models/convert_validation_failed_response.rb +339 -0
- data/lib/factpulse/models/country_code.rb +208 -0
- data/lib/factpulse/models/create_aggregated_report_request.rb +320 -0
- data/lib/factpulse/models/create_cdar_request.rb +414 -0
- data/lib/factpulse/models/create_e_reporting_request.rb +347 -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 +179 -0
- data/lib/factpulse/models/destination.rb +56 -0
- data/lib/factpulse/models/doc_type.rb +42 -0
- data/lib/factpulse/models/document_type_info.rb +220 -0
- data/lib/factpulse/models/e_reporting_flow_type.rb +42 -0
- data/lib/factpulse/models/e_reporting_validation_error.rb +203 -0
- data/lib/factpulse/models/electronic_address.rb +198 -0
- data/lib/factpulse/models/encaisseamount.rb +104 -0
- data/lib/factpulse/models/encaisseamount1.rb +103 -0
- data/lib/factpulse/models/encaissee_request.rb +347 -0
- data/lib/factpulse/models/enriched_invoice_info.rb +354 -0
- data/lib/factpulse/models/error_level.rb +40 -0
- data/lib/factpulse/models/error_source.rb +47 -0
- data/lib/factpulse/models/extraction_info.rb +217 -0
- data/lib/factpulse/models/factur_x_invoice.rb +580 -0
- data/lib/factpulse/models/factur_xpdf_info.rb +205 -0
- data/lib/factpulse/models/facture_electronique_rest_api_schemas_ereporting_invoice_type_code.rb +43 -0
- data/lib/factpulse/models/facture_electronique_rest_api_schemas_processing_chorus_pro_credentials.rb +191 -0
- data/lib/factpulse/models/facture_electronique_rest_api_schemas_validation_validation_error_response.rb +168 -0
- data/lib/factpulse/models/field_status.rb +43 -0
- data/lib/factpulse/models/file_info.rb +161 -0
- data/lib/factpulse/models/files_info.rb +159 -0
- data/lib/factpulse/models/flow_direction.rb +40 -0
- data/lib/factpulse/models/flow_profile.rb +41 -0
- data/lib/factpulse/models/flow_summary.rb +253 -0
- data/lib/factpulse/models/flow_syntax.rb +43 -0
- data/lib/factpulse/models/flow_type.rb +51 -0
- data/lib/factpulse/models/generate_aggregated_report_response.rb +330 -0
- data/lib/factpulse/models/generate_cdar_response.rb +273 -0
- data/lib/factpulse/models/generate_certificate_request.rb +323 -0
- data/lib/factpulse/models/generate_certificate_response.rb +254 -0
- data/lib/factpulse/models/generate_e_reporting_response.rb +274 -0
- data/lib/factpulse/models/get_chorus_pro_id_request.rb +188 -0
- data/lib/factpulse/models/get_chorus_pro_id_response.rb +230 -0
- data/lib/factpulse/models/get_invoice_request.rb +176 -0
- data/lib/factpulse/models/get_invoice_response.rb +263 -0
- data/lib/factpulse/models/get_structure_request.rb +188 -0
- data/lib/factpulse/models/get_structure_response.rb +263 -0
- data/lib/factpulse/models/global_allowance_amount.rb +104 -0
- data/lib/factpulse/models/gross_unit_price.rb +104 -0
- data/lib/factpulse/models/http_validation_error.rb +149 -0
- data/lib/factpulse/models/incoming_invoice.rb +489 -0
- data/lib/factpulse/models/incoming_supplier.rb +236 -0
- data/lib/factpulse/models/invoice_format.rb +41 -0
- data/lib/factpulse/models/invoice_input.rb +439 -0
- data/lib/factpulse/models/invoice_line.rb +593 -0
- data/lib/factpulse/models/invoice_line_allowance_amount.rb +104 -0
- data/lib/factpulse/models/invoice_note.rb +176 -0
- data/lib/factpulse/models/invoice_payment_input.rb +267 -0
- data/lib/factpulse/models/invoice_references.rb +393 -0
- data/lib/factpulse/models/invoice_status.rb +203 -0
- data/lib/factpulse/models/invoice_totals.rb +312 -0
- data/lib/factpulse/models/invoice_totals_prepayment.rb +104 -0
- data/lib/factpulse/models/invoice_type_code.rb +54 -0
- data/lib/factpulse/models/invoice_type_code_output.rb +54 -0
- data/lib/factpulse/models/invoicing_framework.rb +218 -0
- data/lib/factpulse/models/invoicing_framework_code.rb +42 -0
- data/lib/factpulse/models/issuer_role_code.rb +40 -0
- data/lib/factpulse/models/key_rotation_request.rb +211 -0
- data/lib/factpulse/models/key_rotation_response.rb +232 -0
- data/lib/factpulse/models/line_net_amount.rb +104 -0
- data/lib/factpulse/models/line_sub_type.rb +41 -0
- data/lib/factpulse/models/line_total_amount.rb +104 -0
- data/lib/factpulse/models/location_inner.rb +103 -0
- data/lib/factpulse/models/mandatory_note_schema.rb +265 -0
- data/lib/factpulse/models/manual_rate.rb +104 -0
- data/lib/factpulse/models/manual_vat_rate.rb +104 -0
- data/lib/factpulse/models/missing_field.rb +269 -0
- data/lib/factpulse/models/operation_nature.rb +52 -0
- data/lib/factpulse/models/output_format.rb +40 -0
- data/lib/factpulse/models/page_dimensions_schema.rb +193 -0
- data/lib/factpulse/models/payee.rb +281 -0
- data/lib/factpulse/models/payment_amount_by_rate.rb +191 -0
- data/lib/factpulse/models/payment_card.rb +159 -0
- data/lib/factpulse/models/payment_means.rb +44 -0
- data/lib/factpulse/models/pdf_validation_result_api.rb +523 -0
- data/lib/factpulse/models/pdp_config_response.rb +306 -0
- data/lib/factpulse/models/pdp_config_update_request.rb +315 -0
- data/lib/factpulse/models/pdp_credentials.rb +257 -0
- data/lib/factpulse/models/percentage.rb +104 -0
- data/lib/factpulse/models/postal_address.rb +209 -0
- data/lib/factpulse/models/price_allowance_amount.rb +104 -0
- data/lib/factpulse/models/price_basis_quantity.rb +104 -0
- data/lib/factpulse/models/processing_options.rb +207 -0
- data/lib/factpulse/models/processing_rule.rb +44 -0
- data/lib/factpulse/models/product_characteristic.rb +193 -0
- data/lib/factpulse/models/product_classification.rb +186 -0
- data/lib/factpulse/models/quantity.rb +104 -0
- data/lib/factpulse/models/rate.rb +104 -0
- data/lib/factpulse/models/rate1.rb +104 -0
- data/lib/factpulse/models/reason_code_info.rb +220 -0
- data/lib/factpulse/models/reason_codes_response.rb +207 -0
- data/lib/factpulse/models/recipient.rb +231 -0
- data/lib/factpulse/models/recipient_input.rb +191 -0
- data/lib/factpulse/models/refusee_request.rb +346 -0
- data/lib/factpulse/models/report_issuer.rb +236 -0
- 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 +104 -0
- data/lib/factpulse/models/schematron_validation_error.rb +294 -0
- data/lib/factpulse/models/scheme_id.rb +56 -0
- data/lib/factpulse/models/search_flow_request.rb +306 -0
- data/lib/factpulse/models/search_flow_response.rb +249 -0
- data/lib/factpulse/models/search_services_response.rb +217 -0
- data/lib/factpulse/models/search_structure_request.rb +191 -0
- data/lib/factpulse/models/search_structure_response.rb +216 -0
- data/lib/factpulse/models/secret_status.rb +213 -0
- data/lib/factpulse/models/sellercountry.rb +104 -0
- data/lib/factpulse/models/signature_info.rb +186 -0
- data/lib/factpulse/models/signature_info_api.rb +216 -0
- data/lib/factpulse/models/signature_parameters.rb +235 -0
- data/lib/factpulse/models/simplified_cdar_response.rb +274 -0
- data/lib/factpulse/models/simplified_invoice_data.rb +404 -0
- data/lib/factpulse/models/status_code_info.rb +220 -0
- data/lib/factpulse/models/status_codes_response.rb +207 -0
- data/lib/factpulse/models/structure_info.rb +274 -0
- data/lib/factpulse/models/structure_parameters.rb +175 -0
- data/lib/factpulse/models/structure_service.rb +247 -0
- data/lib/factpulse/models/submission_mode.rb +41 -0
- data/lib/factpulse/models/submit_aggregated_report_request.rb +216 -0
- data/lib/factpulse/models/submit_cdar_request.rb +466 -0
- data/lib/factpulse/models/submit_cdar_response.rb +213 -0
- data/lib/factpulse/models/submit_cdarxml_request.rb +228 -0
- data/lib/factpulse/models/submit_complete_invoice_request.rb +239 -0
- data/lib/factpulse/models/submit_complete_invoice_response.rb +355 -0
- 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 +238 -0
- data/lib/factpulse/models/submit_flow_response.rb +294 -0
- data/lib/factpulse/models/submit_gross_amount.rb +104 -0
- data/lib/factpulse/models/submit_invoice_request.rb +388 -0
- data/lib/factpulse/models/submit_invoice_response.rb +213 -0
- data/lib/factpulse/models/submit_net_amount.rb +104 -0
- data/lib/factpulse/models/submit_vat_amount.rb +104 -0
- data/lib/factpulse/models/supplementary_attachment.rb +274 -0
- data/lib/factpulse/models/supplier.rb +337 -0
- data/lib/factpulse/models/task_response.rb +166 -0
- 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 +220 -0
- data/lib/factpulse/models/taxable_amount.rb +104 -0
- data/lib/factpulse/models/taxableamount.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 +104 -0
- data/lib/factpulse/models/total_net_amount.rb +104 -0
- data/lib/factpulse/models/total_vat_amount.rb +104 -0
- 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 +104 -0
- data/lib/factpulse/models/unit_of_measure.rb +44 -0
- data/lib/factpulse/models/validate_cdar_request.rb +219 -0
- data/lib/factpulse/models/validate_cdar_response.rb +190 -0
- 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 +218 -0
- data/lib/factpulse/models/validation_error_detail.rb +245 -0
- data/lib/factpulse/models/validation_error_response.rb +215 -0
- data/lib/factpulse/models/validation_info.rb +255 -0
- data/lib/factpulse/models/validation_success_response.rb +166 -0
- data/lib/factpulse/models/vat_accounting_code.rb +42 -0
- data/lib/factpulse/models/vat_amount.rb +104 -0
- data/lib/factpulse/models/vat_category.rb +47 -0
- data/lib/factpulse/models/vat_line.rb +272 -0
- data/lib/factpulse/models/vat_point_date_code.rb +41 -0
- data/lib/factpulse/models/vat_rate.rb +104 -0
- data/lib/factpulse/models/verification_success_response.rb +343 -0
- data/lib/factpulse/models/verified_field_schema.rb +334 -0
- data/lib/factpulse/models/webhook_secret_delete_response.rb +193 -0
- data/lib/factpulse/models/webhook_secret_generate_response.rb +247 -0
- data/lib/factpulse/models/webhook_secret_status_response.rb +176 -0
- data/lib/factpulse/version.rb +15 -0
- data/lib/factpulse.rb +369 -0
- metadata +806 -0
|
@@ -0,0 +1,1207 @@
|
|
|
1
|
+
# FactPulse::ChorusProApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://factpulse.fr*
|
|
4
|
+
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
| ------ | ------------ | ----------- |
|
|
7
|
+
| [**ajouter_fichier_api_v1_chorus_pro_transverses_ajouter_fichier_post**](ChorusProApi.md#ajouter_fichier_api_v1_chorus_pro_transverses_ajouter_fichier_post) | **POST** /api/v1/chorus-pro/transverses/ajouter-fichier | Add an attachment |
|
|
8
|
+
| [**completer_facture_api_v1_chorus_pro_factures_completer_post**](ChorusProApi.md#completer_facture_api_v1_chorus_pro_factures_completer_post) | **POST** /api/v1/chorus-pro/factures/completer | Complete a suspended invoice (Supplier) |
|
|
9
|
+
| [**consulter_facture_api_v1_chorus_pro_factures_consulter_post**](ChorusProApi.md#consulter_facture_api_v1_chorus_pro_factures_consulter_post) | **POST** /api/v1/chorus-pro/factures/consulter | Consult invoice status |
|
|
10
|
+
| [**consulter_structure_api_v1_chorus_pro_structures_consulter_post**](ChorusProApi.md#consulter_structure_api_v1_chorus_pro_structures_consulter_post) | **POST** /api/v1/chorus-pro/structures/consulter | Consult structure details |
|
|
11
|
+
| [**lister_services_structure_api_v1_chorus_pro_structures_id_structure_cpp_services_get**](ChorusProApi.md#lister_services_structure_api_v1_chorus_pro_structures_id_structure_cpp_services_get) | **GET** /api/v1/chorus-pro/structures/{id_structure_cpp}/services | List structure services |
|
|
12
|
+
| [**obtenir_id_chorus_pro_depuis_siret_api_v1_chorus_pro_structures_obtenir_id_depuis_siret_post**](ChorusProApi.md#obtenir_id_chorus_pro_depuis_siret_api_v1_chorus_pro_structures_obtenir_id_depuis_siret_post) | **POST** /api/v1/chorus-pro/structures/obtenir-id-depuis-siret | Utility: Get Chorus Pro ID from SIRET |
|
|
13
|
+
| [**rechercher_factures_destinataire_api_v1_chorus_pro_factures_rechercher_destinataire_post**](ChorusProApi.md#rechercher_factures_destinataire_api_v1_chorus_pro_factures_rechercher_destinataire_post) | **POST** /api/v1/chorus-pro/factures/rechercher-destinataire | Search received invoices (Recipient) |
|
|
14
|
+
| [**rechercher_factures_fournisseur_api_v1_chorus_pro_factures_rechercher_fournisseur_post**](ChorusProApi.md#rechercher_factures_fournisseur_api_v1_chorus_pro_factures_rechercher_fournisseur_post) | **POST** /api/v1/chorus-pro/factures/rechercher-fournisseur | Search issued invoices (Supplier) |
|
|
15
|
+
| [**rechercher_structures_api_v1_chorus_pro_structures_rechercher_post**](ChorusProApi.md#rechercher_structures_api_v1_chorus_pro_structures_rechercher_post) | **POST** /api/v1/chorus-pro/structures/rechercher | Search Chorus Pro structures |
|
|
16
|
+
| [**recycler_facture_api_v1_chorus_pro_factures_recycler_post**](ChorusProApi.md#recycler_facture_api_v1_chorus_pro_factures_recycler_post) | **POST** /api/v1/chorus-pro/factures/recycler | Recycle an invoice (Supplier) |
|
|
17
|
+
| [**soumettre_facture_api_v1_chorus_pro_factures_soumettre_post**](ChorusProApi.md#soumettre_facture_api_v1_chorus_pro_factures_soumettre_post) | **POST** /api/v1/chorus-pro/factures/soumettre | Submit an invoice to Chorus Pro |
|
|
18
|
+
| [**telecharger_groupe_factures_api_v1_chorus_pro_factures_telecharger_groupe_post**](ChorusProApi.md#telecharger_groupe_factures_api_v1_chorus_pro_factures_telecharger_groupe_post) | **POST** /api/v1/chorus-pro/factures/telecharger-groupe | Download a group of invoices |
|
|
19
|
+
| [**traiter_facture_recue_api_v1_chorus_pro_factures_traiter_facture_recue_post**](ChorusProApi.md#traiter_facture_recue_api_v1_chorus_pro_factures_traiter_facture_recue_post) | **POST** /api/v1/chorus-pro/factures/traiter-facture-recue | Process a received invoice (Recipient) |
|
|
20
|
+
| [**valideur_consulter_facture_api_v1_chorus_pro_factures_valideur_consulter_post**](ChorusProApi.md#valideur_consulter_facture_api_v1_chorus_pro_factures_valideur_consulter_post) | **POST** /api/v1/chorus-pro/factures/valideur/consulter | Consult an invoice (Validator) |
|
|
21
|
+
| [**valideur_rechercher_factures_api_v1_chorus_pro_factures_valideur_rechercher_post**](ChorusProApi.md#valideur_rechercher_factures_api_v1_chorus_pro_factures_valideur_rechercher_post) | **POST** /api/v1/chorus-pro/factures/valideur/rechercher | Search invoices to validate (Validator) |
|
|
22
|
+
| [**valideur_traiter_facture_api_v1_chorus_pro_factures_valideur_traiter_post**](ChorusProApi.md#valideur_traiter_facture_api_v1_chorus_pro_factures_valideur_traiter_post) | **POST** /api/v1/chorus-pro/factures/valideur/traiter | Validate or reject an invoice (Validator) |
|
|
23
|
+
|
|
24
|
+
|
|
25
|
+
## ajouter_fichier_api_v1_chorus_pro_transverses_ajouter_fichier_post
|
|
26
|
+
|
|
27
|
+
> Object ajouter_fichier_api_v1_chorus_pro_transverses_ajouter_fichier_post(request_body)
|
|
28
|
+
|
|
29
|
+
Add an attachment
|
|
30
|
+
|
|
31
|
+
Add an attachment to the current user account. **Max size**: 10 MB per file **Example payload**: ```json { \"pieceJointeFichier\": \"JVBERi0xLjQKJeLjz9MKNSAwIG9iago8P...\", \"pieceJointeNom\": \"purchase_order.pdf\", \"pieceJointeTypeMime\": \"application/pdf\", \"pieceJointeExtension\": \"PDF\" } ``` **Returns**: The attachment ID (`pieceJointeIdFichier`) to use in `/factures/completer`. **Accepted extensions**: PDF, JPG, PNG, ZIP, XML, etc.
|
|
32
|
+
|
|
33
|
+
### Examples
|
|
34
|
+
|
|
35
|
+
```ruby
|
|
36
|
+
require 'time'
|
|
37
|
+
require 'factpulse'
|
|
38
|
+
# setup authorization
|
|
39
|
+
FactPulse.configure do |config|
|
|
40
|
+
# Configure API key authorization: APIKeyHeader
|
|
41
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
42
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
43
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
44
|
+
|
|
45
|
+
# Configure Bearer authorization: HTTPBearer
|
|
46
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
47
|
+
end
|
|
48
|
+
|
|
49
|
+
api_instance = FactPulse::ChorusProApi.new
|
|
50
|
+
request_body = { key: 3.56} # Hash<String, Object> |
|
|
51
|
+
|
|
52
|
+
begin
|
|
53
|
+
# Add an attachment
|
|
54
|
+
result = api_instance.ajouter_fichier_api_v1_chorus_pro_transverses_ajouter_fichier_post(request_body)
|
|
55
|
+
p result
|
|
56
|
+
rescue FactPulse::ApiError => e
|
|
57
|
+
puts "Error when calling ChorusProApi->ajouter_fichier_api_v1_chorus_pro_transverses_ajouter_fichier_post: #{e}"
|
|
58
|
+
end
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
#### Using the ajouter_fichier_api_v1_chorus_pro_transverses_ajouter_fichier_post_with_http_info variant
|
|
62
|
+
|
|
63
|
+
This returns an Array which contains the response data, status code and headers.
|
|
64
|
+
|
|
65
|
+
> <Array(Object, Integer, Hash)> ajouter_fichier_api_v1_chorus_pro_transverses_ajouter_fichier_post_with_http_info(request_body)
|
|
66
|
+
|
|
67
|
+
```ruby
|
|
68
|
+
begin
|
|
69
|
+
# Add an attachment
|
|
70
|
+
data, status_code, headers = api_instance.ajouter_fichier_api_v1_chorus_pro_transverses_ajouter_fichier_post_with_http_info(request_body)
|
|
71
|
+
p status_code # => 2xx
|
|
72
|
+
p headers # => { ... }
|
|
73
|
+
p data # => Object
|
|
74
|
+
rescue FactPulse::ApiError => e
|
|
75
|
+
puts "Error when calling ChorusProApi->ajouter_fichier_api_v1_chorus_pro_transverses_ajouter_fichier_post_with_http_info: #{e}"
|
|
76
|
+
end
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
### Parameters
|
|
80
|
+
|
|
81
|
+
| Name | Type | Description | Notes |
|
|
82
|
+
| ---- | ---- | ----------- | ----- |
|
|
83
|
+
| **request_body** | [**Hash<String, Object>**](Object.md) | | |
|
|
84
|
+
|
|
85
|
+
### Return type
|
|
86
|
+
|
|
87
|
+
**Object**
|
|
88
|
+
|
|
89
|
+
### Authorization
|
|
90
|
+
|
|
91
|
+
[APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
|
|
92
|
+
|
|
93
|
+
### HTTP request headers
|
|
94
|
+
|
|
95
|
+
- **Content-Type**: application/json
|
|
96
|
+
- **Accept**: application/json
|
|
97
|
+
|
|
98
|
+
|
|
99
|
+
## completer_facture_api_v1_chorus_pro_factures_completer_post
|
|
100
|
+
|
|
101
|
+
> Object completer_facture_api_v1_chorus_pro_factures_completer_post(request_body)
|
|
102
|
+
|
|
103
|
+
Complete a suspended invoice (Supplier)
|
|
104
|
+
|
|
105
|
+
Complete a SUSPENDUE status invoice by adding attachments or a comment. **Required status**: SUSPENDUE **Possible actions**: - Add attachments (supporting documents, purchase orders, etc.) - Modify comment **Example payload**: ```json { \"identifiantFactureCPP\": 12345, \"commentaire\": \"Here are the requested documents\", \"listePiecesJointes\": [ { \"pieceJointeIdFichier\": 98765, \"pieceJointeNom\": \"purchase_order.pdf\" } ] } ``` **Note**: Attachments must first be uploaded via `/transverses/ajouter-fichier`. **After completion**: The invoice returns to MISE_A_DISPOSITION status.
|
|
106
|
+
|
|
107
|
+
### Examples
|
|
108
|
+
|
|
109
|
+
```ruby
|
|
110
|
+
require 'time'
|
|
111
|
+
require 'factpulse'
|
|
112
|
+
# setup authorization
|
|
113
|
+
FactPulse.configure do |config|
|
|
114
|
+
# Configure API key authorization: APIKeyHeader
|
|
115
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
116
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
117
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
118
|
+
|
|
119
|
+
# Configure Bearer authorization: HTTPBearer
|
|
120
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
121
|
+
end
|
|
122
|
+
|
|
123
|
+
api_instance = FactPulse::ChorusProApi.new
|
|
124
|
+
request_body = { key: 3.56} # Hash<String, Object> |
|
|
125
|
+
|
|
126
|
+
begin
|
|
127
|
+
# Complete a suspended invoice (Supplier)
|
|
128
|
+
result = api_instance.completer_facture_api_v1_chorus_pro_factures_completer_post(request_body)
|
|
129
|
+
p result
|
|
130
|
+
rescue FactPulse::ApiError => e
|
|
131
|
+
puts "Error when calling ChorusProApi->completer_facture_api_v1_chorus_pro_factures_completer_post: #{e}"
|
|
132
|
+
end
|
|
133
|
+
```
|
|
134
|
+
|
|
135
|
+
#### Using the completer_facture_api_v1_chorus_pro_factures_completer_post_with_http_info variant
|
|
136
|
+
|
|
137
|
+
This returns an Array which contains the response data, status code and headers.
|
|
138
|
+
|
|
139
|
+
> <Array(Object, Integer, Hash)> completer_facture_api_v1_chorus_pro_factures_completer_post_with_http_info(request_body)
|
|
140
|
+
|
|
141
|
+
```ruby
|
|
142
|
+
begin
|
|
143
|
+
# Complete a suspended invoice (Supplier)
|
|
144
|
+
data, status_code, headers = api_instance.completer_facture_api_v1_chorus_pro_factures_completer_post_with_http_info(request_body)
|
|
145
|
+
p status_code # => 2xx
|
|
146
|
+
p headers # => { ... }
|
|
147
|
+
p data # => Object
|
|
148
|
+
rescue FactPulse::ApiError => e
|
|
149
|
+
puts "Error when calling ChorusProApi->completer_facture_api_v1_chorus_pro_factures_completer_post_with_http_info: #{e}"
|
|
150
|
+
end
|
|
151
|
+
```
|
|
152
|
+
|
|
153
|
+
### Parameters
|
|
154
|
+
|
|
155
|
+
| Name | Type | Description | Notes |
|
|
156
|
+
| ---- | ---- | ----------- | ----- |
|
|
157
|
+
| **request_body** | [**Hash<String, Object>**](Object.md) | | |
|
|
158
|
+
|
|
159
|
+
### Return type
|
|
160
|
+
|
|
161
|
+
**Object**
|
|
162
|
+
|
|
163
|
+
### Authorization
|
|
164
|
+
|
|
165
|
+
[APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
|
|
166
|
+
|
|
167
|
+
### HTTP request headers
|
|
168
|
+
|
|
169
|
+
- **Content-Type**: application/json
|
|
170
|
+
- **Accept**: application/json
|
|
171
|
+
|
|
172
|
+
|
|
173
|
+
## consulter_facture_api_v1_chorus_pro_factures_consulter_post
|
|
174
|
+
|
|
175
|
+
> <GetInvoiceResponse> consulter_facture_api_v1_chorus_pro_factures_consulter_post(get_invoice_request)
|
|
176
|
+
|
|
177
|
+
Consult invoice status
|
|
178
|
+
|
|
179
|
+
Retrieves the information and current status of an invoice submitted to Chorus Pro. **Returns**: - Invoice number and date - Total gross amount - **Current status**: SOUMISE, VALIDEE, REJETEE, SUSPENDUE, MANDATEE, MISE_EN_PAIEMENT, etc. - Recipient structure **Use cases**: - Track the processing progress of an invoice - Check if an invoice has been validated or rejected - Get the payment date **Polling**: Call this endpoint regularly to track status changes.
|
|
180
|
+
|
|
181
|
+
### Examples
|
|
182
|
+
|
|
183
|
+
```ruby
|
|
184
|
+
require 'time'
|
|
185
|
+
require 'factpulse'
|
|
186
|
+
# setup authorization
|
|
187
|
+
FactPulse.configure do |config|
|
|
188
|
+
# Configure API key authorization: APIKeyHeader
|
|
189
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
190
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
191
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
192
|
+
|
|
193
|
+
# Configure Bearer authorization: HTTPBearer
|
|
194
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
195
|
+
end
|
|
196
|
+
|
|
197
|
+
api_instance = FactPulse::ChorusProApi.new
|
|
198
|
+
get_invoice_request = FactPulse::GetInvoiceRequest.new({chorus_invoice_id: 37}) # GetInvoiceRequest |
|
|
199
|
+
|
|
200
|
+
begin
|
|
201
|
+
# Consult invoice status
|
|
202
|
+
result = api_instance.consulter_facture_api_v1_chorus_pro_factures_consulter_post(get_invoice_request)
|
|
203
|
+
p result
|
|
204
|
+
rescue FactPulse::ApiError => e
|
|
205
|
+
puts "Error when calling ChorusProApi->consulter_facture_api_v1_chorus_pro_factures_consulter_post: #{e}"
|
|
206
|
+
end
|
|
207
|
+
```
|
|
208
|
+
|
|
209
|
+
#### Using the consulter_facture_api_v1_chorus_pro_factures_consulter_post_with_http_info variant
|
|
210
|
+
|
|
211
|
+
This returns an Array which contains the response data, status code and headers.
|
|
212
|
+
|
|
213
|
+
> <Array(<GetInvoiceResponse>, Integer, Hash)> consulter_facture_api_v1_chorus_pro_factures_consulter_post_with_http_info(get_invoice_request)
|
|
214
|
+
|
|
215
|
+
```ruby
|
|
216
|
+
begin
|
|
217
|
+
# Consult invoice status
|
|
218
|
+
data, status_code, headers = api_instance.consulter_facture_api_v1_chorus_pro_factures_consulter_post_with_http_info(get_invoice_request)
|
|
219
|
+
p status_code # => 2xx
|
|
220
|
+
p headers # => { ... }
|
|
221
|
+
p data # => <GetInvoiceResponse>
|
|
222
|
+
rescue FactPulse::ApiError => e
|
|
223
|
+
puts "Error when calling ChorusProApi->consulter_facture_api_v1_chorus_pro_factures_consulter_post_with_http_info: #{e}"
|
|
224
|
+
end
|
|
225
|
+
```
|
|
226
|
+
|
|
227
|
+
### Parameters
|
|
228
|
+
|
|
229
|
+
| Name | Type | Description | Notes |
|
|
230
|
+
| ---- | ---- | ----------- | ----- |
|
|
231
|
+
| **get_invoice_request** | [**GetInvoiceRequest**](GetInvoiceRequest.md) | | |
|
|
232
|
+
|
|
233
|
+
### Return type
|
|
234
|
+
|
|
235
|
+
[**GetInvoiceResponse**](GetInvoiceResponse.md)
|
|
236
|
+
|
|
237
|
+
### Authorization
|
|
238
|
+
|
|
239
|
+
[APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
|
|
240
|
+
|
|
241
|
+
### HTTP request headers
|
|
242
|
+
|
|
243
|
+
- **Content-Type**: application/json
|
|
244
|
+
- **Accept**: application/json
|
|
245
|
+
|
|
246
|
+
|
|
247
|
+
## consulter_structure_api_v1_chorus_pro_structures_consulter_post
|
|
248
|
+
|
|
249
|
+
> <GetStructureResponse> consulter_structure_api_v1_chorus_pro_structures_consulter_post(get_structure_request)
|
|
250
|
+
|
|
251
|
+
Consult structure details
|
|
252
|
+
|
|
253
|
+
Retrieves detailed information about a Chorus Pro structure. **Returns**: - Company name - Intra-EU VAT number - Contact email - **Required parameters**: Indicates if service code and/or engagement number are required to submit an invoice **Typical step**: Called after `search-structures` to know which fields are mandatory before submitting an invoice.
|
|
254
|
+
|
|
255
|
+
### Examples
|
|
256
|
+
|
|
257
|
+
```ruby
|
|
258
|
+
require 'time'
|
|
259
|
+
require 'factpulse'
|
|
260
|
+
# setup authorization
|
|
261
|
+
FactPulse.configure do |config|
|
|
262
|
+
# Configure API key authorization: APIKeyHeader
|
|
263
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
264
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
265
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
266
|
+
|
|
267
|
+
# Configure Bearer authorization: HTTPBearer
|
|
268
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
269
|
+
end
|
|
270
|
+
|
|
271
|
+
api_instance = FactPulse::ChorusProApi.new
|
|
272
|
+
get_structure_request = FactPulse::GetStructureRequest.new({structure_id: 37}) # GetStructureRequest |
|
|
273
|
+
|
|
274
|
+
begin
|
|
275
|
+
# Consult structure details
|
|
276
|
+
result = api_instance.consulter_structure_api_v1_chorus_pro_structures_consulter_post(get_structure_request)
|
|
277
|
+
p result
|
|
278
|
+
rescue FactPulse::ApiError => e
|
|
279
|
+
puts "Error when calling ChorusProApi->consulter_structure_api_v1_chorus_pro_structures_consulter_post: #{e}"
|
|
280
|
+
end
|
|
281
|
+
```
|
|
282
|
+
|
|
283
|
+
#### Using the consulter_structure_api_v1_chorus_pro_structures_consulter_post_with_http_info variant
|
|
284
|
+
|
|
285
|
+
This returns an Array which contains the response data, status code and headers.
|
|
286
|
+
|
|
287
|
+
> <Array(<GetStructureResponse>, Integer, Hash)> consulter_structure_api_v1_chorus_pro_structures_consulter_post_with_http_info(get_structure_request)
|
|
288
|
+
|
|
289
|
+
```ruby
|
|
290
|
+
begin
|
|
291
|
+
# Consult structure details
|
|
292
|
+
data, status_code, headers = api_instance.consulter_structure_api_v1_chorus_pro_structures_consulter_post_with_http_info(get_structure_request)
|
|
293
|
+
p status_code # => 2xx
|
|
294
|
+
p headers # => { ... }
|
|
295
|
+
p data # => <GetStructureResponse>
|
|
296
|
+
rescue FactPulse::ApiError => e
|
|
297
|
+
puts "Error when calling ChorusProApi->consulter_structure_api_v1_chorus_pro_structures_consulter_post_with_http_info: #{e}"
|
|
298
|
+
end
|
|
299
|
+
```
|
|
300
|
+
|
|
301
|
+
### Parameters
|
|
302
|
+
|
|
303
|
+
| Name | Type | Description | Notes |
|
|
304
|
+
| ---- | ---- | ----------- | ----- |
|
|
305
|
+
| **get_structure_request** | [**GetStructureRequest**](GetStructureRequest.md) | | |
|
|
306
|
+
|
|
307
|
+
### Return type
|
|
308
|
+
|
|
309
|
+
[**GetStructureResponse**](GetStructureResponse.md)
|
|
310
|
+
|
|
311
|
+
### Authorization
|
|
312
|
+
|
|
313
|
+
[APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
|
|
314
|
+
|
|
315
|
+
### HTTP request headers
|
|
316
|
+
|
|
317
|
+
- **Content-Type**: application/json
|
|
318
|
+
- **Accept**: application/json
|
|
319
|
+
|
|
320
|
+
|
|
321
|
+
## lister_services_structure_api_v1_chorus_pro_structures_id_structure_cpp_services_get
|
|
322
|
+
|
|
323
|
+
> <SearchServicesResponse> lister_services_structure_api_v1_chorus_pro_structures_id_structure_cpp_services_get(id_structure_cpp)
|
|
324
|
+
|
|
325
|
+
List structure services
|
|
326
|
+
|
|
327
|
+
Retrieves the list of active services for a public structure. **Use cases**: - List available services for an administration - Verify that a service code exists before submitting an invoice **Returns**: - List of services with their code, label, and status (active/inactive)
|
|
328
|
+
|
|
329
|
+
### Examples
|
|
330
|
+
|
|
331
|
+
```ruby
|
|
332
|
+
require 'time'
|
|
333
|
+
require 'factpulse'
|
|
334
|
+
# setup authorization
|
|
335
|
+
FactPulse.configure do |config|
|
|
336
|
+
# Configure API key authorization: APIKeyHeader
|
|
337
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
338
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
339
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
340
|
+
|
|
341
|
+
# Configure Bearer authorization: HTTPBearer
|
|
342
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
343
|
+
end
|
|
344
|
+
|
|
345
|
+
api_instance = FactPulse::ChorusProApi.new
|
|
346
|
+
id_structure_cpp = 56 # Integer | Chorus Pro structure ID (idStructureCPP)
|
|
347
|
+
|
|
348
|
+
begin
|
|
349
|
+
# List structure services
|
|
350
|
+
result = api_instance.lister_services_structure_api_v1_chorus_pro_structures_id_structure_cpp_services_get(id_structure_cpp)
|
|
351
|
+
p result
|
|
352
|
+
rescue FactPulse::ApiError => e
|
|
353
|
+
puts "Error when calling ChorusProApi->lister_services_structure_api_v1_chorus_pro_structures_id_structure_cpp_services_get: #{e}"
|
|
354
|
+
end
|
|
355
|
+
```
|
|
356
|
+
|
|
357
|
+
#### Using the lister_services_structure_api_v1_chorus_pro_structures_id_structure_cpp_services_get_with_http_info variant
|
|
358
|
+
|
|
359
|
+
This returns an Array which contains the response data, status code and headers.
|
|
360
|
+
|
|
361
|
+
> <Array(<SearchServicesResponse>, Integer, Hash)> lister_services_structure_api_v1_chorus_pro_structures_id_structure_cpp_services_get_with_http_info(id_structure_cpp)
|
|
362
|
+
|
|
363
|
+
```ruby
|
|
364
|
+
begin
|
|
365
|
+
# List structure services
|
|
366
|
+
data, status_code, headers = api_instance.lister_services_structure_api_v1_chorus_pro_structures_id_structure_cpp_services_get_with_http_info(id_structure_cpp)
|
|
367
|
+
p status_code # => 2xx
|
|
368
|
+
p headers # => { ... }
|
|
369
|
+
p data # => <SearchServicesResponse>
|
|
370
|
+
rescue FactPulse::ApiError => e
|
|
371
|
+
puts "Error when calling ChorusProApi->lister_services_structure_api_v1_chorus_pro_structures_id_structure_cpp_services_get_with_http_info: #{e}"
|
|
372
|
+
end
|
|
373
|
+
```
|
|
374
|
+
|
|
375
|
+
### Parameters
|
|
376
|
+
|
|
377
|
+
| Name | Type | Description | Notes |
|
|
378
|
+
| ---- | ---- | ----------- | ----- |
|
|
379
|
+
| **id_structure_cpp** | **Integer** | Chorus Pro structure ID (idStructureCPP) | |
|
|
380
|
+
|
|
381
|
+
### Return type
|
|
382
|
+
|
|
383
|
+
[**SearchServicesResponse**](SearchServicesResponse.md)
|
|
384
|
+
|
|
385
|
+
### Authorization
|
|
386
|
+
|
|
387
|
+
[APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
|
|
388
|
+
|
|
389
|
+
### HTTP request headers
|
|
390
|
+
|
|
391
|
+
- **Content-Type**: Not defined
|
|
392
|
+
- **Accept**: application/json
|
|
393
|
+
|
|
394
|
+
|
|
395
|
+
## obtenir_id_chorus_pro_depuis_siret_api_v1_chorus_pro_structures_obtenir_id_depuis_siret_post
|
|
396
|
+
|
|
397
|
+
> <GetChorusProIdResponse> obtenir_id_chorus_pro_depuis_siret_api_v1_chorus_pro_structures_obtenir_id_depuis_siret_post(get_chorus_pro_id_request)
|
|
398
|
+
|
|
399
|
+
Utility: Get Chorus Pro ID from SIRET
|
|
400
|
+
|
|
401
|
+
**Convenient utility** to get a structure's Chorus Pro ID from its SIRET. This wrapper function combines: 1. Searching for the structure by SIRET 2. Extracting the `id_structure_cpp` if a single structure is found **Returns**: - `id_structure_cpp`: Chorus Pro ID (0 if not found or multiple results) - `designation_structure`: Structure name (if found) - `message`: Explanatory message **Use cases**: - Shortcut to directly get the Chorus Pro ID before submitting an invoice - Simplified alternative to `search-structures` + manual ID extraction **Note**: If multiple structures match the SIRET (rare), returns 0 and an error message.
|
|
402
|
+
|
|
403
|
+
### Examples
|
|
404
|
+
|
|
405
|
+
```ruby
|
|
406
|
+
require 'time'
|
|
407
|
+
require 'factpulse'
|
|
408
|
+
# setup authorization
|
|
409
|
+
FactPulse.configure do |config|
|
|
410
|
+
# Configure API key authorization: APIKeyHeader
|
|
411
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
412
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
413
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
414
|
+
|
|
415
|
+
# Configure Bearer authorization: HTTPBearer
|
|
416
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
417
|
+
end
|
|
418
|
+
|
|
419
|
+
api_instance = FactPulse::ChorusProApi.new
|
|
420
|
+
get_chorus_pro_id_request = FactPulse::GetChorusProIdRequest.new({siret: 'siret_example'}) # GetChorusProIdRequest |
|
|
421
|
+
|
|
422
|
+
begin
|
|
423
|
+
# Utility: Get Chorus Pro ID from SIRET
|
|
424
|
+
result = api_instance.obtenir_id_chorus_pro_depuis_siret_api_v1_chorus_pro_structures_obtenir_id_depuis_siret_post(get_chorus_pro_id_request)
|
|
425
|
+
p result
|
|
426
|
+
rescue FactPulse::ApiError => e
|
|
427
|
+
puts "Error when calling ChorusProApi->obtenir_id_chorus_pro_depuis_siret_api_v1_chorus_pro_structures_obtenir_id_depuis_siret_post: #{e}"
|
|
428
|
+
end
|
|
429
|
+
```
|
|
430
|
+
|
|
431
|
+
#### Using the obtenir_id_chorus_pro_depuis_siret_api_v1_chorus_pro_structures_obtenir_id_depuis_siret_post_with_http_info variant
|
|
432
|
+
|
|
433
|
+
This returns an Array which contains the response data, status code and headers.
|
|
434
|
+
|
|
435
|
+
> <Array(<GetChorusProIdResponse>, Integer, Hash)> obtenir_id_chorus_pro_depuis_siret_api_v1_chorus_pro_structures_obtenir_id_depuis_siret_post_with_http_info(get_chorus_pro_id_request)
|
|
436
|
+
|
|
437
|
+
```ruby
|
|
438
|
+
begin
|
|
439
|
+
# Utility: Get Chorus Pro ID from SIRET
|
|
440
|
+
data, status_code, headers = api_instance.obtenir_id_chorus_pro_depuis_siret_api_v1_chorus_pro_structures_obtenir_id_depuis_siret_post_with_http_info(get_chorus_pro_id_request)
|
|
441
|
+
p status_code # => 2xx
|
|
442
|
+
p headers # => { ... }
|
|
443
|
+
p data # => <GetChorusProIdResponse>
|
|
444
|
+
rescue FactPulse::ApiError => e
|
|
445
|
+
puts "Error when calling ChorusProApi->obtenir_id_chorus_pro_depuis_siret_api_v1_chorus_pro_structures_obtenir_id_depuis_siret_post_with_http_info: #{e}"
|
|
446
|
+
end
|
|
447
|
+
```
|
|
448
|
+
|
|
449
|
+
### Parameters
|
|
450
|
+
|
|
451
|
+
| Name | Type | Description | Notes |
|
|
452
|
+
| ---- | ---- | ----------- | ----- |
|
|
453
|
+
| **get_chorus_pro_id_request** | [**GetChorusProIdRequest**](GetChorusProIdRequest.md) | | |
|
|
454
|
+
|
|
455
|
+
### Return type
|
|
456
|
+
|
|
457
|
+
[**GetChorusProIdResponse**](GetChorusProIdResponse.md)
|
|
458
|
+
|
|
459
|
+
### Authorization
|
|
460
|
+
|
|
461
|
+
[APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
|
|
462
|
+
|
|
463
|
+
### HTTP request headers
|
|
464
|
+
|
|
465
|
+
- **Content-Type**: application/json
|
|
466
|
+
- **Accept**: application/json
|
|
467
|
+
|
|
468
|
+
|
|
469
|
+
## rechercher_factures_destinataire_api_v1_chorus_pro_factures_rechercher_destinataire_post
|
|
470
|
+
|
|
471
|
+
> Object rechercher_factures_destinataire_api_v1_chorus_pro_factures_rechercher_destinataire_post(request_body)
|
|
472
|
+
|
|
473
|
+
Search received invoices (Recipient)
|
|
474
|
+
|
|
475
|
+
Search invoices received by the connected recipient. **Filters**: - Downloaded / not downloaded - Reception dates - Status (MISE_A_DISPOSITION, SUSPENDUE, etc.) - Supplier **Useful indicator**: `factureTelechargeeParDestinataire` indicates whether the invoice has already been downloaded.
|
|
476
|
+
|
|
477
|
+
### Examples
|
|
478
|
+
|
|
479
|
+
```ruby
|
|
480
|
+
require 'time'
|
|
481
|
+
require 'factpulse'
|
|
482
|
+
# setup authorization
|
|
483
|
+
FactPulse.configure do |config|
|
|
484
|
+
# Configure API key authorization: APIKeyHeader
|
|
485
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
486
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
487
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
488
|
+
|
|
489
|
+
# Configure Bearer authorization: HTTPBearer
|
|
490
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
491
|
+
end
|
|
492
|
+
|
|
493
|
+
api_instance = FactPulse::ChorusProApi.new
|
|
494
|
+
request_body = { key: 3.56} # Hash<String, Object> |
|
|
495
|
+
|
|
496
|
+
begin
|
|
497
|
+
# Search received invoices (Recipient)
|
|
498
|
+
result = api_instance.rechercher_factures_destinataire_api_v1_chorus_pro_factures_rechercher_destinataire_post(request_body)
|
|
499
|
+
p result
|
|
500
|
+
rescue FactPulse::ApiError => e
|
|
501
|
+
puts "Error when calling ChorusProApi->rechercher_factures_destinataire_api_v1_chorus_pro_factures_rechercher_destinataire_post: #{e}"
|
|
502
|
+
end
|
|
503
|
+
```
|
|
504
|
+
|
|
505
|
+
#### Using the rechercher_factures_destinataire_api_v1_chorus_pro_factures_rechercher_destinataire_post_with_http_info variant
|
|
506
|
+
|
|
507
|
+
This returns an Array which contains the response data, status code and headers.
|
|
508
|
+
|
|
509
|
+
> <Array(Object, Integer, Hash)> rechercher_factures_destinataire_api_v1_chorus_pro_factures_rechercher_destinataire_post_with_http_info(request_body)
|
|
510
|
+
|
|
511
|
+
```ruby
|
|
512
|
+
begin
|
|
513
|
+
# Search received invoices (Recipient)
|
|
514
|
+
data, status_code, headers = api_instance.rechercher_factures_destinataire_api_v1_chorus_pro_factures_rechercher_destinataire_post_with_http_info(request_body)
|
|
515
|
+
p status_code # => 2xx
|
|
516
|
+
p headers # => { ... }
|
|
517
|
+
p data # => Object
|
|
518
|
+
rescue FactPulse::ApiError => e
|
|
519
|
+
puts "Error when calling ChorusProApi->rechercher_factures_destinataire_api_v1_chorus_pro_factures_rechercher_destinataire_post_with_http_info: #{e}"
|
|
520
|
+
end
|
|
521
|
+
```
|
|
522
|
+
|
|
523
|
+
### Parameters
|
|
524
|
+
|
|
525
|
+
| Name | Type | Description | Notes |
|
|
526
|
+
| ---- | ---- | ----------- | ----- |
|
|
527
|
+
| **request_body** | [**Hash<String, Object>**](Object.md) | | |
|
|
528
|
+
|
|
529
|
+
### Return type
|
|
530
|
+
|
|
531
|
+
**Object**
|
|
532
|
+
|
|
533
|
+
### Authorization
|
|
534
|
+
|
|
535
|
+
[APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
|
|
536
|
+
|
|
537
|
+
### HTTP request headers
|
|
538
|
+
|
|
539
|
+
- **Content-Type**: application/json
|
|
540
|
+
- **Accept**: application/json
|
|
541
|
+
|
|
542
|
+
|
|
543
|
+
## rechercher_factures_fournisseur_api_v1_chorus_pro_factures_rechercher_fournisseur_post
|
|
544
|
+
|
|
545
|
+
> Object rechercher_factures_fournisseur_api_v1_chorus_pro_factures_rechercher_fournisseur_post(request_body)
|
|
546
|
+
|
|
547
|
+
Search issued invoices (Supplier)
|
|
548
|
+
|
|
549
|
+
Search invoices issued by the connected supplier. **Available filters**: - Invoice number - Dates (start/end) - Status - Recipient structure - Amount **Use cases**: - Track issued invoices - Verify statuses - Export for accounting
|
|
550
|
+
|
|
551
|
+
### Examples
|
|
552
|
+
|
|
553
|
+
```ruby
|
|
554
|
+
require 'time'
|
|
555
|
+
require 'factpulse'
|
|
556
|
+
# setup authorization
|
|
557
|
+
FactPulse.configure do |config|
|
|
558
|
+
# Configure API key authorization: APIKeyHeader
|
|
559
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
560
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
561
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
562
|
+
|
|
563
|
+
# Configure Bearer authorization: HTTPBearer
|
|
564
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
565
|
+
end
|
|
566
|
+
|
|
567
|
+
api_instance = FactPulse::ChorusProApi.new
|
|
568
|
+
request_body = { key: 3.56} # Hash<String, Object> |
|
|
569
|
+
|
|
570
|
+
begin
|
|
571
|
+
# Search issued invoices (Supplier)
|
|
572
|
+
result = api_instance.rechercher_factures_fournisseur_api_v1_chorus_pro_factures_rechercher_fournisseur_post(request_body)
|
|
573
|
+
p result
|
|
574
|
+
rescue FactPulse::ApiError => e
|
|
575
|
+
puts "Error when calling ChorusProApi->rechercher_factures_fournisseur_api_v1_chorus_pro_factures_rechercher_fournisseur_post: #{e}"
|
|
576
|
+
end
|
|
577
|
+
```
|
|
578
|
+
|
|
579
|
+
#### Using the rechercher_factures_fournisseur_api_v1_chorus_pro_factures_rechercher_fournisseur_post_with_http_info variant
|
|
580
|
+
|
|
581
|
+
This returns an Array which contains the response data, status code and headers.
|
|
582
|
+
|
|
583
|
+
> <Array(Object, Integer, Hash)> rechercher_factures_fournisseur_api_v1_chorus_pro_factures_rechercher_fournisseur_post_with_http_info(request_body)
|
|
584
|
+
|
|
585
|
+
```ruby
|
|
586
|
+
begin
|
|
587
|
+
# Search issued invoices (Supplier)
|
|
588
|
+
data, status_code, headers = api_instance.rechercher_factures_fournisseur_api_v1_chorus_pro_factures_rechercher_fournisseur_post_with_http_info(request_body)
|
|
589
|
+
p status_code # => 2xx
|
|
590
|
+
p headers # => { ... }
|
|
591
|
+
p data # => Object
|
|
592
|
+
rescue FactPulse::ApiError => e
|
|
593
|
+
puts "Error when calling ChorusProApi->rechercher_factures_fournisseur_api_v1_chorus_pro_factures_rechercher_fournisseur_post_with_http_info: #{e}"
|
|
594
|
+
end
|
|
595
|
+
```
|
|
596
|
+
|
|
597
|
+
### Parameters
|
|
598
|
+
|
|
599
|
+
| Name | Type | Description | Notes |
|
|
600
|
+
| ---- | ---- | ----------- | ----- |
|
|
601
|
+
| **request_body** | [**Hash<String, Object>**](Object.md) | | |
|
|
602
|
+
|
|
603
|
+
### Return type
|
|
604
|
+
|
|
605
|
+
**Object**
|
|
606
|
+
|
|
607
|
+
### Authorization
|
|
608
|
+
|
|
609
|
+
[APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
|
|
610
|
+
|
|
611
|
+
### HTTP request headers
|
|
612
|
+
|
|
613
|
+
- **Content-Type**: application/json
|
|
614
|
+
- **Accept**: application/json
|
|
615
|
+
|
|
616
|
+
|
|
617
|
+
## rechercher_structures_api_v1_chorus_pro_structures_rechercher_post
|
|
618
|
+
|
|
619
|
+
> <SearchStructureResponse> rechercher_structures_api_v1_chorus_pro_structures_rechercher_post(search_structure_request)
|
|
620
|
+
|
|
621
|
+
Search Chorus Pro structures
|
|
622
|
+
|
|
623
|
+
Search for structures (companies, administrations) registered on Chorus Pro. **Use cases**: - Find the Chorus Pro ID of a structure from its SIRET - Check if a structure is registered on Chorus Pro - List structures matching criteria **Available filters**: - Identifier (SIRET, SIREN, etc.) - Company name - Identifier type - Private structures only **Typical step**: Called before `submit-invoice` to get the recipient's `id_structure_cpp`.
|
|
624
|
+
|
|
625
|
+
### Examples
|
|
626
|
+
|
|
627
|
+
```ruby
|
|
628
|
+
require 'time'
|
|
629
|
+
require 'factpulse'
|
|
630
|
+
# setup authorization
|
|
631
|
+
FactPulse.configure do |config|
|
|
632
|
+
# Configure API key authorization: APIKeyHeader
|
|
633
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
634
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
635
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
636
|
+
|
|
637
|
+
# Configure Bearer authorization: HTTPBearer
|
|
638
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
639
|
+
end
|
|
640
|
+
|
|
641
|
+
api_instance = FactPulse::ChorusProApi.new
|
|
642
|
+
search_structure_request = FactPulse::SearchStructureRequest.new # SearchStructureRequest |
|
|
643
|
+
|
|
644
|
+
begin
|
|
645
|
+
# Search Chorus Pro structures
|
|
646
|
+
result = api_instance.rechercher_structures_api_v1_chorus_pro_structures_rechercher_post(search_structure_request)
|
|
647
|
+
p result
|
|
648
|
+
rescue FactPulse::ApiError => e
|
|
649
|
+
puts "Error when calling ChorusProApi->rechercher_structures_api_v1_chorus_pro_structures_rechercher_post: #{e}"
|
|
650
|
+
end
|
|
651
|
+
```
|
|
652
|
+
|
|
653
|
+
#### Using the rechercher_structures_api_v1_chorus_pro_structures_rechercher_post_with_http_info variant
|
|
654
|
+
|
|
655
|
+
This returns an Array which contains the response data, status code and headers.
|
|
656
|
+
|
|
657
|
+
> <Array(<SearchStructureResponse>, Integer, Hash)> rechercher_structures_api_v1_chorus_pro_structures_rechercher_post_with_http_info(search_structure_request)
|
|
658
|
+
|
|
659
|
+
```ruby
|
|
660
|
+
begin
|
|
661
|
+
# Search Chorus Pro structures
|
|
662
|
+
data, status_code, headers = api_instance.rechercher_structures_api_v1_chorus_pro_structures_rechercher_post_with_http_info(search_structure_request)
|
|
663
|
+
p status_code # => 2xx
|
|
664
|
+
p headers # => { ... }
|
|
665
|
+
p data # => <SearchStructureResponse>
|
|
666
|
+
rescue FactPulse::ApiError => e
|
|
667
|
+
puts "Error when calling ChorusProApi->rechercher_structures_api_v1_chorus_pro_structures_rechercher_post_with_http_info: #{e}"
|
|
668
|
+
end
|
|
669
|
+
```
|
|
670
|
+
|
|
671
|
+
### Parameters
|
|
672
|
+
|
|
673
|
+
| Name | Type | Description | Notes |
|
|
674
|
+
| ---- | ---- | ----------- | ----- |
|
|
675
|
+
| **search_structure_request** | [**SearchStructureRequest**](SearchStructureRequest.md) | | |
|
|
676
|
+
|
|
677
|
+
### Return type
|
|
678
|
+
|
|
679
|
+
[**SearchStructureResponse**](SearchStructureResponse.md)
|
|
680
|
+
|
|
681
|
+
### Authorization
|
|
682
|
+
|
|
683
|
+
[APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
|
|
684
|
+
|
|
685
|
+
### HTTP request headers
|
|
686
|
+
|
|
687
|
+
- **Content-Type**: application/json
|
|
688
|
+
- **Accept**: application/json
|
|
689
|
+
|
|
690
|
+
|
|
691
|
+
## recycler_facture_api_v1_chorus_pro_factures_recycler_post
|
|
692
|
+
|
|
693
|
+
> Object recycler_facture_api_v1_chorus_pro_factures_recycler_post(request_body)
|
|
694
|
+
|
|
695
|
+
Recycle an invoice (Supplier)
|
|
696
|
+
|
|
697
|
+
Recycle an invoice with A_RECYCLER status by modifying routing data. **Required status**: A_RECYCLER **Modifiable fields**: - Recipient (`idStructureCPP`) - Service code - Engagement number **Use cases**: - Wrong recipient - Change of billing service - Update engagement number **Example payload**: ```json { \"identifiantFactureCPP\": 12345, \"idStructureCPP\": 67890, \"codeService\": \"SERVICE_01\", \"numeroEngagement\": \"ENG2024001\" } ``` **Note**: The invoice keeps its number and amounts, only routing fields change.
|
|
698
|
+
|
|
699
|
+
### Examples
|
|
700
|
+
|
|
701
|
+
```ruby
|
|
702
|
+
require 'time'
|
|
703
|
+
require 'factpulse'
|
|
704
|
+
# setup authorization
|
|
705
|
+
FactPulse.configure do |config|
|
|
706
|
+
# Configure API key authorization: APIKeyHeader
|
|
707
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
708
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
709
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
710
|
+
|
|
711
|
+
# Configure Bearer authorization: HTTPBearer
|
|
712
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
713
|
+
end
|
|
714
|
+
|
|
715
|
+
api_instance = FactPulse::ChorusProApi.new
|
|
716
|
+
request_body = { key: 3.56} # Hash<String, Object> |
|
|
717
|
+
|
|
718
|
+
begin
|
|
719
|
+
# Recycle an invoice (Supplier)
|
|
720
|
+
result = api_instance.recycler_facture_api_v1_chorus_pro_factures_recycler_post(request_body)
|
|
721
|
+
p result
|
|
722
|
+
rescue FactPulse::ApiError => e
|
|
723
|
+
puts "Error when calling ChorusProApi->recycler_facture_api_v1_chorus_pro_factures_recycler_post: #{e}"
|
|
724
|
+
end
|
|
725
|
+
```
|
|
726
|
+
|
|
727
|
+
#### Using the recycler_facture_api_v1_chorus_pro_factures_recycler_post_with_http_info variant
|
|
728
|
+
|
|
729
|
+
This returns an Array which contains the response data, status code and headers.
|
|
730
|
+
|
|
731
|
+
> <Array(Object, Integer, Hash)> recycler_facture_api_v1_chorus_pro_factures_recycler_post_with_http_info(request_body)
|
|
732
|
+
|
|
733
|
+
```ruby
|
|
734
|
+
begin
|
|
735
|
+
# Recycle an invoice (Supplier)
|
|
736
|
+
data, status_code, headers = api_instance.recycler_facture_api_v1_chorus_pro_factures_recycler_post_with_http_info(request_body)
|
|
737
|
+
p status_code # => 2xx
|
|
738
|
+
p headers # => { ... }
|
|
739
|
+
p data # => Object
|
|
740
|
+
rescue FactPulse::ApiError => e
|
|
741
|
+
puts "Error when calling ChorusProApi->recycler_facture_api_v1_chorus_pro_factures_recycler_post_with_http_info: #{e}"
|
|
742
|
+
end
|
|
743
|
+
```
|
|
744
|
+
|
|
745
|
+
### Parameters
|
|
746
|
+
|
|
747
|
+
| Name | Type | Description | Notes |
|
|
748
|
+
| ---- | ---- | ----------- | ----- |
|
|
749
|
+
| **request_body** | [**Hash<String, Object>**](Object.md) | | |
|
|
750
|
+
|
|
751
|
+
### Return type
|
|
752
|
+
|
|
753
|
+
**Object**
|
|
754
|
+
|
|
755
|
+
### Authorization
|
|
756
|
+
|
|
757
|
+
[APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
|
|
758
|
+
|
|
759
|
+
### HTTP request headers
|
|
760
|
+
|
|
761
|
+
- **Content-Type**: application/json
|
|
762
|
+
- **Accept**: application/json
|
|
763
|
+
|
|
764
|
+
|
|
765
|
+
## soumettre_facture_api_v1_chorus_pro_factures_soumettre_post
|
|
766
|
+
|
|
767
|
+
> <SubmitInvoiceResponse> soumettre_facture_api_v1_chorus_pro_factures_soumettre_post(submit_invoice_request)
|
|
768
|
+
|
|
769
|
+
Submit an invoice to Chorus Pro
|
|
770
|
+
|
|
771
|
+
Submits an electronic invoice to a public structure via Chorus Pro. **Complete workflow**: 1. **Upload the Factur-X PDF** via `/transverses/ajouter-fichier` → retrieve `pieceJointeId` 2. **Get the structure ID** via `/structures/rechercher` or `/structures/obtenir-id-depuis-siret` 3. **Check mandatory parameters** via `/structures/consulter` 4. **Submit the invoice** with the `piece_jointe_principale_id` obtained in step 1 **Prerequisites**: 1. Have the recipient's `id_structure_cpp` (via `/structures/rechercher`) 2. Know the mandatory parameters (via `/structures/consulter`): - Service code if `code_service_doit_etre_renseigne=true` - Engagement number if `numero_ej_doit_etre_renseigne=true` 3. Have uploaded the Factur-X PDF (via `/transverses/ajouter-fichier`) **Expected format**: - `piece_jointe_principale_id`: ID returned by `/transverses/ajouter-fichier` - Amounts: Strings with 2 decimals (e.g., \"1250.50\") - Dates: ISO 8601 format (YYYY-MM-DD) **Returns**: - `identifiant_facture_cpp`: Chorus Pro ID of the created invoice - `numero_flux_depot`: Deposit tracking number **Possible statuses after submission**: - SOUMISE: Pending validation - VALIDEE: Validated by recipient - REJETEE: Rejected (data error or business refusal) - SUSPENDUE: Pending additional information **Note**: Use `/factures/consulter` to track status changes.
|
|
772
|
+
|
|
773
|
+
### Examples
|
|
774
|
+
|
|
775
|
+
```ruby
|
|
776
|
+
require 'time'
|
|
777
|
+
require 'factpulse'
|
|
778
|
+
# setup authorization
|
|
779
|
+
FactPulse.configure do |config|
|
|
780
|
+
# Configure API key authorization: APIKeyHeader
|
|
781
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
782
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
783
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
784
|
+
|
|
785
|
+
# Configure Bearer authorization: HTTPBearer
|
|
786
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
787
|
+
end
|
|
788
|
+
|
|
789
|
+
api_instance = FactPulse::ChorusProApi.new
|
|
790
|
+
submit_invoice_request = FactPulse::SubmitInvoiceRequest.new({invoice_number: 'invoice_number_example', invoice_date: 'invoice_date_example', structure_id: 37, total_net_amount: FactPulse::SubmitNetAmount.new, vat_amount: FactPulse::SubmitVatAmount.new, total_gross_amount: FactPulse::SubmitGrossAmount.new}) # SubmitInvoiceRequest |
|
|
791
|
+
|
|
792
|
+
begin
|
|
793
|
+
# Submit an invoice to Chorus Pro
|
|
794
|
+
result = api_instance.soumettre_facture_api_v1_chorus_pro_factures_soumettre_post(submit_invoice_request)
|
|
795
|
+
p result
|
|
796
|
+
rescue FactPulse::ApiError => e
|
|
797
|
+
puts "Error when calling ChorusProApi->soumettre_facture_api_v1_chorus_pro_factures_soumettre_post: #{e}"
|
|
798
|
+
end
|
|
799
|
+
```
|
|
800
|
+
|
|
801
|
+
#### Using the soumettre_facture_api_v1_chorus_pro_factures_soumettre_post_with_http_info variant
|
|
802
|
+
|
|
803
|
+
This returns an Array which contains the response data, status code and headers.
|
|
804
|
+
|
|
805
|
+
> <Array(<SubmitInvoiceResponse>, Integer, Hash)> soumettre_facture_api_v1_chorus_pro_factures_soumettre_post_with_http_info(submit_invoice_request)
|
|
806
|
+
|
|
807
|
+
```ruby
|
|
808
|
+
begin
|
|
809
|
+
# Submit an invoice to Chorus Pro
|
|
810
|
+
data, status_code, headers = api_instance.soumettre_facture_api_v1_chorus_pro_factures_soumettre_post_with_http_info(submit_invoice_request)
|
|
811
|
+
p status_code # => 2xx
|
|
812
|
+
p headers # => { ... }
|
|
813
|
+
p data # => <SubmitInvoiceResponse>
|
|
814
|
+
rescue FactPulse::ApiError => e
|
|
815
|
+
puts "Error when calling ChorusProApi->soumettre_facture_api_v1_chorus_pro_factures_soumettre_post_with_http_info: #{e}"
|
|
816
|
+
end
|
|
817
|
+
```
|
|
818
|
+
|
|
819
|
+
### Parameters
|
|
820
|
+
|
|
821
|
+
| Name | Type | Description | Notes |
|
|
822
|
+
| ---- | ---- | ----------- | ----- |
|
|
823
|
+
| **submit_invoice_request** | [**SubmitInvoiceRequest**](SubmitInvoiceRequest.md) | | |
|
|
824
|
+
|
|
825
|
+
### Return type
|
|
826
|
+
|
|
827
|
+
[**SubmitInvoiceResponse**](SubmitInvoiceResponse.md)
|
|
828
|
+
|
|
829
|
+
### Authorization
|
|
830
|
+
|
|
831
|
+
[APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
|
|
832
|
+
|
|
833
|
+
### HTTP request headers
|
|
834
|
+
|
|
835
|
+
- **Content-Type**: application/json
|
|
836
|
+
- **Accept**: application/json
|
|
837
|
+
|
|
838
|
+
|
|
839
|
+
## telecharger_groupe_factures_api_v1_chorus_pro_factures_telecharger_groupe_post
|
|
840
|
+
|
|
841
|
+
> Object telecharger_groupe_factures_api_v1_chorus_pro_factures_telecharger_groupe_post(request_body)
|
|
842
|
+
|
|
843
|
+
Download a group of invoices
|
|
844
|
+
|
|
845
|
+
Download one or more invoices (max 10 recommended) with their attachments. **Available formats**: - PDF: PDF file only - XML: XML file only - ZIP: Archive containing PDF + XML + attachments **Maximum size**: 120 MB per download **Example payload**: ```json { \"listeIdentifiantsFactureCPP\": [12345, 12346], \"inclurePiecesJointes\": true, \"formatFichier\": \"ZIP\" } ``` **Returns**: The file is base64-encoded in the `fichierBase64` field. **Note**: The `factureTelechargeeParDestinataire` flag is automatically updated.
|
|
846
|
+
|
|
847
|
+
### Examples
|
|
848
|
+
|
|
849
|
+
```ruby
|
|
850
|
+
require 'time'
|
|
851
|
+
require 'factpulse'
|
|
852
|
+
# setup authorization
|
|
853
|
+
FactPulse.configure do |config|
|
|
854
|
+
# Configure API key authorization: APIKeyHeader
|
|
855
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
856
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
857
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
858
|
+
|
|
859
|
+
# Configure Bearer authorization: HTTPBearer
|
|
860
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
861
|
+
end
|
|
862
|
+
|
|
863
|
+
api_instance = FactPulse::ChorusProApi.new
|
|
864
|
+
request_body = { key: 3.56} # Hash<String, Object> |
|
|
865
|
+
|
|
866
|
+
begin
|
|
867
|
+
# Download a group of invoices
|
|
868
|
+
result = api_instance.telecharger_groupe_factures_api_v1_chorus_pro_factures_telecharger_groupe_post(request_body)
|
|
869
|
+
p result
|
|
870
|
+
rescue FactPulse::ApiError => e
|
|
871
|
+
puts "Error when calling ChorusProApi->telecharger_groupe_factures_api_v1_chorus_pro_factures_telecharger_groupe_post: #{e}"
|
|
872
|
+
end
|
|
873
|
+
```
|
|
874
|
+
|
|
875
|
+
#### Using the telecharger_groupe_factures_api_v1_chorus_pro_factures_telecharger_groupe_post_with_http_info variant
|
|
876
|
+
|
|
877
|
+
This returns an Array which contains the response data, status code and headers.
|
|
878
|
+
|
|
879
|
+
> <Array(Object, Integer, Hash)> telecharger_groupe_factures_api_v1_chorus_pro_factures_telecharger_groupe_post_with_http_info(request_body)
|
|
880
|
+
|
|
881
|
+
```ruby
|
|
882
|
+
begin
|
|
883
|
+
# Download a group of invoices
|
|
884
|
+
data, status_code, headers = api_instance.telecharger_groupe_factures_api_v1_chorus_pro_factures_telecharger_groupe_post_with_http_info(request_body)
|
|
885
|
+
p status_code # => 2xx
|
|
886
|
+
p headers # => { ... }
|
|
887
|
+
p data # => Object
|
|
888
|
+
rescue FactPulse::ApiError => e
|
|
889
|
+
puts "Error when calling ChorusProApi->telecharger_groupe_factures_api_v1_chorus_pro_factures_telecharger_groupe_post_with_http_info: #{e}"
|
|
890
|
+
end
|
|
891
|
+
```
|
|
892
|
+
|
|
893
|
+
### Parameters
|
|
894
|
+
|
|
895
|
+
| Name | Type | Description | Notes |
|
|
896
|
+
| ---- | ---- | ----------- | ----- |
|
|
897
|
+
| **request_body** | [**Hash<String, Object>**](Object.md) | | |
|
|
898
|
+
|
|
899
|
+
### Return type
|
|
900
|
+
|
|
901
|
+
**Object**
|
|
902
|
+
|
|
903
|
+
### Authorization
|
|
904
|
+
|
|
905
|
+
[APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
|
|
906
|
+
|
|
907
|
+
### HTTP request headers
|
|
908
|
+
|
|
909
|
+
- **Content-Type**: application/json
|
|
910
|
+
- **Accept**: application/json
|
|
911
|
+
|
|
912
|
+
|
|
913
|
+
## traiter_facture_recue_api_v1_chorus_pro_factures_traiter_facture_recue_post
|
|
914
|
+
|
|
915
|
+
> Object traiter_facture_recue_api_v1_chorus_pro_factures_traiter_facture_recue_post(request_body)
|
|
916
|
+
|
|
917
|
+
Process a received invoice (Recipient)
|
|
918
|
+
|
|
919
|
+
Change the status of a received invoice. **Possible statuses**: - MISE_A_DISPOSITION: Invoice accepted - SUSPENDUE: Pending additional information (reason required) - REJETEE: Invoice refused (reason required) - MANDATEE: Invoice mandated - MISE_EN_PAIEMENT: Invoice being paid - COMPTABILISEE: Invoice accounted - MISE_A_DISPOSITION_COMPTABLE: Made available to accounting - A_RECYCLER: To be recycled - COMPLETEE: Completed - SERVICE-FAIT: Service rendered - PRISE_EN_COMPTE_DESTINATAIRE: Acknowledged - TRANSMISE_MOA: Transmitted to MOA **Example payload**: ```json { \"identifiantFactureCPP\": 12345, \"nouveauStatut\": \"REJETEE\", \"motifRejet\": \"Duplicate invoice\", \"commentaire\": \"Invoice already received under reference ABC123\" } ``` **Rules**: - A reason is **required** for SUSPENDUE and REJETEE - Only certain statuses are allowed depending on the invoice's current status
|
|
920
|
+
|
|
921
|
+
### Examples
|
|
922
|
+
|
|
923
|
+
```ruby
|
|
924
|
+
require 'time'
|
|
925
|
+
require 'factpulse'
|
|
926
|
+
# setup authorization
|
|
927
|
+
FactPulse.configure do |config|
|
|
928
|
+
# Configure API key authorization: APIKeyHeader
|
|
929
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
930
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
931
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
932
|
+
|
|
933
|
+
# Configure Bearer authorization: HTTPBearer
|
|
934
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
935
|
+
end
|
|
936
|
+
|
|
937
|
+
api_instance = FactPulse::ChorusProApi.new
|
|
938
|
+
request_body = { key: 3.56} # Hash<String, Object> |
|
|
939
|
+
|
|
940
|
+
begin
|
|
941
|
+
# Process a received invoice (Recipient)
|
|
942
|
+
result = api_instance.traiter_facture_recue_api_v1_chorus_pro_factures_traiter_facture_recue_post(request_body)
|
|
943
|
+
p result
|
|
944
|
+
rescue FactPulse::ApiError => e
|
|
945
|
+
puts "Error when calling ChorusProApi->traiter_facture_recue_api_v1_chorus_pro_factures_traiter_facture_recue_post: #{e}"
|
|
946
|
+
end
|
|
947
|
+
```
|
|
948
|
+
|
|
949
|
+
#### Using the traiter_facture_recue_api_v1_chorus_pro_factures_traiter_facture_recue_post_with_http_info variant
|
|
950
|
+
|
|
951
|
+
This returns an Array which contains the response data, status code and headers.
|
|
952
|
+
|
|
953
|
+
> <Array(Object, Integer, Hash)> traiter_facture_recue_api_v1_chorus_pro_factures_traiter_facture_recue_post_with_http_info(request_body)
|
|
954
|
+
|
|
955
|
+
```ruby
|
|
956
|
+
begin
|
|
957
|
+
# Process a received invoice (Recipient)
|
|
958
|
+
data, status_code, headers = api_instance.traiter_facture_recue_api_v1_chorus_pro_factures_traiter_facture_recue_post_with_http_info(request_body)
|
|
959
|
+
p status_code # => 2xx
|
|
960
|
+
p headers # => { ... }
|
|
961
|
+
p data # => Object
|
|
962
|
+
rescue FactPulse::ApiError => e
|
|
963
|
+
puts "Error when calling ChorusProApi->traiter_facture_recue_api_v1_chorus_pro_factures_traiter_facture_recue_post_with_http_info: #{e}"
|
|
964
|
+
end
|
|
965
|
+
```
|
|
966
|
+
|
|
967
|
+
### Parameters
|
|
968
|
+
|
|
969
|
+
| Name | Type | Description | Notes |
|
|
970
|
+
| ---- | ---- | ----------- | ----- |
|
|
971
|
+
| **request_body** | [**Hash<String, Object>**](Object.md) | | |
|
|
972
|
+
|
|
973
|
+
### Return type
|
|
974
|
+
|
|
975
|
+
**Object**
|
|
976
|
+
|
|
977
|
+
### Authorization
|
|
978
|
+
|
|
979
|
+
[APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
|
|
980
|
+
|
|
981
|
+
### HTTP request headers
|
|
982
|
+
|
|
983
|
+
- **Content-Type**: application/json
|
|
984
|
+
- **Accept**: application/json
|
|
985
|
+
|
|
986
|
+
|
|
987
|
+
## valideur_consulter_facture_api_v1_chorus_pro_factures_valideur_consulter_post
|
|
988
|
+
|
|
989
|
+
> Object valideur_consulter_facture_api_v1_chorus_pro_factures_valideur_consulter_post(request_body)
|
|
990
|
+
|
|
991
|
+
Consult an invoice (Validator)
|
|
992
|
+
|
|
993
|
+
Retrieves detailed information about an invoice for validators. **Use case**: Called by validators (public sector) to consult invoice details before approving or rejecting it. **Required payload**: ```json { \"idFacture\": 123456789 } ``` **Returns**: Complete invoice details including amounts, dates, attachments, and current status.
|
|
994
|
+
|
|
995
|
+
### Examples
|
|
996
|
+
|
|
997
|
+
```ruby
|
|
998
|
+
require 'time'
|
|
999
|
+
require 'factpulse'
|
|
1000
|
+
# setup authorization
|
|
1001
|
+
FactPulse.configure do |config|
|
|
1002
|
+
# Configure API key authorization: APIKeyHeader
|
|
1003
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
1004
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1005
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
1006
|
+
|
|
1007
|
+
# Configure Bearer authorization: HTTPBearer
|
|
1008
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
1009
|
+
end
|
|
1010
|
+
|
|
1011
|
+
api_instance = FactPulse::ChorusProApi.new
|
|
1012
|
+
request_body = { key: 3.56} # Hash<String, Object> |
|
|
1013
|
+
|
|
1014
|
+
begin
|
|
1015
|
+
# Consult an invoice (Validator)
|
|
1016
|
+
result = api_instance.valideur_consulter_facture_api_v1_chorus_pro_factures_valideur_consulter_post(request_body)
|
|
1017
|
+
p result
|
|
1018
|
+
rescue FactPulse::ApiError => e
|
|
1019
|
+
puts "Error when calling ChorusProApi->valideur_consulter_facture_api_v1_chorus_pro_factures_valideur_consulter_post: #{e}"
|
|
1020
|
+
end
|
|
1021
|
+
```
|
|
1022
|
+
|
|
1023
|
+
#### Using the valideur_consulter_facture_api_v1_chorus_pro_factures_valideur_consulter_post_with_http_info variant
|
|
1024
|
+
|
|
1025
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1026
|
+
|
|
1027
|
+
> <Array(Object, Integer, Hash)> valideur_consulter_facture_api_v1_chorus_pro_factures_valideur_consulter_post_with_http_info(request_body)
|
|
1028
|
+
|
|
1029
|
+
```ruby
|
|
1030
|
+
begin
|
|
1031
|
+
# Consult an invoice (Validator)
|
|
1032
|
+
data, status_code, headers = api_instance.valideur_consulter_facture_api_v1_chorus_pro_factures_valideur_consulter_post_with_http_info(request_body)
|
|
1033
|
+
p status_code # => 2xx
|
|
1034
|
+
p headers # => { ... }
|
|
1035
|
+
p data # => Object
|
|
1036
|
+
rescue FactPulse::ApiError => e
|
|
1037
|
+
puts "Error when calling ChorusProApi->valideur_consulter_facture_api_v1_chorus_pro_factures_valideur_consulter_post_with_http_info: #{e}"
|
|
1038
|
+
end
|
|
1039
|
+
```
|
|
1040
|
+
|
|
1041
|
+
### Parameters
|
|
1042
|
+
|
|
1043
|
+
| Name | Type | Description | Notes |
|
|
1044
|
+
| ---- | ---- | ----------- | ----- |
|
|
1045
|
+
| **request_body** | [**Hash<String, Object>**](Object.md) | | |
|
|
1046
|
+
|
|
1047
|
+
### Return type
|
|
1048
|
+
|
|
1049
|
+
**Object**
|
|
1050
|
+
|
|
1051
|
+
### Authorization
|
|
1052
|
+
|
|
1053
|
+
[APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
|
|
1054
|
+
|
|
1055
|
+
### HTTP request headers
|
|
1056
|
+
|
|
1057
|
+
- **Content-Type**: application/json
|
|
1058
|
+
- **Accept**: application/json
|
|
1059
|
+
|
|
1060
|
+
|
|
1061
|
+
## valideur_rechercher_factures_api_v1_chorus_pro_factures_valideur_rechercher_post
|
|
1062
|
+
|
|
1063
|
+
> Object valideur_rechercher_factures_api_v1_chorus_pro_factures_valideur_rechercher_post(request_body)
|
|
1064
|
+
|
|
1065
|
+
Search invoices to validate (Validator)
|
|
1066
|
+
|
|
1067
|
+
Search invoices pending validation by the connected validator. **Role**: Validator in the internal validation workflow. **Filters**: Dates, structure, service, etc.
|
|
1068
|
+
|
|
1069
|
+
### Examples
|
|
1070
|
+
|
|
1071
|
+
```ruby
|
|
1072
|
+
require 'time'
|
|
1073
|
+
require 'factpulse'
|
|
1074
|
+
# setup authorization
|
|
1075
|
+
FactPulse.configure do |config|
|
|
1076
|
+
# Configure API key authorization: APIKeyHeader
|
|
1077
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
1078
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1079
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
1080
|
+
|
|
1081
|
+
# Configure Bearer authorization: HTTPBearer
|
|
1082
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
1083
|
+
end
|
|
1084
|
+
|
|
1085
|
+
api_instance = FactPulse::ChorusProApi.new
|
|
1086
|
+
request_body = { key: 3.56} # Hash<String, Object> |
|
|
1087
|
+
|
|
1088
|
+
begin
|
|
1089
|
+
# Search invoices to validate (Validator)
|
|
1090
|
+
result = api_instance.valideur_rechercher_factures_api_v1_chorus_pro_factures_valideur_rechercher_post(request_body)
|
|
1091
|
+
p result
|
|
1092
|
+
rescue FactPulse::ApiError => e
|
|
1093
|
+
puts "Error when calling ChorusProApi->valideur_rechercher_factures_api_v1_chorus_pro_factures_valideur_rechercher_post: #{e}"
|
|
1094
|
+
end
|
|
1095
|
+
```
|
|
1096
|
+
|
|
1097
|
+
#### Using the valideur_rechercher_factures_api_v1_chorus_pro_factures_valideur_rechercher_post_with_http_info variant
|
|
1098
|
+
|
|
1099
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1100
|
+
|
|
1101
|
+
> <Array(Object, Integer, Hash)> valideur_rechercher_factures_api_v1_chorus_pro_factures_valideur_rechercher_post_with_http_info(request_body)
|
|
1102
|
+
|
|
1103
|
+
```ruby
|
|
1104
|
+
begin
|
|
1105
|
+
# Search invoices to validate (Validator)
|
|
1106
|
+
data, status_code, headers = api_instance.valideur_rechercher_factures_api_v1_chorus_pro_factures_valideur_rechercher_post_with_http_info(request_body)
|
|
1107
|
+
p status_code # => 2xx
|
|
1108
|
+
p headers # => { ... }
|
|
1109
|
+
p data # => Object
|
|
1110
|
+
rescue FactPulse::ApiError => e
|
|
1111
|
+
puts "Error when calling ChorusProApi->valideur_rechercher_factures_api_v1_chorus_pro_factures_valideur_rechercher_post_with_http_info: #{e}"
|
|
1112
|
+
end
|
|
1113
|
+
```
|
|
1114
|
+
|
|
1115
|
+
### Parameters
|
|
1116
|
+
|
|
1117
|
+
| Name | Type | Description | Notes |
|
|
1118
|
+
| ---- | ---- | ----------- | ----- |
|
|
1119
|
+
| **request_body** | [**Hash<String, Object>**](Object.md) | | |
|
|
1120
|
+
|
|
1121
|
+
### Return type
|
|
1122
|
+
|
|
1123
|
+
**Object**
|
|
1124
|
+
|
|
1125
|
+
### Authorization
|
|
1126
|
+
|
|
1127
|
+
[APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
|
|
1128
|
+
|
|
1129
|
+
### HTTP request headers
|
|
1130
|
+
|
|
1131
|
+
- **Content-Type**: application/json
|
|
1132
|
+
- **Accept**: application/json
|
|
1133
|
+
|
|
1134
|
+
|
|
1135
|
+
## valideur_traiter_facture_api_v1_chorus_pro_factures_valideur_traiter_post
|
|
1136
|
+
|
|
1137
|
+
> Object valideur_traiter_facture_api_v1_chorus_pro_factures_valideur_traiter_post(request_body)
|
|
1138
|
+
|
|
1139
|
+
Validate or reject an invoice (Validator)
|
|
1140
|
+
|
|
1141
|
+
Validate or reject an invoice pending validation. **Actions**: - Validate: The invoice moves to the next status in the workflow - Reject: The invoice is rejected (reason required)
|
|
1142
|
+
|
|
1143
|
+
### Examples
|
|
1144
|
+
|
|
1145
|
+
```ruby
|
|
1146
|
+
require 'time'
|
|
1147
|
+
require 'factpulse'
|
|
1148
|
+
# setup authorization
|
|
1149
|
+
FactPulse.configure do |config|
|
|
1150
|
+
# Configure API key authorization: APIKeyHeader
|
|
1151
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
1152
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1153
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
1154
|
+
|
|
1155
|
+
# Configure Bearer authorization: HTTPBearer
|
|
1156
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
1157
|
+
end
|
|
1158
|
+
|
|
1159
|
+
api_instance = FactPulse::ChorusProApi.new
|
|
1160
|
+
request_body = { key: 3.56} # Hash<String, Object> |
|
|
1161
|
+
|
|
1162
|
+
begin
|
|
1163
|
+
# Validate or reject an invoice (Validator)
|
|
1164
|
+
result = api_instance.valideur_traiter_facture_api_v1_chorus_pro_factures_valideur_traiter_post(request_body)
|
|
1165
|
+
p result
|
|
1166
|
+
rescue FactPulse::ApiError => e
|
|
1167
|
+
puts "Error when calling ChorusProApi->valideur_traiter_facture_api_v1_chorus_pro_factures_valideur_traiter_post: #{e}"
|
|
1168
|
+
end
|
|
1169
|
+
```
|
|
1170
|
+
|
|
1171
|
+
#### Using the valideur_traiter_facture_api_v1_chorus_pro_factures_valideur_traiter_post_with_http_info variant
|
|
1172
|
+
|
|
1173
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1174
|
+
|
|
1175
|
+
> <Array(Object, Integer, Hash)> valideur_traiter_facture_api_v1_chorus_pro_factures_valideur_traiter_post_with_http_info(request_body)
|
|
1176
|
+
|
|
1177
|
+
```ruby
|
|
1178
|
+
begin
|
|
1179
|
+
# Validate or reject an invoice (Validator)
|
|
1180
|
+
data, status_code, headers = api_instance.valideur_traiter_facture_api_v1_chorus_pro_factures_valideur_traiter_post_with_http_info(request_body)
|
|
1181
|
+
p status_code # => 2xx
|
|
1182
|
+
p headers # => { ... }
|
|
1183
|
+
p data # => Object
|
|
1184
|
+
rescue FactPulse::ApiError => e
|
|
1185
|
+
puts "Error when calling ChorusProApi->valideur_traiter_facture_api_v1_chorus_pro_factures_valideur_traiter_post_with_http_info: #{e}"
|
|
1186
|
+
end
|
|
1187
|
+
```
|
|
1188
|
+
|
|
1189
|
+
### Parameters
|
|
1190
|
+
|
|
1191
|
+
| Name | Type | Description | Notes |
|
|
1192
|
+
| ---- | ---- | ----------- | ----- |
|
|
1193
|
+
| **request_body** | [**Hash<String, Object>**](Object.md) | | |
|
|
1194
|
+
|
|
1195
|
+
### Return type
|
|
1196
|
+
|
|
1197
|
+
**Object**
|
|
1198
|
+
|
|
1199
|
+
### Authorization
|
|
1200
|
+
|
|
1201
|
+
[APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
|
|
1202
|
+
|
|
1203
|
+
### HTTP request headers
|
|
1204
|
+
|
|
1205
|
+
- **Content-Type**: application/json
|
|
1206
|
+
- **Accept**: application/json
|
|
1207
|
+
|