@rinse-dental/open-dental 3.4.2 → 4.0.2

package/docs/Open Dental 2026-04-22/apiclaims.md

@@ -0,0 +1,339 @@
+# API: Claims
+
+**Source:** https://www.opendental.com/site/apiclaims.html
+**DB Schema Ref:** claim
+**Extracted:** 2026-04-22
+**Base Path:** `/claims`
+
+---
+
+## Overview
+The Claims API manages dental insurance claims within Open Dental. Each claim row represents a single insurance claim tied to one plan and patient. Claims link to ClaimProcs for procedure-level detail and to ClaimPayments for received insurance checks.
+
+---
+
+## Endpoints
+
+### GET /claims/{ClaimNum}
+
+**Version:** 23.3.11
+**Description:** Retrieves a single claim by its primary key.
+
+**Path Parameters:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| ClaimNum | integer | Yes | Claim identifier |
+
+**Response:** object
+| Field | Type | Description |
+|-------|------|-------------|
+| ClaimNum | integer | Primary key |
+| PatNum | integer | FK to patient.PatNum |
+| DateService | string | yyyy-MM-dd; usually matches procedure dates |
+| DateSent | string | yyyy-MM-dd; date claim was sent |
+| ClaimStatus | string | Single char: U, H, W, S, R, or I |
+| DateReceived | string | yyyy-MM-dd; date claim was received |
+| PlanNum | integer | FK to insplan.PlanNum |
+| ProvTreat | integer | FK to provider.ProvNum (treating/attending provider) |
+| ClaimFee | decimal | Total fee of the claim |
+| InsPayEst | decimal | Estimated insurance payment |
+| InsPayAmt | decimal | Actual insurance payment |
+| DedApplied | decimal | Deductible applied to the claim |
+| IsProsthesis | string | N = No, I = Initial, R = Replacement |
+| PriorDate | string | yyyy-MM-dd; date prior prosthesis placed (paper claims only) |
+| ReasonUnderPaid | string | Note for patient explaining under-payment |
+| ClaimNote | string | Note sent to insurance; max 400 characters |
+| ClaimType | string | P, S, PreAuth, Cap, or Other |
+| ProvBill | integer | FK to provider.ProvNum (billing provider) |
+| PlaceService | string | Place of service code |
+| AccidentRelated | string | blank, A (Auto), E (Employment), or O (Other) |
+| AccidentDate | string | yyyy-MM-dd; accident date (Canada only) |
+| AccidentST | string | Accident state (2 characters) |
+| IsOrtho | boolean | True if orthodontic claim |
+| OrthoRemainM | integer | Remaining ortho months (1-36) |
+| OrthoDate | string | yyyy-MM-dd; date ortho appliance placed |
+| PatRelat | string | Patient relationship to subscriber |
+| PlanNum2 | integer | FK to insplan.PlanNum (other coverage); 0 if none |
+| PatRelat2 | string | Patient relationship to other coverage subscriber |
+| WriteOff | decimal | Sum of ClaimProc.WriteOff for this claim |
+| ClaimForm | string | FK to claimform.ClaimFormNum |
+| InsSubNum | integer | FK to inssub.InsSubNum |
+| InsSubNum2 | integer | FK to inssub.InsSubNum (other coverage subscriber) |
+| PriorAuthorizationNumber | string | Predetermination of benefits number (X12 REF G3) |
+| MedType | string | Dental, Medical, or Institutional |
+| CustomTracking | integer | Custom tracking number |
+| customTracking | string | Custom tracking name |
+| CorrectionType | string | Correction type |
+| ClaimIdentifier | string | X12 CLM01 identifier |
+| OrigRefNum | string | Original reference number |
+| OrthoTotalM | integer | Total ortho months (1-36) |
+| ShareOfCost | decimal | Share of cost amount |
+| SecDateTEdit | string | yyyy-MM-dd HH:mm:ss; last modified timestamp |
+
+**Status Codes:**
+| Code | Meaning |
+|------|---------|
+| 200 | OK |
+| 404 | Not Found |
+
+---
+
+### GET /claims
+
+**Version:** 22.2
+**Description:** Retrieves multiple claims with optional filtering.
+
+**Query Parameters:**
+| Name | Type | Required | Default | Description |
+|------|------|----------|---------|-------------|
+| PatNum | integer | No | — | Optional after v23.3.11; FK to patient.PatNum |
+| ClaimStatus | string | No | — | Added v23.3.11; single char (U, H, W, S, R, I) |
+| ClaimType | string | No | — | Added v25.3.41; P, S, PreAuth, Cap, or Other |
+| PlanNum | integer | No | — | Added v25.3.41; FK to insplan.PlanNum |
+| PlanNum2 | integer | No | — | Added v25.3.41; FK to insplan.PlanNum (other coverage) |
+| ClaimIdentifier | string | No | — | Added v25.3.41; X12 CLM01 identifier |
+| SecDateTEdit | string | No | — | Added v23.3.11; yyyy-MM-dd HH:mm:ss; returns claims on or after this date |
+
+**Response:** array of claim objects (same fields as single GET)
+
+**Status Codes:**
+| Code | Meaning |
+|------|---------|
+| 200 | OK |
+| 400 | Bad Request |
+| 404 | Not Found |
+
+---
+
+### POST /claims
+
+**Version:** 23.2.5
+**Description:** Creates a new insurance claim.
+
+**Body Parameters:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| PatNum | integer | Yes | FK to patient.PatNum |
+| procNums | array of integers | Yes | Procedure numbers to attach to the claim |
+| ClaimType | string | Yes | P, S, PreAuth, or Other |
+| InsSubNum | integer | Conditional | Required for PreAuth and Other types; FK to inssub.InsSubNum |
+| InsSubNum2 | integer | No | FK to inssub.InsSubNum (other coverage) |
+| PatRelat | string | Conditional | Required for PreAuth and Other; patient relationship to subscriber |
+| PatRelat2 | string | No | Relationship to other coverage subscriber |
+| DateService | string | No | yyyy-MM-dd; defaults to earliest procedure date |
+| DateSent | string | No | yyyy-MM-dd; defaults to today |
+| ClaimForm | integer | No | FK to claimform.ClaimFormNum |
+| ProvTreat | integer | No | FK to provider.ProvNum |
+| ProvBill | integer | No | FK to provider.ProvNum |
+
+**Response:** created claim object with all fields and generated ClaimNum
+
+**Status Codes:**
+| Code | Meaning |
+|------|---------|
+| 201 | Created |
+| 400 | Bad Request |
+| 404 | Not Found |
+
+---
+
+### PUT /claims/{ClaimNum}
+
+**Version:** 21.4
+**Description:** Updates an existing claim. All body fields are optional.
+
+**Path Parameters:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| ClaimNum | integer | Yes | Claim identifier |
+
+**Body Parameters:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| ClaimStatus | string | No | U, H, W, S, or R |
+| DateSent | string | No | Added v25.3.41; yyyy-MM-dd |
+| DateReceived | string | No | yyyy-MM-dd |
+| ProvTreat | integer | No | FK to provider.ProvNum |
+| IsProsthesis | string | No | N, I, or R |
+| PriorDate | string | No | yyyy-MM-dd; paper claims only |
+| ClaimNote | string | No | Note to insurance (max 400 chars) |
+| ReasonUnderPaid | string | No | Added v22.3.31 |
+| ProvBill | integer | No | FK to provider.ProvNum |
+| PlaceService | string | No | Place of service code |
+| AccidentRelated | string | No | No, A, E, or O |
+| AccidentDate | string | No | Added v22.1; yyyy-MM-dd |
+| AccidentST | string | No | 2 characters |
+| IsOrtho | string | No | "true" or "false" |
+| OrthoRemainM | integer | No | Added v23.2.18; 1-36 |
+| OrthoDate | string | No | yyyy-MM-dd |
+| PatRelat | string | No | Added v24.4.35; patient relationship to subscriber |
+| PatRelat2 | string | No | Added v24.4.35; relationship to other coverage subscriber |
+| ClaimForm | integer | No | FK to claimform.ClaimFormNum |
+| InsSubNum2 | integer | No | Added v24.4.35; FK to inssub.InsSubNum |
+| PriorAuthorizationNumber | string | No | Predetermination number |
+| MedType | string | No | Added v25.3.41; Dental, Medical, or Institutional |
+| OrthoTotalM | integer | No | 1-36 |
+
+**Response:** updated claim object
+
+**Status Codes:**
+| Code | Meaning |
+|------|---------|
+| 200 | OK |
+| 400 | Bad Request |
+| 404 | Not Found |
+
+---
+
+### PUT /claims/{ClaimNum}/Status
+
+**Version:** 21.3
+**Description:** Sets claim status to "Sent" and automatically creates an Etrans entry.
+
+**Path Parameters:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| ClaimNum | integer | Yes | Claim identifier |
+
+**Body Parameters:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| DateSent | string | Yes | yyyy-MM-dd; date claim was sent |
+| DateSentOrig | string | No | yyyy-MM-dd; defaults to DateSent; ignored if claim was previously marked Sent |
+
+**Response:** updated claim object
+
+**Status Codes:**
+| Code | Meaning |
+|------|---------|
+| 200 | OK |
+| 400 | Bad Request |
+| 404 | Not Found |
+
+---
+
+### PUT /claims/{ClaimNum}/Split
+
+**Version:** 22.1
+**Description:** Splits an existing claim by moving specified procedures to a newly created claim.
+
+**Path Parameters:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| ClaimNum | integer | Yes | Source claim identifier |
+
+**Body Parameters:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| ProcNums | array of integers | Yes | Procedure numbers to move to the new claim |
+
+**Response:** object
+| Field | Type | Description |
+|-------|------|-------------|
+| ClaimNum | integer | Newly created claim number |
+| ProcNums | array | Procedure numbers moved to the new claim |
+
+**Status Codes:**
+| Code | Meaning |
+|------|---------|
+| 201 | Created |
+| 400 | Bad Request |
+| 404 | Not Found |
+
+---
+
+### DELETE /claims/{ClaimNum}
+
+**Version:** 22.1
+**Description:** Deletes a claim. If claim is attached to ERA(s), they are automatically unassociated before deletion.
+
+**Path Parameters:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| ClaimNum | integer | Yes | Claim identifier |
+
+**Status Codes:**
+| Code | Meaning |
+|------|---------|
+| 200 | OK |
+| 400 | Bad Request (insurance payment attached or status is Received) |
+| 404 | Not Found |
+
+---
+
+## Field Reference
+
+### ClaimStatus
+| Value | DB Char | Description |
+|-------|---------|-------------|
+| U | U | Unsent |
+| H | H | Hold until primary received |
+| W | W | Waiting in queue |
+| S | S | Sent |
+| R | R | Received |
+| I | I | Hold for In Process |
+
+### ClaimType
+| Value | Description |
+|-------|-------------|
+| P | Primary |
+| S | Secondary |
+| PreAuth | Preauthorization |
+| Cap | Capitation |
+| Other | Other claims |
+
+### PatRelat / PatRelat2 (enum: Relat)
+| Value | DB Int | Description |
+|-------|--------|-------------|
+| Self | 0 | Self |
+| Spouse | 1 | Spouse |
+| Child | 2 | Child |
+| Employee | 3 | Employee |
+| HandicapDep | 4 | Handicapped Dependent |
+| SignifOther | 5 | Significant Other |
+| InjuredPlaintiff | 6 | Injured Plaintiff |
+| LifePartner | 7 | Life Partner |
+| Dependent | 8 | Dependent |
+
+### IsProsthesis
+| Value | Description |
+|-------|-------------|
+| N | No prosthesis |
+| I | Initial placement |
+| R | Replacement |
+
+### AccidentRelated
+| Value | Description |
+|-------|-------------|
+| (blank) | Not accident related |
+| A | Auto accident |
+| E | Employment related |
+| O | Other |
+
+### MedType
+| Value | Description |
+|-------|-------------|
+| Dental | Dental claim |
+| Medical | Medical claim |
+| Institutional | Institutional claim |
+
+---
+
+## Implementation Notes
+- Cannot DELETE claims with insurance payments/checks attached or with ClaimStatus = "Received".
+- For ClaimType "PreAuth" or "Other", `InsSubNum` and `PatRelat` are required on POST.
+- Medical claims require an insurance plan with `IsMedical=true`; `MedType` defaults based on the "ClaimMedTypeIsInstWhenInsPlanIsMedical" preference.
+- `OrthoRemainM` and `OrthoTotalM` only accept integers 1-36.
+- `ClaimNote` max length is 400 characters.
+- `DateSentOrig` on the Status endpoint is ignored if the claim was previously marked Sent.
+- Use Claims GET and ClaimProcs GET before splitting claims to verify state.
+
+---
+
+## Related Resources
+| Resource | Purpose |
+|----------|---------|
+| ClaimProcs | Procedure-level claim details and insurance estimates |
+| ClaimPayments | Insurance checks received for claims |
+| ClaimTrackings | Status history and tracking for claims |
+| InsSub | Insurance subscriber referenced by InsSubNum / InsSubNum2 |

