Master Data Business Entities | Asset

An Asset represents any valuable Item owned by a Company such as furniture, computers, buildings, etc.

Overview

api/{tenantKey}/{orgKey}/businessCore/assets

URL	api/{tenantKey}/{orgKey}/businessCore/assets
Methods Supported	GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

GET:
POST:
- POST Assets
PUT:
DELETE:
- DELETE Asset by identifier
- DELETE Asset by key

All Resources

This service uses the following resources:

ApiAssetResource
AssetResource
ExtensibilityCustomAttributeValueResource

GET Operations

GET Assets

Returns the list of all the entity records available.

Response:

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/businessCore/assets

GET /businessCore/assets

GET Assets (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 AssetResource.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/businessCore/assets?page={page}&pageSize={pageSize}

GET /businessCore/assets?page={page}&pageSize={pageSize}

GET Asset 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 AssetResource.

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}/businessCore/assets/{id}

GET /businessCore/assets/{id}

GET Asset by key

Returns the entity record that matches the specified key.

The following elements are required:

companyKey	(string) The company key.
assetKey	(string) The asset key.

Response:

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

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}/businessCore/assets/{companyKey}/{assetKey}

GET /businessCore/assets/{companyKey}/{assetKey}

GET Print Asset 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}/businessCore/assets/{id}/print?template={template}

GET /businessCore/assets/{id}/print?template={template}

GET Print Asset by key

Prints the specified entity record.

The following elements are required:

companyKey	(string) The company key.
assetKey	(string) The asset 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:

api/{tenantKey}/{orgKey}/businessCore/assets/{companyKey}/{assetKey}/print

GET /businessCore/assets/{companyKey}/{assetKey}/print

GET Original Print AssetOriginal 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}/businessCore/assets/{id}/printOriginal?template={template}

GET /businessCore/assets/{id}/printOriginal?template={template}

GET Original Print Asset by key

Prints the specified entity record.

The following elements are required:

companyKey	(string) The company key.
assetKey	(string) The asset 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:

api/{tenantKey}/{orgKey}/businessCore/assets/{companyKey}/{assetKey}/printOriginal

GET /businessCore/assets/{companyKey}/{assetKey}/printOriginal

GET Asset Image.

Returns the value of attribute 'Image' of the specified entity record.

The following elements are required:

id	(string) The record identifier.
fileName	(string) The file name.

Response:

When successful, the response is a stream with the image 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}/businessCore/assets/{id}/image

GET /businessCore/assets/{id}/image

POST Operations

POST Assets

Creates a new entity record.

The following elements are required:

assetResource

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

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/businessCore/assets

POST /businessCore/assets

PUT Operations

PUT Set ActualQuantity Asset

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

The following elements are required:

assetKey	(string) The asset key.
companyKey	(string) The company key.
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:

api/{tenantKey}/{orgKey}/businessCore/assets/{companyKey}/{assetKey}/actualQuantity

PUT /businessCore/assets/{companyKey}/{assetKey}/actualQuantity

PUT Set AssetKey Asset

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

The following elements are required:

assetKey	(string) The asset key.
companyKey	(string) The company 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:

api/{tenantKey}/{orgKey}/businessCore/assets/{companyKey}/{assetKey}/assetKey

PUT /businessCore/assets/{companyKey}/{assetKey}/assetKey

PUT Set Company Asset

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

The following elements are required:

assetKey	(string) The asset key.
companyKey	(string) The company 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:

api/{tenantKey}/{orgKey}/businessCore/assets/{companyKey}/{assetKey}/company

PUT /businessCore/assets/{companyKey}/{assetKey}/company

PUT Set Description Asset

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

The following elements are required:

assetKey	(string) The asset key.
companyKey	(string) The company 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:

api/{tenantKey}/{orgKey}/businessCore/assets/{companyKey}/{assetKey}/description

PUT /businessCore/assets/{companyKey}/{assetKey}/description

PUT Set GroupAsset Asset

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

The following elements are required:

assetKey	(string) The asset key.
companyKey	(string) The company 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:

