Deel: Add off-cycle payment
Deel offCycle.createContractOffCyclePayment: arguments, response, policy and SDK examples.
← Off cycle operations · Get started
Operation deel.offcycle_createcontractoffcyclepayment
Provider route: POST /contracts/{contract_id}/off-cycle-payments. 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["offCycle"]["createContractOffCyclePayment"]>[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.offCycle.createContractOffCyclePayment(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.off_cycle.create_contract_off_cycle_payment(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.contract_id | string | Required within parent | |
body | object | Optional | |
body.data | Model | Optional | Expand Add off-cycle payment — request body — body data The off-cycle payment data to submit. |
Referenced models: Add off-cycle payment — request body — body data
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 Add off-cycle payment — 201 response body |
Referenced models: Add off-cycle payment — 201 response body
Schemas
Section titled “Schemas”Add off-cycle payment — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The off-cycle payment data to submit. |
amount | number | Required within parent | The amount of the off-cycle payment. Format: double Minimum: 0 |
date_submitted | string | Required within parent | The date the off-cycle payment is submitted, in ISO-8601 format (YYYY-MM-DD). Format: date |
description | string | Required within parent | A description or reason for the off-cycle payment. |
hourly_report_preset_id | string or null | Optional | Id of an existing preset. Format: uuid |
is_auto_approved | boolean | Optional | If true, the off-cycle payment will be automatically approved as part of the request. |
payment_due_date | string or null | Optional | Due date of the resulting one-off invoice, in ISO-8601 format (YYYY-MM-DD) in the contract timezone. Defaults to today when omitted or null. Must be today or later and, when the contract is active and has an end date, not after that end date. Format: date |
Add off-cycle payment — 201 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Add off-cycle payment — 201 response body — data Details of the newly created off-cycle payment. |
Referenced models: Add off-cycle payment — 201 response body — data
Add off-cycle payment — 201 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of the newly created off-cycle payment. |
created | boolean | Required within parent | Indicates whether the off-cycle payment was successfully created. |
id | string | Optional | The unique identifier of the created off-cycle payment. Format: uuid |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: deel.offcycle_createcontractoffcyclepayment. Catalog operation: offcycle_createcontractoffcyclepayment. 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: ["off-cycle-payments:write"]
Pinned headers: {"X-Version": "2026-01-01"}