@rinse-dental/open-dental 3.4.2 → 4.0.2

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

@@ -0,0 +1,140 @@
+# API: SheetFields
+
+**Source:** https://www.opendental.com/site/apisheetfields.html
+**DB Schema Ref:** sheetfield
+**Extracted:** 2026-04-22
+**Base Path:** `/sheetfields`
+
+---
+
+## Overview
+
+SheetFields represent individual fields within a sheet (form) instance. Each field has a type (InputField, OutputText, CheckBox, SigBox, etc.), a name, and a value. The API supports reading fields and updating values for editable field types.
+
+---
+
+## Endpoints
+
+### GET /sheetfields/{SheetFieldNum}
+
+**Version:** 22.1
+**Description:** Retrieves a single SheetField record by its identifier.
+
+**Path Parameters:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| SheetFieldNum | integer | Yes | SheetField primary key |
+
+**Response:** object
+| Field | Type | Description |
+|-------|------|-------------|
+| SheetFieldNum | integer | Primary key |
+| SheetNum | integer | FK to sheet.SheetNum |
+| FieldType | string | Field type (e.g., "InputField", "SigBoxPractice", "OutputText", "CheckBox") |
+| FieldName | string | Name identifier for the field |
+| FieldValue | string | Current value of the field (format varies by FieldType) |
+| IsRequired | boolean | Whether a value is required before the sheet can be closed |
+| ReportableName | string | Used for reporting on misc fields and exam sheet replacement fields |
+| DateTimeSig | datetime | Datetime the sheet was signed (relevant for SigBox fields) |
+
+**Status Codes:**
+| Code | Meaning |
+|------|---------|
+| 200 | OK |
+| 400 | Bad Request |
+| 404 | Not Found |
+
+---
+
+### GET /sheetfields
+
+**Version:** 22.1
+**Description:** Retrieves all SheetFields, optionally filtered by sheet.
+
+**Query Parameters:**
+| Name | Type | Required | Default | Description |
+|------|------|----------|---------|-------------|
+| SheetNum | integer | No (optional after v25.2.3) | — | Filter by sheet identifier |
+| Offset | integer | No | 0 | Pagination offset |
+
+**Response:** array of SheetField objects (same fields as single GET)
+
+**Status Codes:**
+| Code | Meaning |
+|------|---------|
+| 200 | OK |
+| 400 | Bad Request |
+| 404 | Not Found |
+
+---
+
+### PUT /sheetfields/{SheetFieldNum}
+
+**Version:** 25.2
+**Description:** Updates the value of a SheetField. Only supported for OutputText, InputField, and CheckBox field types.
+
+**Path Parameters:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| SheetFieldNum | integer | Yes | SheetField primary key |
+
+**Body Parameters:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| FieldValue | string | No | Updated field value |
+
+**Response:** object (same fields as GET /sheetfields/{SheetFieldNum})
+
+**Status Codes:**
+| Code | Meaning |
+|------|---------|
+| 200 | OK |
+| 400 | Bad Request |
+| 404 | Not Found |
+
+---
+
+## Field Reference
+
+### FieldType (enum: SheetFieldType)
+| Value | DB Int | Description |
+|-------|--------|-------------|
+| OutputText | 0 | Data pulled from DB or generated at runtime; user can modify before printing |
+| InputField | 1 | Blank input box for user to fill in |
+| StaticText | 2 | Fixed text defined in the sheet template; never changes |
+| Parameter | 3 | Stores a parameter (not PatNum); not visible on sheet; SheetField only, not SheetFieldDef |
+| Image | 4 | Any image, typically a background form image |
+| Drawing | 5 | Sequence of points forming a drawn line; new field row per pen lift |
+| Line | 6 | Simple line from x,y to x+width,y+height; width/height can be negative or zero |
+| Rectangle | 7 | Simple rectangle outline |
+| CheckBox | 8 | Clickable checkbox; FieldValue is "X" if checked, empty if not; can behave as radio button |
+| SigBox | 9 | Signature box (Topaz or on-screen); signature encrypted via hash of all other field values |
+| PatImage | 10 | Patient-specific image; FieldValue is FK to document.DocNum or "MountNum:####" |
+| Special | 11 | Used for ToothChart, ToothChartLegend, and chart module items |
+| Grid | 12 | Placeable grid (e.g., for statements); content generated on the fly |
+| ComboBox | 13 | Dropdown selection; FieldValue format: "chosen;option1|option2|option3" |
+| ScreenChart | 14 | Tooth chart for screenings; FieldValue is semicolon-delimited list |
+| MobileHeader | 15 | Groups fields for mobile view; XPos/YPos/Width/Height always 0 for non-mobile display |
+| SigBoxPractice | 16 | Practice signature box; same encryption as SigBox |
+| MobileStaticText | — | Alternate text for mobile display; XPos/YPos/Width/Height always 0 for non-mobile |
+
+---
+
+## Implementation Notes
+
+- PUT /sheetfields only supports updating `FieldValue` for `OutputText`, `InputField`, and `CheckBox` field types. Other field types are read-only via the API.
+- For `CheckBox` fields: `FieldValue` is "X" when checked, empty string when unchecked.
+- For `SigBox` and `SigBoxPractice` fields: the first character of `FieldValue` indicates SigIsTopaz (0 or 1); remaining characters are the encrypted signature. These cannot be updated via PUT.
+- For `PatImage` fields: `FieldValue` contains a FK to document.DocNum, or "MountNum:####" for a mount reference.
+- For `ComboBox` fields: `FieldValue` format is "selected_value;option1|option2|option3".
+- `SheetNum` query parameter was made optional in v25.2.3; prior versions require it.
+- `ReportableName` enables reporting on misc fields and is used in Exam Sheet replacement field substitution.
+- `DateTimeSig` records the datetime a sheet was signed via a SigBox field.
+
+---
+
+## Related Resources
+| Resource | Purpose |
+|----------|---------|
+| Sheets | Parent sheet record containing these fields |
+| SheetDefs | Template definition used to create the sheet |

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

