Payroll data model

Updated:

View field support, webhooks, and list parameters for each integration on the Supported Integrations page.

FieldTypeRequiredDescription
idstringNo
created_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
company_idstringNo(reference to HrisCompany)
group_idstringNothe pay group (hris_group of type PAY_GROUP) (reference to HrisGroup)
statusenumNoValues: DRAFT, PENDING, APPROVED, PROCESSING, PAID, FAILED, CANCELLED
typeenumNoValues: REGULAR, OFF_CYCLE, BONUS, CORRECTION, TERMINATION, CONTRACTOR
start_atstring (date-time)Nopay period start (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
end_atstring (date-time)Nopay period end (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
paid_atstring (date-time)Nopay/check date (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
approved_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
currencystringNo
gross_amountnumberNo
net_amountnumberNo
employee_tax_amountnumberNo
employer_tax_amountnumberNo
deduction_amountnumberNototal employee deductions
employer_contribution_amountnumberNototal employer benefit contributions
total_cost_amountnumberNototal company cost/debit for this payroll
user_idsstring[]Noemployees paid in this payroll
payslip_idsstring[]No
metadataHrisMetadata[]No
metadata[].idstringNoThe ID of the custom field definition (from the metadata/metadata endpoint).
metadata[].valueobjectNoThe 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[].namespacestringNo
metadata[].formatenumNoThe 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_dataobjectNo
metadata[].slugstringNoThe 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.

TypeScript

TypeScript
export type HrisPayroll = {
	id?: string;
	created_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	updated_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	company_id?: string; // (reference to HrisCompany)
	group_id?: string; // the pay group (hris_group of type PAY_GROUP) (reference to HrisGroup)
	status?: 'DRAFT' | 'PENDING' | 'APPROVED' | 'PROCESSING' | 'PAID' | 'FAILED' | 'CANCELLED';
	type?: 'REGULAR' | 'OFF_CYCLE' | 'BONUS' | 'CORRECTION' | 'TERMINATION' | 'CONTRACTOR';
	start_at?: string-time; // pay period start (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	end_at?: string-time; // pay period end (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	paid_at?: string-time; // pay/check date (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	approved_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	currency?: string;
	gross_amount?: number;
	net_amount?: number;
	employee_tax_amount?: number;
	employer_tax_amount?: number;
	deduction_amount?: number; // total employee deductions
	employer_contribution_amount?: number; // total employer benefit contributions
	total_cost_amount?: number; // total company cost/debit for this payroll
	user_ids?: string[]; // employees paid in this payroll
	payslip_ids?: string[];
	metadata?: [];
	raw?: any;
} 

Zod

Zod
import { z } from 'zod';

export const ZodHrisPayroll = z.object({
	id: z.string().optional(),
	created_at: z.string-time().optional().describe("(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	updated_at: z.string-time().optional().describe("(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	company_id: z.string().optional().describe("(reference to HrisCompany)"),
	group_id: z.string().optional().describe("the pay group (hris_group of type PAY_GROUP) (reference to HrisGroup)"),
	status: z.enum("DRAFT", "PENDING", "APPROVED", "PROCESSING", "PAID", "FAILED", "CANCELLED").optional(),
	type: z.enum("REGULAR", "OFF_CYCLE", "BONUS", "CORRECTION", "TERMINATION", "CONTRACTOR").optional(),
	start_at: z.string-time().optional().describe("pay period start (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	end_at: z.string-time().optional().describe("pay period end (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	paid_at: z.string-time().optional().describe("pay/check date (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	approved_at: z.string-time().optional().describe("(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	currency: z.string().optional(),
	gross_amount: z.number().optional(),
	net_amount: z.number().optional(),
	employee_tax_amount: z.number().optional(),
	employer_tax_amount: z.number().optional(),
	deduction_amount: z.number().optional().describe("total employee deductions"),
	employer_contribution_amount: z.number().optional().describe("total employer benefit contributions"),
	total_cost_amount: z.number().optional().describe("total company cost/debit for this payroll"),
	user_ids: z.array().optional().describe("employees paid in this payroll"),
	payslip_ids: z.array().optional(),
	metadata: z.array().optional(),

});

Python

Python
import dataclasses

@dataclasses.dataclass
class HrisPayrollStatus(str, Enum):
	DRAFT = 'DRAFT'
	PENDING = 'PENDING'
	APPROVED = 'APPROVED'
	PROCESSING = 'PROCESSING'
	PAID = 'PAID'
	FAILED = 'FAILED'
	CANCELLED = 'CANCELLED'

@dataclasses.dataclass
class HrisPayrollType(str, Enum):
	REGULAR = 'REGULAR'
	OFF_CYCLE = 'OFF_CYCLE'
	BONUS = 'BONUS'
	CORRECTION = 'CORRECTION'
	TERMINATION = 'TERMINATION'
	CONTRACTOR = 'CONTRACTOR'

@dataclasses.dataclass
class HrisPayroll:
	id: Optional[str]
	"""(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	created_at: Optional[str]
	"""(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	updated_at: Optional[str]
	"""(reference to HrisCompany)"""
	company_id: Optional[str]
	"""the pay group (hris_group of type PAY_GROUP) (reference to HrisGroup)"""
	group_id: Optional[str]
	status: Optional[HrisPayrollStatus]
	type: Optional[HrisPayrollType]
	"""pay period start (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	start_at: Optional[str]
	"""pay period end (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	end_at: Optional[str]
	"""pay/check date (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	paid_at: Optional[str]
	"""(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	approved_at: Optional[str]
	currency: Optional[str]
	gross_amount: Optional[int]
	net_amount: Optional[int]
	employee_tax_amount: Optional[int]
	employer_tax_amount: Optional[int]
	"""total employee deductions"""
	deduction_amount: Optional[int]
	"""total employer benefit contributions"""
	employer_contribution_amount: Optional[int]
	"""total company cost/debit for this payroll"""
	total_cost_amount: Optional[int]
	"""employees paid in this payroll"""
	user_ids: Optional[List[List[str]]]
	payslip_ids: Optional[List[List[str]]]
	metadata: Optional[PropertyHrisPayrollMetadata]
Are we missing anything? Let us know
Was this page helpful?