GET
/
api
/
v1
/
invoice
/
Invoice List Api
curl --request GET \
  --url https://api.justpaid.io/api/v1/invoice/ \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "uuid": "123e4567-e89b-12d3-a456-426614174000",
      "invoice_status": "draft",
      "amount": 1000,
      "currency": "USD",
      "invoice_number": "INV-2024-001",
      "invoice_date": "2024-03-21",
      "line_items": [
        {
          "name": "Product A",
          "unit_price": 100,
          "quantity": 2,
          "amount": 200,
          "currency": "USD"
        }
      ],
      "customer": {
        "uuid": "456e4567-e89b-12d3-a456-426614174000",
        "name": "Customer Name"
      }
    }
  ],
  "count": 1
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

invoice_status
string

Filter by invoice status (e.g., 'draft', 'sent', 'paid')

customer
string

Filter by customer UUID

invoice_date_gte
string<date>

Filter invoices with invoice date greater than or equal to this date

invoice_date_lte
string<date>

Filter invoices with invoice date less than or equal to this date

due_date_gte
string<date>

Filter invoices with due date greater than or equal to this date

due_date_lte
string<date>

Filter invoices with due date less than or equal to this date

amount_gte
number

Filter invoices with amount greater than or equal to this value

amount_lte
number

Filter invoices with amount less than or equal to this value

limit
integer

Number of results to return per page

offset
integer

Number of results to skip

Response

200 - application/json

List of invoices retrieved successfully

The response is of type object.