### Get Employee Tax Information

Source: https://developers.getknit.dev/docs/paycom-usecases

Retrieves tax setup details for a specific employee using their employee code. Subject to rate limits.

```APIDOC
## GET /api/v1/hr/employee_tax_information/:eecode

### Description
Retrieves the tax setup details for a specific employee identified by the 'eecode' parameter.

### Method
GET

### Endpoint
/api/v1/hr/employee_tax_information/:eecode

### Parameters
#### Path Parameters
- **eecode** (string) - Required - A four-character employee code.

### Response
#### Success Response (200)
- **federal_allowances** (integer) - Federal tax allowances.
- **state_allowances** (integer) - State tax allowances.
- **filing_status** (string) - Employee's tax filing status.
- **additional_tax** (number) - Additional tax amount specified by the employee.
- **local_tax_details** (object) - Details about local tax setup.

#### Response Example
```json
{
  "federal_allowances": 2,
  "state_allowances": 1,
  "filing_status": "Single",
  "additional_tax": 50.00,
  "local_tax_details": {
    "city": "Anytown",
    "state": "CA",
    "tax_rate": "1.5%"
  }
}
```
```

--------------------------------

### List all Onboarding Templates

Source: https://developers.getknit.dev/docs/intellihr-usecases

Retrieves a list of all Onboarding Templates recorded in the system. Supports pagination.

```APIDOC
## GET /v1/onboarding-templates

### Description
Retrieves a list of all Onboarding Templates. This endpoint supports pagination.

### Method
GET

### Endpoint
https://api.intellihr.io/v1/onboarding-templates

### Parameters
#### Query Parameters
- **limit** (integer) - Optional - The number of items to return per page.
- **page** (integer) - Optional - The page number for pagination.

### Headers
- **Authorization**: Bearer `<key>`

### Response
#### Success Response (200)
- **data** (array) - An array of onboarding template objects, each with 'id', 'name', and 'isEnabled' status.
- **metadata** (object) - Pagination metadata and links.

#### Response Example
```json
{
  "data": [
    {
      "id": "ot1a2b3c4-d5e6-f7a8-b9c0-d1e2f3a4b5c6",
      "name": "Standard Onboarding",
      "isEnabled": true
    },
    {
      "id": "ot7a8b9c0-d1e2-f3a4-b5c6-d7e8f9a0b1c2",
      "name": "Contractor Onboarding",
      "isEnabled": false
    }
  ],
  "metadata": {
    "pagination": {
      "total": 15,
      "limit": 10,
      "page": 1,
      "offset": 0,
      "next": "https://api.intellihr.io/v1/onboarding-templates?limit=10&page=2",
      "previous": null
    }
  }
}
```

#### Error Response (500)
- **error** (string) - An error message describing the internal server error.
```

--------------------------------

### List All Products

Source: https://developers.getknit.dev/docs/freshdesk-usecases

Retrieves a list of all products available in the system. Requires an API key in the 'yourapikey:X' header format.

```APIDOC
## GET /products

### Description
Retrieves a list of all products available in the system.

### Method
GET

### Endpoint
/products

### Parameters
#### Request Headers
- **yourapikey** (string) - Required - The API key for authentication.

### Response
#### Success Response (200)
- **products** (array) - An array of product objects, each containing id, name, description, created_at, and updated_at.

### Response Example
```json
{
  "products": [
    {
      "id": "prod_123",
      "name": "Example Product",
      "description": "A sample product",
      "created_at": "2023-01-01T12:00:00Z",
      "updated_at": "2023-01-01T12:00:00Z"
    }
  ]
}
```
```

--------------------------------

### GET /simpleschedule/timeoff_requests

Source: https://developers.getknit.dev/docs/ukgpro-hris-usecases

Retrieves all time off requests within a specified date range. Requires employee name or ID, and start and end dates for the range.

