Developers
API referenceReferenceExpense claims

List expense claims

Expense claims the caller can see, newest first. `filter_counts` holds the claim count for every `list_filter` value.

GET
/v1/business/{business_slug}/expense_claims/

Path Parameters

business_slug*string

Business slug that scopes this request. If you do not have one yet, call common_accessible_businesses_list and pick a slug from the response.

Query Parameters

group?string

Narrow the list to drafts, claims in progress or processed claims.

  • drafts - drafts
  • in_progress - in_progress
  • processed - processed

Value in

  • "drafts"
  • "in_progress"
  • "processed"
list_filter?string

Status pill. AWAITING_APPROVAL is the caller's own claims, awaiting_you is every claim an approver can act on.

  • all - all
  • awaiting_you - awaiting_you
  • DRAFT - DRAFT
  • AWAITING_APPROVAL - AWAITING_APPROVAL
  • APPROVED - APPROVED
  • PAID - PAID

Value in

  • "APPROVED"
  • "AWAITING_APPROVAL"
  • "DRAFT"
  • "PAID"
  • "all"
  • "awaiting_you"
mine_only?boolean

Only the caller's own claims.

page?integer

A page number within the paginated result set.

page_size?integer

Number of results to return per page.

scope?string

mine (default) lists the caller's own claims. approvals lists submitted claims for an approver. combined lists both.

  • mine - mine
  • approvals - approvals
  • combined - combined

Value in

  • "approvals"
  • "combined"
  • "mine"

Response Body

application/json

curl -X GET "https://example.com/v1/business/string/expense_claims/"
{  "count": 123,  "next": 2,  "prev": 1,  "size": 30,  "results": [    {      "id": 0,      "number": "string",      "name": "string",      "status": "DRAFT",      "total_amount": 0.1,      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z",      "submitted_at": "2019-08-24T14:15:22Z",      "approved_at": "2019-08-24T14:15:22Z",      "paid_on": "2019-08-24",      "submitted_by_name": "string",      "claimant": {        "id": 0,        "first_name": "string",        "last_name": "string"      },      "list_title": "string",      "list_title_month": 0,      "list_summary": {        "trip_count": 0,        "expense_count": 0,        "leg_count": 0,        "has_partial_per_diem": true,        "has_per_diem": true      }    }  ],  "filter_counts": {    "property1": 0,    "property2": 0  }}