# openapi-client
The affixapi.com API documentation.
# Introduction
Affix API is an OAuth 2.1 application that allows developers to access
customer data, without developers needing to manage or maintain
integrations; or collect login credentials or API keys from users for these
third party systems.
# OAuth 2.1
Affix API follows the [OAuth 2.1 spec](https://datatracker.ietf.org/doc/html/draft-ietf-oauth-v2-1-08).
As an OAuth application, Affix API handles not only both the collection of
sensitive user credentials or API keys, but also builds and maintains the
integrations with the providers, so you don't have to.
# How to obtain an access token
in order to get started, you must:
- register a `client_id`
- direct your user to the sign in flow (`https://connect.affixapi.com`
[with the appropriate query
parameters](https://github.com/affixapi/starter-kit/tree/master/connect))
- capture `authorization_code` we will send to your redirect URI after
the sign in flow is complete and exchange that `authorization_code` for
a Bearer token
# Sandbox keys (xhr mode)
### dev
```
eyJhbGciOiJFUzI1NiIsImtpZCI6Ims5RmxwSFR1YklmZWNsUU5QRVZzeFcxazFZZ0Zfbk1BWllOSGVuOFQxdGciLCJ0eXAiOiJKV1MifQ.eyJwcm92aWRlciI6InNhbmRib3giLCJzY29wZXMiOlsiLzIwMjMtMDMtMDEveGhyL2NvbXBhbnkiLCIvMjAyMy0wMy0wMS94aHIvZW1wbG95ZWUiLCIvMjAyMy0wMy0wMS94aHIvZW1wbG95ZWVzIiwiLzIwMjMtMDMtMDEveGhyL2dyb3VwcyIsIi8yMDIzLTAzLTAxL3hoci9pZGVudGl0eSIsIi8yMDIzLTAzLTAxL3hoci9wYXlydW5zIiwiLzIwMjMtMDMtMDEveGhyL3BheXJ1bnMvOnBheXJ1bl9pZCIsIi8yMDIzLTAzLTAxL3hoci90aW1lLW9mZi1iYWxhbmNlcyIsIi8yMDIzLTAzLTAxL3hoci90aW1lLW9mZi1lbnRyaWVzIiwiLzIwMjMtMDMtMDEveGhyL3RpbWVzaGVldHMiLCIvMjAyMy0wMy0wMS94aHIvd29yay1sb2NhdGlvbnMiXSwidG9rZW4iOiIzODIzNTNlMi05N2ZiLTRmMWEtOTYxYy0zZDI5OTViNzYxMTUiLCJpYXQiOjE3MTE4MTA3MTQsImlzcyI6InB1YmxpY2FwaS1pbnRlcm1lZGlhdGUuZGV2LmVuZ2luZWVyaW5nLmFmZml4YXBpLmNvbSIsInN1YiI6InhociIsImF1ZCI6IjNGREFFREY5LTFEQ0E0RjU0LTg3OTQ5RjZBLTQxMDI3NjQzIn0.zUJPaT6IxcIdr8b9iO6u-Rr5I-ohTHPYTrQGrgOFghbEbovItiwr9Wk479GnJVJc3WR8bxAwUMAE4Ul6Okdk6Q
```
#### `employees` endpoint sample:
```
curl --fail \\
-X GET \\
-H 'Authorization: Bearer eyJhbGciOiJFUzI1NiIsImtpZCI6Ims5RmxwSFR1YklmZWNsUU5QRVZzeFcxazFZZ0Zfbk1BWllOSGVuOFQxdGciLCJ0eXAiOiJKV1MifQ.eyJwcm92aWRlciI6InNhbmRib3giLCJzY29wZXMiOlsiLzIwMjMtMDMtMDEveGhyL2NvbXBhbnkiLCIvMjAyMy0wMy0wMS94aHIvZW1wbG95ZWUiLCIvMjAyMy0wMy0wMS94aHIvZW1wbG95ZWVzIiwiLzIwMjMtMDMtMDEveGhyL2dyb3VwcyIsIi8yMDIzLTAzLTAxL3hoci9pZGVudGl0eSIsIi8yMDIzLTAzLTAxL3hoci9wYXlydW5zIiwiLzIwMjMtMDMtMDEveGhyL3BheXJ1bnMvOnBheXJ1bl9pZCIsIi8yMDIzLTAzLTAxL3hoci90aW1lLW9mZi1iYWxhbmNlcyIsIi8yMDIzLTAzLTAxL3hoci90aW1lLW9mZi1lbnRyaWVzIiwiLzIwMjMtMDMtMDEveGhyL3RpbWVzaGVldHMiLCIvMjAyMy0wMy0wMS94aHIvd29yay1sb2NhdGlvbnMiXSwidG9rZW4iOiIzODIzNTNlMi05N2ZiLTRmMWEtOTYxYy0zZDI5OTViNzYxMTUiLCJpYXQiOjE3MTE4MTA3MTQsImlzcyI6InB1YmxpY2FwaS1pbnRlcm1lZGlhdGUuZGV2LmVuZ2luZWVyaW5nLmFmZml4YXBpLmNvbSIsInN1YiI6InhociIsImF1ZCI6IjNGREFFREY5LTFEQ0E0RjU0LTg3OTQ5RjZBLTQxMDI3NjQzIn0.zUJPaT6IxcIdr8b9iO6u-Rr5I-ohTHPYTrQGrgOFghbEbovItiwr9Wk479GnJVJc3WR8bxAwUMAE4Ul6Okdk6Q' \\
'https://dev.api.affixapi.com/2023-03-01/xhr/employees'
```
### prod
```
eyJhbGciOiJFUzI1NiIsImtpZCI6Ims5RmxwSFR1YklmZWNsUU5QRVZzeFcxazFZZ0Zfbk1BWllOSGVuOFQxdGciLCJ0eXAiOiJKV1MifQ.eyJwcm92aWRlciI6InNhbmRib3giLCJzY29wZXMiOlsiLzIwMjMtMDMtMDEveGhyL2NvbXBhbnkiLCIvMjAyMy0wMy0wMS94aHIvZW1wbG95ZWUiLCIvMjAyMy0wMy0wMS94aHIvZW1wbG95ZWVzIiwiLzIwMjMtMDMtMDEveGhyL2dyb3VwcyIsIi8yMDIzLTAzLTAxL3hoci9pZGVudGl0eSIsIi8yMDIzLTAzLTAxL3hoci9wYXlydW5zIiwiLzIwMjMtMDMtMDEveGhyL3BheXJ1bnMvOnBheXJ1bl9pZCIsIi8yMDIzLTAzLTAxL3hoci90aW1lLW9mZi1iYWxhbmNlcyIsIi8yMDIzLTAzLTAxL3hoci90aW1lLW9mZi1lbnRyaWVzIiwiLzIwMjMtMDMtMDEveGhyL3RpbWVzaGVldHMiLCIvMjAyMy0wMy0wMS94aHIvd29yay1sb2NhdGlvbnMiXSwidG9rZW4iOiIzYjg4MDc2NC1kMGFmLTQ5ZDAtOGM5OS00YzIwYjE2MTJjOTMiLCJpYXQiOjE3MTE4MTA4NTgsImlzcyI6InB1YmxpY2FwaS1pbnRlcm1lZGlhdGUucHJvZC5lbmdpbmVlcmluZy5hZmZpeGFwaS5jb20iLCJzdWIiOiJ4aHIiLCJhdWQiOiIwOEJCMDgxRS1EOUFCNEQxNC04REY5OTIzMy02NjYxNUNFOSJ9.n3pJmmfegU21Tko_TyUyCHi4ITvfd75T8NFFTHmf1r8AI8yCUYTWdfNjyZZWcZD6z50I3Wsk2rAd8GDWXn4vlg
```
#### `employees` endpoint sample:
```
curl --fail \\
-X GET \\
-H 'Authorization: Bearer eyJhbGciOiJFUzI1NiIsImtpZCI6Ims5RmxwSFR1YklmZWNsUU5QRVZzeFcxazFZZ0Zfbk1BWllOSGVuOFQxdGciLCJ0eXAiOiJKV1MifQ.eyJwcm92aWRlciI6InNhbmRib3giLCJzY29wZXMiOlsiLzIwMjMtMDMtMDEveGhyL2NvbXBhbnkiLCIvMjAyMy0wMy0wMS94aHIvZW1wbG95ZWUiLCIvMjAyMy0wMy0wMS94aHIvZW1wbG95ZWVzIiwiLzIwMjMtMDMtMDEveGhyL2dyb3VwcyIsIi8yMDIzLTAzLTAxL3hoci9pZGVudGl0eSIsIi8yMDIzLTAzLTAxL3hoci9wYXlydW5zIiwiLzIwMjMtMDMtMDEveGhyL3BheXJ1bnMvOnBheXJ1bl9pZCIsIi8yMDIzLTAzLTAxL3hoci90aW1lLW9mZi1iYWxhbmNlcyIsIi8yMDIzLTAzLTAxL3hoci90aW1lLW9mZi1lbnRyaWVzIiwiLzIwMjMtMDMtMDEveGhyL3RpbWVzaGVldHMiLCIvMjAyMy0wMy0wMS94aHIvd29yay1sb2NhdGlvbnMiXSwidG9rZW4iOiIzYjg4MDc2NC1kMGFmLTQ5ZDAtOGM5OS00YzIwYjE2MTJjOTMiLCJpYXQiOjE3MTE4MTA4NTgsImlzcyI6InB1YmxpY2FwaS1pbnRlcm1lZGlhdGUucHJvZC5lbmdpbmVlcmluZy5hZmZpeGFwaS5jb20iLCJzdWIiOiJ4aHIiLCJhdWQiOiIwOEJCMDgxRS1EOUFCNEQxNC04REY5OTIzMy02NjYxNUNFOSJ9.n3pJmmfegU21Tko_TyUyCHi4ITvfd75T8NFFTHmf1r8AI8yCUYTWdfNjyZZWcZD6z50I3Wsk2rAd8GDWXn4vlg' \\
'https://api.affixapi.com/2023-03-01/xhr/employees'
```
# Compression
We support `brotli`, `gzip`, and `deflate` compression algorithms.
To enable, pass the `Accept-Encoding` header with one or all of the values:
`br`, `gzip`, `deflate`, or `identity` (no compression)
In the response, you will receive the `Content-Encoding` response header
indicating the compression algorithm used in the data payload to enable you
to decompress the result. If the `Accept-Encoding: identity` header was
passed, no `Content-Encoding` response header is sent back, as no
compression algorithm was used.
# Webhooks
An exciting feature for HR/Payroll modes are webhooks.
If enabled, your `webhook_uri` is set on your `client_id` for the
respective environment: `dev | prod`
Webhooks are configured to make live requests to the underlying integration
1x/hr, and if a difference is detected since the last request, we will send a
request to your `webhook_uri` with this shape:
```
{
added: <api.v20230301.Employees>[
<api.v20230301.Employee>{
...,
date_of_birth: '2010-08-06',
display_full_name: 'Daija Rogahn',
employee_number: '57993',
employment_status: 'pending',
employment_type: 'other',
employments: [
{
currency: 'eur',
effective_date: '2022-02-25',
employment_type: 'other',
job_title: 'Dynamic Implementation Manager',
pay_frequency: 'semimonthly',
pay_period: 'YEAR',
pay_rate: 96000,
},
],
first_name: 'Daija',
...
}
],
removed: [],
updated: [
<api.v20230301.Employee>{
...,
date_of_birth: '2009-11-09',
display_full_name: 'Lourdes Stiedemann',
employee_number: '63189',
employment_status: 'leave',
employment_type: 'full_time',
employments: [
{
currency: 'gbp',
effective_date: '2023-01-16',
employment_type: 'full_time',
job_title: 'Forward Brand Planner',
pay_frequency: 'semimonthly',
pay_period: 'YEAR',
pay_rate: 86000,
},
],
first_name: 'Lourdes',
}
]
}
```
the following headers will be sent with webhook requests:
```
x-affix-api-signature: ab8474e609db95d5df3adc39ea3add7a7544bd215c5c520a30a650ae93a2fba7
x-affix-api-origin: webhooks-employees-webhook
user-agent: affixapi.com
```
Before trusting the payload, you should sign the payload and verify the
signature matches the signature sent by the `affixapi.com` service.
This secures that the data sent to your `webhook_uri` is from the
`affixapi.com` server.
The signature is created by combining the signing secret (your
`client_secret`) with the body of the request sent using a standard
HMAC-SHA256 keyed hash.
The signature can be created via:
- create an `HMAC` with your `client_secret`
- update the `HMAC` with the payload
- get the hex digest -> this is the signature
Sample `typescript` code that follows this recipe:
```
import { createHmac } from 'crypto';
export const computeSignature = ({
str,
signingSecret,
}: {
signingSecret: string;
str: string;
}): string => {
const hmac = createHmac('sha256', signingSecret);
hmac.update(str);
const signature = hmac.digest('hex');
return signature;
};
```
While verifying the Affix API signature header should be your primary
method of confirming validity, you can also whitelist our outbound webhook
static IP addresses.
```
dev:
- 52.210.169.82
- 52.210.38.77
- 3.248.135.204
prod:
- 52.51.160.102
- 54.220.83.244
- 3.254.213.171
```
## Rate limits
Open endpoints (not gated by an API key) (applied at endpoint level):
- 15 requests every 1 minute (by IP address)
- 25 requests every 5 minutes (by IP address)
Gated endpoints (require an API key) (applied at endpoint level):
- 40 requests every 1 minute (by IP address)
- 40 requests every 5 minutes (by `client_id`)
Things to keep in mind:
- Open endpoints (not gated by an API key) will likely be called by your
users, not you, so rate limits generally would not apply to you.
- As a developer, rate limits are applied at the endpoint granularity.
- For example, say the rate limits below are 10 requests per minute by ip.
from that same ip, within 1 minute, you get:
- 10 requests per minute on `/orders`,
- another 10 requests per minute on `/items`,
- and another 10 requests per minute on `/identity`,
- for a total of 30 requests per minute.
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: 2023-03-01
- Package version: 1.0.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
## Requirements.
Python >= 3.6
## Installation & Usage
### pip install
If the python package is hosted on a repository, you can install directly using:
```sh
pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
```
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)
Then import the package:
```python
import openapi_client
```
### Setuptools
Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)
Then import the package:
```python
import openapi_client
```
## Getting Started
Please follow the [installation procedure](#installation--usage) and then run the following:
```python
import time
import openapi_client
from pprint import pprint
from openapi_client.api import 2023_03_01_api
from openapi_client.model.companies20230301_response import Companies20230301Response
from openapi_client.model.employees20230301_response import Employees20230301Response
from openapi_client.model.employment_status_not_null_not_nullable import EmploymentStatusNotNullNotNullable
from openapi_client.model.groups20230301_response import Groups20230301Response
from openapi_client.model.identity_response import IdentityResponse
from openapi_client.model.inline_response401 import InlineResponse401
from openapi_client.model.message_response import MessageResponse
from openapi_client.model.payruns20230301_response import Payruns20230301Response
from openapi_client.model.payslips20230301_response import Payslips20230301Response
from openapi_client.model.time_off_balances20230301_response import TimeOffBalances20230301Response
from openapi_client.model.time_off_entries20230301_response import TimeOffEntries20230301Response
from openapi_client.model.timesheets20230301_response import Timesheets20230301Response
from openapi_client.model.work_locations20230301_response import WorkLocations20230301Response
# Defining the host is optional and defaults to https://api.affixapi.com
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
host = "https://api.affixapi.com"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: access-token
configuration.api_key['access-token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['access-token'] = 'Bearer'
# Enter a context with an instance of the API client
with openapi_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = 2023_03_01_api.20230301Api(api_client)
try:
# Company
api_response = api_instance.xhr_companies20230301()
pprint(api_response)
except openapi_client.ApiException as e:
print("Exception when calling 20230301Api->xhr_companies20230301: %s\n" % e)
```
## Documentation for API Endpoints
All URIs are relative to *https://api.affixapi.com*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*20230301Api* | [**xhr_companies20230301**](docs/20230301Api.md#xhr_companies20230301) | **GET** /2023-03-01/xhr/company | Company
*20230301Api* | [**xhr_employees20230301**](docs/20230301Api.md#xhr_employees20230301) | **GET** /2023-03-01/xhr/employees | Employees
*20230301Api* | [**xhr_groups20230301**](docs/20230301Api.md#xhr_groups20230301) | **GET** /2023-03-01/xhr/groups | Groups
*20230301Api* | [**xhr_identity20230301**](docs/20230301Api.md#xhr_identity20230301) | **GET** /2023-03-01/xhr/identity | Identity
*20230301Api* | [**xhr_payruns20230301**](docs/20230301Api.md#xhr_payruns20230301) | **GET** /2023-03-01/xhr/payruns | Payruns
*20230301Api* | [**xhr_payslips20230301**](docs/20230301Api.md#xhr_payslips20230301) | **GET** /2023-03-01/xhr/payruns/{payrun_id} | Payslips
*20230301Api* | [**xhr_time_off_balances20230301**](docs/20230301Api.md#xhr_time_off_balances20230301) | **GET** /2023-03-01/xhr/time-off-balances | Time off balances
*20230301Api* | [**xhr_time_off_entries20230301**](docs/20230301Api.md#xhr_time_off_entries20230301) | **GET** /2023-03-01/xhr/time-off-entries | Time off entries
*20230301Api* | [**xhr_timesheets20230301**](docs/20230301Api.md#xhr_timesheets20230301) | **GET** /2023-03-01/xhr/timesheets | Timesheets
*20230301Api* | [**xhr_work_locations20230301**](docs/20230301Api.md#xhr_work_locations20230301) | **GET** /2023-03-01/xhr/work-locations | Work locations
*CoreApi* | [**providers**](docs/CoreApi.md#providers) | **GET** /providers | Providers
*ManagementApi* | [**client**](docs/ManagementApi.md#client) | **GET** /2023-03-01/management/client | Client
*ManagementApi* | [**disconnect**](docs/ManagementApi.md#disconnect) | **POST** /2023-03-01/management/disconnect | Disconnect token
*ManagementApi* | [**introspect**](docs/ManagementApi.md#introspect) | **GET** /2023-03-01/management/introspect | Inspect token
*ManagementApi* | [**token**](docs/ManagementApi.md#token) | **POST** /2023-03-01/management/token | Create token
*ManagementApi* | [**tokens**](docs/ManagementApi.md#tokens) | **GET** /2023-03-01/management/tokens | Tokens
*ManagementApi* | [**update_client**](docs/ManagementApi.md#update_client) | **POST** /2023-03-01/management/client | Update client
*XHRVerticallyIntegratedApi* | [**xhr_companies20230301**](docs/XHRVerticallyIntegratedApi.md#xhr_companies20230301) | **GET** /2023-03-01/xhr/company | Company
*XHRVerticallyIntegratedApi* | [**xhr_employees20230301**](docs/XHRVerticallyIntegratedApi.md#xhr_employees20230301) | **GET** /2023-03-01/xhr/employees | Employees
*XHRVerticallyIntegratedApi* | [**xhr_groups20230301**](docs/XHRVerticallyIntegratedApi.md#xhr_groups20230301) | **GET** /2023-03-01/xhr/groups | Groups
*XHRVerticallyIntegratedApi* | [**xhr_identity20230301**](docs/XHRVerticallyIntegratedApi.md#xhr_identity20230301) | **GET** /2023-03-01/xhr/identity | Identity
*XHRVerticallyIntegratedApi* | [**xhr_payruns20230301**](docs/XHRVerticallyIntegratedApi.md#xhr_payruns20230301) | **GET** /2023-03-01/xhr/payruns | Payruns
*XHRVerticallyIntegratedApi* | [**xhr_payslips20230301**](docs/XHRVerticallyIntegratedApi.md#xhr_payslips20230301) | **GET** /2023-03-01/xhr/payruns/{payrun_id} | Payslips
*XHRVerticallyIntegratedApi* | [**xhr_time_off_balances20230301**](docs/XHRVerticallyIntegratedApi.md#xhr_time_off_balances20230301) | **GET** /2023-03-01/xhr/time-off-balances | Time off balances
*XHRVerticallyIntegratedApi* | [**xhr_time_off_entries20230301**](docs/XHRVerticallyIntegratedApi.md#xhr_time_off_entries20230301) | **GET** /2023-03-01/xhr/time-off-entries | Time off entries
*XHRVerticallyIntegratedApi* | [**xhr_timesheets20230301**](docs/XHRVerticallyIntegratedApi.md#xhr_timesheets20230301) | **GET** /2023-03-01/xhr/timesheets | Timesheets
*XHRVerticallyIntegratedApi* | [**xhr_work_locations20230301**](docs/XHRVerticallyIntegratedApi.md#xhr_work_locations20230301) | **GET** /2023-03-01/xhr/work-locations | Work locations
## Documentation For Models
- [AddressNoNonNullRequest](docs/AddressNoNonNullRequest.md)
- [AddressResponse](docs/AddressResponse.md)
- [ClientRequest](docs/ClientRequest.md)
- [ClientResponse](docs/ClientResponse.md)
- [Companies20230301Response](docs/Companies20230301Response.md)
- [CompanyResponse](docs/CompanyResponse.md)
- [CompensationHistoryNoNonNullRequest](docs/CompensationHistoryNoNonNullRequest.md)
- [CompensationHistoryResponse](docs/CompensationHistoryResponse.md)
- [CreateEmployeeRequest](docs/CreateEmployeeRequest.md)
- [CreateEmployeeRequestBankAccount](docs/CreateEmployeeRequestBankAccount.md)
- [CreateEmployeeRequestDependents](docs/CreateEmployeeRequestDependents.md)
- [CreateEmployeeRequestEmergencyContacts](docs/CreateEmployeeRequestEmergencyContacts.md)
- [CreateEmployeeRequestManager](docs/CreateEmployeeRequestManager.md)
- [CurrencyNotNullRequest](docs/CurrencyNotNullRequest.md)
- [CurrencyNotNullResponse](docs/CurrencyNotNullResponse.md)
- [CurrencyResponse](docs/CurrencyResponse.md)
- [DisconnectResponse](docs/DisconnectResponse.md)
- [EmployeeResponse](docs/EmployeeResponse.md)
- [EmployeeResponseManager](docs/EmployeeResponseManager.md)
- [Employees20230301Response](docs/Employees20230301Response.md)
- [EmploymentHistoryNoNonNullRequest](docs/EmploymentHistoryNoNonNullRequest.md)
- [EmploymentHistoryResponse](docs/EmploymentHistoryResponse.md)
- [EmploymentStatusNotNullNotNullable](docs/EmploymentStatusNotNullNotNullable.md)
- [EmploymentStatusNotNullRequest](docs/EmploymentStatusNotNullRequest.md)
- [EmploymentStatusResponse](docs/EmploymentStatusResponse.md)
- [GroupNoNullEnumRequest](docs/GroupNoNullEnumRequest.md)
- [GroupResponse](docs/GroupResponse.md)
- [Groups20230301Response](docs/Groups20230301Response.md)
- [GroupsNoNullEnumRequest](docs/GroupsNoNullEnumRequest.md)
- [IdAndMessageResponse](docs/IdAndMessageResponse.md)
- [IdentityResponse](docs/IdentityResponse.md)
- [InlineResponse400](docs/InlineResponse400.md)
- [InlineResponse401](docs/InlineResponse401.md)
- [InlineResponse409](docs/InlineResponse409.md)
- [IntrospectResponse](docs/IntrospectResponse.md)
- [LocationNoNonNullRequest](docs/LocationNoNonNullRequest.md)
- [LocationResponse](docs/LocationResponse.md)
- [MessageResponse](docs/MessageResponse.md)
- [ModeRequest](docs/ModeRequest.md)
- [ModeResponse](docs/ModeResponse.md)
- [PayrunResponse](docs/PayrunResponse.md)
- [PayrunTypeResponse](docs/PayrunTypeResponse.md)
- [Payruns20230301Response](docs/Payruns20230301Response.md)
- [PayslipResponse](docs/PayslipResponse.md)
- [PayslipResponseContributions](docs/PayslipResponseContributions.md)
- [PayslipResponseDeductions](docs/PayslipResponseDeductions.md)
- [PayslipResponseEarnings](docs/PayslipResponseEarnings.md)
- [PayslipResponseReimbursements](docs/PayslipResponseReimbursements.md)
- [PayslipResponseTaxes](docs/PayslipResponseTaxes.md)
- [Payslips20230301Response](docs/Payslips20230301Response.md)
- [PolicyTypeResponse](docs/PolicyTypeResponse.md)
- [ProviderRequest](docs/ProviderRequest.md)
- [ProviderResponse](docs/ProviderResponse.md)
- [ProvidersResponse](docs/ProvidersResponse.md)
- [ScopesRequest](docs/ScopesRequest.md)
- [ScopesResponse](docs/ScopesResponse.md)
- [TimeOffBalanceResponse](docs/TimeOffBalanceResponse.md)
- [TimeOffBalances20230301Response](docs/TimeOffBalances20230301Response.md)
- [TimeOffEntries20230301Response](docs/TimeOffEntries20230301Response.md)
- [TimeOffEntryResponse](docs/TimeOffEntryResponse.md)
- [TimesheetResponse](docs/TimesheetResponse.md)
- [Timesheets20230301Response](docs/Timesheets20230301Response.md)
- [TokenRequest](docs/TokenRequest.md)
- [TokenResponse](docs/TokenResponse.md)
- [TokensResponse](docs/TokensResponse.md)
- [WorkLocations20230301Response](docs/WorkLocations20230301Response.md)
## Documentation For Authorization
## access-token
- **Type**: API key
- **API key parameter name**: Authorization
- **Location**: HTTP header
## basic
- **Type**: API key
- **API key parameter name**: Authorization
- **Location**: HTTP header
## Author
developers@affixapi.com
## Notes for Large OpenAPI documents
If the OpenAPI document is large, imports in openapi_client.apis and openapi_client.models may fail with a
RecursionError indicating the maximum recursion limit has been exceeded. In that case, there are a couple of solutions:
Solution 1:
Use specific imports for apis and models like:
- `from openapi_client.api.default_api import DefaultApi`
- `from openapi_client.model.pet import Pet`
Solution 2:
Before importing the package, adjust the maximum recursion limit as shown below:
```
import sys
sys.setrecursionlimit(1500)
import openapi_client
from openapi_client.apis import *
from openapi_client.models import *
```
Raw data
{
"_id": null,
"home_page": null,
"name": "affixapi",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": "OpenAPI, OpenAPI-Generator, Affix API",
"author": "OpenAPI Generator community",
"author_email": "developers@affixapi.com",
"download_url": "https://files.pythonhosted.org/packages/40/7e/aae2a231447a7ee3c8dc2a34a3af27d81459771915fd854a8a55fd8256c6/affixapi-1.1.100.tar.gz",
"platform": null,
"description": "# openapi-client\nThe affixapi.com API documentation.\n\n# Introduction\nAffix API is an OAuth 2.1 application that allows developers to access\ncustomer data, without developers needing to manage or maintain\nintegrations; or collect login credentials or API keys from users for these\nthird party systems.\n\n# OAuth 2.1\nAffix API follows the [OAuth 2.1 spec](https://datatracker.ietf.org/doc/html/draft-ietf-oauth-v2-1-08).\n\nAs an OAuth application, Affix API handles not only both the collection of\nsensitive user credentials or API keys, but also builds and maintains the\nintegrations with the providers, so you don't have to.\n\n# How to obtain an access token\nin order to get started, you must:\n - register a `client_id`\n - direct your user to the sign in flow (`https://connect.affixapi.com`\n [with the appropriate query\n parameters](https://github.com/affixapi/starter-kit/tree/master/connect))\n - capture `authorization_code` we will send to your redirect URI after\n the sign in flow is complete and exchange that `authorization_code` for\n a Bearer token\n\n# Sandbox keys (xhr mode)\n### dev\n```\neyJhbGciOiJFUzI1NiIsImtpZCI6Ims5RmxwSFR1YklmZWNsUU5QRVZzeFcxazFZZ0Zfbk1BWllOSGVuOFQxdGciLCJ0eXAiOiJKV1MifQ.eyJwcm92aWRlciI6InNhbmRib3giLCJzY29wZXMiOlsiLzIwMjMtMDMtMDEveGhyL2NvbXBhbnkiLCIvMjAyMy0wMy0wMS94aHIvZW1wbG95ZWUiLCIvMjAyMy0wMy0wMS94aHIvZW1wbG95ZWVzIiwiLzIwMjMtMDMtMDEveGhyL2dyb3VwcyIsIi8yMDIzLTAzLTAxL3hoci9pZGVudGl0eSIsIi8yMDIzLTAzLTAxL3hoci9wYXlydW5zIiwiLzIwMjMtMDMtMDEveGhyL3BheXJ1bnMvOnBheXJ1bl9pZCIsIi8yMDIzLTAzLTAxL3hoci90aW1lLW9mZi1iYWxhbmNlcyIsIi8yMDIzLTAzLTAxL3hoci90aW1lLW9mZi1lbnRyaWVzIiwiLzIwMjMtMDMtMDEveGhyL3RpbWVzaGVldHMiLCIvMjAyMy0wMy0wMS94aHIvd29yay1sb2NhdGlvbnMiXSwidG9rZW4iOiIzODIzNTNlMi05N2ZiLTRmMWEtOTYxYy0zZDI5OTViNzYxMTUiLCJpYXQiOjE3MTE4MTA3MTQsImlzcyI6InB1YmxpY2FwaS1pbnRlcm1lZGlhdGUuZGV2LmVuZ2luZWVyaW5nLmFmZml4YXBpLmNvbSIsInN1YiI6InhociIsImF1ZCI6IjNGREFFREY5LTFEQ0E0RjU0LTg3OTQ5RjZBLTQxMDI3NjQzIn0.zUJPaT6IxcIdr8b9iO6u-Rr5I-ohTHPYTrQGrgOFghbEbovItiwr9Wk479GnJVJc3WR8bxAwUMAE4Ul6Okdk6Q\n```\n\n#### `employees` endpoint sample:\n```\ncurl --fail \\\\\n -X GET \\\\\n -H 'Authorization: Bearer eyJhbGciOiJFUzI1NiIsImtpZCI6Ims5RmxwSFR1YklmZWNsUU5QRVZzeFcxazFZZ0Zfbk1BWllOSGVuOFQxdGciLCJ0eXAiOiJKV1MifQ.eyJwcm92aWRlciI6InNhbmRib3giLCJzY29wZXMiOlsiLzIwMjMtMDMtMDEveGhyL2NvbXBhbnkiLCIvMjAyMy0wMy0wMS94aHIvZW1wbG95ZWUiLCIvMjAyMy0wMy0wMS94aHIvZW1wbG95ZWVzIiwiLzIwMjMtMDMtMDEveGhyL2dyb3VwcyIsIi8yMDIzLTAzLTAxL3hoci9pZGVudGl0eSIsIi8yMDIzLTAzLTAxL3hoci9wYXlydW5zIiwiLzIwMjMtMDMtMDEveGhyL3BheXJ1bnMvOnBheXJ1bl9pZCIsIi8yMDIzLTAzLTAxL3hoci90aW1lLW9mZi1iYWxhbmNlcyIsIi8yMDIzLTAzLTAxL3hoci90aW1lLW9mZi1lbnRyaWVzIiwiLzIwMjMtMDMtMDEveGhyL3RpbWVzaGVldHMiLCIvMjAyMy0wMy0wMS94aHIvd29yay1sb2NhdGlvbnMiXSwidG9rZW4iOiIzODIzNTNlMi05N2ZiLTRmMWEtOTYxYy0zZDI5OTViNzYxMTUiLCJpYXQiOjE3MTE4MTA3MTQsImlzcyI6InB1YmxpY2FwaS1pbnRlcm1lZGlhdGUuZGV2LmVuZ2luZWVyaW5nLmFmZml4YXBpLmNvbSIsInN1YiI6InhociIsImF1ZCI6IjNGREFFREY5LTFEQ0E0RjU0LTg3OTQ5RjZBLTQxMDI3NjQzIn0.zUJPaT6IxcIdr8b9iO6u-Rr5I-ohTHPYTrQGrgOFghbEbovItiwr9Wk479GnJVJc3WR8bxAwUMAE4Ul6Okdk6Q' \\\\\n 'https://dev.api.affixapi.com/2023-03-01/xhr/employees'\n```\n\n### prod\n```\neyJhbGciOiJFUzI1NiIsImtpZCI6Ims5RmxwSFR1YklmZWNsUU5QRVZzeFcxazFZZ0Zfbk1BWllOSGVuOFQxdGciLCJ0eXAiOiJKV1MifQ.eyJwcm92aWRlciI6InNhbmRib3giLCJzY29wZXMiOlsiLzIwMjMtMDMtMDEveGhyL2NvbXBhbnkiLCIvMjAyMy0wMy0wMS94aHIvZW1wbG95ZWUiLCIvMjAyMy0wMy0wMS94aHIvZW1wbG95ZWVzIiwiLzIwMjMtMDMtMDEveGhyL2dyb3VwcyIsIi8yMDIzLTAzLTAxL3hoci9pZGVudGl0eSIsIi8yMDIzLTAzLTAxL3hoci9wYXlydW5zIiwiLzIwMjMtMDMtMDEveGhyL3BheXJ1bnMvOnBheXJ1bl9pZCIsIi8yMDIzLTAzLTAxL3hoci90aW1lLW9mZi1iYWxhbmNlcyIsIi8yMDIzLTAzLTAxL3hoci90aW1lLW9mZi1lbnRyaWVzIiwiLzIwMjMtMDMtMDEveGhyL3RpbWVzaGVldHMiLCIvMjAyMy0wMy0wMS94aHIvd29yay1sb2NhdGlvbnMiXSwidG9rZW4iOiIzYjg4MDc2NC1kMGFmLTQ5ZDAtOGM5OS00YzIwYjE2MTJjOTMiLCJpYXQiOjE3MTE4MTA4NTgsImlzcyI6InB1YmxpY2FwaS1pbnRlcm1lZGlhdGUucHJvZC5lbmdpbmVlcmluZy5hZmZpeGFwaS5jb20iLCJzdWIiOiJ4aHIiLCJhdWQiOiIwOEJCMDgxRS1EOUFCNEQxNC04REY5OTIzMy02NjYxNUNFOSJ9.n3pJmmfegU21Tko_TyUyCHi4ITvfd75T8NFFTHmf1r8AI8yCUYTWdfNjyZZWcZD6z50I3Wsk2rAd8GDWXn4vlg\n```\n\n#### `employees` endpoint sample:\n```\ncurl --fail \\\\\n -X GET \\\\\n -H 'Authorization: Bearer eyJhbGciOiJFUzI1NiIsImtpZCI6Ims5RmxwSFR1YklmZWNsUU5QRVZzeFcxazFZZ0Zfbk1BWllOSGVuOFQxdGciLCJ0eXAiOiJKV1MifQ.eyJwcm92aWRlciI6InNhbmRib3giLCJzY29wZXMiOlsiLzIwMjMtMDMtMDEveGhyL2NvbXBhbnkiLCIvMjAyMy0wMy0wMS94aHIvZW1wbG95ZWUiLCIvMjAyMy0wMy0wMS94aHIvZW1wbG95ZWVzIiwiLzIwMjMtMDMtMDEveGhyL2dyb3VwcyIsIi8yMDIzLTAzLTAxL3hoci9pZGVudGl0eSIsIi8yMDIzLTAzLTAxL3hoci9wYXlydW5zIiwiLzIwMjMtMDMtMDEveGhyL3BheXJ1bnMvOnBheXJ1bl9pZCIsIi8yMDIzLTAzLTAxL3hoci90aW1lLW9mZi1iYWxhbmNlcyIsIi8yMDIzLTAzLTAxL3hoci90aW1lLW9mZi1lbnRyaWVzIiwiLzIwMjMtMDMtMDEveGhyL3RpbWVzaGVldHMiLCIvMjAyMy0wMy0wMS94aHIvd29yay1sb2NhdGlvbnMiXSwidG9rZW4iOiIzYjg4MDc2NC1kMGFmLTQ5ZDAtOGM5OS00YzIwYjE2MTJjOTMiLCJpYXQiOjE3MTE4MTA4NTgsImlzcyI6InB1YmxpY2FwaS1pbnRlcm1lZGlhdGUucHJvZC5lbmdpbmVlcmluZy5hZmZpeGFwaS5jb20iLCJzdWIiOiJ4aHIiLCJhdWQiOiIwOEJCMDgxRS1EOUFCNEQxNC04REY5OTIzMy02NjYxNUNFOSJ9.n3pJmmfegU21Tko_TyUyCHi4ITvfd75T8NFFTHmf1r8AI8yCUYTWdfNjyZZWcZD6z50I3Wsk2rAd8GDWXn4vlg' \\\\\n 'https://api.affixapi.com/2023-03-01/xhr/employees'\n```\n\n# Compression\nWe support `brotli`, `gzip`, and `deflate` compression algorithms.\n\nTo enable, pass the `Accept-Encoding` header with one or all of the values:\n`br`, `gzip`, `deflate`, or `identity` (no compression)\n\nIn the response, you will receive the `Content-Encoding` response header\nindicating the compression algorithm used in the data payload to enable you\nto decompress the result. If the `Accept-Encoding: identity` header was\npassed, no `Content-Encoding` response header is sent back, as no\ncompression algorithm was used.\n\n# Webhooks\nAn exciting feature for HR/Payroll modes are webhooks.\n\nIf enabled, your `webhook_uri` is set on your `client_id` for the\nrespective environment: `dev | prod`\n\nWebhooks are configured to make live requests to the underlying integration\n1x/hr, and if a difference is detected since the last request, we will send a\nrequest to your `webhook_uri` with this shape:\n\n```\n{\n\n added: <api.v20230301.Employees>[\n <api.v20230301.Employee>{\n ...,\n date_of_birth: '2010-08-06',\n display_full_name: 'Daija Rogahn',\n employee_number: '57993',\n employment_status: 'pending',\n employment_type: 'other',\n employments: [\n {\n currency: 'eur',\n effective_date: '2022-02-25',\n employment_type: 'other',\n job_title: 'Dynamic Implementation Manager',\n pay_frequency: 'semimonthly',\n pay_period: 'YEAR',\n pay_rate: 96000,\n },\n ],\n first_name: 'Daija',\n ...\n }\n ],\n removed: [],\n updated: [\n <api.v20230301.Employee>{\n ...,\n date_of_birth: '2009-11-09',\n display_full_name: 'Lourdes Stiedemann',\n employee_number: '63189',\n employment_status: 'leave',\n employment_type: 'full_time',\n employments: [\n {\n currency: 'gbp',\n effective_date: '2023-01-16',\n employment_type: 'full_time',\n job_title: 'Forward Brand Planner',\n pay_frequency: 'semimonthly',\n pay_period: 'YEAR',\n pay_rate: 86000,\n },\n ],\n first_name: 'Lourdes',\n }\n ]\n}\n```\n\nthe following headers will be sent with webhook requests:\n\n```\nx-affix-api-signature: ab8474e609db95d5df3adc39ea3add7a7544bd215c5c520a30a650ae93a2fba7\n\nx-affix-api-origin: webhooks-employees-webhook\n\nuser-agent: affixapi.com\n```\n\nBefore trusting the payload, you should sign the payload and verify the\nsignature matches the signature sent by the `affixapi.com` service.\n\nThis secures that the data sent to your `webhook_uri` is from the\n`affixapi.com` server.\n\nThe signature is created by combining the signing secret (your\n`client_secret`) with the body of the request sent using a standard\nHMAC-SHA256 keyed hash.\n\nThe signature can be created via:\n - create an `HMAC` with your `client_secret`\n - update the `HMAC` with the payload\n - get the hex digest -> this is the signature\n\nSample `typescript` code that follows this recipe:\n\n```\nimport { createHmac } from 'crypto';\n\nexport const computeSignature = ({\n str,\n signingSecret,\n}: {\n signingSecret: string;\n str: string;\n}): string => {\n const hmac = createHmac('sha256', signingSecret);\n hmac.update(str);\n const signature = hmac.digest('hex');\n\n return signature;\n};\n```\n\nWhile verifying the Affix API signature header should be your primary\nmethod of confirming validity, you can also whitelist our outbound webhook\nstatic IP addresses.\n\n```\ndev:\n - 52.210.169.82\n - 52.210.38.77\n - 3.248.135.204\n\nprod:\n - 52.51.160.102\n - 54.220.83.244\n - 3.254.213.171\n```\n\n## Rate limits\nOpen endpoints (not gated by an API key) (applied at endpoint level):\n - 15 requests every 1 minute (by IP address)\n - 25 requests every 5 minutes (by IP address)\n\nGated endpoints (require an API key) (applied at endpoint level):\n - 40 requests every 1 minute (by IP address)\n - 40 requests every 5 minutes (by `client_id`)\n\nThings to keep in mind:\n - Open endpoints (not gated by an API key) will likely be called by your\n users, not you, so rate limits generally would not apply to you.\n - As a developer, rate limits are applied at the endpoint granularity.\n - For example, say the rate limits below are 10 requests per minute by ip.\n from that same ip, within 1 minute, you get:\n - 10 requests per minute on `/orders`,\n - another 10 requests per minute on `/items`,\n - and another 10 requests per minute on `/identity`,\n - for a total of 30 requests per minute.\n\n\nThis Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:\n\n- API version: 2023-03-01\n- Package version: 1.0.0\n- Build package: org.openapitools.codegen.languages.PythonClientCodegen\n\n## Requirements.\n\nPython >= 3.6\n\n## Installation & Usage\n### pip install\n\nIf the python package is hosted on a repository, you can install directly using:\n\n```sh\npip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git\n```\n(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)\n\nThen import the package:\n```python\nimport openapi_client\n```\n\n### Setuptools\n\nInstall via [Setuptools](http://pypi.python.org/pypi/setuptools).\n\n```sh\npython setup.py install --user\n```\n(or `sudo python setup.py install` to install the package for all users)\n\nThen import the package:\n```python\nimport openapi_client\n```\n\n## Getting Started\n\nPlease follow the [installation procedure](#installation--usage) and then run the following:\n\n```python\n\nimport time\nimport openapi_client\nfrom pprint import pprint\nfrom openapi_client.api import 2023_03_01_api\nfrom openapi_client.model.companies20230301_response import Companies20230301Response\nfrom openapi_client.model.employees20230301_response import Employees20230301Response\nfrom openapi_client.model.employment_status_not_null_not_nullable import EmploymentStatusNotNullNotNullable\nfrom openapi_client.model.groups20230301_response import Groups20230301Response\nfrom openapi_client.model.identity_response import IdentityResponse\nfrom openapi_client.model.inline_response401 import InlineResponse401\nfrom openapi_client.model.message_response import MessageResponse\nfrom openapi_client.model.payruns20230301_response import Payruns20230301Response\nfrom openapi_client.model.payslips20230301_response import Payslips20230301Response\nfrom openapi_client.model.time_off_balances20230301_response import TimeOffBalances20230301Response\nfrom openapi_client.model.time_off_entries20230301_response import TimeOffEntries20230301Response\nfrom openapi_client.model.timesheets20230301_response import Timesheets20230301Response\nfrom openapi_client.model.work_locations20230301_response import WorkLocations20230301Response\n# Defining the host is optional and defaults to https://api.affixapi.com\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = openapi_client.Configuration(\n host = \"https://api.affixapi.com\"\n)\n\n# The client must configure the authentication and authorization parameters\n# in accordance with the API server security policy.\n# Examples for each auth method are provided below, use the example that\n# satisfies your auth use case.\n\n# Configure API key authorization: access-token\nconfiguration.api_key['access-token'] = 'YOUR_API_KEY'\n\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['access-token'] = 'Bearer'\n\n\n# Enter a context with an instance of the API client\nwith openapi_client.ApiClient(configuration) as api_client:\n # Create an instance of the API class\n api_instance = 2023_03_01_api.20230301Api(api_client)\n \n try:\n # Company\n api_response = api_instance.xhr_companies20230301()\n pprint(api_response)\n except openapi_client.ApiException as e:\n print(\"Exception when calling 20230301Api->xhr_companies20230301: %s\\n\" % e)\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *https://api.affixapi.com*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*20230301Api* | [**xhr_companies20230301**](docs/20230301Api.md#xhr_companies20230301) | **GET** /2023-03-01/xhr/company | Company\n*20230301Api* | [**xhr_employees20230301**](docs/20230301Api.md#xhr_employees20230301) | **GET** /2023-03-01/xhr/employees | Employees\n*20230301Api* | [**xhr_groups20230301**](docs/20230301Api.md#xhr_groups20230301) | **GET** /2023-03-01/xhr/groups | Groups\n*20230301Api* | [**xhr_identity20230301**](docs/20230301Api.md#xhr_identity20230301) | **GET** /2023-03-01/xhr/identity | Identity\n*20230301Api* | [**xhr_payruns20230301**](docs/20230301Api.md#xhr_payruns20230301) | **GET** /2023-03-01/xhr/payruns | Payruns\n*20230301Api* | [**xhr_payslips20230301**](docs/20230301Api.md#xhr_payslips20230301) | **GET** /2023-03-01/xhr/payruns/{payrun_id} | Payslips\n*20230301Api* | [**xhr_time_off_balances20230301**](docs/20230301Api.md#xhr_time_off_balances20230301) | **GET** /2023-03-01/xhr/time-off-balances | Time off balances\n*20230301Api* | [**xhr_time_off_entries20230301**](docs/20230301Api.md#xhr_time_off_entries20230301) | **GET** /2023-03-01/xhr/time-off-entries | Time off entries\n*20230301Api* | [**xhr_timesheets20230301**](docs/20230301Api.md#xhr_timesheets20230301) | **GET** /2023-03-01/xhr/timesheets | Timesheets\n*20230301Api* | [**xhr_work_locations20230301**](docs/20230301Api.md#xhr_work_locations20230301) | **GET** /2023-03-01/xhr/work-locations | Work locations\n*CoreApi* | [**providers**](docs/CoreApi.md#providers) | **GET** /providers | Providers\n*ManagementApi* | [**client**](docs/ManagementApi.md#client) | **GET** /2023-03-01/management/client | Client\n*ManagementApi* | [**disconnect**](docs/ManagementApi.md#disconnect) | **POST** /2023-03-01/management/disconnect | Disconnect token\n*ManagementApi* | [**introspect**](docs/ManagementApi.md#introspect) | **GET** /2023-03-01/management/introspect | Inspect token\n*ManagementApi* | [**token**](docs/ManagementApi.md#token) | **POST** /2023-03-01/management/token | Create token\n*ManagementApi* | [**tokens**](docs/ManagementApi.md#tokens) | **GET** /2023-03-01/management/tokens | Tokens\n*ManagementApi* | [**update_client**](docs/ManagementApi.md#update_client) | **POST** /2023-03-01/management/client | Update client\n*XHRVerticallyIntegratedApi* | [**xhr_companies20230301**](docs/XHRVerticallyIntegratedApi.md#xhr_companies20230301) | **GET** /2023-03-01/xhr/company | Company\n*XHRVerticallyIntegratedApi* | [**xhr_employees20230301**](docs/XHRVerticallyIntegratedApi.md#xhr_employees20230301) | **GET** /2023-03-01/xhr/employees | Employees\n*XHRVerticallyIntegratedApi* | [**xhr_groups20230301**](docs/XHRVerticallyIntegratedApi.md#xhr_groups20230301) | **GET** /2023-03-01/xhr/groups | Groups\n*XHRVerticallyIntegratedApi* | [**xhr_identity20230301**](docs/XHRVerticallyIntegratedApi.md#xhr_identity20230301) | **GET** /2023-03-01/xhr/identity | Identity\n*XHRVerticallyIntegratedApi* | [**xhr_payruns20230301**](docs/XHRVerticallyIntegratedApi.md#xhr_payruns20230301) | **GET** /2023-03-01/xhr/payruns | Payruns\n*XHRVerticallyIntegratedApi* | [**xhr_payslips20230301**](docs/XHRVerticallyIntegratedApi.md#xhr_payslips20230301) | **GET** /2023-03-01/xhr/payruns/{payrun_id} | Payslips\n*XHRVerticallyIntegratedApi* | [**xhr_time_off_balances20230301**](docs/XHRVerticallyIntegratedApi.md#xhr_time_off_balances20230301) | **GET** /2023-03-01/xhr/time-off-balances | Time off balances\n*XHRVerticallyIntegratedApi* | [**xhr_time_off_entries20230301**](docs/XHRVerticallyIntegratedApi.md#xhr_time_off_entries20230301) | **GET** /2023-03-01/xhr/time-off-entries | Time off entries\n*XHRVerticallyIntegratedApi* | [**xhr_timesheets20230301**](docs/XHRVerticallyIntegratedApi.md#xhr_timesheets20230301) | **GET** /2023-03-01/xhr/timesheets | Timesheets\n*XHRVerticallyIntegratedApi* | [**xhr_work_locations20230301**](docs/XHRVerticallyIntegratedApi.md#xhr_work_locations20230301) | **GET** /2023-03-01/xhr/work-locations | Work locations\n\n\n## Documentation For Models\n\n - [AddressNoNonNullRequest](docs/AddressNoNonNullRequest.md)\n - [AddressResponse](docs/AddressResponse.md)\n - [ClientRequest](docs/ClientRequest.md)\n - [ClientResponse](docs/ClientResponse.md)\n - [Companies20230301Response](docs/Companies20230301Response.md)\n - [CompanyResponse](docs/CompanyResponse.md)\n - [CompensationHistoryNoNonNullRequest](docs/CompensationHistoryNoNonNullRequest.md)\n - [CompensationHistoryResponse](docs/CompensationHistoryResponse.md)\n - [CreateEmployeeRequest](docs/CreateEmployeeRequest.md)\n - [CreateEmployeeRequestBankAccount](docs/CreateEmployeeRequestBankAccount.md)\n - [CreateEmployeeRequestDependents](docs/CreateEmployeeRequestDependents.md)\n - [CreateEmployeeRequestEmergencyContacts](docs/CreateEmployeeRequestEmergencyContacts.md)\n - [CreateEmployeeRequestManager](docs/CreateEmployeeRequestManager.md)\n - [CurrencyNotNullRequest](docs/CurrencyNotNullRequest.md)\n - [CurrencyNotNullResponse](docs/CurrencyNotNullResponse.md)\n - [CurrencyResponse](docs/CurrencyResponse.md)\n - [DisconnectResponse](docs/DisconnectResponse.md)\n - [EmployeeResponse](docs/EmployeeResponse.md)\n - [EmployeeResponseManager](docs/EmployeeResponseManager.md)\n - [Employees20230301Response](docs/Employees20230301Response.md)\n - [EmploymentHistoryNoNonNullRequest](docs/EmploymentHistoryNoNonNullRequest.md)\n - [EmploymentHistoryResponse](docs/EmploymentHistoryResponse.md)\n - [EmploymentStatusNotNullNotNullable](docs/EmploymentStatusNotNullNotNullable.md)\n - [EmploymentStatusNotNullRequest](docs/EmploymentStatusNotNullRequest.md)\n - [EmploymentStatusResponse](docs/EmploymentStatusResponse.md)\n - [GroupNoNullEnumRequest](docs/GroupNoNullEnumRequest.md)\n - [GroupResponse](docs/GroupResponse.md)\n - [Groups20230301Response](docs/Groups20230301Response.md)\n - [GroupsNoNullEnumRequest](docs/GroupsNoNullEnumRequest.md)\n - [IdAndMessageResponse](docs/IdAndMessageResponse.md)\n - [IdentityResponse](docs/IdentityResponse.md)\n - [InlineResponse400](docs/InlineResponse400.md)\n - [InlineResponse401](docs/InlineResponse401.md)\n - [InlineResponse409](docs/InlineResponse409.md)\n - [IntrospectResponse](docs/IntrospectResponse.md)\n - [LocationNoNonNullRequest](docs/LocationNoNonNullRequest.md)\n - [LocationResponse](docs/LocationResponse.md)\n - [MessageResponse](docs/MessageResponse.md)\n - [ModeRequest](docs/ModeRequest.md)\n - [ModeResponse](docs/ModeResponse.md)\n - [PayrunResponse](docs/PayrunResponse.md)\n - [PayrunTypeResponse](docs/PayrunTypeResponse.md)\n - [Payruns20230301Response](docs/Payruns20230301Response.md)\n - [PayslipResponse](docs/PayslipResponse.md)\n - [PayslipResponseContributions](docs/PayslipResponseContributions.md)\n - [PayslipResponseDeductions](docs/PayslipResponseDeductions.md)\n - [PayslipResponseEarnings](docs/PayslipResponseEarnings.md)\n - [PayslipResponseReimbursements](docs/PayslipResponseReimbursements.md)\n - [PayslipResponseTaxes](docs/PayslipResponseTaxes.md)\n - [Payslips20230301Response](docs/Payslips20230301Response.md)\n - [PolicyTypeResponse](docs/PolicyTypeResponse.md)\n - [ProviderRequest](docs/ProviderRequest.md)\n - [ProviderResponse](docs/ProviderResponse.md)\n - [ProvidersResponse](docs/ProvidersResponse.md)\n - [ScopesRequest](docs/ScopesRequest.md)\n - [ScopesResponse](docs/ScopesResponse.md)\n - [TimeOffBalanceResponse](docs/TimeOffBalanceResponse.md)\n - [TimeOffBalances20230301Response](docs/TimeOffBalances20230301Response.md)\n - [TimeOffEntries20230301Response](docs/TimeOffEntries20230301Response.md)\n - [TimeOffEntryResponse](docs/TimeOffEntryResponse.md)\n - [TimesheetResponse](docs/TimesheetResponse.md)\n - [Timesheets20230301Response](docs/Timesheets20230301Response.md)\n - [TokenRequest](docs/TokenRequest.md)\n - [TokenResponse](docs/TokenResponse.md)\n - [TokensResponse](docs/TokensResponse.md)\n - [WorkLocations20230301Response](docs/WorkLocations20230301Response.md)\n\n\n## Documentation For Authorization\n\n\n## access-token\n\n- **Type**: API key\n- **API key parameter name**: Authorization\n- **Location**: HTTP header\n\n\n## basic\n\n- **Type**: API key\n- **API key parameter name**: Authorization\n- **Location**: HTTP header\n\n\n## Author\n\ndevelopers@affixapi.com\n\n\n## Notes for Large OpenAPI documents\nIf the OpenAPI document is large, imports in openapi_client.apis and openapi_client.models may fail with a\nRecursionError indicating the maximum recursion limit has been exceeded. In that case, there are a couple of solutions:\n\nSolution 1:\nUse specific imports for apis and models like:\n- `from openapi_client.api.default_api import DefaultApi`\n- `from openapi_client.model.pet import Pet`\n\nSolution 2:\nBefore importing the package, adjust the maximum recursion limit as shown below:\n```\nimport sys\nsys.setrecursionlimit(1500)\nimport openapi_client\nfrom openapi_client.apis import *\nfrom openapi_client.models import *\n```\n\n",
"bugtrack_url": null,
"license": null,
"summary": "Affix API",
"version": "1.1.100",
"project_urls": null,
"split_keywords": [
"openapi",
" openapi-generator",
" affix api"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ba59c5a7f047a8e77da6015296b9b38db7bccdee761b7d23543f4b7c43472800",
"md5": "c03b6667bfde4bdc3a746673e67c7bd7",
"sha256": "44ea5fac431d892d8e237362956602dadb8907f66d07ef67db1da1845493e407"
},
"downloads": -1,
"filename": "affixapi-1.1.100-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c03b6667bfde4bdc3a746673e67c7bd7",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 457993,
"upload_time": "2024-10-05T18:16:04",
"upload_time_iso_8601": "2024-10-05T18:16:04.619763Z",
"url": "https://files.pythonhosted.org/packages/ba/59/c5a7f047a8e77da6015296b9b38db7bccdee761b7d23543f4b7c43472800/affixapi-1.1.100-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "407eaae2a231447a7ee3c8dc2a34a3af27d81459771915fd854a8a55fd8256c6",
"md5": "83e85fbac8295b877833150c7247ec02",
"sha256": "024235fa7313808b8846c882fc229f508f917b5ab763dac799af68eedfa6b3a4"
},
"downloads": -1,
"filename": "affixapi-1.1.100.tar.gz",
"has_sig": false,
"md5_digest": "83e85fbac8295b877833150c7247ec02",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 113774,
"upload_time": "2024-10-05T18:16:06",
"upload_time_iso_8601": "2024-10-05T18:16:06.597273Z",
"url": "https://files.pythonhosted.org/packages/40/7e/aae2a231447a7ee3c8dc2a34a3af27d81459771915fd854a8a55fd8256c6/affixapi-1.1.100.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-05 18:16:06",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "affixapi"
}
JSON