Deel: List gross-to-net report
Deel reports.getGpreportGrossToNet: arguments, response, policy and SDK examples.
← Reports operations · Get started
Operation deel.reports_getgpreportgrosstonet
Provider route: GET /gp/reports/{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"]["getGpreportGrossToNet"]>[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.getGpreportGrossToNet(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.get_gpreport_gross_to_net(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.id | string | Required within parent | |
query | object | Optional | Additional keys: not allowed |
query.currency | string | Optional | |
query.limit | number | Optional | Format: double Maximum: 200 |
query.offset | number | Optional | Format: double |
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 gross-to-net report — 200 response body |
Referenced models: List gross-to-net report — 200 response body
Schemas
Section titled “Schemas”List gross-to-net report — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | List of report rows (summary rows are filtered out). Each row contains dynamic column keys mapped to cell objects. |
data[] | object | Each item | Additional keys: see wildcard field |
data[].* | Model | Additional keys | Expand List gross-to-net report — 200 response body — data item value |
page | Model | Required within parent | Expand List gross-to-net report — 200 response body — page Pagination metadata for the report rows. |
Referenced models: List gross-to-net report — 200 response body — data item value, List gross-to-net report — 200 response body — page
List gross-to-net report — 200 response body — data item value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A cell value object for a given column. |
compareValue | JSON | Optional | Raw value for the comparison period, if applicable. |
currentValue | JSON | Optional | Raw value for the current period. Type varies by column (string/number/null/etc). |
formattedCurrentValue | JSON | Optional | Formatted value for display purposes. |
label | string | Required within parent | Human-readable label of the column for this cell. |
percentageDiff | JSON | Optional | Percentage difference between current and comparison values, if applicable. |
type | string | Required within parent | Cell type used for rendering/formatting. |
List gross-to-net report — 200 response body — page
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Pagination metadata for the report rows. |
limit | JSON | Required within parent | |
limit (anyOf 1) | number | Alternative | Maximum number of rows returned per page. Format: double Maximum: 200 |
limit (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
offset | JSON | Required within parent | |
offset (anyOf 1) | number | Alternative | Zero-based offset of the first returned row. Format: double |
offset (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
total_rows | JSON | Required within parent | |
total_rows (anyOf 1) | number | Alternative | Total number of rows available across all pages. Format: double Minimum: 0 |
total_rows (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: deel.reports_getgpreportgrosstonet. Catalog operation: reports_getgpreportgrosstonet. 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: ["global-payroll:read"]
Pinned headers: {"X-Version": "2026-01-01"}