```APIDOC
## GET /simpleschedule/timeoff_requests

### Description
The Get Time Off Requests API endpoint allows users to obtain all time off requests within a specified date range. The API requires a GET request to the endpoint https://{hostname}/simpleschedule/timeoff_requests. It accepts query parameters such as 'emp_name' (optional), 'emp_id' (optional), 'from' (required, start range for requests), and 'to' (required, end range for requests). Additionally, a required header 'US-CUSTOMER-API-KEY' must be provided for authentication. The response includes a list of time off request entities, each containing details such as request ID, type, comment, days, status, and more.

### Method
GET

### Endpoint
https://{hostname}/simpleschedule/timeoff_requests

### Parameters
#### Query Parameters
- **emp_name** (string) - Optional - The name of the employee.
- **emp_id** (string) - Optional - The ID of the employee.
- **from** (string) - Required - The start date of the range for time off requests (YYYY-MM-DD).
- **to** (string) - Required - The end date of the range for time off requests (YYYY-MM-DD).

#### Request Headers
- **US-CUSTOMER-API-KEY** (string) - Required - API key for authentication.

### Response
#### Success Response (200)
- **requestId** (string) - The unique identifier for the time off request.
- **type** (string) - The type of time off (e.g., Vacation, Sick).
- **comment** (string) - Any comments associated with the request.
- **days** (number) - The number of days requested for time off.
- **status** (string) - The status of the request (e.g., Approved, Pending).

#### Response Example
```json
[
  {
    "requestId": "tof1001",
    "employee": {
      "emp_id": "emp789",
      "emp_name": "Jane Smith"
    },
    "type": "Vacation",
    "comment": "Annual leave",
    "days": 5,
    "status": "Approved",
    "startDate": "2023-07-10",
    "endDate": "2023-07-14"
  }
]
```
```

--------------------------------

### GET /timetracking/search

Source: https://developers.getknit.dev/docs/accounting-apps-api-capabilities

Allows users to search for projects and time entries based on various criteria. Supports filtering by completion status, update date, active status, billing status, and start date range.

```APIDOC
## GET /timetracking/search

### Description
Allows users to search for projects and time entries based on various criteria. Users can filter projects by completion status, update date, and active status. Time entries can be filtered by billing status and start date range.

### Method
GET

### Endpoint
/timetracking/search

### Parameters
#### Path Parameters
- **business_id** (string) - Required - The ID of the business

#### Query Parameters
- **project_status** (string) - Optional - Filter projects by status (e.g., 'completed', 'active')
- **project_updated_from** (string) - Optional - Filter projects updated from this date
- **time_entry_billing_status** (string) - Optional - Filter time entries by billing status
- **time_entry_started_from** (string) - Optional - Filter time entries started from this date
- **time_entry_started_to** (string) - Optional - Filter time entries started to this date

### Headers
- **Authorization** (string) - Required - Bearer token

### Response
#### Success Response (200)
- **projects** (array) - List of matching projects
- **time_entries** (array) - List of matching time entries

#### Response Example
```json
{
  "projects": [
    {
      "id": "proj_123",
      "name": "Project Alpha"
    }
  ],
  "time_entries": [
    {
      "id": "te_123",
      "start_time": "2023-10-26T10:00:00Z"
    }
  ]
}
```
```

--------------------------------

### List App Installation Requirements API

Source: https://developers.getknit.dev/docs/zendesk-ticketing-usecases

Retrieves a list of all requirements for a specific app installation. Requires app_installation_id as a path parameter and an Authorization header. Returns a list of requirements.

```APIDOC
## GET /api/v1/app_installations/{app_installation_id}/requirements

### Description
Retrieves a list of requirements for a specific app installation.

### Method
GET

### Endpoint
/api/v1/app_installations/{app_installation_id}/requirements

### Parameters
#### Path Parameters
- **app_installation_id** (string) - Required - The ID of the app installation.

#### Request Body
None

### Response
#### Success Response (200)
- **requirements** (array) - A list of requirements, each containing:
  - **account_id** (string) - The ID of the account.
  - **created_at** (string) - The creation timestamp.
  - **identifier** (string) - The identifier of the requirement.
  - **requirement_id** (string) - The ID of the requirement.
  - **requirement_type** (string) - The type of the requirement.
  - **updated_at** (string) - The update timestamp.

#### Response Example
{
  "requirements": [
    {
      "account_id": "acc_456",
      "created_at": "2023-01-01T12:00:00Z",
      "identifier": "req_ident_789",
      "requirement_id": "req_789",
      "requirement_type": "type_A",
      "updated_at": "2023-01-01T12:00:00Z"
    }
  ]
}
```

--------------------------------

### Set Up Integration for Company

Source: https://developers.getknit.dev/docs/smartrecruiters-ats-usecases

Sets up an integration for a company by saving and validating credentials with a partner.

```APIDOC
## POST /companies/{companyId}/setup_integration

### Description
This API endpoint is used to set up an integration for a company. It validates if the token has the client_credentials_write scope and if the company has given consent for integration with the partner. It saves the credentials sent by the partner and creates credentials for the current company, which are then sent back to the partner.

### Method
POST

### Endpoint
`/companies/{companyId}/setup_integration`

### Parameters
#### Path Parameters
- **companyId** (string) - Required - The identifier of the company.

#### Request Body
- **clientId** (string) - Required - The client ID provided by the partner.
- **clientSecret** (string) - Required - The client secret provided by the partner.

### Request Example
```json
{
  "clientId": "partner_client_123",
  "clientSecret": "partner_client_secret_abc"
}
```

### Response
#### Success Response (201)
- **companyCredentials** (object) - Credentials created for the company.
  - **clientId** (string) - The client ID for the company.
  - **clientSecret** (string) - The client secret for the company.

#### Error Response (e.g., 400, 401)
- **errorCode** (string) - Description of the error.
- **message** (string) - Detailed error message.
```

