ghl_invoice_schedule_list
Retrieve invoice schedules for a location, with pagination and filters for status, date range, search, and payment mode. Use limit and offset to page through results.
Instructions
List schedules API to get list of schedules Endpoint: GET /invoices/schedule (Version header: v3; source: v3/invoices-v3.json) Requires an Agency or Sub-Account token. OAuth scopes: invoices/schedule.readonly Pagination params: limit, offset — pass them to page through full result sets.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"altId": "<altId>",
"altType": "<altType>",
"limit": "<limit>",
"offset": "<offset>"
},
"name": "ghl_invoice_schedule_list"
}
}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 |