API Reference

Create Payable Item

post
https://api.everee.com/api/v2/payables

Create a new Payable.

Body Params
string
required

A globally-unique identifier for this payable amount.

string

The unique Everee-generated Worker ID of the worker to pay. Either 'workerId' or 'externalWorkerId' is required.

string

The unique External Worker ID of the worker to pay. Either 'workerId' or 'externalWorkerId' is required.

string
required

A human-readable descriptor for this Payable. This label can appear on worker-facing documents and UIs.

amount
object
required

The currency amount of this payable item. May be a wage amount, reimbursement amount, or one-time deduction amount, depending on the pay code.

string
enum
required

The calculation approach for this payable item. Currently always PRE_CALCULATED, meaning that the payable item's amount field is calculated by you before sending to Everee.

Allowed:
string
required

The pay code for this payable item. See the Pay Codes API for more details.

number
required

Unix epoch timestamp in seconds.

string
required

A custom descriptor for the kind of amount being paid. This could be a category name, a batch ID, or anything else.

unitRate
object

The rate at which the amount was earned, if applicable. Optional.

number

The number of 'units' used to calculate the amount (i.e. hours worked), if applicable. Optional.

number

The ID of the Work Location this payable item is assigned to.

Headers
int64

The company ID to provide for this tenant-scoped endpoint (if applicable)

Responses

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

Updated 22 days ago

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 22 days ago