--------------------------------

### Get Single Time Entry API

Source: https://developers.getknit.dev/docs/accounting-apps-api-capabilities

Retrieves a specific time entry for a given business, requiring the business ID as a path parameter. Response includes notes, duration, project ID, client ID, logged status, start time, active status, and timer details.

```HTTP
GET https://api.freshbooks.com/time-tracking/account/<accountid>/time_entries/<timeentryid>
```

--------------------------------

### Get Requirements Install Status API

Source: https://developers.getknit.dev/docs/zendesk-ticketing-usecases-2

Allows administrators to check the status of an app installation job's requirements. Requires a 'job_id' as a path parameter.

```APIDOC
## GET /api/v2/apps/jobs/{job_id}/requirements/status

### Description
The 'Get Requirements Install Status' API endpoint allows administrators to check the status of an app installation job's requirements. The endpoint requires a 'job_id' as a path parameter, which is the ID of the job. The response includes details such as the job's ID, URL for status updates, total tasks, progress, status, message, and installation ID. The status can be 'queued', 'working', 'failed', 'completed', or 'killed'. If the status is 'completed', the installation is successful. If 'failed', the message will provide the reason. This endpoint is useful for tracking the progress and completion of app installations with requirements.

### Method
GET

### Endpoint
/api/v2/apps/jobs/{job_id}/requirements/status

### Parameters
#### Path Parameters
- **job_id** (integer) - Required - The ID of the app installation job.

### Response
#### Success Response (200)
- **job_id** (integer) - The ID of the job.
- **status_url** (string) - URL for status updates.
- **total_tasks** (integer) - Total number of tasks in the job.
- **progress** (integer) - Progress of the job in percentage.
- **status** (string) - The current status of the job ('queued', 'working', 'failed', 'completed', 'killed').
- **message** (string) - A message providing details about the job's status.
- **installation_id** (integer) - The ID of the app installation.

#### Response Example
```json
{
  "job_id": 123,
  "status_url": "/api/v2/apps/jobs/123/status",
  "total_tasks": 5,
  "progress": 75,
  "status": "working",
  "message": "Installing dependencies",
  "installation_id": 456
}
```
```

--------------------------------

### List All Products API

Source: https://developers.getknit.dev/docs/freshdesk-usecases-1

Retrieves a list of all products available in the system. Requires an API key in the 'yourapikey:X' format in the request headers.

```APIDOC
## GET /api/products

### Description
Retrieves a list of all products available in the system.

### Method
GET

### Endpoint
/api/products

### Parameters
#### Headers
- **Authorization** (string) - Required - API key in the format 'yourapikey:X'

### Response
#### Success Response (200)
- **products** (array) - An array of product objects, each containing id, name, description, created_at, and updated_at.

#### Response Example
{
  "products": [
    {
      "id": "prod_123",
      "name": "Product A",
      "description": "Description for Product A",
      "created_at": "2023-01-01T10:00:00Z",
      "updated_at": "2023-01-01T10:00:00Z"
    }
  ]
}
```

--------------------------------

### Create a Solution Article

Source: https://developers.getknit.dev/docs/freshdesk-usecases

The 'Create a Solution Article' API allows for the creation of new solution articles or translated versions of existing ones. It requires article ID and language code as path parameters, and a JSON body with title, description, and status. Authentication via API key is necessary.

