GET Settlement/GetSettlement?CustID={CustID}&Settlement={Settlement}&Commodity={Commodity}&Location={Location}&SettToDPR={SettToDPR}&SettCheckNum={SettCheckNum}&SettSource={SettSource}&SettSourceRef={SettSourceRef}&SettFromDPR={SettFromDPR}&SettContract={SettContract}&UseDateRange={UseDateRange}&StartDate={StartDate}&EndDate={EndDate}&BlankCheckNumber={BlankCheckNumber}&SortAsc={SortAsc}&Status={Status}&lastModifiedOnOrAfterUtc={lastModifiedOnOrAfterUtc}&lastModifiedOnOrBeforeUtc={lastModifiedOnOrBeforeUtc}

Returns a list of settlements.

Request Information

URI Parameters

NameDescriptionTypeAdditional Information
CustID

Customer ID of the settlements (optional)

string

Default value is string.Empty

Settlement

Settlement number (optional)

string

Default value is string.Empty

Commodity

Commodity of the settlements (optional)

string

Default value is string.Empty

Location

Location ID of the settlements (optional)

string

Default value is All

SettToDPR

Settled to DPR of the settlements (optional)

string

Default value is string.Empty

SettCheckNum

Settlement check number (optional)

string

Default value is string.Empty

SettSource

Source transaction that was being settled; for settlement sources this is the DPR (optional)

string

Default value is string.Empty

SettSourceRef

Reference number of the SettSource (optional)

string

Default value is string.Empty

SettFromDPR

Settled from DPR of the settlements (optional)

string

Default value is string.Empty

SettContract

Settlement contract number (optional)

string

Default value is string.Empty

UseDateRange

Indicates whether or not to filter by the start and end dates used on the settlements (optional)

boolean

Default value is False

StartDate

Start date of the settlements formatted as MM-dd-yyyy (optional)

string

Default value is string.Empty

EndDate

End Date of the settlements formatted as MM-dd-yyyy (optional)

string

Default value is string.Empty

BlankCheckNumber

If true and there is a SettCheckNum, results will include settlements with the ACH number that matches SettCheckNum, otherwise the results will only include settlements with blank check numbers. If false, and there is a value for SettCheckNum, results will only include settlements that have the SettCheckNum value. (optional)

boolean

Default value is False

SortAsc

Sorts the settlements by Unique ID in ascending order (default sort method is descending)

boolean

Default value is False

Status

Possible values are open, closed, and all (optional)

string

Default value is All

lastModifiedOnOrAfterUtc

Filter to include only Settlements changed on or after the supplied UTC date and time. Format = yyyy-MM-ddTHH:mm:ss (Optional)

string

Default value is string.Empty

lastModifiedOnOrBeforeUtc

Filter to include only Settlements changed on or before the supplied UTC date and time. Format = yyyy-MM-ddTHH:mm:ss (Optional)

string

Default value is string.Empty

Body Parameters

Response Information

Resource Description

Returns a list of settlements.

AgvSettlementList
NameDescriptionTypeAdditional Information
Status

0 - Success; 1 - An error occurred; 2 - An error occurred; 3 - Descriptive message, process was successful

string
Message

Informational message that corresponds to the Status returned; 0 - Message will be "OK"; 1 - Detailed message returned to give user an indication of what went wrong; 2 - Less detailed message returned that may not mean anything to the user but that the application might use to take a corrective action; 3 - Not an error but something the user might need to know

string
Count

Number of results returned

string
SettlementList

List of properties and values returned for each settlement that matches the request

Collection of SettlementListItem

Response Formats

application/json, text/json

Sample:
{
  "Status": "sample string 1",
  "Message": "sample string 2",
  "Count": "sample string 3",
  "SettlementList": [
    {
      "Settlement": "sample string 1",
      "Location": "sample string 2",
      "SettledDate": "sample string 3",
      "Commodity": "sample string 4",
      "Reversed": "sample string 5",
      "LastModifiedUtc": "2022-12-08T02:18:03.597263+00:00"
    },
    {
      "Settlement": "sample string 1",
      "Location": "sample string 2",
      "SettledDate": "sample string 3",
      "Commodity": "sample string 4",
      "Reversed": "sample string 5",
      "LastModifiedUtc": "2022-12-08T02:18:03.597263+00:00"
    }
  ]
}

application/xml, text/xml

Sample:
<AgvSettlementList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AgvWebAPICSharp.Models.Settlement">
  <Count>sample string 3</Count>
  <Message>sample string 2</Message>
  <SettlementList xmlns:d2p1="http://schemas.datacontract.org/2004/07/SSI">
    <d2p1:clsGRSettlement.SettlementListItem>
      <d2p1:Commodity>sample string 4</d2p1:Commodity>
      <d2p1:LastModifiedUtc>2022-12-08T02:18:03.597263+00:00</d2p1:LastModifiedUtc>
      <d2p1:Location>sample string 2</d2p1:Location>
      <d2p1:Reversed>sample string 5</d2p1:Reversed>
      <d2p1:SettledDate>sample string 3</d2p1:SettledDate>
      <d2p1:Settlement>sample string 1</d2p1:Settlement>
    </d2p1:clsGRSettlement.SettlementListItem>
    <d2p1:clsGRSettlement.SettlementListItem>
      <d2p1:Commodity>sample string 4</d2p1:Commodity>
      <d2p1:LastModifiedUtc>2022-12-08T02:18:03.597263+00:00</d2p1:LastModifiedUtc>
      <d2p1:Location>sample string 2</d2p1:Location>
      <d2p1:Reversed>sample string 5</d2p1:Reversed>
      <d2p1:SettledDate>sample string 3</d2p1:SettledDate>
      <d2p1:Settlement>sample string 1</d2p1:Settlement>
    </d2p1:clsGRSettlement.SettlementListItem>
  </SettlementList>
  <Status>sample string 1</Status>
</AgvSettlementList>