package/docs/Open Dental 2026-04-22/apiclaimtrackings.md

@@ -0,0 +1,110 @@
+# API: ClaimTrackings
+
+**Source:** https://www.opendental.com/site/apiclaimtrackings.html
+**Extracted:** 2026-04-22
+**Base Path:** `/claimtrackings`
+
+---
+
+## Overview
+ClaimTrackings record the status history and tracking events for insurance claims. Each record associates a claim with a tracking definition, an optional error definition, a user, a timestamp, and an optional note. Requires one-time setup by the dental office before use.
+
+---
+
+## Endpoints
+
+### GET /claimtrackings
+
+**Version:** 23.2.5
+**Description:** Retrieves a list of ClaimTracking records, optionally filtered by claim.
+
+**Query Parameters:**
+| Name | Type | Required | Default | Description |
+|------|------|----------|---------|-------------|
+| ClaimNum | integer | No | — | FK to claim.ClaimNum; filters to a specific claim |
+
+**Response:** array of objects
+| Field | Type | Description |
+|-------|------|-------------|
+| ClaimTrackingNum | integer | Primary key |
+| ClaimNum | integer | FK to claim.ClaimNum |
+| TrackingType | string | Type of tracking (e.g., "StatusHistory") |
+| UserNum | integer | FK to userod; associated user |
+| DateTimeEntry | string | Timestamp of entry |
+| Note | string | Optional note |
+| TrackingDefNum | integer | FK to definition.DefNum (Category=31) |
+| TrackingErrorDefNum | integer | FK to definition.DefNum (Category=43) |
+
+**Status Codes:**
+| Code | Meaning |
+|------|---------|
+| 200 | OK |
+| 404 | Claim not found |
+
+---
+
+### POST /claimtrackings
+
+**Version:** 23.2.5
+**Description:** Creates a new ClaimTracking record. Requires one-time setup by the dental office.
+
+**Body Parameters:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| ClaimNum | integer | Yes | FK to claim.ClaimNum |
+| Note | string | No | Default: empty string |
+| TrackingDefNum | integer | Conditional | Definition.DefNum (Category=31); required if office preference `ClaimTrackingStatusExcludesNone` is enabled; otherwise optional (defaults to 0) |
+| TrackingErrorDefNum | integer | No | Definition.DefNum (Category=43); defaults to 0 |
+
+**Response:** created ClaimTracking object (same fields as GET)
+
+**Status Codes:**
+| Code | Meaning |
+|------|---------|
+| 201 | Created |
+| 400 | Bad Request (with explanation) |
+| 404 | Not Found (with explanation) |
+
+---
+
+### PUT /claimtrackings/{ClaimTrackingNum}
+
+**Version:** 23.2.5
+**Description:** Updates an existing ClaimTracking record.
+
+**Path Parameters:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| ClaimTrackingNum | integer | Yes | Primary key |
+
+**Body Parameters:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| Note | string | No | Overwrites existing note |
+| TrackingDefNum | integer | No | Definition.DefNum (Category=31); cannot be 0 if `ClaimTrackingStatusExcludesNone` preference is enabled |
+| TrackingErrorDefNum | integer | No | Definition.DefNum (Category=43) |
+
+**Response:** updated ClaimTracking object (same fields as GET)
+
+**Status Codes:**
+| Code | Meaning |
+|------|---------|
+| 200 | OK |
+| 400 | Bad Request (with explanation) |
+| 404 | Not Found (with explanation) |
+
+---
+
+## Implementation Notes
+- Requires one-time dental office setup before the POST endpoint can be used.
+- `TrackingDefNum` references Definition Category=31 (claim tracking statuses).
+- `TrackingErrorDefNum` references Definition Category=43 (claim tracking error types).
+- When the office preference `ClaimTrackingStatusExcludesNone` is enabled, `TrackingDefNum` is required on POST and cannot be 0 on PUT.
+
+---
+
+## Related Resources
+| Resource | Purpose |
+|----------|---------|
+| Claims | Parent claim record referenced by ClaimNum |
+| Definitions | Source for TrackingDefNum (Cat=31) and TrackingErrorDefNum (Cat=43) |

