Employment Hero

Employment Hero Pension Settings API

Pension Settings

GitHub OpenAPI

Operations 10

GET /api/v2/business/{businessId}/pensionscheme List Pension Schemes #
POST /api/v2/business/{businessId}/pensionscheme Create Pension Scheme #
POST /api/v2/business/{businessId}/pensionscheme/dates Set Pension Scheme Dates #
GET /api/v2/business/{businessId}/pensionscheme/{id} Get Pension Scheme #
PUT /api/v2/business/{businessId}/pensionscheme/{id} Update Pension Scheme #
DELETE /api/v2/business/{businessId}/pensionscheme/{id} Delete Pension Scheme #
POST /api/v2/business/{businessId}/pensionscheme/{schemeId}/plan Create Pension Scheme Contribution Plan #
GET /api/v2/business/{businessId}/pensionscheme/{schemeId}/plan List Pension Scheme Contribution Plans #
PUT /api/v2/business/{businessId}/pensionscheme/{schemeId}/plan/{planId} Update Pension Scheme Contribution Plan #
GET /api/v2/business/{businessId}/pensionscheme/{schemeId}/plan/{planId} Get Pension Scheme Contribution Plan #

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-pensionsettings-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-pensionsettings-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-pensionsettings-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: United Kingdom Pension Settings API
  version: UK
  description: Pension Settings
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: PensionSettings
  description: Pension Settings
