Payments

Create and manage patient payments. Per OpenDental API.

What are Payments in OpenDental?

Payments are patient payments—checks, cash, credit card, etc.—not insurance. (Insurance checks use ClaimPayments.) When you create a payment, it allocates to outstanding procedures and adjustments via PaySplits in FIFO order, reducing the patient balance. Use PayType (Definitions Category=10) for Check, Cash, CC, etc. Supports Refund to reverse a payment, and isPrepayment for unallocated funds. Optionally target specific procNums or payPlanNum for prepayment on a payment plan.

PatNum

PayType (DefNum)

DateEntry

PayType: definition.DefNum where definition.Category=10.

PayNum	PatNum	PayAmt	payType	PayDate	CheckNum	PaymentSource	Actions

Enter PatNum and click Load.

Create Payment

Required

PayAmt *

PatNum *

PayType (DefNum)

PayDate

yyyy-MM-dd. Default today.

CheckNum

BankBranch

ClinicNum

Defaults to patient.ClinicNum

MerchantFee

isPatientPreferred

Splits go to patient vs family FIFO.

isPrepayment

payPlanNum

For Dynamic Payment Plan. Only if isPrepayment=true.

procNums

Comma-separated ProcNums to apply payment to. Ignored if isPrepayment=true.

PayNote

Result:

Create Refund

Creates a refund for an existing payment. Cannot refund payments attached to payment plans or with negative paysplits.

PayNum *

Result:

Search & Update Payment

PatNum *

Select a payment to update:

Update Payment

—

PayType (DefNum)

CheckNum

BankBranch

ProcessStatus

For online payments only.

PayNote

Overwrites existing.

Result:

Payments - GET Response

GET /payments. Params: PatNum, PayType, DateEntry. Per OpenDental API.

Example Response:

[
  {
    "PayNum": 56734,
    "PayType": 69,
    "payType": "Check",
    "PayDate": "2022-06-24",
    "PayAmt": "339",
    "CheckNum": "12798",
    "BankBranch": "20-6",
    "PayNote": "",
    "PatNum": 1337,
    "ClinicNum": "0",
    "DateEntry": "2022-06-24",
    "DepositNum": 0,
    "Receipt": "",
    "IsRecurringCC": "true",
    "SecUserNumEntry": 0,
    "SecDateTEdit": "2022-06-24 07:34:31",
    "PaymentSource": "None",
    "ProcessStatus": "OfficeProcessed",
    "RecurringChargeDate": "0001-01-01",
    "IsCcCompleted": "false",
    "MerchantFee": 0.0,
    "serverDateTime": "2022-08-26 11:55:44"
  }
]

Field Descriptions:

PayNum: Unique payment ID
PayType: definition.DefNum (Category=10)
payType: Human-readable type (Check, Cash, etc.)
PayDate: Payment date
PayAmt: Amount
CheckNum: Check number
BankBranch: Bank-branch code
PayNote: Note
PatNum: Patient
ClinicNum: Clinic
DateEntry: Entry date
PaymentSource: None, API, etc.
ProcessStatus: OfficeProcessed, OnlineProcessed, OnlinePending
MerchantFee: Additional fee (display only)

Create Payment - JSON

POST /payments. Required: PayAmt, PatNum. Per OpenDental API.

Example Request:

{
  "PayAmt": "129.99",
  "PatNum": 1568,
  "PayDate": "2021-07-05",
  "CheckNum": "2058",
  "PayNote": "Check payment through website",
  "BankBranch": "19-7076",
  "ClinicNum": "3",
  "isPatientPreferred": "true",
  "isPrepayment": "false",
  "procNums": [13, 14, 18],
  "payPlanNum": 0,
  "MerchantFee": 0.0
}

Fields:

PayAmt *: Required. Amount (string or number)
PatNum *: Required. patient.PatNum
PayType: definition.DefNum Category=10. Default ApiPaymentType preference
PayDate: yyyy-MM-dd. Default today
CheckNum: Check number
PayNote: Note
BankBranch: Bank-branch code
ClinicNum: Defaults to patient.ClinicNum
isPatientPreferred: "true"/"false". Splits to patient vs family FIFO
isPrepayment: "true"/"false". Unearned/prepayment
procNums: Array [1,2,3] to apply to procedures
payPlanNum: Dynamic Payment Plan. Only if isPrepayment=true
MerchantFee: Display only. Default 0.0

Refund - JSON

POST /payments/Refund. Required: PayNum. Per OpenDental API.

Example Request:

{
  "PayNum": 178
}

Cannot refund payments attached to payment plans or with negative paysplits.

Update Payment - JSON

PUT /payments/{PayNum}. All fields optional. Per OpenDental API.

Example Request:

{
  "PayType": 449,
  "CheckNum": "7492",
  "BankBranch": "98-795",
  "PayNote": "12 months - 10% discount.",
  "ProcessStatus": "OnlineProcessed"
}

Updatable Fields:

PayType: definition.DefNum Category=10
CheckNum: Check number
BankBranch: Bank-branch code
PayNote: Overwrites existing
ProcessStatus: OnlineProcessed | OnlinePending (online payments only)