Incentives
Show Incentive
Show an Incentive's details
Scopes
| Category | Read only Scope | Write only Scope (read access implicit) |
|---|---|---|
| Manage expenses (employment_payments) | View incentives (incentive:read) | Manage incentives (incentive:write) |
get/v1/incentives/{id}
Request
- Base URL: https://gateway.remote.com
- URL: https://gateway.remote.com/v1/incentives/{id}
- Auth: HTTP bearer and OAuth 2 (authorization code, authorization URL /auth/oauth2/authorize, token URL /auth/oauth2/token, scopes: https://gateway.remote.com/company.manage, incentive:read, incentive:write, employment_payments, all:write, all:read)
Path parameters
idstring required
Incentive ID
Headers
Authorizationstring required
Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow.
The refresh token needs to have been obtained through the Authorization Code flow.
Response
Success
Example response
{
"data": {
"incentive": {
"amount": 50000,
"amount_tax_type": "net",
"effective_date": "2021-12-20",
"employment_id": "5e55386e-4f4f-4def-92f4-bdc19a5ce77d",
"expected_payout_date": "2021-12-31",
"id": "0073fcb5-b669-4e4a-b963-2a47744e75a1",
"note": "Signing bonus",
"recurring_incentive_id": "1c130827-f95c-4495-b7cb-5876dce686b8",
"status": "pending",
"type": "signing_bonus"
}
}
}Changes
No recorded changes to this operation across all 1 revision of this API.