API docs by Redocly

Fred FixedAsset Api (v1)

Download OpenAPI specification:

Fred.FixedAsset API

Fred.FixedAsset is the fixed asset management API within the Fred financial ecosystem. It handles the full lifecycle of fixed assets: acquisition, amortization (fiscal & economic depreciation), retirement with gain/loss, grants, component decomposition, and accounting entry generation.

Authentication

All endpoints are secured with Azure Active Directory (Azure AD) / OAuth2.

To call any endpoint, obtain a Bearer token from Azure AD:

Authorization: Bearer <access_token>

The API uses custom Fred claim policies (FredPolicy) that enforce resource-level access control (Read / Write) on top of standard Azure AD authentication.

Key Resources

  • Assets — Core fixed asset entities with characteristics, acquisition, amortization, and lifecycle management.
  • Amortizations — Fiscal and economic depreciation tables with multiple calculation methods.
  • Retirements — Asset disposal handling with gain/loss accounting.
  • Grants — Grants and subsidies linked to assets.
  • Component Groups — Decomposition of complex assets into component groups.
  • Geographical Locations — Physical location tracking for assets.
  • Accounting Entries — Generation and tracking of accounting entries from asset events.

AccountingConfiguration

Retrieves the complete accounting configuration for a specific fixed asset account including related amortization and retirement accounts.

This configuration determines which accounts are used for asset tracking, amortization, depreciation, and disposals. The acquisition date is used to retrieve accounts that were active at that specific point in time.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The unique identifier of the accounting folder (Dossier) for which to retrieve the configuration.

query Parameters
AccountId
integer <int32>
SubAccountId
integer or null <int32>
AcquisitionDate
required
string <date-time>
RetirementDate
string or null <date-time>

Responses

Response samples

Content type
{
  • "RetirementAccount": {
    },
  • "TransferAccount": {
    },
  • "AmortizationAccount": {
    },
  • "AmortizationDegorationAccount": {
    },
  • "AmortizationDotationAccount": {
    },
  • "AmortizationDotationExceptionalAccount": {
    },
  • "AmortizationRecoveryDerogationAccount": {
    },
  • "DepreciationProvisionAccount": {
    },
  • "DepreciationDotationRecoveryAccount": {
    },
  • "DepreciationDotationAccount": {
    },
  • "AmortizationDotationDerogationAccount": {
    },
  • "GrantAccount": {
    },
  • "ShareAccount": {
    },
  • "InvestmentAccount": {
    },
  • "ReceivableAccount": {
    }
}

Retrieves detailed information for multiple accounts by their account codes.

This endpoint provides account metadata including labels, status, and classification. Account codes are matched against the chart of accounts for the specified accounting folder.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The unique identifier of the accounting folder (Dossier) for which to retrieve account information.

query Parameters
accounts
Array of strings or null

The list of account codes for which to retrieve detailed information.

Responses

Response samples

Content type
[
  • {
    }
]

AssetAccount

Returns all transferable fixed asset accounts for an asset at a given transfer date.

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
fixedAssetId
required
integer <int32>
query Parameters
transferDate
string <date-time>

Responses

Response samples

Content type
{
  • "Accounts": [
    ]
}

Registers or updates a fixed asset account transfer at the given date.

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
fixedAssetId
required
integer <int32>
Request Body schema:
required
TransferDate
required
string <date-time>
PeriodStart
required
string <date-time>
PeriodEnd
required
string <date-time>
required
object (AccountCommand)

Responses

Request samples

Content type
{
  • "TransferDate": "2019-08-24T14:15:22Z",
  • "PeriodStart": "2019-08-24T14:15:22Z",
  • "PeriodEnd": "2019-08-24T14:15:22Z",
  • "Account": {
    }
}

Response samples

Content type
{
  • "Id": 0,
  • "EnterpriseId": 0,
  • "Name": "string",
  • "GroupName": "string",
  • "Notes": "string",
  • "AcquisitionValue": 0,
  • "AcquisitionDate": "2019-08-24T14:15:22Z",
  • "AcquisitionMethod": "NewPurchase",
  • "DeploymentDate": "2019-08-24T14:15:22Z",
  • "ResidualValue": 0,
  • "AcquisitionQuantity": 0,
  • "DeductibleVat": 0.1,
  • "AmountIncludingTax": 0.1,
  • "NetAcquisitionValue": 0.1,
  • "NetDeductibleVat": 0.1,
  • "NetAmountIncludingTax": 0.1,
  • "NetAcquisitionQuantity": 0.1,
  • "FixedAssetAccount": {
    },
  • "IsCreatedAutomatically": true,
  • "IsValidatedByUser": true,
  • "Number": 0,
  • "ExternalId": "string",
  • "GeographicalLocation": {
    },
  • "QuantityDetails": {
    },
  • "Retirement": {
    },
  • "Status": "Unknown",
  • "Nature": "Aucun",
  • "ComponentGroup": {
    },
  • "ComponentType": "Unknown",
  • "PreviousAccountDetails": {
    },
  • "DecompositionDate": "2019-08-24T14:15:22Z",
  • "Amortization": {
    },
  • "VehicleProperties": {
    },
  • "AssociationState": {
    },
  • "AccountingEntryLines": [
    ],
  • "IsAmortizable": true,
  • "Grants": [
    ],
  • "CreditNotes": [
    ],
  • "AvailableQuantity": 0,
  • "Errors": [
    ],
  • "HasAnyProspectiveRevision": true,
  • "AmortizationDefaults": {
    }
}

ComponentGroup

Returns all available component groups for an asset

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

Responses

Response samples

Content type
{
  • "ComponentGroupViewModels": [
    ]
}

Decompose at origin an asset in multiple components given a folder. This asset is transformed into a component group and new assets are created as components of this group.

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
fixedAssetId
required
integer <int32>
Request Body schema:
required
ExerciseStart
required
string <date-time>
ExerciseEnd
required
string <date-time>
ComponentGroupId
required
integer <int32>
ComponentGroupName
required
string
required
object (UpdatedAssetIntoComponentGroupCommand)
required
Array of objects (CreatedComponentCommand)

Responses

Request samples

Content type
{
  • "ExerciseStart": "2019-08-24T14:15:22Z",
  • "ExerciseEnd": "2019-08-24T14:15:22Z",
  • "ComponentGroupId": 0,
  • "ComponentGroupName": "string",
  • "UpdatedFixedAsset": {
    },
  • "CreatedComponents": [
    ]
}

Response samples

Content type
{
  • "Id": 0,
  • "EnterpriseId": 0,
  • "Name": "string",
  • "GroupName": "string",
  • "Notes": "string",
  • "AcquisitionValue": 0,
  • "AcquisitionDate": "2019-08-24T14:15:22Z",
  • "AcquisitionMethod": "NewPurchase",
  • "DeploymentDate": "2019-08-24T14:15:22Z",
  • "ResidualValue": 0,
  • "AcquisitionQuantity": 0,
  • "DeductibleVat": 0.1,
  • "AmountIncludingTax": 0.1,
  • "NetAcquisitionValue": 0.1,
  • "NetDeductibleVat": 0.1,
  • "NetAmountIncludingTax": 0.1,
  • "NetAcquisitionQuantity": 0.1,
  • "FixedAssetAccount": {
    },
  • "IsCreatedAutomatically": true,
  • "IsValidatedByUser": true,
  • "Number": 0,
  • "ExternalId": "string",
  • "GeographicalLocation": {
    },
  • "QuantityDetails": {
    },
  • "Retirement": {
    },
  • "Status": "Unknown",
  • "Nature": "Aucun",
  • "ComponentGroup": {
    },
  • "ComponentType": "Unknown",
  • "PreviousAccountDetails": {
    },
  • "DecompositionDate": "2019-08-24T14:15:22Z",
  • "Amortization": {
    },
  • "VehicleProperties": {
    },
  • "AssociationState": {
    },
  • "AccountingEntryLines": [
    ],
  • "IsAmortizable": true,
  • "Grants": [
    ],
  • "CreditNotes": [
    ],
  • "AvailableQuantity": 0,
  • "Errors": [
    ],
  • "HasAnyProspectiveRevision": true,
  • "AmortizationDefaults": {
    }
}

Decompose prospectively asset in multiple components given a folder. This asset is transformed into a component group and new assets are created as components of this group.

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
fixedAssetId
required
integer <int32>
Request Body schema:
required
ExerciseStart
required
string <date-time>
ExerciseEnd
required
string <date-time>
ComponentGroupId
required
integer <int32>
ComponentGroupName
required
string
required
object (UpdatedAssetIntoComponentGroupCommand)
required
Array of objects (CreatedComponentCommand)
DecompositionDate
required
string <date-time>

Responses

Request samples

Content type
{
  • "ExerciseStart": "2019-08-24T14:15:22Z",
  • "ExerciseEnd": "2019-08-24T14:15:22Z",
  • "ComponentGroupId": 0,
  • "ComponentGroupName": "string",
  • "UpdatedFixedAsset": {
    },
  • "CreatedComponents": [
    ],
  • "DecompositionDate": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "Id": 0,
  • "EnterpriseId": 0,
  • "Name": "string",
  • "GroupName": "string",
  • "Notes": "string",
  • "AcquisitionValue": 0,
  • "AcquisitionDate": "2019-08-24T14:15:22Z",
  • "AcquisitionMethod": "NewPurchase",
  • "DeploymentDate": "2019-08-24T14:15:22Z",
  • "ResidualValue": 0,
  • "AcquisitionQuantity": 0,
  • "DeductibleVat": 0.1,
  • "AmountIncludingTax": 0.1,
  • "NetAcquisitionValue": 0.1,
  • "NetDeductibleVat": 0.1,
  • "NetAmountIncludingTax": 0.1,
  • "NetAcquisitionQuantity": 0.1,
  • "FixedAssetAccount": {
    },
  • "IsCreatedAutomatically": true,
  • "IsValidatedByUser": true,
  • "Number": 0,
  • "ExternalId": "string",
  • "GeographicalLocation": {
    },
  • "QuantityDetails": {
    },
  • "Retirement": {
    },
  • "Status": "Unknown",
  • "Nature": "Aucun",
  • "ComponentGroup": {
    },
  • "ComponentType": "Unknown",
  • "PreviousAccountDetails": {
    },
  • "DecompositionDate": "2019-08-24T14:15:22Z",
  • "Amortization": {
    },
  • "VehicleProperties": {
    },
  • "AssociationState": {
    },
  • "AccountingEntryLines": [
    ],
  • "IsAmortizable": true,
  • "Grants": [
    ],
  • "CreditNotes": [
    ],
  • "AvailableQuantity": 0,
  • "Errors": [
    ],
  • "HasAnyProspectiveRevision": true,
  • "AmortizationDefaults": {
    }
}

Create a component group given a folder. Returns all available component groups for a folder.

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
Request Body schema:
required
ComponentGroupId
required
integer <int32>
ComponentGroupName
required
string

Responses

Request samples

Content type
{
  • "ComponentGroupId": 0,
  • "ComponentGroupName": "string"
}

Response samples

Content type
{
  • "ComponentGroupViewModels": [
    ]
}

Compute Decomposition Actual Values Returns computed actual values for components base on a given asset and folder

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
fixedAssetId
required
integer <int32>
Request Body schema:
required
ExerciseStart
required
string <date-time>
ExerciseEnd
required
string <date-time>
DecompositionDate
required
string <date-time>
required
Array of objects (ComputeDecompositionActualValueQuery) non-empty

Responses

Request samples

Content type
{
  • "ExerciseStart": "2019-08-24T14:15:22Z",
  • "ExerciseEnd": "2019-08-24T14:15:22Z",
  • "DecompositionDate": "2019-08-24T14:15:22Z",
  • "CreatedComponents": [
    ]
}

Response samples

Content type
{
  • "ActualValues": [
    ]
}

CreditNote

Creates a new credit note for a fixed asset to reduce its acquisition value and adjust amortization calculations.

The credit note reduces the asset's amortization base and affects all future amortization calculations. The effective date determines when the reduction applies in the amortization schedule. Credit notes cannot exceed the remaining acquisition value of the asset.

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

The unique identifier of the accounting folder (Dossier) containing the asset.

assetId
required
integer <int32>

The unique identifier of the asset for which to create the credit note.

Request Body schema:
required

The credit note details including effective date, VAT rate, amount, and optional quantity adjustment.

EffectiveDate
required
string <date-time>
VatRate
required
number <decimal>
AmountExcludingTax
required
number <decimal>
QuantityToBeDeducted
integer or null <int32>
PeriodEnd
required
string <date-time>

Responses

Request samples

Content type
{
  • "EffectiveDate": "2019-08-24T14:15:22Z",
  • "VatRate": 0,
  • "AmountExcludingTax": 0,
  • "QuantityToBeDeducted": 0,
  • "PeriodEnd": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "EffectiveDate": "2019-08-24T14:15:22Z",
  • "VatRate": 0,
  • "AmountExcludingTax": 0,
  • "QuantityToBeDeducted": 0,
  • "AmountInclTax": 0,
  • "VatAmount": 0
}

Retrieves a specific credit note for an asset by its effective date.

Credit notes are uniquely identified by their effective date for a given asset. Returns the credit note details including calculated amounts and quantity adjustments.

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

The unique identifier of the accounting folder (Dossier) containing the asset.

assetId
required
integer <int32>

The unique identifier of the asset for which to retrieve the credit note.

query Parameters
effectiveDate
required
string <date-time>

The effective date of the credit note to retrieve.

Responses

Response samples

Content type
{
  • "EffectiveDate": "2019-08-24T14:15:22Z",
  • "VatRate": 0,
  • "AmountExcludingTax": 0,
  • "QuantityToBeDeducted": 0,
  • "AmountInclTax": 0,
  • "VatAmount": 0
}

