AttachmentOrderPayment

Used to represent a payment towards an Attachment of Earnings Order (AEO)

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 "2026-06-04"
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 "2026-06-04"
error
If we received an error from HMRC when checking for notices, it'll be displayed here
 string "string"

JSON Example 

{
  "enabled": true,
  "retrieveFrom": "2026-06-04",
  "autoApply": true,
  "lastChecked": "2026-06-04",
  "error": "string"
}

References

Contained in Models

- none -

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