ghl_invoice_list
List and filter invoices for a location or company, with pagination, date ranges, status, contact, and search parameters.
Instructions
List invoices API to get list of invoices Endpoint: GET /invoices/ (Version header: v3; source: v3/invoices-v3.json) Requires an Agency or Sub-Account token. OAuth scopes: invoices.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_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 | |
| contactId | No | Contact ID for the invoice | |
| sortField | No | The field on which sorting should be applied | |
| sortOrder | No | The order of sort which should be applied for the sortField | |
| paymentMode | No | payment mode |