Jump to Content
API Reference
v0.9
v0.91
v0.95
v1.0
Log In
API Reference
Log In
Payroll & Onboarding
API Reference
Update a revenue
Search
JUMP TO
Payroll
Introduction
Topics
API access authorization
RESTful
Coverage Roadmap
3rd party integration
Errors
Webhooks
Backwards compatibility
API Lifecycle policy
Company
Company object
Create new company
post
Retrieve company data
get
Update company data
patch
Retrieve company project structure
get
Add company project
post
Update project information
patch
Delete project
delete
Company-Locations
Company locations
get
Add company location
post
Remove company location
delete
Get company location
get
Update company location
patch
Company-Documents
List company documents
get
Add company document
post
Retrieve company document
get
Update company document
patch
Remove company document
delete
Company-Benefits
Get company benefits
get
Create company benefit
post
Update benefit details
patch
Remove benefit
delete
Employees
Employee object
Create new employee
post
List Company employees
get
Get Employee personal record
get
Update Employee personal record
patch
Get employee documents
get
Submit employee document
post
Get Employee document
get
Update Employee document
patch
Remove Employee document
delete
List Employee payslips
get
Retrieve Employee benefits
get
Assign benefits to Employee
post
Employees-BankAccounts
List employee's bank accounts
get
Add bank account
post
Remove user bank account
delete
Update user bank account
patch
Employees-Contracts
Get user contracts
get
Add contract for user
post
Update user contract
patch
Fetch onboarding contract for Employee
get
Confirm onboarding contract by Employee
post
Contractors
Contractor object
List Company contractors
get
Add new contractor
post
Get Contractor record
get
Update Contractor record
patch
Retrieve Contractor benefits
get
Assign benefits to Contractor(s)
post
List Contractor payslips
get
Contractors-BankAccounts
List contractor's bank accounts
get
Add bank account
post
Remove user bank account
delete
Update user bank account
patch
Contractors-Contracts
Get user contracts
get
Add contract for user
post
Update user contract
patch
Fetch onboarding contract for Contractor
get
Confirm onboarding contract by Contractor
post
Scheduling
Get scheduled shifts
get
Create shifts
post
Get shift details
get
Update shift
patch
Delete shift
delete
Credit
Credit object
Retrieve credits
get
Create credits
post
Update credit record
patch
Delete credit
delete
Payroll
Payroll object
Get Company payroll
get
Create new Payroll
post
Get Payroll details
get
Update Payroll parameters
patch
Set Employees for Payroll
post
Get payroll employees
get
List Payroll calculations
get
Request Payroll calculation
post
Get Payroll calculation
get
Retrieve payslips in payroll calculation
get
Payroll operations
post
Payslip
Payslip object
Get payslip details
get
Payments
Payments object
List issued payment requests
get
Issue payment request based on Employee payslip.
post
Get payment information
get
Approve payment
post
Reject payment request
get
Ext_services
Ext_services usage
Retrieve Employee/Contractor income
get
Get Employee/Contractor deductions
get
Add Employee/Contractor deduction
post
Get Employee/Contractor contract confirmation
get
Get Employee/Contractor bank account information
get
onboardingAPI.v1
Applicants
List applicants
get
Create an applicant
post
Get Applicant information
get
Delete an Applicant
delete
Update Applicant information
patch
Get Applicant documents
get
Upload Applicant document
post
Get Applicant document
get
Update Applicant document
put
Delete Applicant document
delete
Get Applicant assigned workflows
get
Assign Workflows to Applicant
post
Remove Applicant assignment to Workflows
delete
Onboardings
Get Applicant onboardings
get
Approve or Reject an Applicant
post
Advance Applicant onboarding stage
post
Workflows
List workflows
get
Create Workflow
post
Get Workflow
get
Update Workflow
patch
ApplicantUI
Submit Applicant form data
post
Redirect to onboarding flow
get
Applicant access to onboarding flow
get
Revenue Aggregation
Reimbursement
Get a reimbursement
get
Update a reimbursement
put
Delete a reimbursement
delete
Get reimbursements
get
Add a reimbursement
post
Get employee's reimbursements
get
Employees
Get employees
get
Update an employee
put
Add an employee
post
Onboard an employee
post
Get an employee
get
Get employee's system identifiers
get
Settlement Employees
Update employee's working hours in a settlement
post
Update employee's lump sum in a settlement
post
Update employee's cash in a settlement
post
Start processing employees in a settlement
post
Change employees' statuses and resend emails
post
Resend an acceptance email
post
Include an employee in a settlement
post
Get an employee's payouts file
post
Exclude an employee from a settlement
post
Get settlement employees
get
Get a settlement employee
get
Get an employee's settlement receipt file
get
Get a settlement's transfers file
get
Get number of employees in every state
get
Get a settlement's details file
get
Settlements
Close a settlement
post
Finalize a settlement
post
Extend a settlement
patch
Get settlements
get
Get a settlement
get
Get settlement's fee categories
get
Revenues
Add a revenue
post
Delete revenues
post
Get a revenue
get
Delete a revenue
delete
Update a revenue
patch
Reimbursement Categories
Get categories
get
Add a category
post
Get a category
get
Delete a category
delete
Update a category
patch
Fee Categories
Get fee categories
get
Add a fee category
post
Get a fee category
get
Delete a fee category
delete
Update a fee category
patch
Remove employee groups from a fee category
patch
Add employee groups to a fee category
patch
Recurring Fees
Create a fee
post
Get a fee
get
Delete a fee
delete
Update a fee
patch
AdHoc Fees
Add a fee
post
Get a fee
get
Delete a fee
delete
Update a fee
patch
Settlement Configs
Get settlement configs by employer id
get
Add a settlement config
post
Add employees to a settlement config
post
Delete employees from a settlement config
delete
Get a settlement config
get
Delete a settlement config
delete
Update a settlement config
patch
Employer
Onboard an employer
post
Get employers
get
Get an employer
get
Get employer parameters
get
Settlement Reimbursements
Get reimbursements in settlement
get
Get reimbursements for employee
get
Get sum of reimbursements in settlement
get
Settlement employee
Get a settlement employee's invoice
get
Powered by
Update a revenue
patch
http://sandbox.env.symmetrical.ai/v1/revenues/
{revenueId}
Updates revenue
Language
Shell
Node
Ruby
PHP
Python
Credentials
Bearer
JWT
Bearer
RESPONSE
Click
Try It!
to start a request and see the response here!