Employees, Payroll And Teams

The Veend Expense Product is designed for Companies to manage employees, teams and payroll on VeendHQ.

ORG_BASE_URL

The BASE_URL for all Team and Employee request on Test Environment is https://stipendstagingapi.veendhq.com and on Live Environment - https://api.stipend.co

Employees

Create and employees on Veend Platform with the Employees API.

Add Employee

To add an employee to your Veend Business Account, the employee must have a user account registered as an employee type.

Registers a new user as an Employee

POST {{BASE_URL}}/register

Request Body

Name
Type
Description

type*

employee

Sets the account type to employee

If you already have the employee user account, you can add the employee to your business.

POST {{ORG_BASE_URL}}/register

Request Body

Name
Type
Description

_id*

String

Employee Id return in the response data above

employer*

String

Veend Business User Id

role*

employee

one of these values approver, disburser, employee or admin

roles

employee

must be same value as the role field

type*

employee

Sets the account type to employee

Get All Employees

Get all employees

GET {{ORG_BASE_URL}}/myEmployees/users?populate=addressBooks

Query Parameters

Name
Type
Description

populate

addressBooks

Get Employee

Get an employee detail

GET {{ORG_BASE_URL}}/users/{{USER_ID}}?populate=addressBooks

Query Parameters

Name
Type
Description

populate

addressBooks

Update Employee Detail

Update an Employee Detail

PATCH {{ORG_BASE_URL}}/updateProfile/users/{{employeeId}}

Request Body

Name
Type
Description

firstName

String

lastName

String

phoneNumber

String

employeeDetails

dateOfBirth

String

address

String

addressState

String

picture

String

email

String

Employee Details on Payload

Payroll

Create and manage payrolls to schedule and disburse salary

Create Payroll

Create Payroll

POST {{ORG_BASE_URL}}/payrolls

Get Payrolls

GET {{ORG_BASE_URL}}/payrolls

Disburse Payroll

PATCH {{BASE_URL}}/payrolls/{{PAYROLL_ID}}

Deduct Salary

Deduct amount from salary for a list of employees.

PATCH {{BASE_URL}}/deduct/payrolls/{{PAYROLL_ID}}

Teams

Create teams, assign your employees to teams on Veend Platform with the Teams API.

Create a Team

Create a Team

POST {{ORG_BASE_URL}}/teams?accountId={{ACCOUNT_ID}}

Request Body

Name
Type
Description

name*

Design

Name of the team

Delete a Team

Delete a Team

DELETE {{ORG_BASE_URL}}/teams/{{TEAM_ID}}?accountId={{ACCOUNT_ID}}

Request Body

Name
Type
Description

name*

Design

The name of the team to delete

Assign Employee to a Team

Assign an employee to a team

POST {{BASE_URL}}/teams/{{TEAM_ID}}/assignEmployeeToTeam?accountId={{ACCOUNT_ID}}

Request Body

Name
Type
Description

teamId*

Team _id

employeeId*

String

Employee _id

PreviousInvoicesNextCards

Last updated