Paycode 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)
namestringNo
codestringNothe payroll system's code for this item
descriptionstringNo
typeenumNoValues: EARNING, DEDUCTION, TAX, CONTRIBUTION, REIMBURSEMENT
detail_typeenumNothe normalized payslip-line type this code produces Values: EARNING_SALARY, EARNING_OVERTIME, EARNING_TIP, EARNING_BONUS, EARNING_COMMISSION, EARNING_ADJUSTMENT, EARNING, PRETAX_DEDUCTION, PRETAX_DEDUCTION_HEALTH_INSURANCE, PRETAX_DEDUCTION_RETIREMENT, PRETAX_DEDUCTION_HRA, TAX_FEDERAL, TAX_REGION, TAX_LOCAL, POSTTAX_BENEFIT, POSTTAX_GARNISHMENT, REIMBURSEMENT, EARNING_REGULAR, EARNING_DOUBLE_OVERTIME, EARNING_PTO, EARNING_SICK, EARNING_HOLIDAY, EARNING_SEVERANCE, EARNING_REIMBURSEMENT, TAX_SOCIAL_SECURITY, TAX_MEDICARE, TAX_UNEMPLOYMENT, TAX_EMPLOYER, PRETAX_DEDUCTION_HSA, PRETAX_DEDUCTION_FSA, PRETAX_DEDUCTION_DEPENDENT_CARE, PRETAX_DEDUCTION_COMMUTER, PRETAX_DEDUCTION_DENTAL, PRETAX_DEDUCTION_VISION, POSTTAX_DEDUCTION, POSTTAX_RETIREMENT_ROTH, POSTTAX_LOAN_REPAYMENT, EMPLOYER_CONTRIBUTION, PENSION, EARNING_CASH_IN_LIEU, PRETAX_DEDUCTION_RETIREMENT_CATCHUP, POSTTAX_RETIREMENT_ROTH_CATCHUP, POSTTAX_RETIREMENT_AFTER_TAX, EMPLOYER_CONTRIBUTION_RETIREMENT, EMPLOYER_CONTRIBUTION_HSA, EMPLOYER_CONTRIBUTION_FSA, POSTTAX_DEDUCTION_COLLEGE_SAVINGS, POSTTAX_DEDUCTION_UNION_DUES, POSTTAX_DEDUCTION_EWA_REPAYMENT
is_pre_taxbooleanNo
is_employerbooleanNo
is_activebooleanNo
is_retirement_eligiblebooleanNotrue when earnings under this code count as retirement-plan compensation
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 HrisPaycode = {
	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)
	name?: string;
	code?: string; // the payroll system's code for this item
	description?: string;
	type?: 'EARNING' | 'DEDUCTION' | 'TAX' | 'CONTRIBUTION' | 'REIMBURSEMENT';
	detail_type?: 'EARNING_SALARY' | 'EARNING_OVERTIME' | 'EARNING_TIP' | 'EARNING_BONUS' | 'EARNING_COMMISSION' | 'EARNING_ADJUSTMENT' | 'EARNING' | 'PRETAX_DEDUCTION' | 'PRETAX_DEDUCTION_HEALTH_INSURANCE' | 'PRETAX_DEDUCTION_RETIREMENT' | 'PRETAX_DEDUCTION_HRA' | 'TAX_FEDERAL' | 'TAX_REGION' | 'TAX_LOCAL' | 'POSTTAX_BENEFIT' | 'POSTTAX_GARNISHMENT' | 'REIMBURSEMENT' | 'EARNING_REGULAR' | 'EARNING_DOUBLE_OVERTIME' | 'EARNING_PTO' | 'EARNING_SICK' | 'EARNING_HOLIDAY' | 'EARNING_SEVERANCE' | 'EARNING_REIMBURSEMENT' | 'TAX_SOCIAL_SECURITY' | 'TAX_MEDICARE' | 'TAX_UNEMPLOYMENT' | 'TAX_EMPLOYER' | 'PRETAX_DEDUCTION_HSA' | 'PRETAX_DEDUCTION_FSA' | 'PRETAX_DEDUCTION_DEPENDENT_CARE' | 'PRETAX_DEDUCTION_COMMUTER' | 'PRETAX_DEDUCTION_DENTAL' | 'PRETAX_DEDUCTION_VISION' | 'POSTTAX_DEDUCTION' | 'POSTTAX_RETIREMENT_ROTH' | 'POSTTAX_LOAN_REPAYMENT' | 'EMPLOYER_CONTRIBUTION' | 'PENSION' | 'EARNING_CASH_IN_LIEU' | 'PRETAX_DEDUCTION_RETIREMENT_CATCHUP' | 'POSTTAX_RETIREMENT_ROTH_CATCHUP' | 'POSTTAX_RETIREMENT_AFTER_TAX' | 'EMPLOYER_CONTRIBUTION_RETIREMENT' | 'EMPLOYER_CONTRIBUTION_HSA' | 'EMPLOYER_CONTRIBUTION_FSA' | 'POSTTAX_DEDUCTION_COLLEGE_SAVINGS' | 'POSTTAX_DEDUCTION_UNION_DUES' | 'POSTTAX_DEDUCTION_EWA_REPAYMENT'; // the normalized payslip-line type this code produces
	is_pre_tax?: boolean;
	is_employer?: boolean;
	is_active?: boolean;
	is_retirement_eligible?: boolean; // true when earnings under this code count as retirement-plan compensation
	metadata?: [];
	raw?: any;
} 

