Assets | Assets Parameters

The Assets Setup is used to manage asset default values for each company, such as the Depreciation Area and default document journals.

Overview

api/{tenantKey}/{orgKey}/assetsCore/assetsSetups

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

All Operations

This service includes the following operations:

GET:
POST:
- POST AssetsSetups
- POST Assets Setup
PUT:
DELETE:

All Resources

This service uses the following resources:

ApiAssetsSetupAssetsSetupDetailsResource
ApiAssetsSetupResource
AssetsSetupDetailResource
AssetsSetupResource
DefaultDepreciationArea
ExtensibilityCustomAttributeValueResource

GET Operations

GET AssetsSetups

Returns the list of all the entity records available.

Response:

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/assetsCore/assetsSetups

GET /assetsCore/assetsSetups

GET AssetsSetups (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 AssetsSetupResource.

Response status codes:

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

Resource URL:

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

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

GET AssetsSetup 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 AssetsSetupResource.

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

GET /assetsCore/assetsSetups/{id}

GET AssetsSetup by key

Returns the entity record that matches the specified key.

The following elements are required:

company

(string) The company where the following setup applies.

Response:

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

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/assetsSetups/{company}

GET /assetsCore/assetsSetups/{company}

GET Print AssetsSetup 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/assetsSetups/{id}/print?template={template}

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

GET Print AssetsSetup by key

Prints the specified entity record.

The following elements are required:

company

(string) The company where the following setup applies.

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/assetsSetups/{company}/print

GET /assetsCore/assetsSetups/{company}/print

GET Original Print AssetsSetupOriginal 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/assetsSetups/{id}/printOriginal?template={template}

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

GET Original Print AssetsSetup by key

Prints the specified entity record.

The following elements are required:

company

(string) The company where the following setup applies.

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/assetsSetups/{company}/printOriginal

GET /assetsCore/assetsSetups/{company}/printOriginal

GET Get Depreciation Area For Company

Returns the default depreciation area form the company.

The following elements are required:

company

(string) The Company Key.

Response:

When successful, the response body contains a resource of type 'DefaultDepreciationArea'. See DefaultDepreciationArea.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/assetsCore/assetsSetups/getDepreciationAreaForCompany

GET /assetsCore/assetsSetups/getDepreciationAreaForCompany

POST Operations

POST AssetsSetups

Creates a new entity record.

The following elements are required:

assetsSetupResource

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

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/assetsCore/assetsSetups

POST /assetsCore/assetsSetups

POST Assets Setup

Inserts a new 'Assets Setup Detail' in the 'Assets Setup'.

The following elements are required:

company	(string) The company where the following setup applies.
value	(ApiAssetsSetupAssetsSetupDetailsResource) The ApiAssetsSetupAssetsSetupDetailsResource instance. See ApiAssetsSetupAssetsSetupDetailsResource.

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/assetsSetups/{company}/assetsSetupDetails

POST /assetsCore/assetsSetups/{company}/assetsSetupDetails

PUT Operations

PUT Set AquisitionTransferJournal AssetsSetup

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

The following elements are required:

company	(string) The company where the following setup applies.
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/assetsSetups/{company}/aquisitionTransferJournal

PUT /assetsCore/assetsSetups/{company}/aquisitionTransferJournal

PUT Set AssetAquisitionJournal AssetsSetup

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

The following elements are required:

company	(string) The company where the following setup applies.
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/assetsSetups/{company}/assetAquisitionJournal

PUT /assetsCore/assetsSetups/{company}/assetAquisitionJournal

PUT Set AssetSaleJournal AssetsSetup

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

The following elements are required:

company	(string) The company where the following setup applies.
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/assetsSetups/{company}/assetSaleJournal

PUT /assetsCore/assetsSetups/{company}/assetSaleJournal

PUT Set AssetScrapJournal AssetsSetup

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

The following elements are required:

company	(string) The company where the following setup applies.
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/assetsSetups/{company}/assetScrapJournal

PUT /assetsCore/assetsSetups/{company}/assetScrapJournal

PUT Set Company AssetsSetup

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

The following elements are required:

company	(string) The company where the following setup applies.
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/assetsSetups/{company}/company

PUT /assetsCore/assetsSetups/{company}/company

PUT Set DepreciationArea AssetsSetupDetail

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

The following elements are required:

company	(string) The company where the following setup applies.
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/assetsSetups/{company}/assetsSetupDetails/{lineId}/depreciationArea

PUT /assetsCore/assetsSetups/{company}/assetsSetupDetails/{lineId}/depreciationArea

PUT Set DepreciationJournal AssetsSetup

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

The following elements are required:

company	(string) The company where the following setup applies.
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/assetsSetups/{company}/depreciationJournal

PUT /assetsCore/assetsSetups/{company}/depreciationJournal

PUT Set DisposalTransferJournal AssetsSetup

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

The following elements are required:

company	(string) The company where the following setup applies.
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/assetsSetups/{company}/disposalTransferJournal

PUT /assetsCore/assetsSetups/{company}/disposalTransferJournal

PUT Set ForcastLedger AssetsSetupDetail

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

The following elements are required:

company	(string) The company where the following setup applies.
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/assetsSetups/{company}/assetsSetupDetails/{lineId}/forcastLedger

PUT /assetsCore/assetsSetups/{company}/assetsSetupDetails/{lineId}/forcastLedger

PUT Set ImparityLossesJournal AssetsSetup

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

The following elements are required:

company	(string) The company where the following setup applies.
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/assetsSetups/{company}/imparityLossesJournal

PUT /assetsCore/assetsSetups/{company}/imparityLossesJournal

PUT Set ImportJournal AssetsSetup

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

The following elements are required:

company	(string) The company where the following setup applies.
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/assetsSetups/{company}/importJournal

PUT /assetsCore/assetsSetups/{company}/importJournal

PUT Set IsActive AssetsSetup

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

The following elements are required:

company	(string) The company where the following setup applies.
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/assetsSetups/{company}/isActive

PUT /assetsCore/assetsSetups/{company}/isActive

PUT Set Ledger AssetsSetupDetail

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

The following elements are required:

company	(string) The company where the following setup applies.
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/assetsSetups/{company}/assetsSetupDetails/{lineId}/ledger

PUT /assetsCore/assetsSetups/{company}/assetsSetupDetails/{lineId}/ledger

PUT Set Custom Attribute AssetsSetup

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

The following elements are required:

companyKey	(string) The company key.
company	(string) The company where the following setup applies
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/assetsSetups/{companyKey}/{company}/{customAttributeName}

PUT /assetsCore/assetsSetups/{companyKey}/{company}/{customAttributeName}

PUT Set Custom Attribute AssetsSetupDetail

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

The following elements are required:

companyKey	(string) The company key.
company	(string) The company where the following setup applies
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/assetsSetups/{companyKey}/{company}/assetsSetupDetails/{lineId}/{customAttributeName}

PUT /assetsCore/assetsSetups/{companyKey}/{company}/assetsSetupDetails/{lineId}/{customAttributeName}

DELETE Operations

DELETE Assets Setup Detail by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

company	(string) The company where the following setup applies.
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/assetsSetups/{company}/assetsSetupDetails/{lineId}

DELETE /assetsCore/assetsSetups/{company}/assetsSetupDetails/{lineId}

DELETE AssetsSetup 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/assetsSetups/{id}

DELETE /assetsCore/assetsSetups/{id}

DELETE AssetsSetup by key

Deletes the entity record that matches the specified key.

The following elements are required:

company

(string) The company where the following setup applies.

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/assetsSetups/{company}

DELETE /assetsCore/assetsSetups/{company}

Resources

ApiAssetsSetupAssetsSetupDetailsResource

The following elements are required:

depreciationArea	(string) The key of the depreciation area.
ledger	(string) The actual ledger where the values are posted.
forcastLedger	(string) The ledger o be used as forecast.

ApiAssetsSetupResource

The following elements are required:

company	(string) The company where the following setup applies.
assetScrapJournal	(string) The default journal to be used in asset scrap posting.
assetSaleJournal	(string) The default journal to be used in asset sale posting.
assetAquisitionJournal	(string) The default journal to be used in asset aquisition posting.
depreciationJournal	(string) The default journal to be used in asset depreciation posting.
imparityLossesJournal	(string) The default journal to be used in special depreciation posting.
importJournal	(string) The default journal to be used in asset history import.
aquisitionTransferJournal	(string) The default journal to be used in an asset aquisition transfer.
disposalTransferJournal	(string) The default journal to be used in an asset disposal transfer.

The following elements are optional:

assetsSetupDetails

(List of ApiAssetsSetupAssetsSetupDetailsResource) Reference list of setup details.
See ApiAssetsSetupAssetsSetupDetailsResource.

AssetsSetupDetailResource

The following elements are required:

depreciationArea	(string) The key of the depreciation area.
ledger	(string) The actual ledger where the values are posted.
forcastLedger	(string) The ledger o be used as forecast.

AssetsSetupResource

The following elements are required:

company	(string) The company where the following setup applies. (fk) Allowed value: the natural key of a record of type Company. These records are accessibly through the Companies service.
assetScrapJournal	(string) The default journal to be used in asset scrap posting. (fk) Allowed value: the natural key of a record of type JournalType. These records are accessibly through the JournalTypes service.
assetSaleJournal	(string) The default journal to be used in asset sale posting. (fk) Allowed value: the natural key of a record of type JournalType. These records are accessibly through the JournalTypes service.
assetAquisitionJournal	(string) The default journal to be used in asset aquisition posting. (fk) Allowed value: the natural key of a record of type JournalType. These records are accessibly through the JournalTypes service.
depreciationJournal	(string) The default journal to be used in asset depreciation posting. (fk) Allowed value: the natural key of a record of type JournalType. These records are accessibly through the JournalTypes service.
imparityLossesJournal	(string) The default journal to be used in special depreciation posting. (fk) Allowed value: the natural key of a record of type JournalType. These records are accessibly through the JournalTypes service.
importJournal	(string) The default journal to be used in asset history import. (fk) Allowed value: the natural key of a record of type JournalType. These records are accessibly through the JournalTypes service.
aquisitionTransferJournal	(string) The default journal to be used in an asset aquisition transfer. (fk) Allowed value: the natural key of a record of type JournalType. These records are accessibly through the JournalTypes service.
disposalTransferJournal	(string) The default journal to be used in an asset disposal transfer. (fk) Allowed value: the natural key of a record of type JournalType. These records are accessibly through the JournalTypes service.

The following elements are optional:

assetsSetupDetails

(List of AssetsSetupDetailResource) Reference list of setup details.
See AssetsSetupDetailResource.

DefaultDepreciationArea

The following elements are optional:

depreciationID	(Guid) The Depreciation Area Id,.
depreciationKey	(string) The Depreciation Area Key.
description	(string) The Depreciation Area Description.

ExtensibilityCustomAttributeValueResource

The following elements are required:

value

(object) The custom attribute value.