Skip to Content
DevelopersAPI referenceExpenses

List expenses

GET
/v1/expenses

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)$
from?string
Match^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
Formatdate
to?string
Match^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
Formatdate
categoryId?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
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
projectId?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
billing?string
Value in"billable""unbilled""non_billable"
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
totals*array<>
Example Request
curl -X GET 'https://your-billleaf-api/v1/expenses'
Example Response200
{  "items": [    {      "id": "string",      "spentOn": "2019-08-24",      "vendor": "string",      "description": "string",      "categoryId": "string",      "categoryName": "string",      "amount": -9007199254740991,      "taxAmount": -9007199254740991,      "currency": "string",      "paymentMethod": "bank_transfer",      "reference": "string",      "clientId": "string",      "clientName": "string",      "projectId": "string",      "projectName": "string",      "billable": true,      "invoiceId": "string",      "invoiceNumber": "string",      "receipt": {        "filename": "string",        "contentType": "string",        "url": "string"      },      "createdAt": "2019-08-24T14:15:22Z"    }  ],  "total": -9007199254740991,  "page": -9007199254740991,  "pageSize": -9007199254740991,  "totals": [    {      "currency": "string",      "amount": -9007199254740991    }  ]}