Endpoints / Métodos de Pago

GET

Listar métodos de pago

Lista métodos de pago de forma paginada, con búsqueda por nombre y filtro por estado, dentro de la empresa del usuario autenticado.

GET/playment-methods

Caso de Uso

Se usa cuando la aplicación necesita mostrar una tabla de métodos de pago, buscar por nombre o filtrar por estado. Al usarlo, el usuario obtiene una página de resultados con el conteo total de métodos de pago de su empresa.

Autenticación

Requiere token JWT en el header `Authorization: Bearer <token>`. Permite acceso a usuarios con rol jefe o empleado. La empresa y el usuario autenticado deben estar activos.

Parámetros de ruta

Este endpoint no recibe parámetros de ruta.

Query params

pagestringobligatorio

Número de página. Debe ser un entero positivo.

pageSizestringobligatorio

Cantidad de registros por página. Debe ser un entero positivo.

searchstring opcional

Texto opcional para buscar por mpnombre.

statusstring opcional

Estado del método de pago. Solo acepta activo o inactivo.

Body

No aplica.

Reglas de negocio

1

Solo un usuario con rol jefe o empleado puede listar métodos de pago.

2

Solo permite listar métodos de pago de la empresa del usuario autenticado.

3

La empresa del usuario autenticado debe estar activa.

4

El usuario autenticado debe estar activo.

5

page y pageSize son obligatorios y deben ser enteros positivos.

6

Si no se envía status, se excluyen los métodos de pago con estado eliminado.

7

Si se envía status, solo acepta activo o inactivo.

8

search busca coincidencias parciales en mpnombre.

Errores esperados

401No autorizado

No se envió un token JWT válido o el token no contiene información válida del usuario.

400La búsqueda debe ser un texto

El query param search fue enviado como arreglo en lugar de texto.

400El estado debe ser un texto

El query param status fue enviado como arreglo en lugar de texto.

400El estado debe ser activo o inactivo

El query param status tiene un valor distinto de activo o inactivo.

500La página debe ser un entero positivo

page no es un entero positivo o no fue enviado.

500El tamaño de página debe ser un entero positivo

pageSize no es un entero positivo o no fue enviado.

500La empresa no existe

La empresa asociada al usuario autenticado no fue encontrada.

500La empresa no está activa

La empresa asociada al usuario autenticado está inactiva.

500El usuario no existe

El usuario autenticado no fue encontrado dentro de su empresa.

500El usuario no pertenece a la empresa

El usuario autenticado no pertenece a la empresa indicada por su sesión.

500El usuario no puede acceder a otra empresa

El usuario autenticado intentó acceder a una empresa distinta a la suya.

500El usuario no es jefe, empleado o administrador

El rol del usuario no está permitido para acceder al módulo de métodos de pago.

500El usuario no es jefe o empleado

El usuario autenticado no tiene un rol permitido para listar métodos de pago.

500El usuario no está activo

El usuario autenticado está inactivo y no puede usar el sistema.

Notas de uso

1

search y status son query params opcionales.

2

Si no hay resultados para la página solicitada, items se devuelve como arreglo vacío.

3

El listado está restringido a la empresa del usuario autenticado.