---
title: PCA API Documentation
slug: apimanual.pcuganda.com
icon: 🚀
createdAt: 2022-12-14T06:30:46.000Z
---

:::hint{type="info"}
Each function has the API call URL, parameters (all are query parameters).
All functions are GET functions.
Status responses are included as well.
:::

:::ApiMethodV2
```json
{
  "name": "Validate Employee",
  "method": "GET",
  "url": "https:pcuganda.com/api/data/validate/[employeenumber]",
  "description": "Function to validate employee using employee number",
  "tab": "examples",
  "examples": {
    "languages": [
      {
        "id": "6V94GpSrxi1ehiYAUT9yO",
        "language": "curl",
        "code": "",
        "customLabel": "Responses"
      }
    ],
    "selectedLanguageId": "6V94GpSrxi1ehiYAUT9yO"
  },
  "results": {
    "languages": [
      {
        "id": "1kXDjW1bsQybhVVCGoRt1",
        "language": "200",
        "customLabel": "",
        "code": "{ \n  \"employeedetails\" : \n  {\n    \"employeenumber\" : \"000000000123456\",\n    \"fullname\" : \"RICHARD AKZO\",\n    \"dateofbirth\" : \"1979-01-10\",\n    \"gender\" : \"M\",\n    \"votecode\" : \"563\",\n    \"votedescription\" : \"KOBOKO DISTRICT\",\n    \"employeetitle\" : \"Entomological Assistant\",\n    \"terms\" : \"Permanent Employee\",\n    \"lastupdated\" : \"2018-2\",\n    \"tel\" : \"0712999999\",\n    \"deductions\" : {\n      \"reservationnumber\" : \"1485652415\",\n      \"referencecode\" : \"866178\",\n      \"installmentamount\" : \"50000\",\n      \"loanamount\" : \"200000\",\n      \"startdate\" : \"2017-02-01\",\n      \"enddate\" : \"2019-03-01\",\n      \"deductiontype\" : \"458\",\n      \"companyname\" : \"JOPEG Financial Services\",\n      \"status\" : \"reserved\",\n    }\n    \"recurring_allowances\" : {\n      \"code\" : \"1510\",\n      \"amount\" : \"50000\",\n      \"payrolldate\" : \"2018-02-01\",\n      \"description\" : \"Lunch Allowance\"\n    }\n    \"statutory_deductions\" : {\n      \"code\" : \"249\",\n      \"deductionamount\" : \"63351\",\n      \"payrolldate\" : \"2018-02-01\",\n      \"description\" : \"PAYE\"\n    }\n    \"maximum_affordability\" : \"189432.76\",\n    \"alt_affordability\": null,\n    \"last_deduction_date\": null,\n    \"last_payment_amount\": null,\n    \"totalpaid\": null\n  }\n}"
      },
      {
        "id": "SpAIHfgE34yu2oK7IBO-i",
        "language": "404",
        "customLabel": "",
        "code": "{\n  \"status\" : \"false\",\n  \"message\": \"Employee could not be found\"\n}"
      }
    ],
    "selectedLanguageId": "1kXDjW1bsQybhVVCGoRt1"
  },
  "request": {
    "pathParameters": [],
    "queryParameters": [
      {
        "name": "Employee number",
        "kind": "required",
        "type": "string",
        "description": "15 digit string with leading zeros",
        "children": []
      }
    ],
    "headerParameters": [],
    "bodyDataParameters": [],
    "formDataParameters": []
  },
  "currentNewParameter": {
    "label": "Query Parameter",
    "value": "queryParameters"
  }
}
```
:::