Updates an existing credit note for an asset with new values.

The effective date can be changed, which will affect when the credit note applies in the amortization schedule. All credit note values including amount and VAT rate can be modified. The asset's amortization is automatically recalculated after the update.

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

The unique identifier of the accounting folder (Dossier) containing the asset.

assetId
required
integer <int32>

The unique identifier of the asset for which to update the credit note.

Request Body schema:
required

The updated credit note data including old and new effective dates, VAT rate, amount, and optional quantity adjustment.

OldEffectiveDate
required
string <date-time>
NewEffectiveDate
required
string <date-time>
VatRate
required
number <decimal>
AmountExcludingTax
required
number <decimal>
QuantityToBeDeducted
integer or null <int32>
PeriodEnd
required
string <date-time>

Responses

Request samples

Content type
{
  • "OldEffectiveDate": "2019-08-24T14:15:22Z",
  • "NewEffectiveDate": "2019-08-24T14:15:22Z",
  • "VatRate": 0,
  • "AmountExcludingTax": 0,
  • "QuantityToBeDeducted": 0,
  • "PeriodEnd": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "EffectiveDate": "2019-08-24T14:15:22Z",
  • "VatRate": 0,
  • "AmountExcludingTax": 0,
  • "QuantityToBeDeducted": 0,
  • "AmountInclTax": 0,
  • "VatAmount": 0
}

Deletes a credit note from an asset, restoring the full acquisition value.

Deleting a credit note recalculates the asset's amortization using the original acquisition value. This operation cannot be undone and will affect all historical and future amortization calculations.

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

The unique identifier of the accounting folder (Dossier) containing the asset.

assetId
required
integer <int32>

The unique identifier of the asset from which to delete the credit note.

effectiveDate
required
string <date-time>

The effective date of the credit note to delete.

Responses

EnergyType

Retrieves the complete list of available energy types for vehicle classification and TVS tax calculation.

Energy types include categories such as gasoline, diesel, electric, and hybrid vehicles. This reference data is essential for accurate vehicle registration and tax computation.

Authorizations:
oauth2

Responses

Response samples

Content type
[
  • {
    }
]

FixedAsset

Searches and retrieves fixed assets within a specified accounting folder (Dossier) based on filtering, sorting, grouping, and pagination criteria.

This endpoint supports advanced querying capabilities including dynamic filters, multi-level sorting, and field grouping. Results are paginated by default with a limit of 50 items per page. Additional fields can be included in the response using the extends parameter.

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

The unique identifier of the accounting folder (Dossier) containing the assets to search.

query Parameters
startDate
required
string <date-time>

The start date of the period for which assets should be retrieved.

endDate
required
string <date-time>

The end date of the period for which assets should be retrieved.

sort
Array of strings or null

Optional sorting criteria in the format 'PropertyName:order' where order can be 'asc' (ascending) or 'desc' (descending). Multiple sorts can be applied by separating them with commas (e.g., 'name:desc,acquisitionDate:asc').

q
Array of strings or null

Optional filter criteria in the format 'PropertyName:operator:Value'. Supported operators include 'eq' (equals), 'ne' (not equals), 'lt' (less than), 'le' (less than or equals), 'gt' (greater than), 'ge' (greater than or equals), and 'in' (includes). For 'in' operator, values should be separated by '#' (e.g., 'Id:in:[1#2#3]').

group
Array of strings or null

Optional grouping criteria specifying the property name by which to group the results (e.g., 'category').

extends
Array of strings or null

Optional additional properties to include in the response, specified as comma-separated values (e.g., 'amortization,grants').

hasAlert
boolean or null

Optional filter to retrieve assets based on the presence of an alert. Set to {true} to get assets with alerts, {false} for those without, or leave {null} to retrieve all assets.

page
integer or null <int32>

The page number for pagination, with a default value of 1.

limit
integer or null <int32>

The maximum number of items to return per page, with a default value of 50.

Responses

Response samples

Content type
{
  • "Items": [
    ],
  • "Groups": [
    ],
  • "Page": 0,
  • "Limit": 0,
  • "TotalItems": 0,
  • "HasMore": true
}

Exports fixed assets from a specified accounting folder (Dossier) to a file in the requested format with optional filtering, sorting, and column selection.

This endpoint generates downloadable files containing asset data in various formats suitable for reporting and external processing. Filtering and sorting options are identical to the search endpoint, ensuring consistency in data retrieval. Column selection allows for customized reports with only the required fields.

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

The unique identifier of the accounting folder (Dossier) containing the assets to export.

query Parameters
startDate
required
string <date-time>

The start date of the period for which assets should be exported.

endDate
required
string <date-time>

The end date of the period for which assets should be exported.

exportType
required
string
Enum: "Html" "Pdf" "Csv" "Excel" "Inqom"

The desired export file format. Valid values are: Html, Pdf, Csv, Excel, or Inqom.

sort
Array of strings or null

Optional sorting criteria in the format 'PropertyName:order' where order can be 'asc' (ascending) or 'desc' (descending). Multiple sorts can be applied by separating them with commas.

q
Array of strings or null

Optional filter criteria in the format 'PropertyName:operator:Value'. Supported operators include 'eq' (equals), 'ne' (not equals), 'lt' (less than), 'le' (less than or equals), 'gt' (greater than), 'ge' (greater than or equals), and 'in' (includes).

group
Array of strings or null

Optional grouping criteria specifying the property name by which to group the exported results.

extends
Array of strings or null
Enum: "Id" "Number" "Name" "AcquisitionQuantity" "ExternalId" "ComponentGroupId" "ComponentGroupName" "AcquisitionDate" "DeploymentDate" "AcquisitionValue" "ResidualValue" "Notes" "Account" "Location" "IsRetired" "IsAssociated" "IsCreatedAutomatically" "IsValidatedByUser" "IsActiveInPeriod" "Status" "EconomicStartDate" "EconomicBase" "EconomicDuration" "EconomicMethod" "EconomicDecliningCoefficient" "EconomicCurrentPeriodAmount" "EconomicPastPeriodAmount" "EconomicCumulatedPeriodAmount" "EconomicVNCPeriodAmount" "FiscalBase" "FiscalCurrentPeriodAmount" "FiscalPastPeriodAmount" "FiscalCumulatedPeriodAmount" "FiscalVNCPeriodAmount" "HasVehicle" "OverAmortization" "TaxDeductibilityLimit" "RetirementType" "RetirementDate" "RetirementSaleAmount" "GainOrLossAmount" "GainOrLossEconomic" "GainOrLossShortTerm" "GainOrLossLongTerm" "GainOrLossTaxable" "Analytics"

Optional additional asset header fields to include in the export, specified as comma-separated AssetHeaderField values.

columns
Array of strings or null
Enum: "Id" "Number" "Name" "AcquisitionQuantity" "ExternalId" "ComponentGroupId" "ComponentGroupName" "AcquisitionDate" "DeploymentDate" "AcquisitionValue" "ResidualValue" "Notes" "Account" "Location" "IsRetired" "IsAssociated" "IsCreatedAutomatically" "IsValidatedByUser" "IsActiveInPeriod" "Status" "EconomicStartDate" "EconomicBase" "EconomicDuration" "EconomicMethod" "EconomicDecliningCoefficient" "EconomicCurrentPeriodAmount" "EconomicPastPeriodAmount" "EconomicCumulatedPeriodAmount" "EconomicVNCPeriodAmount" "FiscalBase" "FiscalCurrentPeriodAmount" "FiscalPastPeriodAmount" "FiscalCumulatedPeriodAmount" "FiscalVNCPeriodAmount" "HasVehicle" "OverAmortization" "TaxDeductibilityLimit" "RetirementType" "RetirementDate" "RetirementSaleAmount" "GainOrLossAmount" "GainOrLossEconomic" "GainOrLossShortTerm" "GainOrLossLongTerm" "GainOrLossTaxable" "Analytics"

Optional specific columns to include in the export, specified as comma-separated AssetHeaderField values. If not specified, default columns will be used.

withAnalytics
boolean or null

Specifies whether the export should include analytics-related information for the assets.

Responses

Response samples

Content type
{
  • "Filename": "string",
  • "Url": "string"
}

Retrieves the available data column headers and their metadata for assets within the specified accounting folder (Dossier).

This endpoint provides information about which fields are available for display and filtering in asset-related views. Headers include display names, data types, and sorting/filtering capabilities for each column.

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

The unique identifier of the accounting folder (Dossier) for which to retrieve header information.

Responses

Response samples

Content type
[
  • {
    }
]

Retrieves the identifiers of all fixed assets within the specified accounting folder (Dossier) that currently have active alerts or validation warnings.

Alerts may indicate issues such as missing required data, inconsistent amortization calculations, or validation rule violations. This endpoint is useful for quickly identifying assets requiring attention without retrieving full asset details.

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

The unique identifier of the accounting folder (Dossier) to check for assets with alerts.

query Parameters
endDate
string or null <date-time>

Responses

Response samples

Content type
[
  • 0
]

Updates the retirement information for one or multiple fixed assets within the specified accounting folder (Dossier).

This endpoint allows batch updates of retirement details such as retirement dates, disposal values, and retirement methods. Assets must exist and be in a state that allows retirement modifications. Changes are validated against business rules before being applied.

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

The unique identifier of the accounting folder (Dossier) containing the assets to update.

Request Body schema:

The command containing the retirement information for the specified assets, including retirement dates, disposal values, and method details.

AccountingFolderId
required
integer <int32>
AssetIds
required
Array of integers <int32> [ items <int32 > ]
object (RetirementCommand)
AllocationMethod
required
string
Enum: "AssetAmount" "AmortizationAmount" "VNC"
EndDate
string or null <date-time>

Responses

Request samples

Content type
{
  • "AccountingFolderId": 0,
  • "AssetIds": [
    ],
  • "Retirement": {
    },
  • "AllocationMethod": "AssetAmount",
  • "EndDate": "2019-08-24T14:15:22Z"
}

Transfers multiple in-progress fixed assets (class 23) into a single new class-21 asset.

This endpoint groups N in-progress asset records (23 accounts) into a single consolidated asset record (21 account). The consolidated record takes the sum of source acquisition values, the destination account must belong to class 21, and the deployment date must be later than or equal to the acquisition date of every source asset. Source assets are marked as transferred; they are hidden from the "in-progress assets" view on and after the transfer date.

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

The unique identifier of the accounting folder (Dossier) containing the source assets.

Request Body schema:

The command payload: source asset identifiers (N >= 2), deployment date, destination class-21 account, name, entry granularity flag.

SourceAssetIds
Array of integers or null <int32> [ items <int32 > ]
DeploymentDate
required
string <date-time>
object (AccountCommand)
Name
string or null
EntryLabel
string or null
IsDetailedEntry
required
boolean
StartDate
required
string <date-time>
EndDate
required
string <date-time>

Responses

Request samples

Content type
{
  • "SourceAssetIds": [
    ],
  • "DeploymentDate": "2019-08-24T14:15:22Z",
  • "DestinationAccount": {
    },
  • "Name": "string",
  • "EntryLabel": "string",
  • "IsDetailedEntry": true,
  • "StartDate": "2019-08-24T14:15:22Z",
  • "EndDate": "2019-08-24T14:15:22Z"
}

Response samples

Content type
0
0

Retrieves pre-configured retirement templates available for a specific fixed asset within the specified accounting folder (Dossier).

Retirement templates provide standardized retirement scenarios with pre-filled values based on the asset's current state and configuration. These templates help ensure consistent retirement processing and reduce manual data entry errors.

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

The unique identifier of the accounting folder (Dossier) containing the asset.

assetId
required
integer <int32>

The unique identifier of the fixed asset for which to retrieve retirement templates.

Request Body schema:
required

The query containing parameters for retirement template generation, such as retirement date and scenario type.

required
object (AccountCommand)
AcquisitionDate
required
string <date-time>
RetirementDate
required
string <date-time>
EndDate
string or null <date-time>

Responses

Request samples

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

Response samples

Content type
{
  • "DisposalTemplateViewModel": {
    },
  • "SaleTemplateViewModel": {
    }
}

FixedAssetFixedAsset_GetApplicableAssetRetirementExonerations

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Responses

Response samples

Content type
{
  • "Items": {
    }
}

Retrieves the complete details of a specific fixed asset within the specified accounting folder (Dossier) at a particular exercise end date.

This endpoint provides comprehensive asset information including acquisition details, amortization data, retirement information, grants, and associated accounting entries. The exercise end date determines the temporal view of the asset's financial state.

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

The unique identifier of the accounting folder (Dossier) containing the fixed asset.

assetId
required
integer <int32>

The unique identifier of the fixed asset to retrieve.

query Parameters
exerciseStart
required
string <date-time>

The start date of the displayed exercise, used for period-based transfer summaries.

exerciseEnd
required
string <date-time>

The end date of the accounting exercise for which to retrieve the asset's state and calculations.

Responses

Response samples

