POST api/BHHopper/GetExpiredAgreements?expdate={expdate}&releaseunsigned={releaseunsigned}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| expdate | date |
Required |
|
| releaseunsigned | boolean |
Required |
Body Parameters
None.
Response Information
Resource Description
Collection of ExpiringAgreements| Name | Description | Type | Additional information |
|---|---|---|---|
| CUSTNMBR | string |
None. |
|
| CUSTNAME | string |
None. |
|
| AgreementID | integer |
None. |
|
| CreatedDate | date |
None. |
|
| AgreementYear | string |
None. |
|
| ExpireDate | date |
None. |
|
| Status | string |
None. |
|
| Orders | Collection of ExpiringAgreementDetails |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"CUSTNMBR": "sample string 1",
"CUSTNAME": "sample string 2",
"AgreementID": 3,
"CreatedDate": "2026-11-21T14:48:50.9278297+00:00",
"AgreementYear": "sample string 5",
"ExpireDate": "2026-11-21T14:48:50.9278297+00:00",
"Status": "sample string 7",
"Orders": [
{
"AgreementID": 1,
"SOPTYPE": 2,
"SOPNUMBE": "sample string 3",
"DOCDATE": "2026-11-21T14:48:50.9278297+00:00",
"ITEMNMBR": "sample string 5",
"ITEMDESC": "sample string 6",
"Quantity": 7.0,
"UofM": "sample string 8",
"LOCNCODE": "sample string 9"
},
{
"AgreementID": 1,
"SOPTYPE": 2,
"SOPNUMBE": "sample string 3",
"DOCDATE": "2026-11-21T14:48:50.9278297+00:00",
"ITEMNMBR": "sample string 5",
"ITEMDESC": "sample string 6",
"Quantity": 7.0,
"UofM": "sample string 8",
"LOCNCODE": "sample string 9"
}
]
},
{
"CUSTNMBR": "sample string 1",
"CUSTNAME": "sample string 2",
"AgreementID": 3,
"CreatedDate": "2026-11-21T14:48:50.9278297+00:00",
"AgreementYear": "sample string 5",
"ExpireDate": "2026-11-21T14:48:50.9278297+00:00",
"Status": "sample string 7",
"Orders": [
{
"AgreementID": 1,
"SOPTYPE": 2,
"SOPNUMBE": "sample string 3",
"DOCDATE": "2026-11-21T14:48:50.9278297+00:00",
"ITEMNMBR": "sample string 5",
"ITEMDESC": "sample string 6",
"Quantity": 7.0,
"UofM": "sample string 8",
"LOCNCODE": "sample string 9"
},
{
"AgreementID": 1,
"SOPTYPE": 2,
"SOPNUMBE": "sample string 3",
"DOCDATE": "2026-11-21T14:48:50.9278297+00:00",
"ITEMNMBR": "sample string 5",
"ITEMDESC": "sample string 6",
"Quantity": 7.0,
"UofM": "sample string 8",
"LOCNCODE": "sample string 9"
}
]
}
]
application/xml, text/xml
Sample:
<ArrayOfExpiringAgreements xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GoHarrellsAPI.Models">
<ExpiringAgreements>
<AgreementID>3</AgreementID>
<AgreementYear>sample string 5</AgreementYear>
<CUSTNAME>sample string 2</CUSTNAME>
<CUSTNMBR>sample string 1</CUSTNMBR>
<CreatedDate>2026-11-21T14:48:50.9278297+00:00</CreatedDate>
<ExpireDate>2026-11-21T14:48:50.9278297+00:00</ExpireDate>
<Orders>
<ExpiringAgreementDetails>
<AgreementID>1</AgreementID>
<DOCDATE>2026-11-21T14:48:50.9278297+00:00</DOCDATE>
<ITEMDESC>sample string 6</ITEMDESC>
<ITEMNMBR>sample string 5</ITEMNMBR>
<LOCNCODE>sample string 9</LOCNCODE>
<Quantity>7</Quantity>
<SOPNUMBE>sample string 3</SOPNUMBE>
<SOPTYPE>2</SOPTYPE>
<UofM>sample string 8</UofM>
</ExpiringAgreementDetails>
<ExpiringAgreementDetails>
<AgreementID>1</AgreementID>
<DOCDATE>2026-11-21T14:48:50.9278297+00:00</DOCDATE>
<ITEMDESC>sample string 6</ITEMDESC>
<ITEMNMBR>sample string 5</ITEMNMBR>
<LOCNCODE>sample string 9</LOCNCODE>
<Quantity>7</Quantity>
<SOPNUMBE>sample string 3</SOPNUMBE>
<SOPTYPE>2</SOPTYPE>
<UofM>sample string 8</UofM>
</ExpiringAgreementDetails>
</Orders>
<Status>sample string 7</Status>
</ExpiringAgreements>
<ExpiringAgreements>
<AgreementID>3</AgreementID>
<AgreementYear>sample string 5</AgreementYear>
<CUSTNAME>sample string 2</CUSTNAME>
<CUSTNMBR>sample string 1</CUSTNMBR>
<CreatedDate>2026-11-21T14:48:50.9278297+00:00</CreatedDate>
<ExpireDate>2026-11-21T14:48:50.9278297+00:00</ExpireDate>
<Orders>
<ExpiringAgreementDetails>
<AgreementID>1</AgreementID>
<DOCDATE>2026-11-21T14:48:50.9278297+00:00</DOCDATE>
<ITEMDESC>sample string 6</ITEMDESC>
<ITEMNMBR>sample string 5</ITEMNMBR>
<LOCNCODE>sample string 9</LOCNCODE>
<Quantity>7</Quantity>
<SOPNUMBE>sample string 3</SOPNUMBE>
<SOPTYPE>2</SOPTYPE>
<UofM>sample string 8</UofM>
</ExpiringAgreementDetails>
<ExpiringAgreementDetails>
<AgreementID>1</AgreementID>
<DOCDATE>2026-11-21T14:48:50.9278297+00:00</DOCDATE>
<ITEMDESC>sample string 6</ITEMDESC>
<ITEMNMBR>sample string 5</ITEMNMBR>
<LOCNCODE>sample string 9</LOCNCODE>
<Quantity>7</Quantity>
<SOPNUMBE>sample string 3</SOPNUMBE>
<SOPTYPE>2</SOPTYPE>
<UofM>sample string 8</UofM>
</ExpiringAgreementDetails>
</Orders>
<Status>sample string 7</Status>
</ExpiringAgreements>
</ArrayOfExpiringAgreements>