API Departamentos

Esta API permite gestionar departamentos, provincias o estados asociados a los países definidos en la empresa. Incluye operaciones de consulta, creación, modificación y eliminación de registros geográficos.

La funcionalidad asociada en el sistema se encuentra en Configuración > Países y Departamentos.

Casos de uso

• Consultar departamentos configurados en la empresa.
• Crear nuevos departamentos, provincias o estados.
• Actualizar datos geográficos ya existentes.
• Sincronizar catálogos geográficos con sistemas externos.

Endpoint del servicio

• WSDL: https://api.zetasoftware.com/z.apis.asoapdepartamentosv1?wsdl
• Servicio: https://api.zetasoftware.com/z.apis.asoapdepartamentosv1

Método Query

Permite obtener un listado paginado de departamentos, provincias o estados configurados en la empresa.

Requisitos previos

• Contar con acceso habilitado a la API.
• Definir, si aplica, el rango de códigos o el texto a buscar.

Parámetros de entrada

Estructura del request

CodigoDesde
CodigoHasta
NombreContiene
Page

Estructura del response

Codigo
Nombre
PaisCodigo
PaisNombre

Campos devueltos

Ejemplo de request

{
  "CodigoDesde": "",
  "CodigoHasta": "",
  "NombreContiene": "",
  "Page": 1
}

Ejemplo de response

[
  {
    "Codigo": "010",
    "Nombre": "Montevideo",
    "PaisCodigo": "URY",
    "PaisNombre": "Uruguay"
  }
]

Método Save

Permite crear un nuevo departamento o actualizar uno existente.

Parámetros de entrada

Resultado

Succeed
Error
Mensaje

Método Load

Permite obtener un departamento específico mediante su código.

Parámetro de entrada

• Codigo – Obligatorio.

Resultado

Codigo
Nombre
PaisCodigo

Método Delete

Permite eliminar un departamento.

Parámetro de entrada

• Codigo – Obligatorio.

Resultado

Succeed
Error
Mensaje

Observaciones

• Esta API gestiona departamentos, provincias o estados según la estructura geográfica utilizada por la empresa.
• El método Query permite búsquedas masivas con paginación.
• El método Save permite alta y modificación.
• La configuración de departamentos puede ser obligatoria para empresas que operan como Emisor Electrónico.

Consideraciones de integración

• Validar previamente que el país exista antes de crear un departamento.
• Utilizar paginación en consultas masivas.
• Verificar dependencias antes de eliminar registros geográficos en producción.