@@ -0,0 +1,156 @@
+# API: Sheets
+
+**Source:** https://www.opendental.com/site/apisheets.html
+**DB Schema Ref:** sheet
+**Extracted:** 2026-04-22
+**Base Path:** `/sheets`
+
+---
+
+## Overview
+
+Sheets are patient-specific instances of form templates (SheetDefs). They represent filled-out or generated forms such as consent forms, medical histories, patient letters, and exam sheets. The API supports retrieving sheets per patient, creating new sheets from a template, and exporting sheets as PDF to SFTP.
+
+---
+
+## Endpoints
+
+### GET /sheets
+
+**Version:** 21.4
+**Description:** Retrieves all sheets for a single patient.
+
+**Query Parameters:**
+| Name | Type | Required | Default | Description |
+|------|------|----------|---------|-------------|
+| PatNum | integer | Yes | — | Patient identifier |
+| Offset | integer | No | 0 | Pagination offset |
+
+**Response:** array of objects
+| Field | Type | Description |
+|-------|------|-------------|
+| SheetNum | integer | Primary key |
+| SheetType | string | Sheet type (e.g., "PatientLetter", "MedicalHistory", "ExamSheet") |
+| PatNum | integer | FK to patient.PatNum |
+| DateTimeSheet | datetime | Sheet creation/display timestamp; updated when patient submits via eClipboard |
+| InternalNote | string | Internal staff note; not printed on the sheet |
+| Description | string | Sheet description (copied from SheetDef) |
+| IsWebForm | boolean | True if sheet was downloaded from the webforms service |
+| SheetDefNum | integer | FK to sheetdef.SheetDefNum; 0 if internal or created before v17.2 |
+| DocNum | integer | FK to document.DocNum; referral letters stored as PDF in A-to-Z folder |
+| ClinicNum | integer | FK to clinic.ClinicNum; limits display in webforms by clinic |
+| DateTSheetEdited | datetime | Last datetime the sheet was opened and saved (even without changes) |
+
+**Status Codes:**
+| Code | Meaning |
+|------|---------|
+| 200 | OK |
+| 400 | Bad Request (with explanation) |
+| 404 | Not Found (with explanation) |
+
+---
+
+### POST /sheets
+
+**Version:** 23.1.32
+**Description:** Creates a new sheet for a patient using an existing SheetDef template. Supported SheetTypes: "Consent", "PatientLetter", "PatientForm", "MedicalHistory", and "ExamSheet".
+
+**Body Parameters:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| SheetDefNum | integer | Yes | FK to sheetdef.SheetDefNum — the template to use |
+| PatNum | integer | Yes | FK to patient.PatNum |
+| InternalNote | string | No | Internal staff note (not printed) |
+
+**Response:** object (same fields as GET /sheets)
+
+**Status Codes:**
+| Code | Meaning |
+|------|---------|
+| 200 | OK |
+| 400 | Bad Request (with explanation) |
+| 404 | Not Found (with explanation) |
+
+---
+
+### POST /sheets/DownloadSftp
+
+**Version:** 22.1
+**Description:** Converts a sheet to PDF and uploads it to an SFTP server. The destination directory is created if it does not exist. Existing files at the target path are overwritten. Default filename if not specified: "sheet.pdf".
+
+**Body Parameters:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| SheetNum | integer | Yes | Sheet identifier to convert and upload |
+| SftpAddress | string | Yes | Full SFTP destination path including filename |
+| SftpUsername | string | Yes | SFTP authentication username |
+| SftpPassword | string | Yes | SFTP authentication password |
+| SftpPort | integer | No | SFTP port; defaults to 22 (v25.4.45+) |
+
+**Response:** 201 Created — returns full filepath in the `location` response field
+
+**Status Codes:**
+| Code | Meaning |
+|------|---------|
+| 201 | Created — full filepath returned in location field |
+| 400 | Bad Request — invalid fields, invalid file extension, or SFTP connection error |
+| 404 | Not Found (with explanation) |
+
+---
+
+## Field Reference
+
+### SheetType (enum: SheetTypeEnum)
+| Value | DB Int | Description |
+|-------|--------|-------------|
+| LabelPatient | 0 | Patient label; not saved to DB |
+| LabelCarrier | 1 | Carrier label; not saved to DB |
+| LabelReferral | 2 | Referral label; not saved to DB |
+| ReferralSlip | 3 | Referral slip |
+| LabelAppointment | 4 | Appointment label; not saved to DB |
+| Rx | 5 | Prescription |
+| Consent | 6 | Consent form |
+| PatientLetter | 7 | Patient letter |
+| ReferralLetter | 8 | Referral letter |
+| PatientForm | 9 | Patient form |
+| RoutingSlip | 10 | Routing slip; not saved to DB |
+| MedicalHistory | 11 | Medical history form |
+| LabSlip | 12 | Lab slip |
+| ExamSheet | 13 | Exam sheet |
+| DepositSlip | 14 | Deposit slip |
+| Statement | 15 | Statement |
+| MedLabResults | 16 | Medical lab results |
+| TreatmentPlan | 17 | Treatment plan |
+| Screening | 18 | Screening form |
+| PaymentPlan | 19 | Payment plan |
+| RxMulti | 20 | Multiple prescriptions |
+| ERA | 21 | Electronic remittance advice |
+| ERAGridHeader | 22 | ERA grid header |
+| RxInstruction | 23 | Prescription instructions |
+| PatientDashboard | 24 | Deprecated — patient dashboard layout |
+| PatientDashboardWidget | 25 | Patient dashboard widget |
+| ChartModule | 26 | Chart module sheet |
+| None | 27 | Not designed to be saved to DB |
+| Check | 28 | Check printing |
+
+---
+
+## Implementation Notes
+
+- POST /sheets only supports creating sheets for these SheetTypes: "Consent", "PatientLetter", "PatientForm", "MedicalHistory", and "ExamSheet".
+- `SheetDefNum` will be 0 on existing sheets if they were created before v17.2 or from internal templates.
+- `DocNum` is used when referral letters are stored as PDF in the A-to-Z folder.
+- `DateTSheetEdited` is updated whenever the sheet is opened and saved, even if no changes were made — used for concurrent edit detection.
+- POST /sheets/DownloadSftp overwrites existing files at the target SFTP path without warning.
+- SFTP port defaults to 22; use the `SftpPort` parameter (v25.4.45+) to specify a non-standard port.
+- The `location` field in the 201 response from DownloadSftp contains the full remote filepath.
+- `IsWebForm` is true only for sheets downloaded from the webforms service; eClipboard/eForms use a separate Status field.
+
+---
+
+## Related Resources
+| Resource | Purpose |
+|----------|---------|
+| SheetDefs | Template definitions used to create sheet instances |
+| SheetFields | Individual field values within a sheet |
+| Documents | DocNum links for sheets stored as PDF |

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