Content type
{
  • "Id": 0,
  • "EnterpriseId": 0,
  • "Name": "string",
  • "GroupName": "string",
  • "Notes": "string",
  • "AcquisitionValue": 0,
  • "AcquisitionDate": "2019-08-24T14:15:22Z",
  • "AcquisitionMethod": "NewPurchase",
  • "DeploymentDate": "2019-08-24T14:15:22Z",
  • "ResidualValue": 0,
  • "AcquisitionQuantity": 0,
  • "DeductibleVat": 0.1,
  • "AmountIncludingTax": 0.1,
  • "NetAcquisitionValue": 0.1,
  • "NetDeductibleVat": 0.1,
  • "NetAmountIncludingTax": 0.1,
  • "NetAcquisitionQuantity": 0.1,
  • "FixedAssetAccount": {
    },
  • "IsCreatedAutomatically": true,
  • "IsValidatedByUser": true,
  • "Number": 0,
  • "ExternalId": "string",
  • "GeographicalLocation": {
    },
  • "QuantityDetails": {
    },
  • "Retirement": {
    },
  • "Status": "Unknown",
  • "Nature": "Aucun",
  • "ComponentGroup": {
    },
  • "ComponentType": "Unknown",
  • "PreviousAccountDetails": {
    },
  • "DecompositionDate": "2019-08-24T14:15:22Z",
  • "Amortization": {
    },
  • "VehicleProperties": {
    },
  • "AssociationState": {
    },
  • "AccountingEntryLines": [
    ],
  • "IsAmortizable": true,
  • "Grants": [
    ],
  • "CreditNotes": [
    ],
  • "AvailableQuantity": 0,
  • "Errors": [
    ],
  • "HasAnyProspectiveRevision": true,
  • "AmortizationDefaults": {
    }
}

Updates the detailed information of a specific fixed asset within the specified accounting folder (Dossier) for a particular exercise end date.

This endpoint allows modification of asset properties including name, description, acquisition value, amortization parameters, accounts, and retirement details. All changes are validated against business rules before being applied. The updated asset is returned with recalculated values and association states.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The unique identifier of the accounting folder (Dossier) containing the asset.

assetId
required
integer <int32>

The unique identifier of the fixed asset to update.

query Parameters
exerciseStart
string or null <date-time>

The start date of the displayed exercise, used for period-based transfer summaries.

exerciseEnd
required
string <date-time>

The end date of the accounting exercise for which to update the asset.

Request Body schema:
required

The command containing the updated asset details including all modifiable properties.

EnterpriseId
required
integer <int32>
Name
required
string
required
object (AccountCommand)
AcquisitionValue
required
number <decimal>
AcquisitionDate
required
string <date-time>
DeploymentDate
required
string <date-time>
AcquisitionMethod
string or null
Enum: "NewPurchase" "UsedPurchase" "Contribution" "SelfDelivery" "Lease" "TransferBetweenAccounts"
object (GeographicalLocationCommand)
ExternalId
string or null
AcquisitionQuantity
required
number <decimal>
Nature
string or null
Enum: "Aucun" "Immeuble" "FraisDAcquisitionSurTitresDeParticipation" "TerrainsABatir"
object (QuantityCommand)
object (AssignAssetComponentGroupCommand)
AssetId
required
integer <int32>
ExerciseEnd
string or null <date-time>
IsActive
required
boolean
IsValidatedByUser
required
boolean
Notes
string or null
ResidualValue
required
number <decimal>
DeductibleVat
number or null <double>
AmountIncludingTax
number or null <double>
object (AmortizationCommand)
object (RetirementCommand)
object (VehiclePropertiesCommand)

Responses

Request samples

Content type
{
  • "EnterpriseId": 0,
  • "Name": "string",
  • "FixedAssetAccount": {
    },
  • "AcquisitionValue": 0,
  • "AcquisitionDate": "2019-08-24T14:15:22Z",
  • "DeploymentDate": "2019-08-24T14:15:22Z",
  • "AcquisitionMethod": "NewPurchase",
  • "GeographicalLocation": {
    },
  • "ExternalId": "string",
  • "AcquisitionQuantity": 0,
  • "Nature": "Aucun",
  • "QuantityDetails": {
    },
  • "ComponentGroup": {
    },
  • "AssetId": 0,
  • "ExerciseEnd": "2019-08-24T14:15:22Z",
  • "IsActive": true,
  • "IsValidatedByUser": true,
  • "Notes": "string",
  • "ResidualValue": 0,
  • "DeductibleVat": 0.1,
  • "AmountIncludingTax": 0.1,
  • "Amortization": {
    },
  • "Retirement": {
    },
  • "VehicleProperties": {
    }
}

Response samples

Content type
{
  • "Id": 0,
  • "EnterpriseId": 0,
  • "Name": "string",
  • "GroupName": "string",
  • "Notes": "string",
  • "AcquisitionValue": 0,
  • "AcquisitionDate": "2019-08-24T14:15:22Z",
  • "AcquisitionMethod": "NewPurchase",
  • "DeploymentDate": "2019-08-24T14:15:22Z",
  • "ResidualValue": 0,
  • "AcquisitionQuantity": 0,
  • "DeductibleVat": 0.1,
  • "AmountIncludingTax": 0.1,
  • "NetAcquisitionValue": 0.1,
  • "NetDeductibleVat": 0.1,
  • "NetAmountIncludingTax": 0.1,
  • "NetAcquisitionQuantity": 0.1,
  • "FixedAssetAccount": {
    },
  • "IsCreatedAutomatically": true,
  • "IsValidatedByUser": true,
  • "Number": 0,
  • "ExternalId": "string",
  • "GeographicalLocation": {
    },
  • "QuantityDetails": {
    },
  • "Retirement": {
    },
  • "Status": "Unknown",
  • "Nature": "Aucun",
  • "ComponentGroup": {
    },
  • "ComponentType": "Unknown",
  • "PreviousAccountDetails": {
    },
  • "DecompositionDate": "2019-08-24T14:15:22Z",
  • "Amortization": {
    },
  • "VehicleProperties": {
    },
  • "AssociationState": {
    },
  • "AccountingEntryLines": [
    ],
  • "IsAmortizable": true,
  • "Grants": [
    ],
  • "CreditNotes": [
    ],
  • "AvailableQuantity": 0,
  • "Errors": [
    ],
  • "HasAnyProspectiveRevision": true,
  • "AmortizationDefaults": {
    }
}

Retrieves the complete amortization table for a specific fixed asset within the specified accounting folder (Dossier) at a particular exercise end date.

The amortization table contains detailed yearly breakdown of depreciation values, accumulated depreciation, and net book values. Calculations are performed based on the asset's amortization method and parameters at the specified exercise end date.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The unique identifier of the accounting folder (Dossier) containing the asset.

assetId
required
integer <int32>

The unique identifier of the fixed asset for which to retrieve the amortization table.

query Parameters
exerciseEnd
required
string <date-time>

The end date of the accounting exercise for which to calculate the amortization table.

Responses

Response samples

Content type
{
  • "AmortizationRows": [
    ]
}

Retrieves the amortization tables for all fixed assets within the specified accounting folder (Dossier) at a particular exercise end date.

This endpoint returns a comprehensive dictionary mapping asset identifiers to their respective amortization tables. The tables are calculated concurrently for improved performance when retrieving data for multiple assets.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The unique identifier of the accounting folder (Dossier) for which to retrieve all amortization tables.

query Parameters
exerciseEnd
required
string <date-time>

The end date of the accounting exercise for which to calculate the amortization tables.

Responses

Response samples

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

Calculates and retrieves the amortization table including gain or loss projections based on draft asset parameters without persisting the asset.

This endpoint enables simulation of amortization scenarios for planning purposes before creating or modifying actual assets. The calculation includes potential gains or losses based on disposal scenarios provided in the query. No data is saved to the database during this operation.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The unique identifier of the accounting folder (Dossier) in which the draft asset would be created.

query Parameters
exerciseEnd
required
string <date-time>

The end date of the accounting exercise for which to calculate the draft amortization table.

Request Body schema:
required

The query containing the draft asset details including acquisition value, amortization method, useful life, and disposal parameters.

AcquisitionValue
required
number <decimal>
AcquisitionDate
required
string <date-time>
DeploymentDate
required
string <date-time>
ResidualValue
required
number <decimal>
object (AmortizationCommand)
object (RetirementCommand)
AssetId
integer or null <int32>

Responses

Request samples

Content type
{
  • "AcquisitionValue": 0,
  • "AcquisitionDate": "2019-08-24T14:15:22Z",
  • "DeploymentDate": "2019-08-24T14:15:22Z",
  • "ResidualValue": 0,
  • "Amortization": {
    },
  • "Retirement": {
    },
  • "AssetId": 0
}

Response samples

Content type
{
  • "AmortizationRows": [
    ],
  • "GainOrLossAmount": 0,
  • "EconomicGainOrLoss": 0,
  • "ShortTermGainOrLoss": 0,
  • "LongTermGainOrLoss": 0,
  • "TaxableGainOrLoss": 0
}

Calculates and retrieves simulated amortization tables for multiple draft assets with their associated information within the specified accounting folder (Dossier).

This endpoint supports batch simulation of amortization scenarios for multiple assets simultaneously. Each result includes both the calculated amortization table and relevant asset information for easy comparison. This is particularly useful for evaluating the impact of bulk asset acquisitions or modifications.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The unique identifier of the accounting folder (Dossier) in which the draft assets would be created.

query Parameters
exerciseEnd
required
string <date-time>

The end date of the accounting exercise for which to calculate the simulated amortization tables.

Request Body schema:
required

The query containing the collection of draft asset details for which to simulate amortization.

Array of objects or null (ComputeAmortizationTableQuery)

Responses

Request samples

Content type
{
  • "ComputeAmortizationTablesQueries": [
    ]
}

Response samples

Content type
[
  • {
    }
]

Retrieves the complete details of a specific fixed asset within the specified accounting folder (Dossier) without requiring an exercise end date. Deprecated

This is a legacy endpoint that has been superseded by the newer GetFixedAsset endpoint which requires an exercise end date parameter. The asset is retrieved with its current state without temporal filtering.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The unique identifier of the accounting folder (Dossier) containing the fixed asset.

assetId
required
integer <int32>

The unique identifier of the fixed asset to retrieve.

query Parameters
endDate
string or null <date-time>

Responses

Response samples

Content type
{
  • "Id": 0,
  • "EnterpriseId": 0,
  • "Name": "string",
  • "GroupName": "string",
  • "Notes": "string",
  • "AcquisitionValue": 0,
  • "AcquisitionDate": "2019-08-24T14:15:22Z",
  • "AcquisitionMethod": "NewPurchase",
  • "DeploymentDate": "2019-08-24T14:15:22Z",
  • "ResidualValue": 0,
  • "AcquisitionQuantity": 0,
  • "DeductibleVat": 0.1,
  • "AmountIncludingTax": 0.1,
  • "NetAcquisitionValue": 0.1,
  • "NetDeductibleVat": 0.1,
  • "NetAmountIncludingTax": 0.1,
  • "NetAcquisitionQuantity": 0.1,
  • "FixedAssetAccount": {
    },
  • "IsCreatedAutomatically": true,
  • "IsValidatedByUser": true,
  • "Number": 0,
  • "ExternalId": "string",
  • "GeographicalLocation": {
    },
  • "QuantityDetails": {
    },
  • "Retirement": {
    },
  • "Status": "Unknown",
  • "Nature": "Aucun",
  • "ComponentGroup": {
    },
  • "ComponentType": "Unknown",
  • "PreviousAccountDetails": {
    },
  • "DecompositionDate": "2019-08-24T14:15:22Z",
  • "Amortization": {
    },
  • "VehicleProperties": {
    },
  • "AssociationState": {
    },
  • "AccountingEntryLines": [
    ],
  • "IsAmortizable": true,
  • "Grants": [
    ],
  • "CreditNotes": [
    ],
  • "AvailableQuantity": 0,
  • "Errors": [
    ],
  • "HasAnyProspectiveRevision": true,
  • "AmortizationDefaults": {
    }
}

Updates the detailed information of a specific fixed asset within the specified accounting folder (Dossier) without requiring an exercise end date. Deprecated

This is a legacy endpoint that has been superseded by the newer UpdateFixedAsset endpoint which requires an exercise end date parameter. All changes are validated against business rules before being applied. The updated asset is returned with recalculated values and association states.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The unique identifier of the accounting folder (Dossier) containing the asset.

assetId
required
integer <int32>

The unique identifier of the fixed asset to update.

Request Body schema:
required

The command containing the updated asset details including all modifiable properties.

EnterpriseId
required
integer <int32>
Name
required
string
required
object (AccountCommand)
AcquisitionValue
required
number <decimal>
AcquisitionDate
required
string <date-time>
DeploymentDate
required
string <date-time>
AcquisitionMethod
string or null
Enum: "NewPurchase" "UsedPurchase" "Contribution" "SelfDelivery" "Lease" "TransferBetweenAccounts"
object (GeographicalLocationCommand)
ExternalId
string or null
AcquisitionQuantity
required
number <decimal>
Nature
string or null
Enum: "Aucun" "Immeuble" "FraisDAcquisitionSurTitresDeParticipation" "TerrainsABatir"
object (QuantityCommand)
object (AssignAssetComponentGroupCommand)
AssetId
required
integer <int32>
ExerciseEnd
string or null <date-time>
IsActive
required
boolean
IsValidatedByUser
required
boolean
Notes
string or null
ResidualValue
required
number <decimal>
DeductibleVat
number or null <double>
AmountIncludingTax
number or null <double>
object (AmortizationCommand)
object (RetirementCommand)
object (VehiclePropertiesCommand)

Responses

Request samples

Content type
{
  • "EnterpriseId": 0,
  • "Name": "string",
  • "FixedAssetAccount": {
    },
  • "AcquisitionValue": 0,
  • "AcquisitionDate": "2019-08-24T14:15:22Z",
  • "DeploymentDate": "2019-08-24T14:15:22Z",
  • "AcquisitionMethod": "NewPurchase",
  • "GeographicalLocation": {
    },
  • "ExternalId": "string",
  • "AcquisitionQuantity": 0,
  • "Nature": "Aucun",
  • "QuantityDetails": {
    },
  • "ComponentGroup": {
    },
  • "AssetId": 0,
  • "ExerciseEnd": "2019-08-24T14:15:22Z",
  • "IsActive": true,
  • "IsValidatedByUser": true,
  • "Notes": "string",
  • "ResidualValue": 0,
  • "DeductibleVat": 0.1,
  • "AmountIncludingTax": 0.1,
  • "Amortization": {
    },
  • "Retirement": {
    },
  • "VehicleProperties": {
    }
}