```APIDOC
## POST /api/v2/solution_articles/{article_id}/{language_code}

### Description
Creates a new solution article or a translated version of an existing article in the knowledge base.

### Method
POST

### Endpoint
/api/v2/solution_articles/{article_id}/{language_code}

### Parameters
#### Path Parameters
- **article_id** (integer) - Required - The ID of the article to create or translate.
- **language_code** (string) - Required - The language code for the article (e.g., 'en', 'es').

#### Request Body
- **title** (string) - Required - The title of the solution article.
- **description** (string) - Required - The content of the solution article.
- **status** (string) - Required - The status of the article (e.g., 'draft', 'published').
- **seo_data** (object) - Optional - SEO-related data for the article.
  - **meta_title** (string) - Optional - The meta title for SEO.
  - **meta_description** (string) - Optional - The meta description for SEO.
- **tags** (array of strings) - Optional - Tags associated with the article.

### Request Example
```json
{
  "title": "How to Reset Your Password",
  "description": "Step-by-step guide to reset your password using the account portal.",
  "status": "published",
  "seo_data": {
    "meta_title": "Password Reset Guide",
    "meta_description": "Learn how to easily reset your account password."
  },
  "tags": ["password", "reset", "account"]
}
```

### Response
#### Success Response (201 Created)
- **id** (integer) - The unique identifier of the created or updated article.
- **title** (string) - The title of the article.
- **description** (string) - The content of the article.
- **status** (string) - The status of the article.
- **language_code** (string) - The language code of the article.
- **seo_data** (object) - SEO data associated with the article.
- **tags** (array of strings) - Tags associated with the article.
- **created_at** (string) - Timestamp of when the article was created.
- **updated_at** (string) - Timestamp of when the article was last updated.

#### Response Example
```json
{
  "id": 701,
  "title": "How to Reset Your Password",
  "description": "Step-by-step guide to reset your password using the account portal.",
  "status": "published",
  "language_code": "en",
  "seo_data": {
    "meta_title": "Password Reset Guide",
    "meta_description": "Learn how to easily reset your account password."
  },
  "tags": ["password", "reset", "account"],
  "created_at": "2023-10-27T14:00:00Z",
  "updated_at": "2023-10-27T14:00:00Z"
}
```
```

--------------------------------

### GET /contacts/{id}

Source: https://developers.getknit.dev/docs/intercom-usecases

The 'Get a contact' API allows you to fetch the details of a single contact from Intercom. It requires a GET request to the endpoint 'https://api.intercom.io/contacts/{id}', where '{id}' is the unique identifier of the contact.

```APIDOC
## GET /contacts/{id}

### Description
Fetches the details of a single contact from Intercom using their unique identifier.

### Method
GET

### Endpoint
`/contacts/{id}`

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the contact.

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **type** (string) - The type of the object (e.g., "contact").
- **id** (string) - The unique identifier of the contact.
- **name** (string) - The name of the contact.
- **email** (string) - The email address of the contact.
- **phone** (string) - The phone number of the contact.
- **role** (string) - The role of the contact (e.g., "user", "lead").
- **social_profiles** (object) - Contains social media profile information.

#### Response Example
{
  "type": "contact",
  "id": "12345",
  "name": "John Doe",
  "email": "john.doe@example.com",
  "phone": "+1234567890",
  "role": "user",
  "social_profiles": {
    "linkedin": {
      "url": "https://www.linkedin.com/in/johndoe"
    }
  }
}
```

--------------------------------

### Start Break in Open Shift

Source: https://developers.getknit.dev/docs/factorialhr-usecases

Starts a break in an open shift when attendance breaks are enabled. Requires the current time.

```APIDOC
## POST /api/shifts/start-break

### Description
This API endpoint is used to start a break in an open shift when attendance breaks are enabled. It requires a POST request to the specified URL with headers indicating the content type as 'application/json'. The request body must include the current time of the break ('now') as a required field, and optionally, the employee ID, observations, and time settings break configuration ID. The response returns a detailed JSON object containing information about the shift.

### Method
POST

### Endpoint
/api/shifts/start-break

### Parameters
#### Request Body
- **now** (string) - Required - The current time in ISO 8601 format (e.g., '2023-10-27T10:00:00Z').
- **employee_id** (integer) - Optional - The ID of the employee.
- **observations** (string) - Optional - Any observations related to the break.
- **time_settings_break_configuration_id** (integer) - Optional - The ID of the break configuration.

### Response
#### Success Response (200)
- **id** (integer) - The ID of the shift.
- **employee_id** (integer) - The ID of the employee associated with the shift.
- **date** (string) - The date of the shift.
- **reference_date** (string) - A reference date for the shift.
- **clock_in_time** (string) - The time the employee clocked in.
- **clock_out_time** (string) - The time the employee clocked out.
- **location** (object) - Details about the shift's location.
  - **id** (integer) - The ID of the location.
  - **name** (string) - The name of the location.

### Request Example
```json
{
  "now": "2023-10-27T10:00:00Z",
  "employee_id": 123,
  "observations": "Short break",
  "time_settings_break_configuration_id": 456
}
```

### Response Example
```json
{
  "id": 789,
  "employee_id": 123,
  "date": "2023-10-27",
  "reference_date": "2023-10-27",
  "clock_in_time": "2023-10-27T09:00:00Z",
  "clock_out_time": null,
  "location": {
    "id": 101,
    "name": "Office"
  }
}
```
```

--------------------------------

### POST /deals/{id}/products

Source: https://developers.getknit.dev/docs/pipedrive-usecases-2

Adds a product to a deal, creating a deal-product. Requires product ID, price, and quantity. Optional fields include tax, comments, and discount.

