Microkeeper

https://microkeeper.com.au/guides.php
Admin
Microkeeper is a comprehensive end-to-end employee management and payroll system for Australian...
Tokens:77,868
Snippets:696
Trust Score:9.3
Update:6 months ago
Show doc for...
Tokens:
Raw
### Successful Payrun Response Example

Source: https://microkeeper.com.au/guides.php?guide=api-payroll-add-get-process

An example of a successful API response for a payrun, including detailed payslip information and leave accrual.

```APIDOC
## Successful Payrun Response Example

### Description
This is a sample of a successful API response for a payrun, detailing run data, payslip information, and leave accrual for employees.

### Method
GET (Assumed, as it's a response example)

### Endpoint
`/api/payruns/{id}` (Assumed)

### Response
#### Success Response (200)
- **success** (string) - Indicates if the operation was successful ('1' for success).
- **authenticated** (string) - Indicates if the user is authenticated ('1' for authenticated).
- **message** (string) - A message describing the response.
- **data** (object) - Contains the main payrun and payslip data.
  - **runs** (array) - An array of payrun runs.
    - **run_data** (object) - Details about the payrun run.
    - **payslips** (array) - An array of payslips for the run.
      - **leave_accrual** (object) - Leave accrual details for the employee.
        - **al** (object) - Annual Leave details.
          - **accrual_amount** (string) - Amount accrued in this payrun.
          - **accrual_bal** (string) - Running balance of accrued leave.
        - **sick** (object) - Sick Leave details.
          - **accrual_amount** (string) - Amount accrued in this payrun.
          - **accrual_bal** (string) - Running balance of accrued leave.
        - **rdo** (object) - RDO (Rostered Day Off) details.
          - **accrual_amount** (string) - Amount accrued in this payrun.
          - **accrual_bal** (string) - Running balance of accrued leave.

### Response Example
```json
{
  "success": "1",
  "authenticated": "1",
  "message": "Payrun data",
  "data": {
    "runs": [
      {
        "run_data": {
          "pay_cycle_title": "Casuals",
          "abn": "95149280320",
          "abn_name": "ABN Engineering PTY LTD",
          "abn_trading": "ABN Engineering",
          "PCID": "0",
          "year": "2018",
          "run_id": "5",
          "payment_date": "2018-12-20",
          "wip": "2",
          "period": "fortnightly",
          "day": "wednesday",
          "unlocked": "1",
          "period_start": "2018-07-18",
          "period_end": "2018-07-31"
        },
        "payslips": [
          {
            "eusername": "john_smith",
            "payment": "234.88",
            "expense": "170.38",
            "taxable": "64.50",
            "deduction": "10.00",
            "tax": "13.00",
            "net": "41.50",
            "hours": 12,
            "annual": "134.458",
            "sick": "205.867",
            "rdo": 0,
            "lsl": "151.88",
            "annual_gross": "3000.00",
            "annual_net": "2216.08",
            "annual_tax": "2.00",
            "EID": "3",
            "EmployeeID": "ABC123",
            "super_fund": "482",
            "super_no": "987654321",
            "pay_list": [
              {
                "ESBDID": "100001",
                "note": "Basic Job A",
                "date": "2021-12-20",
                "LID": "856",
                "ROID": "521",
                "JID": "907",
                "rate": "20.5",
                "hours": "9",
                "mult": "1",
                "value": "184.50",
                "class": "FALSE",
                "STP": ""
              },
              {
                "ESBDID": "100002",
                "note": "Fixed extra",
                "date": "2021-12-20",
                "LID": "856",
                "ROID": "521",
                "JID": "909",
                "rate": "10",
                "hours": "3",
                "mult": "1",
                "value": "30.00",
                "class": "TRUE",
                "STP": ""
              },
              {
                "ESBDID": "100003",
                "note": "Super Exclusive-Job C",
                "date": "2021-12-20",
                "LID": "856",
                "ROID": "521",
                "JID": "909",
                "rate": "9.5",
                "hours": "0",
                "mult": "0",
                "value": "20.38",
                "class": "SUPER",
                "STP": ""
              }
            ],
            "exp_list": [
              {
                "ESNTDID": "1001",
                "note": "Salary Sac",
                "rate": "75.000",
                "mult": "2.00",
                "value": "150.00",
                "class": "SUPER"
              },
              {
                "ESNTDID": "1002",
                "note": "Super-Job C",
                "rate": "9.500",
                "mult": "1.00",
                "value": "20.38",
                "class": "SUPER3"
              }
            ],
            "ded_list": [
              {
                "ESDID": "101",
                "note": "Test",
                "rate": "10.000",
                "mult": "1.00",
                "value": "10.00",
                "class": "FEES"
              }
            ],
            "leave_accrual": {
              "al": {
                "accrual_amount": "2.932",
                "accrual_bal": "25"
              },
              "sick": {
                "accrual_amount": "1.556",
                "accrual_bal": "10"
              },
              "rdo": {
                "accrual_amount": "0",
                "accrual_bal": "40"
              }
            }
          }
        ]
      }
    ]
  },
  "super_fund_detail": {
    "482": {
      "name": "REST",
      "ABN": "62653671394",
      "USI": "RES0103AU",
      "open": "1"
    }
  }
}
```
```

