API docs by Redocly

Fred Tax Reporting Api (v1)

Download OpenAPI specification:

Introduction

L'API TaxReporting permet la gestion des déclarations fiscales (TVA, formulaires 3310-CA3, etc.), l'échange EDI avec l'administration fiscale (TDFC, JeDeclare), et la configuration des comptes de taxes par dossier comptable.

Authentication

Voir : Authentification API Inqom

TaxReportingAccount

TaxReportingAccount_GetAccounts

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

Responses

Response samples

Content type
[
  • {
    }
]

TaxReportingAccount_CreateAccount

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
accountId
required
integer <int32>
Request Body schema:
Iban
required
string
Bic
required
string
Name
required
string
BankName
required
string
Description
string

Responses

Request samples

Content type
{
  • "Iban": "string",
  • "Bic": "string",
  • "Name": "string",
  • "BankName": "string",
  • "Description": "string"
}

Response samples

Content type
0
0

TaxReportingAccount_DeleteAccount

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
accountId
required
integer <int32>

Responses

TaxReportingAccount_UpdateIban

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
accountId
required
integer <int32>
Request Body schema:
Iban
required
string

Responses

Request samples

Content type
{
  • "Iban": "string"
}

TaxReportingAccount_UpdateBic

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
accountId
required
integer <int32>
Request Body schema:
Bic
required
string

Responses

Request samples

Content type
{
  • "Bic": "string"
}

TaxReportingAccount_UpdateName

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
accountId
required
integer <int32>
Request Body schema:
Name
required
string

Responses

Request samples

Content type
{
  • "Name": "string"
}

TaxReportingAccount_UpdateDescription

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
accountId
required
integer <int32>
Request Body schema:
Description
required
string

Responses

Request samples

Content type
{
  • "Description": "string"
}

TaxReportingAccountConfigurationVatAccountConfiguration

Récupère les configurations de comptes TVA d'un dossier comptable

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Identifiant du dossier comptable

query Parameters
configurableOnly
boolean
Default: false

Si vrai, ne retourne que les configurations des comptes paramétrables (par défaut : faux, retourne toutes les configurations)

Responses

Response samples

Content type
[
  • {
    }
]

Crée ou met à jour une configuration de compte TVA

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Identifiant du dossier comptable

Request Body schema:
required

Données de la configuration à créer ou mettre à jour

AccountId
required
integer <int32>
SubAccountId
integer <int32>
Exigibility
string
Enum: "Unknown" "OnReceipts" "OnDebits" "Mixed" "NotLiable"
IncludeUnletteredPayments
boolean
VatCategory
string
Enum: "ACHAT_ELEC" "ACHAT_ELEC_CORSE" "ACHAT_HORS_FR" "ACHAT_HORS_FR_CORSE" "ACHATS_FRANCHISE" "ACQUI_INTRACOM" "ACQUI_INTRACOM_CORSE" "AUTRE_OP_IMP" "AUTRE_OP_IMP_CORSE" "AUTRE_OP_IMP_DOM" "AUTRE_OP_IMP_RET_AUT" "AUTRE_OP_NON_IMP" "AUTRE_TVA_A_DEDUIRE" "CESSION_IMMO" "CESSION_IMMO_CORSE" "CESSION_IMMO_DOM" "COEFFICIENT_TAX" "CREDIT_TVA_TRANSF_GROUP" "DED_AUTRES" "AUTOLIQ_SOUS_TRAITANCE_BTP" "AUTOLIQ_PREST_INTRACOM" "AUTOLIQ_ACQUI_INTRACOM" "AUTOLIQ_IMPORTATION" "AUTOLIQ_ACHATS_PREST_283_1" "DED_IMMO" "AUTOLIQ_PREST_INTRACOM_IMMO" "AUTOLIQ_ACQUI_INTRACOM_IMMO" "AUTOLIQ_IMPORTATION_IMMO" "EXPORT_HORS_UE" "IMPORT_AUTOLIQ" "IMPORT_RFS" "IMPORT_RFS_PETR" "LIVRAISON_ELEC_NON_IMP" "LIVRAISON_INTRA_B2B" "LIVR_SOI_MEME" "LIVR_SOI_MEME_CORSE" "OPER_INTERN_AU" "PREST_INTRACOM" "PREST_INTRACOM_CORSE" "PROD_PETR" "REGUL_OPERATION_IMP" "REGUL_OPERATION_NON_IMP" "REGUL_TVA_DED" "REPORT_TVA" "SOMMES_AJOUT" "SOMMES_IMPUT" "SORTIES_REG_SUSP" "SORTIES_REG_SUSP_DOM" "SORTIES_REG_SUSP_CORSE" "TOTAL_A_PAYER_GROUP" "TVA_MONACO" "TVA_REMB_DEMANDE" "VENTES_UE_B2C" "VENTE_NON_ETABLI_FR" "VT_PREST" "VT_PREST_CORSE" "VT_PREST_DOM" "NOT_DECLARABLE"
VatRate
string
Enum: "Unknown" "_20" "_10" "_055" "_085" "_021" "_0175" "_009" "_0105" "_13" "MultipleRates" "_0"
IsSystemGenerated
required
boolean

Responses

Request samples

Content type
{
  • "AccountId": 0,
  • "SubAccountId": 0,
  • "Exigibility": "Unknown",
  • "IncludeUnletteredPayments": true,
  • "VatCategory": "ACHAT_ELEC",
  • "VatRate": "Unknown",
  • "IsSystemGenerated": true
}

Response samples

Content type
{
  • "AccountId": 0,
  • "SubAccountId": 0,
  • "AccountNumber": "string",
  • "AccountLabel": "string",
  • "SystemExigibility": "Unknown",
  • "SystemVatCategory": "ACHAT_ELEC",
  • "SystemVatRate": "Unknown",
  • "UserExigibility": "Unknown",
  • "UserVatCategory": "ACHAT_ELEC",
  • "UserVatRate": "Unknown",
  • "IsUserExigibilityCleared": true,
  • "IsUserVatCategoryCleared": true,
  • "IsUserVatRateCleared": true,
  • "ChartOfAccountExigibility": "Unknown",
  • "ChartOfAccountVatCategory": "ACHAT_ELEC",
  • "ChartOfAccountVatRate": "Unknown",
  • "ExtendedChartOfAccountExigibility": "Unknown",
  • "ExtendedChartOfAccountVatCategory": "ACHAT_ELEC",
  • "ExtendedChartOfAccountVatRate": "Unknown",
  • "IncludeUnletteredPayments": true,
  • "ChartOfAccountIncludeUnletteredPayments": true,
  • "ExtendedChartOfAccountIncludeUnletteredPayments": true,
  • "IsValidatedByUser": true,
  • "IsAutoComputed": true,
  • "IsUserOverridden": true,
  • "RequiresUserValidation": true,
  • "HasChartOfAccountConfiguration": true,
  • "IsChartOfAccountOverridden": true,
  • "HasExtendedChartOfAccountConfiguration": true,
  • "IsExtendedChartOfAccountOverridden": true,
  • "Exigibility": "Unknown",
  • "VatCategory": "ACHAT_ELEC",
  • "VatRate": "Unknown",
  • "IsExigibilitySystemGenerated": true,
  • "IsVatCategorySystemGenerated": true,
  • "IsVatRateSystemGenerated": true
}

Récupère la liste des comptes configurables avec leurs métadonnées d'éditabilité

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Identifiant du dossier comptable

Responses

Response samples

Content type
[
  • {
    }
]

Récupère les métadonnées d'éditabilité d'un compte configurable spécifique

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Identifiant du dossier comptable

accountId
required
integer <int32>

Identifiant du compte

query Parameters
subAccountId
integer <int32>

Identifiant du sous-compte (optionnel)

Responses

Response samples

Content type
{
  • "AccountId": 0,
  • "SubAccountId": 0,
  • "CanEditExigibility": true,
  • "CanEditVatCategory": true,
  • "CanEditVatRate": true,
  • "ExigibilityEditabilityMode": "NotEditable",
  • "VatCategoryEditabilityMode": "NotEditable",
  • "VatRateEditabilityMode": "NotEditable",
  • "CanUseMultipleVatRates": true
}

Récupère une configuration de compte TVA spécifique

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Identifiant du dossier comptable

accountId
required
integer <int32>

Identifiant du compte

query Parameters
subAccountId
integer <int32>

Identifiant du sous-compte (optionnel)

Responses

Response samples

Content type
{
  • "AccountId": 0,
  • "SubAccountId": 0,
  • "AccountNumber": "string",
  • "AccountLabel": "string",
  • "SystemExigibility": "Unknown",
  • "SystemVatCategory": "ACHAT_ELEC",
  • "SystemVatRate": "Unknown",
  • "UserExigibility": "Unknown",
  • "UserVatCategory": "ACHAT_ELEC",
  • "UserVatRate": "Unknown",
  • "IsUserExigibilityCleared": true,
  • "IsUserVatCategoryCleared": true,
  • "IsUserVatRateCleared": true,
  • "ChartOfAccountExigibility": "Unknown",
  • "ChartOfAccountVatCategory": "ACHAT_ELEC",
  • "ChartOfAccountVatRate": "Unknown",
  • "ExtendedChartOfAccountExigibility": "Unknown",
  • "ExtendedChartOfAccountVatCategory": "ACHAT_ELEC",
  • "ExtendedChartOfAccountVatRate": "Unknown",
  • "IncludeUnletteredPayments": true,
  • "ChartOfAccountIncludeUnletteredPayments": true,
  • "ExtendedChartOfAccountIncludeUnletteredPayments": true,
  • "IsValidatedByUser": true,
  • "IsAutoComputed": true,
  • "IsUserOverridden": true,
  • "RequiresUserValidation": true,
  • "HasChartOfAccountConfiguration": true,
  • "IsChartOfAccountOverridden": true,
  • "HasExtendedChartOfAccountConfiguration": true,
  • "IsExtendedChartOfAccountOverridden": true,
  • "Exigibility": "Unknown",
  • "VatCategory": "ACHAT_ELEC",
  • "VatRate": "Unknown",
  • "IsExigibilitySystemGenerated": true,
  • "IsVatCategorySystemGenerated": true,
  • "IsVatRateSystemGenerated": true
}

Supprime une configuration de compte TVA

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Identifiant du dossier comptable

accountId
required
integer <int32>

Identifiant du compte

query Parameters
subAccountId
integer <int32>

Identifiant du sous-compte (optionnel)

Responses

Récupère la table de correspondance CERFA d'un compte (catégories, taux et cellules du formulaire 3310-CA3), par jointure des référentiels embarqués compte→taux→catégorie et catégorie×taux→cellules. Retourne un tableau vide si le compte n'est pas paramétrable pour la TVA, ou s'il est inconnu du dossier.

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Identifiant du dossier comptable

accountId
required
integer <int32>

Identifiant du compte

query Parameters
subAccountId
integer <int32>

Identifiant du sous-compte (optionnel)

rate
string
Enum: "Unknown" "_20" "_10" "_055" "_085" "_021" "_0175" "_009" "_0105" "_13" "MultipleRates" "_0"

Taux de TVA sélectionné dans la modale (optionnel) : si fourni, seules les correspondances que le compte porte à ce taux dans le référentiel compte→taux→catégorie sont servies (les lignes sans ventilation par taux sur le CERFA restent rendues sans taux) ; si absent ou sentinelle (Inconnu, Multi-taux), aucun filtre

Responses

Response samples

Content type
[
  • {
    }
]

Récupère les configurations des comptes tiers

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Identifiant du dossier comptable

Responses

Response samples

Content type
[
  • {
    }
]

Déclenche le calcul d'exigibilité des comptes tiers et récupère les comptes mouvementés pour le paramétrage de la déclaration TVA pré-remplie.

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Identifiant du dossier comptable

query Parameters
procedureId
integer <int32>

Identifiant de la procédure dont les dates de période sont utilisées. Optionnel : si absent (wizard de bienvenue, avant la première déclaration), la fenêtre de calcul des soldes est l'exercice sélectionné via exerciseStartDate/exerciseEndDate, ou à défaut l'exercice comptable en cours.

exerciseStartDate
string <date-time>

Date de début de l'exercice (optionnel, permet de sélectionner un exercice alternatif ; ignoré si procedureId est fourni)

exerciseEndDate
string <date-time>

Date de fin de l'exercice (optionnel, permet de sélectionner un exercice alternatif ; ignoré si procedureId est fourni)

Responses

Response samples

Content type
[
  • {
    }
]

Récupère le mode acompte TVA (TTC / HT) du dossier comptable.

Route distincte de vat-declaration-accounts : le mode est un réglage de dossier, pas une propriété des comptes listés. Les deux écrans de paramétrage appellent déjà plusieurs routes en parallèle et adoptent celle-ci quand ils en ont besoin, sans que le contrat de la liste bouge.

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Identifiant du dossier comptable

Responses

Response samples

Content type
{
  • "Mode": "TaxIncluded",
  • "IsLocked": true,
  • "LastChangedAt": "2019-08-24T14:15:22Z",
  • "LastChangedByUserId": 0
}

Enregistre le mode acompte TVA (TTC / HT) du dossier comptable.

Le mode se change dans les deux sens tant qu'aucune déclaration du dossier n'est transmise. Un changement effectif efface le paramétrage TVA porté par les lignes des comptes d'acompte du dossier : traitement, cadrage et déclaration repartent du nouveau mode.

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Identifiant du dossier comptable

Request Body schema:
required

Mode acompte à enregistrer

Mode
required
string
Enum: "TaxIncluded" "TaxExcluded"

Responses

Request samples

Content type
{
  • "Mode": "TaxIncluded"
}

Response samples

Content type
{
  • "Mode": "TaxIncluded",
  • "IsLocked": true,
  • "LastChangedAt": "2019-08-24T14:15:22Z",
  • "LastChangedByUserId": 0
}

Indique s'il faut poser la question du mode acompte sur la période d'une procédure, et quel mode les écritures suggèrent.

Route distincte de advance-payment-mode : le mode est un réglage de dossier, la recommandation dépend d'une période. La recommandation ne décide jamais.

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Identifiant du dossier comptable

procedureId
required
integer <int32>

Identifiant de la procédure dont la période est analysée

Responses

Response samples

Content type
{
  • "ShouldAsk": true,
  • "RecommendedMode": "TaxIncluded",
  • "IsDetected": true
}

Épingle la catégorie de TVA d'un compte sans toucher au reste de sa configuration (crée la configuration si elle n'existe pas encore)

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Identifiant du dossier comptable

accountId
required
integer <int32>

Identifiant du compte

query Parameters
subAccountId
integer <int32>

Identifiant du sous-compte (optionnel)

Request Body schema:
required

Catégorie de TVA à épingler

VatCategory
required
string
Enum: "ACHAT_ELEC" "ACHAT_ELEC_CORSE" "ACHAT_HORS_FR" "ACHAT_HORS_FR_CORSE" "ACHATS_FRANCHISE" "ACQUI_INTRACOM" "ACQUI_INTRACOM_CORSE" "AUTRE_OP_IMP" "AUTRE_OP_IMP_CORSE" "AUTRE_OP_IMP_DOM" "AUTRE_OP_IMP_RET_AUT" "AUTRE_OP_NON_IMP" "AUTRE_TVA_A_DEDUIRE" "CESSION_IMMO" "CESSION_IMMO_CORSE" "CESSION_IMMO_DOM" "COEFFICIENT_TAX" "CREDIT_TVA_TRANSF_GROUP" "DED_AUTRES" "AUTOLIQ_SOUS_TRAITANCE_BTP" "AUTOLIQ_PREST_INTRACOM" "AUTOLIQ_ACQUI_INTRACOM" "AUTOLIQ_IMPORTATION" "AUTOLIQ_ACHATS_PREST_283_1" "DED_IMMO" "AUTOLIQ_PREST_INTRACOM_IMMO" "AUTOLIQ_ACQUI_INTRACOM_IMMO" "AUTOLIQ_IMPORTATION_IMMO" "EXPORT_HORS_UE" "IMPORT_AUTOLIQ" "IMPORT_RFS" "IMPORT_RFS_PETR" "LIVRAISON_ELEC_NON_IMP" "LIVRAISON_INTRA_B2B" "LIVR_SOI_MEME" "LIVR_SOI_MEME_CORSE" "OPER_INTERN_AU" "PREST_INTRACOM" "PREST_INTRACOM_CORSE" "PROD_PETR" "REGUL_OPERATION_IMP" "REGUL_OPERATION_NON_IMP" "REGUL_TVA_DED" "REPORT_TVA" "SOMMES_AJOUT" "SOMMES_IMPUT" "SORTIES_REG_SUSP" "SORTIES_REG_SUSP_DOM" "SORTIES_REG_SUSP_CORSE" "TOTAL_A_PAYER_GROUP" "TVA_MONACO" "TVA_REMB_DEMANDE" "VENTES_UE_B2C" "VENTE_NON_ETABLI_FR" "VT_PREST" "VT_PREST_CORSE" "VT_PREST_DOM" "NOT_DECLARABLE"

Responses

Request samples

Content type
{
  • "VatCategory": "ACHAT_ELEC"
}

Response samples

Content type
{
  • "AccountId": 0,
  • "SubAccountId": 0,
  • "AccountNumber": "string",
  • "AccountLabel": "string",
  • "SystemExigibility": "Unknown",
  • "SystemVatCategory": "ACHAT_ELEC",
  • "SystemVatRate": "Unknown",
  • "UserExigibility": "Unknown",
  • "UserVatCategory": "ACHAT_ELEC",
  • "UserVatRate": "Unknown",
  • "IsUserExigibilityCleared": true,
  • "IsUserVatCategoryCleared": true,
  • "IsUserVatRateCleared": true,
  • "ChartOfAccountExigibility": "Unknown",
  • "ChartOfAccountVatCategory": "ACHAT_ELEC",
  • "ChartOfAccountVatRate": "Unknown",
  • "ExtendedChartOfAccountExigibility": "Unknown",
  • "ExtendedChartOfAccountVatCategory": "ACHAT_ELEC",
  • "ExtendedChartOfAccountVatRate": "Unknown",
  • "IncludeUnletteredPayments": true,
  • "ChartOfAccountIncludeUnletteredPayments": true,
  • "ExtendedChartOfAccountIncludeUnletteredPayments": true,
  • "IsValidatedByUser": true,
  • "IsAutoComputed": true,
  • "IsUserOverridden": true,
  • "RequiresUserValidation": true,
  • "HasChartOfAccountConfiguration": true,
  • "IsChartOfAccountOverridden": true,
  • "HasExtendedChartOfAccountConfiguration": true,
  • "IsExtendedChartOfAccountOverridden": true,
  • "Exigibility": "Unknown",
  • "VatCategory": "ACHAT_ELEC",
  • "VatRate": "Unknown",
  • "IsExigibilitySystemGenerated": true,
  • "IsVatCategorySystemGenerated": true,
  • "IsVatRateSystemGenerated": true
}

Met à jour en lot plusieurs configurations de comptes TVA

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Identifiant du dossier comptable

Request Body schema:
required

Collection des configurations à mettre à jour

Array
AccountId
required
integer <int32>
SubAccountId
integer <int32>
Exigibility
string
Enum: "Unknown" "OnReceipts" "OnDebits" "Mixed" "NotLiable"
IncludeUnletteredPayments
boolean
VatCategory
string
Enum: "ACHAT_ELEC" "ACHAT_ELEC_CORSE" "ACHAT_HORS_FR" "ACHAT_HORS_FR_CORSE" "ACHATS_FRANCHISE" "ACQUI_INTRACOM" "ACQUI_INTRACOM_CORSE" "AUTRE_OP_IMP" "AUTRE_OP_IMP_CORSE" "AUTRE_OP_IMP_DOM" "AUTRE_OP_IMP_RET_AUT" "AUTRE_OP_NON_IMP" "AUTRE_TVA_A_DEDUIRE" "CESSION_IMMO" "CESSION_IMMO_CORSE" "CESSION_IMMO_DOM" "COEFFICIENT_TAX" "CREDIT_TVA_TRANSF_GROUP" "DED_AUTRES" "AUTOLIQ_SOUS_TRAITANCE_BTP" "AUTOLIQ_PREST_INTRACOM" "AUTOLIQ_ACQUI_INTRACOM" "AUTOLIQ_IMPORTATION" "AUTOLIQ_ACHATS_PREST_283_1" "DED_IMMO" "AUTOLIQ_PREST_INTRACOM_IMMO" "AUTOLIQ_ACQUI_INTRACOM_IMMO" "AUTOLIQ_IMPORTATION_IMMO" "EXPORT_HORS_UE" "IMPORT_AUTOLIQ" "IMPORT_RFS" "IMPORT_RFS_PETR" "LIVRAISON_ELEC_NON_IMP" "LIVRAISON_INTRA_B2B" "LIVR_SOI_MEME" "LIVR_SOI_MEME_CORSE" "OPER_INTERN_AU" "PREST_INTRACOM" "PREST_INTRACOM_CORSE" "PROD_PETR" "REGUL_OPERATION_IMP" "REGUL_OPERATION_NON_IMP" "REGUL_TVA_DED" "REPORT_TVA" "SOMMES_AJOUT" "SOMMES_IMPUT" "SORTIES_REG_SUSP" "SORTIES_REG_SUSP_DOM" "SORTIES_REG_SUSP_CORSE" "TOTAL_A_PAYER_GROUP" "TVA_MONACO" "TVA_REMB_DEMANDE" "VENTES_UE_B2C" "VENTE_NON_ETABLI_FR" "VT_PREST" "VT_PREST_CORSE" "VT_PREST_DOM" "NOT_DECLARABLE"
VatRate
string
Enum: "Unknown" "_20" "_10" "_055" "_085" "_021" "_0175" "_009" "_0105" "_13" "MultipleRates" "_0"
IsSystemGenerated
required
boolean

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
[
  • {
    }
]