```APIDOC
## POST /deals/{id}/products

### Description
Adds a product to a deal, creating a new deal-product item. Requires product ID, item price, and quantity. Optional parameters include tax, comments, and discount.

### Method
POST

### Endpoint
`/deals/{id}/products`

#### Path Parameters
- **id** (integer) - Required - The ID of the deal to add the product to.

#### Request Body
- **product_id** (integer) - Required - The ID of the product to add.
- **price** (number) - Required - The price of the product for this deal.
- **quantity** (integer) - Required - The quantity of the product.
- **tax** (number) - Optional - The tax rate applied to the product.
- **comments** (string) - Optional - Comments related to the product in the deal.
- **discount** (number) - Optional - The discount applied to the product.
- **discount_type** (string) - Optional - The type of discount ('percentage' or 'amount').
- **billing_frequency_type** (string) - Optional - The type of billing frequency (e.g., 'monthly', 'yearly').
- **billing_frequency_amount** (integer) - Optional - The amount of the billing frequency.
- **start_date** (string) - Optional - The start date for recurring products.

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the operation was successful.
- **data** (object) - Contains details of the created deal-product.
  - **id** (integer) - The ID of the deal-product.
  - **deal_id** (integer) - The ID of the deal.
  - **product_id** (integer) - The ID of the product.
  - **sum** (string) - The total sum of the deal-product.
  - **tax** (number) - The tax applied.
  - **discount** (number) - The discount applied.
```

--------------------------------

### Install Knit LangChain SDK

Source: https://developers.getknit.dev/docs/knit-ai-langchain-sdk

Installs the Knit LangChain SDK using pip. This is the first step to integrating Knit with your LangChain projects.

```powershell
pip install knit-langchain
```

--------------------------------

### Applicant Onboarding API

Source: https://developers.getknit.dev/docs/adp-run-usecases

Onboards applicants by submitting their personal, job offer, and tax profile information. Accepts a POST request with comprehensive applicant and job offer data.

```APIDOC
## POST /api/applicant-onboarding

### Description
The Applicant Onboarding API is used to onboard applicants by submitting their personal, job offer, and tax profile information. The API accepts a POST request with a JSON body containing details such as service category code, event name code, originator and actor associate OIDs, job requisition and offer item IDs, event reason and status codes, effective date, and applicant personal details.

### Method
POST

### Endpoint
/api/applicant-onboarding

### Parameters
#### Request Body
- **serviceCategoryCode** (string) - Required - The code for the service category.
- **eventNameCode** (string) - Required - The code for the event name.
- **originatorOID** (string) - Required - The originator's Object ID.
- **actorOID** (string) - Required - The actor's Object ID.
- **jobRequisitionID** (string) - Required - The ID of the job requisition.
- **jobOfferItemID** (string) - Required - The ID of the job offer item.
- **eventReasonCode** (string) - Required - The reason code for the event.
- **eventStatusCode** (string) - Required - The status code for the event.
- **effectiveDate** (string) - Required - The effective date of the onboarding.
- **applicantPersonalDetail** (object) - Required - Personal details of the applicant.
  - **genderCode** (string) - Required - Gender of the applicant.
  - **personIdentification** (array) - Required - List of person identification details.
  - **legalName** (object) - Required - Legal name of the applicant.
  - **preferredName** (string) - Optional - Preferred name of the applicant.
  - **address** (object) - Required - Address of the applicant.
  - **communicationDetail** (array) - Required - Communication details of the applicant.
  - **birthDate** (string) - Required - Birth date of the applicant.
- **jobOfferDetail** (object) - Required - Details of the job offer.
  - **expectedStartDate** (string) - Required - Expected start date.
  - **compensation** (object) - Required - Compensation details.
  - **workerType** (string) - Required - Type of worker.
  - **workLevel** (string) - Required - Work level.
  - **standardHours** (number) - Required - Standard hours.
  - **homeWorkLocation** (object) - Required - Home work location details.

### Request Example
```json
{
  "serviceCategoryCode": "HR",
  "eventNameCode": "APPLICANT_ONBOARDING",
  "originatorOID": "originator_oid_1",
  "actorOID": "actor_oid_1",
  "jobRequisitionID": "job_req_id_1",
  "jobOfferItemID": "job_offer_item_id_1",
  "eventReasonCode": "INIT",
  "eventStatusCode": "ACTIVE",
  "effectiveDate": "2023-10-27",
  "applicantPersonalDetail": {
    "genderCode": "M",
    "personIdentification": [
      {
        "id": "national_id_1",
        "typeCode": "NATIONAL_ID"
      }
    ],
    "legalName": {
      "firstName": "John",
      "lastName": "Doe"
    },
    "preferredName": "Johnny",
    "address": {
      "streetName": "123 Main St",
      "cityName": "Anytown"
    },
    "communicationDetail": [
      {
        "typeCode": "EMAIL",
        "value": "john.doe@example.com"
      }
    ],
    "birthDate": "1990-01-01"
  },
  "jobOfferDetail": {
    "expectedStartDate": "2023-11-15",
    "compensation": {
      "amount": 50000,
      "currency": "USD"
    },
    "workerType": "CONTRACTOR",
    "workLevel": "L3",
    "standardHours": 40,
    "homeWorkLocation": {
      "associatedOID": "location_oid_1"
    }
  }
}
```

### Response
#### Success Response (200)
- **confirmation** (string) - Confirmation message of the onboarding process.
- **applicant** (object) - Details of the onboarded applicant.
- **jobOffer** (object) - Details of the associated job offer.

#### Response Example
```json
{
  "confirmation": "Applicant onboarding successful.",
  "applicant": {
    "associateOID": "applicant_oid_1"
  },
  "jobOffer": {
    "jobOfferID": "job_offer_id_1"
  }
}
```
```

