POST api/tonnage/GetClasses

Request Information

URI Parameters

None.

Body Parameters

TonnageCriteria
NameDescriptionTypeAdditional information
State

string

None.

BeginDate

date

None.

EndDate

date

None.

IncludeSalesGT

decimal number

None.

ItemClassCodes

Collection of string

None.

Categories

Collection of string

None.

SearchStr

string

None.

Request Formats

application/json, text/json

Sample:
{
  "State": "sample string 1",
  "BeginDate": "2026-11-17T10:34:57.1791582+00:00",
  "EndDate": "2026-11-17T10:34:57.1791582+00:00",
  "IncludeSalesGT": 4.1,
  "ItemClassCodes": [
    "sample string 1",
    "sample string 2"
  ],
  "Categories": [
    "sample string 1",
    "sample string 2"
  ],
  "SearchStr": "sample string 5"
}

application/xml, text/xml

Sample:
<TonnageReportingModels.TonnageCriteria xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HarAccountingAPI.Models">
  <BeginDate>2026-11-17T10:34:57.1791582+00:00</BeginDate>
  <Categories xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Categories>
  <EndDate>2026-11-17T10:34:57.1791582+00:00</EndDate>
  <IncludeSalesGT>4.1</IncludeSalesGT>
  <ItemClassCodes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ItemClassCodes>
  <SearchStr>sample string 5</SearchStr>
  <State>sample string 1</State>
</TonnageReportingModels.TonnageCriteria>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

NameValueListWrapper
NameDescriptionTypeAdditional information
ResponseStatus

string

None.

ValidationMessages

Collection of string

None.

Warnings

Collection of string

None.

BusinessRuleViolations

Collection of string

None.

ErrorWrappers

Collection of ErrorWrapper

None.

GridSummary

string

None.

AdditionalData

Object

None.

Data

Collection of NameValue

None.

Response Formats

application/json, text/json

Sample:
{
  "ResponseStatus": "sample string 1",
  "ValidationMessages": [
    "sample string 1",
    "sample string 2"
  ],
  "Warnings": [
    "sample string 1",
    "sample string 2"
  ],
  "BusinessRuleViolations": [
    "sample string 1",
    "sample string 2"
  ],
  "ErrorWrappers": [
    {
      "ErrorMessage": "sample string 1",
      "ErrorCode": "sample string 2",
      "AdditionalInformation": "sample string 3"
    },
    {
      "ErrorMessage": "sample string 1",
      "ErrorCode": "sample string 2",
      "AdditionalInformation": "sample string 3"
    }
  ],
  "GridSummary": "sample string 2",
  "AdditionalData": {},
  "Data": [
    {
      "Name": "sample string 1",
      "Value": "sample string 2"
    },
    {
      "Name": "sample string 1",
      "Value": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample:
<TonnageReportingModels.NameValueListWrapper xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HarAccountingAPI.Models">
  <AdditionalData />
  <BusinessRuleViolations xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </BusinessRuleViolations>
  <Data>
    <AccountingModels.NameValue>
      <Name>sample string 1</Name>
      <Value>sample string 2</Value>
    </AccountingModels.NameValue>
    <AccountingModels.NameValue>
      <Name>sample string 1</Name>
      <Value>sample string 2</Value>
    </AccountingModels.NameValue>
  </Data>
  <ErrorWrappers>
    <ErrorWrapper>
      <AdditionalInformation>sample string 3</AdditionalInformation>
      <ErrorCode>sample string 2</ErrorCode>
      <ErrorMessage>sample string 1</ErrorMessage>
    </ErrorWrapper>
    <ErrorWrapper>
      <AdditionalInformation>sample string 3</AdditionalInformation>
      <ErrorCode>sample string 2</ErrorCode>
      <ErrorMessage>sample string 1</ErrorMessage>
    </ErrorWrapper>
  </ErrorWrappers>
  <GridSummary>sample string 2</GridSummary>
  <ResponseStatus>sample string 1</ResponseStatus>
  <ValidationMessages xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ValidationMessages>
  <Warnings xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Warnings>
</TonnageReportingModels.NameValueListWrapper>