API package
HRMS
Personnel, time, leave, benefits, training, and payroll — payroll posts straight to the general ledger.
198 APIs1347 operationsBase path
/api/hrmsBenefits
Benefit Elections
What each person chose, what tier they are on, and what it costs them and the employer each period.
GET2 POST2 PUT1 DELETE1
Benefit Eligibility Rules
Who may be enrolled in a plan, by age, work location, grade, tenure, employment type and dependents, from a date. Every rule that applies to a plan must be met, at enrollment, at a life event, or both.
GET2 POST3 PUT1 DELETE1
Benefit Enrollments
Read and maintain benefit enrollments records (hr.benefit_enrollments).
GET2 POST2 PUT1 DELETE1
Benefit Plans
What is offered, who carries it, and what a period of it costs the employee and the employer. Every election is against one of these.
GET3 POST3 PUT2 DELETE2
Benefits Dashboard
Eligibility and enrollment, open-enrollment progress, life events, dependents waiting on proof, and -- in the United States -- ACA compliance, carrier files and garnishments, each figure a link to its list.
GET1
Dependents
Read and maintain dependants records (hr.dependants).
GET2 POST3 PUT1 DELETE1
Life Events
What lets somebody change their choices outside open enrollment, and how long they have. The window is computed from the event, not typed.
GET2 POST2 PUT1 DELETE1
Plan Years
The year a benefit runs for, and the window in which anybody may change their mind without a life event.
GET2 POST2 PUT1 DELETE1
Carriers & ACA
ACA Forms (1095-C / 1094-C)
Form 1095-C lines 14, 15 and 16 for every month, the 1094-C transmittal, printing, AIR-shaped XML and corrections.
GET4 POST5
ACA Full-Time Status
Who is full time under the ACA, month by month -- by look-back measurement or monthly hours -- and why.
GET2 POST1
ACA Settings
The measurement method and periods, the affordability safe harbor, and the employer (ALE member) on the 1094-C. Mark which plans are minimum essential coverage and minimum value with "Plan ACA flags".
GET3 POST3 PUT1 DELETE1
Carrier Files
Every 834, contribution and eligibility file built, sealed: download, send, resend, regenerate a corrected version, and the delivery log of every attempt.
GET3 POST4
Carriers & Recordkeepers
Who is sent what: an insurer (Aflac, Prudential ...) its 834 enrollment file, a 401(k) or 457 recordkeeper (Vanguard, Nationwide ...) its contribution file after each payroll, in its own layout, and how it is delivered.
GET3 POST5 PUT1 DELETE1
Certifications & Skills
Certifications & Licenses
What each person holds and when it expires. Alerts go at 90, 60 and 30 days and on expiry, and a renewal task is raised.
GET2 POST4 PUT1 DELETE1
Job Skill Requirements
What a job (or one position) needs, and at what level. The gaps are measured against these.
GET2 POST2 PUT1 DELETE1
Skill Gaps
Each person against what their job requires: the level held, the level needed, and the gap.
GET2 POST2 PUT1 DELETE1
Skills
The skill catalogue: what can be held, grouped by category, on a scale of 1 to its top level.
GET4 POST2 PUT1 DELETE1
Skills a Course Teaches
Completing the course raises the skill to this level, verified, as from the course.
GET2 POST2 PUT1 DELETE1
Skills Inventory
Who has which skill at what level, where the level came from -- self, manager, course or certification -- and whether it is verified.
GET2 POST3 PUT1 DELETE1
Compensation
Compensation Awards
What the matrix said and what the manager asked for. The gap between them is what a committee reviews.
GET2 POST2 PUT1 DELETE1
Compensation Cycles
A review, its budget, and whether the proposals fit inside it.
GET2 POST2 PUT1 DELETE1
Equity Grants
Read and maintain equity grants records (hr.equity_grants).
GET2 POST2 PUT1 DELETE1
Pay Position
Where everybody sits in their range. A compa-ratio of 1.00 is the midpoint. Pay and range are compared per year and in the pay’s currency: a monthly range is annualised and a range set in another currency is converted at today’s rate.
GET2 POST2 PUT1 DELETE1
Salary Grade Steps
The steps of a grade: step 1 on hire, the next after a year’s service. A grade with no steps is paid anywhere in its range.
GET2 POST2 PUT1 DELETE1
Salary Grades
A range, not a number. Everything worth deciding about pay is a question about position in range.
GET2 POST2 PUT1 DELETE1
Salary Structures
Read and maintain salary structures records (hr.salary_structures).
GET2 POST2 PUT1 DELETE1
Total Rewards
The whole package: pay, bonus target, what the employer puts into benefits and taxes, equity and leave.
GET2 POST2 PUT1 DELETE1
Employee Relations & Records
AI Decision Reviews
AI-assisted decisions about people that wait for a person: accept, override or reject, with the reason.
GET1 POST1
Disciplinary Actions
Warnings, suspensions, demotions and dismissals for cause, with the policy they rest on, the employee's acknowledgement and any appeal. Never deleted: an action given in error is rescinded and the record stays. Retained, held and exported like every personnel record.
GET2 POST2 PUT1 DELETE1
Document Types
The kinds of employee document HR keeps and how long each is kept after the person leaves. An onboarding task can require one; a legal hold can hold them by type; retention keeps each for its own period.
GET2 POST2 PUT1 DELETE1
Employee Documents
What each employee has handed in or signed, by document type: asked for on hire, uploaded in self service, or signed. Raised by the process that asks for them; HR verifies them on the onboarding checklist.
GET2 POST2 PUT1 DELETE1
Legal Holds
The legal holds on people's records, active first. While a hold is active its records cannot be changed or deleted — that is why a save on a held employee is refused. Holds are placed and released under Platform › Legal Holds.
GET1
Garnishments
Garnishment Orders
Child support, tax levies and creditor orders: the case, the payee and where the money goes, and the order of precedence. Payroll takes them in priority order within the CCPA limits of their deduction code.
GET2 POST2 PUT1 DELETE1
Garnishment Remittances
What each payroll run withheld under each order, one remittance per payee, its file (with the child support DED addenda) and the payment reference once it is sent.
GET3 POST3
Health & Safety
Identity Verification
Labor Distribution & GL Interface
GL Interface Code Crosswalk
A property, department, program, fund, grant, cost center or job as the target system codes it.
GET2 POST2 PUT1 DELETE1
GL Interface Exceptions
What stopped a file: a missing mapping, an invalid code, an imbalance, a control total that did not agree, a failed transmission. Correct the cause and Reprocess.
GET2 POST4 PUT1 DELETE1
GL Interface Files
Every file made, version by version, with its checksum and control totals -- never changed, never deleted. Resend sends the same file again; Reprocess makes the next version after a correction.
GET4 POST7 PUT1 DELETE1
GL Interface Mappings
Which target account (and property, segments) each payroll amount goes to. The most specific rule wins: a code before *, then each dimension it names, then priority.
GET2 POST2 PUT1 DELETE1
GL Interface Valid Codes
The receiving system's own chart and property list. With a list loaded, a code not on it stops the file.
GET2 POST2 PUT1 DELETE1
GL Interfaces
Where payroll goes in the general ledger that receives it: the target system profile (Yardi Voyager journal ETL, or a generic CSV / JSON journal), its codes, the schedule and the transport. A new interface sends TEST files until Go live.
GET5 POST5 PUT2 DELETE1
Labor Splits
The standing distribution of an employee's (or a position's) pay, used where no time says otherwise: salaried people, holidays, retro and off-cycle pay.
GET2 POST2 PUT1 DELETE1
Payslip Allocations
Each payslip split by what the work was for. The employer's taxes and benefit costs follow the gross.
GET2 POST3 PUT1 DELETE1
Learning
Completion History
Every completion ever recorded -- a recurring course keeps each round -- with whether it was on time and until when it counts.
GET2 POST2 PUT1 DELETE1
Compliance Training
Every assigned course and whether each person is compliant today -- completed, and the completion still valid -- with what is overdue. Filter to compliance courses for the mandatory-training report.
GET2 POST2 PUT1 DELETE1
Course Enrollments
Who is on which course, how far they have got, and what they scored.
GET2 POST3 PUT1 DELETE1
Course Evaluations
What people thought of a course after completing it: ratings from 1 to 5 and comments.
GET2 POST2 PUT1 DELETE1
Learning Path Assignments
Who is on which path and how far along -- completion %.
GET2 POST2 PUT1 DELETE1
Learning Path Courses
The courses of each path and their order.
GET2 POST2 PUT1 DELETE1
Learning Paths
Courses in order. A sequential path enrols the next course when the one before it is completed.
GET2 POST3 PUT1 DELETE1
Learning Reminders
Every reminder of training coming due and every escalation of overdue training to a manager, as it went out: who, which course, its due date, and when. "Recorded" means there was nobody to tell (no sign-in, no manager).
GET2 POST2 PUT1 DELETE1
Programme Effectiveness
Per course: how many finish, how well they score, and what they thought of it.
GET2 POST2 PUT1 DELETE1
Session Attendance
Who registered for each session, who was wait-listed and who attended.
GET2 POST2 PUT1 DELETE1
Training Assignment Rules
Who must take a course or a learning path -- by job, position, department, location or as new hires -- by when, and how often again. Run daily, or now.
GET3 POST3 PUT1 DELETE1
Training Courses
Read and maintain training courses records (hr.training_courses).
GET2 POST2 PUT1 DELETE1
Training Sessions
Instructor-led dates: where (or the link), who teaches, how many places, who registered and who attended.
GET2 POST5 PUT1 DELETE1
Leave
Holiday Calendars
The days off every leave request, timesheet, attendance check, pay date and due date counts. Each company starts with its own country’s public holidays and changes them here: add company holidays, move or rename one, remove one, or keep another calendar for a state, a business unit or a location. Dates marked estimated follow a lunar calendar — confirm them when they are announced.
GET3 POST3 PUT1 DELETE1
Leave Balances
Everything earned, less what has been taken and what is asked for but not yet decided.
GET2 POST2 PUT1 DELETE1
Leave Movements
Every accrual, day taken and carry-over, so a balance can be explained rather than trusted.
GET2 POST2 PUT1 DELETE1
Leave Requests
Read and maintain leave requests records (hr.leave_requests).
GET2 POST3 PUT1 DELETE1
Leave Types
What a day off can be called, how entitlement to it accrues, and what it costs. Every leave request and every balance is against one of these.
GET2 POST2 PUT1 DELETE1
Who Is Off
Booked and requested absence, for a manager looking at cover.
GET2 POST2 PUT1 DELETE1
LMS Integration
LMS Connectors
An external learning platform -- Aspire, or any other -- exchanging courses, enrolments and completions by file (CSV, Excel, text) or over HTTP, with the field mapping and the schedule.
GET5 POST7 PUT2 DELETE1
LMS Error Log
Rows a platform sent that could not be taken, and why. Put the mapping or the master data right, then reprocess.
GET2 POST4 PUT1 DELETE1
LMS Sync Runs
Every exchange with a learning platform: what was read, created, updated and refused.
GET2 POST2 PUT1 DELETE1
Parallel Payroll
Legacy Payroll Registers
The payroll register of the system being replaced, one per cycle: Import a CSV, text or Excel file -- employee rows (gross, net, taxes, deductions, benefits, employer costs, accruals, liabilities), GL rows (account, debit, credit) and labor allocation rows.
GET3 POST3 PUT1 DELETE1
Parallel Payroll Comparisons
Legacy register against a TRANXACT run, category by category and employee by employee, with a tolerance and a sign-off. Go-live is ready after two cycles in a row are signed off.
GET4 POST5 PUT1 DELETE1
Pay Processing
Direct Deposits
Who is paid where, masked to the last four, and the pay periods each account is in force. A change is asked for, approved by somebody else, and paid from the next pay period.
GET2 POST4 PUT1 DELETE1
Pay File Settings
The account net pay leaves from, the ACH identity the bank gave the company, balanced files and prenotes.
GET1 PUT1
Pay Files
Each payroll run’s net-pay file for the bank, every version kept with its checksum and control totals. Made from Payroll Runs > Create pay file.
GET4 POST6 PUT1 DELETE1
Payroll Readiness
Each pay group’s period now due, how far its cycle has got, and what is still open before it can be run.
GET2 POST2 PUT1 DELETE1
Payroll Register
Every payslip in every run, with what it cost the employer.
GET2 POST2 PUT1 DELETE1
Payroll Runs
Read and maintain payroll runs records (hr.payroll_runs).
GET5 POST9 PUT2 DELETE2
Payslip Explained
Every line of every payslip with the sentence that explains it — for the one conversation every payroll clerk has.
GET1
Retroactive Pay
Money owed for periods already paid, from a change dated backwards.
GET2 POST2 PUT1 DELETE1
Year to Date
What every tax rule actually reads: the wage bases, the thresholds and the limits are all year-to-date questions.
GET2 POST2 PUT1 DELETE1
Year to Date by Jurisdiction
Each state, state program and locality on its own, as the W-2’s boxes 14 to 20 need it. Accumulated by payroll; correct the payslip and these follow.
GET2 POST2 PUT1 DELETE1
Pay Setup
Deduction Codes
What comes out, in what order, and which taxes it reduces before it does.
GET2 POST2 PUT1 DELETE1
Earning Codes
What money is called, how each kind is worked out, and whether it counts as wages.
GET2 POST2 PUT1 DELETE1
Employee Deductions
What comes out of a particular person’s pay, including garnishments and loans.
GET2 POST2 PUT1 PATCH1 DELETE1
Local Tax Assignments
The cities, counties, school districts and PSDs each employee is taxed by, as a resident or as somebody who works there. The work and home locality on the employee record count as assignments too; this is for anything more.
GET2 POST2 PUT1 DELETE1
Pay Calendar
The periods a pay group is paid for, and when each one is paid.
GET2 POST3 PUT1 DELETE1
Pay Formulas
An earning or deduction code worked out by a formula over the pay variables (hours, rate, base_pay, gross, years_of_service ...). Test it, activate it from a date, and change it only by adding a new version: payslips already paid keep the version they used. Set the code's "Worked out as" to Formula to use it.
GET3 POST7 PUT1 DELETE1
Pay Groups
Who is paid together, how often, and which engine calculates them.
GET2 POST3 PUT1 DELETE1
Payroll Tax Accounts
Which liability account each kind of tax is owed on when a payroll is posted. Anything left on 2110 stays where it always was.
GET2 POST2 PUT1 DELETE1
Recurring Earnings
Pay that repeats every period without being re-entered.
GET2 POST2 PUT1 DELETE1
Withholding (W-4)
What each employee has told the employer to withhold. Nothing can be calculated for somebody with no setup on file.
GET2 POST2 PUT1 DELETE1
Payroll Tax
Payroll Tax Calendar
What is due and when. The deposit and the return are separate rows because they are separate obligations with separate penalties.
GET2 POST2 PUT1 DELETE1
Payroll Tax Deposits
Every deposit actually made. Separate from the liability because one liability can be deposited in instalments and one deposit can cover several liabilities, and the reconciliation between them is the annual step where errors are found.
GET2 POST2 PUT1 DELETE1
Payroll Tax Findings
What the checks turned up. A negative net pay and a missing registration are both blocking, and for the same reason: somebody outside the company finds them first.
GET2 POST2 PUT1 DELETE1
Payroll Tax Liabilities
One row per obligation. "Payroll tax" is not a number: it is six numbers to five authorities on four clocks, and the run total is the sum of these rather than the other way round.
GET2 POST2 PUT1 DELETE1
Payroll Tax Periods
A run has a purpose as well as a period. The same pay period appears in a deposit run, a return and a year end at different times, computed the same way and reconciled against each other.
GET2 POST2 PUT1 DELETE1
Payroll Tax Registrations
One per obligation, not one per authority: an income-tax withholding account and an unemployment account with the same state are different registrations with different numbers, different rates and different due dates.
GET2 POST2 PUT1 DELETE1
People
Employees
Open a worker for their work relationships, right to work, compliance, talent profile, goals, reviews and offboarding. A rehire is a new relationship and the same person, which is what keeps continuous service right.
GET5 POST10 PUT2 PATCH1 DELETE1
Jobs
The job catalogue: what each kind of work is called, its level, and what it asks of the person who does it. Every position is a seat of one of these jobs. A job in use is set inactive rather than deleted.
GET2 POST2 PUT1 DELETE1
Organization Chart
The reporting line, graphically. Drag a person onto another to change their manager.
GET3 POST5
Personnel Actions
Promotions, transfers and pay changes, each approved by somebody other than whoever asked and applied to the employee on the day it takes effect — with the history of what changed from what.
GET3 POST7 PUT1 DELETE1
Positions
The seats on the organization chart: each one a job, in a department and a location, with the headcount it is budgeted for and the grade it is paid in. People are hired into positions.
GET2 POST2 PUT1 PATCH1 DELETE1
Possible Duplicate Employees
Every employee whose name matches another record together with an email, a national identifier (such as an Iqama number), the same position and hire date, or the same person record; every employee with the same email, or simply the same name, as another current employee (namesakes stay listed until somebody records that they are different people) -- and every current employee who looks like a FORMER employee held as a different person (a possible rehire). Open both to compare. The same person hired back: choose Same person -- link as rehire, and the employment joins the person of the former employee, keeping its own pay and records. Different people: choose Not a duplicate and say why (or say why when saving with Create anyway), and the pair leaves this list.
GET2 POST3 PUT1 DELETE1
Performance & Talent
Check-in Status
Each goal’s check-in clock: the cycle’s cadence, the last check-in, when the next is due, and which are overdue.
GET2 POST2 PUT1 DELETE1
Development Actions
The steps of each plan: a course (enrolled, and closed when completed), a skill to a level, mentoring, a stretch assignment.
GET2 POST3 PUT1 DELETE1
Development Plans
What a person will do to grow: actions with due dates, linked to courses and skills. Activating a plan enrols its courses.
GET2 POST3 PUT1 DELETE1
Goal Check-ins
Where each goal stood at each check-in, the owner’s update and the manager’s answer.
GET2 POST4 PUT1 DELETE1
Goals
How a goal is judged has to be agreed before the period rather than argued after it, which is what the measure and target are for.
GET2 POST4 PUT1 DELETE1
Performance Cycles
The period, the rating scale and whether ratings have to fit a distribution.
GET2 POST3 PUT1 DELETE1
Performance Reviews
Performance and potential are different axes, and conflating them is what makes a nine-box impossible to build later.
GET3 POST6 PUT1 DELETE1
Review History
Every move of every review: who started, submitted, approved, sent back or acknowledged it, and what they said.
GET2 POST2 PUT1 DELETE1
Review Workflow Steps
Each step, in order: what it is, who acts (the employee, their manager, the manager’s manager, or a role) and how many days it has.
GET2 POST2 PUT1 DELETE1
Review Workflows
The steps a performance review passes through, per review type or chosen on a cycle: self review, manager review, calibration, approval, acknowledgement.
GET2 POST2 PUT1 DELETE1
Succession Candidates
Whether the candidate knows matters: a plan they have been told about and one they have not are different instruments.
GET2 POST2 PUT1 DELETE1
Succession Plans
A plan is for a POSITION, not for a person — planning succession for a person is how you end up with no plan when they are promoted.
GET2 POST2 PUT1 DELETE1
Talent Profiles
The nine-box as its two axes, plus flight risk, mobility and what the person themselves says they want — which is not the same as what has been planned for them.
GET2 POST2 PUT1 DELETE1
Reachable by link
Identifiers & Right to Work
Passports, visas, work permits and licences. The status follows the expiry date, and the consequence column is what makes a lapse stop work rather than merely be noticed.
GET2 POST2 PUT1 DELETE1
Offboarding
Leaving, including retirement — the exit conversation, the final pay, the assets, the access, and the obligations that outlive the employment.
GET2 POST2 PUT1 DELETE1
Payroll Tax Run Steps
Every step of every run, with who ran it and who approved it.
GET2 POST2 PUT1 DELETE1
Work Relationships
The layer between a person and their assignments. A rehire is a new relationship and the same person — which is what keeps continuous service right.
GET2 POST2 PUT1 PATCH1 DELETE1
Worker Compliance
What has to be true about a worker before they may do the work — and what happens if it is not.
GET2 POST2 PUT1 DELETE1
Records
Comp cycle status
Read and maintain comp cycle status records (hr.comp_cycle_status).
GET2 POST2 PUT1 DELETE1
Cost center lookup
Read and maintain cost center lookup records (acct.cost_centers).
GET2 POST2 PUT1 DELETE1
Labor lookup
Read and maintain labor lookup records (hr.labor_lookup).
GET2 POST2 PUT1 DELETE1
Learning path progress
Read and maintain learning path progress records (hr.learning_path_progress).
GET2 POST2 PUT1 DELETE1
Merit matrix
Read and maintain merit matrix records (hr.merit_matrix).
GET2 POST2 PUT1 DELETE1
Persons
Read and maintain persons records (hr.persons).
GET2 POST2 PUT1 DELETE1
Requisition status
Read and maintain requisition status records (hr.requisition_status).
GET2 POST2 PUT1 DELETE1
Recruiting & Onboarding
Applications
Every application received against a vacancy, and what stage it has reached. This is the screen that answers "how many applied, how many were shortlisted, how many were interviewed, and who was selected" — counted from the record rather than from a spreadsheet somebody keeps.
GET3 POST6 PUT1 DELETE1
Calendar Invitations
Invitations sent from interviews, performance reviews and check-ins: who was invited to what, when, and how often it was sent. Sending again after a change updates the same calendar entry; cancelling removes it from every calendar.
GET1 POST2
Candidate Messages
What a candidate is told when their application arrives, reaches a stage, is invited to interview, is not taken further or is made an offer. Switch a message on to send it by itself.
GET2 POST2 PUT1 DELETE1
Candidate Ranking
Everybody who applied for a vacancy, in the order the interview panels put them. Candidates on the same score share a rank. Selecting anyone ranked below a candidate still in the running is allowed — with the reason kept on the record.
GET2 POST3 PUT1 DELETE1
Candidates
Everybody who has been in front of this company for a post, whether they applied or were found. Somebody already employed here is marked internal, which is what makes an internal move visible as one.
GET2 POST4 PUT1 DELETE1
Careers Site
The company's public careers site: its live postings on the careers-site channel, each with an apply form that works without signing in. Closed until you open it; at an unguessable address until you choose a public one. Internal postings are never shown there (employees see them under Internal Jobs).
GET2 POST4 PUT1 DELETE1
Hiring Approval Rules
Which vacancies need signing for, and by whom. The people are named on the rule's Approval Levels (Supply Chain > Procurement Control > Approval Levels, choosing the rule under "Hiring rule"), which is the same screen a purchase order uses — one delegation of authority, written once. A rule with no level that applies cannot send a request for approval.
GET2 POST2 PUT1 DELETE1
Hiring Approvals
Every signature a vacancy is waiting for, in the order they are collected. The level being waited on is the one whose earlier levels have all signed — nothing below it can be decided first.
GET2 POST3 PUT1 DELETE1
Hiring Requisitions
A request for a post: what it is, which grade, where, what it costs for a year, and why it is needed. Send it for signature and it collects the approvals its value calls for; only an approved vacancy can be advertised.
GET6 POST5 PUT1 PATCH1 DELETE1
Interview Panels
Every seat on every interview panel: who sits, as what, what they recommended and what they gave out of 100. A panelist marks their own row with Score.
GET2 POST2 PUT1 DELETE1
Interview Scorecards
What a panel marks a candidate on, how much each criterion counts, and how the panel’s view becomes a recommendation — set before anybody is interviewed. One for a vacancy, one for a job, or the company’s default.
GET3 POST3 PUT2 DELETE2
Interviews
Who is being seen, by whom, when, and what came of it. A round with no feedback is a meeting nobody can act on, which is why the outcome sits on the row.
GET6 POST10 PUT3 DELETE3
Job Postings
Where a vacancy was advertised, and for how long. One vacancy can be advertised on several channels at once — the staff portal and a newspaper are two postings against one request. Attach the published advertisement to the posting and it stays with the record of the appointment.
GET2 POST3 PUT1 PATCH1 DELETE1
Joining & Leaving
Every checklist actually running: whose it is, what is done, what is overdue. A new joiner's access, card and desk are on one of these, and so is what a leaver still has to hand back.
GET3 POST4 PUT1 DELETE1
Messages to Candidates
Every message written to a candidate -- by itself or by hand, sent, held, opted out or failed -- and why.
GET2 POST2 PUT1 DELETE1
Offer Letter Templates
The letter an offer is sent with. Send writes it from the default template, files it as a PDF on the offer and sends it for the candidate's electronic signature.
GET2 POST2 PUT1 DELETE1
Offers
Offers out to candidates, and where each one is in its approval and response cycle.
GET3 POST6 PUT1 DELETE1
Onboarding Checklists
What has to happen before somebody can start, and what has to happen when they leave. A sign-in to raise, an identity card to print, a desk to allocate, assets to hand back — held as a template so nobody is relying on remembering it.
GET2 POST2 PUT1 DELETE1
Pipeline Stages
The stages an application passes through, and which of them mean shortlisted, interviewed, offered and hired. Counting a funnel is only possible because these are records rather than words in a column.
GET2 POST2 PUT1 DELETE1
Recruiting Settings
Whether offers go out for electronic signature and who countersigns them, how long an applicant's self-identification link works, and the smallest group the EEO report will show.
GET2 POST2 PUT1 DELETE1
Task Departments
Which department does the onboarding and offboarding tasks of each owner role, and who answers for them. The offboarding dashboard counts each department's tasks, overdue ones first.
GET2 POST2 PUT1 DELETE1
Reporting
Saudi Payroll
End of Service
What each employee would be owed on leaving: half a month’s wage for each of the first five years and a month for each after, on the last wage; a third, two thirds or all of it on resignation, by length of service (articles 84 and 85).
GET1
GOSI Rates
What GOSI takes, from whom and from when. A Saudi registered before 3 July 2024 pays 9.75% and the employer 11.75%; one registered since is on the new law’s rising annuity rate; for anybody else the employer pays 2% occupational hazards. On basic + housing, at least SAR 1,500 and at most SAR 45,000 a month.
GET2 POST2 PUT1 DELETE1
GOSI Statement
The month’s contributions to GOSI, employee by employee — the contributory wage, the annuity, SANED and hazards shares — beside what the payslips actually deducted. Due by the 15th of the next month.
GET1 POST1
WPS Salary File
The salary information file for an approved payroll run, for the bank to pay and Mudad to record. Each employee’s iqama or ID, bank and IBAN, and the pay split into basic, housing, other earnings and deductions.
GET1 POST1
Services and actions
Benefits
The benefits service of HRMS: 3 operation(s).
GET1 POST2
Comp
The comp service of HRMS: 6 operation(s).
GET2 POST3 PUT1
Engines
The engines service of HRMS: 9 operation(s).
GET2 POST5 PUT1 DELETE1
Expiring
The expiring service of HRMS: 1 operation(s).
GET1
Leave
The leave service of HRMS: 7 operation(s).
GET1 POST6
Payroll
The payroll service of HRMS: 3 operation(s).
GET1 POST2
Payroll country
The payroll country service of HRMS: 1 operation(s).
GET1
Payroll tax
The payroll tax service of HRMS: 14 operation(s).
GET5 POST9
Payslips
The payslips service of HRMS: 1 operation(s).
GET1
Plan tiers
The plan tiers service of HRMS: 1 operation(s).
GET1
Recruiting
The recruiting service of HRMS: 4 operation(s).
GET4
Tax form types
The tax form types service of HRMS: 1 operation(s).
GET1
Statutory Regimes
Regime Components
The parts of a statutory regime: an income tax on slabs, a social contribution, an employer cost.
GET2 POST2 PUT1 DELETE1
Regime Filings
The returns a regime reports, how often, to whom, and the columns each carries.
GET2 POST2 PUT1 DELETE1
Regime Tax Slabs
The slabs of an income tax component: each taxes the part of annual income inside it. They run on without gaps from 0.
GET2 POST2 PUT1 DELETE1
Statutory Regimes
Add a country to payroll by configuration: income tax slabs, social contributions, employer costs and the returns it files. The United States, India and Saudi Arabia keep their built-in regimes. The sample regime is a disabled worked example: copy it under your own country code.
GET2 POST6 PUT1 DELETE1
Tax & Filing
Engine Exchanges
Every exchange with an outside tax or payroll engine. When a provider and the ledger disagree six months later, this is what settles it.
GET2 POST2 PUT1 DELETE1
Local Brackets
A locality’s graduated resident scale — New York City’s, chiefly.
GET2 POST2 PUT1 DELETE1
Local Tax Jurisdictions
Cities, counties, school districts, PA political subdivisions and transit districts, with their resident and non-resident rates and the rule that decides between them.
GET2 POST2 PUT1 DELETE1
State Brackets
The graduated scales the state methods read. Only From and Rate matter to the calculation; a state with no married table withholds married filers on its single one.
GET2 POST2 PUT1 DELETE1
State Programs
What employees pay into in the state they work in: disability, family and paid leave, long-term care, employee unemployment — each with its own wage base, and each a line on the payslip and an entry in W-2 box 14.
GET2 POST2 PUT1 DELETE1
State Rates
How each state withholds: no tax, a flat rate, its graduated scale (State Brackets) or California’s DE 44. The note says which year each figure is from — check it against the state’s employer guide before a live run.
GET2 POST2 PUT1 DELETE1
Statutory Forms
The statutory payroll forms of the company’s country, and where each one is prepared.
GET3 POST4 PUT1
Tax Constants
The rates and wage bases in force for a year. Held as data because they change every year — check them against the current Publication 15-T.
GET2 POST2 PUT1 DELETE1
Withholding Tables
The percentage-method brackets. "Multiple jobs" is the standard table with every threshold halved, which is what step 2(c) of the W-4 selects.
GET2 POST2 PUT1 DELETE1
Time & Attendance
Clock Punches
Every clock-in, clock-out, break and status, with the server’s time, where it came from and, where asked for, the position. Never edited: a wrong one is put right by a punch correction.
GET2 POST2 PUT1 DELETE1
Overtime Rules
Overtime is a conclusion, not an entry. The rules of the country a person is paid in apply to them, and the most specific wins: an agreement over a regional rule over the national one.
GET3 POST2 PUT2 DELETE1
Punch Corrections
A missed or wrong punch put right, with the reason, decided by somebody other than whoever asked and never by the employee themselves. Those an employee asks for wait in their manager’s Team Approvals too.
GET2 POST3 PUT1 DELETE1
Punch Exceptions
The last two weeks’ missed punches: a clock-in never clocked out, a break never ended, and -- for people whose policy requires punches -- a scheduled day with no punch and no leave.
GET1
Roster
Read and maintain shift assignments records (hr.shift_assignments).
GET2 POST2 PUT1 DELETE1
Schedule Assignments
Read and maintain employee schedules records (hr.employee_schedules).
GET2 POST2 PUT1 DELETE1
Shifts
A shift that ends before it starts runs past midnight, which puts its hours on two dates.
GET2 POST2 PUT1 DELETE1
Time Entries
Read and maintain time entries records (hr.time_entries).
GET2 POST2 PUT1 DELETE1
Time Exceptions
What the daily check found: a shift with no time against it, a no-show, a late start, a very long day, overtime nobody approved, a timesheet nobody submitted. Correct the time where time is kept; mark here what was done.
GET2 POST2 PUT1 DELETE1
Time Policies
How time is captured and counted for a pay group, the people an overtime rule governs, or the whole company: clock punches required or hours typed allowed, whether the browser’s position is asked for, rounding, and a premium for working a holiday.
GET2 POST2 PUT1 DELETE1
Timesheets
Hours entered, then evaluated against the rule that governs the person so that what a manager approves is what will be paid.
GET2 POST7 PUT1 DELETE1
Who’s In
Who is clocked in, on a break or out right now, with the status they last gave and where.
GET1
Work Schedules
The pattern somebody is meant to work. A cycle need not be seven days: four on, four off is eight.
GET3 POST3 PUT2 DELETE2
Trips & Expense Reports
Corporate Cards
Who holds which card, and the account it settles to. What a card paid is not owed to the claimant again.
GET2 POST2 PUT1 DELETE1
Expense Policy
The caps, the daily limits and the receipt thresholds each claim is measured against. A claim above its linked travel request’s estimate is always flagged on the claim — that rule is built in and needs no policy here.
GET2 POST2 PUT1 DELETE1
Expense Reports
Every line is checked against the policy for its type on submission, and the breach is named on the line — which rule, and by how much.
GET3 POST5 PUT2 DELETE2
Per Diem Rates
Lodging, meals and incidentals by destination.
GET2 POST2 PUT1 DELETE1
Travel Requests
What was approved before the trip. An expense type that needs pre-approval has nowhere to hide without one.
GET2 POST7 PUT1 DELETE1
US Employment Forms
FMLA Cases
Family and Medical Leave Act requests: eligibility when asked, the certification, your designation, and the hours used against the 12-week (or 26-week) entitlement. Designating here also decides the request in the self-service inbox. Medical certifications are filed on the case, not on the employee file.
GET5 POST8 PUT1 DELETE1
FMLA Settings
How this company applies FMLA: the entitlement, the 12-month method (one for everybody), whether paid leave runs at the same time, the eligibility rule, and whether the worksite has 50 employees within 75 miles.
GET2 POST2 PUT1 DELETE1
Form I-9
Employment eligibility: Section 1 is the employee’s, by their first day; Section 2 is yours, within three business days of it; Supplement B when a work authorization expires. Overdue forms come first. Numbers are sealed and shown as their last four. Retain until the later of 3 years after the first day and 1 year after employment ends.
GET6 POST6 PUT1 DELETE1
W-4 Submissions
Forms W-4 employees signed in self service. Each took effect from the next pay period as a new withholding record (Employee Tax Setup); the old one is kept. A W-4 needs no approval -- acknowledge that HR has seen it.
GET3 POST3 PUT1 DELETE1