Met à jour en lot plusieurs configurations de comptes TVA par numéro de compte

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Identifiant du dossier comptable

Request Body schema:
required

Commande contenant les configurations avec numéros de compte

required
Array of objects (VatAccountConfigurationByAccountNumberItem)
AtDate
string <date-time>

Responses

Request samples

Content type
{
  • "Configurations": [
    ],
  • "AtDate": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "Succeeded": [
    ],
  • "Errors": [
    ]
}

Valide une configuration de compte TVA calculée automatiquement

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Identifiant du dossier comptable

accountId
required
integer <int32>

Identifiant du compte

query Parameters
subAccountId
integer <int32>

Identifiant du sous-compte (optionnel)

Responses

Response samples

Content type
{
  • "AccountId": 0,
  • "SubAccountId": 0,
  • "AccountNumber": "string",
  • "AccountLabel": "string",
  • "SystemExigibility": "Unknown",
  • "SystemVatCategory": "ACHAT_ELEC",
  • "SystemVatRate": "Unknown",
  • "UserExigibility": "Unknown",
  • "UserVatCategory": "ACHAT_ELEC",
  • "UserVatRate": "Unknown",
  • "IsUserExigibilityCleared": true,
  • "IsUserVatCategoryCleared": true,
  • "IsUserVatRateCleared": true,
  • "ChartOfAccountExigibility": "Unknown",
  • "ChartOfAccountVatCategory": "ACHAT_ELEC",
  • "ChartOfAccountVatRate": "Unknown",
  • "ExtendedChartOfAccountExigibility": "Unknown",
  • "ExtendedChartOfAccountVatCategory": "ACHAT_ELEC",
  • "ExtendedChartOfAccountVatRate": "Unknown",
  • "IncludeUnletteredPayments": true,
  • "ChartOfAccountIncludeUnletteredPayments": true,
  • "ExtendedChartOfAccountIncludeUnletteredPayments": true,
  • "IsValidatedByUser": true,
  • "IsAutoComputed": true,
  • "IsUserOverridden": true,
  • "RequiresUserValidation": true,
  • "HasChartOfAccountConfiguration": true,
  • "IsChartOfAccountOverridden": true,
  • "HasExtendedChartOfAccountConfiguration": true,
  • "IsExtendedChartOfAccountOverridden": true,
  • "Exigibility": "Unknown",
  • "VatCategory": "ACHAT_ELEC",
  • "VatRate": "Unknown",
  • "IsExigibilitySystemGenerated": true,
  • "IsVatCategorySystemGenerated": true,
  • "IsVatRateSystemGenerated": true
}

Calcule les valeurs système pour les configurations de comptes TVA d'un dossier comptable

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Identifiant du dossier comptable

Responses

Response samples

Content type
[
  • {
    }
]

Détecte et persiste le taux TVA système pour chaque compte paramétrable du dossier

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Identifiant du dossier comptable

Responses

Response samples

Content type
{
  • "FilledCount": 0,
  • "SkippedCount": 0,
  • "Accounts": [
    ]
}

Récupère les catégories de TVA spécifique pour un compte donné et potentiellement un taux de TVA

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Identifiant du dossier comptable

accountId
required
integer <int32>

Identifiant du compte

query Parameters
vatRate
string
Enum: "Unknown" "_20" "_10" "_055" "_085" "_021" "_0175" "_009" "_0105" "_13" "MultipleRates" "_0"

Taux de TVA

subAccountId
integer <int32>

Identifiant du sous-compte (optionnel)

Responses

Response samples

Content type
[
  • {
    }
]

Récupère en un seul appel les catégories de TVA disponibles pour plusieurs comptes ou sous-comptes

Une entrée par demande, dans l'ordre reçu. Un compte introuvable garde son entrée, sans catégorie, avec Error = "BookAccountNotFound". Au plus 1 000 entrées par appel.

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Identifiant du dossier comptable

Request Body schema:
required

Comptes ou sous-comptes demandés, avec leur taux éventuel

Array
AccountId
required
integer <int32>
SubAccountId
integer <int32>
VatRate
string
Enum: "Unknown" "_20" "_10" "_055" "_085" "_021" "_0175" "_009" "_0105" "_13" "MultipleRates" "_0"

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
[
  • {
    }
]

Récupère les catégories de comptes associées à un taux de TVA spécifique pour un compte donné Deprecated

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Identifiant du dossier comptable

accountId
required
integer <int32>

Identifiant du compte

query Parameters
vatRate
required
string
Enum: "Unknown" "_20" "_10" "_055" "_085" "_021" "_0175" "_009" "_0105" "_13" "MultipleRates" "_0"

Taux de TVA

subAccountId
integer <int32>

Identifiant du sous-compte (optionnel)

Responses

Response samples

Content type
[
  • {
    }
]

Vérifie s'il existe une déclaration pré-configurée brouillon pour le dossier comptable

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Identifiant du dossier comptable

Responses

Response samples

Content type
true

Vérifie si la configuration VAT a changé depuis la création d'une déclaration brouillon

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Identifiant du dossier comptable

procedureId
required
integer <int32>

Identifiant de la procédure

Responses

Response samples

Content type
true

TaxReportingAccountConfigurationVatChartOfAccountConfiguration

Récupère les configurations de comptes TVA d'un plan comptable

Authorizations:
oauth2
path Parameters
chartOfAccountId
required
integer <int32>

Identifiant du plan comptable

Responses

Response samples

Content type
[
  • {
    }
]

Crée ou met à jour une configuration TVA plan comptable

Authorizations:
oauth2
path Parameters
chartOfAccountId
required
integer <int32>

Identifiant du plan comptable

Request Body schema:
required

Données de la configuration à créer ou mettre à jour

AccountId
required
integer <int32>
Exigibility
string
Enum: "Unknown" "OnReceipts" "OnDebits" "Mixed" "NotLiable"
IncludeUnletteredPayments
boolean
VatCategory
string
Enum: "ACHAT_ELEC" "ACHAT_ELEC_CORSE" "ACHAT_HORS_FR" "ACHAT_HORS_FR_CORSE" "ACHATS_FRANCHISE" "ACQUI_INTRACOM" "ACQUI_INTRACOM_CORSE" "AUTRE_OP_IMP" "AUTRE_OP_IMP_CORSE" "AUTRE_OP_IMP_DOM" "AUTRE_OP_IMP_RET_AUT" "AUTRE_OP_NON_IMP" "AUTRE_TVA_A_DEDUIRE" "CESSION_IMMO" "CESSION_IMMO_CORSE" "CESSION_IMMO_DOM" "COEFFICIENT_TAX" "CREDIT_TVA_TRANSF_GROUP" "DED_AUTRES" "AUTOLIQ_SOUS_TRAITANCE_BTP" "AUTOLIQ_PREST_INTRACOM" "AUTOLIQ_ACQUI_INTRACOM" "AUTOLIQ_IMPORTATION" "AUTOLIQ_ACHATS_PREST_283_1" "DED_IMMO" "AUTOLIQ_PREST_INTRACOM_IMMO" "AUTOLIQ_ACQUI_INTRACOM_IMMO" "AUTOLIQ_IMPORTATION_IMMO" "EXPORT_HORS_UE" "IMPORT_AUTOLIQ" "IMPORT_RFS" "IMPORT_RFS_PETR" "LIVRAISON_ELEC_NON_IMP" "LIVRAISON_INTRA_B2B" "LIVR_SOI_MEME" "LIVR_SOI_MEME_CORSE" "OPER_INTERN_AU" "PREST_INTRACOM" "PREST_INTRACOM_CORSE" "PROD_PETR" "REGUL_OPERATION_IMP" "REGUL_OPERATION_NON_IMP" "REGUL_TVA_DED" "REPORT_TVA" "SOMMES_AJOUT" "SOMMES_IMPUT" "SORTIES_REG_SUSP" "SORTIES_REG_SUSP_DOM" "SORTIES_REG_SUSP_CORSE" "TOTAL_A_PAYER_GROUP" "TVA_MONACO" "TVA_REMB_DEMANDE" "VENTES_UE_B2C" "VENTE_NON_ETABLI_FR" "VT_PREST" "VT_PREST_CORSE" "VT_PREST_DOM" "NOT_DECLARABLE"
VatRate
string
Enum: "Unknown" "_20" "_10" "_055" "_085" "_021" "_0175" "_009" "_0105" "_13" "MultipleRates" "_0"
IsSystemGenerated
required
boolean

Responses

Request samples

Content type
{
  • "AccountId": 0,
  • "Exigibility": "Unknown",
  • "IncludeUnletteredPayments": true,
  • "VatCategory": "ACHAT_ELEC",
  • "VatRate": "Unknown",
  • "IsSystemGenerated": true
}

Response samples

Content type
{
  • "ChartOfAccountId": 0,
  • "AccountId": 0,
  • "Exigibility": "Unknown",
  • "VatCategory": "ACHAT_ELEC",
  • "VatRate": "Unknown",
  • "IncludeUnletteredPayments": true
}

Récupère une configuration TVA spécifique d'un plan comptable

Authorizations:
oauth2
path Parameters
chartOfAccountId
required
integer <int32>

Identifiant du plan comptable

accountId
required
integer <int32>

Identifiant du compte

Responses

Response samples

Content type
{
  • "ChartOfAccountId": 0,
  • "AccountId": 0,
  • "Exigibility": "Unknown",
  • "VatCategory": "ACHAT_ELEC",
  • "VatRate": "Unknown",
  • "IncludeUnletteredPayments": true
}

Supprime une configuration TVA plan comptable

Authorizations:
oauth2
path Parameters
chartOfAccountId
required
integer <int32>

Identifiant du plan comptable

accountId
required
integer <int32>

Identifiant du compte

query Parameters
subAccountId
integer <int32>

Identifiant du sous-compte (optionnel)

Responses

Met à jour en lot plusieurs configurations TVA plan comptable

Authorizations:
oauth2
path Parameters
chartOfAccountId
required
integer <int32>

Identifiant du plan comptable

Request Body schema:
required

Collection des configurations à mettre à jour

Array
AccountId
required
integer <int32>
Exigibility
string
Enum: "Unknown" "OnReceipts" "OnDebits" "Mixed" "NotLiable"
IncludeUnletteredPayments
boolean
VatCategory
string
Enum: "ACHAT_ELEC" "ACHAT_ELEC_CORSE" "ACHAT_HORS_FR" "ACHAT_HORS_FR_CORSE" "ACHATS_FRANCHISE" "ACQUI_INTRACOM" "ACQUI_INTRACOM_CORSE" "AUTRE_OP_IMP" "AUTRE_OP_IMP_CORSE" "AUTRE_OP_IMP_DOM" "AUTRE_OP_IMP_RET_AUT" "AUTRE_OP_NON_IMP" "AUTRE_TVA_A_DEDUIRE" "CESSION_IMMO" "CESSION_IMMO_CORSE" "CESSION_IMMO_DOM" "COEFFICIENT_TAX" "CREDIT_TVA_TRANSF_GROUP" "DED_AUTRES" "AUTOLIQ_SOUS_TRAITANCE_BTP" "AUTOLIQ_PREST_INTRACOM" "AUTOLIQ_ACQUI_INTRACOM" "AUTOLIQ_IMPORTATION" "AUTOLIQ_ACHATS_PREST_283_1" "DED_IMMO" "AUTOLIQ_PREST_INTRACOM_IMMO" "AUTOLIQ_ACQUI_INTRACOM_IMMO" "AUTOLIQ_IMPORTATION_IMMO" "EXPORT_HORS_UE" "IMPORT_AUTOLIQ" "IMPORT_RFS" "IMPORT_RFS_PETR" "LIVRAISON_ELEC_NON_IMP" "LIVRAISON_INTRA_B2B" "LIVR_SOI_MEME" "LIVR_SOI_MEME_CORSE" "OPER_INTERN_AU" "PREST_INTRACOM" "PREST_INTRACOM_CORSE" "PROD_PETR" "REGUL_OPERATION_IMP" "REGUL_OPERATION_NON_IMP" "REGUL_TVA_DED" "REPORT_TVA" "SOMMES_AJOUT" "SOMMES_IMPUT" "SORTIES_REG_SUSP" "SORTIES_REG_SUSP_DOM" "SORTIES_REG_SUSP_CORSE" "TOTAL_A_PAYER_GROUP" "TVA_MONACO" "TVA_REMB_DEMANDE" "VENTES_UE_B2C" "VENTE_NON_ETABLI_FR" "VT_PREST" "VT_PREST_CORSE" "VT_PREST_DOM" "NOT_DECLARABLE"
VatRate
string
Enum: "Unknown" "_20" "_10" "_055" "_085" "_021" "_0175" "_009" "_0105" "_13" "MultipleRates" "_0"
IsSystemGenerated
required
boolean

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
[
  • {
    }
]

TaxReportingAccountConfigurationVatEntryLineConfiguration

Récupère toutes les configurations de lignes d'écritures pour un dossier

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Responses

Response samples

Content type
[
  • {
    }
]

Crée ou met à jour une configuration de ligne d'écriture

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
Request Body schema:
required
EntryId
required
integer <int32>
EntryLineId
required
integer <int64>
AccountId
required
integer <int32>
SubAccountId
integer <int32>
VatRate
string
Enum: "Unknown" "_20" "_10" "_055" "_085" "_021" "_0175" "_009" "_0105" "_13" "MultipleRates" "_0"
VatCategory
string
Enum: "ACHAT_ELEC" "ACHAT_ELEC_CORSE" "ACHAT_HORS_FR" "ACHAT_HORS_FR_CORSE" "ACHATS_FRANCHISE" "ACQUI_INTRACOM" "ACQUI_INTRACOM_CORSE" "AUTRE_OP_IMP" "AUTRE_OP_IMP_CORSE" "AUTRE_OP_IMP_DOM" "AUTRE_OP_IMP_RET_AUT" "AUTRE_OP_NON_IMP" "AUTRE_TVA_A_DEDUIRE" "CESSION_IMMO" "CESSION_IMMO_CORSE" "CESSION_IMMO_DOM" "COEFFICIENT_TAX" "CREDIT_TVA_TRANSF_GROUP" "DED_AUTRES" "AUTOLIQ_SOUS_TRAITANCE_BTP" "AUTOLIQ_PREST_INTRACOM" "AUTOLIQ_ACQUI_INTRACOM" "AUTOLIQ_IMPORTATION" "AUTOLIQ_ACHATS_PREST_283_1" "DED_IMMO" "AUTOLIQ_PREST_INTRACOM_IMMO" "AUTOLIQ_ACQUI_INTRACOM_IMMO" "AUTOLIQ_IMPORTATION_IMMO" "EXPORT_HORS_UE" "IMPORT_AUTOLIQ" "IMPORT_RFS" "IMPORT_RFS_PETR" "LIVRAISON_ELEC_NON_IMP" "LIVRAISON_INTRA_B2B" "LIVR_SOI_MEME" "LIVR_SOI_MEME_CORSE" "OPER_INTERN_AU" "PREST_INTRACOM" "PREST_INTRACOM_CORSE" "PROD_PETR" "REGUL_OPERATION_IMP" "REGUL_OPERATION_NON_IMP" "REGUL_TVA_DED" "REPORT_TVA" "SOMMES_AJOUT" "SOMMES_IMPUT" "SORTIES_REG_SUSP" "SORTIES_REG_SUSP_DOM" "SORTIES_REG_SUSP_CORSE" "TOTAL_A_PAYER_GROUP" "TVA_MONACO" "TVA_REMB_DEMANDE" "VENTES_UE_B2C" "VENTE_NON_ETABLI_FR" "VT_PREST" "VT_PREST_CORSE" "VT_PREST_DOM" "NOT_DECLARABLE"
Exigibility
string
Enum: "Unknown" "OnReceipts" "OnDebits" "Mixed" "NotLiable"
TaxExcludedAmount
number <double>
TaxExcludedRemainingAmount
number <double>
VatAmountToDeclare
number <double>
Source
required
string
Enum: "Manual" "FecImport" "Automatic" "Inherited"
CustomVatRate
number <double>

Responses

Request samples

Content type
{
  • "EntryId": 0,
  • "EntryLineId": 0,
  • "AccountId": 0,
  • "SubAccountId": 0,
  • "VatRate": "Unknown",
  • "VatCategory": "ACHAT_ELEC",
  • "Exigibility": "Unknown",
  • "TaxExcludedAmount": 0.1,
  • "TaxExcludedRemainingAmount": 0.1,
  • "VatAmountToDeclare": 0.1,
  • "Source": "Manual",
  • "CustomVatRate": 0.1
}

Response samples

Content type
{
  • "EntryId": 0,
  • "EntryLineId": 0,
  • "AccountId": 0,
  • "SubAccountId": 0,
  • "VatRate": "Unknown",
  • "VatCategory": "ACHAT_ELEC",
  • "Exigibility": "Unknown",
  • "Source": "Manual",
  • "TaxExcludedAmount": 0.1,
  • "TaxExcludedRemainingAmount": 0.1,
  • "VatAmountToDeclare": 0.1,
  • "Status": "Draft",
  • "CustomVatRate": 0.1
}

Récupère les configurations pour une liste d'écritures

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
query Parameters
entryIds
required
Array of integers <int32> [ items <int32 > ]

Responses

Response samples

Content type
[
  • {
    }
]

Complète la catégorie de flux TVA d'une configuration de ligne existante, sans toucher au reste de la configuration (taux, montants). Geste de correction des anomalies « catégorie à renseigner » remontées par la validation pré-CERFA.

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
entryId
required
integer <int32>
entryLineId
required
integer <int64>
Request Body schema:
required
VatCategory
required
string
Enum: "ACHAT_ELEC" "ACHAT_ELEC_CORSE" "ACHAT_HORS_FR" "ACHAT_HORS_FR_CORSE" "ACHATS_FRANCHISE" "ACQUI_INTRACOM" "ACQUI_INTRACOM_CORSE" "AUTRE_OP_IMP" "AUTRE_OP_IMP_CORSE" "AUTRE_OP_IMP_DOM" "AUTRE_OP_IMP_RET_AUT" "AUTRE_OP_NON_IMP" "AUTRE_TVA_A_DEDUIRE" "CESSION_IMMO" "CESSION_IMMO_CORSE" "CESSION_IMMO_DOM" "COEFFICIENT_TAX" "CREDIT_TVA_TRANSF_GROUP" "DED_AUTRES" "AUTOLIQ_SOUS_TRAITANCE_BTP" "AUTOLIQ_PREST_INTRACOM" "AUTOLIQ_ACQUI_INTRACOM" "AUTOLIQ_IMPORTATION" "AUTOLIQ_ACHATS_PREST_283_1" "DED_IMMO" "AUTOLIQ_PREST_INTRACOM_IMMO" "AUTOLIQ_ACQUI_INTRACOM_IMMO" "AUTOLIQ_IMPORTATION_IMMO" "EXPORT_HORS_UE" "IMPORT_AUTOLIQ" "IMPORT_RFS" "IMPORT_RFS_PETR" "LIVRAISON_ELEC_NON_IMP" "LIVRAISON_INTRA_B2B" "LIVR_SOI_MEME" "LIVR_SOI_MEME_CORSE" "OPER_INTERN_AU" "PREST_INTRACOM" "PREST_INTRACOM_CORSE" "PROD_PETR" "REGUL_OPERATION_IMP" "REGUL_OPERATION_NON_IMP" "REGUL_TVA_DED" "REPORT_TVA" "SOMMES_AJOUT" "SOMMES_IMPUT" "SORTIES_REG_SUSP" "SORTIES_REG_SUSP_DOM" "SORTIES_REG_SUSP_CORSE" "TOTAL_A_PAYER_GROUP" "TVA_MONACO" "TVA_REMB_DEMANDE" "VENTES_UE_B2C" "VENTE_NON_ETABLI_FR" "VT_PREST" "VT_PREST_CORSE" "VT_PREST_DOM" "NOT_DECLARABLE"

Responses

Request samples

Content type
{
  • "VatCategory": "ACHAT_ELEC"
}

Response samples

Content type
{
  • "EntryId": 0,
  • "EntryLineId": 0,
  • "AccountId": 0,
  • "SubAccountId": 0,
  • "VatRate": "Unknown",
  • "VatCategory": "ACHAT_ELEC",
  • "Exigibility": "Unknown",
  • "Source": "Manual",
  • "TaxExcludedAmount": 0.1,
  • "TaxExcludedRemainingAmount": 0.1,
  • "VatAmountToDeclare": 0.1,
  • "Status": "Draft",
  • "CustomVatRate": 0.1
}

Import en masse

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
Request Body schema:
required
required
Array of objects (VatEntryLineConfigurationDto)

Responses

Request samples

Content type
{
  • "Configurations": [
    ]
}

Response samples

Content type
{
  • "TotalImported": 0,
  • "TotalUpdated": 0,
  • "TotalErrors": 0,
  • "Errors": [
    ]
}

Déclenche le nettoyage asynchrone des configurations de lignes d'écriture obsolètes (sans procédure)

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Responses

Supprime une configuration de ligne d'écriture

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
entryId
required
integer <int32>
entryLineId
required
integer <int64>

Responses

TaxReportingAccountConfigurationVatExtendedChartOfAccountConfiguration

Récupère les configurations de comptes TVA d'un plan comptable étendu

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>

Identifiant du cabinet

extendedChartOfAccountId
required
integer <int32>

Identifiant du plan comptable étendu

Responses

Response samples

Content type
[
  • {
    }
]

Crée ou met à jour une configuration TVA plan comptable étendu

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>