package/docs/Open Dental 2026-04-22/apiclinics.md

@@ -0,0 +1,95 @@
+# API: Clinics
+
+**Source:** https://www.opendental.com/site/apiclinics.html
+**Extracted:** 2026-04-22
+**Base Path:** `/clinics`
+
+---
+
+## Overview
+The Clinics API provides access to clinic location and billing information within Open Dental. An empty list from the GET endpoint indicates the dental office does not use the Clinics feature. Only non-hidden clinics are returned by GET.
+
+---
+
+## Endpoints
+
+### GET /clinics
+
+**Version:** 21.1
+**Description:** Gets all non-hidden clinics. Returns an empty list if the dental office does not utilize the Clinics feature.
+
+**Response:** array of objects
+| Field | Type | Description |
+|-------|------|-------------|
+| ClinicNum | integer | Clinic identifier (primary key) |
+| Description | string | Clinic name; appears on statements and letters |
+| Address | string | Physical location street address |
+| Address2 | string | Secondary address line |
+| City | string | City |
+| State | string | State abbreviation |
+| Zip | string | Postal code |
+| BillingAddress | string | Claims billing address if different from treating address |
+| BillingAddress2 | string | Secondary billing address line |
+| BillingCity | string | Billing city |
+| BillingState | string | Billing state |
+| BillingZip | string | Billing postal code |
+| PayToAddress | string | Insurance payment address (may be a PO Box) |
+| PayToAddress2 | string | Secondary payment address line |
+| PayToCity | string | Payment city |
+| PayToState | string | Payment state |
+| PayToZip | string | Payment postal code |
+| Phone | string | Clinic phone number |
+| Abbr | string | Clinic abbreviation; displayed in dropdowns and pick lists |
+| IsHidden | boolean | Hidden status indicator |
+
+**Status Codes:**
+| Code | Meaning |
+|------|---------|
+| 200 | OK |
+
+---
+
+### PUT /clinics/{ClinicNum}
+
+**Version:** 21.4
+**Description:** Updates general contact and billing information for a clinic.
+
+**Path Parameters:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| ClinicNum | integer | Yes | Clinic identifier |
+
+**Body Parameters:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| Description | string | No | Clinic name appearing on statements and letters |
+| Phone | string | No | Exactly 10 digits; no punctuation |
+| BillingAddress | string | No | Billing address used on claims if different from physical treating address |
+| BillingAddress2 | string | No | Secondary billing address line |
+| BillingCity | string | No | Billing city |
+| BillingState | string | No | Billing state |
+| BillingZip | string | No | Billing postal code |
+| PayToAddress | string | No | Address where insurance payments will go; accepts PO Box |
+| PayToAddress2 | string | No | Secondary payment address line |
+| PayToCity | string | No | Payment city |
+| PayToState | string | No | Payment state |
+| PayToZip | string | No | Payment postal code |
+| Abbr | string | No | Abbreviation for the clinic description |
+| IsHidden | string | No | "true" or "false"; cannot hide a clinic that has attached patients |
+
+**Response:** updated clinic object (same fields as GET)
+
+**Status Codes:**
+| Code | Meaning |
+|------|---------|
+| 200 | OK |
+| 400 | Bad Request (with explanation) |
+| 404 | Not Found (with explanation) |
+
+---
+
+## Implementation Notes
+- `Phone` must be exactly 10 digits with no punctuation or formatting.
+- A clinic cannot be hidden (`IsHidden=true`) if it has patients attached to it.
+- GET only returns non-hidden clinics; `IsHidden` is included in response for informational purposes.
+- An empty GET response means the office does not use the Clinics feature — not an error condition.

