Accounts Receivable | Summary Value
The Summary Values end point is used to get summary information from open itens to be used on dashboards. RESERVED FOR INTERNAL USE.
Overview
| URL | api/{tenantKey}/{orgKey}/accountsReceivable/summaryValues |
| Methods Supported | GET |
All Operations
This service includes the following operations:
All Resources
This service uses the following resources:
GET Get Sales Open List Count
This operation gets the count of records from a list for a specific kpi based on the supplied company and code.
The following elements are required:
| company | (string) The Company Key. |
| code | (string) The Code is a tag used to get the date range. |
Response:
| When successful, the response body contains an item of type 'number'. |
Resource URL:
GET Get Sales Open List Data
This operation gets all the values needed to create a list for a specific kpi based on the supplied company and code.
The following elements are required:
| company | (string) The Company Key. |
| code | (string) The Code is a tag used to get the date range. |
Response:
| When successful, the response body contains a list of resources of type 'SalesOpenListData'. See SalesOpenListData. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET Get Sales Open Card Data
This operation gets all the values needed to create a card for a specific kpi based on the supplied company.
The following elements are required:
| company | (string) The Company Key. |
Response:
| When successful, the response body contains a resource of type 'NamedSummarizedValue'. See NamedSummarizedValue. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
Resources
NamedSummarizedValue
The following elements are required:
| amount | (decimal) The value used on the card. This value depends of the property type amount. |
| typeAmount | (string) The type of value the card is demonstrating (money, percentage or number). |
| fractionDigits | (int) The currency fraction digits. |
| currencySymbol | (string) The currency ISO symbol. |
| description | (string) The description of the card. |
SalesOpenListData
The following elements are required:
| sourceDoc | (string) The source doc for the transaction. |
| dueDate | (DateTime) The due date of the original document to be settled. |
| party | (string) The party key. Inferred from the source document. |
| partyName | (string) The party's name. Inferred from the source document. |
| paymentMethod | (string) Financial transfer method used by the entity responsible for paying a transaction. For example, cash, transfer or check payments. The default is defined on the supplier party. |
| amount | (decimal) The total amount of the original document. |
| pendingAmount | (decimal) The pending amount. |
| symbol | (string) The currency ISO symbol. |
| fractionDigits | (int) The currency fraction digits. |
The following elements are optional:
| sourceDocLink | (string) The url link to the source document. |
| partyLink | (string) The URL link to the entity. |
| operation | (string) The name of the operation. |
| operationLink | (string) The operation link. |