Knit is #1 product of the week in the developer tools category on Product Hunt!
X
Insights

Developer's Guide to Accounting API Integration

This article discusses the A to Z of accounting APIs from key accounting concepts that developers need to know to accounting data models, use cases and how to solve the common accounting integration challenges in the smartest way

Any company that undertakes financial data keeping and transactions relies on accounting software to prevent inaccuracies, facilitate automation and overall streamline all aspects of the financial ecosystem. Research shows that 58% of businesses used accounting software to meet the needs of their clients. 

In this article, we will uncover how SaaS providers can easily integrate with different accounting APIs along with key accounting concepts that developers must know to work with accounting data fields. 

What are accounting APIs?

Different accounting functions like payroll, reimbursements, payments, expense/ invoice management, etc. have different software for businesses to use. Each of these accounting software comes with an API, what is collectively called accounting APIs. 

Essentially, accounting APIs help companies integrate different accounting software with their systems of function to ensure smooth transfer of data from one application to the other.

Accounting APIs facilitate a great degree of automation when it comes to financial operations and help companies with informed decision making.      

Types if accounting APIs

Based on different financial functions, there are different accounting APIs that companies use. Each accounting API seeks to address specific needs and functionalities. 

1. General ledger APIs

As the name suggests, general ledger APIs provide all encompassing financial functionalities to companies. They help companies consolidate all financial data about income, expenses, liabilities, assets, etc. in one place. 

Overall, with general ledger APIs, companies can get a macro view of their financial health and make decisions accordingly. General ledger APIs tend to provide users with very granular information.  

Top general ledger APIs: QuickBooks API, Xero API, Sage Intacct API

2. Invoice and billing APIs

Invoicing and billing APIs take care of the payments side of the accounting APIs. For any company, there are a plethora of invoices that are received and need to be processed. There are almost an equal or maybe more volume of bills which are sent. 

Invoicing and billing APIs can help companies create, send and track invoices by automating a lot of functions in the way. They enable users to leverage API calls to carry out different functions associated with invoicing and billing. 

Top invoicing and billing APIs: FreshBooks API, QuickBooks Online Invoicing API, Xero Invoicing API, ZohoBooks API

3. Payroll APIs

This type of accounting APIs enable companies to seamlessly manage employee payrolls and ensure that their employees are paid on time, correctly. They integrate with payroll systems and automate a series of tasks associated with salary disbursement. 

Integration with payroll APIs can enable users to seamlessly get employee information from different company used software, create payroll for the month, manage deductions, based on contract and even create payslips. 

Top payroll APIs: ZohoPeople API, RazorpayX API, UKG Pro API, BambooHR API 

4. Expense management APIs

Each business has a set of expenses that are carried out on a regular basis. As the company scales, the expenses and the management for the same balloons up. Expense management APIs seek to automate the process of recording, tracking, categorizing expenses. 

Furthermore, they integrate all expense related data with other accounting APIs to facilitate smooth transactions. Such tools are especially important from a reimbursement tracking perspective as well. 

Top expense management APIs: Zoho Expense API, SAP Concur API, Quickbooks Online API

5. Reporting and analytics APIs

These APIs integrate with different accounting software to create customized and logic driven reports of financial accounts and provide insights based on the data captured. 

Their main objective is to help gauge the company's financial performance and map it against the goals set initially. 

Top reporting and analytics APIs: QuickBooks Online Reports API, Xero Reports API

6. Payment gateway APIs

Another set of accounting APIs are payment gateway APIs. These APIs help companies integrate different APIs in their applications, website or accounting systems for payment related functionalities. 

Payment gateway APIs are extremely important to manage online transactions and allow companies to accept payment from customers/ others via different payment methods including credit/ debit cards, netbanking, UPI, etc. 

Top payment gateway APIs: PayPal API, PayU API, Stripe API

7. Tax calculation APIs

Since businesses are bound by their local tax regimes, tax calculation APIs make the entire process more streamlined. They integrate with the company’s accounting software and help with calculating tax rates, provide calculation logic and automate various tax-related processes. 

Top tax calculation APIs: Avalara API, TaxJar API, Stripe API

Accounting API key concepts

When using accounting APIs, it is important for developers to understand some of the key concepts or data schemas that you will be using. Knowledge of these concepts will help you make the right API calls and ensure seamless access and exchange of data. 

Learn more about accounting data models here

Account

Essentially, each accounting system has different accounts associated with it. These can be expense accounts, payments accounts, bank accounts, etc. Important data or information related to each account includes a unique identifier, name of the account, type or categorization, balance, transaction model, etc. See docs

Journal Entry

Whenever you record any information in the accounting system, it is referred to as an entry. Each entry is generally associated with an account. An entry includes the entry ID, date, detailed description and line items to support the same. See docs 

Invoice

An invoice is a document which records details about a service provided or received by a company. It includes information about the invoice ID, invoice number (in case a sequential number is provided), customer details, line items in the invoice, total payable amount, taxes, discounts, issue date, due date, quantity, etc. See docs

Payment

Related to invoice is the payment which focuses on the monetary transaction following an invoice generation. This data schema contains information like payment ID, payment date, payment method, payment amount, related invoice ID, etc. See docs

Contact

This refers to an individual or organization that is associated with the accounting system, usually a customer or a vendor. The data carried here contains contact ID, address and contact details, billing address, payment terms and conditions, etc. See docs

Report

A financial report as a key data concept consolidates all data about the financial performance of the company. Key data schemas within the same include report ID, report date, account balances, time period, data metrics, etc. 

Transaction

