factpulse 2.0.37__py3-none-any.whl → 3.0.23__py3-none-any.whl

factpulse/models/incoming_invoice.py

@@ -0,0 +1,175 @@
+# coding: utf-8
+
+"""
+    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://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://factpulse.fr/accounts/password/set/ - Once the password is created, you can use the API  **Request example:** ```bash curl -X POST https://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://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://factpulse.fr/api/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://factpulse.fr/documentation-api/     
+
+    The version of the OpenAPI document: 1.0.0
+    Contact: contact@factpulse.fr
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from factpulse.models.incoming_supplier import IncomingSupplier
+from factpulse.models.invoice_format import InvoiceFormat
+from factpulse.models.invoice_type_code_output import InvoiceTypeCodeOutput
+from typing import Optional, Set
+from typing_extensions import Self
+
+class IncomingInvoice(BaseModel):
+    """
+    Invoice received from a supplier via PDP/PA.  This model contains essential metadata extracted from incoming invoices, regardless of their source format (CII, UBL, Factur-X).  Amounts are Decimal in Python but will be serialized as strings in JSON to preserve monetary precision.
+    """ # noqa: E501
+    flow_id: Optional[StrictStr] = Field(default=None, alias="flowId")
+    source_format: InvoiceFormat = Field(description="Invoice source format", alias="sourceFormat")
+    supplier_reference: StrictStr = Field(description="Invoice number issued by the supplier (BT-1)", alias="supplierReference")
+    document_type: Optional[InvoiceTypeCodeOutput] = Field(default=None, description="Document type (BT-3)", alias="documentType")
+    supplier: IncomingSupplier = Field(description="Invoice issuer (SellerTradeParty)")
+    billing_site_name: StrictStr = Field(description="Recipient name / your company (BT-44)", alias="billingSiteName")
+    billing_site_siret: Optional[StrictStr] = Field(default=None, alias="billingSiteSiret")
+    issue_date: StrictStr = Field(description="Invoice date (BT-2) - YYYY-MM-DD", alias="issueDate")
+    due_date: Optional[StrictStr] = Field(default=None, alias="dueDate")
+    currency: Optional[StrictStr] = Field(default='EUR', description="ISO currency code (BT-5)")
+    net_amount: StrictStr = Field(description="Total net amount (BT-109)", alias="netAmount")
+    vat_amount: StrictStr = Field(description="Total VAT amount (BT-110)", alias="vatAmount")
+    gross_amount: StrictStr = Field(description="Total gross amount (BT-112)", alias="grossAmount")
+    purchase_order_number: Optional[StrictStr] = Field(default=None, alias="purchaseOrderNumber")
+    contract_reference: Optional[StrictStr] = Field(default=None, alias="contractReference")
+    invoice_subject: Optional[StrictStr] = Field(default=None, alias="invoiceSubject")
+    document_base64: Optional[StrictStr] = Field(default=None, alias="documentBase64")
+    document_content_type: Optional[StrictStr] = Field(default=None, alias="documentContentType")
+    document_filename: Optional[StrictStr] = Field(default=None, alias="documentFilename")
+    __properties: ClassVar[List[str]] = ["flowId", "sourceFormat", "supplierReference", "documentType", "supplier", "billingSiteName", "billingSiteSiret", "issueDate", "dueDate", "currency", "netAmount", "vatAmount", "grossAmount", "purchaseOrderNumber", "contractReference", "invoiceSubject", "documentBase64", "documentContentType", "documentFilename"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of IncomingInvoice from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of supplier
+        if self.supplier:
+            _dict['supplier'] = self.supplier.to_dict()
+        # set to None if flow_id (nullable) is None
+        # and model_fields_set contains the field
+        if self.flow_id is None and "flow_id" in self.model_fields_set:
+            _dict['flowId'] = None
+
+        # set to None if billing_site_siret (nullable) is None
+        # and model_fields_set contains the field
+        if self.billing_site_siret is None and "billing_site_siret" in self.model_fields_set:
+            _dict['billingSiteSiret'] = None
+
+        # set to None if due_date (nullable) is None
+        # and model_fields_set contains the field
+        if self.due_date is None and "due_date" in self.model_fields_set:
+            _dict['dueDate'] = None
+
+        # set to None if purchase_order_number (nullable) is None
+        # and model_fields_set contains the field
+        if self.purchase_order_number is None and "purchase_order_number" in self.model_fields_set:
+            _dict['purchaseOrderNumber'] = None
+
+        # set to None if contract_reference (nullable) is None
+        # and model_fields_set contains the field
+        if self.contract_reference is None and "contract_reference" in self.model_fields_set:
+            _dict['contractReference'] = None
+
+        # set to None if invoice_subject (nullable) is None
+        # and model_fields_set contains the field
+        if self.invoice_subject is None and "invoice_subject" in self.model_fields_set:
+            _dict['invoiceSubject'] = None
+
+        # set to None if document_base64 (nullable) is None
+        # and model_fields_set contains the field
+        if self.document_base64 is None and "document_base64" in self.model_fields_set:
+            _dict['documentBase64'] = None
+
+        # set to None if document_content_type (nullable) is None
+        # and model_fields_set contains the field
+        if self.document_content_type is None and "document_content_type" in self.model_fields_set:
+            _dict['documentContentType'] = None
+
+        # set to None if document_filename (nullable) is None
+        # and model_fields_set contains the field
+        if self.document_filename is None and "document_filename" in self.model_fields_set:
+            _dict['documentFilename'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of IncomingInvoice from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "flowId": obj.get("flowId"),
+            "sourceFormat": obj.get("sourceFormat"),
+            "supplierReference": obj.get("supplierReference"),
+            "documentType": obj.get("documentType"),
+            "supplier": IncomingSupplier.from_dict(obj["supplier"]) if obj.get("supplier") is not None else None,
+            "billingSiteName": obj.get("billingSiteName"),
+            "billingSiteSiret": obj.get("billingSiteSiret"),
+            "issueDate": obj.get("issueDate"),
+            "dueDate": obj.get("dueDate"),
+            "currency": obj.get("currency") if obj.get("currency") is not None else 'EUR',
+            "netAmount": obj.get("netAmount"),
+            "vatAmount": obj.get("vatAmount"),
+            "grossAmount": obj.get("grossAmount"),
+            "purchaseOrderNumber": obj.get("purchaseOrderNumber"),
+            "contractReference": obj.get("contractReference"),
+            "invoiceSubject": obj.get("invoiceSubject"),
+            "documentBase64": obj.get("documentBase64"),
+            "documentContentType": obj.get("documentContentType"),
+            "documentFilename": obj.get("documentFilename")
+        })
+        return _obj
+
+

factpulse/models/incoming_supplier.py

@@ -0,0 +1,145 @@
+# coding: utf-8
+
+"""
+    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://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://factpulse.fr/accounts/password/set/ - Once the password is created, you can use the API  **Request example:** ```bash curl -X POST https://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://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://factpulse.fr/api/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://factpulse.fr/documentation-api/     
+
+    The version of the OpenAPI document: 1.0.0
+    Contact: contact@factpulse.fr
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from factpulse.models.electronic_address import ElectronicAddress
+from factpulse.models.postal_address import PostalAddress
+from typing import Optional, Set
+from typing_extensions import Self
+
+class IncomingSupplier(BaseModel):
+    """
+    Supplier extracted from an incoming invoice.  Unlike the Supplier model in models.py, this model does not have a supplier_id field as this information is not available in Factur-X/CII/UBL XML files.
+    """ # noqa: E501
+    name: StrictStr = Field(description="Supplier business name (BT-27)")
+    siren: Optional[StrictStr] = None
+    siret: Optional[StrictStr] = None
+    vat_number: Optional[StrictStr] = Field(default=None, alias="vatNumber")
+    postal_address: Optional[PostalAddress] = Field(default=None, alias="postalAddress")
+    electronic_address: Optional[ElectronicAddress] = Field(default=None, alias="electronicAddress")
+    email: Optional[StrictStr] = None
+    phone: Optional[StrictStr] = None
+    __properties: ClassVar[List[str]] = ["name", "siren", "siret", "vatNumber", "postalAddress", "electronicAddress", "email", "phone"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of IncomingSupplier from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of postal_address
+        if self.postal_address:
+            _dict['postalAddress'] = self.postal_address.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of electronic_address
+        if self.electronic_address:
+            _dict['electronicAddress'] = self.electronic_address.to_dict()
+        # set to None if siren (nullable) is None
+        # and model_fields_set contains the field
+        if self.siren is None and "siren" in self.model_fields_set:
+            _dict['siren'] = None
+
+        # set to None if siret (nullable) is None
+        # and model_fields_set contains the field
+        if self.siret is None and "siret" in self.model_fields_set:
+            _dict['siret'] = None
+
+        # set to None if vat_number (nullable) is None
+        # and model_fields_set contains the field
+        if self.vat_number is None and "vat_number" in self.model_fields_set:
+            _dict['vatNumber'] = None
+
+        # set to None if postal_address (nullable) is None
+        # and model_fields_set contains the field
+        if self.postal_address is None and "postal_address" in self.model_fields_set:
+            _dict['postalAddress'] = None
+
+        # set to None if electronic_address (nullable) is None
+        # and model_fields_set contains the field
+        if self.electronic_address is None and "electronic_address" in self.model_fields_set:
+            _dict['electronicAddress'] = None
+
+        # set to None if email (nullable) is None
+        # and model_fields_set contains the field
+        if self.email is None and "email" in self.model_fields_set:
+            _dict['email'] = None
+
+        # set to None if phone (nullable) is None
+        # and model_fields_set contains the field
+        if self.phone is None and "phone" in self.model_fields_set:
+            _dict['phone'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of IncomingSupplier from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "name": obj.get("name"),
+            "siren": obj.get("siren"),
+            "siret": obj.get("siret"),
+            "vatNumber": obj.get("vatNumber"),
+            "postalAddress": PostalAddress.from_dict(obj["postalAddress"]) if obj.get("postalAddress") is not None else None,
+            "electronicAddress": ElectronicAddress.from_dict(obj["electronicAddress"]) if obj.get("electronicAddress") is not None else None,
+            "email": obj.get("email"),
+            "phone": obj.get("phone")
+        })
+        return _obj
+
+