--------------------------------

### POST /v2/products

Source: https://developers.getknit.dev/docs/zendesk-crm-usecases

The 'Create a product' API allows an account administrator to create a new product in the system. The request must include specific headers and a request body with mandatory and optional fields.

```APIDOC
## POST /v2/products

### Description
Allows an account administrator to create a new product in the system.

### Method
POST

### Endpoint
/v2/products

### Parameters
#### Headers
- **Accept** (string) - Required
- **Content-Type** (string) - Required
- **Authorization** (string) - Required

#### Request Body
- **data** (object) - Required
  - **name** (string) - Required
  - **prices** (array) - Required
  - **sku** (string) - Optional
  - **description** (string) - Optional
  - **active** (boolean) - Optional
  - **cost** (number) - Optional
  - **cost_currency** (string) - Optional
  - **max_discount** (number) - Optional
  - **max_markup** (number) - Optional

### Request Example
```json
{
  "data": {
    "name": "New Product",
    "prices": [
      {
        "amount": 100,
        "currency": "USD"
      }
    ],
    "sku": "NP-001",
    "description": "This is a new product.",
    "active": true,
    "cost": 50,
    "cost_currency": "USD",
    "max_discount": 0.1,
    "max_markup": 0.5
  }
}
```

### Response
#### Success Response (200)
- **id** (string) - The unique identifier of the created product.
- **name** (string) - The name of the product.
- **sku** (string) - The SKU of the product.
- **description** (string) - The description of the product.
- **prices** (array) - An array of price objects.
- **max_discount** (number) - The maximum discount allowed for the product.
- **max_markup** (number) - The maximum markup allowed for the product.
- **cost** (number) - The cost of the product.
- **cost_currency** (string) - The currency of the product cost.

#### Response Example
```json
{
  "id": "prod_123",
  "name": "New Product",
  "sku": "NP-001",
  "description": "This is a new product.",
  "prices": [
    {
      "amount": 100,
      "currency": "USD"
    }
  ],
  "max_discount": 0.1,
  "max_markup": 0.5,
  "cost": 50,
  "cost_currency": "USD"
}
```
```

--------------------------------

### Get Employee Rates by Start Date

Source: https://developers.getknit.dev/docs/fingercheck-usecases

Returns all employee rates starting from a specified date. Requires a 'startDate' query parameter. Returns a JSON array of employee rate objects.

```APIDOC
## GET /employees/rates

### Description
The 'Get Employee Rates by Start Date' API returns all employee rates starting from a specified date.

### Method
GET

### Endpoint
/employees/rates

### Parameters
#### Path Parameters
None

#### Query Parameters
- **startDate** (string) - Required - The start date for retrieving rates (YYYY-MM-DD).

### Request Example
```
GET /employees/rates?startDate=2023-01-01
```

### Response
#### Success Response (200)
- **EmployeeID** (integer) - The employee's unique identifier.
- **RateCode** (string) - The code for the pay rate.
- **StartDate** (string) - The date when the pay rate becomes effective (YYYY-MM-DD).
- **Rate** (number) - The employee's pay rate.

#### Response Example
```json
[
  {
    "EmployeeID": 101,
    "RateCode": "HOURLY",
    "StartDate": "2023-01-01",
    "Rate": 25.50
  },
  {
    "EmployeeID": 102,
    "RateCode": "SALARY",
    "StartDate": "2023-03-15",
    "Rate": 60000.00
  }
]
```
```

--------------------------------

### Get User Identity and Details

Source: https://developers.getknit.dev/docs/hris-apps-api-capabilities

