Skip to content

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

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.

List gross-to-net report — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentList of report rows (summary rows are filtered out). Each row contains dynamic column keys mapped to cell objects.
data[]objectEach itemAdditional keys: see wildcard field
data[].*ModelAdditional keysExpand List gross-to-net report — 200 response body — data item value
pageModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRootA cell value object for a given column.
compareValueJSONOptionalRaw value for the comparison period, if applicable.
currentValueJSONOptionalRaw value for the current period. Type varies by column (string/number/null/etc).
formattedCurrentValueJSONOptionalFormatted value for display purposes.
labelstringRequired within parentHuman-readable label of the column for this cell.
percentageDiffJSONOptionalPercentage difference between current and comparison values, if applicable.
typestringRequired within parentCell type used for rendering/formatting.

List gross-to-net report — 200 response body — page

FieldTypePresenceDescription and constraints
$objectRootPagination metadata for the report rows.
limitJSONRequired within parent
limit (anyOf 1)numberAlternativeMaximum number of rows returned per page.
Format: double
Maximum: 200
limit (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
offsetJSONRequired within parent
offset (anyOf 1)numberAlternativeZero-based offset of the first returned row.
Format: double
offset (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
total_rowsJSONRequired within parent
total_rows (anyOf 1)numberAlternativeTotal number of rows available across all pages.
Format: double
Minimum: 0
total_rows (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

List payroll events by legal entity — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parent
data[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
end_datestringRequired within parentEnd date of the payroll event in ISO-8601 format.
Format: date-time
idstringRequired within parentUnique identifier for the payroll event.
lock_dateJSONOptional
lock_date (anyOf 1)stringAlternativeDate when the payroll event is locked, in ISO-8601 format.
Format: date-time
lock_date (anyOf 2)nullAlternativeDate when the payroll event is locked, in ISO-8601 format.
Format: date-time
start_datestringRequired within parentStart date of the payroll event in ISO-8601 format.
Format: date-time
statusstringRequired within parentStatus of the payroll event (e.g., OPEN, CLOSED).

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.