ghl_invoice_schedule_list
Retrieve a list of invoice schedules filtered by status, date range, payment mode, or search term, with pagination support.
Instructions
List schedules API to get list of schedules Endpoint: GET /invoices/schedule (Version header: v3; source: v3/invoices-v3.json) OAuth scopes: invoices/schedule.readonly Pagination params: limit, offset — pass them to page through full result sets.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| altId | Yes | location Id / company Id based on altType | |
| endAt | No | endAt in YYYY-MM-DD format | |
| limit | Yes | Limit the number of items to return | |
| offset | Yes | Number of items to skip | |
| search | No | To search for an invoice by id / name / email / phoneNo | |
| status | No | status to be filtered | |
| altType | Yes | Alt Type | |
| startAt | No | startAt in YYYY-MM-DD format | |
| paymentMode | No | payment mode |