:::ApiMethodV2
```json
{
  "name": "Make Reservation",
  "method": "GET",
  "url": "https:pcuganda.com/api/data/reservation/ [employeenumber]/ [referencecode]/ [installmentamount]/ [loanamount]/ [telephone]",
  "description": "Function to make a reservation on an employee",
  "tab": "examples",
  "examples": {
    "languages": [
      {
        "id": "6V94GpSrxi1ehiYAUT9yO",
        "language": "curl",
        "code": "",
        "customLabel": "Responses"
      }
    ],
    "selectedLanguageId": "6V94GpSrxi1ehiYAUT9yO"
  },
  "results": {
    "languages": [
      {
        "id": "1kXDjW1bsQybhVVCGoRt1",
        "language": "200",
        "customLabel": "",
        "code": "{\n  reservation_details : {\n    \"employeenumber\" : \"000000000123456\",\n    \"referencecode\" : \"jp001\",\n    \"installmentamount\" : \"50000\",\n    \"loanamount\" : \"600000\",\n    \"deductiontype\" : \"458\",\n    \"reservationnumber\" : \"25412415231\" \n  }\n}"
      },
      {
        "id": "SpAIHfgE34yu2oK7IBO-i",
        "language": "404",
        "customLabel": "",
        "code": "{\n  \"status\"  : \"false\",\n  \"message\" : \"Please enter all parameters\"\n}\nOR\n{\n  \"status\"  : \"false\",\n  \"message\" : \"Reservation/Deduction Already Exists\"\n}\nOR\n{\n  \"status\"  : \"false\",\n  \"message\" : \"The employee has no affordability\"\n}"
      }
    ],
    "selectedLanguageId": "1kXDjW1bsQybhVVCGoRt1"
  },
  "request": {
    "pathParameters": [],
    "queryParameters": [
      {
        "name": "employeenumber",
        "kind": "required",
        "type": "string",
        "description": "15 digit employee number with leading zeros",
        "children": []
      },
      {
        "name": "referencecode",
        "kind": "required",
        "type": "string",
        "description": "loan unique identifier",
        "children": []
      },
      {
        "name": "installmentamount",
        "kind": "required",
        "type": "Integer",
        "description": "",
        "children": []
      },
      {
        "name": "loanamount",
        "kind": "required",
        "type": "string",
        "description": "",
        "children": []
      },
      {
        "name": "telephone",
        "kind": "optional",
        "type": "string",
        "description": "employee's telephone number",
        "children": []
      }
    ],
    "headerParameters": [],
    "bodyDataParameters": [],
    "formDataParameters": []
  },
  "currentNewParameter": {
    "label": "Query Parameter",
    "value": "queryParameters"
  }
}
```
:::

:::ApiMethodV2
```json
{
  "name": "Get Reservations Pending Approval",
  "method": "GET",
  "url": "https:pcuganda.com/api/data/reservations_pending_approval",
  "description": "Function to show all reservations pending approval",
  "tab": "examples",
  "examples": {
    "languages": [
      {
        "id": "6V94GpSrxi1ehiYAUT9yO",
        "language": "curl",
        "code": "",
        "customLabel": "Responses"
      }
    ],
    "selectedLanguageId": "6V94GpSrxi1ehiYAUT9yO"
  },
  "results": {
    "languages": [
      {
        "id": "1kXDjW1bsQybhVVCGoRt1",
        "language": "200",
        "customLabel": "",
        "code": "{\n    \"pending_approval\": [\n        {\n            \"employeenumber\" : \"000000000123456\",\n            \"id\" : \"7754\",\n            \"reservationnumber\" : \"45215642\",\n            \"referencecode\" : \"jp001\",\n            \"installmentamount\" : \"50000\",\n            \"loanamout\" : \"600000\",\n            \"startdate\" : \"2017-02-01\",\n            \"enddate\" : \"2019-03-01\",\n            \"deductiontype\" : \"458\"\n        },\n        ...\n    ]\n}"
      }
    ],
    "selectedLanguageId": "1kXDjW1bsQybhVVCGoRt1"
  },
  "request": {
    "pathParameters": [],
    "queryParameters": [],
    "headerParameters": [],
    "bodyDataParameters": [],
    "formDataParameters": []
  },
  "currentNewParameter": {
    "label": "Form Parameter",
    "value": "formDataParameters"
  }
}
```
:::

