Assets | Periodic Depreciation
The Periodic Depretiations end point is used to record the information related with the process of a depretiation such as the asset and value.
Overview
| URL | api/{tenantKey}/{orgKey}/assets/periodicDepreciations |
| Methods Supported | GET, POST, PUT, DELETE |
All Operations
This service includes the following operations:
-
GET:
- GET PeriodicDepreciations
- GET PeriodicDepreciations (paged)
- GET PeriodicDepreciation by identifier
- GET PeriodicDepreciation by key
- GET Print PeriodicDepreciation by identifier
- GET Print PeriodicDepreciation by key
- GET Original Print PeriodicDepreciationOriginal by identifier
- GET Original Print PeriodicDepreciation by key
- POST:
- PUT:
- DELETE:
All Resources
This service uses the following resources:
- ApiPeriodicDepreciationDocumentLinesResource
- ApiPeriodicDepreciationResource
- MoneyResource
- PeriodicDepreciationLineResource
- PeriodicDepreciationResource
All Enumerations
This service uses the following enumerations:
GET PeriodicDepreciations
Returns the list of all the entity records available.
Response:
| When successful, the response body contains the list of records available. See PeriodicDepreciationResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/assets/periodicDepreciations
GET /assets/periodicDepreciations
GET PeriodicDepreciations (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 PeriodicDepreciationResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/assets/periodicDepreciations?page={page}&pageSize={pageSize}
GET /assets/periodicDepreciations?page={page}&pageSize={pageSize}
GET PeriodicDepreciation 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 PeriodicDepreciationResource. |
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/periodicDepreciations/{id}
GET /assets/periodicDepreciations/{id}
GET PeriodicDepreciation 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) 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 PeriodicDepreciationResource. |
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/periodicDepreciations/{companyKey}/{journalType}/{financialYear}/{ledger}/{seriesNumber}
GET /assets/periodicDepreciations/{companyKey}/{journalType}/{financialYear}/{ledger}/{seriesNumber}
GET Print PeriodicDepreciation 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/periodicDepreciations/{id}/print?template={template}
GET /assets/periodicDepreciations/{id}/print?template={template}
GET Print PeriodicDepreciation 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) 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/periodicDepreciations/{companyKey}/{journalType}/{financialYear}/{ledger}/{seriesNumber}/print
GET /assets/periodicDepreciations/{companyKey}/{journalType}/{financialYear}/{ledger}/{seriesNumber}/print
GET Original Print PeriodicDepreciationOriginal 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/periodicDepreciations/{id}/printOriginal?template={template}
GET /assets/periodicDepreciations/{id}/printOriginal?template={template}
GET Original Print PeriodicDepreciation 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) 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/periodicDepreciations/{companyKey}/{journalType}/{financialYear}/{ledger}/{seriesNumber}/printOriginal
GET /assets/periodicDepreciations/{companyKey}/{journalType}/{financialYear}/{ledger}/{seriesNumber}/printOriginal
POST PeriodicDepreciations
Creates a new entity record.
The following elements are required:
| periodicDepreciationResource | (ApiPeriodicDepreciationResource) The request body should contain the entity record that should be created. See ApiPeriodicDepreciationResource. |
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 ApiPeriodicDepreciationResource. |
Response status codes:
| 201 | Created. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/assets/periodicDepreciations
POST /assets/periodicDepreciations
POST Post Depreciation
This service will create a periodic depreciation.
The following elements are required:
| company | (string) The company key. |
| depreciationArea | (string) The Depreciation Area Key. |
| financialYear | (string) The Financial Year Key. |
| financialPeriod | (int) The financial period. |
| postingDate | (DateTime?) The posting date. |
Response:
| When successful, the response body contains a unique identifier. |
Resource URL:
api/{tenantKey}/{orgKey}/assets/periodicDepreciations/postDepreciation/{company}/{depreciationArea}/{financialYear}/{financialPeriod}
POST /assets/periodicDepreciations/postDepreciation/{company}/{depreciationArea}/{financialYear}/{financialPeriod}
PUT Set IsActive PeriodicDepreciation
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) 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/periodicDepreciations/{companyKey}/{journalType}/{financialYear}/{ledger}/{seriesNumber}/isActive
PUT /assets/periodicDepreciations/{companyKey}/{journalType}/{financialYear}/{ledger}/{seriesNumber}/isActive
PUT Set Note PeriodicDepreciation
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) 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/periodicDepreciations/{companyKey}/{journalType}/{financialYear}/{ledger}/{seriesNumber}/note
PUT /assets/periodicDepreciations/{companyKey}/{journalType}/{financialYear}/{ledger}/{seriesNumber}/note
PUT Set Remarks PeriodicDepreciation
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) 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/periodicDepreciations/{companyKey}/{journalType}/{financialYear}/{ledger}/{seriesNumber}/remarks
PUT /assets/periodicDepreciations/{companyKey}/{journalType}/{financialYear}/{ledger}/{seriesNumber}/remarks
DELETE PeriodicDepreciation 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/periodicDepreciations/{id}
DELETE /assets/periodicDepreciations/{id}
DELETE PeriodicDepreciation 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) 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/periodicDepreciations/{companyKey}/{journalType}/{financialYear}/{ledger}/{seriesNumber}
DELETE /assets/periodicDepreciations/{companyKey}/{journalType}/{financialYear}/{ledger}/{seriesNumber}
Resources
ApiPeriodicDepreciationDocumentLinesResource
The following elements are required:
| financialAsset | (string) Asset. |
ApiPeriodicDepreciationResource
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) 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. |
| postingDate | (DateTime) The date when the document is created. |
| 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. |
The following elements are optional:
| documentLines | (List of ApiPeriodicDepreciationDocumentLinesResource) Document lines.
See ApiPeriodicDepreciationDocumentLinesResource. |
| note | (string) The note. |
| remarks | (string) The remarks. |
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.
PeriodicDepreciationLineResource
The following elements are required:
| financialAsset | (string) Asset. |
| quantity | (int) The quantity of depreciated assets. |
| gLAccount | (string) The GL account to be posted. Internally resolved. |
| debitAmount | (MoneyResource) The debit amount.
See MoneyResource . |
| creditAmount | (MoneyResource) The credit amount.
See MoneyResource . |
| currency | (string) Select the currency. Only records in the selected currency are shown. |
| chartOfAccount | (string) The chart of accounts of the company (Internal). |
The following elements are optional:
| dimensionSet | (string) The dimension set. Infered from the dimension combination in the asset type. |
| dimensionSetJson | (string) The json representation of the dimension set (Internal). |
| assetTransactionAccountType | (enum AssetTransactionAccountType) The asset transaction GL account type. Determined from the asset class account types.
See AssetTransactionAccountType. |
PeriodicDepreciationResource
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) 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. |
| documentDate | (DateTime) The date when the document is issued. |
| postingDate | (DateTime) The date when the document is created. |
| currency | (string) Select the currency. Only records in the selected currency are shown. |
| 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. |
| chartOfAccount | (string) The chart of accounts of the company (Internal). |
| totalAmount | (MoneyResource) The total amount depreciated.
See MoneyResource . |
The following elements are optional:
| accountingDocument | (string) A place to store related information with the journal entry. |
| financialPeriodName | (string) The name of the financial period for display purposes only. |
| documentLines | (List of PeriodicDepreciationLineResource) Document lines.
See PeriodicDepreciationLineResource. |
| note | (string) The note. |
| remarks | (string) The remarks. |