PCA API Documentation
10 min
Each function has the API call URL, parameters (all are query parameters). All functions are GET functions. Status responses are included as well.
Validate Employee
Function to validate employee using employee number
GET
https:pcuganda.com/api/data/validate/[employeenumber]
Query Parameters
- Employee numberstringrequiredDescription
Responses
200
{
"employeedetails" :
{
"employeenumber" : "000000000123456",
"fullname" : "RICHARD AKZO",
"dateofbirth" : "1979-01-10",
"gender" : "M",
"votecode" : "563",
"votedescription" : "KOBOKO DISTRICT",
"employeetitle" : "Entomological Assistant",
"terms" : "Permanent Employee",
"lastupdated" : "2018-2",
"tel" : "0712999999",
"deductions" : {
"reservationnumber" : "1485652415",
"referencecode" : "866178",
"installmentamount" : "50000",
"loanamount" : "200000",
"startdate" : "2017-02-01",
"enddate" : "2019-03-01",
"deductiontype" : "458",
"companyname" : "JOPEG Financial Services",
"status" : "reserved",
}
"recurring_allowances" : {
"code" : "1510",
"amount" : "50000",
"payrolldate" : "2018-02-01",
"description" : "Lunch Allowance"
}
"statutory_deductions" : {
"code" : "249",
"deductionamount" : "63351",
"payrolldate" : "2018-02-01",
"description" : "PAYE"
}
"maximum_affordability" : "189432.76",
"alt_affordability": null,
"last_deduction_date": null,
"last_payment_amount": null,
"totalpaid": null
}
}404
{
"status" : "false",
"message": "Employee could not be found"
}Make Reservation
Function to make a reservation on an employee
GET
https:pcuganda.com/api/data/reservation/ [employeenumber]/ [referencecode]/ [installmentamount]/ [loanamount]/ [telephone]
Query Parameters
- employeenumberstringrequiredDescription
- referencecodestringrequiredDescription
- installmentamountIntegerrequired
- loanamountstringrequired
- telephonestringDescription
Responses
200
{
reservation_details : {
"employeenumber" : "000000000123456",
"referencecode" : "jp001",
"installmentamount" : "50000",
"loanamount" : "600000",
"deductiontype" : "458",
"reservationnumber" : "25412415231"
}
}404
{
"status" : "false",
"message" : "Please enter all parameters"
}
OR
{
"status" : "false",
"message" : "Reservation/Deduction Already Exists"
}
OR
{
"status" : "false",
"message" : "The employee has no affordability"
}Get Reservations Pending Approval
Function to show all reservations pending approval
GET
https:pcuganda.com/api/data/reservations_pending_approval
Responses
200
{
"pending_approval": [
{
"employeenumber" : "000000000123456",
"id" : "7754",
"reservationnumber" : "45215642",
"referencecode" : "jp001",
"installmentamount" : "50000",
"loanamout" : "600000",
"startdate" : "2017-02-01",
"enddate" : "2019-03-01",
"deductiontype" : "458"
},
...
]
}Submit Reservation for Approval
Function to submit individual reservation for approval
Use this function call after getting results from the “Get Reservations Pending Approval” function
GET
https:pcuganda.com/api/data/submit_for_approval/ [deductionid]
Query Parameters
- deductionidstringrequiredDescription
Responses
200
{
"status" : "true",
"message": "Reservation Submitted for Approval"
}404
{
"status" : "false",
"message": "No reservation selected"
}Find Reservation
Function to get details of institution reservation
GET
https:pcuganda.com/api/data/find_reservation / [employeenumber]
Query Parameters
- employeenumberstringrequired
Responses
200
{
"employeenumber" : "000000000324516",
"reservations": {
"id" : "7754",
"reservationnumber" : "45215642",
"referencecode" : "jp001",
"installmentamount" : "50000",
"loanamout" : "600000",
"startdate" : "2017-02-01",
"enddate" : "2019-03-01",
"deductiontype" : "458"
}
}404
{
"status" : "false",
"message": "Invalid Employee Number"
}
OR
{
"status" : "false",
"message": "No Reservations Found"
}Cancel Reservation
Function to get cancel running reservation
GET
https:pcuganda.com/api/data/cancel_reservation / [employeenumber]
Query Parameters
- employeenumberStringrequiredDescription
Responses
200
{
"status" : "true",
"message" : "Reservation Cancelled"
}404
{
"status" : "false",
"message": "Invalid Employee Number"
}
OR
{
"status" : "false",
"message": "No Reservations Found"
}Reports
Function to retrieve different reports on the PDMS
GET
https:pcuganda.com/api/data/report /[startdate]/[enddate]/[status]
Query Parameters
- startdateStringrequiredDescription
- enddatestringrequiredDescription
- statusstringrequiredDescription
Responses
200
{
"deductions" : {
"reservationnumber" : "45215642",
"referencecode" : "jp001",
"installmentamount" : "50000",
"loanamout" : "600000",
"deductionstart" : "2017-02-01",
"deductionend" : "2019-03-01",
"status" : "reserved",
"firstname" : "MOSES ARIHO",
"employeenumber" : "000000000635467",
"votedesc" : "STATE HOUSE"
}
}Find Deduction
Function to find deduction details
GET
https:pcuganda.com/api/data/find_deduction/[employeenumber]
Query Parameters
- employeenumberStringrequired
Responses
200
{
"employeenumber" : "000000000324516",
"fullname" : "MOSES ARIHO",
"department" : "LOCAL GOVERNMENT",
"deduction" : {
"id" : "7754",
"reservationnumber" : "45215642",
"referencecode" : "jp001",
"installmentamount" : "50000",
"loanamout" : "600000",
"borrowedamount" : "600000",
"startdate" : "2017-02-01",
"enddate" : "2019-03-01",
"status" : "takenup",
"deductiontype" : "458"
}
}404
{
"status" : "false",
"message" : "Employee Number Not Found"
}
OR
{
"status" : "false",
"message": "No deduction found"
}Stop Deduction
Function to stop active deduction
GET
https:pcuganda.com/api/data/stop_deduction / [employeenumber]
Query Parameters
- employeenumberStringrequired
Responses
200
{
"status" : "true",
"message" : "Deduction Stopped"
}404
{
"status" : "false",
"message" : "Employee Number Not Found"
}
OR
{
"status" : "false",
"message": "No deduction found"
}Replace Deduction / Do Topup
Function to top up active deduction
GET
https:pcuganda.com/api/data/replace_deduction /[employeenumber]/[installmentamount]/[loanamount]
Query Parameters
- employeenumberStringrequired
- installmentamountstringrequired
- loanamountstringrequired
Responses
200
{
"status" : "true",
"message" : "Topup Reservation Done"
}404
{
"status" : "false",
"message" : "Employee Number Not Found"
}
OR
{
"status" : "false",
"message": "No deduction found"
}
OR
{
"status" : "false",
"message": "Reservation Not Affordable"
}Find Topup Reservation
Function to retrieve topup reservation details
GET
https:pcuganda.com/api/data/find_topup_reservation /[employeenumber]
Query Parameters
- employeenumberStringrequired
Responses
200
{
"reservation_list": [
{
"id" : "7754",
"reservationnumber" : "45215642",
"referencecode" : "jp001",
"installmentamount" : "50000",
"loanamout" : "600000",
"deductionstart" : "2017-02-01",
"deductionend" : "2019-03-01",
"status" : "Topup Reserved",
"firstname" : "MOSES ARIHO",
"employeenumber" : "000000000783645",
"votedesc" : "KOBOKO DISTRICT",
},
]
}404
{
"status" : "false",
"message" : "No Topup Reservation Found"
}Cancel Topup Reservation
Function to cancel active topup reservation
GET
https:pcuganda.com/api/data/cancel_topup_reservation/ [employeenumber]
Query Parameters
- employeenumberStringrequired
Responses
200
{
"status" : "true",
"message" : "Topup Reservation Cancelled"
}404
{
"status" : "false",
"message" : "No Topup Reservation Found"
}Get Topup Reservations Pending Approval
Function to show records of topup reservations pending approval
GET
https:pcuganda.com/api/data/topup_reservations_pending_approval
Responses
200
{
"pending_approval" : [
{
"employeenumber" : "000000000123456",
"firstname" : "MOSES ARIHO",
"deductionid" : "7754",
"reservationnumber" : "45215642",
"referencecode" : "jp001",
"installmentamount" : "50000",
"loanamout" : "600000",
"startdate" : "2017-02-01",
"enddate" : "2019-03-01",
"deductiontype" : "458"
}
]
}Submit Topup Reservation for Approval
Function to submit topup reservations for approval
GET
https:pcuganda.com/api/data/submit_topup_for_approval/ [deductionid]
Query Parameters
- deductionidstringrequiredDescription
Responses
200
{
"status" : "true",
"message": "Topup Reservation Submitted for Approval"
}404
{
"status" : "false",
"message": "No reservation selected"
}Update Deduction Balance
Function to update loan balance
GET
https:pcuganda.com/api/data/update_balance/ [employeenumber]/[loanamount]
Query Parameters
- employeenumberstringrequired
- loanamountstringrequiredDescription
Responses
200
{
"status" : "true",
"message": "Deduction Balance Updated"
}404
{
"status" : "false",
"message": "Employee Number Not Found"
}
OR
{
"status" : "false",
"message": "No deduction found"
}
PLEASE NOTE : The quota for the API calls is 1 call per second.