@factpulse/sdk 3.0.5 → 3.0.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +66 -4
- package/.openapi-generator/VERSION +1 -1
- package/CHANGELOG.md +3 -3
- package/api/document-conversion-api.ts +485 -0
- package/api/invoice-processing-api.ts +34 -34
- package/api.ts +1 -0
- package/dist/api/document-conversion-api.d.ts +226 -0
- package/dist/api/document-conversion-api.js +464 -0
- package/dist/api/invoice-processing-api.d.ts +33 -33
- package/dist/api/invoice-processing-api.js +16 -16
- package/dist/api.d.ts +1 -0
- package/dist/api.js +1 -0
- package/dist/esm/api/document-conversion-api.d.ts +226 -0
- package/dist/esm/api/document-conversion-api.js +454 -0
- package/dist/esm/api/invoice-processing-api.d.ts +33 -33
- package/dist/esm/api/invoice-processing-api.js +16 -16
- package/dist/esm/api.d.ts +1 -0
- package/dist/esm/api.js +1 -0
- package/dist/esm/models/additional-document.d.ts +24 -0
- package/dist/esm/models/additional-document.js +14 -0
- package/dist/esm/models/allowance-charge.d.ts +31 -0
- package/dist/esm/models/allowance-charge.js +14 -0
- package/dist/esm/models/{apiprofile.d.ts → allowance-total-amount.d.ts} +3 -8
- package/dist/esm/models/allowance-total-amount.js +14 -0
- package/dist/esm/models/amount-due.d.ts +1 -1
- package/dist/{models/apiprofile.d.ts → esm/models/amount.d.ts} +3 -8
- package/dist/esm/models/amount.js +14 -0
- package/dist/esm/models/base-amount.d.ts +16 -0
- package/dist/esm/models/base-amount.js +14 -0
- package/dist/esm/models/charge-total-amount.d.ts +16 -0
- package/dist/esm/models/charge-total-amount.js +14 -0
- package/dist/esm/models/contact.d.ts +20 -0
- package/dist/esm/models/contact.js +14 -0
- package/dist/esm/models/convert-error-response.d.ts +27 -0
- package/dist/esm/models/convert-error-response.js +14 -0
- package/dist/esm/models/convert-pending-input-response.d.ts +31 -0
- package/dist/esm/models/convert-pending-input-response.js +14 -0
- package/dist/esm/models/convert-resume-request.d.ts +22 -0
- package/dist/esm/models/convert-resume-request.js +14 -0
- package/dist/esm/models/{document-type.d.ts → convert-success-response.d.ts} +29 -19
- package/dist/esm/models/convert-success-response.js +14 -0
- package/dist/{models/document-type.d.ts → esm/models/convert-validation-failed-response.d.ts} +25 -20
- package/dist/esm/models/convert-validation-failed-response.js +14 -0
- package/dist/esm/models/delivery-party.d.ts +22 -0
- package/dist/esm/models/delivery-party.js +14 -0
- package/dist/esm/models/document-type-info.d.ts +28 -0
- package/dist/esm/models/document-type-info.js +14 -0
- package/dist/esm/models/extraction-info.d.ts +32 -0
- package/dist/esm/models/extraction-info.js +14 -0
- package/dist/esm/models/factur-xinvoice.d.ts +19 -0
- package/dist/esm/models/factur-xprofile.d.ts +21 -0
- package/{models/apiprofile.ts → dist/esm/models/factur-xprofile.js} +5 -14
- package/dist/esm/models/facture-electronique-rest-api-schemas-chorus-pro-chorus-pro-credentials.d.ts +4 -4
- package/dist/esm/models/file-info.d.ts +21 -0
- package/dist/esm/models/file-info.js +14 -0
- package/dist/esm/models/files-info.d.ts +19 -0
- package/dist/esm/models/files-info.js +14 -0
- package/dist/esm/models/generate-certificate-request.d.ts +5 -5
- package/dist/esm/models/get-chorus-pro-id-request.d.ts +1 -1
- package/dist/esm/models/get-invoice-request.d.ts +1 -1
- package/dist/esm/models/get-structure-request.d.ts +2 -2
- package/dist/esm/models/global-allowance-amount.d.ts +1 -1
- package/dist/esm/models/gross-unit-price.d.ts +16 -0
- package/dist/esm/models/gross-unit-price.js +14 -0
- package/dist/esm/models/incoming-invoice.d.ts +2 -2
- package/dist/esm/models/index.d.ts +32 -2
- package/dist/esm/models/index.js +32 -2
- package/dist/esm/models/invoice-line-allowance-amount.d.ts +1 -1
- package/dist/esm/models/invoice-line.d.ts +40 -6
- package/dist/esm/models/invoice-references.d.ts +20 -1
- package/dist/esm/models/invoice-totals-prepayment.d.ts +1 -1
- package/dist/esm/models/invoice-totals.d.ts +10 -2
- package/dist/esm/models/line-net-amount.d.ts +1 -1
- package/dist/esm/models/line-total-amount.d.ts +16 -0
- package/dist/esm/models/line-total-amount.js +14 -0
- package/dist/esm/models/manual-rate.d.ts +1 -1
- package/dist/esm/models/manual-vat-rate.d.ts +1 -1
- package/dist/esm/models/missing-field.d.ts +34 -0
- package/dist/esm/models/missing-field.js +14 -0
- package/dist/esm/models/payee.d.ts +2 -0
- package/dist/esm/models/payment-card.d.ts +18 -0
- package/dist/esm/models/payment-card.js +14 -0
- package/dist/esm/models/pdpcredentials.d.ts +5 -5
- package/dist/esm/models/percentage.d.ts +16 -0
- package/dist/esm/models/percentage.js +14 -0
- package/dist/esm/models/postal-address.d.ts +3 -1
- package/dist/esm/models/price-allowance-amount.d.ts +16 -0
- package/dist/esm/models/price-allowance-amount.js +14 -0
- package/dist/esm/models/price-basis-quantity.d.ts +16 -0
- package/dist/esm/models/price-basis-quantity.js +14 -0
- package/dist/esm/models/processing-options.d.ts +3 -3
- package/dist/esm/models/product-characteristic.d.ts +24 -0
- package/dist/esm/models/product-characteristic.js +14 -0
- package/dist/esm/models/product-classification.d.ts +22 -0
- package/dist/esm/models/product-classification.js +14 -0
- package/dist/esm/models/quantity.d.ts +1 -1
- package/dist/esm/models/recipient.d.ts +5 -1
- package/dist/esm/models/rounding-amount.d.ts +16 -0
- package/dist/esm/models/rounding-amount.js +14 -0
- package/dist/esm/models/scheme-id.d.ts +11 -5
- package/dist/esm/models/scheme-id.js +11 -5
- package/dist/esm/models/search-flow-request.d.ts +7 -7
- package/dist/esm/models/search-structure-request.d.ts +4 -4
- package/dist/esm/models/submit-flow-request.d.ts +6 -6
- package/dist/esm/models/submit-invoice-request.d.ts +13 -13
- package/dist/esm/models/supplier.d.ts +10 -1
- package/dist/esm/models/tax-representative.d.ts +29 -0
- package/dist/esm/models/tax-representative.js +14 -0
- package/dist/esm/models/taxable-amount.d.ts +1 -1
- package/dist/esm/models/total-gross-amount.d.ts +1 -1
- package/dist/esm/models/total-net-amount.d.ts +1 -1
- package/dist/esm/models/total-vatamount.d.ts +1 -1
- package/dist/esm/models/unit-net-price.d.ts +1 -1
- package/dist/esm/models/validation-info.d.ts +38 -0
- package/dist/esm/models/validation-info.js +14 -0
- package/dist/esm/models/vat-rate.d.ts +16 -0
- package/dist/esm/models/vat-rate.js +14 -0
- package/dist/esm/models/vatamount.d.ts +1 -1
- package/dist/esm/models/vatline.d.ts +3 -1
- package/dist/esm/models/vatpoint-date-code.d.ts +20 -0
- package/dist/esm/models/{apiprofile.js → vatpoint-date-code.js} +5 -6
- package/dist/models/additional-document.d.ts +24 -0
- package/dist/models/{apiprofile.js → additional-document.js} +0 -10
- package/dist/models/allowance-charge.d.ts +31 -0
- package/dist/models/allowance-charge.js +15 -0
- package/dist/models/allowance-total-amount.d.ts +16 -0
- package/dist/models/allowance-total-amount.js +15 -0
- package/dist/models/amount-due.d.ts +1 -1
- package/dist/models/amount.d.ts +16 -0
- package/dist/models/amount.js +15 -0
- package/dist/models/base-amount.d.ts +16 -0
- package/dist/models/base-amount.js +15 -0
- package/dist/models/charge-total-amount.d.ts +16 -0
- package/dist/models/charge-total-amount.js +15 -0
- package/dist/models/contact.d.ts +20 -0
- package/dist/models/contact.js +15 -0
- package/dist/models/convert-error-response.d.ts +27 -0
- package/dist/models/convert-error-response.js +15 -0
- package/dist/models/convert-pending-input-response.d.ts +31 -0
- package/dist/models/convert-pending-input-response.js +15 -0
- package/dist/models/convert-resume-request.d.ts +22 -0
- package/dist/models/convert-resume-request.js +15 -0
- package/dist/models/convert-success-response.d.ts +47 -0
- package/dist/models/convert-success-response.js +15 -0
- package/dist/models/{document-type.js → convert-validation-failed-response.d.ts} +25 -24
- package/dist/models/convert-validation-failed-response.js +15 -0
- package/dist/models/delivery-party.d.ts +22 -0
- package/dist/models/delivery-party.js +15 -0
- package/dist/models/document-type-info.d.ts +28 -0
- package/dist/models/document-type-info.js +15 -0
- package/dist/models/extraction-info.d.ts +32 -0
- package/dist/models/extraction-info.js +15 -0
- package/dist/models/factur-xinvoice.d.ts +19 -0
- package/dist/models/factur-xprofile.d.ts +21 -0
- package/dist/models/factur-xprofile.js +25 -0
- package/dist/models/facture-electronique-rest-api-schemas-chorus-pro-chorus-pro-credentials.d.ts +4 -4
- package/dist/models/file-info.d.ts +21 -0
- package/dist/models/file-info.js +15 -0
- package/dist/models/files-info.d.ts +19 -0
- package/dist/models/files-info.js +15 -0
- package/dist/models/generate-certificate-request.d.ts +5 -5
- package/dist/models/get-chorus-pro-id-request.d.ts +1 -1
- package/dist/models/get-invoice-request.d.ts +1 -1
- package/dist/models/get-structure-request.d.ts +2 -2
- package/dist/models/global-allowance-amount.d.ts +1 -1
- package/dist/models/gross-unit-price.d.ts +16 -0
- package/dist/models/gross-unit-price.js +15 -0
- package/dist/models/incoming-invoice.d.ts +2 -2
- package/dist/models/index.d.ts +32 -2
- package/dist/models/index.js +32 -2
- package/dist/models/invoice-line-allowance-amount.d.ts +1 -1
- package/dist/models/invoice-line.d.ts +40 -6
- package/dist/models/invoice-references.d.ts +20 -1
- package/dist/models/invoice-totals-prepayment.d.ts +1 -1
- package/dist/models/invoice-totals.d.ts +10 -2
- package/dist/models/line-net-amount.d.ts +1 -1
- package/dist/models/line-total-amount.d.ts +16 -0
- package/dist/models/line-total-amount.js +15 -0
- package/dist/models/manual-rate.d.ts +1 -1
- package/dist/models/manual-vat-rate.d.ts +1 -1
- package/dist/models/missing-field.d.ts +34 -0
- package/dist/models/missing-field.js +15 -0
- package/dist/models/payee.d.ts +2 -0
- package/dist/models/payment-card.d.ts +18 -0
- package/dist/models/payment-card.js +15 -0
- package/dist/models/pdpcredentials.d.ts +5 -5
- package/dist/models/percentage.d.ts +16 -0
- package/dist/models/percentage.js +15 -0
- package/dist/models/postal-address.d.ts +3 -1
- package/dist/models/price-allowance-amount.d.ts +16 -0
- package/dist/models/price-allowance-amount.js +15 -0
- package/dist/models/price-basis-quantity.d.ts +16 -0
- package/dist/models/price-basis-quantity.js +15 -0
- package/dist/models/processing-options.d.ts +3 -3
- package/dist/models/product-characteristic.d.ts +24 -0
- package/dist/models/product-characteristic.js +15 -0
- package/dist/models/product-classification.d.ts +22 -0
- package/dist/models/product-classification.js +15 -0
- package/dist/models/quantity.d.ts +1 -1
- package/dist/models/recipient.d.ts +5 -1
- package/dist/models/rounding-amount.d.ts +16 -0
- package/dist/models/rounding-amount.js +15 -0
- package/dist/models/scheme-id.d.ts +11 -5
- package/dist/models/scheme-id.js +11 -5
- package/dist/models/search-flow-request.d.ts +7 -7
- package/dist/models/search-structure-request.d.ts +4 -4
- package/dist/models/submit-flow-request.d.ts +6 -6
- package/dist/models/submit-invoice-request.d.ts +13 -13
- package/dist/models/supplier.d.ts +10 -1
- package/dist/models/tax-representative.d.ts +29 -0
- package/dist/models/tax-representative.js +15 -0
- package/dist/models/taxable-amount.d.ts +1 -1
- package/dist/models/total-gross-amount.d.ts +1 -1
- package/dist/models/total-net-amount.d.ts +1 -1
- package/dist/models/total-vatamount.d.ts +1 -1
- package/dist/models/unit-net-price.d.ts +1 -1
- package/dist/models/validation-info.d.ts +38 -0
- package/dist/models/validation-info.js +15 -0
- package/dist/models/vat-rate.d.ts +16 -0
- package/dist/models/vat-rate.js +15 -0
- package/dist/models/vatamount.d.ts +1 -1
- package/dist/models/vatline.d.ts +3 -1
- package/dist/models/vatpoint-date-code.d.ts +20 -0
- package/dist/models/vatpoint-date-code.js +24 -0
- package/docs/AdditionalDocument.md +29 -0
- package/docs/AllowanceCharge.md +35 -0
- package/docs/AllowanceTotalAmount.md +19 -0
- package/docs/Amount.md +19 -0
- package/docs/AmountDue.md +1 -1
- package/docs/BaseAmount.md +19 -0
- package/docs/ChargeTotalAmount.md +19 -0
- package/docs/Contact.md +27 -0
- package/docs/ConvertErrorResponse.md +29 -0
- package/docs/ConvertPendingInputResponse.md +35 -0
- package/docs/ConvertResumeRequest.md +21 -0
- package/docs/ConvertSuccessResponse.md +39 -0
- package/docs/ConvertValidationFailedResponse.md +37 -0
- package/docs/DeliveryParty.md +27 -0
- package/docs/DocumentConversionApi.md +297 -0
- package/docs/DocumentTypeInfo.md +25 -0
- package/docs/ExtractionInfo.md +27 -0
- package/docs/FacturXInvoice.md +28 -0
- package/docs/{APIProfile.md → FacturXProfile.md} +2 -2
- package/docs/FactureElectroniqueRestApiSchemasChorusProChorusProCredentials.md +8 -8
- package/docs/FileInfo.md +23 -0
- package/docs/FilesInfo.md +23 -0
- package/docs/GenerateCertificateRequest.md +10 -10
- package/docs/GetChorusProIdRequest.md +2 -2
- package/docs/GetInvoiceRequest.md +2 -2
- package/docs/GetStructureRequest.md +4 -4
- package/docs/GlobalAllowanceAmount.md +1 -1
- package/docs/GrossUnitPrice.md +19 -0
- package/docs/IncomingInvoice.md +1 -1
- package/docs/InvoiceLine.md +48 -14
- package/docs/InvoiceLineAllowanceAmount.md +1 -1
- package/docs/InvoiceProcessingApi.md +8 -8
- package/docs/InvoiceReferences.md +25 -5
- package/docs/InvoiceTotals.md +11 -3
- package/docs/InvoiceTotalsPrepayment.md +1 -1
- package/docs/LineNetAmount.md +1 -1
- package/docs/LineTotalAmount.md +19 -0
- package/docs/ManualRate.md +1 -1
- package/docs/ManualVatRate.md +1 -1
- package/docs/MissingField.md +31 -0
- package/docs/PDPCredentials.md +10 -10
- package/docs/Payee.md +4 -0
- package/docs/PaymentCard.md +23 -0
- package/docs/Percentage.md +19 -0
- package/docs/PostalAddress.md +5 -1
- package/docs/PriceAllowanceAmount.md +19 -0
- package/docs/PriceBasisQuantity.md +19 -0
- package/docs/ProcessingOptions.md +3 -3
- package/docs/ProductCharacteristic.md +23 -0
- package/docs/ProductClassification.md +25 -0
- package/docs/Quantity.md +1 -1
- package/docs/Recipient.md +7 -1
- package/docs/RoundingAmount.md +19 -0
- package/docs/SchemeID.md +17 -5
- package/docs/SearchFlowRequest.md +14 -14
- package/docs/SearchStructureRequest.md +8 -8
- package/docs/SubmitFlowRequest.md +12 -12
- package/docs/SubmitInvoiceRequest.md +26 -26
- package/docs/Supplier.md +17 -1
- package/docs/TaxRepresentative.md +25 -0
- package/docs/TaxableAmount.md +1 -1
- package/docs/TotalGrossAmount.md +1 -1
- package/docs/TotalNetAmount.md +1 -1
- package/docs/TotalVATAmount.md +1 -1
- package/docs/UnitNetPrice.md +1 -1
- package/docs/VATAmount.md +1 -1
- package/docs/VATLine.md +3 -1
- package/docs/VATPointDateCode.md +13 -0
- package/docs/ValidationInfo.md +31 -0
- package/docs/VatRate.md +19 -0
- package/models/additional-document.ts +30 -0
- package/models/{document-type.ts → allowance-charge.ts} +25 -27
- package/models/allowance-total-amount.ts +22 -0
- package/models/amount-due.ts +1 -1
- package/models/amount.ts +22 -0
- package/models/base-amount.ts +22 -0
- package/models/charge-total-amount.ts +22 -0
- package/models/contact.ts +26 -0
- package/models/convert-error-response.ts +33 -0
- package/models/convert-pending-input-response.ts +39 -0
- package/models/convert-resume-request.ts +26 -0
- package/models/convert-success-response.ts +59 -0
- package/models/convert-validation-failed-response.ts +52 -0
- package/models/delivery-party.ts +32 -0
- package/models/document-type-info.ts +34 -0
- package/models/extraction-info.ts +38 -0
- package/models/factur-xinvoice.ts +29 -0
- package/models/factur-xprofile.ts +31 -0
- package/models/facture-electronique-rest-api-schemas-chorus-pro-chorus-pro-credentials.ts +4 -4
- package/models/file-info.ts +27 -0
- package/models/files-info.ts +27 -0
- package/models/generate-certificate-request.ts +5 -5
- package/models/get-chorus-pro-id-request.ts +1 -1
- package/models/get-invoice-request.ts +1 -1
- package/models/get-structure-request.ts +2 -2
- package/models/global-allowance-amount.ts +1 -1
- package/models/gross-unit-price.ts +22 -0
- package/models/incoming-invoice.ts +4 -4
- package/models/index.ts +32 -2
- package/models/invoice-line-allowance-amount.ts +1 -1
- package/models/invoice-line.ts +56 -6
- package/models/invoice-references.ts +20 -1
- package/models/invoice-totals-prepayment.ts +1 -1
- package/models/invoice-totals.ts +18 -2
- package/models/line-net-amount.ts +1 -1
- package/models/line-total-amount.ts +22 -0
- package/models/manual-rate.ts +1 -1
- package/models/manual-vat-rate.ts +1 -1
- package/models/missing-field.ts +40 -0
- package/models/payee.ts +2 -0
- package/models/payment-card.ts +24 -0
- package/models/pdpcredentials.ts +5 -5
- package/models/percentage.ts +22 -0
- package/models/postal-address.ts +3 -1
- package/models/price-allowance-amount.ts +22 -0
- package/models/price-basis-quantity.ts +22 -0
- package/models/processing-options.ts +3 -3
- package/models/product-characteristic.ts +30 -0
- package/models/product-classification.ts +28 -0
- package/models/quantity.ts +1 -1
- package/models/recipient.ts +7 -1
- package/models/rounding-amount.ts +22 -0
- package/models/scheme-id.ts +11 -5
- package/models/search-flow-request.ts +7 -7
- package/models/search-structure-request.ts +4 -4
- package/models/submit-flow-request.ts +6 -6
- package/models/submit-invoice-request.ts +13 -13
- package/models/supplier.ts +12 -1
- package/models/tax-representative.ts +37 -0
- package/models/taxable-amount.ts +1 -1
- package/models/total-gross-amount.ts +1 -1
- package/models/total-net-amount.ts +1 -1
- package/models/total-vatamount.ts +1 -1
- package/models/unit-net-price.ts +1 -1
- package/{dist/esm/models/document-type.js → models/validation-info.ts} +28 -20
- package/models/vat-rate.ts +22 -0
- package/models/vatamount.ts +1 -1
- package/models/vatline.ts +5 -1
- package/models/vatpoint-date-code.ts +30 -0
- package/package.json +1 -1
- package/docs/DocumentType.md +0 -17
|
@@ -0,0 +1,297 @@
|
|
|
1
|
+
# DocumentConversionApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *http://localhost*
|
|
4
|
+
|
|
5
|
+
|Method | HTTP request | Description|
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
|[**convertDocumentApiV1ConvertPost**](#convertdocumentapiv1convertpost) | **POST** /api/v1/convert | Convertir un document en Factur-X|
|
|
8
|
+
|[**convertDocumentAsyncApiV1ConvertAsyncPost**](#convertdocumentasyncapiv1convertasyncpost) | **POST** /api/v1/convert/async | Convertir un document en Factur-X (mode asynchrone)|
|
|
9
|
+
|[**downloadFileApiV1ConvertConversionIdDownloadFilenameGet**](#downloadfileapiv1convertconversioniddownloadfilenameget) | **GET** /api/v1/convert/{conversion_id}/download/{filename} | Télécharger un fichier généré|
|
|
10
|
+
|[**getConversionStatusApiV1ConvertConversionIdStatusGet**](#getconversionstatusapiv1convertconversionidstatusget) | **GET** /api/v1/convert/{conversion_id}/status | Vérifier le statut d\'une conversion|
|
|
11
|
+
|[**resumeConversionApiV1ConvertConversionIdResumePost**](#resumeconversionapiv1convertconversionidresumepost) | **POST** /api/v1/convert/{conversion_id}/resume | Reprendre une conversion avec corrections|
|
|
12
|
+
|
|
13
|
+
# **convertDocumentApiV1ConvertPost**
|
|
14
|
+
> ConvertSuccessResponse convertDocumentApiV1ConvertPost()
|
|
15
|
+
|
|
16
|
+
Convertit un document (PDF, DOCX, XLSX, image) en Factur-X conforme. ## Workflow 1. **Upload** : Le document est envoyé en multipart/form-data 2. **Extraction OCR + Classification** : Mistral OCR extrait les données et classifie le document en un seul appel 3. **Enrichissement** : Les données sont enrichies via SIRENE (SIRET → raison sociale) 4. **Validation** : Les règles Schematron sont appliquées 5. **Génération** : Le Factur-X PDF/A-3 est généré ## Réponses possibles - **200** : Conversion réussie, fichiers disponibles - **202** : Données manquantes, complétion requise - **422** : Validation échouée, corrections nécessaires - **400** : Fichier invalide - **429** : Quota dépassé
|
|
17
|
+
|
|
18
|
+
### Example
|
|
19
|
+
|
|
20
|
+
```typescript
|
|
21
|
+
import {
|
|
22
|
+
DocumentConversionApi,
|
|
23
|
+
Configuration
|
|
24
|
+
} from '@factpulse/sdk';
|
|
25
|
+
|
|
26
|
+
const configuration = new Configuration();
|
|
27
|
+
const apiInstance = new DocumentConversionApi(configuration);
|
|
28
|
+
|
|
29
|
+
let file: File; //Document à convertir (PDF, DOCX, XLSX, JPG, PNG) (default to undefined)
|
|
30
|
+
let output: string; //Format de sortie: pdf, xml, both (optional) (default to 'pdf')
|
|
31
|
+
let callbackUrl: string; // (optional) (default to undefined)
|
|
32
|
+
|
|
33
|
+
const { status, data } = await apiInstance.convertDocumentApiV1ConvertPost(
|
|
34
|
+
file,
|
|
35
|
+
output,
|
|
36
|
+
callbackUrl
|
|
37
|
+
);
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
### Parameters
|
|
41
|
+
|
|
42
|
+
|Name | Type | Description | Notes|
|
|
43
|
+
|------------- | ------------- | ------------- | -------------|
|
|
44
|
+
| **file** | [**File**] | Document à convertir (PDF, DOCX, XLSX, JPG, PNG) | defaults to undefined|
|
|
45
|
+
| **output** | [**string**] | Format de sortie: pdf, xml, both | (optional) defaults to 'pdf'|
|
|
46
|
+
| **callbackUrl** | [**string**] | | (optional) defaults to undefined|
|
|
47
|
+
|
|
48
|
+
|
|
49
|
+
### Return type
|
|
50
|
+
|
|
51
|
+
**ConvertSuccessResponse**
|
|
52
|
+
|
|
53
|
+
### Authorization
|
|
54
|
+
|
|
55
|
+
[HTTPBearer](../README.md#HTTPBearer)
|
|
56
|
+
|
|
57
|
+
### HTTP request headers
|
|
58
|
+
|
|
59
|
+
- **Content-Type**: multipart/form-data
|
|
60
|
+
- **Accept**: application/json
|
|
61
|
+
|
|
62
|
+
|
|
63
|
+
### HTTP response details
|
|
64
|
+
| Status code | Description | Response headers |
|
|
65
|
+
|-------------|-------------|------------------|
|
|
66
|
+
|**200** | Conversion réussie | - |
|
|
67
|
+
|**202** | Données manquantes | - |
|
|
68
|
+
|**422** | Validation échouée | - |
|
|
69
|
+
|**400** | Fichier invalide | - |
|
|
70
|
+
|
|
71
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
72
|
+
|
|
73
|
+
# **convertDocumentAsyncApiV1ConvertAsyncPost**
|
|
74
|
+
> any convertDocumentAsyncApiV1ConvertAsyncPost()
|
|
75
|
+
|
|
76
|
+
Lance une conversion asynchrone via Celery. ## Workflow 1. **Upload** : Le document est envoyé en multipart/form-data 2. **Task Celery** : La tâche est mise en file d\'attente 3. **Callback** : Notification par webhook à la fin ## Réponses possibles - **202** : Tâche acceptée, en cours de traitement - **400** : Fichier invalide
|
|
77
|
+
|
|
78
|
+
### Example
|
|
79
|
+
|
|
80
|
+
```typescript
|
|
81
|
+
import {
|
|
82
|
+
DocumentConversionApi,
|
|
83
|
+
Configuration
|
|
84
|
+
} from '@factpulse/sdk';
|
|
85
|
+
|
|
86
|
+
const configuration = new Configuration();
|
|
87
|
+
const apiInstance = new DocumentConversionApi(configuration);
|
|
88
|
+
|
|
89
|
+
let file: File; //Document à convertir (PDF, DOCX, XLSX, JPG, PNG) (default to undefined)
|
|
90
|
+
let output: string; //Format de sortie: pdf, xml, both (optional) (default to 'pdf')
|
|
91
|
+
let callbackUrl: string; // (optional) (default to undefined)
|
|
92
|
+
|
|
93
|
+
const { status, data } = await apiInstance.convertDocumentAsyncApiV1ConvertAsyncPost(
|
|
94
|
+
file,
|
|
95
|
+
output,
|
|
96
|
+
callbackUrl
|
|
97
|
+
);
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
### Parameters
|
|
101
|
+
|
|
102
|
+
|Name | Type | Description | Notes|
|
|
103
|
+
|------------- | ------------- | ------------- | -------------|
|
|
104
|
+
| **file** | [**File**] | Document à convertir (PDF, DOCX, XLSX, JPG, PNG) | defaults to undefined|
|
|
105
|
+
| **output** | [**string**] | Format de sortie: pdf, xml, both | (optional) defaults to 'pdf'|
|
|
106
|
+
| **callbackUrl** | [**string**] | | (optional) defaults to undefined|
|
|
107
|
+
|
|
108
|
+
|
|
109
|
+
### Return type
|
|
110
|
+
|
|
111
|
+
**any**
|
|
112
|
+
|
|
113
|
+
### Authorization
|
|
114
|
+
|
|
115
|
+
[HTTPBearer](../README.md#HTTPBearer)
|
|
116
|
+
|
|
117
|
+
### HTTP request headers
|
|
118
|
+
|
|
119
|
+
- **Content-Type**: multipart/form-data
|
|
120
|
+
- **Accept**: application/json
|
|
121
|
+
|
|
122
|
+
|
|
123
|
+
### HTTP response details
|
|
124
|
+
| Status code | Description | Response headers |
|
|
125
|
+
|-------------|-------------|------------------|
|
|
126
|
+
|**200** | Successful Response | - |
|
|
127
|
+
|**202** | Tâche acceptée | - |
|
|
128
|
+
|**400** | Fichier invalide | - |
|
|
129
|
+
|**422** | Validation Error | - |
|
|
130
|
+
|
|
131
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
132
|
+
|
|
133
|
+
# **downloadFileApiV1ConvertConversionIdDownloadFilenameGet**
|
|
134
|
+
> any downloadFileApiV1ConvertConversionIdDownloadFilenameGet()
|
|
135
|
+
|
|
136
|
+
Télécharge le fichier Factur-X PDF ou XML généré. ## Fichiers disponibles - `facturx.pdf` : PDF/A-3 avec XML embarqué - `facturx.xml` : XML CII seul (Cross Industry Invoice) Les fichiers sont disponibles pendant 24 heures après génération.
|
|
137
|
+
|
|
138
|
+
### Example
|
|
139
|
+
|
|
140
|
+
```typescript
|
|
141
|
+
import {
|
|
142
|
+
DocumentConversionApi,
|
|
143
|
+
Configuration
|
|
144
|
+
} from '@factpulse/sdk';
|
|
145
|
+
|
|
146
|
+
const configuration = new Configuration();
|
|
147
|
+
const apiInstance = new DocumentConversionApi(configuration);
|
|
148
|
+
|
|
149
|
+
let conversionId: string; // (default to undefined)
|
|
150
|
+
let filename: string; // (default to undefined)
|
|
151
|
+
|
|
152
|
+
const { status, data } = await apiInstance.downloadFileApiV1ConvertConversionIdDownloadFilenameGet(
|
|
153
|
+
conversionId,
|
|
154
|
+
filename
|
|
155
|
+
);
|
|
156
|
+
```
|
|
157
|
+
|
|
158
|
+
### Parameters
|
|
159
|
+
|
|
160
|
+
|Name | Type | Description | Notes|
|
|
161
|
+
|------------- | ------------- | ------------- | -------------|
|
|
162
|
+
| **conversionId** | [**string**] | | defaults to undefined|
|
|
163
|
+
| **filename** | [**string**] | | defaults to undefined|
|
|
164
|
+
|
|
165
|
+
|
|
166
|
+
### Return type
|
|
167
|
+
|
|
168
|
+
**any**
|
|
169
|
+
|
|
170
|
+
### Authorization
|
|
171
|
+
|
|
172
|
+
[HTTPBearer](../README.md#HTTPBearer)
|
|
173
|
+
|
|
174
|
+
### HTTP request headers
|
|
175
|
+
|
|
176
|
+
- **Content-Type**: Not defined
|
|
177
|
+
- **Accept**: application/json
|
|
178
|
+
|
|
179
|
+
|
|
180
|
+
### HTTP response details
|
|
181
|
+
| Status code | Description | Response headers |
|
|
182
|
+
|-------------|-------------|------------------|
|
|
183
|
+
|**200** | Fichier téléchargé | - |
|
|
184
|
+
|**404** | Fichier non trouvé ou expiré | - |
|
|
185
|
+
|**422** | Validation Error | - |
|
|
186
|
+
|
|
187
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
188
|
+
|
|
189
|
+
# **getConversionStatusApiV1ConvertConversionIdStatusGet**
|
|
190
|
+
> { [key: string]: any; } getConversionStatusApiV1ConvertConversionIdStatusGet()
|
|
191
|
+
|
|
192
|
+
Retourne le statut actuel d\'une conversion asynchrone.
|
|
193
|
+
|
|
194
|
+
### Example
|
|
195
|
+
|
|
196
|
+
```typescript
|
|
197
|
+
import {
|
|
198
|
+
DocumentConversionApi,
|
|
199
|
+
Configuration
|
|
200
|
+
} from '@factpulse/sdk';
|
|
201
|
+
|
|
202
|
+
const configuration = new Configuration();
|
|
203
|
+
const apiInstance = new DocumentConversionApi(configuration);
|
|
204
|
+
|
|
205
|
+
let conversionId: string; // (default to undefined)
|
|
206
|
+
|
|
207
|
+
const { status, data } = await apiInstance.getConversionStatusApiV1ConvertConversionIdStatusGet(
|
|
208
|
+
conversionId
|
|
209
|
+
);
|
|
210
|
+
```
|
|
211
|
+
|
|
212
|
+
### Parameters
|
|
213
|
+
|
|
214
|
+
|Name | Type | Description | Notes|
|
|
215
|
+
|------------- | ------------- | ------------- | -------------|
|
|
216
|
+
| **conversionId** | [**string**] | | defaults to undefined|
|
|
217
|
+
|
|
218
|
+
|
|
219
|
+
### Return type
|
|
220
|
+
|
|
221
|
+
**{ [key: string]: any; }**
|
|
222
|
+
|
|
223
|
+
### Authorization
|
|
224
|
+
|
|
225
|
+
[HTTPBearer](../README.md#HTTPBearer)
|
|
226
|
+
|
|
227
|
+
### HTTP request headers
|
|
228
|
+
|
|
229
|
+
- **Content-Type**: Not defined
|
|
230
|
+
- **Accept**: application/json
|
|
231
|
+
|
|
232
|
+
|
|
233
|
+
### HTTP response details
|
|
234
|
+
| Status code | Description | Response headers |
|
|
235
|
+
|-------------|-------------|------------------|
|
|
236
|
+
|**200** | Successful Response | - |
|
|
237
|
+
|**422** | Validation Error | - |
|
|
238
|
+
|
|
239
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
240
|
+
|
|
241
|
+
# **resumeConversionApiV1ConvertConversionIdResumePost**
|
|
242
|
+
> ConvertSuccessResponse resumeConversionApiV1ConvertConversionIdResumePost(convertResumeRequest)
|
|
243
|
+
|
|
244
|
+
Reprend une conversion après complétion des données manquantes ou correction des erreurs. L\'extraction OCR est conservée, les données sont mises à jour avec les corrections, puis une nouvelle validation Schematron est effectuée.
|
|
245
|
+
|
|
246
|
+
### Example
|
|
247
|
+
|
|
248
|
+
```typescript
|
|
249
|
+
import {
|
|
250
|
+
DocumentConversionApi,
|
|
251
|
+
Configuration,
|
|
252
|
+
ConvertResumeRequest
|
|
253
|
+
} from '@factpulse/sdk';
|
|
254
|
+
|
|
255
|
+
const configuration = new Configuration();
|
|
256
|
+
const apiInstance = new DocumentConversionApi(configuration);
|
|
257
|
+
|
|
258
|
+
let conversionId: string; // (default to undefined)
|
|
259
|
+
let convertResumeRequest: ConvertResumeRequest; //
|
|
260
|
+
|
|
261
|
+
const { status, data } = await apiInstance.resumeConversionApiV1ConvertConversionIdResumePost(
|
|
262
|
+
conversionId,
|
|
263
|
+
convertResumeRequest
|
|
264
|
+
);
|
|
265
|
+
```
|
|
266
|
+
|
|
267
|
+
### Parameters
|
|
268
|
+
|
|
269
|
+
|Name | Type | Description | Notes|
|
|
270
|
+
|------------- | ------------- | ------------- | -------------|
|
|
271
|
+
| **convertResumeRequest** | **ConvertResumeRequest**| | |
|
|
272
|
+
| **conversionId** | [**string**] | | defaults to undefined|
|
|
273
|
+
|
|
274
|
+
|
|
275
|
+
### Return type
|
|
276
|
+
|
|
277
|
+
**ConvertSuccessResponse**
|
|
278
|
+
|
|
279
|
+
### Authorization
|
|
280
|
+
|
|
281
|
+
[HTTPBearer](../README.md#HTTPBearer)
|
|
282
|
+
|
|
283
|
+
### HTTP request headers
|
|
284
|
+
|
|
285
|
+
- **Content-Type**: application/json
|
|
286
|
+
- **Accept**: application/json
|
|
287
|
+
|
|
288
|
+
|
|
289
|
+
### HTTP response details
|
|
290
|
+
| Status code | Description | Response headers |
|
|
291
|
+
|-------------|-------------|------------------|
|
|
292
|
+
|**200** | Conversion réussie | - |
|
|
293
|
+
|**404** | Conversion non trouvée ou expirée | - |
|
|
294
|
+
|**422** | Validation toujours en échec | - |
|
|
295
|
+
|
|
296
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
297
|
+
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# DocumentTypeInfo
|
|
2
|
+
|
|
3
|
+
Informations sur le type de document detecte.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**code** | **number** | Code UNTDID 1001 | [default to undefined]
|
|
10
|
+
**label** | **string** | Libelle (Facture, Avoir, etc.) | [default to undefined]
|
|
11
|
+
**detected_as** | **string** | Classification interne | [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { DocumentTypeInfo } from '@factpulse/sdk';
|
|
17
|
+
|
|
18
|
+
const instance: DocumentTypeInfo = {
|
|
19
|
+
code,
|
|
20
|
+
label,
|
|
21
|
+
detected_as,
|
|
22
|
+
};
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
# ExtractionInfo
|
|
2
|
+
|
|
3
|
+
Informations sur l\'extraction des donnees.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**confidence_score** | **number** | Score de confiance global (0-1) | [default to undefined]
|
|
10
|
+
**fields_extracted** | **number** | Nombre de champs extraits | [default to undefined]
|
|
11
|
+
**fields_enriched** | **number** | Nombre de champs enrichis automatiquement | [optional] [default to 0]
|
|
12
|
+
**fields_missing** | **number** | Nombre de champs manquants | [optional] [default to 0]
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import { ExtractionInfo } from '@factpulse/sdk';
|
|
18
|
+
|
|
19
|
+
const instance: ExtractionInfo = {
|
|
20
|
+
confidence_score,
|
|
21
|
+
fields_extracted,
|
|
22
|
+
fields_enriched,
|
|
23
|
+
fields_missing,
|
|
24
|
+
};
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
package/docs/FacturXInvoice.md
CHANGED
|
@@ -22,6 +22,20 @@ Name | Type | Description | Notes
|
|
|
22
22
|
**current_user_id** | **number** | | [optional] [default to undefined]
|
|
23
23
|
**supplementary_attachments** | [**Array<SupplementaryAttachment>**](SupplementaryAttachment.md) | | [optional] [default to undefined]
|
|
24
24
|
**payee** | [**Payee**](Payee.md) | | [optional] [default to undefined]
|
|
25
|
+
**delivery_party** | [**DeliveryParty**](DeliveryParty.md) | | [optional] [default to undefined]
|
|
26
|
+
**tax_representative** | [**TaxRepresentative**](TaxRepresentative.md) | | [optional] [default to undefined]
|
|
27
|
+
**delivery_date** | **string** | | [optional] [default to undefined]
|
|
28
|
+
**billing_period_start** | **string** | | [optional] [default to undefined]
|
|
29
|
+
**billing_period_end** | **string** | | [optional] [default to undefined]
|
|
30
|
+
**payment_reference** | **string** | | [optional] [default to undefined]
|
|
31
|
+
**creditor_reference_id** | **string** | | [optional] [default to undefined]
|
|
32
|
+
**direct_debit_mandate_id** | **string** | | [optional] [default to undefined]
|
|
33
|
+
**debtor_iban** | **string** | | [optional] [default to undefined]
|
|
34
|
+
**payment_terms** | **string** | | [optional] [default to undefined]
|
|
35
|
+
**allowances_charges** | [**Array<AllowanceCharge>**](AllowanceCharge.md) | | [optional] [default to undefined]
|
|
36
|
+
**additional_documents** | [**Array<AdditionalDocument>**](AdditionalDocument.md) | | [optional] [default to undefined]
|
|
37
|
+
**buyer_accounting_reference** | **string** | | [optional] [default to undefined]
|
|
38
|
+
**payment_card** | [**PaymentCard**](PaymentCard.md) | | [optional] [default to undefined]
|
|
25
39
|
|
|
26
40
|
## Example
|
|
27
41
|
|
|
@@ -45,6 +59,20 @@ const instance: FacturXInvoice = {
|
|
|
45
59
|
current_user_id,
|
|
46
60
|
supplementary_attachments,
|
|
47
61
|
payee,
|
|
62
|
+
delivery_party,
|
|
63
|
+
tax_representative,
|
|
64
|
+
delivery_date,
|
|
65
|
+
billing_period_start,
|
|
66
|
+
billing_period_end,
|
|
67
|
+
payment_reference,
|
|
68
|
+
creditor_reference_id,
|
|
69
|
+
direct_debit_mandate_id,
|
|
70
|
+
debtor_iban,
|
|
71
|
+
payment_terms,
|
|
72
|
+
allowances_charges,
|
|
73
|
+
additional_documents,
|
|
74
|
+
buyer_accounting_reference,
|
|
75
|
+
payment_card,
|
|
48
76
|
};
|
|
49
77
|
```
|
|
50
78
|
|
|
@@ -6,10 +6,10 @@ Chorus Pro credentials for Zero-Trust mode. **Zero-Trust Mode**: Credentials ar
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**
|
|
10
|
-
**
|
|
11
|
-
**
|
|
12
|
-
**
|
|
9
|
+
**pisteClientId** | **string** | PISTE Client ID (government API portal) | [default to undefined]
|
|
10
|
+
**pisteClientSecret** | **string** | PISTE Client Secret | [default to undefined]
|
|
11
|
+
**chorusProLogin** | **string** | Chorus Pro login | [default to undefined]
|
|
12
|
+
**chorusProPassword** | **string** | Chorus Pro password | [default to undefined]
|
|
13
13
|
**sandbox** | **boolean** | Use sandbox environment (true) or production (false) | [optional] [default to true]
|
|
14
14
|
|
|
15
15
|
## Example
|
|
@@ -18,10 +18,10 @@ Name | Type | Description | Notes
|
|
|
18
18
|
import { FactureElectroniqueRestApiSchemasChorusProChorusProCredentials } from '@factpulse/sdk';
|
|
19
19
|
|
|
20
20
|
const instance: FactureElectroniqueRestApiSchemasChorusProChorusProCredentials = {
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
21
|
+
pisteClientId,
|
|
22
|
+
pisteClientSecret,
|
|
23
|
+
chorusProLogin,
|
|
24
|
+
chorusProPassword,
|
|
25
25
|
sandbox,
|
|
26
26
|
};
|
|
27
27
|
```
|
package/docs/FileInfo.md
ADDED
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# FileInfo
|
|
2
|
+
|
|
3
|
+
Informations sur un fichier genere (contenu inline en base64).
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**content_b64** | **string** | | [optional] [default to undefined]
|
|
10
|
+
**size_bytes** | **number** | Taille en bytes | [optional] [default to 0]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { FileInfo } from '@factpulse/sdk';
|
|
16
|
+
|
|
17
|
+
const instance: FileInfo = {
|
|
18
|
+
content_b64,
|
|
19
|
+
size_bytes,
|
|
20
|
+
};
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# FilesInfo
|
|
2
|
+
|
|
3
|
+
Fichiers generes.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**facturx_pdf** | [**FileInfo**](FileInfo.md) | | [optional] [default to undefined]
|
|
10
|
+
**xml** | [**FileInfo**](FileInfo.md) | | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { FilesInfo } from '@factpulse/sdk';
|
|
16
|
+
|
|
17
|
+
const instance: FilesInfo = {
|
|
18
|
+
facturx_pdf,
|
|
19
|
+
xml,
|
|
20
|
+
};
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -12,11 +12,11 @@ Name | Type | Description | Notes
|
|
|
12
12
|
**city** | **string** | City (L) | [optional] [default to 'Paris']
|
|
13
13
|
**state** | **string** | State/Province (ST) | [optional] [default to 'Ile-de-France']
|
|
14
14
|
**email** | **string** | | [optional] [default to undefined]
|
|
15
|
-
**
|
|
16
|
-
**
|
|
17
|
-
**
|
|
18
|
-
**
|
|
19
|
-
**
|
|
15
|
+
**validityDays** | **number** | Validity duration in days | [optional] [default to 365]
|
|
16
|
+
**keySize** | **number** | RSA key size in bits | [optional] [default to 2048]
|
|
17
|
+
**keyPassphrase** | **string** | | [optional] [default to undefined]
|
|
18
|
+
**generateP12** | **boolean** | Also generate a PKCS#12 (.p12) file | [optional] [default to false]
|
|
19
|
+
**p12Passphrase** | **string** | Passphrase for PKCS#12 file | [optional] [default to 'changeme']
|
|
20
20
|
|
|
21
21
|
## Example
|
|
22
22
|
|
|
@@ -30,11 +30,11 @@ const instance: GenerateCertificateRequest = {
|
|
|
30
30
|
city,
|
|
31
31
|
state,
|
|
32
32
|
email,
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
33
|
+
validityDays,
|
|
34
|
+
keySize,
|
|
35
|
+
keyPassphrase,
|
|
36
|
+
generateP12,
|
|
37
|
+
p12Passphrase,
|
|
38
38
|
};
|
|
39
39
|
```
|
|
40
40
|
|
|
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
|
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
9
|
**credentials** | [**FactureElectroniqueRestApiSchemasChorusProChorusProCredentials**](FactureElectroniqueRestApiSchemasChorusProChorusProCredentials.md) | | [optional] [default to undefined]
|
|
10
10
|
**siret** | **string** | Structure SIRET (14 digits) | [default to undefined]
|
|
11
|
-
**
|
|
11
|
+
**identifierType** | **string** | Identifier type (SIRET, SIREN, UE_HORS_FRANCE, etc.) | [optional] [default to 'SIRET']
|
|
12
12
|
|
|
13
13
|
## Example
|
|
14
14
|
|
|
@@ -18,7 +18,7 @@ import { GetChorusProIdRequest } from '@factpulse/sdk';
|
|
|
18
18
|
const instance: GetChorusProIdRequest = {
|
|
19
19
|
credentials,
|
|
20
20
|
siret,
|
|
21
|
-
|
|
21
|
+
identifierType,
|
|
22
22
|
};
|
|
23
23
|
```
|
|
24
24
|
|
|
@@ -7,7 +7,7 @@ Get an invoice.
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
9
|
**credentials** | [**FactureElectroniqueRestApiSchemasChorusProChorusProCredentials**](FactureElectroniqueRestApiSchemasChorusProChorusProCredentials.md) | | [optional] [default to undefined]
|
|
10
|
-
**
|
|
10
|
+
**chorusInvoiceId** | **number** | Chorus Pro invoice ID | [default to undefined]
|
|
11
11
|
|
|
12
12
|
## Example
|
|
13
13
|
|
|
@@ -16,7 +16,7 @@ import { GetInvoiceRequest } from '@factpulse/sdk';
|
|
|
16
16
|
|
|
17
17
|
const instance: GetInvoiceRequest = {
|
|
18
18
|
credentials,
|
|
19
|
-
|
|
19
|
+
chorusInvoiceId,
|
|
20
20
|
};
|
|
21
21
|
```
|
|
22
22
|
|
|
@@ -7,8 +7,8 @@ Get structure details.
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
9
|
**credentials** | [**FactureElectroniqueRestApiSchemasChorusProChorusProCredentials**](FactureElectroniqueRestApiSchemasChorusProChorusProCredentials.md) | | [optional] [default to undefined]
|
|
10
|
-
**
|
|
11
|
-
**
|
|
10
|
+
**structureId** | **number** | Chorus Pro structure ID | [default to undefined]
|
|
11
|
+
**languageCode** | **string** | Language code (fr, en) | [optional] [default to 'fr']
|
|
12
12
|
|
|
13
13
|
## Example
|
|
14
14
|
|
|
@@ -17,8 +17,8 @@ import { GetStructureRequest } from '@factpulse/sdk';
|
|
|
17
17
|
|
|
18
18
|
const instance: GetStructureRequest = {
|
|
19
19
|
credentials,
|
|
20
|
-
|
|
21
|
-
|
|
20
|
+
structureId,
|
|
21
|
+
languageCode,
|
|
22
22
|
};
|
|
23
23
|
```
|
|
24
24
|
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# GrossUnitPrice
|
|
2
|
+
|
|
3
|
+
Item gross price before line discount (BT-148).
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { GrossUnitPrice } from '@factpulse/sdk';
|
|
14
|
+
|
|
15
|
+
const instance: GrossUnitPrice = {
|
|
16
|
+
};
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
package/docs/IncomingInvoice.md
CHANGED
|
@@ -9,7 +9,7 @@ Name | Type | Description | Notes
|
|
|
9
9
|
**flowId** | **string** | | [optional] [default to undefined]
|
|
10
10
|
**sourceFormat** | [**InvoiceFormat**](InvoiceFormat.md) | Invoice source format | [default to undefined]
|
|
11
11
|
**supplierReference** | **string** | Invoice number issued by the supplier (BT-1) | [default to undefined]
|
|
12
|
-
**documentType** | [**
|
|
12
|
+
**documentType** | [**InvoiceTypeCode**](InvoiceTypeCode.md) | Document type (BT-3) | [optional] [default to undefined]
|
|
13
13
|
**supplier** | [**IncomingSupplier**](IncomingSupplier.md) | Invoice issuer (SellerTradeParty) | [default to undefined]
|
|
14
14
|
**billingSiteName** | **string** | Recipient name / your company (BT-44) | [default to undefined]
|
|
15
15
|
**billingSiteSiret** | **string** | | [optional] [default to undefined]
|