Retrieves the identity and user details of the authenticated user. Makes a GET request to the /whoami endpoint. Supports optional versioning and company GUID headers.

```APIDOC
## GET /whoami

### Description
The 'Get User Identity and Details' API endpoint allows you to retrieve the identity and user details of the authenticated user. It requires a GET request to the URL 'https://api.7shifts.com/v2/whoami'. The request can include optional headers such as 'x-api-version' for specifying the API version and 'x-company-guid' for the company GUID.

### Method
GET

### Endpoint
`/whoami`

### Parameters
#### Headers
- **x-api-version** (string) - Optional - Specifies the API version.
- **x-company-guid** (string) - Optional - The GUID of the company.

### Response
#### Success Response (200)
- **identity_id** (integer) - The ID of the user's identity.
- **user** (object) - An object containing the user's details.
  - **user_id** (integer) - The user's ID.
  - **company_id** (integer) - The ID of the company.
  - **first_name** (string) - The user's first name.
  - **last_name** (string) - The user's last name.
  - **email** (string) - The user's email address.
  - **mobile_number** (string) - The user's mobile number.
  - **invite_status** (string) - The status of the user's invitation.
  - **is_active** (boolean) - Indicates if the user account is active.
  - **role_type** (string) - The type of role the user has.

#### Response Example
```json
{
  "identity_id": 987,
  "user": {
    "user_id": 123,
    "company_id": 456,
    "first_name": "Jane",
    "last_name": "Smith",
    "email": "jane.smith@example.com",
    "mobile_number": "555-987-6543",
    "invite_status": "accepted",
    "is_active": true,
    "role_type": "manager"
  }
}
```
```

--------------------------------

### Set Up Integration for Company

Source: https://developers.getknit.dev/docs/smartrecruiters-ats-usecases-1

Sets up an integration for a company by saving and exchanging credentials.

```APIDOC
## POST /companies/{companyId}/setup_integration

### Description
This API endpoint is used to set up an integration for a company. It validates if the token has the client_credentials_write scope and if the company has given consent for integration with the partner. It saves the credentials sent by the partner and creates credentials for the current company, which are then sent back to the partner.

### Method
POST

### Endpoint
/companies/{companyId}/setup_integration

### Parameters
#### Path Parameters
- **companyId** (string) - Required - The ID of the company.

#### Request Body
- **clientId** (string) - Required - The client ID provided by the partner.
- **clientSecret** (string) - Required - The client secret provided by the partner.

### Request Example
```json
{
  "clientId": "partner_client_id",
  "clientSecret": "partner_client_secret"
}
```

### Response
#### Success Response (200)
Indicates successful integration setup. Response may contain newly generated credentials.

#### Error Response
- **400**: Bad Request (Invalid request body or missing required fields)
- **401**: Unauthorized (Missing or invalid token, or insufficient scopes)
- **409**: Conflict (Integration already exists or company has not given consent)
```

--------------------------------

### POST /websites/developers_getknit_dev/position/{position_id}/candidate/resume

Source: https://developers.getknit.dev/docs/breezy-usecases

Uploads and parses a resume file to create a candidate. Requires an API key for authorization.

```APIDOC
## POST /websites/developers_getknit_dev/position/{position_id}/candidate/resume

### Description
This API endpoint allows users to upload and parse a resume file to create a new candidate in the Breezy HR system. The request requires an API key for authorization and includes path parameters for the company and position IDs. Optional query parameters allow specifying the pipeline stage and whether stage actions should be executed. The request body can include candidate details such as name, email, phone number, address, summary, tags, origin, source, work history, education, custom attributes, and a cover letter. The response can be a successful candidate object, a partial candidate creation notice, or various error messages depending on the outcome.

### Method
POST

### Endpoint
/websites/developers_getknit_dev/position/{position_id}/candidate/resume

### Parameters
#### Path Parameters
- **company_id** (string) - Required - The ID of the company.
- **position_id** (string) - Required - The ID of the position.

#### Query Parameters
- **pipeline_stage** (string) - Optional - The pipeline stage to assign the candidate to.
- **execute_stage_actions** (boolean) - Optional - Whether to execute stage actions.

#### Request Body
- **resume_file** (file) - Required - The resume file to upload.
- **name** (string) - Optional - The candidate's full name.
- **email** (string) - Optional - The candidate's email address.
- **phone_number** (string) - Optional - The candidate's phone number.
- **address** (string) - Optional - The candidate's address.
- **summary** (string) - Optional - A summary of the candidate.
- **tags** (array) - Optional - Tags to associate with the candidate.
- **origin** (string) - Optional - The origin of the candidate.
- **source** (string) - Optional - The source of the candidate.
- **work_history** (array) - Optional - A list of work history entries.
- **education** (array) - Optional - A list of education entries.
- **custom_attributes** (object) - Optional - Custom attributes for the candidate.
- **cover_letter** (string) - Optional - The candidate's cover letter.

### Response
#### Success Response (200 or 201)
- **candidate** (object) - The created candidate object.

#### Response Example
```json
{
  "candidate": {
    "id": "cand_456",
    "name": "Jane Smith",
    "email": "jane.smith@example.com"
  }
}
```

#### Error Responses
- Various error codes (e.g., 400, 401, 500) for invalid input or server errors.
```