Response samples

Content type
{
  • "Id": 0,
  • "EnterpriseId": 0,
  • "Name": "string",
  • "GroupName": "string",
  • "Notes": "string",
  • "AcquisitionValue": 0,
  • "AcquisitionDate": "2019-08-24T14:15:22Z",
  • "AcquisitionMethod": "NewPurchase",
  • "DeploymentDate": "2019-08-24T14:15:22Z",
  • "ResidualValue": 0,
  • "AcquisitionQuantity": 0,
  • "DeductibleVat": 0.1,
  • "AmountIncludingTax": 0.1,
  • "NetAcquisitionValue": 0.1,
  • "NetDeductibleVat": 0.1,
  • "NetAmountIncludingTax": 0.1,
  • "NetAcquisitionQuantity": 0.1,
  • "FixedAssetAccount": {
    },
  • "IsCreatedAutomatically": true,
  • "IsValidatedByUser": true,
  • "Number": 0,
  • "ExternalId": "string",
  • "GeographicalLocation": {
    },
  • "QuantityDetails": {
    },
  • "Retirement": {
    },
  • "Status": "Unknown",
  • "Nature": "Aucun",
  • "ComponentGroup": {
    },
  • "ComponentType": "Unknown",
  • "PreviousAccountDetails": {
    },
  • "DecompositionDate": "2019-08-24T14:15:22Z",
  • "Amortization": {
    },
  • "VehicleProperties": {
    },
  • "AssociationState": {
    },
  • "AccountingEntryLines": [
    ],
  • "IsAmortizable": true,
  • "Grants": [
    ],
  • "CreditNotes": [
    ],
  • "AvailableQuantity": 0,
  • "Errors": [
    ],
  • "HasAnyProspectiveRevision": true,
  • "AmortizationDefaults": {
    }
}

Permanently deletes a specific fixed asset from the specified accounting folder (Dossier).

This operation removes the asset and all its associated data including amortization history, grants, and entry line associations. Assets with generated accounting entries may require entry deletion before the asset can be removed. This action cannot be undone.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The unique identifier of the accounting folder (Dossier) containing the asset to delete.

assetId
required
integer <int32>

The unique identifier of the fixed asset to permanently delete.

query Parameters
endDate
string or null <date-time>

Responses

Retrieves all fixed assets within the specified accounting folder (Dossier) including their associated account information.

This endpoint returns a comprehensive list of all assets in the folder with their accounting details. For large datasets, consider using the paginated SearchAssets endpoint instead for better performance.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The unique identifier of the accounting folder (Dossier) for which to retrieve all fixed assets.

query Parameters
endDate
string or null <date-time>

Responses

Response samples

Content type
[
  • {
    }
]

Creates a new fixed asset within the specified accounting folder (Dossier) with the provided details.

This endpoint validates all required asset properties including acquisition date, value, amortization method, and account assignments. The newly created asset is assigned a unique identifier and initialized with default calculated values.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The unique identifier of the accounting folder (Dossier) in which to create the fixed asset.

Request Body schema:
required

The command containing all required details for the new asset including name, category, acquisition information, and amortization parameters.

EnterpriseId
required
integer <int32>
Name
required
string
required
object (AccountCommand)
AcquisitionValue
required
number <decimal>
AcquisitionDate
required
string <date-time>
DeploymentDate
required
string <date-time>
AcquisitionMethod
string or null
Enum: "NewPurchase" "UsedPurchase" "Contribution" "SelfDelivery" "Lease" "TransferBetweenAccounts"
object (GeographicalLocationCommand)
ExternalId
string or null
AcquisitionQuantity
required
number <decimal>
Nature
string or null
Enum: "Aucun" "Immeuble" "FraisDAcquisitionSurTitresDeParticipation" "TerrainsABatir"
object (QuantityCommand)
object (AssignAssetComponentGroupCommand)

Responses

Request samples

Content type
{
  • "EnterpriseId": 0,
  • "Name": "string",
  • "FixedAssetAccount": {
    },
  • "AcquisitionValue": 0,
  • "AcquisitionDate": "2019-08-24T14:15:22Z",
  • "DeploymentDate": "2019-08-24T14:15:22Z",
  • "AcquisitionMethod": "NewPurchase",
  • "GeographicalLocation": {
    },
  • "ExternalId": "string",
  • "AcquisitionQuantity": 0,
  • "Nature": "Aucun",
  • "QuantityDetails": {
    },
  • "ComponentGroup": {
    }
}

Response samples

Content type
0
0

Permanently deletes all fixed assets within the specified accounting folder (Dossier).

This is a destructive operation that removes all assets and their associated data from the accounting folder. This endpoint is restricted to support personnel only and should be used with extreme caution. This action cannot be undone and may affect accounting reports and audit trails.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The unique identifier of the accounting folder (Dossier) from which to delete all fixed assets.

query Parameters
withGrants
boolean or null

Optional flag to also delete all grants associated with the accounting folder.

Responses

Retrieves multiple fixed assets by their identifiers within the specified accounting folder (Dossier).

This endpoint allows efficient bulk retrieval of specific assets by providing a list of asset identifiers. Only assets that exist and belong to the specified accounting folder are returned.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The unique identifier of the accounting folder (Dossier) containing the requested assets.

query Parameters
endDate
string or null <date-time>
Request Body schema:

The collection of unique identifiers for the fixed assets to retrieve.

Array
integer <int32>

Responses

Request samples

Content type
[
  • 0
]

Response samples

Content type
[
  • {
    }
]

Automatically creates fixed assets from accounting entry lines within the specified accounting folder (Dossier) for a given period.

This endpoint analyzes accounting entries in specified accounts during the period and automatically generates corresponding fixed assets. Asset properties are derived from the accounting entries including acquisition dates, values, and account assignments. The process identifies relevant entries based on account classification and configured rules.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The unique identifier of the accounting folder (Dossier) in which to create the fixed assets.

query Parameters
periodBeginDate
required
string <date-time>

The start date of the period from which to analyze accounting entries for asset creation.

periodEndDate
required
string <date-time>

The end date of the period from which to analyze accounting entries for asset creation. Must be later than periodBeginDate.

Responses

Response samples

Content type
{
  • "FixedAssetsCreatedCount": 0,
  • "FixedAssetsNotAssociatedError": [
    ]
}

Creates assets from specified accounting entry lines within the specified accounting folder.

This endpoint creates assets by associating selected accounting entry lines with the new fixed assets. Asset properties are calculated based on the aggregated values from the provided entry lines. The entry lines must belong to the specified accounting folder and be eligible for asset creation.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
query Parameters
endDate
string or null <date-time>
Request Body schema:
required
EnterpriseId
required
integer <int32>
Array of objects or null (AccountingEntryLineCommand)
AutomaticCreationTrigger
string or null
Enum: "Unknown" "ByUser" "Server" "Bulk"

Responses

Request samples

Content type
{
  • "EnterpriseId": 0,
  • "AccountingEntryLines": [
    ],
  • "AutomaticCreationTrigger": "Unknown"
}

Response samples

Content type
[
  • {
    }
]

Updates the account assignment information for a specific fixed asset within the specified accounting folder (Dossier). Deprecated

This is a legacy endpoint that has been superseded by the Update endpoint which handles all asset modifications including account assignments. Account changes affect how the asset is categorized and reported in accounting statements.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The unique identifier of the accounting folder (Dossier) containing the asset.

assetId
required
integer <int32>

The unique identifier of the fixed asset for which to update account information.

query Parameters
endDate
string or null <date-time>
Request Body schema:
required

The command containing the new account assignment details.

AccountId
required
integer <int32>
AccountNumber
required
integer <int32>
SubAccountId
integer or null <int32>
SubAccountCode
string or null

Responses

Request samples

Content type
{
  • "AccountId": 0,
  • "AccountNumber": 0,
  • "SubAccountId": 0,
  • "SubAccountCode": "string"
}

Deletes a fixed asset associated with a specific accounting entry line within the specified accounting folder (Dossier).

This endpoint identifies and removes the asset that is linked to the specified entry line. If multiple assets are associated with the entry line, only the primary asset is deleted. This action cannot be undone.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The unique identifier of the accounting folder (Dossier) containing the asset.

lineId
required
integer <int64>

The unique identifier of the accounting entry line associated with the asset to delete.

Responses

Removes the associations between a fixed asset and specified accounting entry lines within the specified accounting folder (Dossier).

This endpoint breaks the link between the asset and entry lines without deleting either entity. Dissociated entry lines become available for association with other assets. The asset's values and calculations are recalculated after dissociation.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The unique identifier of the accounting folder (Dossier) containing the asset.

assetId
required
integer <int32>

The unique identifier of the fixed asset from which to dissociate entry lines.

query Parameters
endDate
string or null <date-time>
Request Body schema:
required

The collection of accounting entry line identifiers to dissociate from the asset.

Array
integer <int64>

Responses

Request samples

Content type
[
  • 0
]

Response samples

Content type
{
  • "Id": 0,
  • "EnterpriseId": 0,
  • "Name": "string",
  • "GroupName": "string",
  • "Notes": "string",
  • "AcquisitionValue": 0,
  • "AcquisitionDate": "2019-08-24T14:15:22Z",
  • "AcquisitionMethod": "NewPurchase",
  • "DeploymentDate": "2019-08-24T14:15:22Z",
  • "ResidualValue": 0,
  • "AcquisitionQuantity": 0,
  • "DeductibleVat": 0.1,
  • "AmountIncludingTax": 0.1,
  • "NetAcquisitionValue": 0.1,
  • "NetDeductibleVat": 0.1,
  • "NetAmountIncludingTax": 0.1,
  • "NetAcquisitionQuantity": 0.1,
  • "FixedAssetAccount": {
    },
  • "IsCreatedAutomatically": true,
  • "IsValidatedByUser": true,
  • "Number": 0,
  • "ExternalId": "string",
  • "GeographicalLocation": {
    },
  • "QuantityDetails": {
    },
  • "Retirement": {
    },
  • "Status": "Unknown",
  • "Nature": "Aucun",
  • "ComponentGroup": {
    },
  • "ComponentType": "Unknown",
  • "PreviousAccountDetails": {
    },
  • "DecompositionDate": "2019-08-24T14:15:22Z",
  • "Amortization": {
    },
  • "VehicleProperties": {
    },
  • "AssociationState": {
    },
  • "AccountingEntryLines": [
    ],
  • "IsAmortizable": true,
  • "Grants": [
    ],
  • "CreditNotes": [
    ],
  • "AvailableQuantity": 0,
  • "Errors": [
    ],
  • "HasAnyProspectiveRevision": true,
  • "AmortizationDefaults": {
    }
}

Automatically associates unassociated accounting entry lines to existing fixed assets within the specified accounting folder (Dossier) using matching rules.

This endpoint applies configured association rules to match entry lines with assets based on criteria such as account numbers, dates, and amounts. Only entry lines that are not already associated with an asset are processed. The operation provides a summary of successful associations and any entries that could not be matched.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The unique identifier of the accounting folder (Dossier) in which to perform automatic associations.

query Parameters
endDate
string or null <date-time>

Responses

Response samples

Content type
{
  • "FixedAssetsAssociatedCount": 0,
  • "FixedAssetsNotAssociatedCount": 0
}

Associates specific accounting entry lines to a designated fixed asset within the specified accounting folder (Dossier).

This endpoint creates explicit links between the specified entry lines and the target asset. Entry lines must not be already associated with other assets and must belong to the specified accounting folder. The asset's values and calculations are updated to reflect the newly associated entries.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The unique identifier of the accounting folder (Dossier) containing the asset.

assetId
required
integer <int32>

The unique identifier of the fixed asset to which entry lines should be associated.

query Parameters
endDate
string or null <date-time>
Request Body schema:
required

The command containing the collection of accounting entry line identifiers to associate with the asset.

Array of objects or null (AccountingEntryLineCommand)

Responses

Request samples

Content type
{
  • "AccountingEntryLines": [
    ]
}

Response samples

Content type
0
0

Splits a fixed asset into multiple separate assets within the specified accounting folder (Dossier) based on provided allocation criteria.

This endpoint divides the original asset's value and properties across newly created assets according to specified percentages or amounts. The original asset may be retained or replaced depending on the split configuration. Each resulting asset maintains its own amortization schedule calculated from the split date.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The unique identifier of the accounting folder (Dossier) containing the asset to split.

assetId
required
integer <int32>

The unique identifier of the fixed asset to split into multiple assets.

Request Body schema:
required

The command containing the split details including allocation ratios and properties for each resulting asset.

RetirementValue
required
number <decimal>
Quantity
required
number <decimal>
Name
string or null
InMultipleIdenticalAssets
required
boolean
RetirementDate
string or null <date-time>
ExerciseEnd
string or null <date-time>

Responses

Request samples

Content type
{
  • "RetirementValue": 0,
  • "Quantity": 0,
  • "Name": "string",
  • "InMultipleIdenticalAssets": true,
  • "RetirementDate": "2019-08-24T14:15:22Z",
  • "ExerciseEnd": "2019-08-24T14:15:22Z"
}

Response samples

Content type
[
  • {
    }
]

Retrieves fixed assets grouped by category within the specified accounting folder (Dossier) based on search criteria.

This endpoint organizes assets into hierarchical categories for easier navigation and reporting. Search parameters allow filtering within categories to find specific assets. Categories are determined by the asset classification configured in the accounting folder.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The unique identifier of the accounting folder (Dossier) for which to retrieve categorized assets.

query Parameters
Name
string or null
IsActive
boolean or null
endDate
string or null <date-time>

Responses

Response samples

Content type
[
  • {
    }
]

