API docs by Redocly

Fred Tax Declaration Api (v1)

Download OpenAPI specification:

Fred Tax Declaration API

This API sends French tax declarations (Liasse fiscale, 2571 / 2572, CVAE solde and acompte) to the French tax authorities, through the Teledec / Teleportail channel or the internal ApEF channel. It is part of the larger Fred platform and is consumed by other Fred services.

Authentication

All endpoints are protected and require a valid Fred bearer token, except where explicitly marked as anonymous. Authentication and authorization follow the common Inqom mechanism shared by every Fred microservice.

See the shared Inqom authentication documentation for how to obtain a token and call the API behind the gateway: Inqom API authentication.

Environments

Environment Base URL
Production https://apim-fred-prod.azure-api.net/tax-declaration
Staging https://apim-fred-staging.azure-api.net/tax-declaration

Replace the URLs above and the authentication link with the values for this service if they differ.

Jedeclare

Sends a JeDeclare tax declaration for the given accounting folder.

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Identifier of the accounting folder

Request Body schema:
required

The JeDeclare send parameters

EndDate
required
string <date-time>
Sujet
required
string
DeclarationType
required
string
Enum: "Liasse" "IS2571" "IS2572" "IS2573" "LiasseTeteDeGroupe" "CVAESolde" "CVAEAcompte" "Inconnu"

Responses

Request samples

Content type
{
  • "EndDate": "2019-08-24T14:15:22Z",
  • "Sujet": "string",
  • "DeclarationType": "Liasse"
}

Response samples

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

Downloads the raw EDI file deposited to JeDeclare for the given declaration, exactly as it was sent (raw EDIFACT, charset ISO-8859-15). Returned as a text/plain ".edi" attachment for inspection.

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Identifier of the accounting folder

query Parameters
endDate
required
string <date-time>

End date of the declaration period

declarationType
string
Enum: "Liasse" "IS2571" "IS2572" "IS2573" "LiasseTeteDeGroupe" "CVAESolde" "CVAEAcompte" "Inconnu"

Declaration type (defaults to Liasse)

Responses

TaxDeclaration

Get the Teledec reminders for a given accounting folder

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Identifier of the accounting folder

query Parameters
startDate
string <date-time>

Start date of the targeted exercise

endDate
string <date-time>

End date of the targeted exercise

declarationType
string
Default: "Liasse"
Enum: "Liasse" "IS2571" "IS2572" "IS2573" "LiasseTeteDeGroupe" "CVAESolde" "CVAEAcompte" "Inconnu"

Type of declaration targeted by the reminders (defaults to Liasse)

Responses

Response samples

Content type
[
  • {
    }
]

Get the accounting folder config (flags such as DisableReadOnlyForms, AllowSendingDeclarationWithFscpError) for a given (accountingFolderId, period). Always returns a value: defaults are returned when nothing has been stored yet.

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Identifier of the accounting folder

query Parameters
startDate
required
string <date-time>

Start date of the targeted exercise

endDate
required
string <date-time>

End date of the targeted exercise

Responses

Response samples

Content type
{
  • "AccountingFolderId": 0,
  • "StartDate": "2019-08-24T14:15:22Z",
  • "EndDate": "2019-08-24T14:15:22Z",
  • "DisableReadOnlyForms": true,
  • "AllowSendingDeclarationWithFscpError": true
}

Get the Teledec declarations url for a given accounting folder

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Identifier of the accounting folder

Responses

Response samples

Content type
"string"

Get the Teledec url of the greffe (court registry) filing page for a given accounting folder

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Identifier of the accounting folder

Responses

Response samples

Content type
"string"

Get the EDI file of a declaration from Teledec

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Identifier of the accounting folder

query Parameters
startDate
string <date-time>

Start date of the targeted exercise

endDate
string <date-time>

End date of the targeted exercise

declarationType
string
Default: "Liasse"
Enum: "Liasse" "IS2571" "IS2572" "IS2573" "LiasseTeteDeGroupe" "CVAESolde" "CVAEAcompte" "Inconnu"