--------------------------------

### Upsert Employees via API (PHP Example)

Source: https://microkeeper.com.au/guides.php?guide=api-add-employee-payroll

This snippet demonstrates how to prepare and send data to the Microkeeper API to upsert employee information. It involves setting the action and data variables, with the data formatted as a JSON string. The example assumes a PHP environment and requires prior completion of the 'Hello World' tutorial for API authentication.

```php
<?php

// Ensure you have completed the Hello World tutorial for API authentication.

// Set the action for the API call
$mk_action = 'upsert_employees';

// Prepare the data payload for employees
$mk_data = json_encode([
    "Employees" => [
        [
            "EmployeeID" => "emp_001",
            "firstname" => "John",
            "lastname" => "Smith",
            "email" => "john@example.com",
            "phoneno" => "0400123456",
            "super_fund" => "RES0103AU",
            "welcome" => "email"
        ]
    ]
]);

// In a real scenario, you would then make an API request using these variables.
// For example, using cURL or a similar HTTP client:
/*
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'YOUR_API_ENDPOINT'); // Replace with your actual API endpoint
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query(['mk_action' => $mk_action, 'mk_data' => $mk_data]));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$server_output = curl_exec($ch);
curl_close($ch);

// Process $server_output
*/

echo "mk_action: " . $mk_action . "\n";
echo "mk_data: " . $mk_data . "\n";

?>

```

--------------------------------

### Successful Payrun Response Example

Source: https://microkeeper.com.au/guides.php?guide=api-payroll-add-get-process

A sample JSON response for a successful payrun query. It includes run metadata, detailed payslip information for employees, and associated superannuation fund details.

```json
{
  "success": "1",
  "authenticated": "1",
  "message": "Payrun data",
  "data": {
    "runs": [
      {
        "run_data": {
          "pay_cycle_title": "Casuals",
          "abn": "95149280320",
          "abn_name": "ABN Engineering PTY LTD",
          "abn_trading": "ABN Engineering",
          "PCID": "0",
          "year": "2018",
          "run_id": "5",
          "payment_date": "2018-12-20",
          "wip": "2",
          "period": "fortnightly",
          "day": "wednesday",
          "unlocked": "1",
          "period_start": "2018-07-18",
          "period_end": "2018-07-31"
        },
        "payslips": [
          {
            "eusername": "john_smith",
            "payment": "234.88",
            "expense": "170.38",
            "taxable": "64.50",
            "deduction": "10.00",
            "tax": "13.00",
            "net": "41.50",
            "hours": 12,
            "annual": "134.458",
            "sick": "205.867",
            "rdo": 0,
            "lsl": "151.88",
            "annual_gross": "3000.00",
            "annual_net": "2216.08",
            "annual_tax": "2.00",
            "EID": "3",
            "EmployeeID": "ABC123",
            "super_fund": "482",
            "super_no": "987654321",
            "pay_list": [
              {
                "ESBDID": "100001",
                "note": "Basic Job A",
                "date": "2021-12-20",
                "LID": "856",
                "ROID": "521",
                "JID": "907",
                "rate": "20.5",
                "hours": "9",
                "mult": "1",
                "value": "184.50",
                "class": "FALSE",
                "STP": ""
              }
            ],
            "leave_accrual": {
              "al": {
                "accrual_amount": "2.932",
                "accrual_bal": "25"
              }
            }
          }
        ]
      }
    ]
  }
}
```

