API Contactos

Esta API permite gestionar contactos, clientes y proveedores dentro del sistema. Incluye operaciones de consulta, creación, modificación y eliminación de registros.

La funcionalidad asociada en el sistema se encuentra en Configuración > Contactos, Clientes y Proveedores.

Endpoint del servicio

Método Query

Permite obtener un listado de contactos aplicando filtros.

Parámetros de entrada

Parámetro Tipo Obligatorio Descripción
Search T No Búsqueda por nombre o razón social.
CodigoDesde T(10) No Código inicial.
CodigoHasta T(10) No Código final.
RUTContiene T(12) No Filtro por RUT.
DocumentoContiene T(30) No Filtro por documento.
EsCliente T(1) No S/N.
EsProveedor T(1) No S/N.
ContactoActivo T(1) No S/N.
PaisCodigo T(3) No Filtro por país.
ZonaCodigo T(3) No Filtro por zona.
GiroCodigo T(3) No Filtro por giro.
GrupoCodigo T(3) No Filtro por grupo.
OrigenCodigo T(3) No Filtro por origen.
PropietarioCodigo N(3) No Responsable del contacto.
FechaRegistroDesde Fecha No Fecha desde.
FechaRegistroHasta Fecha No Fecha hasta.

Estructura del response

Codigo
Nombre
RazonSocial
DocumentoTipo
RUT
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 Load

Permite obtener un contacto específico.

Parámetro de entrada

  • Codigo

Resultado

Devuelve los mismos datos que el método Query para un único registro.

Método Save

Permite crear o actualizar un contacto.

Al actualizar el contacto, los campos que no se envían en el payload no conservan automáticamente su valor anterior.

El sistema toma como referencia únicamente la información recibida. Por este motivo, los campos que no se incluyen en  la solicitud quedan sin valor.

Por lo tanto, al realizar una actualización, es necesario enviar también los datos que se desean conservar.

Campos obligatorios

Campo Descripción
Codigo Código único del contacto
Nombre Nombre del contacto
RazonSocial Razón social del contacto
DocumentoTipo Ejemplo: R (RUT), C (CI), Pa (Pasaporte), D (DNI), N (NIFE), O (Otro)
EsCliente "S" o "N"
EsProveedor "S" o "N"
ContactoActivo "S" o "N"
PaisCodigo Código de país existente
DepartamentoCodigo Código de departamento existente, debe pertenecer al país
Localidad Localidad del contacto
Direccion Dirección del contacto
Telefono o Celular Debe informarse al menos uno de los dos

Campos opcionales

Campo Descripción
RUT Indicar cuando el DocumentoTipo es R
DocumentoSigla Indicar cuando el DocumentoTipo es O
Documento Indicar cuando el DocumentoTipo es C, PA, D, N,
CodigoPostal Opcional según la documentación disponible
ZonaCodigo Código de zona. . El valor enviado debe existir previamente en la configuración de la empresa en ZetaSoftware.
Telefono Obligatorio solamente si no se informa Celular
Celular Obligatorio solamente si no se informa Telefono
Web Dirección web
Email1 Correo principal
Email2 Correo alternativo
GiroCodigo Código de giro comercial. El valor enviado debe existir previamente en la configuración de la empresa en ZetaSoftware.
GrupoCodigo Código de grupo. El valor enviado debe existir previamente en la configuración de la empresa en ZetaSoftware.
OrigenCodigo Código de origen. El valor enviado debe existir previamente en la configuración de la empresa en ZetaSoftware.
PropietarioCodigo Código del propietario o responsable. El valor enviado debe existir previamente en la configuración de la empresa en ZetaSoftware.
Notas Observaciones
NotasCFEs Observaciones para CFE

Resultado

Succeed
Error
Mensaje

 

Método Delete

Permite eliminar un contacto.

Parámetro

  • Codigo

Resultado

Succeed
Error
Mensaje

Restricciones

  • No se puede eliminar si tiene datos comerciales asociados.
  • No se puede eliminar si tiene movimientos (comprobantes, pagos, etc.).

Observaciones

  • El método Query es para consultas masivas.
  • El método Load es para consultas puntuales.
  • El método Save permite alta y modificación.

Buenas prácticas de integración

  • Mantener una base de datos local de contactos.
  • Ejecutar Query completo inicialmente.
  • Luego consultar por fechas para sincronización incremental.
  • Evitar consultas constantes a la API.
Compartir

API Contactos

O copia el enlace

CONTENIDO