TRANXACT.AI Help

API package

HRMS

Personnel, time, leave, benefits, training, and payroll — payroll posts straight to the general ledger.

198 APIs1347 operationsBase path /api/hrms

Benefits

Benefit Elections What each person chose, what tier they are on, and what it costs them and the employer each period. /api/hrms/benefit-elections 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. /api/hrms/benefit-eligibility-rules GET2 POST3 PUT1 DELETE1 Benefit Enrollments Read and maintain benefit enrollments records (hr.benefit_enrollments). /api/hrms/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. /api/hrms/benefit-plans 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. /api/hrms/benefits-dashboard GET1 Dependents Read and maintain dependants records (hr.dependants). /api/hrms/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. /api/hrms/life-events 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. /api/hrms/plan-years GET2 POST2 PUT1 DELETE1

Carriers & ACA

Certifications & Skills

Compensation

Employee Relations & Records

Garnishments

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. /api/hrms/gl-code-map 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. /api/hrms/gl-exceptions 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. /api/hrms/gl-files 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. /api/hrms/gl-mappings 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. /api/hrms/gl-valid-codes 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. /api/hrms/gl-interfaces 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. /api/hrms/labor-splits 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. /api/hrms/payslip-allocations 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. /api/hrms/course-completions 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. /api/hrms/training-compliance GET2 POST2 PUT1 DELETE1 Course Enrollments Who is on which course, how far they have got, and what they scored. /api/hrms/course-enrollments GET2 POST3 PUT1 DELETE1 Course Evaluations What people thought of a course after completing it: ratings from 1 to 5 and comments. /api/hrms/course-evaluations GET2 POST2 PUT1 DELETE1 Learning Path Assignments Who is on which path and how far along -- completion %. /api/hrms/learning-path-enrollments GET2 POST2 PUT1 DELETE1 Learning Path Courses The courses of each path and their order. /api/hrms/learning-path-courses GET2 POST2 PUT1 DELETE1 Learning Paths Courses in order. A sequential path enrols the next course when the one before it is completed. /api/hrms/learning-paths 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). /api/hrms/learning-reminders GET2 POST2 PUT1 DELETE1 Programme Effectiveness Per course: how many finish, how well they score, and what they thought of it. /api/hrms/course-effectiveness GET2 POST2 PUT1 DELETE1 Session Attendance Who registered for each session, who was wait-listed and who attended. /api/hrms/session-attendance 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. /api/hrms/training-rules GET3 POST3 PUT1 DELETE1 Training Courses Read and maintain training courses records (hr.training_courses). /api/hrms/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. /api/hrms/training-sessions GET2 POST5 PUT1 DELETE1

Leave

LMS Integration

Parallel Payroll

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. /api/hrms/direct-deposits 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. /api/hrms/pay-file-settings 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. /api/hrms/pay-files 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. /api/hrms/payroll-readiness GET2 POST2 PUT1 DELETE1 Payroll Register Every payslip in every run, with what it cost the employer. /api/hrms/payroll-register GET2 POST2 PUT1 DELETE1 Payroll Runs Read and maintain payroll runs records (hr.payroll_runs). /api/hrms/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. /api/hrms/payslip-lines GET1 Retroactive Pay Money owed for periods already paid, from a change dated backwards. /api/hrms/retro-adjustments 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. /api/hrms/ytd-balances 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. /api/hrms/ytd-tax-jurisdictions GET2 POST2 PUT1 DELETE1

Pay Setup