Zod

Zod
import { z } from 'zod';

export const ZodHrisPaycode = 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)"),
	name: z.string().optional(),
	code: z.string().optional().describe("the payroll system's code for this item"),
	description: z.string().optional(),
	type: z.enum("EARNING", "DEDUCTION", "TAX", "CONTRIBUTION", "REIMBURSEMENT").optional(),
	detail_type: z.enum("EARNING_SALARY", "EARNING_OVERTIME", "EARNING_TIP", "EARNING_BONUS", "EARNING_COMMISSION", "EARNING_ADJUSTMENT", "EARNING", "PRETAX_DEDUCTION", "PRETAX_DEDUCTION_HEALTH_INSURANCE", "PRETAX_DEDUCTION_RETIREMENT", "PRETAX_DEDUCTION_HRA", "TAX_FEDERAL", "TAX_REGION", "TAX_LOCAL", "POSTTAX_BENEFIT", "POSTTAX_GARNISHMENT", "REIMBURSEMENT", "EARNING_REGULAR", "EARNING_DOUBLE_OVERTIME", "EARNING_PTO", "EARNING_SICK", "EARNING_HOLIDAY", "EARNING_SEVERANCE", "EARNING_REIMBURSEMENT", "TAX_SOCIAL_SECURITY", "TAX_MEDICARE", "TAX_UNEMPLOYMENT", "TAX_EMPLOYER", "PRETAX_DEDUCTION_HSA", "PRETAX_DEDUCTION_FSA", "PRETAX_DEDUCTION_DEPENDENT_CARE", "PRETAX_DEDUCTION_COMMUTER", "PRETAX_DEDUCTION_DENTAL", "PRETAX_DEDUCTION_VISION", "POSTTAX_DEDUCTION", "POSTTAX_RETIREMENT_ROTH", "POSTTAX_LOAN_REPAYMENT", "EMPLOYER_CONTRIBUTION", "PENSION", "EARNING_CASH_IN_LIEU", "PRETAX_DEDUCTION_RETIREMENT_CATCHUP", "POSTTAX_RETIREMENT_ROTH_CATCHUP", "POSTTAX_RETIREMENT_AFTER_TAX", "EMPLOYER_CONTRIBUTION_RETIREMENT", "EMPLOYER_CONTRIBUTION_HSA", "EMPLOYER_CONTRIBUTION_FSA", "POSTTAX_DEDUCTION_COLLEGE_SAVINGS", "POSTTAX_DEDUCTION_UNION_DUES", "POSTTAX_DEDUCTION_EWA_REPAYMENT").optional().describe("the normalized payslip-line type this code produces"),
	is_pre_tax: z.boolean().optional(),
	is_employer: z.boolean().optional(),
	is_active: z.boolean().optional(),
	is_retirement_eligible: z.boolean().optional().describe("true when earnings under this code count as retirement-plan compensation"),
	metadata: z.array().optional(),

});

Python

Python
import dataclasses

@dataclasses.dataclass
class HrisPaycodeType(str, Enum):
	EARNING = 'EARNING'
	DEDUCTION = 'DEDUCTION'
	TAX = 'TAX'
	CONTRIBUTION = 'CONTRIBUTION'
	REIMBURSEMENT = 'REIMBURSEMENT'

