Update Incentive

put

https://gateway.remote.com/v1/incentives/{id}

Updates an Incentive.

Incentives use the currency of the employment specified provided in the employment_id field.

The API doesn't support updating paid incentives.

Scopes

Category	Read only Scope	Write only Scope (read access implicit)
Manage expenses (`employment_payments`)	-	Manage incentives (`incentive:write`)

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

Incentive ID

Body Params

Incentive

amount

integer

The amount (in the currency of the employment) to be given to the employee.

This field accepts fractional amounts as well. However to avoid precision issues
and errors that can arise from storing fractional amounts, the Remote API only
accepts currencies and their fractional amounts as integers. This means you
should append fractional amounts to the end of the amount you're passing in with
this field.

For example, if the incentive you're offering is EUR 500.25, you would specify 50025 as
the amount for this field.

amount_tax_type

string

enum

Whether the amount given accounts for taxes or not.

gross indicates that the amount given is the amount to be paid before taxes
are subtracted.

net indicates that the amount given is the amount which will be paid to the
employee after taxes. Remote will gross this up to ensure the taxes are
included and employee receives the amount requested without further reduction.

Allowed:

effective_date

date

The date at which the incentive should take effect.

Note that the incentive is not paid out on the effective date, but during the
next payroll cycle. The effective date determines which payroll cycle the
incentive will be paid out in.

The effective date needs to be today or a future date.

Note for recurring incentives: since the months don't have the same amount of days,
if day of month of effective_date is one of [28, 29, 30, 31] it will be transformed to
the last day of each month, avoiding the possibility of skipping a month in the recurrence.

note

string | null

period_end

date | null

The end date of the incentive period (month, quarter, half-year or year)

period_start

date | null

The start date of the incentive period (month, quarter, half-year or year)

type

string

A valid type according to the payment frequency

Responses

Callback

Language

Credentials

URL

Loading…

Response

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

application/json

200Success

400Bad Request

401Unauthorized

404Not Found

409Conflict

422Unprocessable Entity

429Too many requests