List invoices
Tool ID: kohlercode_crm_invoices_list
Summary
Lists formal invoices with their dates, service periods, payment status, amounts, and company information. Read-only.
When to use it
- Find an invoice — Browse invoice numbers and dates before opening one in detail.
- Check payment status — List only unpaid or paid invoices.
- Review history — Move through a longer invoice list with pagination.
What you need
| Requirement | Required? |
|---|---|
| Metraclick connection | Yes |
| Tool enabled for your account | Yes |
| KohlerCode CRM connected by your administrator | Yes |
Parameters
| Parameter | Required? | Description |
|---|---|---|
status |
No | Payment status: 0 for unpaid or 1 for paid |
limit |
No | Number of invoices to return, from 1 to 100; default is 50 |
offset |
No | Number of invoices to skip; default is 0 |
company_id |
No | Admin-only company filter; client connections always use their assigned company |
What you get back
| Field | Meaning |
|---|---|
count |
Number of invoices in this page |
invoices |
Invoice summaries, including number, dates, company, status, currency, and totals |
pagination |
Total results, page limit, offset, and whether more invoices remain |
Example prompts
List our unpaid invoices.
Show our 20 most recent paid invoices.
Are there more invoices after this page?
Tips
- Use the returned invoice
id, not its displayed invoice number, with Get invoice. - Invoice status
0means unpaid and1means paid. - Formal invoices are separate from KohlerCode CRM Work and Billing balances.
- Client connections can only see their assigned company. An admin connection may list every company or filter by one company.