:::ApiMethodV2
```json
{
  "name": "Submit Reservation for Approval",
  "method": "GET",
  "url": "https:pcuganda.com/api/data/submit_for_approval/ [deductionid]",
  "description": "Function to submit individual reservation for approval\nUse this function call after getting results from the “Get Reservations Pending Approval” function",
  "tab": "examples",
  "examples": {
    "languages": [
      {
        "id": "6V94GpSrxi1ehiYAUT9yO",
        "language": "curl",
        "code": "",
        "customLabel": "Responses"
      }
    ],
    "selectedLanguageId": "6V94GpSrxi1ehiYAUT9yO"
  },
  "results": {
    "languages": [
      {
        "id": "1kXDjW1bsQybhVVCGoRt1",
        "language": "200",
        "customLabel": "",
        "code": "{\n  \"status\" : \"true\",\n  \"message\": \"Reservation Submitted for Approval\"\n}"
      },
      {
        "id": "SpAIHfgE34yu2oK7IBO-i",
        "language": "404",
        "customLabel": "",
        "code": "{\n  \"status\" : \"false\",\n  \"message\": \"No reservation selected\"\n}"
      }
    ],
    "selectedLanguageId": "SpAIHfgE34yu2oK7IBO-i"
  },
  "request": {
    "pathParameters": [],
    "queryParameters": [
      {
        "name": "deductionid",
        "kind": "required",
        "type": "string",
        "description": "id for the reservation as retrieved from Get Reservations Pending Approval function",
        "children": []
      }
    ],
    "headerParameters": [],
    "bodyDataParameters": [],
    "formDataParameters": []
  },
  "currentNewParameter": {
    "label": "Query Parameter",
    "value": "queryParameters"
  }
}
```
:::

:::ApiMethodV2
```json
{
  "name": "Find Reservation",
  "method": "GET",
  "url": "https:pcuganda.com/api/data/find_reservation / [employeenumber]",
  "description": "Function to get details of institution reservation",
  "tab": "examples",
  "examples": {
    "languages": [
      {
        "id": "6V94GpSrxi1ehiYAUT9yO",
        "language": "curl",
        "code": "",
        "customLabel": "Responses"
      }
    ],
    "selectedLanguageId": "6V94GpSrxi1ehiYAUT9yO"
  },
  "results": {
    "languages": [
      {
        "id": "1kXDjW1bsQybhVVCGoRt1",
        "language": "200",
        "customLabel": "",
        "code": "{\n  \"employeenumber\" : \"000000000324516\",\n  \"reservations\": {\n    \"id\" : \"7754\",\n    \"reservationnumber\" : \"45215642\",\n    \"referencecode\" : \"jp001\",\n    \"installmentamount\" : \"50000\",\n    \"loanamout\" : \"600000\",\n    \"startdate\" : \"2017-02-01\",\n    \"enddate\" : \"2019-03-01\",\n    \"deductiontype\" : \"458\"\n  }\n}"
      },
      {
        "id": "SpAIHfgE34yu2oK7IBO-i",
        "language": "404",
        "customLabel": "",
        "code": "{\n  \"status\" : \"false\",\n  \"message\": \"Invalid Employee Number\"\n}\nOR\n{\n  \"status\" : \"false\",\n  \"message\": \"No Reservations Found\"\n}"
      }
    ],
    "selectedLanguageId": "1kXDjW1bsQybhVVCGoRt1"
  },
  "request": {
    "pathParameters": [],
    "queryParameters": [
      {
        "name": "employeenumber",
        "kind": "required",
        "type": "string",
        "description": "",
        "children": []
      }
    ],
    "headerParameters": [],
    "bodyDataParameters": [],
    "formDataParameters": []
  },
  "currentNewParameter": {
    "label": "Query Parameter",
    "value": "queryParameters"
  }
}
```
:::

