PApaychex
Worker

Worker Direct Deposit

Update a single direct deposit for an "Active" or "In-Progress" worker. "In-Progress" workers cannot be PATCHED using Content Type "application/json-patch+json"

patch/workers/{workerId}/directdeposits/{directDepositId}

Request

Path parameters

workerIdstring required

ID associated with desired worker.

directDepositIdstring required

The id assigned to the direct deposit for this worker.

Query parameters

effectivitydatestring

The effectivity date. Cannot be used with Content Type "application/json-patch+json"

Request body

directDepositIdstring

The ID for the direct deposit item.

startDatestring date-time

The date that this direct deposit will be applied to future pay periods. This data field cannot be PATCHED.

paymentType'FLAT_DOLLAR_AMOUNT' | 'PERCENTAGE' | 'REMAINDER'

A type of payment for the direct deposit.

accountType'CHECKING' | 'SAVINGS'

Financial institutions account type. This data field cannot be PATCHED.

valuenumber

The amount to be applied to this direct deposit.

routingNumberstring

The financial institutions routing number.This data field cannot be PATCHED.

accountNumberstring

The financial institutions account number.This data field cannot be PATCHED.

prioritystring

The priority order for which the direct deposits will be performed in. When a new direct deposit is added the priority will be assigned. The priority can be modified only by swapping with a different direct deposit using the bulk PATCH. A paymentType of REMAINDER will show a priority of 99 and can't be modified.This data field cannot be PATCHED.

_linksLinks

Example request

{
  "directDepositId": "1020026420675252",
  "startDate": "2017-09-11T00:00:00Z",
  "paymentType": "PERCENTAGE",
  "accountType": "CHECKING",
  "value": 75,
  "routingNumber": "222371863",
  "accountNumber": "123456",
  "priority": "1"
}

Response

Successful operation

Example response

{
  "content": {
    "directDepositId": "1020026420675252",
    "startDate": "2017-09-11T00:00:00Z",
    "paymentType": "PERCENTAGE",
    "accountType": "CHECKING",
    "value": 75,
    "routingNumber": "222371863",
    "accountNumber": "123456",
    "priority": "1"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.