Sales | Summary Value

Overview

api/{tenantKey}/{orgKey}/sales/summaryValues

URL	api/{tenantKey}/{orgKey}/sales/summaryValues
Methods Supported	GET

All Operations

This service includes the following operations:

GET:

All Resources

This service uses the following resources:

NamedSummarizedValue
OrderToBillResource
OrderToShipResource
PendingQuotationResource

GET Operations

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:

api/{tenantKey}/{orgKey}/sales/summaryValues/getPendingQuotationsListCount/{company}/{code}

GET /sales/summaryValues/getPendingQuotationsListCount/{company}/{code}

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:

api/{tenantKey}/{orgKey}/sales/summaryValues/getOrdersToShipListCount/{company}/{code}

GET /sales/summaryValues/getOrdersToShipListCount/{company}/{code}

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:

api/{tenantKey}/{orgKey}/sales/summaryValues/getOrdersToBillListCount/{company}/{code}

GET /sales/summaryValues/getOrdersToBillListCount/{company}/{code}

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:

api/{tenantKey}/{orgKey}/sales/summaryValues/getOrdersToShipListData/{company}/{code}

GET /sales/summaryValues/getOrdersToShipListData/{company}/{code}

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:

api/{tenantKey}/{orgKey}/sales/summaryValues/getPendingQuotationsListData/{company}/{code}

GET /sales/summaryValues/getPendingQuotationsListData/{company}/{code}

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:

api/{tenantKey}/{orgKey}/sales/summaryValues/getOrdersToBillListData/{company}/{code}

GET /sales/summaryValues/getOrdersToBillListData/{company}/{code}

GET Get Sales In Progress Card Data

Custom operation 'GetSalesInProgressCardData'.

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:

api/{tenantKey}/{orgKey}/sales/summaryValues/getSalesInProgressCardData/{company}

GET /sales/summaryValues/getSalesInProgressCardData/{company}

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.
secondOperation	(string) Second Operation.
secondOperationLink	(string) Second Operation Link.