CAcaresquare
Mobile - Claims

Get Claims List

Get paginated list of claims/invoices with optional filtering.

get/api/v1/mobile/claims/{participant_id}

Request

  • Base URL
    https://api.caresquare.com.au (the document declares no server; this is the origin it was published from)
  • URL
    https://api.caresquare.com.au/api/v1/mobile/claims/{participant_id}
  • Auth
    none declared. Required headers: authorization

Path parameters

participant_idstring required

Participant ID

Query parameters

pageinteger

Page number

limitinteger

Items per page

statusstring nullable

Filter by status

date_fromstring nullable

Filter by start date (YYYY-MM-DD)

date_tostring nullable

Filter by end date (YYYY-MM-DD)

budget_type_idinteger nullable

Filter by budget type ID

category_idinteger nullable

Filter by category ID

searchstring nullable

Search by provider name or invoice number

needs_approvalboolean nullable

Filter to only invoices needing approval

plan_start_datestring date nullable

When filtering by category/type, only include line items with service_date_from >= this date (YYYY-MM-DD).

Headers

authorizationstring required

Bearer token

Response

Successful Response

filtersobject
pending_approval_countinteger

Changes

No recorded changes to this operation across all 19 revisions of this API.