@factpulse/sdk 2.0.49 → 3.0.2

package/docs/FormatFacture.md

@@ -1,13 +0,0 @@
-# FormatFacture
-
-Formats de facture supportés pour l\'extraction.
-
-## Enum
-
-* `Cii` (value: `'CII'`)
-
-* `Ubl` (value: `'UBL'`)
-
-* `FacturX` (value: `'Factur-X'`)
-
-[[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/FormatSortie.md

@@ -1,10 +0,0 @@
-# FormatSortie
-
-
-## 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/Fournisseur.md

@@ -1,39 +0,0 @@
-# Fournisseur
-
-Informations sur le fournisseur qui émet la facture.
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**adresseElectronique** | [**AdresseElectronique**](AdresseElectronique.md) |  | [default to undefined]
-**idFournisseur** | **number** |  | [default to undefined]
-**codeCoordonneesBancairesFournisseur** | **number** |  | [optional] [default to undefined]
-**idServiceFournisseur** | **number** |  | [optional] [default to undefined]
-**nom** | **string** |  | [optional] [default to undefined]
-**siren** | **string** |  | [optional] [default to undefined]
-**siret** | **string** |  | [optional] [default to undefined]
-**numeroTvaIntra** | **string** |  | [optional] [default to undefined]
-**iban** | **string** |  | [optional] [default to undefined]
-**adressePostale** | [**AdressePostale**](AdressePostale.md) |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { Fournisseur } from '@factpulse/sdk';
-
-const instance: Fournisseur = {
-    adresseElectronique,
-    idFournisseur,
-    codeCoordonneesBancairesFournisseur,
-    idServiceFournisseur,
-    nom,
-    siren,
-    siret,
-    numeroTvaIntra,
-    iban,
-    adressePostale,
-};
-```
-
-[[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/FournisseurEntrant.md

@@ -1,35 +0,0 @@
-# FournisseurEntrant
-
-Fournisseur extrait d\'une facture entrante.  Contrairement au modèle Fournisseur de models.py, ce modèle n\'a pas de champ id_fournisseur car cette information n\'est pas disponible dans les XML Factur-X/CII/UBL.
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**nom** | **string** | Raison sociale du fournisseur (BT-27) | [default to undefined]
-**siren** | **string** |  | [optional] [default to undefined]
-**siret** | **string** |  | [optional] [default to undefined]
-**numero_tva_intra** | **string** |  | [optional] [default to undefined]
-**adresse_postale** | [**AdressePostale**](AdressePostale.md) |  | [optional] [default to undefined]
-**adresse_electronique** | [**AdresseElectronique**](AdresseElectronique.md) |  | [optional] [default to undefined]
-**email** | **string** |  | [optional] [default to undefined]
-**telephone** | **string** |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { FournisseurEntrant } from '@factpulse/sdk';
-
-const instance: FournisseurEntrant = {
-    nom,
-    siren,
-    siret,
-    numero_tva_intra,
-    adresse_postale,
-    adresse_electronique,
-    email,
-    telephone,
-};
-```
-
-[[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/InformationSignatureAPI.md

@@ -1,31 +0,0 @@
-# InformationSignatureAPI
-
-Informations sur une signature électronique dans un PDF.
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**nom_champ** | **string** | Nom du champ de signature dans le PDF | [default to undefined]
-**signataire** | **string** |  | [optional] [default to undefined]
-**date_signature** | **string** |  | [optional] [default to undefined]
-**raison** | **string** |  | [optional] [default to undefined]
-**localisation** | **string** |  | [optional] [default to undefined]
-**est_valide** | **boolean** |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { InformationSignatureAPI } from '@factpulse/sdk';
-
-const instance: InformationSignatureAPI = {
-    nom_champ,
-    signataire,
-    date_signature,
-    raison,
-    localisation,
-    est_valide,
-};
-```
-
-[[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/LigneDePoste.md

@@ -1,49 +0,0 @@
-# LigneDePoste
-
-Représente une ligne de détail dans une facture.
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**numero** | **number** |  | [default to undefined]
-**reference** | **string** |  | [optional] [default to undefined]
-**denomination** | **string** |  | [default to undefined]
-**quantite** | [**Quantite**](Quantite.md) |  | [default to undefined]
-**unite** | [**Unite**](Unite.md) |  | [default to undefined]
-**montantUnitaireHt** | [**MontantUnitaireHt**](MontantUnitaireHt.md) |  | [default to undefined]
-**montantRemiseHt** | [**LigneDePosteMontantRemiseHt**](LigneDePosteMontantRemiseHt.md) |  | [optional] [default to undefined]
-**montantTotalLigneHt** | [**MontantTotalLigneHt**](MontantTotalLigneHt.md) |  | [optional] [default to undefined]
-**tauxTva** | **string** |  | [optional] [default to undefined]
-**tauxTvaManuel** | [**LigneDePosteTauxTvaManuel**](LigneDePosteTauxTvaManuel.md) |  | [optional] [default to undefined]
-**categorieTva** | [**CategorieTVA**](CategorieTVA.md) |  | [optional] [default to undefined]
-**dateDebutPeriode** | **string** |  | [optional] [default to undefined]
-**dateFinPeriode** | **string** |  | [optional] [default to undefined]
-**codeRaisonReduction** | [**CodeRaisonReduction**](CodeRaisonReduction.md) |  | [optional] [default to undefined]
-**raisonReduction** | **string** |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { LigneDePoste } from '@factpulse/sdk';
-
-const instance: LigneDePoste = {
-    numero,
-    reference,
-    denomination,
-    quantite,
-    unite,
-    montantUnitaireHt,
-    montantRemiseHt,
-    montantTotalLigneHt,
-    tauxTva,
-    tauxTvaManuel,
-    categorieTva,
-    dateDebutPeriode,
-    dateFinPeriode,
-    codeRaisonReduction,
-    raisonReduction,
-};
-```
-
-[[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/LigneDePosteMontantRemiseHt.md

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

@@ -1,19 +0,0 @@
-# LigneDePosteTauxTvaManuel
-
-Taux de TVA avec valeur manuelle. (Accepte number, string ou integer)
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-
-## Example
-
-```typescript
-import { LigneDePosteTauxTvaManuel } from '@factpulse/sdk';
-
-const instance: LigneDePosteTauxTvaManuel = {
-};
-```
-
-[[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/LigneDeTVA.md

@@ -1,33 +0,0 @@
-# LigneDeTVA
-
-Représente une ligne de totalisation par taux de TVA.  Pour les exonérations (catégories E, AE, K, G, O), les champs `motif_exoneration` et `code_vatex` sont requis selon EN16931.
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**montantBaseHt** | [**MontantBaseHt**](MontantBaseHt.md) |  | [default to undefined]
-**montantTva** | [**MontantTvaLigne**](MontantTvaLigne.md) |  | [default to undefined]
-**taux** | **string** |  | [optional] [default to undefined]
-**tauxManuel** | [**Tauxmanuel**](Tauxmanuel.md) |  | [optional] [default to undefined]
-**categorie** | [**CategorieTVA**](CategorieTVA.md) |  | [optional] [default to undefined]
-**motifExoneration** | **string** |  | [optional] [default to undefined]
-**codeVatex** | **string** |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { LigneDeTVA } from '@factpulse/sdk';
-
-const instance: LigneDeTVA = {
-    montantBaseHt,
-    montantTva,
-    taux,
-    tauxManuel,
-    categorie,
-    motifExoneration,
-    codeVatex,
-};
-```
-
-[[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/ModeDepot.md

@@ -1,13 +0,0 @@
-# ModeDepot
-
-Mode de dépôt de la facture sur Chorus Pro.
-
-## Enum
-
-* `SaisieApi` (value: `'SAISIE_API'`)
-
-* `DepotPdfApi` (value: `'DEPOT_PDF_API'`)
-
-* `DepotPdfSigneApi` (value: `'DEPOT_PDF_SIGNE_API'`)
-
-[[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/ModePaiement.md

@@ -1,19 +0,0 @@
-# ModePaiement
-
-Modes de paiement acceptés.
-
-## Enum
-
-* `Cheque` (value: `'CHEQUE'`)
-
-* `Prelevement` (value: `'PRELEVEMENT'`)
-
-* `Virement` (value: `'VIREMENT'`)
-
-* `Espece` (value: `'ESPECE'`)
-
-* `Autre` (value: `'AUTRE'`)
-
-* `Report` (value: `'REPORT'`)
-
-[[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/MontantAPayer.md

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

@@ -1,19 +0,0 @@
-# MontantBaseHt
-
-Montant de la base HT pour cette ligne de TVA. (Accepte number, string ou integer)
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-
-## Example
-
-```typescript
-import { MontantBaseHt } from '@factpulse/sdk';
-
-const instance: MontantBaseHt = {
-};
-```
-
-[[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/MontantHtTotal.md

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

@@ -1,19 +0,0 @@
-# MontantRemiseGlobaleTtc
-
-Montant de la remise globale TTC. (Accepte number, string ou integer)
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-
-## Example
-
-```typescript
-import { MontantRemiseGlobaleTtc } from '@factpulse/sdk';
-
-const instance: MontantRemiseGlobaleTtc = {
-};
-```
-
-[[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/MontantTotal.md

@@ -1,33 +0,0 @@
-# MontantTotal
-
-Contient tous les montants totaux de la facture.
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**montantHtTotal** | [**MontantHtTotal**](MontantHtTotal.md) |  | [default to undefined]
-**montantTva** | [**MontantTvaTotal**](MontantTvaTotal.md) |  | [default to undefined]
-**montantTtcTotal** | [**MontantTtcTotal**](MontantTtcTotal.md) |  | [default to undefined]
-**montantAPayer** | [**MontantAPayer**](MontantAPayer.md) |  | [default to undefined]
-**acompte** | [**MontantTotalAcompte**](MontantTotalAcompte.md) |  | [optional] [default to undefined]
-**montantRemiseGlobaleTtc** | [**MontantRemiseGlobaleTtc**](MontantRemiseGlobaleTtc.md) |  | [optional] [default to undefined]
-**motifRemiseGlobaleTtc** | **string** |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { MontantTotal } from '@factpulse/sdk';
-
-const instance: MontantTotal = {
-    montantHtTotal,
-    montantTva,
-    montantTtcTotal,
-    montantAPayer,
-    acompte,
-    montantRemiseGlobaleTtc,
-    motifRemiseGlobaleTtc,
-};
-```
-
-[[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/MontantTotalAcompte.md

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

@@ -1,19 +0,0 @@
-# MontantTotalLigneHt
-
-Montant total HT de la ligne (quantité × prix unitaire - remise). (Accepte number, string ou integer)
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-
-## Example
-
-```typescript
-import { MontantTotalLigneHt } from '@factpulse/sdk';
-
-const instance: MontantTotalLigneHt = {
-};
-```
-
-[[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/MontantTtcTotal.md

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

@@ -1,19 +0,0 @@
-# MontantTva
-
-Montant TVA
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-
-## Example
-
-```typescript
-import { MontantTva } from '@factpulse/sdk';
-
-const instance: MontantTva = {
-};
-```
-
-[[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/MontantTvaLigne.md

@@ -1,19 +0,0 @@
-# MontantTvaLigne
-
-Montant de la TVA pour cette ligne. (Accepte number, string ou integer)
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-
-## Example
-
-```typescript
-import { MontantTvaLigne } from '@factpulse/sdk';
-
-const instance: MontantTvaLigne = {
-};
-```
-
-[[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/MontantTvaTotal.md

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

@@ -1,19 +0,0 @@
-# MontantUnitaireHt
-
-Montant unitaire Hors Taxes de l\'article.
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-
-## Example
-
-```typescript
-import { MontantUnitaireHt } from '@factpulse/sdk';
-
-const instance: MontantUnitaireHt = {
-};
-```
-
-[[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/NatureOperation.md

@@ -1,35 +0,0 @@
-# NatureOperation
-
-Nature de l\'opération (BT-23) pour Factur-X - Réforme française.  BR-FR-08: Le cadre de facturation doit être l\'un des codes suivants. La première lettre indique : B = Biens, S = Services, M = Mixte.  Ref: XP Z12-012, article_conformite_pdf_facturx.md  Exemple d\'utilisation:     >>> cadre = CadreDeFacturation(     ...     code_cadre_facturation=CodeCadreFacturation.A1_FACTURE_FOURNISSEUR,     ...     nature_operation=NatureOperation.BIENS     ... )
-
-## 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/Note.md

@@ -1,23 +0,0 @@
-# Note
-
-Note de facture (IncludedNote en Factur-X).  Les notes obligatoires pour BR-FR-05 sont : - PMT : Indemnité forfaitaire pour frais de recouvrement - PMD : Pénalités de retard - AAB : Escompte pour paiement anticipé
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**codeSujet** | **string** |  | [optional] [default to undefined]
-**contenu** | **string** |  | [default to undefined]
-
-## Example
-
-```typescript
-import { Note } from '@factpulse/sdk';
-
-const instance: Note = {
-    codeSujet,
-    contenu,
-};
-```
-
-[[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/NoteObligatoireSchema.md

@@ -1,33 +0,0 @@
-# NoteObligatoireSchema
-
-Note obligatoire détectée avec localisation et comparaison XML/PDF.
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**code_sujet** | **string** | Code sujet (PMT, PMD, AAB) | [default to undefined]
-**label** | **string** | Libellé (ex: Indemnité recouvrement) | [default to undefined]
-**valeur_pdf** | **string** |  | [optional] [default to undefined]
-**valeur_xml** | **string** |  | [optional] [default to undefined]
-**statut** | [**StatutChampAPI**](StatutChampAPI.md) | Statut de conformité (CONFORME si XML trouvé dans PDF) | [optional] [default to undefined]
-**message** | **string** |  | [optional] [default to undefined]
-**bbox** | [**BoundingBoxSchema**](BoundingBoxSchema.md) |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { NoteObligatoireSchema } from '@factpulse/sdk';
-
-const instance: NoteObligatoireSchema = {
-    code_sujet,
-    label,
-    valeur_pdf,
-    valeur_xml,
-    statut,
-    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/ObtenirIdChorusProRequest.md

@@ -1,25 +0,0 @@
-# ObtenirIdChorusProRequest
-
-Obtenir l\'ID Chorus Pro depuis un SIRET.
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**credentials** | [**ChorusProCredentials**](ChorusProCredentials.md) |  | [optional] [default to undefined]
-**siret** | **string** | SIRET de la structure (14 chiffres) | [default to undefined]
-**type_identifiant** | **string** | Type d\'identifiant (SIRET, SIREN, UE_HORS_FRANCE, etc.) | [optional] [default to 'SIRET']
-
-## Example
-
-```typescript
-import { ObtenirIdChorusProRequest } from '@factpulse/sdk';
-
-const instance: ObtenirIdChorusProRequest = {
-    credentials,
-    siret,
-    type_identifiant,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)