Upsert Earning

put

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

Upsert Earning API sends new or updated employee earnings information directly to Paylocity Payroll/HR solution.

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

Body Params

Earning Model

The employee earning model

agency

string

Third-party agency associated with earning. Must match Company setup.
Max length: 10

amount

number

Value that matches CalculationCode to add to gross wages. For percentage (%), enter whole number (10 = 10%).
Decimal(12,2)

annualMaximum

number

Year to Date dollar amount not to be exceeded for an earning in the calendar year. Used only with company driven maximums.
Decimal(12,2)

calculationCode

string

Defines how earnings are calculated. Common values are % (percentage of gross), flat (flat dollar amount). Defaulted to the Company setup calcCode for earning.
Max length: 20

costCenter1

string

Cost Center associated with earning. Must match Company setup.
Max length: 10

costCenter2

string

Cost Center associated with earning. Must match Company setup.
Max length: 10

costCenter3

string

Cost Center associated with earning. Must match Company setup.
Max length: 10

earningCode

string

required

Earning code. Must match Company setup.
Max length: 10

effectiveDate

string

Date earning is active. Defaulted to run date or check date based on Company setup. Common formats are MM-DD-CCYY, CCYY-MM-DD.

endDate

string

Stop date of an earning. Common formats are MM-DD-CCYY, CCYY-MM-DD.

frequency

string

Needed if earning is applied differently from the payroll frequency (one time earning for example).
Max length: 5

goal

number

Dollar amount. The employee earning will stop when the goal amount is reached.
Decimal(12,2)

hoursOrUnits

number

The value is used in conjunction with the Rate field. When entering Group Term Life Insurance (GTL), it should contain the full amount of the group term life insurance policy.
Decimal(12,2)

isSelfInsured

boolean

Used for ACA. If not entered, defaulted to Company earning setup.

jobCode

string

Job code associated with earnings. Must match Company setup.
Max length: 20

miscellaneousInfo

string

Information to print on the check stub if agency is set up for this earning.
Max length: 50

paidTowardsGoal

number

Amount already paid to employee toward goal.
Decimal(12,2)

payPeriodMaximum

number

Maximum amount of the earning on a single paycheck.
Decimal(12,2)

payPeriodMinimum

number

Minimum amount of the earning on a single paycheck.
Decimal(12,2)

rate

number

Rate is used in conjunction with the hoursOrUnits field.
Decimal(12,2)

rateCode

string

Rate Code applies to additional pay rates entered for an employee. Must match Company setup.
Max length: 10

startDate

string

required

Start date of an earning based on payroll calendar. Common formats are MM-DD-CCYY, CCYY-MM-DD.

Responses

200

Successfully added or updated

401

Unauthorized

403

Forbidden

429

Too Many Requests

400Bad Request

500Internal Server Error