Type of the declaration whose EDI file is requested (defaults to Liasse)

Responses

Response samples

Content type
{
  • "DomainDeclarationId": 0,
  • "TeledecId": 0,
  • "EdiContent": "string"
}

Send a declaration for a given accounting folder

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Identifier of the accounting folder

query Parameters
testPayload
boolean
Default: false

If true, the declaration will not be sent to Teledec

Request Body schema:
required

Set of data required for sending a declaration (check subsets of PublishDeclarationCommand for additional parameters)

StartDate
required
string <date-time>
EndDate
required
string <date-time>
DeclarationType
required
string
Enum: "Liasse" "IS2571" "IS2572" "IS2573" "LiasseTeteDeGroupe" "CVAESolde" "CVAEAcompte" "Inconnu"
DeclarationSourceType
required
string
Enum: "Manual" "Inqom"

Responses

Request samples

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

Response samples

Content type
{
  • "TeledecUrl": "string",
  • "JsonContent": "string",
  • "Reminders": [
    ],
  • "TransmissionChannel": "Teledec",
  • "DeclarationId": 0,
  • "StartDate": "2019-08-24T14:15:22Z",
  • "EndDate": "2019-08-24T14:15:22Z",
  • "DeclarationType": "Liasse"
}

Send a declaration for a given accounting folder and an existing declaration

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Identifier of the accounting folder

query Parameters
declarationType
string
Enum: "Liasse" "IS2571" "IS2572" "IS2573" "LiasseTeteDeGroupe" "CVAESolde" "CVAEAcompte" "Inconnu"

Declaration type

bloquerSiIncoherence
boolean
Default: true

Do not send declaration if errors are detected by Teledec

Request Body schema:
required

Set of data required for sending a declaration (check subsets of PublishExistingDeclarationCommand for additional parameters)

StartDate
required
string <date-time>
EndDate
required
string <date-time>

Responses

Request samples

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

Response samples

Content type
{
  • "Message": "string",
  • "TeledecId": 0
}

Get the declarations for a given accounting folder.

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Identifier of the accounting folder.

query Parameters
refreshTeledecData
boolean or null

When true, refreshes only the Teledec-channel declarations (reconciliation against Teledec). JeDeclare declarations are left untouched. Ignored when refreshData is true.

refreshData
boolean or null

When true, refreshes declaration data from all providers (Teledec reconciliation + JeDeclare sync). Takes priority over refreshTeledecData when both are supplied.

Responses

Response samples

Content type
[
  • {
    }
]

Add declarations for a given accounting folder

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Identifier of the accounting folder

Request Body schema:
required

Declarations to add

AccountingFolderId
required
integer <int32>
Array of objects or null (AddOrUpdateTaxDeclarationCommand)

Responses

Request samples

Content type
{
  • "AccountingFolderId": 0,
  • "Declarations": [
    ]
}

Update existing declarations of a given accounting folder

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Identifier of the accounting folder

Request Body schema:
required

Declarations to update

AccountingFolderId
required
integer <int32>
Array of objects or null (AddOrUpdateTaxDeclarationCommand)

Responses

Request samples

Content type
{
  • "AccountingFolderId": 0,
  • "Declarations": [
    ]
}

Get the advance payment calendar (due date ranges) for a given accounting folder and period

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Identifier of the accounting folder

query Parameters
StartDate
required
string <date-time>

Start date of the targeted exercise

EndDate
required
string <date-time>

End date of the targeted exercise

Responses

Response samples

Content type
[
  • [
    ]
]

Mark the status of a declaration as checked by the user

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Identifier of the accounting folder

query Parameters
declarationId
required
integer <int32>

Identifier of the declaration

Responses

Get the Teledec download url of a declaration document for a given accounting folder

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Identifier of the accounting folder

declarationId
required
integer <int32>

Identifier of the declaration

query Parameters
downloadType
required
string
Enum: "Unknown" "Pdf" "Edi"

Type of document to download

Responses

Response samples

Content type
"string"