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 custom descriptor for the kind of amount being paid. This could be a category name, a batch ID, or anything else.

string
required

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

boolean
required

Whether this payable amount has been approved for payout. Specify 'true' in most cases.

earningAmount
object
required

The gross amount to pay.

unitRate
object

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

number

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

string
enum
required
Allowed:
string
enum
required
number
required

Unix epoch timestamp in seconds

number

The ID of the Work Location this Payable 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 7 months 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 7 months ago