Deel: Get EOR Additional Costs
Deel eorHiring.getAdditionalCosts: arguments, response, policy and SDK examples.
← EOR hiring operations · Get started
Operation deel.eorhiring_getadditionalcosts
Provider route: GET /eor/additional-costs/{country}. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/deel with npm, or alter-sdk-deel with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { DeelIntegration } from "@alter-ai/deel";
async function execute(input: Parameters<DeelIntegration["eorHiring"]["getAdditionalCosts"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new DeelIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.eorHiring.getAdditionalCosts(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_deel import DeelIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = DeelIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.eor_hiring.get_additional_costs(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.country | string | Required within parent | Maximum length: 2 Minimum length: 2 Pattern: ^[A-Z]{2}$ |
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand Get EOR Additional Costs — 200 response body |
Referenced models: Get EOR Additional Costs — 200 response body
Schemas
Section titled “Schemas”Get EOR Additional Costs — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Optional | Expand Get EOR Additional Costs — 200 response body — data |
Referenced models: Get EOR Additional Costs — 200 response body — data
Get EOR Additional Costs — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
allowances | array | Optional | |
allowances[] | Model | Each item | Expand Get EOR Additional Costs — 200 response body — data allowances item |
non_statutory | array | Optional | |
non_statutory[] | Model | Each item | Expand Get EOR Additional Costs — 200 response body — data non statutory item |
Referenced models: Get EOR Additional Costs — 200 response body — data allowances item, Get EOR Additional Costs — 200 response body — data non statutory item
Get EOR Additional Costs — 200 response body — data allowances item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
description | string | Optional | Allowance description. |
is_recurring | boolean | Optional | Indicates if the allowance is recurring. |
name | string | Optional | Allowance name. |
optional | boolean | Optional | Indicates if the allowance is optional. |
rule_cost_id | string | Optional | Unique identifier for the allowance. |
skipping_confirmation_text | JSON | Optional | |
skipping_confirmation_text (anyOf 1) | string | Alternative | Confirmation text for opting out of the allowance. |
skipping_confirmation_text (anyOf 2) | null | Alternative | Confirmation text for opting out of the allowance. |
use_contract_currency | boolean | Optional | Indicates if the allowance uses the contract currency. |
value | JSON | Optional | |
value (anyOf 1) | number | Alternative | Allowance value. Format: double |
value (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Get EOR Additional Costs — 200 response body — data non statutory item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
currency | string | Optional | Currency |
description | string | Optional | Allowance description. |
is_recurring | boolean | Optional | Indicates if the allowance is recurring. |
name | string | Optional | Allowance name. |
rule_cost_id | string | Optional | Unique identifier for the allowance. |
use_contract_currency | boolean | Optional | Indicates if the allowance uses the contract currency. |
value | JSON | Optional | |
value (anyOf 1) | number | Alternative | Allowance value. Format: double |
value (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: deel.eorhiring_getadditionalcosts. Catalog operation: eorhiring_getadditionalcosts. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.
Required provider scopes: ["contracts:read"]
Pinned headers: {"X-Version": "2026-01-01"}