List Invoices

GET https://app.alaaqat.com/api/invoices

Lists your invoices, newest first. Your API key needs the invoice-index ability.

The list holds the invoices the team member who created the key can see in the app: all of them with View Invoices, or only the ones they or their teams own with Invoice Team's Invoices or View User's Invoices.

Header

{
    "Accept": "application/json"
}

Query parameters

This endpoint accepts the Pagination parameters, with up to 250 invoices a page, and supports Complex Filtration.

Key Type Default Description
search string - Search by invoice number or title.
complex_filters array [] Filter by property values. See Complex Filtration.
forAssociationType string - With forAssociationId, lists only the invoices linked to one record. See Associations.
forAssociationId string - The _id of the record whose linked invoices you want.

Response

200 OK, or 206 Partial Content when more pages follow. The invoices are under data, each with its property values under properties, and its line items under items. See Pagination for links and meta.

{
    "data": [
        {
            "properties": {
                "_id": "6657c1d2e3f4a5b6c7d8e901",
                "title": "Office chairs, October order",
                "status": "open",
                "currency": "JOD",
                "discount_rate": 5,
                "tax_rate": 16,
                "invoice_number": "INV-1001",
                "amount": 523.45,
                "created_by": 12,
                "updated_at": "2026-10-20T09:30:00.000000Z",
                "created_at": "2026-10-20T09:30:00.000000Z"
            },
            "account_id": 1024,
            "items": [
                {
                    "net_price": 440,
                    "name": "Ergonomic office chair",
                    "unit_price": 120,
                    "quantity": 4,
                    "description": "Black mesh back",
                    "unit_discount": 10,
                    "tax_rate": 0
                },
                {
                    "net_price": 35,
                    "name": "Delivery and assembly",
                    "unit_price": 35,
                    "quantity": 1,
                    "description": null,
                    "unit_discount": 0,
                    "tax_rate": 0
                }
            ]
        },
        {
            "properties": {
                "_id": "6657c1d2e3f4a5b6c7d8e902",
                "title": "Meeting room setup",
                "status": "paid",
                "currency": "JOD",
                "discount_rate": 5,
                "tax_rate": 16,
                "invoice_number": "INV-1000",
                "amount": 1180,
                "created_by": 12,
                "updated_at": "2026-10-18T11:00:00.000000Z",
                "created_at": "2026-10-18T11:00:00.000000Z"
            },
            "account_id": 1024,
            "items": [
                {
                    "net_price": 1180,
                    "name": "Meeting room setup",
                    "unit_price": 1180,
                    "quantity": 1,
                    "description": null,
                    "unit_discount": 0,
                    "tax_rate": 0
                }
            ]
        }
    ],
    "links": {
        "first": "https://app.alaaqat.com/api/invoices?page=1",
        "last": "https://app.alaaqat.com/api/invoices?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "active": false
            },
            {
                "url": "https://app.alaaqat.com/api/invoices?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next »",
                "active": false
            }
        ],
        "path": "https://app.alaaqat.com/api/invoices",
        "per_page": 15,
        "to": 2,
        "total": 2
    }
}