POST TopCustomersBySales/Get

Gets the Top Customers by Sales based on the request.

Request Information

This method supports OData queries.

URI Parameters

None.

Body Parameters

The request.

Name	Type	Additional information	Description
FromDate	date	None.	Gets or sets From Date.
ToDate	date	None.	Gets or sets To Date.
CustomerId	integer	None.
IncludeCreditNotes	bool	None.
ViewTop	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "CustomerId": 1,
  "IncludeCreditNotes": true,
  "ViewTop": 3,
  "FromDate": "2024-04-20",
  "ToDate": "2024-04-20"
}

Response Information

Resource Description

This collection is wrapped in a paging response object.

Paging response of Top Customers By Sales

Name	Type	Additional information
TotalResults	integer	None.
ReturnedResults	integer	None.
Results	Collection of Top Customers By Sales	None.

Response Formats

application/json, text/json

Sample:

{
  "TotalResults": 1,
  "ReturnedResults": 2,
  "Results": [
    {
      "CustomerId": 1,
      "Name": "sample string 2",
      "Exclusive": 3.0,
      "Total": 4.0
    },
    {
      "CustomerId": 1,
      "Name": "sample string 2",
      "Exclusive": 3.0,
      "Total": 4.0
    }
  ]
}