PayrollAu

Creates a pay item

post/PayItems

Headers

Idempotency-Keystring

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Request body

Example request

{
  "EarningsRates": [
    {
      "Name": "PTO",
      "TypeOfUnits": "Fixed",
      "IsQualifyingEarnings": true,
      "EarningsRateID": "e0eb6747-7c17-4075-b804-989f8d4e5d39",
      "Multiplier": 1.5,
      "Amount": 50.3,
      "UpdatedDateUTC": "/Date(1583967733054+0000)/",
      "CurrentRecord": true
    }
  ],
  "DeductionTypes": [
    {
      "Name": "PTO",
      "DeductionTypeID": "e0eb6747-7c17-4075-b804-989f8d4e5d39",
      "UpdatedDateUTC": "/Date(1583967733054+0000)/",
      "CurrentRecord": true
    }
  ],
  "LeaveTypes": [
    {
      "Name": "PTO",
      "TypeOfUnits": "Hours",
      "LeaveTypeID": "e0eb6747-7c17-4075-b804-989f8d4e5d39",
      "NormalEntitlement": 152,
      "LeaveLoadingRate": 2,
      "UpdatedDateUTC": "/Date(1583967733054+0000)/",
      "IsPaidLeave": true,
      "ShowOnPayslip": true,
      "CurrentRecord": true,
      "LeaveCategoryCode": "ANNUALLEAVE",
      "SGCExempt": true,
      "IsQualifyingEarnings": true
    }
  ],
  "ReimbursementTypes": [
    {
      "Name": "PTO",
      "ReimbursementTypeID": "e0eb6747-7c17-4075-b804-989f8d4e5d39",
      "UpdatedDateUTC": "/Date(1583967733054+0000)/",
      "CurrentRecord": true
    }
  ]
}

Response

A successful request - currently returns empty array for JSON

Example response

{
  "PayItems": {
    "EarningsRates": [
      {
        "Name": "PTO",
        "TypeOfUnits": "Fixed",
        "IsQualifyingEarnings": true,
        "EarningsRateID": "e0eb6747-7c17-4075-b804-989f8d4e5d39",
        "Multiplier": 1.5,
        "Amount": 50.3,
        "UpdatedDateUTC": "/Date(1583967733054+0000)/",
        "CurrentRecord": true
      }
    ],
    "DeductionTypes": [
      {
        "Name": "PTO",
        "DeductionTypeID": "e0eb6747-7c17-4075-b804-989f8d4e5d39",
        "UpdatedDateUTC": "/Date(1583967733054+0000)/",
        "CurrentRecord": true
      }
    ],
    "LeaveTypes": [
      {
        "Name": "PTO",
        "TypeOfUnits": "Hours",
        "LeaveTypeID": "e0eb6747-7c17-4075-b804-989f8d4e5d39",
        "NormalEntitlement": 152,
        "LeaveLoadingRate": 2,
        "UpdatedDateUTC": "/Date(1583967733054+0000)/",
        "IsPaidLeave": true,
        "ShowOnPayslip": true,
        "CurrentRecord": true,
        "LeaveCategoryCode": "ANNUALLEAVE",
        "SGCExempt": true,
        "IsQualifyingEarnings": true
      }
    ],
    "ReimbursementTypes": [
      {
        "Name": "PTO",
        "ReimbursementTypeID": "e0eb6747-7c17-4075-b804-989f8d4e5d39",
        "UpdatedDateUTC": "/Date(1583967733054+0000)/",
        "CurrentRecord": true
      }
    ]
  }
}

Changes

Changed in 7 of the 54 revisions of this API.5211

May 11, 2026f9c1d353a79422See the full diff
- ▲
  the request property EarningsRates/items/IsQualifyingEarnings became required
  request-property-became-required
- ▲
  the request property LeaveTypes/items/IsQualifyingEarnings became required
  request-property-became-required
- ○
  the response property PayItems/EarningsRates/items/IsQualifyingEarnings became required for the status 200
  response-property-became-required
- ○
  the response property PayItems/LeaveTypes/items/IsQualifyingEarnings became required for the status 200
  response-property-became-required
Jan 27, 2026d1b43af7b70d4See the full diff
- ○
  added the new optional request property EarningsRates/items/IsQualifyingEarnings
  new-optional-request-property
- ○
  added the new optional request property LeaveTypes/items/IsQualifyingEarnings
  new-optional-request-property
- ○
  added the optional property PayItems/EarningsRates/items/IsQualifyingEarnings to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property PayItems/LeaveTypes/items/IsQualifyingEarnings to the response with the 200 status
  response-optional-property-added
May 2, 202466c6566eb54811See the full diff
- ▲
  removed the enum value JOBKEEPER of the request property EarningsRates/items/AllowanceType
  request-property-enum-value-removed
- ○
  removed the JOBKEEPER enum value from the PayItems/EarningsRates/items/AllowanceType response property for the response status 200
  response-property-enum-value-removed
May 2, 2024cd5eef76229a11See the full diff
- ●
  added the new JOBKEEPER enum value to the PayItems/EarningsRates/items/AllowanceType response property for the response status 200
  response-property-enum-value-added
- ○
  added the new JOBKEEPER enum value to the request property EarningsRates/items/AllowanceType
  request-property-enum-value-added
Mar 31, 2024ead883bf776b11See the full diff
- ▲
  removed the enum value JOBKEEPER of the request property EarningsRates/items/AllowanceType
  request-property-enum-value-removed
- ○
  removed the JOBKEEPER enum value from the PayItems/EarningsRates/items/AllowanceType response property for the response status 200
  response-property-enum-value-removed
Jan 8, 20244338f9e057c711See the full diff
- ●
  added the new JOBKEEPER enum value to the PayItems/EarningsRates/items/AllowanceType response property for the response status 200
  response-property-enum-value-added
- ○
  added the new JOBKEEPER enum value to the request property EarningsRates/items/AllowanceType
  request-property-enum-value-added
Nov 28, 202398aea080c4db11See the full diff
- ▲
  removed the enum value JOBKEEPER of the request property EarningsRates/items/AllowanceType
  request-property-enum-value-removed
- ○
  removed the JOBKEEPER enum value from the PayItems/EarningsRates/items/AllowanceType response property for the response status 200
  response-property-enum-value-removed

Full history