Search Payment Schedules

Retrieve a list of payment schedules with optional filtering.

This endpoint provides comprehensive search capabilities for payment schedules including:

  • Status Filtering: Filter by payment schedule status (PENDING_APPROVAL, APPROVED, PENDING, etc.)
  • Business Unit Filtering: Search schedules for specific business units
  • Booking Filtering: Search schedules for specific bookings or booking references
  • Date Range Filtering: Filter schedules by execution date ranges
  • Sorting: Sort results by creation date, update date, or execution date
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
status
array of strings

Filter by payment schedule status

status
string

Filter by business unit identifier

string

Filter by booking identifier

string

Filter by booking reference (customer-facing booking reference from the booking object)

date-time

Filter schedules executing from this datetime (ISO 8601)

date-time

Filter schedules executing until this datetime (ISO 8601)

string
enum
Defaults to created_at

Sort payment schedules by field and direction (eg. created_at:desc, execute_after:asc)

Allowed:
integer
1 to 100
Defaults to 20

Maximum number of results to return

integer
≥ 0
Defaults to 0

Number of records to skip before starting to return the results

Responses

Language
Credentials
Bearer
UUID
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json