POST 17.0/database/paymentcollections/list

Description

Retrieve a list of Payment Collections

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 PaymentCollectionsUpdate
Name Description Type Additional information
ID

integer

None.
AddedDate

date

None.
DueDate

date

None.
UserID

integer

None.
CompanyID

integer

None.
Amount

decimal number

None.

application/json, text/json
Sample: 
[
  {
    "id": 1,
    "addedDate": "2025-01-09T20:39",
    "dueDate": "2025-01-09T20:39",
    "userID": 1,
    "companyID": 1,
    "amount": 1.0
  },
  {
    "id": 1,
    "addedDate": "2025-01-09T20:39",
    "dueDate": "2025-01-09T20:39",
    "userID": 1,
    "companyID": 1,
    "amount": 1.0
  }
]

application/xml, text/xml
Sample: 
<ArrayOfPaymentCollectionsUpdate xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <PaymentCollectionsUpdate>
    <ID>1</ID>
    <AddedDate>2025-01-09T20:39:47.2249625+00:00</AddedDate>
    <DueDate>2025-01-09T20:39:47.2249625+00:00</DueDate>
    <UserID>1</UserID>
    <CompanyID>1</CompanyID>
    <Amount>1</Amount>
  </PaymentCollectionsUpdate>
  <PaymentCollectionsUpdate>
    <ID>1</ID>
    <AddedDate>2025-01-09T20:39:47.2249625+00:00</AddedDate>
    <DueDate>2025-01-09T20:39:47.2249625+00:00</DueDate>
    <UserID>1</UserID>
    <CompanyID>1</CompanyID>
    <Amount>1</Amount>
  </PaymentCollectionsUpdate>
</ArrayOfPaymentCollectionsUpdate>