POST api/BHHopper/GetBillHoldCustomerRows

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

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of BillHoldOrderCustomer
NameDescriptionTypeAdditional information
CUSTNMBR

string

None.

CUSTNAME

string

None.

PaperAgreement

boolean

None.

TotalOrders

integer

None.

UnprocessedOrders

integer

None.

UnsentOrders

integer

None.

UnsignedOrders

integer

None.

EOPRewardsEmail

string

None.

BHAgreementEmail

string

None.

Orders

Collection of BillHoldOrderHeader

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "CUSTNMBR": "sample string 1",
    "CUSTNAME": "sample string 2",
    "PaperAgreement": true,
    "TotalOrders": 4,
    "UnprocessedOrders": 5,
    "UnsentOrders": 6,
    "UnsignedOrders": 7,
    "EOPRewardsEmail": "sample string 8",
    "BHAgreementEmail": "sample string 9",
    "Orders": [
      {
        "CUSTNMBR": "sample string 1",
        "ProcessedOrderId": 2,
        "SOPTYPE": 3,
        "SOPNUMBE": "sample string 4",
        "AgreementID": 5,
        "Status": "sample string 6",
        "CreatedDate": "2026-11-21T14:53:02.9209201+00:00",
        "DOCDATE": "2026-11-21T14:53:02.9209201+00:00",
        "ADRSCODE": "sample string 9",
        "SLPRSNID": "sample string 10",
        "RepName": "sample string 11",
        "NmbrItems": 12,
        "ShipDate": "2026-11-21T14:53:02.9209201+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:02.9209201+00:00",
        "EmailSentTo": "sample string 24",
        "AgreementSignedBy": "sample string 25",
        "SigneeTitle": "sample string 26",
        "SignDate": "2026-11-21T14:53:02.9209201+00:00",
        "OrderNotes": "sample string 28",
        "OrderComments": "sample string 29",
        "OrigSOPNUMBE": "sample string 30",
        "OrigDOCDATE": "2026-11-21T14:53:02.9209201+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:02.9209201+00:00",
        "ExpirationDate": "2026-11-21T14:53:02.9209201+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:02.9209201+00:00",
        "DOCDATE": "2026-11-21T14:53:02.9209201+00:00",
        "ADRSCODE": "sample string 9",
        "SLPRSNID": "sample string 10",
        "RepName": "sample string 11",
        "NmbrItems": 12,
        "ShipDate": "2026-11-21T14:53:02.9209201+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:02.9209201+00:00",
        "EmailSentTo": "sample string 24",
        "AgreementSignedBy": "sample string 25",
        "SigneeTitle": "sample string 26",
        "SignDate": "2026-11-21T14:53:02.9209201+00:00",
        "OrderNotes": "sample string 28",
        "OrderComments": "sample string 29",
        "OrigSOPNUMBE": "sample string 30",
        "OrigDOCDATE": "2026-11-21T14:53:02.9209201+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:02.9209201+00:00",
        "ExpirationDate": "2026-11-21T14:53:02.9209201+00:00",
        "CUSTNAME": "sample string 42"
      }
    ]
  },
  {
    "CUSTNMBR": "sample string 1",
    "CUSTNAME": "sample string 2",
    "PaperAgreement": true,
    "TotalOrders": 4,
    "UnprocessedOrders": 5,
    "UnsentOrders": 6,
    "UnsignedOrders": 7,
    "EOPRewardsEmail": "sample string 8",
    "BHAgreementEmail": "sample string 9",
    "Orders": [
      {
        "CUSTNMBR": "sample string 1",
        "ProcessedOrderId": 2,
        "SOPTYPE": 3,
        "SOPNUMBE": "sample string 4",
        "AgreementID": 5,
        "Status": "sample string 6",
        "CreatedDate": "2026-11-21T14:53:02.9209201+00:00",
        "DOCDATE": "2026-11-21T14:53:02.9209201+00:00",
        "ADRSCODE": "sample string 9",
        "SLPRSNID": "sample string 10",
        "RepName": "sample string 11",
        "NmbrItems": 12,
        "ShipDate": "2026-11-21T14:53:02.9209201+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:02.9209201+00:00",
        "EmailSentTo": "sample string 24",
        "AgreementSignedBy": "sample string 25",
        "SigneeTitle": "sample string 26",
        "SignDate": "2026-11-21T14:53:02.9209201+00:00",
        "OrderNotes": "sample string 28",
        "OrderComments": "sample string 29",
        "OrigSOPNUMBE": "sample string 30",
        "OrigDOCDATE": "2026-11-21T14:53:02.9209201+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:02.9209201+00:00",
        "ExpirationDate": "2026-11-21T14:53:02.9209201+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:02.9209201+00:00",
        "DOCDATE": "2026-11-21T14:53:02.9209201+00:00",
        "ADRSCODE": "sample string 9",
        "SLPRSNID": "sample string 10",
        "RepName": "sample string 11",
        "NmbrItems": 12,
        "ShipDate": "2026-11-21T14:53:02.9209201+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:02.9209201+00:00",
        "EmailSentTo": "sample string 24",
        "AgreementSignedBy": "sample string 25",
        "SigneeTitle": "sample string 26",
        "SignDate": "2026-11-21T14:53:02.9209201+00:00",
        "OrderNotes": "sample string 28",
        "OrderComments": "sample string 29",
        "OrigSOPNUMBE": "sample string 30",
        "OrigDOCDATE": "2026-11-21T14:53:02.9209201+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:02.9209201+00:00",
        "ExpirationDate": "2026-11-21T14:53:02.9209201+00:00",
        "CUSTNAME": "sample string 42"
      }
    ]
  }
]

