Skip to content

Partner API (0.0.1)

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

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
Mock server
https://developer.aslan.io/_mock/openapi/
https://uat.partner.aslan.io/api/v1/
https://partner.aslan.io/api/v1/

Companies

Manage company registrations and details for Aslan enrollment

Operations

Users

Manage employee records and their eligibility for earned wage access

Operations

Reports

Access spend reports and transaction data for payroll deductions

Operations

Retrieve company deductions report summary

Request

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.

Security
partnerAdminAuth
Path
reportIdstring(uuid)required

The unique identifier for the company report

Headers
X-Aslan-Timestampinteger(int64)required

Unix epoch timestamp of the request in seconds.

Example: 1730000000
curl -i -X GET \
  'https://developer.aslan.io/_mock/openapi/deductions/reports/company/{reportId}' \
  -H 'Authorization: Bearer <YOUR_token:signature_HERE>' \
  -H 'X-Aslan-Timestamp: 1730000000'

Responses

Successfully retrieved company deductions report summary

Bodyapplication/json
companyIdstring(uuid)required

Unique identifier of the company

Example: "a3f2e1d0-5c4b-4a3e-9f8e-7d6c5b4a3e2f"
reportIdstring(uuid)required

Unique identifier for the report

Example: "a1b2c3d4-e5f6-4a8b-9c0d-e1f2a3b4c5d6"
employeeDeductionsReportsArray of objects(EmployeeDeductionReportResponse)required

List of employee deductions within this report period

employeeDeductionsReports[].​employeeIdstring(uuid)required

Unique identifier of the employee

Example: "f7e6d5c4-b3a2-4918-8e7d-6c5b4a3f2e1d"
employeeDeductionsReports[].​reportIdstring(uuid)required

Unique identifier for the report

Example: "a1b2c3d4-e5f6-4a8b-9c0d-e1f2a3b4c5d6"
employeeDeductionsReports[].​fromstring(date)required

Start date of the deduction period

Example: "2024-10-01"
employeeDeductionsReports[].​tostring(date)required

End date of the deduction period

Example: "2024-10-31"
employeeDeductionsReports[].​deductionAmountnumber(decimal)required

Total deduction amount in GBP to be processed through payroll

Example: 862.75
Response
application/json
{
  "companyId": "a3f2e1d0-5c4b-4a3e-9f8e-7d6c5b4a3e2f",
  "reportId": "a1b2c3d4-e5f6-4a8b-9c0d-e1f2a3b4c5d6",
  "employeeDeductionsReports": [
    { … }
  ]
}

Retrieve employee deduction details

Request

Returns detailed deduction information for a specific employee report. This includes the deduction amount, report period, and employee identifier for individual payroll processing.

Security
partnerAdminAuth
Path
reportIdstring(uuid)required

The unique identifier for the employee report

Headers
X-Aslan-Timestampinteger(int64)required

Unix epoch timestamp of the request in seconds.

Example: 1730000000
curl -i -X GET \
  'https://developer.aslan.io/_mock/openapi/deductions/reports/employee/{reportId}' \
  -H 'Authorization: Bearer <YOUR_token:signature_HERE>' \
  -H 'X-Aslan-Timestamp: 1730000000'

Responses

Successfully retrieved employee deduction details

Bodyapplication/json
employeeIdstring(uuid)required

Unique identifier of the employee

Example: "f7e6d5c4-b3a2-4918-8e7d-6c5b4a3f2e1d"
reportIdstring(uuid)required

Unique identifier for the report

Example: "a1b2c3d4-e5f6-4a8b-9c0d-e1f2a3b4c5d6"
fromstring(date)required

Start date of the deduction period

Example: "2024-10-01"
tostring(date)required

End date of the deduction period

Example: "2024-10-31"
deductionAmountnumber(decimal)required

Total deduction amount in GBP to be processed through payroll

Example: 862.75
Response
application/json
{
  "employeeId": "f7e6d5c4-b3a2-4918-8e7d-6c5b4a3f2e1d",
  "reportId": "a1b2c3d4-e5f6-4a8b-9c0d-e1f2a3b4c5d6",
  "from": "2024-10-01",
  "to": "2024-10-31",
  "deductionAmount": 862.75
}