API Basics

Authentication
Errors
Filtering
Rate Limits
API Versioning
Webhooks
Postman Collection

Assessments API

Assessments Overview
Callback
Order
- Update Assessment Orderpatch
Package
Subscription
- Upsert Subscriptionput
Client Onboarding

Background Check API

Background Check Overview
Client Onboarding
Subscription
Screening Package
Candidate Screening Order
- Updates the Screening Order statuspatch

Company Level Information

Company Information
- Get Company Informationget
Payroll/HR
Cost Centers
- Get Cost Center Codesget
- Upsert Cost Center Codeput
Job Codes

Document Management API

Documents Overview
Documents

Employee Demographic API

Employees
- Get Employees [Batch]get
- Get Employee [Single]get

Partner Onboarding API

Onboarding Overview
Client Onboarding
- Upsert Onboarding Statusput

Pay Entry

Pay Entry
- Create New Payroll Batchpost
- [DEPRECATED] Create New Payroll Batchpost

Pay Setup API

Pay Setup Overview
Recurring Earnings
Recurring Deductions

Punch detail Api

Punch Details Overview
Company Punch Details
- Create Company Punch Detail Operationpost
Employee Punch Details
- Gets Employee Punch Detailsget
- [DEPRECATED] Gets Employee Punch Detailsget

Punch Import API

Punch Import Overview
Punch Import Data Fields
Punch Import
- Create Employee Punch [Batch]post

Scheduling Api

Employee Shifts
- Get Employee Shiftsget
Company Shifts
- Get Shifts by Companyget
Open Shifts
- Get Open Shifts by Companyget

WebLink API

Authentication
Rate Limits
Deduction
Onboarding
- Add Employee to Onboardingpost
Additional Rates
- Add/update additional ratesput
Client Credentials
- Obtain new client secret.post
Company Codes
- Get All Company Codesget
Company-Specific Schema
- Get Company-Specific Open API Documentationget
Custom Fields
- Get All Custom Fieldsget
Direct Deposit
- Get All Direct Depositget
Earnings
Emergency Contacts
- Add/update emergency contactsput
Employee Benefit Setup
- Add/update employee's benefit setupput
Employee Staging
- Add new employee to Web Linkpost
Employee
Local Taxes
Non-Primary State Tax
- Add/update non-primary state taxput
Pay Rate Searches
- Create an employee pay rates searchpost
PayStatements
Primary State Tax
- Add/update primary state taxput
Sensitive Data
- Get sensitive dataget
- Add/update sensitive dataput
Status Searches
- Create an employee statuses searchpost

API Basics

Authentication
Errors
Filtering
Rate Limits
API Versioning
Webhooks
Postman Collection

Assessments API

Assessments Overview
Callback
Order
- Update Assessment Orderpatch
Package
Subscription
- Upsert Subscriptionput
Client Onboarding

Background Check API

Background Check Overview
Client Onboarding
Subscription
Screening Package
Candidate Screening Order
- Updates the Screening Order statuspatch

Company Level Information

Company Information
- Get Company Informationget
Payroll/HR
Cost Centers
- Get Cost Center Codesget
- Upsert Cost Center Codeput
Job Codes

Document Management API

Documents Overview
Documents

Employee Demographic API

Employees
- Get Employees [Batch]get
- Get Employee [Single]get

Partner Onboarding API

Onboarding Overview
Client Onboarding
- Upsert Onboarding Statusput

Pay Entry

Pay Entry
- Create New Payroll Batchpost
- [DEPRECATED] Create New Payroll Batchpost

Pay Setup API

Pay Setup Overview
Recurring Earnings
Recurring Deductions

Punch detail Api

Punch Details Overview
Company Punch Details
- Create Company Punch Detail Operationpost
Employee Punch Details
- Gets Employee Punch Detailsget
- [DEPRECATED] Gets Employee Punch Detailsget

Punch Import API

Punch Import Overview
Punch Import Data Fields
Punch Import
- Create Employee Punch [Batch]post

