Assets | Value Adjustment
The Asset Value Adjustment end point is used to record the information related with the process of a value adjustment such as the asset and value.
Overview
| URL | api/{tenantKey}/{orgKey}/assets/assetValueAdjustments |
| Methods Supported | GET, POST, PUT, DELETE |
All Operations
This service includes the following operations:
-
GET:
- GET AssetValueAdjustments
- GET AssetValueAdjustments (paged)
- GET AssetValueAdjustment by identifier
- GET AssetValueAdjustment by key
- GET Print AssetValueAdjustment by identifier
- GET Print AssetValueAdjustment by key
- GET Original Print AssetValueAdjustmentOriginal by identifier
- GET Original Print AssetValueAdjustment by key
- POST:
-
PUT:
- PUT Set Custom Attribute AssetValueAdjustment
- PUT Set Custom Attribute AssetValueAdjustmentLine
- PUT Set IsActive AssetValueAdjustment
- PUT Set ImpairmentReason AssetValueAdjustment
- PUT Set Remarks AssetValueAdjustment
- PUT Set IsPrinted AssetValueAdjustment
- PUT Set ExchangeRate AssetValueAdjustment
- PUT Set ExchangeRateDate AssetValueAdjustment
- PUT Set ChartOfAccount AssetValueAdjustment
- PUT Set PrintedReportName AssetValueAdjustment
- PUT Set DimensionSet AssetValueAdjustmentLine
- PUT Set DimensionSetJson AssetValueAdjustmentLine
- PUT Set RemainingLife AssetValueAdjustmentLine
- DELETE:
All Resources
This service uses the following resources:
- AdjustmentLineAccountResource
- ApiAssetValueAdjustmentDocumentLinesDocumentLineAccountsResource
- ApiAssetValueAdjustmentDocumentLinesResource
- ApiAssetValueAdjustmentResource
- AssetValueAdjustmentLineResource
- AssetValueAdjustmentResource
- MoneyResource
- ExtensibilityCustomAttributeValueResource
All Enumerations
This service uses the following enumerations:
GET AssetValueAdjustments
Returns the list of all the entity records available.
Response:
| When successful, the response body contains the list of records available. See AssetValueAdjustmentResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/assets/assetValueAdjustments
GET /assets/assetValueAdjustments
GET AssetValueAdjustments (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 AssetValueAdjustmentResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/assets/assetValueAdjustments?page={page}&pageSize={pageSize}
GET /assets/assetValueAdjustments?page={page}&pageSize={pageSize}
GET AssetValueAdjustment 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 AssetValueAdjustmentResource. |
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}/assets/assetValueAdjustments/{id}
GET /assets/assetValueAdjustments/{id}
GET AssetValueAdjustment by key
Returns the entity record that matches the specified key.
The following elements are required:
| companyKey | (string) The company key. |
| journalType | (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. |
| financialYear | (string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods. |
| ledger | (string) The depreciation area's ledger to be used when posting in accounting. |
| 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 AssetValueAdjustmentResource. |
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}/assets/assetValueAdjustments/{companyKey}/{journalType}/{financialYear}/{ledger}/{seriesNumber}
GET /assets/assetValueAdjustments/{companyKey}/{journalType}/{financialYear}/{ledger}/{seriesNumber}
GET Print AssetValueAdjustment 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}/assets/assetValueAdjustments/{id}/print?template={template}
GET /assets/assetValueAdjustments/{id}/print?template={template}
GET Print AssetValueAdjustment by key
Prints the specified entity record.
The following elements are required:
| companyKey | (string) The company key. |
| journalType | (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. |
| financialYear | (string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods. |
| ledger | (string) The depreciation area's ledger to be used when posting in accounting. |
| 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:
api/{tenantKey}/{orgKey}/assets/assetValueAdjustments/{companyKey}/{journalType}/{financialYear}/{ledger}/{seriesNumber}/print
GET /assets/assetValueAdjustments/{companyKey}/{journalType}/{financialYear}/{ledger}/{seriesNumber}/print
GET Original Print AssetValueAdjustmentOriginal 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}/assets/assetValueAdjustments/{id}/printOriginal?template={template}
GET /assets/assetValueAdjustments/{id}/printOriginal?template={template}
GET Original Print AssetValueAdjustment by key
Prints the specified entity record.
The following elements are required:
| companyKey | (string) The company key. |
| journalType | (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. |
| financialYear | (string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods. |
| ledger | (string) The depreciation area's ledger to be used when posting in accounting. |
| 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:
api/{tenantKey}/{orgKey}/assets/assetValueAdjustments/{companyKey}/{journalType}/{financialYear}/{ledger}/{seriesNumber}/printOriginal
GET /assets/assetValueAdjustments/{companyKey}/{journalType}/{financialYear}/{ledger}/{seriesNumber}/printOriginal
POST AssetValueAdjustments
Creates a new entity record.
The following elements are required:
| assetValueAdjustmentResource | (ApiAssetValueAdjustmentResource) The request body should contain the entity record that should be created. See ApiAssetValueAdjustmentResource. |
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 ApiAssetValueAdjustmentResource. |
Response status codes:
| 201 | Created. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/assets/assetValueAdjustments
POST /assets/assetValueAdjustments
POST Asset Value Adjustment
Inserts a new 'Asset Value Adjustment Line' in the 'Asset Value Adjustment'.
The following elements are required:
| journalType | (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. |
| financialYear | (string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods. |
| ledger | (string) The depreciation area's ledger to be used when posting in accounting. |
| 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 | (ApiAssetValueAdjustmentDocumentLinesResource) The ApiAssetValueAdjustmentDocumentLinesResource instance. See ApiAssetValueAdjustmentDocumentLinesResource. |
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}/assets/assetValueAdjustments/{companyKey}/{journalType}/{financialYear}/{ledger}/{seriesNumber}/documentLines
POST /assets/assetValueAdjustments/{companyKey}/{journalType}/{financialYear}/{ledger}/{seriesNumber}/documentLines
PUT Set ChartOfAccount AssetValueAdjustment
Updates the value of attribute 'ChartOfAccount' in the specified entity record.
The following elements are required:
| journalType | (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. |
| financialYear | (string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods. |
| ledger | (string) The depreciation area's ledger to be used when posting in accounting. |
| 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:
api/{tenantKey}/{orgKey}/assets/assetValueAdjustments/{companyKey}/{journalType}/{financialYear}/{ledger}/{seriesNumber}/chartOfAccount
PUT /assets/assetValueAdjustments/{companyKey}/{journalType}/{financialYear}/{ledger}/{seriesNumber}/chartOfAccount
PUT Set DimensionSet AssetValueAdjustmentLine
Updates the value of attribute 'DimensionSet' in the specified entity record.
The following elements are required:
| journalType | (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. |
| financialYear | (string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods. |
| ledger | (string) The depreciation area's ledger to be used when posting in accounting. |
| 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:
api/{tenantKey}/{orgKey}/assets/assetValueAdjustments/{companyKey}/{journalType}/{financialYear}/{ledger}/{seriesNumber}/documentLines/{lineId}/dimensionSet
PUT /assets/assetValueAdjustments/{companyKey}/{journalType}/{financialYear}/{ledger}/{seriesNumber}/documentLines/{lineId}/dimensionSet
PUT Set DimensionSetJson AssetValueAdjustmentLine
Updates the value of attribute 'DimensionSetJson' in the specified entity record.
The following elements are required:
| journalType | (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. |
| financialYear | (string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods. |
| ledger | (string) The depreciation area's ledger to be used when posting in accounting. |
| 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:
api/{tenantKey}/{orgKey}/assets/assetValueAdjustments/{companyKey}/{journalType}/{financialYear}/{ledger}/{seriesNumber}/documentLines/{lineId}/dimensionSetJson
PUT /assets/assetValueAdjustments/{companyKey}/{journalType}/{financialYear}/{ledger}/{seriesNumber}/documentLines/{lineId}/dimensionSetJson
PUT Set ExchangeRate AssetValueAdjustment
Updates the value of attribute 'ExchangeRate' in the specified entity record.
The following elements are required:
| journalType | (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. |
| financialYear | (string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods. |
| ledger | (string) The depreciation area's ledger to be used when posting in accounting. |
| 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 | (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:
api/{tenantKey}/{orgKey}/assets/assetValueAdjustments/{companyKey}/{journalType}/{financialYear}/{ledger}/{seriesNumber}/exchangeRate
PUT /assets/assetValueAdjustments/{companyKey}/{journalType}/{financialYear}/{ledger}/{seriesNumber}/exchangeRate
PUT Set ExchangeRateDate AssetValueAdjustment
Updates the value of attribute 'ExchangeRateDate' in the specified entity record.
The following elements are required:
| journalType | (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. |
| financialYear | (string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods. |
| ledger | (string) The depreciation area's ledger to be used when posting in accounting. |
| 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 | (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}/assets/assetValueAdjustments/{companyKey}/{journalType}/{financialYear}/{ledger}/{seriesNumber}/exchangeRateDate
PUT /assets/assetValueAdjustments/{companyKey}/{journalType}/{financialYear}/{ledger}/{seriesNumber}/exchangeRateDate
PUT Set ImpairmentReason AssetValueAdjustment
Updates the value of attribute 'ImpairmentReason' in the specified entity record.
The following elements are required:
| journalType | (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. |
| financialYear | (string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods. |
| ledger | (string) The depreciation area's ledger to be used when posting in accounting. |
| 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:
api/{tenantKey}/{orgKey}/assets/assetValueAdjustments/{companyKey}/{journalType}/{financialYear}/{ledger}/{seriesNumber}/impairmentReason
PUT /assets/assetValueAdjustments/{companyKey}/{journalType}/{financialYear}/{ledger}/{seriesNumber}/impairmentReason
PUT Set IsActive AssetValueAdjustment
Updates the value of attribute 'IsActive' in the specified entity record.
The following elements are required:
| journalType | (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. |
| financialYear | (string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods. |
| ledger | (string) The depreciation area's ledger to be used when posting in accounting. |
| 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:
api/{tenantKey}/{orgKey}/assets/assetValueAdjustments/{companyKey}/{journalType}/{financialYear}/{ledger}/{seriesNumber}/isActive
PUT /assets/assetValueAdjustments/{companyKey}/{journalType}/{financialYear}/{ledger}/{seriesNumber}/isActive
PUT Set IsPrinted AssetValueAdjustment
Updates the value of attribute 'IsPrinted' in the specified entity record.
The following elements are required:
| journalType | (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. |
| financialYear | (string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods. |
| ledger | (string) The depreciation area's ledger to be used when posting in accounting. |
| 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. |
Resource URL:
api/{tenantKey}/{orgKey}/assets/assetValueAdjustments/{companyKey}/{journalType}/{financialYear}/{ledger}/{seriesNumber}/isPrinted
PUT /assets/assetValueAdjustments/{companyKey}/{journalType}/{financialYear}/{ledger}/{seriesNumber}/isPrinted
PUT Set PrintedReportName AssetValueAdjustment
Updates the value of attribute 'PrintedReportName' in the specified entity record.
The following elements are required:
| journalType | (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. |
| financialYear | (string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods. |
| ledger | (string) The depreciation area's ledger to be used when posting in accounting. |
| 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:
api/{tenantKey}/{orgKey}/assets/assetValueAdjustments/{companyKey}/{journalType}/{financialYear}/{ledger}/{seriesNumber}/printedReportName
PUT /assets/assetValueAdjustments/{companyKey}/{journalType}/{financialYear}/{ledger}/{seriesNumber}/printedReportName
PUT Set RemainingLife AssetValueAdjustmentLine
Updates the value of attribute 'RemainingLife' in the specified entity record.
The following elements are required:
| journalType | (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. |
| financialYear | (string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods. |
| ledger | (string) The depreciation area's ledger to be used when posting in accounting. |
| 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 | (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}/assets/assetValueAdjustments/{companyKey}/{journalType}/{financialYear}/{ledger}/{seriesNumber}/documentLines/{lineId}/remainingLife
PUT /assets/assetValueAdjustments/{companyKey}/{journalType}/{financialYear}/{ledger}/{seriesNumber}/documentLines/{lineId}/remainingLife
PUT Set Remarks AssetValueAdjustment
Updates the value of attribute 'Remarks' in the specified entity record.
The following elements are required:
| journalType | (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. |
| financialYear | (string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods. |
| ledger | (string) The depreciation area's ledger to be used when posting in accounting. |
| 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:
api/{tenantKey}/{orgKey}/assets/assetValueAdjustments/{companyKey}/{journalType}/{financialYear}/{ledger}/{seriesNumber}/remarks
PUT /assets/assetValueAdjustments/{companyKey}/{journalType}/{financialYear}/{ledger}/{seriesNumber}/remarks
PUT Set Custom Attribute AssetValueAdjustment
Updates the value of 'CustomAttribute' in the specified entity record.
The following elements are required:
| companyKey | (string) The company key. |
| journalType | (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. |
| financialYear | (string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods. |
| ledger | (string) The depreciation area's ledger to be used when posting in accounting. |
| 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:
api/{tenantKey}/{orgKey}/assets/assetValueAdjustments/{companyKey}/{journalType}/{financialYear}/{ledger}/{seriesNumber}/{customAttributeName}
PUT /assets/assetValueAdjustments/{companyKey}/{journalType}/{financialYear}/{ledger}/{seriesNumber}/{customAttributeName}
PUT Set Custom Attribute AssetValueAdjustmentLine
Updates the value of 'CustomAttribute' in the specified entity record.
The following elements are required:
| companyKey | (string) The company key. |
| journalType | (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. |
| financialYear | (string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods. |
| ledger | (string) The depreciation area's ledger to be used when posting in accounting. |
| 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:
api/{tenantKey}/{orgKey}/assets/assetValueAdjustments/{companyKey}/{journalType}/{financialYear}/{ledger}/{seriesNumber}/documentLines/{lineId}/{customAttributeName}
PUT /assets/assetValueAdjustments/{companyKey}/{journalType}/{financialYear}/{ledger}/{seriesNumber}/documentLines/{lineId}/{customAttributeName}
DELETE Asset Value Adjustment Line by identifier
Deletes the entity record that matches the specified identifier.
The following elements are required:
| journalType | (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. |
| financialYear | (string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods. |
| ledger | (string) The depreciation area's ledger to be used when posting in accounting. |
| 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. |
| 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}/assets/assetValueAdjustments/{companyKey}/{journalType}/{financialYear}/{ledger}/{seriesNumber}/documentLines/{lineId}
DELETE /assets/assetValueAdjustments/{companyKey}/{journalType}/{financialYear}/{ledger}/{seriesNumber}/documentLines/{lineId}
DELETE AssetValueAdjustment 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}/assets/assetValueAdjustments/{id}
DELETE /assets/assetValueAdjustments/{id}
DELETE AssetValueAdjustment by key
Deletes the entity record that matches the specified key.
The following elements are required:
| companyKey | (string) The company key. |
| journalType | (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. |
| financialYear | (string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods. |
| ledger | (string) The depreciation area's ledger to be used when posting in accounting. |
| 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:
api/{tenantKey}/{orgKey}/assets/assetValueAdjustments/{companyKey}/{journalType}/{financialYear}/{ledger}/{seriesNumber}
DELETE /assets/assetValueAdjustments/{companyKey}/{journalType}/{financialYear}/{ledger}/{seriesNumber}
Resources
AdjustmentLineAccountResource
The following elements are required:
| amount | (MoneyResource) Internal Field not used.
See MoneyResource . |
| ledger | (string) The actual ledger where the values are posted. |
| depreciationArea | (string) The Asset SetUp depreciation area. Automatically resolved. |
The following elements are optional:
| chartOfAccount | (string) The chart of accounts of the company (Internal). |
| gLAccount | (string) The GL account to be posted. Internally resolved. |
| currency | (string) The currency of the monetary fields. |
| assetTransactionAccountType | (enum AssetTransactionAccountType) The Asset Class Detail GlAccount. Automatically resolved.
See AssetTransactionAccountType. |
ApiAssetValueAdjustmentDocumentLinesDocumentLineAccountsResource
The following elements are required:
| amount | (MoneyResource) Internal Field not used.
See MoneyResource . |
| ledger | (string) The actual ledger where the values are posted. |
| depreciationArea | (string) The Asset SetUp depreciation area. Automatically resolved. |
The following elements are optional:
| chartOfAccount | (string) The chart of accounts of the company (Internal). |
| gLAccount | (string) The GL account to be posted. Internally resolved. |
| currency | (string) The currency of the monetary fields. |
| assetTransactionAccountType | (enum AssetTransactionAccountType) The Asset Class Detail GlAccount. Automatically resolved.
See AssetTransactionAccountType. |
ApiAssetValueAdjustmentDocumentLinesResource
The following elements are required:
| financialAsset | (string) The asset on which depreciations will be recorded. |
| lossDueImpairmentValue | (MoneyResource) The Impairment value to record. The impairment occurs when an asset suffers a depreciation value in excess of the book value of the asset on the company's financial statements.
See MoneyResource . |
| currency | (string) The transaction currency. |
The following elements are optional:
| description | (string) The asset description. |
| documentLineAccounts | (List of ApiAssetValueAdjustmentDocumentLinesDocumentLineAccountsResource) Document Line Accounts.
See ApiAssetValueAdjustmentDocumentLinesDocumentLineAccountsResource. |
| dimensionSet | (string) The dimension set. Infered from the dimension combination in the asset type. |
| dimensionSetJson | (string) The json representation of the dimension set (Internal). |
| remainingLife | (int) Remaining Life. |
ApiAssetValueAdjustmentResource
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 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. |
| financialYear | (string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods. |
| ledger | (string) The depreciation area's ledger to be used when posting in accounting. |
| 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. |
| currency | (string) The currency of the journal entry. |
| documentDate | (DateTime) The date when the document is issued. |
| postingDate | (DateTime) The date when the document is created. |
| impairmentReason | (string) This field allows specify the reason that led to the recording of the impairment of the asset. |
| depreciationArea | (string) The depreciation Area for the entity. |
| financialPeriod | (int) The financial period of the journal entry. It's determined by the posting date, user can only assign special periods when the posting date is on the upper/lower margin of the calendar. |
| exchangeRate | (decimal) Exchange Rate. |
The following elements are optional:
| documentLines | (List of ApiAssetValueAdjustmentDocumentLinesResource) Document Lines.
See ApiAssetValueAdjustmentDocumentLinesResource. |
| remarks | (string) A place to store related information with the journal entry. |
| isPrinted | (bool) Flag to know if it was printed. |
| exchangeRateDate | (DateTime) Exchange Rate Date. |
| chartOfAccount | (string) The chart of accounts of the company (Internal). |
| printedReportName | (string) Indicates the report name used to print the document. Internally determined. |
AssetValueAdjustmentLineResource
The following elements are required:
| financialAsset | (string) The asset on which depreciations will be recorded. |
| acquisitionCost | (MoneyResource) The asset aquisition value. The acquisition cost include all the cost the are normal and necessary to prepare the asset for its use.
See MoneyResource . |
| scrapValue | (MoneyResource) The estimated book value of an asset after depreciation is complete.
See MoneyResource . |
| depreciationAmount | (MoneyResource) The total depreciation book value of na asset.
See MoneyResource . |
| impairmentAmount | (MoneyResource) The total Impairment book value of na asset.
See MoneyResource . |
| netBookValue | (MoneyResource) Net Book Value.
See MoneyResource . |
| lossDueImpairmentValue | (MoneyResource) The Impairment value to record. The impairment occurs when an asset suffers a depreciation value in excess of the book value of the asset on the company's financial statements.
See MoneyResource . |
| impairmentLoss | (MoneyResource) The total earming book value of na asset.
See MoneyResource . |
| impairmentLossReversal | (MoneyResource) The total of loss book value of na asset.
See MoneyResource . |
| currency | (string) The transaction currency. |
The following elements are optional:
| description | (string) The asset description. |
| documentLineAccounts | (List of AdjustmentLineAccountResource) Document Line Accounts.
See AdjustmentLineAccountResource. |
| dimensionSet | (string) The dimension set. Infered from the dimension combination in the asset type. |
| dimensionSetJson | (string) The json representation of the dimension set (Internal). |
| remainingLife | (int) Remaining Life. |
AssetValueAdjustmentResource
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 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 JournalType. These records are accessibly through the JournalTypes service. |
| financialYear | (string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods.
(fk) Allowed value: the natural key of a record of type FinancialYear. These records are accessibly through the FinancialYears service. |
| ledger | (string) The depreciation area's ledger to be used when posting in accounting.
(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. |
| 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. |
| documentDate | (DateTime) The date when the document is issued. |
| postingDate | (DateTime) The date when the document is created. |
| impairmentReason | (string) This field allows specify the reason that led to the recording of the impairment of the asset. |
| depreciationArea | (string) The depreciation Area for the entity.
(fk) Allowed value: the natural key of a record of type DepreciationArea. These records are accessibly through the DepreciationAreas service. |
| financialPeriod | (int) The financial period of the journal entry. It's determined by the posting date, user can only assign special periods when the posting date is on the upper/lower margin of the calendar. |
| financialPeriodName | (string) The name of the financial period for display purposes only. |
| lossDueImpairmentTotal | (MoneyResource) The total impairment loss amount in transaction currency.
See MoneyResource . |
| exchangeRate | (decimal) Exchange Rate. |
The following elements are optional:
| documentLines | (List of AssetValueAdjustmentLineResource) Document Lines.
See AssetValueAdjustmentLineResource. |
| remarks | (string) A place to store related information with the journal entry. |
| accountingDocument | (string) A place to store related information with the journal entry. |
| isPrinted | (bool) Flag to know if it was printed. |
| exchangeRateDate | (DateTime) Exchange Rate Date. |
| 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. |
| printedReportName | (string) Indicates the report name used to print the document. Internally determined. |
| isReprinted | (bool) Indicates if the document has been reprinted. Internally determined. |
| isSigned | (bool) Indicates if the document is electronically signed with a valid certificate. Internally determined. |
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. |