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

# Predict-match a EmployeePaycycle record

`POST /resource/EmployeePaycycle/PREDICT`

## Request

- Base URL: `https://your-subdomain.deputy.deputy.com/api/v1`
- URL: `https://your-subdomain.deputy.deputy.com/api/v1/resource/EmployeePaycycle/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

- EmployeePaycycle
  - `Id` integer, required
  - `EmployeeId` integer, required
  - `EmployeeAgreementId` integer, required
  - `PeriodId` integer, required
  - `RecommendedLoadings` boolean
  - `Timesheets` integer
  - `TimesheetsTimeApproved` integer
  - `TimesheetsPayApproved` integer, required
  - `PaycycleRules` integer
  - `PaycycleRulesApproved` integer
  - `Exported` boolean
  - `ExportId` integer
  - `Paid` boolean
  - `TimeTotal` number, double
  - `CostTotal` number, double
  - `EmployeeAgreementHistoryId` integer, required
  - `Creator` integer
  - `Created` string, date-time
  - `Modified` string, required
  - `Employee` object
  - `EmployeeAgreement` object
  - `Period` object

## Response `200`

Success

- EmployeePaycycle
  - `Id` integer, required
  - `EmployeeId` integer, required
  - `EmployeeAgreementId` integer, required
  - `PeriodId` integer, required
  - `RecommendedLoadings` boolean
  - `Timesheets` integer
  - `TimesheetsTimeApproved` integer
  - `TimesheetsPayApproved` integer, required
  - `PaycycleRules` integer
  - `PaycycleRulesApproved` integer
  - `Exported` boolean
  - `ExportId` integer
  - `Paid` boolean
  - `TimeTotal` number, double
  - `CostTotal` number, double
  - `EmployeeAgreementHistoryId` integer, required
  - `Creator` integer
  - `Created` string, date-time
  - `Modified` string, required
  - `Employee` object
  - `EmployeeAgreement` object
  - `Period` 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)