Sales | Summary Value
This SummaryValues end point is used to get a summary of organization data, like orders to bill, orders to ship, etc.
Overview
| URL | api/{tenantKey}/{orgKey}/sales/summaryValues |
| Methods Supported | GET |
All Operations
This service includes the following operations:
-
GET:
- GET Get Orders To Bill Card Data
- GET Get Pending Quotations Card Data
- GET Get Orders To Ship Card Data
- GET Get Pending Quotations List Data
- GET Get Pending Quotations List Count
- GET Get Orders To Bill List Data
- GET Get Orders To Bill List Count
- GET Get Orders To Ship List Count
- GET Get Orders To Ship List Data
All Resources
This service uses the following resources:
GET Get Orders To Bill Card Data
Custom operation 'GetOrdersToBillCardData'.
The following elements are required:
| company | (string) Company. |
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 Pending Quotations Card Data
Custom operation 'GetPendingQuotationsCardData'.
The following elements are required:
| company | (string) Company. |
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 Ship Card Data
Custom operation 'GetOrdersToShipCardData'.
The following elements are required:
| company | (string) Company. |
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 Pending Quotations List Data
Custom operation 'GetPendingQuotationsListData'.
The following elements are required:
| company | (string) Company. |
| code | (string) Code. |
Response:
| When successful, the response body contains a list of resources of type 'PendingQuotationResource'. See PendingQuotationResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET Get Pending Quotations List Count
Custom operation 'GetPendingQuotationsListCount'.
The following elements are required:
| company | (string) Company. |
| code | (string) Code. |
Response:
| When successful, the response body contains an item of type 'number'. |
Resource URL:
GET Get Orders To Bill List Data
Custom operation 'GetOrdersToBillListData'.
The following elements are required:
| company | (string) Company. |
| code | (string) Code. |
Response:
| When successful, the response body contains a list of resources of type 'OrderToBillResource'. See OrderToBillResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET Get Orders To Bill List Count
Custom operation 'GetOrdersToBillListCount'.
The following elements are required:
| company | (string) Company. |
| code | (string) Code. |
Response:
| When successful, the response body contains an item of type 'number'. |
Resource URL:
GET Get Orders To Ship List Count
Custom operation 'GetOrdersToShipListCount'.
The following elements are required:
| company | (string) Company. |
| code | (string) Code. |
Response:
| When successful, the response body contains an item of type 'number'. |
Resource URL:
GET Get Orders To Ship List Data
Custom operation 'GetOrdersToShipListData'.
The following elements are required:
| company | (string) Company. |
| code | (string) Code. |
Response:
| When successful, the response body contains a list of resources of type 'OrderToShipResource'. See OrderToShipResource. |
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) Amount. |
| typeAmount | (string) Type Amount. |
| fractionDigits | (int) Fraction Digits. |
| currencySymbol | (string) Currency Symbol. |
| description | (string) Description. |
OrderToBillResource
The following elements are optional:
| sourceDoc | (string) Source Doc. |
| sourceDocLink | (string) Source Doc Link. |
| documentDate | (DateTimeOffset) Document Date. |
| party | (string) Party. |
| partyName | (string) Party Name. |
| partyLink | (string) Party Link. |
| paymentMethod | (string) Payment Method. |
| amount | (decimal) Amount. |
| symbol | (string) Symbol. |
| fractionDigits | (int) Fraction Digits. |
| operation | (string) Operation. |
| operationLink | (string) Operation Link. |
OrderToShipResource
The following elements are optional:
| sourceDoc | (string) Source Doc. |
| sourceDocLink | (string) Source Doc Link. |
| deliveryDate | (DateTime) Delivery Date. |
| party | (string) Party. |
| partyName | (string) Party Name. |
| partyLink | (string) Party Link. |
| paymentMethod | (string) Payment Method. |
| quantity | (decimal) Quantity. |
| openQuantity | (decimal) Open Quantity. |
| openAmount | (decimal) Open Amount. |
| symbol | (string) Symbol. |
| fractionDigits | (int) Fraction Digits. |
| operation | (string) Operation. |
| operationLink | (string) Operation Link. |
PendingQuotationResource
The following elements are optional:
| sourceDoc | (string) Source Doc. |
| sourceDocLink | (string) Source Doc Link. |
| validUntil | (DateTimeOffset) Valid Until. |
| partyId | (Guid) Party Id. |
| party | (string) Party. |
| partyName | (string) Party Name. |
| partyLink | (string) Party Link. |
| partyPhone | (string) Party Phone. |
| partyEmail | (string) Party Email. |
| amount | (decimal) Amount. |
| symbol | (string) Symbol. |
| fractionDigits | (int) Fraction Digits. |
| operation | (string) Operation. |
| operationLink | (string) Operation Link. |