@factpulse/sdk 2.0.49 → 3.0.2

package/docs/InvoiceReferences.md

@@ -0,0 +1,35 @@
+# InvoiceReferences
+
+Contains various invoice references (currency, type, etc.).
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**invoice_currency** | **string** |  | [optional] [default to 'EUR']
+**payment_means** | [**PaymentMeans**](PaymentMeans.md) |  | [default to undefined]
+**invoice_type** | [**InvoiceTypeCode**](InvoiceTypeCode.md) |  | [default to undefined]
+**vat_accounting_code** | [**VATAccountingCode**](VATAccountingCode.md) |  | [default to undefined]
+**contract_reference** | **string** |  | [optional] [default to undefined]
+**vat_exemption_reason** | **string** |  | [optional] [default to undefined]
+**purchase_order_reference** | **string** |  | [optional] [default to undefined]
+**preceding_invoice_reference** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { InvoiceReferences } from '@factpulse/sdk';
+
+const instance: InvoiceReferences = {
+    invoice_currency,
+    payment_means,
+    invoice_type,
+    vat_accounting_code,
+    contract_reference,
+    vat_exemption_reason,
+    purchase_order_reference,
+    preceding_invoice_reference,
+};
+```
+
+[[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/InvoiceStatus.md

@@ -0,0 +1,25 @@
+# InvoiceStatus
+
+Chorus Pro invoice status.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **string** | Status code (SOUMISE, VALIDEE, REJETEE, SUSPENDUE, MANDATEE, MISE_EN_PAIEMENT, etc.) | [default to undefined]
+**label** | **string** | Status label | [default to undefined]
+**date** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { InvoiceStatus } from '@factpulse/sdk';
+
+const instance: InvoiceStatus = {
+    code,
+    label,
+    date,
+};
+```
+
+[[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/InvoiceTotals.md

@@ -0,0 +1,33 @@
+# InvoiceTotals
+
+Contains all invoice total amounts.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**total_net_amount** | [**TotalNetAmount**](TotalNetAmount.md) |  | [default to undefined]
+**vat_amount** | [**TotalVATAmount**](TotalVATAmount.md) |  | [default to undefined]
+**total_gross_amount** | [**TotalGrossAmount**](TotalGrossAmount.md) |  | [default to undefined]
+**amount_due** | [**AmountDue**](AmountDue.md) |  | [default to undefined]
+**prepayment** | [**InvoiceTotalsPrepayment**](InvoiceTotalsPrepayment.md) |  | [optional] [default to undefined]
+**globalAllowanceAmount** | [**GlobalAllowanceAmount**](GlobalAllowanceAmount.md) |  | [optional] [default to undefined]
+**globalAllowanceReason** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { InvoiceTotals } from '@factpulse/sdk';
+
+const instance: InvoiceTotals = {
+    total_net_amount,
+    vat_amount,
+    total_gross_amount,
+    amount_due,
+    prepayment,
+    globalAllowanceAmount,
+    globalAllowanceReason,
+};
+```
+
+[[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/InvoiceTotalsPrepayment.md

@@ -0,0 +1,19 @@
+# InvoiceTotalsPrepayment
+
+Prepayment amount. (Accepte number, string ou integer)
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+## Example
+
+```typescript
+import { InvoiceTotalsPrepayment } from '@factpulse/sdk';
+
+const instance: InvoiceTotalsPrepayment = {
+};
+```
+
+[[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/InvoiceTypeCode.md

@@ -0,0 +1,71 @@
+# InvoiceTypeCode
+
+Document type according to BR-FR-04 (UNTDID 1001 codes).  | Code | Name | Description | |------|------|-------------| | 380 | INVOICE | Commercial invoice | | 389 | SELF_BILLED_INVOICE | Self-billed invoice | | 393 | FACTORED_INVOICE | Factored invoice | | 501 | SELF_BILLED_FACTORED_INVOICE | Self-billed factored invoice | | 386 | PREPAYMENT_INVOICE | Prepayment invoice | | 500 | SELF_BILLED_PREPAYMENT_INVOICE | Self-billed prepayment invoice | | 384 | CORRECTIVE_INVOICE | Corrective invoice | | 471 | SELF_BILLED_CORRECTIVE_INVOICE | Self-billed corrective invoice | | 472 | FACTORED_CORRECTIVE_INVOICE | Factored corrective invoice | | 473 | SELF_BILLED_FACTORED_CORRECTIVE_INVOICE | Self-billed factored corrective invoice | | 381 | CREDIT_NOTE | Credit note | | 261 | SELF_BILLED_CREDIT_NOTE | Self-billed credit note | | 262 | GLOBAL_ALLOWANCE_CREDIT_NOTE | Credit note for global allowance | | 396 | FACTORED_CREDIT_NOTE | Factored credit note | | 502 | SELF_BILLED_FACTORED_CREDIT_NOTE | Self-billed factored credit note | | 503 | PREPAYMENT_CREDIT_NOTE | Credit note for prepayment invoice |
+
+## Enum
+
+* `INVOICE` (value: `'380'`)
+
+* `SELF_BILLED_INVOICE` (value: `'389'`)
+
+* `FACTORED_INVOICE` (value: `'393'`)
+
+* `SELF_BILLED_FACTORED_INVOICE` (value: `'501'`)
+
+* `PREPAYMENT_INVOICE` (value: `'386'`)
+
+* `SELF_BILLED_PREPAYMENT_INVOICE` (value: `'500'`)
+
+* `CORRECTIVE_INVOICE` (value: `'384'`)
+
+* `SELF_BILLED_CORRECTIVE_INVOICE` (value: `'471'`)
+
+* `FACTORED_CORRECTIVE_INVOICE` (value: `'472'`)
+
+* `SELF_BILLED_FACTORED_CORRECTIVE_INVOICE` (value: `'473'`)
+
+* `CREDIT_NOTE` (value: `'381'`)
+
+* `SELF_BILLED_CREDIT_NOTE` (value: `'261'`)
+
+* `GLOBAL_ALLOWANCE_CREDIT_NOTE` (value: `'262'`)
+
+* `FACTORED_CREDIT_NOTE` (value: `'396'`)
+
+* `SELF_BILLED_FACTORED_CREDIT_NOTE` (value: `'502'`)
+
+* `PREPAYMENT_CREDIT_NOTE` (value: `'503'`)
+
+* `_3802` (value: `'380'`)
+
+* `_3892` (value: `'389'`)
+
+* `_3932` (value: `'393'`)
+
+* `_5012` (value: `'501'`)
+
+* `_3862` (value: `'386'`)
+
+* `_5002` (value: `'500'`)
+
+* `_3842` (value: `'384'`)
+
+* `_4712` (value: `'471'`)
+
+* `_4722` (value: `'472'`)
+
+* `_4732` (value: `'473'`)
+
+* `_3812` (value: `'381'`)
+
+* `_2612` (value: `'261'`)
+
+* `_2622` (value: `'262'`)
+
+* `_3962` (value: `'396'`)
+
+* `_5022` (value: `'502'`)
+
+* `_5032` (value: `'503'`)
+
+[[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/InvoicingFramework.md

@@ -0,0 +1,27 @@
+# InvoicingFramework
+
+Defines the invoicing framework.  - invoicing_framework_code: Chorus Pro code (A1, A2, A9, A12) - used for B2G - operation_nature: Operation nature (B1, S1, M1, etc.) - priority for Factur-X  If operation_nature is provided, it will be used directly in Factur-X XML (BT-23). Otherwise, the code will be derived from invoicing_framework_code via automatic mapping.  Example:     >>> framework = InvoicingFramework(     ...     invoicing_framework_code=InvoicingFrameworkCode.A1_SUPPLIER_INVOICE,     ...     operation_nature=OperationNature.GOODS  # Forces B1 instead of S1     ... )
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**invoicing_framework_code** | [**InvoicingFrameworkCode**](InvoicingFrameworkCode.md) |  | [default to undefined]
+**operation_nature** | [**OperationNature**](OperationNature.md) |  | [optional] [default to undefined]
+**approver_service_code** | **string** |  | [optional] [default to undefined]
+**approver_structure_code** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { InvoicingFramework } from '@factpulse/sdk';
+
+const instance: InvoicingFramework = {
+    invoicing_framework_code,
+    operation_nature,
+    approver_service_code,
+    approver_structure_code,
+};
+```
+
+[[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/InvoicingFrameworkCode.md

@@ -0,0 +1,23 @@
+# InvoicingFrameworkCode
+
+Chorus Pro codes for invoicing framework (B2G usage).
+
+## Enum
+
+* `A1FactureFournisseur` (value: `'A1_FACTURE_FOURNISSEUR'`)
+
+* `A2FactureFournisseurDejaPayee` (value: `'A2_FACTURE_FOURNISSEUR_DEJA_PAYEE'`)
+
+* `A9FactureSoustraitant` (value: `'A9_FACTURE_SOUSTRAITANT'`)
+
+* `A12FactureCotraitant` (value: `'A12_FACTURE_COTRAITANT'`)
+
+* `A1FactureFournisseur2` (value: `'A1_FACTURE_FOURNISSEUR'`)
+
+* `A2FactureFournisseurDejaPayee2` (value: `'A2_FACTURE_FOURNISSEUR_DEJA_PAYEE'`)
+
+* `A9FactureSoustraitant2` (value: `'A9_FACTURE_SOUSTRAITANT'`)
+
+* `A12FactureCotraitant2` (value: `'A12_FACTURE_COTRAITANT'`)
+
+[[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/LineNetAmount.md

@@ -0,0 +1,19 @@
+# LineNetAmount
+
+Line net amount (quantity × unit price - allowance). (Accepte number, string ou integer)
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+## Example
+
+```typescript
+import { LineNetAmount } from '@factpulse/sdk';
+
+const instance: LineNetAmount = {
+};
+```
+
+[[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/MandatoryNoteSchema.md

@@ -0,0 +1,33 @@
+# MandatoryNoteSchema
+
+Mandatory note detected with location and XML/PDF comparison.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**subjectCode** | **string** | Subject code (PMT, PMD, AAB) | [default to undefined]
+**label** | **string** | Label (e.g., Recovery indemnity) | [default to undefined]
+**pdfValue** | **string** |  | [optional] [default to undefined]
+**xmlValue** | **string** |  | [optional] [default to undefined]
+**status** | [**FieldStatus**](FieldStatus.md) | Compliance status (COMPLIANT if XML found in PDF) | [optional] [default to undefined]
+**message** | **string** |  | [optional] [default to undefined]
+**bbox** | [**BoundingBoxSchema**](BoundingBoxSchema.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { MandatoryNoteSchema } from '@factpulse/sdk';
+
+const instance: MandatoryNoteSchema = {
+    subjectCode,
+    label,
+    pdfValue,
+    xmlValue,
+    status,
+    message,
+    bbox,
+};
+```
+
+[[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

@@ -0,0 +1,19 @@
+# ManualRate
+
+Manual VAT rate value. (Accepte number, string ou integer)
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+## Example
+
+```typescript
+import { ManualRate } from '@factpulse/sdk';
+
+const instance: ManualRate = {
+};
+```
+
+[[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/ManualVatRate.md

@@ -0,0 +1,19 @@
+# ManualVatRate
+
+Manual VAT rate value. (Accepte number, string ou integer)
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+## Example
+
+```typescript
+import { ManualVatRate } from '@factpulse/sdk';
+
+const instance: ManualVatRate = {
+};
+```
+
+[[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/OperationNature.md

@@ -0,0 +1,35 @@
+# OperationNature
+
+Operation nature (BT-23) for Factur-X - French Reform.  BR-FR-08: The invoicing framework must be one of the following codes. First letter indicates: B = Goods, S = Services, M = Mixed.  Ref: XP Z12-012, article_conformite_pdf_facturx.md  Example:     >>> framework = InvoicingFramework(     ...     invoicing_framework_code=InvoicingFrameworkCode.A1_SUPPLIER_INVOICE,     ...     operation_nature=OperationNature.GOODS     ... )
+
+## Enum
+
+* `B1` (value: `'B1'`)
+
+* `S1` (value: `'S1'`)
+
+* `M1` (value: `'M1'`)
+
+* `B2` (value: `'B2'`)
+
+* `S2` (value: `'S2'`)
+
+* `M2` (value: `'M2'`)
+
+* `B4` (value: `'B4'`)
+
+* `S4` (value: `'S4'`)
+
+* `M4` (value: `'M4'`)
+
+* `S3` (value: `'S3'`)
+
+* `S5` (value: `'S5'`)
+
+* `S6` (value: `'S6'`)
+
+* `B7` (value: `'B7'`)
+
+* `S7` (value: `'S7'`)
+
+[[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/OutputFormat.md

@@ -0,0 +1,11 @@
+# OutputFormat
+
+Output format for invoice generation.
+
+## Enum
+
+* `Xml` (value: `'xml'`)
+
+* `Pdf` (value: `'pdf'`)
+
+[[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/PDFValidationResultAPI.md

@@ -0,0 +1,65 @@
+# PDFValidationResultAPI
+
+Complete result of a Factur-X PDF validation.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**isCompliant** | **boolean** | True if PDF complies with all criteria (XML, PDF/A, XMP) | [default to undefined]
+**xmlPresent** | **boolean** | True if a Factur-X XML is embedded in the PDF | [default to undefined]
+**xmlCompliant** | **boolean** | True if Factur-X XML complies with Schematron rules | [default to undefined]
+**detectedProfile** | **string** |  | [optional] [default to undefined]
+**xmlErrors** | **Array<string>** | List of XML validation errors | [optional] [default to undefined]
+**pdfaCompliant** | **boolean** | True if PDF is PDF/A compliant | [default to undefined]
+**pdfaVersion** | **string** |  | [optional] [default to undefined]
+**pdfaValidationMethod** | **string** | Method used for PDF/A validation (metadata or verapdf) | [optional] [default to 'metadata']
+**validatedRules** | **number** |  | [optional] [default to undefined]
+**failedRules** | **number** |  | [optional] [default to undefined]
+**pdfaErrors** | **Array<string>** | List of PDF/A compliance errors | [optional] [default to undefined]
+**pdfaWarnings** | **Array<string>** | List of PDF/A warnings | [optional] [default to undefined]
+**xmpPresent** | **boolean** | True if XMP metadata is present | [default to undefined]
+**xmpFacturxCompliant** | **boolean** | True if XMP metadata contains Factur-X information | [default to undefined]
+**xmpProfile** | **string** |  | [optional] [default to undefined]
+**xmpVersion** | **string** |  | [optional] [default to undefined]
+**xmpErrors** | **Array<string>** | List of XMP metadata errors | [optional] [default to undefined]
+**xmpMetadata** | **{ [key: string]: any; }** | XMP metadata extracted from PDF | [optional] [default to undefined]
+**isSigned** | **boolean** | True if PDF contains at least one signature | [default to undefined]
+**signatureCount** | **number** | Number of electronic signatures found | [optional] [default to 0]
+**signatures** | [**Array<SignatureInfoAPI>**](SignatureInfoAPI.md) | List of found signatures with their information | [optional] [default to undefined]
+**signatureErrors** | **Array<string>** | List of errors during signature analysis | [optional] [default to undefined]
+**summaryMessage** | **string** | Message summarizing the validation result | [default to undefined]
+
+## Example
+
+```typescript
+import { PDFValidationResultAPI } from '@factpulse/sdk';
+
+const instance: PDFValidationResultAPI = {
+    isCompliant,
+    xmlPresent,
+    xmlCompliant,
+    detectedProfile,
+    xmlErrors,
+    pdfaCompliant,
+    pdfaVersion,
+    pdfaValidationMethod,
+    validatedRules,
+    failedRules,
+    pdfaErrors,
+    pdfaWarnings,
+    xmpPresent,
+    xmpFacturxCompliant,
+    xmpProfile,
+    xmpVersion,
+    xmpErrors,
+    xmpMetadata,
+    isSigned,
+    signatureCount,
+    signatures,
+    signatureErrors,
+    summaryMessage,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)