API Referencias

Esta API permite gestionar referencias que se utilizan como etiquetas en comprobantes y asientos contables.

La funcionalidad corresponde a Configuración > Referencias.

Casos de uso

  • Consultar referencias.
  • Crear o actualizar etiquetas contables.
  • Obtener una referencia específica.
  • Eliminar registros sin uso.

Endpoint del servicio

Método Query

Permite obtener un listado de referencias.

Parámetros de entrada

Parámetro Tipo Obligatorio Descripción
CodigoDesde T(10) No Código inicial del rango.
CodigoHasta T(10) No Código final del rango.
NombreContiene T(20) No Búsqueda parcial por nombre.
Page N(2) Paginación de resultados.

Estructura del response

Codigo
Nombre

Método Save

Permite crear o actualizar una referencia.

Parámetros de entrada

Parámetro Tipo Obligatorio Descripción
Codigo T(10) Identificador único de la referencia.
Nombre T(40) Nombre de la referencia.

Resultado

Succeed / Error / Mensaje

Método Load

Permite obtener una referencia específica.

Parámetros de entrada

Parámetro Tipo Obligatorio Descripción
Codigo T(10) Identificador único de la referencia.

Resultado

Codigo
Nombre

Método Delete

Permite eliminar una referencia.

Parámetros de entrada

Parámetro Tipo Obligatorio Descripción
Codigo T(10) Identificador único de la referencia.

Resultado

Succeed / Error / Mensaje

Consideraciones

  • Las referencias permiten clasificar comprobantes y asientos contables.
  • Se recomienda validar existencia antes de crear o actualizar.
Importante: No es posible eliminar una referencia si está asociada a comprobantes o asientos contables.
Compartir

API Referencias

O copia el enlace

CONTENIDO