Scheduling Api

Employee Shifts
- Get Employee Shiftsget
Company Shifts
- Get Shifts by Companyget
Open Shifts
- Get Open Shifts by Companyget

WebLink API

Authentication
Rate Limits
Deduction
Onboarding
- Add Employee to Onboardingpost
Additional Rates
- Add/update additional ratesput
Client Credentials
- Obtain new client secret.post
Company Codes
- Get All Company Codesget
Company-Specific Schema
- Get Company-Specific Open API Documentationget
Custom Fields
- Get All Custom Fieldsget
Direct Deposit
- Get All Direct Depositget
Earnings
Emergency Contacts
- Add/update emergency contactsput
Employee Benefit Setup
- Add/update employee's benefit setupput
Employee Staging
- Add new employee to Web Linkpost
Employee
Local Taxes
Non-Primary State Tax
- Add/update non-primary state taxput
Pay Rate Searches
- Create an employee pay rates searchpost
PayStatements
Primary State Tax
- Add/update primary state taxput
Sensitive Data
- Get sensitive dataget
- Add/update sensitive dataput
Status Searches
- Create an employee statuses searchpost

Get All Direct Deposit

get https://dc1demogw.paylocity.com/api/v2/companies/{companyId}/employees/{employeeId}/directDeposit

Get All Direct Deposit returns main direct deposit and all additional direct depositsfor the selected employee.

Path Params

companyId

string

required

The Paylocity Company Identifier. This is the unique value provided by Paylocity to each specific Payroll Entity.
Allowable Values:
9 char max

employeeId

string

required

The Paylocity Employee ID. This is a unique value per Paylocity Company ID.
Allowable Values:
10 char max

Responses

Response body

object

additionalDirectDeposit

array of objects

Additional Direct Deposits that are not the main Direct Deposit.

additionalDirectDeposit

object

accountNumber

string

Account number, entered without special characters and spaces.
Max length: 17

accountType

string

Account type. Valid values are C (Checking), S (Saving), P (Pay Card).
Max length: 1

amount

number

Amount value to be deposited to the account.
Decimal (12,2)

amountType

string

Amount type to indicate the context of the amount. Common values are F (FLAT), F- (Net Minus), P (Percent).
Max length: 5

blockSpecial

boolean

Indicates if direct deposit should be blocked when special check types such as Bonus are processed.

isSkipPreNote

boolean

Indicates if account will not pre-note.

nameOnAccount

string

Name on the bank account. Defaults to employee's name.
Max length: 30

preNoteDate

string

Date to end the pre-note of the account. Common formats include MM-DD-CCYY, CCYY-MM-DD.

routingNumber

string

ABA Transit Routing Number, entered without dashes or spaces.
Max length: 9

mainDirectDeposit

object

The main Direct Deposit account.

accountNumber

string

Account number, entered without special characters and spaces.
Max length: 17

accountType

string

Account type. Valid values are C (Checking), S (Saving), P (Pay Card).
Max length: 1

blockSpecial

boolean

Indicates if direct deposit should be blocked when special check types such as Bonus are processed.

isSkipPreNote

boolean

Indicates if account will not pre-note.

nameOnAccount

string

Name on the bank account. Defaults to employee's name.
Max length: 30

preNoteDate

string

Date to end the pre-note of the account. Common formats include MM-DD-CCYY, CCYY-MM-DD.

routingNumber

string

ABA Transit Routing Number, entered without dashes or spaces.
Max length: 9

401

Unauthorized

403

Forbidden

Response body

array of objects

object

field

string

The name of the field, or property in the request message that contains an error.

message

string

The error message.

options

array of objects

A list of options associated with this error. These options may indicate valid values for the field, or property that contains an error.

options

object

code

string

The code associated with this option.

description

string

The description of the option.

path

string

The JSON path of the field, or property, that contains an error in the request message.

429

Too Many Requests

Response body

array of objects

object

field

string

The name of the field, or property in the request message that contains an error.

