Create gross earning for W-2 payroll

Adds a single "gross earning" record of a single earning type, rate, count (or duration), and optionally an "external ID" that uniquely identifies the earning in your system.

❗️

This API is deprecated. Refer to the Payables API for its replacement.

Body Params
string

Required if "externalWorkerId" is null.

string

Required if "workerId" is null.

date
required
string
enum
required
Allowed:
grossAmount
object
required
string

A unique value that identifies this earning in your system. This value is unique globally within a company instance and cannot be reused.

unitRate
object

The rate at which each unit of this earning was earned. For example, if an earning represents hourly wages, this property would be the hourly pay rate.

string

Decimal value as a string, i.e. "23.25". The number of units earned. For example, if this earning represents hourly wages, this property should be the number of hours.

int32

The ID of the work location this earning should be attributed to. This property only controls how expenses are allocated in GL data, not tax or compliance-related calculations.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
text/plain