Assets | Summary Value
The Summary Values end point is used to get asset information such as open assets, or the number of asset operations.
Overview
| URL | api/{tenantKey}/{orgKey}/assetsCore/summaryValues |
| Methods Supported | GET |
All Operations
This service includes the following operations:
All Resources
This service uses the following resources:
GET Get Asset Open Count
Gets the number of assets to capitalize or alienate.
The following elements are required:
| company | (string) The Company. |
| transactionType | (string) The Transaction Type. |
Response:
| When successful, the response body contains a resource of type 'AssetOpenCount'. See AssetOpenCount. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET Get Asset Open List Data
Gets the Open Assets by transaction type.
The following elements are required:
| company | (string) The company. |
| transactionType | (string) The TransactionType. |
Response:
| When successful, the response body contains a list of resources of type 'AssetOpenListData'. See AssetOpenListData. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET Get Asset Operation Count
Gets the Open Assets operations by transaction type.
The following elements are required:
| company | (string) The Company. |
| transactionType | (string) The Transaction type. |
Response:
| When successful, the response body contains an item of type 'number'. |
Resource URL:
Resources
AssetOpenCount
The following elements are optional:
| value | (decimal) The total amount. |
| description | (string) The asset description. |
| fractionDigits | (int) The currency fraction digits. |
| currencySymbol | (string) The currency ISO symbol. |
AssetOpenListData
The following elements are required:
| sourceDoc | (string) The source doc for the transaction. |
| party | (string) The entity. |
| partyName | (string) The entity name. |
| amount | (decimal) The open amount.. |
| pendingAmount | (decimal) The pending amount. |
| symbol | (string) The currency ISO symbol. |
| fractionDigits | (string) The currency fraction digits. |
| openQuantity | (decimal) The remaining quantities. |
The following elements are optional:
| sourceDocLink | (string) The url link to the source document. |
| note | (string) The transaction remarks. |
| description | (string) The transaction description. |
| partyLink | (string) The URL link to the entity. |
| operation | (string) The asset operation type. |
| operationLink | (string) The operation link. |