Assets | Disposal
The Asset Disposal end point is used to record the information related with the process of a disposal such as the asset and value.
Overview
| URL | api/{tenantKey}/{orgKey}/assets/assetDisposals |
| Methods Supported | GET, POST, PUT, DELETE |
All Operations
This service includes the following operations:
- GET:
- POST:
-
PUT:
- PUT Set Custom Attribute AssetDisposal
- PUT Set Custom Attribute AssetDisposalLine
- PUT Set IsActive AssetDisposal
- PUT Set FinancialYear AssetDisposal
- PUT Set Note AssetDisposal
- PUT Set Remarks AssetDisposal
- PUT Set Currency AssetDisposal
- PUT Set FinancialPeriodName AssetDisposal
- PUT Set ChartOfAccount AssetDisposal
- PUT Set PrintedReportName AssetDisposal
- PUT Set Unit AssetDisposalLine
- PUT Set LineDescription AssetDisposalLine
- PUT Set UpdateCurrentQuantity AssetDisposalLine
- PUT Set ChartOfAccount AssetDisposalLine
- PUT Set GLAccount AssetDisposalLine
- PUT Set DimensionSet AssetDisposalLine
- PUT Set DimensionSetJson AssetDisposalLine
- PUT Set ExchangeRate AssetDisposalLine
- PUT Set ExchangeRateDate AssetDisposalLine
- PUT Set Currency AssetDisposalLine
- DELETE:
All Resources
This service uses the following resources:
- ApiAssetDisposalDocumentLinesDocumentLineAccountsResource
- ApiAssetDisposalDocumentLinesResource
- ApiAssetDisposalResource
- AssetDisposalLineResource
- AssetDisposalResource
- DisposalLineAccountResource
- MoneyResource
- ExtensibilityCustomAttributeValueResource
All Enumerations
This service uses the following enumerations:
GET AssetDisposals
Returns the list of all the entity records available.
Response:
| When successful, the response body contains the list of records available. See AssetDisposalResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET AssetDisposals (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 AssetDisposalResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET AssetDisposal 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 AssetDisposalResource. |
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 AssetDisposal 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 disposal. |
| 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 Asset Disposal. An journal number is a number used to identify a journal entry. It is set up in Journal Type Asset Sale. |
Response:
| When successful, the response body contains the entity record. See AssetDisposalResource. |
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 AssetDisposal 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 AssetDisposal by key
Prints the specified entity record.
The following elements are required:
| companyKey | (string) The company key. |
| journalType | (string) The journal type of the disposal. |
| 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 Asset Disposal. An journal number is a number used to identify a journal entry. It is set up in Journal Type Asset Sale. |
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 AssetDisposalOriginal 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 AssetDisposal by key
Prints the specified entity record.
The following elements are required:
| companyKey | (string) The company key. |
| journalType | (string) The journal type of the disposal. |
| 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 Asset Disposal. An journal number is a number used to identify a journal entry. It is set up in Journal Type Asset Sale. |
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 AssetDisposals
Creates a new entity record.
The following elements are required:
| assetDisposalResource | (ApiAssetDisposalResource) The request body should contain the entity record that should be created. See ApiAssetDisposalResource. |
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 ApiAssetDisposalResource. |
Response status codes:
| 201 | Created. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set ChartOfAccount AssetDisposal
Updates the value of attribute 'ChartOfAccount' in the specified entity record.
The following elements are required:
| journalType | (string) The journal type of the disposal. |
| 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 Asset Disposal. An journal number is a number used to identify a journal entry. It is set up in Journal Type Asset Sale. |
| 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 AssetDisposalLine
Updates the value of attribute 'ChartOfAccount' in the specified entity record.
The following elements are required:
| journalType | (string) The journal type of the disposal. |
| 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 Asset Disposal. An journal number is a number used to identify a journal entry. It is set up in Journal Type Asset Sale. |
| 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 Currency AssetDisposal
Updates the value of attribute 'Currency' in the specified entity record.
The following elements are required:
| journalType | (string) The journal type of the disposal. |
| 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 Asset Disposal. An journal number is a number used to identify a journal entry. It is set up in Journal Type Asset Sale. |
| 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 AssetDisposalLine
Updates the value of attribute 'Currency' in the specified entity record.
The following elements are required:
| journalType | (string) The journal type of the disposal. |
| 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 Asset Disposal. An journal number is a number used to identify a journal entry. It is set up in Journal Type Asset Sale. |
| 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 DimensionSet AssetDisposalLine
Updates the value of attribute 'DimensionSet' in the specified entity record.
The following elements are required:
| journalType | (string) The journal type of the disposal. |
| 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 Asset Disposal. An journal number is a number used to identify a journal entry. It is set up in Journal Type Asset Sale. |
| 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 DimensionSetJson AssetDisposalLine
Updates the value of attribute 'DimensionSetJson' in the specified entity record.
The following elements are required:
| journalType | (string) The journal type of the disposal. |
| 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 Asset Disposal. An journal number is a number used to identify a journal entry. It is set up in Journal Type Asset Sale. |
| 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 AssetDisposalLine
Updates the value of attribute 'ExchangeRate' in the specified entity record.
The following elements are required:
| journalType | (string) The journal type of the disposal. |
| 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 Asset Disposal. An journal number is a number used to identify a journal entry. It is set up in Journal Type Asset Sale. |
| 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 AssetDisposalLine
Updates the value of attribute 'ExchangeRateDate' in the specified entity record.
The following elements are required:
| journalType | (string) The journal type of the disposal. |
| 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 Asset Disposal. An journal number is a number used to identify a journal entry. It is set up in Journal Type Asset Sale. |
| 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 FinancialPeriodName AssetDisposal
Updates the value of attribute 'FinancialPeriodName' in the specified entity record.
The following elements are required:
| journalType | (string) The journal type of the disposal. |
| 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 Asset Disposal. An journal number is a number used to identify a journal entry. It is set up in Journal Type Asset Sale. |
| 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 FinancialYear AssetDisposal
Updates the value of attribute 'FinancialYear' in the specified entity record.
The following elements are required:
| journalType | (string) The journal type of the disposal. |
| 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 Asset Disposal. An journal number is a number used to identify a journal entry. It is set up in Journal Type Asset Sale. |
| 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 GLAccount AssetDisposalLine
Updates the value of attribute 'GLAccount' in the specified entity record.
The following elements are required:
| journalType | (string) The journal type of the disposal. |
| 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 Asset Disposal. An journal number is a number used to identify a journal entry. It is set up in Journal Type Asset Sale. |
| 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 AssetDisposal
Updates the value of attribute 'IsActive' in the specified entity record.
The following elements are required:
| journalType | (string) The journal type of the disposal. |
| 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 Asset Disposal. An journal number is a number used to identify a journal entry. It is set up in Journal Type Asset Sale. |
| 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 LineDescription AssetDisposalLine
Updates the value of attribute 'LineDescription' in the specified entity record.
The following elements are required:
| journalType | (string) The journal type of the disposal. |
| 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 Asset Disposal. An journal number is a number used to identify a journal entry. It is set up in Journal Type Asset Sale. |
| 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 Note AssetDisposal
Updates the value of attribute 'Note' in the specified entity record.
The following elements are required:
| journalType | (string) The journal type of the disposal. |
| 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 Asset Disposal. An journal number is a number used to identify a journal entry. It is set up in Journal Type Asset Sale. |
| 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 PrintedReportName AssetDisposal
Updates the value of attribute 'PrintedReportName' in the specified entity record.
The following elements are required:
| journalType | (string) The journal type of the disposal. |
| 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 Asset Disposal. An journal number is a number used to identify a journal entry. It is set up in Journal Type Asset Sale. |
| 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 AssetDisposal
Updates the value of attribute 'Remarks' in the specified entity record.
The following elements are required:
| journalType | (string) The journal type of the disposal. |
| 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 Asset Disposal. An journal number is a number used to identify a journal entry. It is set up in Journal Type Asset Sale. |
| 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 AssetDisposalLine
Updates the value of attribute 'Unit' in the specified entity record.
The following elements are required:
| journalType | (string) The journal type of the disposal. |
| 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 Asset Disposal. An journal number is a number used to identify a journal entry. It is set up in Journal Type Asset Sale. |
| 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 UpdateCurrentQuantity AssetDisposalLine
Updates the value of attribute 'UpdateCurrentQuantity' in the specified entity record.
The following elements are required:
| journalType | (string) The journal type of the disposal. |
| 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 Asset Disposal. An journal number is a number used to identify a journal entry. It is set up in Journal Type Asset Sale. |
| lineId | (string) The detail identifier. |
| 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:
PUT Set Custom Attribute AssetDisposal
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 disposal. |
| 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 Asset Disposal. An journal number is a number used to identify a journal entry. It is set up in Journal Type Asset Sale. |
| 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 AssetDisposalLine
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 disposal. |
| 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 Asset Disposal. An journal number is a number used to identify a journal entry. It is set up in Journal Type Asset Sale. |
| 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 AssetDisposal 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 AssetDisposal 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 disposal. |
| 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 Asset Disposal. An journal number is a number used to identify a journal entry. It is set up in Journal Type Asset Sale. |
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
ApiAssetDisposalDocumentLinesDocumentLineAccountsResource
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. |
ApiAssetDisposalDocumentLinesResource
The following elements are required:
| financialAsset | (string) The financial asset to be disposed. |
| quantity | (int) The quantity to be disposed. |
| unit | (string) The unit of measure of the original document line. |
| lineDescription | (string) The sourceLine description. |
| updateCurrentQuantity | (bool) Update Quantity. |
| exchangeRate | (decimal) Exchange Rate. |
| currency | (string) Currency. |
The following elements are optional:
| documentLineAccounts | (List of ApiAssetDisposalDocumentLinesDocumentLineAccountsResource) Document Line Accounts.
See ApiAssetDisposalDocumentLinesDocumentLineAccountsResource. |
| chartOfAccount | (string) The chart of accounts of the company (Internal). |
| gLAccount | (string) Clearing Account. |
| dimensionSet | (string) The dimension set. Infered from the dimension combination in the asset type. |
| dimensionSetJson | (string) The json representation of the dimension set (Internal). |
| exchangeRateDate | (DateTime) Exchange Rate Date. |
ApiAssetDisposalResource
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 disposal. |
| 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 Asset Disposal. An journal number is a number used to identify a journal entry. It is set up in Journal Type Asset Sale. |
| documentDate | (DateTime) The date when the document is issued. |
| documentLines | (List of ApiAssetDisposalDocumentLinesResource) Details of the disposal document.
See ApiAssetDisposalDocumentLinesResource. |
| postingDate | (DateTime) The posting date. |
| currency | (string) The base currency of the company (Internal). |
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) The remarks. |
| financialPeriodName | (string) The name of the financial period for display purposes only. |
| chartOfAccount | (string) The chart of accounts of the company (Internal). |
| printedReportName | (string) Indicates the report name used to print the document. Internally determined. |
AssetDisposalLineResource
The following elements are required:
| party | (string) The party. |
| sourceDoc | (string) The original document to be settled. The source documents is usually an invoice but other documents can be included on a payment (ex: Credit or Debit Notes). Internally determined. |
| sourceDocLine | (int) The original document line number. |
| sourceDocLineId | (Guid) The original document line id. |
| sourceSchemaEntityId | (Guid) Schema entity from originating document. |
| amount | (MoneyResource) The amount to bem disposed.
See MoneyResource . |
| financialAsset | (string) The financial asset to be disposed. |
| acquisitionAmount | (MoneyResource) The total acquisition book value of an asset.
See MoneyResource . |
| depreciationAmount | (MoneyResource) The total depreciation book value of an asset.
See MoneyResource . |
| imparityAmount | (MoneyResource) The total imparity book value of an asset.
See MoneyResource . |
| quantity | (int) The quantity to be disposed. |
| unit | (string) The unit of measure of the original document line. |
| lineDescription | (string) The sourceLine description. |
| updateCurrentQuantity | (bool) Update Quantity. |
| exchangeRate | (decimal) Exchange Rate. |
| currency | (string) Currency. |
The following elements are optional:
| sourceDocId | (Guid) The identifier of the original document to be settled. Internally determined. |
| documentLineAccounts | (List of DisposalLineAccountResource) Document Line Accounts.
See DisposalLineAccountResource. |
| chartOfAccount | (string) The chart of accounts of the company (Internal). |
| gLAccount | (string) Clearing Account. |
| dimensionSet | (string) The dimension set. Infered from the dimension combination in the asset type. |
| dimensionSetJson | (string) The json representation of the dimension set (Internal). |
| exchangeRateDate | (DateTime) Exchange Rate Date. |
AssetDisposalResource
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 disposal.
(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 Asset Disposal. An journal number is a number used to identify a journal entry. It is set up in Journal Type Asset Sale. |
| documentDate | (DateTime) The date when the document is issued. |
| documentLines | (List of AssetDisposalLineResource) Details of the disposal document.
See AssetDisposalLineResource. |
| postingDate | (DateTime) The posting date. |
| currency | (string) The base currency of the company (Internal).
(fk) Allowed value: the natural key of a record of type Currency. These records are accessibly through the Currencies 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. |
| totalAmount | (MoneyResource) 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) The remarks. |
| accountingDocument | (string) The accounting document that was assigned in accounting. |
| isPrinted | (bool) Flag to know if it was printed. |
| financialPeriodName | (string) The name of the financial period for display purposes only. |
| 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. |
DisposalLineAccountResource
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. |
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. |