Payroll data model
View field support, webhooks, and list parameters for each integration on the Supported Integrations page.
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No | |
created_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
updated_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
company_id | string | No | (reference to HrisCompany) |
group_id | string | No | the pay group (hris_group of type PAY_GROUP) (reference to HrisGroup) |
status | enum | No | Values: DRAFT, PENDING, APPROVED, PROCESSING, PAID, FAILED, CANCELLED |
type | enum | No | Values: REGULAR, OFF_CYCLE, BONUS, CORRECTION, TERMINATION, CONTRACTOR |
start_at | string (date-time) | No | pay period start (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
end_at | string (date-time) | No | pay period end (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
paid_at | string (date-time) | No | pay/check date (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
approved_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
currency | string | No | |
gross_amount | number | No | |
net_amount | number | No | |
employee_tax_amount | number | No | |
employer_tax_amount | number | No | |
deduction_amount | number | No | total employee deductions |
employer_contribution_amount | number | No | total employer benefit contributions |
total_cost_amount | number | No | total company cost/debit for this payroll |
user_ids | string[] | No | employees paid in this payroll |
payslip_ids | string[] | No | |
metadata | HrisMetadata[] | No | |
metadata[].id | string | No | The ID of the custom field definition (from the metadata/metadata endpoint). |
metadata[].value | object | No | The field's value, typed by format: DATE as ISO-8601 (YYYY-MM-DD, or YYYY-MM-DDTHH:MM:SSZ for date-times); NUMBER, PRICE and CURRENCY as a number; BOOLEAN and YES_NO as true/false; MULTIPLE_SELECT as an array of option values; otherwise a string. |
metadata[].namespace | string | No | |
metadata[].format | enum | No | The data type of the custom field, which determines how value is formatted. Values: TEXT, NUMBER, DATE, BOOLEAN, FILE, TEXTAREA, SINGLE_SELECT, MULTIPLE_SELECT, MEASUREMENT, PRICE, YES_NO, CURRENCY, URL |
metadata[].extra_data | object | No | |
metadata[].slug | string | No | The integration's API name (key) of an existing custom field. List valid slugs for this object with the metadata/metadata endpoint; unknown slugs are rejected by the integration. |
Are we missing anything? Let us know
Was this page helpful?