Home

PayrollDeductions

POST api/Payment/{systemID}/PaymentMethods/PayrollDeductions

Add Payroll Deduction to a Patient's Profile

Special Remarks

Successful response returns PaymentMethodID (Backend Identifier for Payment Method)

Request Information

Parameters

NameDescriptionAdditional information
systemID 
The SystemID of the pharmacy system.

Define this parameter in the request URI.
payrollDetails 
PayrollDeductionDetails object:
            PatientID - Unique ID of patient in pharmacy system  [*Required], 
            ThirdPartyPayrollID - Customer identifier for Payroll deductions,
            PayrollAmountPerPeriod - Maximum amount to deduct per pay period (decimal),
            PayrollAmountPerOrder - Maximum amount to use per order (decimal),

Define this parameter in the request body.
    

Response Codes

    
  • OK (200)
  • NotFound (404)
  • InternalServerError (500)
  • BadRequest (400)
    •     

Request body formats

application/json, text/json

Sample: 
{
  "PatientID": "sample string 1",
  "ThirdPartyPayrollID": "sample string 2",
  "PayrollAmountPerPeriod": 3.0,
  "PayrollAmountPerOrder": 4.0
}

text/javascript

Sample: 
{"PatientID":"sample string 1","ThirdPartyPayrollID":"sample string 2","PayrollAmountPerPeriod":3.0,"PayrollAmountPerOrder":4.0}

application/xml, text/xml

Sample: 
<PayrollDeductionDetails xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QCFWebAPI.Models">
  <PatientID>sample string 1</PatientID>
  <PayrollAmountPerOrder>4</PayrollAmountPerOrder>
  <PayrollAmountPerPeriod>3</PayrollAmountPerPeriod>
  <ThirdPartyPayrollID>sample string 2</ThirdPartyPayrollID>
</PayrollDeductionDetails>