Skip to Content
DevelopersAPI referenceInvoices

List invoices

GET
/v1/invoices

Authorization

apiKey
headerAuthorizationBearer <token>

An API key (blk_…) from Settings → API keys.

Query Parameters

page?integer
Range1 <= value <= 100000
Default1
pageSize?integer
Range1 <= value <= 100
Default25
sort?string
Match^[A-Za-z]+:(asc|desc)$
status?string
Value in"draft""open""overdue""partially_paid""paid""void"
clientId?string
Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Formatuuid
q?string
Lengthlength <= 100

Response Body

application/json
  1. response
items*array<>
total*integer
Range-9007199254740991 <= value <= 9007199254740991
page*integer
Range-9007199254740991 <= value <= 9007199254740991
pageSize*integer
Range-9007199254740991 <= value <= 9007199254740991
Example Request
curl -X GET 'https://your-billleaf-api/v1/invoices'
Example Response200
{  "items": [    {      "id": "string",      "number": "string",      "status": "draft",      "paymentStatus": "unpaid",      "displayStatus": "draft",      "isOverdue": true,      "title": "string",      "clientId": "string",      "clientName": "string",      "quoteId": "string",      "currency": "string",      "issueDate": "2019-08-24",      "dueDate": "2019-08-24",      "subtotal": -9007199254740991,      "taxTotal": -9007199254740991,      "total": -9007199254740991,      "amountPaid": -9007199254740991,      "amountCredited": -9007199254740991,      "amountDue": -9007199254740991,      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    }  ],  "total": -9007199254740991,  "page": -9007199254740991,  "pageSize": -9007199254740991}