@factpulse/sdk 3.0.4 → 3.0.6

package/docs/RoundingAmount.md

@@ -0,0 +1,19 @@
+# RoundingAmount
+
+Rounding amount added to total (BT-114).
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+## Example
+
+```typescript
+import { RoundingAmount } from '@factpulse/sdk';
+
+const instance: RoundingAmount = {
+};
+```
+
+[[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/SchemeID.md

@@ -1,17 +1,29 @@
 # SchemeID
 
-Identification scheme codes (Electronic Address Scheme - EAS), mainly for electronic invoice addressing.  **Possible values:** - `0225`: FR_SIREN - French SIREN (most common for France, replaces old 0002) - `0088`: GLN - Global Location Number - `0060`: DUNS - Data Universal Numbering System - `9957`: FR_VAT_INTRA - French intra-community VAT number - `0199`: GLEIF - Global Legal Entity Identifier Foundation
+Identification scheme codes (Electronic Address Scheme - EAS), mainly for electronic invoice addressing.  **Possible values:** - `0225`: FR_SIREN - French SIREN (most common for France) - `0009`: FR_SIRET - French SIRET - `0002`: FR_SIREN_OLD - French SIREN (old code, for legal organization ID) - `0088`: GLN - Global Location Number - `0060`: DUNS - Data Universal Numbering System - `9957`: FR_VAT_INTRA - French intra-community VAT number - `0199`: GLEIF - Global Legal Entity Identifier Foundation - `0231`: DT_DIRECTORY_ID - Directory ID for tax administration - `EM`: EMAIL - Email-based electronic address (BT-34/BT-49)
 
 ## Enum
 
 * `FR_SIREN` (value: `'0225'`)
 
-* `GLN` (value: `'0088'`)
+* `GLN` (value: `'0009'`)
 
-* `DUNS` (value: `'0060'`)
+* `DUNS` (value: `'0002'`)
 
-* `FR_TVA_INTRA` (value: `'9957'`)
+* `FR_TVA_INTRA` (value: `'0088'`)
 
-* `GLEIF` (value: `'0199'`)
+* `GLEIF` (value: `'0060'`)
+
+* `_9957` (value: `'9957'`)
+
+* `_0199` (value: `'0199'`)
+
+* `_0231` (value: `'0231'`)
+
+* `Em` (value: `'EM'`)
+
+* `_0177` (value: `'0177'`)
+
+* `_0224` (value: `'0224'`)
 
 [[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/SearchFlowRequest.md

@@ -6,13 +6,13 @@ Request to search submitted flows.
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**updated_after** | **string** |  | [optional] [default to undefined]
-**updated_before** | **string** |  | [optional] [default to undefined]
-**flow_types** | [**Array<FlowType>**](FlowType.md) |  | [optional] [default to undefined]
-**flow_directions** | [**Array<FlowDirection>**](FlowDirection.md) |  | [optional] [default to undefined]
-**tracking_id** | **string** |  | [optional] [default to undefined]
-**flow_id** | **string** |  | [optional] [default to undefined]
-**acknowledgment_status** | [**AcknowledgmentStatus**](AcknowledgmentStatus.md) |  | [optional] [default to undefined]
+**updatedAfter** | **string** |  | [optional] [default to undefined]
+**updatedBefore** | **string** |  | [optional] [default to undefined]
+**flowTypes** | [**Array<FlowType>**](FlowType.md) |  | [optional] [default to undefined]
+**flowDirections** | [**Array<FlowDirection>**](FlowDirection.md) |  | [optional] [default to undefined]
+**trackingId** | **string** |  | [optional] [default to undefined]
+**flowId** | **string** |  | [optional] [default to undefined]
+**acknowledgmentStatus** | [**AcknowledgmentStatus**](AcknowledgmentStatus.md) |  | [optional] [default to undefined]
 **offset** | **number** | Offset for pagination | [optional] [default to 0]
 **limit** | **number** | Maximum number of results (max 100) | [optional] [default to 25]
 
@@ -22,13 +22,13 @@ Name | Type | Description | Notes
 import { SearchFlowRequest } from '@factpulse/sdk';
 
 const instance: SearchFlowRequest = {
-    updated_after,
-    updated_before,
-    flow_types,
-    flow_directions,
-    tracking_id,
-    flow_id,
-    acknowledgment_status,
+    updatedAfter,
+    updatedBefore,
+    flowTypes,
+    flowDirections,
+    trackingId,
+    flowId,
+    acknowledgmentStatus,
     offset,
     limit,
 };

package/docs/SearchStructureRequest.md

@@ -7,10 +7,10 @@ Search structures by criteria.
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **credentials** | [**FactureElectroniqueRestApiSchemasChorusProChorusProCredentials**](FactureElectroniqueRestApiSchemasChorusProChorusProCredentials.md) |  | [optional] [default to undefined]
-**structure_identifier** | **string** |  | [optional] [default to undefined]
-**structure_identifier_type** | **string** |  | [optional] [default to undefined]
-**company_name** | **string** |  | [optional] [default to undefined]
-**restrict_private_structures** | **boolean** | Limit search to private structures only | [optional] [default to false]
+**structureIdentifier** | **string** |  | [optional] [default to undefined]
+**structureIdentifierType** | **string** |  | [optional] [default to undefined]
+**companyName** | **string** |  | [optional] [default to undefined]
+**restrictPrivateStructures** | **boolean** | Limit search to private structures only | [optional] [default to false]
 
 ## Example
 
@@ -19,10 +19,10 @@ import { SearchStructureRequest } from '@factpulse/sdk';
 
 const instance: SearchStructureRequest = {
     credentials,
-    structure_identifier,
-    structure_identifier_type,
-    company_name,
-    restrict_private_structures,
+    structureIdentifier,
+    structureIdentifierType,
+    companyName,
+    restrictPrivateStructures,
 };
 ```
 

package/docs/SubmitFlowRequest.md

@@ -6,12 +6,12 @@ Request to submit an invoice to a PDP/PA via AFNOR.
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**flow_name** | **string** | Flow name (e.g., \'Invoice 2025-001\') | [default to undefined]
-**flow_syntax** | [**FlowSyntax**](FlowSyntax.md) | Flow syntax (CII for Factur-X) | [optional] [default to undefined]
-**flow_profile** | [**FlowProfile**](FlowProfile.md) |  | [optional] [default to undefined]
-**tracking_id** | **string** |  | [optional] [default to undefined]
-**request_id** | **string** |  | [optional] [default to undefined]
-**pdp_credentials** | [**PDPCredentials**](PDPCredentials.md) |  | [optional] [default to undefined]
+**flowName** | **string** | Flow name (e.g., \'Invoice 2025-001\') | [default to undefined]
+**flowSyntax** | [**FlowSyntax**](FlowSyntax.md) | Flow syntax (CII for Factur-X) | [optional] [default to undefined]
+**flowProfile** | [**FlowProfile**](FlowProfile.md) |  | [optional] [default to undefined]
+**trackingId** | **string** |  | [optional] [default to undefined]
+**requestId** | **string** |  | [optional] [default to undefined]
+**pdpCredentials** | [**PDPCredentials**](PDPCredentials.md) |  | [optional] [default to undefined]
 
 ## Example
 
@@ -19,12 +19,12 @@ Name | Type | Description | Notes
 import { SubmitFlowRequest } from '@factpulse/sdk';
 
 const instance: SubmitFlowRequest = {
-    flow_name,
-    flow_syntax,
-    flow_profile,
-    tracking_id,
-    request_id,
-    pdp_credentials,
+    flowName,
+    flowSyntax,
+    flowProfile,
+    trackingId,
+    requestId,
+    pdpCredentials,
 };
 ```
 

package/docs/SubmitInvoiceRequest.md

@@ -7,20 +7,20 @@ Submit an invoice to Chorus Pro.
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **credentials** | [**FactureElectroniqueRestApiSchemasChorusProChorusProCredentials**](FactureElectroniqueRestApiSchemasChorusProChorusProCredentials.md) |  | [optional] [default to undefined]
-**invoice_number** | **string** | Invoice number | [default to undefined]
-**invoice_date** | **string** | Invoice date (ISO format: YYYY-MM-DD) | [default to undefined]
-**payment_due_date** | **string** |  | [optional] [default to undefined]
-**structure_id** | **number** | Chorus Pro recipient structure ID | [default to undefined]
-**service_code** | **string** |  | [optional] [default to undefined]
-**engagement_number** | **string** |  | [optional] [default to undefined]
-**total_net_amount** | [**SubmitNetAmount**](SubmitNetAmount.md) |  | [default to undefined]
-**vat_amount** | [**SubmitVatAmount**](SubmitVatAmount.md) |  | [default to undefined]
-**total_gross_amount** | [**SubmitGrossAmount**](SubmitGrossAmount.md) |  | [default to undefined]
-**main_attachment_id** | **number** |  | [optional] [default to undefined]
-**main_attachment_label** | **string** |  | [optional] [default to undefined]
+**invoiceNumber** | **string** | Invoice number | [default to undefined]
+**invoiceDate** | **string** | Invoice date (ISO format: YYYY-MM-DD) | [default to undefined]
+**paymentDueDate** | **string** |  | [optional] [default to undefined]
+**structureId** | **number** | Chorus Pro recipient structure ID | [default to undefined]
+**serviceCode** | **string** |  | [optional] [default to undefined]
+**engagementNumber** | **string** |  | [optional] [default to undefined]
+**totalNetAmount** | [**SubmitNetAmount**](SubmitNetAmount.md) |  | [default to undefined]
+**vatAmount** | [**SubmitVatAmount**](SubmitVatAmount.md) |  | [default to undefined]
+**totalGrossAmount** | [**SubmitGrossAmount**](SubmitGrossAmount.md) |  | [default to undefined]
+**mainAttachmentId** | **number** |  | [optional] [default to undefined]
+**mainAttachmentLabel** | **string** |  | [optional] [default to undefined]
 **comment** | **string** |  | [optional] [default to undefined]
-**purchase_order_reference** | **string** |  | [optional] [default to undefined]
-**contract_reference** | **string** |  | [optional] [default to undefined]
+**purchaseOrderReference** | **string** |  | [optional] [default to undefined]
+**contractReference** | **string** |  | [optional] [default to undefined]
 
 ## Example
 
@@ -29,20 +29,20 @@ import { SubmitInvoiceRequest } from '@factpulse/sdk';
 
 const instance: SubmitInvoiceRequest = {
     credentials,
-    invoice_number,
-    invoice_date,
-    payment_due_date,
-    structure_id,
-    service_code,
-    engagement_number,
-    total_net_amount,
-    vat_amount,
-    total_gross_amount,
-    main_attachment_id,
-    main_attachment_label,
+    invoiceNumber,
+    invoiceDate,
+    paymentDueDate,
+    structureId,
+    serviceCode,
+    engagementNumber,
+    totalNetAmount,
+    vatAmount,
+    totalGrossAmount,
+    mainAttachmentId,
+    mainAttachmentLabel,
     comment,
-    purchase_order_reference,
-    contract_reference,
+    purchaseOrderReference,
+    contractReference,
 };
 ```
 

package/docs/Supplier.md

@@ -1,6 +1,6 @@
 # Supplier
 
-Information about the supplier who issues the invoice.
+Information about the supplier / seller (BG-4).
 
 ## Properties
 
@@ -8,14 +8,22 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **electronic_address** | [**ElectronicAddress**](ElectronicAddress.md) |  | [default to undefined]
 **supplier_id** | **number** |  | [default to undefined]
+**private_id** | **string** |  | [optional] [default to undefined]
 **supplier_bank_account_code** | **number** |  | [optional] [default to undefined]
 **supplier_service_id** | **number** |  | [optional] [default to undefined]
 **name** | **string** |  | [optional] [default to undefined]
+**trading_business_name** | **string** |  | [optional] [default to undefined]
+**legal_description** | **string** |  | [optional] [default to undefined]
 **siren** | **string** |  | [optional] [default to undefined]
 **siret** | **string** |  | [optional] [default to undefined]
 **vat_number** | **string** |  | [optional] [default to undefined]
 **iban** | **string** |  | [optional] [default to undefined]
+**bic** | **string** |  | [optional] [default to undefined]
+**bank_account_name** | **string** |  | [optional] [default to undefined]
+**proprietaryId** | **string** |  | [optional] [default to undefined]
 **postal_address** | [**PostalAddress**](PostalAddress.md) |  | [optional] [default to undefined]
+**contact** | [**Contact**](Contact.md) |  | [optional] [default to undefined]
+**global_ids** | [**Array<ElectronicAddress>**](ElectronicAddress.md) |  | [optional] [default to undefined]
 
 ## Example
 
@@ -25,14 +33,22 @@ import { Supplier } from '@factpulse/sdk';
 const instance: Supplier = {
     electronic_address,
     supplier_id,
+    private_id,
     supplier_bank_account_code,
     supplier_service_id,
     name,
+    trading_business_name,
+    legal_description,
     siren,
     siret,
     vat_number,
     iban,
+    bic,
+    bank_account_name,
+    proprietaryId,
     postal_address,
+    contact,
+    global_ids,
 };
 ```
 

package/docs/TaxRepresentative.md

@@ -0,0 +1,25 @@
+# TaxRepresentative
+
+Seller tax representative (BG-11).  The tax representative is required when the seller is not established in the country where VAT is due.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** | Tax representative name (BT-62). | [default to undefined]
+**vat_number** | **string** | Tax representative VAT identifier (BT-63). | [default to undefined]
+**postal_address** | [**PostalAddress**](PostalAddress.md) | Tax representative postal address (BG-12). | [default to undefined]
+
+## Example
+
+```typescript
+import { TaxRepresentative } from '@factpulse/sdk';
+
+const instance: TaxRepresentative = {
+    name,
+    vat_number,
+    postal_address,
+};
+```
+
+[[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/TaxableAmount.md

@@ -1,6 +1,6 @@
 # TaxableAmount
 
-Taxable amount (base) for this VAT line. (Accepte number, string ou integer)
+VAT category taxable amount (BT-116). Can be negative for correction invoices.
 
 ## Properties
 

package/docs/TotalGrossAmount.md

@@ -1,6 +1,6 @@
 # TotalGrossAmount
 
-Total gross amount (including tax). (Accepte number, string ou integer)
+Invoice total amount with VAT (BT-112). Can be negative for correction invoices.
 
 ## Properties
 

package/docs/TotalNetAmount.md

@@ -1,6 +1,6 @@
 # TotalNetAmount
 
-Total net amount (before tax). (Accepte number, string ou integer)
+Invoice total amount without VAT (BT-109). Can be negative for correction invoices.
 
 ## Properties
 

package/docs/TotalVATAmount.md

@@ -1,6 +1,6 @@
 # TotalVATAmount
 
-Total VAT amount. (Accepte number, string ou integer)
+Invoice total VAT amount (BT-110). Can be negative for correction invoices.
 
 ## Properties
 

package/docs/UnitNetPrice.md

@@ -1,6 +1,6 @@
 # UnitNetPrice
 
-Unit net price (before tax).
+Item net price after line discount (BT-146).
 
 ## Properties
 

package/docs/VATAmount.md

@@ -1,6 +1,6 @@
 # VATAmount
 
-VAT amount for this line. (Accepte number, string ou integer)
+VAT category tax amount (BT-117). Can be negative for correction invoices.
 
 ## Properties
 

package/docs/VATLine.md

@@ -1,6 +1,6 @@
 # VATLine
 
-Represents a VAT breakdown line by rate.  For exemptions (categories E, AE, K, G, O), the fields `exemption_reason` and `vatex_code` are required per EN16931.
+Represents a VAT breakdown line by rate (BG-23).  For exemptions (categories E, AE, K, G, O), the fields `exemption_reason` and `vatex_code` are required per EN16931.
 
 ## Properties
 
@@ -11,6 +11,7 @@ Name | Type | Description | Notes
 **rate** | **string** |  | [optional] [default to undefined]
 **manual_rate** | [**ManualRate**](ManualRate.md) |  | [optional] [default to undefined]
 **category** | [**VATCategory**](VATCategory.md) |  | [optional] [default to undefined]
+**due_date_type_code** | [**VATPointDateCode**](VATPointDateCode.md) |  | [optional] [default to undefined]
 **exemption_reason** | **string** |  | [optional] [default to undefined]
 **vatex_code** | **string** |  | [optional] [default to undefined]
 
@@ -25,6 +26,7 @@ const instance: VATLine = {
     rate,
     manual_rate,
     category,
+    due_date_type_code,
     exemption_reason,
     vatex_code,
 };

package/docs/VATPointDateCode.md

@@ -0,0 +1,13 @@
+# VATPointDateCode
+
+VAT point date code (BT-8) - When VAT becomes due.  UNTDID 2005 subset used in EN16931.
+
+## Enum
+
+* `_5` (value: `'5'`)
+
+* `_29` (value: `'29'`)
+
+* `_72` (value: `'72'`)
+
+[[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/ValidationInfo.md

@@ -0,0 +1,31 @@
+# ValidationInfo
+
+Informations sur la validation.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**profile** | **string** | Profil Factur-X utilise | [default to undefined]
+**schematron_rules_passed** | **number** | Regles passees | [default to undefined]
+**schematron_rules_total** | **number** | Total regles | [default to undefined]
+**pdfa_compliant** | **boolean** | PDF/A-3 conforme | [optional] [default to true]
+**xml_embedded** | **boolean** | XML embarque dans PDF | [optional] [default to true]
+**errors** | [**Array<ValidationError>**](ValidationError.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ValidationInfo } from '@factpulse/sdk';
+
+const instance: ValidationInfo = {
+    profile,
+    schematron_rules_passed,
+    schematron_rules_total,
+    pdfa_compliant,
+    xml_embedded,
+    errors,
+};
+```
+
+[[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/VatRate.md

@@ -0,0 +1,19 @@
+# VatRate
+
+VAT rate applicable to this allowance/charge (BT-96/103).
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+## Example
+
+```typescript
+import { VatRate } from '@factpulse/sdk';
+
+const instance: VatRate = {
+};
+```
+
+[[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/models/additional-document.ts

@@ -0,0 +1,30 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * FactPulse REST API
+ *  REST API for electronic invoicing in France: Factur-X, AFNOR PDP/PA, electronic signatures.  ## 🎯 Main Features  ### 📄 Factur-X Invoice Generation - **Formats**: XML only or PDF/A-3 with embedded XML - **Profiles**: MINIMUM, BASIC, EN16931, EXTENDED - **Standards**: EN 16931 (EU directive 2014/55), ISO 19005-3 (PDF/A-3), CII (UN/CEFACT) - **🆕 Simplified Format**: Generation from SIRET + auto-enrichment (Chorus Pro API + Business Search)  ### ✅ Validation and Compliance - **XML Validation**: Schematron (45 to 210+ rules depending on profile) - **PDF Validation**: PDF/A-3, Factur-X XMP metadata, electronic signatures - **VeraPDF**: Strict PDF/A validation (146+ ISO 19005-3 rules) - **Asynchronous Processing**: Celery support for heavy validations (VeraPDF)  ### 📡 AFNOR PDP/PA Integration (XP Z12-013) - **Flow Submission**: Send invoices to Partner Dematerialization Platforms - **Flow Search**: View submitted invoices - **Download**: Retrieve PDF/A-3 with XML - **Directory Service**: Company search (SIREN/SIRET) - **Multi-client**: Support for multiple PDP configs per user (stored credentials or zero-storage)  ### ✍️ PDF Electronic Signature - **Standards**: PAdES-B-B, PAdES-B-T (RFC 3161 timestamping), PAdES-B-LT (long-term archival) - **eIDAS Levels**: SES (self-signed), AdES (commercial CA), QES (QTSP) - **Validation**: Cryptographic integrity and certificate verification - **Certificate Generation**: Self-signed X.509 certificates for testing  ### 🔄 Asynchronous Processing - **Celery**: Asynchronous generation, validation and signing - **Polling**: Status tracking via `/tasks/{task_id}/status` - **No timeout**: Ideal for large files or heavy validations  ## 🔒 Authentication  All requests require a **JWT token** in the Authorization header: ``` Authorization: Bearer YOUR_JWT_TOKEN ```  ### How to obtain a JWT token?  #### 🔑 Method 1: `/api/token/` API (Recommended)  **URL:** `https://www.factpulse.fr/api/token/`  This method is **recommended** for integration in your applications and CI/CD workflows.  **Prerequisites:** Having set a password on your account  **For users registered via email/password:** - You already have a password, use it directly  **For users registered via OAuth (Google/GitHub):** - You must first set a password at: https://www.factpulse.fr/accounts/password/set/ - Once the password is created, you can use the API  **Request example:** ```bash curl -X POST https://www.factpulse.fr/api/token/ \\   -H \"Content-Type: application/json\" \\   -d \'{     \"username\": \"your_email@example.com\",     \"password\": \"your_password\"   }\' ```  **Optional `client_uid` parameter:**  To select credentials for a specific client (PA/PDP, Chorus Pro, signing certificates), add `client_uid`:  ```bash curl -X POST https://www.factpulse.fr/api/token/ \\   -H \"Content-Type: application/json\" \\   -d \'{     \"username\": \"your_email@example.com\",     \"password\": \"your_password\",     \"client_uid\": \"550e8400-e29b-41d4-a716-446655440000\"   }\' ```  The `client_uid` will be included in the JWT and allow the API to automatically use: - AFNOR/PDP credentials configured for this client - Chorus Pro credentials configured for this client - Electronic signature certificates configured for this client  **Response:** ```json {   \"access\": \"eyJ0eXAiOiJKV1QiLCJhbGc...\",  // Access token (validity: 30 min)   \"refresh\": \"eyJ0eXAiOiJKV1QiLCJhbGc...\"  // Refresh token (validity: 7 days) } ```  **Advantages:** - ✅ Full automation (CI/CD, scripts) - ✅ Programmatic token management - ✅ Refresh token support for automatic access renewal - ✅ Easy integration in any language/tool  #### 🖥️ Method 2: Dashboard Generation (Alternative)  **URL:** https://www.factpulse.fr/dashboard/  This method is suitable for quick tests or occasional use via the graphical interface.  **How it works:** - Log in to the dashboard - Use the \"Generate Test Token\" or \"Generate Production Token\" buttons - Works for **all** users (OAuth and email/password), without requiring a password  **Token types:** - **Test Token**: 24h validity, 1000 calls/day quota (free) - **Production Token**: 7 days validity, quota based on your plan  **Advantages:** - ✅ Quick for API testing - ✅ No password required - ✅ Simple visual interface  **Disadvantages:** - ❌ Requires manual action - ❌ No refresh token - ❌ Less suited for automation  ### 📚 Full Documentation  For more information on authentication and API usage: https://www.factpulse.fr/documentation-api/     
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+/**
+ * Additional supporting document (BG-24).  References to external documents or embedded attachments.
+ */
+export interface AdditionalDocument {
+    /**
+     * Document reference identifier (BT-122).
+     */
+    'id': string;
+    'type_code'?: string | null;
+    'name'?: string | null;
+    'uri'?: string | null;
+    'reference_type_code'?: string | null;
+}
+

package/models/{document-type.ts → allowance-charge.ts}

@@ -13,35 +13,33 @@
  */
 
 
+// May contain unused imports in some cases
+// @ts-ignore
+import type { Amount } from './amount';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { BaseAmount } from './base-amount';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { Percentage } from './percentage';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { VatRate } from './vat-rate';
 
 /**
- * Commercial document types (UNTDID 1001).  | Code | Name | Description | |------|------|-------------| | 380 | INVOICE | Commercial invoice | | 381 | CREDIT_NOTE | Credit note | | 384 | CORRECTED_INVOICE | Corrected invoice | | 386 | PREPAYMENT | Prepayment invoice | | 389 | SELF_BILLED | Self-billed invoice |
+ * Document-level or line-level allowance/charge.  Represents BG-20 (Document level allowances), BG-21 (Document level charges), BG-27 (Invoice line allowances), or BG-28 (Invoice line charges).
  */
-
-export const DocumentType = {
-    /**
-    * Commercial invoice
-    */
-    INVOICE: '380',
-    /**
-    * Credit note
-    */
-    CREDIT_NOTE: '381',
-    /**
-    * Corrected invoice
-    */
-    CORRECTED_INVOICE: '384',
+export interface AllowanceCharge {
     /**
-    * Prepayment invoice
-    */
-    PREPAYMENT: '386',
-    /**
-    * Self-billed invoice
-    */
-    SELF_BILLED: '389'
-} as const;
-
-export type DocumentType = typeof DocumentType[keyof typeof DocumentType];
-
-
+     * True for charge, False for allowance (ChargeIndicator).
+     */
+    'is_charge': boolean;
+    'amount': Amount;
+    'base_amount'?: BaseAmount | null;
+    'percentage'?: Percentage | null;
+    'reason'?: string | null;
+    'reason_code'?: string | null;
+    'vat_category'?: string | null;
+    'vat_rate'?: VatRate | null;
+}
 

package/models/allowance-total-amount.ts

@@ -0,0 +1,22 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * FactPulse REST API
+ *  REST API for electronic invoicing in France: Factur-X, AFNOR PDP/PA, electronic signatures.  ## 🎯 Main Features  ### 📄 Factur-X Invoice Generation - **Formats**: XML only or PDF/A-3 with embedded XML - **Profiles**: MINIMUM, BASIC, EN16931, EXTENDED - **Standards**: EN 16931 (EU directive 2014/55), ISO 19005-3 (PDF/A-3), CII (UN/CEFACT) - **🆕 Simplified Format**: Generation from SIRET + auto-enrichment (Chorus Pro API + Business Search)  ### ✅ Validation and Compliance - **XML Validation**: Schematron (45 to 210+ rules depending on profile) - **PDF Validation**: PDF/A-3, Factur-X XMP metadata, electronic signatures - **VeraPDF**: Strict PDF/A validation (146+ ISO 19005-3 rules) - **Asynchronous Processing**: Celery support for heavy validations (VeraPDF)  ### 📡 AFNOR PDP/PA Integration (XP Z12-013) - **Flow Submission**: Send invoices to Partner Dematerialization Platforms - **Flow Search**: View submitted invoices - **Download**: Retrieve PDF/A-3 with XML - **Directory Service**: Company search (SIREN/SIRET) - **Multi-client**: Support for multiple PDP configs per user (stored credentials or zero-storage)  ### ✍️ PDF Electronic Signature - **Standards**: PAdES-B-B, PAdES-B-T (RFC 3161 timestamping), PAdES-B-LT (long-term archival) - **eIDAS Levels**: SES (self-signed), AdES (commercial CA), QES (QTSP) - **Validation**: Cryptographic integrity and certificate verification - **Certificate Generation**: Self-signed X.509 certificates for testing  ### 🔄 Asynchronous Processing - **Celery**: Asynchronous generation, validation and signing - **Polling**: Status tracking via `/tasks/{task_id}/status` - **No timeout**: Ideal for large files or heavy validations  ## 🔒 Authentication  All requests require a **JWT token** in the Authorization header: ``` Authorization: Bearer YOUR_JWT_TOKEN ```  ### How to obtain a JWT token?  #### 🔑 Method 1: `/api/token/` API (Recommended)  **URL:** `https://www.factpulse.fr/api/token/`  This method is **recommended** for integration in your applications and CI/CD workflows.  **Prerequisites:** Having set a password on your account  **For users registered via email/password:** - You already have a password, use it directly  **For users registered via OAuth (Google/GitHub):** - You must first set a password at: https://www.factpulse.fr/accounts/password/set/ - Once the password is created, you can use the API  **Request example:** ```bash curl -X POST https://www.factpulse.fr/api/token/ \\   -H \"Content-Type: application/json\" \\   -d \'{     \"username\": \"your_email@example.com\",     \"password\": \"your_password\"   }\' ```  **Optional `client_uid` parameter:**  To select credentials for a specific client (PA/PDP, Chorus Pro, signing certificates), add `client_uid`:  ```bash curl -X POST https://www.factpulse.fr/api/token/ \\   -H \"Content-Type: application/json\" \\   -d \'{     \"username\": \"your_email@example.com\",     \"password\": \"your_password\",     \"client_uid\": \"550e8400-e29b-41d4-a716-446655440000\"   }\' ```  The `client_uid` will be included in the JWT and allow the API to automatically use: - AFNOR/PDP credentials configured for this client - Chorus Pro credentials configured for this client - Electronic signature certificates configured for this client  **Response:** ```json {   \"access\": \"eyJ0eXAiOiJKV1QiLCJhbGc...\",  // Access token (validity: 30 min)   \"refresh\": \"eyJ0eXAiOiJKV1QiLCJhbGc...\"  // Refresh token (validity: 7 days) } ```  **Advantages:** - ✅ Full automation (CI/CD, scripts) - ✅ Programmatic token management - ✅ Refresh token support for automatic access renewal - ✅ Easy integration in any language/tool  #### 🖥️ Method 2: Dashboard Generation (Alternative)  **URL:** https://www.factpulse.fr/dashboard/  This method is suitable for quick tests or occasional use via the graphical interface.  **How it works:** - Log in to the dashboard - Use the \"Generate Test Token\" or \"Generate Production Token\" buttons - Works for **all** users (OAuth and email/password), without requiring a password  **Token types:** - **Test Token**: 24h validity, 1000 calls/day quota (free) - **Production Token**: 7 days validity, quota based on your plan  **Advantages:** - ✅ Quick for API testing - ✅ No password required - ✅ Simple visual interface  **Disadvantages:** - ❌ Requires manual action - ❌ No refresh token - ❌ Less suited for automation  ### 📚 Full Documentation  For more information on authentication and API usage: https://www.factpulse.fr/documentation-api/     
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+/**
+ * Sum of all allowances on document level (BT-107).
+ */
+export interface AllowanceTotalAmount {
+}
+

package/models/amount-due.ts

@@ -15,7 +15,7 @@
 
 
 /**
- * Amount due for payment. (Accepte number, string ou integer)
+ * Amount due for payment (BT-115). Can be negative for correction invoices.
  */
 export interface AmountDue {
 }

package/models/amount.ts

@@ -0,0 +1,22 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * FactPulse REST API
+ *  REST API for electronic invoicing in France: Factur-X, AFNOR PDP/PA, electronic signatures.  ## 🎯 Main Features  ### 📄 Factur-X Invoice Generation - **Formats**: XML only or PDF/A-3 with embedded XML - **Profiles**: MINIMUM, BASIC, EN16931, EXTENDED - **Standards**: EN 16931 (EU directive 2014/55), ISO 19005-3 (PDF/A-3), CII (UN/CEFACT) - **🆕 Simplified Format**: Generation from SIRET + auto-enrichment (Chorus Pro API + Business Search)  ### ✅ Validation and Compliance - **XML Validation**: Schematron (45 to 210+ rules depending on profile) - **PDF Validation**: PDF/A-3, Factur-X XMP metadata, electronic signatures - **VeraPDF**: Strict PDF/A validation (146+ ISO 19005-3 rules) - **Asynchronous Processing**: Celery support for heavy validations (VeraPDF)  ### 📡 AFNOR PDP/PA Integration (XP Z12-013) - **Flow Submission**: Send invoices to Partner Dematerialization Platforms - **Flow Search**: View submitted invoices - **Download**: Retrieve PDF/A-3 with XML - **Directory Service**: Company search (SIREN/SIRET) - **Multi-client**: Support for multiple PDP configs per user (stored credentials or zero-storage)  ### ✍️ PDF Electronic Signature - **Standards**: PAdES-B-B, PAdES-B-T (RFC 3161 timestamping), PAdES-B-LT (long-term archival) - **eIDAS Levels**: SES (self-signed), AdES (commercial CA), QES (QTSP) - **Validation**: Cryptographic integrity and certificate verification - **Certificate Generation**: Self-signed X.509 certificates for testing  ### 🔄 Asynchronous Processing - **Celery**: Asynchronous generation, validation and signing - **Polling**: Status tracking via `/tasks/{task_id}/status` - **No timeout**: Ideal for large files or heavy validations  ## 🔒 Authentication  All requests require a **JWT token** in the Authorization header: ``` Authorization: Bearer YOUR_JWT_TOKEN ```  ### How to obtain a JWT token?  #### 🔑 Method 1: `/api/token/` API (Recommended)  **URL:** `https://www.factpulse.fr/api/token/`  This method is **recommended** for integration in your applications and CI/CD workflows.  **Prerequisites:** Having set a password on your account  **For users registered via email/password:** - You already have a password, use it directly  **For users registered via OAuth (Google/GitHub):** - You must first set a password at: https://www.factpulse.fr/accounts/password/set/ - Once the password is created, you can use the API  **Request example:** ```bash curl -X POST https://www.factpulse.fr/api/token/ \\   -H \"Content-Type: application/json\" \\   -d \'{     \"username\": \"your_email@example.com\",     \"password\": \"your_password\"   }\' ```  **Optional `client_uid` parameter:**  To select credentials for a specific client (PA/PDP, Chorus Pro, signing certificates), add `client_uid`:  ```bash curl -X POST https://www.factpulse.fr/api/token/ \\   -H \"Content-Type: application/json\" \\   -d \'{     \"username\": \"your_email@example.com\",     \"password\": \"your_password\",     \"client_uid\": \"550e8400-e29b-41d4-a716-446655440000\"   }\' ```  The `client_uid` will be included in the JWT and allow the API to automatically use: - AFNOR/PDP credentials configured for this client - Chorus Pro credentials configured for this client - Electronic signature certificates configured for this client  **Response:** ```json {   \"access\": \"eyJ0eXAiOiJKV1QiLCJhbGc...\",  // Access token (validity: 30 min)   \"refresh\": \"eyJ0eXAiOiJKV1QiLCJhbGc...\"  // Refresh token (validity: 7 days) } ```  **Advantages:** - ✅ Full automation (CI/CD, scripts) - ✅ Programmatic token management - ✅ Refresh token support for automatic access renewal - ✅ Easy integration in any language/tool  #### 🖥️ Method 2: Dashboard Generation (Alternative)  **URL:** https://www.factpulse.fr/dashboard/  This method is suitable for quick tests or occasional use via the graphical interface.  **How it works:** - Log in to the dashboard - Use the \"Generate Test Token\" or \"Generate Production Token\" buttons - Works for **all** users (OAuth and email/password), without requiring a password  **Token types:** - **Test Token**: 24h validity, 1000 calls/day quota (free) - **Production Token**: 7 days validity, quota based on your plan  **Advantages:** - ✅ Quick for API testing - ✅ No password required - ✅ Simple visual interface  **Disadvantages:** - ❌ Requires manual action - ❌ No refresh token - ❌ Less suited for automation  ### 📚 Full Documentation  For more information on authentication and API usage: https://www.factpulse.fr/documentation-api/     
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+/**
+ * Allowance/charge amount (BT-92/99/136/141).
+ */
+export interface Amount {
+}
+