---
title: "Return a set of AccrualSummary resources for the given person and date"
method: GET
path: "/operations/accrualSummary"
---

# Return a set of AccrualSummary resources for the given person and date

`GET /operations/accrualSummary`

## Query parameters

- `date` string, date, required
- `personId` string, required

## Response `200`

Expected response to a valid request

- AccrualSummary — Provides an overview of a specific type of Accrual for a specific date.
  - `name` string, required — The user friendly name of this type of Accrual. Intended to be displayed in a user interface
  - `personId` number, required — The identifier of the Person who's Accrual is being summarised
  - `date` string, date, required — The date that this summary covers
  - `measurementUnit` string, required — The way that the balance of an Accrual of this `accrual_type` should be interpreted eg "hours" or "count"
  - `total` number, double — The total amount agreed for the Accrual in the Agreement period.
  - `worked` number, double — The total amount of units worked to date.
  - `totalNetOrGrossOfPH` 'net_of_ph' | 'gross_of_ph' — Shows whether the target is net or gross of public holiday allowence
  - `target` number, double, required — The pro-rated target value for the Accrual. Shows how many units of the Accrual type the worker should have worked (or been sheduled to work) by this date in order to remain on track to meet the target by the end of the agreement period
  - `remainingLowPrecision` integer, required — The balance that is remaining at the given date presented as a rounded number
  - `remainingHighPrecision` number, double, required — The balance that is remaining at the given date presented as a floating point number
  - `targetVariance` number, double, required — Shows how far in surplus (positive number) or deficit (negative number) the worker is against their target
  - `agreementVariance` number, double, required — Shows how far in surplus (positive number) or deficit (negative number) the worker is against their agreement
  - `targetStatus` 'over_target' | 'under_target' | 'on_target', required — Shows whether the worker is over, under or on target

## Other responses

- `default` — unexpected error

---

[API](https://skmtc.net/home-office/apis/accruals.md) · [All operations](https://skmtc.net/home-office/apis/accruals/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/home-office/accruals/revisions/6d04e5812726/schema)