@factpulse/sdk 3.0.4 → 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
package/docs/InvoiceLine.md
CHANGED
|
@@ -1,26 +1,43 @@
|
|
|
1
1
|
# InvoiceLine
|
|
2
2
|
|
|
3
|
-
Represents
|
|
3
|
+
Represents an invoice line item (BG-25).
|
|
4
4
|
|
|
5
5
|
## Properties
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**line_number** | **number** |
|
|
9
|
+
**line_number** | **number** | Invoice line identifier (BT-126). | [default to undefined]
|
|
10
|
+
**line_note** | **string** | | [optional] [default to undefined]
|
|
10
11
|
**reference** | **string** | | [optional] [default to undefined]
|
|
11
|
-
**
|
|
12
|
+
**buyer_assigned_id** | **string** | | [optional] [default to undefined]
|
|
13
|
+
**product_global_id** | **string** | | [optional] [default to undefined]
|
|
14
|
+
**product_global_id_scheme** | **string** | | [optional] [default to undefined]
|
|
15
|
+
**item_name** | **string** | Item name (BT-153). | [default to undefined]
|
|
16
|
+
**item_description** | **string** | | [optional] [default to undefined]
|
|
17
|
+
**origin_country** | **string** | | [optional] [default to undefined]
|
|
18
|
+
**characteristics** | [**Array<ProductCharacteristic>**](ProductCharacteristic.md) | | [optional] [default to undefined]
|
|
19
|
+
**classifications** | [**Array<ProductClassification>**](ProductClassification.md) | | [optional] [default to undefined]
|
|
12
20
|
**quantity** | [**Quantity**](Quantity.md) | | [default to undefined]
|
|
13
|
-
**unit** | [**UnitOfMeasure**](UnitOfMeasure.md) |
|
|
21
|
+
**unit** | [**UnitOfMeasure**](UnitOfMeasure.md) | Invoiced quantity unit of measure code (BT-130). | [default to undefined]
|
|
22
|
+
**gross_unit_price** | [**GrossUnitPrice**](GrossUnitPrice.md) | | [optional] [default to undefined]
|
|
14
23
|
**unit_net_price** | [**UnitNetPrice**](UnitNetPrice.md) | | [default to undefined]
|
|
15
|
-
**
|
|
24
|
+
**price_basis_quantity** | [**PriceBasisQuantity**](PriceBasisQuantity.md) | | [optional] [default to undefined]
|
|
25
|
+
**price_basis_unit** | **string** | | [optional] [default to undefined]
|
|
26
|
+
**price_allowance_amount** | [**PriceAllowanceAmount**](PriceAllowanceAmount.md) | | [optional] [default to undefined]
|
|
16
27
|
**lineNetAmount** | [**LineNetAmount**](LineNetAmount.md) | | [optional] [default to undefined]
|
|
28
|
+
**allowanceAmount** | [**InvoiceLineAllowanceAmount**](InvoiceLineAllowanceAmount.md) | | [optional] [default to undefined]
|
|
29
|
+
**allowanceReasonCode** | [**AllowanceReasonCode**](AllowanceReasonCode.md) | | [optional] [default to undefined]
|
|
30
|
+
**allowanceReason** | **string** | | [optional] [default to undefined]
|
|
31
|
+
**allowances_charges** | [**Array<AllowanceCharge>**](AllowanceCharge.md) | | [optional] [default to undefined]
|
|
17
32
|
**vat_rate** | **string** | | [optional] [default to undefined]
|
|
18
33
|
**manual_vat_rate** | [**ManualVatRate**](ManualVatRate.md) | | [optional] [default to undefined]
|
|
19
34
|
**vat_category** | [**VATCategory**](VATCategory.md) | | [optional] [default to undefined]
|
|
20
|
-
**
|
|
21
|
-
**
|
|
22
|
-
**
|
|
23
|
-
**
|
|
35
|
+
**period_start_date** | **string** | | [optional] [default to undefined]
|
|
36
|
+
**period_end_date** | **string** | | [optional] [default to undefined]
|
|
37
|
+
**purchase_order_line_ref** | **string** | | [optional] [default to undefined]
|
|
38
|
+
**accounting_account** | **string** | | [optional] [default to undefined]
|
|
39
|
+
**additional_documents** | [**Array<AdditionalDocument>**](AdditionalDocument.md) | | [optional] [default to undefined]
|
|
40
|
+
**line_notes** | [**Array<InvoiceNote>**](InvoiceNote.md) | | [optional] [default to undefined]
|
|
24
41
|
|
|
25
42
|
## Example
|
|
26
43
|
|
|
@@ -29,20 +46,37 @@ import { InvoiceLine } from '@factpulse/sdk';
|
|
|
29
46
|
|
|
30
47
|
const instance: InvoiceLine = {
|
|
31
48
|
line_number,
|
|
49
|
+
line_note,
|
|
32
50
|
reference,
|
|
51
|
+
buyer_assigned_id,
|
|
52
|
+
product_global_id,
|
|
53
|
+
product_global_id_scheme,
|
|
33
54
|
item_name,
|
|
55
|
+
item_description,
|
|
56
|
+
origin_country,
|
|
57
|
+
characteristics,
|
|
58
|
+
classifications,
|
|
34
59
|
quantity,
|
|
35
60
|
unit,
|
|
61
|
+
gross_unit_price,
|
|
36
62
|
unit_net_price,
|
|
37
|
-
|
|
63
|
+
price_basis_quantity,
|
|
64
|
+
price_basis_unit,
|
|
65
|
+
price_allowance_amount,
|
|
38
66
|
lineNetAmount,
|
|
67
|
+
allowanceAmount,
|
|
68
|
+
allowanceReasonCode,
|
|
69
|
+
allowanceReason,
|
|
70
|
+
allowances_charges,
|
|
39
71
|
vat_rate,
|
|
40
72
|
manual_vat_rate,
|
|
41
73
|
vat_category,
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
74
|
+
period_start_date,
|
|
75
|
+
period_end_date,
|
|
76
|
+
purchase_order_line_ref,
|
|
77
|
+
accounting_account,
|
|
78
|
+
additional_documents,
|
|
79
|
+
line_notes,
|
|
46
80
|
};
|
|
47
81
|
```
|
|
48
82
|
|
|
@@ -33,7 +33,7 @@ const configuration = new Configuration();
|
|
|
33
33
|
const apiInstance = new InvoiceProcessingApi(configuration);
|
|
34
34
|
|
|
35
35
|
let invoiceData: string; //Invoice data in JSON format. Two formats accepted: 1. **Classic format**: Complete FactureFacturX structure (all fields) 2. **Simplified format** (🆕 P0.1): Minimal structure with auto-enrichment Format is detected automatically! (default to undefined)
|
|
36
|
-
let profile:
|
|
36
|
+
let profile: FacturXProfile; //Factur-X profile: MINIMUM, BASIC, EN16931 or EXTENDED. (optional) (default to undefined)
|
|
37
37
|
let outputFormat: OutputFormat; //Output format: \\\'xml\\\' (XML only) or \\\'pdf\\\' (Factur-X PDF with embedded XML). (optional) (default to undefined)
|
|
38
38
|
let autoEnrich: boolean; //🆕 Enable auto-enrichment from SIRET/SIREN (simplified format only) (optional) (default to true)
|
|
39
39
|
let sourcePdf: File; // (optional) (default to undefined)
|
|
@@ -52,7 +52,7 @@ const { status, data } = await apiInstance.generateInvoiceApiV1ProcessingGenerat
|
|
|
52
52
|
|Name | Type | Description | Notes|
|
|
53
53
|
|------------- | ------------- | ------------- | -------------|
|
|
54
54
|
| **invoiceData** | [**string**] | Invoice data in JSON format. Two formats accepted: 1. **Classic format**: Complete FactureFacturX structure (all fields) 2. **Simplified format** (🆕 P0.1): Minimal structure with auto-enrichment Format is detected automatically! | defaults to undefined|
|
|
55
|
-
| **profile** | **
|
|
55
|
+
| **profile** | **FacturXProfile** | Factur-X profile: MINIMUM, BASIC, EN16931 or EXTENDED. | (optional) defaults to undefined|
|
|
56
56
|
| **outputFormat** | **OutputFormat** | Output format: \\\'xml\\\' (XML only) or \\\'pdf\\\' (Factur-X PDF with embedded XML). | (optional) defaults to undefined|
|
|
57
57
|
| **autoEnrich** | [**boolean**] | 🆕 Enable auto-enrichment from SIRET/SIREN (simplified format only) | (optional) defaults to true|
|
|
58
58
|
| **sourcePdf** | [**File**] | | (optional) defaults to undefined|
|
|
@@ -458,7 +458,7 @@ const configuration = new Configuration();
|
|
|
458
458
|
const apiInstance = new InvoiceProcessingApi(configuration);
|
|
459
459
|
|
|
460
460
|
let pdfFile: File; //Factur-X PDF file to validate (.pdf format). (default to undefined)
|
|
461
|
-
let profile:
|
|
461
|
+
let profile: FacturXProfile; // (optional) (default to undefined)
|
|
462
462
|
let useVerapdf: boolean; //Enable strict PDF/A validation with VeraPDF (recommended for production). If False, uses basic metadata validation. (optional) (default to false)
|
|
463
463
|
|
|
464
464
|
const { status, data } = await apiInstance.validateFacturxPdfApiV1ProcessingValidateFacturxPdfPost(
|
|
@@ -473,7 +473,7 @@ const { status, data } = await apiInstance.validateFacturxPdfApiV1ProcessingVali
|
|
|
473
473
|
|Name | Type | Description | Notes|
|
|
474
474
|
|------------- | ------------- | ------------- | -------------|
|
|
475
475
|
| **pdfFile** | [**File**] | Factur-X PDF file to validate (.pdf format). | defaults to undefined|
|
|
476
|
-
| **profile** | **
|
|
476
|
+
| **profile** | **FacturXProfile** | | (optional) defaults to undefined|
|
|
477
477
|
| **useVerapdf** | [**boolean**] | Enable strict PDF/A validation with VeraPDF (recommended for production). If False, uses basic metadata validation. | (optional) defaults to false|
|
|
478
478
|
|
|
479
479
|
|
|
@@ -517,7 +517,7 @@ const configuration = new Configuration();
|
|
|
517
517
|
const apiInstance = new InvoiceProcessingApi(configuration);
|
|
518
518
|
|
|
519
519
|
let pdfFile: File; //Factur-X PDF file to validate (.pdf format). (default to undefined)
|
|
520
|
-
let profile:
|
|
520
|
+
let profile: FacturXProfile; // (optional) (default to undefined)
|
|
521
521
|
let useVerapdf: boolean; //Enable strict PDF/A validation with VeraPDF (recommended for production). May take several seconds. (optional) (default to false)
|
|
522
522
|
|
|
523
523
|
const { status, data } = await apiInstance.validateFacturxPdfAsyncApiV1ProcessingValidateFacturxAsyncPost(
|
|
@@ -532,7 +532,7 @@ const { status, data } = await apiInstance.validateFacturxPdfAsyncApiV1Processin
|
|
|
532
532
|
|Name | Type | Description | Notes|
|
|
533
533
|
|------------- | ------------- | ------------- | -------------|
|
|
534
534
|
| **pdfFile** | [**File**] | Factur-X PDF file to validate (.pdf format). | defaults to undefined|
|
|
535
|
-
| **profile** | **
|
|
535
|
+
| **profile** | **FacturXProfile** | | (optional) defaults to undefined|
|
|
536
536
|
| **useVerapdf** | [**boolean**] | Enable strict PDF/A validation with VeraPDF (recommended for production). May take several seconds. | (optional) defaults to false|
|
|
537
537
|
|
|
538
538
|
|
|
@@ -629,7 +629,7 @@ const configuration = new Configuration();
|
|
|
629
629
|
const apiInstance = new InvoiceProcessingApi(configuration);
|
|
630
630
|
|
|
631
631
|
let xmlFile: File; //Factur-X XML file to validate (.xml format). (default to undefined)
|
|
632
|
-
let profile:
|
|
632
|
+
let profile: FacturXProfile; //Validation profile (MINIMUM, BASIC, EN16931, EXTENDED). (optional) (default to undefined)
|
|
633
633
|
|
|
634
634
|
const { status, data } = await apiInstance.validateXmlApiV1ProcessingValidateXmlPost(
|
|
635
635
|
xmlFile,
|
|
@@ -642,7 +642,7 @@ const { status, data } = await apiInstance.validateXmlApiV1ProcessingValidateXml
|
|
|
642
642
|
|Name | Type | Description | Notes|
|
|
643
643
|
|------------- | ------------- | ------------- | -------------|
|
|
644
644
|
| **xmlFile** | [**File**] | Factur-X XML file to validate (.xml format). | defaults to undefined|
|
|
645
|
-
| **profile** | **
|
|
645
|
+
| **profile** | **FacturXProfile** | Validation profile (MINIMUM, BASIC, EN16931, EXTENDED). | (optional) defaults to undefined|
|
|
646
646
|
|
|
647
647
|
|
|
648
648
|
### Return type
|
|
@@ -6,14 +6,24 @@ Contains various invoice references (currency, type, etc.).
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**
|
|
10
|
-
**
|
|
9
|
+
**business_process_id** | **string** | | [optional] [default to undefined]
|
|
10
|
+
**invoice_currency** | **string** | Invoice currency code (BT-5). ISO 4217. | [optional] [default to 'EUR']
|
|
11
|
+
**payment_means** | [**PaymentMeans**](PaymentMeans.md) | Payment means type code (BT-81). | [default to undefined]
|
|
12
|
+
**payment_means_text** | **string** | | [optional] [default to undefined]
|
|
11
13
|
**invoice_type** | [**InvoiceTypeCode**](InvoiceTypeCode.md) | | [default to undefined]
|
|
12
|
-
**vat_accounting_code** | [**VATAccountingCode**](VATAccountingCode.md) |
|
|
14
|
+
**vat_accounting_code** | [**VATAccountingCode**](VATAccountingCode.md) | VAT accounting code. | [default to undefined]
|
|
15
|
+
**buyer_reference** | **string** | | [optional] [default to undefined]
|
|
13
16
|
**contract_reference** | **string** | | [optional] [default to undefined]
|
|
14
|
-
**vat_exemption_reason** | **string** | | [optional] [default to undefined]
|
|
15
17
|
**purchase_order_reference** | **string** | | [optional] [default to undefined]
|
|
18
|
+
**seller_order_reference** | **string** | | [optional] [default to undefined]
|
|
19
|
+
**receiving_advice_reference** | **string** | | [optional] [default to undefined]
|
|
20
|
+
**despatch_advice_reference** | **string** | | [optional] [default to undefined]
|
|
21
|
+
**tender_reference** | **string** | | [optional] [default to undefined]
|
|
16
22
|
**preceding_invoice_reference** | **string** | | [optional] [default to undefined]
|
|
23
|
+
**preceding_invoice_date** | **string** | | [optional] [default to undefined]
|
|
24
|
+
**project_reference** | **string** | | [optional] [default to undefined]
|
|
25
|
+
**project_name** | **string** | | [optional] [default to undefined]
|
|
26
|
+
**vat_exemption_reason** | **string** | | [optional] [default to undefined]
|
|
17
27
|
|
|
18
28
|
## Example
|
|
19
29
|
|
|
@@ -21,14 +31,24 @@ Name | Type | Description | Notes
|
|
|
21
31
|
import { InvoiceReferences } from '@factpulse/sdk';
|
|
22
32
|
|
|
23
33
|
const instance: InvoiceReferences = {
|
|
34
|
+
business_process_id,
|
|
24
35
|
invoice_currency,
|
|
25
36
|
payment_means,
|
|
37
|
+
payment_means_text,
|
|
26
38
|
invoice_type,
|
|
27
39
|
vat_accounting_code,
|
|
40
|
+
buyer_reference,
|
|
28
41
|
contract_reference,
|
|
29
|
-
vat_exemption_reason,
|
|
30
42
|
purchase_order_reference,
|
|
43
|
+
seller_order_reference,
|
|
44
|
+
receiving_advice_reference,
|
|
45
|
+
despatch_advice_reference,
|
|
46
|
+
tender_reference,
|
|
31
47
|
preceding_invoice_reference,
|
|
48
|
+
preceding_invoice_date,
|
|
49
|
+
project_reference,
|
|
50
|
+
project_name,
|
|
51
|
+
vat_exemption_reason,
|
|
32
52
|
};
|
|
33
53
|
```
|
|
34
54
|
|
package/docs/InvoiceTotals.md
CHANGED
|
@@ -1,16 +1,20 @@
|
|
|
1
1
|
# InvoiceTotals
|
|
2
2
|
|
|
3
|
-
Contains all invoice total amounts.
|
|
3
|
+
Contains all invoice total amounts (BG-22).
|
|
4
4
|
|
|
5
5
|
## Properties
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**line_total_amount** | [**LineTotalAmount**](LineTotalAmount.md) | | [optional] [default to undefined]
|
|
10
|
+
**allowance_total_amount** | [**AllowanceTotalAmount**](AllowanceTotalAmount.md) | | [optional] [default to undefined]
|
|
11
|
+
**charge_total_amount** | [**ChargeTotalAmount**](ChargeTotalAmount.md) | | [optional] [default to undefined]
|
|
9
12
|
**total_net_amount** | [**TotalNetAmount**](TotalNetAmount.md) | | [default to undefined]
|
|
10
13
|
**vat_amount** | [**TotalVATAmount**](TotalVATAmount.md) | | [default to undefined]
|
|
11
14
|
**total_gross_amount** | [**TotalGrossAmount**](TotalGrossAmount.md) | | [default to undefined]
|
|
12
|
-
**amount_due** | [**AmountDue**](AmountDue.md) | | [default to undefined]
|
|
13
15
|
**prepayment** | [**InvoiceTotalsPrepayment**](InvoiceTotalsPrepayment.md) | | [optional] [default to undefined]
|
|
16
|
+
**rounding_amount** | [**RoundingAmount**](RoundingAmount.md) | | [optional] [default to undefined]
|
|
17
|
+
**amount_due** | [**AmountDue**](AmountDue.md) | | [default to undefined]
|
|
14
18
|
**globalAllowanceAmount** | [**GlobalAllowanceAmount**](GlobalAllowanceAmount.md) | | [optional] [default to undefined]
|
|
15
19
|
**globalAllowanceReason** | **string** | | [optional] [default to undefined]
|
|
16
20
|
|
|
@@ -20,11 +24,15 @@ Name | Type | Description | Notes
|
|
|
20
24
|
import { InvoiceTotals } from '@factpulse/sdk';
|
|
21
25
|
|
|
22
26
|
const instance: InvoiceTotals = {
|
|
27
|
+
line_total_amount,
|
|
28
|
+
allowance_total_amount,
|
|
29
|
+
charge_total_amount,
|
|
23
30
|
total_net_amount,
|
|
24
31
|
vat_amount,
|
|
25
32
|
total_gross_amount,
|
|
26
|
-
amount_due,
|
|
27
33
|
prepayment,
|
|
34
|
+
rounding_amount,
|
|
35
|
+
amount_due,
|
|
28
36
|
globalAllowanceAmount,
|
|
29
37
|
globalAllowanceReason,
|
|
30
38
|
};
|
package/docs/LineNetAmount.md
CHANGED
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# LineTotalAmount
|
|
2
|
+
|
|
3
|
+
Sum of all Invoice line net amounts (BT-106).
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { LineTotalAmount } from '@factpulse/sdk';
|
|
14
|
+
|
|
15
|
+
const instance: LineTotalAmount = {
|
|
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/ManualRate.md
CHANGED
package/docs/ManualVatRate.md
CHANGED
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
# MissingField
|
|
2
|
+
|
|
3
|
+
Champ manquant requis pour la conformite.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**field** | **string** | Nom du champ | [default to undefined]
|
|
10
|
+
**bt_code** | **string** | Code Business Term (BT-XX) | [default to undefined]
|
|
11
|
+
**description** | **string** | Description du champ | [default to undefined]
|
|
12
|
+
**required_for** | **Array<string>** | Profils necessitant ce champ | [default to undefined]
|
|
13
|
+
**suggested_value** | **string** | | [optional] [default to undefined]
|
|
14
|
+
**confidence** | **number** | | [optional] [default to undefined]
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```typescript
|
|
19
|
+
import { MissingField } from '@factpulse/sdk';
|
|
20
|
+
|
|
21
|
+
const instance: MissingField = {
|
|
22
|
+
field,
|
|
23
|
+
bt_code,
|
|
24
|
+
description,
|
|
25
|
+
required_for,
|
|
26
|
+
suggested_value,
|
|
27
|
+
confidence,
|
|
28
|
+
};
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
[[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/PDPCredentials.md
CHANGED
|
@@ -6,11 +6,11 @@ PDP credentials for zero-storage strategy (Strategy B). Allows providing PDP cr
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**
|
|
10
|
-
**
|
|
11
|
-
**
|
|
12
|
-
**
|
|
13
|
-
**
|
|
9
|
+
**flowServiceUrl** | **string** | Base URL of the AFNOR Flow Service | [default to undefined]
|
|
10
|
+
**directoryServiceUrl** | **string** | | [optional] [default to undefined]
|
|
11
|
+
**tokenUrl** | **string** | OAuth2 server URL | [default to undefined]
|
|
12
|
+
**clientId** | **string** | OAuth2 Client ID | [default to undefined]
|
|
13
|
+
**clientSecret** | **string** | OAuth2 Client Secret (sensitive) | [default to undefined]
|
|
14
14
|
|
|
15
15
|
## Example
|
|
16
16
|
|
|
@@ -18,11 +18,11 @@ Name | Type | Description | Notes
|
|
|
18
18
|
import { PDPCredentials } from '@factpulse/sdk';
|
|
19
19
|
|
|
20
20
|
const instance: PDPCredentials = {
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
21
|
+
flowServiceUrl,
|
|
22
|
+
directoryServiceUrl,
|
|
23
|
+
tokenUrl,
|
|
24
|
+
clientId,
|
|
25
|
+
clientSecret,
|
|
26
26
|
};
|
|
27
27
|
```
|
|
28
28
|
|
package/docs/Payee.md
CHANGED
|
@@ -7,11 +7,13 @@ Information about the payment beneficiary (BG-10 / PayeeTradeParty). The payee
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
9
|
**nom** | **string** | Payee name (BT-59). Mandatory. | [default to undefined]
|
|
10
|
+
**payeeId** | **string** | | [optional] [default to undefined]
|
|
10
11
|
**siret** | **string** | | [optional] [default to undefined]
|
|
11
12
|
**siren** | **string** | | [optional] [default to undefined]
|
|
12
13
|
**electronicAddress** | [**ElectronicAddress**](ElectronicAddress.md) | | [optional] [default to undefined]
|
|
13
14
|
**iban** | **string** | | [optional] [default to undefined]
|
|
14
15
|
**bic** | **string** | | [optional] [default to undefined]
|
|
16
|
+
**global_ids** | [**Array<ElectronicAddress>**](ElectronicAddress.md) | | [optional] [default to undefined]
|
|
15
17
|
|
|
16
18
|
## Example
|
|
17
19
|
|
|
@@ -20,11 +22,13 @@ import { Payee } from '@factpulse/sdk';
|
|
|
20
22
|
|
|
21
23
|
const instance: Payee = {
|
|
22
24
|
nom,
|
|
25
|
+
payeeId,
|
|
23
26
|
siret,
|
|
24
27
|
siren,
|
|
25
28
|
electronicAddress,
|
|
26
29
|
iban,
|
|
27
30
|
bic,
|
|
31
|
+
global_ids,
|
|
28
32
|
};
|
|
29
33
|
```
|
|
30
34
|
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# PaymentCard
|
|
2
|
+
|
|
3
|
+
Payment card information (BG-18). Used when payment is made by payment card.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**card_id** | **string** | | [optional] [default to undefined]
|
|
10
|
+
**cardholder_name** | **string** | | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { PaymentCard } from '@factpulse/sdk';
|
|
16
|
+
|
|
17
|
+
const instance: PaymentCard = {
|
|
18
|
+
card_id,
|
|
19
|
+
cardholder_name,
|
|
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,19 @@
|
|
|
1
|
+
# Percentage
|
|
2
|
+
|
|
3
|
+
Percentage applied to base amount (BT-94/101/138/143).
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { Percentage } from '@factpulse/sdk';
|
|
14
|
+
|
|
15
|
+
const instance: Percentage = {
|
|
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/PostalAddress.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# PostalAddress
|
|
2
2
|
|
|
3
|
-
Represents a postal address.
|
|
3
|
+
Represents a postal address (BG-5, BG-8, BG-12, BG-15).
|
|
4
4
|
|
|
5
5
|
## Properties
|
|
6
6
|
|
|
@@ -9,8 +9,10 @@ Name | Type | Description | Notes
|
|
|
9
9
|
**postalCode** | **string** | | [optional] [default to undefined]
|
|
10
10
|
**lineOne** | **string** | | [optional] [default to undefined]
|
|
11
11
|
**lineTwo** | **string** | | [optional] [default to undefined]
|
|
12
|
+
**lineThree** | **string** | | [optional] [default to undefined]
|
|
12
13
|
**city** | **string** | | [optional] [default to undefined]
|
|
13
14
|
**countryCode** | **string** | | [optional] [default to undefined]
|
|
15
|
+
**countrySubdivision** | **string** | | [optional] [default to undefined]
|
|
14
16
|
|
|
15
17
|
## Example
|
|
16
18
|
|
|
@@ -21,8 +23,10 @@ const instance: PostalAddress = {
|
|
|
21
23
|
postalCode,
|
|
22
24
|
lineOne,
|
|
23
25
|
lineTwo,
|
|
26
|
+
lineThree,
|
|
24
27
|
city,
|
|
25
28
|
countryCode,
|
|
29
|
+
countrySubdivision,
|
|
26
30
|
};
|
|
27
31
|
```
|
|
28
32
|
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# PriceAllowanceAmount
|
|
2
|
+
|
|
3
|
+
Item price discount amount (BT-147).
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { PriceAllowanceAmount } from '@factpulse/sdk';
|
|
14
|
+
|
|
15
|
+
const instance: PriceAllowanceAmount = {
|
|
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)
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# PriceBasisQuantity
|
|
2
|
+
|
|
3
|
+
Item price base quantity (BT-149). Default is 1.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { PriceBasisQuantity } from '@factpulse/sdk';
|
|
14
|
+
|
|
15
|
+
const instance: PriceBasisQuantity = {
|
|
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)
|
|
@@ -6,9 +6,9 @@ Processing options for generation and submission.
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**facturxProfile** | [**
|
|
9
|
+
**facturxProfile** | [**FacturXProfile**](FacturXProfile.md) | Factur-X profile to use | [optional] [default to undefined]
|
|
10
10
|
**autoEnrich** | **boolean** | Auto-enrich data (Company APIs, Chorus Pro, etc.) | [optional] [default to true]
|
|
11
|
-
**
|
|
11
|
+
**validateXml** | **boolean** | Validate Factur-X XML with Schematron | [optional] [default to true]
|
|
12
12
|
**verifyDestinationParameters** | **boolean** | Verify required parameters for destination (e.g., service_code for Chorus) | [optional] [default to true]
|
|
13
13
|
|
|
14
14
|
## Example
|
|
@@ -19,7 +19,7 @@ import { ProcessingOptions } from '@factpulse/sdk';
|
|
|
19
19
|
const instance: ProcessingOptions = {
|
|
20
20
|
facturxProfile,
|
|
21
21
|
autoEnrich,
|
|
22
|
-
|
|
22
|
+
validateXml,
|
|
23
23
|
verifyDestinationParameters,
|
|
24
24
|
};
|
|
25
25
|
```
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# ProductCharacteristic
|
|
2
|
+
|
|
3
|
+
Item attribute (BG-32). Additional product characteristics as key-value pairs.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**name** | **string** | Attribute name (BT-160). | [default to undefined]
|
|
10
|
+
**value** | **string** | Attribute value (BT-161). | [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { ProductCharacteristic } from '@factpulse/sdk';
|
|
16
|
+
|
|
17
|
+
const instance: ProductCharacteristic = {
|
|
18
|
+
name,
|
|
19
|
+
value,
|
|
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,25 @@
|
|
|
1
|
+
# ProductClassification
|
|
2
|
+
|
|
3
|
+
Item classification identifier (BG-31). Product classification according to a classification scheme.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**class_code** | **string** | Classification code (BT-158). | [default to undefined]
|
|
10
|
+
**list_id** | **string** | | [optional] [default to undefined]
|
|
11
|
+
**list_version_id** | **string** | | [optional] [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { ProductClassification } from '@factpulse/sdk';
|
|
17
|
+
|
|
18
|
+
const instance: ProductClassification = {
|
|
19
|
+
class_code,
|
|
20
|
+
list_id,
|
|
21
|
+
list_version_id,
|
|
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)
|
package/docs/Quantity.md
CHANGED
package/docs/Recipient.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Recipient
|
|
2
2
|
|
|
3
|
-
Information about the invoice recipient (
|
|
3
|
+
Information about the invoice recipient / buyer (BG-7).
|
|
4
4
|
|
|
5
5
|
## Properties
|
|
6
6
|
|
|
@@ -11,7 +11,10 @@ Name | Type | Description | Notes
|
|
|
11
11
|
**name** | **string** | | [optional] [default to undefined]
|
|
12
12
|
**siren** | **string** | | [optional] [default to undefined]
|
|
13
13
|
**siret** | **string** | | [optional] [default to undefined]
|
|
14
|
+
**vat_number** | **string** | | [optional] [default to undefined]
|
|
14
15
|
**postal_address** | [**PostalAddress**](PostalAddress.md) | | [optional] [default to undefined]
|
|
16
|
+
**contact** | [**Contact**](Contact.md) | | [optional] [default to undefined]
|
|
17
|
+
**global_ids** | [**Array<ElectronicAddress>**](ElectronicAddress.md) | | [optional] [default to undefined]
|
|
15
18
|
|
|
16
19
|
## Example
|
|
17
20
|
|
|
@@ -24,7 +27,10 @@ const instance: Recipient = {
|
|
|
24
27
|
name,
|
|
25
28
|
siren,
|
|
26
29
|
siret,
|
|
30
|
+
vat_number,
|
|
27
31
|
postal_address,
|
|
32
|
+
contact,
|
|
33
|
+
global_ids,
|
|
28
34
|
};
|
|
29
35
|
```
|
|
30
36
|
|