@@ -0,0 +1,118 @@
+# API: Signalods
+
+**Source:** https://www.opendental.com/site/apisignalods.html
+**DB Schema Ref:** signalod
+**Extracted:** 2026-04-22
+**Base Path:** `/signalods`
+
+---
+
+## Overview
+
+Signalods are internal cache-invalidation and event signals stored in the database. Open Dental uses this table to notify all connected workstations when a shared cache needs refreshing or when specific events (appointments, tasks, security changes) have occurred. The API exposes a GET endpoint for polling new signals after a given datetime.
+
+---
+
+## Endpoints
+
+### GET /signalods
+
+**Version:** 21.2
+**Description:** Returns all Signalod entries that exist after the given `SigDateTime`. Use the returned `serverDateTime` as the input for subsequent requests to implement polling-based pagination.
+
+**Query Parameters:**
+| Name | Type | Required | Default | Description |
+|------|------|----------|---------|-------------|
+| SigDateTime | DateTime | Yes | — | Returns all signals that occurred after this datetime. Store the returned `serverDateTime` and use it for the next call. |
+
+**Response:** array of objects
+| Field | Type | Description |
+|-------|------|-------------|
+| SignalNum | integer | Primary key of the signalod row. |
+| DateViewing | date | If IType=Date, the affected date in the Appointments module. |
+| SigDateTime | datetime | Exact server time when the signal was inserted. |
+| FKey | integer | Identifies the object that caused the signal. For SmsMsgUnreadCount, this is a count rather than a FK. |
+| FKeyType | string | Enum:KeyType — describes the type of object referenced by FKey. |
+| IType | string | Enum:InvalidType — indicates which cache or entity was changed. |
+| RemoteRole | string | Role associated with the signal (e.g., ClientDirect). |
+| MsgValue | string | Message value or content. |
+| serverDateTime | datetime | Server timestamp; store this and pass it as `SigDateTime` in the next request. |
+
+**Status Codes:**
+| Code | Meaning |
+|------|---------|
+| 200 | Success — returns array (may be empty if no new signals). |
+| 400 | Bad Request — invalid or missing parameters. |
+| 404 | Not Found. |
+
+---
+
+## Field Reference
+
+### FKeyType (enum: KeyType)
+| Value | Description |
+|-------|-------------|
+| Undefined | Default/unknown; may be empty string or "Undefined". |
+| FeeSched | Fee schedule object. |
+| Job | Job object. |
+| Operatory | Operatory object. |
+| PhoneExtension | HQ only — FKey is the phone extension that changed. |
+| Provider | Provider object. |
+| SigMessage | Signal message. |
+| SmsMsgUnreadCount | Special: FKey holds a count of unread SMS messages, not a FK. |
+| Task | Task object. |
+| ProcessId | Process identifier; signals the process that sent it so consumers can ignore their own signals. |
+| ConfKick | HQ only — notifies phone tracking server to kick users from a conference room. |
+| PatNum | Patient number; used in AccModule, TPModule, and PerioExams. |
+| UserOd | Deprecated — indicates signal pertains to a specific UserOd. |
+| EmailAddress | Specific email address this signal pertains to. |
+| ChanSpy | HQ specific — used to listen in on live calls. |
+| Computer | Specifies the computerNum the signal pertains to. |
+
+### IType (enum: InvalidType)
+| Value | DB Int | Description |
+|-------|--------|-------------|
+| None | 0 | No type. |
+| Date | 1 | Deprecated. Affects Appointments module date. |
+| AllLocal | 2 | Deprecated. Inefficient — all flags combined except Date and Tasks. |
+| Task | 3 | Any task change not requiring a popup. For popups, use TaskPopup. |
+| ProcCodes | 4 | Procedure codes cache. |
+| Prefs | 5 | Preferences cache. |
+| Views | 6 | ApptViews, ApptViewItems, AppointmentRules, ProcApptColors. |
+| AutoCodes | 7 | Auto codes cache. |
+| Carriers | 8 | Carriers cache. |
+| ClearHouses | 9 | Clearinghouses cache. |
+| Computers | 10 | Computers cache. |
+| InsCats | 11 | Insurance categories cache. |
+| Employees | 12 | Employees cache; also includes payperiods. |
+| StartupOld | 13 | Deprecated. |
+| Defs | 14 | Definitions cache. |
+| Email | 15 | Email templates and addresses (not messages). |
+| Fees | 16 | Obsolete. |
+| Letters | 17 | Letters cache. |
+| QuickPaste | 18 | Quick paste notes and categories. |
+| Security | 19 | Userods, UserGroups, UserGroupAttaches, and GroupPermissions. |
+| Programs | 20 | Programs and program properties. |
+| ToolButsAndMounts | 21 | Tool buttons, MountDefs, and ImagingDevices. |
+| Providers | 22 | Providers and clinics. |
+| ClaimForms | 23 | Claim forms and ClaimFormItems. |
+| ZipCodes | 24 | Zip codes cache. |
+| LetterMerge | 25 | Letter merge cache. |
+| DentalSchools | 26 | Dental school-related tables. |
+| Operatories | 27 | Operatories cache. |
+| TaskPopup | 28 | Task change that requires a popup notification. |
+| Sites | 29 | Sites cache. |
+| Pharmacies | 30 | Pharmacies cache. |
+| Sheets | 31 | Sheets and EForms cache. |
+| RecallTypes | 32 | Recall types cache. |
+| FeeScheds | 33 | Fee schedules cache. |
+
+---
+
+## Implementation Notes
+
+- Poll by passing the last received `serverDateTime` as `SigDateTime` on each subsequent request.
+- An empty array is returned when no signals exist after the given datetime — this is normal, not an error.
+- `FKey` interpretation depends on `FKeyType`; for `SmsMsgUnreadCount`, `FKey` is a count value, not a foreign key.
+- Do not combine `FKeyType` (KeyType) and `IType` (InvalidType) signals — they are separate signal mechanisms.
+- `SigDateTime` on the signal row is set automatically by the server; consumers should not attempt to set it.

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

