The Earning object represents an amount of money earned by an employee for work performed at a specific location. Please see our Guide on Structuring Earnings for more information about use cases.
{
"amount": "2500.00",
"piece_units": null,
"hours": 40.0,
"type": "hourly",
"code": null,
"description": null,
"earning_code": null,
"earning_rate": null,
"workplace": "wrk_TPdFwcg3AzN8UJ5hs2Ru",
"tip_credit_amount": null,
"metadata": {}
}
| Attribute | Description |
|---|---|
| amount string | Amount earned for this earning Must be greater than 0 if type is not non_hourly_regular |
| piece_units float | Number of units of work produced. Required if type is piece |
| hours float | Number of hours worked for this earning Required when using an hourly-type earning |
| type string | Type of earning. Can be one of the following earning types in types of earnings Can be null if earning_code is provided |
| code string | Deprecated - replaced by earning_code |
| description string | Readable description of the earning code that will show up on the paystub |
| earning_code string | The earning code ID which will be used to aggregate earnings on the paystub Can be null if type is provided |
| earning_rate string | The earning rate ID which will be used to calculate the gross wage. Required if type is piece |
| workplace string | ID of the workplace where work for this earning was performed |
| tip_credit_amount string | Amount of tip credit being taken by the employer. Required if the type is tip_credit_adjustmentSee Working with Tip Credit for more information |
| metadata object | Additional loosely structured information to associate with the earning See our Guide on Metadata for more information |