message

string

The error message.

options

array of objects

A list of options associated with this error. These options may indicate valid values for the field, or property that contains an error.

options

object

code

string

The code associated with this option.

description

string

The description of the option.

path

string

The JSON path of the field, or property, that contains an error in the request message.

Updated 7 months ago

Get All Custom Fields

Earnings

Did this page help you?

Language

Credentials

OAuth2

Bearer


xxxxxxxxxx
1
curl --request GET \
2
     --url https://dc1demogw.paylocity.com/api/v2/companies/companyId/employees/employeeId/directDeposit \
3
     --header 'accept: application/json'


xxxxxxxxxx
24
 
1
{
2
  "additionalDirectDeposit": [
3
    {
4
      "accountNumber": "string",
5
      "accountType": "string",
6
      "amount": 0,
7
      "amountType": "string",
8
      "blockSpecial": true,
9
      "isSkipPreNote": true,
10
      "nameOnAccount": "string",
11
      "preNoteDate": "string",
12
      "routingNumber": "string"
13
    }
14
  ],
15
  "mainDirectDeposit": {
16
    "accountNumber": "string",
17
    "accountType": "string",
18
    "blockSpecial": true,
19
    "isSkipPreNote": true,
20
    "nameOnAccount": "string",
21
    "preNoteDate": "string",
22
    "routingNumber": "string"
23
  }
24
}

Updated 7 months ago

Get All Custom Fields

Earnings

Did this page help you?

API Basics
Authentication
Errors
Filtering
Rate Limits
API Versioning
Webhooks
Future Dated Changes
Time Off Approval Webhooks
Payroll Processed Webhooks
Termination Webhooks
Employee Change Webhooks
New Hire Webhooks

Assessments API
Assessments Overview
Callback
Delete Callbackdelete
Get Callbackget
Upsert Callbackput
Order
Update Assessment Orderpatch
Package
Delete Assessment Packagedelete
Get Assessment Packagesget
Upsert Assessment Packages [Bulk]put
Upsert Assessment Packageput
Subscription
Upsert Subscriptionput

Background Check API
Background Check Overview
Client Onboarding
[DEPRECATED] Delete Billing Codedelete
[DEPRECATED] Update Billing Code Statuspatch
Delete Billing Codedelete
Update Billing Code Statuspatch
Get Company Billing Codesget
Upsert Onboarding Statuspost
Create Billing Codespost
Subscription
Delete Webhook for Candidate Screening Orderdelete
Create Webhook for Candidate Screening Orderpost
Get Webhook for Candidate Screening Orderget
Screening Package
Delete Screening Packagedelete
Upsert Screening Packagepost
Upsert Screening Packages [Batch]post
Get Screening Packagesget
Candidate Screening Order
Updates the Screening Order statuspatch

Company Level Information
Company Information
Get Company Informationget
Payroll/HR
Get Workers Compensation Codesget
Get Work Locationsget
Get Tax Codesget
Get Rate Codesget
Get Position Codesget
Get Pay Gradesget
Get Pay Frequency Codesget
Get Earning Codesget
Get Deduction Codesget
Cost Centers
Upsert Cost Center Codeput
Get Cost Center Codesget
Job Codes
Filtering Job Codes
Delete Job Codedelete
Update Job Codeput
Get Job Codes [Batch]get
Get Job Code [Single]get
Create Job Codepost

Document Management API
Documents Overview
Documents
Retrieve a document download URLpost
Get a list of documents filtered by employee for a companyget
Get a list of documents for a companyget

Employee Demographic API
Employees
Get Employee [Single]get
Get Employees [Batch]get

Partner Onboarding API
Onboarding Overview
Client Onboarding
Upsert Onboarding Statusput

Pay Entry
Pay Entry
[DEPRECATED] Create New Payroll Batchpost
Create New Payroll Batchpost

