PayrollAu

Creates a pay item

Changed on
post/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)

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

  • 351ab145bf72Revision changes
    • breaking

      the request property // became required

    • breaking

      the request property // became required

    • 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

    • info

      the request property // became optional

    • info

      the request property // became optional