API PayPlans

See API Specification

PayPlans POST (create)

Version Added: 21.3

Creates a payment plan for the patient with the specified terms. This is a patient payment plan, not an insurance or dynamic payment plan. Procedures and adjustments are not associated with the plan. The terms of the payment plan are stored in the PayPlan.Note field and returned in the response. Uses the patient's information to set the provider and clinic (if enabled) associated with the payment plan.

PatNum: Required.
Guarantor: Optional. The person responsible for payments. Default this plan's patient.
PayPlanDate: Optional. The date of the plan agreement. Default today.
principalAmount: Required. The principal amount for the plan.
PayAmt: This or NumberOfPayments is required. The amount due per payment plan charge.
NumberOfPayments: This or PayAmt is requried. The total number of payments in the payment plan.
APR: Optional. Default 0.
DownPayment: Optional. Default 0.00.
Note: Optional. The terms of the payment plan are stored in this field by default. Additional note text is appended to these terms.
ChargeFrequency: Optional. Either "Weekly", "EveryOtherWeek", "Monthly", "Quarterly", or "OrdinalWeekday" (ie, second Tueday of each month, based on the DatePayPlanStart). Default "Monthly".
DatePayPlanStart: Optional. Due date of first payment. Default one month after the PayPlanDate.
DateInterestStart: Optional. Date the payment plan can start posting interest charges. Default minval.

Example Requests:
POST /payplans

{
"PatNum" : 61,
"principalAmount": 500,
"PayAmt": 100
}

{
"PatNum" : 19,
"principalAmount": 256.12,
"NumberOfPayments": 12,
"APR": 5
}

{
"PatNum" : 11,
"Guarantor": 21,
"PayPlanDate": "2021-09-06",
"principalAmount": 500,
"PayAmt": 75.50,
"APR": 18,
"DownPayment": 125,
"ChargeFrequency": "OrdinalWeekday",
"Note": "No payments until 12/06/2021. No interest until 01/03/2022. Payments due first Monday of each month.",
"DatePayPlanStart": "2021-12-06",
"DateInterestStart": "2022-01-03"
}

Example Response:

"9/20/2021 - Date of Agreement: 9/20/2021, Total Amount: 500.00, APR: 0, Total Cost of Loan: 500.00 "

"9/20/2021 - Date of Agreement: 9/20/2021, Total Amount: 256.12, APR: 5, Total Cost of Loan: 263.11 "

"9/20/2021 - Date of Agreement: 9/6/2021, Total Amount: 500.00, APR: 18, Total Cost of Loan: 511.66 No payments until 12/06/2021. No interest until 01/03/2022. Payments due first Monday of each month."

201 Created
400 BadRequest (Missing or invalid fields)
404 NotFound (Patient not found)