Employment Hero

Employment Hero Employee Iras Lump Sum API

Employee Iras Lump Sum

GitHub OpenAPI

Operations 5

GET /api/v2/business/{businessId}/employee/{employeeId}/lumpsum Get lump sum #
POST /api/v2/business/{businessId}/employee/{employeeId}/lumpsum Create IRAS lump sum details #
GET /api/v2/business/{businessId}/employee/{employeeId}/lumpsum/{id} Get IRAS lump sum details for employee #
PUT /api/v2/business/{businessId}/employee/{employeeId}/lumpsum/{id} Update a lump sum #
DELETE /api/v2/business/{businessId}/employee/{employeeId}/lumpsum/{id} Delete lump sum #

Documentation

📖
Documentation
https://api.keypay.com.au/guides/Home.html
📖
APIReference
https://api.keypay.com.au/
📖
APIReference
https://api.keypay.com.au/new-zealand/reference.html
📖
APIReference
https://api.keypay.com.au/united-kingdom/reference.html
📖
APIReference
https://api.keypay.com.au/singapore/reference.html
📖
APIReference
https://api.keypay.com.au/malaysia/reference.html

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/employment-hero/refs/heads/main/openapi/employment-hero-employeeiraslumpsum-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/employment-hero:employment-hero-employeeiraslumpsum-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

employment-hero-employeeiraslumpsum-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Singapore Employee Iras Lump Sum API
  version: SG
  description: Employee Iras Lump Sum
security:
- basic: []
- apiKey: []
- oauth2:
  - read
  - write
- basic: []
- apiKey: []
- oauth2:
  - read
  - write
- basic: []
- apiKey: []
- oauth2:
  - read
  - write
- basic: []
- apiKey: []
- oauth2:
  - read
  - write
- basic: []
- apiKey: []
- oauth2:
  - read
  - write
tags:
- name: EmployeeIrasLumpSum
  description: Employee Iras Lump Sum
