Assets | Asset Account Type

The AssetAccountType represents the specification of asset gl accounts.

Overview

api/{tenantKey}/{orgKey}/assetsCore/assetAccountTypes

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

All Operations

This service includes the following operations:

GET:
POST:
- POST AssetAccountTypes
- POST Asset Account Type
PUT:
DELETE:

All Resources

This service uses the following resources:

ApiAssetAccountTypeAssetAccountTypeDetailsResource
ApiAssetAccountTypeResource
AssetAccountTypeDetailResource
AssetAccountTypeResource
ExtensibilityCustomAttributeValueResource

GET Operations

GET AssetAccountTypes

Returns the list of all the entity records available.

Response:

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/assetsCore/assetAccountTypes

GET /assetsCore/assetAccountTypes

GET AssetAccountTypes (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 AssetAccountTypeResource.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/assetsCore/assetAccountTypes?page={page}&pageSize={pageSize}

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

GET AssetAccountType 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 AssetAccountTypeResource.

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:

api/{tenantKey}/{orgKey}/assetsCore/assetAccountTypes/{id}

GET /assetsCore/assetAccountTypes/{id}

GET AssetAccountType by key

Returns the entity record that matches the specified key.

The following elements are required:

assetAccountTypeKey

(string) The asset account type key. The asset account type is used to determine all the asset GL accounts.

Response:

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

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:

api/{tenantKey}/{orgKey}/assetsCore/assetAccountTypes/{assetAccountTypeKey}

GET /assetsCore/assetAccountTypes/{assetAccountTypeKey}

GET Print AssetAccountType 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:

api/{tenantKey}/{orgKey}/assetsCore/assetAccountTypes/{id}/print?template={template}

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

GET Print AssetAccountType by key

Prints the specified entity record.

The following elements are required:

assetAccountTypeKey

(string) The asset account type key. The asset account type is used to determine all the asset GL accounts.

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:

api/{tenantKey}/{orgKey}/assetsCore/assetAccountTypes/{assetAccountTypeKey}/print

GET /assetsCore/assetAccountTypes/{assetAccountTypeKey}/print

GET Original Print AssetAccountTypeOriginal 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:

api/{tenantKey}/{orgKey}/assetsCore/assetAccountTypes/{id}/printOriginal?template={template}

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

GET Original Print AssetAccountType by key

Prints the specified entity record.

The following elements are required:

assetAccountTypeKey

(string) The asset account type key. The asset account type is used to determine all the asset GL accounts.

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:

api/{tenantKey}/{orgKey}/assetsCore/assetAccountTypes/{assetAccountTypeKey}/printOriginal

GET /assetsCore/assetAccountTypes/{assetAccountTypeKey}/printOriginal

POST Operations

POST AssetAccountTypes

Creates a new entity record.

The following elements are required:

assetAccountTypeResource

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

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/assetsCore/assetAccountTypes

POST /assetsCore/assetAccountTypes

POST Asset Account Type

Inserts a new 'Asset Account Type Detail' in the 'Asset Account Type'.

The following elements are required:

assetAccountTypeKey	(string) The asset account type key. The asset account type is used to determine all the asset GL accounts.
value	(ApiAssetAccountTypeAssetAccountTypeDetailsResource) The ApiAssetAccountTypeAssetAccountTypeDetailsResource instance. See ApiAssetAccountTypeAssetAccountTypeDetailsResource.

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:

api/{tenantKey}/{orgKey}/assetsCore/assetAccountTypes/{assetAccountTypeKey}/assetAccountTypeDetails

POST /assetsCore/assetAccountTypes/{assetAccountTypeKey}/assetAccountTypeDetails

PUT Operations

PUT Set AccumulatedDepreciationAccount AssetAccountTypeDetail

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

The following elements are required:

assetAccountTypeKey	(string) The asset account type key. The asset account type is used to determine all the asset GL accounts.
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:

api/{tenantKey}/{orgKey}/assetsCore/assetAccountTypes/{assetAccountTypeKey}/assetAccountTypeDetails/{lineId}/accumulatedDepreciationAccount

PUT /assetsCore/assetAccountTypes/{assetAccountTypeKey}/assetAccountTypeDetails/{lineId}/accumulatedDepreciationAccount

PUT Set AccumulatedImparityAccount AssetAccountTypeDetail

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

The following elements are required:

assetAccountTypeKey	(string) The asset account type key. The asset account type is used to determine all the asset GL accounts.
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:

api/{tenantKey}/{orgKey}/assetsCore/assetAccountTypes/{assetAccountTypeKey}/assetAccountTypeDetails/{lineId}/accumulatedImparityAccount

PUT /assetsCore/assetAccountTypes/{assetAccountTypeKey}/assetAccountTypeDetails/{lineId}/accumulatedImparityAccount

PUT Set AssetAccount AssetAccountTypeDetail

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

The following elements are required:

assetAccountTypeKey	(string) The asset account type key. The asset account type is used to determine all the asset GL accounts.
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:

api/{tenantKey}/{orgKey}/assetsCore/assetAccountTypes/{assetAccountTypeKey}/assetAccountTypeDetails/{lineId}/assetAccount

PUT /assetsCore/assetAccountTypes/{assetAccountTypeKey}/assetAccountTypeDetails/{lineId}/assetAccount

PUT Set AssetAccountTypeKey AssetAccountType

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

The following elements are required:

assetAccountTypeKey	(string) The asset account type key. The asset account type is used to determine all the asset GL accounts.
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:

api/{tenantKey}/{orgKey}/assetsCore/assetAccountTypes/{assetAccountTypeKey}/assetAccountTypeKey

PUT /assetsCore/assetAccountTypes/{assetAccountTypeKey}/assetAccountTypeKey

PUT Set ChartOfAccount AssetAccountTypeDetail

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

The following elements are required:

assetAccountTypeKey	(string) The asset account type key. The asset account type is used to determine all the asset GL accounts.
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:

api/{tenantKey}/{orgKey}/assetsCore/assetAccountTypes/{assetAccountTypeKey}/assetAccountTypeDetails/{lineId}/chartOfAccount

PUT /assetsCore/assetAccountTypes/{assetAccountTypeKey}/assetAccountTypeDetails/{lineId}/chartOfAccount

PUT Set DataImportClearingAccount AssetAccountTypeDetail

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

The following elements are required:

assetAccountTypeKey	(string) The asset account type key. The asset account type is used to determine all the asset GL accounts.
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:

api/{tenantKey}/{orgKey}/assetsCore/assetAccountTypes/{assetAccountTypeKey}/assetAccountTypeDetails/{lineId}/dataImportClearingAccount

PUT /assetsCore/assetAccountTypes/{assetAccountTypeKey}/assetAccountTypeDetails/{lineId}/dataImportClearingAccount

PUT Set DepreciationCostAccount AssetAccountTypeDetail

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

The following elements are required:

assetAccountTypeKey	(string) The asset account type key. The asset account type is used to determine all the asset GL accounts.
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:

api/{tenantKey}/{orgKey}/assetsCore/assetAccountTypes/{assetAccountTypeKey}/assetAccountTypeDetails/{lineId}/depreciationCostAccount

PUT /assetsCore/assetAccountTypes/{assetAccountTypeKey}/assetAccountTypeDetails/{lineId}/depreciationCostAccount

PUT Set Description AssetAccountType

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

The following elements are required:

assetAccountTypeKey	(string) The asset account type key. The asset account type is used to determine all the asset GL accounts.
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:

api/{tenantKey}/{orgKey}/assetsCore/assetAccountTypes/{assetAccountTypeKey}/description

PUT /assetsCore/assetAccountTypes/{assetAccountTypeKey}/description

PUT Set ImparityCostAccount AssetAccountTypeDetail

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

The following elements are required:

assetAccountTypeKey	(string) The asset account type key. The asset account type is used to determine all the asset GL accounts.
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:

api/{tenantKey}/{orgKey}/assetsCore/assetAccountTypes/{assetAccountTypeKey}/assetAccountTypeDetails/{lineId}/imparityCostAccount

PUT /assetsCore/assetAccountTypes/{assetAccountTypeKey}/assetAccountTypeDetails/{lineId}/imparityCostAccount

PUT Set IsActive AssetAccountType

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

The following elements are required:

assetAccountTypeKey	(string) The asset account type key. The asset account type is used to determine all the asset GL accounts.
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:

api/{tenantKey}/{orgKey}/assetsCore/assetAccountTypes/{assetAccountTypeKey}/isActive

PUT /assetsCore/assetAccountTypes/{assetAccountTypeKey}/isActive

PUT Set LossAssetSaleAccount AssetAccountTypeDetail

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

The following elements are required:

assetAccountTypeKey	(string) The asset account type key. The asset account type is used to determine all the asset GL accounts.
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:

api/{tenantKey}/{orgKey}/assetsCore/assetAccountTypes/{assetAccountTypeKey}/assetAccountTypeDetails/{lineId}/lossAssetSaleAccount

PUT /assetsCore/assetAccountTypes/{assetAccountTypeKey}/assetAccountTypeDetails/{lineId}/lossAssetSaleAccount

PUT Set RevenueAssetSaleAccount AssetAccountTypeDetail

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

The following elements are required:

assetAccountTypeKey	(string) The asset account type key. The asset account type is used to determine all the asset GL accounts.
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:

api/{tenantKey}/{orgKey}/assetsCore/assetAccountTypes/{assetAccountTypeKey}/assetAccountTypeDetails/{lineId}/revenueAssetSaleAccount

PUT /assetsCore/assetAccountTypes/{assetAccountTypeKey}/assetAccountTypeDetails/{lineId}/revenueAssetSaleAccount

PUT Set RevenueImparityReversalAccount AssetAccountTypeDetail

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

The following elements are required:

assetAccountTypeKey	(string) The asset account type key. The asset account type is used to determine all the asset GL accounts.
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:

api/{tenantKey}/{orgKey}/assetsCore/assetAccountTypes/{assetAccountTypeKey}/assetAccountTypeDetails/{lineId}/revenueImparityReversalAccount

PUT /assetsCore/assetAccountTypes/{assetAccountTypeKey}/assetAccountTypeDetails/{lineId}/revenueImparityReversalAccount

PUT Set Custom Attribute AssetAccountType

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

The following elements are required:

assetAccountTypeKey	(string) The asset account type key. The asset account type is used to determine all the asset GL accounts.
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:

api/{tenantKey}/{orgKey}/assetsCore/assetAccountTypes/{assetAccountTypeKey}/{customAttributeName}

PUT /assetsCore/assetAccountTypes/{assetAccountTypeKey}/{customAttributeName}

PUT Set Custom Attribute AssetAccountTypeDetail

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

The following elements are required:

assetAccountTypeKey	(string) The asset account type key. The asset account type is used to determine all the asset GL accounts.
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:

api/{tenantKey}/{orgKey}/assetsCore/assetAccountTypes/{assetAccountTypeKey}/assetAccountTypeDetails/{lineId}/{customAttributeName}

PUT /assetsCore/assetAccountTypes/{assetAccountTypeKey}/assetAccountTypeDetails/{lineId}/{customAttributeName}

DELETE Operations

DELETE Asset Account Type Detail by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

assetAccountTypeKey	(string) The asset account type key. The asset account type is used to determine all the asset GL accounts.
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:

api/{tenantKey}/{orgKey}/assetsCore/assetAccountTypes/{assetAccountTypeKey}/assetAccountTypeDetails/{lineId}

DELETE /assetsCore/assetAccountTypes/{assetAccountTypeKey}/assetAccountTypeDetails/{lineId}

DELETE AssetAccountType 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:

api/{tenantKey}/{orgKey}/assetsCore/assetAccountTypes/{id}

DELETE /assetsCore/assetAccountTypes/{id}

DELETE AssetAccountType by key

Deletes the entity record that matches the specified key.

The following elements are required:

assetAccountTypeKey

(string) The asset account type key. The asset account type is used to determine all the asset GL accounts.

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:

api/{tenantKey}/{orgKey}/assetsCore/assetAccountTypes/{assetAccountTypeKey}

DELETE /assetsCore/assetAccountTypes/{assetAccountTypeKey}

Resources

ApiAssetAccountTypeAssetAccountTypeDetailsResource

The following elements are required:

chartOfAccount	(string) The chart of accounts. All the following accounts are belonging to this chart of accounts.
assetAccount	(string) The asset APC (Aquisition or Production Costs) account on the balance sheet.
accumulatedDepreciationAccount	(string) The accumulated depreciaition account (balance sheet).
depreciationCostAccount	(string) The expense account for cost of depreciation.
revenueAssetSaleAccount	(string) The revenue account for asset sale (profit).
lossAssetSaleAccount	(string) The expense account for asset sale (non profit).

The following elements are optional:

accumulatedImparityAccount	(string) The accumulated imparity losses account (balance sheet).
imparityCostAccount	(string) The expense account for cost of imparity losses.
revenueImparityReversalAccount	(string) The revenue account for reversal of imparity losses.
dataImportClearingAccount	(string) The clearing account for asset history data import.

ApiAssetAccountTypeResource

The following elements are required:

assetAccountTypeKey

(string) The asset account type key. The asset account type is used to determine all the asset GL accounts.

The following elements are optional:

description	(string) The description of the asset account type.
assetAccountTypeDetails	(List of ApiAssetAccountTypeAssetAccountTypeDetailsResource) The asset account type detail is used to decode the gl accounts based on the chart of account. See ApiAssetAccountTypeAssetAccountTypeDetailsResource.

AssetAccountTypeDetailResource

The following elements are required:

chartOfAccount	(string) The chart of accounts. All the following accounts are belonging to this chart of accounts.
assetAccount	(string) The asset APC (Aquisition or Production Costs) account on the balance sheet.
accumulatedDepreciationAccount	(string) The accumulated depreciaition account (balance sheet).
depreciationCostAccount	(string) The expense account for cost of depreciation.
revenueAssetSaleAccount	(string) The revenue account for asset sale (profit).
lossAssetSaleAccount	(string) The expense account for asset sale (non profit).

The following elements are optional:

accumulatedImparityAccount	(string) The accumulated imparity losses account (balance sheet).
imparityCostAccount	(string) The expense account for cost of imparity losses.
revenueImparityReversalAccount	(string) The revenue account for reversal of imparity losses.
dataImportClearingAccount	(string) The clearing account for asset history data import.

AssetAccountTypeResource

The following elements are required:

assetAccountTypeKey

(string) The asset account type key. The asset account type is used to determine all the asset GL accounts.

The following elements are optional:

description	(string) The description of the asset account type.
assetAccountTypeDetails	(List of AssetAccountTypeDetailResource) The asset account type detail is used to decode the gl accounts based on the chart of account. See AssetAccountTypeDetailResource.

ExtensibilityCustomAttributeValueResource

The following elements are required:

value

(object) The custom attribute value.