@@ -0,0 +1,47 @@
+# API: Specification (Overview)
+
+**Source:** https://www.opendental.com/site/apispecification.html
+**Extracted:** 2026-04-22
+**Base Path:** `/api/v1`
+
+---
+
+## Overview
+
+The Open Dental API is a RESTful service that allows developers to safely interact with an Open Dental database. It is distinct from the Open Dental FHIR API. Developers are required to maintain a Business Associate Agreement (BAA) with their clients before accessing patient data through the API.
+
+---
+
+## Endpoints
+
+This page is a specification index / table of contents rather than a single endpoint reference. It documents the general conventions shared across all API resources.
+
+### HTTP Methods — General Conventions
+
+| Method | Behavior | Typical Response |
+|--------|----------|-----------------|
+| GET | Retrieve one or multiple items | 200 OK with body |
+| POST | Create a new item | 201 Created; includes Location header and created object |
+| PUT | Update an existing item | 200 OK with updated object |
+| DELETE | Remove a database entry | 200 OK |
+
+---
+
+## Implementation Notes
+
+- All resources follow standard REST conventions with JSON request/response bodies.
+- Developers must have a Business Associate Agreement (BAA) in place with their clients.
+- The Open Dental API and the Open Dental FHIR API are separate services with different target audiences and endpoint structures.
+- Over 100 resource endpoints are available, covering clinical and administrative entities including Patients, Appointments, Claims, Medications, Providers, and many more.
+- Consult the API Developer Setup (`apisetup.html`) and API Implementation (`apiimplementation.html`) pages for authentication and integration setup details.
+- Community support is available at the API Forum: https://www.opendentalsoft.com:8085/forum/
+
+---
+
+## Related Resources
+
+| Resource | Purpose |
+|----------|---------|
+| apisetup.html | Developer setup and authentication configuration |
+| apiimplementation.html | Implementation guidance and integration patterns |
+| FHIR API | Separate FHIR-compliant API for interoperability use cases |

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

