API PayPlanCharges
Anyone using the API should also become very familiar with our schema documentation which contains important details about individual database table columns.
See PayPlanCharge Database Schema.
PayPlanCharges GET
Version Added: 23.2.28
Gets all payplancharges for a specified payment plan.
PayPlanNum: Required.
getExpected: (Added in version T.B.A.) Optional, either "true" or "false". If "true", the response will include predicted future charges, which are indicated with a PayPlanChargeNum of 0. Can only be "true" if PayPlanNum is for a Dynamic Payment Plan. Default "false".
Example Requests:
GET /payplancharges?PayPlanNum=23
GET /payplancharges?PayPlanNum=21&getExpected=true
Example Response:
[
{
"PayPlanChargeNum": 42,
"PayPlanNum": 23,
"Guarantor": 30,
"PatNum": 30,
"ChargeDate": "2023-09-20",
"Principal": 25.0,
"Interest": 0.0,
"Note": "Down Payment",
"ProvNum": 2,
"ClinicNum": 0,
"ChargeType": "Debit",
"ProcNum": 0,
"SecDateTEntry": "2023-09-20 09:24:16",
"SecDateTEdit": "2023-09-20 09:24:16",
"StatementNum": 0,
"FKey": 134,
"LinkType": "Procedure",
"IsOffset": "false",
"IsDownPayment": "true"
},
{
"PayPlanChargeNum": 43,
"PayPlanNum": 23,
"Guarantor": 30,
"PatNum": 30,
"ChargeDate": "2023-10-20",
"Principal": 40.96,
"Interest": 0.12,
"Note": "",
"ProvNum": 2,
"ClinicNum": 0,
"ChargeType": "Debit",
"ProcNum": 0,
"SecDateTEntry": "2023-10-20 08:58:27",
"SecDateTEdit": "2023-10-20 08:58:27",
"StatementNum": 0,
"FKey": 134,
"LinkType": "Procedure",
"IsOffset": "false",
"IsDownPayment": "false"
},
{
"PayPlanChargeNum": 44,
"PayPlanNum": 23,
"Guarantor": 30,
"PatNum": 30,
"ChargeDate": "2023-10-23",
"Principal": 8.04,
"Interest": 0.0,
"Note": "Close Out Charge",
"ProvNum": 2,
"ClinicNum": 0,
"ChargeType": "Debit",
"ProcNum": 0,
"SecDateTEntry": "2023-10-23 15:38:30",
"SecDateTEdit": "2023-10-23 15:38:30",
"StatementNum": 0,
"FKey": 134,
"LinkType": "Procedure",
"IsOffset": "false",
"IsDownPayment": "false"
}
]
200 OK
400 BadRequest (with explanation)
404 NotFound (with explanation)
PayPlanCharges POST
Version Added: T.B.A.
Creates a PayPlanCharge for a specified Dynamic Payment Plan.
PayPlanNum: Required. FK to payplan.PayPlanNum for a Dynamic Payment Plan.
ChargeDate: Required. String in "yyyy-MM-dd" format. The date at which this PayPlanCharge will be due.
Principal: Required. Charge amount. Cannot exceed remaining value on the production it's going towards.
FKey: Required. FK to the primary key of the object type found in LinkType. Must match one of the pieces of production linked to the PayPlan.
LinkType: Required. Either "Adjustment", "Procedure", or "OrthoCase". Used in tandem with FKey to select a production linked to the PayPlan that this charge will go towards.
Interest: Optional. Interest portion of this charge.
Note: Optional.
Example Request:
POST /payplancharges
{
"PayPlanNum": 21,
"ChargeDate": "2026-09-20",
"Principal": 25.75,
"Interest": 0,
"Note": "Made via API",
"FKey": 324,
"LinkType": "Procedure"
}
Example Response:
{
"PayPlanChargeNum": 72,
"PayPlanNum": 21,
"Guarantor": 31,
"PatNum": 31,
"ChargeDate": "2026-09-20",
"Principal": 25.75,
"Interest": 0.0,
"Note": "Made via API",
"ProvNum": 3,
"ClinicNum": 0,
"ChargeType": "Debit",
"ProcNum": 0,
"SecDateTEntry": "2026-06-15 14:29:12",
"SecDateTEdit": "2026-06-15 14:29:12",
"StatementNum": 0,
"FKey": 324,
"LinkType": "Procedure",
"IsOffset": "false",
"IsDownPayment": "false"
}
201 Created
400 BadRequest (with explanation)
404 NotFound (with explanation)
PayPlanCharges PUT
Version Added: T.B.A.
Updates an existing payplancharge belonging to a Dynamic Payment Plan.
PayPlanChargeNum: Required in the URL.
ChargeDate: String in "yyyy-MM-dd" format. The date at which this PayPlanCharge will be due.
Principal: Charge amount. Cannot exceed remaining value on the production it's going towards.
Interest: Interest portion of this charge.
Note: Overwrites existing note.
Example Request:
PUT /payplancharges/72
{
"ChargeDate": "2026-10-20",
"Principal": 20.99,
"Interest": 0.24,
"Note": "Updated via API"
}
Example Response:
{
"PayPlanChargeNum": 72,
"PayPlanNum": 21,
"Guarantor": 31,
"PatNum": 31,
"ChargeDate": "2026-10-20",
"Principal": 20.99,
"Interest": 0.24,
"Note": "Updated via API",
"ProvNum": 3,
"ClinicNum": 0,
"ChargeType": "Debit",
"ProcNum": 0,
"SecDateTEntry": "2026-06-15 14:29:12",
"SecDateTEdit": "2026-06-15 14:29:12",
"StatementNum": 0,
"FKey": 324,
"LinkType": "Procedure",
"IsOffset": "false",
"IsDownPayment": "false"
}
200 OK
400 BadRequest (with explanation)
404 NotFound (with explanation)
PayPlanCharges DELETE
Version Added: T.B.A.
Deletes a payplancharge belonging to a Dynamic Payment Plan. Will not delete a payplancharge with an associated PaySplit.
PayPlanChargeNum: Required in the URL.
Example Request:
DELETE /payplancharges/72
Example Response:
200 OK
400 BadRequest (with explanation)
404 NotFound (with explanation)