A transaction is a key concept which records any transfer of money in the form of debit or credit. It contains data schemas like transaction ID, transaction date, value of transaction, type (debit or credit), description, etc. For most organizations, transaction details are included in the Entry / Journal Entry data schema.

While these key concepts and data schemas are more generic in nature, each type of accounting API discussed above will have its own sets of data concepts associated with it, like (illustrative and non exhaustive):

Payroll API key concepts

  • Employee with information like employee ID, name, contact details, employment status, pay rate, tax withholding information, and other relevant employee details
  • Payroll run focused on payroll run ID, start date, end date, payroll adjustments or special considerations
  • Paycheck with paycheck ID, employee details, payment amount, payment date, tax deductions, net pay, etc.
  • Time and attendance with date, employee ID, hours worked, leave type, and any associated calculations or rules, etc. 

See our developer documentation for more details on payroll APIs

Expense management API key concepts

  • Expense report with report ID, submitter details, submission date, status, and associated expenses.
  • Expense category with data schemas on category ID, name, etc. 
  • Expense item with item ID, expense date, amount, currency, vendor details, expense description, supporting documentation
  • Receipt with fields like receipt ID, file attachments, etc. 

Use Cases of Accounting APIs

Data inputs and functionalities from accounting APIs can help businesses automate many financial tasks and facilitate greater efficiency across the spectrum. 

1. Cash flow management

With data from accounting APIs, companies can easily keep real time track of expenses and potential incomes to manage their cash flows better. Real time visibility into projected expenses and cash shortages can help prevent overspending and facilitate better cash management. 

This way businesses can ensure sufficient working capital in the bank and maintain liquidity, while managing investments and other liabilities and assets. 

For instance, healthcare companies can use accounting APIs to automate tracking of healthcare supplies and medicines and create projected expenses to fulfill inventory. 

2. Budgeting and forecasting

Data from accounting APIs can help companies predict spending and expense patterns to create accurate and realistic budgets and financial forecasting for subsequent years. Historical data can enable companies to better optimize expenses and allocate greater budgets to revenue generating areas. 

3. Regulatory compliances

Any company that operates under any law is likely to undergo financial audits from time to time. Accounting APIs ensures that companies have structured and accurate data on their financial health in real time. 

This helps track all financial transactions and be prepared for any audit/ generate audit trails seamlessly. Invariably, accounting APIs, thus, help businesses adhere to regulatory compliances and facilitate transparency and accountability. 

For instance, non profit organizations can use accounting APIs to manage their grants and donations and adhere to the local compliances, promote transparency and prevent any regulatory challenges. 

4. Integration with third party applications 

Accounting APIs can help businesses integrate their accounting software with other applications they use including CRM, ERP, etc. This can automate and facilitate multiple processes without the need for manual data entry. 

For instance, companies can integrate accounting APIs with their HRMS platform for easy information transfer on payslips and payroll updates. Similarly, manufacturing companies can integrate their accounting APIs with ERP and procurement systems for automated invoice processing, payments, etc. 

5. Timely invoicing and payments

Accounting APIs can help companies send automated invoices to customers on a timely basis and integration with payment gateway APIs can enable seamless and faster transactions. Especially, when it comes to subscription based services, accounting APIs can facilitate accurate calculation of recurring billing. 

Most subscription based companies can leverage accounting APIs to predict future revenues and integrate with other applications to handle subscription upgrades and downgrades, which can be automatically captured in subsequent billings. 

6. Vendor and supplier management

A major part of accurate accounting is managing vendors and suppliers. With accounting APIs, companies can easily integrate their procurement systems to automate recording of vendor invoices, track expenses, facilitate timely payments, etc. 

Furthermore, they can be integrated into the enterprise workflow for approval mechanisms, communication and payment scheduling. 

Challenges with Accounting API integration

Undoubtedly, there are several ways in which accounting API integration can help power high levels of efficiency and automation for companies. However, there are a few challenges and risks that can make accounting API integration overwhelming for developers.

Data security and privacy

Accounting applications carry sensitive financial information and are prone to hacking/ unauthorized access during transfer by threats like man in the middle attacks. A key challenge with accounting API integration is to ensure encryption and authentication. 

At the same time, even within the organization, not everyone needs access to all financial information, thus, adding a layer of authorization is important, which can be challenging.

Note: If you are looking for a secure way to scale your accounting integrations, check our Security page to see how Knit is emerging as the most secure unified API platform available in the market today

Data mapping

With different accounting APIs in the market for different functionalities, chances are that fields across the applications are diverse. In such a situation, mapping data for transfer becomes difficult. Inaccurate data mapping can lead to loss of critical financial information during transfer, leading to monetary losses.

API updates and maintenance

Accounting APIs undergo several changes as new features are added and older ones become irrelevant. There can be changes in endpoints, API versions, etc. which require constant monitoring and updating to keep the API working properly. 

At the same time, there can be deprecated features which are not removed, which adds to security challenges. Thus, accounting API maintenance can be a challenge for companies that don’t have large in-house engineering teams or don’t want to spend a lot on API management. 

Legacy system challenges

Most accounting information currently is stored in legacy systems for companies. The new-age accounting APIs differ in data formats, schemas, etc. This can lead to compatibility issues. 

Most legacy systems don’t have APIs and may require additional coding to be integrated with the new accounting APIs. 

Error handling and data consistency

As mentioned, errors in financial data transfer, which is the main objective of using accounting APIs, can lead to heavy financial losses for companies. Thus, constant monitoring, logging and real time error resolution is a challenge that comes with accounting API management and scalability. 

At the same time, as the volume of accounting requests increases, implementing practices like rate limiting and throttle can be challenging if accounting APIs are managed in-house.  

Limited technical knowledge