Identifiant du cabinet

extendedChartOfAccountId
required
integer <int32>

Identifiant du plan comptable étendu

Request Body schema:
required

Données de la configuration à créer ou mettre à jour

AccountId
required
integer <int32>
Exigibility
string
Enum: "Unknown" "OnReceipts" "OnDebits" "Mixed" "NotLiable"
IncludeUnletteredPayments
boolean
VatCategory
string
Enum: "ACHAT_ELEC" "ACHAT_ELEC_CORSE" "ACHAT_HORS_FR" "ACHAT_HORS_FR_CORSE" "ACHATS_FRANCHISE" "ACQUI_INTRACOM" "ACQUI_INTRACOM_CORSE" "AUTRE_OP_IMP" "AUTRE_OP_IMP_CORSE" "AUTRE_OP_IMP_DOM" "AUTRE_OP_IMP_RET_AUT" "AUTRE_OP_NON_IMP" "AUTRE_TVA_A_DEDUIRE" "CESSION_IMMO" "CESSION_IMMO_CORSE" "CESSION_IMMO_DOM" "COEFFICIENT_TAX" "CREDIT_TVA_TRANSF_GROUP" "DED_AUTRES" "AUTOLIQ_SOUS_TRAITANCE_BTP" "AUTOLIQ_PREST_INTRACOM" "AUTOLIQ_ACQUI_INTRACOM" "AUTOLIQ_IMPORTATION" "AUTOLIQ_ACHATS_PREST_283_1" "DED_IMMO" "AUTOLIQ_PREST_INTRACOM_IMMO" "AUTOLIQ_ACQUI_INTRACOM_IMMO" "AUTOLIQ_IMPORTATION_IMMO" "EXPORT_HORS_UE" "IMPORT_AUTOLIQ" "IMPORT_RFS" "IMPORT_RFS_PETR" "LIVRAISON_ELEC_NON_IMP" "LIVRAISON_INTRA_B2B" "LIVR_SOI_MEME" "LIVR_SOI_MEME_CORSE" "OPER_INTERN_AU" "PREST_INTRACOM" "PREST_INTRACOM_CORSE" "PROD_PETR" "REGUL_OPERATION_IMP" "REGUL_OPERATION_NON_IMP" "REGUL_TVA_DED" "REPORT_TVA" "SOMMES_AJOUT" "SOMMES_IMPUT" "SORTIES_REG_SUSP" "SORTIES_REG_SUSP_DOM" "SORTIES_REG_SUSP_CORSE" "TOTAL_A_PAYER_GROUP" "TVA_MONACO" "TVA_REMB_DEMANDE" "VENTES_UE_B2C" "VENTE_NON_ETABLI_FR" "VT_PREST" "VT_PREST_CORSE" "VT_PREST_DOM" "NOT_DECLARABLE"
VatRate
string
Enum: "Unknown" "_20" "_10" "_055" "_085" "_021" "_0175" "_009" "_0105" "_13" "MultipleRates" "_0"
IsSystemGenerated
required
boolean

Responses

Request samples

Content type
{
  • "AccountId": 0,
  • "Exigibility": "Unknown",
  • "IncludeUnletteredPayments": true,
  • "VatCategory": "ACHAT_ELEC",
  • "VatRate": "Unknown",
  • "IsSystemGenerated": true
}

Response samples

Content type
{
  • "ExtendedChartOfAccountId": 0,
  • "AccountId": 0,
  • "ExtendedChartOfAccountExigibility": "Unknown",
  • "ExtendedChartOfAccountVatCategory": "ACHAT_ELEC",
  • "ExtendedChartOfAccountVatRate": "Unknown",
  • "ExtendedChartOfAccountIncludeUnletteredPayments": true,
  • "ChartOfAccountExigibility": "Unknown",
  • "ChartOfAccountVatCategory": "ACHAT_ELEC",
  • "ChartOfAccountVatRate": "Unknown",
  • "ChartOfAccountIncludeUnletteredPayments": true,
  • "HasOwnConfiguration": true,
  • "HasChartOfAccountConfiguration": true,
  • "Exigibility": "Unknown",
  • "VatCategory": "ACHAT_ELEC",
  • "VatRate": "Unknown",
  • "IncludeUnletteredPayments": true,
  • "IsExigibilitySystemGenerated": true,
  • "IsVatCategorySystemGenerated": true,
  • "IsVatRateSystemGenerated": true
}

Récupère une configuration TVA spécifique d'un plan comptable étendu

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>

Identifiant du cabinet

extendedChartOfAccountId
required
integer <int32>

Identifiant du plan comptable étendu

accountId
required
integer <int32>

Identifiant du compte

Responses

Response samples

Content type
{
  • "ExtendedChartOfAccountId": 0,
  • "AccountId": 0,
  • "ExtendedChartOfAccountExigibility": "Unknown",
  • "ExtendedChartOfAccountVatCategory": "ACHAT_ELEC",
  • "ExtendedChartOfAccountVatRate": "Unknown",
  • "ExtendedChartOfAccountIncludeUnletteredPayments": true,
  • "ChartOfAccountExigibility": "Unknown",
  • "ChartOfAccountVatCategory": "ACHAT_ELEC",
  • "ChartOfAccountVatRate": "Unknown",
  • "ChartOfAccountIncludeUnletteredPayments": true,
  • "HasOwnConfiguration": true,
  • "HasChartOfAccountConfiguration": true,
  • "Exigibility": "Unknown",
  • "VatCategory": "ACHAT_ELEC",
  • "VatRate": "Unknown",
  • "IncludeUnletteredPayments": true,
  • "IsExigibilitySystemGenerated": true,
  • "IsVatCategorySystemGenerated": true,
  • "IsVatRateSystemGenerated": true
}

Supprime une configuration TVA plan comptable étendu

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>

Identifiant du cabinet

extendedChartOfAccountId
required
integer <int32>

Identifiant du plan comptable étendu

accountId
required
integer <int32>

Identifiant du compte

query Parameters
subAccountId
integer <int32>

Identifiant du sous-compte (optionnel)

Responses

Met à jour en lot plusieurs configurations TVA plan comptable étendu

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>

Identifiant du cabinet

extendedChartOfAccountId
required
integer <int32>

Identifiant du plan comptable étendu

Request Body schema:
required

Collection des configurations à mettre à jour

Array
AccountId
required
integer <int32>
Exigibility
string
Enum: "Unknown" "OnReceipts" "OnDebits" "Mixed" "NotLiable"
IncludeUnletteredPayments
boolean
VatCategory
string
Enum: "ACHAT_ELEC" "ACHAT_ELEC_CORSE" "ACHAT_HORS_FR" "ACHAT_HORS_FR_CORSE" "ACHATS_FRANCHISE" "ACQUI_INTRACOM" "ACQUI_INTRACOM_CORSE" "AUTRE_OP_IMP" "AUTRE_OP_IMP_CORSE" "AUTRE_OP_IMP_DOM" "AUTRE_OP_IMP_RET_AUT" "AUTRE_OP_NON_IMP" "AUTRE_TVA_A_DEDUIRE" "CESSION_IMMO" "CESSION_IMMO_CORSE" "CESSION_IMMO_DOM" "COEFFICIENT_TAX" "CREDIT_TVA_TRANSF_GROUP" "DED_AUTRES" "AUTOLIQ_SOUS_TRAITANCE_BTP" "AUTOLIQ_PREST_INTRACOM" "AUTOLIQ_ACQUI_INTRACOM" "AUTOLIQ_IMPORTATION" "AUTOLIQ_ACHATS_PREST_283_1" "DED_IMMO" "AUTOLIQ_PREST_INTRACOM_IMMO" "AUTOLIQ_ACQUI_INTRACOM_IMMO" "AUTOLIQ_IMPORTATION_IMMO" "EXPORT_HORS_UE" "IMPORT_AUTOLIQ" "IMPORT_RFS" "IMPORT_RFS_PETR" "LIVRAISON_ELEC_NON_IMP" "LIVRAISON_INTRA_B2B" "LIVR_SOI_MEME" "LIVR_SOI_MEME_CORSE" "OPER_INTERN_AU" "PREST_INTRACOM" "PREST_INTRACOM_CORSE" "PROD_PETR" "REGUL_OPERATION_IMP" "REGUL_OPERATION_NON_IMP" "REGUL_TVA_DED" "REPORT_TVA" "SOMMES_AJOUT" "SOMMES_IMPUT" "SORTIES_REG_SUSP" "SORTIES_REG_SUSP_DOM" "SORTIES_REG_SUSP_CORSE" "TOTAL_A_PAYER_GROUP" "TVA_MONACO" "TVA_REMB_DEMANDE" "VENTES_UE_B2C" "VENTE_NON_ETABLI_FR" "VT_PREST" "VT_PREST_CORSE" "VT_PREST_DOM" "NOT_DECLARABLE"
VatRate
string
Enum: "Unknown" "_20" "_10" "_055" "_085" "_021" "_0175" "_009" "_0105" "_13" "MultipleRates" "_0"
IsSystemGenerated
required
boolean

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
[
  • {
    }
]

Récupère la liste des comptes configurables avec leurs métadonnées d'éditabilité

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>

Identifiant du cabinet

extendedChartOfAccountId
required
integer <int32>

Identifiant du plan comptable étendu

Responses

Response samples

Content type
[
  • {
    }
]

Récupère les métadonnées d'éditabilité d'un compte configurable spécifique

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>

Identifiant du cabinet

extendedChartOfAccountId
required
integer <int32>

Identifiant du plan comptable étendu

accountId
required
integer <int32>

Identifiant du compte

Responses

Response samples

Content type
{
  • "AccountId": 0,
  • "SubAccountId": 0,
  • "CanEditExigibility": true,
  • "CanEditVatCategory": true,
  • "CanEditVatRate": true,
  • "ExigibilityEditabilityMode": "NotEditable",
  • "VatCategoryEditabilityMode": "NotEditable",
  • "VatRateEditabilityMode": "NotEditable",
  • "CanUseMultipleVatRates": true
}

Récupère les catégories de TVA spécifique pour un compte donné et potentiellement un taux de TVA

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>

Identifiant du cabinet

extendedChartOfAccountId
required
integer <int32>

Identifiant du plan comptable étendu

accountId
required
integer <int32>

Identifiant du compte

query Parameters
vatRate
string
Enum: "Unknown" "_20" "_10" "_055" "_085" "_021" "_0175" "_009" "_0105" "_13" "MultipleRates" "_0"

Taux de TVA

Responses

Response samples

Content type
[
  • {
    }
]

TaxReportingAccountDeclarationVatAccountDeclaration

Lance la déclaration de TVA d'un dossier comptable par solde de comptes

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Identifiant du dossier comptable

procedureId
required
integer <int32>

Identifiant de la procédure de déclaration

Responses

Response samples

Content type
{
  • "property1": null,
  • "property2": null
}

Récupère une déclaration de TVA par identifiant

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Identifiant du dossier comptable

procedureId
required
integer <int32>

Identifiant de la procedure déclaration de TVA

Responses

Response samples

Content type
{
  • "AccountingFolderId": 0,
  • "ProcedureId": 0,
  • "VatAccountElements": [
    ],
  • "VatAccountsConfigurationUsed": "string",
  • "Issues": [
    ]
}

Force le recalcul d'une déclaration TVA par solde de comptes. Réservé aux procédures en statut Draft. Réinitialise le snapshot de configuration et le contenu CERFA.

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Identifiant du dossier comptable

procedureId
required
integer <int32>

Identifiant de la procédure de déclaration

query Parameters
preserveManualEntries
boolean
Default: false

Si vrai, conserve les saisies manuelles du formulaire au lieu de tout recalculer (par défaut : faux, tout est recalculé). Accepté et sans effet tant que le choix du type de synchro n'est pas branché.

Responses

Response samples

Content type
{
  • "AccountingFolderId": 0,
  • "ProcedureId": 0,
  • "VatAccountElements": [
    ],
  • "VatAccountsConfigurationUsed": "string",
  • "Issues": [
    ]
}

Enregistre le formulaire prérempli comme référence d'un brouillon jamais sauvegardé.

À appeler à chaque affichage tant que le formulaire n'a jamais été sauvegardé. Seule la référence est écrite : le formulaire n'est pas sauvegardé et continue de se recalculer à l'affichage suivant.

Une procédure introuvable dans le dossier rend 404 ; une procédure non préremplie est refusée par NotSupportedProcedureType (400) ; une procédure hors brouillon (ProcedureNotInDraftStatus) et un formulaire déjà sauvegardé (PrefilledFormAlreadySaved) par une erreur fonctionnelle.

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Identifiant du dossier comptable

procedureId
required
integer <int32>

Identifiant de la procédure de déclaration

Request Body schema:
required

Formulaire prérempli

Content
string

Responses

Request samples

Content type
{
  • "Content": "string"
}

Response samples

Content type
{
  • "property1": null,
  • "property2": null
}

Réaligne le cadrage d'un brouillon sur le grand livre.

Régénère le snapshot d'éléments TVA depuis les soldes de comptes et remet le contenu CERFA à zéro, qui se recomposera au prochain enregistrement du formulaire. Le clic de l'utilisateur, après édition d'une écriture depuis le panneau grand livre, est la seule preuve de péremption retenue : aucune fraîcheur n'est stockée en base, aucune écriture n'a lieu sur un GET.

204 hors du périmètre source unifiée (dossier hors pilote ou formulaire hors liste) : rien n'est écrit et rien n'est refusé, le bouton existant aussi sur les dossiers legacy où un refus afficherait une erreur pour un dossier qui fonctionne. 409 sur un CERFA porteur de saisies manuelles, que la remise à zéro effacerait. Un type de procédure non pré-configuré est refusé par NotSupportedProcedureType (nature Errors.BadRequest) et une procédure qui a quitté le statut Draft par l'erreur fonctionnelle ProcedureNotInDraftStatus, la même que le recalcul du CERFA rend pour la même condition : son snapshot est figé, l'OD le relira tel quel au retour d'acceptation de la DGFiP.

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Identifiant du dossier comptable

procedureId
required
integer <int32>

Identifiant de la procédure de déclaration

Responses

Response samples

Content type
{
  • "AccountingFolderId": 0,
  • "ProcedureId": 0,
  • "VatAccountElements": [
    ],
  • "VatAccountsConfigurationUsed": "string",
  • "Issues": [
    ]
}

Valide une déclaration préremplie avant génération du CERFA : combinaisons (taux, catégorie) invalides et catégories de flux TVA à renseigner.

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Identifiant du dossier comptable

procedureId
required
integer <int32>

Identifiant de la procédure

Responses

Response samples

Content type
{
  • "IsValid": true,
  • "MissingCategoryAccounts": [
    ],
  • "MissingCategoryLines": [
    ],
  • "InvalidCombinations": [
    ],
  • "ClampedNegativeBalances": [
    ],
  • "StaleAdjustments": [
    ],
  • "StaleAdjustmentsUnverifiable": true
}

Obtient le contenu d'une déclaration TVA par solde de comptes sous forme de champs de formulaire

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Identifiant du dossier comptable

procedureId
required
integer <int32>

Identifiant de la procédure

Responses

Response samples

Content type
[
  • {
    }
]

Obtient le mapping des comptes par tag pour la génération de tooltips dans le formulaire de récapitulatif TVA

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Identifiant du dossier comptable

procedureId
required
integer <int32>

Identifiant de la procédure

Responses

Response samples

Content type
[
  • {
    }
]

Récupère les écritures caractérisées du grand livre pour l'export des éléments de TVA déclarables par solde de compte. Chaque ligne d'écriture est enrichie avec sa décomposition TVA (catégorie, taux, montants, source).

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Identifiant du dossier comptable

procedureId
required
integer <int32>

Identifiant de la procédure

Responses

Response samples

Content type
{
  • "Metadata": {
    },
  • "Entries": [
    ],
  • "Validation": {
    }
}

Lance le pipeline d'export asynchrone des écritures caractérisées au format XLSX.

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
procedureId
required
integer <int32>

Responses

Response samples

Content type
{
  • "JobId": "b63aeb7e-595c-4f65-82ac-857bbcab263d"
}

Traite le job d'export (endpoint interne appelé par le WebJob).

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
procedureId
required
integer <int32>
jobId
required
string <uuid>

Responses

Response samples

Content type
{
  • "property1": null,
  • "property2": null
}

Retourne le statut du job d'export.

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
procedureId
required
integer <int32>
jobId
required
string <uuid>

Responses

Response samples

Content type
{
  • "JobId": "b63aeb7e-595c-4f65-82ac-857bbcab263d",
  • "Status": "InProgress",
  • "ErrorMessage": "string",
  • "TotalLines": 0,
  • "TotalAccounts": 0,
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "CompletedAt": "2019-08-24T14:15:22Z"
}

Télécharge le fichier XLSX d'un job d'export terminé.

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
procedureId
required
integer <int32>
jobId
required
string <uuid>

Responses

Response samples

Content type
"string"

TaxReportingAdarTax

Obtient le calcul de la taxe ADAR

Authorizations:
oauth2
query Parameters
isGaec
boolean

Indique si le calcul est pour un GAEC

annualRevenue
required
number <decimal>

Chiffre d'affaires hors taxe de l'année précédente

associatesCount
integer <int32>

Nombre d'associés

Responses

Response samples

Content type
{
  • "FixedAmount": 0,
  • "VariableAmount": 0,
  • "TotalAmount": 0
}

Récupère toutes les déclarations de taxe ADAR déjà effectuées pour une entreprise

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Identifiant du dossier comptable

Responses

Response samples

Content type
[
  • {
    }
]

Crée ou met à jour une déclaration de taxe ADAR pour une entreprise. Si une déclaration existe déjà pour l'année donnée, elle est mise à jour.

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Identifiant du dossier comptable

year
required
integer <int32>

Année de déclaration

Request Body schema:
required

Données de la déclaration

IsGaec
required
boolean
AnnualRevenue
required
number <decimal>
AssociatesCount
integer <int32>

Responses

Request samples

Content type
{
  • "IsGaec": true,
  • "AnnualRevenue": 0,
  • "AssociatesCount": 0
}

Response samples

Content type
{
  • "Id": 0,
  • "Year": 0,
  • "IsGaec": true,
  • "AnnualRevenue": 0,
  • "AssociatesCount": 0,
  • "Calculation": {
    }
}

TaxReportingAdminAuditMigration

Analyse les données d'audit nécessitant une migration

Authorizations:
oauth2

Responses

Response samples

Content type
{
  • "AnalysisResult": {
    },
  • "MigrationResult": {
    },
  • "DryRun": true,
  • "CompletedAt": "2019-08-24T14:15:22Z"
}

Effectue la migration réelle des données d'audit avec contrôle du volume et de la concurrence

Cet endpoint retourne un stream de données JSON en temps réel.

Authorizations:
oauth2
Request Body schema:
DryRun
required
boolean

Mode de fonctionnement : true pour simulation, false pour migration réelle

TimeoutMinutes
required
integer <int32>

Timeout en minutes pour l'opération (défaut: 60 minutes)

MaxItemsToMigrate
integer <int32>

Nombre maximum d'éléments à migrer (null = pas de limite, migration complète) Utile pour faire des migrations par petits lots et éviter de traiter toute la base d'un coup

MaxConcurrency
required
integer <int32>

Nombre de threads en parallèle pour la migration (défaut: 8) Permet de contrôler la charge sur Azure Table Storage

Responses

Request samples

Content type
{
  • "DryRun": true,
  • "TimeoutMinutes": 0,
  • "MaxItemsToMigrate": 1000,
  • "MaxConcurrency": 4
}

TaxReportingAdminProcedureAdmin

Admin endpoint: Reverts a procedure status from Sending back to Draft.

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Accounting folder ID

procedureId
required
integer <int32>

Procedure ID to revert

Responses

TaxReportingAllocationVatAllocation

Récupère les données de ventilation TVA pour un dossier comptable Expose la vue "grand livre" enrichie avec le / les taux de TVA et le montant HT restant à déclarer

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Identifiant du dossier comptable

query Parameters
procedureId
required
integer <int32>

Identifiant de la procédure

scope
string
Enum: "Purchases" "Sales"

Périmètre des comptes: Providers (Achats) ou Customers (Ventes)

page
required
integer <int32>
Default: 1

Numéro de page pour la pagination (défaut: 1)

size
required
integer <int32>
Default: 20

Nombre d'éléments par page (défaut: 20)

sortBy
required
string
Default: "Date"
Enum: "None" "Date" "DebitSum" "CreditSum" "AbsoluteAmount" "Label" "Journal" "Letter" "DocRef"

Champ de tri (défaut: Date)

sortDesc
required
boolean
Default: false

Tri descendant si true (défaut: false)

onlyRequiringCompletion
boolean
Default: false

Si true, filtre uniquement les écritures nécessitant une complétion du montant HT restant à déclarer (défaut: false = pas de filtre)

Responses

Response samples

Content type
{
  • "Accounts": [
    ],
  • "TotalCount": 0
}

Récupère les données de ventilation TVA pour un dossier comptable Expose la vue "grand livre" enrichie avec le / les taux de TVA et le montant HT restant à déclarer

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Identifiant du dossier comptable

query Parameters
procedureId
required
integer <int32>

Identifiant de la procédure

scope
string
Enum: "Purchases" "Sales"

Périmètre des comptes: Providers (Achats) ou Customers (Ventes)

page
required
integer <int32>
Default: 1

Numéro de page pour la pagination (défaut: 1)

size
required
integer <int32>
Default: 20

Nombre d'éléments par page (défaut: 20)

sortBy
required
string
Default: "Date"
Enum: "None" "Date" "DebitSum" "CreditSum" "AbsoluteAmount" "Label" "Journal" "Letter" "DocRef"

