Deel: List work statement payment policies
Deel contracts.getWorkStatementPaymentPolicies: arguments, response, policy and SDK examples.
← Contracts operations · Get started
Operation deel.contracts_getworkstatementpaymentpolicies_v2026_09_07
Provider route: GET /work-statement-payment-policies. 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["contracts"]["getWorkStatementPaymentPolicies"]>[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.contracts.getWorkStatementPaymentPolicies(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.contracts.get_work_statement_payment_policies(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
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 List work statement payment policies — 200 response body |
Referenced models: List work statement payment policies — 200 response body
Schemas
Section titled “Schemas”List work statement payment policies — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | The organization's work statement payment policies. |
data[] | Model | Each item | Expand List work statement payment policies — 200 response body — data item |
Referenced models: List work statement payment policies — 200 response body — data item
List work statement payment policies — 200 response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A work statement payment policy of the organization. |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | Description of the payment policy. |
description (anyOf 2) | null | Alternative | Description of the payment policy. |
due_days | JSON | Required within parent | |
due_days (anyOf 1) | integer | Alternative | Number of days after cycle end before payment is released. |
due_days (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
due_type | string | Required within parent | How the payment due date is calculated relative to cycle end. Known values: REGULAR, WITHIN_MONTH, AFTER_MONTH, BEFORE_CYCLE_END |
end_day | JSON | Required within parent | |
end_day (anyOf 1) | integer | Alternative | Day the billing cycle ends. 1–31 when end_type is DAY_OF_MONTH, 1–7 when DAY_OF_WEEK or DAY_OF_LAST_WEEK. |
end_day (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
end_type | string | Required within parent | How end_day is interpreted. Known values: DAY_OF_WEEK, DAY_OF_LAST_WEEK, DAY_OF_MONTH |
end_week_parity | JSON | Optional | Week parity constraint for biweekly cycles. Null for non-biweekly scales. |
end_week_parity (anyOf 1) | string | Alternative | Week parity constraint for biweekly cycles. Null for non-biweekly scales. Known values: AUTO, ODD, EVEN |
end_week_parity (anyOf 2) | null | Alternative | |
id | string | Required within parent | The public ID (UUID) of the payment policy. Format: uuid |
name | string | Required within parent | Name of the payment policy. |
scale | string | Required within parent | Payment cycle frequency. Known values: WEEKLY, MONTHLY, BIWEEKLY, SEMIMONTHLY, CALENDAR_MONTH |
semimonthly_first_day | JSON | Optional | |
semimonthly_first_day (anyOf 1) | JSON | Alternative | |
semimonthly_first_day (anyOf 1) (anyOf 1) | integer | Alternative | First payment day of the month for semimonthly cycles. Null for other scales. |
semimonthly_first_day (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
semimonthly_first_day (anyOf 2) | null | Alternative | First payment day of the month for semimonthly cycles. Null for other scales. |
semimonthly_second_day | JSON | Optional | |
semimonthly_second_day (anyOf 1) | JSON | Alternative | |
semimonthly_second_day (anyOf 1) (anyOf 1) | integer | Alternative | Second payment day of the month for semimonthly cycles. Null for other scales. |
semimonthly_second_day (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
semimonthly_second_day (anyOf 2) | null | Alternative | Second payment day of the month for semimonthly cycles. Null for other scales. |
should_pay_before_weekends | boolean | Required within parent | Whether payment is moved earlier when the due date falls on a weekend. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: deel.contracts_getworkstatementpaymentpolicies_v2026_09_07. Catalog operation: contracts_getworkstatementpaymentpolicies_v2026_09_07. 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-09-07"}