paths:
  /api/v2/business/{businessId}/pensionscheme:
    get:
      tags:
      - PensionSettings
      summary: List Pension Schemes
      description: List Pension Schemes for business
      operationId: UKBusinessPensionSettings_ListPensionSchemes
      parameters:
      - in: path
        name: businessId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                title: List<PensionSchemeApiModel>
                type: array
                items:
                  $ref: '#/components/schemas/PensionSchemeApiModel'
            application/xml:
              schema:
                title: List<PensionSchemeApiModel>
                type: array
                items:
                  $ref: '#/components/schemas/PensionSchemeApiModel'
            text/plain:
              schema:
                title: List<PensionSchemeApiModel>
                type: array
                items:
                  $ref: '#/components/schemas/PensionSchemeApiModel'
            application/octet-stream:
              schema:
                title: List<PensionSchemeApiModel>
                type: array
                items:
                  $ref: '#/components/schemas/PensionSchemeApiModel'
            text/json:
              schema:
                title: List<PensionSchemeApiModel>
                type: array
                items:
                  $ref: '#/components/schemas/PensionSchemeApiModel'
    post:
      tags:
      - PensionSettings
      summary: Create Pension Scheme
      description: Create Pension Scheme for business
      operationId: UKBusinessPensionSettings_SavePensionScheme
      parameters:
      - in: path
        name: businessId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PensionSchemeApiModel'
            application/xml:
              schema:
                $ref: '#/components/schemas/PensionSchemeApiModel'
            text/plain:
              schema:
                $ref: '#/components/schemas/PensionSchemeApiModel'
            application/octet-stream:
              schema:
                $ref: '#/components/schemas/PensionSchemeApiModel'
            text/json:
              schema:
                $ref: '#/components/schemas/PensionSchemeApiModel'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PensionSchemeApiModel'
          application/xml:
            schema:
              $ref: '#/components/schemas/PensionSchemeApiModel'
          text/plain:
            schema:
              $ref: '#/components/schemas/PensionSchemeApiModel'
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/PensionSchemeApiModel'
          text/json:
            schema:
              $ref: '#/components/schemas/PensionSchemeApiModel'
          application/*+json:
            schema:
              $ref: '#/components/schemas/PensionSchemeApiModel'
  /api/v2/business/{businessId}/pensionscheme/dates:
    post:
      tags:
      - PensionSettings
      summary: Set Pension Scheme Dates
      description: Save auto enrollment staging and re-enrolment dates for business
      operationId: UKBusinessPensionSettings_SaveStagingDate
      parameters:
      - in: path
        name: businessId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PensionSchemeStagingModel'
            application/xml:
              schema:
                $ref: '#/components/schemas/PensionSchemeStagingModel'
            text/plain:
              schema:
                $ref: '#/components/schemas/PensionSchemeStagingModel'
            application/octet-stream:
              schema:
                $ref: '#/components/schemas/PensionSchemeStagingModel'
            text/json:
              schema:
                $ref: '#/components/schemas/PensionSchemeStagingModel'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PensionSchemeStagingModel'
          application/xml:
            schema:
              $ref: '#/components/schemas/PensionSchemeStagingModel'
          text/plain:
            schema:
              $ref: '#/components/schemas/PensionSchemeStagingModel'
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/PensionSchemeStagingModel'
          text/json:
            schema:
              $ref: '#/components/schemas/PensionSchemeStagingModel'
          application/*+json:
            schema:
              $ref: '#/components/schemas/PensionSchemeStagingModel'
  /api/v2/business/{businessId}/pensionscheme/{id}:
    get:
      tags:
      - PensionSettings
      summary: Get Pension Scheme
      description: Get Pension Scheme for business
      operationId: UKBusinessPensionSettings_Get
      parameters:
      - in: path
        name: id
        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/PensionSchemeApiModel'
            application/xml:
              schema:
                $ref: '#/components/schemas/PensionSchemeApiModel'
            text/plain:
              schema:
                $ref: '#/components/schemas/PensionSchemeApiModel'
            application/octet-stream:
              schema:
                $ref: '#/components/schemas/PensionSchemeApiModel'
            text/json:
              schema:
                $ref: '#/components/schemas/PensionSchemeApiModel'
        '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:
      - PensionSettings
      summary: Update Pension Scheme
      description: Update Pension Scheme for business
      operationId: UKBusinessPensionSettings_UpdatePensionScheme
      parameters:
      - in: path
        name: id
        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/PensionSchemeApiModel'
            application/xml:
              schema:
                $ref: '#/components/schemas/PensionSchemeApiModel'
            text/plain:
              schema:
                $ref: '#/components/schemas/PensionSchemeApiModel'
            application/octet-stream:
              schema:
                $ref: '#/components/schemas/PensionSchemeApiModel'
            text/json:
              schema:
                $ref: '#/components/schemas/PensionSchemeApiModel'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PensionSchemeApiModel'
          application/xml:
            schema:
              $ref: '#/components/schemas/PensionSchemeApiModel'
          text/plain:
            schema:
              $ref: '#/components/schemas/PensionSchemeApiModel'
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/PensionSchemeApiModel'
          text/json:
            schema:
              $ref: '#/components/schemas/PensionSchemeApiModel'
          application/*+json:
            schema:
              $ref: '#/components/schemas/PensionSchemeApiModel'
    delete:
      tags:
      - PensionSettings
      summary: Delete Pension Scheme
      description: Delete Pension Scheme for business
      operationId: UKBusinessPensionSettings_DeletePensionScheme
      parameters:
      - in: path
        name: id
        required: true
        title: Int32
        schema:
          type: integer
          format: int32
      - in: path
        name: businessId
        required: true
        schema:
          type: string
      responses:
        '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'
        '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'
  /api/v2/business/{businessId}/pensionscheme/{schemeId}/plan:
    post:
      tags:
      - PensionSettings
      summary: Create Pension Scheme Contribution Plan
      description: Create Contribution Plan for Pension Scheme
      operationId: UKBusinessPensionSettings_SavePensionSchemeContributionPlan
      parameters:
      - in: path
        name: schemeId
        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/PensionSchemeContributionPlanApiModel'
            application/xml:
              schema:
                $ref: '#/components/schemas/PensionSchemeContributionPlanApiModel'
            text/plain:
              schema:
                $ref: '#/components/schemas/PensionSchemeContributionPlanApiModel'
            application/octet-stream:
              schema:
                $ref: '#/components/schemas/PensionSchemeContributionPlanApiModel'
            text/json:
              schema:
                $ref: '#/components/schemas/PensionSchemeContributionPlanApiModel'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PensionSchemeContributionPlanApiModel'
          application/xml:
            schema:
              $ref: '#/components/schemas/PensionSchemeContributionPlanApiModel'
          text/plain:
            schema:
              $ref: '#/components/schemas/PensionSchemeContributionPlanApiModel'
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/PensionSchemeContributionPlanApiModel'
          text/json:
            schema:
              $ref: '#/components/schemas/PensionSchemeContributionPlanApiModel'
          application/*+json:
            schema:
              $ref: '#/components/schemas/PensionSchemeContributionPlanApiModel'
    get:
      tags:
      - PensionSettings
      summary: List Pension Scheme Contribution Plans
      description: List all Contribution Plans for a Pension Scheme
      operationId: UKBusinessPensionSettings_GetPensionSchemeContributionPlan
      parameters:
      - in: path
        name: schemeId
        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:
                title: List<PensionSchemeContributionPlanApiModel>
                type: array
                items:
                  $ref: '#/components/schemas/PensionSchemeContributionPlanApiModel'
            application/xml:
              schema:
                title: List<PensionSchemeContributionPlanApiModel>
                type: array
                items:
                  $ref: '#/components/schemas/PensionSchemeContributionPlanApiModel'
            text/plain:
              schema:
                title: List<PensionSchemeContributionPlanApiModel>
                type: array
                items:
                  $ref: '#/components/schemas/PensionSchemeContributionPlanApiModel'
            application/octet-stream:
              schema:
                title: List<PensionSchemeContributionPlanApiModel>
                type: array
                items:
                  $ref: '#/components/schemas/PensionSchemeContributionPlanApiModel'
            text/json:
              schema:
                title: List<PensionSchemeContributionPlanApiModel>
                type: array
                items:
                  $ref: '#/components/schemas/PensionSchemeContributionPlanApiModel'
        '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'
  /api/v2/business/{businessId}/pensionscheme/{schemeId}/plan/{planId}:
    put:
      tags:
      - PensionSettings
      summary: Update Pension Scheme Contribution Plan
      description: UpdateContribution Plan for Pension Scheme
      operationId: UKBusinessPensionSettings_UpdatePensionSchemeContributionPlan
      parameters:
      - in: path
        name: schemeId
        required: true
        title: Int32
        schema:
          type: integer
          format: int32
      - in: path
        name: planId
        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/PensionSchemeContributionPlanApiModel'
            application/xml:
              schema:
                $ref: '#/components/schemas/PensionSchemeContributionPlanApiModel'
            text/plain:
              schema:
                $ref: '#/components/schemas/PensionSchemeContributionPlanApiModel'
            application/octet-stream:
              schema:
                $ref: '#/components/schemas/PensionSchemeContributionPlanApiModel'
            text/json:
              schema:
                $ref: '#/components/schemas/PensionSchemeContributionPlanApiModel'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PensionSchemeContributionPlanApiModel'
          application/xml:
            schema:
              $ref: '#/components/schemas/PensionSchemeContributionPlanApiModel'
          text/plain:
            schema:
              $ref: '#/components/schemas/PensionSchemeContributionPlanApiModel'
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/PensionSchemeContributionPlanApiModel'
          text/json:
            schema:
              $ref: '#/components/schemas/PensionSchemeContributionPlanApiModel'
          application/*+json:
            schema:
              $ref: '#/components/schemas/PensionSchemeContributionPlanApiModel'
    get:
      tags:
      - PensionSettings
      summary: Get Pension Scheme Contribution Plan
      description: Get specified Pension Scheme Contribution Plan for business
      operationId: UKBusinessPensionSettings_GetPensionSchemeContributionPlan_2
      parameters:
      - in: path
        name: schemeId
        required: true
        title: Int32
        schema:
          type: integer
          format: int32
      - in: path
        name: planId
        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/PensionSchemeContributionPlanApiModel'
            application/xml:
              schema:
                $ref: '#/components/schemas/PensionSchemeContributionPlanApiModel'
            text/plain:
              schema:
                $ref: '#/components/schemas/PensionSchemeContributionPlanApiModel'
            application/octet-stream:
              schema:
                $ref: '#/components/schemas/PensionSchemeContributionPlanApiModel'
            text/json:
              schema:
                $ref: '#/components/schemas/PensionSchemeContributionPlanApiModel'
        '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'
components:
  schemas:
    PensionSchemeStagingModel:
      title: PensionSchemeStagingModel
      type: object
      properties:
        stagingDate:
          format: date-time
          title: DateTime
          type: string
          x-title: DateTime
        autoReEnrolmentDate:
          format: date-time
          title: Nullable<DateTime>
          type: string
          x-title: Nullable<DateTime>
        includeOptedOutEmployees:
          title: Boolean
          type: boolean
          x-title: Boolean
      additionalProperties: false
    PensionSchemeContributionPlanApiModel:
      title: PensionSchemeContributionPlanApiModel
      type: object
      properties:
        id:
          format: int32
          title: Nullable<Int32>
          type: integer
          x-title: Nullable<Int32>
        contributionGroupName:
          title: String
          type: string
          x-title: String
        contributionGroupId:
          title: String
          type: string
          x-title: String
        contributionPlanName:
          title: String
          type: string
          x-title: String
        calculateOnQualifyingEarnings:
          title: Boolean
          type: boolean
          x-title: Boolean
        pensionType:
          title: PensionTypeEnum
          enum:
          - NetPay
          - ReliefAtSource
          type: string
        employeeContribution:
          format: double
          title: Decimal
          type: number
          x-title: Decimal
        employerContribution:
          format: double
          title: Decimal
          type: number
          x-title: Decimal
        salarySacrifice:
          format: double
          title: Decimal
          type: number
          x-title: Decimal
        reportingFrequency:
          title: PensionReportingFrequencyEnum
          enum:
          - W1
          - W2
          - W4
          - M1
          - M3
          - M6
          - MA
          - TW
          - TM
          type: string
        pensionSchemeId:
          format: int32
          title: Int32
          type: integer
          x-title: Int32
        maxEarningsThreshold:
          format: double
          title: Decimal
          type: number
          x-title: Decimal
        minEarningsThreshold:
          format: double
          title: Decimal
          type: number
          x-title: Decimal
        salarySacrificeDeductionCategoryId:
          format: int32
          title: Nullable<Int32>
          type: integer
          x-title: Nullable<Int32>
        nicSavingRebate:
          format: double
          title: Decimal
          type: number
          x-title: Decimal
        isAutoEnrolmentScheme:
          title: Nullable<Boolean>
          type: boolean
          x-title: Nullable<Boolean>
        lowerEarningsDisregard:
          format: double
          title: Nullable<Decimal>
          type: number
          x-title: Nullable<Decimal>
        lowerDefaultEarningsDisregardType:
          title: Nullable<DefaultLELOffsetEnum>
          enum:
          - NoOffset
          - LELOffset
          - LELOffsetMultiplied
          type: string
        upperEarningsCap:
          format: double
          title: Nullable<Decimal>
          type: number
          x-title: Nullable<Decimal>
        upperDefaultEarningsCapType:
          title: Nullable<DefaultUETOffsetEnum>
          enum:
          - NoOffset
          - UETOffset
          type: string
        pensionSchemeContributionPlanPostponementRules:
          title: List<PensionSchemeContributionPlanPostponementRuleApiModel>
          type: array
          items:
            $ref: '#/components/schemas/PensionSchemeContributionPlanPostponementRuleApiModel'
        collectionSourceId:
          title: String
          type: string
          x-title: String
        useTaxMonthPayPeriod:
          title: Boolean
          type: boolean
          x-title: Boolean
      additionalProperties: false
    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
    PensionSchemeContributionPlanPostponementRuleApiModel:
      title: PensionSchemeContributionPlanPostponementRuleApiModel
      type: object
      properties:
        postponementRuleType:
          title: PostponementRuleTypeEnum
          enum:
          - ReachesDutiesStartDate
          - JoinsACompany
          - ReachesAgeOf22
          - EligibleAfterInitialAssessment
          type: string
        postponementRuleOptionType:
          title: PostponementRuleOptionTypeEnum
          enum:
          - PostponeWeeks
          - PostponeMonths
          - PostponePayPeriods
          - PostponeSixthFollowingMonths
          type: string
        postponementPeriod:
          format: int32
          title: Int32
          type: integer
          x-title: Int32
        pensionSchemeContributionPlanId:
          format: int32
          title: Int32
          type: integer
          x-title: Int32
        name:
          title: String
          type: string
          x-title: String
      additionalProperties: false
    PensionSchemeApiModel:
      title: PensionSchemeApiModel
      type: object
      properties:
        id:
          format: int32
          title: Int32
          type: integer
          x-title: Int32
        name:
          title: String
          type: string
          x-title: String
        providerName:
          title: String
          type: string
          x-title: String
        employerNumber:
          title: String
          type: string
          x-title: String
        adminTitle:
          title: String
          type: string
          x-title: String
        adminFirstName:
          title: String
          type: string
          x-title: String
        adminSurname:
          title: String
          type: string
          x-title: String
        adminEmailAddress:
          title: String
          type: string
          x-title: String
        adminPhoneNumber:
          title: String
          type: string
          x-title: String
        adminAddressLine1:
          title: String
          type: string
          x-title: String
        adminAddressLine2:
          title: String
          type: string
          x-title: String
        adminSuburb:
          title: String
          type: string
          x-title: String
        adminPostcode:
          title: String
          type: string
          x-title: String
        adminAutoEnrolmentSignatoryFullname:
          title: String
          type: string
          x-title: String
        adminAutoEnrolmentSignatoryTitle:
          title: String
          type: string
          x-title: String
        adminAutoEnrolmentSignatoryEmailAddress:
          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