Assets | Acquisition
The Asset Acquisition end point is used to record the information related with the process of an acquisition such as the asset and value.
Overview
URL | api/{tenantKey}/{orgKey}/assets/assetAcquisitions |
Methods Supported | GET, POST, PUT, DELETE |
All Operations
This service includes the following operations:
- GET:
- POST:
-
PUT:
- PUT Set Custom Attribute AssetAcquisition
- PUT Set Custom Attribute AssetAcquisitionLine
- PUT Set IsActive AssetAcquisition
- PUT Set Note AssetAcquisition
- PUT Set Remarks AssetAcquisition
- PUT Set ChartOfAccount AssetAcquisition
- PUT Set SourceSchemaEntityId AssetAcquisitionLine
- PUT Set GLAccount AssetAcquisitionLine
- PUT Set ChartOfAccount AssetAcquisitionLine
- PUT Set ExchangeRate AssetAcquisitionLine
- PUT Set ExchangeRateDate AssetAcquisitionLine
- DELETE:
All Resources
This service uses the following resources:
- AcquistionLineAccountResource
- ApiAssetAcquisitionDocumentLinesDocumentLineAccountsResource
- ApiAssetAcquisitionDocumentLinesResource
- ApiAssetAcquisitionResource
- AssetAcquisitionLineResource
- AssetAcquisitionResource
- MoneyResource
- ExtensibilityCustomAttributeValueResource
All Enumerations
This service uses the following enumerations:
GET AssetAcquisitions
Returns the list of all the entity records available.
Response:
When successful, the response body contains the list of records available. See AssetAcquisitionResource. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET AssetAcquisitions (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 AssetAcquisitionResource. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET AssetAcquisition 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 AssetAcquisitionResource. |
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 AssetAcquisition by key
Returns the entity record that matches the specified key.
The following elements are required:
companyKey | (string) The company key. |
journalType | (string) The journal type of the transaction. |
financialYear | (string) The financial year. |
ledger | (string) The ledger to be used when posting in accounting. The default value is the company's General Ledger. |
seriesNumber | (int) The journal number assigned to the journal entry. An journal number is a number used to identify a journal entry. It is set up in Journal Type maintenance. |
Response:
When successful, the response body contains the entity record. See AssetAcquisitionResource. |
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 AssetAcquisition 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 AssetAcquisition by key
Prints the specified entity record.
The following elements are required:
companyKey | (string) The company key. |
journalType | (string) The journal type of the transaction. |
financialYear | (string) The financial year. |
ledger | (string) The ledger to be used when posting in accounting. The default value is the company's General Ledger. |
seriesNumber | (int) The journal number assigned to the journal entry. An journal number is a number used to identify a journal entry. It is set up in Journal Type maintenance. |
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 AssetAcquisitionOriginal 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 AssetAcquisition by key
Prints the specified entity record.
The following elements are required:
companyKey | (string) The company key. |
journalType | (string) The journal type of the transaction. |
financialYear | (string) The financial year. |
ledger | (string) The ledger to be used when posting in accounting. The default value is the company's General Ledger. |
seriesNumber | (int) The journal number assigned to the journal entry. An journal number is a number used to identify a journal entry. It is set up in Journal Type maintenance. |
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 AssetAcquisitions
Creates a new entity record.
The following elements are required:
assetAcquisitionResource | (ApiAssetAcquisitionResource) The request body should contain the entity record that should be created. See ApiAssetAcquisitionResource. |
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 ApiAssetAcquisitionResource. |
Response status codes:
201 | Created. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set ChartOfAccount AssetAcquisition
Updates the value of attribute 'ChartOfAccount' in the specified entity record.
The following elements are required:
journalType | (string) The journal type of the transaction. |
financialYear | (string) The financial year. |
ledger | (string) The ledger to be used when posting in accounting. The default value is the company's General Ledger. |
seriesNumber | (int) The journal number assigned to the journal entry. An journal number is a number used to identify a journal entry. It is set up in Journal Type maintenance. |
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 ChartOfAccount AssetAcquisitionLine
Updates the value of attribute 'ChartOfAccount' in the specified entity record.
The following elements are required:
journalType | (string) The journal type of the transaction. |
financialYear | (string) The financial year. |
ledger | (string) The ledger to be used when posting in accounting. The default value is the company's General Ledger. |
seriesNumber | (int) The journal number assigned to the journal entry. An journal number is a number used to identify a journal entry. It is set up in Journal Type maintenance. |
lineId | (string) The detail identifier. |
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 ExchangeRate AssetAcquisitionLine
Updates the value of attribute 'ExchangeRate' in the specified entity record.
The following elements are required:
journalType | (string) The journal type of the transaction. |
financialYear | (string) The financial year. |
ledger | (string) The ledger to be used when posting in accounting. The default value is the company's General Ledger. |
seriesNumber | (int) The journal number assigned to the journal entry. An journal number is a number used to identify a journal entry. It is set up in Journal Type maintenance. |
lineId | (string) The detail identifier. |
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 AssetAcquisitionLine
Updates the value of attribute 'ExchangeRateDate' in the specified entity record.
The following elements are required:
journalType | (string) The journal type of the transaction. |
financialYear | (string) The financial year. |
ledger | (string) The ledger to be used when posting in accounting. The default value is the company's General Ledger. |
seriesNumber | (int) The journal number assigned to the journal entry. An journal number is a number used to identify a journal entry. It is set up in Journal Type maintenance. |
lineId | (string) The detail identifier. |
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 AssetAcquisitionLine
Updates the value of attribute 'GLAccount' in the specified entity record.
The following elements are required:
journalType | (string) The journal type of the transaction. |
financialYear | (string) The financial year. |
ledger | (string) The ledger to be used when posting in accounting. The default value is the company's General Ledger. |
seriesNumber | (int) The journal number assigned to the journal entry. An journal number is a number used to identify a journal entry. It is set up in Journal Type maintenance. |
lineId | (string) The detail identifier. |
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 AssetAcquisition
Updates the value of attribute 'IsActive' in the specified entity record.
The following elements are required:
journalType | (string) The journal type of the transaction. |
financialYear | (string) The financial year. |
ledger | (string) The ledger to be used when posting in accounting. The default value is the company's General Ledger. |
seriesNumber | (int) The journal number assigned to the journal entry. An journal number is a number used to identify a journal entry. It is set up in Journal Type maintenance. |
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 AssetAcquisition
Updates the value of attribute 'Note' in the specified entity record.
The following elements are required:
journalType | (string) The journal type of the transaction. |
financialYear | (string) The financial year. |
ledger | (string) The ledger to be used when posting in accounting. The default value is the company's General Ledger. |
seriesNumber | (int) The journal number assigned to the journal entry. An journal number is a number used to identify a journal entry. It is set up in Journal Type maintenance. |
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 Remarks AssetAcquisition
Updates the value of attribute 'Remarks' in the specified entity record.
The following elements are required:
journalType | (string) The journal type of the transaction. |
financialYear | (string) The financial year. |
ledger | (string) The ledger to be used when posting in accounting. The default value is the company's General Ledger. |
seriesNumber | (int) The journal number assigned to the journal entry. An journal number is a number used to identify a journal entry. It is set up in Journal Type maintenance. |
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 SourceSchemaEntityId AssetAcquisitionLine
Updates the value of attribute 'SourceSchemaEntityId' in the specified entity record.
The following elements are required:
journalType | (string) The journal type of the transaction. |
financialYear | (string) The financial year. |
ledger | (string) The ledger to be used when posting in accounting. The default value is the company's General Ledger. |
seriesNumber | (int) The journal number assigned to the journal entry. An journal number is a number used to identify a journal entry. It is set up in Journal Type maintenance. |
lineId | (string) The detail identifier. |
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 Custom Attribute AssetAcquisition
Updates the value of 'CustomAttribute' in the specified entity record.
The following elements are required:
companyKey | (string) The company key. |
journalType | (string) The journal type of the transaction. |
financialYear | (string) The financial year. |
ledger | (string) The ledger to be used when posting in accounting. The default value is the company's General Ledger. |
seriesNumber | (int) The journal number assigned to the journal entry. An journal number is a number used to identify a journal entry. It is set up in Journal Type maintenance. |
customAttributeName | (string) The custom attribute name. |
value | (ExtensibilityCustomAttributeValueResource) The request body should contain the new value for the custom attribute. See ExtensibilityCustomAttributeValueResource. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
404 | NotFound. The specified record does not exist. |
Resource URL:
PUT Set Custom Attribute AssetAcquisitionLine
Updates the value of 'CustomAttribute' in the specified entity record.
The following elements are required:
companyKey | (string) The company key. |
journalType | (string) The journal type of the transaction. |
financialYear | (string) The financial year. |
ledger | (string) The ledger to be used when posting in accounting. The default value is the company's General Ledger. |
seriesNumber | (int) The journal number assigned to the journal entry. An journal number is a number used to identify a journal entry. It is set up in Journal Type maintenance. |
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:
DELETE AssetAcquisition 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 AssetAcquisition by key
Deletes the entity record that matches the specified key.
The following elements are required:
companyKey | (string) The company key. |
journalType | (string) The journal type of the transaction. |
financialYear | (string) The financial year. |
ledger | (string) The ledger to be used when posting in accounting. The default value is the company's General Ledger. |
seriesNumber | (int) The journal number assigned to the journal entry. An journal number is a number used to identify a journal entry. It is set up in Journal Type maintenance. |
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
AcquistionLineAccountResource
The following elements are required:
chartOfAccount | (string) The chart of accounts of the company (Internal). |
gLAccount | (string) The GL account to be posted. Internally resolved. |
amount | (MoneyResource) Internal Field not used.
See MoneyResource . |
depreciationArea | (string) The Asset SetUp depreciation area. Automatically resolved. |
ledger | (string) The actual ledger where the values are posted. |
The following elements are optional:
currency | (string) The currency of the monetary fields. |
assetTransactionAccountType | (enum AssetTransactionAccountType) The Asset Class Detail GlAccount. Automatically resolved.
See AssetTransactionAccountType. |
ApiAssetAcquisitionDocumentLinesDocumentLineAccountsResource
The following elements are required:
chartOfAccount | (string) The chart of accounts of the company (Internal). |
gLAccount | (string) The GL account to be posted. Internally resolved. |
amount | (MoneyResource) Internal Field not used.
See MoneyResource . |
depreciationArea | (string) The Asset SetUp depreciation area. Automatically resolved. |
ledger | (string) The actual ledger where the values are posted. |
The following elements are optional:
currency | (string) The currency of the monetary fields. |
assetTransactionAccountType | (enum AssetTransactionAccountType) The Asset Class Detail GlAccount. Automatically resolved.
See AssetTransactionAccountType. |
ApiAssetAcquisitionDocumentLinesResource
The following elements are required:
sourceDocLineId | (Guid) The original document line id. |
quantity | (int) The quantity selected from the original document. |
assetClass | (string) Select the asset class is to be created. |
updateCurrentQuantity | (bool) Select if the current quantity of the existing asset is to be updated. |
currency | (string) the currency of the monetary fields. |
createAsset | (bool) Select if the asset is to be created. |
sourceSchemaEntityId | (Guid) The original document line schema id. |
exchangeRate | (decimal) Exchange Rate. |
The following elements are optional:
sourceDocId | (Guid) The original document reference id. |
sourceDocLine | (int) The original document line number. |
putInServiceDate | (DateTime) For new assets the put in service date has to be assigned. |
description | (string) The description to be used if the asset is to be created. |
unit | (string) The unit of measure of the original document line. |
note | (string) The customer original order number. |
financialAsset | (string) Select an existing asset number to be capitalized. |
dimensionSetJson | (string) The json representation of the dimension set (Internal). |
dimensionSet | (string) The dimensions to be used if the asset is to be created. by default the original dimensions are used. |
documentLineAccounts | (List of ApiAssetAcquisitionDocumentLinesDocumentLineAccountsResource) Document Line Accounts.
See ApiAssetAcquisitionDocumentLinesDocumentLineAccountsResource. |
gLAccount | (string) Clearing Account. |
chartOfAccount | (string) The chart of accounts of the company (Internal). |
exchangeRateDate | (DateTime) Exchange Rate Date. |
ApiAssetAcquisitionResource
The following elements are required:
company | (string) The company code is the central organizational unit of the system. This is to whose transactions will be posted . You must define at least one company before create the journal entry transaction, but if you have only one company the system will select then automatically. |
journalType | (string) The journal type of the transaction. |
financialYear | (string) The financial year. |
ledger | (string) The ledger to be used when posting in accounting. The default value is the company's General Ledger. |
seriesNumber | (int) The journal number assigned to the journal entry. An journal number is a number used to identify a journal entry. It is set up in Journal Type maintenance. |
postingDate | (DateTime) The date when the document is created. |
documentDate | (DateTime) The date when the document is issued. |
documentLines | (List of ApiAssetAcquisitionDocumentLinesResource) The acquisition document lines.
See ApiAssetAcquisitionDocumentLinesResource. |
The following elements are optional:
note | (string) A reference of the journal entry, normally the external number identification (eg. the vendor document number). |
remarks | (string) A place to store related information with the journal entry. |
chartOfAccount | (string) The chart of accounts of the company (Internal). |
AssetAcquisitionLineResource
The following elements are required:
supplierParty | (string) The supplier of the original document. |
sourceDoc | (string) The original document reference. |
sourceDocLineId | (Guid) The original document line id. |
quantity | (int) The quantity selected from the original document. |
assetClass | (string) Select the asset class is to be created. |
updateCurrentQuantity | (bool) Select if the current quantity of the existing asset is to be updated. |
amount | (MoneyResource) The amount to be capitalized.
See MoneyResource . |
currency | (string) the currency of the monetary fields. |
createAsset | (bool) Select if the asset is to be created. |
sourceSchemaEntityId | (Guid) The original document line schema id. |
exchangeRate | (decimal) Exchange Rate. |
The following elements are optional:
sourceDocId | (Guid) The original document reference id. |
sourceDocLine | (int) The original document line number. |
putInServiceDate | (DateTime) For new assets the put in service date has to be assigned. |
description | (string) The description to be used if the asset is to be created. |
unit | (string) The unit of measure of the original document line. |
note | (string) The customer original order number. |
financialAsset | (string) Select an existing asset number to be capitalized. |
dimensionSetJson | (string) The json representation of the dimension set (Internal). |
dimensionSet | (string) The dimensions to be used if the asset is to be created. by default the original dimensions are used. |
documentLineAccounts | (List of AcquistionLineAccountResource) Document Line Accounts.
See AcquistionLineAccountResource. |
gLAccount | (string) Clearing Account. |
chartOfAccount | (string) The chart of accounts of the company (Internal). |
exchangeRateDate | (DateTime) Exchange Rate Date. |
AssetAcquisitionResource
The following elements are required:
company | (string) The company code is the central organizational unit of the system. This is to whose transactions will be posted . You must define at least one company before create the journal entry transaction, but if you have only one company the system will select then automatically.
(fk) Allowed value: the natural key of a record of type Company. These records are accessibly through the Companies service. |
journalType | (string) The journal type of the transaction.
(fk) Allowed value: the natural key of a record of type JournalType. These records are accessibly through the JournalTypes service. |
financialYear | (string) The financial year.
(fk) Allowed value: the natural key of a record of type FinancialYear. These records are accessibly through the FinancialYears service. |
ledger | (string) The ledger to be used when posting in accounting. The default value is the company's General Ledger.
(fk) Allowed value: the natural key of a record of type Ledger. These records are accessibly through the Ledgers service. |
seriesNumber | (int) The journal number assigned to the journal entry. An journal number is a number used to identify a journal entry. It is set up in Journal Type maintenance. |
postingDate | (DateTime) The date when the document is created. |
documentDate | (DateTime) The date when the document is issued. |
currency | (string) The currency of the journal entry.
(fk) Allowed value: the natural key of a record of type Currency. These records are accessibly through the Currencies service. |
documentLines | (List of AssetAcquisitionLineResource) The acquisition document lines.
See AssetAcquisitionLineResource. |
financialPeriod | (int) The Financial year period. |
totalAmount | (MoneyResource) The doucument Total.
See MoneyResource . |
The following elements are optional:
note | (string) A reference of the journal entry, normally the external number identification (eg. the vendor document number). |
remarks | (string) A place to store related information with the journal entry. |
accountingDocument | (string) The accounting document that was assigned in accounting. |
financialPeriodName | (string) The financial period name. |
chartOfAccount | (string) The chart of accounts of the company (Internal).
(fk) Allowed value: the natural key of a record of type ChartOfAccount. These records are accessibly through the ChartOfAccounts service. |
MoneyResource
The following elements are required:
amount | (decimal) The amount. |
The following elements are optional:
baseAmount | (decimal) The base amount. |
reportingAmount | (decimal) The reporting amount. |
fractionDigits | (int) The fraction digits. |
symbol | (string) The symbol. |
Notes: For the POST operation it is not necessary to send the fields: BaseAmount, ReportingAmount, FractionDigits and Symbol. Will be ignored.
ExtensibilityCustomAttributeValueResource
The following elements are required:
value | (object) The custom attribute value. |