If you are building and managing your accounting API integration in-house, you will need comprehensive knowledge of different financial concepts, tax knowledge, local compliances, etc. Limited technical knowledge is, thus, another challenge that comes along with accounting APIs. 

At the same time, accounting API integration and transfer of financial data requires adherence of GDPR, GAAS and other regulatory laws, any breach of which can lead to legal repercussions. 

Unified Accounting API: Way Forward

While there might be roadblocks on the way, it is safe to say that accounting APIs have significant use cases across industries. Thus, their implementation and use cannot be negated.

Unified Accounting APIs help businesses connect with multiple accounting software in one go using just one API. Thus, reducing integration shipping time by as much as 80%. 

However, there are some questions you must consider while choosing the right unified accounting API provider for your company. 

Q1. What are the considerations for data privacy and security?

As mentioned, when it comes to accounting APIs, data privacy and security is of utmost importance. Having a safe way to integrate and sync data with accounting software can lead to gaining customer confidence and higher retention rates. 

Since most of the numbers are confidential, it is important that your unified API provider doesn’t access or store a copy of the data. 

In this case, choosing a unified API which has security embedded in the platform infrastructure can be beneficial. An events driven architecture ensures that the unified API doesn’t store a copy of your data, facilitating data privacy and security. 

Such unified API platforms work only with webhooks and the initial and delta data syncs are delivered via events, preventing the possibility of data storage. Learn more

Q2. Is data sync automatic?

A critical part of using APIs is data sync. When choosing a unified accounting API, you need to gauge whether data sync is automatic or needs an additional push. 

If you look closely, there are two types of unified APIs to choose from based on their architecture. Pull based APIs which need an additional polling infrastructure to make constant requests for data sync. 

On the other hand, there are Push based APIs which are events driven with webhooks. Put simply, you need to configure events that will trigger data sync and there will be data flow whenever the event occurs, without any additional push. 

A webhooks driven architecture without any polling infrastructure is definitely easier to maintain and leverage, and facilitate data sync in almost real time. 

Q3. What are the customization functionalities?

When you use a unified API, you want the look and interface feel to be as close as possible to your application. Irrespective of whether it is for internal or external use, interface familiarity leads to a better user experience, be it your end customers or internal employees. 

Thus, you need to check the auth component that is powering the unified API you choose and explore the degree of flexibility and customization it offers in terms of design and styling. 

Javascript SDK as the auth component generally offers greater flexibility and can ensure that your customers feel no friction of a different interface of design while using the unified API within your application. 

Q4. Does it support rate limiting?

Financial data transfer and accounting APIs are vulnerable to brute force attacks like DDoS. To prevent falling prey to such threats, it is important for the unified API to support robust rate limiting. 

Essentially, rate limiting restricts the number of API calls that can be made in a given time duration. Quotas and throttling are two key ways of achieving rate limiting. To prevent attacks, you must choose a unified API which facilitates rate limiting. 

Q5. Does it take care of integration management?

Finally, managing and maintaining integrations can be a challenge and your unified API provider must offer support to take care of the same. Here functionalities like deep RCA and resolution are important to not only identify which accounts were synced, but to also rerun syncs if needed.

The idea is that your unified API should be able to identify and address integration issues on its own. 

This will empower your CX team to troubleshoot errors by themselves and allow your engineering teams to focus more on enhancing product features and functionalities, rather than spending time on maintaining integrations.

Get started with accounting APIs

Knit Unified Accounting API is built to ensure maximum level of data protection while transferring sensitive financial data. Knit also provides a no-polling, webhooks-driven architecture to facilitate data transfer in real time. 

Talk to one of our experts to see how Knit fits into your specific use case. You can also reach out to us with a specific accounting API request. We are always looking to expand our API catalog

Or if you are ready to try it yourself, you can get your Knit Accounting API key today. Getting started is completely free

Sudeshna Roy

Head of Content, Knit

Decoding product and generating users with valuable content

Latest Blogs

Browse all Blogs
API Directory
Apr 9, 2024

A Guide toIntegrating with Freshteams API

11
mins

Freshteam API Directory

A cloud based HR software, Freshteam enables organizations with managing employee details, recruitment, on-boarding, time-off, off-boarding, and organization details, among other aspects of their HR processes and practices. With Freshteam API integration, organizations can seamlessly synchronize data between their application and Freshteam to ensure real time updation of employee information across both platforms. It helps capture any changes in employee status, designation, HR policies, etc. across different applications a business uses. 

Freshteam API Authentication, Filtering, Rate Limits

To ensure utmost security and prevent unauthorized access, Freshteam API uses Oauth2.0 for authentication and authorization. Developers can use the Freshteam UI to make calls to the Freshteam authentication server to obtain an access token. This access token can be used to make valid API calls thereon. The access token identifies the requester and the requester’s permission. In the Freshteam domain, the access token is present under Your API Key, which can be copied and used to make API calls. 

Rate limits i.e. the number of API calls that can be made in a minute for Fresteam API are determined by the plan selected by the organization. The rate limit variation for each plan is dependent on the number of subscribed employees for the organization. The trial account has a limit of 10 API calls per minute, which goes on to as high as (100, 2 * number of subscribed employees) API calls per minute for the enterprise plan. Developers or admins can also keep a track of the API calls to understand their usage patterns via:

  • X-ratelimit-total: Permissible number of API calls in a minute.
  • X-ratelimit-remaining: Number of API calls remaining.
  • X-ratelimit-used-currentrequest: Number of API calls consumed by the API request that obtained the response.

