# Partner API

API for payroll providers to integrate with Aslan. This API enables payroll providers to manage company registrations and employee onboarding for Aslan services.

Version: 0.0.1

## Servers

```
https://uat.partner.aslan.io/api/v1
```

```
https://partner.aslan.io/api/v1
```

## Security

### partnerAdminAuth

Partner admin authentication using Bearer token with HMAC signature.

Format: `Bearer <token>:<signature>`

The token and signature are separated by a colon. The signature is generated using HMAC-SHA256
based on the request details including the timestamp provided in the X-Aslan-Timestamp header.


Type: http
Scheme: bearer
Bearer Format: token:signature

## Download OpenAPI description

[Partner API](https://developer.aslan.io/_bundle/openapi.yaml)

## Companies

Manage company registrations and details for Aslan enrollment

### Retrieve all companies

 - [GET /companies](https://developer.aslan.io/openapi/companies/getallcompanies.md): Returns a paginated list of all companies registered with Aslan. This endpoint provides an overview of all employer clients in the system with support for filtering and sorting.

### Retrieve company details

 - [GET /companies/{companyId}](https://developer.aslan.io/openapi/companies/getcompanybyid.md): Returns detailed information for a specific company, including registration status, company information, and audit trail.

### Update company information

 - [PUT /companies/{companyId}](https://developer.aslan.io/openapi/companies/updatecompanybyid.md): Updates company details such as name and address. This endpoint is typically used when company information changes in the payroll system.

## Users

Manage employee records and their eligibility for earned wage access

### Retrieve all employees for a company

 - [GET /companies/{companyId}/users](https://developer.aslan.io/openapi/users/getallusers.md): Returns a paginated, summarized list of all employees registered under a specific company with Aslan. This endpoint provides essential employee information without sensitive or detailed fields. Supports filtering by status, role, and date ranges, plus sorting capabilities.

### Create new employee

 - [POST /companies/{companyId}/users](https://developer.aslan.io/openapi/users/createuser.md): Creates a new employee record in the system. This endpoint does NOT automatically send an invitation. To send an invitation, use the send invitation endpoint after creating the employee. Only employees with the EMPLOYEE role can be created through this endpoint.

### Retrieve complete employee details

 - [GET /companies/{companyId}/users/{userId}](https://developer.aslan.io/openapi/users/getuserbyid.md): Returns comprehensive information for a specific employee, including employment status, salary information, allowances, verification status, salary history, and audit trail. This endpoint provides the full employee record.

### Update employee information

 - [PUT /companies/{companyId}/users/{userId}](https://developer.aslan.io/openapi/users/updateuserbyid.md): Updates employee details including status, contact information, role, salary, and employment dates. Used to synchronize employee data from the payroll system with Aslan.

### Send invitations to employees

 - [POST /companies/{companyId}/users/invite](https://developer.aslan.io/openapi/users/sendinvitations.md): Sends invitation emails to one or more employees to join Aslan. This endpoint can be called multiple times - if an employee has already been invited, it will resend the invitation. Can be used for employees in CREATED or INVITED status. Supports batch invitations for multiple employees.

## Reports

Access spend reports and transaction data for payroll deductions

### Retrieve company deductions report summary

 - [GET /deductions/reports/company/{reportId}](https://developer.aslan.io/openapi/reports/getcompanydeductionsreport.md): Returns a summary of all employee deductions for a specific company report. This report includes deduction amounts for all employees within the specified date range, providing an overview for payroll processing.

### Retrieve employee deduction details

 - [GET /deductions/reports/employee/{reportId}](https://developer.aslan.io/openapi/reports/getemployeedeductionsreport.md): Returns detailed deduction information for a specific employee report. This includes the deduction amount, report period, and employee identifier for individual payroll processing.