Departamentos

La API de Departamentos provee una herramienta eficaz para la administración de unidades geográficas dentro de la empresa. Trabaja con la tabla que en la aplicación se encuentra en Configuración > Países y Departamentos

URL y Descripción General

Esta API permite gestionar los departamentos, provincias o estados asociados a cada país dentro del marco empresarial. Es especialmente obligatoria para empresas que ostentan el status de Emisor Electrónico.

Método Query

Filtros
  • CodigoDesde: T(3)
  • CodigoHasta: T(3)
  • NombreContiene: T(20)
  • Page: N(2) – Obligatorio. Paginación con muestras de 100 registros por página.

Los filtros en el método Query se utilizan para refinar la búsqueda de departamentos, permitiendo que los usuarios puedan encontrar la información de manera más eficiente.

Resultado
  • Codigo
  • Nombre
  • PaisCodigo
  • PaisNombre

Estos son los elementos informativos que se obtendrán al realizar una consulta. Son fundamentales para entender la organización geográfica de la empresa en relación con sus operaciones en diferentes departamentos y países.

Método Save

Datos
  • Codigo: T(3) – Obligatorio.
  • Nombre: T(40) – Obligatorio.
  • PaisCodigo: T(3) – Obligatorio. El país debe estar previamente creado y se puede verificar mediante la API de Configuración de Países.

El método Save se emplea para crear o actualizar registros de departamentos. La presencia de campos obligatorios asegura la integridad de los datos ingresados.

Resultado
  • Succeed / Error / Mensaje

Método Load

Filtros
  • Codigo: T(3) – Obligatorio.
Resultado
  • Codigo
  • Nombre
  • PaisCodigo

Este método es responsable de cargar los datos específicos de un departamento, lo cual es esencial para tareas como la edición de registros o la revisión de información.

Método Delete

Filtros
  • Codigo: T(3) – Obligatorio.
Resultado
  • Succeed / Error / Mensaje

La utilidad del método Delete se manifiesta en su capacidad para eliminar registros de departamentos, siempre y cuando no haya restricciones o transacciones pendientes asociadas a ellos.


 

Compartir

Departamentos

O copia el enlace

CONTENIDO