# API: Get client invoices

# getClientInvoices

Get list of client's invoices.

TIP

This API call uses pagination for results.

# Required parameters

Parameter Description
id Client ID

# Optional parameters

Parameter Description
page Which page to return
filter[lastname] Filter by client last name
filter[firstname] Filter by client first name
filter[companyname] Filter by client company name
filter[id] Filter by invoice id
filterop[date] Filter by invoice date, possible values: =, <, >, !=
filter[date] Filter by invoice date, format: YYYY-MM-DD
filterop[duedate] Filter by invoice due date, possible values: =, <, >, !=
filter[duedate] Filter by invoice due date, format: YYYY-MM-DD
filter[payment_module] Filter by payment module
filter[status] Filter by invoice status
filter[recurring_id] Filter by recurring id
filter[currency_id] Filter by currency id
filter[country] Filter by client country
filter[group_id] Filter by client group id
filter[paid_id] Filter by invoice paid id

# Request

GET /admin/api.php?api_id=API_ID&api_key=API_KEY&call=getClientInvoices&id=ID

# PHP Samples

# Response

{
    "success": true,
    "invoices": [
        {
            "id": "62",
            "currency_id": "0",
            "date": "2011-12-09",
            "duedate": "2011-12-09",
            "subtotal2": "178.00",
            "credit": "0.00",
            "total": "178.00",
            "paid_id": "",
            "status": "Paid",
            "firstname": "Jack",
            "client_id": "8",
            "lastname": "Black",
            "module": "AlertPay",
            "recid": "0"
        },
        {
            "id": "61",
            "currency_id": "0",
            "date": "2011-12-07",
            "duedate": "2011-12-07",
            "subtotal2": "295.00",
            "credit": "0.00",
            "total": "295.00",
            "paid_id": "",
            "status": "Unpaid",
            "firstname": "Jack",
            "client_id": "8",
            "lastname": "Black",
            "module": "AlertPay",
            "recid": "0"
        }
    ],
    "call": "getClientInvoices",
    "server_time": 1323444575
}
Last Updated: 1/2/2024, 3:19:45 PM