Puntos de Emisión
Maneja todas las operaciones relacionadas con puntos de emisión en la API.
Endpoints
Section titled “Endpoints”Obtener todos los puntos de emisión
Section titled “Obtener todos los puntos de emisión”GET /emission-points
Obtiene el listado de todos los puntos de emisión registrados.
Parámetros de consulta
Section titled “Parámetros de consulta”Parámetro | Tipo | Descripción |
---|---|---|
query | Object | Parámetros de filtrado y ordenamiento (opcional) |
Respuesta
Section titled “Respuesta”La API devolverá un array con todos los puntos de emisión registrados o un mensaje de error en caso de fallar.
Respuesta exitosa:
[ { "id": "uuid-punto-emision-1", "establishmentId": "uuid-establecimiento", "code": 1, "name": "Punto de Emisión Principal", "companyId": "uuid-empresa", "tenantId": "uuid-tenant", "createdAt": "2025-06-02T12:00:00Z", "updatedAt": "2025-06-02T12:00:00Z" }, { "id": "uuid-punto-emision-2", "establishmentId": "uuid-establecimiento", "code": 2, "name": "Punto de Emisión Secundario", "companyId": "uuid-empresa", "tenantId": "uuid-tenant", "createdAt": "2025-06-02T12:00:00Z", "updatedAt": "2025-06-02T12:00:00Z" }]
Posibles errores
Section titled “Posibles errores”Código | Descripción |
---|---|
500 | Error interno al obtener la lista de puntos de emisión |
{ "statusCode": 500, "message": "Error fetching emission points: [detalles del error]"}
Obtener un punto de emisión por ID
Section titled “Obtener un punto de emisión por ID”GET /emission-points/{id}
Obtiene la información detallada de un punto de emisión específico a partir de su ID.
Parámetros de ruta
Section titled “Parámetros de ruta”Parámetro | Tipo | Descripción |
---|---|---|
id | String (UUID) | ID del punto de emisión a consultar |
Respuesta
Section titled “Respuesta”La API devolverá los detalles completos del punto de emisión solicitado o un mensaje de error en caso de fallar.
Respuesta exitosa:
{ "id": "uuid-punto-emision", "establishmentId": "uuid-establecimiento", "code": 1, "name": "Punto de Emisión Principal", "companyId": "uuid-empresa", "tenantId": "uuid-tenant", "createdAt": "2025-06-02T12:00:00Z", "updatedAt": "2025-06-02T12:00:00Z"}
Posibles errores
Section titled “Posibles errores”Código | Descripción |
---|---|
404 | El punto de emisión con el ID proporcionado no ha sido encontrado |
{ "statusCode": 404, "message": "Emission point with id uuid-no-existente not found"}
Crear un nuevo punto de emisión
Section titled “Crear un nuevo punto de emisión”POST /emission-points
Crea un nuevo punto de emisión en el sistema.
Cuerpo de la solicitud (JSON)
Section titled “Cuerpo de la solicitud (JSON)”{ "establishmentId": "uuid-establecimiento", "code": 1, "name": "Punto de Emisión Principal", "companyId": "uuid-empresa", "tenantId": "uuid-tenant"}
Campos del objeto para crear un punto de emisión
Section titled “Campos del objeto para crear un punto de emisión”Campo | Tipo | Requerido | Descripción |
---|---|---|---|
establishmentId | String (UUID) | Sí | ID del establecimiento |
code | Integer | Sí | Código del punto de emisión |
name | String | Sí | Nombre del punto de emisión |
companyId | String (UUID) | Sí | ID de la empresa |
tenantId | String (UUID) | No | ID del tenant (opcional) |
Respuesta
Section titled “Respuesta”La API devolverá la información del punto de emisión creado exitosamente o un mensaje de error en caso de fallar.
Posibles errores
Section titled “Posibles errores”Código | Descripción |
---|---|
400 | Error en la creación del punto de emisión con detalles del problema |
{ "statusCode": 400, "message": "Error creating emission point"}
Actualizar un punto de emisión existente
Section titled “Actualizar un punto de emisión existente”PUT /emission-points/{id}
Actualiza la información de un punto de emisión existente.
Parámetros de ruta
Section titled “Parámetros de ruta”Parámetro | Tipo | Descripción |
---|---|---|
id | String (UUID) | ID del punto de emisión a actualizar |
Cuerpo de la solicitud (JSON)
Section titled “Cuerpo de la solicitud (JSON)”{ "establishmentId": "uuid-establecimiento-actualizado", "code": "2", "companyId": "uuid-empresa-actualizada", "tenantId": "uuid-tenant-actualizado"}
Campos del objeto para actualizar un punto de emisión
Section titled “Campos del objeto para actualizar un punto de emisión”Campo | Tipo | Requerido | Descripción |
---|---|---|---|
establishmentId | String (UUID) | No | ID del establecimiento |
code | String | No | Código del punto de emisión |
companyId | String (UUID) | Sí | ID de la empresa |
tenantId | String (UUID) | No | ID del tenant (opcional) |
Respuesta
Section titled “Respuesta”La API devolverá la información actualizada del punto de emisión o un mensaje de error en caso de fallar.
Posibles errores
Section titled “Posibles errores”Código | Descripción |
---|---|
400 | Error al actualizar el punto de emisión con detalles del problema |
{ "statusCode": 400, "message": "Error updating emission point"}
Eliminar un punto de emisión
Section titled “Eliminar un punto de emisión”DELETE /emission-points/{id}
Elimina un punto de emisión existente del sistema.
Parámetros de ruta
Section titled “Parámetros de ruta”Parámetro | Tipo | Descripción |
---|---|---|
id | String (UUID) | ID del punto de emisión a eliminar |
Respuesta
Section titled “Respuesta”La API devolverá un mensaje de confirmación o un mensaje de error en caso de fallar.
Posibles errores
Section titled “Posibles errores”Código | Descripción |
---|---|
400 | Error al eliminar el punto de emisión con detalles del problema |
{ "statusCode": 400, "message": "Error deleting emission point"}