Skip to Content
Admin APIClinicClaims

Admin Clinic Claims API

Administrative endpoints for managing claims within the clinic system.

Filter Claims

Filter and search claims with advanced criteria.

Endpoint: POST /v1/admin/clinic/claims/filter_claims
Authentication: Required (Admin role)

Request Body Parameters

ParameterTypeRequiredDescription
searchstringNoSearch term
sort_bystringNoField to sort by
sort_dirstringNoSort direction
filtersobjectNoFilter criteria with available parameters: date (object with start_date/end_date), status (string), appointment_type (string), insurance_plan_id (integer), appointment_id (integer), patient_name (string), provider_name (string)
page_sizeintegerNoNumber of items per page

Example Request

POST /v1/admin/clinic/claims/filter_claims HTTP/1.1
Content-Type: application/json
X-User-Token: your_admin_token_here
 
{
  "search": "therapy claim",
  "filters": {
    "date": {
      "start_date": "2023-10-01",
      "end_date": "2023-10-31"
    },
    "status": "submitted",
    "appointment_type": "individual_therapy",
    "insurance_plan_id": 123,
    "appointment_id": 789,
    "patient_name": "John Doe",
    "provider_name": "Dr. Smith"
  },
  "sort_by": "created_at",
  "sort_dir": "DESC",
  "page_size": 25
}

Response Format

{
  "claims": [
    {
      "id": 456,
      "appointment_id": 789,
      "patient_id": 1049,
      "provider_id": 123,
      "insurance_plan_id": 456,
      "status": "submitted",
      "amount": 150.00,
      "appointment_type": "individual_therapy",
      "created_at": "2023-10-15T10:00:00.000Z",
      "updated_at": "2023-10-15T14:30:00.000Z",
      "patient": {
        "id": 1049,
        "user": {
          "first_name": "John",
          "last_name": "Doe"
        }
      },
      "provider": {
        "id": 123,
        "first_name": "Dr. Jane",
        "last_name": "Smith"
      }
    }
  ],
  "total_amount": 1500.00,
  "pagination": {
    "current_page": 1,
    "total_pages": 6,
    "total_count": 150,
    "per_page": 25
  }
}

Error Responses

422 Unprocessable Entity

{
  "errors": "No claims were found."
}

Notes

  • All admin clinic endpoints require administrative privileges
  • Claims are filtered based on clinic-wide access permissions
  • The status filter accepts claim status values like “draft”, “submitted”, “approved”, “denied”
  • The appointment_type filter accepts values like “individual_therapy”, “group_therapy”, “assessment”
  • The appointment_id filter allows filtering by specific appointment
  • Date filters use ISO 8601 format (YYYY-MM-DD)
  • Response includes total_amount for financial reporting
AppointmentsAvailability