--------------------------------

### API Payroll Processing

Source: https://microkeeper.com.au/guides.php?guide=api-payroll-add-get-process

This guide explains how to process payroll via API, including adding payments, expenses, and deductions.

```APIDOC
## POST /api/payroll

### Description
Processes payroll, allowing for the addition of payments, expenses, and deductions.

### Method
POST

### Endpoint
/api/payroll

### Parameters
#### Request Body
- **employee_id** (integer) - Required - The ID of the employee for whom payroll is being processed.
- **payments** (array) - Optional - A list of payments to be added.
  - **type** (string) - Required - The type of payment (e.g., 'salary', 'bonus').
  - **amount** (float) - Required - The amount of the payment.
- **expenses** (array) - Optional - A list of expenses to be added.
  - **type** (string) - Required - The type of expense (e.g., 'travel', 'uniform').
  - **amount** (float) - Required - The amount of the expense.
- **deductions** (array) - Optional - A list of deductions to be made.
  - **type** (string) - Required - The type of deduction (e.g., 'tax', 'loan').
  - **amount** (float) - Required - The amount of the deduction.

### Request Example
```json
{
  "employee_id": 123,
  "payments": [
    {
      "type": "salary",
      "amount": 5000.00
    }
  ],
  "expenses": [
    {
      "type": "travel",
      "amount": 50.00
    }
  ],
  "deductions": [
    {
      "type": "tax",
      "amount": 1000.00
    }
  ]
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the success of the payroll processing.
- **message** (string) - A message detailing the outcome of the process.

#### Response Example
```json
{
  "status": "success",
  "message": "Payroll processed successfully for employee ID 123."
}
```
```

--------------------------------

### API Successful Response Format

Source: https://microkeeper.com.au/guides.php?guide=api-payroll-add-get-process

Example of a successful JSON response returned after processing a payrun, including calculation duration and totals for payments, expenses, and deductions.

```json
{ "success":"1", "authenticated":"1", "message":"Payrun processed", "data": {"calculation_duration":0.31,"total":{"payment":718.37,"expense":20,"deduction":5}} }
```

--------------------------------

### Define Super Fund Detail Object

Source: https://microkeeper.com.au/guides.php?guide=api-payroll-add-get-process

Example structure of a super_fund_detail object returned by the API, showing key-value mapping for fund identification and metadata.

```json
{
  "482": {
    "name": "REST",
    "ABN": "62653671394",
    "USI": "RES0103AU",
    "open": "1"
  }
}
```

--------------------------------

### Retrieve Specific Jobs by JobID API Call (JSON)

Source: https://microkeeper.com.au/guides.php?guide=api-get-update-job

Example of how to retrieve specific jobs by their third-party IDs (JobIDs) using the 'get_jobs' action. The 'status' is set to 'JobID' and a list of JobIDs is provided.

```json
{
  "status":"JobID",
  "JobID":["ABC5","ABC3"]
}
```

--------------------------------

### Payroll Data Retrieval Request Parameters

Source: https://microkeeper.com.au/guides.php?guide=api-payroll-add-get-process

Examples of how to structure the mk_data variable for different payroll retrieval scenarios, including date ranges, specific payrun IDs, and employee filtering.

```json
{"start_date":"2018-05-21", "end_date":"2018-05-21"}
```

```json
{"payrun_id":[{"year":2018,"run_id":48},{"year":2018,"run_id":49}],"EmployeeID":[111]}
```

```json
{"start_date":"2018-07-01","end_date":"2019-06-30", "eusername":["john_smith"],"EmployeeID":[111,222,333],"EID":[3,4,6]}
```

--------------------------------

### Retrieve Specific Jobs by JID API Call (JSON)

Source: https://microkeeper.com.au/guides.php?guide=api-get-update-job

Example of how to retrieve specific jobs by their Microkeeper IDs (JIDs) using the 'get_jobs' action. The 'status' is set to 'JID' and a list of JIDs is provided.

```json
{
  "status":"JID",
  "JID":["8557","8556"]
}
```

--------------------------------

### POST /api_post.php - Hello World Example

Source: https://microkeeper.com.au/guides.php?guide=api-integration

This snippet demonstrates how to make a 'Hello World' request to the Microkeeper API using PHP. It includes setting up the necessary variables like business key, developer key, action, and data, then sending the POST request via cURL.

```APIDOC
## POST /api_post.php

### Description
This endpoint is used to post data to the Microkeeper API for various actions, including a 'hello_world' example.

### Method
POST

### Endpoint
https://microkeeper.com.au/api_post.php

### Parameters
#### Request Body
- **mk_biz_key** (string) - Required - Used to identify which Microkeeper account to access. Each business has a unique key.
- **mk_dev_key** (string) - Required - Identifies the software provider. Stored server side and never displayed to the user.
- **mk_action** (string) - Required - Specifies the action to be performed (e.g., 'hello_world').
- **mk_data** (JSON string) - Required - The data payload for the action. Requirements vary based on `mk_action`.

### Request Example
```json
{
  "mk_biz_key": "1o7ayfmp092rmkrds7et7s3e3cnq3wqr",
  "mk_dev_key": "YOUR_DEVELOPER_KEY",
  "mk_action": "hello_world",
  "mk_data": "{\"hello\":\"world\"}"
}
```

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the transaction was successful.
- **authenticated** (boolean) - Indicates if the user passed authentication.
- **message** (string) - Message from Microkeeper (success or error).
- **data** (JSON) - Optional - Send data back to your API.

#### Response Example
```json
{
  "success": "1",
  "authenticated": "1",
  "message": "Hello World! Accessed: frogga"
}
```
```

--------------------------------

### GET /jobs

Source: https://microkeeper.com.au/guides.php?guide=api-get-update-job

Retrieves a list of jobs currently recorded in the Microkeeper system.

```APIDOC
## GET /jobs

### Description
Retrieves a list of all jobs stored in Microkeeper, including their unique identifiers, client associations, titles, date ranges, access permissions, and status.

### Method
GET

### Endpoint
/jobs

### Parameters
None

### Response
#### Success Response (200)
- **success** (string) - Indicates if the request was successful (1).
- **authenticated** (string) - Indicates if the session is authenticated (1).
- **message** (string) - Status message.
- **data** (object) - Contains the list of jobs.

#### Response Example
{
  "success": "1",
  "authenticated": "1",
  "message": "Job data",
  "data": {
    "jobs": [
      {
        "JID": "2588",
        "CID": "0",
        "title": "Job 1",
        "startdate": "2018-10-25",
        "enddate": "2018-11-25",
        "job_access": "0",
        "status": "Active"
      }
    ]
  }
}
```

--------------------------------

### PHP Hello World API Call to Microkeeper

Source: https://microkeeper.com.au/guides.php?guide=api-integration

This PHP script demonstrates how to make a 'Hello World' request to the Microkeeper API. It sets up the necessary API keys and data, then uses cURL to send the POST request and receive the JSON response. Ensure your $mk_dev_key is set correctly and stored securely server-side.

```PHP
////////////////////////////////
//CONFIG
///////////////////////////////
$mk_dev_key='';//Set this value once to identify your software

$post_data['mk_biz_key']='1o7ayfmp092rmkrds7et7s3e3cnq3wqr';//Dynamically set this depending on which user you want to access
$post_data['mk_dev_key']=$mk_dev_key;
$post_data['mk_action']='hello_world';//Set this depending on what data you want to access
$post_data['mk_data']='{"hello":"world"}';//JSON data being sent

//Traverse array and prepare data for posting (key1=value1)
foreach($post_data as $key => $value)
{
    $post_items[]=$key.'='.$value;
}

//Create the final string to be posted using implode()
$post_string=implode('&', $post_items);

//URL to hit server with NOTE HTTPS!
$curl_connection=curl_init('https://microkeeper.com.au/api_post.php');

//Setup CURL
curl_setopt($curl_connection, CURLOPT_CONNECTTIMEOUT,30);
curl_setopt($curl_connection, CURLOPT_USERAGENT,"Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1)");
curl_setopt($curl_connection, CURLOPT_RETURNTRANSFER,true);
curl_setopt($curl_connection, CURLOPT_SSL_VERIFYPEER,false);
curl_setopt($curl_connection, CURLOPT_FOLLOWLOCATION,1);

curl_setopt($curl_connection, CURLOPT_POSTFIELDS, $post_string);//set data to be posted
$result=json_decode(curl_exec($curl_connection),true);//perform our request
curl_close($curl_connection);//close the connection

//output the response
?><pre><?php print_r($result);?></pre><?php
```

--------------------------------

### GET /api/skills

Source: https://microkeeper.com.au/guides.php?guide=api-get-add-skill

Retrieves a list of employee skills including their status, approval details, and expiry information.

```APIDOC
## GET /api/skills

### Description
Retrieves a collection of employee skills, including metadata such as skill titles, employee identifiers, approval status, and expiry dates.

### Method
GET

### Endpoint
/api/skills

### Response
#### Success Response (200)
- **SMID** (Integer) - Unique Skill ID
- **skill_title** (String) - Name of the skill
- **EID** (Integer) - Employee ID
- **EmployeeID** (String) - Third party employee ID
- **eusername** (String) - Employee username
- **employee_name** (String) - Full name of employee
- **accepted_by_employee** (String) - Employee acceptance status
- **approved_by** (String) - Username of approver
- **can_expire** (String) - Indicates if the skill can expire (0 or 1)
- **expiry_date** (String) - Date skill expires (YYYY-MM-DD)
- **signed_date** (String) - Date skill was signed (YYYY-MM-DD)
- **status** (String) - Current status of skill
- **number_of_files_attached** (Integer) - Count of attached files
- **response_value** (String) - Employee's response text

#### Response Example
{
  "success": "1",
  "authenticated": "1",
  "message": "Skill data present",
  "data": [
    {
      "SMID": "123",
      "skill_title": "First Aid",
      "EID": "456",
      "EmployeeID": "E456",
      "eusername": "john_smith",
      "employee_name": "John Smith",
      "accepted_by_employee": "Accepted",
      "approved_by": "jane_doe",
      "skill_expiry_date": "2024-12-31",
      "signed_date": "2024-01-01",
      "status": "Approved",
      "number_of_files_attached": 2,
      "response_value": "Completed first aid training"
    }
  ]
}
```

--------------------------------

### GET /employees

Source: https://microkeeper.com.au/guides.php?guide=api-add-employee-payroll

Retrieves a list of employees from Microkeeper, including their associated leave quotas and opening balances.

```APIDOC
## GET /employees

### Description
Retrieves a collection of employee records. The response includes personal details, superannuation funds, assigned groups, open balances, and leave quotas.

### Method
GET

### Endpoint
/employees

### Parameters
#### Query Parameters
- **filters** (string) - Optional - Filters to narrow down the employee list.

### Response
#### Success Response (200)
- **success** (string) - Status indicator (1 for success).
- **authenticated** (string) - Authentication status.
- **message** (string) - Summary of the operation.
- **data** (object) - Contains the employees array.

#### Response Example
{
  "success": "1",
  "authenticated": "1",
  "message": "2 staff retrieved from Microkeeper",
  "data": {
    "employees": [
      {
        "EID": "3",
        "EmployeeID": "emp_001",
        "firstname": "John",
        "lastname": "Smith",
        "open_balance": {
          "2024": { "al": 80, "sick": 16 }
        },
        "leave_quota": {
          "al": { "accrual_amount": 2.923, "payslip_hide": 0 }
        }
      }
    ]
  }
}
```

--------------------------------

### Configuration Variables

Source: https://microkeeper.com.au/guides.php?guide=api-payroll-add-get-process

Details the 'config' variables used for setting up pay periods and processing payroll.

```APIDOC
## Configuration Variables API

### Description
This section details the configuration variables used for setting up pay periods and processing payroll via the Microkeeper API. These variables control aspects like the pay period dates, payment dates, and how payroll runs are structured.

### Method
POST (Implied, as these are configuration parameters for a process)

### Endpoint
/api/configure_payroll (Hypothetical endpoint for configuration)

### Parameters
#### Request Body
- **start_date** (string) - Required - The start date of the pay period in YYYY-MM-DD format.
- **end_date** (string) - Required - The end date of the pay period in YYYY-MM-DD format. This date helps identify the specific pay run.
- **payment_date** (string) - Required - The date the payment will be made, in YYYY-MM-DD format. Used for fiscal year and superannuation calculations.
- **period** (string) - Required - Specifies the pay period frequency. Accepted options: "weekly", "fortnightly", "semi_monthly", "monthly".
- **runs_in_year** (boolean) - Optional - Indicates if there is an extra pay run in the fiscal year (e.g., 53 weeks). Accepts 0 (No) or 1 (Yes). Defaults to 0.
- **active_staff** (boolean) - Optional - Determines if all active staff should be included. Accepts 0 (Only staff receiving payments/deductions) or 1 (All staff). Defaults to 1.
- **run_unworked_ph** (boolean) - Optional - Specifies whether to pay unworked Public Holidays. Accepts 0 (Do not pay) or 1 (Pay by default). Defaults to 1.

### Request Example
```json
{
  "start_date": "2023-07-01",
  "end_date": "2023-07-15",
  "payment_date": "2023-07-15",
  "period": "semi_monthly",
  "runs_in_year": 0,
  "active_staff": 1,
  "run_unworked_ph": 1
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message indicating successful configuration.

#### Response Example
```json
{
  "message": "Payroll configuration updated successfully."
}
```

**Note:** The fields `period`, `runs_in_year`, and `payment_date` can only be set during the first processing of a payrun. Subsequent changes to these fields will be ignored, and the original values will be used. Changes to the payment date can be made within Microkeeper.
```

--------------------------------

### GET /api/jobs

Source: https://microkeeper.com.au/guides.php?guide=api-get-update-job

Retrieves job data from Microkeeper. This API assumes Microkeeper is the source of truth for job management.

```APIDOC
## Retrieving Job Data

### Description
Microkeeper job data can be exported from Microkeeper via API. If this API endpoint is being called, it is assumed Microkeeper is the point of truth. This means job management would take place in Microkeeper and the third-party app would be considered a copy of the job list in Microkeeper.

### Method
GET

### Endpoint
/api/jobs

### Parameters

#### Query Parameters

- **mk_action** (string) - Required - The action to perform. Use `get_jobs` to retrieve job data.
- **mk_data** (JSON) - Required - Contains the data for the request. See examples below:
  - Get all Jobs: `{"status":"all"}`
  - Get specific Jobs by Microkeeper ID: `{"status":"JID","JID":["8557","8556"]}`
  - Get specific Jobs by third-party ID: `{"status":"JobID","JobID":["ABC5","ABC3"]}`

#### Available Fields for `mk_data`

- **status** (string) - Required - The status field. Accepted values:
  - `all`: Returns all jobs that are not set to Finished.
  - `finished`: Returns all jobs that are set to Finished.
  - `JID`: Returns jobs matching the provided JID list.
  - `JobID`: Returns jobs matching the provided JobID list.
- **JID** (array of strings) - Required if `status` is set to `JID`. List of JIDs.
  - Example: `["8557","8556"]`
- **JobID** (array of strings) - Required if `status` is set to `JobID`. List of JobIDs.
  - Example: `["ABC5","ABC3"]`

### Response

#### Success Response (200)
- **success** (string) - Indicates if the request was successful.
- **authenticated** (string) - Indicates if the user was authenticated.
- **message** (string) - A message describing the result of the request.
- **data** (object) - Contains the job data.
  - **jobs** (array) - List of jobs returned.

#### Response Example
```json
{
  "success": "1",
  "authenticated": "1",
  "message": "Jobs retrieved successfully",
  "data": {
    "jobs": [
      {
        "JID": "8557",
        "JobID": "ABC1",
        "Title": "Example Job 1",
        "Status": "Active"
      },
      {
        "JID": "8556",
        "JobID": "ABC2",
        "Title": "Example Job 2",
        "Status": "Active"
      }
    ]
  }
}
```
```

--------------------------------

### POST /payroll/add

Source: https://microkeeper.com.au/guides.php?guide=api-payroll-add-get-process

Triggers a payroll process by submitting configuration, payment lists, expense lists, and deduction lists.

```APIDOC
## POST /payroll/add

### Description
Processes a new payroll run using the provided configuration and lists of payments, expenses, and deductions.

### Method
POST

### Endpoint
/payroll/add

### Parameters
#### Request Body
- **mk_action** (string) - Required - Must be set to "add_payroll".
- **mk_data** (object) - Required - Contains the payroll payload.
  - **config** (object) - Required - Includes start_date, end_date, payment_date, and period.
  - **pay_list** (array) - Optional - List of payment items (EID, eusername, note, rate, hours, mult, JID, class, STP).
  - **exp_list** (array) - Optional - List of expense items (EID, note, rate, mult, class).
  - **ded_list** (array) - Optional - List of deduction items (eusername, note, rate, mult, class).

### Request Example
{
  "mk_action": "add_payroll",
  "mk_data": {
    "config": {
      "start_date": "2018-12-01",
      "end_date": "2018-12-31",
      "payment_date": "2018-12-22",
      "period": "semi-monthly"
    },
    "pay_list": [
      {"EID": "3", "eusername": "john_smith", "note": "Basic Rate", "rate": "15.123456789", "hours": "38", "mult": "1.25", "JID": "2206", "class": "normal", "STP": ""}
    ],
    "exp_list": [
      {"EID": "3", "note": "Sal Sac", "rate": "20", "mult": "1", "class": "Super"}
    ],
    "ded_list": [
      {"eusername": "john_smith", "note": "Union", "rate": "5", "mult": "1", "class": "Fees"}
    ]
  }
}

### Response
#### Success Response (200)
- **status** (string) - Confirmation of payroll processing.

#### Response Example
{
  "status": "success",
  "message": "Payroll processed successfully"
}
```

--------------------------------

### GET /payslips

Source: https://microkeeper.com.au/guides.php?guide=api-payroll-add-get-process

Retrieves the structure and field definitions for employee payslip objects, including nested lists for payments, expenses, and deductions.

```APIDOC
## GET /payslips

### Description
Returns the comprehensive data structure for an employee's payslip, including totals and nested lists for specific payment lines, expenses, and deductions.

### Method
GET

### Endpoint
/payslips

### Parameters
#### Path Parameters
- None

#### Query Parameters
- None

### Request Example
GET /payslips

### Response
#### Success Response (200)
- **eusername** (String) - Employee username unique identifier
- **payment** (Decimal) - Total payments for employee for payrun
- **expense** (Decimal) - Total expenses for employee for payrun
- **taxable** (Decimal) - Total taxable (payment - expense)
- **deduction** (Decimal) - Total deductions for an employee for payrun
- **tax** (Decimal) - Total tax withheld
- **net** (Decimal) - Total net (taxable - deduction - tax)
- **pay_list** (Object) - Detailed breakdown of payments
- **exp_list** (Object) - Detailed breakdown of expenses
- **ded_list** (Object) - Detailed breakdown of deductions

#### Response Example
{
  "eusername": "john_smith",
  "payment": 234.88,
  "expense": 170.38,
  "taxable": 64.50,
  "deduction": 10.00,
  "tax": 13.00,
  "net": 41.50
}
```
Tokens:
Raw