View source for Xero Payroll (Australia) Endpoint: PayrollCalendars

== Overview ==

The Xero '''PayrollCalendars''' [[Xero Payroll (Australia) Endpoints|endpoint]] provides the dates of the forthcomming payroll calendars.


== Fields ==

The following fields are available for the PayrollCalendars endpoint.

;PayrollCalendarID
:A [[Field Type: GUID|guid field]] that provides the id of the payroll calendar.

;Name
:A [[Field Type: Text|text field]] that provides the name of the payroll calendar.

;CalendarType
:A [[Field Type: Text|text field]] that indicates the frequency type of the payroll calendar.
:Possible values are:
:* '''WEEKLY'''
:* '''FORTNIGHTLY'''
:* '''FOURWEEKLY'''
:* '''MONTHLY'''
:* '''TWICEMONTHLY'''
:* '''QUARTERLY'''

;StartDate
:A [[Field Type: Date|date field]] that provides the start date of the payroll calendar for the next pay period.

;PaymentDate
:A [[Field Type: Date|date field]] that provides the expected payment date of the payroll calendar for the next pay period.

;ReferenceDate
:A [[Field Type: Date|date field]] that provides the start date of the first pay period for the payroll calendar.

;UpdatedDateUTC
:A [[Field Type: DateTimeOffset|date time field]] that indicates the last time this record was updated.


== Xero API ==

For a detailed run through of the endpoint, you can see the [https://developer.xero.com/documentation/api/payrollau/payrollcalendars Xero API].


== Related Fields ==

:None


== Related Endpoints ==

:[[Xero Payroll (Australia) Endpoint: GetPayRun|GetPayRun]]
:[[Xero Payroll (Australia) Endpoint: GetPayslip|GetPayslip]]
:[[Xero Payroll (Australia) Endpoint: PayRuns|PayRuns]]
:[[Xero Payroll (Australia) Endpoint: PayRunsExpanded|PayRunsExpanded]]
:[[Xero Payroll (Australia) Endpoint: Payslips|Payslips]]


== Related Topics ==

:[[Xero Payroll (Australia) Models]]
:[[Xero Payroll (Australia) Endpoints]]