Pay Setup API
Pay Setup Overview
Recurring Earnings
Filtering Earnings
Delete Employee Earning by resourceIDdelete
Update Employee Earning by resourceIDput
Get Employee Earning by resourceIDget
Get Employee Earning [Single]get
Get Employee Earnings [Batch]get
Create Employee Earningpost
Recurring Deductions
Filtering Deductions
Delete Employee Deduction by resourceIddelete
Update Employee Deduction by resourceIdput
Get Employee Deduction by resourceIdget
Get Employee Deduction [Single]get
Get Employee Deduction [Batch]get
Create Employee Deductionpost

Punch detail Api
Punch Details Overview
Company Punch Details
Create Company Punch Detail Operationpost
Employee Punch Details
[DEPRECATED] Gets Employee Punch Detailsget
Gets Employee Punch Detailsget

Punch Import API
Punch Import Overview
Punch Import Data Fields
Punch Import
Create Employee Punch [Batch]post

Scheduling Api
Employee Shifts
Get Employee Shiftsget
Company Shifts
Get Shifts by Companyget
Open Shifts
Get Open Shifts by Companyget

WebLink API
Authentication
Rate Limits
Deduction
Get Deduction for Deduction Codeget
Get All Deductionsget
Delete deduction for deduction code / start datedelete
Add / Update Deductionpost
Onboarding
Add Employee to Onboardingpost
Additional Rates
Add/update additional ratesput
Client Credentials
Obtain new client secret.post
Company Codes
Get All Company Codesget
Company-Specific Schema
Get Company-Specific Open API Documentationget
Custom Fields
Get All Custom Fieldsget
Direct Deposit
Get All Direct Depositget
Earnings
Get Earnings by Earning Codeget
Delete Earning by Earning Code and Start Datedelete
Get Earning by Earning Code and Start Dateget
Add/Update Earningput
Get All Earningsget
Emergency Contacts
Add/update emergency contactsput
Employee Benefit Setup
Add/update employee's benefit setupput
Employee Staging
Add new employee to Web Linkpost
Employee
Update employeepatch
Get employeeget
Add new employeepost
Get all employeesget
Local Taxes
Delete local tax by tax codedelete
Get local taxes by tax codeget
Add new local taxpost
Update Local Taxput
Get all local taxesget
Non-Primary State Tax
Add/update non-primary state taxput
Pay Rate Searches
Create an employee pay rates searchpost
PayStatements
Get employee pay statement summary data for the specified year.get
Get employee pay statement summary data for the specified year and check date.get
Get employee pay statement details data for the specified year.get
Get employee pay statement details data for the specified year and check date.get
Primary State Tax
Add/update primary state taxput
Sensitive Data
Add/update sensitive dataput
Get sensitive dataget
Status Searches
Create an employee statuses searchpost

API Basics
Authentication
Errors
Filtering
Rate Limits
API Versioning
Webhooks
Future Dated Changes
Time Off Approval Webhooks
Payroll Processed Webhooks
Termination Webhooks
Employee Change Webhooks
New Hire Webhooks

Assessments API
Assessments Overview
Callback
Delete Callbackdelete
Get Callbackget
Upsert Callbackput
Order
Update Assessment Orderpatch
Package
Delete Assessment Packagedelete
Get Assessment Packagesget
Upsert Assessment Packages [Bulk]put
Upsert Assessment Packageput
Subscription
Upsert Subscriptionput

Background Check API
Background Check Overview
Client Onboarding
[DEPRECATED] Delete Billing Codedelete
[DEPRECATED] Update Billing Code Statuspatch
Delete Billing Codedelete
Update Billing Code Statuspatch
Get Company Billing Codesget
Upsert Onboarding Statuspost
Create Billing Codespost
Subscription
Delete Webhook for Candidate Screening Orderdelete
Create Webhook for Candidate Screening Orderpost
Get Webhook for Candidate Screening Orderget
Screening Package
Delete Screening Packagedelete
Upsert Screening Packagepost
Upsert Screening Packages [Batch]post
Get Screening Packagesget
Candidate Screening Order
Updates the Screening Order statuspatch

