Ingresar

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ámetroTipoObligatorioDescripción
SearchTNoBúsqueda por nombre o razón social.
CodigoDesdeT(10)NoCódigo inicial.
CodigoHastaT(10)NoCódigo final.
RUTContieneT(12)NoFiltro por RUT.
DocumentoContieneT(30)NoFiltro por documento.
EsClienteT(1)NoS/N.
EsProveedorT(1)NoS/N.
ContactoActivoT(1)NoS/N.
PaisCodigoT(3)NoFiltro por país.
ZonaCodigoT(3)NoFiltro por zona.
GiroCodigoT(3)NoFiltro por giro.
GrupoCodigoT(3)NoFiltro por grupo.
OrigenCodigoT(3)NoFiltro por origen.
PropietarioCodigoN(3)NoResponsable del contacto.
FechaRegistroDesdeFechaNoFecha desde.
FechaRegistroHastaFechaNoFecha 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

CampoDescripción
CodigoCódigo único del contacto
NombreNombre del contacto
RazonSocialRazón social del contacto
DocumentoTipoEjemplo: R (RUT), C (CI), Pa (Pasaporte), D (DNI), N (NIFE), O (Otro)
EsCliente"S" o "N"
EsProveedor"S" o "N"
ContactoActivo"S" o "N"
PaisCodigoCódigo de país existente
DepartamentoCodigoCódigo de departamento existente, debe pertenecer al país
LocalidadLocalidad del contacto
DireccionDirección del contacto
Telefono o CelularDebe informarse al menos uno de los dos

Campos opcionales

CampoDescripción
RUTIndicar cuando el DocumentoTipo es R
DocumentoSiglaIndicar cuando el DocumentoTipo es O
DocumentoIndicar cuando el DocumentoTipo es C, PA, D, N,
CodigoPostalOpcional según la documentación disponible
ZonaCodigoCódigo de zona. . El valor enviado debe existir previamente en la configuración de la empresa en ZetaSoftware.
TelefonoObligatorio solamente si no se informa Celular
CelularObligatorio solamente si no se informa Telefono
WebDirección web
Email1Correo principal
Email2Correo alternativo
GiroCodigoCódigo de giro comercial. El valor enviado debe existir previamente en la configuración de la empresa en ZetaSoftware.
GrupoCodigoCódigo de grupo. El valor enviado debe existir previamente en la configuración de la empresa en ZetaSoftware.
OrigenCodigoCódigo de origen. El valor enviado debe existir previamente en la configuración de la empresa en ZetaSoftware.
PropietarioCodigoCódigo del propietario o responsable. El valor enviado debe existir previamente en la configuración de la empresa en ZetaSoftware.
NotasObservaciones
NotasCFEsObservaciones 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.
API Contactos - PreviousAPI Condiciones de PagoNext - API ContactosAPI Sucursales de Contactos
Compartir

API Contactos

O copia el enlace

CONTENIDO