Deel: Get amendment data points configuration by country
Deel eor.getAmendmentDataPointsConfigurationByCountry: arguments, response, policy and SDK examples.
← EOR operations · Get started
Operation deel.eor_getamendmentdatapointsconfigurationbycountry_v2026_05_06
Provider route: GET /eor/contracts/amendments/data-points/configuration. 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["eor"]["getAmendmentDataPointsConfigurationByCountry"]>[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.eor.getAmendmentDataPointsConfigurationByCountry(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.get_amendment_data_points_configuration_by_country(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
query | object | Optional | Additional keys: not allowed |
query.countries | array | Optional | |
query.countries[] | string | Each item | Maximum length: 2 Minimum length: 2 |
query.enabled | boolean | Optional | |
query.limit | integer | Optional | Default: 20 Maximum: 100 Minimum: 1 |
query.cursor | string | Optional |
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 amendment data points configuration by country — 200 response body |
Referenced models: Get amendment data points configuration by country — 200 response body
Schemas
Section titled “Schemas”Get amendment data points configuration by country — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Get amendment data points configuration by country — 200 response body — data |
has_more | boolean | Required within parent | Whether more pages are available |
next_cursor | JSON | Required within parent | |
next_cursor (anyOf 1) | string | Alternative | Opaque cursor to pass as the cursor query param to fetch the next page. null when on the last page. |
next_cursor (anyOf 2) | null | Alternative | Opaque cursor to pass as the cursor query param to fetch the next page. null when on the last page. |
total_count | JSON | Required within parent | |
total_count (anyOf 1) | integer | Alternative | Total number of countries with amendment settings in the database |
total_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Referenced models: Get amendment data points configuration by country — 200 response body — data
Get amendment data points configuration by country — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
settings | array | Required within parent | List of countries with their amendment data points configuration |
settings[] | Model | Each item | Expand Get amendment data points configuration by country — 200 response body — data settings item |
Referenced models: Get amendment data points configuration by country — 200 response body — data settings item
Get amendment data points configuration by country — 200 response body — data settings item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
country | string | Required within parent | ISO 3166-1 alpha-2 country code |
created_at | JSON | Required within parent | |
created_at (anyOf 1) | string | Alternative | Timestamp when the country settings row was created. null when no DB row exists. Format: date-time |
created_at (anyOf 2) | null | Alternative | Timestamp when the country settings row was created. null when no DB row exists. Format: date-time |
data_points | array | Required within parent | Amendment data points configured for this country |
data_points[] | Model | Each item | Expand Get amendment data points configuration by country — 200 response body — data settings item data points item |
id | JSON | Required within parent | |
id (anyOf 1) | string | Alternative | Database record ID for this country's settings. null when no settings row exists and defaults are returned. Format: uuid |
id (anyOf 2) | null | Alternative | Database record ID for this country's settings. null when no settings row exists and defaults are returned. Format: uuid |
updated_at | JSON | Required within parent | |
updated_at (anyOf 1) | string | Alternative | Timestamp when the country settings row was last updated. null when no DB row exists. Format: date-time |
updated_at (anyOf 2) | null | Alternative | Timestamp when the country settings row was last updated. null when no DB row exists. Format: date-time |
Referenced models: Get amendment data points configuration by country — 200 response body — data settings item data points item
Get amendment data points configuration by country — 200 response body — data settings item data points item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
is_enabled | boolean | Required within parent | Whether at least one amendment item within this data point is enabled |
item | Model | Required within parent | Expand Get amendment data points configuration by country — 200 response body — data settings item data points item item Data point identifier |
metadata | Model | Optional | Expand Get amendment data points configuration by country — 200 response body — data settings item data points item metadata Additional configuration for the data point. Present only for CUSTOM. |
types | array | Required within parent | Processing type configuration per amendment item within this data point |
types[] | Model | Each item | Expand Get amendment data points configuration by country — 200 response body — data settings item data points item types item |
Referenced models: Get amendment data points configuration by country — 200 response body — data settings item data points item item, Get amendment data points configuration by country — 200 response body — data settings item data points item metadata, Get amendment data points configuration by country — 200 response body — data settings item data points item types item
Get amendment data points configuration by country — 200 response body — data settings item data points item item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | string | Root | Data point identifier Known values: SALARY, START_DATE, END_DATE, HOLIDAYS, SCOPE, JOB_TITLE, VARIABLE_COMPENSATIONS, CUSTOM, CURRENCY, TIME_OFF_TYPE, FIXED_ALLOWANCES, PROBATION_PERIOD, SENIORITY_ID, WORK_HOURS_PER_WEEK, EMPLOYMENT_STATE, EMPLOYMENT_TYPE, EMPLOYEE_NATIONALITY, NOTICE_PERIOD_DURING_PROBATION, NOTICE_PERIOD_AFTER_PROBATION, NOTICE_PERIOD_TYPE, WORK_SCHEDULE, HOURLY_RATE, SENIORITY_DATE, JOB_CATEGORY, JOB_CODE |
Get amendment data points configuration by country — 200 response body — data settings item data points item metadata
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional configuration for the data point. Present only for CUSTOM. |
possible_options | array | Optional | Allowed subject values for a custom amendment item |
possible_options[] | string | Each item | Known values: START_DATE, END_DATE, BENEFITS, PROBATION_PERIOD, VARIABLE_COMPENSATIONS, INCENTIVE_PLAN, SALARY, FIXED_ALLOWANCES, JOB_TITLE, SENIORITY_ID, SENIORITY_DATE, JOB_CODE, JOB_CATEGORY, JOB_SCOPE, EMPLOYMENT_TYPE, PERSONAL_DATA, OTHER |
Get amendment data points configuration by country — 200 response body — data settings item data points item types item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amendment_item | string | Required within parent | Amendment item identifier |
type | string | Required within parent | Processing type. AUTOMATED means no explicit configuration — processed automatically. Known values: AUTOMATED, INSTANT, LEGAL, NO_AUTOMATION, DISABLED_AMENDMENTS |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: deel.eor_getamendmentdatapointsconfigurationbycountry_v2026_05_06. Catalog operation: eor_getamendmentdatapointsconfigurationbycountry_v2026_05_06. 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-05-06"}