POST SalesByItem/Get

Gets the specified request.

Request Information

This method supports OData queries.

URI Parameters

None.

Body Parameters

The Sales By Item request.

Sales By Item Request Model
NameTypeAdditional informationDescription
FromDate date

None.

Gets or sets From Date.

ToDate date

None.

Gets or sets To Date.

FromItem string

None.

The Item Code to start the range at.

ToItem string

None.

The Item Code to stop the range at.

FromCategory string

None.

The Category Name to start the range at.

ToCategory string

None.

The Category Name to stop the range at.

IncludeService bool

None.

Gets or sets a value indicating whether service items should be included.

IncludePhysical bool

None.

Gets or sets a value indicating whether physical items should be included.

IncludeActive bool

None.

Gets or sets a value indicating whether to include active items.

IncludeInactive bool

None.

Gets or sets a value indicating whether to include inactive items.

AnalysisCategoryId1 nullable integer

None.

Gets or sets the AnalysisCategoryID1.

AnalysisCategoryId2 nullable integer

None.

Gets or sets the AnalysisCategoryID2.

AnalysisCategoryId3 nullable integer

None.

Gets or sets the AnalysisCategoryID3.

ReportGroupAccount string

None.

Gets or sets the report group account.

IncludeCreditNotes bool

None.

Gets or sets a value indicating whether to include credit notes or not.

Detailed bool

None.

Gets or sets a value indicating whether this is detailed.

UseLastCost bool

None.

Gets or sets a value indicating whether to use last cost on items or not.

Limit integer

None.

Gets or sets the limit.

Request Formats

application/json, text/json

Sample:
{
  "AnalysisCategoryId1": 1,
  "AnalysisCategoryId2": 1,
  "AnalysisCategoryId3": 1,
  "ReportGroupAccount": "sample string 1",
  "IncludeCreditNotes": true,
  "Detailed": true,
  "UseLastCost": true,
  "Limit": 5,
  "FromItem": "sample string 6",
  "ToItem": "sample string 7",
  "FromCategory": "sample string 8",
  "ToCategory": "sample string 9",
  "IncludeService": true,
  "IncludePhysical": true,
  "IncludeActive": true,
  "IncludeInactive": true,
  "FromDate": "2021-10-19",
  "ToDate": "2021-10-19"
}

Response Information

Resource Description

This collection is wrapped in a paging response object.

Paging response of Sales By Item
NameTypeAdditional informationDescription
TotalResults integer

None.

ReturnedResults integer

None.

Results Collection of Sales By Item

None.

Response Formats

application/json, text/json

Sample:
{
  "TotalResults": 1,
  "ReturnedResults": 2,
  "Results": [
    {
      "ID": 1,
      "TransactionID": 2,
      "DocumentTypeId": 3,
      "DocumentNumber": "sample string 4",
      "CustomerName": "sample string 5",
      "ItemCode": "sample string 6",
      "ItemDescription": "sample string 7",
      "ItemCodeAndDescription": "sample string 8",
      "UnitPriceExclusive": 9.0,
      "Quantity": 10.0,
      "TotalCost": 11.0,
      "TotalSelling": 12.0,
      "Date": "2021-10-19T00:00:00Z",
      "LastCost": 14.0,
      "PriceExclusive": 15.0,
      "GPAmount": 16.0,
      "GPPercentage": 1.3333333333333333
    },
    {
      "ID": 1,
      "TransactionID": 2,
      "DocumentTypeId": 3,
      "DocumentNumber": "sample string 4",
      "CustomerName": "sample string 5",
      "ItemCode": "sample string 6",
      "ItemDescription": "sample string 7",
      "ItemCodeAndDescription": "sample string 8",
      "UnitPriceExclusive": 9.0,
      "Quantity": 10.0,
      "TotalCost": 11.0,
      "TotalSelling": 12.0,
      "Date": "2021-10-19T00:00:00Z",
      "LastCost": 14.0,
      "PriceExclusive": 15.0,
      "GPAmount": 16.0,
      "GPPercentage": 1.3333333333333333
    }
  ]
}