PeriodValue

Schema

Name / Description Type / Format Example
effectiveFrom
The date when these period values are effective
 string date "2024-11-21"
annualValue
The Annual value
 number double 0.0
periodValues
Period values for different pay periods
 object {object}
midYearChanges
Any optional changes to the period values that are effective from a specified date in the middle of a tax year
 PeriodValue[] {PeriodValue}

JSON Example 

{
  "effectiveFrom": "2024-11-21",
  "annualValue": 0.0,
  "periodValues": {},
  "midYearChanges": [
    {
      "effectiveFrom": "2024-11-21",
      "annualValue": 0.0,
      "periodValues": {},
      "midYearChanges": [
        {
          "effectiveFrom": "2024-11-21",
          "annualValue": 0.0,
          "periodValues": {},
          "midYearChanges": [
            {
              "effectiveFrom": "2024-11-21",
              "annualValue": 0.0,
              "periodValues": {},
              "midYearChanges": "error too many levels"
            }
          ]
        }
      ]
    }
  ]
}

References

Contained in Models
PeriodValue
TaxYearConfig
Consumed by Operations

- none -

Returned by Operations

- none -