application/xml, text/xml

Sample:
<ArrayOfBillHoldOrderCustomer xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GoHarrellsAPI.Models">
  <BillHoldOrderCustomer>
    <BHAgreementEmail>sample string 9</BHAgreementEmail>
    <CUSTNAME>sample string 2</CUSTNAME>
    <CUSTNMBR>sample string 1</CUSTNMBR>
    <EOPRewardsEmail>sample string 8</EOPRewardsEmail>
    <Orders>
      <BillHoldOrderHeader>
        <ADRSCODE>sample string 9</ADRSCODE>
        <Address1>sample string 17</Address1>
        <Address2>sample string 18</Address2>
        <AgreementDate>2026-11-21T14:53:02.9209201+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:02.9209201+00:00</CreatedDate>
        <CreditIssues xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </CreditIssues>
        <CreditLimit>34</CreditLimit>
        <CurrentBalance>35</CurrentBalance>
        <DOCDATE>2026-11-21T14:53:02.9209201+00:00</DOCDATE>
        <EmailSent>2026-11-21T14:53:02.9209201+00:00</EmailSent>
        <EmailSentTo>sample string 24</EmailSentTo>
        <ExpirationDate>2026-11-21T14:53:02.9209201+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:02.9209201+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:02.9209201+00:00</ShipDate>
        <SignDate>2026-11-21T14:53:02.9209201+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:02.9209201+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:02.9209201+00:00</CreatedDate>
        <CreditIssues xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </CreditIssues>
        <CreditLimit>34</CreditLimit>
        <CurrentBalance>35</CurrentBalance>
        <DOCDATE>2026-11-21T14:53:02.9209201+00:00</DOCDATE>
        <EmailSent>2026-11-21T14:53:02.9209201+00:00</EmailSent>
        <EmailSentTo>sample string 24</EmailSentTo>
        <ExpirationDate>2026-11-21T14:53:02.9209201+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:02.9209201+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:02.9209201+00:00</ShipDate>
        <SignDate>2026-11-21T14:53:02.9209201+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>
    </Orders>
    <PaperAgreement>true</PaperAgreement>
    <TotalOrders>4</TotalOrders>
    <UnprocessedOrders>5</UnprocessedOrders>
    <UnsentOrders>6</UnsentOrders>
    <UnsignedOrders>7</UnsignedOrders>
  </BillHoldOrderCustomer>
  <BillHoldOrderCustomer>
    <BHAgreementEmail>sample string 9</BHAgreementEmail>
    <CUSTNAME>sample string 2</CUSTNAME>
    <CUSTNMBR>sample string 1</CUSTNMBR>
    <EOPRewardsEmail>sample string 8</EOPRewardsEmail>
    <Orders>
      <BillHoldOrderHeader>
        <ADRSCODE>sample string 9</ADRSCODE>
        <Address1>sample string 17</Address1>
        <Address2>sample string 18</Address2>
        <AgreementDate>2026-11-21T14:53:02.9209201+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:02.9209201+00:00</CreatedDate>
        <CreditIssues xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </CreditIssues>
        <CreditLimit>34</CreditLimit>
        <CurrentBalance>35</CurrentBalance>
        <DOCDATE>2026-11-21T14:53:02.9209201+00:00</DOCDATE>
        <EmailSent>2026-11-21T14:53:02.9209201+00:00</EmailSent>
        <EmailSentTo>sample string 24</EmailSentTo>
        <ExpirationDate>2026-11-21T14:53:02.9209201+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:02.9209201+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:02.9209201+00:00</ShipDate>
        <SignDate>2026-11-21T14:53:02.9209201+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:02.9209201+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:02.9209201+00:00</CreatedDate>
        <CreditIssues xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </CreditIssues>
        <CreditLimit>34</CreditLimit>
        <CurrentBalance>35</CurrentBalance>
        <DOCDATE>2026-11-21T14:53:02.9209201+00:00</DOCDATE>
        <EmailSent>2026-11-21T14:53:02.9209201+00:00</EmailSent>
        <EmailSentTo>sample string 24</EmailSentTo>
        <ExpirationDate>2026-11-21T14:53:02.9209201+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:02.9209201+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:02.9209201+00:00</ShipDate>
        <SignDate>2026-11-21T14:53:02.9209201+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>
    </Orders>
    <PaperAgreement>true</PaperAgreement>
    <TotalOrders>4</TotalOrders>
    <UnprocessedOrders>5</UnprocessedOrders>
    <UnsentOrders>6</UnsentOrders>
    <UnsignedOrders>7</UnsignedOrders>
  </BillHoldOrderCustomer>
</ArrayOfBillHoldOrderCustomer>