POST 17.0/database/paymentlinks/list

Description

Retrieve a list of Payment Links

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

integer

None.
AddedDate

date

None.
DueDate

date

None.
ContactID

integer

None.
PropertyID

integer

None.
BankAccountID

integer

None.
Amount

decimal number

None.
Description

string

String length: inclusive between 0 and 255
UserID

integer

None.
SiteID

integer

None.
CreationProcess

byte

None.
ExternalID

string

String length: inclusive between 0 and 50
URL

string

String length: inclusive between 0 and 100
Status

byte

None.
StatusDate

date

None.
Notified

byte

None.

application/json, text/json
Sample: 
[
  {
    "id": 1,
    "addedDate": "2025-04-26T15:02",
    "dueDate": "2025-04-26T15:02",
    "contactID": 1,
    "propertyID": 1,
    "bankAccountID": 1,
    "amount": 1.0,
    "description": "sample string 1",
    "userID": 1,
    "siteID": 1,
    "creationProcess": 64,
    "externalID": "sample string 2",
    "url": "sample string 3",
    "status": 64,
    "statusDate": "2025-04-26T15:02",
    "notified": 64
  },
  {
    "id": 1,
    "addedDate": "2025-04-26T15:02",
    "dueDate": "2025-04-26T15:02",
    "contactID": 1,
    "propertyID": 1,
    "bankAccountID": 1,
    "amount": 1.0,
    "description": "sample string 1",
    "userID": 1,
    "siteID": 1,
    "creationProcess": 64,
    "externalID": "sample string 2",
    "url": "sample string 3",
    "status": 64,
    "statusDate": "2025-04-26T15:02",
    "notified": 64
  }
]

application/xml, text/xml
Sample: 
<ArrayOfPaymentLinksUpdate xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <PaymentLinksUpdate>
    <ID>1</ID>
    <AddedDate>2025-04-26T15:02:10.9289921+01:00</AddedDate>
    <DueDate>2025-04-26T15:02:10.9289921+01:00</DueDate>
    <ContactID>1</ContactID>
    <PropertyID>1</PropertyID>
    <BankAccountID>1</BankAccountID>
    <Amount>1</Amount>
    <Description>sample string 1</Description>
    <UserID>1</UserID>
    <SiteID>1</SiteID>
    <CreationProcess>64</CreationProcess>
    <ExternalID>sample string 2</ExternalID>
    <URL>sample string 3</URL>
    <Status>64</Status>
    <StatusDate>2025-04-26T15:02:10.9289921+01:00</StatusDate>
    <Notified>64</Notified>
  </PaymentLinksUpdate>
  <PaymentLinksUpdate>
    <ID>1</ID>
    <AddedDate>2025-04-26T15:02:10.9289921+01:00</AddedDate>
    <DueDate>2025-04-26T15:02:10.9289921+01:00</DueDate>
    <ContactID>1</ContactID>
    <PropertyID>1</PropertyID>
    <BankAccountID>1</BankAccountID>
    <Amount>1</Amount>
    <Description>sample string 1</Description>
    <UserID>1</UserID>
    <SiteID>1</SiteID>
    <CreationProcess>64</CreationProcess>
    <ExternalID>sample string 2</ExternalID>
    <URL>sample string 3</URL>
    <Status>64</Status>
    <StatusDate>2025-04-26T15:02:10.9289921+01:00</StatusDate>
    <Notified>64</Notified>
  </PaymentLinksUpdate>
</ArrayOfPaymentLinksUpdate>