There are several endpoints in Freshteam API which retrieve bulk data, especially the ones which are required to List a certain object. In such a case, developers can use pagination parameters to filter data and limit the responses for a streamlined understanding. Developers can select the page value (from which page number they want responses), as well as the number of responses required for each page (default is set at 50). They can also sort the values as ascending or descending or select some other attribute for sorting as well. 

Freshteam API Objects, Data Models & Endpoints

Employees

  • List all employees: GET /employees
  • Create an employee: POST /employees
  • Retrieve employee information: GET /employees/{id}
  • Update employee information: PUT /employees/{id}
  • List all employee fields: GET /employee_fields
  • Create a custom employee field: POST /employee_fields

Common attributes: id, created at, updated at, workstation number, date of birth, gender, address, communication address, designation, phone number, joining date, termination date, first name, last name, status, official email, personal email, employee type, team id, department id, reporting to id, time off, hire reason, marital status, etc. 

Branches

(Used to configure different geographical locations for an organization and associate employees to a branch)

  • List all branches: GET /branches

Common attributes: id, created at, updated at, name, street, state, country code, zip, time zone, currency, language, main office, date format

Departments & Sub-Departments

  • List all departments: GET /departments
  • List all sub-departments: GET /sub_departments

Business Units

  • List all business units: GET /business_units

Common attributes: id, created at, updated at, name, description

Teams

  • List all teams: GET /teams

Levels

  • List all levels: GET /levels

Timeoffs

  • List all timeoffs: GET /time_offs
  • Create a timeoff request: POST /time_offs
  • List all timeoff types: GET /time_off_types
  • Retrieve timeoff information: GET /time_off_types/{id}
  • Cancel A Timeoff Request: PUT /time_off_types/{id}/ cancel
  • Approve A Timeoff Request: PUT /time_off_types/{id}/ approve

Common attributes: id, created at, updated at, start date, end date, status, leave units, leave type id, status comments, comments, attachment, applied by, approved by, rejected by, canceled by, notify to, description, add to calendar, canceled at, optional leave days, applicable for, auto approve, status

Roles

  • List all roles: GET /roles

Job Postings

  • List all job postings: GET /job_postings
  • Retrieve job posting information: GET /job_postings/{id}
  • List all job posting fields: GET /job_posting_fields
  • List all applicant fields: GET /job_postings/{id}/applicant_fields
  • Create an applicant: POST  /job_postings/{id}/applicants

Common attributes: id, created at, updated at, deleted, title, description, status, show_pursue_as_career, closing date, experience, remote, type, salary, branch, department, title, location, skills, requisitions, label, field type, position, candidate, candidate id, first name, last name, date of birth, mobile, phone number, source id, resume, cover letter, portfolio, skype id, content file name, url, gender, profile link, rejected at, archived at, on hold at, on hold till

Candidate Sources

  • List all candidate sources: GET /candidate_sources
  • Create a candidate source: POST /candidate_sources
  • List all candidate source categories: GET ​/candidate_source_categories

Common attributes: id, created at, updated at, deleted, label, default, leads count

User Functions

  • List all user functions: GET /user_functions

New Hires

  • Create a new hire: POST /new_hires
  • Retrieve new hire information: GET /new_hires/{id}
  • Update new hire information: PUT /new_hires/{id}

Common attributes: id, created at, updated at, deleted, first name, middle name, last name, official email, employee id, status, workstation number, designation, joining date, probation start date, probation end date, branch id, team id, department id, sub department id, termination date, termination reason, notice period, notice start date, notice end date, employee type, hired on, no show, no show reason, date of birth, marital status, gender, blood group, emergency contacts, social profiles, address, communication address, phone numbers, job codes, job exempt, scheduled weekly hours, retirement eligibility date, rehire eligibility, rehire status, confirmed, language, branch, team

Freshteam API Use Cases

  • Centralize HR operations with AI-powered virtual agents, self-service solutions and  seamless integration with MS Teams, Slack, and other applications
  • Automate internal processes with easy-to-configure workflows, leading to streamlined work and increased efficiency
  • Leverage 50+ job descriptions out of the box for use to accelerate hiring processes
  • Capture qualitative feedback about candidates along with better candidate relationships through built-in email and a manageable candidate database

Top customers

50,000+ companies from across 120+ countries use Freshteam to power their HR operations and streamline processes to make them efficient, robust and optimized. Here are some of the top customers that are leveraging Freshteam:

  • Gartner, Inc., an American technological research and consulting firm
  • OpeninApp, a smart link generator tool that ensures all social media links open in the apps they should
  • Dymocks Booksellers, an Australian-founded privately owned bookstore chain
  • Valley Medical Center, a 321-bed, acute care community hospital and clinic network
  • Kirat Plastics, a full-service custom plastic injection molding, metal pressing, fabrication, and assembly facility
  • Lot Squared Development, a Washington DC based design-build residential real estate developer 

Freshteam API FAQs

Here is a list of Freshteam API FAQs that developers must understand to make their integration journey more effective and robust:

  • How to use Freshteam Developer API? Answer
  • Where to find Freshteam API key, how to reset it and Scope of an API Key? Answer
  • What are the status and error messages that indicate the success or failure of an API request in Freshteam API? Answer
  • What are the common request header parameters used in requests to Freshteam APIs? Answer
  • What are the API methods that developers interact with for Freshteam API? Answer
  • What are models in Freshteam API? Answer

Common Integrations with Freshteam API 