@dataclasses.dataclass
class HrisPaycodeDetail_type(str, Enum):
	EARNING_SALARY = 'EARNING_SALARY'
	EARNING_OVERTIME = 'EARNING_OVERTIME'
	EARNING_TIP = 'EARNING_TIP'
	EARNING_BONUS = 'EARNING_BONUS'
	EARNING_COMMISSION = 'EARNING_COMMISSION'
	EARNING_ADJUSTMENT = 'EARNING_ADJUSTMENT'
	EARNING = 'EARNING'
	PRETAX_DEDUCTION = 'PRETAX_DEDUCTION'
	PRETAX_DEDUCTION_HEALTH_INSURANCE = 'PRETAX_DEDUCTION_HEALTH_INSURANCE'
	PRETAX_DEDUCTION_RETIREMENT = 'PRETAX_DEDUCTION_RETIREMENT'
	PRETAX_DEDUCTION_HRA = 'PRETAX_DEDUCTION_HRA'
	TAX_FEDERAL = 'TAX_FEDERAL'
	TAX_REGION = 'TAX_REGION'
	TAX_LOCAL = 'TAX_LOCAL'
	POSTTAX_BENEFIT = 'POSTTAX_BENEFIT'
	POSTTAX_GARNISHMENT = 'POSTTAX_GARNISHMENT'
	REIMBURSEMENT = 'REIMBURSEMENT'
	EARNING_REGULAR = 'EARNING_REGULAR'
	EARNING_DOUBLE_OVERTIME = 'EARNING_DOUBLE_OVERTIME'
	EARNING_PTO = 'EARNING_PTO'
	EARNING_SICK = 'EARNING_SICK'
	EARNING_HOLIDAY = 'EARNING_HOLIDAY'
	EARNING_SEVERANCE = 'EARNING_SEVERANCE'
	EARNING_REIMBURSEMENT = 'EARNING_REIMBURSEMENT'
	TAX_SOCIAL_SECURITY = 'TAX_SOCIAL_SECURITY'
	TAX_MEDICARE = 'TAX_MEDICARE'
	TAX_UNEMPLOYMENT = 'TAX_UNEMPLOYMENT'
	TAX_EMPLOYER = 'TAX_EMPLOYER'
	PRETAX_DEDUCTION_HSA = 'PRETAX_DEDUCTION_HSA'
	PRETAX_DEDUCTION_FSA = 'PRETAX_DEDUCTION_FSA'
	PRETAX_DEDUCTION_DEPENDENT_CARE = 'PRETAX_DEDUCTION_DEPENDENT_CARE'
	PRETAX_DEDUCTION_COMMUTER = 'PRETAX_DEDUCTION_COMMUTER'
	PRETAX_DEDUCTION_DENTAL = 'PRETAX_DEDUCTION_DENTAL'
	PRETAX_DEDUCTION_VISION = 'PRETAX_DEDUCTION_VISION'
	POSTTAX_DEDUCTION = 'POSTTAX_DEDUCTION'
	POSTTAX_RETIREMENT_ROTH = 'POSTTAX_RETIREMENT_ROTH'
	POSTTAX_LOAN_REPAYMENT = 'POSTTAX_LOAN_REPAYMENT'
	EMPLOYER_CONTRIBUTION = 'EMPLOYER_CONTRIBUTION'
	PENSION = 'PENSION'
	EARNING_CASH_IN_LIEU = 'EARNING_CASH_IN_LIEU'
	PRETAX_DEDUCTION_RETIREMENT_CATCHUP = 'PRETAX_DEDUCTION_RETIREMENT_CATCHUP'
	POSTTAX_RETIREMENT_ROTH_CATCHUP = 'POSTTAX_RETIREMENT_ROTH_CATCHUP'
	POSTTAX_RETIREMENT_AFTER_TAX = 'POSTTAX_RETIREMENT_AFTER_TAX'
	EMPLOYER_CONTRIBUTION_RETIREMENT = 'EMPLOYER_CONTRIBUTION_RETIREMENT'
	EMPLOYER_CONTRIBUTION_HSA = 'EMPLOYER_CONTRIBUTION_HSA'
	EMPLOYER_CONTRIBUTION_FSA = 'EMPLOYER_CONTRIBUTION_FSA'
	POSTTAX_DEDUCTION_COLLEGE_SAVINGS = 'POSTTAX_DEDUCTION_COLLEGE_SAVINGS'
	POSTTAX_DEDUCTION_UNION_DUES = 'POSTTAX_DEDUCTION_UNION_DUES'
	POSTTAX_DEDUCTION_EWA_REPAYMENT = 'POSTTAX_DEDUCTION_EWA_REPAYMENT'

@dataclasses.dataclass
class HrisPaycode:
	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]
	name: Optional[str]
	"""the payroll system's code for this item"""
	code: Optional[str]
	description: Optional[str]
	type: Optional[HrisPaycodeType]
	"""the normalized payslip-line type this code produces"""
	detail_type: Optional[HrisPaycodeDetail_type]
	is_pre_tax: Optional[bool]
	is_employer: Optional[bool]
	is_active: Optional[bool]
	"""true when earnings under this code count as retirement-plan compensation"""
	is_retirement_eligible: Optional[bool]
	metadata: Optional[PropertyHrisPaycodeMetadata]
Are we missing anything? Let us know
Was this page helpful?