--------------------------------

### Get Companies Information API

Source: https://developers.getknit.dev/docs/accounting-apps-api-capabilities

Retrieves detailed information about the authenticated user and their associated business entities. Requires GET request with specific headers.

```http
GET https://api.freshbooks.com/auth/api/v1/users/me
Authorization: Bearer YOUR_ACCESS_TOKEN
Api-Version: alpha
Content-Type: application/json

Response:
{
  "response": {
    "id": "1",
    "profile": {
      "first_name": "John",
      "last_name": "Doe"
    },
    "email": "john.doe@example.com",
    "business_memberships": [
      {
        "business_id": "101",
        "business_name": "My Business"
      }
    ]
  }
}
```

--------------------------------

### Install Knit LangGraph SDK

Source: https://developers.getknit.dev/docs/knit-ai-langgraph-sdk

Installs the Knit LangGraph SDK using pip. This is the first step to begin integrating AI agents with SaaS applications.

```powershell
pip install knit-langgraph

```

--------------------------------

### Applicant Onboard API

Source: https://developers.getknit.dev/docs/adp-run-usecases

Initiates the onboarding process for an applicant. Requires a POST request with event details and authorization headers.

```APIDOC
## POST /events/staffing/v1/applicant.onboard

### Description
The Applicant Onboard API is used to initiate the onboarding process for an applicant. It requires a POST request to the endpoint '/events/staffing/v1/applicant.onboard' with a JSON body containing event details such as service category, event name, originator, actor, and data related to the applicant and job offer.

### Method
POST

### Endpoint
/events/staffing/v1/applicant.onboard

### Parameters
#### Request Body
- **serviceCategoryCode** (string) - Required - The code for the service category.
- **eventNameCode** (string) - Required - The code for the event name.
- **originatorOID** (string) - Required - The originator's Object ID.
- **actorOID** (string) - Required - The actor's Object ID.
- **data** (object) - Required - Contains applicant and job offer data.
  - **applicant** (object) - Required - Applicant details.
  - **jobOffer** (object) - Required - Job offer details.

### Request Example
```json
{
  "serviceCategoryCode": "STAFFING",
  "eventNameCode": "APPLICANT_ONBOARD",
  "originatorOID": "12345",
  "actorOID": "67890",
  "data": {
    "applicant": {
      "associateOID": "applicant_oid_1"
    },
    "jobOffer": {
      "jobOfferID": "job_offer_id_1"
    }
  }
}
```

### Response
#### Success Response (200)
- **eventStatus** (string) - The status of the event.
- **effectiveDate** (string) - The effective date of the event.
- **applicant** (object) - Details of the applicant.
- **jobOffer** (object) - Details of the job offer.

#### Response Example
```json
{
  "eventStatus": "SUCCESS",
  "effectiveDate": "2023-10-27",
  "applicant": {
    "associateOID": "applicant_oid_1"
  },
  "jobOffer": {
    "jobOfferID": "job_offer_id_1"
  }
}
```
```

--------------------------------

### Get Onboarding Wizards Information API

Source: https://developers.getknit.dev/docs/hibob-usecases

Retrieves information about onboarding wizards available for users.

```APIDOC
## GET /api/onboarding/wizards

### Description
This API endpoint retrieves information about onboarding wizards. It returns a list of wizards, each with a unique ID and name. The request requires an 'accept' header specifying 'application/json'. The response includes a JSON object with an array of wizards, where each wizard has an 'id' and 'name'. This API is intended for use by service-type users.

### Method
GET

### Endpoint
/api/onboarding/wizards

### Headers
- **Accept** (string) - Required - Must be 'application/json'.

### Response
#### Success Response (200)
- **wizards** (array) - A list of onboarding wizards.
  - **id** (string) - The unique identifier for the wizard.
  - **name** (string) - The name of the wizard.

#### Response Example
```json
{
  "wizards": [
    {
      "id": "wiz001",
      "name": "New Hire Onboarding"
    },
    {
      "id": "wiz002",
      "name": "Role Change Process"
    }
  ]
}
```
```