Skip to content

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.

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 os
from alter_sdk import App
from 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()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.contract_idstringRequired within parent
bodyobjectOptional
body.dataModelOptionalExpand 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 media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Add off-cycle payment — 201 response body

Referenced models: Add off-cycle payment — 201 response body

Add off-cycle payment — request body — body data
FieldTypePresenceDescription and constraints
$objectRootThe off-cycle payment data to submit.
amountnumberRequired within parentThe amount of the off-cycle payment.
Format: double
Minimum: 0
date_submittedstringRequired within parentThe date the off-cycle payment is submitted, in ISO-8601 format (YYYY-MM-DD).
Format: date
descriptionstringRequired within parentA description or reason for the off-cycle payment.
hourly_report_preset_idstring or nullOptionalId of an existing preset.
Format: uuid
is_auto_approvedbooleanOptionalIf true, the off-cycle payment will be automatically approved as part of the request.
payment_due_datestring or nullOptionalDue 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
FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand 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
FieldTypePresenceDescription and constraints
$objectRootDetails of the newly created off-cycle payment.
createdbooleanRequired within parentIndicates whether the off-cycle payment was successfully created.
idstringOptionalThe unique identifier of the created off-cycle payment.
Format: uuid

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"}

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.