Champ de tri (défaut: Date)

sortDesc
required
boolean
Default: false

Tri descendant si true (défaut: false)

onlyRequiringCompletion
boolean
Default: false

Si true, filtre uniquement les écritures nécessitant une complétion du montant HT restant à déclarer (défaut: false = pas de filtre)

Request Body schema:

Body object to filter

AmountAbove
number <double>
AmountBelow
number <double>
EntryLineLabel
string
EntryLineLabelStartWith
string
JournalId
integer <int32>
HasAttachedFile
boolean
AccountStartWith
string
object (AccountKey)
Array of objects (AccountSearch)
BalancedAccount
boolean
JournalType
string
WithoutJournalType
string
AmountDirections
string
CreationDate
string <date-time>
DocRef
string
CreatedBefore
string <date-time>
EntrySource
string
FileId
integer <int32>
WithAxisId
integer <int32>
WithoutAxisId
integer <int32>
WithTagId
integer <int32>
WithoutTagId
integer <int32>
AccountIds
Array of integers <int32> [ items <int32 > ]
SubAccountIds
Array of integers <int32> [ items <int32 > ]
LetteringCreatedAfter
string <date-time>
LetteringCreatedBefore
string <date-time>
UnletteredAt
string <date-time>
EntryLineSourceId
string
LetterId
integer <int32>
EntryIds
Array of integers <int32> [ items <int32 > ]

Responses

Request samples

Content type
{
  • "AmountAbove": 0.1,
  • "AmountBelow": 0.1,
  • "EntryLineLabel": "string",
  • "EntryLineLabelStartWith": "string",
  • "JournalId": 0,
  • "HasAttachedFile": true,
  • "AccountStartWith": "string",
  • "AccountKey": {
    },
  • "WithAccounts": [
    ],
  • "BalancedAccount": true,
  • "JournalType": "string",
  • "WithoutJournalType": "string",
  • "AmountDirections": "string",
  • "CreationDate": "2019-08-24T14:15:22Z",
  • "DocRef": "string",
  • "CreatedBefore": "2019-08-24T14:15:22Z",
  • "EntrySource": "string",
  • "FileId": 0,
  • "WithAxisId": 0,
  • "WithoutAxisId": 0,
  • "WithTagId": 0,
  • "WithoutTagId": 0,
  • "AccountIds": [
    ],
  • "SubAccountIds": [
    ],
  • "LetteringCreatedAfter": "2019-08-24T14:15:22Z",
  • "LetteringCreatedBefore": "2019-08-24T14:15:22Z",
  • "UnletteredAt": "2019-08-24T14:15:22Z",
  • "EntryLineSourceId": "string",
  • "LetterId": 0,
  • "EntryIds": [
    ]
}

Response samples

Content type
{
  • "Accounts": [
    ],
  • "TotalCount": 0
}

Récupère les données de ventilation TVA pour la page de récupération de données Applique un filtre spécifique pour les écritures nécessitant une récupération

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Identifiant du dossier comptable

query Parameters
scope
string
Enum: "Purchases" "Sales"

Périmètre des comptes: Providers (Achats) ou Customers (Ventes)

page
required
integer <int32>
Default: 1

Numéro de page pour la pagination (défaut: 1)

size
required
integer <int32>
Default: 20

Nombre d'éléments par page (défaut: 20)

sortBy
required
string
Default: "Date"
Enum: "None" "Date" "DebitSum" "CreditSum" "AbsoluteAmount" "Label" "Journal" "Letter" "DocRef"

Champ de tri (défaut: Date)

sortDesc
required
boolean
Default: false

Tri descendant si true (défaut: false)

Request Body schema:

Body object to filter

AmountAbove
number <double>
AmountBelow
number <double>
EntryLineLabel
string
EntryLineLabelStartWith
string
JournalId
integer <int32>
HasAttachedFile
boolean
AccountStartWith
string
object (AccountKey)
Array of objects (AccountSearch)
BalancedAccount
boolean
JournalType
string
WithoutJournalType
string
AmountDirections
string
CreationDate
string <date-time>
DocRef
string
CreatedBefore
string <date-time>
EntrySource
string
FileId
integer <int32>
WithAxisId
integer <int32>
WithoutAxisId
integer <int32>
WithTagId
integer <int32>
WithoutTagId
integer <int32>
AccountIds
Array of integers <int32> [ items <int32 > ]
SubAccountIds
Array of integers <int32> [ items <int32 > ]
LetteringCreatedAfter
string <date-time>
LetteringCreatedBefore
string <date-time>
UnletteredAt
string <date-time>
EntryLineSourceId
string
LetterId
integer <int32>
EntryIds
Array of integers <int32> [ items <int32 > ]

Responses

Request samples

Content type
{
  • "AmountAbove": 0.1,
  • "AmountBelow": 0.1,
  • "EntryLineLabel": "string",
  • "EntryLineLabelStartWith": "string",
  • "JournalId": 0,
  • "HasAttachedFile": true,
  • "AccountStartWith": "string",
  • "AccountKey": {
    },
  • "WithAccounts": [
    ],
  • "BalancedAccount": true,
  • "JournalType": "string",
  • "WithoutJournalType": "string",
  • "AmountDirections": "string",
  • "CreationDate": "2019-08-24T14:15:22Z",
  • "DocRef": "string",
  • "CreatedBefore": "2019-08-24T14:15:22Z",
  • "EntrySource": "string",
  • "FileId": 0,
  • "WithAxisId": 0,
  • "WithoutAxisId": 0,
  • "WithTagId": 0,
  • "WithoutTagId": 0,
  • "AccountIds": [
    ],
  • "SubAccountIds": [
    ],
  • "LetteringCreatedAfter": "2019-08-24T14:15:22Z",
  • "LetteringCreatedBefore": "2019-08-24T14:15:22Z",
  • "UnletteredAt": "2019-08-24T14:15:22Z",
  • "EntryLineSourceId": "string",
  • "LetterId": 0,
  • "EntryIds": [
    ]
}

Response samples

Content type
{
  • "Accounts": [
    ],
  • "TotalCount": 0
}

Récupère le détail d'une écriture

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Identifiant du dossier comptable

entryId
required
integer <int32>

Identifiant de l'écriture

entryLineId
required
integer <int64>

Identifiant de la ligne d'écriture

Responses

Response samples

Content type
{
  • "Id": 0,
  • "Date": "2019-08-24T14:15:22Z",
  • "JournalId": 0,
  • "ExerciseId": 0,
  • "Label": "string",
  • "DocRef": "string",
  • "UserId": 0,
  • "FileId": 0,
  • "ValidationDate": "2019-08-24T14:15:22Z",
  • "LastUpdateDate": "2019-08-24T14:15:22Z",
  • "Lines": [
    ],
  • "VerificationInfo": {
    }
}

Met à jour le taux de TVA d'une ligne d'écriture dans la ventilation

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Identifiant du dossier comptable

entryId
required
integer <int32>

Identifiant de l'écriture

entryLineId
required
integer <int64>

Identifiant de la ligne d'écriture

Request Body schema:

Commande de mise à jour du taux de TVA

AccountId
required
integer <int32>
SubAccountId
integer <int32>
VatRate
required
string
Enum: "Unknown" "_20" "_10" "_055" "_085" "_021" "_0175" "_009" "_0105" "_13" "MultipleRates" "_0"

Responses

Request samples

Content type
{
  • "AccountId": 0,
  • "SubAccountId": 0,
  • "VatRate": "Unknown"
}

Response samples

Content type
{
  • "Id": 0,
  • "AccountId": 0,
  • "SubAccountId": 0,
  • "EntryId": 0,
  • "Label": "string",
  • "Amount": 0,
  • "ProgressiveBalance": 0.1,
  • "CurrencyId": 0,
  • "Lettering": "string",
  • "IsPartialLettering": true,
  • "MatchedId": 0,
  • "MatchedLetterOrientation": "string",
  • "MatchedDate": "2019-08-24T14:15:22Z",
  • "SourceId": "string",
  • "SourceType": "Unknown",
  • "Revision": "Unrevised",
  • "TaxExcludedAmount": 0.1,
  • "VatAmount": 0.1,
  • "VatRateDistributions": [
    ],
  • "InitialVatRateDistributions": [
    ],
  • "IsAdjustedBySystem": true,
  • "VatAmountToDeclare": 0.1,
  • "IsVatEditable": true,
  • "IsVatRateInherited": true,
  • "IsAlreadyDeclared": true,
  • "CanUndeclare": true,
  • "UniqueVatRate": "Unknown",
  • "TtcRestantAPayer": 0.1,
  • "PriorPeriodTaxExcludedAmount": 0.1,
  • "PriorPeriodVatAmount": 0.1,
  • "IsVatDeclarable": true
}

Met à jour le taux de TVA de plusieurs lignes d'écriture en mode bulk Permet de traiter plusieurs lignes en une seule requête pour des performances optimales

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Identifiant du dossier comptable

Request Body schema:

Commande de mise à jour bulk avec la liste des lignes à modifier

required
Array of objects (VatAllocationEntryLineRateUpdateDto)

Responses

Request samples

Content type
{
  • "Updates": [
    ]
}

Response samples

Content type
[
  • {
    }
]

Met à jour la ventilation multi-taux d'une ligne d'écriture avec le montant de TVA à déclarer Permet de ventiler manuellement une ligne sur plusieurs taux de TVA

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Identifiant du dossier comptable

entryId
required
integer <int32>

Identifiant de l'écriture

entryLineId
required
integer <int64>

Identifiant de la ligne d'écriture

query Parameters
procedureId
integer <int32>

Identifiant de la procedure

Request Body schema:

Commande de mise à jour avec les distributions par taux et le montant de TVA à déclarer

AccountId
required
integer <int32>
SubAccountId
integer <int32>
VatAmountToDeclare
required
number <decimal>
required
Array of objects (VatRateDistributionDto)

Responses

Request samples

Content type
{
  • "AccountId": 0,
  • "SubAccountId": 0,
  • "VatAmountToDeclare": 0,
  • "VatRateDistributions": [
    ]
}

Response samples

Content type
{
  • "Id": 0,
  • "AccountId": 0,
  • "SubAccountId": 0,
  • "EntryId": 0,
  • "Label": "string",
  • "Amount": 0,
  • "ProgressiveBalance": 0.1,
  • "CurrencyId": 0,
  • "Lettering": "string",
  • "IsPartialLettering": true,
  • "MatchedId": 0,
  • "MatchedLetterOrientation": "string",
  • "MatchedDate": "2019-08-24T14:15:22Z",
  • "SourceId": "string",
  • "SourceType": "Unknown",
  • "Revision": "Unrevised",
  • "TaxExcludedAmount": 0.1,
  • "VatAmount": 0.1,
  • "VatRateDistributions": [
    ],
  • "InitialVatRateDistributions": [
    ],
  • "IsAdjustedBySystem": true,
  • "VatAmountToDeclare": 0.1,
  • "IsVatEditable": true,
  • "IsVatRateInherited": true,
  • "IsAlreadyDeclared": true,
  • "CanUndeclare": true,
  • "UniqueVatRate": "Unknown",
  • "TtcRestantAPayer": 0.1,
  • "PriorPeriodTaxExcludedAmount": 0.1,
  • "PriorPeriodVatAmount": 0.1,
  • "IsVatDeclarable": true
}

Calcule automatiquement le montant de TVA en se basant sur les comptes 445xxx de l'écriture

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Identifiant du dossier comptable

entryId
required
integer <int32>

Identifiant de l'écriture

entryLineId
required
integer <int64>

Identifiant de la ligne d'écriture

query Parameters
dryRun
boolean
Default: false

Si true, calcule sans sauvegarder. Défaut: false

Responses

Response samples

Content type
{
  • "IsSuccessful": true,
  • "ErrorMessage": "string",
  • "EntryLine": {
    }
}

Calcule automatiquement la TVA de plusieurs lignes d'écriture en mode bulk. Optimisé pour traiter plusieurs lignes en une seule requête.

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Identifiant du dossier comptable

query Parameters
dryRun
boolean
Default: false

Si true, calcule sans sauvegarder. Défaut: false

Request Body schema:
required

Commande bulk avec la liste des lignes à calculer

required
Array of objects (VatCalculationEntryLineDto)

Responses

Request samples

Content type
{
  • "EntryLines": [
    ]
}

Response samples

Content type
{
  • "Results": [
    ],
  • "TotalProcessed": 0,
  • "SuccessCount": 0,
  • "FailureCount": 0,
  • "IsSuccessful": true
}

Bascule le statut déclaré/non-déclaré d'une ligne d'écriture.

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Identifiant du dossier comptable

entryId
required
integer <int32>

Identifiant de l'écriture

entryLineId
required
integer <int64>

Identifiant de la ligne d'écriture

Request Body schema:

Commande avec le statut cible (shouldDeclare: true/false)

IsDeclared
required
boolean

Responses

Request samples

Content type
{
  • "IsDeclared": true
}

Response samples

Content type
{
  • "Id": 0,
  • "AccountId": 0,
  • "SubAccountId": 0,
  • "EntryId": 0,
  • "Label": "string",
  • "Amount": 0,
  • "ProgressiveBalance": 0.1,
  • "CurrencyId": 0,
  • "Lettering": "string",
  • "IsPartialLettering": true,
  • "MatchedId": 0,
  • "MatchedLetterOrientation": "string",
  • "MatchedDate": "2019-08-24T14:15:22Z",
  • "SourceId": "string",
  • "SourceType": "Unknown",
  • "Revision": "Unrevised",
  • "TaxExcludedAmount": 0.1,
  • "VatAmount": 0.1,
  • "VatRateDistributions": [
    ],
  • "InitialVatRateDistributions": [
    ],
  • "IsAdjustedBySystem": true,
  • "VatAmountToDeclare": 0.1,
  • "IsVatEditable": true,
  • "IsVatRateInherited": true,
  • "IsAlreadyDeclared": true,
  • "CanUndeclare": true,
  • "UniqueVatRate": "Unknown",
  • "TtcRestantAPayer": 0.1,
  • "PriorPeriodTaxExcludedAmount": 0.1,
  • "PriorPeriodVatAmount": 0.1,
  • "IsVatDeclarable": true
}

Active ou désactive la déclaration mensuelle d'une ligne d'écriture TVA (exigibilité encaissement). Toggle ON : crée un snapshot du VatAmountToDeclare par taux. Toggle OFF : supprime toutes les configurations de la ligne.

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Identifiant du dossier comptable

entryId
required
integer <int32>

Identifiant de l'écriture

entryLineId
required
integer <int64>

Identifiant de la ligne d'écriture

query Parameters
procedureId
integer <int32>

Identifiant de la procédure courante (snapshot DEJA_DECLARE)

Request Body schema:

Commande avec le flag shouldDeclare

ShouldDeclare
required
boolean

Responses

Request samples

Content type
{
  • "ShouldDeclare": true
}

Response samples

Content type
{
  • "Id": 0,
  • "AccountId": 0,
  • "SubAccountId": 0,
  • "EntryId": 0,
  • "Label": "string",
  • "Amount": 0,
  • "ProgressiveBalance": 0.1,
  • "CurrencyId": 0,
  • "Lettering": "string",
  • "IsPartialLettering": true,
  • "MatchedId": 0,
  • "MatchedLetterOrientation": "string",
  • "MatchedDate": "2019-08-24T14:15:22Z",
  • "SourceId": "string",
  • "SourceType": "Unknown",
  • "Revision": "Unrevised",
  • "TaxExcludedAmount": 0.1,
  • "VatAmount": 0.1,
  • "VatRateDistributions": [
    ],
  • "InitialVatRateDistributions": [
    ],
  • "IsAdjustedBySystem": true,
  • "VatAmountToDeclare": 0.1,
  • "IsVatEditable": true,
  • "IsVatRateInherited": true,
  • "IsAlreadyDeclared": true,
  • "CanUndeclare": true,
  • "UniqueVatRate": "Unknown",
  • "TtcRestantAPayer": 0.1,
  • "PriorPeriodTaxExcludedAmount": 0.1,
  • "PriorPeriodVatAmount": 0.1,
  • "IsVatDeclarable": true
}

Calcule automatiquement la répartition TVA multi-taux pour toutes les lignes de vente (411x) non configurées. Parcourt l'ensemble des écritures éligibles du grand livre et applique le calcul automatique sur les lignes sans VatEntryLineConfiguration existante.

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Identifiant du dossier comptable

query Parameters
procedureId
required
integer <int32>

Identifiant de la procédure (détermine la période de déclaration)

Responses

Response samples

Content type
{
  • "Results": [
    ],
  • "TotalProcessed": 0,
  • "SuccessCount": 0,
  • "FailureCount": 0,
  • "IsSuccessful": true
}

TaxReportingDeadLineDeadLines

Get all procedure group of enterprise, can be filter by category

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
query Parameters
closingDate
string <date-time>

Responses

Response samples

Content type
{
  • "DeadlineDate": "2019-08-24T14:15:22Z",
  • "TaskName": "string",
  • "CabinetId": 0,
  • "AccountantUserId": 0,
  • "EnterpriseClientId": 0,
  • "AccountingTaskId": 0,
  • "AccountingTask": {
    }
}

TaxReportingDeadLines_Deadlines

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema:
TaxSystemId
integer <int32>
VatSystemId
integer <int32>
VatDeadlineDay
integer <int32>

Responses

Request samples

Content type
{
  • "TaxSystemId": 0,
  • "VatSystemId": 0,
  • "VatDeadlineDay": 0
}

TaxReportingDeadLines_GetTaxesDeadlinesForEnterprises

Authorizations:
oauth2
query Parameters
enterprisesIds
Array of integers <int32> [ items <int32 > ]

Responses

Response samples

Content type
[
  • {
    }
]

TaxReportingDeclarationDeclarationDeadlines

Renvoie la déclaration de référence du dossier avec son échéance DGFiP, celle tirée du dossier permanent et celle du Téléportail, ainsi que le jour d'échéance du dossier permanent

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Identifiant du dossier comptable

query Parameters
procedureId
integer <int32>

Déclaration à renvoyer ; sans elle, la CA3, la CA12 ou la CA12 agricole datée la plus récente

Responses

Response samples

Content type
{
  • "PermanentFileDeadlineDay": 0,
  • "RecommendedPermanentFileDeadlineDay": 0,
  • "Declaration": {
    }
}

TaxReportingDeclarationProcedure

TaxReportingProcedure_ValidateProcedureEntries

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
procedureId
required
integer <int32>

Responses

Response samples

Content type
{
  • "Data": true,
  • "Message": "string",
  • "Type": "Success"
}

Génère l'écriture d'OD de TVA pour la procédure donnée

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
procedureId
required
integer <int32>

Responses

TaxReportingProcedure_CanBeSent

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
procedureId
required
integer <int32>

Responses

Response samples

Content type
{
  • "Data": true,
  • "Message": "string",
  • "Type": "Success"
}

TaxReportingProcedure_MarkStatusAsOutsideOfInqom

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
procedureId
required
integer <int32>

Responses

Lie la déclaration avec les deux cadrages de TVA (par taux et par montant)

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
procedureId
required
integer <int32>
Request Body schema:
required
VatControlByRatesLink
required
string
VatControlByAmountsLink
required
string

Responses

Request samples

Content type
{
  • "VatControlByRatesLink": "string",
  • "VatControlByAmountsLink": "string"
}

Lie la déclaration préremplie avec le cadrage de TVA par solde de compte (gel read-only, US #65703)

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
procedureId
required
integer <int32>
Request Body schema:
required
VatControlByAccountBalanceLink
required
string

Responses

Request samples

Content type
{
  • "VatControlByAccountBalanceLink": "string"
}

TaxReportingProcedure_GetAccountingFoldersWithLastProcedureRejected

Authorizations:
oauth2

Responses

Response samples

Content type
[
  • 0
]

Lance le lettrage de l'OD de TVA pour la procédure donnée

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
procedureId
required
integer <int32>

Responses

Met à jour le contenu d'export PDF de la procédure. La mise à jour est autorisée si la procédure est en Draft OU si le contenu PDF actuel est vide.

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
procedureId
required
integer <int32>
Request Body schema:
required
Header
string
Footer
string
Cover
string
Style
string
HtmlFiles
Array of strings
FileName
string
HeaderFooterEnableOnCover
required
boolean

Responses

Request samples

Content type
{
  • "Header": "string",
  • "Footer": "string",
  • "Cover": "string",
  • "Style": "string",
  • "HtmlFiles": [
    ],
  • "FileName": "string",
  • "HeaderFooterEnableOnCover": true
}

Génère le PDF de la procédure à partir du contenu HTML stocké dans PdfExportContentJson. La génération n'est possible que si un PDF n'a pas déjà été généré (politique de non-régénération).

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
procedureId
required
integer <int32>

Responses

Response samples

Content type
{
  • "PdfDownloadUrl": "string",
  • "FileName": "string"
}

Télécharge le PDF généré pour la procédure.

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
procedureId
required
integer <int32>

Responses

Response samples

Content type
"string"

Duplique une procédure rejetée (manuelle ou préremplie) en une nouvelle procédure manuelle en Draft.

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
procedureId
required
integer <int32>

Responses

Response samples

Content type
0
0

Indique s'il faut proposer la modale d'acompte de congés payés après publication de la déclaration d'origine, et renvoie les montants pré-calculés (acompte ou crédit).

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Identifiant du dossier comptable.

procedureId
required
integer <int32>

Identifiant de la déclaration d'origine (celle qui vient d'être publiée).

Responses

Response samples

Content type
{
  • "ShouldPropose": true,
  • "Kind": "Deposit",
  • "CurrentPaidAmount": 0.1,
  • "DepositAmount": 0.1,
  • "DepositRate": 0.1,
  • "CreditAmount": 0.1
}