:::ApiMethodV2
```json
{
  "name": "Cancel Reservation",
  "method": "GET",
  "url": "https:pcuganda.com/api/data/cancel_reservation / [employeenumber]",
  "description": "Function to get cancel running reservation",
  "tab": "examples",
  "examples": {
    "languages": [
      {
        "id": "6V94GpSrxi1ehiYAUT9yO",
        "language": "curl",
        "code": "",
        "customLabel": "Responses"
      }
    ],
    "selectedLanguageId": "6V94GpSrxi1ehiYAUT9yO"
  },
  "results": {
    "languages": [
      {
        "id": "1kXDjW1bsQybhVVCGoRt1",
        "language": "200",
        "customLabel": "",
        "code": "{\n   \"status\" : \"true\",\n   \"message\" : \"Reservation Cancelled\"\n}"
      },
      {
        "id": "SpAIHfgE34yu2oK7IBO-i",
        "language": "404",
        "customLabel": "",
        "code": "{\n  \"status\" : \"false\",\n  \"message\": \"Invalid Employee Number\"\n}\nOR\n{\n  \"status\" : \"false\",\n  \"message\": \"No Reservations Found\"\n}"
      }
    ],
    "selectedLanguageId": "1kXDjW1bsQybhVVCGoRt1"
  },
  "request": {
    "pathParameters": [],
    "queryParameters": [
      {
        "name": "employeenumber",
        "kind": "required",
        "type": "String",
        "description": "15 digit string with trailing zeros eg 000000000123456",
        "children": []
      }
    ],
    "headerParameters": [],
    "bodyDataParameters": [],
    "formDataParameters": []
  },
  "currentNewParameter": {
    "label": "Query Parameter",
    "value": "queryParameters"
  }
}
```
:::

:::ApiMethodV2
```json
{
  "name": "Reports",
  "method": "GET",
  "url": "https:pcuganda.com/api/data/report /[startdate]/[enddate]/[status]",
  "description": "Function to retrieve different reports on the PDMS",
  "tab": "examples",
  "examples": {
    "languages": [
      {
        "id": "6V94GpSrxi1ehiYAUT9yO",
        "language": "curl",
        "code": "",
        "customLabel": "Responses"
      }
    ],
    "selectedLanguageId": "6V94GpSrxi1ehiYAUT9yO"
  },
  "results": {
    "languages": [
      {
        "id": "1kXDjW1bsQybhVVCGoRt1",
        "language": "200",
        "customLabel": "",
        "code": "{\n   \"deductions\" : {\n     \"reservationnumber\" : \"45215642\",\n     \"referencecode\" : \"jp001\",\n     \"installmentamount\" : \"50000\",\n     \"loanamout\" : \"600000\", \n     \"deductionstart\" : \"2017-02-01\", \n     \"deductionend\" : \"2019-03-01\", \n     \"status\" : \"reserved\",\n     \"firstname\" : \"MOSES ARIHO\", \n     \"employeenumber\" : \"000000000635467\",\n     \"votedesc\" : \"STATE HOUSE\"\n   }\n}"
      }
    ],
    "selectedLanguageId": "1kXDjW1bsQybhVVCGoRt1"
  },
  "request": {
    "pathParameters": [],
    "queryParameters": [
      {
        "name": "startdate",
        "kind": "required",
        "type": "String",
        "description": "date format is YYYY-MM-DD eg 2017-12-01",
        "children": []
      },
      {
        "name": "enddate",
        "kind": "required",
        "type": "string",
        "description": "date format is YYYY-MM-DD eg 2017-12-01",
        "children": []
      },
      {
        "name": "status",
        "kind": "required",
        "type": "string",
        "description": "STATUS CODES: reserved, takenup, cancelled, stopped, rejected, topups_rejected, expired, Pending, topup_pending, Approve, approved_topups",
        "children": []
      }
    ],
    "headerParameters": [],
    "bodyDataParameters": [],
    "formDataParameters": []
  },
  "currentNewParameter": {
    "label": "Query Parameter",
    "value": "queryParameters"
  }
}
```
:::

