POST 17.0/database/paymentruns/list

Description

Retrieve a list of Payment Runs

URI Parameters

None.

ListOptions
Name Description Type Additional information
Fields

Collection of string

None.
Filters

Collection of DatabaseFilter

None.
Order

string

None.

application/json, text/json
Sample: 
{
  "fields": [
    "sample string 1",
    "sample string 2"
  ],
  "filters": [
    {
      "fieldName": "sample string 1",
      "value": "sample string 2",
      "operator": "sample string 3",
      "valueType": "sample string 4"
    },
    {
      "fieldName": "sample string 1",
      "value": "sample string 2",
      "operator": "sample string 3",
      "valueType": "sample string 4"
    }
  ],
  "order": "sample string 1"
}

application/xml, text/xml
Sample: 
<ListOptions xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Fields>
    <string>sample string 1</string>
    <string>sample string 2</string>
  </Fields>
  <Filters>
    <DatabaseFilter>
      <FieldName>sample string 1</FieldName>
      <Value>sample string 2</Value>
      <Operator>sample string 3</Operator>
      <ValueType>sample string 4</ValueType>
    </DatabaseFilter>
    <DatabaseFilter>
      <FieldName>sample string 1</FieldName>
      <Value>sample string 2</Value>
      <Operator>sample string 3</Operator>
      <ValueType>sample string 4</ValueType>
    </DatabaseFilter>
  </Filters>
  <Order>sample string 1</Order>
</ListOptions>

application/x-www-form-urlencoded
Sample:

Sample not available.

Collection of PaymentRunsUpdate
Name Description Type Additional information
ID

integer

None.
AddedDate

date

None.
PaymentDate

date

None.
ProcessingDate

date

None.
ContactTypeID

integer

None.
BankAccountID

integer

None.
FileFormat

integer

None.
PaymentCount

integer

None.
PaymentTotal

decimal number

None.
SiteID

integer

None.
UserID

integer

None.
ReportTypeID

integer

None.

application/json, text/json
Sample: 
[
  {
    "id": 1,
    "addedDate": "2025-01-09T20:21",
    "paymentDate": "2025-01-09T20:21",
    "processingDate": "2025-01-09T20:21",
    "contactTypeID": 1,
    "bankAccountID": 1,
    "fileFormat": 1,
    "paymentCount": 1,
    "paymentTotal": 1.0,
    "siteID": 1,
    "userID": 1,
    "reportTypeID": 1
  },
  {
    "id": 1,
    "addedDate": "2025-01-09T20:21",
    "paymentDate": "2025-01-09T20:21",
    "processingDate": "2025-01-09T20:21",
    "contactTypeID": 1,
    "bankAccountID": 1,
    "fileFormat": 1,
    "paymentCount": 1,
    "paymentTotal": 1.0,
    "siteID": 1,
    "userID": 1,
    "reportTypeID": 1
  }
]

application/xml, text/xml
Sample: 
<ArrayOfPaymentRunsUpdate xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <PaymentRunsUpdate>
    <ID>1</ID>
    <AddedDate>2025-01-09T20:21:11.1896589+00:00</AddedDate>
    <PaymentDate>2025-01-09T20:21:11.1896589+00:00</PaymentDate>
    <ProcessingDate>2025-01-09T20:21:11.1896589+00:00</ProcessingDate>
    <ContactTypeID>1</ContactTypeID>
    <BankAccountID>1</BankAccountID>
    <FileFormat>1</FileFormat>
    <PaymentCount>1</PaymentCount>
    <PaymentTotal>1</PaymentTotal>
    <SiteID>1</SiteID>
    <UserID>1</UserID>
    <ReportTypeID>1</ReportTypeID>
  </PaymentRunsUpdate>
  <PaymentRunsUpdate>
    <ID>1</ID>
    <AddedDate>2025-01-09T20:21:11.1896589+00:00</AddedDate>
    <PaymentDate>2025-01-09T20:21:11.1896589+00:00</PaymentDate>
    <ProcessingDate>2025-01-09T20:21:11.1896589+00:00</ProcessingDate>
    <ContactTypeID>1</ContactTypeID>
    <BankAccountID>1</BankAccountID>
    <FileFormat>1</FileFormat>
    <PaymentCount>1</PaymentCount>
    <PaymentTotal>1</PaymentTotal>
    <SiteID>1</SiteID>
    <UserID>1</UserID>
    <ReportTypeID>1</ReportTypeID>
  </PaymentRunsUpdate>
</ArrayOfPaymentRunsUpdate>