POST api/BHHopper/GetBillHoldGroups

Request Information

URI Parameters

None.

Body Parameters

BillHoldCriteria
NameDescriptionTypeAdditional information
IncludeUnprocessed

boolean

None.

IncludeUnsent

boolean

None.

IncludeUnsigned

boolean

None.

IncludeSigned

boolean

None.

IncludeVoid

boolean

None.

CUSTNMBR

string

None.

SLPRSNID

string

None.

SOPNUMBE

string

None.

AgreementID

integer

None.

FromDate

date

None.

ToDate

date

None.

PaperAgreements

boolean

None.

ActiveAgreements

boolean

None.

AgreementYear

string

None.

SalesGroupID

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "IncludeUnprocessed": true,
  "IncludeUnsent": true,
  "IncludeUnsigned": true,
  "IncludeSigned": true,
  "IncludeVoid": true,
  "CUSTNMBR": "sample string 6",
  "SLPRSNID": "sample string 7",
  "SOPNUMBE": "sample string 8",
  "AgreementID": 9,
  "FromDate": "2026-11-21T14:53:01.2802689+00:00",
  "ToDate": "2026-11-21T14:53:01.2802689+00:00",
  "PaperAgreements": true,
  "ActiveAgreements": true,
  "AgreementYear": "sample string 14",
  "SalesGroupID": 15
}

application/xml, text/xml

Sample:
<BillHoldCriteria xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GoHarrellsAPI.Models">
  <ActiveAgreements>true</ActiveAgreements>
  <AgreementID>9</AgreementID>
  <AgreementYear>sample string 14</AgreementYear>
  <CUSTNMBR>sample string 6</CUSTNMBR>
  <FromDate>2026-11-21T14:53:01.2802689+00:00</FromDate>
  <IncludeSigned>true</IncludeSigned>
  <IncludeUnprocessed>true</IncludeUnprocessed>
  <IncludeUnsent>true</IncludeUnsent>
  <IncludeUnsigned>true</IncludeUnsigned>
  <IncludeVoid>true</IncludeVoid>
  <PaperAgreements>true</PaperAgreements>
  <SLPRSNID>sample string 7</SLPRSNID>
  <SOPNUMBE>sample string 8</SOPNUMBE>
  <SalesGroupID>15</SalesGroupID>
  <ToDate>2026-11-21T14:53:01.2802689+00:00</ToDate>
</BillHoldCriteria>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of NameValue
NameDescriptionTypeAdditional information
Name

string

None.

Value

string

None.

PORequired

boolean

None.

Partnership

string

None.

LOCNCODE

string

None.

MTDCost

decimal number

None.

YTDCost

decimal number

None.

MTDSales

decimal number

None.

YTDSales

decimal number

None.

DownLoadDate

date

None.

LastGoPWAUpdate

date

None.

MonthName

string

None.

Row_Id

integer

None.

DefaultRec

boolean

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "Name": "sample string 1",
    "Value": "sample string 2",
    "PORequired": true,
    "Partnership": "sample string 4",
    "LOCNCODE": "sample string 5",
    "MTDCost": 6.1,
    "YTDCost": 7.1,
    "MTDSales": 8.1,
    "YTDSales": 9.1,
    "DownLoadDate": "2026-11-21T14:53:01.2802689+00:00",
    "LastGoPWAUpdate": "2026-11-21T14:53:01.2802689+00:00",
    "MonthName": "sample string 12",
    "Row_Id": 13,
    "DefaultRec": true
  },
  {
    "Name": "sample string 1",
    "Value": "sample string 2",
    "PORequired": true,
    "Partnership": "sample string 4",
    "LOCNCODE": "sample string 5",
    "MTDCost": 6.1,
    "YTDCost": 7.1,
    "MTDSales": 8.1,
    "YTDSales": 9.1,
    "DownLoadDate": "2026-11-21T14:53:01.2802689+00:00",
    "LastGoPWAUpdate": "2026-11-21T14:53:01.2802689+00:00",
    "MonthName": "sample string 12",
    "Row_Id": 13,
    "DefaultRec": true
  }
]

application/xml, text/xml

Sample:
<ArrayOfNameValue xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GoHarrellsAPI.Models">
  <NameValue>
    <DefaultRec>true</DefaultRec>
    <DownLoadDate>2026-11-21T14:53:01.2802689+00:00</DownLoadDate>
    <LOCNCODE>sample string 5</LOCNCODE>
    <LastGoPWAUpdate>2026-11-21T14:53:01.2802689+00:00</LastGoPWAUpdate>
    <MTDCost>6.1</MTDCost>
    <MTDSales>8.1</MTDSales>
    <MonthName>sample string 12</MonthName>
    <Name>sample string 1</Name>
    <PORequired>true</PORequired>
    <Partnership>sample string 4</Partnership>
    <Row_Id>13</Row_Id>
    <Value>sample string 2</Value>
    <YTDCost>7.1</YTDCost>
    <YTDSales>9.1</YTDSales>
  </NameValue>
  <NameValue>
    <DefaultRec>true</DefaultRec>
    <DownLoadDate>2026-11-21T14:53:01.2802689+00:00</DownLoadDate>
    <LOCNCODE>sample string 5</LOCNCODE>
    <LastGoPWAUpdate>2026-11-21T14:53:01.2802689+00:00</LastGoPWAUpdate>
    <MTDCost>6.1</MTDCost>
    <MTDSales>8.1</MTDSales>
    <MonthName>sample string 12</MonthName>
    <Name>sample string 1</Name>
    <PORequired>true</PORequired>
    <Partnership>sample string 4</Partnership>
    <Row_Id>13</Row_Id>
    <Value>sample string 2</Value>
    <YTDCost>7.1</YTDCost>
    <YTDSales>9.1</YTDSales>
  </NameValue>
</ArrayOfNameValue>