:::ApiMethodV2
```json
{
  "name": "Find Deduction",
  "method": "GET",
  "url": "https:pcuganda.com/api/data/find_deduction/[employeenumber]",
  "description": "Function to find deduction details",
  "tab": "examples",
  "examples": {
    "languages": [
      {
        "id": "6V94GpSrxi1ehiYAUT9yO",
        "language": "curl",
        "code": "",
        "customLabel": "Responses"
      }
    ],
    "selectedLanguageId": "6V94GpSrxi1ehiYAUT9yO"
  },
  "results": {
    "languages": [
      {
        "id": "1kXDjW1bsQybhVVCGoRt1",
        "language": "200",
        "customLabel": "",
        "code": "{\n   \"employeenumber\" : \"000000000324516\",\n   \"fullname\" : \"MOSES ARIHO\",\n   \"department\" : \"LOCAL GOVERNMENT\",\n   \"deduction\" : {\n     \"id\" : \"7754\",\n     \"reservationnumber\" : \"45215642\",\n     \"referencecode\" : \"jp001\",\n     \"installmentamount\" : \"50000\",\n     \"loanamout\" : \"600000\",\n     \"borrowedamount\" : \"600000\",\n     \"startdate\" : \"2017-02-01\",\n     \"enddate\" : \"2019-03-01\",\n     \"status\" : \"takenup\",\n     \"deductiontype\" : \"458\"\n   }\n}"
      },
      {
        "id": "PdTRkR-WePjM7voW3SMTg",
        "language": "404",
        "code": "{\n  \"status\" : \"false\",\n  \"message\" : \"Employee Number Not Found\"\n}\nOR\n{\n  \"status\" : \"false\",\n  \"message\": \"No deduction found\"\n}",
        "customLabel": ""
      }
    ],
    "selectedLanguageId": "1kXDjW1bsQybhVVCGoRt1"
  },
  "request": {
    "pathParameters": [],
    "queryParameters": [
      {
        "name": "employeenumber",
        "kind": "required",
        "type": "String",
        "description": "",
        "children": []
      }
    ],
    "headerParameters": [],
    "bodyDataParameters": [],
    "formDataParameters": []
  },
  "currentNewParameter": {
    "label": "Query Parameter",
    "value": "queryParameters"
  }
}
```
:::

:::ApiMethodV2
```json
{
  "name": "Stop Deduction",
  "method": "GET",
  "url": "https:pcuganda.com/api/data/stop_deduction / [employeenumber]",
  "description": "Function to stop active deduction",
  "tab": "examples",
  "examples": {
    "languages": [
      {
        "id": "6V94GpSrxi1ehiYAUT9yO",
        "language": "curl",
        "code": "",
        "customLabel": "Responses"
      }
    ],
    "selectedLanguageId": "6V94GpSrxi1ehiYAUT9yO"
  },
  "results": {
    "languages": [
      {
        "id": "1kXDjW1bsQybhVVCGoRt1",
        "language": "200",
        "customLabel": "",
        "code": "{\n   \"status\" : \"true\",\n   \"message\" : \"Deduction Stopped\"\n}"
      },
      {
        "id": "PdTRkR-WePjM7voW3SMTg",
        "language": "404",
        "code": "{\n  \"status\" : \"false\",\n  \"message\" : \"Employee Number Not Found\"\n}\nOR\n{\n  \"status\" : \"false\",\n  \"message\": \"No deduction found\"\n}",
        "customLabel": ""
      }
    ],
    "selectedLanguageId": "1kXDjW1bsQybhVVCGoRt1"
  },
  "request": {
    "pathParameters": [],
    "queryParameters": [
      {
        "name": "employeenumber",
        "kind": "required",
        "type": "String",
        "description": "",
        "children": []
      }
    ],
    "headerParameters": [],
    "bodyDataParameters": [],
    "formDataParameters": []
  },
  "currentNewParameter": {
    "label": "Query Parameter",
    "value": "queryParameters"
  }
}
```
:::

