Purchases | Summary Value
The summary values endpoint allows to get information about orders to receive or orders to invoice. This service is used on dashboards.
Overview
| URL | api/{tenantKey}/{orgKey}/purchases/summaryValues |
| Methods Supported | GET |
All Operations
This service includes the following operations:
- GET:
All Resources
This service uses the following resources:
GET Get Received But Not Invoiced Card Data
This endpoint is used to get the card data of orders received (but not invoiced).
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:
GET Get Orders To Receive Card Data
This endpoint is used to get the card data of orders received.
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:
GET Get Orders To Receive List Data
This endpoint is used to get the list of orders received.
The following elements are required:
| company | (string) The company key. |
| code | (string) The code specifies the time to retrived data (ALL, OLDER, THIS_WEEK, NEXT_WEEK, FUTURE). |
Response:
| When successful, the response body contains a list of resources of type 'OrderToReceiveResource'. See OrderToReceiveResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET Get Orders To Receive List Count
This endpoint is used to get the count of orders received.
The following elements are required:
| company | (string) The company key. |
| code | (string) The code specifies the time to retrived data (ALL, OLDER, THIS_WEEK, NEXT_WEEK, FUTURE). |
Response:
| When successful, the response body contains an item of type 'number'. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET Get Received But Not Invoiced List Count
This endpoint is used to get the count of orders received (but not invoiced).
The following elements are required:
| company | (string) The company key. |
| code | (string) The code specifies the time to retrived data (ALL, OLDER, THIS_WEEK, NEXT_WEEK, FUTURE). |
Response:
| When successful, the response body contains an item of type 'number'. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET Get Received But Not Invoiced List Data
This endpoint is used to get the list of orders received (but not invoiced).
The following elements are required:
| company | (string) The company key. |
| code | (string) The code specifies the time to retrived data (ALL, OLDER, THIS_WEEK, NEXT_WEEK, FUTURE). |
Response:
| When successful, the response body contains a list of resources of type 'OrderToInvoiceResource'. See OrderToInvoiceResource. |
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 amount. |
| typeAmount | (string) The type amount. |
| fractionDigits | (int) The fraction digits to be displayed. |
| currencySymbol | (string) The currency symbol. |
| description | (string) The description. |
OrderToInvoiceResource
The following elements are required:
| sourceDoc | (string) The source document key. |
| documentDate | (DateTime) Document's date. |
| party | (string) The party key. |
| partyName | (string) The party's name. |
| amount | (decimal) The 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. |
| paymentMethod | (string) Method of payment (ex:TRA). |
| operation | (string) The name of the operation. |
| operationLink | (string) The operation link. |
OrderToReceiveResource
The following elements are required:
| sourceDoc | (string) The original document reference. |
| deliveryDate | (DateTime) The expected delivery date. |
| party | (string) The party key. |
| partyName | (string) The party's name. |
| openAmount | (decimal) The remain amount to be settled. |
| 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. |
| quantity | (decimal) The quantity to receive. |
| openQuantity | (decimal) The remaining quantities. |
| operation | (string) The name of the operation. |
| operationLink | (string) The operation link. |