Assets | Asset
The Financial Asset represents the accounting data of an asset.
This service extends Assets.
Overview
URL | api/{tenantKey}/{orgKey}/assetsCore/financialAssets |
Methods Supported | GET, POST, PUT, DELETE |
All Operations
This service includes the following operations:
- GET:
- POST:
-
PUT:
- PUT Set Custom Attribute FinancialAsset
- PUT Set IsActive FinancialAsset
- PUT Set AssetClass FinancialAsset
- PUT Set IsAssetClassChanged FinancialAsset
- PUT Set PropertyType FinancialAsset
- PUT Set CalculateDepreciation FinancialAsset
- PUT Set ScrapValue FinancialAsset
- PUT Set IsScrapValueChanged FinancialAsset
- PUT Set PreviousScrapValue FinancialAsset
- PUT Set User FinancialAsset
- PUT Set Status FinancialAsset
- PUT Set Currency FinancialAsset
- PUT Set AssetGroup FinancialAsset
- PUT Set ApiImportKey FinancialAsset
- PUT Set Dimension FinancialAssetDimension
- PUT Set DimensionValue FinancialAssetDimension
- DELETE:
All Resources
This service uses the following resources:
- ApiBaseFinancialAssetEntityDimensionDetailsResource
- ApiBaseFinancialAssetResource
- ApiFinancialAssetEntityDimensionDetailsResource
- ApiFinancialAssetResource
- BaseFinancialAssetEntityDimensionDetailsResource
- BaseFinancialAssetResource
- FinancialAssetDimensionResource
- FinancialAssetResource
- MoneyResource
- ExtensibilityCustomAttributeValueResource
All Enumerations
This service uses the following enumerations:
GET FinancialAssets
Returns the list of all the entity records available.
Response:
When successful, the response body contains the list of records available. See FinancialAssetResource. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET FinancialAssets (paged)
Returns a page of the list of all the entity records available.
The following elements are optional:
page | (int) The index of the page of the list that should be returned. This is a query string parameter. |
pageSize | (int) The number of page elements that should be returned (max. is 1000). This is a query string parameter. |
Response:
When successful, the response body contains the list of records available. See FinancialAssetResource. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET FinancialAsset by identifier
Returns the entity record that matches the specified identifier.
The following elements are required:
id | (string) The record identifier. |
Response:
When successful, the response body contains the entity record. See FinancialAssetResource. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
404 | NotFound. The specified record does not exist. |
Resource URL:
GET FinancialAsset by key
Returns the entity record that matches the specified key.
The following elements are required:
assetKey | (string) The asset key. |
Response:
When successful, the response body contains the entity record. See FinancialAssetResource. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
404 | NotFound. The specified record does not exist. |
Resource URL:
GET FinancialAssets (with Asset)
Returns the list of all the entity records available. Each record contains both data from the entity and the base entity.
Response:
When successful, the response body contains the list of records available. See BaseFinancialAssetResource. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET FinancialAssets (with Asset) (paged)
Returns a page of the list of all the entity records available. Each record contains both data from the entity and the base entity.
The following elements are optional:
page | (int) The index of the page of the list that should be returned. This is a query string parameter. |
pageSize | (int) The number of page elements that should be returned (max. is 1000). This is a query string parameter. |
Response:
When successful, the response body contains the list of records available. See BaseFinancialAssetResource. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET FinancialAsset (with Asset) by identifier
Returns the entity record that matches the specified identifier. The record contains both data from the entity and the base entity.
The following elements are required:
id | (string) The record identifier. |
Response:
When successful, the response body contains the entity record. See BaseFinancialAssetResource. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
404 | NotFound. The specified record does not exist. |
Resource URL:
GET FinancialAsset (with Asset) by key
Returns the entity record that matches the specified key. The record contains both data from the entity and the base entity.
The following elements are required:
assetKey | (string) The asset key. |
Response:
When successful, the response body contains the entity record. See BaseFinancialAssetResource. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
404 | NotFound. The specified record does not exist. |
Resource URL:
POST FinancialAssets
Creates a new entity record.
The following elements are required:
financialAssetResource | (ApiFinancialAssetResource) The request body should contain the entity record that should be created. See ApiFinancialAssetResource. |
The following elements are optional:
customAttributes | (JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity. The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName". While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required. |
Response:
When successful, the response body contains the new entity record identifier. The resource header location property contains the URL for the new entity record. See ApiFinancialAssetResource. |
Response status codes:
201 | Created. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
POST FinancialAssets (with ApiBaseFinancialAsset)
Creates a new entity record. The record shoud contain both data from the entity and the base entity.
The following elements are required:
financialAssetResource | (ApiFinancialAssetResource) The request body should contain the entity record that should be created. See ApiFinancialAssetResource. |
The following elements are optional:
customAttributes | (JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity. The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName". While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required. |
Response:
When successful, the response body contains the new entity record identifier. The resource header location property contains the URL for the new entity record. See ApiBaseFinancialAssetResource. |
Response status codes:
201 | Created. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
POST Asset
Inserts a new 'Asset Dimension' in the 'Asset'.
The following elements are required:
assetKey | (string) The asset key. |
value | (ApiFinancialAssetEntityDimensionDetailsResource) The ApiFinancialAssetEntityDimensionDetailsResource instance. See ApiFinancialAssetEntityDimensionDetailsResource. |
The following elements are optional:
customAttributes | (JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity. The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName". While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required. |
Response:
When successful, the response body is empty. |
Response status codes:
204 | NoContent. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set ApiImportKey FinancialAsset
Updates the value of attribute 'ApiImportKey' in the specified entity record.
The following elements are required:
assetKey | (string) The asset key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set AssetClass FinancialAsset
Updates the value of attribute 'AssetClass' in the specified entity record.
The following elements are required:
assetKey | (string) The asset key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set AssetGroup FinancialAsset
Updates the value of attribute 'AssetGroup' in the specified entity record.
The following elements are required:
assetKey | (string) The asset key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set CalculateDepreciation FinancialAsset
Updates the value of attribute 'CalculateDepreciation' in the specified entity record.
The following elements are required:
assetKey | (string) The asset key. |
value | (bool) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set Currency FinancialAsset
Updates the value of attribute 'Currency' in the specified entity record.
The following elements are required:
assetKey | (string) The asset key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set Dimension FinancialAssetDimension
Updates the value of attribute 'Dimension' in the specified entity record.
The following elements are required:
assetKey | (string) The asset key. |
lineId | (string) The detail identifier. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set DimensionValue FinancialAssetDimension
Updates the value of attribute 'DimensionValue' in the specified entity record.
The following elements are required:
assetKey | (string) The asset key. |
lineId | (string) The detail identifier. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set IsActive FinancialAsset
Updates the value of attribute 'IsActive' in the specified entity record.
The following elements are required:
assetKey | (string) The asset key. |
value | (bool) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
404 | NotFound. The specified record does not exist. |
Resource URL:
PUT Set IsAssetClassChanged FinancialAsset
Updates the value of attribute 'IsAssetClassChanged' in the specified entity record.
The following elements are required:
assetKey | (string) The asset key. |
value | (bool) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set IsScrapValueChanged FinancialAsset
Updates the value of attribute 'IsScrapValueChanged' in the specified entity record.
The following elements are required:
assetKey | (string) The asset key. |
value | (bool) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set PreviousScrapValue FinancialAsset
Updates the value of attribute 'PreviousScrapValue' in the specified entity record.
The following elements are required:
assetKey | (string) The asset key. |
value | (decimal) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set PropertyType FinancialAsset
Updates the value of attribute 'PropertyType' in the specified entity record.
The following elements are required:
assetKey | (string) The asset key. |
value | (enum PropertyType) The request body should contain the new value for the attribute. See PropertyType. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set ScrapValue FinancialAsset
Updates the value of attribute 'ScrapValue' in the specified entity record.
The following elements are required:
assetKey | (string) The asset key. |
value | (decimal) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set Status FinancialAsset
Updates the value of attribute 'Status' in the specified entity record.
The following elements are required:
assetKey | (string) The asset key. |
value | (enum Status) The request body should contain the new value for the attribute. See Status. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set User FinancialAsset
Updates the value of attribute 'User' in the specified entity record.
The following elements are required:
assetKey | (string) The asset key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set Custom Attribute FinancialAsset
Updates the value of 'CustomAttribute' in the specified entity record.
The following elements are required:
assetKey | (string) The asset key. |
customAttributeName | (string) The custom attribute name. |
value | (ExtensibilityCustomAttributeValueResource) The request body should contain the new value for the custom attribute. See ExtensibilityCustomAttributeValueResource. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
404 | NotFound. The specified record does not exist. |
Resource URL:
DELETE Asset Dimension by identifier
Deletes the entity record that matches the specified identifier.
The following elements are required:
assetKey | (string) The asset key. |
lineId | (string) The line identifier. |
Response:
When successful, the response body is empty. |
Response status codes:
204 | NoContent. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
404 | NotFound. The specified record does not exist. |
Resource URL:
DELETE FinancialAsset by identifier
Deletes the entity record that matches the specified identifier.
The following elements are required:
id | (string) The record identifier. |
Response:
When successful, the response body is empty. |
Response status codes:
204 | Deleted. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
404 | NotFound. The specified record does not exist. |
Resource URL:
DELETE FinancialAsset by key
Deletes the entity record that matches the specified key.
The following elements are required:
assetKey | (string) The asset key. |
Response:
When successful, the response body is empty. |
Response status codes:
204 | Deleted. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
404 | NotFound. The specified record does not exist. |
Resource URL:
Resources
ApiBaseFinancialAssetEntityDimensionDetailsResource
The following elements are required:
dimension | (string) Dimension. |
dimensionValue | (string) The dimension value. |
ApiBaseFinancialAssetResource
The following elements are required:
assetClass | (string) The class where asset bellongs. |
isAssetClassChanged | (bool) Check if asset class has been changed. |
propertyType | (enum PropertyType) The ownership type of the asset.
See PropertyType. |
calculateDepreciation | (bool) Select if the asset calculate depreciation. |
scrapValue | (MoneyResource) The remaining value of the asset at the end of usefull life.
See MoneyResource . |
isScrapValueChanged | (bool) Check if asset scrap value has been changed. |
previousScrapValue | (decimal) Scrap value previous of update. |
status | (enum Status) Status of the asset.
See Status. |
currency | (string) Currency of the Scrap Value. |
assetKey | (string) The asset key. |
company | (string) The company that owns the asset. |
groupAsset | (bool) Sets if asset is group asset ou not. |
actualQuantity | (int) The quantity at this date. |
putInServiceDate | (DateTime) Date that the asset was put in service. |
originalQuantity | (int) (Internal use only). This quantity is used internally in asset's operations such as forecast depreciation processing. |
The following elements are optional:
user | (string) The main user / responsible for the asset. |
entityDimensionDetails | (List of ApiBaseFinancialAssetEntityDimensionDetailsResource) Reference to the list of dimension details.
See ApiBaseFinancialAssetEntityDimensionDetailsResource. |
assetGroup | (string) The asset group associated with the financial asset. |
apiImportKey | (string) Api Import. |
description | (string) The description of the asset. |
inventoryNumber | (string) The inventory number. |
serialNumber | (string) The serial number. |
remarks | (string) The remarks. |
image | (string) Picture of the asset. |
markedForForecast | (bool) When true this attribute indicates that the asset has been marked for a new forecast depreciation. This is set base on a change in the asset properties or because a new financial year are created. |
ApiFinancialAssetEntityDimensionDetailsResource
The following elements are required:
dimension | (string) Dimension. |
dimensionValue | (string) The dimension value. |
ApiFinancialAssetResource
The following elements are required:
assetClass | (string) The class where asset bellongs. |
isAssetClassChanged | (bool) Check if asset class has been changed. |
propertyType | (enum PropertyType) The ownership type of the asset.
See PropertyType. |
calculateDepreciation | (bool) Select if the asset calculate depreciation. |
scrapValue | (MoneyResource) The remaining value of the asset at the end of usefull life.
See MoneyResource . |
isScrapValueChanged | (bool) Check if asset scrap value has been changed. |
previousScrapValue | (decimal) Scrap value previous of update. |
status | (enum Status) Status of the asset.
See Status. |
currency | (string) Currency of the Scrap Value. |
assetKey | (string) The asset key. |
The following elements are optional:
user | (string) The main user / responsible for the asset. |
entityDimensionDetails | (List of ApiFinancialAssetEntityDimensionDetailsResource) Reference to the list of dimension details.
See ApiFinancialAssetEntityDimensionDetailsResource. |
assetGroup | (string) The asset group associated with the financial asset. |
apiImportKey | (string) Api Import. |
BaseFinancialAssetEntityDimensionDetailsResource
The following elements are required:
dimension | (string) Dimension. |
dimensionValue | (string) The dimension value. |
BaseFinancialAssetResource
The following elements are required:
assetClass | (string) The class where asset bellongs. |
isAssetClassChanged | (bool) Check if asset class has been changed. |
propertyType | (enum PropertyType) The ownership type of the asset.
See PropertyType. |
calculateDepreciation | (bool) Select if the asset calculate depreciation. |
scrapValue | (MoneyResource) The remaining value of the asset at the end of usefull life.
See MoneyResource . |
isScrapValueChanged | (bool) Check if asset scrap value has been changed. |
previousScrapValue | (decimal) Scrap value previous of update. |
status | (enum Status) Status of the asset.
See Status. |
currency | (string) Currency of the Scrap Value. |
assetKey | (string) The asset key. |
company | (string) The company that owns the asset. |
groupAsset | (bool) Sets if asset is group asset ou not. |
actualQuantity | (int) The quantity at this date. |
putInServiceDate | (DateTime) Date that the asset was put in service. |
originalQuantity | (int) (Internal use only). This quantity is used internally in asset's operations such as forecast depreciation processing. |
The following elements are optional:
user | (string) The main user / responsible for the asset. |
entityDimensionDetails | (List of BaseFinancialAssetEntityDimensionDetailsResource) Reference to the list of dimension details.
See BaseFinancialAssetEntityDimensionDetailsResource. |
assetGroup | (string) The asset group associated with the financial asset. |
apiImportKey | (string) Api Import. |
description | (string) The description of the asset. |
inventoryNumber | (string) The inventory number. |
serialNumber | (string) The serial number. |
remarks | (string) The remarks. |
image | (string) Picture of the asset. |
markedForForecast | (bool) When true this attribute indicates that the asset has been marked for a new forecast depreciation. This is set base on a change in the asset properties or because a new financial year are created. |
FinancialAssetDimensionResource
The following elements are required:
dimension | (string) Dimension. |
dimensionValue | (string) The dimension value. |
FinancialAssetResource
The following elements are required:
assetClass | (string) The class where asset bellongs.
(fk) Allowed value: the natural key of a record of type AssetClass. These records are accessibly through the AssetClasses service. |
isAssetClassChanged | (bool) Check if asset class has been changed. |
propertyType | (enum PropertyType) The ownership type of the asset.
See PropertyType. |
calculateDepreciation | (bool) Select if the asset calculate depreciation. |
scrapValue | (MoneyResource) The remaining value of the asset at the end of usefull life.
See MoneyResource . |
isScrapValueChanged | (bool) Check if asset scrap value has been changed. |
previousScrapValue | (decimal) Scrap value previous of update. |
status | (enum Status) Status of the asset.
See Status. |
currency | (string) Currency of the Scrap Value.
(fk) Allowed value: the natural key of a record of type Currency. These records are accessibly through the Currencies service. |
assetKey | (string) The asset key. |
The following elements are optional:
user | (string) The main user / responsible for the asset. |
entityDimensionDetails | (List of FinancialAssetDimensionResource) Reference to the list of dimension details.
See FinancialAssetDimensionResource. |
assetGroup | (string) The asset group associated with the financial asset.
(fk) Allowed value: the natural key of a record of type AssetGroup. These records are accessibly through the AssetGroups service. |
apiImportKey | (string) Api Import. |
MoneyResource
The following elements are required:
amount | (decimal) The amount. |
The following elements are optional:
baseAmount | (decimal) The base amount. |
reportingAmount | (decimal) The reporting amount. |
fractionDigits | (int) The fraction digits. |
symbol | (string) The symbol. |
Notes: For the POST operation it is not necessary to send the fields: BaseAmount, ReportingAmount, FractionDigits and Symbol. Will be ignored.
ExtensibilityCustomAttributeValueResource
The following elements are required:
value | (object) The custom attribute value. |