Deel: List On-Demand Payroll entries
Deel onDemandPayroll.listOnDemandPayrollEntries: arguments, response, policy and SDK examples.
← On demand payroll operations · Get started
Operation deel.ondemandpayroll_listondemandpayrollentries_v2026_07_16
Provider route: GET /on-demand-payroll/contract/{contract_id}/entries. 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["onDemandPayroll"]["listOnDemandPayrollEntries"]>[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.onDemandPayroll.listOnDemandPayrollEntries(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.on_demand_payroll.list_on_demand_payroll_entries(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 |
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 On-Demand Payroll entries — 200 response body |
Referenced models: List On-Demand Payroll entries — 200 response body
Schemas
Section titled “Schemas”List On-Demand Payroll entries — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | List of contracts with their eligible entries. |
data[] | Model | Each item | Expand List On-Demand Payroll entries — 200 response body — data item |
Referenced models: List On-Demand Payroll entries — 200 response body — data item
List On-Demand Payroll entries — 200 response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A contract and its entries eligible for On-Demand Payroll. |
contract_id | string | Required within parent | Public ID (oid) of the contract. |
currency | string | Required within parent | ISO 4217 currency code of the contract. |
employee_name | string | Optional | Full name of the employee. |
entries | array | Required within parent | Eligible entries for the contract. |
entries[] | Model | Each item | Expand Create On-Demand Payroll — 201 response body — data entries item |
has_pending_items | boolean | Required within parent | Whether the contract has entries in a pending state. |
is_odp_enabled | boolean | Required within parent | Whether On-Demand Payroll is enabled for the contract. |
job_title | JSON | Optional | |
job_title (anyOf 1) | string | Alternative | Job title of the employee. |
job_title (anyOf 2) | null | Alternative | Job title of the employee. |
odp_limit | JSON | Optional | |
odp_limit (anyOf 1) | number | Alternative | Maximum total ODP amount allowed, in the contract currency. Format: double |
odp_limit (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
odp_warning_limit | JSON | Optional | |
odp_warning_limit (anyOf 1) | number | Alternative | Amount above which the client is warned (3x the salary per cycle). Format: double |
odp_warning_limit (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
ongoing_odp | JSON | Optional | The ongoing ODP for the contract, if one exists. |
ongoing_odp (anyOf 1) | Model | Alternative | Expand List On-Demand Payroll entries — 200 response body — data item ongoing odp The ongoing ODP for the contract, if one exists |
ongoing_odp (anyOf 2) | null | Alternative | |
salary_advance_limit | JSON | Optional | |
salary_advance_limit (anyOf 1) | number | Alternative | Maximum salary advance allowed, in the contract currency. Format: double |
salary_advance_limit (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
team | JSON | Optional | Team the contract belongs to. |
team (anyOf 1) | Model | Alternative | Expand List On-Demand Payroll entries — 200 response body — data item team Team the contract belongs to |
team (anyOf 2) | null | Alternative |
Referenced models: List On-Demand Payroll entries — 200 response body — data item team Team the contract belongs to, Create On-Demand Payroll — 201 response body — data entries item, List On-Demand Payroll entries — 200 response body — data item ongoing odp The ongoing ODP for the contract, if one exists
List On-Demand Payroll entries — 200 response body — data item team Team the contract belongs to
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Team the contract belongs to. |
id | string | Optional | Public ID of the team. |
name | string | Optional | Name of the team. |
Create On-Demand Payroll — 201 response body — data entries item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | An On-Demand Payroll entry (an adjustment attached to the ODP). |
amount | JSON | Required within parent | |
amount (anyOf 1) | number | Alternative | The entry amount in the contract currency. Format: double |
amount (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
currency | string | Required within parent | ISO 4217 currency code of the entry amount. |
date_of_entry | JSON | Optional | |
date_of_entry (anyOf 1) | string | Alternative | Date the entry applies to (YYYY-MM-DD). Null when not available for the entry. Format: date |
date_of_entry (anyOf 2) | null | Alternative | Date the entry applies to (YYYY-MM-DD). Null when not available for the entry. Format: date |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | Free-text description of the entry. |
description (anyOf 2) | null | Alternative | Free-text description of the entry. |
id | string | Required within parent | Public ID of the On-Demand Payroll entry. |
metadata | Model | Required within parent | Expand Create On-Demand Payroll — 201 response body — data entries item metadata Additional, non-contractual metadata about the entry. |
submitter | JSON | Optional | The person who submitted the entry. |
submitter (anyOf 1) | Model | Alternative | Expand Create On-Demand Payroll — 201 response body — data entries item submitter The person who submitted the entry |
submitter (anyOf 2) | null | Alternative | |
title | string | Required within parent | Short human-readable title of the entry. |
type | string | Required within parent | The adjustment type of the entry. |
uom | string | Required within parent | Unit of measure of the entry amount. Always CURRENCY. Known values: CURRENCY |
Referenced models: Create On-Demand Payroll — 201 response body — data entries item metadata, Create On-Demand Payroll — 201 response body — data entries item submitter The person who submitted the entry
List On-Demand Payroll entries — 200 response body — data item ongoing odp The ongoing ODP for the contract, if one exists
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The ongoing ODP for the contract, if one exists. |
status | string | Optional | Status of the ongoing ODP. Known values: AWAITING_CLIENT_APPROVAL, AWAITING_CLIENT_SUBMISSION, AWAITING_ADJUSTMENTS_TO_BE_READY, AWAITING_DEEL_PROCESSING, DEEL_PROCESSING, REJECTED, CANCELLED, PARTIALLY_APPROVED, APPROVED |
Create On-Demand Payroll — 201 response body — data entries item metadata
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional, non-contractual metadata about the entry. |
category_group_label | JSON | Optional | |
category_group_label (anyOf 1) | string | Alternative | Label of the adjustment category group. |
category_group_label (anyOf 2) | null | Alternative | Label of the adjustment category group. |
category_label | JSON | Optional | |
category_label (anyOf 1) | string | Alternative | Label of the adjustment category. |
category_label (anyOf 2) | null | Alternative | Label of the adjustment category. |
reviewed_at | JSON | Optional | |
reviewed_at (anyOf 1) | string | Alternative | Timestamp of the last review of the entry. Format: date-time |
reviewed_at (anyOf 2) | null | Alternative | Timestamp of the last review of the entry. Format: date-time |
source_service_entry_id | string | Optional | Public ID of the entry in the service it originates from (for example, the adjustment ID for an adjustment entry). Use it to correlate the entry with the source resource. |
submission_date | JSON | Optional | |
submission_date (anyOf 1) | string | Alternative | Timestamp when the entry was submitted. Format: date-time |
submission_date (anyOf 2) | null | Alternative | Timestamp when the entry was submitted. Format: date-time |
type | string | Optional | The adjustment type of the entry. |
vendor_name | JSON | Optional | |
vendor_name (anyOf 1) | string | Alternative | Vendor associated with the entry, when applicable. |
vendor_name (anyOf 2) | null | Alternative | Vendor associated with the entry, when applicable. |
Create On-Demand Payroll — 201 response body — data entries item submitter The person who submitted the entry
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The person who submitted the entry. |
id | JSON | Optional | |
id (anyOf 1) | string | Alternative | Public ID of the submitter, when available. |
id (anyOf 2) | null | Alternative | Public ID of the submitter, when available. |
name | string | Optional | Full name of the submitter. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: deel.ondemandpayroll_listondemandpayrollentries_v2026_07_16. Catalog operation: ondemandpayroll_listondemandpayrollentries_v2026_07_16. 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: ["on-demand-payroll:read"]
Pinned headers: {"X-Version": "2026-07-16"}