api/{tenantKey}/{orgKey}/businessCore/assets/{companyKey}/{assetKey}/groupAsset

PUT /businessCore/assets/{companyKey}/{assetKey}/groupAsset

PUT Set Image Asset

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

The following elements are required:

assetKey	(string) The asset key.
companyKey	(string) The company 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:

api/{tenantKey}/{orgKey}/businessCore/assets/{companyKey}/{assetKey}/image

PUT /businessCore/assets/{companyKey}/{assetKey}/image

PUT Set InventoryNumber Asset

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

The following elements are required:

assetKey	(string) The asset key.
companyKey	(string) The company 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:

api/{tenantKey}/{orgKey}/businessCore/assets/{companyKey}/{assetKey}/inventoryNumber

PUT /businessCore/assets/{companyKey}/{assetKey}/inventoryNumber

PUT Set IsActive Asset

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

The following elements are required:

assetKey	(string) The asset key.
companyKey	(string) The company 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:

api/{tenantKey}/{orgKey}/businessCore/assets/{companyKey}/{assetKey}/isActive

PUT /businessCore/assets/{companyKey}/{assetKey}/isActive

PUT Set MarkedForForecast Asset

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

The following elements are required:

assetKey	(string) The asset key.
companyKey	(string) The company 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:

api/{tenantKey}/{orgKey}/businessCore/assets/{companyKey}/{assetKey}/markedForForecast

PUT /businessCore/assets/{companyKey}/{assetKey}/markedForForecast

PUT Set OriginalQuantity Asset

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

The following elements are required:

assetKey	(string) The asset key.
companyKey	(string) The company key.
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:

api/{tenantKey}/{orgKey}/businessCore/assets/{companyKey}/{assetKey}/originalQuantity

PUT /businessCore/assets/{companyKey}/{assetKey}/originalQuantity

PUT Set PutInServiceDate Asset

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

The following elements are required:

assetKey	(string) The asset key.
companyKey	(string) The company key.
value	(DateTime) 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}/businessCore/assets/{companyKey}/{assetKey}/putInServiceDate

PUT /businessCore/assets/{companyKey}/{assetKey}/putInServiceDate

PUT Set Remarks Asset

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

The following elements are required:

assetKey	(string) The asset key.
companyKey	(string) The company 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:

api/{tenantKey}/{orgKey}/businessCore/assets/{companyKey}/{assetKey}/remarks

PUT /businessCore/assets/{companyKey}/{assetKey}/remarks

PUT Set SerialNumber Asset

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

The following elements are required:

assetKey	(string) The asset key.
companyKey	(string) The company 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:

api/{tenantKey}/{orgKey}/businessCore/assets/{companyKey}/{assetKey}/serialNumber

PUT /businessCore/assets/{companyKey}/{assetKey}/serialNumber

PUT Set Custom Attribute Asset

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

The following elements are required:

companyKey	(string) The company key.
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:

api/{tenantKey}/{orgKey}/businessCore/assets/{companyKey}/{assetKey}/{customAttributeName}

PUT /businessCore/assets/{companyKey}/{assetKey}/{customAttributeName}

DELETE Operations

DELETE Asset 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}/businessCore/assets/{id}

DELETE /businessCore/assets/{id}

DELETE Asset by key

Deletes the entity record that matches the specified key.

The following elements are required:

companyKey	(string) The company key.
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:

api/{tenantKey}/{orgKey}/businessCore/assets/{companyKey}/{assetKey}

DELETE /businessCore/assets/{companyKey}/{assetKey}

Resources

ApiAssetResource

The following elements are required:

company	(string) The company that owns the asset.
assetKey	(string) The asset key.
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:

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.

AssetResource

The following elements are required:

company	(string) The company that owns the asset. (fk) Allowed value: the natural key of a record of type Company. These records are accessibly through the Companies service.
assetKey	(string) The asset key.
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:

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.

ExtensibilityCustomAttributeValueResource

The following elements are required:

value

(object) The custom attribute value.