Businesses, especially those engaged in the employee side of work, are increasingly seeking integration with Freshteam API to streamline data exchange between this HRIS platform and their application. Some of the top use cases and common integrations with Freshteam API include:

  • Recruitment companies which can use the write APIs to update candidate information into Freshteam once a client is hired to ensure the customer’s HRIS is up to date for all onboarding and future requirements
  • Payroll providers can leverage both read APIs to fetch employee information for payroll creation and disbursement, as well as write APIs, to push back data into customer’s Freshteam account to notify that salaries have been paid
  • Rewards and recognition companies which can use integration with Freshteam API to fetch information on employees to seamlessly manage their operations and help end customers build a culture of recognition.  

How to integrate with Freshteam API 

To kickstart the integration journey with Freshteam API, developers can go through this quick start guide. The first step is to create a developer account and join the Freshteam developer community. Next developers need to follow the installation instructions to install the API SDK. Following this it is important to get acquainted with the authorization and authentication protocols to access data and make API calls.  Learn about the terms of use for accessing or using the Freshteam developer portal and understand the different terminology used. For more support and information, businesses can scroll through the Freshteam support page and get answers to their queries. 

Get started with Freshteam API 

Companies that integrate with Freshteam API benefit from the seamless exchange of information between this HRIS platform and their application and have been able to explore multiple use cases for their end customers. However, manually building and maintaining integration with Freshteam API can be a daunting task for developers. Building the integration alone can take 4 weeks on an average and cost USD 10K (considering the cost of software developers, QA engineers, etc.). Further, the cost associated with maintaining the Freshteam API adds another burden on the bottom line, while diverting resources away from core product functionalities and enhancements. And, this is for a single HRIS integration in question here (Freshteam API). Businesses generally need to integrate with multiple HRIS APIs, meeting the demands of their end customers. Here, a unified HRIS API like Knit can enable businesses to easily integrate with multiple HRIS applications with a single connector. By incorporating an additional layer of abstraction, a unified API allows businesses to ship and scale integrations faster and in an efficient manner. Book a discovery call today to learn how developers can integrate with Freshteam API and other HRIS applications within hours and not weeks. 

API Directory
Apr 9, 2024

A Guide to Integrating with Zenefits APIs

11
mins

Zenefits API Directory

TriNet Zenefits is a leading provider of full service HR solutions. It enables small and medium sized companies to administer and manage benefits, HR offerings, including time tracking, onboarding, employee engagement, employee record keeping; payroll; performance and well-being. As a highly sought after HRIS platform, companies have been increasingly integrating with TriNet Zenefits to facilitate seamless exchange of HRIS data, captured by Zenefits, with their own apps to drive diverse use cases. 

Zenefits API Authentication, Filtering, Rate Limits

Owing to the sensitive nature of information held by the HRIS application, including personal identifiable information (PII), Zenefits API ensures that all data scopes are accessed at a granular level. The Zenefits API uses OAuth2 to authenticate and authorize access to information stored in the application. OAuth2 authorizes third party applications to request private details from Zenefits accounts, without passwords. It is limited only to admins and developers receive unique Client ID and Client Secret to access data with integration. 

Zenefits API pagination helps developers define the records needed per page. The developers can use the limit parameter to specify the number of records in a response. The maximum limit can be 100, however, in case the limit is not defined, the default limit is 20. In case the total number of records do not fit into a single page, the next_url field will have a link to the next page with the remaining records. In case the next_url field displays null, then no records exist for subsequent pages. Developers can also use the starting_after or ending_before query parameter to specify pagination based on object ids. The ending_before query parameter is useful for backwards pagination. 

Zenefits API Objects, Data Models & Endpoints

It is extremely important for developers to understand the objects, data models and endpoints when it comes to integrating with Zenefits API. While the overall scope might be large, here are a few which can be considered as a starting point for Zenefits API integration. 

  • Applications: Used to return information about the application

GET https://api.zenefits.com/platform/applications

  • Companies: Used to get information about the company

GET https://api.zenefits.com/core/companies

Fields include: ‘legal_name', 'ein','departments', 'locations'

  • People: Used to return information about a company’s employees

GET https://api.zenefits.com/core/companies/{:company_id}/people

GET http://api.zenefits.com/core/people/{:id} (For information about a single employee)

GET http://api.zenefits.com/core/people (For information for all employees across the company)

Fields include: 'work_email', 'date_of_birth', 'manager', 'department', 'location', 'work_phone', 'status', 'subordinates', 'banks','company', 'employments', 'department', 'location', 'manager', 'banks'

  • Employments: Used to return information about an employee’s employment history

GET https://api.zenefits.com/core/people/{:person_id}/employments

GET https://api.zenefits.com/core/employments/{:employment_id} (For information on a specific employment

GET https://api.zenefits.com/core/employments (For information on all employments across all people)

Fields include: 'termination_type', 'employment_type', 'comp_type', 'annual_salary', 'pay_rate', 'working_hours_per_week','person'

  • Employee Bank Accounts: Used to return information about employee’s bank account

GET https://api.zenefits.com/core/people/{:person_id}/banks

GET http://api.zenefits.com/core/banks/{:bank_id} (For information for a specific bank)

GET http://api.zenefits.com/core/banks (For information for all banks across all people)

  • Departments: Used to return the list of a company’s department

GET https://api.zenefits.com/core/companies/{:id}/departments

GET http://api.zenefits.com/core/departments/{:department_id} (For information regarding a single department:

GET http://api.zenefits.com/core/departments (For information relating to all departments across all companies)

  • Locations: Used to return the list of a company’s location

GET https://api.zenefits.com/core/companies/{:company_id}/locations

GET http://api.zenefits.com/core/locations/{:location_id} (For information relating to a single location)

GET http://api.zenefits.com/core/locations (For information relating to all locations across all companies)

  • Vacation Requests: Used to return information about employees' PTO vacation requests

GET https://api.zenefits.com/time_off/vacation_requests