Deduction Codes What comes out, in what order, and which taxes it reduces before it does. /api/hrms/deduction-codes GET2 POST2 PUT1 DELETE1 Earning Codes What money is called, how each kind is worked out, and whether it counts as wages. /api/hrms/earning-codes GET2 POST2 PUT1 DELETE1 Employee Deductions What comes out of a particular person’s pay, including garnishments and loans. /api/hrms/employee-deductions 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. /api/hrms/employee-local-taxes GET2 POST2 PUT1 DELETE1 Pay Calendar The periods a pay group is paid for, and when each one is paid. /api/hrms/pay-periods 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. /api/hrms/pay-formulas GET3 POST7 PUT1 DELETE1 Pay Groups Who is paid together, how often, and which engine calculates them. /api/hrms/pay-groups 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. /api/hrms/payroll-tax-accounts GET2 POST2 PUT1 DELETE1 Recurring Earnings Pay that repeats every period without being re-entered. /api/hrms/employee-earnings 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. /api/hrms/employee-tax-setup 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. /api/hrms/payroll-tax-calendar 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. /api/hrms/payroll-tax-deposits 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. /api/hrms/payroll-tax-findings 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. /api/hrms/payroll-tax-liabilities 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. /api/hrms/payroll-tax-runs 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. /api/hrms/payroll-tax-registrations 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. /api/hrms/employees 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. /api/hrms/jobs GET2 POST2 PUT1 DELETE1 Organization Chart The reporting line, graphically. Drag a person onto another to change their manager. /api/hrms/org-chart 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. /api/hrms/personnel-actions 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. /api/hrms/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. /api/hrms/employee-duplicates 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. /api/hrms/goal-checkin-status 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. /api/hrms/development-plan-actions 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. /api/hrms/development-plans GET2 POST3 PUT1 DELETE1 Goal Check-ins Where each goal stood at each check-in, the owner’s update and the manager’s answer. /api/hrms/goal-checkins 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. /api/hrms/performance-goals GET2 POST4 PUT1 DELETE1 Performance Cycles The period, the rating scale and whether ratings have to fit a distribution. /api/hrms/performance-cycles 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. /api/hrms/performance-reviews GET3 POST6 PUT1 DELETE1 Review History Every move of every review: who started, submitted, approved, sent back or acknowledged it, and what they said. /api/hrms/review-steps 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. /api/hrms/review-workflow-steps 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. /api/hrms/review-workflows 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. /api/hrms/succession-candidates 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. /api/hrms/succession-plans 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. /api/hrms/talent-profiles GET2 POST2 PUT1 DELETE1

Records

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. /api/hrms/applications 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. /api/hrms/calendar-invites 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. /api/hrms/candidate-message-templates 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. /api/hrms/panel-rankings 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. /api/hrms/candidates 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). /api/hrms/careers-site 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. /api/hrms/requisition-approval-rules 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. /api/hrms/requisition-approvals 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. /api/hrms/requisitions 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. /api/hrms/interview-panels 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. /api/hrms/interview-scorecards 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. /api/hrms/interviews 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. /api/hrms/job-postings 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. /api/hrms/checklists 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. /api/hrms/candidate-communications 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. /api/hrms/offer-letter-templates GET2 POST2 PUT1 DELETE1 Offers Offers out to candidates, and where each one is in its approval and response cycle. /api/hrms/offers 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. /api/hrms/checklist-templates 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. /api/hrms/pipeline-stages 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. /api/hrms/recruiting-settings 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. /api/hrms/checklist-owner-departments GET2 POST2 PUT1 DELETE1

Reporting

Saudi Payroll

Services and actions

Statutory Regimes

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. /api/hrms/payroll-interfaces GET2 POST2 PUT1 DELETE1 Local Brackets A locality’s graduated resident scale — New York City’s, chiefly. /api/hrms/local-tax-brackets 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. /api/hrms/local-tax-jurisdictions 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. /api/hrms/state-tax-brackets 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. /api/hrms/state-payroll-programs 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. /api/hrms/state-tax-rates GET2 POST2 PUT1 DELETE1 Statutory Forms The statutory payroll forms of the company’s country, and where each one is prepared. /api/hrms/tax-forms 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. /api/hrms/tax-constants 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. /api/hrms/tax-brackets 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. /api/hrms/time-punches 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. /api/hrms/overtime-rules 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. /api/hrms/punch-corrections 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. /api/hrms/punch-exceptions GET1 Roster Read and maintain shift assignments records (hr.shift_assignments). /api/hrms/shift-assignments GET2 POST2 PUT1 DELETE1 Schedule Assignments Read and maintain employee schedules records (hr.employee_schedules). /api/hrms/employee-schedules GET2 POST2 PUT1 DELETE1 Shifts A shift that ends before it starts runs past midnight, which puts its hours on two dates. /api/hrms/shifts GET2 POST2 PUT1 DELETE1 Time Entries Read and maintain time entries records (hr.time_entries). /api/hrms/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. /api/hrms/time-exceptions 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. /api/hrms/time-policies 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. /api/hrms/timesheets 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. /api/hrms/whos-in GET1 Work Schedules The pattern somebody is meant to work. A cycle need not be seven days: four on, four off is eight. /api/hrms/work-schedules GET3 POST3 PUT2 DELETE2

Trips & Expense Reports

US Employment Forms