Crée une déclaration manuelle d'acompte de congés payés pré-remplie à partir de la déclaration d'origine ({procedureId}). Renvoie l'identifiant de la procédure créée.

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Identifiant du dossier comptable.

procedureId
required
integer <int32>

Identifiant de la déclaration d'origine.

Request Body schema:
required

Montant pré-rempli et texte de correspondance.

Amount
required
number <decimal>
CorrespondenceText
string

Responses

Request samples

Content type
{
  • "Amount": 0,
  • "CorrespondenceText": "string"
}

Response samples

Content type
0
0

TaxReportingProcedure_GetFormsListByProcedureInstance

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
procedureId
required
integer <int32>

Responses

Response samples

Content type
{
  • "Forms": [
    ],
  • "NewerVersionWarning": [
    ]
}

TaxReportingProcedure_GetDeclarationFieldsByProcedureInstance

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
procedureId
required
integer <int32>

Responses

Response samples

Content type
{
  • "Fields": {
    },
  • "NewerVersionWarning": [
    ]
}

TaxReportingDefinition

Create a new form definition

Authorizations:
oauth2
Request Body schema:
Name
required
string
PeriodBeginDate
required
string <date-time>
PeriodEndDate
required
string <date-time>
Content
required
string
Type
required
string
Enum: "Web" "Excel"
DeclaredAmountField
string
PaidAmountField
string
IsDraft
required
boolean
FormCode
string
Enum: "_3310A" "_3310CA3" "_3310TER" "_3310TIC" "_3514" "_3515SD" "_3517AGRSD" "_3517DDR" "_3517SCA12" "_3519" "_3525BIS" "T_IDENTIF"
Millesime
integer <int32>
FormVersion
integer <int32>
FormActivationDate
string <date-time>

Responses

Request samples

Content type
{
  • "Name": "string",
  • "PeriodBeginDate": "2019-08-24T14:15:22Z",
  • "PeriodEndDate": "2019-08-24T14:15:22Z",
  • "Content": "string",
  • "Type": "Web",
  • "DeclaredAmountField": "string",
  • "PaidAmountField": "string",
  • "IsDraft": true,
  • "FormCode": "_3310A",
  • "Millesime": 0,
  • "FormVersion": 0,
  • "FormActivationDate": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "Id": 0,
  • "Name": "string",
  • "PeriodBeginDate": "2019-08-24T14:15:22Z",
  • "PeriodEndDate": "2019-08-24T14:15:22Z",
  • "Content": "string",
  • "Type": "Web",
  • "CreationDate": "2019-08-24T14:15:22Z",
  • "IsDeleted": true,
  • "Expired": true,
  • "DeclaredAmountField": "string",
  • "PaidAmountField": "string",
  • "IsDraft": true,
  • "FormCodeDgfip": "string",
  • "Millesime": 0,
  • "FormVersion": 0
}

Get all form definitions with optional filtering

Authorizations:
oauth2
query Parameters
type
string
Enum: "Web" "Excel"
activeOnly
boolean
beginDate
string <date-time>
endDate
string <date-time>

Responses

Response samples

Content type
[
  • {
    }
]

Get a specific form definition by ID

Authorizations:
oauth2
path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
{
  • "Id": 0,
  • "Name": "string",
  • "PeriodBeginDate": "2019-08-24T14:15:22Z",
  • "PeriodEndDate": "2019-08-24T14:15:22Z",
  • "Content": "string",
  • "Type": "Web",
  • "CreationDate": "2019-08-24T14:15:22Z",
  • "IsDeleted": true,
  • "Expired": true,
  • "DeclaredAmountField": "string",
  • "PaidAmountField": "string",
  • "IsDraft": true,
  • "FormCodeDgfip": "string",
  • "Millesime": 0,
  • "FormVersion": 0
}

Update an existing form definition

Authorizations:
oauth2
path Parameters
id
required
integer <int32>
Request Body schema:
Id
required
integer <int32>
Name
required
string
PeriodBeginDate
required
string <date-time>
PeriodEndDate
required
string <date-time>
Content
required
string
Type
required
string
Enum: "Web" "Excel"
DeclaredAmountField
string
PaidAmountField
string
IsDraft
required
boolean
FormCode
string
Enum: "_3310A" "_3310CA3" "_3310TER" "_3310TIC" "_3514" "_3515SD" "_3517AGRSD" "_3517DDR" "_3517SCA12" "_3519" "_3525BIS" "T_IDENTIF"
Millesime
integer <int32>
FormVersion
integer <int32>
FormActivationDate
string <date-time>

Responses

Request samples

Content type
{
  • "Id": 0,
  • "Name": "string",
  • "PeriodBeginDate": "2019-08-24T14:15:22Z",
  • "PeriodEndDate": "2019-08-24T14:15:22Z",
  • "Content": "string",
  • "Type": "Web",
  • "DeclaredAmountField": "string",
  • "PaidAmountField": "string",
  • "IsDraft": true,
  • "FormCode": "_3310A",
  • "Millesime": 0,
  • "FormVersion": 0,
  • "FormActivationDate": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "Id": 0,
  • "Name": "string",
  • "PeriodBeginDate": "2019-08-24T14:15:22Z",
  • "PeriodEndDate": "2019-08-24T14:15:22Z",
  • "Content": "string",
  • "Type": "Web",
  • "CreationDate": "2019-08-24T14:15:22Z",
  • "IsDeleted": true,
  • "Expired": true,
  • "DeclaredAmountField": "string",
  • "PaidAmountField": "string",
  • "IsDraft": true,
  • "FormCodeDgfip": "string",
  • "Millesime": 0,
  • "FormVersion": 0
}

Delete a form definition

Authorizations:
oauth2
path Parameters
id
required
integer <int32>

Responses

Get forms list by procedure

Authorizations:
oauth2
query Parameters
procedureId
integer <int32>
beginDate
string <date-time>
endDate
string <date-time>

Responses

Response samples

Content type
[
  • {
    }
]

Get declaration fields for forms by procedure (legacy compatibility) or by form ID

Authorizations:
oauth2
query Parameters
procedureId
integer <int32>
beginDate
string <date-time>
endDate
string <date-time>

Responses

Response samples

Content type
{
  • "DeclaredAmountField": "string",
  • "PaidAmountField": "string"
}

Create a new procedure definition

Authorizations:
oauth2
Request Body schema:
Vats
required
integer <int32>
Category
required
string
Value: "TVA"
Nature
required
string
Enum: "Declaration" "Remboursement"
PrincipalForm
required
string
IdentificationForm
required
string
Annexe
required
Array of strings
ActivationDate
required
string <date-time>
ExpirationDate
required
string <date-time>
IsAgricultural
required
boolean
Type
required
string
Enum: "Liquidation" "Refund" "Deposit" "Appendix"
PrincipalFormCode
required
string
Enum: "_3310A" "_3310CA3" "_3310TER" "_3310TIC" "_3514" "_3515SD" "_3517AGRSD" "_3517DDR" "_3517SCA12" "_3519" "_3525BIS" "T_IDENTIF"
IdentificationFormCode
required
string
Enum: "_3310A" "_3310CA3" "_3310TER" "_3310TIC" "_3514" "_3515SD" "_3517AGRSD" "_3517DDR" "_3517SCA12" "_3519" "_3525BIS" "T_IDENTIF"
AnnexeFormCodes
Array of strings
Items Enum: "_3310A" "_3310CA3" "_3310TER" "_3310TIC" "_3514" "_3515SD" "_3517AGRSD" "_3517DDR" "_3517SCA12" "_3519" "_3525BIS" "T_IDENTIF"
StructureActivationDate
string <date-time>

Responses

Request samples

Content type
{
  • "Vats": 0,
  • "Category": "TVA",
  • "Nature": "Declaration",
  • "PrincipalForm": "string",
  • "IdentificationForm": "string",
  • "Annexe": [
    ],
  • "ActivationDate": "2019-08-24T14:15:22Z",
  • "ExpirationDate": "2019-08-24T14:15:22Z",
  • "IsAgricultural": true,
  • "Type": "Liquidation",
  • "PrincipalFormCode": "_3310A",
  • "IdentificationFormCode": "_3310A",
  • "AnnexeFormCodes": [
    ],
  • "StructureActivationDate": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "Id": 0,
  • "Vats": 0,
  • "Category": "TVA",
  • "Nature": "Declaration",
  • "PrincipalForm": "string",
  • "IdentificationForm": "string",
  • "Annexe": [
    ],
  • "ActivationDate": "2019-08-24T14:15:22Z",
  • "ExpirationDate": "2019-08-24T14:15:22Z",
  • "IsAgricultural": true,
  • "Type": "Liquidation",
  • "PrincipalFormCode": "string",
  • "IdentificationFormCode": "string",
  • "AnnexeFormCodes": [
    ]
}

Get filtered procedure definitions

Authorizations:
oauth2
query Parameters
category
string
Value: "TVA"
nature
string
Enum: "Declaration" "Remboursement"
activeOnly
boolean
beginDate
string <date-time>
endDate
string <date-time>
isAgricultural
boolean
vatSystemId
integer <int32>

Responses

Response samples

Content type
[
  • {
    }
]

Get filtered procedure definitions

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
query Parameters
category
string
Value: "TVA"
nature
string
Enum: "Declaration" "Remboursement"
activeOnly
boolean
beginDate
string <date-time>
endDate
string <date-time>
isAgricultural
boolean
vatSystemId
integer <int32>
procedureType
string
Enum: "Manual" "Assisted" "PreConfigured"

Responses

Response samples

Content type
[
  • {
    }
]

Get all procedure definitions

Authorizations:
oauth2

Responses

Response samples

Content type
[
  • {
    }
]

Get a specific procedure definition by ID

Authorizations:
oauth2
path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
{
  • "Id": 0,
  • "Vats": 0,
  • "Category": "TVA",
  • "Nature": "Declaration",
  • "PrincipalForm": "string",
  • "IdentificationForm": "string",
  • "Annexe": [
    ],
  • "ActivationDate": "2019-08-24T14:15:22Z",
  • "ExpirationDate": "2019-08-24T14:15:22Z",
  • "IsAgricultural": true,
  • "Type": "Liquidation",
  • "PrincipalFormCode": "string",
  • "IdentificationFormCode": "string",
  • "AnnexeFormCodes": [
    ]
}

Update an existing procedure definition

Authorizations:
oauth2
path Parameters
id
required
integer <int32>
Request Body schema:
Id
required
integer <int32>
Vats
required
integer <int32>
Category
required
string
Value: "TVA"
Nature
required
string
Enum: "Declaration" "Remboursement"
PrincipalForm
required
string
IdentificationForm
required
string
Annexe
required
Array of strings
ActivationDate
required
string <date-time>
ExpirationDate
required
string <date-time>
IsAgricultural
required
boolean
Type
required
string
Enum: "Liquidation" "Refund" "Deposit" "Appendix"
PrincipalFormCode
required
string
Enum: "_3310A" "_3310CA3" "_3310TER" "_3310TIC" "_3514" "_3515SD" "_3517AGRSD" "_3517DDR" "_3517SCA12" "_3519" "_3525BIS" "T_IDENTIF"
IdentificationFormCode
required
string
Enum: "_3310A" "_3310CA3" "_3310TER" "_3310TIC" "_3514" "_3515SD" "_3517AGRSD" "_3517DDR" "_3517SCA12" "_3519" "_3525BIS" "T_IDENTIF"
AnnexeFormCodes
Array of strings
Items Enum: "_3310A" "_3310CA3" "_3310TER" "_3310TIC" "_3514" "_3515SD" "_3517AGRSD" "_3517DDR" "_3517SCA12" "_3519" "_3525BIS" "T_IDENTIF"
StructureActivationDate
string <date-time>

Responses

Request samples

Content type
{
  • "Id": 0,
  • "Vats": 0,
  • "Category": "TVA",
  • "Nature": "Declaration",
  • "PrincipalForm": "string",
  • "IdentificationForm": "string",
  • "Annexe": [
    ],
  • "ActivationDate": "2019-08-24T14:15:22Z",
  • "ExpirationDate": "2019-08-24T14:15:22Z",
  • "IsAgricultural": true,
  • "Type": "Liquidation",
  • "PrincipalFormCode": "_3310A",
  • "IdentificationFormCode": "_3310A",
  • "AnnexeFormCodes": [
    ],
  • "StructureActivationDate": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "Id": 0,
  • "Vats": 0,
  • "Category": "TVA",
  • "Nature": "Declaration",
  • "PrincipalForm": "string",
  • "IdentificationForm": "string",
  • "Annexe": [
    ],
  • "ActivationDate": "2019-08-24T14:15:22Z",
  • "ExpirationDate": "2019-08-24T14:15:22Z",
  • "IsAgricultural": true,
  • "Type": "Liquidation",
  • "PrincipalFormCode": "string",
  • "IdentificationFormCode": "string",
  • "AnnexeFormCodes": [
    ]
}

Delete a procedure definition

Authorizations:
oauth2
path Parameters
id
required
integer <int32>

Responses

TaxReportingEdiEdiFiles

Récupère le fichier EDI pour un dossier (AccountingFolder/entreprise) et une déclaration donnée.

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Identifiant du dossier fiscal

procedureId
required
integer <int32>

Identifiant de la déclaration (obligatoire)

query Parameters
fileType
string
Default: "Sent"
Enum: "Sent" "Received"

Type de fichier EDI à récupérer (envoyé ou reçu)

Responses

Response samples

Content type
"string"

TaxReportingEdiProcedureGroup

Get all procedure group of enterprise, can be filter by category

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
query Parameters
category
string
Default: "None"
Enum: "None" "Tva" "TvaRefund" "LiasseFiscale" "LiasseIs" "Cvae" "Def" "AcompteCvae" "Tvs" "PaiementSoldeIs" "PaiementAcomptesIs" "AcompteCA12"
beginDate
string <date-time>
endDate
string <date-time>

Responses

Response samples

Content type
[
  • {
    }
]

Create a procedure group

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema:
required
DocumentName
required
string
ProcedureDefinitionId
required
integer <int32>
Category
required
string
Enum: "None" "Tva" "TvaRefund" "LiasseFiscale" "LiasseIs" "Cvae" "Def" "AcompteCvae" "Tvs" "PaiementSoldeIs" "PaiementAcomptesIs" "AcompteCA12"
BeginDate
required
string <date-time>
EndDate
required
string <date-time>
ClosingDate
string <date-time>
DocumentId
string
object (FormSnapshotData)

Responses

Request samples

Content type
{
  • "DocumentName": "string",
  • "ProcedureDefinitionId": 0,
  • "Category": "None",
  • "BeginDate": "2019-08-24T14:15:22Z",
  • "EndDate": "2019-08-24T14:15:22Z",
  • "ClosingDate": "2019-08-24T14:15:22Z",
  • "DocumentId": "string",
  • "FormSnapshot": {
    }
}

Response samples

Content type
{
  • "Id": 0,
  • "EnterpriseId": 0,
  • "Category": "None",
  • "BeginDate": "2019-08-24T14:15:22Z",
  • "EndDate": "2019-08-24T14:15:22Z",
  • "FilingDeadline": "2019-08-24T14:15:22Z",
  • "DepositDeadline": "2019-08-24T14:15:22Z",
  • "DocumentName": "string",
  • "DocumentId": "string",
  • "ProcedureDefinitionId": 0,
  • "ProcedureItems": [
    ],
  • "FormType": "Liquidation",
  • "PeriodType": "Monthly",
  • "DepositNumber": 0,
  • "FormSnapshot": {
    }
}

Get a procedure group by its Identifier

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
procedureGroupId
required
integer <int32>

Responses

Response samples

Content type
{
  • "Id": 0,
  • "EnterpriseId": 0,
  • "Category": "None",
  • "BeginDate": "2019-08-24T14:15:22Z",
  • "EndDate": "2019-08-24T14:15:22Z",
  • "FilingDeadline": "2019-08-24T14:15:22Z",
  • "DepositDeadline": "2019-08-24T14:15:22Z",
  • "DocumentName": "string",
  • "DocumentId": "string",
  • "ProcedureDefinitionId": 0,
  • "ProcedureItems": [
    ],
  • "FormType": "Liquidation",
  • "PeriodType": "Monthly",
  • "DepositNumber": 0,
  • "FormSnapshot": {
    }
}

Create a procedure group for VAT Assistant (simplified creation using ProcedureNature) Automatically resolves DocumentName and ProcedureDefinitionId based on VAT system configuration

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

Accounting folder identifier

Request Body schema:
required

VAT Assistant procedure group creation command

AccountingFolderId
required
integer <int32>
ProcedureType
required
string
Enum: "Liquidation" "Refund" "Deposit" "Appendix"
BeginDate
required
string <date-time>
EndDate
required
string <date-time>
DepositNumber
integer <int32>
FormCode
string
Enum: "_3310A" "_3310CA3" "_3310TER" "_3310TIC" "_3514" "_3515SD" "_3517AGRSD" "_3517DDR" "_3517SCA12" "_3519" "_3525BIS" "T_IDENTIF"

Responses

Request samples

Content type
{
  • "AccountingFolderId": 0,
  • "ProcedureType": "Liquidation",
  • "BeginDate": "2019-08-24T14:15:22Z",
  • "EndDate": "2019-08-24T14:15:22Z",
  • "DepositNumber": 0,
  • "FormCode": "_3310A"
}

Response samples

Content type
{
  • "Id": 0,
  • "EnterpriseId": 0,
  • "Category": "None",
  • "BeginDate": "2019-08-24T14:15:22Z",
  • "EndDate": "2019-08-24T14:15:22Z",
  • "FilingDeadline": "2019-08-24T14:15:22Z",
  • "DepositDeadline": "2019-08-24T14:15:22Z",
  • "DocumentName": "string",
  • "DocumentId": "string",
  • "ProcedureDefinitionId": 0,
  • "ProcedureItems": [
    ],
  • "FormType": "Liquidation",
  • "PeriodType": "Monthly",
  • "DepositNumber": 0,
  • "FormSnapshot": {
    }
}

Delete a procedure group

CHANGEMENT DE CONTRAT : cette route n'emporte plus les procédures du groupe en cascade. Elle refuse désormais (403) tant que le groupe en porte au moins une, et les déclarations doivent être supprimées une à une d'abord — la suppression d'une procédure passant, elle, par le refus de statut et par le nettoyage des corrections de cadrage qu'elle déclenche, que la cascade court-circuitait. Un groupe vidé n'a donc jamais rien déposé.

Le code d'erreur n'est délibérément PAS déclaré en ProducesResponseType : AutoRest whitelisterait le statut et le client généré ne désérialiserait plus que les codes de succès, faisant avaler l'erreur — voir OpenApiDocumentContractTests.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
procedureGroupId
required
integer <int32>

Responses

Get one procedure item by its identifier

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
procedureId
required
integer <int32>

Responses

Response samples

Content type
{
  • "AccountingFolderId": 0,
  • "ProcedureId": 0,
  • "ProcedureGroupId": 0,
  • "Status": {
    },
  • "ExcelExportAvailable": true,
  • "PdfExportAvailable": true,
  • "PdfStatus": "NotConfigured",
  • "PdfDownloadUrl": "string",
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "IsFromTvaAssistant": true,
  • "Type": "Manual",
  • "ByUser": 0,
  • "ReceiveContent": [
    ],
  • "AreEntriesValidated": true,
  • "VatControlAvailable": true,
  • "DeclaredAmount": 0.1,
  • "PaidAmount": 0.1,
  • "SentAt": "2019-08-24T14:15:22Z",
  • "SendingDate": "2019-08-24T14:15:22Z",
  • "FileReceivedId": 0,
  • "FileId": 0,
  • "FileName": "string",
  • "PdfFileName": "string",
  • "RawFormContent": "string",
  • "TestMode": true,
  • "ReceiveSignature": "string",
  • "CanGenerateOd": true,
  • "VatAccountsConfigurationUsed": "string",
  • "SendingChannel": {
    },
  • "VatControlByAccountBalanceLink": "string",
  • "PrefilledRawFormContent": "string",
  • "IsPaidLeaveDeposit": true,
  • "DgfipDeadline": "2019-08-24T14:15:22Z",
  • "DgfipDeadlineDay": 0,
  • "LastSavedAt": "2019-08-24T14:15:22Z",
  • "ReceiveContentInfos": [
    ]
}

Update a procedure Item

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
procedureId
required
integer <int32>
Request Body schema:
Content
string
DeclaredAmount
number <double>
PaidAmount
number <double>
IsFromTvaAssistant
boolean
Type
string
Enum: "Manual" "Assisted" "PreConfigured"
object (PdfExportContent)

Responses

Request samples

Content type
{
  • "Content": "string",
  • "DeclaredAmount": 0.1,
  • "PaidAmount": 0.1,
  • "IsFromTvaAssistant": true,
  • "Type": "Manual",
  • "PdfExportContent": {
    }
}

Response samples

