Deel: Reports schemas
9 Deel schemas with complete fields and constraints.
← Reports operations · All 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. |
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]+)?$ |
List payroll events by legal entity — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | |
data[] | Model | Each item | Expand List payroll events by legal entity — 200 response body — data item |
Referenced models: List payroll events by legal entity — 200 response body — data item
List payroll events by legal entity — 200 response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
end_date | string | Required within parent | End date of the payroll event in ISO-8601 format. Format: date-time |
id | string | Required within parent | Unique identifier for the payroll event. |
lock_date | JSON | Optional | |
lock_date (anyOf 1) | string | Alternative | Date when the payroll event is locked, in ISO-8601 format. Format: date-time |
lock_date (anyOf 2) | null | Alternative | Date when the payroll event is locked, in ISO-8601 format. Format: date-time |
start_date | string | Required within parent | Start date of the payroll event in ISO-8601 format. Format: date-time |
status | string | Required within parent | Status of the payroll event (e.g., OPEN, CLOSED). |