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.
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["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 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.reports.gets_g2_nreport_data_for_agiven_payroll_cycle_by_its_id(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.cycle_id | string | Required within parent | Format: uuid |
query | object | Optional | Additional keys: not allowed |
query.limit | integer | Optional | Default: 20 Maximum: 100 Minimum: 1 |
query.cursor | string | Optional |
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 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
Schemas
Section titled “Schemas”Gets G2 N report data for a given payroll cycle by it's ID — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_at | string | Required within parent | Timestamp when the report was generated Format: date-time |
data | array | Required within parent | List of contracts associated with the payroll event. |
data[] | Model | Each item | Expand Gets G2 N report data for a given payroll cycle by it's ID — 200 response body — data item |
has_more | boolean | Required within parent | Indicates whether more pages are available. |
items_per_page | JSON | Required within parent | |
items_per_page (anyOf 1) | integer | Alternative | The number of items per page. |
items_per_page (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
next_cursor | JSON | Required within parent | |
next_cursor (anyOf 1) | string | Alternative | Pagination cursor to fetch the next page of results. |
next_cursor (anyOf 2) | null | Alternative | Pagination cursor to fetch the next page of results. |
updated_at | string | Required within parent | Timestamp 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
contract_oid | string | Optional | Unique identifier for the contract. |
currency | string | Optional | Currency associated with the payroll event. |
items | array | Optional | List of payroll-related items. |
items[] | Model | Each item | Expand Gets G2 N report data for a given payroll cycle by it's ID — 200 response body — data item items item |
payment_data | JSON | Optional | Payment details associated with the payroll event. Null if no payment data is available. |
payment_data (anyOf 1) | Model | Alternative | Expand 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) | null | Alternative |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
category | string | Optional | Category of the item. |
category_group | string | Optional | Category group for the reporting label. Known values: ADDITIONS, DEDUCTIONS, BENEFITS, INFOS, CONTRIBUTIONS, TOTALS |
label | string | Optional | Label of the payroll item. |
sub_category | string | Optional | Sub-category of the item. |
value | JSON | Optional | |
value (anyOf 1) | number | Alternative | Value associated with the payroll item. Format: double |
value (anyOf 2) | string | Alternative | Pattern: ^-?[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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Payment details associated with the payroll event. Null if no payment data is available. |
conversion_rate | string | Optional | Conversion rate applied between the payroll currency and the payment currency. |
payment_currency | string | Optional | Currency in which the payment is made. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”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"}