GET All Invoices

Retrieves a paginated list of invoices with optional filtering.

Available Filters

Parameter	Description
limit	Number of results per page (max: 1000)
page	Page number for pagination
client_id	Filter by client ID
date_from	Filter invoices from this date (YYYY-MM-DD)
date_to	Filter invoices to this date (YYYY-MM-DD)
payment_status	Filter by payment status (0=Unpaid, 1=Partially Paid, 2=Paid, 3=Refunded, 4=OverPaid, -1=Draft)
store_id	Filter by store ID
draft	Filter by draft status (0 or 1)

Response

Returns a paginated list of invoices with client data and summary information such as payments and totals.

{
  "code": 200,
  "result": "successful",
  "data": [
    {
      "Invoice": {
        "id": 123,
        "client_id": 15,
        "store_id": 1,
        "no": "INV-001",
        "date": "2023-03-23",
        "summary_total": 120.00,
        "summary_paid": 0.00,
        "payment_status": 0
      },
      "Client": {
        "business_name": "ACME Corp",
        "email": "contact@acme.com"
      }
    }
  ],
  "pagination": {
    "page": 1,
    "page_count": 5,
    "total_results": 98,
    "prev": null,
    "next": "/api2/invoices/?page=2"
  }
}

curl --location -g --request GET '{{subdomain}}/api2/api2/invoices.json?limit=20&page=1&client_id={{client_id}}&date_from={{date_from}}&date_to={{date_to}}&payment_status={{payment_status}}&store_id={{store_id}}&draft={{draft}}' \ --header 'Authorization: Bearer {{token}}'

Request

Query Params

limit

string

required

Number of results per page (max: 1000)

Example:

page

string

required

Page number for pagination

Example:

client_id

string

required

Filter by client ID

Example:

date_from

string

required

Filter invoices from this date (YYYY-MM-DD)

Example:

date_to

string

required

Filter invoices to this date (YYYY-MM-DD)

Example:

payment_status

string

required

Filter by payment status (0=Unpaid, 1=Partially Paid, 2=Paid, 3=Refunded, 4=OverPaid, -1=Draft)

Example:

store_id

string

required

Filter by store ID

Example:

draft

string

required

Filter by draft status (0 or 1)

Example:

Header Params

Authorization

string

required

Example:

Bearer {{token}}

Available Filters#

Response#

Request

Responses

Available Filters

Response