Skip to main content
ScheduleVersion: v3

List schedules

GET/invoices/schedule

API to get list of schedules

Authorizations

Authorizationstringheaderrequired

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

Scope:invoices/schedule.readonly
Auth methods:OAuthPrivate Integration
Token types:Sub-Account TokenAgency Token

Request​

Headers

Versionstringrequired

API Version

Available optionsv3

Query Parameters

altIdstringrequired

location Id / company Id based on altType

Example:6578278e879ad2646715ba9c
altTypestringrequired

Alt Type

Available optionslocation
Example:location
statusstring

status to be filtered

startAtstring

startAt in YYYY-MM-DD format

Example:2023-01-01
endAtstring

endAt in YYYY-MM-DD format

Example:2023-01-01
searchstring

To search for an invoice by id / name / email / phoneNo

Example:Alex
paymentModestring

payment mode

Available optionsdefaultlivetest
Example:live
limitstringrequired

Limit the number of items to return

Example:10
offsetstringrequired

Number of items to skip

Example:10

Response

application/json

Successful response

schedulesobject[]required
totalnumberrequired

Total number of Schedules

Example:100