Retrieves the amortization table for a specific fixed asset within the specified accounting folder (Dossier) without requiring an exercise end date. Deprecated

This is a legacy endpoint that has been superseded by the GetAmortizationTableByAsset endpoint which requires an exercise end date parameter. The amortization table is calculated using the asset's current configuration.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The unique identifier of the accounting folder (Dossier) containing the asset.

assetId
required
integer <int32>

The unique identifier of the fixed asset for which to retrieve the amortization table.

query Parameters
endDate
string or null <date-time>

Responses

Response samples

Content type
{
  • "AmortizationRows": [
    ]
}

Retrieves the amortization tables for all fixed assets within the specified accounting folder (Dossier) without requiring an exercise end date. Deprecated

This is a legacy endpoint that has been superseded by the GetAmortizationTablesByAccountingFolder endpoint which requires an exercise end date parameter. Tables are calculated using each asset's current configuration.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The unique identifier of the accounting folder (Dossier) for which to retrieve all amortization tables.

query Parameters
endDate
string or null <date-time>

Responses

Response samples

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

Calculates and retrieves the amortization table including gain or loss projections based on draft asset parameters without requiring an exercise end date. Deprecated

This is a legacy endpoint that has been superseded by the GetAmortizationTablesFromDraftAsset endpoint which requires an exercise end date parameter. The calculation includes potential gains or losses based on disposal scenarios provided in the query.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The unique identifier of the accounting folder (Dossier) in which the draft asset would be created.

query Parameters
endDate
string or null <date-time>
Request Body schema:
required

The query containing the draft asset details including acquisition value, amortization method, useful life, and disposal parameters.

AcquisitionValue
required
number <decimal>
AcquisitionDate
required
string <date-time>
DeploymentDate
required
string <date-time>
ResidualValue
required
number <decimal>
object (AmortizationCommand)
object (RetirementCommand)
AssetId
integer or null <int32>

Responses

Request samples

Content type
{
  • "AcquisitionValue": 0,
  • "AcquisitionDate": "2019-08-24T14:15:22Z",
  • "DeploymentDate": "2019-08-24T14:15:22Z",
  • "ResidualValue": 0,
  • "Amortization": {
    },
  • "Retirement": {
    },
  • "AssetId": 0
}

Response samples

Content type
{
  • "AmortizationRows": [
    ],
  • "GainOrLossAmount": 0,
  • "EconomicGainOrLoss": 0,
  • "ShortTermGainOrLoss": 0,
  • "LongTermGainOrLoss": 0,
  • "TaxableGainOrLoss": 0
}

Creates or updates the fixed asset configuration settings for the specified accounting folder (Dossier).

Configuration settings control default behaviors including amortization calculation methods, account assignments, entry generation rules, and validation parameters. Changes to configuration may affect how existing assets are calculated and displayed. Configuration settings are folder-specific and do not affect other accounting folders.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The unique identifier of the accounting folder (Dossier) for which to set the configuration.

Request Body schema:

The command containing the complete configuration settings including default accounts, calculation rules, and validation options.

AreFixedAssetEntriesGroupedByAccount
required
boolean
IsMiniMaxiEnabled
required
boolean

Responses

Request samples

Content type
{
  • "AreFixedAssetEntriesGroupedByAccount": true,
  • "IsMiniMaxiEnabled": true
}

Response samples

Content type
{
  • "AreFixedAssetEntriesGroupedByAccount": true,
  • "IsMiniMaxiEnabled": true
}

Retrieves the current fixed asset configuration settings for the specified accounting folder (Dossier).

Configuration settings include default account assignments, amortization calculation rules, entry generation parameters, and validation options. These settings determine how assets behave within the accounting folder.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The unique identifier of the accounting folder (Dossier) for which to retrieve the configuration.

Responses

Response samples

Content type
{
  • "AreFixedAssetEntriesGroupedByAccount": true,
  • "IsMiniMaxiEnabled": true
}

Generates accounting journal entries for fixed asset amortization and depreciation within the specified accounting folder (Dossier) for a given period.

This endpoint creates accounting entries based on calculated amortization for all active assets during the specified period. Generated entries are posted to the specified journal and can include depreciation, accumulated depreciation, and grant-related entries. Entries are validated against accounting rules before being created.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The unique identifier of the accounting folder (Dossier) in which to generate the entries.

Request Body schema:
required

The command containing the period for entry generation and the target journal identifier.

required
object (Period)
JournalId
required
integer <int32>

Responses

Request samples

Content type
{
  • "Period": { },
  • "JournalId": 0
}

Response samples

Content type
{
  • "EntryGeneratedCount": 0,
  • "LineGeneratedCount": 0
}

Deletes previously generated accounting journal entries for fixed assets within the specified accounting folder (Dossier) for a given period.

This endpoint removes amortization and depreciation entries that were generated by the fixed asset module. Only entries generated by the fixed asset system can be deleted; manual entries are not affected. Deletion is typically performed before regenerating entries with updated calculations.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The unique identifier of the accounting folder (Dossier) from which to delete entries.

Request Body schema:
required

The command containing the period and journal information for entries to be deleted.

AccountingFolderId
required
integer <int32>
AssetId
required
integer <int32>
StartDate
string or null <date-time>
EndDate
string or null <date-time>

Responses

Request samples

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

Generates regularization entries (OD) to align fixed asset amortization balances with accounting balances for economic amortizations.

This endpoint compares fixed asset economic amortization totals with accounting balances (category "Amortissements Économiques", accounts 28xx) and generates adjustment entries for any delta exceeding 0.01. Existing regularization entries for the same period are deleted before regeneration (idempotent). Returns an error if the exercise is closed.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The unique identifier of the accounting folder (Dossier) in which to generate the regularization entries.

Request Body schema:
required

The command containing the period end date and the target journal identifier.

PeriodEnd
required
string <date-time>
JournalId
required
integer <int32>

Responses

Request samples

Content type
{
  • "PeriodEnd": "2019-08-24T14:15:22Z",
  • "JournalId": 0
}

Response samples

Content type
{
  • "EntryGeneratedCount": 0,
  • "LineGeneratedCount": 0
}

Imports and creates fixed assets from an external file within the specified accounting folder (Dossier) using a specified import provider format.

This endpoint parses the uploaded file and creates assets based on the data contained within. Supported import formats are provider-specific and may include proprietary fixed asset management systems. The import process validates data and reports any entries that could not be processed. Past amortization data can be included by specifying an end date for historical depreciation.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The unique identifier of the accounting folder (Dossier) in which to import the fixed assets.

query Parameters
pastAmortizationEndDate
string or null <date-time>

Optional end date for importing past amortization history. If provided, historical depreciation up to this date will be included.

provider
string
Enum: "Inqom" "Cegid" "Quadra" "Coala" "Sage" "Acd" "Agiris"

The import provider format identifier. Valid values include 0 for Inqom format.

Request Body schema: multipart/form-data
attachmentFile
string or null <binary>

The import file containing fixed asset data. Maximum file size is 100 MB.

Responses

Response samples

Content type
{
  • "ImportedCount": 0,
  • "NotAssociatedErrors": [
    ],
  • "ErrorFile": "string"
}

Retrieves the history of fixed asset imports performed for the specified accounting folder (Dossier).

This endpoint returns a list of all import operations including import dates, source files, and counts of created assets. Import history helps track data sources and identify when assets were added to the system.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The unique identifier of the accounting folder (Dossier) for which to retrieve import history.

Responses

Deletes a specific import batch and all associated fixed assets from the specified accounting folder (Dossier).

This operation removes all assets that were created during the specified import batch. Associated accounting entries and amortization data for the imported assets are also deleted. This action cannot be undone.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The unique identifier of the accounting folder (Dossier) containing the import to delete.

Request Body schema:
required

The command containing the identifier of the import batch to delete.

AccountingFolderId
required
integer <int32>
ImportedAt
required
string <date-time>

Responses

Request samples

