ROSE Developers - Web API Reference

Assets | Asset Class

The Asset Class represents a grouping of investments that exhibit similar characteristics and are subject to the same laws and regulations.

Overview


URL api/{tenantKey}/{orgKey}/assetsCore/assetClasses
Methods Supported GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

All Resources

This service uses the following resources:

All Enumerations

This service uses the following enumerations:

GET Operations

GET AssetClasses

Returns the list of all the entity records available.

Response:

When successful, the response body contains the list of records available. See AssetClassResource.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

GET /assetsCore/assetClasses

GET AssetClasses (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 AssetClassResource.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

GET /assetsCore/assetClasses?page={page}&pageSize={pageSize}

GET AssetClass 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 AssetClassResource.

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 /assetsCore/assetClasses/{id}

GET AssetClass by key

Returns the entity record that matches the specified key.

The following elements are required:

assetClassKey (string) Main asset classification key.

Response:

When successful, the response body contains the entity record. See AssetClassResource.

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 /assetsCore/assetClasses/{assetClassKey}

GET Print AssetClass by identifier

Prints the specified entity record.

The following elements are required:

id (string) The record identifier.

The following elements are optional:

template (string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200 OK. The operation was completed successfully.
404 NotFound. The specified resord does not exist.

Resource URL:

GET /assetsCore/assetClasses/{id}/print?template={template}

GET Print AssetClass by key

Prints the specified entity record.

The following elements are required:

assetClassKey (string) Main asset classification key.

The following elements are optional:

template (string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

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 /assetsCore/assetClasses/{assetClassKey}/print

GET Original Print AssetClassOriginal by identifier

Prints the specified entity record.

The following elements are required:

id (string) The record identifier.

The following elements are optional:

template (string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200 OK. The operation was completed successfully.
404 NotFound. The specified resord does not exist.

Resource URL:

GET /assetsCore/assetClasses/{id}/printOriginal?template={template}

GET Original Print AssetClass by key

Prints the specified entity record.

The following elements are required:

assetClassKey (string) Main asset classification key.

The following elements are optional:

template (string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

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 /assetsCore/assetClasses/{assetClassKey}/printOriginal

POST Operations

POST AssetClasses

Creates a new entity record.

The following elements are required:

assetClassResource (ApiAssetClassResource) The request body should contain the entity record that should be created.
See ApiAssetClassResource.

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 ApiAssetClassResource.

Response status codes:

201 Created. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

POST /assetsCore/assetClasses

POST Asset Class

Inserts a new 'Asset Class Detail' in the 'Asset Class'.

The following elements are required:

assetClassKey (string) Main asset classification key.
value (ApiAssetClassAssetClassDetailsResource) The ApiAssetClassAssetClassDetailsResource instance.
See ApiAssetClassAssetClassDetailsResource.

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:

POST /assetsCore/assetClasses/{assetClassKey}/assetClassDetails

PUT Operations

PUT Set AssetAccountType AssetClassDetail

Updates the value of attribute 'AssetAccountType' in the specified entity record.

The following elements are required:

assetClassKey (string) Main asset classification 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 /assetsCore/assetClasses/{assetClassKey}/assetClassDetails/{lineId}/assetAccountType

PUT Set AssetClassKey AssetClass

Updates the value of attribute 'AssetClassKey' in the specified entity record.

The following elements are required:

assetClassKey (string) Main asset classification 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 /assetsCore/assetClasses/{assetClassKey}/assetClassKey

PUT Set AssetType AssetClass

Updates the value of attribute 'AssetType' in the specified entity record.

The following elements are required:

assetClassKey (string) Main asset classification 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 /assetsCore/assetClasses/{assetClassKey}/assetType

PUT Set AutonomousTaxation AssetClass

Updates the value of attribute 'AutonomousTaxation' in the specified entity record.

The following elements are required:

assetClassKey (string) Main asset classification 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 /assetsCore/assetClasses/{assetClassKey}/autonomousTaxation

PUT Set Currency AssetClassDetail

Updates the value of attribute 'Currency' in the specified entity record.

The following elements are required:

assetClassKey (string) Main asset classification 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 /assetsCore/assetClasses/{assetClassKey}/assetClassDetails/{lineId}/currency

PUT Set DepreciationArea AssetClassDetail

Updates the value of attribute 'DepreciationArea' in the specified entity record.

The following elements are required:

assetClassKey (string) Main asset classification 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 /assetsCore/assetClasses/{assetClassKey}/assetClassDetails/{lineId}/depreciationArea

PUT Set Description AssetClass

Updates the value of attribute 'Description' in the specified entity record.

The following elements are required:

assetClassKey (string) Main asset classification 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 /assetsCore/assetClasses/{assetClassKey}/description

PUT Set DoesNotDepreciate AssetClass

Updates the value of attribute 'DoesNotDepreciate' in the specified entity record.

The following elements are required:

assetClassKey (string) Main asset classification 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 /assetsCore/assetClasses/{assetClassKey}/doesNotDepreciate

PUT Set DynamicValueList AssetClass

Updates the value of attribute 'DynamicValueList' in the specified entity record.

The following elements are required:

assetClassKey (string) Main asset classification 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 /assetsCore/assetClasses/{assetClassKey}/dynamicValueList

PUT Set FiscalClassification AssetClass

Updates the value of attribute 'FiscalClassification' in the specified entity record.

The following elements are required:

assetClassKey (string) Main asset classification 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 /assetsCore/assetClasses/{assetClassKey}/fiscalClassification

PUT Set FiscalDepreciationLimit AssetClassDetail

Updates the value of attribute 'FiscalDepreciationLimit' in the specified entity record.

The following elements are required:

assetClassKey (string) Main asset classification key.
lineId (string) The detail identifier.
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 /assetsCore/assetClasses/{assetClassKey}/assetClassDetails/{lineId}/fiscalDepreciationLimit

PUT Set IsActive AssetClass

Updates the value of attribute 'IsActive' in the specified entity record.

The following elements are required:

assetClassKey (string) Main asset classification 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 /assetsCore/assetClasses/{assetClassKey}/isActive

PUT Set LowValueAsset AssetClass

Updates the value of attribute 'LowValueAsset' in the specified entity record.

The following elements are required:

assetClassKey (string) Main asset classification 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 /assetsCore/assetClasses/{assetClassKey}/lowValueAsset

PUT Set MaxAmount AssetClassDetail

Updates the value of attribute 'MaxAmount' in the specified entity record.

The following elements are required:

assetClassKey (string) Main asset classification key.
lineId (string) The detail identifier.
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 /assetsCore/assetClasses/{assetClassKey}/assetClassDetails/{lineId}/maxAmount

PUT Set MinAmount AssetClassDetail

Updates the value of attribute 'MinAmount' in the specified entity record.

The following elements are required:

assetClassKey (string) Main asset classification key.
lineId (string) The detail identifier.
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 /assetsCore/assetClasses/{assetClassKey}/assetClassDetails/{lineId}/minAmount

PUT Set Ordinance AssetClass

Updates the value of attribute 'Ordinance' in the specified entity record.

The following elements are required:

assetClassKey (string) Main asset classification 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 /assetsCore/assetClasses/{assetClassKey}/ordinance

PUT Set PostingCycle AssetClass

Updates the value of attribute 'PostingCycle' in the specified entity record.

The following elements are required:

assetClassKey (string) Main asset classification key.
value (enum PostingCycle) The request body should contain the new value for the attribute.
See PostingCycle.

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 /assetsCore/assetClasses/{assetClassKey}/postingCycle

PUT Set SubType AssetClass

Updates the value of attribute 'SubType' in the specified entity record.

The following elements are required:

assetClassKey (string) Main asset classification 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 /assetsCore/assetClasses/{assetClassKey}/subType

PUT Set UsefulLife AssetClassDetail

Updates the value of attribute 'UsefulLife' in the specified entity record.

The following elements are required:

assetClassKey (string) Main asset classification key.
lineId (string) The detail identifier.
value (int) 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 /assetsCore/assetClasses/{assetClassKey}/assetClassDetails/{lineId}/usefulLife

PUT Set Custom Attribute AssetClass

Updates the value of 'CustomAttribute' in the specified entity record.

The following elements are required:

assetClassKey (string) Main asset classification 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:

PUT /assetsCore/assetClasses/{assetClassKey}/{customAttributeName}

PUT Set Custom Attribute AssetClassDetail

Updates the value of 'CustomAttribute' in the specified entity record.

The following elements are required:

assetClassKey (string) Main asset classification key
lineId (string) The detail identifier.
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:

PUT /assetsCore/assetClasses/{assetClassKey}/assetClassDetails/{lineId}/{customAttributeName}

DELETE Operations

DELETE Asset Class Detail by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

assetClassKey (string) Main asset classification 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 /assetsCore/assetClasses/{assetClassKey}/assetClassDetails/{lineId}

DELETE AssetClass 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 /assetsCore/assetClasses/{id}

DELETE AssetClass by key

Deletes the entity record that matches the specified key.

The following elements are required:

assetClassKey (string) Main asset classification 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:

DELETE /assetsCore/assetClasses/{assetClassKey}

Resources


ApiAssetClassAssetClassDetailsResource

The following elements are required:

depreciationArea (string) Select the depreciation area.
assetAccountType (string) Select the account set to be used when posting an asset.
currency (string) The currency of the monetary amounts. Its set by depreciation area currency.
fiscalDepreciationLimit (MoneyResource) Some countries specify a maximum depreciation limitations for special assets (eg. luxury cars). If it's the case for this asset class specify the limit here, otherwise leave it as zero.
See MoneyResource .
maxAmount (MoneyResource) Specify a maximum APC (Aquisition or Production Cost) limit for the assets of this class, otherwise leave it as zero.
See MoneyResource .
minAmount (MoneyResource) Specify a minimum APC (Aquisition or Production Cost) limit for the assets of this class, otherwise leave it as zero.
See MoneyResource .

The following elements are optional:

usefulLife (int) Fill the usefull life (in months).


ApiAssetClassResource

The following elements are required:

assetClassKey (string) Main asset classification key.
postingCycle (enum PostingCycle) Fill if the assets will be depreciated yearly or monthly.
See PostingCycle.
lowValueAsset (bool) A low-value asset is an asset whose acquisition costs fall within defined limits. It varies from country to country.
doesNotDepreciate (bool) Check if the assets will not depreciate (eg. land or assets under construction).
assetType (string) Select the type of assets of this class.
subType (string) Select the subtype of assets of this class.

The following elements are optional:

description (string) Description of the asset class.
assetClassDetails (List of ApiAssetClassAssetClassDetailsResource) The list of Asset Classes.
See ApiAssetClassAssetClassDetailsResource.
fiscalClassification (string) Type of asset for tax purposes.
dynamicValueList (string) The dynamic value list identifier.
autonomousTaxation (string) Autonomous Taxation.
ordinance (string) The ordinance that apply.


AssetClassDetailResource

The following elements are required:

depreciationArea (string) Select the depreciation area.
assetAccountType (string) Select the account set to be used when posting an asset.
currency (string) The currency of the monetary amounts. Its set by depreciation area currency.
fiscalDepreciationLimit (MoneyResource) Some countries specify a maximum depreciation limitations for special assets (eg. luxury cars). If it's the case for this asset class specify the limit here, otherwise leave it as zero.
See MoneyResource .
maxAmount (MoneyResource) Specify a maximum APC (Aquisition or Production Cost) limit for the assets of this class, otherwise leave it as zero.
See MoneyResource .
minAmount (MoneyResource) Specify a minimum APC (Aquisition or Production Cost) limit for the assets of this class, otherwise leave it as zero.
See MoneyResource .

The following elements are optional:

usefulLife (int) Fill the usefull life (in months).


AssetClassResource

The following elements are required:

assetClassKey (string) Main asset classification key.
postingCycle (enum PostingCycle) Fill if the assets will be depreciated yearly or monthly.
See PostingCycle.
lowValueAsset (bool) A low-value asset is an asset whose acquisition costs fall within defined limits. It varies from country to country.
doesNotDepreciate (bool) Check if the assets will not depreciate (eg. land or assets under construction).
assetType (string) Select the type of assets of this class.
(fk) Allowed value: the natural key of a record of type DynamicValueList. These records are accessibly through the DynamicValueLists service.
subType (string) Select the subtype of assets of this class.
(fk) Allowed value: the natural key of a record of type DynamicValueListDetail.

The following elements are optional:

description (string) Description of the asset class.
assetClassDetails (List of AssetClassDetailResource) The list of Asset Classes.
See AssetClassDetailResource.
fiscalClassification (string) Type of asset for tax purposes.
(fk) Allowed value: the natural key of a record of type FiscalClassification. These records are accessibly through the FiscalClassifications service.
dynamicValueList (string) The dynamic value list identifier.
(fk) Allowed value: the natural key of a record of type DynamicValueList. These records are accessibly through the DynamicValueLists service.
autonomousTaxation (string) Autonomous Taxation.
(fk) Allowed value: the natural key of a record of type AutonomousTaxation.
ordinance (string) The ordinance that apply.
(fk) Allowed value: the natural key of a record of type Ordinance. These records are accessibly through the Ordinances service.


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.

Enumerations


PostingCycle

1 Monthly
2 Anual