Guides

Name / Description	Type / Format	Example
`result`	`string`	`"Success"` `"EarningsBelowThreshold"` `"NotEnoughPayrollData"` `"TaxYearNotSupported"`
`resultDescription`	`string`	`"string"`
`averageEarnings`	`number` double	`0.0`
`threshold`	`number` double	`0.0`
`eligibilityThreshold`	`number` double	`0.0`
`requestedDate`	`string` date	`"2024-11-21"`
`relevantPeriodStart`	`string` date	`"2024-11-21"`
`relevantPeriodEnd`	`string` date	`"2024-11-21"`
`relevantPeriodWeekCount`	`number` double	`0.0`
`relevantPeriodEarnings`	`number` double	`0.0`

JSON Example

{
  "result": "Success",
  "resultDescription": "string",
  "averageEarnings": 0.0,
  "threshold": 0.0,
  "eligibilityThreshold": 0.0,
  "requestedDate": "2024-11-21",
  "relevantPeriodStart": "2024-11-21",
  "relevantPeriodEnd": "2024-11-21",
  "relevantPeriodWeekCount": 0.0,
  "relevantPeriodEarnings": 0.0
}

References

Contained in Models

- none -

Consumed by Operations

- none -

Returned by Operations
Average Weekly Earnings