POST api/BHHopper/GetBillHoldOrders
Request Information
URI Parameters
None.
Body Parameters
BillHoldCriteria| Name | Description | Type | Additional 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:46.6799921+00:00",
"ToDate": "2026-11-21T14:53:46.6799921+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:46.6799921+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:46.6799921+00:00</ToDate> </BillHoldCriteria>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
Collection of BillHoldOrderHeader| Name | Description | Type | Additional information |
|---|---|---|---|
| CUSTNMBR | 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. |
|
| SLPRSNID | string |
None. |
|
| RepName | string |
None. |
|
| NmbrItems | integer |
None. |
|
| ShipDate | date |
None. |
|
| INVSOPNUMBE | string |
None. |
|
| ExtPrice | decimal number |
None. |
|
| MargDollars | decimal number |
None. |
|
| Address1 | string |
None. |
|
| Address2 | string |
None. |
|
| City | string |
None. |
|
| State | string |
None. |
|
| Zip | string |
None. |
|
| PONumber | string |
None. |
|
| EmailSent | date |
None. |
|
| EmailSentTo | string |
None. |
|
| AgreementSignedBy | string |
None. |
|
| SigneeTitle | string |
None. |
|
| SignDate | date |
None. |
|
| OrderNotes | string |
None. |
|
| OrderComments | string |
None. |
|
| OrigSOPNUMBE | string |
None. |
|
| OrigDOCDATE | date |
None. |
|
| CreditIssues | Collection of string |
None. |
|
| PaymentTerms | string |
None. |
|
| OnHold | boolean |
None. |
|
| CreditLimit | decimal number |
None. |
|
| CurrentBalance | decimal number |
None. |
|
| Over60Days | decimal number |
None. |
|
| TotalOpen | decimal number |
None. |
|
| IsSigned | boolean |
None. |
|
| SignedDocExists | boolean |
None. |
|
| AgreementDate | date |
None. |
|
| ExpirationDate | date |
None. |
|
| CUSTNAME | string |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"CUSTNMBR": "sample string 1",
"ProcessedOrderId": 2,
"SOPTYPE": 3,
"SOPNUMBE": "sample string 4",
"AgreementID": 5,
"Status": "sample string 6",
"CreatedDate": "2026-11-21T14:53:46.6799921+00:00",
"DOCDATE": "2026-11-21T14:53:46.6799921+00:00",
"ADRSCODE": "sample string 9",
"SLPRSNID": "sample string 10",
"RepName": "sample string 11",
"NmbrItems": 12,
"ShipDate": "2026-11-21T14:53:46.6799921+00:00",
"INVSOPNUMBE": "sample string 14",
"ExtPrice": 15.0,
"MargDollars": 16.0,
"Address1": "sample string 17",
"Address2": "sample string 18",
"City": "sample string 19",
"State": "sample string 20",
"Zip": "sample string 21",
"PONumber": "sample string 22",
"EmailSent": "2026-11-21T14:53:46.6799921+00:00",
"EmailSentTo": "sample string 24",
"AgreementSignedBy": "sample string 25",
"SigneeTitle": "sample string 26",
"SignDate": "2026-11-21T14:53:46.6799921+00:00",
"OrderNotes": "sample string 28",
"OrderComments": "sample string 29",
"OrigSOPNUMBE": "sample string 30",
"OrigDOCDATE": "2026-11-21T14:53:46.6799921+00:00",
"CreditIssues": [
"sample string 1",
"sample string 2"
],
"PaymentTerms": "sample string 32",
"OnHold": true,
"CreditLimit": 34.0,
"CurrentBalance": 35.0,
"Over60Days": 36.0,
"TotalOpen": 37.0,
"IsSigned": true,
"SignedDocExists": true,
"AgreementDate": "2026-11-21T14:53:46.6799921+00:00",
"ExpirationDate": "2026-11-21T14:53:46.6799921+00:00",
"CUSTNAME": "sample string 42"
},
{
"CUSTNMBR": "sample string 1",
"ProcessedOrderId": 2,
"SOPTYPE": 3,
"SOPNUMBE": "sample string 4",
"AgreementID": 5,
"Status": "sample string 6",
"CreatedDate": "2026-11-21T14:53:46.6799921+00:00",
"DOCDATE": "2026-11-21T14:53:46.6799921+00:00",
"ADRSCODE": "sample string 9",
"SLPRSNID": "sample string 10",
"RepName": "sample string 11",
"NmbrItems": 12,
"ShipDate": "2026-11-21T14:53:46.6799921+00:00",
"INVSOPNUMBE": "sample string 14",
"ExtPrice": 15.0,
"MargDollars": 16.0,
"Address1": "sample string 17",
"Address2": "sample string 18",
"City": "sample string 19",
"State": "sample string 20",
"Zip": "sample string 21",
"PONumber": "sample string 22",
"EmailSent": "2026-11-21T14:53:46.6799921+00:00",
"EmailSentTo": "sample string 24",
"AgreementSignedBy": "sample string 25",
"SigneeTitle": "sample string 26",
"SignDate": "2026-11-21T14:53:46.6799921+00:00",
"OrderNotes": "sample string 28",
"OrderComments": "sample string 29",
"OrigSOPNUMBE": "sample string 30",
"OrigDOCDATE": "2026-11-21T14:53:46.6799921+00:00",
"CreditIssues": [
"sample string 1",
"sample string 2"
],
"PaymentTerms": "sample string 32",
"OnHold": true,
"CreditLimit": 34.0,
"CurrentBalance": 35.0,
"Over60Days": 36.0,
"TotalOpen": 37.0,
"IsSigned": true,
"SignedDocExists": true,
"AgreementDate": "2026-11-21T14:53:46.6799921+00:00",
"ExpirationDate": "2026-11-21T14:53:46.6799921+00:00",
"CUSTNAME": "sample string 42"
}
]
application/xml, text/xml
Sample:
<ArrayOfBillHoldOrderHeader xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GoHarrellsAPI.Models">
<BillHoldOrderHeader>
<ADRSCODE>sample string 9</ADRSCODE>
<Address1>sample string 17</Address1>
<Address2>sample string 18</Address2>
<AgreementDate>2026-11-21T14:53:46.6799921+00:00</AgreementDate>
<AgreementID>5</AgreementID>
<AgreementSignedBy>sample string 25</AgreementSignedBy>
<CUSTNAME>sample string 42</CUSTNAME>
<CUSTNMBR>sample string 1</CUSTNMBR>
<City>sample string 19</City>
<CreatedDate>2026-11-21T14:53:46.6799921+00:00</CreatedDate>
<CreditIssues xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:string>sample string 1</d3p1:string>
<d3p1:string>sample string 2</d3p1:string>
</CreditIssues>
<CreditLimit>34</CreditLimit>
<CurrentBalance>35</CurrentBalance>
<DOCDATE>2026-11-21T14:53:46.6799921+00:00</DOCDATE>
<EmailSent>2026-11-21T14:53:46.6799921+00:00</EmailSent>
<EmailSentTo>sample string 24</EmailSentTo>
<ExpirationDate>2026-11-21T14:53:46.6799921+00:00</ExpirationDate>
<ExtPrice>15</ExtPrice>
<INVSOPNUMBE>sample string 14</INVSOPNUMBE>
<IsSigned>true</IsSigned>
<MargDollars>16</MargDollars>
<NmbrItems>12</NmbrItems>
<OnHold>true</OnHold>
<OrderComments>sample string 29</OrderComments>
<OrderNotes>sample string 28</OrderNotes>
<OrigDOCDATE>2026-11-21T14:53:46.6799921+00:00</OrigDOCDATE>
<OrigSOPNUMBE>sample string 30</OrigSOPNUMBE>
<Over60Days>36</Over60Days>
<PONumber>sample string 22</PONumber>
<PaymentTerms>sample string 32</PaymentTerms>
<ProcessedOrderId>2</ProcessedOrderId>
<RepName>sample string 11</RepName>
<SLPRSNID>sample string 10</SLPRSNID>
<SOPNUMBE>sample string 4</SOPNUMBE>
<SOPTYPE>3</SOPTYPE>
<ShipDate>2026-11-21T14:53:46.6799921+00:00</ShipDate>
<SignDate>2026-11-21T14:53:46.6799921+00:00</SignDate>
<SignedDocExists>true</SignedDocExists>
<SigneeTitle>sample string 26</SigneeTitle>
<State>sample string 20</State>
<Status>sample string 6</Status>
<TotalOpen>37</TotalOpen>
<Zip>sample string 21</Zip>
</BillHoldOrderHeader>
<BillHoldOrderHeader>
<ADRSCODE>sample string 9</ADRSCODE>
<Address1>sample string 17</Address1>
<Address2>sample string 18</Address2>
<AgreementDate>2026-11-21T14:53:46.6799921+00:00</AgreementDate>
<AgreementID>5</AgreementID>
<AgreementSignedBy>sample string 25</AgreementSignedBy>
<CUSTNAME>sample string 42</CUSTNAME>
<CUSTNMBR>sample string 1</CUSTNMBR>
<City>sample string 19</City>
<CreatedDate>2026-11-21T14:53:46.6799921+00:00</CreatedDate>
<CreditIssues xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:string>sample string 1</d3p1:string>
<d3p1:string>sample string 2</d3p1:string>
</CreditIssues>
<CreditLimit>34</CreditLimit>
<CurrentBalance>35</CurrentBalance>
<DOCDATE>2026-11-21T14:53:46.6799921+00:00</DOCDATE>
<EmailSent>2026-11-21T14:53:46.6799921+00:00</EmailSent>
<EmailSentTo>sample string 24</EmailSentTo>
<ExpirationDate>2026-11-21T14:53:46.6799921+00:00</ExpirationDate>
<ExtPrice>15</ExtPrice>
<INVSOPNUMBE>sample string 14</INVSOPNUMBE>
<IsSigned>true</IsSigned>
<MargDollars>16</MargDollars>
<NmbrItems>12</NmbrItems>
<OnHold>true</OnHold>
<OrderComments>sample string 29</OrderComments>
<OrderNotes>sample string 28</OrderNotes>
<OrigDOCDATE>2026-11-21T14:53:46.6799921+00:00</OrigDOCDATE>
<OrigSOPNUMBE>sample string 30</OrigSOPNUMBE>
<Over60Days>36</Over60Days>
<PONumber>sample string 22</PONumber>
<PaymentTerms>sample string 32</PaymentTerms>
<ProcessedOrderId>2</ProcessedOrderId>
<RepName>sample string 11</RepName>
<SLPRSNID>sample string 10</SLPRSNID>
<SOPNUMBE>sample string 4</SOPNUMBE>
<SOPTYPE>3</SOPTYPE>
<ShipDate>2026-11-21T14:53:46.6799921+00:00</ShipDate>
<SignDate>2026-11-21T14:53:46.6799921+00:00</SignDate>
<SignedDocExists>true</SignedDocExists>
<SigneeTitle>sample string 26</SigneeTitle>
<State>sample string 20</State>
<Status>sample string 6</Status>
<TotalOpen>37</TotalOpen>
<Zip>sample string 21</Zip>
</BillHoldOrderHeader>
</ArrayOfBillHoldOrderHeader>