:::ApiMethodV2
```json
{
  "name": "Replace Deduction / Do Topup",
  "method": "GET",
  "url": "https:pcuganda.com/api/data/replace_deduction /[employeenumber]/[installmentamount]/[loanamount]",
  "description": "Function to top up active deduction",
  "tab": "examples",
  "examples": {
    "languages": [
      {
        "id": "6V94GpSrxi1ehiYAUT9yO",
        "language": "curl",
        "code": "",
        "customLabel": "Responses"
      }
    ],
    "selectedLanguageId": "6V94GpSrxi1ehiYAUT9yO"
  },
  "results": {
    "languages": [
      {
        "id": "1kXDjW1bsQybhVVCGoRt1",
        "language": "200",
        "customLabel": "",
        "code": "{\n   \"status\" : \"true\",\n   \"message\" : \"Topup Reservation Done\"\n}"
      },
      {
        "id": "PdTRkR-WePjM7voW3SMTg",
        "language": "404",
        "code": "{\n  \"status\" : \"false\",\n  \"message\" : \"Employee Number Not Found\"\n}\nOR\n{\n  \"status\" : \"false\",\n  \"message\": \"No deduction found\"\n}\nOR\n{\n  \"status\" : \"false\",\n  \"message\": \"Reservation Not Affordable\"\n}",
        "customLabel": ""
      }
    ],
    "selectedLanguageId": "1kXDjW1bsQybhVVCGoRt1"
  },
  "request": {
    "pathParameters": [],
    "queryParameters": [
      {
        "name": "employeenumber",
        "kind": "required",
        "type": "String",
        "description": "",
        "children": []
      },
      {
        "name": "installmentamount",
        "kind": "required",
        "type": "string",
        "description": "",
        "children": []
      },
      {
        "name": "loanamount",
        "kind": "required",
        "type": "string",
        "description": "",
        "children": []
      }
    ],
    "headerParameters": [],
    "bodyDataParameters": [],
    "formDataParameters": []
  },
  "currentNewParameter": {
    "label": "Query Parameter",
    "value": "queryParameters"
  }
}
```
:::

:::ApiMethodV2
```json
{
  "name": "Find Topup Reservation",
  "method": "GET",
  "url": "https:pcuganda.com/api/data/find_topup_reservation /[employeenumber]",
  "description": "Function to retrieve topup reservation details",
  "tab": "examples",
  "examples": {
    "languages": [
      {
        "id": "6V94GpSrxi1ehiYAUT9yO",
        "language": "curl",
        "code": "",
        "customLabel": "Responses"
      }
    ],
    "selectedLanguageId": "6V94GpSrxi1ehiYAUT9yO"
  },
  "results": {
    "languages": [
      {
        "id": "1kXDjW1bsQybhVVCGoRt1",
        "language": "200",
        "customLabel": "",
        "code": "{\n   \"reservation_list\": [\n     {\n       \"id\" : \"7754\",\n       \"reservationnumber\" : \"45215642\",\n       \"referencecode\" : \"jp001\",\n       \"installmentamount\" : \"50000\",\n       \"loanamout\" : \"600000\",\n       \"deductionstart\" : \"2017-02-01\",\n       \"deductionend\" : \"2019-03-01\",\n       \"status\" : \"Topup Reserved\",\n       \"firstname\" : \"MOSES ARIHO\",\n       \"employeenumber\" : \"000000000783645\",\n       \"votedesc\" : \"KOBOKO DISTRICT\",\n     },\n   ]\n}"
      },
      {
        "id": "PdTRkR-WePjM7voW3SMTg",
        "language": "404",
        "code": "{\n  \"status\" : \"false\",\n  \"message\" : \"No Topup Reservation Found\"\n}",
        "customLabel": ""
      }
    ],
    "selectedLanguageId": "PdTRkR-WePjM7voW3SMTg"
  },
  "request": {
    "pathParameters": [],
    "queryParameters": [
      {
        "name": "employeenumber",
        "kind": "required",
        "type": "String",
        "description": "",
        "children": []
      }
    ],
    "headerParameters": [],
    "bodyDataParameters": [],
    "formDataParameters": []
  },
  "currentNewParameter": {
    "label": "Query Parameter",
    "value": "queryParameters"
  }
}
```
:::

