Update Payable Item by ID

put

https://api.everee.com/api/v2/payables/{externalId}

Update a payable item's data fields. Only unpaid payable items may be updated.

Path Params

externalId

string

required

Body Params

type

string

required

A freeform metadata field.

label

string

required

The human-readable description of this payable item. Displayed on pay stubs, statements, and reports.

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.

payableModel

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:

payCode

string

required

The pay code for this payable item

timestamp

number

required

Unix epoch timestamp in seconds

workLocationId

number

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

Headers

x-everee-tenant-id

int64

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

Responses

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

Language

Credentials

OAuth2

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK