Empresas / Usuarios

El usuario de rol administrador puede listar, crear y editar empresas y usuarios.

Modelo Empresa

El modelo empresa tiene las siguientes propiedades:

Propiedades

  • Name
    ruc
    Type
    string
    Description

    Número de RUC

  • Name
    bussiness_name
    Type
    string
    Description

    Nombre

  • Name
    address
    Type
    string
    Description

    Dirección

  • Name
    workers_amount
    Type
    number
    Description

    Cantidad de trabajadores

  • Name
    license.max_records
    Type
    number
    Description

    Máximo de expedientes permitidos

  • Name
    license.cost
    Type
    number
    Description

    Costo total de la licencia

  • Name
    license.unit_cost
    Type
    number
    Description

    Costo por expediente

  • Name
    license.date
    Type
    date
    Description

    Fecha de vencimiento de la licencia

  • Name
    license_history
    Type
    array
    Description

    Historial de cambios de la licencia

Modelo Usuario

El modelo usuario tiene las siguientes propiedades:

Propiedades

  • Name
    dni
    Type
    string
    Description

    Documento de identidad

  • Name
    first_name
    Type
    string
    Description

    Nombre completo

  • Name
    last_name_p
    Type
    string
    Description

    Apellido paterno

  • Name
    last_name_m
    Type
    string
    Description

    Apellido materno

  • Name
    email
    Type
    string
    Description

    Correo

  • Name
    phone_number
    Type
    string
    Description

    Celular

  • Name
    position
    Type
    string
    Description

    Rol del usuario. Puede ser user, admin o super_admin.

  • Name
    company
    Type
    string
    Description

    Identificador de la empresa asociada al usuario.

  • Name
    created_at
    Type
    date
    Description

    Fecha de creación del usuario.

GET/users/companies

Listar empresas

Esta ruta le permite obtener una lista de las empresas registradas en el sistema.

Respuesta

{
  "items": [
    {
      "_id": "WAz8eIbvDR60rouK",
      "bussiness_name": "EMPRESA",
      "ruc": "12345678901",
      "address": "DIRECCION",
      "workers_amount": 100,
      "yearly_record_count": 50,
      "license": {
        "max_records": 100,
        "cost": 1000,
        "unit_cost": 10,
        "date": "2024-01-25T00:00:00.000Z"
      },
      "license_history": [
        {
          "max_records": 100,
          "cost": 1000,
          "unit_cost": 10,
          "date": "2024-01-25T00:00:00.000Z",
          "updated_at": "2023-05-25T00:00:00.000Z"
        }
        // ...
      ],
      "created_at": "2023-01-25T00:00:00.000Z"
    },
    {
      "_id": "hSIhXBhNe8X1d8Et"
      // ...
    }
  ]
}
POST/users/list

Listar usuarios

Esta ruta le permite obtener una lista de los usuarios registrados en el sistema. Se puede filtrar por cualquier atributo del modelo usuario y empresa.

Esta ruta tiene habilitadas las opciones de paginación, filtrado y ordenamiento. Para más información, revisa la documentación de cada una de estas opciones.

Pedido

POST
/users/alerts
  {
    "pagination": {
      // ...
    },
    "filter": {
      // ...
    },
    "sort": {
      // ...
    }
  }

Respuesta

{
  "items": [
    {
      "_id": "WAz8eIbvDR60rouK",
      "first_name": "USUARIO",
      "company": {
        "_id": "WAz8eIbvDR60rouK",
        "bussiness_name": "EMPRESA",
        "ruc": "12345678901",
        "address": "DIRECCION",
        "workers_amount": 100,
        "license": {
          "max_records": 100,
          "cost": 1000,
          "unit_cost": 10,
          "date": "2024-01-25T00:00:00.000Z"
        }
      },
      "created_at": "2023-01-25T00:00:00.000Z"
      // ...
    },
    {
      "_id": "hSIhXBhNe8X1d8Et"
      // ...
    }
  ]
}
POST/users

Crear empresa y usuario

Esta ruta permite crear una empresa y un usuario asociado a ella. El usuario creado será de rol admin.

