Contract.BureauEmployerPagedResponse

Paged list of bureau employer (client) rows for the dashboard table.

Schema

Name / Description Type / Format Example
items BureauEmployerListItem[] {BureauEmployerListItem}
totalCount integer int32 0
pageNum integer int32 0
pageSize integer int32 0
availableSchedules
Pay schedule frequencies present in the current processor/tax-year/search scope (for the Schedule filter dropdown).
 PayPeriods[]

JSON Example 

{
  "items": [
    {
      "bureauSettingsRowVersion": "string",
      "id": "string",
      "name": "string",
      "metadata": {},
      "url": "string"
    }
  ],
  "totalCount": 0,
  "pageNum": 0,
  "pageSize": 0,
  "availableSchedules": []
}

References

Contained in Models

- none -

Consumed by Operations

- none -

Returned by Operations
List Employers (filtered and paged)