package/docs/Open Dental 2026-04-22/apiclockevents.md

@@ -0,0 +1,98 @@
+# API: ClockEvents
+
+**Source:** https://www.opendental.com/site/apiclockevents.html
+**Extracted:** 2026-04-22
+**Base Path:** `/clockevents`
+
+---
+
+## Overview
+The ClockEvents API provides access to employee time clock records, tracking clock-in and clock-out events including status (Home, Lunch, Break), displayed and entered times, overtime, and pay rate adjustments.
+
+---
+
+## Endpoints
+
+### GET /clockevents/{ClockEventNum}
+
+**Version:** 24.1.11
+**Description:** Retrieves a single clock event record by its unique identifier.
+
+**Path Parameters:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| ClockEventNum | integer | Yes | Unique clock event identifier |
+
+**Response:** object
+| Field | Type | Description |
+|-------|------|-------------|
+| ClockEventNum | integer | Unique identifier |
+| EmployeeNum | integer | FK to employee |
+| TimeEntered1 | datetime | When the first clock entry was recorded (system time) |
+| TimeDisplayed1 | datetime | Displayed time for first entry (may differ from entered) |
+| ClockStatus | string | Status at clock-in (see Field Reference) |
+| Note | string | Optional note |
+| TimeEntered2 | datetime | When the second clock entry was recorded |
+| TimeDisplayed2 | datetime | Displayed time for second entry |
+| OTimeHours | duration | Overtime hours |
+| OTimeAuto | duration | Automatically calculated overtime |
+| Adjust | duration | Manual time adjustment |
+| AdjustAuto | duration | Automatic time adjustment |
+| AdjustIsOverridden | boolean | Whether adjustment has been manually overridden |
+| Rate2Hours | duration | Hours at rate 2 |
+| Rate2Auto | duration | Automatically calculated rate 2 hours |
+| ClinicNum | integer | FK to clinic |
+| Rate3Hours | duration | Hours at rate 3 |
+| Rate3Auto | duration | Automatically calculated rate 3 hours |
+| IsWorkingHome | boolean | Whether employee is working from home |
+
+**Status Codes:**
+| Code | Meaning |
+|------|---------|
+| 200 | OK |
+| 404 | NotFound |
+
+---
+
+### GET /clockevents
+
+**Version:** 24.1.11
+**Description:** Retrieves multiple clock event records with optional filtering. Date filters apply to `TimeDisplayed1`.
+
+**Query Parameters:**
+| Name | Type | Required | Default | Description |
+|------|------|----------|---------|-------------|
+| EmployeeNum | integer | No | — | Filter by employee |
+| ClockStatus | string | No | — | Filter by status: "Home", "Lunch", or "Break" |
+| ClinicNum | integer | No | — | Filter by clinic |
+| date | string | No | — | Single day filter (format: "yyyy-MM-dd"); based on TimeDisplayed1 |
+| dateStart | string | No | — | Filter events on or after this date (format: "yyyy-MM-dd"); based on TimeDisplayed1 |
+| dateEnd | string | No | — | Filter events before this date (format: "yyyy-MM-dd"); based on TimeDisplayed1 |
+
+**Response:** array of objects (same fields as GET single)
+
+**Status Codes:**
+| Code | Meaning |
+|------|---------|
+| 200 | OK |
+| 400 | BadRequest |
+| 404 | NotFound |
+
+---
+
+## Field Reference
+
+### ClockStatus (enum)
+| Value | Description |
+|-------|-------------|
+| Home | Employee clocked in from/to home |
+| Lunch | Employee on lunch break |
+| Break | Employee on general break |
+
+---
+
+## Implementation Notes
+- Date filter parameters (`date`, `dateStart`, `dateEnd`) apply to `TimeDisplayed1`, not `TimeEntered1`.
+- `TimeDisplayed1` and `TimeDisplayed2` may differ from their corresponding `TimeEntered` fields if times were manually adjusted.
+- This endpoint is read-only; no POST, PUT, or DELETE operations are available.
+- Consult the Open Dental schema documentation for detailed column definitions on the underlying `clockevent` table.