Atributos requeridos

  • Name
    ruc
    Type
    string
    Description

    Número de RUC

  • Name
    bussiness_name
    Type
    string
    Description

    Nombre

  • Name
    address
    Type
    string
    Description

    Dirección

  • Name
    workers_amount
    Type
    number
    Description

    Cantidad de trabajadores

  • Name
    max_records
    Type
    string
    Description

    Máximo de expedientes permitidos

  • Name
    cost
    Type
    string
    Description

    Costo total de la licencia

  • Name
    unit_cost
    Type
    string
    Description

    Costo por expediente

  • Name
    date
    Type
    date
    Description

    Fecha de vencimiento de la licencia

  • Name
    dni
    Type
    string
    Description

    Documento de identidad del usuario

  • Name
    first_name
    Type
    string
    Description

    Nombre completo del usuario

  • Name
    last_name_p
    Type
    string
    Description

    Apellido paterno del usuario

  • Name
    last_name_m
    Type
    string
    Description

    Apellido materno del usuario

  • Name
    email
    Type
    string
    Description

    Correo del usuario

  • Name
    password
    Type
    string
    Description

    Contraseña del usuario

Atributos opcionales

  • Name
    phone_number
    Type
    string
    Description

    Celular del usuario

Pedido

POST
/users
  {
    // Empresa
    "ruc": "12345678901",
    "bussiness_name": "EMPRESA",
    "address": "DIRECCION",
    "workers_amount": 100,
    // Licencia
    "max_records": 100,
    "cost": 1000,
    "unit_cost": 10,
    "date": "2024-01-25",
    // Usuario
    "dni": "12345678",
    "first_name": "USUARIO",
    "last_name_p": "APELLIDO PATERNO",
    "last_name_m": "APELLIDO MATERNO",
    "email": "correo@gmail.com",
    "password": "12345678"
  }

Respuesta

{
  "_id": "WAz8eIbvDR60rouK",
  "company": "WAz8eIbvDR60rouK",
}
PUT/users

Editar empresa y usuario

Esta ruta permite modificar un usuario y la empresa asociada a él.

Atributos requeridos

  • Name
    userId
    Type
    string
    Description

    Identificador del usuario

  • Name
    ruc
    Type
    string
    Description

    Número de RUC

  • Name
    bussiness_name
    Type
    string
    Description

    Nombre

  • Name
    address
    Type
    string
    Description

    Dirección

  • Name
    workers_amount
    Type
    number
    Description

    Cantidad de trabajadores

  • Name
    max_records
    Type
    number
    Description

    Máximo de expedientes permitidos

  • Name
    cost
    Type
    number
    Description

    Costo total de la licencia

  • Name
    unit_cost
    Type
    number
    Description

    Costo por expediente

  • Name
    date
    Type
    date
    Description

    Fecha de vencimiento de la licencia

  • Name
    dni
    Type
    string
    Description

    Documento de identidad del usuario

  • Name
    first_name
    Type
    string
    Description

    Nombre completo del usuario

  • Name
    last_name_p
    Type
    string
    Description

    Apellido paterno del usuario

  • Name
    last_name_m
    Type
    string
    Description

    Apellido materno del usuario

  • Name
    email
    Type
    string
    Description

    Correo del usuario

Atributos opcionales

  • Name
    phone_number
    Type
    string
    Description

    Celular del usuario

  • Name
    password
    Type
    string
    Description

    Contraseña del usuario

Pedido

PUT
/users
  {
    "userId": "WAz8eIbvDR60rouK",
    // Empresa
    "ruc": "12345678901",
    "bussiness_name": "EMPRESA",
    "address": "DIRECCION",
    "workers_amount": 100,
    // Licencia
    "max_records": 100,
    "cost": 1000,
    "unit_cost": 10,
    "date": "2024-01-25",
    // Usuario
    "dni": "12345678",
    "first_name": "USUARIO",
    "last_name_p": "APELLIDO PATERNO",
    "last_name_m": "APELLIDO MATERNO",
    "email": "correo@gmail.com",
    "password": "12345678"
  }