PayGradesReportReportResponse

Used to encapsulate a response for any of the reports.
See the Introduction Guide for Reports for more details

Schema

Name / Description Type / Format Example
enabled
If enabled, we'll automatically retrieve DPS notices from HMRC for you
 boolean true
retrieveFrom
The date from which notices should be retrieved
 string date "2025-08-29"
autoApply
If enabled, we'll automatically apply DPSNotices before starting a payrun that covers the EffectiveDate
 boolean true
lastChecked
The time we last checked for notices
 string date "2025-08-29"
error
If we received an error from HMRC when checking for notices, it'll be displayed here
 string "string"

JSON Example 

{
  "enabled": true,
  "retrieveFrom": "2025-08-29",
  "autoApply": true,
  "lastChecked": "2025-08-29",
  "error": "string"
}

References

Contained in Models

- none -

Consumed by Operations
Update DPS Settings
Returned by Operations
Get DPS Settings
Update DPS Settings