PayrollAu

Retrieves payroll calendar by using a unique payroll calendar ID

get/PayrollCalendars/{PayrollCalendarID}

Request

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

Path parameters

PayrollCalendarIDstring uuid required
Example:4ff1e5cc-9835-40d5-bb18-09fdb118db9c

Payroll Calendar id for single object

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.