GET http://api.zenefits.com/time_off/vacation_requests/{:id} (For information relating to a single vacation request)

GET http://api.zenefits.com/time_off/vacation_types/{:vacation_type_id}/vacation_requests/ (For all vacation requests for a single vacation type)

Fields include: 

  • status: Requested, approved, denied, cancelled, deleted
  • vacation_type: Vacation Type for this request, e.g. Jury Duty, Work From Home, Doctor's Appointment
  • start_date: Start date of vacation request (inclusive)
  • end_date: End date of vacation request (inclusive) 
  • creator i.e. Person who filed this vacation request
  • person i.e. Person who this vacation request applies to (often the same as creator)
  • created_date: Date this vacation request was created
  • hours: Number of hours requested, generally calculated at 8 hours a day for multi-day requests and specified manually for single day requests
  • approved_date: Date this request was moved from requested status, either to approved or denied.
  • reason: Note from the person requesting this vacation
  • deny_reason: Note from the approver for why this vacation request was denied. (Only applies if status is denied)

  • Vacation Types: Used to return information about a company's PTO vacation types

GET https://api.zenefits.com/time_off/vacation_types 

GET http://api.zenefits.com/time_off/vacation_types/{:id} (For information relating to a single vacation type)

Fields include:

  • status: Active, deleted
  • vacation_types
  • name: Name of the type
  • company: Company for this vacation type
  • vacation_requests: Vacation Requests for this type
  • counts_as: What account this type counts towards (vacation, sick, personal)

  • Time Durations: Used to return information about a person's T&A hours

GET https://api.zenefits.com/time_attendance/time_durations

GET http://api.zenefits.com/time_attendance/time_durations/{:id} (For information relating to a single time duration object)

Fields include: 

  • person: Person that this time duration is logged for people
  • activity: Activity type (work, meal_break)
  • state: Effective, overridden, deleted, correction
  • valid_status: valid, exceeds, overlapping same day, overlapping previous day, overlapping next day, missing clock out, missing clock in
  • hours: Number of hours logged
  • start: When this time duration started
  • end: When this time duration ended
  • is_overnight: Whether this time duration has been marked as part of an overnight shift
  • is_approved: When this time duration was approved. 
  • approver: Person who approved this time duration

Zenefits API Use Cases

  • Automate onboarding, saving 100s of hours as information gets auto synced to Benefits and Payroll
  • Simplify employee management with organizational charts, company directories allowing employees to update their own records
  • Improve HR processes and decision making with business intelligence reports and insights on turnover, workforce diversity, with understanding of how to pay new hires
  • Simplify the process of providing great benefits to employees, from comprehensive healthcare plans to extra perks like commuter benefits
  • Facilitate time and attendance management with employee scheduling tools, with time off and clocked-in hours automatically syncing Payroll

Zenefits API FAQs

Here is a list of FAQs about TriNet Zenefits API which can help commence and accelerate your integration:

  • What is the software stack of Zenefits? Answer
  • How to address the CORS issue in Angular 8 without changing the backend in Zenefits API? Answer 
  • How to handle New Company Installations in TriNet Zenefits API? Answer
  • How to handle New People's Subscriptions in TriNet Zenefits API? Answer
  • What does Webhooks shared secret vs OAuth client secret mean? Answer
  • How to read and write custom data with Zenefits API? Answer
  • How to issue Access Tokens for Zenefits API authentication and authorization? Answer
  • Where can I find a guidebook for Zenefits integration? Answer
  • Does Zenefits have a public API? Answer
  • What is Zenefits’ App Acceptance Criteria for API integration? Answer
  • Where is the developer portal for Zenefits API? Answer

Common Integrations with Zenefits API 

Several businesses are increasingly building integrations with Zenefits API to power operations for the end customers, facilitated by seamless data exchange, including:

  • Payroll providers to get access to employee information, employment records and agreement terms, compensation details and other relevant information like leaves, time off, etc. 
  • Candidate recruitment companies to push data about selected candidates and relevant information for smooth onboarding
  • Employee engagement companies to fetch employee data, including demographic information, personal and professional details, attendance, etc. 
  • Early wage access providers to get access to employee information, payroll details and even write back data regarding early payments/ deductions for accurate payroll processing

How to integrate with Zenefits API 

To get started with the Zenefit API integration journey, a developer account needs to be created. To create the same, developers can reach out to Zenefits team by dropping an email on this email address. Reaching out on this email ID will take the developers to the next step to get access to a sandboxed Zenefits test company and credentials to start using the API. Once the Zenefits developer account is active, developers can leverage this getting started guide for a detailed overview on REST API, Modules, Webhooks, Authentication and much more.  It is important to read through and understand the App Acceptance Criteria well. The same can be accessed here. At the same time, knowledge of the Zenefits Developer Policy is critical to understand the technical, brand and general requirements and restrictions. 

Get started with Zenefits API 

Integrating with Zenefits API is beneficial for businesses looking to seamlessly exchange data with this leading HRIS provider with bi-directional sync. However, building a custom 1:1 integration can be a complex, time and resource intensive process. The above mentioned steps, restrictions and requirements can all choke up developer bandwidth. Invariably, SaaS businesses today are moving away from building integrations to partnering with unified APIs like Knit. A unified API, in this case for HRIS integrations, enables companies to integrate once and seamlessly connect with multiple HRIS applications, including Zenefits API, without any additional requirements. With a unified HRIS API, maintenance and management of integration with Zenefits and other applications also becomes quite easy. Book a discovery call today to learn how a unified API can help you ship and scale integrations fast. 

API Directory
Mar 21, 2024

Comprehensive Guide to Keka API Directory

11
mins

