List invoices

{
  "data": [
    {
      "id": "string",
      "invoice_number": "string",
      "invoice_date": "2023-01-15",
      "total": 1.1,
      "tax": 1.1,
      "subtotal": 1.1,
      "plan_manager": "string",
      "participant_id": "string",
      "claim_status": "string",
      "approval_status": "string",
      "created_at": "2024-01-15T09:30:00Z",
      "pm_provider_id": "string",
      "s3_key": "string",
      "email_message_id": "string",
      "errors": true,
      "state_management": {},
      "is_deleted": true,
      "wont_claim": true,
      "is_reimbursement": true,
      "is_duplicate": true
    }
  ],
  "pagination": {
    "limit": 1,
    "offset": 1,
    "has_more": true,
    "total": 1,
    "next_cursor": "string"
  }
}

Paginated list of invoices for the plan manager. Optional filters: participant_id, provider_id, claim_status, approval_status, invoice_number. Paginate with limit/offset, or pass after for a stable id-ascending cursor (start with after=0, then pagination.next_cursor). Requires X-Plan-Manager-Id header.

Authentication

AuthorizationBearer

API key issued for your account. Send as Bearer token in the Authorization header.

X-Plan-Manager-Idstring

Plan manager UUID. Required on all public API requests to scope data access.

Query parameters

participant_idstringOptionalformat: "uuid"

Filter by participant UUID

provider_idstringOptionalformat: "uuid"

Filter by provider UUID (pm_provider_id)

claim_statusstringOptional

Filter by claim status

approval_statusstringOptional

Filter by approval status

invoice_numberstringOptional

Filter by exact invoice number

limitintegerOptional1-1000Defaults to 20

Items per page (max 1000)

offsetintegerOptional>=0Defaults to 0

Number of items to skip. Cannot be combined with after.

afterstringOptional

Keyset cursor. Returns records after this id (or error_code for the error catalogue), ordered by that field ascending. Pass pagination.next_cursor from the previous page. Start a cursor walk with after=0. Cannot be combined with a non-zero offset.

Response

List of invoices

datalist of objects

paginationobject

Errors

400

Bad Request Error

403

Forbidden Error

500

Internal Server Error