Assets | Asset Transaction Request

The Asset Transaction Request end point is used to rectify accounts used in a purchase or sale of an asset.

Overview

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

All Operations

This service includes the following operations:

• GET:
  • GET AssetTransactionRequests
  • GET AssetTransactionRequests (paged)
  • GET AssetTransactionRequest by identifier
  • GET AssetTransactionRequest by key
  • GET Print AssetTransactionRequest by identifier
  • GET Print AssetTransactionRequest by key
  • GET Original Print AssetTransactionRequestOriginal by identifier
  • GET Original Print AssetTransactionRequest by key
• POST:
  • POST AssetTransactionRequests
• PUT:
  • PUT Set IsActive AssetTransactionRequest
  • PUT Set Company AssetTransactionRequest
  • PUT Set SourceDoc AssetTransactionRequest
  • PUT Set SourceDocLine AssetTransactionRequest
  • PUT Set SourceDocId AssetTransactionRequest
  • PUT Set SourceDocLineId AssetTransactionRequest
  • PUT Set SourceSchemaEntity AssetTransactionRequest
  • PUT Set Note AssetTransactionRequest
  • PUT Set Description AssetTransactionRequest
  • PUT Set AssetTransactionType AssetTransactionRequest
  • PUT Set Party AssetTransactionRequest
  • PUT Set Amount AssetTransactionRequest
  • PUT Set Currency AssetTransactionRequest
  • PUT Set Quantity AssetTransactionRequest
  • PUT Set OpenQuantity AssetTransactionRequest
  • PUT Set Unit AssetTransactionRequest
  • PUT Set PostingDate AssetTransactionRequest
  • PUT Set DocumentDate AssetTransactionRequest
  • PUT Set GLAccount AssetTransactionRequest
  • PUT Set ChartOfAccount AssetTransactionRequest
  • PUT Set ExchangeRate AssetTransactionRequest
  • PUT Set ExchangeRateDate AssetTransactionRequest
• DELETE:
  • DELETE AssetTransactionRequest by identifier
  • DELETE AssetTransactionRequest by key

All Resources

This service uses the following resources:

• ApiAssetTransactionRequestResource
• AssetTransactionRequestResource
• MoneyResource

All Enumerations

This service uses the following enumerations:

• AssetTransactionType

GET Operations

GET AssetTransactionRequests

Returns the list of all the entity records available.

Response:

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

Response status codes:

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

Resource URL:

