Skip to content

Deel: Gets G2 N report data for a given payroll cycle by it's ID

Deel reports.getsG2NreportDataForAgivenPayrollCycleByItsId: arguments, response, policy and SDK examples.

← Reports operations · Get started

Operation deel.reports_getsg2nreportdataforagivenpayrollcyclebyitsid_v2026_01_01

Provider route: GET /reports/payroll/cycles/{cycle_id}/gross-to-net. 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["reports"]["getsG2NreportDataForAgivenPayrollCycleByItsId"]>[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.reports.getsG2NreportDataForAgivenPayrollCycleByItsId(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.reports.gets_g2_nreport_data_for_agiven_payroll_cycle_by_its_id(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.cycle_idstringRequired within parentFormat: uuid
queryobjectOptionalAdditional keys: not allowed
query.limitintegerOptionalDefault: 20
Maximum: 100
Minimum: 1
query.cursorstringOptional

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

FieldTypePresenceDescription and constraints
$ModelRootExpand Gets G2 N report data for a given payroll cycle by it’s ID — 200 response body

Referenced models: Gets G2 N report data for a given payroll cycle by it’s ID — 200 response body

Gets G2 N report data for a given payroll cycle by it's ID — 200 response body
FieldTypePresenceDescription and constraints
$objectRoot
created_atstringRequired within parentTimestamp when the report was generated
Format: date-time
dataarrayRequired within parentList of contracts associated with the payroll event.
data[]ModelEach itemExpand Gets G2 N report data for a given payroll cycle by it's ID — 200 response body — data item
has_morebooleanRequired within parentIndicates whether more pages are available.
items_per_pageJSONRequired within parent
items_per_page (anyOf 1)integerAlternativeThe number of items per page.
items_per_page (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
next_cursorJSONRequired within parent
next_cursor (anyOf 1)stringAlternativePagination cursor to fetch the next page of results.
next_cursor (anyOf 2)nullAlternativePagination cursor to fetch the next page of results.
updated_atstringRequired within parentTimestamp when the report was updated
Format: date-time

Referenced models: Gets G2 N report data for a given payroll cycle by it's ID — 200 response body — data item

Gets G2 N report data for a given payroll cycle by it's ID — 200 response body — data item
FieldTypePresenceDescription and constraints
$objectRoot
contract_oidstringOptionalUnique identifier for the contract.
currencystringOptionalCurrency associated with the payroll event.
itemsarrayOptionalList of payroll-related items.
items[]ModelEach itemExpand Gets G2 N report data for a given payroll cycle by it's ID — 200 response body — data item items item
payment_dataJSONOptionalPayment details associated with the payroll event. Null if no payment data is available.
payment_data (anyOf 1)ModelAlternativeExpand Gets G2 N report data for a given payroll cycle by it's ID — 200 response body — data item payment data conversion rate, payment currency
payment_data (anyOf 2)nullAlternative

Referenced models: Gets G2 N report data for a given payroll cycle by it's ID — 200 response body — data item items item, Gets G2 N report data for a given payroll cycle by it's ID — 200 response body — data item payment data conversion rate, payment currency

Gets G2 N report data for a given payroll cycle by it's ID — 200 response body — data item items item
FieldTypePresenceDescription and constraints
$objectRoot
categorystringOptionalCategory of the item.
category_groupstringOptionalCategory group for the reporting label.
Known values: ADDITIONS, DEDUCTIONS, BENEFITS, INFOS, CONTRIBUTIONS, TOTALS
labelstringOptionalLabel of the payroll item.
sub_categorystringOptionalSub-category of the item.
valueJSONOptional
value (anyOf 1)numberAlternativeValue associated with the payroll item.
Format: double
value (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Gets G2 N report data for a given payroll cycle by it's ID — 200 response body — data item payment data conversion rate, payment currency
FieldTypePresenceDescription and constraints
$objectRootPayment details associated with the payroll event. Null if no payment data is available.
conversion_ratestringOptionalConversion rate applied between the payroll currency and the payment currency.
payment_currencystringOptionalCurrency in which the payment is made.

SDK function policy ID: deel.reports_getsg2nreportdataforagivenpayrollcyclebyitsid_v2026_01_01. Catalog operation: reports_getsg2nreportdataforagivenpayrollcyclebyitsid_v2026_01_01. 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: ["payslips:read"]

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.