@@ -0,0 +1,160 @@
+# API: Statements
+
+**Source:** https://www.opendental.com/site/apistatements.html
+**DB Schema Ref:** statement
+**Extracted:** 2026-04-22
+**Base Path:** `/statements`
+
+---
+
+## Overview
+
+Statements represent billing statements generated for a patient or family. Each statement covers a date range, supports multiple delivery modes (mail, email, electronic, API), and tracks balance and insurance estimate data. The POST endpoint creates a ledger entry in the Account Module without impacting billing processing. The DELETE endpoint is restricted to API-generated statements only.
+
+---
+
+## Endpoints
+
+### GET /statements/{StatementNum}
+
+**Version:** 24.2.23
+**Description:** Retrieves a single statement record by primary key.
+
+**Path Parameters:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| StatementNum | integer | Yes | Primary key of the statement |
+
+**Response:** object
+| Field | Type | Description |
+|-------|------|-------------|
+| StatementNum | bigint | Primary key |
+| PatNum | bigint | FK to patient.PatNum; typically the guarantor |
+| DateSent | date | Date statement was sent; format "yyyy-MM-dd" |
+| DateRangeFrom | date | Statement date range start; format "yyyy-MM-dd" |
+| DateRangeTo | date | Statement date range end; format "yyyy-MM-dd"; dates >= year 2200 indicate max value |
+| Note | text | Standard-font statement note; may include line breaks |
+| NoteBold | text | Bold-font statement note |
+| Mode_ | string | Delivery mode enum: StatementMode (see Field Reference) |
+| HidePayment | boolean | True hides credit card section and "please pay" box |
+| SinglePatient | boolean | True if statement is for one patient rather than entire family |
+| Intermingled | boolean | For family statements: true = intermingled grid; false = separate grids per patient |
+| IsSent | boolean | True if statement has been sent |
+| DocNum | bigint | FK to document.DocNum when a PDF has been archived; 0 if none |
+| DateTStamp | datetime | Last modified timestamp |
+| IsReceipt | boolean | True changes heading from "statement" to "receipt" |
+| IsInvoice | boolean | True marks as invoice (contains procedures, adjustments, payplan charges) |
+| IsInvoiceCopy | boolean | True if this is a subsequent printout of an invoice (shows "copy") |
+| SuperFamily | bigint | FK to patient.PatNum for super-family statements; 0 if not applicable |
+| IsBalValid | boolean | True for statements generated in v16.1+, except API-created statements |
+| InsEst | double | Insurance estimate for entire family at time of statement |
+| BalTotal | double | Total family balance before insurance estimate |
+| StatementType | string | Enum: StmtType (see Field Reference) |
+
+**Status Codes:**
+| Code | Meaning |
+|------|---------|
+| 200 | OK |
+| 404 | NotFound |
+
+---
+
+### GET /statements
+
+**Version:** 24.2.23
+**Description:** Retrieves multiple statement records, optionally filtered by patient.
+
+**Query Parameters:**
+| Name | Type | Required | Default | Description |
+|------|------|----------|---------|-------------|
+| PatNum | integer | No | — | Filters results to statements for a specific patient |
+
+**Response:** array of objects (same fields as single GET)
+
+**Status Codes:**
+| Code | Meaning |
+|------|---------|
+| 200 | OK |
+| 400 | BadRequest |
+| 404 | NotFound |
+
+---
+
+### POST /statements
+
+**Version:** 25.3.26
+**Description:** Creates a statement entry in the Account Module ledger. Does not impact billing processing.
+
+**Body Parameters:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| PatNum | integer | Yes | FK to patient.PatNum |
+| DateSent | string (date) | No | Format "yyyy-MM-dd"; defaults to current date |
+| Note | string | No | Statement note; defaults to empty string |
+| DocNum | integer | No | FK to document.DocNum; defaults to 0 |
+
+**Response:** object — complete statement record with assigned StatementNum
+
+**Status Codes:**
+| Code | Meaning |
+|------|---------|
+| 201 | Created |
+| 400 | BadRequest |
+| 404 | NotFound |
+
+---
+
+### DELETE /statements/{StatementNum}
+
+**Version:** 25.4.33
+**Description:** Deletes a statement record. Only API-mode statements may be deleted.
+
+**Path Parameters:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| StatementNum | integer | Yes | Primary key of the statement to delete |
+
+**Status Codes:**
+| Code | Meaning |
+|------|---------|
+| 200 | OK |
+| 400 | BadRequest |
+| 404 | NotFound |
+
+---
+
+## Field Reference
+
+### Mode_ (enum: StatementMode)
+| Value | DB Int | Description |
+|-------|--------|-------------|
+| Mail | 0 | Mailed statement |
+| InPerson | 1 | In-person walkout statement |
+| Email | 2 | Emailed statement |
+| Electronic | 3 | Sent electronically to a third-party API for physical mailing |
+| API | 4 | Generated by a third-party API developer; optionally associated with a DocNum |
+
+### StatementType (enum: StmtType)
+| Value | DB Int | Description |
+|-------|--------|-------------|
+| NotSet | (string) | Regular statement |
+| LimitedStatement | (string) | Contains specific selected procedures, patient payments, insurance payments, or adjustments |
+| Walkout | (string) | Marks as walkout; shows everything that occurred today |
+
+---
+
+## Implementation Notes
+
+- DELETE is only permitted when `Mode_` equals "API"; attempting to delete other statement types returns 400.
+- Associated document records (DocNum) must be deleted before deleting the statement.
+- `IsBalValid` is false for API-created statements; `InsEst` and `BalTotal` are not populated in that case.
+- `DateRangeTo` values >= year 2200 represent "maximum" (open-ended) date range.
+- POST creates a ledger entry only; it does not trigger any billing workflow.
+
+---
+
+## Related Resources
+
+| Resource | Purpose |
+|----------|---------|
+| Documents | PDF archive linked via DocNum |