GET AssetTransactionRequests (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 AssetTransactionRequestResource.

Response status codes:

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

Resource URL:

GET AssetTransactionRequest 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 AssetTransactionRequestResource.

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 AssetTransactionRequest by key

Returns the entity record that matches the specified key.

The following elements are required:

companyKey	(string) The company key.
assetTransactionRequestKey	(int) The asset transaction request key.

Response:

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

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 Print AssetTransactionRequest 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 Print AssetTransactionRequest by key

Prints the specified entity record.

The following elements are required:

companyKey	(string) The company key.
assetTransactionRequestKey	(int) The asset transaction request 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 Original Print AssetTransactionRequestOriginal 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 Original Print AssetTransactionRequest by key

Prints the specified entity record.

The following elements are required:

companyKey	(string) The company key.
assetTransactionRequestKey	(int) The asset transaction request 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:

POST Operations

POST AssetTransactionRequests

Creates a new entity record.

The following elements are required:

assetTransactionRequestResource

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

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

Response status codes:

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

Resource URL:

PUT Operations

PUT Set Amount AssetTransactionRequest

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

The following elements are required:

assetTransactionRequestKey	(int) The asset transaction request key.
companyKey	(string) The company key.
value	(decimal) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT Set AssetTransactionType AssetTransactionRequest

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

The following elements are required:

assetTransactionRequestKey	(int) The asset transaction request key.
companyKey	(string) The company key.
value	(enum AssetTransactionType) The request body should contain the new value for the attribute. See AssetTransactionType.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT Set ChartOfAccount AssetTransactionRequest

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

The following elements are required:

assetTransactionRequestKey	(int) The asset transaction request 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:

PUT Set Company AssetTransactionRequest

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

The following elements are required:

assetTransactionRequestKey	(int) The asset transaction request 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:

PUT Set Currency AssetTransactionRequest

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

The following elements are required:

assetTransactionRequestKey	(int) The asset transaction request 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:

PUT Set Description AssetTransactionRequest

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

The following elements are required:

assetTransactionRequestKey	(int) The asset transaction request 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:

PUT Set DocumentDate AssetTransactionRequest

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

The following elements are required:

assetTransactionRequestKey	(int) The asset transaction request 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:

PUT Set ExchangeRate AssetTransactionRequest

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

The following elements are required:

assetTransactionRequestKey	(int) The asset transaction request key.
companyKey	(string) The company key.
value	(decimal) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT Set ExchangeRateDate AssetTransactionRequest

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

The following elements are required:

assetTransactionRequestKey	(int) The asset transaction request 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:

PUT Set GLAccount AssetTransactionRequest

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

The following elements are required:

assetTransactionRequestKey	(int) The asset transaction request 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:

PUT Set IsActive AssetTransactionRequest

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

The following elements are required:

assetTransactionRequestKey	(int) The asset transaction request 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:

PUT Set Note AssetTransactionRequest

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

The following elements are required:

assetTransactionRequestKey	(int) The asset transaction request 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:

PUT Set OpenQuantity AssetTransactionRequest

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

The following elements are required:

assetTransactionRequestKey	(int) The asset transaction request 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:

PUT Set Party AssetTransactionRequest

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

The following elements are required:

assetTransactionRequestKey	(int) The asset transaction request 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:

PUT Set PostingDate AssetTransactionRequest

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

The following elements are required:

assetTransactionRequestKey	(int) The asset transaction request 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:

PUT Set Quantity AssetTransactionRequest

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

The following elements are required:

assetTransactionRequestKey	(int) The asset transaction request 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:

PUT Set SourceDoc AssetTransactionRequest

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

The following elements are required:

assetTransactionRequestKey	(int) The asset transaction request 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:

PUT Set SourceDocId AssetTransactionRequest

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

The following elements are required:

assetTransactionRequestKey	(int) The asset transaction request key.
companyKey	(string) The company key.
value	(Guid) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT Set SourceDocLine AssetTransactionRequest

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

The following elements are required:

assetTransactionRequestKey	(int) The asset transaction request 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:

PUT Set SourceDocLineId AssetTransactionRequest

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

The following elements are required:

assetTransactionRequestKey	(int) The asset transaction request key.
companyKey	(string) The company key.
value	(Guid) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT Set SourceSchemaEntity AssetTransactionRequest

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

The following elements are required:

assetTransactionRequestKey	(int) The asset transaction request 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:

PUT Set Unit AssetTransactionRequest

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

The following elements are required:

assetTransactionRequestKey	(int) The asset transaction request 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:

DELETE Operations

DELETE AssetTransactionRequest 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 AssetTransactionRequest by key

Deletes the entity record that matches the specified key.

The following elements are required:

companyKey	(string) The company key.
assetTransactionRequestKey	(int) The asset transaction request key.

Response:

When successful, the response body is empty.

Response status codes:

204	Deleted. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

Resources

ApiAssetTransactionRequestResource

The following elements are required:

company	(string) The company key.
sourceDoc	(string) The original document.
sourceDocId	(Guid) The original document identifier.
sourceDocLineId	(Guid) The original document line identifier.
sourceSchemaEntity	(string) The original document schema entity.
assetTransactionType	(enum AssetTransactionType) The type of asset transaction ex.: capitalization. See AssetTransactionType.
party	(string) The original document party.
amount	(MoneyResource) The original document line amount. See MoneyResource .
currency	(string) The transaction currency.
quantity	(int) The quantity to be adjusted.
openQuantity	(int) The remaining quantities.
postingDate	(DateTime) The posting date.
documentDate	(DateTime) The date when the document is issued.
gLAccount	(string) The Clearing acccount key.
chartOfAccount	(string) The Chart of accounts key.
exchangeRate	(decimal) The exchange rate from transaction currency to base currency of the original document.

The following elements are optional:

sourceDocLine	(int) The original document line.
note	(string) The document's note.
description	(string) The transaction request description.
unit	(string) The unit of measure.
exchangeRateDate	(DateTime) The exchange rate creation date.

AssetTransactionRequestResource

The following elements are required:

assetTransactionRequestKey	(int) The asset transaction request key.
company	(string) The company key. (fk) Allowed value: the natural key of a record of type Company. These records are accessibly through the Companies service.
sourceDoc	(string) The original document.
sourceDocId	(Guid) The original document identifier.
sourceDocLineId	(Guid) The original document line identifier.
sourceSchemaEntity	(string) The original document schema entity. (fk) Allowed value: the natural key of a record of type SchemaEntity. These records are accessibly through the SchemaEntities service.
assetTransactionType	(enum AssetTransactionType) The type of asset transaction ex.: capitalization. See AssetTransactionType.
party	(string) The original document party. (fk) Allowed value: the natural key of a record of type Party. These records are accessibly through the Parties service.
amount	(MoneyResource) The original document line amount. See MoneyResource .
currency	(string) The transaction currency. (fk) Allowed value: the natural key of a record of type Currency. These records are accessibly through the Currencies service.
quantity	(int) The quantity to be adjusted.
openQuantity	(int) The remaining quantities.
postingDate	(DateTime) The posting date.
documentDate	(DateTime) The date when the document is issued.
gLAccount	(string) The Clearing acccount key. (fk) Allowed value: the natural key of a record of type GLAccount. These records are accessibly through the GLAccounts service.
chartOfAccount	(string) The Chart of accounts key. (fk) Allowed value: the natural key of a record of type ChartOfAccount. These records are accessibly through the ChartOfAccounts service.
exchangeRate	(decimal) The exchange rate from transaction currency to base currency of the original document.

The following elements are optional:

sourceDocLine	(int) The original document line.
note	(string) The document's note.
description	(string) The transaction request description.
unit	(string) The unit of measure. (fk) Allowed value: the natural key of a record of type Unit. These records are accessibly through the Units service.
exchangeRateDate	(DateTime) The exchange rate creation date.

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.

Enumerations

AssetTransactionType

1	Capitalization
2	Scrap
3	Sale
4	Imparity
5	OtherCosts
6	Revenue
7	Depreciation
8	RetrospectiveDepreciation