factpulse/models/invoice_format.py

@@ -0,0 +1,39 @@
+# coding: utf-8
+
+"""
+    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://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://factpulse.fr/accounts/password/set/ - Once the password is created, you can use the API  **Request example:** ```bash curl -X POST https://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://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://factpulse.fr/api/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://factpulse.fr/documentation-api/     
+
+    The version of the OpenAPI document: 1.0.0
+    Contact: contact@factpulse.fr
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import json
+from enum import Enum
+from typing_extensions import Self
+
+
+class InvoiceFormat(str, Enum):
+    """
+    Supported invoice formats for extraction.
+    """
+
+    """
+    allowed enum values
+    """
+    CII = 'CII'
+    UBL = 'UBL'
+    FACTUR_MINUS_X = 'Factur-X'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of InvoiceFormat from a JSON string"""
+        return cls(json.loads(json_str))
+
+

factpulse/models/invoice_input.py

@@ -0,0 +1,179 @@
+# coding: utf-8
+
+"""
+    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://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://factpulse.fr/accounts/password/set/ - Once the password is created, you can use the API  **Request example:** ```bash curl -X POST https://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://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://factpulse.fr/api/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://factpulse.fr/documentation-api/     
+
+    The version of the OpenAPI document: 1.0.0
+    Contact: contact@factpulse.fr
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from datetime import date
+from pydantic import BaseModel, ConfigDict, Field, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing_extensions import Annotated
+from factpulse.models.buyercountry import Buyercountry
+from factpulse.models.currency import Currency
+from factpulse.models.facture_electronique_rest_api_schemas_ereporting_invoice_type_code import FactureElectroniqueRestApiSchemasEreportingInvoiceTypeCode
+from factpulse.models.sellercountry import Sellercountry
+from factpulse.models.tax_breakdown_input import TaxBreakdownInput
+from factpulse.models.taxamount1 import Taxamount1
+from factpulse.models.taxexclusiveamount1 import Taxexclusiveamount1
+from typing import Optional, Set
+from typing_extensions import Self
+
+class InvoiceInput(BaseModel):
+    """
+    Invoice for B2B international reporting (flux 10.1).  Used for unitary declaration of international B2B invoices.
+    """ # noqa: E501
+    invoice_id: StrictStr = Field(description="Invoice identifier", alias="invoiceId")
+    issue_date: date = Field(description="Invoice issue date", alias="issueDate")
+    type_code: Optional[FactureElectroniqueRestApiSchemasEreportingInvoiceTypeCode] = Field(default=None, description="Invoice type code", alias="typeCode")
+    currency: Optional[Currency] = None
+    due_date: Optional[date] = Field(default=None, alias="dueDate")
+    seller_siren: StrictStr = Field(description="Seller SIREN/SIRET", alias="sellerSiren")
+    seller_vat_id: Optional[StrictStr] = Field(default=None, alias="sellerVatId")
+    seller_country: Optional[Sellercountry] = Field(default=None, alias="sellerCountry")
+    buyer_id: Optional[StrictStr] = Field(default=None, alias="buyerId")
+    buyer_vat_id: Optional[StrictStr] = Field(default=None, alias="buyerVatId")
+    buyer_country: Buyercountry = Field(alias="buyerCountry")
+    tax_exclusive_amount: Taxexclusiveamount1 = Field(alias="taxExclusiveAmount")
+    tax_amount: Taxamount1 = Field(alias="taxAmount")
+    tax_breakdown: Annotated[List[TaxBreakdownInput], Field(min_length=1)] = Field(description="VAT breakdown", alias="taxBreakdown")
+    referenced_invoice_id: Optional[StrictStr] = Field(default=None, alias="referencedInvoiceId")
+    referenced_invoice_date: Optional[date] = Field(default=None, alias="referencedInvoiceDate")
+    __properties: ClassVar[List[str]] = ["invoiceId", "issueDate", "typeCode", "currency", "dueDate", "sellerSiren", "sellerVatId", "sellerCountry", "buyerId", "buyerVatId", "buyerCountry", "taxExclusiveAmount", "taxAmount", "taxBreakdown", "referencedInvoiceId", "referencedInvoiceDate"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of InvoiceInput from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of currency
+        if self.currency:
+            _dict['currency'] = self.currency.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of seller_country
+        if self.seller_country:
+            _dict['sellerCountry'] = self.seller_country.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of buyer_country
+        if self.buyer_country:
+            _dict['buyerCountry'] = self.buyer_country.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of tax_exclusive_amount
+        if self.tax_exclusive_amount:
+            _dict['taxExclusiveAmount'] = self.tax_exclusive_amount.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of tax_amount
+        if self.tax_amount:
+            _dict['taxAmount'] = self.tax_amount.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of each item in tax_breakdown (list)
+        _items = []
+        if self.tax_breakdown:
+            for _item_tax_breakdown in self.tax_breakdown:
+                if _item_tax_breakdown:
+                    _items.append(_item_tax_breakdown.to_dict())
+            _dict['taxBreakdown'] = _items
+        # set to None if due_date (nullable) is None
+        # and model_fields_set contains the field
+        if self.due_date is None and "due_date" in self.model_fields_set:
+            _dict['dueDate'] = None
+
+        # set to None if seller_vat_id (nullable) is None
+        # and model_fields_set contains the field
+        if self.seller_vat_id is None and "seller_vat_id" in self.model_fields_set:
+            _dict['sellerVatId'] = None
+
+        # set to None if buyer_id (nullable) is None
+        # and model_fields_set contains the field
+        if self.buyer_id is None and "buyer_id" in self.model_fields_set:
+            _dict['buyerId'] = None
+
+        # set to None if buyer_vat_id (nullable) is None
+        # and model_fields_set contains the field
+        if self.buyer_vat_id is None and "buyer_vat_id" in self.model_fields_set:
+            _dict['buyerVatId'] = None
+
+        # set to None if referenced_invoice_id (nullable) is None
+        # and model_fields_set contains the field
+        if self.referenced_invoice_id is None and "referenced_invoice_id" in self.model_fields_set:
+            _dict['referencedInvoiceId'] = None
+
+        # set to None if referenced_invoice_date (nullable) is None
+        # and model_fields_set contains the field
+        if self.referenced_invoice_date is None and "referenced_invoice_date" in self.model_fields_set:
+            _dict['referencedInvoiceDate'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of InvoiceInput from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "invoiceId": obj.get("invoiceId"),
+            "issueDate": obj.get("issueDate"),
+            "typeCode": obj.get("typeCode"),
+            "currency": Currency.from_dict(obj["currency"]) if obj.get("currency") is not None else None,
+            "dueDate": obj.get("dueDate"),
+            "sellerSiren": obj.get("sellerSiren"),
+            "sellerVatId": obj.get("sellerVatId"),
+            "sellerCountry": Sellercountry.from_dict(obj["sellerCountry"]) if obj.get("sellerCountry") is not None else None,
+            "buyerId": obj.get("buyerId"),
+            "buyerVatId": obj.get("buyerVatId"),
+            "buyerCountry": Buyercountry.from_dict(obj["buyerCountry"]) if obj.get("buyerCountry") is not None else None,
+            "taxExclusiveAmount": Taxexclusiveamount1.from_dict(obj["taxExclusiveAmount"]) if obj.get("taxExclusiveAmount") is not None else None,
+            "taxAmount": Taxamount1.from_dict(obj["taxAmount"]) if obj.get("taxAmount") is not None else None,
+            "taxBreakdown": [TaxBreakdownInput.from_dict(_item) for _item in obj["taxBreakdown"]] if obj.get("taxBreakdown") is not None else None,
+            "referencedInvoiceId": obj.get("referencedInvoiceId"),
+            "referencedInvoiceDate": obj.get("referencedInvoiceDate")
+        })
+        return _obj
+
+