Keka is a leading human resources management system that enables organizations to seamlessly manage diverse aspects of their human resource processes, including recruitment and onboarding, attendance and time management, payroll, expense and performance management. With OAuth authentication, rate limiting, pagination, and adherence to industry standards, Keka provides developers with everything they need to build robust integrations with their software/ platform and facilitate data exchange between their application and this leading HRMS portal. 

Keka API Authentication, Pagination, Rate Limit

To ensure safe and secure access, Keka API uses OAuth for authentication. This suggests that for successful integration, developers need an access token which can be generated with specific details. This includes client id (identifier for the client), client secret (for secure authentication), api key (unique API key for accessing the system), scope (requires passing kekaapi for this key). To facilitate integration testing for applications, developers can also leverage the Sandbox Environment which is offered by Keka. This allows developers to ensure robust functionality, before integration production begins. Keka APIs already come with pagination implemented to ensure response time optimization. The standard or the default page size in Keka is 100 with 1 being the default page number. 

API limit is a critical element of any API and so is the case with Keka, which helps define the number of requests that can be made to Keka within a limited time period. Keka has a rate limit of 50 API requests/ minute. This suggests that once 50 requests are made in a minute, the user needs to wait for the quote to be refilled before any other request is made. The rate limits are enforced and automatically reset after 60 seconds. In case a request is made before the quota is refilled, a 429 error with the reason rateLimitExceeded will be sent. 

Keka API Objects, Data Models & Endpoints

As a developer or the representative of an organization seeking to integrate with Keka API, it is important to understand the endpoints that you will be using eventually for data exchange, both when it comes to read APIs (getting data from Keka) as well as write APIs (providing data to Keka). 

CORE HR

Employees

  • Get all Employees

GET https://{company}.{environment}.com/api/v1/hris/employees

  • Create an Employee

POST https://{company}.{environment}.com/api/v1/hris/employees

  • Get an Employee

GET https://{company}.{environment}.com/api/v1/hris/employees/{id}

  • Get all update fields

GET https://{company}.{environment}.com/api/v1/hris/employees/updatefields

  • Update Employee personal details

PUT https://{company}.{environment}.com/api/v1/hris/employees/{id}/personaldetails

  • Update employee job details

PUT https://{company}.{environment}.com/api/v1/hris/employees/{id}/jobdetails

Groups

  • Get all Groups

GET https://{company}.{environment}.com/api/v1/hris/groups

  • Get all Group Types

GET https://{company}.{environment}.com/api/v1/hris/grouptypes

Departments

  • Get all departments

GET https://{company}.{environment}.com/api/v1/hris/departments

Locations

  • Get all Locations

GET https://{company}.{environment}.com/api/v1/hris/locations

Job Title

  • Get all job titles

GET https://{company}.{environment}.com/api/v1/hris/jobtitles

Currency

  • Get all currencies

GET https://{company}.{environment}.com/api/v1/hris/currencies

Notice Period

  • Get all notice periods

GET https://{company}.{environment}.com/api/v1/hris/noticeperiods

LEAVE

Leave Types

  • Get all Leave Types

GET https://{company}.{environment}.com/api/v1/time/leavetypes

Leave Balance

  • Get all Leave balances

GET https://{company}.{environment}.com/api/v1/time/leavebalance

Leave Requests

  • Get all Leave Requests

GET https://{company}.{environment}.com/api/v1/time/leaverequests

  • Create an Leave Request

POST https://{company}.{environment}.com/api/v1/time/leaverequests

ATTENDANCE

Attendance

  • Get all Attendance Records

GET https://{company}.{environment}.com/api/v1/time/attendance

Attendance Capture Scheme

  • Get all captureschemes

GET https://{company}.{environment}.com/api/v1/time/capturescheme

Holiday Calendar

  • Get all holidays Calendar

GET https://{company}.{environment}.com/api/v1/time/holidayscalendar

PAYROLL

Salary Components

  • Get all Salary Components

GET https://{company}.{environment}.com/api/v1/payroll/salarycomponents

Pay Groups

  • Get all Pay Groups

GET https://{company}.{environment}.com/api/v1/payroll/paygroups

Pay Cycles

  • Get all Pay Cycles

GET https://{company}.{environment}.com/api/v1/payroll/paygroups/{payGroupId}/paycycles

  • Get Pay Register

GET https://{company}.{environment}.com/api/v1/payroll/paygroups/{payGroupId}/paycycles/{payCycleId}/payregister

  • Get all Pay Batches

GET https://{company}.{environment}.com/api/v1/payroll/paygroups/{payGroupId}/paycycles/{payCycleId}/paybatches

  • Get all Batch Payments

GET https://{company}.{environment}.com/api/v1/payroll/paygroups/{payGroupId}/paycycles/{payCycleId}/paybatches/{payBatchId}/payments

  • Update the Payments status

PUT https://{company}.{environment}.com/api/v1/payroll/paygroups/{payGroupId}/paycycles/{payCycleId}/paybatches/{payBatchId}/payments

Pay Grades

  • Get all Pay Grades

GET https://{company}.{environment}.com/api/v1/payroll/paygrades

Pay Bands

  • Get all Pay Bands

GET https://{company}.{environment}.com/api/v1/payroll/paybands

PSA

Clients

  • Get all clients

GET https://{company}.{environment}.com/api/v1/psa/clients

  • Create a Client

POST https://{company}.{environment}.com/api/v1/psa/clients

  • Get a client

GET https://{company}.{environment}.com/api/v1/psa/clients/{id}

  • Update a Client

PUT https://{company}.{environment}.com/api/v1/psa/clients/{id}

Project Phases

  • Get project phases.

