---
title: "Creates a Payroll Calendar"
method: POST
path: "/PayrollCalendars"
tags: ["PayrollAu"]
---

# Creates a Payroll Calendar

`POST /PayrollCalendars`

## Headers

- `Idempotency-Key` string

## Request body

- PayrollCalendar[]
  - `Name` string — Name of the Payroll Calendar
  - `CalendarType` 'WEEKLY' | 'FORTNIGHTLY' | 'FOURWEEKLY' | 'MONTHLY' | 'TWICEMONTHLY' | 'QUARTERLY'
  - `StartDate` string — 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)
  - `PaymentDate` string — The date on which employees will be paid for the upcoming pay period (YYYY-MM-DD)
  - `PayrollCalendarID` string, uuid — Xero identifier
  - `UpdatedDateUTC` string — Last modified timestamp
  - `ReferenceDate` string — Reference Date (YYYY-MM-DD)
  - `ValidationErrors` ValidationError[] — Displays array of validation error messages from the API
    - `Message` string — Validation error message

## Response `200`

A successful request

- PayrollCalendars
  - `PayrollCalendars` PayrollCalendar[]
    - `Name` string — Name of the Payroll Calendar
    - `CalendarType` 'WEEKLY' | 'FORTNIGHTLY' | 'FOURWEEKLY' | 'MONTHLY' | 'TWICEMONTHLY' | 'QUARTERLY'
    - `StartDate` string — 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)
    - `PaymentDate` string — The date on which employees will be paid for the upcoming pay period (YYYY-MM-DD)
    - `PayrollCalendarID` string, uuid — Xero identifier
    - `UpdatedDateUTC` string — Last modified timestamp
    - `ReferenceDate` string — Reference Date (YYYY-MM-DD)
    - `ValidationErrors` ValidationError[] — Displays array of validation error messages from the API
      - `Message` string — Validation error message

## Other responses

- `400` — invalid input, object invalid - TODO

---

[API](https://skmtc.net/xeroapi/apis/xero-payroll-au-api.md) · [All operations](https://skmtc.net/xeroapi/apis/xero-payroll-au-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/xeroapi/xero-payroll-au-api/versions/35651d98854e/schema)