Demo

## 🚀 Theneo

Theneo is the quickest, simplest way to generate high-quality, interactive API docs. Just import your API collection and we'll take care of the rest.

**⚠️ Note:** All of the stated endpoints and sections are for demonstration purposes only. Theneo does not manage payments API. Get sales data, itemize payments, push orders to POS, and more.The Orders API provides a one-stop shop for integrating advanced payment functionality. You can itemize payments with custom line items or catalog objects, send orders to real Point of Sale devices to be fulfilled, and more.In addition, the Orders API allows you to look through all of a seller's previous sales and returns itemization data, customer references, and other information from POS or online transactions.

&lt;img src="https://assets.website-files.com/61f7e03934c23c1dcc9c3cd4/6306089ecc13c15fe0a7e006_Main page_2 (with visual studoi code logo) 2.svg" alt="" height="237" width="322">

### Generate API Documentation

- Build interactive API docs
- Tailor you documentation
- Create and launch quickly
- Update easily within seconds
- Built for everyone
    

# Integrations

Import your collections manually or use our integrations to automatically migrate your work from:

- Swagger
- Postman
- Github
    

[  
](https://www.theneo.io/#)

[  
](https://app.theneo.io/signup)

API Reference

🚀 Theneo is the quickest, simplest way to generate high-quality, interactive API docs. Just import your API collection and we'll take care of the rest.

⚠️ Note**:** All of the stated endpoints and sections are for demonstration purposes only. Theneo does not manage payments API. Get sales data, itemize payments, push orders to POS, and more.The Orders API provides a one-stop shop for integrating advanced payment functionality. You can itemize payments with custom line items or catalog objects, send orders to real Point of Sale devices to be fulfilled, and more.In addition, the Orders API allows you to look through all of a seller's previous sales and returns itemization data, customer references, and other information from POS or online transactions.

&lt;img src="https://assets.website-files.com/61f7e03934c23c1dcc9c3cd4/6306089ecc13c15fe0a7e006_Main" page_2="" (with="" visual="" studoi="" code="" logo)="" 2.svg="" width="200" height="168">

### Generate API Documentation

- Build interactive API docs
- Tailor you documentation
- Create and launch quickly
- Update easily within seconds
- Built for everyone
    

# Integrations

Import your collections manually or use our integrations to automatically migrate your work from:

- Swagger
- Postman
- Github

Customer CRM API Example

Creates a new customer for a business.

You must provide at least one of the following values in your request to this endpoint:

 *   `given_name`
 *   `family_name`
 *   `company_name`
 *   `email_address`
 *   `phone_number`

Create customer

Updates a customer profile.

To change an attribute, specify the new value. To remove an attribute, specify the value as an empty string or empty object.

As a best practice, you should include the `version` field in the request to enable [optimistic concurrency](https://developer.squareup.com/docs/working-with-apis/optimistic-concurrency) control. The value must be set to the current version of the customer profile.

To update a customer profile that was created by merging existing profiles, you must use the ID of the newly created profile.

Update customer

Retrieve customer

Utilizes one or more supported query filters to search the associated customer profiles with a Theneo account.  
Without an explicit query filter, SearchCustomers returns all customer profiles based on given name and family name in alphabetical order.  
Under normal working conditions, newly created or modified customer profiles become available for the search operation in significantly less than 30 seconds. Occasionally, propagation of new or updated profiles can take up to a minute or longer, particularly during network outages and events.

Search customers

Deletes a customer profile from a business.

This operation also unlinks any associated cards on file.

As a best practice, you should include the `version` field in the request to enable [optimistic concurrency](https://developer.squareup.com/docs/working-with-apis/optimistic-concurrency) control. The value must be set to the current version of the customer profile.

To delete a customer profile that was created by merging existing profiles, you must use the ID of the newly created profile.

Delete customer

All of the stated endpoints and sections are for demonstration purposes only. Theneo does not manage payments API.  
Get sales data, itemize payments, push orders to POS, and more.

**⚠️ Note:** The Orders API provides a one-stop shop for integrating advanced payment functionality. You can itemize payments with custom line items or catalog objects, send orders to real Point of Sale devices to be fulfilled, and more.

In addition, the Orders API allows you to look through all of a seller's previous sales and returns itemization data, customer references, and other information from POS or online transactions.

&lt;img src="https://media.geeksforgeeks.org/wp-content/cdn-uploads/20200318193845/Top-7-Payment-Gateway-APIs-That-Every-Developer-Must-Know.png">

As an organization, you need to be careful while choosing a payment gateway option. It should be according to the customer’s experience on your websites through to cash flow to online sales. Make sure that you take care of at least 5 things mentioned below while choosing a payment gateway… 

- **Security** should be the topmost priority. Make sure that it should be integrated with the 3D security and comply with the PCI Data Security Standard (PCI DSS).
- **Payout Time** should be less to credit money in your bank account.
- **Integration need to be easy and simple** or it can develop a custom-coded solution for your platform easily.
- **Multiple currencies** should be handled by the payment gateway for the customers using different currencies across the world.

Payments / Transaction Examples

Creates a new order that can include information about products for purchase and settings to apply to the purchase.

Create order

Updates an open order by adding, replacing, or deleting fields.

Orders with a `COMPLETED` or `CANCELED` state cannot be updated.

An `UpdateOrder` request requires the following:

- The `order_id` in the endpoint path, identifying the order to update.
- The latest `version` of the order to update.
- The sparse order containing only the fields to update and the version to which the update is being applied.
- If deleting fields, the dot notation paths identifying the fields to clear.

Update order

Retrieve order

Creates a subscription to a subscription plan by a customer.

If a card on file is provided in the request, the API provider will charge the card for the subscription. Otherwise, an email invoice is sent to the customer. The subscription begins instantly unless the optional start date parameter is included in the request. Each unique subscription corresponds to a certain region.

Create subscription

Searches for subscriptions.

Results are ordered chronologically by subscription creation date. If the request specifies more than one location ID, the endpoint orders the result by location ID, and then by creation date within each location. If no locations are given in the query, all locations are searched.

You can also optionally specify `customer_ids` to search by customer. If left unset, all customers associated with the specified locations are returned. If the request specifies customer IDs, the endpoint orders results first by location, within location by customer ID, and within customer by subscription creation date.

Search subscriptions

Updates a subscription.

You can set, modify, and clear the `subscription` field values.

Update subscription

Schedules a `CANCEL` action to cancel an active subscription by setting the `canceled_date` field to the end of the active billing period and changing the subscription status from ACTIVE to CANCELED after this date.

Cancel subscription

Leverage all these API to build your own in-app payroll solution, customized for your users' needs

&lt;img src="https://516180.smushcdn.com/2880970/wp-content/uploads/2021/08/api-management-2200-2048x854.png?lossy=1&amp;strip=1&amp;webp=1" alt="">

#### How Are APIs Used By HR Software Providers?

Back in the bad old days before software that's hosted in the Cloud became the norm, APIs were designed to make it possible to connect different legacy software systems, which were often hosted on-premise (within the business location itself). Today, the ways in which APIs are applied is growing exponentially. Organisations with complex digital infrastructures use them to simplify data transfer. HR and ERP software providers use them to integrate seamlessly with other systems like Payroll and Time & Attendance. APIs facilitate data transfers that reduce the manual handling, time, and cost involved in importing and exporting (sharing) data.  

In combination with automated data validation (to check the accuracy and completeness of data that is uploaded to the system), the integrations between HR, Payroll and T&A solutions reduce processing times, decrease error rates, and eliminate the need for data double entry. Essentially, integrations are all about efficiency. They save you time, money, and energy.

#### APIs as HR and Payroll Software Enhancers

Most HR software Platforms provide APIs that you can use to integrate, automate, and orchestrate data sharing without writing code. In the HR and Payroll spaces, APIs make it easier to integrate and connect systems, services and data, create new user experiences, share information, and authenticate users. They enable transactions and algorithms and let you offer new services.

Using APIs, you can turn your HR software Platform into the source of truth in a digital ecosystem. With the right integrations, your HR Platform forms the hub in a spoke and wheel type configuration for real-time data sharing and improved decision-making across your entire organisation. Another benefit of using an HR [HR software Platform](https://www.subscribe-hr.com.au/blog/hr-software-from-product-to-platform) (as opposed to stand-alone HR solutions) with a high number of out-of-the-box integrations and an open API is that you will also be less dependent on any one vendor for managing the processes and tasks your business needs to digitise, automate and optimise. If you don’t like that particular product or service at some point in the future, or a better one becomes available, you can simply switch out one solution in your ecosystem for another via the API.

When you access pre-existing integrations through the vendor API instead of having new ones built (which might require the time and cost of a Developer), you save your business time and money. Here's an [estimate](https://blog.dreamfactory.com/api-calculator-understanding-the-costs-behind-building-an-api-based-application/) of what it costs to build a custom API from scratch:

> “An enterprise API costs an estimated $25,000-$30,000 to build, and then 50% of that amount per year to manage. Multiply that by 10 APIs and you have $275,000-$450,000 per year just so APIs can exist within your organisation. Everyone who wants to access an API must develop, test and implement custom code, at an estimated cost of $15,000 per integration, plus a 50% maintenance fee. Each API must also be secured, costing additional thousands of dollars.” 

No matter how sophisticated your HR solution (or suite of solutions) is, it will never cover all of the services you need or want to offer to your employees. Sometimes it will be necessary to exchange data with another service. Payroll is an excellent example. Or, you might want to make a completely new service available and that vendor only offers it through an API. APIs also happen to make life easier for your employees - if your HR software provider offers single sign-on, that means you can combine access to all the different software products you use via a single logon - meaning you give your people one place to go and help themselves to al the different business systems they need.

Hr Management Examples

Create a job

Deletes a specific job that an employee holds.

Delete an individual job

Returns all payrolls, current and past for a company.

Notes:

- Hour and dollar amounts are returned as string representations of numeric decimals.
- Hours are represented to the thousands place; dollar amounts are represented to the cent.
- Every eligible compensation is returned for each employee. If no data has yet be inserted for a given field, it defaults to “0.00” (for fixed amounts) or “0.000” (for hours ).

Get all payrolls for a company

Update a payroll

You can create, update, review and delete timesheets which are used to track the time a particular employee has worked during a certain period.

#

Create a timesheet

You can update timesheets to make changes to an existing timesheet entry.  
For this, you will need to retrieve the _timesheetId_ for a specific contract.

Update a timesheet entry

You are also able to delete timesheet entries from a timesheet:

Delete a timesheet entry

Sometimes things change when it comes to employee contracts. So whether it is promoting someone to a new role and salary band, increasing their holiday days, or more, you can do this entirely via this API.

  

| Clients can make amendments to | Clients can not make amendments to |
| --- | --- |
| ✅ Job title | ✘ Country of tax residence |
| ✅ Payment details (rate, invoice cycle, payment due date) | ✘ Start date (original start date must remain but an amendment may be added) |
| ✅ Contract currency | ✘ Contract type |
| ✅ Work schedule | ✘ Client entity information |
| ✅ Scope of work |  |
| ✅ End of contract (end date and notice period) |  |
| ✅ Special clauses |  |
| ✅ Employee personal details (full legal name, passport number, etc.) |

Amend a contract

Theneo Demo TechCrunch

Theneo Demo

<p class="slate-p" placeholder="Type / for widgets">Theneo is the quickest, simplest way to generate high-quality, interactive API docs. Just import your API collection and we&apos;ll take care of the rest.</p><p class="slate-p" placeholder="Type / for widgets"><strong class="slate-bold">⚠️ Note:</strong> All of the stated endpoints and sections are for demonstration purposes only. Theneo does not manage payments API. Get sales data, itemize payments, push orders to POS, and more.The Orders API provides a one-stop shop for integrating advanced payment functionality. You can itemize payments with custom line items or catalog objects, send orders to real Point of Sale devices to be fulfilled, and more.In addition, the Orders API allows you to look through all of a seller&apos;s previous sales and returns itemization data, customer references, and other information from POS or online transactions.</p><p class="slate-p" placeholder="Type / for widgets"></p><div style="text-align:center"><img src="https://theneo-prod-public.s3.amazonaws.com/images-1689094962909.png" alt="" id="1689094963406"/></div><h3 class="slate-h3"></h3><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"><a href="https://www.theneo.io/#" target="_blank"></a></p><p class="slate-p" placeholder="Type / for widgets"><a href="https://app.theneo.io/signup" target="_blank"></a></p>

Theneo is the quickest, simplest way to generate high-quality, interactive API docs. Just import your API collection and we'll take care of the rest.

 All of the stated endpoints and sections are for demonstration purposes only. Theneo does not manage payments API. Get sales data, itemize payments, push orders to POS, and more.The Orders API provides a one-stop shop for integrating advanced payment functionality. You can itemize payments with custom line items or catalog objects, send orders to real Point of Sale devices to be fulfilled, and more.In addition, the Orders API allows you to look through all of a seller's previous sales and returns itemization data, customer references, and other information from POS or online transactions.

api_connection_error

API errors cover any other type of problem (e.g., a temporary problem with servers), and are extremely uncommon.

api_error

Failure to properly authenticate yourself in the request.

authentication_error

Card errors are the most common type of error you should expect to handle. They result when the user enters a card that can't be charged for some reason.

card_error

Idempotency errors occur when an Idempotency-Key is re-used on a request that does not match the first request's API endpoint and parameters.

idempotency_error

Invalid request errors arise when your request has invalid parameters.

invalid_request_error

Too many requests hit the API too quickly.

rate_limit_error

Errors triggered by our client-side libraries when failing to validate fields (e.g., when a card number or expiration date is invalid or incomplete).

validation_error

Theneo Demo API Doc

200 - OK

The request was unacceptable, often due to missing a required parameter.

400 - Bad request

401 - Unauthorized

The parameters were valid but the request failed.

402 - Request Failed

The API key doesnt have permissions to perform the request.

403 - Forbidden

404 - Not Found

<p>🚀 Theneo is the quickest, simplest way to generate high-quality, interactive API docs. Just import your API collection and we'll take care of the rest.</p><p></p><div><div></div></div>

🚀 Theneo is the quickest, simplest way to generate high-quality, interactive API docs. Just import your API collection and we'll take care of the rest.

<p class="slate-p" placeholder="Type / for widgets">All of the stated endpoints and sections are for demonstration purposes only. Theneo does not manage payments API.Get sales data, itemize payments, push orders to POS, and more.</p><p class="slate-p" placeholder="Type / for widgets"></p><div  data-type="info" style="background-color:#eef1ff;color:#4a59af"><div ><svg width="20" height="20" viewBox="0 0 20 20" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M10.0628 14.1676C10.2434 14.1676 10.3927 14.1086 10.5107 13.9905C10.6288 13.8725 10.6878 13.7232 10.6878 13.5426V9.77177C10.6878 9.6051 10.6253 9.46274 10.5003 9.34469C10.3753 9.22663 10.2295 9.1676 10.0628 9.1676C9.88227 9.1676 9.73296 9.22663 9.61491 9.34469C9.49685 9.46274 9.43783 9.61205 9.43783 9.7926V13.5634C9.43783 13.7301 9.50033 13.8725 9.62533 13.9905C9.75033 14.1086 9.89616 14.1676 10.0628 14.1676ZM10.0003 7.62594C10.1948 7.62594 10.358 7.56344 10.4899 7.43844C10.6219 7.31344 10.6878 7.15371 10.6878 6.95927C10.6878 6.76482 10.6219 6.59816 10.4899 6.45927C10.358 6.32038 10.1948 6.25094 10.0003 6.25094C9.80588 6.25094 9.64269 6.32038 9.51074 6.45927C9.3788 6.59816 9.31283 6.76482 9.31283 6.95927C9.31283 7.15371 9.3788 7.31344 9.51074 7.43844C9.64269 7.56344 9.80588 7.62594 10.0003 7.62594ZM10.0003 18.3343C8.81977 18.3343 7.72255 18.1225 6.70866 17.6989C5.69477 17.2752 4.81283 16.6884 4.06283 15.9384C3.31283 15.1884 2.72602 14.3065 2.30241 13.2926C1.8788 12.2787 1.66699 11.1815 1.66699 10.0009C1.66699 8.83427 1.8788 7.74399 2.30241 6.7301C2.72602 5.71621 3.31283 4.83427 4.06283 4.08427C4.81283 3.33427 5.69477 2.74399 6.70866 2.31344C7.72255 1.88288 8.81977 1.6676 10.0003 1.6676C11.167 1.6676 12.2573 1.88288 13.2712 2.31344C14.285 2.74399 15.167 3.33427 15.917 4.08427C16.667 4.83427 17.2573 5.71621 17.6878 6.7301C18.1184 7.74399 18.3337 8.83427 18.3337 10.0009C18.3337 11.1815 18.1184 12.2787 17.6878 13.2926C17.2573 14.3065 16.667 15.1884 15.917 15.9384C15.167 16.6884 14.285 17.2752 13.2712 17.6989C12.2573 18.1225 11.167 18.3343 10.0003 18.3343ZM10.0003 17.0843C11.9448 17.0843 13.6114 16.3898 15.0003 15.0009C16.3892 13.612 17.0837 11.9454 17.0837 10.0009C17.0837 8.05649 16.3892 6.38982 15.0003 5.00094C13.6114 3.61205 11.9448 2.9176 10.0003 2.9176C8.05588 2.9176 6.38921 3.61205 5.00033 5.00094C3.61144 6.38982 2.91699 8.05649 2.91699 10.0009C2.91699 11.9454 3.61144 13.612 5.00033 15.0009C6.38921 16.3898 8.05588 17.0843 10.0003 17.0843Z" fill="#3960B4"></path></svg></div><div ><p class="slate-p" placeholder="Type / for widgets"><strong class="slate-bold">Note:</strong> The Orders API provides a one-stop shop for integrating advanced payment functionality. You can itemize payments with custom line items or catalog objects, send orders to real Point of Sale devices to be fulfilled, and more.</p></div></div><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets">In addition, the Orders API allows you to look through all of a seller&apos;s previous sales and returns itemization data, customer references, and other information from POS or online transactions.</p><p class="slate-p" placeholder="Type / for widgets"><div style="text-align:center"><img src="https://media.geeksforgeeks.org/wp-content/cdn-uploads/20200318193845/Top-7-Payment-Gateway-APIs-That-Every-Developer-Must-Know.png" alt=""/></div></p><p class="slate-p" placeholder="Type / for widgets">As an organization, you need to be careful while choosing a payment gateway option. It should be according to the customer’s experience on your websites through to cash flow to online sales. Make sure that you take care of at least 5 things mentioned below while choosing a payment gateway… </p><p class="slate-p" placeholder="Type / for widgets"></p><ul class="slate-ul"><li class="slate-li"><p class="slate-p" placeholder="Type / for widgets"><strong class="slate-bold">Security</strong> should be the topmost priority. Make sure that it should be integrated with the 3D security and comply with the PCI Data Security Standard (PCI DSS).</p></li><li class="slate-li"><p class="slate-p" placeholder="Type / for widgets"><strong class="slate-bold">Payout Time</strong> should be less to credit money in your bank account.</p></li><li class="slate-li"><p class="slate-p" placeholder="Type / for widgets"><strong class="slate-bold">Integration need to be easy and simple</strong> or it can develop a custom-coded solution for your platform easily.</p></li><li class="slate-li"><p class="slate-p" placeholder="Type / for widgets"><strong class="slate-bold">Multiple currencies</strong> should be handled by the payment gateway for the customers using different currencies across the world.</p></li></ul><p class="slate-p" placeholder="Type / for widgets"></p>

All of the stated endpoints and sections are for demonstration purposes only. Theneo does not manage payments API.Get sales data, itemize payments, push orders to POS, and more.

In addition, the Orders API allows you to look through all of a seller's previous sales and returns itemization data, customer references, and other information from POS or online transactions.

As an organization, you need to be careful while choosing a payment gateway option. It should be according to the customer’s experience on your websites through to cash flow to online sales. Make sure that you take care of at least 5 things mentioned below while choosing a payment gateway… 

idempotency_key

order

Authorization

Content-Type

fields_to_clear

order_id

location_id

plan_id

customer_id

card_id

start_date

tax_percentage

price_override_money

timezone

source

subscription

query

subscriptions

subscription_id

<p>Leverage all these API to build your own in-app payroll solution, customized for your users' needs</p><p></p><p></p><div></div><p></p><h4>How Are APIs Used By HR S</h4>

Leverage all these API to build your own in-app payroll solution, customized for your users' needs

How Are APIs Used By HR Software Providers?

Back in the bad old days before software that's hosted in the Cloud became the norm, APIs were designed to make it possible to connect different legacy software systems, which were often hosted on-premise (within the business location itself). Today, the ways in which APIs are applied is growing exponentially. Organisations with complex digital infrastructures use them to simplify data transfer. HR and ERP software providers use them to integrate seamlessly with other systems like Payroll and Time & Attendance. APIs facilitate data transfers that reduce the manual handling, time, and cost involved in importing and exporting (sharing) data.  

In combination with automated data validation (to check the accuracy and completeness of data that is uploaded to the system), the integrations between HR, Payroll and T&A solutions reduce processing times, decrease error rates, and eliminate the need for data double entry. Essentially, integrations are all about efficiency. They save you time, money, and energy.

APIs as HR and Payroll Software Enhancers

Most HR software Platforms provide APIs that you can use to integrate, automate, and orchestrate data sharing without writing code. In the HR and Payroll spaces, APIs make it easier to integrate and connect systems, services and data, create new user experiences, share information, and authenticate users. They enable transactions and algorithms and let you offer new services.

Using APIs, you can turn your HR software Platform into the source of truth in a digital ecosystem. With the right integrations, your HR Platform forms the hub in a spoke and wheel type configuration for real-time data sharing and improved decision-making across your entire organisation. Another benefit of using an HR 

 (as opposed to stand-alone HR solutions) with a high number of out-of-the-box integrations and an open API is that you will also be less dependent on any one vendor for managing the processes and tasks your business needs to digitise, automate and optimise. If you don’t like that particular product or service at some point in the future, or a better one becomes available, you can simply switch out one solution in your ecosystem for another via the API.

When you access pre-existing integrations through the vendor API instead of having new ones built (which might require the time and cost of a Developer), you save your business time and money. Here's an 

 of what it costs to build a custom API from scratch:

No matter how sophisticated your HR solution (or suite of solutions) is, it will never cover all of the services you need or want to offer to your employees. Sometimes it will be necessary to exchange data with another service. Payroll is an excellent example. Or, you might want to make a completely new service available and that vendor only offers it through an API. APIs also happen to make life easier for your employees - if your HR software provider offers single sign-on, that means you can combine access to all the different software products you use via a single logon - meaning you give your people one place to go and help themselves to al the different business systems they need.