GET https://{company}.{environment}.com/api/v1/psa/projects/{projectId}/phases

  • Create a Project Phase

POST https://{company}.{environment}.com/api/v1/psa/projects/{projectId}/phases

Projects

  • Get all projects.

GET https://{company}.{environment}.com/api/v1/psa/projects

  • Create a Project

POST https://{company}.{environment}.com/api/v1/psa/projects

  • Get a project

GET https://{company}.{environment}.com/api/v1/psa/projects/{id}

  • Update a Project

PUT https://{company}.{environment}.com/api/v1/psa/projects/{id}

  • Get a project allocations

GET https://{company}.{environment}.com/api/v1/psa/projects/{id}/allocations

  • Get project timesheet entries.

GET https://{company}.{environment}.com/api/v1/psa/projects/{id}/timeentries

Tasks

  • Get project tasks.

GET https://{company}.{environment}.com/api/v1/psa/projects/{projectId}/tasks

  • Create a task

POST https://{company}.{environment}.com/api/v1/psa/projects/{projectId}/tasks

  • Update a task

PUT https://{company}.{environment}.com/api/v1/psa/projects/{projectId}/tasks/{taskId}

  • Get project task time entries.

GET https://{company}.{environment}.com/api/v1/psa/projects/{projectId}/tasks/{taskId}/timeentries

PMS

Time Frames

  • Get time frame list.

GET https://{company}.{environment}.com/api/v1/pms/timeframes

Goal

  • Get goal list.

GET https://{company}.{environment}.com/api/v1/pms/goals

  • Update goal progress

PUT https://{company}.{environment}.com/api/v1/pms/goals/{goalId}/progress

Badge

  • Get badge list.

GET https://{company}.{environment}.com/api/v1/pms/badges

Praise

  • Add Praise

POST https://{company}.{environment}.com/api/v1/pms/praise

EXPENSE

Expense Category

  • Get all Expense Categories

GET https://{company}.{environment}.com/api/v1/expense/categories

Expense

  • Get all Expense Claims

GET https://{company}.{environment}.com/api/v1/expense/claims

Expense Policy

  • Get all expense policies

GET https://{company}.{environment}.com/api/v1/expensepolicies

ASSETS

Asset

  • Get all Assets

GET https://{company}.{environment}.com/api/v1/assets

Asset Type

  • Get all Asset Types

GET https://{company}.{environment}.com/api/v1/assets/types

Asset Category

  • Get all Asset Categories

GET https://{company}.{environment}.com/api/v1/assets/categories

Asset Condition

  • Get all Asset Conditions

GET https://{company}.{environment}.com/api/v1/assets/conditions

Keka API Use Cases

  • Easy payroll processing and integration with attendance and leave to ensure proper calculation of payroll and taxes
  • Covers every HR workflow to manage people processes, including hiring, onboarding, probation confirmation, internal movements, etc.
  • Streamline all HR operations with automated workflows, comprehensive analytics, and hassle-free employee management
  • Conduct a multi-dimensional assessment of employees' abilities, behavioral competencies, and performance for constructive team evaluation
  • Get an accurate view of revenue against each project, resources allocation, and amount of time spent
  • Robust attendance management system that integrates every aspect of time tracking, including scheduling shifts, and tracking over-time, fully integrated with payroll

Top Customers

Keka, as an HRMS tool, is widely used with 5000+ customers, including:

  • Noise, India's trusted wearable watch brand
  • GrabOn, one of India’s top players in the coupons and deals industry
  • ICM, a UK-based global multi-regulated financial service provider
  • Easypolicy, a leading insurance aggregator
  • Traveazy, a Dubai-based travel-tech company focused on simplifying pilgrimage travel
  • Unbox Robotics, a leading supply chain robotics technology company specializing 
  • HackerEarth, a comprehensive developer assessment software that helps companies accurately measure developers' skills while recruiting
  • Metrochem API, a manufacturer of Active Pharmaceutical Ingredients (APIs), Pellets, and Intermediates in Multi Therapeutic segments

Keka API FAQs

Here’s a list of quick FAQs which will help answer any thoughts that you might have during your journey of integrating your application with Keka API

  • How can an admin create an API access key on Keka? Answer
  • How to integrate the Mettl assessment app with Keka Hire? Answer
  • How to integrate Naukri with Keka Hire? Answer
  • How to integrate Keka Hire with HackerEarth for Sending Assessments? Answer
  • How to integrate Keka Hire with LinkedIn? Answer 
  • How to integrate MS Teams account with Keka Hire? Answer
  • How to integrate SpringVerify with Keka? Answer

How to integrate with Keka API 

If you are just getting started, it might be a good idea to go through this documentation to understand how you can initiate the integration process. The detailed documentation contains everything you need to know about the overview, endpoints and much more. Leverage this to learn about the different data models scope and other details which will come in handy to get started. At the same time, this link will help you generate the access token for seamless authentication. 

Get started with Keka API 

While the guide shared above will serve as a comprehensive starting point for you to integrate your application with Keka API, it is important to understand that the entire process can be engineering heavy, time consuming and resource intensive. Put simply, it’s not just about building an integration, but also about managing and maintaining it over time. At the same time, if you want to connect with other HRMS APIs, the process becomes multifold. In such a situation, leveraging a unified HRMS API like Knit can come in handy. Knit enables SaaS businesses to easily connect with multiple HRMS applications by integrating once with its unified API, eliminating the need to connect with each application separately.

Book a demo call today to learn how you can accelerate your integration journey with Keka and other HRMS applications using Knit. 

Start building with Knit, today

Talk to our sales team for a free tour of Knit!

Book Demo!