Company Level Information
Company Information
Get Company Informationget
Payroll/HR
Get Workers Compensation Codesget
Get Work Locationsget
Get Tax Codesget
Get Rate Codesget
Get Position Codesget
Get Pay Gradesget
Get Pay Frequency Codesget
Get Earning Codesget
Get Deduction Codesget
Cost Centers
Upsert Cost Center Codeput
Get Cost Center Codesget
Job Codes
Filtering Job Codes
Delete Job Codedelete
Update Job Codeput
Get Job Codes [Batch]get
Get Job Code [Single]get
Create Job Codepost

Document Management API
Documents Overview
Documents
Retrieve a document download URLpost
Get a list of documents filtered by employee for a companyget
Get a list of documents for a companyget

Employee Demographic API
Employees
Get Employee [Single]get
Get Employees [Batch]get

Partner Onboarding API
Onboarding Overview
Client Onboarding
Upsert Onboarding Statusput

Pay Entry
Pay Entry
[DEPRECATED] Create New Payroll Batchpost
Create New Payroll Batchpost

Pay Setup API
Pay Setup Overview
Recurring Earnings
Filtering Earnings
Delete Employee Earning by resourceIDdelete
Update Employee Earning by resourceIDput
Get Employee Earning by resourceIDget
Get Employee Earning [Single]get
Get Employee Earnings [Batch]get
Create Employee Earningpost
Recurring Deductions
Filtering Deductions
Delete Employee Deduction by resourceIddelete
Update Employee Deduction by resourceIdput
Get Employee Deduction by resourceIdget
Get Employee Deduction [Single]get
Get Employee Deduction [Batch]get
Create Employee Deductionpost

Punch detail Api
Punch Details Overview
Company Punch Details
Create Company Punch Detail Operationpost
Employee Punch Details
[DEPRECATED] Gets Employee Punch Detailsget
Gets Employee Punch Detailsget

Punch Import API
Punch Import Overview
Punch Import Data Fields
Punch Import
Create Employee Punch [Batch]post

Scheduling Api
Employee Shifts
Get Employee Shiftsget
Company Shifts
Get Shifts by Companyget
Open Shifts
Get Open Shifts by Companyget

WebLink API
Authentication
Rate Limits
Deduction
Get Deduction for Deduction Codeget
Get All Deductionsget
Delete deduction for deduction code / start datedelete
Add / Update Deductionpost
Onboarding
Add Employee to Onboardingpost
Additional Rates
Add/update additional ratesput
Client Credentials
Obtain new client secret.post
Company Codes
Get All Company Codesget
Company-Specific Schema
Get Company-Specific Open API Documentationget
Custom Fields
Get All Custom Fieldsget
Direct Deposit
Get All Direct Depositget
Earnings
Get Earnings by Earning Codeget
Delete Earning by Earning Code and Start Datedelete
Get Earning by Earning Code and Start Dateget
Add/Update Earningput
Get All Earningsget
Emergency Contacts
Add/update emergency contactsput
Employee Benefit Setup
Add/update employee's benefit setupput
Employee Staging
Add new employee to Web Linkpost
Employee
Update employeepatch
Get employeeget
Add new employeepost
Get all employeesget
Local Taxes
Delete local tax by tax codedelete
Get local taxes by tax codeget
Add new local taxpost
Update Local Taxput
Get all local taxesget
Non-Primary State Tax
Add/update non-primary state taxput
Pay Rate Searches
Create an employee pay rates searchpost
PayStatements
Get employee pay statement summary data for the specified year.get
Get employee pay statement summary data for the specified year and check date.get
Get employee pay statement details data for the specified year.get
Get employee pay statement details data for the specified year and check date.get
Primary State Tax
Add/update primary state taxput
Sensitive Data
Add/update sensitive dataput
Get sensitive dataget
Status Searches
Create an employee statuses searchpost

200Successfully Retrieved

404The employee, or direct deposit does not exist

500Internal Server Error