PayrollAu

Retrieves pay items

Changed on
get/PayItems

Request

  • Base URL: https://api.xero.com/payroll.xro/1.0
  • URL: https://api.xero.com/payroll.xro/1.0/PayItems
  • Auth: OAuth 2 (authorization code, authorization URL https://login.xero.com/identity/connect/authorize, token URL https://identity.xero.com/connect/token, scopes: payroll.settings, payroll.settings.read)

Query parameters

wherestring

Filter by an any element

orderstring

Order by an any element

pageinteger

e.g. page=1 – Up to 100 objects will be returned in a single API call

Headers

If-Modified-Sincestring date-time

Only records created or modified since this timestamp will be returned

Response

search results matching criteria

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

  • 351ab145bf72Revision changes
    • info

      the response property /// became required for the status

    • info

      the response property /// became required for the status

  • 8fdef4eb1addRevision changes
    • breaking

      the response property /// became optional for the status

    • breaking

      the response property /// became optional for the status