Guides

Name / Description	Type / Format	Example
`payPeriod`	`string`	`"Custom"` `"Monthly"` `"FourWeekly"` `"Fortnightly"` `"Weekly"` `"Daily"`
`taxYear`	`string`	`"Year2017"` `"Year2018"` `"Year2019"` `"Year2020"` `"Year2021"` `"Year2022"` `"Year2023"` `"Year2024"`
`fromPeriod` The start Tax Month of report data.	`integer` int32	`0`
`toPeriod` The end Tax Month of report data.	`integer` int32	`0`
`reportFormat`	`string`	`"Json"` `"Csv"` `"Pdf"`
`sortBy`	`string`	`"PayrollCode"` `"LastName"` `"Department"`
`sortDescending` Defines whether to sort the data in descending order. Defaults to false.	`boolean`	`true`
`ordinal` Indicates whether this uses first, second, third (etc.) PaySchedule for this PayPeriod.	`integer` int32	`0`
`forCis` If true then CIS Subcontractors are reported on.	`boolean`	`true`

JSON Example

{
  "payPeriod": "Custom",
  "taxYear": "Year2017",
  "fromPeriod": 0,
  "toPeriod": 0,
  "reportFormat": "Json",
  "sortBy": "PayrollCode",
  "sortDescending": true,
  "ordinal": 0,
  "forCis": true
}

References

Contained in Models

- none -

Consumed by Operations
Gross To Net async (beta)

Returned by Operations

- none -