Skip to content

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.

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 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.on_demand_payroll.list_on_demand_payroll_entries(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

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand List On-Demand Payroll entries — 200 response body

Referenced models: List On-Demand Payroll entries — 200 response body

List On-Demand Payroll entries — 200 response body
FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentList of contracts with their eligible entries.
data[]ModelEach itemExpand 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
FieldTypePresenceDescription and constraints
$objectRootA contract and its entries eligible for On-Demand Payroll.
contract_idstringRequired within parentPublic ID (oid) of the contract.
currencystringRequired within parentISO 4217 currency code of the contract.
employee_namestringOptionalFull name of the employee.
entriesarrayRequired within parentEligible entries for the contract.
entries[]ModelEach itemExpand Create On-Demand Payroll — 201 response body — data entries item
has_pending_itemsbooleanRequired within parentWhether the contract has entries in a pending state.
is_odp_enabledbooleanRequired within parentWhether On-Demand Payroll is enabled for the contract.
job_titleJSONOptional
job_title (anyOf 1)stringAlternativeJob title of the employee.
job_title (anyOf 2)nullAlternativeJob title of the employee.
odp_limitJSONOptional
odp_limit (anyOf 1)numberAlternativeMaximum total ODP amount allowed, in the contract currency.
Format: double
odp_limit (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
odp_warning_limitJSONOptional
odp_warning_limit (anyOf 1)numberAlternativeAmount above which the client is warned (3x the salary per cycle).
Format: double
odp_warning_limit (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
ongoing_odpJSONOptionalThe ongoing ODP for the contract, if one exists.
ongoing_odp (anyOf 1)ModelAlternativeExpand 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)nullAlternative
salary_advance_limitJSONOptional
salary_advance_limit (anyOf 1)numberAlternativeMaximum salary advance allowed, in the contract currency.
Format: double
salary_advance_limit (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
teamJSONOptionalTeam the contract belongs to.
team (anyOf 1)ModelAlternativeExpand List On-Demand Payroll entries — 200 response body — data item team Team the contract belongs to
team (anyOf 2)nullAlternative

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
FieldTypePresenceDescription and constraints
$objectRootTeam the contract belongs to.
idstringOptionalPublic ID of the team.
namestringOptionalName of the team.
Create On-Demand Payroll — 201 response body — data entries item
FieldTypePresenceDescription and constraints
$objectRootAn On-Demand Payroll entry (an adjustment attached to the ODP).
amountJSONRequired within parent
amount (anyOf 1)numberAlternativeThe entry amount in the contract currency.
Format: double
amount (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
currencystringRequired within parentISO 4217 currency code of the entry amount.
date_of_entryJSONOptional
date_of_entry (anyOf 1)stringAlternativeDate the entry applies to (YYYY-MM-DD). Null when not available for the entry.
Format: date
date_of_entry (anyOf 2)nullAlternativeDate the entry applies to (YYYY-MM-DD). Null when not available for the entry.
Format: date
descriptionJSONOptional
description (anyOf 1)stringAlternativeFree-text description of the entry.
description (anyOf 2)nullAlternativeFree-text description of the entry.
idstringRequired within parentPublic ID of the On-Demand Payroll entry.
metadataModelRequired within parentExpand Create On-Demand Payroll — 201 response body — data entries item metadata
Additional, non-contractual metadata about the entry.
submitterJSONOptionalThe person who submitted the entry.
submitter (anyOf 1)ModelAlternativeExpand Create On-Demand Payroll — 201 response body — data entries item submitter The person who submitted the entry
submitter (anyOf 2)nullAlternative
titlestringRequired within parentShort human-readable title of the entry.
typestringRequired within parentThe adjustment type of the entry.
uomstringRequired within parentUnit 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
FieldTypePresenceDescription and constraints
$objectRootThe ongoing ODP for the contract, if one exists.
statusstringOptionalStatus 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
FieldTypePresenceDescription and constraints
$objectRootAdditional, non-contractual metadata about the entry.
category_group_labelJSONOptional
category_group_label (anyOf 1)stringAlternativeLabel of the adjustment category group.
category_group_label (anyOf 2)nullAlternativeLabel of the adjustment category group.
category_labelJSONOptional
category_label (anyOf 1)stringAlternativeLabel of the adjustment category.
category_label (anyOf 2)nullAlternativeLabel of the adjustment category.
reviewed_atJSONOptional
reviewed_at (anyOf 1)stringAlternativeTimestamp of the last review of the entry.
Format: date-time
reviewed_at (anyOf 2)nullAlternativeTimestamp of the last review of the entry.
Format: date-time
source_service_entry_idstringOptionalPublic 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_dateJSONOptional
submission_date (anyOf 1)stringAlternativeTimestamp when the entry was submitted.
Format: date-time
submission_date (anyOf 2)nullAlternativeTimestamp when the entry was submitted.
Format: date-time
typestringOptionalThe adjustment type of the entry.
vendor_nameJSONOptional
vendor_name (anyOf 1)stringAlternativeVendor associated with the entry, when applicable.
vendor_name (anyOf 2)nullAlternativeVendor associated with the entry, when applicable.
Create On-Demand Payroll — 201 response body — data entries item submitter The person who submitted the entry
FieldTypePresenceDescription and constraints
$objectRootThe person who submitted the entry.
idJSONOptional
id (anyOf 1)stringAlternativePublic ID of the submitter, when available.
id (anyOf 2)nullAlternativePublic ID of the submitter, when available.
namestringOptionalFull name of the submitter.

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

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.