Contactos

La API de Contactos permite la gestión de una base de datos de los Contactos, Clientes y Proveedores. La API está accesible desde la interfaz de usuario a través de la sección Configuración > Contactos, Clientes y Proveedores.

URL y Descripción

• URL Descripción: https://api.zetasoftware.com/z.apis.asoapcontactosv3?wsdl
• Servicio: https://api.zetasoftware.com/z.apis.asoapcontactosv3

Método Query

Filtros

• Search: Para búsquedas textuales en el nombre o razón social.
• CodigoDesde: T(10)
• CodigoHasta: T(10)
• RUTContiene: T(12)
• DocumentoContiene: T(30)
• EsCliente: T(1) (Valores: S=Si, N=No)
• EsProveedor: T(1) (Valores: S=Si, N=No)
• ContactoActivo: T(1) (Valores: S=Si, N=No)
• PaisCodigo: T(3)
• ZonaCodigo: T(3)
• GiroCodigo: T(3)
• GrupoCodigo: T(3)
• OrigenCodigo: T(3)
• PropietarioCodigo: N(3)
• FechaRegistroDesde: AAAA-MM-DD
• FechaRegistroHasta: AAAA-MM-DD

Resultado

• Codigo
• Nombre
• RazonSocial
• DocumentoTipo
• RUT
• DocumentoSigla
• Documento
• EsCliente
• EsProveedor
• ContactoActivo
• PaisCodigo
• PaisNombre
• DepartamentoCodigo
• DepartamentoNombre
• Localidad
• Direccion
• DireccionCompleta
• CodigoPostal
• ZonaCodigo
• ZonaNombre
• Telefono
• Celular
• Web
• Email1
• Email2
• GiroCodigo
• GiroNombre
• GrupoCodigo
• GrupoNombre
• OrigenCodigo
• OrigenNombre
• PropietarioCodigo
• PropietarioNombre
• Notas
• NotasCFEs
• FechaRegistro

Método Save

Datos

La ejecución del método Save implica un acto crucial: la inserción o actualización de un registro de contacto en la base de datos. Los campos obligatorios son exhaustivos, lo que garantiza una representación completa del contacto.

• Codigo: T(10) – Obligatorio.
• Nombre: T(50) – Obligatorio.
• RazonSocial: T(50) – Obligatorio.
• DocumentoTipo: T(1) – Lista de valores aceptados: Vacío=sin documento, R=RUT, C=Cédula, P=Pasaporte, D=DNI, N=NIFE, O=Otro.
• RUT: T(12) – Aplica cuando DocumentoTipo = «R».
• DocumentoSigla: T(12) – Aplica cuando DocumentoTipo = «O» (Otro).
• Documento: T(20) – Aplica cuando DocumentoTipo <> «R».
• EsCliente: T(1) – Obligatorio. Valores aceptados: S=Si, N=No.
• EsProveedor: T(1) – Obligatorio. Valores aceptados: S=Si, N=No.
• ContactoActivo: T(1) – Obligatorio. Valores aceptados: S=Si, N=No.
• PaisCodigo: T(3) – Obligatorio.
• DepartamentoCodigo: T(3) – Obligatorio.
• Localidad: T(30) – Obligatorio.
• Direccion: T(50) – Obligatorio.
• CodigoPostal: T(20)
• ZonaCodigo: T(3)
• Telefono: T(30) – Obligatorio, a menos que se informe el Celular.
• Celular: T(30) – Obligatorio, a menos que se informe el Teléfono.
• Web: T(50)
• Email1: T(50)
• Email2: T(50)
• GiroCodigo: T(3)
• GrupoCodigo: T(3)
• OrigenCodigo: T(3)
• PropietarioCodigo: N(3)
• Notas: T(1000)
• NotasCFEs: T(150)

Resultado

• Succeed si la operación es exitosa.
• Error y mensaje descriptivo en caso contrario.

Método Load

Filtros

• Codigo: T(10)

Resultado

El método Load permite recuperar un contacto específico mediante su código, y devuelve una cantidad amplia de campos informativos, muy similar a los datos que se obtienen a través del método Query.

• Codigo
• Nombre
• RazonSocial
• DocumentoTipo
• RUT
• DocumentoSigla
• Documento
• EsCliente
• EsProveedor
• ContactoActivo
• PaisCodigo
• DepartamentoCodigo
• Localidad
• Direccion
• CodigoPostal
• ZonaCodigo
• Telefono
• Celular
• Web
• Email1
• Email2
• GiroCodigo
• GrupoCodigo
• OrigenCodigo
• PropietarioCodigo
• Notas
• NotasCFEs

En caso de error, el método retorna False y un mensaje descriptivo.

Estos métodos son particularmente útiles para la actualización y recuperación de datos de contactos. Por ejemplo, el método Save permite no solo crear nuevos registros sino también actualizarlos, haciendo cambios en campos como el nombre, la dirección o el estado de actividad. Por su parte, el método Load ofrece la posibilidad de acceder a un registro específico en casos donde se requiere información más detallada o para verificar la correcta inserción o modificación de un contacto. Ambos métodos se complementan y ofrecen un robusto conjunto de herramientas para la gestión efectiva de contactos empresariales.

Método Delete

Filtros

• Codigo: T(10)

Resultado

• Succeed si la operación se ha completado con éxito.
• Error y mensaje descriptivo en caso de fallo.

Notas Importantes

La eliminación de un contacto no es una acción trivial y está sujeta a condiciones específicas. Específicamente, un contacto no puede ser eliminado si:

1. Posee información en los datos comerciales, tanto de Cliente como de Proveedor. Para eliminar estos datos, primero deberán ser removidos a nivel de aplicación o mediante las APIs correspondientes.
2. Hay movimientos asociados a ese contacto, como comprobantes de compra y venta, recibos de cobro o de pago, entre otros.

Metodología de Uso Esperada

Se enfatiza la importancia de que el desarrollador mantenga una base de datos local para las consultas cotidianas de contactos. Las altas y modificaciones en la base local deben ser actualizadas conforme a los cambios en la base de datos de ZetaSoftware. Esta práctica tiene como objetivo minimizar las consultas a la base de datos de ZetaSoftware y optimizar el rendimiento general.

Método Load

Debe utilizarse sólo para la consulta de registros específicos. No está diseñado para consultas en rangos, para las cuales se debe utilizar el método Query.

Método Query

Este método no está destinado para la obtención de datos de un único contacto ni para realizar consultas frecuentes de todos los contactos. Se recomienda que al iniciar la actividad, se ejecute este método una sola vez al día, preferiblemente fuera del horario comercial, dejando los parámetros CodigoDesde y CodigoHasta vacíos para obtener todos los registros. Para futuras consultas, se deberán usar los parámetros FechaRegistroDesde y FechaRegistroHasta para obtener sólo los registros que han sido agregados o modificados, añadiéndolos a la base de datos local.