Content type
{
  • "AccountingFolderId": 0,
  • "ProcedureId": 0,
  • "ProcedureGroupId": 0,
  • "Status": {
    },
  • "ExcelExportAvailable": true,
  • "PdfExportAvailable": true,
  • "PdfStatus": "NotConfigured",
  • "PdfDownloadUrl": "string",
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "IsFromTvaAssistant": true,
  • "Type": "Manual",
  • "ByUser": 0,
  • "ReceiveContent": [
    ],
  • "AreEntriesValidated": true,
  • "VatControlAvailable": true,
  • "DeclaredAmount": 0.1,
  • "PaidAmount": 0.1,
  • "SentAt": "2019-08-24T14:15:22Z",
  • "SendingDate": "2019-08-24T14:15:22Z",
  • "FileReceivedId": 0,
  • "FileId": 0,
  • "FileName": "string",
  • "PdfFileName": "string",
  • "RawFormContent": "string",
  • "TestMode": true,
  • "ReceiveSignature": "string",
  • "CanGenerateOd": true,
  • "VatAccountsConfigurationUsed": "string",
  • "SendingChannel": {
    },
  • "VatControlByAccountBalanceLink": "string",
  • "PrefilledRawFormContent": "string",
  • "IsPaidLeaveDeposit": true,
  • "DgfipDeadline": "2019-08-24T14:15:22Z",
  • "DgfipDeadlineDay": 0,
  • "LastSavedAt": "2019-08-24T14:15:22Z",
  • "ReceiveContentInfos": [
    ]
}

Delete a procedure Item

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
procedureId
required
integer <int32>

Responses

Get one procedure item by its filename

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
query Parameters
fileName
string

Responses

Response samples

Content type
{
  • "AccountingFolderId": 0,
  • "ProcedureId": 0,
  • "ProcedureGroupId": 0,
  • "Status": {
    },
  • "ExcelExportAvailable": true,
  • "PdfExportAvailable": true,
  • "PdfStatus": "NotConfigured",
  • "PdfDownloadUrl": "string",
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "IsFromTvaAssistant": true,
  • "Type": "Manual",
  • "ByUser": 0,
  • "ReceiveContent": [
    ],
  • "AreEntriesValidated": true,
  • "VatControlAvailable": true,
  • "DeclaredAmount": 0.1,
  • "PaidAmount": 0.1,
  • "SentAt": "2019-08-24T14:15:22Z",
  • "SendingDate": "2019-08-24T14:15:22Z",
  • "FileReceivedId": 0,
  • "FileId": 0,
  • "FileName": "string",
  • "PdfFileName": "string",
  • "RawFormContent": "string",
  • "TestMode": true,
  • "ReceiveSignature": "string",
  • "CanGenerateOd": true,
  • "VatAccountsConfigurationUsed": "string",
  • "SendingChannel": {
    },
  • "VatControlByAccountBalanceLink": "string",
  • "PrefilledRawFormContent": "string",
  • "IsPaidLeaveDeposit": true,
  • "DgfipDeadline": "2019-08-24T14:15:22Z",
  • "DgfipDeadlineDay": 0,
  • "LastSavedAt": "2019-08-24T14:15:22Z",
  • "ReceiveContentInfos": [
    ]
}

Get the next procedure number for a given year

Authorizations:
oauth2
query Parameters
year
required
integer <int32>

Responses

Response samples

Content type
0
0

Add a new procedure item to a procedure group

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
procedureGroupId
required
integer <int32>
Request Body schema:
Content
string
DeclaredAmount
number <double>
PaidAmount
number <double>
IsFromTvaAssistant
boolean
Type
string
Enum: "Manual" "Assisted" "PreConfigured"
object (PdfExportContent)

Responses

Request samples

Content type
{
  • "Content": "string",
  • "DeclaredAmount": 0.1,
  • "PaidAmount": 0.1,
  • "IsFromTvaAssistant": true,
  • "Type": "Manual",
  • "PdfExportContent": {
    }
}

Response samples

Content type
{
  • "AccountingFolderId": 0,
  • "ProcedureId": 0,
  • "ProcedureGroupId": 0,
  • "Status": {
    },
  • "ExcelExportAvailable": true,
  • "PdfExportAvailable": true,
  • "PdfStatus": "NotConfigured",
  • "PdfDownloadUrl": "string",
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "IsFromTvaAssistant": true,
  • "Type": "Manual",
  • "ByUser": 0,
  • "ReceiveContent": [
    ],
  • "AreEntriesValidated": true,
  • "VatControlAvailable": true,
  • "DeclaredAmount": 0.1,
  • "PaidAmount": 0.1,
  • "SentAt": "2019-08-24T14:15:22Z",
  • "SendingDate": "2019-08-24T14:15:22Z",
  • "FileReceivedId": 0,
  • "FileId": 0,
  • "FileName": "string",
  • "PdfFileName": "string",
  • "RawFormContent": "string",
  • "TestMode": true,
  • "ReceiveSignature": "string",
  • "CanGenerateOd": true,
  • "VatAccountsConfigurationUsed": "string",
  • "SendingChannel": {
    },
  • "VatControlByAccountBalanceLink": "string",
  • "PrefilledRawFormContent": "string",
  • "IsPaidLeaveDeposit": true,
  • "DgfipDeadline": "2019-08-24T14:15:22Z",
  • "DgfipDeadlineDay": 0,
  • "LastSavedAt": "2019-08-24T14:15:22Z",
  • "ReceiveContentInfos": [
    ]
}

Switch from assisted declaration to manual declaration

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
procedureId
required
integer <int32>

Responses

Response samples

Content type
0
0

Update a procedure item after the receive status trigger by the DGFIP

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema:
ProcedureId
required
integer <int32>
Status
required
string
Enum: "Draft" "Sent" "Accepted" "Rejected" "PartialRejected" "Error" "Sending" "SwitchedToManual" "OutsideOfInqom" "RefusedByPartner"
ReceiveSignature
string <= 3072 characters
ReceiveContent
Array of strings
FileReceivedId
integer <int32>
VerdictScope
required
string
Enum: "Declaration" "File"
DgfipDeadline
string <date-time>
DgfipDeadlineDay
integer <int32> [ 1 .. 31 ]
DgfipReceivedAt
string <date-time>
DgfipProcessingNumber
string <= 35 characters

Responses

Request samples

Content type
{
  • "ProcedureId": 0,
  • "Status": "Draft",
  • "ReceiveSignature": "string",
  • "ReceiveContent": [
    ],
  • "FileReceivedId": 0,
  • "VerdictScope": "Declaration",
  • "DgfipDeadline": "2019-08-24T14:15:22Z",
  • "DgfipDeadlineDay": 1,
  • "DgfipReceivedAt": "2019-08-24T14:15:22Z",
  • "DgfipProcessingNumber": "string"
}

Process an EDI response file already stored in blob storage and update the procedure status

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
procedureId
required
integer <int32>
Request Body schema:
EdiResponseBlobUrl
required
string
FileName
required
string
FileReceivedId
integer <int32>

Responses

Request samples

Content type
{
  • "EdiResponseBlobUrl": "string",
  • "FileName": "string",
  • "FileReceivedId": 0
}

Send a procedure to the DGFIP (directly or via JeDelclare)

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
procedureId
required
integer <int32>
query Parameters
activateTestMode
boolean
Default: true
shouldGenerateODAutomaticaly
boolean
Default: true

Responses

Response samples

Content type
{
  • "AccountingFolderId": 0,
  • "ProcedureId": 0,
  • "ProcedureGroupId": 0,
  • "Status": {
    },
  • "ExcelExportAvailable": true,
  • "PdfExportAvailable": true,
  • "PdfStatus": "NotConfigured",
  • "PdfDownloadUrl": "string",
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "IsFromTvaAssistant": true,
  • "Type": "Manual",
  • "ByUser": 0,
  • "ReceiveContent": [
    ],
  • "AreEntriesValidated": true,
  • "VatControlAvailable": true,
  • "DeclaredAmount": 0.1,
  • "PaidAmount": 0.1,
  • "SentAt": "2019-08-24T14:15:22Z",
  • "SendingDate": "2019-08-24T14:15:22Z",
  • "FileReceivedId": 0,
  • "FileId": 0,
  • "FileName": "string",
  • "PdfFileName": "string",
  • "RawFormContent": "string",
  • "TestMode": true,
  • "ReceiveSignature": "string",
  • "CanGenerateOd": true,
  • "VatAccountsConfigurationUsed": "string",
  • "SendingChannel": {
    },
  • "VatControlByAccountBalanceLink": "string",
  • "PrefilledRawFormContent": "string",
  • "IsPaidLeaveDeposit": true,
  • "DgfipDeadline": "2019-08-24T14:15:22Z",
  • "DgfipDeadlineDay": 0,
  • "LastSavedAt": "2019-08-24T14:15:22Z",
  • "ReceiveContentInfos": [
    ]
}

Add the filename to a procedure

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
procedureId
required
integer <int32>
Request Body schema:
required
FileSendId
required
integer <int32>
FileName
required
string

Responses

Request samples

Content type
{
  • "FileSendId": 0,
  • "FileName": "string"
}

Response samples

Content type
{
  • "AccountingFolderId": 0,
  • "ProcedureId": 0,
  • "ProcedureGroupId": 0,
  • "Status": {
    },
  • "ExcelExportAvailable": true,
  • "PdfExportAvailable": true,
  • "PdfStatus": "NotConfigured",
  • "PdfDownloadUrl": "string",
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "IsFromTvaAssistant": true,
  • "Type": "Manual",
  • "ByUser": 0,
  • "ReceiveContent": [
    ],
  • "AreEntriesValidated": true,
  • "VatControlAvailable": true,
  • "DeclaredAmount": 0.1,
  • "PaidAmount": 0.1,
  • "SentAt": "2019-08-24T14:15:22Z",
  • "SendingDate": "2019-08-24T14:15:22Z",
  • "FileReceivedId": 0,
  • "FileId": 0,
  • "FileName": "string",
  • "PdfFileName": "string",
  • "RawFormContent": "string",
  • "TestMode": true,
  • "ReceiveSignature": "string",
  • "CanGenerateOd": true,
  • "VatAccountsConfigurationUsed": "string",
  • "SendingChannel": {
    },
  • "VatControlByAccountBalanceLink": "string",
  • "PrefilledRawFormContent": "string",
  • "IsPaidLeaveDeposit": true,
  • "DgfipDeadline": "2019-08-24T14:15:22Z",
  • "DgfipDeadlineDay": 0,
  • "LastSavedAt": "2019-08-24T14:15:22Z",
  • "ReceiveContentInfos": [
    ]
}

Update a procedure in order to pass its status to sent

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
procedureId
required
integer <int32>
Request Body schema:
required
SentDate
required
string <date-time>

Responses

Request samples

Content type
{
  • "SentDate": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "AccountingFolderId": 0,
  • "ProcedureId": 0,
  • "ProcedureGroupId": 0,
  • "Status": {
    },
  • "ExcelExportAvailable": true,
  • "PdfExportAvailable": true,
  • "PdfStatus": "NotConfigured",
  • "PdfDownloadUrl": "string",
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "IsFromTvaAssistant": true,
  • "Type": "Manual",
  • "ByUser": 0,
  • "ReceiveContent": [
    ],
  • "AreEntriesValidated": true,
  • "VatControlAvailable": true,
  • "DeclaredAmount": 0.1,
  • "PaidAmount": 0.1,
  • "SentAt": "2019-08-24T14:15:22Z",
  • "SendingDate": "2019-08-24T14:15:22Z",
  • "FileReceivedId": 0,
  • "FileId": 0,
  • "FileName": "string",
  • "PdfFileName": "string",
  • "RawFormContent": "string",
  • "TestMode": true,
  • "ReceiveSignature": "string",
  • "CanGenerateOd": true,
  • "VatAccountsConfigurationUsed": "string",
  • "SendingChannel": {
    },
  • "VatControlByAccountBalanceLink": "string",
  • "PrefilledRawFormContent": "string",
  • "IsPaidLeaveDeposit": true,
  • "DgfipDeadline": "2019-08-24T14:15:22Z",
  • "DgfipDeadlineDay": 0,
  • "LastSavedAt": "2019-08-24T14:15:22Z",
  • "ReceiveContentInfos": [
    ]
}

Callback du WebJob d'envoi : enregistre les informations de dépôt JeDéclare (numéro de pièce, code retour) sur la procédure après l'appel SOAP DeposerPieceFiscale.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
procedureId
required
integer <int32>
Request Body schema:
required
NumeroPiece
required
string
CodeRetour
required
string

Responses

Request samples

Content type
{
  • "NumeroPiece": "string",
  • "CodeRetour": "string"
}

TaxReportingProcedureGroup_UpdateDeadlines

Authorizations:
oauth2
Request Body schema:
required
ProcedureGroupIds
Array of integers <int32> [ items <int32 > ]

Responses

Request samples

Content type
{
  • "ProcedureGroupIds": [
    ]
}

Response samples

Content type
[
  • {
    }
]

Vérifie l'existence d'une procédure pour un dossier comptable sur une période donnée et un ou plusieurs types de procédures

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
query Parameters
startDate
required
string <date-time>
endDate
required
string <date-time>
formNames
required
Array of strings

Responses

Response samples

Content type
{
  • "HasDraftProcedures": true,
  • "HasSentProcedures": true,
  • "DraftFormNames": [
    ],
  • "SentFormNames": [
    ],
  • "StartDate": "2019-08-24T14:15:22Z",
  • "EndDate": "2019-08-24T14:15:22Z"
}

Liste paginée des procedure-groups d'une company, pour un consommateur externe. Le périmètre autorisé est résolu serveur-side (Fred.TaxReporting.Domain.Providers.IAuthorizedEnterprisesResolver), jamais fourni par le client. Anti-énumération : company inexistante, hors périmètre ou vide ⇒ 200 + page vide, jamais 403/404.

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>
query Parameters
Category
string
Enum: "None" "Tva" "TvaRefund" "LiasseFiscale" "LiasseIs" "Cvae" "Def" "AcompteCvae" "Tvs" "PaiementSoldeIs" "PaiementAcomptesIs" "AcompteCA12"
BeginDate
string <date-time>
EndDate
string <date-time>
UpdatedAfter
string <date-time>
UpdatedBefore
string <date-time>
Page
integer <int32>
PageSize
integer <int32>

Responses

Response samples

Content type
{
  • "Items": [
    ],
  • "Page": 0,
  • "PageSize": 0,
  • "TotalCount": 0
}

TaxReportingJedeclareJedeclare

NumeroADS des procédures Sent pour le dossier (court-circuit polling WebJob). typeAccuse renseigné = exclusion des déjà-accusés de ce type ; null = rétro-compat.

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
query Parameters
typeAccuse
string
Enum: "Acs" "Ars" "Code98"

Responses

Response samples

Content type
[
  • "string"
]

Traite un avis Jedeclare reçu (idempotence par hash, archivage légal immuable, transition Procedure si applicable).

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Identifiant du dossier comptable propriétaire de l'avis.

Request Body schema:
required

Charge utile de l'avis (NumeroAds, TypeAccuse, codes, RawXml, code applicatif extrait).

NumeroAds
required
string
TypeAccuse
required
string
Enum: "Acs" "Ars" "Code98"
CodeRetour
required
string
Contenu
string
MimeType
string
Enum: "Zip" "Gzip" "Autre"
RawXml
required
string
CodeRejetApplicatif
string
LibelleRejetApplicatif
string

Responses

Request samples

Content type
{
  • "NumeroAds": "string",
  • "TypeAccuse": "Acs",
  • "CodeRetour": "string",
  • "Contenu": "string",
  • "MimeType": "Zip",
  • "RawXml": "string",
  • "CodeRejetApplicatif": "string",
  • "LibelleRejetApplicatif": "string"
}

Response samples

Content type
{
  • "property1": null,
  • "property2": null
}

DEBUG (admin only) : redépose à JeDéclare l'EDI déjà généré d'une procédure, de façon synchrone, en réutilisant le vrai code de dépôt SOAP (`IJedeclareService.DeposeAsync` → `JedeclareClient`). Permet de débugger le dépôt en process API sans passer par le bus + le WebJob d'envoi.

Ne régénère pas l'EDI : la procédure doit avoir été envoyée au moins une fois (le fichier « envoyé » doit exister en blob). Le CodeRetour JeDéclare est renvoyé tel quel, y compris les codes d'erreur, pour inspection. En cas de succès (code 00 + numeroADS présent), persiste JdcNumeroPiece/JdcCodeRetour sur la procédure. À réserver aux environnements de test/recette.

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Identifiant du dossier comptable (= EnterpriseId du SendProcedureMessage).

procedureId
required
integer <int32>

Identifiant de la procédure dont l'EDI envoyé sera redéposé.

Responses

Response samples

Content type
{
  • "CompanyId": 0,
  • "FileName": "string",
  • "CodeRetour": "string",
  • "NumeroADS": "string"
}

DEBUG (admin only) : déclenche un cycle de polling Jedeclare ciblé sur un seul cabinet, équivalent fonctionnel d'un tour de `JedeclareReturnsPollingJob` sans attendre le timer.

Chaque avis remonté est dispatché vers ProcessJedeclareNoticeCommand — archivage légal + transition statut suivent exactement le même chemin que le polling normal. La réponse contient un résumé par item (numero, codeRetour, codeRejetApplicatif, succès du traitement). À réserver aux environnements de test/recette.

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Identifiant du dossier comptable cible.

typeAccuse
required
string
Enum: "Acs" "Ars" "Code98"

Acs ou Ars (Code98 non supporté pour le debug).

Responses

Response samples

Content type
{
  • "AccountingFolderId": 0,
  • "CompanyId": 0,
  • "TypeAccuse": "Acs",
  • "ListeCodeRetour": "string",
  • "ItemsFound": 0,
  • "Items": [
    ]
}

DEBUG (admin only) : régénère à la volée l'EDI d'une procédure via le canal JeDéclare et le renvoie en texte brut pour inspection (vérifier le rendu du générateur, ex. structure du Groupe 1).

