PayrollAu

Creates a Payroll Calendar

post/PayrollCalendars

Request

  • Base URL: https://api.xero.com/payroll.xro/1.0
  • URL: https://api.xero.com/payroll.xro/1.0/PayrollCalendars
  • 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

Namestring

Name of the Payroll Calendar

CalendarType'WEEKLY' | 'FORTNIGHTLY' | 'FOURWEEKLY' | 'MONTHLY' | 'TWICEMONTHLY' | 'QUARTERLY'
StartDatestring

The start date of the upcoming pay period. The end date will be calculated based upon this date, and the calendar type selected (YYYY-MM-DD)

PaymentDatestring

The date on which employees will be paid for the upcoming pay period (YYYY-MM-DD)

PayrollCalendarIDstring uuid

Xero identifier

UpdatedDateUTCstring

Last modified timestamp

ReferenceDatestring

Reference Date (YYYY-MM-DD)

Example request

[
  {
    "Name": "Fortnightly Calendar",
    "StartDate": "/Date(322560000000+0000)/",
    "PaymentDate": "/Date(322560000000+0000)/",
    "PayrollCalendarID": "e0eb6747-7c17-4075-b804-989f8d4e5d39",
    "UpdatedDateUTC": "/Date(1583967733054+0000)/",
    "ReferenceDate": "/Date(322560000000+0000)/"
  }
]

Response

A successful request

Example response

{
  "PayrollCalendars": [
    {
      "Name": "Fortnightly Calendar",
      "StartDate": "/Date(322560000000+0000)/",
      "PaymentDate": "/Date(322560000000+0000)/",
      "PayrollCalendarID": "e0eb6747-7c17-4075-b804-989f8d4e5d39",
      "UpdatedDateUTC": "/Date(1583967733054+0000)/",
      "ReferenceDate": "/Date(322560000000+0000)/"
    }
  ]
}

Changes

No recorded changes to this operation across all 56 revisions of this API.