---
title: "Predict-match a TimesheetPayReturnDetail record"
method: POST
path: "/resource/TimesheetPayReturnDetail/PREDICT"
tags: ["TimesheetPayReturnDetail"]
---

# Predict-match a TimesheetPayReturnDetail record

`POST /resource/TimesheetPayReturnDetail/PREDICT`

## Request

- Base URL: `https://your-subdomain.deputy.deputy.com/api/v1`
- URL: `https://your-subdomain.deputy.deputy.com/api/v1/resource/TimesheetPayReturnDetail/PREDICT`
- Auth: one of:
  - HTTP bearer
  - OAuth 2
    - Authorization code: `https://once.deputy.com/my/oauth/login`
    - Token URL: `https://once.deputy.com/my/oauth/access_token`

Returns the closest matching existing record for a partial payload. Used by upsert-style integrations to find an existing row before creating.

## Request body

- TimesheetPayReturnDetail
  - `Id` integer, required
  - `TimesheetPayReturnId` integer, required
  - `StpClass` string
  - `StpCode` string
  - `IsMultiplier` boolean
  - `MultiplierValue` number, double
  - `Rate` number, double
  - `PayRate` string, required
  - `RemunerationType` integer, required
  - `RateType` integer
  - `RateTag` string
  - `ExportCode` string
  - `Level` string, required
  - `PayrollId` string
  - `TimesheetPayReturn` object

## Response `200`

Success

- TimesheetPayReturnDetail
  - `Id` integer, required
  - `TimesheetPayReturnId` integer, required
  - `StpClass` string
  - `StpCode` string
  - `IsMultiplier` boolean
  - `MultiplierValue` number, double
  - `Rate` number, double
  - `PayRate` string, required
  - `RemunerationType` integer, required
  - `RateType` integer
  - `RateTag` string
  - `ExportCode` string
  - `Level` string, required
  - `PayrollId` string
  - `TimesheetPayReturn` object

## Other responses

- `400`: Bad request
- `401`: Authentication required or invalid token
- `403`: Forbidden — token lacks access to this resource
- `404`: Resource not found

---

[API](https://skmtc.dev/deputy/apis/deputy-v1-resource-api.md) - [All operations](https://skmtc.dev/deputy/apis/deputy-v1-resource-api/llms.txt) - [OpenAPI document](https://skmtc.dev/deputy/apis/deputy-v1-resource-api/revisions/5d8e44000786?raw)