POST TopSuppliersByPurchases/Get

Gets the Top Suppliers by Purchases based on the request.

Request Information

This method supports OData queries.

URI Parameters

None.

Body Parameters

The request.

Top Suppliers By Purchases Request Model
NameTypeAdditional informationDescription
FromDate date

None.

Gets or sets From Date.

ToDate date

None.

Gets or sets To Date.

SupplierId integer

None.

IncludeSupplierReturns bool

None.

ViewTop integer

None.

Request Formats

application/json, text/json

Sample:
{
  "SupplierId": 1,
  "IncludeSupplierReturns": true,
  "ViewTop": 3,
  "FromDate": "2022-06-27",
  "ToDate": "2022-06-27"
}

Response Information

Resource Description

This collection is wrapped in a paging response object.

Paging response of Top Suppliers By Purchases
NameTypeAdditional informationDescription
TotalResults integer

None.

ReturnedResults integer

None.

Results Collection of Top Suppliers By Purchases

None.

Response Formats

application/json, text/json

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