Overview
September’s updates reduce the number of API calls needed for embedded payroll experiences, improve performance as data volume grows, expand support for tax adjustments and exemptions, and give clients more control when testing in the sandbox.API & Sandbox Updates
getPayPeriodDetails: More information, fewer API calls
getPayPeriodDetails now returns employee names, active wage details, payment methods, differential and base pay information, and tax adjustments. This information previously required additional calls to getUser, so clients can now build payroll detail screens with fewer API requests.
Pagination
Added optionallimit and offset pagination to some of the more time-intensive endpoints:
Pagination enables clients to lazy-load records instead of waiting for an entire dataset, significantly improving initial screen load times as data volume grows. We are continuing to introduce pagination across additional endpoints.
Status: Already live.
Tax Adjustments & Exemptions
Tax adjustments and exemptions must be enabled on a per client basis before they can be used. Rollfi must also configure which taxes are allowed for adjustment or exemption. Contact us before integrating these features.Tax adjustments
- Retrieve the configured tax names with
getAllowedTaxAdjustmentsListbefore submitting an adjustment. - Add adjustments directly with
addPayrollLineItemTaxAdjustments, or include them inline when usingimportRegularPayrollData. An adjustment replaces the calculated amount for that tax; it is not added to or subtracted from the calculated value. - Existing adjustments can be corrected with
updatePayrollLineItemTaxAdjustmentor removed withremovePayrollLineItemTaxAdjustmentbefore payroll submission. - Payroll import components support
overwriteExistingLineItems. When enabled, existing line items for the employee and pay period, including tax adjustments, are replaced by the submitted payload. Include every line item that should remain after the import.
Tax exemptions
- Use
getTaxNameForExemptionto retrieve the tax names Rollfi has configured as eligible. Include auserIdfor employee-level options, or omit it for company-level options. - Add an effective-dated exemption with
addPayrollTaxExemption. Supplying auserIdapplies the exemption to that employee; omitting it creates a company-level exemption. - Review active exemptions with
getEmployeeTaxExemptionsorgetCompanyTaxExemptions, and useupdatePayrollTaxExemptionto set or change the end date. - Some exemptions are marked
High Risk. Integrations must display the warning returned by the API and obtain confirmation before applying one.
Sandbox-Only Methods
New sandbox capabilities make testing faster and reduce the need for manual intervention:- Refresh statuses during testing with
refreshCompanyKybStatus,refreshUserKycStatus,refreshCompanyBankAccountStatus, andrefreshUserBankAccountStatus, reducing test latency. addFundsToLedgereliminates the need to request funds through email.- Gives clients more control and flexibility when testing in the sandbox.
