Employment Hero

Employment Hero Subcontractor API

Subcontractor

GitHub OpenAPI

Operations 2

POST /api/v2/business/{businessId}/subcontractor Create subcontractor #
POST /api/v2/business/{businessId}/subcontractor/{subcontractorId}/paymentdetails Save subcontractor payment details #

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-subcontractor-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-subcontractor-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-subcontractor-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: United Kingdom Subcontractor API
  version: UK
  description: Subcontractor
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: Subcontractor
  description: Subcontractor
paths:
  /api/v2/business/{businessId}/subcontractor:
    post:
      tags:
      - Subcontractor
      summary: Create subcontractor
      description: Creates a new subcontractor
      operationId: UkSubcontractor_Create
      parameters:
      - in: path
        name: businessId
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UkSubcontractorReadModel'
            application/xml:
              schema:
                $ref: '#/components/schemas/UkSubcontractorReadModel'
            text/plain:
              schema:
                $ref: '#/components/schemas/UkSubcontractorReadModel'
            application/octet-stream:
              schema:
                $ref: '#/components/schemas/UkSubcontractorReadModel'
            text/json:
              schema:
                $ref: '#/components/schemas/UkSubcontractorReadModel'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UkSubcontractorCreateModel'
          application/xml:
            schema:
              $ref: '#/components/schemas/UkSubcontractorCreateModel'
          text/plain:
            schema:
              $ref: '#/components/schemas/UkSubcontractorCreateModel'
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/UkSubcontractorCreateModel'
          text/json:
            schema:
              $ref: '#/components/schemas/UkSubcontractorCreateModel'
          application/*+json:
            schema:
              $ref: '#/components/schemas/UkSubcontractorCreateModel'
  /api/v2/business/{businessId}/subcontractor/{subcontractorId}/paymentdetails:
    post:
      tags:
      - Subcontractor
      summary: Save subcontractor payment details
      description: Creates or updates payment details for a subcontractor
      operationId: UkSubcontractor_SavePaymentDetails
      parameters:
      - in: path
        name: subcontractorId
        required: true
        title: Int32
        schema:
          type: integer
          format: int32
      - in: path
        name: businessId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UkSubcontractorPaymentDetailsModel'
            application/xml:
              schema:
                $ref: '#/components/schemas/UkSubcontractorPaymentDetailsModel'
            text/plain:
              schema:
                $ref: '#/components/schemas/UkSubcontractorPaymentDetailsModel'
            application/octet-stream:
              schema:
                $ref: '#/components/schemas/UkSubcontractorPaymentDetailsModel'
            text/json:
              schema:
                $ref: '#/components/schemas/UkSubcontractorPaymentDetailsModel'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UkSaveSubcontractorPaymentDetailsModel'
          application/xml:
            schema:
              $ref: '#/components/schemas/UkSaveSubcontractorPaymentDetailsModel'
          text/plain:
            schema:
              $ref: '#/components/schemas/UkSaveSubcontractorPaymentDetailsModel'
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/UkSaveSubcontractorPaymentDetailsModel'
          text/json:
            schema:
              $ref: '#/components/schemas/UkSaveSubcontractorPaymentDetailsModel'
          application/*+json:
            schema:
              $ref: '#/components/schemas/UkSaveSubcontractorPaymentDetailsModel'
components:
  schemas:
    UkSubcontractorReadModel:
      title: UkSubcontractorReadModel
      type: object
      properties:
        employeeId:
          format: int32
          title: Int32
          type: integer
          x-title: Int32
        tradingName:
          title: String
          type: string
          x-title: String
        businessType:
          title: SubcontractorBusinessType
          enum:
          - Unknown
          - SoleTrader
          - Partnership
          - Company
          - Trust
          type: string
        firstName:
          title: String
          type: string
          x-title: String
        surname:
          title: String
          type: string
          x-title: String
        middleName:
          title: String
          type: string
          x-title: String
        addressLine1:
          title: String
          type: string
          x-title: String
        addressLine2:
          title: String
          type: string
          x-title: String
        town:
          title: String
          type: string
          x-title: String
        postcode:
          title: String
          type: string
          x-title: String
        county:
          title: String
          type: string
          x-title: String
        countryId:
          title: String
          type: string
          x-title: String
        emailAddress:
          title: String
          type: string
          x-title: String
        phoneNumber:
          title: String
          type: string
          x-title: String
        uniqueTaxpayerReference:
          title: String
          type: string
          x-title: String
        partnershipUniqueTaxpayerReference:
          title: String
          type: string
          x-title: String
        nationalInsuranceNumber:
          title: String
          type: string
          x-title: String
        companyRegistrationNumber:
          title: String
          type: string
          x-title: String
        taxStatus:
          title: SubcontractorTaxStatus
          enum:
          - Unknown
          - Unmatched
          - Standard
          - Gross
          - VerificationRequired
          type: string
        dateMatched:
          format: date-time
          title: Nullable<DateTime>
          type: string
          x-title: Nullable<DateTime>
        verificationNumber:
          title: String
          type: string
          x-title: String
        isContractAgreed:
          title: Boolean
          type: boolean
          x-title: Boolean
      additionalProperties: false
    UkSubcontractorPaymentDetailsModel:
      title: UkSubcontractorPaymentDetailsModel
      type: object
      properties:
        bankAccountId:
          format: int32
          title: Int32
          type: integer
          x-title: Int32
        accountType:
          title: BankAccountTypeEnum
          enum:
          - Electronic
          - ManualDeposit
          - CashOrCheque
          type: string
          x-title: BankAccountTypeEnum
        sortCode:
          title: String
          type: string
          x-title: String
        accountName:
          title: String
          type: string
          x-title: String
        accountNumber:
          title: String
          type: string
          x-title: String
        rollNumber:
          title: String
          type: string
          x-title: String
        lastPaymentDate:
          format: date-time
          title: Nullable<DateTime>
          type: string
          x-title: Nullable<DateTime>
        payScheduleId:
          format: int32
          title: Int32
          type: integer
          x-title: Int32
        payCategoryId:
          format: int32
          title: Int32
          type: integer
          x-title: Int32
      additionalProperties: false
    UkSubcontractorCreateModel:
      title: UkSubcontractorCreateModel
      type: object
      properties:
        tradingName:
          title: String
          type: string
          x-title: String
        businessType:
          title: Nullable<SubcontractorBusinessType>
          enum:
          - Unknown
          - SoleTrader
          - Partnership
          - Company
          - Trust
          type: string
        firstName:
          title: String
          type: string
          x-title: String
        surname:
          title: String
          type: string
          x-title: String
        middleName:
          title: String
          type: string
          x-title: String
        addressLine1:
          title: String
          type: string
          x-title: String
        addressLine2:
          title: String
          type: string
          x-title: String
        town:
          title: String
          type: string
          x-title: String
        postcode:
          title: String
          type: string
          x-title: String
        county:
          title: String
          type: string
          x-title: String
        countryId:
          title: String
          type: string
          x-title: String
        emailAddress:
          title: String
          type: string
          x-title: String
        phoneNumber:
          title: String
          type: string
          x-title: String
        uniqueTaxpayerReference:
          title: String
          type: string
          x-title: String
        partnershipUniqueTaxpayerReference:
          title: String
          type: string
          x-title: String
        nationalInsuranceNumber:
          title: String
          type: string
          x-title: String
        companyRegistrationNumber:
          title: String
          type: string
          x-title: String
        taxStatus:
          title: Nullable<SubcontractorTaxStatus>
          enum:
          - Unknown
          - Unmatched
          - Standard
          - Gross
          - VerificationRequired
          type: string
        dateMatched:
          format: date-time
          title: Nullable<DateTime>
          type: string
          x-title: Nullable<DateTime>
        verificationNumber:
          title: String
          type: string
          x-title: String
        isContractAgreed:
          title: Nullable<Boolean>
          type: boolean
          x-title: Nullable<Boolean>
        lastPaymentDate:
          format: date-time
          title: Nullable<DateTime>
          type: string
          x-title: Nullable<DateTime>
      additionalProperties: false
    UkSaveSubcontractorPaymentDetailsModel:
      title: UkSaveSubcontractorPaymentDetailsModel
      type: object
      properties:
        bankAccountId:
          format: int32
          title: Nullable<Int32>
          type: integer
          x-title: Nullable<Int32>
        accountType:
          title: BankAccountTypeEnum
          enum:
          - Electronic
          - ManualDeposit
          - CashOrCheque
          type: string
          x-title: BankAccountTypeEnum
        sortCode:
          title: String
          type: string
          x-title: String
        accountName:
          title: String
          type: string
          x-title: String
        accountNumber:
          title: String
          type: string
          x-title: String
        rollNumber:
          title: String
          type: string
          x-title: String
        lastPaymentDate:
          format: date-time
          title: Nullable<DateTime>
          type: string
          x-title: Nullable<DateTime>
        payScheduleId:
          format: int32
          title: Nullable<Int32>
          type: integer
          x-title: Nullable<Int32>
        payCategoryId:
          format: int32
          title: Nullable<Int32>
          type: integer
          x-title: Nullable<Int32>
      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