POST 17.0/database/paymentruns

Description

Create Payment Runs

URI Parameters

None.

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:45",
  "paymentDate": "2025-01-09T20:45",
  "processingDate": "2025-01-09T20:45",
  "contactTypeID": 1,
  "bankAccountID": 1,
  "fileFormat": 1,
  "paymentCount": 1,
  "paymentTotal": 1.0,
  "siteID": 1,
  "userID": 1,
  "reportTypeID": 1
}

application/xml, text/xml

Sample:
<PaymentRunsUpdate xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ID>1</ID>
  <AddedDate>2025-01-09T20:45:47.484567+00:00</AddedDate>
  <PaymentDate>2025-01-09T20:45:47.484567+00:00</PaymentDate>
  <ProcessingDate>2025-01-09T20:45:47.484567+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>

application/x-www-form-urlencoded

Sample:

Sample not available.

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:45",
  "paymentDate": "2025-01-09T20:45",
  "processingDate": "2025-01-09T20:45",
  "contactTypeID": 5,
  "bankAccountID": 6,
  "fileFormat": 7,
  "paymentCount": 8,
  "paymentTotal": 9.0,
  "siteID": 10,
  "userID": 11,
  "reportTypeID": 12
}

application/xml, text/xml

Sample:
<PaymentRuns xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ID>1</ID>
  <AddedDate>2025-01-09T20:45:47.484567+00:00</AddedDate>
  <PaymentDate>2025-01-09T20:45:47.484567+00:00</PaymentDate>
  <ProcessingDate>2025-01-09T20:45:47.484567+00:00</ProcessingDate>
  <ContactTypeID>5</ContactTypeID>
  <BankAccountID>6</BankAccountID>
  <FileFormat>7</FileFormat>
  <PaymentCount>8</PaymentCount>
  <PaymentTotal>9</PaymentTotal>
  <SiteID>10</SiteID>
  <UserID>11</UserID>
  <ReportTypeID>12</ReportTypeID>
</PaymentRuns>