API PaySplits

See API Specification

PaySplits GET

Version Added: 22.4.16

Get a list of PaySplits for a patient or payment.

Parameters:

PatNum:This or PayNum is required. Get all PaySplits for a single patient.
PayNum: This or PatNum is required. Get all PaySplits for a single payment.

Example Request:
GET /paysplits?PatNum=407
GET /paysplits?PayNum=8567
GET /paysplits?PatNum=407&PayNum=8567

Example Response:

[
{
"SplitNum": 116,
"SplitAmt": 140,
"PatNum": 407,
"PayNum": 8567,
"ProvNum": 1,
"PayPlanNum": 0,
"DatePay": "2023-01-27",
"ProcNum": 9,
"DateEntry": "2023-01-27",
"UnearnedType": 0,
"unearnedType": "",
"ClinicNum": 1,
"SecDateTEdit": "2023-01-27",
"AdjNum": 0,
"PayPlanChargeNum": 0,
"PayPlanDebitType": "Unknown"
},
{
"SplitNum": 115,
"SplitAmt": 140,
"PatNum": 407,
"PayNum": 8567,
"ProvNum": 1,
"PayPlanNum": 0,
"DatePay": "2023-01-27",
"ProcNum": 8,
"DateEntry": "2023-01-27",
"UnearnedType": 0,
"unearnedType": "",
"ClinicNum": 1,
"SecDateTEdit": "2023-01-27",
"AdjNum": 0,
"PayPlanChargeNum": 0,
"PayPlanDebitType": "Unknown"
},
etc...
]

200 OK
400 BadRequest (Patient is deleted, etc)
404 NotFound (Patient not found, Payment not found)