POST PriceListingReport/Get

Request Information

URI Parameters

None.

Body Parameters

Price List Report Request Model
NameTypeAdditional informationDescription
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.

PriceListIds Collection of integer

None.

Exclusive bool

None.

IncludeServiceItems bool

None.

IncludePhysicalItems bool

None.

IncludeActive bool

None.

IncludeInactive bool

None.

Request Formats

application/json, text/json

Sample:
{
  "FromItem": "sample string 1",
  "ToItem": "sample string 2",
  "FromCategory": "sample string 3",
  "ToCategory": "sample string 4",
  "PriceListIds": [
    1,
    2
  ],
  "Exclusive": true,
  "IncludeServiceItems": true,
  "IncludePhysicalItems": true,
  "IncludeActive": true,
  "IncludeInactive": true
}

Response Information

Resource Description

Collection of Price List Report Line
NameTypeAdditional informationDescription
ID integer

None.

Code string

None.

Description string

None.

CategoryDescription string

None.

Unit string

None.

PriceListReportLineItems Collection of Price List Report Line Item

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "ID": 1,
    "Code": "sample string 2",
    "Description": "sample string 3",
    "CategoryDescription": "sample string 4",
    "Unit": "sample string 5",
    "PriceListReportLineItems": [
      {
        "AdditionalPriceListID": 1,
        "UnitPrice": 2.0,
        "UnitPriceInclusive": 1.0,
        "UnitPriceExclusive": 1.0
      },
      {
        "AdditionalPriceListID": 1,
        "UnitPrice": 2.0,
        "UnitPriceInclusive": 1.0,
        "UnitPriceExclusive": 1.0
      }
    ]
  },
  {
    "ID": 1,
    "Code": "sample string 2",
    "Description": "sample string 3",
    "CategoryDescription": "sample string 4",
    "Unit": "sample string 5",
    "PriceListReportLineItems": [
      {
        "AdditionalPriceListID": 1,
        "UnitPrice": 2.0,
        "UnitPriceInclusive": 1.0,
        "UnitPriceExclusive": 1.0
      },
      {
        "AdditionalPriceListID": 1,
        "UnitPrice": 2.0,
        "UnitPriceInclusive": 1.0,
        "UnitPriceExclusive": 1.0
      }
    ]
  }
]