All URIs are relative to https://unify.apideck.com
| Method | HTTP request | Description |
|---|---|---|
| companies_add | POST /hris/companies | Create Company |
| companies_all | GET /hris/companies | List Companies |
| companies_delete | DELETE /hris/companies/{id} | Delete Company |
| companies_one | GET /hris/companies/{id} | Get Company |
| companies_update | PATCH /hris/companies/{id} | Update Company |
| departments_add | POST /hris/departments | Create Department |
| departments_all | GET /hris/departments | List Departments |
| departments_delete | DELETE /hris/departments/{id} | Delete Department |
| departments_one | GET /hris/departments/{id} | Get Department |
| departments_update | PATCH /hris/departments/{id} | Update Department |
| employee_payrolls_all | GET /hris/payrolls/employees/{employee_id} | List Employee Payrolls |
| employee_payrolls_one | GET /hris/payrolls/employees/{employee_id}/payrolls/{payroll_id} | Get Employee Payroll |
| employee_schedules_all | GET /hris/schedules/employees/{employee_id} | List Employee Schedules |
| employees_add | POST /hris/employees | Create Employee |
| employees_all | GET /hris/employees | List Employees |
| employees_delete | DELETE /hris/employees/{id} | Delete Employee |
| employees_one | GET /hris/employees/{id} | Get Employee |
| employees_update | PATCH /hris/employees/{id} | Update Employee |
| payrolls_all | GET /hris/payrolls | List Payroll |
| payrolls_one | GET /hris/payrolls/{payroll_id} | Get Payroll |
| time_off_requests_add | POST /hris/time-off-requests | Create Time Off Request |
| time_off_requests_all | GET /hris/time-off-requests | List Time Off Requests |
| time_off_requests_delete | DELETE /hris/time-off-requests/employees/{employee_id}/time-off-requests/{id} | Delete Time Off Request |
| time_off_requests_one | GET /hris/time-off-requests/employees/{employee_id}/time-off-requests/{id} | Get Time Off Request |
| time_off_requests_update | PATCH /hris/time-off-requests/employees/{employee_id}/time-off-requests/{id} | Update Time Off Request |
CreateHrisCompanyResponse companies_add(hris_company)
Create Company
Create Company
- Api Key Authentication (apiKey):
import time
import apideck
from apideck.api import hris_api
from apideck.model.create_hris_company_response import CreateHrisCompanyResponse
from apideck.model.bad_request_response import BadRequestResponse
from apideck.model.payment_required_response import PaymentRequiredResponse
from apideck.model.hris_company import HrisCompany
from apideck.model.unexpected_error_response import UnexpectedErrorResponse
from apideck.model.unauthorized_response import UnauthorizedResponse
from apideck.model.unprocessable_response import UnprocessableResponse
from apideck.model.not_found_response import NotFoundResponse
from pprint import pprint
# Defining the host is optional and defaults to https://unify.apideck.com
# See configuration.py for a list of all supported configuration parameters.
configuration = apideck.Configuration(
host = "https://unify.apideck.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: apiKey
configuration.api_key['apiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiKey'] = 'Bearer'
# Enter a context with an instance of the API client
with apideck.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = hris_api.HrisApi(api_client)
hris_company = HrisCompany(
legal_name="SpaceX",
display_name="SpaceX",
subdomain="company",
status="active",
company_number="123456-AB",
currency=Currency("USD"),
addresses=[
Address(
id="123",
type="primary",
string="25 Spring Street, Blackburn, VIC 3130",
name="HQ US",
line1="Main street",
line2="apt #",
line3="Suite #",
line4="delivery instructions",
street_number="25",
city="San Francisco",
state="CA",
postal_code="94104",
country="US",
latitude="40.759211",
longitude="-73.984638",
county="Santa Clara",
contact_name="Elon Musk",
salutation="Mr",
phone_number="111-111-1111",
fax="122-111-1111",
email="[email protected]",
website="https://elonmusk.com",
notes="Address notes or delivery instructions.",
row_version="1-12345",
),
],
phone_numbers=[
PhoneNumber(
id="12345",
country_code="1",
area_code="323",
number="111-111-1111",
extension="105",
type="primary",
),
],
emails=[
Email(
id="123",
email="[email protected]",
type="primary",
),
],
websites=[
Website(
id="12345",
url="http://example.com",
type="primary",
),
],
debtor_id="12345",
pass_through=PassThroughBody([
{
service_id="service_id_example",
operation_id="operation_id_example",
extend_object={},
extend_paths=[
{
path="$.nested.property",
value=None,
},
],
},
]),
) # HrisCompany |
raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False
consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional)
app_id = "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" # str | The ID of your Unify application (optional)
service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional)
# example passing only required values which don't have defaults set
try:
# Create Company
api_response = api_instance.companies_add(hris_company)
pprint(api_response)
except apideck.ApiException as e:
print("Exception when calling HrisApi->companies_add: %s\n" % e)
# example passing only required values which don't have defaults set
# and optional values
try:
# Create Company
api_response = api_instance.companies_add(hris_company, raw=raw, consumer_id=consumer_id, app_id=app_id, service_id=service_id)
pprint(api_response)
except apideck.ApiException as e:
print("Exception when calling HrisApi->companies_add: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| hris_company | HrisCompany | ||
| raw | bool | Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False |
| consumer_id | str | ID of the consumer which you want to get or push data from | [optional] |
| app_id | str | The ID of your Unify application | [optional] |
| service_id | str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] |
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 201 | Companies | - |
| 400 | Bad Request | - |
| 401 | Unauthorized | - |
| 402 | Payment Required | - |
| 404 | The specified resource was not found | - |
| 422 | Unprocessable | - |
| 0 | Unexpected error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetHrisCompaniesResponse companies_all()
List Companies
List Companies
- Api Key Authentication (apiKey):
import time
import apideck
from apideck.api import hris_api
from apideck.model.pass_through_query import PassThroughQuery
from apideck.model.get_hris_companies_response import GetHrisCompaniesResponse
from apideck.model.bad_request_response import BadRequestResponse
from apideck.model.payment_required_response import PaymentRequiredResponse
from apideck.model.unexpected_error_response import UnexpectedErrorResponse
from apideck.model.unauthorized_response import UnauthorizedResponse
from apideck.model.unprocessable_response import UnprocessableResponse
from apideck.model.not_found_response import NotFoundResponse
from pprint import pprint
# Defining the host is optional and defaults to https://unify.apideck.com
# See configuration.py for a list of all supported configuration parameters.
configuration = apideck.Configuration(
host = "https://unify.apideck.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: apiKey
configuration.api_key['apiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiKey'] = 'Bearer'
# Enter a context with an instance of the API client
with apideck.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = hris_api.HrisApi(api_client)
raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False
consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional)
app_id = "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" # str | The ID of your Unify application (optional)
service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional)
cursor = "cursor_example" # str, none_type | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. (optional)
limit = 20 # int | Number of results to return. Minimum 1, Maximum 200, Default 20 (optional) if omitted the server will use the default value of 20
pass_through = PassThroughQuery() # PassThroughQuery | Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads (optional)
fields = "id,updated_at" # str, none_type | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: `fields=name,email,addresses.city`<br /><br />In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. (optional)
# example passing only required values which don't have defaults set
# and optional values
try:
# List Companies
api_response = api_instance.companies_all(raw=raw, consumer_id=consumer_id, app_id=app_id, service_id=service_id, cursor=cursor, limit=limit, pass_through=pass_through, fields=fields)
pprint(api_response)
except apideck.ApiException as e:
print("Exception when calling HrisApi->companies_all: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| raw | bool | Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False |
| consumer_id | str | ID of the consumer which you want to get or push data from | [optional] |
| app_id | str | The ID of your Unify application | [optional] |
| service_id | str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] |
| cursor | str, none_type | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | [optional] |
| limit | int | Number of results to return. Minimum 1, Maximum 200, Default 20 | [optional] if omitted the server will use the default value of 20 |
| pass_through | PassThroughQuery | Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads | [optional] |
| fields | str, none_type | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: `fields=name,email,addresses.city`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | [optional] |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Companies | - |
| 400 | Bad Request | - |
| 401 | Unauthorized | - |
| 402 | Payment Required | - |
| 404 | The specified resource was not found | - |
| 422 | Unprocessable | - |
| 0 | Unexpected error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DeleteHrisCompanyResponse companies_delete(id)
Delete Company
Delete Company
- Api Key Authentication (apiKey):
import time
import apideck
from apideck.api import hris_api
from apideck.model.delete_hris_company_response import DeleteHrisCompanyResponse
from apideck.model.bad_request_response import BadRequestResponse
from apideck.model.payment_required_response import PaymentRequiredResponse
from apideck.model.unexpected_error_response import UnexpectedErrorResponse
from apideck.model.unauthorized_response import UnauthorizedResponse
from apideck.model.unprocessable_response import UnprocessableResponse
from apideck.model.not_found_response import NotFoundResponse
from pprint import pprint
# Defining the host is optional and defaults to https://unify.apideck.com
# See configuration.py for a list of all supported configuration parameters.
configuration = apideck.Configuration(
host = "https://unify.apideck.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: apiKey
configuration.api_key['apiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiKey'] = 'Bearer'
# Enter a context with an instance of the API client
with apideck.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = hris_api.HrisApi(api_client)
id = "id_example" # str | ID of the record you are acting upon.
consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional)
app_id = "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" # str | The ID of your Unify application (optional)
service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional)
raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False
# example passing only required values which don't have defaults set
try:
# Delete Company
api_response = api_instance.companies_delete(id)
pprint(api_response)
except apideck.ApiException as e:
print("Exception when calling HrisApi->companies_delete: %s\n" % e)
# example passing only required values which don't have defaults set
# and optional values
try:
# Delete Company
api_response = api_instance.companies_delete(id, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw)
pprint(api_response)
except apideck.ApiException as e:
print("Exception when calling HrisApi->companies_delete: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| id | str | ID of the record you are acting upon. | |
| consumer_id | str | ID of the consumer which you want to get or push data from | [optional] |
| app_id | str | The ID of your Unify application | [optional] |
| service_id | str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] |
| raw | bool | Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Companies | - |
| 400 | Bad Request | - |
| 401 | Unauthorized | - |
| 402 | Payment Required | - |
| 404 | The specified resource was not found | - |
| 422 | Unprocessable | - |
| 0 | Unexpected error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetHrisCompanyResponse companies_one(id)
Get Company
Get Company
- Api Key Authentication (apiKey):
import time
import apideck
from apideck.api import hris_api
from apideck.model.bad_request_response import BadRequestResponse
from apideck.model.payment_required_response import PaymentRequiredResponse
from apideck.model.get_hris_company_response import GetHrisCompanyResponse
from apideck.model.unexpected_error_response import UnexpectedErrorResponse
from apideck.model.unauthorized_response import UnauthorizedResponse
from apideck.model.unprocessable_response import UnprocessableResponse
from apideck.model.not_found_response import NotFoundResponse
from pprint import pprint
# Defining the host is optional and defaults to https://unify.apideck.com
# See configuration.py for a list of all supported configuration parameters.
configuration = apideck.Configuration(
host = "https://unify.apideck.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: apiKey
configuration.api_key['apiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiKey'] = 'Bearer'
# Enter a context with an instance of the API client
with apideck.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = hris_api.HrisApi(api_client)
id = "id_example" # str | ID of the record you are acting upon.
consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional)
app_id = "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" # str | The ID of your Unify application (optional)
service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional)
raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False
fields = "id,updated_at" # str, none_type | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: `fields=name,email,addresses.city`<br /><br />In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. (optional)
# example passing only required values which don't have defaults set
try:
# Get Company
api_response = api_instance.companies_one(id)
pprint(api_response)
except apideck.ApiException as e:
print("Exception when calling HrisApi->companies_one: %s\n" % e)
# example passing only required values which don't have defaults set
# and optional values
try:
# Get Company
api_response = api_instance.companies_one(id, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw, fields=fields)
pprint(api_response)
except apideck.ApiException as e:
print("Exception when calling HrisApi->companies_one: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| id | str | ID of the record you are acting upon. | |
| consumer_id | str | ID of the consumer which you want to get or push data from | [optional] |
| app_id | str | The ID of your Unify application | [optional] |
| service_id | str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] |
| raw | bool | Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False |
| fields | str, none_type | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: `fields=name,email,addresses.city`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | [optional] |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Company | - |
| 400 | Bad Request | - |
| 401 | Unauthorized | - |
| 402 | Payment Required | - |
| 404 | The specified resource was not found | - |
| 422 | Unprocessable | - |
| 0 | Unexpected error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
UpdateHrisCompanyResponse companies_update(id, hris_company)
Update Company
Update Company
- Api Key Authentication (apiKey):
import time
import apideck
from apideck.api import hris_api
from apideck.model.update_hris_company_response import UpdateHrisCompanyResponse
from apideck.model.bad_request_response import BadRequestResponse
from apideck.model.payment_required_response import PaymentRequiredResponse
from apideck.model.hris_company import HrisCompany
from apideck.model.unexpected_error_response import UnexpectedErrorResponse
from apideck.model.unauthorized_response import UnauthorizedResponse
from apideck.model.unprocessable_response import UnprocessableResponse
from apideck.model.not_found_response import NotFoundResponse
from pprint import pprint
# Defining the host is optional and defaults to https://unify.apideck.com
# See configuration.py for a list of all supported configuration parameters.
configuration = apideck.Configuration(
host = "https://unify.apideck.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: apiKey
configuration.api_key['apiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiKey'] = 'Bearer'
# Enter a context with an instance of the API client
with apideck.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = hris_api.HrisApi(api_client)
id = "id_example" # str | ID of the record you are acting upon.
hris_company = HrisCompany(
legal_name="SpaceX",
display_name="SpaceX",
subdomain="company",
status="active",
company_number="123456-AB",
currency=Currency("USD"),
addresses=[
Address(
id="123",
type="primary",
string="25 Spring Street, Blackburn, VIC 3130",
name="HQ US",
line1="Main street",
line2="apt #",
line3="Suite #",
line4="delivery instructions",
street_number="25",
city="San Francisco",
state="CA",
postal_code="94104",
country="US",
latitude="40.759211",
longitude="-73.984638",
county="Santa Clara",
contact_name="Elon Musk",
salutation="Mr",
phone_number="111-111-1111",
fax="122-111-1111",
email="[email protected]",
website="https://elonmusk.com",
notes="Address notes or delivery instructions.",
row_version="1-12345",
),
],
phone_numbers=[
PhoneNumber(
id="12345",
country_code="1",
area_code="323",
number="111-111-1111",
extension="105",
type="primary",
),
],
emails=[
Email(
id="123",
email="[email protected]",
type="primary",
),
],
websites=[
Website(
id="12345",
url="http://example.com",
type="primary",
),
],
debtor_id="12345",
pass_through=PassThroughBody([
{
service_id="service_id_example",
operation_id="operation_id_example",
extend_object={},
extend_paths=[
{
path="$.nested.property",
value=None,
},
],
},
]),
) # HrisCompany |
consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional)
app_id = "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" # str | The ID of your Unify application (optional)
service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional)
raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False
# example passing only required values which don't have defaults set
try:
# Update Company
api_response = api_instance.companies_update(id, hris_company)
pprint(api_response)
except apideck.ApiException as e:
print("Exception when calling HrisApi->companies_update: %s\n" % e)
# example passing only required values which don't have defaults set
# and optional values
try:
# Update Company
api_response = api_instance.companies_update(id, hris_company, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw)
pprint(api_response)
except apideck.ApiException as e:
print("Exception when calling HrisApi->companies_update: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| id | str | ID of the record you are acting upon. | |
| hris_company | HrisCompany | ||
| consumer_id | str | ID of the consumer which you want to get or push data from | [optional] |
| app_id | str | The ID of your Unify application | [optional] |
| service_id | str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] |
| raw | bool | Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False |
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Companies | - |
| 400 | Bad Request | - |
| 401 | Unauthorized | - |
| 402 | Payment Required | - |
| 404 | The specified resource was not found | - |
| 422 | Unprocessable | - |
| 0 | Unexpected error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
CreateDepartmentResponse departments_add(department)
Create Department
Create Department
- Api Key Authentication (apiKey):
import time
import apideck
from apideck.api import hris_api
from apideck.model.bad_request_response import BadRequestResponse
from apideck.model.payment_required_response import PaymentRequiredResponse
from apideck.model.unexpected_error_response import UnexpectedErrorResponse
from apideck.model.unauthorized_response import UnauthorizedResponse
from apideck.model.department import Department
from apideck.model.unprocessable_response import UnprocessableResponse
from apideck.model.create_department_response import CreateDepartmentResponse
from apideck.model.not_found_response import NotFoundResponse
from pprint import pprint
# Defining the host is optional and defaults to https://unify.apideck.com
# See configuration.py for a list of all supported configuration parameters.
configuration = apideck.Configuration(
host = "https://unify.apideck.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: apiKey
configuration.api_key['apiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiKey'] = 'Bearer'
# Enter a context with an instance of the API client
with apideck.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = hris_api.HrisApi(api_client)
department = Department(
name="R&D",
code="2",
description="R&D",
pass_through=PassThroughBody([
{
service_id="service_id_example",
operation_id="operation_id_example",
extend_object={},
extend_paths=[
{
path="$.nested.property",
value=None,
},
],
},
]),
) # Department |
raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False
consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional)
app_id = "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" # str | The ID of your Unify application (optional)
service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional)
# example passing only required values which don't have defaults set
try:
# Create Department
api_response = api_instance.departments_add(department)
pprint(api_response)
except apideck.ApiException as e:
print("Exception when calling HrisApi->departments_add: %s\n" % e)
# example passing only required values which don't have defaults set
# and optional values
try:
# Create Department
api_response = api_instance.departments_add(department, raw=raw, consumer_id=consumer_id, app_id=app_id, service_id=service_id)
pprint(api_response)
except apideck.ApiException as e:
print("Exception when calling HrisApi->departments_add: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| department | Department | ||
| raw | bool | Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False |
| consumer_id | str | ID of the consumer which you want to get or push data from | [optional] |
| app_id | str | The ID of your Unify application | [optional] |
| service_id | str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] |
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 201 | Departments | - |
| 400 | Bad Request | - |
| 401 | Unauthorized | - |
| 402 | Payment Required | - |
| 404 | The specified resource was not found | - |
| 422 | Unprocessable | - |
| 0 | Unexpected error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetDepartmentsResponse departments_all()
List Departments
List Departments
- Api Key Authentication (apiKey):
import time
import apideck
from apideck.api import hris_api
from apideck.model.pass_through_query import PassThroughQuery
from apideck.model.bad_request_response import BadRequestResponse
from apideck.model.payment_required_response import PaymentRequiredResponse
from apideck.model.unexpected_error_response import UnexpectedErrorResponse
from apideck.model.unauthorized_response import UnauthorizedResponse
from apideck.model.get_departments_response import GetDepartmentsResponse
from apideck.model.unprocessable_response import UnprocessableResponse
from apideck.model.not_found_response import NotFoundResponse
from pprint import pprint
# Defining the host is optional and defaults to https://unify.apideck.com
# See configuration.py for a list of all supported configuration parameters.
configuration = apideck.Configuration(
host = "https://unify.apideck.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: apiKey
configuration.api_key['apiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiKey'] = 'Bearer'
# Enter a context with an instance of the API client
with apideck.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = hris_api.HrisApi(api_client)
raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False
consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional)
app_id = "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" # str | The ID of your Unify application (optional)
service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional)
cursor = "cursor_example" # str, none_type | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. (optional)
limit = 20 # int | Number of results to return. Minimum 1, Maximum 200, Default 20 (optional) if omitted the server will use the default value of 20
pass_through = PassThroughQuery() # PassThroughQuery | Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads (optional)
fields = "id,updated_at" # str, none_type | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: `fields=name,email,addresses.city`<br /><br />In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. (optional)
# example passing only required values which don't have defaults set
# and optional values
try:
# List Departments
api_response = api_instance.departments_all(raw=raw, consumer_id=consumer_id, app_id=app_id, service_id=service_id, cursor=cursor, limit=limit, pass_through=pass_through, fields=fields)
pprint(api_response)
except apideck.ApiException as e:
print("Exception when calling HrisApi->departments_all: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| raw | bool | Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False |
| consumer_id | str | ID of the consumer which you want to get or push data from | [optional] |
| app_id | str | The ID of your Unify application | [optional] |
| service_id | str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] |
| cursor | str, none_type | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | [optional] |
| limit | int | Number of results to return. Minimum 1, Maximum 200, Default 20 | [optional] if omitted the server will use the default value of 20 |
| pass_through | PassThroughQuery | Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads | [optional] |
| fields | str, none_type | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: `fields=name,email,addresses.city`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | [optional] |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Departments | - |
| 400 | Bad Request | - |
| 401 | Unauthorized | - |
| 402 | Payment Required | - |
| 404 | The specified resource was not found | - |
| 422 | Unprocessable | - |
| 0 | Unexpected error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DeleteDepartmentResponse departments_delete(id)
Delete Department
Delete Department
- Api Key Authentication (apiKey):
import time
import apideck
from apideck.api import hris_api
from apideck.model.bad_request_response import BadRequestResponse
from apideck.model.payment_required_response import PaymentRequiredResponse
from apideck.model.delete_department_response import DeleteDepartmentResponse
from apideck.model.unexpected_error_response import UnexpectedErrorResponse
from apideck.model.unauthorized_response import UnauthorizedResponse
from apideck.model.unprocessable_response import UnprocessableResponse
from apideck.model.not_found_response import NotFoundResponse
from pprint import pprint
# Defining the host is optional and defaults to https://unify.apideck.com
# See configuration.py for a list of all supported configuration parameters.
configuration = apideck.Configuration(
host = "https://unify.apideck.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: apiKey
configuration.api_key['apiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiKey'] = 'Bearer'
# Enter a context with an instance of the API client
with apideck.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = hris_api.HrisApi(api_client)
id = "id_example" # str | ID of the record you are acting upon.
consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional)
app_id = "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" # str | The ID of your Unify application (optional)
service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional)
raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False
# example passing only required values which don't have defaults set
try:
# Delete Department
api_response = api_instance.departments_delete(id)
pprint(api_response)
except apideck.ApiException as e:
print("Exception when calling HrisApi->departments_delete: %s\n" % e)
# example passing only required values which don't have defaults set
# and optional values
try:
# Delete Department
api_response = api_instance.departments_delete(id, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw)
pprint(api_response)
except apideck.ApiException as e:
print("Exception when calling HrisApi->departments_delete: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| id | str | ID of the record you are acting upon. | |
| consumer_id | str | ID of the consumer which you want to get or push data from | [optional] |
| app_id | str | The ID of your Unify application | [optional] |
| service_id | str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] |
| raw | bool | Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Departments | - |
| 400 | Bad Request | - |
| 401 | Unauthorized | - |
| 402 | Payment Required | - |
| 404 | The specified resource was not found | - |
| 422 | Unprocessable | - |
| 0 | Unexpected error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetDepartmentResponse departments_one(id)
Get Department
Get Department
- Api Key Authentication (apiKey):
import time
import apideck
from apideck.api import hris_api
from apideck.model.bad_request_response import BadRequestResponse
from apideck.model.payment_required_response import PaymentRequiredResponse
from apideck.model.unexpected_error_response import UnexpectedErrorResponse
from apideck.model.get_department_response import GetDepartmentResponse
from apideck.model.unauthorized_response import UnauthorizedResponse
from apideck.model.unprocessable_response import UnprocessableResponse
from apideck.model.not_found_response import NotFoundResponse
from pprint import pprint
# Defining the host is optional and defaults to https://unify.apideck.com
# See configuration.py for a list of all supported configuration parameters.
configuration = apideck.Configuration(
host = "https://unify.apideck.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: apiKey
configuration.api_key['apiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiKey'] = 'Bearer'
# Enter a context with an instance of the API client
with apideck.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = hris_api.HrisApi(api_client)
id = "id_example" # str | ID of the record you are acting upon.
consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional)
app_id = "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" # str | The ID of your Unify application (optional)
service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional)
raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False
fields = "id,updated_at" # str, none_type | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: `fields=name,email,addresses.city`<br /><br />In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. (optional)
# example passing only required values which don't have defaults set
try:
# Get Department
api_response = api_instance.departments_one(id)
pprint(api_response)
except apideck.ApiException as e:
print("Exception when calling HrisApi->departments_one: %s\n" % e)
# example passing only required values which don't have defaults set
# and optional values
try:
# Get Department
api_response = api_instance.departments_one(id, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw, fields=fields)
pprint(api_response)
except apideck.ApiException as e:
print("Exception when calling HrisApi->departments_one: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| id | str | ID of the record you are acting upon. | |
| consumer_id | str | ID of the consumer which you want to get or push data from | [optional] |
| app_id | str | The ID of your Unify application | [optional] |
| service_id | str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] |
| raw | bool | Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False |
| fields | str, none_type | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: `fields=name,email,addresses.city`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | [optional] |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Departments | - |
| 400 | Bad Request | - |
| 401 | Unauthorized | - |
| 402 | Payment Required | - |
| 404 | The specified resource was not found | - |
| 422 | Unprocessable | - |
| 0 | Unexpected error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
UpdateDepartmentResponse departments_update(id, department)
Update Department
Update Department
- Api Key Authentication (apiKey):
import time
import apideck
from apideck.api import hris_api
from apideck.model.update_department_response import UpdateDepartmentResponse
from apideck.model.bad_request_response import BadRequestResponse
from apideck.model.payment_required_response import PaymentRequiredResponse
from apideck.model.unexpected_error_response import UnexpectedErrorResponse
from apideck.model.unauthorized_response import UnauthorizedResponse
from apideck.model.department import Department
from apideck.model.unprocessable_response import UnprocessableResponse
from apideck.model.not_found_response import NotFoundResponse
from pprint import pprint
# Defining the host is optional and defaults to https://unify.apideck.com
# See configuration.py for a list of all supported configuration parameters.
configuration = apideck.Configuration(
host = "https://unify.apideck.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: apiKey
configuration.api_key['apiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiKey'] = 'Bearer'
# Enter a context with an instance of the API client
with apideck.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = hris_api.HrisApi(api_client)
id = "id_example" # str | ID of the record you are acting upon.
department = Department(
name="R&D",
code="2",
description="R&D",
pass_through=PassThroughBody([
{
service_id="service_id_example",
operation_id="operation_id_example",
extend_object={},
extend_paths=[
{
path="$.nested.property",
value=None,
},
],
},
]),
) # Department |
consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional)
app_id = "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" # str | The ID of your Unify application (optional)
service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional)
raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False
# example passing only required values which don't have defaults set
try:
# Update Department
api_response = api_instance.departments_update(id, department)
pprint(api_response)
except apideck.ApiException as e:
print("Exception when calling HrisApi->departments_update: %s\n" % e)
# example passing only required values which don't have defaults set
# and optional values
try:
# Update Department
api_response = api_instance.departments_update(id, department, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw)
pprint(api_response)
except apideck.ApiException as e:
print("Exception when calling HrisApi->departments_update: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| id | str | ID of the record you are acting upon. | |
| department | Department | ||
| consumer_id | str | ID of the consumer which you want to get or push data from | [optional] |
| app_id | str | The ID of your Unify application | [optional] |
| service_id | str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] |
| raw | bool | Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False |
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Departments | - |
| 400 | Bad Request | - |
| 401 | Unauthorized | - |
| 402 | Payment Required | - |
| 404 | The specified resource was not found | - |
| 422 | Unprocessable | - |
| 0 | Unexpected error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetEmployeePayrollsResponse employee_payrolls_all(employee_id)
List Employee Payrolls
List payrolls for employee
- Api Key Authentication (apiKey):
import time
import apideck
from apideck.api import hris_api
from apideck.model.pass_through_query import PassThroughQuery
from apideck.model.bad_request_response import BadRequestResponse
from apideck.model.payment_required_response import PaymentRequiredResponse
from apideck.model.payrolls_filter import PayrollsFilter
from apideck.model.get_employee_payrolls_response import GetEmployeePayrollsResponse
from apideck.model.unexpected_error_response import UnexpectedErrorResponse
from apideck.model.unauthorized_response import UnauthorizedResponse
from apideck.model.unprocessable_response import UnprocessableResponse
from apideck.model.not_found_response import NotFoundResponse
from pprint import pprint
# Defining the host is optional and defaults to https://unify.apideck.com
# See configuration.py for a list of all supported configuration parameters.
configuration = apideck.Configuration(
host = "https://unify.apideck.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: apiKey
configuration.api_key['apiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiKey'] = 'Bearer'
# Enter a context with an instance of the API client
with apideck.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = hris_api.HrisApi(api_client)
employee_id = "employee_id_example" # str | ID of the employee you are acting upon.
raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False
consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional)
app_id = "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" # str | The ID of your Unify application (optional)
service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional)
filter = PayrollsFilter(
start_date="2022-04-08",
end_date="2022-04-21",
) # PayrollsFilter | Apply filters (optional)
pass_through = PassThroughQuery() # PassThroughQuery | Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads (optional)
fields = "id,updated_at" # str, none_type | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: `fields=name,email,addresses.city`<br /><br />In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. (optional)
# example passing only required values which don't have defaults set
try:
# List Employee Payrolls
api_response = api_instance.employee_payrolls_all(employee_id)
pprint(api_response)
except apideck.ApiException as e:
print("Exception when calling HrisApi->employee_payrolls_all: %s\n" % e)
# example passing only required values which don't have defaults set
# and optional values
try:
# List Employee Payrolls
api_response = api_instance.employee_payrolls_all(employee_id, raw=raw, consumer_id=consumer_id, app_id=app_id, service_id=service_id, filter=filter, pass_through=pass_through, fields=fields)
pprint(api_response)
except apideck.ApiException as e:
print("Exception when calling HrisApi->employee_payrolls_all: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| employee_id | str | ID of the employee you are acting upon. | |
| raw | bool | Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False |
| consumer_id | str | ID of the consumer which you want to get or push data from | [optional] |
| app_id | str | The ID of your Unify application | [optional] |
| service_id | str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] |
| filter | PayrollsFilter | Apply filters | [optional] |
| pass_through | PassThroughQuery | Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads | [optional] |
| fields | str, none_type | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: `fields=name,email,addresses.city`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | [optional] |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | EmployeePayrolls | - |
| 400 | Bad Request | - |
| 401 | Unauthorized | - |
| 402 | Payment Required | - |
| 404 | The specified resource was not found | - |
| 422 | Unprocessable | - |
| 0 | Unexpected error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetEmployeePayrollResponse employee_payrolls_one(payroll_id, employee_id)
Get Employee Payroll
Get payroll for employee
- Api Key Authentication (apiKey):
import time
import apideck
from apideck.api import hris_api
from apideck.model.bad_request_response import BadRequestResponse
from apideck.model.payment_required_response import PaymentRequiredResponse
from apideck.model.get_employee_payroll_response import GetEmployeePayrollResponse
from apideck.model.unexpected_error_response import UnexpectedErrorResponse
from apideck.model.unauthorized_response import UnauthorizedResponse
from apideck.model.unprocessable_response import UnprocessableResponse
from apideck.model.not_found_response import NotFoundResponse
from pprint import pprint
# Defining the host is optional and defaults to https://unify.apideck.com
# See configuration.py for a list of all supported configuration parameters.
configuration = apideck.Configuration(
host = "https://unify.apideck.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: apiKey
configuration.api_key['apiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiKey'] = 'Bearer'
# Enter a context with an instance of the API client
with apideck.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = hris_api.HrisApi(api_client)
payroll_id = "payroll_id_example" # str | ID of the payroll you are acting upon.
employee_id = "employee_id_example" # str | ID of the employee you are acting upon.
raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False
consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional)
app_id = "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" # str | The ID of your Unify application (optional)
service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional)
fields = "id,updated_at" # str, none_type | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: `fields=name,email,addresses.city`<br /><br />In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. (optional)
# example passing only required values which don't have defaults set
try:
# Get Employee Payroll
api_response = api_instance.employee_payrolls_one(payroll_id, employee_id)
pprint(api_response)
except apideck.ApiException as e:
print("Exception when calling HrisApi->employee_payrolls_one: %s\n" % e)
# example passing only required values which don't have defaults set
# and optional values
try:
# Get Employee Payroll
api_response = api_instance.employee_payrolls_one(payroll_id, employee_id, raw=raw, consumer_id=consumer_id, app_id=app_id, service_id=service_id, fields=fields)
pprint(api_response)
except apideck.ApiException as e:
print("Exception when calling HrisApi->employee_payrolls_one: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| payroll_id | str | ID of the payroll you are acting upon. | |
| employee_id | str | ID of the employee you are acting upon. | |
| raw | bool | Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False |
| consumer_id | str | ID of the consumer which you want to get or push data from | [optional] |
| app_id | str | The ID of your Unify application | [optional] |
| service_id | str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] |
| fields | str, none_type | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: `fields=name,email,addresses.city`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | [optional] |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Payrolls | - |
| 400 | Bad Request | - |
| 401 | Unauthorized | - |
| 402 | Payment Required | - |
| 404 | The specified resource was not found | - |
| 422 | Unprocessable | - |
| 0 | Unexpected error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetEmployeeSchedulesResponse employee_schedules_all(employee_id)
List Employee Schedules
List schedules for employee, a schedule is a work pattern, not the actual worked hours, for an employee.
- Api Key Authentication (apiKey):
import time
import apideck
from apideck.api import hris_api
from apideck.model.pass_through_query import PassThroughQuery
from apideck.model.bad_request_response import BadRequestResponse
from apideck.model.payment_required_response import PaymentRequiredResponse
from apideck.model.unexpected_error_response import UnexpectedErrorResponse
from apideck.model.unauthorized_response import UnauthorizedResponse
from apideck.model.get_employee_schedules_response import GetEmployeeSchedulesResponse
from apideck.model.unprocessable_response import UnprocessableResponse
from apideck.model.not_found_response import NotFoundResponse
from pprint import pprint
# Defining the host is optional and defaults to https://unify.apideck.com
# See configuration.py for a list of all supported configuration parameters.
configuration = apideck.Configuration(
host = "https://unify.apideck.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: apiKey
configuration.api_key['apiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiKey'] = 'Bearer'
# Enter a context with an instance of the API client
with apideck.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = hris_api.HrisApi(api_client)
employee_id = "employee_id_example" # str | ID of the employee you are acting upon.
raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False
consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional)
app_id = "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" # str | The ID of your Unify application (optional)
service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional)
pass_through = PassThroughQuery() # PassThroughQuery | Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads (optional)
fields = "id,updated_at" # str, none_type | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: `fields=name,email,addresses.city`<br /><br />In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. (optional)
# example passing only required values which don't have defaults set
try:
# List Employee Schedules
api_response = api_instance.employee_schedules_all(employee_id)
pprint(api_response)
except apideck.ApiException as e:
print("Exception when calling HrisApi->employee_schedules_all: %s\n" % e)
# example passing only required values which don't have defaults set
# and optional values
try:
# List Employee Schedules
api_response = api_instance.employee_schedules_all(employee_id, raw=raw, consumer_id=consumer_id, app_id=app_id, service_id=service_id, pass_through=pass_through, fields=fields)
pprint(api_response)
except apideck.ApiException as e:
print("Exception when calling HrisApi->employee_schedules_all: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| employee_id | str | ID of the employee you are acting upon. | |
| raw | bool | Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False |
| consumer_id | str | ID of the consumer which you want to get or push data from | [optional] |
| app_id | str | The ID of your Unify application | [optional] |
| service_id | str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] |
| pass_through | PassThroughQuery | Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads | [optional] |
| fields | str, none_type | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: `fields=name,email,addresses.city`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | [optional] |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | EmployeeSchedules | - |
| 400 | Bad Request | - |
| 401 | Unauthorized | - |
| 402 | Payment Required | - |
| 404 | The specified resource was not found | - |
| 422 | Unprocessable | - |
| 0 | Unexpected error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
CreateEmployeeResponse employees_add(employee)
Create Employee
Create Employee
- Api Key Authentication (apiKey):
import time
import apideck
from apideck.api import hris_api
from apideck.model.employee import Employee
from apideck.model.bad_request_response import BadRequestResponse
from apideck.model.payment_required_response import PaymentRequiredResponse
from apideck.model.unexpected_error_response import UnexpectedErrorResponse
from apideck.model.unauthorized_response import UnauthorizedResponse
from apideck.model.create_employee_response import CreateEmployeeResponse
from apideck.model.unprocessable_response import UnprocessableResponse
from apideck.model.not_found_response import NotFoundResponse
from pprint import pprint
# Defining the host is optional and defaults to https://unify.apideck.com
# See configuration.py for a list of all supported configuration parameters.
configuration = apideck.Configuration(
host = "https://unify.apideck.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: apiKey
configuration.api_key['apiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiKey'] = 'Bearer'
# Enter a context with an instance of the API client
with apideck.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = hris_api.HrisApi(api_client)
employee = Employee(
id="12345",
first_name="Elon",
last_name="Musk",
middle_name="D.",
display_name="Technoking",
preferred_name="Elon Musk",
initials="EM",
salutation="Mr",
title="CEO",
marital_status="married",
partner=Person(
first_name="Elon",
last_name="Musk",
middle_name="D.",
gender=Gender("male"),
initials="EM",
birthday=dateutil_parser('Sat Aug 12 00:00:00 UTC 2000').date(),
deceased_on=dateutil_parser('Sat Aug 12 00:00:00 UTC 2000').date(),
),
division="Europe",
division_id="12345",
department="R&D",
department_id="12345",
department_name="12345",
team=Team(
id="1234",
name="Full Stack Engineers",
),
company_id="23456",
company_name="SpaceX",
employment_start_date="2021-10-26",
employment_end_date="2028-10-26",
leaving_reason="resigned",
employee_number="123456-AB",
employment_status=EmploymentStatus("active"),
employment_role=EmployeeEmploymentRole(
type="contractor",
sub_type="full_time",
),
ethnicity="African American",
manager=EmployeeManager(
id="12345",
name="Elon Musk",
first_name="Elon",
last_name="Musk",
email="[email protected]",
employment_status=EmploymentStatus("active"),
),
direct_reports=["a0d636c6-43b3-4bde-8c70-85b707d992f4","a98lfd96-43b3-4bde-8c70-85b707d992e6"],
social_security_number="123456789",
birthday=dateutil_parser('Sat Aug 12 00:00:00 UTC 2000').date(),
deceased_on=dateutil_parser('Sat Aug 12 00:00:00 UTC 2000').date(),
country_of_birth=Country("US"),
description="A description",
gender=Gender("male"),
pronouns="she,her",
preferred_language="EN",
languages=[
"EN",
],
nationalities=[
"US",
],
photo_url="https://unavatar.io/elon-musk",
timezone="Europe/London",
source="lever",
source_id="12345",
record_url="https://app.intercom.io/contacts/12345",
jobs=[
EmployeeJob(
title="CEO",
role="Sales",
start_date=dateutil_parser('Wed Aug 12 00:00:00 UTC 2020').date(),
end_date=dateutil_parser('Wed Aug 12 00:00:00 UTC 2020').date(),
compensation_rate=72000,
currency=Currency("USD"),
payment_unit=PaymentUnit("year"),
hired_at=dateutil_parser('Wed Aug 12 00:00:00 UTC 2020').date(),
is_primary=True,
is_manager=True,
status="active",
location=Address(
id="123",
type="primary",
string="25 Spring Street, Blackburn, VIC 3130",
name="HQ US",
line1="Main street",
line2="apt #",
line3="Suite #",
line4="delivery instructions",
street_number="25",
city="San Francisco",
state="CA",
postal_code="94104",
country="US",
latitude="40.759211",
longitude="-73.984638",
county="Santa Clara",
contact_name="Elon Musk",
salutation="Mr",
phone_number="111-111-1111",
fax="122-111-1111",
email="[email protected]",
website="https://elonmusk.com",
notes="Address notes or delivery instructions.",
row_version="1-12345",
),
),
],
compensations=[
EmployeeCompensation(
rate=72000,
payment_unit=PaymentUnit("year"),
currency=Currency("USD"),
flsa_status="exempt",
effective_date="2020-08-12",
payment_frequency=PaymentFrequency("monthly"),
),
],
works_remote=True,
addresses=[
Address(
id="123",
type="primary",
string="25 Spring Street, Blackburn, VIC 3130",
name="HQ US",
line1="Main street",
line2="apt #",
line3="Suite #",
line4="delivery instructions",
street_number="25",
city="San Francisco",
state="CA",
postal_code="94104",
country="US",
latitude="40.759211",
longitude="-73.984638",
county="Santa Clara",
contact_name="Elon Musk",
salutation="Mr",
phone_number="111-111-1111",
fax="122-111-1111",
email="[email protected]",
website="https://elonmusk.com",
notes="Address notes or delivery instructions.",
row_version="1-12345",
),
],
phone_numbers=[
PhoneNumber(
id="12345",
country_code="1",
area_code="323",
number="111-111-1111",
extension="105",
type="primary",
),
],
emails=[
Email(
id="123",
email="[email protected]",
type="primary",
),
],
custom_fields=[
CustomField(
id="2389328923893298",
name="employee_level",
description="Employee Level",
value=None,
),
],
social_links=[
SocialLink(
id="12345",
url="https://www.twitter.com/apideck",
type="twitter",
),
],
bank_accounts=[
BankAccount(
bank_name="Monzo",
account_number="123465",
account_name="SPACEX LLC",
account_type="credit_card",
iban="CH2989144532982975332",
bic="AUDSCHGGXXX",
routing_number="012345678",
bsb_number="062-001",
branch_identifier="001",
bank_code="BNH",
currency=Currency("USD"),
),
],
tax_code="1111",
tax_id="234-32-0000",
dietary_preference="Veggie",
food_allergies=["No allergies"],
probation_period=ProbationPeriod(
start_date=dateutil_parser('Fri Oct 01 00:00:00 UTC 2021').date(),
end_date=dateutil_parser('Sun Nov 28 00:00:00 UTC 2021').date(),
),
tags=Tags(["New"]),
row_version="1-12345",
deleted=True,
pass_through=PassThroughBody([
{
service_id="service_id_example",
operation_id="operation_id_example",
extend_object={},
extend_paths=[
{
path="$.nested.property",
value=None,
},
],
},
]),
) # Employee |
raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False
consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional)
app_id = "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" # str | The ID of your Unify application (optional)
service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional)
# example passing only required values which don't have defaults set
try:
# Create Employee
api_response = api_instance.employees_add(employee)
pprint(api_response)
except apideck.ApiException as e:
print("Exception when calling HrisApi->employees_add: %s\n" % e)
# example passing only required values which don't have defaults set
# and optional values
try:
# Create Employee
api_response = api_instance.employees_add(employee, raw=raw, consumer_id=consumer_id, app_id=app_id, service_id=service_id)
pprint(api_response)
except apideck.ApiException as e:
print("Exception when calling HrisApi->employees_add: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| employee | Employee | ||
| raw | bool | Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False |
| consumer_id | str | ID of the consumer which you want to get or push data from | [optional] |
| app_id | str | The ID of your Unify application | [optional] |
| service_id | str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] |
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 201 | Employees | - |
| 400 | Bad Request | - |
| 401 | Unauthorized | - |
| 402 | Payment Required | - |
| 404 | The specified resource was not found | - |
| 422 | Unprocessable | - |
| 0 | Unexpected error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetEmployeesResponse employees_all()
List Employees
Apideck operates as a stateless Unified API, which means that the list endpoint only provides a portion of the employee model. This is due to the fact that most HRIS systems do not readily provide all data in every call. However, you can access the complete employee model through an employee detail call.
- Api Key Authentication (apiKey):
import time
import apideck
from apideck.api import hris_api
from apideck.model.pass_through_query import PassThroughQuery
from apideck.model.bad_request_response import BadRequestResponse
from apideck.model.get_employees_response import GetEmployeesResponse
from apideck.model.employees_sort import EmployeesSort
from apideck.model.payment_required_response import PaymentRequiredResponse
from apideck.model.employees_filter import EmployeesFilter
from apideck.model.unexpected_error_response import UnexpectedErrorResponse
from apideck.model.unauthorized_response import UnauthorizedResponse
from apideck.model.unprocessable_response import UnprocessableResponse
from apideck.model.not_found_response import NotFoundResponse
from pprint import pprint
# Defining the host is optional and defaults to https://unify.apideck.com
# See configuration.py for a list of all supported configuration parameters.
configuration = apideck.Configuration(
host = "https://unify.apideck.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: apiKey
configuration.api_key['apiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiKey'] = 'Bearer'
# Enter a context with an instance of the API client
with apideck.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = hris_api.HrisApi(api_client)
raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False
consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional)
app_id = "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" # str | The ID of your Unify application (optional)
service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional)
cursor = "cursor_example" # str, none_type | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. (optional)
limit = 20 # int | Number of results to return. Minimum 1, Maximum 200, Default 20 (optional) if omitted the server will use the default value of 20
filter = EmployeesFilter(
company_id="1234",
email="[email protected]",
first_name="Elon",
title="Manager",
last_name="Musk",
manager_id="1234",
employment_status="active",
employee_number="123456-AB",
department_id="1234",
) # EmployeesFilter | Apply filters (optional)
sort = EmployeesSort(
by="created_at",
direction=SortDirection("asc"),
) # EmployeesSort | Apply sorting (optional)
pass_through = PassThroughQuery() # PassThroughQuery | Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads (optional)
fields = "id,updated_at" # str, none_type | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: `fields=name,email,addresses.city`<br /><br />In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. (optional)
# example passing only required values which don't have defaults set
# and optional values
try:
# List Employees
api_response = api_instance.employees_all(raw=raw, consumer_id=consumer_id, app_id=app_id, service_id=service_id, cursor=cursor, limit=limit, filter=filter, sort=sort, pass_through=pass_through, fields=fields)
pprint(api_response)
except apideck.ApiException as e:
print("Exception when calling HrisApi->employees_all: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| raw | bool | Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False |
| consumer_id | str | ID of the consumer which you want to get or push data from | [optional] |
| app_id | str | The ID of your Unify application | [optional] |
| service_id | str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] |
| cursor | str, none_type | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | [optional] |
| limit | int | Number of results to return. Minimum 1, Maximum 200, Default 20 | [optional] if omitted the server will use the default value of 20 |
| filter | EmployeesFilter | Apply filters | [optional] |
| sort | EmployeesSort | Apply sorting | [optional] |
| pass_through | PassThroughQuery | Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads | [optional] |
| fields | str, none_type | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: `fields=name,email,addresses.city`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | [optional] |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Employees | - |
| 400 | Bad Request | - |
| 401 | Unauthorized | - |
| 402 | Payment Required | - |
| 404 | The specified resource was not found | - |
| 422 | Unprocessable | - |
| 0 | Unexpected error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DeleteEmployeeResponse employees_delete(id)
Delete Employee
Delete Employee
- Api Key Authentication (apiKey):
import time
import apideck
from apideck.api import hris_api
from apideck.model.bad_request_response import BadRequestResponse
from apideck.model.payment_required_response import PaymentRequiredResponse
from apideck.model.unexpected_error_response import UnexpectedErrorResponse
from apideck.model.unauthorized_response import UnauthorizedResponse
from apideck.model.delete_employee_response import DeleteEmployeeResponse
from apideck.model.unprocessable_response import UnprocessableResponse
from apideck.model.not_found_response import NotFoundResponse
from pprint import pprint
# Defining the host is optional and defaults to https://unify.apideck.com
# See configuration.py for a list of all supported configuration parameters.
configuration = apideck.Configuration(
host = "https://unify.apideck.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: apiKey
configuration.api_key['apiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiKey'] = 'Bearer'
# Enter a context with an instance of the API client
with apideck.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = hris_api.HrisApi(api_client)
id = "id_example" # str | ID of the record you are acting upon.
consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional)
app_id = "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" # str | The ID of your Unify application (optional)
service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional)
raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False
# example passing only required values which don't have defaults set
try:
# Delete Employee
api_response = api_instance.employees_delete(id)
pprint(api_response)
except apideck.ApiException as e:
print("Exception when calling HrisApi->employees_delete: %s\n" % e)
# example passing only required values which don't have defaults set
# and optional values
try:
# Delete Employee
api_response = api_instance.employees_delete(id, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw)
pprint(api_response)
except apideck.ApiException as e:
print("Exception when calling HrisApi->employees_delete: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| id | str | ID of the record you are acting upon. | |
| consumer_id | str | ID of the consumer which you want to get or push data from | [optional] |
| app_id | str | The ID of your Unify application | [optional] |
| service_id | str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] |
| raw | bool | Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Employees | - |
| 400 | Bad Request | - |
| 401 | Unauthorized | - |
| 402 | Payment Required | - |
| 404 | The specified resource was not found | - |
| 422 | Unprocessable | - |
| 0 | Unexpected error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetEmployeeResponse employees_one(id)
Get Employee
Get Employee
- Api Key Authentication (apiKey):
import time
import apideck
from apideck.api import hris_api
from apideck.model.employees_one_filter import EmployeesOneFilter
from apideck.model.get_employee_response import GetEmployeeResponse
from apideck.model.pass_through_query import PassThroughQuery
from apideck.model.bad_request_response import BadRequestResponse
from apideck.model.payment_required_response import PaymentRequiredResponse
from apideck.model.unexpected_error_response import UnexpectedErrorResponse
from apideck.model.unauthorized_response import UnauthorizedResponse
from apideck.model.unprocessable_response import UnprocessableResponse
from apideck.model.not_found_response import NotFoundResponse
from pprint import pprint
# Defining the host is optional and defaults to https://unify.apideck.com
# See configuration.py for a list of all supported configuration parameters.
configuration = apideck.Configuration(
host = "https://unify.apideck.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: apiKey
configuration.api_key['apiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiKey'] = 'Bearer'
# Enter a context with an instance of the API client
with apideck.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = hris_api.HrisApi(api_client)
id = "id_example" # str | ID of the record you are acting upon.
consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional)
app_id = "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" # str | The ID of your Unify application (optional)
service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional)
raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False
fields = "id,updated_at" # str, none_type | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: `fields=name,email,addresses.city`<br /><br />In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. (optional)
filter = EmployeesOneFilter(
company_id="1234",
) # EmployeesOneFilter | Apply filters (optional)
pass_through = PassThroughQuery() # PassThroughQuery | Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads (optional)
# example passing only required values which don't have defaults set
try:
# Get Employee
api_response = api_instance.employees_one(id)
pprint(api_response)
except apideck.ApiException as e:
print("Exception when calling HrisApi->employees_one: %s\n" % e)
# example passing only required values which don't have defaults set
# and optional values
try:
# Get Employee
api_response = api_instance.employees_one(id, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw, fields=fields, filter=filter, pass_through=pass_through)
pprint(api_response)
except apideck.ApiException as e:
print("Exception when calling HrisApi->employees_one: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| id | str | ID of the record you are acting upon. | |
| consumer_id | str | ID of the consumer which you want to get or push data from | [optional] |
| app_id | str | The ID of your Unify application | [optional] |
| service_id | str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] |
| raw | bool | Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False |
| fields | str, none_type | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: `fields=name,email,addresses.city`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | [optional] |
| filter | EmployeesOneFilter | Apply filters | [optional] |
| pass_through | PassThroughQuery | Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads | [optional] |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Employees | - |
| 400 | Bad Request | - |
| 401 | Unauthorized | - |
| 402 | Payment Required | - |
| 404 | The specified resource was not found | - |
| 422 | Unprocessable | - |
| 0 | Unexpected error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
UpdateEmployeeResponse employees_update(id, employee)
Update Employee
Update Employee
- Api Key Authentication (apiKey):
import time
import apideck
from apideck.api import hris_api
from apideck.model.employee import Employee
from apideck.model.bad_request_response import BadRequestResponse
from apideck.model.payment_required_response import PaymentRequiredResponse
from apideck.model.unexpected_error_response import UnexpectedErrorResponse
from apideck.model.unauthorized_response import UnauthorizedResponse
from apideck.model.update_employee_response import UpdateEmployeeResponse
from apideck.model.unprocessable_response import UnprocessableResponse
from apideck.model.not_found_response import NotFoundResponse
from pprint import pprint
# Defining the host is optional and defaults to https://unify.apideck.com
# See configuration.py for a list of all supported configuration parameters.
configuration = apideck.Configuration(
host = "https://unify.apideck.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: apiKey
configuration.api_key['apiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiKey'] = 'Bearer'
# Enter a context with an instance of the API client
with apideck.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = hris_api.HrisApi(api_client)
id = "id_example" # str | ID of the record you are acting upon.
employee = Employee(
id="12345",
first_name="Elon",
last_name="Musk",
middle_name="D.",
display_name="Technoking",
preferred_name="Elon Musk",
initials="EM",
salutation="Mr",
title="CEO",
marital_status="married",
partner=Person(
first_name="Elon",
last_name="Musk",
middle_name="D.",
gender=Gender("male"),
initials="EM",
birthday=dateutil_parser('Sat Aug 12 00:00:00 UTC 2000').date(),
deceased_on=dateutil_parser('Sat Aug 12 00:00:00 UTC 2000').date(),
),
division="Europe",
division_id="12345",
department="R&D",
department_id="12345",
department_name="12345",
team=Team(
id="1234",
name="Full Stack Engineers",
),
company_id="23456",
company_name="SpaceX",
employment_start_date="2021-10-26",
employment_end_date="2028-10-26",
leaving_reason="resigned",
employee_number="123456-AB",
employment_status=EmploymentStatus("active"),
employment_role=EmployeeEmploymentRole(
type="contractor",
sub_type="full_time",
),
ethnicity="African American",
manager=EmployeeManager(
id="12345",
name="Elon Musk",
first_name="Elon",
last_name="Musk",
email="[email protected]",
employment_status=EmploymentStatus("active"),
),
direct_reports=["a0d636c6-43b3-4bde-8c70-85b707d992f4","a98lfd96-43b3-4bde-8c70-85b707d992e6"],
social_security_number="123456789",
birthday=dateutil_parser('Sat Aug 12 00:00:00 UTC 2000').date(),
deceased_on=dateutil_parser('Sat Aug 12 00:00:00 UTC 2000').date(),
country_of_birth=Country("US"),
description="A description",
gender=Gender("male"),
pronouns="she,her",
preferred_language="EN",
languages=[
"EN",
],
nationalities=[
"US",
],
photo_url="https://unavatar.io/elon-musk",
timezone="Europe/London",
source="lever",
source_id="12345",
record_url="https://app.intercom.io/contacts/12345",
jobs=[
EmployeeJob(
title="CEO",
role="Sales",
start_date=dateutil_parser('Wed Aug 12 00:00:00 UTC 2020').date(),
end_date=dateutil_parser('Wed Aug 12 00:00:00 UTC 2020').date(),
compensation_rate=72000,
currency=Currency("USD"),
payment_unit=PaymentUnit("year"),
hired_at=dateutil_parser('Wed Aug 12 00:00:00 UTC 2020').date(),
is_primary=True,
is_manager=True,
status="active",
location=Address(
id="123",
type="primary",
string="25 Spring Street, Blackburn, VIC 3130",
name="HQ US",
line1="Main street",
line2="apt #",
line3="Suite #",
line4="delivery instructions",
street_number="25",
city="San Francisco",
state="CA",
postal_code="94104",
country="US",
latitude="40.759211",
longitude="-73.984638",
county="Santa Clara",
contact_name="Elon Musk",
salutation="Mr",
phone_number="111-111-1111",
fax="122-111-1111",
email="[email protected]",
website="https://elonmusk.com",
notes="Address notes or delivery instructions.",
row_version="1-12345",
),
),
],
compensations=[
EmployeeCompensation(
rate=72000,
payment_unit=PaymentUnit("year"),
currency=Currency("USD"),
flsa_status="exempt",
effective_date="2020-08-12",
payment_frequency=PaymentFrequency("monthly"),
),
],
works_remote=True,
addresses=[
Address(
id="123",
type="primary",
string="25 Spring Street, Blackburn, VIC 3130",
name="HQ US",
line1="Main street",
line2="apt #",
line3="Suite #",
line4="delivery instructions",
street_number="25",
city="San Francisco",
state="CA",
postal_code="94104",
country="US",
latitude="40.759211",
longitude="-73.984638",
county="Santa Clara",
contact_name="Elon Musk",
salutation="Mr",
phone_number="111-111-1111",
fax="122-111-1111",
email="[email protected]",
website="https://elonmusk.com",
notes="Address notes or delivery instructions.",
row_version="1-12345",
),
],
phone_numbers=[
PhoneNumber(
id="12345",
country_code="1",
area_code="323",
number="111-111-1111",
extension="105",
type="primary",
),
],
emails=[
Email(
id="123",
email="[email protected]",
type="primary",
),
],
custom_fields=[
CustomField(
id="2389328923893298",
name="employee_level",
description="Employee Level",
value=None,
),
],
social_links=[
SocialLink(
id="12345",
url="https://www.twitter.com/apideck",
type="twitter",
),
],
bank_accounts=[
BankAccount(
bank_name="Monzo",
account_number="123465",
account_name="SPACEX LLC",
account_type="credit_card",
iban="CH2989144532982975332",
bic="AUDSCHGGXXX",
routing_number="012345678",
bsb_number="062-001",
branch_identifier="001",
bank_code="BNH",
currency=Currency("USD"),
),
],
tax_code="1111",
tax_id="234-32-0000",
dietary_preference="Veggie",
food_allergies=["No allergies"],
probation_period=ProbationPeriod(
start_date=dateutil_parser('Fri Oct 01 00:00:00 UTC 2021').date(),
end_date=dateutil_parser('Sun Nov 28 00:00:00 UTC 2021').date(),
),
tags=Tags(["New"]),
row_version="1-12345",
deleted=True,
pass_through=PassThroughBody([
{
service_id="service_id_example",
operation_id="operation_id_example",
extend_object={},
extend_paths=[
{
path="$.nested.property",
value=None,
},
],
},
]),
) # Employee |
consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional)
app_id = "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" # str | The ID of your Unify application (optional)
service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional)
raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False
# example passing only required values which don't have defaults set
try:
# Update Employee
api_response = api_instance.employees_update(id, employee)
pprint(api_response)
except apideck.ApiException as e:
print("Exception when calling HrisApi->employees_update: %s\n" % e)
# example passing only required values which don't have defaults set
# and optional values
try:
# Update Employee
api_response = api_instance.employees_update(id, employee, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw)
pprint(api_response)
except apideck.ApiException as e:
print("Exception when calling HrisApi->employees_update: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| id | str | ID of the record you are acting upon. | |
| employee | Employee | ||
| consumer_id | str | ID of the consumer which you want to get or push data from | [optional] |
| app_id | str | The ID of your Unify application | [optional] |
| service_id | str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] |
| raw | bool | Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False |
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Employees | - |
| 400 | Bad Request | - |
| 401 | Unauthorized | - |
| 402 | Payment Required | - |
| 404 | The specified resource was not found | - |
| 422 | Unprocessable | - |
| 0 | Unexpected error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetPayrollsResponse payrolls_all()
List Payroll
List Payroll
- Api Key Authentication (apiKey):
import time
import apideck
from apideck.api import hris_api
from apideck.model.pass_through_query import PassThroughQuery
from apideck.model.bad_request_response import BadRequestResponse
from apideck.model.payment_required_response import PaymentRequiredResponse
from apideck.model.payrolls_filter import PayrollsFilter
from apideck.model.get_payrolls_response import GetPayrollsResponse
from apideck.model.unexpected_error_response import UnexpectedErrorResponse
from apideck.model.unauthorized_response import UnauthorizedResponse
from apideck.model.unprocessable_response import UnprocessableResponse
from apideck.model.not_found_response import NotFoundResponse
from pprint import pprint
# Defining the host is optional and defaults to https://unify.apideck.com
# See configuration.py for a list of all supported configuration parameters.
configuration = apideck.Configuration(
host = "https://unify.apideck.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: apiKey
configuration.api_key['apiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiKey'] = 'Bearer'
# Enter a context with an instance of the API client
with apideck.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = hris_api.HrisApi(api_client)
raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False
consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional)
app_id = "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" # str | The ID of your Unify application (optional)
service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional)
filter = PayrollsFilter(
start_date="2022-04-08",
end_date="2022-04-21",
) # PayrollsFilter | Apply filters (optional)
pass_through = PassThroughQuery() # PassThroughQuery | Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads (optional)
fields = "id,updated_at" # str, none_type | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: `fields=name,email,addresses.city`<br /><br />In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. (optional)
# example passing only required values which don't have defaults set
# and optional values
try:
# List Payroll
api_response = api_instance.payrolls_all(raw=raw, consumer_id=consumer_id, app_id=app_id, service_id=service_id, filter=filter, pass_through=pass_through, fields=fields)
pprint(api_response)
except apideck.ApiException as e:
print("Exception when calling HrisApi->payrolls_all: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| raw | bool | Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False |
| consumer_id | str | ID of the consumer which you want to get or push data from | [optional] |
| app_id | str | The ID of your Unify application | [optional] |
| service_id | str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] |
| filter | PayrollsFilter | Apply filters | [optional] |
| pass_through | PassThroughQuery | Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads | [optional] |
| fields | str, none_type | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: `fields=name,email,addresses.city`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | [optional] |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Payrolls | - |
| 400 | Bad Request | - |
| 401 | Unauthorized | - |
| 402 | Payment Required | - |
| 404 | The specified resource was not found | - |
| 422 | Unprocessable | - |
| 0 | Unexpected error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetPayrollResponse payrolls_one(payroll_id)
Get Payroll
Get Payroll
- Api Key Authentication (apiKey):
import time
import apideck
from apideck.api import hris_api
from apideck.model.bad_request_response import BadRequestResponse
from apideck.model.payment_required_response import PaymentRequiredResponse
from apideck.model.unexpected_error_response import UnexpectedErrorResponse
from apideck.model.unauthorized_response import UnauthorizedResponse
from apideck.model.get_payroll_response import GetPayrollResponse
from apideck.model.unprocessable_response import UnprocessableResponse
from apideck.model.not_found_response import NotFoundResponse
from pprint import pprint
# Defining the host is optional and defaults to https://unify.apideck.com
# See configuration.py for a list of all supported configuration parameters.
configuration = apideck.Configuration(
host = "https://unify.apideck.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: apiKey
configuration.api_key['apiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiKey'] = 'Bearer'
# Enter a context with an instance of the API client
with apideck.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = hris_api.HrisApi(api_client)
payroll_id = "payroll_id_example" # str | ID of the payroll you are acting upon.
raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False
consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional)
app_id = "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" # str | The ID of your Unify application (optional)
service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional)
fields = "id,updated_at" # str, none_type | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: `fields=name,email,addresses.city`<br /><br />In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. (optional)
# example passing only required values which don't have defaults set
try:
# Get Payroll
api_response = api_instance.payrolls_one(payroll_id)
pprint(api_response)
except apideck.ApiException as e:
print("Exception when calling HrisApi->payrolls_one: %s\n" % e)
# example passing only required values which don't have defaults set
# and optional values
try:
# Get Payroll
api_response = api_instance.payrolls_one(payroll_id, raw=raw, consumer_id=consumer_id, app_id=app_id, service_id=service_id, fields=fields)
pprint(api_response)
except apideck.ApiException as e:
print("Exception when calling HrisApi->payrolls_one: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| payroll_id | str | ID of the payroll you are acting upon. | |
| raw | bool | Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False |
| consumer_id | str | ID of the consumer which you want to get or push data from | [optional] |
| app_id | str | The ID of your Unify application | [optional] |
| service_id | str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] |
| fields | str, none_type | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: `fields=name,email,addresses.city`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | [optional] |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Payrolls | - |
| 400 | Bad Request | - |
| 401 | Unauthorized | - |
| 402 | Payment Required | - |
| 404 | The specified resource was not found | - |
| 422 | Unprocessable | - |
| 0 | Unexpected error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
CreateTimeOffRequestResponse time_off_requests_add(time_off_request)
Create Time Off Request
Create Time Off Request
- Api Key Authentication (apiKey):
import time
import apideck
from apideck.api import hris_api
from apideck.model.create_time_off_request_response import CreateTimeOffRequestResponse
from apideck.model.time_off_request import TimeOffRequest
from apideck.model.bad_request_response import BadRequestResponse
from apideck.model.payment_required_response import PaymentRequiredResponse
from apideck.model.unexpected_error_response import UnexpectedErrorResponse
from apideck.model.unauthorized_response import UnauthorizedResponse
from apideck.model.unprocessable_response import UnprocessableResponse
from apideck.model.not_found_response import NotFoundResponse
from pprint import pprint
# Defining the host is optional and defaults to https://unify.apideck.com
# See configuration.py for a list of all supported configuration parameters.
configuration = apideck.Configuration(
host = "https://unify.apideck.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: apiKey
configuration.api_key['apiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiKey'] = 'Bearer'
# Enter a context with an instance of the API client
with apideck.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = hris_api.HrisApi(api_client)
time_off_request = TimeOffRequest(
employee_id="12345",
policy_id="12345",
status="approved",
description="Enjoying some sun.",
start_date="2022-04-01",
end_date="2022-04-01",
request_date="2022-03-21",
request_type="vacation",
approval_date="2022-03-21",
units="hours",
amount=3.5,
day_part="morning",
notes=TimeOffRequestNotes(
employee="Relaxing on the beach for a few hours.",
manager="Enjoy!",
),
pass_through=PassThroughBody([
{
service_id="service_id_example",
operation_id="operation_id_example",
extend_object={},
extend_paths=[
{
path="$.nested.property",
value=None,
},
],
},
]),
policy_type="sick",
) # TimeOffRequest |
raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False
consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional)
app_id = "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" # str | The ID of your Unify application (optional)
service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional)
# example passing only required values which don't have defaults set
try:
# Create Time Off Request
api_response = api_instance.time_off_requests_add(time_off_request)
pprint(api_response)
except apideck.ApiException as e:
print("Exception when calling HrisApi->time_off_requests_add: %s\n" % e)
# example passing only required values which don't have defaults set
# and optional values
try:
# Create Time Off Request
api_response = api_instance.time_off_requests_add(time_off_request, raw=raw, consumer_id=consumer_id, app_id=app_id, service_id=service_id)
pprint(api_response)
except apideck.ApiException as e:
print("Exception when calling HrisApi->time_off_requests_add: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| time_off_request | TimeOffRequest | ||
| raw | bool | Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False |
| consumer_id | str | ID of the consumer which you want to get or push data from | [optional] |
| app_id | str | The ID of your Unify application | [optional] |
| service_id | str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] |
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 201 | TimeOffRequests | - |
| 400 | Bad Request | - |
| 401 | Unauthorized | - |
| 402 | Payment Required | - |
| 404 | The specified resource was not found | - |
| 422 | Unprocessable | - |
| 0 | Unexpected error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetTimeOffRequestsResponse time_off_requests_all()
List Time Off Requests
List Time Off Requests
- Api Key Authentication (apiKey):
import time
import apideck
from apideck.api import hris_api
from apideck.model.pass_through_query import PassThroughQuery
from apideck.model.get_time_off_requests_response import GetTimeOffRequestsResponse
from apideck.model.bad_request_response import BadRequestResponse
from apideck.model.payment_required_response import PaymentRequiredResponse
from apideck.model.unexpected_error_response import UnexpectedErrorResponse
from apideck.model.time_off_requests_filter import TimeOffRequestsFilter
from apideck.model.unauthorized_response import UnauthorizedResponse
from apideck.model.unprocessable_response import UnprocessableResponse
from apideck.model.not_found_response import NotFoundResponse
from pprint import pprint
# Defining the host is optional and defaults to https://unify.apideck.com
# See configuration.py for a list of all supported configuration parameters.
configuration = apideck.Configuration(
host = "https://unify.apideck.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: apiKey
configuration.api_key['apiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiKey'] = 'Bearer'
# Enter a context with an instance of the API client
with apideck.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = hris_api.HrisApi(api_client)
raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False
consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional)
app_id = "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" # str | The ID of your Unify application (optional)
service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional)
cursor = "cursor_example" # str, none_type | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. (optional)
limit = 20 # int | Number of results to return. Minimum 1, Maximum 200, Default 20 (optional) if omitted the server will use the default value of 20
filter = TimeOffRequestsFilter(
start_date="2022-04-08",
end_date="2022-04-21",
updated_since="2020-09-30T07:43:32.000Z",
employee_id="1234",
time_off_request_status="requested",
company_id="1234",
) # TimeOffRequestsFilter | Apply filters (optional)
pass_through = PassThroughQuery() # PassThroughQuery | Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads (optional)
fields = "id,updated_at" # str, none_type | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: `fields=name,email,addresses.city`<br /><br />In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. (optional)
# example passing only required values which don't have defaults set
# and optional values
try:
# List Time Off Requests
api_response = api_instance.time_off_requests_all(raw=raw, consumer_id=consumer_id, app_id=app_id, service_id=service_id, cursor=cursor, limit=limit, filter=filter, pass_through=pass_through, fields=fields)
pprint(api_response)
except apideck.ApiException as e:
print("Exception when calling HrisApi->time_off_requests_all: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| raw | bool | Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False |
| consumer_id | str | ID of the consumer which you want to get or push data from | [optional] |
| app_id | str | The ID of your Unify application | [optional] |
| service_id | str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] |
| cursor | str, none_type | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | [optional] |
| limit | int | Number of results to return. Minimum 1, Maximum 200, Default 20 | [optional] if omitted the server will use the default value of 20 |
| filter | TimeOffRequestsFilter | Apply filters | [optional] |
| pass_through | PassThroughQuery | Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads | [optional] |
| fields | str, none_type | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: `fields=name,email,addresses.city`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | [optional] |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | TimeOffRequests | - |
| 400 | Bad Request | - |
| 401 | Unauthorized | - |
| 402 | Payment Required | - |
| 404 | The specified resource was not found | - |
| 422 | Unprocessable | - |
| 0 | Unexpected error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DeleteTimeOffRequestResponse time_off_requests_delete(id, employee_id)
Delete Time Off Request
Delete Time Off Request
- Api Key Authentication (apiKey):
import time
import apideck
from apideck.api import hris_api
from apideck.model.delete_time_off_request_response import DeleteTimeOffRequestResponse
from apideck.model.bad_request_response import BadRequestResponse
from apideck.model.payment_required_response import PaymentRequiredResponse
from apideck.model.unexpected_error_response import UnexpectedErrorResponse
from apideck.model.unauthorized_response import UnauthorizedResponse
from apideck.model.unprocessable_response import UnprocessableResponse
from apideck.model.not_found_response import NotFoundResponse
from pprint import pprint
# Defining the host is optional and defaults to https://unify.apideck.com
# See configuration.py for a list of all supported configuration parameters.
configuration = apideck.Configuration(
host = "https://unify.apideck.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: apiKey
configuration.api_key['apiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiKey'] = 'Bearer'
# Enter a context with an instance of the API client
with apideck.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = hris_api.HrisApi(api_client)
id = "id_example" # str | ID of the record you are acting upon.
employee_id = "employee_id_example" # str | ID of the employee you are acting upon.
consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional)
app_id = "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" # str | The ID of your Unify application (optional)
service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional)
raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False
# example passing only required values which don't have defaults set
try:
# Delete Time Off Request
api_response = api_instance.time_off_requests_delete(id, employee_id)
pprint(api_response)
except apideck.ApiException as e:
print("Exception when calling HrisApi->time_off_requests_delete: %s\n" % e)
# example passing only required values which don't have defaults set
# and optional values
try:
# Delete Time Off Request
api_response = api_instance.time_off_requests_delete(id, employee_id, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw)
pprint(api_response)
except apideck.ApiException as e:
print("Exception when calling HrisApi->time_off_requests_delete: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| id | str | ID of the record you are acting upon. | |
| employee_id | str | ID of the employee you are acting upon. | |
| consumer_id | str | ID of the consumer which you want to get or push data from | [optional] |
| app_id | str | The ID of your Unify application | [optional] |
| service_id | str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] |
| raw | bool | Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | TimeOffRequests | - |
| 400 | Bad Request | - |
| 401 | Unauthorized | - |
| 402 | Payment Required | - |
| 404 | The specified resource was not found | - |
| 422 | Unprocessable | - |
| 0 | Unexpected error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetTimeOffRequestResponse time_off_requests_one(id, employee_id)
Get Time Off Request
Get Time Off Request
- Api Key Authentication (apiKey):
import time
import apideck
from apideck.api import hris_api
from apideck.model.bad_request_response import BadRequestResponse
from apideck.model.payment_required_response import PaymentRequiredResponse
from apideck.model.get_time_off_request_response import GetTimeOffRequestResponse
from apideck.model.unexpected_error_response import UnexpectedErrorResponse
from apideck.model.unauthorized_response import UnauthorizedResponse
from apideck.model.unprocessable_response import UnprocessableResponse
from apideck.model.not_found_response import NotFoundResponse
from pprint import pprint
# Defining the host is optional and defaults to https://unify.apideck.com
# See configuration.py for a list of all supported configuration parameters.
configuration = apideck.Configuration(
host = "https://unify.apideck.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: apiKey
configuration.api_key['apiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiKey'] = 'Bearer'
# Enter a context with an instance of the API client
with apideck.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = hris_api.HrisApi(api_client)
id = "id_example" # str | ID of the record you are acting upon.
employee_id = "employee_id_example" # str | ID of the employee you are acting upon.
consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional)
app_id = "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" # str | The ID of your Unify application (optional)
service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional)
raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False
fields = "id,updated_at" # str, none_type | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: `fields=name,email,addresses.city`<br /><br />In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. (optional)
# example passing only required values which don't have defaults set
try:
# Get Time Off Request
api_response = api_instance.time_off_requests_one(id, employee_id)
pprint(api_response)
except apideck.ApiException as e:
print("Exception when calling HrisApi->time_off_requests_one: %s\n" % e)
# example passing only required values which don't have defaults set
# and optional values
try:
# Get Time Off Request
api_response = api_instance.time_off_requests_one(id, employee_id, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw, fields=fields)
pprint(api_response)
except apideck.ApiException as e:
print("Exception when calling HrisApi->time_off_requests_one: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| id | str | ID of the record you are acting upon. | |
| employee_id | str | ID of the employee you are acting upon. | |
| consumer_id | str | ID of the consumer which you want to get or push data from | [optional] |
| app_id | str | The ID of your Unify application | [optional] |
| service_id | str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] |
| raw | bool | Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False |
| fields | str, none_type | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: `fields=name,email,addresses.city`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | [optional] |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | TimeOffRequests | - |
| 400 | Bad Request | - |
| 401 | Unauthorized | - |
| 402 | Payment Required | - |
| 404 | The specified resource was not found | - |
| 422 | Unprocessable | - |
| 0 | Unexpected error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
UpdateTimeOffRequestResponse time_off_requests_update(id, employee_id, time_off_request)
Update Time Off Request
Update Time Off Request
- Api Key Authentication (apiKey):
import time
import apideck
from apideck.api import hris_api
from apideck.model.time_off_request import TimeOffRequest
from apideck.model.bad_request_response import BadRequestResponse
from apideck.model.update_time_off_request_response import UpdateTimeOffRequestResponse
from apideck.model.payment_required_response import PaymentRequiredResponse
from apideck.model.unexpected_error_response import UnexpectedErrorResponse
from apideck.model.unauthorized_response import UnauthorizedResponse
from apideck.model.unprocessable_response import UnprocessableResponse
from apideck.model.not_found_response import NotFoundResponse
from pprint import pprint
# Defining the host is optional and defaults to https://unify.apideck.com
# See configuration.py for a list of all supported configuration parameters.
configuration = apideck.Configuration(
host = "https://unify.apideck.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: apiKey
configuration.api_key['apiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiKey'] = 'Bearer'
# Enter a context with an instance of the API client
with apideck.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = hris_api.HrisApi(api_client)
id = "id_example" # str | ID of the record you are acting upon.
employee_id = "employee_id_example" # str | ID of the employee you are acting upon.
time_off_request = TimeOffRequest(
employee_id="12345",
policy_id="12345",
status="approved",
description="Enjoying some sun.",
start_date="2022-04-01",
end_date="2022-04-01",
request_date="2022-03-21",
request_type="vacation",
approval_date="2022-03-21",
units="hours",
amount=3.5,
day_part="morning",
notes=TimeOffRequestNotes(
employee="Relaxing on the beach for a few hours.",
manager="Enjoy!",
),
pass_through=PassThroughBody([
{
service_id="service_id_example",
operation_id="operation_id_example",
extend_object={},
extend_paths=[
{
path="$.nested.property",
value=None,
},
],
},
]),
policy_type="sick",
) # TimeOffRequest |
consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional)
app_id = "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" # str | The ID of your Unify application (optional)
service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional)
raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False
# example passing only required values which don't have defaults set
try:
# Update Time Off Request
api_response = api_instance.time_off_requests_update(id, employee_id, time_off_request)
pprint(api_response)
except apideck.ApiException as e:
print("Exception when calling HrisApi->time_off_requests_update: %s\n" % e)
# example passing only required values which don't have defaults set
# and optional values
try:
# Update Time Off Request
api_response = api_instance.time_off_requests_update(id, employee_id, time_off_request, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw)
pprint(api_response)
except apideck.ApiException as e:
print("Exception when calling HrisApi->time_off_requests_update: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| id | str | ID of the record you are acting upon. | |
| employee_id | str | ID of the employee you are acting upon. | |
| time_off_request | TimeOffRequest | ||
| consumer_id | str | ID of the consumer which you want to get or push data from | [optional] |
| app_id | str | The ID of your Unify application | [optional] |
| service_id | str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] |
| raw | bool | Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False |
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | TimeOffRequests | - |
| 400 | Bad Request | - |
| 401 | Unauthorized | - |
| 402 | Payment Required | - |
| 404 | The specified resource was not found | - |
| 422 | Unprocessable | - |
| 0 | Unexpected error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]