---
title: "Get Pay Return Rates"
method: POST
path: "/tsa/v2/timesheets/{id}:get-pay-return-rates"
tags: ["Timesheet Get Pay Return Rates"]
---

# Get Pay Return Rates

`POST /tsa/v2/timesheets/{id}:get-pay-return-rates`

## Request

- Base URL: `https://your-subdomain.deputy.deputy.com/api`
- URL: `https://your-subdomain.deputy.deputy.com/api/tsa/v2/timesheets/{id}:get-pay-return-rates`
- Auth: API key in header `OAuth`

Get the pay return rates for a specific timesheet.

## Path parameters

- `id` integer, required

## Request body

- GetPayReturnRatesRequestPayReturnRatesRequestBody
  - `setProperties` TsaTimesheetPropertyRequest
    - `startTime` string, int64: unix epoch timestamp, seconds
    - `endTime` string, int64: unix epoch timestamp, seconds
    - `operationalUnitId` integer: operational unit (area) ID
    - `setBreaks` TsaTimesheetBreaksRequest
      - `breaks` ModelTimesheetBreak[]: passing an empty array here will delete all breaks for the timesheet.
        - `duration` integer
        - `startTimeOffset` integer
        - `breakType` 'NO_TYPE' | 'MEAL_BREAK' | 'REST_BREAK'
      - `totalDurationMealBreak` integer: total duration of meal break in minutes
    - `employeeId` integer
    - `leaveRuleId` integer: leave rule (leave type) ID
    - `employeeComment` string: employee comment for the timesheet
  - `setPayReturns` TsaTimesheetPayReturnOverrideRequest
    - `payReturnOverrides` ModelPayReturnOverride[]: passing an empty array here will cause an approval with no pay returns.
      - `payRuleId` integer
      - `value` number, float

## Response `200`

A successful response.

- TsaGetPayReturnRatesResponse
  - `data` GetPayReturnRatesResponsePayReturnRatesResponseBody
    - `rateByPayRuleId` object
  - `success` boolean

---

[API](https://skmtc.dev/deputy/apis/deputy-v2-api.md) - [All operations](https://skmtc.dev/deputy/apis/deputy-v2-api/llms.txt) - [OpenAPI document](https://skmtc.dev/deputy/apis/deputy-v2-api/revisions/78f0278f4608?raw)