:::ApiMethodV2
```json
{
  "name": "Cancel Topup Reservation",
  "method": "GET",
  "url": "https:pcuganda.com/api/data/cancel_topup_reservation/ [employeenumber]",
  "description": "Function to cancel active topup reservation",
  "tab": "examples",
  "examples": {
    "languages": [
      {
        "id": "6V94GpSrxi1ehiYAUT9yO",
        "language": "curl",
        "code": "",
        "customLabel": "Responses"
      }
    ],
    "selectedLanguageId": "6V94GpSrxi1ehiYAUT9yO"
  },
  "results": {
    "languages": [
      {
        "id": "1kXDjW1bsQybhVVCGoRt1",
        "language": "200",
        "customLabel": "",
        "code": "{\n   \"status\" : \"true\",\n   \"message\" : \"Topup Reservation Cancelled\"\n}"
      },
      {
        "id": "PdTRkR-WePjM7voW3SMTg",
        "language": "404",
        "code": "{\n  \"status\" : \"false\",\n  \"message\" : \"No Topup Reservation Found\"\n}",
        "customLabel": ""
      }
    ],
    "selectedLanguageId": "1kXDjW1bsQybhVVCGoRt1"
  },
  "request": {
    "pathParameters": [],
    "queryParameters": [
      {
        "name": "employeenumber",
        "kind": "required",
        "type": "String",
        "description": "",
        "children": []
      }
    ],
    "headerParameters": [],
    "bodyDataParameters": [],
    "formDataParameters": []
  },
  "currentNewParameter": {
    "label": "Query Parameter",
    "value": "queryParameters"
  }
}
```
:::

:::ApiMethodV2
```json
{
  "name": "Get Topup Reservations Pending Approval",
  "method": "GET",
  "url": "https:pcuganda.com/api/data/topup_reservations_pending_approval",
  "description": "Function to show records of topup reservations pending approval",
  "tab": "examples",
  "examples": {
    "languages": [
      {
        "id": "6V94GpSrxi1ehiYAUT9yO",
        "language": "curl",
        "code": "",
        "customLabel": "Responses"
      }
    ],
    "selectedLanguageId": "6V94GpSrxi1ehiYAUT9yO"
  },
  "results": {
    "languages": [
      {
        "id": "1kXDjW1bsQybhVVCGoRt1",
        "language": "200",
        "customLabel": "",
        "code": "{\n   \"pending_approval\" : [\n     {\n       \"employeenumber\" : \"000000000123456\",\n       \"firstname\" : \"MOSES ARIHO\",\n       \"deductionid\" : \"7754\",\n       \"reservationnumber\" : \"45215642\",\n       \"referencecode\" : \"jp001\",\n       \"installmentamount\" : \"50000\",\n       \"loanamout\" : \"600000\",\n       \"startdate\" : \"2017-02-01\",\n       \"enddate\" : \"2019-03-01\",\n       \"deductiontype\" : \"458\"\n     }\n   ]\n}"
      }
    ],
    "selectedLanguageId": "1kXDjW1bsQybhVVCGoRt1"
  },
  "request": {
    "pathParameters": [],
    "queryParameters": [],
    "headerParameters": [],
    "bodyDataParameters": [],
    "formDataParameters": []
  },
  "currentNewParameter": {
    "label": "Query Parameter",
    "value": "queryParameters"
  }
}
```
:::

