Skip to content

Employees

Empleados asociados a miembros de empresa con datos laborales.

POST /api/companies/{companyId}/employees/v1

Section titled “POST /api/companies/{companyId}/employees/v1”

Crear empleado

NombreTipoRequeridoDescripción
companyIdstring
{
"memberId": "00000000-0000-0000-0000-000000000000",
"position": "Cajero",
"department": "Ventas",
"startDate": "2024-01-15"
}

Empleado creado exitosamente

{
"id": "00000000-0000-0000-0000-000000000000",
"memberId": "00000000-0000-0000-0000-000000000000",
"position": "position",
"department": "department",
"startDate": "2024-01-15",
"status": "ACTIVE",
"createdAt": "2024-01-15T10:00:00Z",
"updatedAt": "2024-01-15T10:00:00Z"
}

GET /api/companies/{companyId}/employees/v1

Section titled “GET /api/companies/{companyId}/employees/v1”

Listar empleados activos

NombreTipoRequeridoDescripción
companyIdstring

Lista de empleados

{
"id": "00000000-0000-0000-0000-000000000000",
"memberId": "00000000-0000-0000-0000-000000000000",
"position": "position",
"department": "department",
"startDate": "2024-01-15",
"status": "ACTIVE",
"createdAt": "2024-01-15T10:00:00Z",
"updatedAt": "2024-01-15T10:00:00Z"
}

GET /api/companies/{companyId}/employees/v1/{id}

Section titled “GET /api/companies/{companyId}/employees/v1/{id}”

Obtener empleado por ID

NombreTipoRequeridoDescripción
companyIdstring
idstring

Datos del empleado

{
"id": "00000000-0000-0000-0000-000000000000",
"memberId": "00000000-0000-0000-0000-000000000000",
"position": "position",
"department": "department",
"startDate": "2024-01-15",
"status": "ACTIVE",
"createdAt": "2024-01-15T10:00:00Z",
"updatedAt": "2024-01-15T10:00:00Z"
}

PATCH /api/companies/{companyId}/employees/v1/{id}

Section titled “PATCH /api/companies/{companyId}/employees/v1/{id}”

Actualizar empleado

NombreTipoRequeridoDescripción
companyIdstring
idstring
{
"position": "position",
"department": "department",
"startDate": "2024-01-15"
}

Empleado actualizado

{
"id": "00000000-0000-0000-0000-000000000000",
"memberId": "00000000-0000-0000-0000-000000000000",
"position": "position",
"department": "department",
"startDate": "2024-01-15",
"status": "ACTIVE",
"createdAt": "2024-01-15T10:00:00Z",
"updatedAt": "2024-01-15T10:00:00Z"
}

DELETE /api/companies/{companyId}/employees/v1/{id}

Section titled “DELETE /api/companies/{companyId}/employees/v1/{id}”

Dar de baja empleado

NombreTipoRequeridoDescripción
companyIdstring
idstring

Empleado dado de baja exitosamente


CampoTipoRequeridoDescripción
memberIdstring (uuid)ID del CompanyMember
positionstring ej: “Cajero”
departmentstring ej: “Ventas”
startDatestring (date) ej: “2024-01-15”
CampoTipoRequeridoDescripción
idstring (uuid)
memberIdstring (uuid)
positionstring
departmentstring
startDatestring (date)
statusEmploymentStatus
createdAtstring (date-time)
updatedAtstring (date-time)
CampoTipoRequeridoDescripción
positionstring
departmentstring
startDatestring (date)