paths:
  /api/v2/business/{businessId}/employee/{employeeId}/lumpsum:
    get:
      tags:
      - EmployeeIrasLumpSum
      summary: Get lump sum
      description: Gets the lump sum for the specified employee
      operationId: SgEmployeeIrasLumpSum_GetAll
      parameters:
      - in: path
        name: businessId
        required: true
        schema:
          type: string
      - in: path
        name: employeeId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                title: IList<SgIrasLumpSumModel>
                type: array
                items:
                  $ref: '#/components/schemas/SgIrasLumpSumModel'
            application/xml:
              schema:
                title: IList<SgIrasLumpSumModel>
                type: array
                items:
                  $ref: '#/components/schemas/SgIrasLumpSumModel'
            text/plain:
              schema:
                title: IList<SgIrasLumpSumModel>
                type: array
                items:
                  $ref: '#/components/schemas/SgIrasLumpSumModel'
            application/octet-stream:
              schema:
                title: IList<SgIrasLumpSumModel>
                type: array
                items:
                  $ref: '#/components/schemas/SgIrasLumpSumModel'
            text/json:
              schema:
                title: IList<SgIrasLumpSumModel>
                type: array
                items:
                  $ref: '#/components/schemas/SgIrasLumpSumModel'
    post:
      tags:
      - EmployeeIrasLumpSum
      summary: Create IRAS lump sum details
      description: Creates new IRAS lump sum details for the employee.
      operationId: SgEmployeeIrasLumpSum_Post
      parameters:
      - in: path
        name: businessId
        required: true
        schema:
          type: string
      - in: path
        name: employeeId
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SgIrasLumpSumModel'
            application/xml:
              schema:
                $ref: '#/components/schemas/SgIrasLumpSumModel'
            text/plain:
              schema:
                $ref: '#/components/schemas/SgIrasLumpSumModel'
            application/octet-stream:
              schema:
                $ref: '#/components/schemas/SgIrasLumpSumModel'
            text/json:
              schema:
                $ref: '#/components/schemas/SgIrasLumpSumModel'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            application/xml:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            text/plain:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            application/octet-stream:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SgIrasLumpSumModel'
          application/xml:
            schema:
              $ref: '#/components/schemas/SgIrasLumpSumModel'
          text/plain:
            schema:
              $ref: '#/components/schemas/SgIrasLumpSumModel'
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/SgIrasLumpSumModel'
          text/json:
            schema:
              $ref: '#/components/schemas/SgIrasLumpSumModel'
          application/*+json:
            schema:
              $ref: '#/components/schemas/SgIrasLumpSumModel'
  /api/v2/business/{businessId}/employee/{employeeId}/lumpsum/{id}:
    get:
      tags:
      - EmployeeIrasLumpSum
      summary: Get IRAS lump sum details for employee
      description: Gets specific IRAS lump sum details for the specified employee
      operationId: SgEmployeeIrasLumpSum_Get_2
      parameters:
      - in: path
        name: id
        required: true
        title: Int32
        schema:
          type: integer
          format: int32
      - in: path
        name: businessId
        required: true
        schema:
          type: string
      - in: path
        name: employeeId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SgIrasLumpSumModel'
            application/xml:
              schema:
                $ref: '#/components/schemas/SgIrasLumpSumModel'
            text/plain:
              schema:
                $ref: '#/components/schemas/SgIrasLumpSumModel'
            application/octet-stream:
              schema:
                $ref: '#/components/schemas/SgIrasLumpSumModel'
            text/json:
              schema:
                $ref: '#/components/schemas/SgIrasLumpSumModel'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            application/xml:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            text/plain:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            application/octet-stream:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
    put:
      tags:
      - EmployeeIrasLumpSum
      summary: Update a lump sum
      description: Update an existing lump sum.
      operationId: SgEmployeeIrasLumpSum_Put_3
      parameters:
      - in: path
        name: id
        required: true
        title: Int32
        schema:
          type: integer
          format: int32
      - in: path
        name: businessId
        required: true
        schema:
          type: string
      - in: path
        name: employeeId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SgIrasLumpSumModel'
            application/xml:
              schema:
                $ref: '#/components/schemas/SgIrasLumpSumModel'
            text/plain:
              schema:
                $ref: '#/components/schemas/SgIrasLumpSumModel'
            application/octet-stream:
              schema:
                $ref: '#/components/schemas/SgIrasLumpSumModel'
            text/json:
              schema:
                $ref: '#/components/schemas/SgIrasLumpSumModel'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            application/xml:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            text/plain:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            application/octet-stream:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SgIrasLumpSumModel'
          application/xml:
            schema:
              $ref: '#/components/schemas/SgIrasLumpSumModel'
          text/plain:
            schema:
              $ref: '#/components/schemas/SgIrasLumpSumModel'
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/SgIrasLumpSumModel'
          text/json:
            schema:
              $ref: '#/components/schemas/SgIrasLumpSumModel'
          application/*+json:
            schema:
              $ref: '#/components/schemas/SgIrasLumpSumModel'
    delete:
      tags:
      - EmployeeIrasLumpSum
      summary: Delete lump sum
      description: Deletes the IRAS lump sum details with the specified ID.
      operationId: SgEmployeeIrasLumpSum_Delete_4
      parameters:
      - in: path
        name: id
        required: true
        title: Int32
        schema:
          type: integer
          format: int32
      - in: path
        name: businessId
        required: true
        schema:
          type: string
      - in: path
        name: employeeId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            application/xml:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            text/plain:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            application/octet-stream:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
components:
  schemas:
    ProblemDetails:
      title: ProblemDetails
      type: object
      properties:
        type:
          title: String
          type: string
          x-title: String
        title:
          title: String
          type: string
          x-title: String
        status:
          format: int32
          title: Nullable<Int32>
          type: integer
          x-title: Nullable<Int32>
        detail:
          title: String
          type: string
          x-title: String
        instance:
          title: String
          type: string
          x-title: String
      additionalProperties:
        title: Object
        x-title: Object
        type: object
    SgIrasLumpSumModel:
      title: SgIrasLumpSumModel
      type: object
      properties:
        id:
          format: int32
          title: Int32
          type: integer
          x-title: Int32
        employingEntityId:
          format: int32
          title: Nullable<Int32>
          type: integer
          x-title: Nullable<Int32>
        basisPeriod:
          format: int32
          title: Int32
          type: integer
          x-title: Int32
        approved:
          title: Nullable<Boolean>
          type: boolean
          x-title: Nullable<Boolean>
        dateOfApproval:
          format: date-time
          title: Nullable<DateTime>
          type: string
          x-title: Nullable<DateTime>
        paymentReason:
          title: String
          type: string
          x-title: String
        serviceLength:
          title: String
          type: string
          x-title: String
        paymentBasis:
          title: String
          type: string
          x-title: String
        retirementBenefitsFund:
          title: String
          type: string
          x-title: String
      additionalProperties: false
  securitySchemes:
    basic:
      type: http
      scheme: basic
      description: Your API key should be the username and the password can be left blank
    apiKey:
      type: apiKey
      in: header
      description: API Key Authentication
    oauth2:
      type: oauth2
      flows:
        implicit:
          scopes:
            read: Read access to protected resources
            write: Write access to protected resources
          authorizationUrl: https://keypay.yourpayroll.com.au/oauth/authorise
      description: OAuth2 Implicit Grant
x-navigateMethodsByName: true