PayrollAu

Retrieves payroll calendars

get/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, 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

{
  "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.