POST api/BHHopper/GetBillHoldExport

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:00.5614483+00:00",
  "ToDate": "2026-11-21T14:53:00.5614483+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:00.5614483+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:00.5614483+00:00</ToDate>
</BillHoldCriteria>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of BillHoldExport
NameDescriptionTypeAdditional information
CUSTNMBR

string

None.

CUSTNAME

string

None.

ProcessedOrderId

integer

None.

SOPTYPE

integer

None.

SOPNUMBE

string

None.

AgreementID

integer

None.

Status

string

None.

CreatedDate

date

None.

DOCDATE

date

None.

ADRSCODE

string

None.

ShipDate

date

None.

INVSOPNUMBE

string

None.

OrigSOPNUMBE

string

None.

OrigDOCDATE

date

None.

ITEMNMBR

string

None.

ITEMDESC

string

None.

Quantity

decimal number

None.

UofM

string

None.

VendorId

string

None.

LOCNCODE

string

None.

SLPRSNID

string

None.

RepName

string

None.

SalesSegment

string

None.

SalesGroup

string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "CUSTNMBR": "sample string 1",
    "CUSTNAME": "sample string 2",
    "ProcessedOrderId": 3,
    "SOPTYPE": 4,
    "SOPNUMBE": "sample string 5",
    "AgreementID": 6,
    "Status": "sample string 7",
    "CreatedDate": "2026-11-21T14:53:00.5614483+00:00",
    "DOCDATE": "2026-11-21T14:53:00.5614483+00:00",
    "ADRSCODE": "sample string 10",
    "ShipDate": "2026-11-21T14:53:00.5614483+00:00",
    "INVSOPNUMBE": "sample string 12",
    "OrigSOPNUMBE": "sample string 13",
    "OrigDOCDATE": "2026-11-21T14:53:00.5614483+00:00",
    "ITEMNMBR": "sample string 15",
    "ITEMDESC": "sample string 16",
    "Quantity": 17.0,
    "UofM": "sample string 18",
    "VendorId": "sample string 19",
    "LOCNCODE": "sample string 20",
    "SLPRSNID": "sample string 21",
    "RepName": "sample string 22",
    "SalesSegment": "sample string 23",
    "SalesGroup": "sample string 24"
  },
  {
    "CUSTNMBR": "sample string 1",
    "CUSTNAME": "sample string 2",
    "ProcessedOrderId": 3,
    "SOPTYPE": 4,
    "SOPNUMBE": "sample string 5",
    "AgreementID": 6,
    "Status": "sample string 7",
    "CreatedDate": "2026-11-21T14:53:00.5614483+00:00",
    "DOCDATE": "2026-11-21T14:53:00.5614483+00:00",
    "ADRSCODE": "sample string 10",
    "ShipDate": "2026-11-21T14:53:00.5614483+00:00",
    "INVSOPNUMBE": "sample string 12",
    "OrigSOPNUMBE": "sample string 13",
    "OrigDOCDATE": "2026-11-21T14:53:00.5614483+00:00",
    "ITEMNMBR": "sample string 15",
    "ITEMDESC": "sample string 16",
    "Quantity": 17.0,
    "UofM": "sample string 18",
    "VendorId": "sample string 19",
    "LOCNCODE": "sample string 20",
    "SLPRSNID": "sample string 21",
    "RepName": "sample string 22",
    "SalesSegment": "sample string 23",
    "SalesGroup": "sample string 24"
  }
]

application/xml, text/xml

Sample:
<ArrayOfBillHoldExport xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GoHarrellsAPI.Models">
  <BillHoldExport>
    <ADRSCODE>sample string 10</ADRSCODE>
    <AgreementID>6</AgreementID>
    <CUSTNAME>sample string 2</CUSTNAME>
    <CUSTNMBR>sample string 1</CUSTNMBR>
    <CreatedDate>2026-11-21T14:53:00.5614483+00:00</CreatedDate>
    <DOCDATE>2026-11-21T14:53:00.5614483+00:00</DOCDATE>
    <INVSOPNUMBE>sample string 12</INVSOPNUMBE>
    <ITEMDESC>sample string 16</ITEMDESC>
    <ITEMNMBR>sample string 15</ITEMNMBR>
    <LOCNCODE>sample string 20</LOCNCODE>
    <OrigDOCDATE>2026-11-21T14:53:00.5614483+00:00</OrigDOCDATE>
    <OrigSOPNUMBE>sample string 13</OrigSOPNUMBE>
    <ProcessedOrderId>3</ProcessedOrderId>
    <Quantity>17</Quantity>
    <RepName>sample string 22</RepName>
    <SLPRSNID>sample string 21</SLPRSNID>
    <SOPNUMBE>sample string 5</SOPNUMBE>
    <SOPTYPE>4</SOPTYPE>
    <SalesGroup>sample string 24</SalesGroup>
    <SalesSegment>sample string 23</SalesSegment>
    <ShipDate>2026-11-21T14:53:00.5614483+00:00</ShipDate>
    <Status>sample string 7</Status>
    <UofM>sample string 18</UofM>
    <VendorId>sample string 19</VendorId>
  </BillHoldExport>
  <BillHoldExport>
    <ADRSCODE>sample string 10</ADRSCODE>
    <AgreementID>6</AgreementID>
    <CUSTNAME>sample string 2</CUSTNAME>
    <CUSTNMBR>sample string 1</CUSTNMBR>
    <CreatedDate>2026-11-21T14:53:00.5614483+00:00</CreatedDate>
    <DOCDATE>2026-11-21T14:53:00.5614483+00:00</DOCDATE>
    <INVSOPNUMBE>sample string 12</INVSOPNUMBE>
    <ITEMDESC>sample string 16</ITEMDESC>
    <ITEMNMBR>sample string 15</ITEMNMBR>
    <LOCNCODE>sample string 20</LOCNCODE>
    <OrigDOCDATE>2026-11-21T14:53:00.5614483+00:00</OrigDOCDATE>
    <OrigSOPNUMBE>sample string 13</OrigSOPNUMBE>
    <ProcessedOrderId>3</ProcessedOrderId>
    <Quantity>17</Quantity>
    <RepName>sample string 22</RepName>
    <SLPRSNID>sample string 21</SLPRSNID>
    <SOPNUMBE>sample string 5</SOPNUMBE>
    <SOPTYPE>4</SOPTYPE>
    <SalesGroup>sample string 24</SalesGroup>
    <SalesSegment>sample string 23</SalesSegment>
    <ShipDate>2026-11-21T14:53:00.5614483+00:00</ShipDate>
    <Status>sample string 7</Status>
    <UofM>sample string 18</UofM>
    <VendorId>sample string 19</VendorId>
  </BillHoldExport>
</ArrayOfBillHoldExport>