API Reference
Log In
API Reference

Introduction

Welcome to Symmetrical Rails

Symmetrical Rails is a powerful REST API that gives any developer access to world-class, international payroll infrastructure that can be embedded directly into any software. We enable you to run payroll for your clients, read payroll data, access payroll cashflows but also to programatically hire people, all in a few lines of code. Single integration covers multiple geographies.

Symmetrical Rails API is bundled with Symmetrical Objects - microservice-like features that can be copy-pasted into your solution to speed up go-to-market.

Core components of our API:
• Payroll - payroll service management, incl. build-to-gross, gross-to-net calculations
• Hire - High volume hiring, applicants and hire process management
• People - HRIS Lite, employee data management
• Money - Earned Wage Access

Our REST API is here to allow you easy management of your hiring process, applicants, employees, contractors, documents, payroll process and payments. As specified, API also works for reporting purposes and 3rd party partners data access.

In the following sections you will find specifications for access methods, authentication and API data objects. Afterwards, you can find API specification details, divided into following objects:

• Company
• Employees
• Contractors
• Benefits
• Deductions
• Credits
• Payroll
• Payslip
• Payments
• Reporting
• Services for Partners

Once you get familiar with our API specification, contact us to obtain API key for Sandbox environment. After we mutually decide that our integration is ready to roll, we will switch to production environment.