Inspection pure : aucun effet de bord (pas de dépôt JeDéclare, pas d'écriture blob, pas de transition statut). L'EDI est régénéré depuis le RawFormContent courant de la procédure (reflète le code de génération actuel), quel que soit le canal d'envoi réel. Le contenu renvoyé comporte des données sensibles (SIREN/SIRET/raison sociale) : non mis en cache, non journalisé. À réserver aux environnements de test/recette.

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Identifiant du dossier comptable (= EnterpriseId de la procédure).

procedureId
required
integer <int32>

Identifiant de la procédure dont l'EDI JeDéclare sera régénéré.

Responses

Response samples

Content type
"string"

TaxReportingTaxEnterprise

TaxReportingEnterprise_SetFiscalInformation

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema:
SubjectToCVAE
required
boolean
CVAEAdvanceDeposit
required
boolean
ISBalance
required
boolean

Responses

Request samples

Content type
{
  • "SubjectToCVAE": true,
  • "CVAEAdvanceDeposit": true,
  • "ISBalance": true
}

TaxReportingEnterprise_GetFiscalInformation

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

Responses

Response samples

Content type
{
  • "SubjectToCVAE": true,
  • "CVAEAdvanceDeposit": true,
  • "ISBalance": true
}

TaxReportingTaxTaxSystem

TaxReportingTaxSystem_GetAll

Authorizations:
oauth2

Responses

Response samples

Content type
[
  • {
    }
]

TaxReportingTaxSystem_Get

Authorizations:
oauth2
path Parameters
taxSystemId
required
integer <int32>

Responses

Response samples

Content type
{
  • "Id": 0,
  • "CountryCodeId": 0,
  • "Code": "string",
  • "SubCode": "string",
  • "Description": "string",
  • "FiscalCategory": "string",
  • "ReelDeclarationType": "None"
}

TaxReportingTvaAssistantVatAssistant

Obtient les paramétrages de compte tiers

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Identifiant du dossier fiscal

query Parameters
endDate
required
string <date-time>

La date de fin de période de la procédure

Responses

Response samples

Content type
[
  • {
    }
]

Met à jour le paramétrage de comptes tiers

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Identifiant du dossier fiscal

Request Body schema:
required

Les comptes tiers à actualiser

Array
AccountId
required
integer <int32>
SubAccountId
integer <int32>
ExigibilityMode
required
string
Enum: "Unknown" "OnReceipts" "OnDebits" "Mixed" "NotLiable"
IncludeUnletteredPayments
boolean

Responses

Request samples

Content type
[
  • {
    }
]

Valide les paramétrages de comptes tiers sans modification

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Identifiant du dossier fiscal

Request Body schema:
required

Les comptes tiers à valider

Array
AccountId
required
integer <int32>
SubAccountId
integer <int32>
ExigibilityMode
required
string
Enum: "Unknown" "OnReceipts" "OnDebits" "Mixed" "NotLiable"
IncludeUnletteredPayments
boolean

Responses

Request samples

Content type
[
  • {
    }
]

Obtient le contenu d'une déclaration

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Identifiant du dossier fiscal

procedureId
required
integer <int32>

L'identifiant de la procédure

Responses

Response samples

Content type
[
  • {
    }
]

Obtient les factures d'achat à déclarer pour une déclaration donnée

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Identifiant du dossier fiscal

procedureId
required
integer <int32>

L'identifiant de la procédure

Responses

Response samples

Content type
[
  • {
    }
]

Obtient les paiements d'achat à déclarer pour une déclaration donnée

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Identifiant du dossier fiscal

procedureId
required
integer <int32>

L'identifiant de la procédure

Responses

Response samples

Content type
[
  • {
    }
]

Obtient les paiements d'achats à déclarer pour une déclaration donnée

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Identifiant du dossier fiscal

procedureId
required
integer <int32>

L'identifiant de la procédure

Responses

Response samples

Content type
{
  • "Entries": [
    ],
  • "Payments": [
    ],
  • "Invoices": [
    ]
}

Obtient les factures de vente à déclarer pour une déclaration donnée

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Identifiant du dossier fiscal

procedureId
required
integer <int32>

L'identifiant de la procédure

Responses

Response samples

Content type
[
  • {
    }
]

Obtient les régularisation de TVA à reverser pour une déclaration donnée

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Identifiant du dossier fiscal

procedureId
required
integer <int32>

L'identifiant de la procédure

Responses

Response samples

Content type
[
  • {
    }
]

Obtient les régularisations de TVA à régulariser pour une déclaration donnée

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Identifiant du dossier fiscal

procedureId
required
integer <int32>

L'identifiant de la procédure

Responses

Response samples

Content type
[
  • {
    }
]

Obtient les régularisations de report de TVA pour une déclaration donnée

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Identifiant du dossier fiscal

procedureId
required
integer <int32>

L'identifiant de la procédure

Responses

Response samples

Content type
{
  • "Amount": 0.1
}

Obtient les paiements de vente à déclarer pour une déclaration donnée Deprecated

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Identifiant du dossier fiscal

procedureId
required
integer <int32>

L'identifiant de la procédure

Responses

Response samples

Content type
[
  • {
    }
]

Obtient les paiements de vente à déclarer pour une déclaration donnée

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Identifiant du dossier fiscal

procedureId
required
integer <int32>

L'identifiant de la procédure

Responses

Response samples

Content type
{
  • "Entries": [
    ],
  • "Payments": [
    ],
  • "Invoices": [
    ]
}

Met à jour les catégorisations de TVA pour une facture

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Identifiant du dossier fiscal

procedureId
required
integer <int32>

L'identifiant de la procédure

Request Body schema:
required

La facture à mettre à jour

EntryId
required
integer <int32>
ToSend
required
boolean
Date
required
string <date-time>
Reference
string
ProcedureDate
string <date-time>
required
object (VatAssistantAccountViewModel)
Label
required
string
FileId
integer <int32>
DeclarationRatio
required
number <decimal>
Journal
required
string
TaxExcludedAmount
required
number <decimal>
TaxIncludedAmount
required
number <decimal>
VatAmount
required
number <decimal>
IsCategorized
required
boolean
required
Array of objects (VatRatedEntryLineViewModel)
required
Array of objects (VatElementCommand)
object (VatRatedEntryLineLetteringViewModel)

Responses

Request samples

Content type
{
  • "EntryId": 0,
  • "ToSend": true,
  • "Date": "2019-08-24T14:15:22Z",
  • "Reference": "string",
  • "ProcedureDate": "2019-08-24T14:15:22Z",
  • "Account": {
    },
  • "Label": "string",
  • "FileId": 0,
  • "DeclarationRatio": 0,
  • "Journal": "string",
  • "TaxExcludedAmount": 0,
  • "TaxIncludedAmount": 0,
  • "VatAmount": 0,
  • "IsCategorized": true,
  • "VatRatedEntryLines": [
    ],
  • "VatElements": [
    ],
  • "Lettering": {
    }
}

Response samples

Content type
{
  • "EntryId": 0,
  • "ToSend": true,
  • "Date": "2019-08-24T14:15:22Z",
  • "Account": {
    },
  • "Label": "string",
  • "FileId": 0,
  • "DeclarationRatio": 0,
  • "Journal": "string",
  • "TaxExcludedAmount": 0,
  • "TaxIncludedAmount": 0,
  • "VatAmount": 0,
  • "IsCategorized": true,
  • "IsIgnored": true,
  • "VatRatedEntryLines": [
    ],
  • "VatElements": [
    ],
  • "Lettering": {
    },
  • "Reference": "string"
}

Met à jour une collection d'éléments de TVA

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Identifiant du dossier fiscal

procedureId
required
integer <int32>

L'identifiant de la procédure

Request Body schema:
required

Les éléments de TVA à mettre à jour

Array
Id
required
integer <int32>
Category
string
Enum: "ACHAT_ELEC" "ACHAT_ELEC_CORSE" "ACHAT_HORS_FR" "ACHAT_HORS_FR_CORSE" "ACHATS_FRANCHISE" "ACQUI_INTRACOM" "ACQUI_INTRACOM_CORSE" "AUTRE_OP_IMP" "AUTRE_OP_IMP_CORSE" "AUTRE_OP_IMP_DOM" "AUTRE_OP_IMP_RET_AUT" "AUTRE_OP_NON_IMP" "AUTRE_TVA_A_DEDUIRE" "CESSION_IMMO" "CESSION_IMMO_CORSE" "CESSION_IMMO_DOM" "COEFFICIENT_TAX" "CREDIT_TVA_TRANSF_GROUP" "DED_AUTRES" "AUTOLIQ_SOUS_TRAITANCE_BTP" "AUTOLIQ_PREST_INTRACOM" "AUTOLIQ_ACQUI_INTRACOM" "AUTOLIQ_IMPORTATION" "AUTOLIQ_ACHATS_PREST_283_1" "DED_IMMO" "AUTOLIQ_PREST_INTRACOM_IMMO" "AUTOLIQ_ACQUI_INTRACOM_IMMO" "AUTOLIQ_IMPORTATION_IMMO" "EXPORT_HORS_UE" "IMPORT_AUTOLIQ" "IMPORT_RFS" "IMPORT_RFS_PETR" "LIVRAISON_ELEC_NON_IMP" "LIVRAISON_INTRA_B2B" "LIVR_SOI_MEME" "LIVR_SOI_MEME_CORSE" "OPER_INTERN_AU" "PREST_INTRACOM" "PREST_INTRACOM_CORSE" "PROD_PETR" "REGUL_OPERATION_IMP" "REGUL_OPERATION_NON_IMP" "REGUL_TVA_DED" "REPORT_TVA" "SOMMES_AJOUT" "SOMMES_IMPUT" "SORTIES_REG_SUSP" "SORTIES_REG_SUSP_DOM" "SORTIES_REG_SUSP_CORSE" "TOTAL_A_PAYER_GROUP" "TVA_MONACO" "TVA_REMB_DEMANDE" "VENTES_UE_B2C" "VENTE_NON_ETABLI_FR" "VT_PREST" "VT_PREST_CORSE" "VT_PREST_DOM" "NOT_DECLARABLE"

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
[
  • {
    }
]

Met à jour une collection d'éléments de TVA (pour les encaissements non lettrés) Deprecated

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Identifiant du dossier fiscal

procedureId
required
integer <int32>

L'identifiant de la procédure

Request Body schema:
required

Les éléments de TVA à mettre à jour

Array
Id
required
integer <int32>
VatRate
required
string
Enum: "Unknown" "_20" "_10" "_055" "_085" "_021" "_0175" "_009" "_0105" "_13" "MultipleRates" "_0"
Category
required
string
Enum: "ACHAT_ELEC" "ACHAT_ELEC_CORSE" "ACHAT_HORS_FR" "ACHAT_HORS_FR_CORSE" "ACHATS_FRANCHISE" "ACQUI_INTRACOM" "ACQUI_INTRACOM_CORSE" "AUTRE_OP_IMP" "AUTRE_OP_IMP_CORSE" "AUTRE_OP_IMP_DOM" "AUTRE_OP_IMP_RET_AUT" "AUTRE_OP_NON_IMP" "AUTRE_TVA_A_DEDUIRE" "CESSION_IMMO" "CESSION_IMMO_CORSE" "CESSION_IMMO_DOM" "COEFFICIENT_TAX" "CREDIT_TVA_TRANSF_GROUP" "DED_AUTRES" "AUTOLIQ_SOUS_TRAITANCE_BTP" "AUTOLIQ_PREST_INTRACOM" "AUTOLIQ_ACQUI_INTRACOM" "AUTOLIQ_IMPORTATION" "AUTOLIQ_ACHATS_PREST_283_1" "DED_IMMO" "AUTOLIQ_PREST_INTRACOM_IMMO" "AUTOLIQ_ACQUI_INTRACOM_IMMO" "AUTOLIQ_IMPORTATION_IMMO" "EXPORT_HORS_UE" "IMPORT_AUTOLIQ" "IMPORT_RFS" "IMPORT_RFS_PETR" "LIVRAISON_ELEC_NON_IMP" "LIVRAISON_INTRA_B2B" "LIVR_SOI_MEME" "LIVR_SOI_MEME_CORSE" "OPER_INTERN_AU" "PREST_INTRACOM" "PREST_INTRACOM_CORSE" "PROD_PETR" "REGUL_OPERATION_IMP" "REGUL_OPERATION_NON_IMP" "REGUL_TVA_DED" "REPORT_TVA" "SOMMES_AJOUT" "SOMMES_IMPUT" "SORTIES_REG_SUSP" "SORTIES_REG_SUSP_DOM" "SORTIES_REG_SUSP_CORSE" "TOTAL_A_PAYER_GROUP" "TVA_MONACO" "TVA_REMB_DEMANDE" "VENTES_UE_B2C" "VENTE_NON_ETABLI_FR" "VT_PREST" "VT_PREST_CORSE" "VT_PREST_DOM" "NOT_DECLARABLE"

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
[
  • {
    }
]

Met à jour le statut "À envoyer" d'une collection de facture

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Identifiant du dossier fiscal

procedureId
required
integer <int32>

L'identifiant de la procédure

Request Body schema:
required

Les écritures à actualiser

EntryIds
required
Array of integers <int32> [ items <int32 > ]
ToSend
required
boolean

Responses

Request samples

Content type
{
  • "EntryIds": [
    ],
  • "ToSend": true
}

Met à jour le statut "À envoyer" et/ou les catégories d'une collection de factures

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Identifiant du dossier fiscal

procedureId
required
integer <int32>

L'identifiant de la procédure

Request Body schema:
required

Les écritures à actualiser

EntryIds
required
Array of integers <int32> [ items <int32 > ]
ToSend
boolean
Category
string
Enum: "ACHAT_ELEC" "ACHAT_ELEC_CORSE" "ACHAT_HORS_FR" "ACHAT_HORS_FR_CORSE" "ACHATS_FRANCHISE" "ACQUI_INTRACOM" "ACQUI_INTRACOM_CORSE" "AUTRE_OP_IMP" "AUTRE_OP_IMP_CORSE" "AUTRE_OP_IMP_DOM" "AUTRE_OP_IMP_RET_AUT" "AUTRE_OP_NON_IMP" "AUTRE_TVA_A_DEDUIRE" "CESSION_IMMO" "CESSION_IMMO_CORSE" "CESSION_IMMO_DOM" "COEFFICIENT_TAX" "CREDIT_TVA_TRANSF_GROUP" "DED_AUTRES" "AUTOLIQ_SOUS_TRAITANCE_BTP" "AUTOLIQ_PREST_INTRACOM" "AUTOLIQ_ACQUI_INTRACOM" "AUTOLIQ_IMPORTATION" "AUTOLIQ_ACHATS_PREST_283_1" "DED_IMMO" "AUTOLIQ_PREST_INTRACOM_IMMO" "AUTOLIQ_ACQUI_INTRACOM_IMMO" "AUTOLIQ_IMPORTATION_IMMO" "EXPORT_HORS_UE" "IMPORT_AUTOLIQ" "IMPORT_RFS" "IMPORT_RFS_PETR" "LIVRAISON_ELEC_NON_IMP" "LIVRAISON_INTRA_B2B" "LIVR_SOI_MEME" "LIVR_SOI_MEME_CORSE" "OPER_INTERN_AU" "PREST_INTRACOM" "PREST_INTRACOM_CORSE" "PROD_PETR" "REGUL_OPERATION_IMP" "REGUL_OPERATION_NON_IMP" "REGUL_TVA_DED" "REPORT_TVA" "SOMMES_AJOUT" "SOMMES_IMPUT" "SORTIES_REG_SUSP" "SORTIES_REG_SUSP_DOM" "SORTIES_REG_SUSP_CORSE" "TOTAL_A_PAYER_GROUP" "TVA_MONACO" "TVA_REMB_DEMANDE" "VENTES_UE_B2C" "VENTE_NON_ETABLI_FR" "VT_PREST" "VT_PREST_CORSE" "VT_PREST_DOM" "NOT_DECLARABLE"

Responses

Request samples

Content type
{
  • "EntryIds": [
    ],
  • "ToSend": true,
  • "Category": "ACHAT_ELEC"
}

Response samples

Content type
[
  • {
    }
]

Met à jour les écritures qui seront ignorées pour une déclaration donnée

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Identifiant du dossier fiscal

procedureId
required
integer <int32>

L'identifiant de la procédure

vatEntryType
required
string
Enum: "Purchase" "Sale" "Regularisation"

Le type d'écriture (i.e. Achat)

Request Body schema:
required

Les identifiants des écritures à ignorer pour la déclaration

Array
integer <int32>

Responses

Request samples

Content type
[
  • 0
]

Exporte les éléments de TVA d'une déclaration

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Identifiant du dossier fiscal

procedureId
required
integer <int32>

L'identifiant de la procédure

Responses

Response samples

Content type
"string"

Obtient l'élément TVA à jour pour un nouveau taux de TVA Deprecated

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Identifiant du dossier fiscal

procedureId
required
integer <int32>

L'identifiant de la procédure

vatElementId
required
integer <int32>
query Parameters
vatRate
required
string
Enum: "Unknown" "_20" "_10" "_055" "_085" "_021" "_0175" "_009" "_0105" "_13" "MultipleRates" "_0"

Responses

Response samples

Content type
{
  • "Id": 0,
  • "EntryLineId": 0,
  • "DeclarationRatio": 0.1,
  • "Type": {
    },
  • "TaxExcludedAmount": 0.1,
  • "VatAmount": 0,
  • "VatRate": {
    },
  • "Category": {
    },
  • "SystemCategory": {
    },
  • "UserCategory": {
    },
  • "Categories": [
    ],
  • "AlreadyDeclared": true,
  • "IsReverse": true,
  • "TaxIncludedAmount": 0.1,
  • "ComputedRate": 0.1
}

Obtient les paiements d'achats et de vente à déclarer pour une déclaration donnée

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Identifiant du dossier fiscal

procedureId
required
integer <int32>

L'identifiant de la procédure

vatEntryType
required
string
Enum: "Purchase" "Sale" "Regularisation"

Défini le type d'éléments attendus

Responses

Response samples

Content type
{
  • "Entries": [
    ],
  • "Payments": [
    ],
  • "Invoices": [
    ]
}

Obtient l'élément TVA à jour pour un nouveau taux de TVA

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Identifiant du dossier fiscal

procedureId
required
integer <int32>

L'identifiant de la procédure

vatElementId
required
integer <int32>
query Parameters
vatRate
required
string
Enum: "Unknown" "_20" "_10" "_055" "_085" "_021" "_0175" "_009" "_0105" "_13" "MultipleRates" "_0"

Responses

Response samples

Content type
{
  • "Id": 0,
  • "EntryLineId": 0,
  • "DeclarationRatio": 0.1,
  • "Type": {
    },
  • "TaxExcludedAmount": 0.1,
  • "VatAmount": 0,
  • "VatRate": {
    },
  • "Category": {
    },
  • "SystemCategory": {
    },
  • "UserCategory": {
    },
  • "Categories": [
    ],
  • "AlreadyDeclared": true,
  • "IsReverse": true,
  • "TaxIncludedAmount": 0.1,
  • "ComputedRate": 0.1
}

Met à jour une collection d'éléments de TVA (pour les paiements non lettrés)

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Identifiant du dossier fiscal

procedureId
required
integer <int32>

L'identifiant de la procédure

Request Body schema:
required

Les éléments de TVA à mettre à jour

Array
Id
required
integer <int32>
VatRate
required
string
Enum: "Unknown" "_20" "_10" "_055" "_085" "_021" "_0175" "_009" "_0105" "_13" "MultipleRates" "_0"
Category
required
string
Enum: "ACHAT_ELEC" "ACHAT_ELEC_CORSE" "ACHAT_HORS_FR" "ACHAT_HORS_FR_CORSE" "ACHATS_FRANCHISE" "ACQUI_INTRACOM" "ACQUI_INTRACOM_CORSE" "AUTRE_OP_IMP" "AUTRE_OP_IMP_CORSE" "AUTRE_OP_IMP_DOM" "AUTRE_OP_IMP_RET_AUT" "AUTRE_OP_NON_IMP" "AUTRE_TVA_A_DEDUIRE" "CESSION_IMMO" "CESSION_IMMO_CORSE" "CESSION_IMMO_DOM" "COEFFICIENT_TAX" "CREDIT_TVA_TRANSF_GROUP" "DED_AUTRES" "AUTOLIQ_SOUS_TRAITANCE_BTP" "AUTOLIQ_PREST_INTRACOM" "AUTOLIQ_ACQUI_INTRACOM" "AUTOLIQ_IMPORTATION" "AUTOLIQ_ACHATS_PREST_283_1" "DED_IMMO" "AUTOLIQ_PREST_INTRACOM_IMMO" "AUTOLIQ_ACQUI_INTRACOM_IMMO" "AUTOLIQ_IMPORTATION_IMMO" "EXPORT_HORS_UE" "IMPORT_AUTOLIQ" "IMPORT_RFS" "IMPORT_RFS_PETR" "LIVRAISON_ELEC_NON_IMP" "LIVRAISON_INTRA_B2B" "LIVR_SOI_MEME" "LIVR_SOI_MEME_CORSE" "OPER_INTERN_AU" "PREST_INTRACOM" "PREST_INTRACOM_CORSE" "PROD_PETR" "REGUL_OPERATION_IMP" "REGUL_OPERATION_NON_IMP" "REGUL_TVA_DED" "REPORT_TVA" "SOMMES_AJOUT" "SOMMES_IMPUT" "SORTIES_REG_SUSP" "SORTIES_REG_SUSP_DOM" "SORTIES_REG_SUSP_CORSE" "TOTAL_A_PAYER_GROUP" "TVA_MONACO" "TVA_REMB_DEMANDE" "VENTES_UE_B2C" "VENTE_NON_ETABLI_FR" "VT_PREST" "VT_PREST_CORSE" "VT_PREST_DOM" "NOT_DECLARABLE"

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
[
  • {
    }
]

Obtient la prochaine période de déclaration d'après la table des échéances. Indicatif : sur un régime annuel, form-declaration-period fait foi, seul à connaître les natures de période et les dépôts déjà faits

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Identifiant du dossier fiscal

Responses

Response samples

Content type
{
  • "StartDate": "2019-08-24T14:15:22Z",
  • "EndDate": "2019-08-24T14:15:22Z"
}

Obtient la prochaine période de remboursement pour un dossier fiscal

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Identifiant du dossier fiscal

Responses

Response samples

Content type
{
  • "StartDate": "2019-08-24T14:15:22Z",
  • "EndDate": "2019-08-24T14:15:22Z"
}

Obtient toutes les périodes de déclaration disponibles pour un dossier fiscal ainsi que la période recommandée. Source de vérité du choix de période : préférer cet endpoint à next-declaration-period, qui ignore les natures de période et les dépôts chevauchants

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Identifiant du dossier fiscal

query Parameters
procedureType
required
string
Enum: "Liquidation" "Refund" "Deposit" "Appendix"

Type de formulaire (Liquidation, Refund, Deposit)

onlyNonDeclaredPeriods
boolean
Default: false

Si true, retourne uniquement les périodes non déclarées

exerciseStartDate
string <date-time>

Date de début de l'exercice (optionnel, permet de sélectionner un exercice alternatif)

exerciseEndDate
string <date-time>

Date de fin de l'exercice (optionnel, permet de sélectionner un exercice alternatif)

type
string
Default: "Manual"
Enum: "Manual" "Assisted" "PreConfigured"

Type de procédure (Manual, Assisted)

startDate
string <date-time>

Début de la période déclarative demandée (optionnel, CA12 agricole uniquement : ajoute la période saisie aux natures proposées)

endDate
string <date-time>

Fin de la période déclarative demandée (optionnel, à fournir avec startDate)

Responses

Response samples

Content type
{
  • "Periods": [
    ],
  • "RecommendedPeriod": {
    },
  • "ExerciseStartDate": "2019-08-24T14:15:22Z",
  • "ExerciseEndDate": "2019-08-24T14:15:22Z",
  • "PeriodType": "Monthly"
}

TaxReportingTvaAssistantVatControl

Obtient les comptes nécessaires au cadrage base par taux

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Identifiant du dossier comptable

procedureId
required
integer <int32>

Identifiant de la procédure

query Parameters
startDate
string <date-time>

Date de début du cadrage

Responses

Response samples

Content type
{
  • "Rows": [
    ],
  • "Columns": [
    ],
  • "ErrorMessages": [
    ]
}

Obtient les comptes nécessaires au cadrage bases déclarées

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Identifiant du dossier comptable

procedureId
required
integer <int32>

Identifiant de la procédure

query Parameters
startDate
string <date-time>

Date de début du cadrage

Responses

Response samples

Content type
{
  • "Rows": [
    ],
  • "Columns": [
    ],
  • "ErrorMessages": [
    ]
}

Obtient le cadrage par solde de compte

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Identifiant du dossier comptable

procedureId
required
integer <int32>

Identifiant de la procédure

query Parameters
startDate
string <date-time>

Date de début du cadrage

Responses

Response samples

Content type
{
  • "Rows": [
    ],
  • "Columns": [
    ],
  • "ErrorMessages": [
    ]
}

Télécharge le cadrage par solde de compte au format XLSX

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Identifiant du dossier comptable

procedureId
required
integer <int32>

Identifiant de la procédure

Responses

Response samples

Content type
"string"

Obtient la synthèse de TVA déductible pour la déclaration par solde de compte

Retourne les trois éléments constitutifs de la TVA déductible :

  • TVA déductible : montant calculé automatiquement à partir des soldes comptables
  • Régularisations de TVA : somme des ajustements effectués par l'utilisateur lors de la ventilation
  • Correction à l'étape de ventilation : montant net de TVA déductible à déclarer (constatée - régularisations)
Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Identifiant du dossier comptable

procedureId
required
integer <int32>

Identifiant de la procédure

Responses

Response samples

Content type
{
  • "DeductibleVat": 0,
  • "VatRegularizations": 0,
  • "DeferredVat": 0,
  • "DeclaredVatForMonth": 0,
  • "NetDeductibleVat": 0,
  • "DeductibleVatElements": [
    ],
  • "RegularizationElements": [
    ]
}

Ajoute un nouveau compte au cadrage

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Identifiant du dossier comptable

procedureId
required
integer <int32>

Identifiant de la procédure

Request Body schema:
required

Donnée nécessaire à l'ajout du compte au cadrage

AccountId
required
integer <int32>
SubAccountId
integer <int32>
ParentRowIdentifier
required
string
VatControlType
required
string
Enum: "ByRates" "ByAmounts" "ByAccountBalance"

Responses

Request samples

Content type
{
  • "AccountId": 0,
  • "SubAccountId": 0,
  • "ParentRowIdentifier": "string",
  • "VatControlType": "ByRates"
}

Response samples

Content type
0
0

Supprime un compte du cadrage

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Identifiant du dossier comptable

procedureId
required
integer <int32>

Identifiant de la procédure

Request Body schema:
required

La commende de suppression de compte

VatControlType
required
string
Enum: "ByRates" "ByAmounts" "ByAccountBalance"
AccountId
required
integer <int32>
ParentRowIdentifier
required
string
SubAccountId
integer <int32>

Responses

Request samples

Content type
{
  • "VatControlType": "ByRates",
  • "AccountId": 0,
  • "ParentRowIdentifier": "string",
  • "SubAccountId": 0
}

Enregistre une surcharge de montant pour un compte du cadrage

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Identifiant du dossier comptable

procedureId
required
integer <int32>

Identifiant de la procédure

Request Body schema:
required
ControlType
required
string
Enum: "ByRates" "ByAmounts" "ByAccountBalance"
required
Array of objects (CellAmountCommand)

Responses

Request samples

Content type
{
  • "ControlType": "ByRates",
  • "CellAmountCommands": [
    ]
}

Crée une correction manuelle durable d'une cellule de cadrage TVA

La correction est clé-ée par le groupe de procédure : elle survit aux recalculs et est héritée par les rectificatives de la même période. Une période déjà déclarée (procédure hors statut Draft) est verrouillée.

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Identifiant du dossier comptable

procedureId
required
integer <int32>

Identifiant de la procédure

Request Body schema:
required

Donnée nécessaire à la création de la correction manuelle

RowIdentifier
required
string
VatRate
required
string
Enum: "Unknown" "_20" "_10" "_055" "_085" "_021" "_0175" "_009" "_0105" "_13" "MultipleRates" "_0"
VatCategory
required
string
Enum: "ACHAT_ELEC" "ACHAT_ELEC_CORSE" "ACHAT_HORS_FR" "ACHAT_HORS_FR_CORSE" "ACHATS_FRANCHISE" "ACQUI_INTRACOM" "ACQUI_INTRACOM_CORSE" "AUTRE_OP_IMP" "AUTRE_OP_IMP_CORSE" "AUTRE_OP_IMP_DOM" "AUTRE_OP_IMP_RET_AUT" "AUTRE_OP_NON_IMP" "AUTRE_TVA_A_DEDUIRE" "CESSION_IMMO" "CESSION_IMMO_CORSE" "CESSION_IMMO_DOM" "COEFFICIENT_TAX" "CREDIT_TVA_TRANSF_GROUP" "DED_AUTRES" "AUTOLIQ_SOUS_TRAITANCE_BTP" "AUTOLIQ_PREST_INTRACOM" "AUTOLIQ_ACQUI_INTRACOM" "AUTOLIQ_IMPORTATION" "AUTOLIQ_ACHATS_PREST_283_1" "DED_IMMO" "AUTOLIQ_PREST_INTRACOM_IMMO" "AUTOLIQ_ACQUI_INTRACOM_IMMO" "AUTOLIQ_IMPORTATION_IMMO" "EXPORT_HORS_UE" "IMPORT_AUTOLIQ" "IMPORT_RFS" "IMPORT_RFS_PETR" "LIVRAISON_ELEC_NON_IMP" "LIVRAISON_INTRA_B2B" "LIVR_SOI_MEME" "LIVR_SOI_MEME_CORSE" "OPER_INTERN_AU" "PREST_INTRACOM" "PREST_INTRACOM_CORSE" "PROD_PETR" "REGUL_OPERATION_IMP" "REGUL_OPERATION_NON_IMP" "REGUL_TVA_DED" "REPORT_TVA" "SOMMES_AJOUT" "SOMMES_IMPUT" "SORTIES_REG_SUSP" "SORTIES_REG_SUSP_DOM" "SORTIES_REG_SUSP_CORSE" "TOTAL_A_PAYER_GROUP" "TVA_MONACO" "TVA_REMB_DEMANDE" "VENTES_UE_B2C" "VENTE_NON_ETABLI_FR" "VT_PREST" "VT_PREST_CORSE" "VT_PREST_DOM" "NOT_DECLARABLE"
Amount
required
number <decimal>
TargetAccountId
integer <int32>
TargetSubAccountId
integer <int32>

Responses

Request samples

Content type
{
  • "RowIdentifier": "string",
  • "VatRate": "Unknown",
  • "VatCategory": "ACHAT_ELEC",
  • "Amount": 0,
  • "TargetAccountId": 0,
  • "TargetSubAccountId": 0
}

Obtient le jeu effectif des corrections manuelles durables du cadrage TVA visibles depuis la procédure

Les corrections annulées sont exclues ; les corrections de début d'exercice héritées des périodes antérieures de l'exercice apparaissent, sauf quand une correction plus récente de même clé les masque. L'origine et le droit d'annulation sont portés par IsInherited et IsCancellable : ce sont des règles serveur — périmètre d'héritage, état de dépôt des procédures — que le client n'a pas à re-dériver en comparant des identifiants de groupe. Les deux sont indépendants et les quatre combinaisons existent. IsCancellable se lit par correction et non par période. Sur la période qu'on RECTIFIE, ses PROPRES dépôts ne s'opposent plus au retrait de ce qu'ils ont emporté : refaire une déclaration de correction, c'est revenir sur ces montants, et le déclaré n'en est pas réécrit (les éléments déclarés sont persistés par procédure). Cette exemption ne couvre que les dépôts de cette période : le dépôt d'une période SUIVANTE de l'exercice qui a hérité la correction la reverrouille, cette période-là n'étant pas celle qu'on rectifie. Une correction HÉRITÉE d'une période antérieure n'est annulable que tant qu'aucune déclaration partie ne l'a emportée — ni celle de sa période déclarante, ni celle d'une période suivante de l'exercice, une correction de début d'exercice ou de régularisation N-1 valant pour toutes : sa corbeille agit à l'origine, donc sur une période que l'utilisateur ne rectifie pas. La chronologie court sur tout l'EXERCICE, y compris les périodes POSTÉRIEURES à celle qui est adressée : elles ne sont jamais dans le périmètre de lecture (une correction ne remonte pas), mais ce sont elles qui ont pu matérialiser puis transmettre une correction propagée. Amount rend le montant tel qu'il a été saisi, dans l'unité de la cellule éditée.

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Identifiant du dossier comptable

procedureId
required
integer <int32>

Identifiant de la procédure

Responses

Response samples

Content type
[
  • {
    }
]

Annule une correction manuelle durable du cadrage TVA

L'annulation adresse tout le périmètre d'héritage de la période : une correction de début d'exercice héritée d'une période antérieure est annulable ici, et disparaît à son origine — donc de toutes les périodes qui en héritent. Ce qui décide est la CHRONOLOGIE des dépôts comparée à la correction elle-même, sur toutes les périodes qui l'ont portée : sa période déclarante, et — pour une section qui vaut pour tout l'exercice — les périodes suivantes de l'EXERCICE, y compris celles postérieures à la période adressée, qui n'entrent jamais dans le périmètre de lecture mais ont pu matérialiser puis transmettre la correction. Une seule exemption : sur la période qu'on RECTIFIE, SES PROPRES dépôts ne s'opposent plus au retrait de ce qu'ils ont emporté — refaire une déclaration de correction, c'est revenir sur ces montants, et le déclaré n'en est pas réécrit, les éléments déclarés étant persistés par procédure. Elle ne s'étend pas aux dépôts des périodes suivantes, que l'utilisateur ne rectifie pas. Tant qu'aucune déclaration partie ne l'a emportée la correction s'annule ; sinon l'annulation est refusée (409 VatControlAdjustmentDeclaringPeriodFiled), car l'annuler à son origine réécrirait la base d'une période que l'utilisateur ne rectifie pas. Sur une correction HÉRITÉE le remède est alors de la neutraliser vers l'avant par un remplacement à montant nul depuis la période courante, qui ne touche pas l'origine ; sur une correction PROPRE le remplacement rencontre le même refus, et seule une correction compensatoire sur la même cellule reste ouverte, les corrections d'un même groupe s'additionnant. Le client n'a pas à trancher le droit : IsCancellable, renvoyé par la liste, le dit par correction. La période adressée doit elle aussi porter une procédure en brouillon (409 VatControlAdjustmentProcedureGroupLocked, cause distincte). L'annulation est définitive (pas de réactivation) et idempotente : annuler une correction déjà annulée répond succès sans effet. Toute correction hors périmètre — absente, d'un autre tenant, d'un autre exercice — est introuvable indistinctement (404), le couple introuvable/refusé ne servant pas d'oracle d'existence.

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Identifiant du dossier comptable

procedureId
required
integer <int32>

Identifiant de la procédure

adjustmentId
required
string <uuid>

Identifiant de la correction à annuler

Responses

Remplace une correction manuelle durable du cadrage TVA par une nouvelle correction du groupe courant

Une correction du groupe courant est annulée puis recréée ; une correction héritée d'une période antérieure de l'exercice reste intacte et se retrouve masquée par la nouvelle correction du groupe courant. Dans les deux cas la réponse porte la correction de remplacement, avec un nouvel identifiant. Remplacer une correction PROPRE commence par l'annuler : ce verbe porte donc le même verrou que l'annulation, rendu par le même verdict, et répond comme elle — jamais l'inverse. Sur la période qu'on rectifie ce verrou est ouvert pour SES PROPRES dépôts, mais pas pour ceux d'une période suivante de l'exercice qui a hérité la correction : remplacer y est alors refusé comme annuler (409 VatControlAdjustmentDeclaringPeriodFiled), et seule une correction compensatoire sur la même cellule reste ouverte. La branche HÉRITÉE ne passe pas par ce verrou : neutraliser une héritée qu'un dépôt a emportée reste recevable, c'est précisément le remède que IsCancellable faux désigne sur une héritée. Sur une héritée, ligne et taux sont immuables (409 VatControlAdjustmentInheritedKeyCannotChange) ; changer la seule catégorie pose une ombre à montant nul sur la clé héritée et crée la correction sous la nouvelle catégorie, dans la même transaction. Le groupe courant ne peut masquer une clé héritée qu'une fois, clé visée comprise (409 VatControlAdjustmentKeyAlreadyShadowedInCurrentGroup). Une correction déjà annulée est refusée en conflit, et la période adressée doit porter une procédure en brouillon (409 VatControlAdjustmentProcedureGroupLocked).

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Identifiant du dossier comptable

procedureId
required
integer <int32>

Identifiant de la procédure

adjustmentId
required
string <uuid>

Identifiant de la correction à remplacer

Request Body schema:
required

Donnée nécessaire à la création de la correction de remplacement

RowIdentifier
required
string
VatRate
required
string
Enum: "Unknown" "_20" "_10" "_055" "_085" "_021" "_0175" "_009" "_0105" "_13" "MultipleRates" "_0"
VatCategory
required
string
Enum: "ACHAT_ELEC" "ACHAT_ELEC_CORSE" "ACHAT_HORS_FR" "ACHAT_HORS_FR_CORSE" "ACHATS_FRANCHISE" "ACQUI_INTRACOM" "ACQUI_INTRACOM_CORSE" "AUTRE_OP_IMP" "AUTRE_OP_IMP_CORSE" "AUTRE_OP_IMP_DOM" "AUTRE_OP_IMP_RET_AUT" "AUTRE_OP_NON_IMP" "AUTRE_TVA_A_DEDUIRE" "CESSION_IMMO" "CESSION_IMMO_CORSE" "CESSION_IMMO_DOM" "COEFFICIENT_TAX" "CREDIT_TVA_TRANSF_GROUP" "DED_AUTRES" "AUTOLIQ_SOUS_TRAITANCE_BTP" "AUTOLIQ_PREST_INTRACOM" "AUTOLIQ_ACQUI_INTRACOM" "AUTOLIQ_IMPORTATION" "AUTOLIQ_ACHATS_PREST_283_1" "DED_IMMO" "AUTOLIQ_PREST_INTRACOM_IMMO" "AUTOLIQ_ACQUI_INTRACOM_IMMO" "AUTOLIQ_IMPORTATION_IMMO" "EXPORT_HORS_UE" "IMPORT_AUTOLIQ" "IMPORT_RFS" "IMPORT_RFS_PETR" "LIVRAISON_ELEC_NON_IMP" "LIVRAISON_INTRA_B2B" "LIVR_SOI_MEME" "LIVR_SOI_MEME_CORSE" "OPER_INTERN_AU" "PREST_INTRACOM" "PREST_INTRACOM_CORSE" "PROD_PETR" "REGUL_OPERATION_IMP" "REGUL_OPERATION_NON_IMP" "REGUL_TVA_DED" "REPORT_TVA" "SOMMES_AJOUT" "SOMMES_IMPUT" "SORTIES_REG_SUSP" "SORTIES_REG_SUSP_DOM" "SORTIES_REG_SUSP_CORSE" "TOTAL_A_PAYER_GROUP" "TVA_MONACO" "TVA_REMB_DEMANDE" "VENTES_UE_B2C" "VENTE_NON_ETABLI_FR" "VT_PREST" "VT_PREST_CORSE" "VT_PREST_DOM" "NOT_DECLARABLE"
Amount
required
number <decimal>
TargetAccountId
integer <int32>
TargetSubAccountId
integer <int32>

Responses

Request samples

Content type
{
  • "RowIdentifier": "string",
  • "VatRate": "Unknown",
  • "VatCategory": "ACHAT_ELEC",
  • "Amount": 0,
  • "TargetAccountId": 0,
  • "TargetSubAccountId": 0
}

Response samples

Content type
{
  • "AdjustmentId": "506f6f67-d01d-4a49-bf29-22bdcf105185",
  • "DeclaredInProcedureGroupId": 0,
  • "IsInherited": true,
  • "IsCancellable": true,
  • "RowIdentifier": "string",
  • "VatRate": "Unknown",
  • "VatCategory": "ACHAT_ELEC",
  • "VatElementNature": "CollectedVatAccount",
  • "Amount": 0,
  • "TaxExcludedAmount": 0,
  • "TaxAmount": 0,
  • "CreatedByUserId": 0,
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "TargetAccountId": 0,
  • "TargetSubAccountId": 0
}

Obtient les comptes impactés sur la période de la procédure

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Identifiant du dossier comptable

procedureId
required
integer <int32>

Identifiant de la procédure

Responses

Response samples

Content type
[
  • {
    }
]

Obtient le cadrage TVA collectée calculé à partir des éléments de TVA stockés (source unifiée), sous la même forme de table que le cadrage par solde de compte

Table vide si le flag de bascule est désactivé pour ce dossier.

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Identifiant du dossier comptable

procedureId
required
integer <int32>

Identifiant de la procédure

Responses

Response samples

Content type
{
  • "Rows": [
    ],
  • "Columns": [
    ],
  • "ErrorMessages": [
    ]
}

TaxReportingTvaAssistantVatControlAdmin

Endpoint admin permettant de créer la structure de compte des cadrages lorsque celle-ci est manquante Temporaire, à utiliser pour rattraper l'histoire et à supprimer ensuite

Authorizations:
oauth2
Request Body schema:

Identifiants des déclarations à vérifier/créer la structure de compte

ProcedureIds
Array of integers <int32> [ items <int32 > ]

Responses

Request samples

Content type
{
  • "ProcedureIds": [
    ]
}

TaxReportingTvaAssistantVatRates

TaxReportingVatRates_PurchaseRates

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
procedureId
required
integer <int32>

Responses

Response samples

Content type
[
  • {
    }
]

TaxReportingVatRates_SaleRates

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
procedureId
required
integer <int32>

Responses

Response samples

Content type
[
  • {
    }
]

TaxReportingVatRates_CorrectionsRates

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
procedureId
required
integer <int32>

Responses

Response samples

Content type
[
  • {
    }
]

TaxReportingVatRates_UpdateEntryVatRates

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
entryId
required
integer <int32>
Request Body schema:
Id
required
integer <int32>
FileId
integer <int32>
Date
required
string <date-time>
Reference
required
string
required
object (VatAssistantAccountViewModel)
Label
required
string
Journal
required
string
TaxIncludedAmount
required
number <decimal>
TaxExcludedAmount
required
number <decimal>
VatAmount
required
number <decimal>
HasTaxRates
required
boolean
IsComputed
required
boolean
IsAutoLiquidation
required
boolean
required
Array of objects (VatRatedEntryLineViewModel)
object (VatRatedEntryLineLetteringViewModel)
EntryType
string
Enum: "Purchase" "Sale" "Regularisation"

Responses

Request samples

Content type
{
  • "Id": 0,
  • "FileId": 0,
  • "Date": "2019-08-24T14:15:22Z",
  • "Reference": "string",
  • "Account": {
    },
  • "Label": "string",
  • "Journal": "string",
  • "TaxIncludedAmount": 0,
  • "TaxExcludedAmount": 0,
  • "VatAmount": 0,
  • "HasTaxRates": true,
  • "IsComputed": true,
  • "IsAutoLiquidation": true,
  • "VatRatedEntryLines": [
    ],
  • "Lettering": {
    },
  • "EntryType": "Purchase"
}

Response samples

Content type
{
  • "Id": 0,
  • "FileId": 0,
  • "Date": "2019-08-24T14:15:22Z",
  • "Reference": "string",
  • "Account": {
    },
  • "Label": "string",
  • "Journal": "string",
  • "TaxIncludedAmount": 0,
  • "TaxExcludedAmount": 0,
  • "VatAmount": 0,
  • "HasTaxRates": true,
  • "IsComputed": true,
  • "IsAutoLiquidation": true,
  • "VatRatedEntryLines": [
    ],
  • "Lettering": {
    },
  • "EntryType": "Purchase",
  • "ComputedRate": 0.1
}

TaxReportingVatRates_UpdateEntriesVatRates

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
Request Body schema:
Array
Id
required
integer <int32>
FileId
integer <int32>
Date
required
string <date-time>
Reference
required
string
required
object (VatAssistantAccountViewModel)
Label
required
string
Journal
required
string
TaxIncludedAmount
required
number <decimal>
TaxExcludedAmount
required
number <decimal>
VatAmount
required
number <decimal>
HasTaxRates
required
boolean
IsComputed
required
boolean
IsAutoLiquidation
required
boolean
required
Array of objects (VatRatedEntryLineViewModel)
object (VatRatedEntryLineLetteringViewModel)
EntryType
string
Enum: "Purchase" "Sale" "Regularisation"

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
[
  • {
    }
]

TaxReportingVatRates_GetEntryVatDistribution

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
entryId
required
integer <int32>

Responses

Response samples

Content type
[
  • {
    }
]

TaxReportingVatDataRecoveryVatDataRecovery

Récupère le statut de la reprise de données TVA pour conditionner l'affichage des boutons

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Identifiant du dossier comptable

Responses

Response samples

Content type
true

Récupère le statut de la reprise de données TVA pour conditionner l'affichage des boutons

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Identifiant du dossier comptable

Responses

Response samples

Content type
{
  • "HasFecWithVatData": true,
  • "FecImportDate": "2019-08-24T14:15:22Z",
  • "IsDataRecoveryCompleted": true,
  • "DataRecoveryCompletedDate": "2019-08-24T14:15:22Z",
  • "ShowDataRecoveryButton": true
}

Crée ou met à jour le statut de reprise de données TVA suite à un import FEC

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Identifiant du dossier comptable

Request Body schema:

Informations sur l'import FEC

FecImportDate
required
string <date-time>
HasFecWithVatData
required
boolean

Responses

Request samples

Content type
{
  • "FecImportDate": "2019-08-24T14:15:22Z",
  • "HasFecWithVatData": true
}

Response samples

Content type
{
  • "HasFecWithVatData": true,
  • "FecImportDate": "2019-08-24T14:15:22Z",
  • "IsDataRecoveryCompleted": true,
  • "DataRecoveryCompletedDate": "2019-08-24T14:15:22Z",
  • "ShowDataRecoveryButton": true
}

Valide la reprise de données TVA pour permettre l'accès aux déclarations

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Identifiant du dossier comptable

Responses

Response samples

Content type
{
  • "IsValid": true,
  • "IsPurchasesValid": true,
  • "IsSalesValid": true,
  • "PurchasesErrors": [
    ],
  • "SalesErrors": [
    ],
  • "Status": {
    }
}

TaxReportingVatSettings

Obtient la liste des catégories de TVA disponibles

Authorizations:
oauth2

Responses

Response samples

Content type
[
  • {
    }
]

Obtient la liste des taux de TVA disponibles

Authorizations:
oauth2

Responses

Response samples

Content type
[
  • {
    }
]

Détermine si le dossier comptable a accès à l'assistant TVA

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

L'identifiant du dossier comptable

Responses

Response samples

Content type
{
  • "Data": true,
  • "Message": "string",
  • "Type": "Success"
}

Obtient une liste de bonnes pratiques pour le bon déroulement de la déclaration TVA du dossier comptable

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

L'identifiant du dossier comptable

Responses

Response samples

Content type
[
  • {
    }
]