Skip to main content
GET
List Scheduled Payments

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

teamIds
string[]
Example:
fromDate
string
required

Start date in YYYY-MM-DD format

Example:

"2023-01-01"

toDate
string
required

End date in YYYY-MM-DD format

Example:

"2023-01-31"

contractorIds
string[]
Example:
scheduledPaymentStatuses
enum<string>[]
Available options:
upcoming,
processing,
failed,
paid,
deleted
Example:
sortOrder
enum<string>
default:desc
Available options:
asc,
desc
sortField
enum<string>
default:scheduledPaymentOn
Available options:
scheduledPaymentOn,
date,
budget,
paidAmount,
scheduledPaymentStatus,
contract,
contractor
page
number
default:1
Required range: x >= 1
itemsPerPage
number
default:10
Required range: 1 <= x <= 100

Response

200 - application/json

Scheduled payments list response.

results
object[]
required
pagination
object
required
statistics
object
required