API PayPlanLinks
Anyone using the API should also become very familiar with our schema documentation which contains important details about individual database table columns.
See PayPlanLink Database Schema.
PayPlanLinks GET (single)
Version Added: 25.3.29
Gets a single payplanlink.
PayPlanLinkNum: Required in the URL.
Example Request:
GET /payplanlinks/243
Example Response:
{
"PayPlanLinkNum": 243,
"PayPlanNum": 106,
"LinkType": "Procedure",
"FKey": 153,
"AmountOverride": 0.0,
"SecDateTEntry": "2024-03-13 13:59:41"
}
200 OK
404 NotFound (with explanation)
PayPlanLinks GET (multiple)
Version Added: 25.3.29
Gets a list of all payplanlinks. Can optionally filter by PayPlanNum.
PayPlanNum: Optional in URL.
Example Requests:
GET /payplanlinks
GET /payplanlinks?PayPlanNum=106
Example Response:
[
{
"PayPlanLinkNum": 243,
"PayPlanNum": 106,
"LinkType": "Procedure",
"FKey": 153,
"AmountOverride": 0.0,
"SecDateTEntry": "2024-03-13 13:59:41"
},
{
"PayPlanLinkNum": 247,
"PayPlanNum": 106,
"LinkType": "Procedure",
"FKey": 155,
"AmountOverride": 0.0,
"SecDateTEntry": "2024-03-13 14:02:32"
},
{
"PayPlanLinkNum": 262,
"PayPlanNum": 106,
"LinkType": "Adjustment",
"FKey": 372,
"AmountOverride": 0.0,
"SecDateTEntry": "2024-03-15 09:27:11"
}
]
200 OK
404 NotFound (with explanation)
PayPlanLinks POST (create)
Version Added: 25.3.29
Creates a payplanlink.
PayPlanNum: Required. FK to payplan.PayPlanNum for Dynamic Payment Plans that are not locked or closed.
LinkType: Required, either "Procedure" or "Adjustment".
FKey: Required. procedurelog.ProcNum if LinkType is "Procedure", or adjustment.AdjNum if LinkType is "Adjustment".
AmountOverride: Optional. Cannot exceed amount remaining on the production. 0.0 indicates no override. Default 0.0.
Example Request:
POST /payplanlinks
{
"PayPlanNum": 134,
"LinkType": "Procedure",
"FKey": 395,
"AmountOverride": 15.49
}
Example Response:
{
"PayPlanLinkNum": 496,
"PayPlanNum": 134,
"LinkType": "Procedure",
"FKey": 395,
"AmountOverride": 15.49,
"SecDateTEntry": "2025-10-15 15:19:17"
}
201 Created
400 BadRequest (with explanation)
404 NotFound (with explanation)
PayPlans PUT (update)
Version Added: 25.3.29
Updates a payplanlink.
PayPlanLinkNum: Required in URL.
AmountOverride: Cannot exceed amount remaining on the production. 0.0 indicates no override.
Example Request:
PUT /payplanlinks/496
{
"AmountOverride" : 9.95
}
Example Response:
{
"PayPlanLinkNum": 496,
"PayPlanNum": 134,
"LinkType": "Procedure",
"FKey": 395,
"AmountOverride": 9.95,
"SecDateTEntry": "2025-10-15 16:22:48"
}
400 BadRequest (with explanation)
404 NotFound (with explanation)
PayPlanLinks DELETE
Version Added: 25.3.29
Deletes a payplanlink.
PayPlanLinkNum: Required in the URL.
Example Request:
DELETE /payplanlinks/496
Example Responses:
200 OK
400 BadRequest (with explanation)
404 NotFound (with explanation)