:::ApiMethodV2
```json
{
  "name": "Submit Topup Reservation for Approval",
  "method": "GET",
  "url": "https:pcuganda.com/api/data/submit_topup_for_approval/ [deductionid]",
  "description": "Function to submit topup reservations for approval",
  "tab": "examples",
  "examples": {
    "languages": [
      {
        "id": "6V94GpSrxi1ehiYAUT9yO",
        "language": "curl",
        "code": "",
        "customLabel": "Responses"
      }
    ],
    "selectedLanguageId": "6V94GpSrxi1ehiYAUT9yO"
  },
  "results": {
    "languages": [
      {
        "id": "1kXDjW1bsQybhVVCGoRt1",
        "language": "200",
        "customLabel": "",
        "code": "{\n   \"status\" : \"true\",\n   \"message\": \"Topup Reservation Submitted for Approval\"\n}"
      },
      {
        "id": "Xks08BLgEbUwJSVunELGb",
        "language": "404",
        "code": "{\n   \"status\" : \"false\",\n   \"message\": \"No reservation selected\"\n}",
        "customLabel": ""
      }
    ],
    "selectedLanguageId": "1kXDjW1bsQybhVVCGoRt1"
  },
  "request": {
    "pathParameters": [],
    "queryParameters": [
      {
        "name": "deductionid",
        "kind": "required",
        "type": "string",
        "description": "id for the deduction got from Get Topup Reservations Pending Approval function",
        "children": []
      }
    ],
    "headerParameters": [],
    "bodyDataParameters": [],
    "formDataParameters": []
  },
  "currentNewParameter": {
    "label": "Query Parameter",
    "value": "queryParameters"
  }
}
```
:::

:::ApiMethodV2
```json
{
  "name": "Update Deduction Balance",
  "method": "GET",
  "url": "https:pcuganda.com/api/data/update_balance/ [employeenumber]/[loanamount]",
  "description": "Function to update loan balance",
  "tab": "examples",
  "examples": {
    "languages": [
      {
        "id": "6V94GpSrxi1ehiYAUT9yO",
        "language": "curl",
        "code": "",
        "customLabel": "Responses"
      }
    ],
    "selectedLanguageId": "6V94GpSrxi1ehiYAUT9yO"
  },
  "results": {
    "languages": [
      {
        "id": "1kXDjW1bsQybhVVCGoRt1",
        "language": "200",
        "customLabel": "",
        "code": "{\n   \"status\" : \"true\",\n   \"message\": \"Deduction Balance Updated\"\n}"
      },
      {
        "id": "Xks08BLgEbUwJSVunELGb",
        "language": "404",
        "code": "{\n   \"status\" : \"false\",\n   \"message\": \"Employee Number Not Found\"\n}\nOR\n{\n  \"status\" : \"false\",\n   \"message\": \"No deduction found\"\n}",
        "customLabel": ""
      }
    ],
    "selectedLanguageId": "Xks08BLgEbUwJSVunELGb"
  },
  "request": {
    "pathParameters": [],
    "queryParameters": [
      {
        "name": "employeenumber",
        "kind": "required",
        "type": "string",
        "description": "",
        "children": []
      },
      {
        "name": "loanamount",
        "kind": "required",
        "type": "string",
        "description": "new balance to update",
        "children": []
      }
    ],
    "headerParameters": [],
    "bodyDataParameters": [],
    "formDataParameters": []
  },
  "currentNewParameter": {
    "label": "Query Parameter",
    "value": "queryParameters"
  }
}
```
:::

***

:::hint{type="warning"}
**PLEASE NOTE :**
The quota for the API calls is 1 call per second.
:::

***

:::ExpandableHeading{isOpen="true"}
## Connection to the API

Use the example below to connect to the PCA API. The example was written in PHP.

```php
<?php
  $curl_header = array();
  $key = '*************';    //API Key provided by PCA
  $dedtype = '***';          //Institution Deduction Code Provided by PCA
  $companycode = '***';      //Company Code Provided by PCA
  $username = '***********'; //Username credentials for API user configured by PCA
  $password = '***********'; //Password for API user configured by PCA
  
  $curl_header = [
                  'apikey:'.$key,
                  'dedtype:'.$dedtype,
                  'companycode:'.$companycode,
                  'username:'.$username,
                  'password:'.$password
                 ];
   //change the url depending on the api to call and add the required values
   $url = "https://sandbox.pcuganda.com/api/data/validate/000000000123456";
   
   $ch = curl_init();
   curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE);
   curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 2);
   curl_setopt($ch, CURLOPT_URL, $url);
   curl_setopt($ch, CURLOPT_HTTPHEADER, $curl_header);
   
   $result = curl_exec($ch);
   if($result === FALSE){
     echo "cURL Error: ".$curl_error($ch);
   }
   
   curl_close($ch);
?>
```
:::