Content type
{
  • "AccountingFolderId": 0,
  • "ImportedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
0
0

Adds a new grant or subsidy to a specific fixed asset within the specified accounting folder (Dossier).

Grants reduce the net amortization expense by spreading the grant amount over the asset's useful life. Grant values and amortization methods must be compatible with the asset's configuration. Multiple grants can be applied to a single asset if allowed by the accounting folder configuration.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The unique identifier of the accounting folder (Dossier) containing the asset.

assetId
required
integer <int32>

The unique identifier of the fixed asset to which the grant should be added.

Request Body schema:
required

The command containing the grant details including amount, date, and amortization parameters.

GrantId
required
integer <int32>
Amount
required
number <decimal>
StaggeringYears
integer or null <int32>
EndDate
string or null <date-time>

Responses

Request samples

Content type
{
  • "GrantId": 0,
  • "Amount": 0,
  • "StaggeringYears": 0,
  • "EndDate": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "Id": 0,
  • "EnterpriseId": 0,
  • "Name": "string",
  • "GroupName": "string",
  • "Notes": "string",
  • "AcquisitionValue": 0,
  • "AcquisitionDate": "2019-08-24T14:15:22Z",
  • "AcquisitionMethod": "NewPurchase",
  • "DeploymentDate": "2019-08-24T14:15:22Z",
  • "ResidualValue": 0,
  • "AcquisitionQuantity": 0,
  • "DeductibleVat": 0.1,
  • "AmountIncludingTax": 0.1,
  • "NetAcquisitionValue": 0.1,
  • "NetDeductibleVat": 0.1,
  • "NetAmountIncludingTax": 0.1,
  • "NetAcquisitionQuantity": 0.1,
  • "FixedAssetAccount": {
    },
  • "IsCreatedAutomatically": true,
  • "IsValidatedByUser": true,
  • "Number": 0,
  • "ExternalId": "string",
  • "GeographicalLocation": {
    },
  • "QuantityDetails": {
    },
  • "Retirement": {
    },
  • "Status": "Unknown",
  • "Nature": "Aucun",
  • "ComponentGroup": {
    },
  • "ComponentType": "Unknown",
  • "PreviousAccountDetails": {
    },
  • "DecompositionDate": "2019-08-24T14:15:22Z",
  • "Amortization": {
    },
  • "VehicleProperties": {
    },
  • "AssociationState": {
    },
  • "AccountingEntryLines": [
    ],
  • "IsAmortizable": true,
  • "Grants": [
    ],
  • "CreditNotes": [
    ],
  • "AvailableQuantity": 0,
  • "Errors": [
    ],
  • "HasAnyProspectiveRevision": true,
  • "AmortizationDefaults": {
    }
}

Updates the details of an existing grant or subsidy associated with a specific fixed asset within the specified accounting folder (Dossier).

Changes to grant amounts or amortization parameters trigger recalculation of the asset's net amortization. Grant modifications are validated against business rules to ensure consistency with the asset's state. Past accounting periods may be affected by grant updates depending on the effective date.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The unique identifier of the accounting folder (Dossier) containing the asset.

assetId
required
integer <int32>

The unique identifier of the fixed asset containing the grant.

grantId
required
integer <int32>

The unique identifier of the grant to update.

Request Body schema:
required

The command containing the updated grant details including amount, date, and amortization parameters.

Amount
required
number <decimal>
StaggeringYears
integer or null <int32>
EndDate
string or null <date-time>

Responses

Request samples

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

Response samples

Content type
{
  • "Id": 0,
  • "EnterpriseId": 0,
  • "Name": "string",
  • "GroupName": "string",
  • "Notes": "string",
  • "AcquisitionValue": 0,
  • "AcquisitionDate": "2019-08-24T14:15:22Z",
  • "AcquisitionMethod": "NewPurchase",
  • "DeploymentDate": "2019-08-24T14:15:22Z",
  • "ResidualValue": 0,
  • "AcquisitionQuantity": 0,
  • "DeductibleVat": 0.1,
  • "AmountIncludingTax": 0.1,
  • "NetAcquisitionValue": 0.1,
  • "NetDeductibleVat": 0.1,
  • "NetAmountIncludingTax": 0.1,
  • "NetAcquisitionQuantity": 0.1,
  • "FixedAssetAccount": {
    },
  • "IsCreatedAutomatically": true,
  • "IsValidatedByUser": true,
  • "Number": 0,
  • "ExternalId": "string",
  • "GeographicalLocation": {
    },
  • "QuantityDetails": {
    },
  • "Retirement": {
    },
  • "Status": "Unknown",
  • "Nature": "Aucun",
  • "ComponentGroup": {
    },
  • "ComponentType": "Unknown",
  • "PreviousAccountDetails": {
    },
  • "DecompositionDate": "2019-08-24T14:15:22Z",
  • "Amortization": {
    },
  • "VehicleProperties": {
    },
  • "AssociationState": {
    },
  • "AccountingEntryLines": [
    ],
  • "IsAmortizable": true,
  • "Grants": [
    ],
  • "CreditNotes": [
    ],
  • "AvailableQuantity": 0,
  • "Errors": [
    ],
  • "HasAnyProspectiveRevision": true,
  • "AmortizationDefaults": {
    }
}

Removes a grant or subsidy from a specific fixed asset within the specified accounting folder (Dossier).

Deleting a grant recalculates the asset's net amortization without the grant's impact. If accounting entries have been generated for periods including the grant, those entries may need to be regenerated. This action cannot be undone.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The unique identifier of the accounting folder (Dossier) containing the asset.

assetId
required
integer <int32>

The unique identifier of the fixed asset from which to remove the grant.

grantId
required
integer <int32>

The unique identifier of the grant to delete.

query Parameters
endDate
string or null <date-time>

Responses

Response samples

Content type
{
  • "Id": 0,
  • "EnterpriseId": 0,
  • "Name": "string",
  • "GroupName": "string",
  • "Notes": "string",
  • "AcquisitionValue": 0,
  • "AcquisitionDate": "2019-08-24T14:15:22Z",
  • "AcquisitionMethod": "NewPurchase",
  • "DeploymentDate": "2019-08-24T14:15:22Z",
  • "ResidualValue": 0,
  • "AcquisitionQuantity": 0,
  • "DeductibleVat": 0.1,
  • "AmountIncludingTax": 0.1,
  • "NetAcquisitionValue": 0.1,
  • "NetDeductibleVat": 0.1,
  • "NetAmountIncludingTax": 0.1,
  • "NetAcquisitionQuantity": 0.1,
  • "FixedAssetAccount": {
    },
  • "IsCreatedAutomatically": true,
  • "IsValidatedByUser": true,
  • "Number": 0,
  • "ExternalId": "string",
  • "GeographicalLocation": {
    },
  • "QuantityDetails": {
    },
  • "Retirement": {
    },
  • "Status": "Unknown",
  • "Nature": "Aucun",
  • "ComponentGroup": {
    },
  • "ComponentType": "Unknown",
  • "PreviousAccountDetails": {
    },
  • "DecompositionDate": "2019-08-24T14:15:22Z",
  • "Amortization": {
    },
  • "VehicleProperties": {
    },
  • "AssociationState": {
    },
  • "AccountingEntryLines": [
    ],
  • "IsAmortizable": true,
  • "Grants": [
    ],
  • "CreditNotes": [
    ],
  • "AvailableQuantity": 0,
  • "Errors": [
    ],
  • "HasAnyProspectiveRevision": true,
  • "AmortizationDefaults": {
    }
}

FixedAssetAdmin

Deletes obsolete reverse accounting entries across multiple accounting folders for cleanup and data integrity.

This administrative operation removes reverse entries that are no longer needed or were incorrectly generated. The operation can be run in simulation mode to preview deletions before committing changes. Only users with Support permissions can execute this operation.

Authorizations:
oauth2
path Parameters
accountingFirmId
required
integer <int32>

The unique identifier of the accounting firm (Cabinet/Company) for which to clean up obsolete entries.

Request Body schema:
required

The deletion command specifying target accounting folders and simulation mode flag.

AccountingFirmId
required
integer <int32>
AccountingFolderIds
Array of integers or null <int32> [ items <int32 > ]
IsSimulationMode
required
boolean

Responses

Request samples

Content type
{
  • "AccountingFirmId": 0,
  • "AccountingFolderIds": [
    ],
  • "IsSimulationMode": true
}

Response samples

Content type
{
  • "AccountingFolders": {
    }
}

Updates the amortization calculation method for specified assets or entire accounting folders.

This operation recalculates amortization tables using a different calculation method version. Available methods include V1, V2, V3, and Latest, each with different rounding and prorata rules. Only users with Support permissions can modify calculation methods due to impact on financial reporting.

Authorizations:
oauth2
Request Body schema:

The update command specifying asset or folder IDs and the target calculation method.

FixedAssetIds
required
Array of integers <int32> [ items <int32 > ]
AccountingFolderIds
required
Array of integers <int32> [ items <int32 > ]
AmortizationCalculationMethod
required
string
Enum: "Unset" "V1" "V2" "V3" "Latest"

Responses

Request samples

Content type
{
  • "FixedAssetIds": [
    ],
  • "AccountingFolderIds": [
    ],
  • "AmortizationCalculationMethod": "Unset"
}

Response samples

Content type
"string"

Restores soft-deleted fixed assets by setting their DeletedAt back to null.

This administrative operation restores assets that were previously soft-deleted. Only assets belonging to the specified accounting folder can be restored. Only users with Support permissions can execute this operation.

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

The unique identifier of the accounting folder containing the assets to restore.

Request Body schema:

The restore command specifying the list of asset IDs to restore.

AccountingFolderId
required
integer <int32>
AssetIds
Array of integers or null <int32> [ items <int32 > ]

Responses

Request samples

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

Response samples

Content type
0
0

Permanently and irreversibly removes all fixed assets and their associated grants from the specified accounting folder.

Unlike the standard delete, this operation performs a hard delete: all assets are physically removed from the database, including assets that were previously soft-deleted. Associated grants are also hard-deleted. Domain events are published only for assets that were not already soft-deleted. Only users with Support permissions can execute this operation.

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

The unique identifier of the accounting folder from which to hard delete all fixed assets.

Responses

FixedAssetAmortization

Creates or updates the amortization configuration for a specific fixed asset, including economic and fiscal amortization parameters.

Each amortization configuration is uniquely identified by its effective date, allowing for prospective revisions to amortization schedules. The configuration includes amortization duration, method (linear, declining), base amount, and prorata temporis settings.

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

The unique identifier of the accounting folder (Dossier) containing the asset.

assetId
required
integer <int32>

The unique identifier of the asset for which to set amortization.

query Parameters
exerciseStart
string or null <date-time>

The start date of the displayed exercise, used for period-based transfer summaries.

exerciseEnd
required
string <date-time>

The end date of the current accounting exercise, used to determine the amortization period context.

Request Body schema:
required

The command containing the complete amortization configuration including economic attributes, fiscal attributes, residual value, and optional effective date.

EffectiveDate
string or null <date-time>
ResidualValue
required
number <decimal>
AmortizationId
integer or null <int32>
required
object (EconomicAmortizationAttributesCommand)
required
object (FiscalAmortizationAttributesCommand)
AmortizationCalculationMethod
required
string
Enum: "Unset" "V1" "V2" "V3" "Latest"

Responses

Request samples

Content type
{
  • "EffectiveDate": "2019-08-24T14:15:22Z",
  • "ResidualValue": 0,
  • "AmortizationId": 0,
  • "EconomicAttributes": {
    },
  • "FiscalAttributes": {
    },
  • "AmortizationCalculationMethod": "Unset"
}

Response samples

Content type
{
  • "Id": 0,
  • "EnterpriseId": 0,
  • "Name": "string",
  • "GroupName": "string",
  • "Notes": "string",
  • "AcquisitionValue": 0,
  • "AcquisitionDate": "2019-08-24T14:15:22Z",
  • "AcquisitionMethod": "NewPurchase",
  • "DeploymentDate": "2019-08-24T14:15:22Z",
  • "ResidualValue": 0,
  • "AcquisitionQuantity": 0,
  • "DeductibleVat": 0.1,
  • "AmountIncludingTax": 0.1,
  • "NetAcquisitionValue": 0.1,
  • "NetDeductibleVat": 0.1,
  • "NetAmountIncludingTax": 0.1,
  • "NetAcquisitionQuantity": 0.1,
  • "FixedAssetAccount": {
    },
  • "IsCreatedAutomatically": true,
  • "IsValidatedByUser": true,
  • "Number": 0,
  • "ExternalId": "string",
  • "GeographicalLocation": {
    },
  • "QuantityDetails": {
    },
  • "Retirement": {
    },
  • "Status": "Unknown",
  • "Nature": "Aucun",
  • "ComponentGroup": {
    },
  • "ComponentType": "Unknown",
  • "PreviousAccountDetails": {
    },
  • "DecompositionDate": "2019-08-24T14:15:22Z",
  • "Amortization": {
    },
  • "VehicleProperties": {
    },
  • "AssociationState": {
    },
  • "AccountingEntryLines": [
    ],
  • "IsAmortizable": true,
  • "Grants": [
    ],
  • "CreditNotes": [
    ],
  • "AvailableQuantity": 0,
  • "Errors": [
    ],
  • "HasAnyProspectiveRevision": true,
  • "AmortizationDefaults": {
    }
}

Deletes a specific amortization configuration from a fixed asset, removing its amortization schedule and calculations.

Deleting an amortization configuration affects all related amortization calculations and may impact accounting entries. This operation should be used with caution, particularly for assets with existing accounting history.

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

The unique identifier of the accounting folder (Dossier) containing the asset.

assetId
required
integer <int32>

The unique identifier of the asset from which to delete the amortization.

amortizationId
required
integer <int32>

The unique identifier of the amortization configuration to delete.

Responses

FixedAssetReport

Retrieves the APEF (Association Pour l'Emploi dans l'Industrie et le Commerce) aggregate report for fixed assets within a specified date range.

This report aggregates fixed asset data according to APEF standards for regulatory reporting purposes. The period must have valid start and end dates to generate accurate aggregate values.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The unique identifier of the accounting folder (Dossier) for which to generate the APEF report.

query Parameters
startDate
required
string <date-time>

The start date of the reporting period, must be earlier than or equal to endDate.

endDate
required
string <date-time>

The end date of the reporting period, must be later than or equal to startDate.

Responses

Response samples

Content type
{
  • "Assets": [
    ],
  • "Grants": [
    ]
}

Creates or updates the acquisition report configuration settings for a specific accounting folder.

This configuration controls how acquisition reports are generated, including account grouping preferences. The configuration persists and applies to all future acquisition reports for this folder.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The unique identifier of the accounting folder (Dossier) to configure.

Request Body schema:

The configuration data containing account grouping rules and display preferences for the acquisition report.

AccountsGrouping
Array of strings or null

Responses

Request samples

Content type
{
  • "AccountsGrouping": [
    ]
}

Creates or updates the retirement report configuration settings for a specific accounting folder.

This configuration controls how retirement (disposal and sale) reports are generated, including account grouping preferences. The configuration persists and applies to all future retirement reports for this folder.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The unique identifier of the accounting folder (Dossier) to configure.

Request Body schema:

The configuration data containing account grouping rules and display preferences for the retirement report.

AccountsGrouping
Array of strings or null

Responses

Request samples

Content type
{
  • "AccountsGrouping": [
    ]
}

Creates or updates the forecast report configuration settings for a specific accounting folder.

This configuration controls how forecast reports are generated, including account grouping preferences. The configuration persists and applies to all future forecast reports for this folder.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The unique identifier of the accounting folder (Dossier) to configure.

Request Body schema:

The configuration data containing account grouping rules and display preferences for the forecast report.

AccountsGrouping
Array of strings or null

Responses

Request samples

Content type
{
  • "AccountsGrouping": [
    ]
}

Retrieves the complete fixed asset report configuration for a specific accounting folder.

Returns all configured settings for acquisitions, retirements, and forecast reports. If no configuration exists for the folder, default settings are returned.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The unique identifier of the accounting folder (Dossier) for which to retrieve the configuration.

Responses

Response samples

Content type
{
  • "AcquisitionsReportConfiguration": {
    },
  • "RetirementsReportConfiguration": {
    },
  • "ForecastsReportConfiguration": {
    }
}

Retrieves the grants table summarizing investment grants and subsidies for a specific period.

The grants table includes grant amounts, amortization schedules, and remaining balances for all active grants. Only grants with activity within the specified period or with remaining balances are included.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The unique identifier of the accounting folder (Dossier) for which to retrieve the grants table.

query Parameters
periodBeginDate
string <date-time>

The start date of the reporting period, must be earlier than or equal to periodEndDate.

periodEndDate
string <date-time>

The end date of the reporting period, must be later than or equal to periodBeginDate.

Responses

Response samples

Content type
{
  • "AllGrants": [
    ]
}

Exports the grants table for a specific period to a downloadable file in the requested format.

The export includes all grant details and can optionally include extended information based on the withDetails flag. The generated file is temporarily stored and accessed via the returned URL.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The unique identifier of the accounting folder (Dossier) for which to export the grants table.

query Parameters
periodBeginDate
string <date-time>

The start date of the reporting period, must be earlier than or equal to periodEndDate.

periodEndDate
string <date-time>

The end date of the reporting period, must be later than or equal to periodBeginDate.

withDetails
boolean
Default: false

Indicates whether to include detailed breakdown information in the export.

exportType
string
Default: "Pdf"
Enum: "Html" "Pdf" "Csv" "Excel" "Inqom"

The desired file format for the export; valid values include Pdf, Csv, Excel.

Responses

Response samples

Content type
"string"

Retrieves the comparison table showing economic versus fiscal amortization differences for the specified period.

This table compares economic and fiscal amortization values to identify derogatory amortization amounts. The comparison is essential for tax reporting and reconciliation purposes.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The unique identifier of the accounting folder (Dossier) for which to retrieve the comparison table.

query Parameters
periodBeginDate
string <date-time>

The start date of the reporting period, must be earlier than or equal to periodEndDate.

periodEndDate
string <date-time>

The end date of the reporting period, must be later than or equal to periodBeginDate.

Responses

Response samples

Content type
{
  • "Period": {
    },
  • "Categories": [
    ],
  • "ContainsPastAmortization": true,
  • "IsEmpty": true
}

Exports the comparison table showing economic versus fiscal amortization differences to a downloadable file.

The export includes all comparison data with economic, fiscal, and derogatory amortization values. The generated file is temporarily stored and accessed via the returned URL.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The unique identifier of the accounting folder (Dossier) for which to export the comparison table.

query Parameters
periodBeginDate
string <date-time>

The start date of the reporting period, must be earlier than or equal to periodEndDate.

periodEndDate
string <date-time>

The end date of the reporting period, must be later than or equal to periodBeginDate.

exportType
string
Default: "Pdf"
Enum: "Html" "Pdf" "Csv" "Excel" "Inqom"

The desired file format for the export; valid values include Pdf, Csv, Excel.

Responses

Response samples

Content type
"string"

Retrieves the comprehensive fixed asset list report including economic, fiscal, and derogatory amortization details for the specified period.

This report includes all active assets within the period with their complete amortization information. Assets are grouped by account class and include both current and cumulative amortization values.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The unique identifier of the accounting folder (Dossier) for which to retrieve the asset list.

query Parameters
periodBeginDate
string <date-time>

The start date of the reporting period, must be earlier than or equal to periodEndDate.

periodEndDate
string <date-time>

The end date of the reporting period, must be later than or equal to periodBeginDate.

Responses

Response samples

Content type
{
  • "Economic": {
    },
  • "Fiscal": {
    },
  • "Derogatory": {
    },
  • "IsEmpty": true
}

Retrieves the asset list table with analytics for the specified date range.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema:
required
StartDate
required
string <date-time>
EndDate
required
string <date-time>
TagIds
Array of integers or null <int32> non-empty [ items <int32 > ]

Responses

Request samples

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

Response samples

Content type
{
  • "Groups": {
    }
}

Export the asset list table with analytics for the specified date range.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
query Parameters
exportType
string
Default: "Pdf"
Enum: "Html" "Pdf" "Csv" "Excel" "Inqom"
Request Body schema:
required
StartDate
required
string <date-time>
EndDate
required
string <date-time>
TagIds
Array of integers or null <int32> non-empty [ items <int32 > ]

Responses

Request samples

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

Response samples

Content type
"string"

Exports the comprehensive fixed asset list report to a downloadable file in the requested format.

The export includes all assets with economic, fiscal, and derogatory amortization details. The generated document is formatted in landscape orientation for optimal readability.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The unique identifier of the accounting folder (Dossier) for which to export the asset list.

query Parameters
periodBeginDate
string <date-time>

The start date of the reporting period, must be earlier than or equal to periodEndDate.

periodEndDate
string <date-time>

The end date of the reporting period, must be later than or equal to periodBeginDate.

exportType
string
Default: "Pdf"
Enum: "Html" "Pdf" "Csv" "Excel" "Inqom"

The desired file format for the export; valid values include Pdf, Csv, Excel.

Responses

Response samples

Content type
"string"

Retrieves the acquisitions table (version 2) showing all fixed assets acquired within the specified date range with detailed accounting information.

This enhanced version includes improved grouping and categorization of acquired assets. Assets are organized by account classification and include acquisition values and initial amortization data.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The unique identifier of the accounting folder (Dossier) for which to retrieve the acquisitions table.

query Parameters
startDate
required
string <date-time>

The start date of the acquisition period, must be earlier than or equal to endDate.

endDate
required
string <date-time>

The end date of the acquisition period, must be later than or equal to startDate.

Responses

Response samples

Content type
{
  • "AllCategories": [
    ],
  • "Total": {
    }
}

Exports the acquisitions table (version 2) to a downloadable file in the requested format.

The export includes all assets acquired within the specified period with complete acquisition and amortization details. The generated file is temporarily stored and accessed via the returned URL.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The unique identifier of the accounting folder (Dossier) for which to export the acquisitions table.

query Parameters
exportType
required
string
Enum: "Html" "Pdf" "Csv" "Excel" "Inqom"

The desired file format for the export; valid values include Pdf, Csv, Excel.

startDate
required
string <date-time>

The start date of the acquisition period, must be earlier than or equal to endDate.

endDate
required
string <date-time>

The end date of the acquisition period, must be later than or equal to startDate.

Responses

Response samples

Content type
"string"

Retrieves a specific section of the acquisitions table for document composition or partial report generation.

This endpoint returns a formatted section suitable for integration into larger financial documents. The section includes acquisition data structured for direct document assembly.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The unique identifier of the accounting folder (Dossier) for which to retrieve the acquisitions table section.

query Parameters
startDate
required
string <date-time>

The start date of the acquisition period in UTC format, must be earlier than or equal to endDate.

endDate
required
string <date-time>

The end date of the acquisition period in UTC format, must be later than or equal to startDate.

Responses

Response samples

Content type
"string"

Retrieves the retirements table showing all fixed assets retired within the specified date range with gain or loss calculations.

This table includes both disposal and sale retirements with detailed gain/loss analysis. Retirement values, net book values, and fiscal impacts are calculated and categorized.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The unique identifier of the accounting folder (Dossier) for which to retrieve the retirements table.

query Parameters
startDate
required
string <date-time>

The start date of the retirement period, must be earlier than or equal to endDate.

endDate
required
string <date-time>

The end date of the retirement period, must be later than or equal to startDate.

Responses

Response samples

Content type
{
  • "AllCategories": [
    ],
  • "Total": {
    }
}

Retrieves the retirements table with analytics showing all fixed assets retired within the specified date range with gain or loss calculations.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema:
StartDate
required
string <date-time>
EndDate
required
string <date-time>
TagIds
Array of integers or null <int32> non-empty [ items <int32 > ]

Responses

Request samples

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

Response samples

Content type
{
  • "AssetAnalyticsAxisViewModels": [
    ]
}

Exports the retirements (disposals) table to a downloadable file in the requested format.

The export includes all retired assets with complete retirement details, gain/loss calculations, and fiscal impacts. The generated file is temporarily stored and accessed via the returned URL.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The unique identifier of the accounting folder (Dossier) for which to export the retirements table.

query Parameters
exportType
required
string
Enum: "Html" "Pdf" "Csv" "Excel" "Inqom"

The desired file format for the export; valid values include Pdf, Csv, Excel.

startDate
required
string <date-time>

The start date of the retirement period, must be earlier than or equal to endDate.

endDate
required
string <date-time>

The end date of the retirement period, must be later than or equal to startDate.

Responses

Response samples

Content type
"string"

Retrieves a specific section of the retirements table for document composition or partial report generation.

This endpoint returns a formatted section suitable for integration into larger financial documents. The section includes retirement data with gain/loss details structured for direct document assembly.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The unique identifier of the accounting folder (Dossier) for which to retrieve the retirements table section.

query Parameters
startDate
required
string <date-time>

The start date of the retirement period in UTC format, must be earlier than or equal to endDate.

endDate
required
string <date-time>

The end date of the retirement period in UTC format, must be later than or equal to startDate.

Responses

Response samples

Content type
"string"

Retrieves a filtered list of assets acquired within the specified period with detailed acquisition information.

This legacy endpoint provides acquisition data in the original format for backward compatibility. Only assets with acquisition dates within the specified period are included in the results.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The unique identifier of the accounting folder (Dossier) for which to retrieve acquired assets.

query Parameters
periodBeginDate
string <date-time>

The start date of the acquisition period, must be earlier than or equal to periodEndDate.

periodEndDate
string <date-time>

The end date of the acquisition period, must be later than or equal to periodBeginDate.

Responses

Response samples

Content type
{
  • "Economic": {
    },
  • "Fiscal": {
    },
  • "Derogatory": {
    },
  • "IsEmpty": true
}

Exports the list of assets acquired within the specified period to a downloadable file.

This legacy export format provides backward compatibility with existing report consumers. The generated file is temporarily stored and accessed via the returned URL.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The unique identifier of the accounting folder (Dossier) for which to export acquired assets.

query Parameters
periodBeginDate
string <date-time>

The start date of the acquisition period, must be earlier than or equal to periodEndDate.

periodEndDate
string <date-time>

The end date of the acquisition period, must be later than or equal to periodBeginDate.

exportType
string
Default: "Pdf"
Enum: "Html" "Pdf" "Csv" "Excel" "Inqom"

The desired file format for the export; valid values include Pdf, Csv, Excel.

Responses

Response samples

Content type
"string"

Retrieves a filtered list of assets retired within the specified period with retirement details and financial impacts.

This legacy endpoint provides retirement data in the original format for backward compatibility. Retired assets are aggregated to show net book values and gain/loss calculations at retirement date.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The unique identifier of the accounting folder (Dossier) for which to retrieve retired assets.

query Parameters
periodBeginDate
string <date-time>

The start date of the retirement period, must be earlier than or equal to periodEndDate.

periodEndDate
string <date-time>

The end date of the retirement period, must be later than or equal to periodBeginDate.

Responses

Response samples

Content type
{
  • "Economic": {
    },
  • "Fiscal": {
    },
  • "Derogatory": {
    },
  • "IsEmpty": true
}

Retrieves a filtered list of retired assets with analytics within the specified date range with gain or loss calculations.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema:
required
StartDate
required
string <date-time>
EndDate
required
string <date-time>
TagIds
Array of integers or null <int32> non-empty [ items <int32 > ]

Responses

Request samples

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

Response samples

Content type
{
  • "Groups": {
    }
}

Retrieves a filtered list of acquired assets with analytics within the specified date range

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema:
required
StartDate
required
string <date-time>
EndDate
required
string <date-time>
TagIds
Array of integers or null <int32> non-empty [ items <int32 > ]

Responses

Request samples

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

Response samples

Content type
{
  • "Groups": {
    }
}

Exports the list of assets retired within the specified period to a downloadable file.

This legacy export format provides backward compatibility with existing report consumers. The generated file is temporarily stored and accessed via the returned URL.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The unique identifier of the accounting folder (Dossier) for which to export retired assets.

query Parameters
periodBeginDate
string <date-time>

The start date of the retirement period, must be earlier than or equal to periodEndDate.

periodEndDate
string <date-time>

The end date of the retirement period, must be later than or equal to periodBeginDate.

exportType
string
Default: "Pdf"
Enum: "Html" "Pdf" "Csv" "Excel" "Inqom"

The desired file format for the export; valid values include Pdf, Csv, Excel.

Responses

Response samples

Content type
"string"

Retrieves a filtered list of assets that will be active during future forecast periods with projected amortization values. Deprecated

This endpoint is obsolete and maintained only for backward compatibility; use the V2 forecast endpoint instead. Assets are filtered to show only those that will remain active and subject to amortization in future periods.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The unique identifier of the accounting folder (Dossier) for which to retrieve forecast assets.

query Parameters
periodBeginDate
string <date-time>

The start date of the forecast period, must be earlier than or equal to periodEndDate.

periodEndDate
string <date-time>

The end date of the forecast period, must be later than or equal to periodBeginDate.

Responses

Response samples

Content type
{
  • "Economic": {
    },
  • "Fiscal": {
    },
  • "Derogatory": {
    },
  • "IsEmpty": true
}

Exports the list of forecast assets with projected amortization values to a downloadable file. Deprecated

This endpoint is obsolete and maintained only for backward compatibility; use the V2 forecast export endpoint instead. The generated file is temporarily stored and accessed via the returned URL.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The unique identifier of the accounting folder (Dossier) for which to export forecast assets.

query Parameters
periodBeginDate
string <date-time>

The start date of the forecast period, must be earlier than or equal to periodEndDate.

periodEndDate
string <date-time>

The end date of the forecast period, must be later than or equal to periodBeginDate.

exportType
string
Default: "Pdf"
Enum: "Html" "Pdf" "Csv" "Excel" "Inqom"

The desired file format for the export; valid values include Pdf, Csv, Excel.

Responses

Response samples

Content type
"string"

Retrieves the over-amortization report identifying assets with excessive amortization compared to fiscal limits.

This report highlights assets where economic amortization exceeds fiscally deductible amounts. Over-amortization must be tracked separately for tax reporting and compliance purposes.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The unique identifier of the accounting folder (Dossier) for which to retrieve the over-amortization report.

query Parameters
startDate
string <date-time>

The start date of the reporting period, must be earlier than or equal to endDate.

endDate
string <date-time>

The end date of the reporting period, must be later than or equal to startDate.

Responses

Response samples

Content type
{
  • "Rows": [
    ],
  • "Total": {
    }
}

Retrieves the tax deductibility limit report showing assets subject to amortization caps for tax purposes.

This report identifies vehicles and other assets with statutory limits on tax-deductible amortization. Deductibility limits vary by asset type and must be calculated according to current tax regulations.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The unique identifier of the accounting folder (Dossier) for which to retrieve the tax deductibility report.

query Parameters
startDate
string <date-time>

The start date of the reporting period, must be earlier than or equal to endDate.

endDate
string <date-time>

The end date of the reporting period, must be later than or equal to startDate.

Responses

Response samples

Content type
{
  • "Rows": [
    ],
  • "Total": {
    }
}

Retrieves fixed asset categories with their value ranges (minimum and maximum amounts) for the specified period.

This endpoint provides category boundaries useful for financial analysis and statistical reporting. Categories are defined by account classification and include aggregate value ranges for all contained assets.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The unique identifier of the accounting folder (Dossier) for which to retrieve categories with ranges.

query Parameters
periodBeginDate
string <date-time>

The start date of the reporting period, must be earlier than or equal to periodEndDate.

periodEndDate
string <date-time>

The end date of the reporting period, must be later than or equal to periodBeginDate.

Responses

Response samples

Content type
[
  • {
    }
]

Retrieves the gain or loss report detailing financial results from asset sales and disposals for the specified period.

This report calculates short-term and long-term capital gains and losses on retired assets. Gain/loss classification follows tax regulations and affects taxable income calculations.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The unique identifier of the accounting folder (Dossier) for which to retrieve the gain or loss report.

query Parameters
periodStart
required
string <date-time>

The start date of the reporting period, must be earlier than or equal to periodEnd.

periodEnd
required
string <date-time>

The end date of the reporting period, must be later than or equal to periodStart.

Responses

Response samples

Content type
{
  • "Rows": [
    ]
}

Retrieves the forecast table (version 2) showing projected amortization values for active assets in future periods.

This enhanced forecast provides improved accuracy for planning and budgeting purposes. Projections include economic, fiscal, and derogatory amortization for all active assets.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The unique identifier of the accounting folder (Dossier) for which to retrieve the forecast table.

query Parameters
startDate
required
string <date-time>

The start date of the forecast period, must be earlier than or equal to endDate.

endDate
required
string <date-time>

The end date of the forecast period, must be later than or equal to startDate.

numberOfYears
integer <int32>
Default: 5

Number of forecast years to display (default: 5 years)

Responses

Response samples

Content type
{
  • "DotationYears": [
    ],
  • "Groups": {
    }
}

Retrieves the inventory table listing all assets active or retired within the specified period.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The unique identifier of the accounting folder (Dossier) for which to retrieve the inventory table.

query Parameters
startDate
required
string <date-time>

The start date of the inventory period, must be earlier than or equal to endDate.

endDate
required
string <date-time>

The end date of the inventory period, must be later than or equal to startDate.

Responses

Response samples

Content type
{
  • "AllCategories": [
    ],
  • "Total": {
    }
}

Exports the inventory table to a downloadable file.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The unique identifier of the accounting folder (Dossier) for which to export the inventory table.

query Parameters
exportType
required
string
Enum: "Html" "Pdf" "Csv" "Excel" "Inqom"

The desired file format for the export; valid values include Pdf, Csv, Excel.

startDate
required
string <date-time>

The start date of the inventory period, must be earlier than or equal to endDate.

endDate
required
string <date-time>

The end date of the inventory period, must be later than or equal to startDate.

Responses

Response samples

Content type
"string"

Retrieves the forecast table with analytics for the specified date range.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema:
StartDate
required
string <date-time>
EndDate
required
string <date-time>
TagIds
Array of integers or null <int32> non-empty [ items <int32 > ]
NumberOfYears
integer or null <int32>

Responses

Request samples

Content type
{
  • "StartDate": "2019-08-24T14:15:22Z",
  • "EndDate": "2019-08-24T14:15:22Z",
  • "TagIds": [
    ],
  • "NumberOfYears": 0
}

Response samples

Content type
{
  • "DotationYears": [
    ],
  • "Groups": {
    }
}

Exports the forecast table with analytics for the specified date range.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
query Parameters
exportType
string
Default: "Pdf"
Enum: "Html" "Pdf" "Csv" "Excel" "Inqom"
Request Body schema:
required
StartDate
required
string <date-time>
EndDate
required
string <date-time>
TagIds
Array of integers or null <int32> non-empty [ items <int32 > ]
NumberOfYears
integer or null <int32>

Responses

Request samples

Content type
{
  • "StartDate": "2019-08-24T14:15:22Z",
  • "EndDate": "2019-08-24T14:15:22Z",
  • "TagIds": [
    ],
  • "NumberOfYears": 0
}

Response samples

Content type
"string"

Exports the forecast table (version 2) with projected amortization values to a downloadable file.

The export includes all active assets with projected economic, fiscal, and derogatory amortization. The generated file is temporarily stored and accessed via the returned URL.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The unique identifier of the accounting folder (Dossier) for which to export the forecast table.

query Parameters
exportType
required
string
Enum: "Html" "Pdf" "Csv" "Excel" "Inqom"

The desired file format for the export; valid values include Pdf, Csv, Excel.

startDate
required
string <date-time>

The start date of the forecast period, must be earlier than or equal to endDate.

endDate
required
string <date-time>

The end date of the forecast period, must be later than or equal to startDate.

numberOfYears
integer <int32>
Default: 5

Number of forecast years to display (default: 5 years)

Responses

Response samples

Content type
"string"

Retrieves a specific section of the forecast table for a particular amortization type for document composition.

This endpoint returns a formatted section filtered by amortization type (Economic, Fiscal, or Derogatory). The section is structured for direct integration into larger financial documents.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The unique identifier of the accounting folder (Dossier) for which to retrieve the forecast table section.

query Parameters
startDate
required
string <date-time>

The start date of the forecast period in UTC format, must be earlier than or equal to endDate.

endDate
required
string <date-time>

The end date of the forecast period in UTC format, must be later than or equal to startDate.

amortizationType
required
string
Enum: "Economic" "Fiscal" "Derogatory"

The specific amortization type to include in the section; valid values are Economic, Fiscal, or Derogatory.

numberOfYears
integer <int32>
Default: 5

Number of forecast years to display (default: 5 years)

Responses

Response samples

Content type
"string"

Exports a simulation report showing mini-maxi amortization scenarios for tax optimization planning.

This simulation helps determine optimal amortization strategies by comparing minimum and maximum allowable amounts. The report is useful for tax planning and includes projected impacts on taxable income.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The unique identifier of the accounting folder (Dossier) for which to export the mini-maxi simulation.

query Parameters
exportType
required
string
Enum: "Html" "Pdf" "Csv" "Excel" "Inqom"

The desired file format for the export; valid values include Pdf, Csv, Excel.

startDate
required
string <date-time>

The start date of the simulation period, must be earlier than or equal to endDate.

endDate
required
string <date-time>

The end date of the simulation period, must be later than or equal to startDate.

Responses

Response samples

Content type
{
  • "Filename": "string",
  • "Url": "string"
}

Retrieves a specific section of the inventory table for document composition or partial report generation.

This endpoint returns a formatted section suitable for integration into larger financial documents. The section includes inventory data structured for direct document assembly.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The unique identifier of the accounting folder (Dossier) for which to retrieve the inventory table section.

query Parameters
startDate
required
string <date-time>

The start date of the inventory period in UTC format, must be earlier than or equal to endDate.

endDate
required
string <date-time>

The end date of the inventory period in UTC format, must be later than or equal to startDate.

Responses

Response samples

Content type
"string"

GeographicalLocation

Retrieves all available geographical locations defined for a specific accounting folder.

Geographical locations help organize and track fixed assets by physical location. Locations are used for asset categorization, reporting, and inventory management.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The unique identifier of the accounting folder (Dossier) for which to retrieve geographical locations.

Responses

Response samples

Content type
[
  • {
    }
]

Creates a new geographical location for organizing fixed assets by physical location.

The location name must be unique within the accounting folder. Once created, the location can be assigned to one or more fixed assets.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The unique identifier of the accounting folder (Dossier) in which to create the geographical location.

Request Body schema:
required

The location data containing the unique location name or identifier.

Location
required
string

Responses

Request samples

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

Response samples

Content type
{
  • "Id": 0,
  • "Location": "string"
}

Grant

Retrieves all investment grants and subsidies for a specific accounting folder.

Returns the complete list of grants including active grants with remaining balances and fully amortized grants. Each grant includes account information, total and available amounts, and past grant history if applicable.

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

The unique identifier of the accounting folder (Dossier) for which to retrieve grants.

Responses

Response samples

Content type
[
  • {
    }
]

Creates a new investment grant or subsidy for tracking alongside fixed assets.

The grant must reference a valid grant account and can include past amortization data for historical grants. Total amount must be positive and the grant date determines the start of amortization.

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

The unique identifier of the accounting folder (Dossier) in which to create the grant.

Request Body schema:
required

The grant data including name, account, amount, date, funder, and optional past grant information.

Name
string or null
object (AccountCommand)
Amount
required
number <decimal>
GrantDate
required
string <date-time>
Funder
string or null
object (PastGrantCommand)

Responses

Request samples

Content type
{
  • "Name": "string",
  • "Account": {
    },
  • "Amount": 0,
  • "GrantDate": "2019-08-24T14:15:22Z",
  • "Funder": "string",
  • "PastGrant": {
    }
}

Response samples

Content type
{
  • "Id": 0,
  • "Name": "string",
  • "Account": {
    },
  • "TotalAmount": 0,
  • "AvailableAmount": 0,
  • "GrantDate": "2019-08-24T14:15:22Z",
  • "Funder": "string",
  • "PastGrant": {
    },
  • "AccountingFolderId": 0
}

Retrieves a specific investment grant by its unique identifier.

Returns detailed information about a single grant including allocation history and remaining balance.

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

The unique identifier of the accounting folder (Dossier) containing the grant.

grantId
required
integer <int32>

The unique identifier of the grant to retrieve.

Responses

Response samples

Content type
{
  • "Id": 0,
  • "Name": "string",
  • "Account": {
    },
  • "TotalAmount": 0,
  • "AvailableAmount": 0,
  • "GrantDate": "2019-08-24T14:15:22Z",
  • "Funder": "string",
  • "PastGrant": {
    },
  • "AccountingFolderId": 0
}

Updates an existing investment grant with new information.

All grant properties can be modified except those already allocated to assets. Changing the grant amount may affect available balance for future asset allocations.

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

The unique identifier of the accounting folder (Dossier) containing the grant.

grantId
required
integer <int32>

The unique identifier of the grant to update.

Request Body schema:
required

The updated grant data including name, account, amount, date, funder, and optional past grant information.

Name
string or null
object (AccountCommand)
Amount
required
number <decimal>
GrantDate
required
string <date-time>
Funder
string or null
object (PastGrantCommand)

Responses

Request samples

Content type
{
  • "Name": "string",
  • "Account": {
    },
  • "Amount": 0,
  • "GrantDate": "2019-08-24T14:15:22Z",
  • "Funder": "string",
  • "PastGrant": {
    }
}

Response samples

Content type
{
  • "Id": 0,
  • "Name": "string",
  • "Account": {
    },
  • "TotalAmount": 0,
  • "AvailableAmount": 0,
  • "GrantDate": "2019-08-24T14:15:22Z",
  • "Funder": "string",
  • "PastGrant": {
    },
  • "AccountingFolderId": 0
}

Deletes an investment grant from the accounting folder.

A grant can only be deleted if it has not been allocated to any assets. Grants with existing allocations must have those allocations removed before deletion.

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

The unique identifier of the accounting folder (Dossier) containing the grant.

grantId
required
integer <int32>

The unique identifier of the grant to delete.

Responses

Retrieves the list of available accounting accounts that can be used for grant accounting.

Returns accounts filtered by the specified grant account kind (FixedAsset for equipment grants). Only accounts active at the optional start date are included in the results.

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

The unique identifier of the accounting folder (Dossier) for which to retrieve available accounts.

query Parameters
accountKind
string
Enum: "Unknown" "FixedAsset"

The type of grant account to filter; valid values include FixedAsset for investment grants.

startDate
string or null <date-time>

Optional date to filter accounts that are active at the specified date.

Responses

Response samples

Content type
[
  • {
    }
]

Imports investment grants from an external file in supported formats (Agiris or SAV Cegid).

The import process validates grant data and can include past amortization history. Any validation errors are returned in the summary without creating the grants. Maximum file size is 100 MB and supported formats are determined by the provider parameter.

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

The unique identifier of the accounting folder (Dossier) into which to import grants.

query Parameters
pastGrantDate
string or null <date-time>

Optional date representing the end of past grant amortization period for historical data.

provider
string
Enum: "Inqom" "Cegid" "Quadra" "Coala" "Sage" "Acd" "Agiris"

The import file format provider; valid values include Agiris and Cegid.

Request Body schema: multipart/form-data
attachmentFile
string or null <binary>

The file containing grant data to import, must not exceed 100 MB.

Responses

Response samples

Content type
{
  • "ImportedCount": 0,
  • "Errors": [
    ]
}

MicroToReal

Get the revaluation table of assets for the micro to real regime transition.

Returns a paginated, filterable, sortable list of active assets on amortizable accounts (1 row per individual component for decomposed assets), with pre-filled theoretical NBV and remaining duration ready to be adjusted.

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
query Parameters
transitionDate
required
string <date-time>
search
string or null
page
integer or null <int32>
limit
integer or null <int32>
sortBy
string or null
Enum: "Name" "AcquisitionDate" "AcquisitionValue" "TheoreticalNetValue" "RemainingDuration"
sortDirection
string or null
Enum: "Asc" "Desc"

Responses

Response samples

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

MiniMaxi

Saves the mini-maxi amortization configuration for assets in the specified accounting folder for a given period.

The mini-maxi approach allows choosing between minimum, maximum, or intermediate amortization amounts for tax optimization. The selected strategy applies to all applicable assets within the specified period. Mini and maxi values represent the allowed range, while intermediate allows custom positioning within that range.

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

The unique identifier of the accounting folder (Dossier) for which to configure mini-maxi amortization.

Request Body schema:
required

The mini-maxi configuration including period dates, strategy type (Mini, Maxi, or Intermediate), and value thresholds.

StartDate
required
string <date-time>
EndDate
required
string <date-time>
MiniMaxiType
required
string
Enum: "Maxi" "Mini" "Intermediate"
IntermediateValue
number or null <double>
MiniValue
required
number <decimal>
MaxiValue
required
number <decimal>
AssetIds
Array of integers or null <int32> [ items <int32 > ]

Responses

Request samples

Content type
{
  • "StartDate": "2019-08-24T14:15:22Z",
  • "EndDate": "2019-08-24T14:15:22Z",
  • "MiniMaxiType": "Maxi",
  • "IntermediateValue": 0.1,
  • "MiniValue": 0,
  • "MaxiValue": 0,
  • "AssetIds": [
    ]
}

Retrieves the current mini-maxi amortization configuration for assets in the specified accounting folder and period.

Returns the configured mini-maxi strategy including minimum and maximum allowable amortization amounts. The configuration shows the current applied strategy and values for the specified period.

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

The unique identifier of the accounting folder (Dossier) for which to retrieve mini-maxi configuration.

query Parameters
startDate
required
string <date-time>

The start date of the period for which to retrieve the mini-maxi configuration.

endDate
required
string <date-time>

The end date of the period for which to retrieve the mini-maxi configuration.

Responses

Response samples

Content type
{
  • "AccountingFolderId": 0,
  • "MiniMaxiType": "Maxi",
  • "MiniValue": 0,
  • "MaxiValue": 0,
  • "IntermediateValue": 0.1,
  • "AssetIds": [
    ]
}

Simulates mini-maxi amortization scenarios for the nth period to evaluate tax optimization options.

The simulation calculates the impact of different mini-maxi strategies without applying them. Results show minimum, maximum, and intermediate amortization amounts and their effects on net book values. This allows evaluation of tax implications before committing to a specific strategy.

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

The unique identifier of the accounting folder (Dossier) for which to simulate mini-maxi scenarios.

query Parameters
startDate
required
string <date-time>

The start date of the period for which to simulate mini-maxi amortization.

endDate
required
string <date-time>

The end date of the period for which to simulate mini-maxi amortization.

Responses

Response samples

Content type
{
  • "Exercices": [
    ]
}