Artículos

La API de Artículos proporciona una interfaz robusta y flexible para gestionar productos, servicios y artículos de su empresa. Con acceso a través de la opción Configuración > Artículos, esta API es un recurso indispensable para la administración moderna de inventarios y servicios.

URL y Descripción

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

Método Query

• Objetivo: Obtener datos de artículos de la empresa.
• Requerimientos: El desarrollador debe tener su propia base de datos de artículos para minimizar las consultas a la base de ZetaSoftware.
• Sugerencia: Los campos FechaRegistroDesde y FechaRegistroHasta contiene la fecha de alta o de última modificación de cada artículo. Utilizar este filtro para conocer los últimas variaciones.

Filtros Disponibles

1. CodigoDesde: T(20)
2. CodigoHasta: T(20)
3. NombreContiene: T(20)
4. CodigoOrigen: T(20)
5. CodigoBarras: T(30)
6. ArticulosActivo: T(1) (Valores: S=Si, N=No)
7. CategoriaCodigo: T(3)
8. FamiliaCodigoDesde: T(10)
9. FamiliaCodigoHasta: T(10)
10. MarcaCodigo: T(3)
11. ProveedorCodigo: T(10)
12. ConceptoCodigo: T(10)
13. IVACodigo: N(2)
14. UnidadPrincipalCodigo: T(3)
15. MonedaCodigo: N(2)
16. FechaRegistroDesde: T(8) (Formato: AAAA-MM-DD)
17. FechaRegistroHasta: T(8) (Formato: AAAA-MM-DD)

Paginación

• Page: N(2) (Obligatorio, paginación de 500 registros por página. Valores admitidos: 1, 2, etc.)

Campos en el Resultado

1. Codigo
2. Nombre
3. Abreviacion
4. CodigoOrigen
5. CodigoBarras
6. ArticulosActivo
7. CategoriaCodigo
8. CategoriaNombre
9. FamiliaCodigo
10. FamiliaNombre
11. MarcaCodigo
12. MarcaNombre
13. ProveedorCodigo
14. ProveedorNombre
15. ConceptoCodigo
16. ConceptoNombre
17. IVACodigo
18. IVANombre
19. IVATAsa
20. IVATipo
21. PercepcionCodigo
22. PercepcionNombre
23. CodigoContableCompras
24. CodigoContableVentas
25. CodigoContableProduccion
26. ContabilizarStock
27. UnidadPrincipalCodigo
28. UnidadPrincipalNombre
29. UnidadPrincipalSimbolo
30. UnidadSecundariaCodigo
31. UnidadSecundariaSimbolo
32. UnidadSecundariaNombre
33. CantidadPorUnidad
34. TrabajaDobleCantidad
35. IncluirListaPrecios
36. Lotes
37. Vencimiento
38. CostoFecha
39. MonedaCodigo
40. MonedaSimbolo
41. Costo
42. PorcentajeUtilidadCosto
43. TextoPredefinidoCodigo
44. TextoPredefinidoNombre
45. Web
46. Notas
47. FechaRegistroDesde
48. FechaRegistroHasta

Método Save

Este método se utiliza para guardar o actualizar información de artículos en la base de datos. A continuación, se describen los campos que se deben considerar:

Datos Requeridos y Opcionales

1. Codigo: T(20) – Obligatorio.
2. Nombre: T(50) – Obligatorio.
3. Abreviacion: T(30) – Obligatorio.
4. ArticulosActivo: T(1) – Obligatorio. Valores aceptados: S/N.
5. IVACodigo: N(2) – Obligatorio.
6. ContabilizarStock: T(1) – Obligatorio. Valores aceptados: S/N.
7. TrabajaDobleCantidad: T(1) – Obligatorio. Valores aceptados: S/N.
8. IncluirListaPrecios: T(1) – Obligatorio. Valores aceptados: S/N.
9. MonedaCodigo: N(2) – Obligatorio.

Datos Opcionales

1. CodigoOrigen: T(20)
2. CodigoBarras: T(30)
3. CategoriaCodigo: T(3)
4. CategoriaNombre: T(30)
5. FamiliaCodigo: T(30)
6. MarcaCodigo: T(3)
7. ProveedorCodigo: T(10)
8. ConceptoCodigo: T(10)
9. PercepcionCodigo: T(10)
10. CodigoContableCompras: T(30)
11. CodigoContableVentas: T(30)
12. CodigoContableProduccion: T(30)
13. UnidadPrincipalCodigo: T(3)
14. UnidadSecundariaCodigo: T(3)
15. CantidadPorUnidad: N(10.2)
16. Lotes: T(20)
17. Vencimiento: AAAA-MM-DD (Obligatorio si se utiliza lote y fecha de vencimiento de lotes)
18. CostoFecha: AAAA-MM-DD
19. Costo: N(12.5)
20. PorcentajeUtilidadCosto: N(12.5)
21. TextoPredefinidoCodigo: T(3)
22. Web: T(60)
23. Notas: T(1000)

Resultado de la Operación

• Succeed si la operación fue exitosa.
• Error si ocurrió algún problema.
• Mensaje brinda detalles específicos sobre el resultado de la operación.

Método Load

Este método tiene una finalidad particular: se utiliza exclusivamente para consultar un único registro de artículo. A diferencia del método «Query», que está diseñado para obtener un conjunto de registros o un rango de ellos, «Load» es más preciso y está orientado a la obtención de información detallada de un único artículo.

Filtro Requerido

• Codigo: T(20) – Obligatorio. Este es el identificador único del artículo que se desea consultar. Al ser un campo obligatorio, su correcta asignación es crucial para la obtención de datos precisos.

Resultado de la Consulta

Los datos retornados serán extensos y cubrirán diversas áreas de información del artículo:

1. Codigo
2. Nombre
3. Abreviacion
4. CodigoOrigen
5. CodigoBarras
6. ArticulosActivo
7. CategoriaCodigo
8. CategoriaNombre
9. FamiliaCodigo
10. MarcaCodigo
11. ProveedorCodigo
12. ConceptoCodigo
13. IVACodigo
14. PercepcionCodigo
15. CodigoContableCompras
16. CodigoContableVentas
17. CodigoContableProduccion
18. ContabilizarStock
19. UnidadPrincipalCodigo
20. UnidadSecundariaCodigo
21. CantidadPorUnidad
22. TrabajaDobleCantidad
23. IncluirListaPrecios
24. Lotes
25. Vencimiento
26. CostoFecha
27. MonedaCodigo
28. Costo
29. PorcentajeUtilidadCosto
30. TextoPredefinidoCodigo
31. Web
32. Notas

Si la consulta es exitosa, estos campos devolverán los datos del artículo consultado. En cambio, si hay un error durante la operación, el método retornará «False» y un mensaje que describirá el problema específico encontrado.

La precisión del método «Load» lo convierte en una herramienta sumamente útil para consultas puntuales.

Método Delete

Filtros

• Codigo: T(20) – Este campo es obligatorio y representa el código del artículo que se desea eliminar.

Nota Importante

Es fundamental tener en cuenta que un artículo no puede ser eliminado si ya ha sido utilizado en algún proceso dentro de la aplicación. En tal caso, el artículo puede ser marcado como «inactivo», lo cual permitirá excluirlo de futuras generaciones de comprobantes, pero sin eliminarlo de la base de datos.

Resultado

El método retornará uno de los siguientes estados:

• Succeed: Indica que la eliminación ha sido exitosa.
• Error: Señala que ha ocurrido un error.
• Mensaje: Proporciona un mensaje descriptivo del resultado de la operación.

El método «Delete» es especialmente útil para mantener una base de datos limpia y actualizada, pero su uso requiere un entendimiento claro de las limitaciones, especialmente en el contexto de artículos ya en uso.

Método CamposAdicionales

Filtros

• ArticuloCodigo: T(20) – Si este campo no se especifica, el método devolverá los campos adicionales de todos los artículos disponibles.

Resultado

Los datos retornados consisten en un listado de campos adicionales con los siguientes elementos:

• Codigo: Representa el código del artículo.
• CodigoCampo: Identifica el campo adicional en cuestión.
• Valor: Ofrece el valor del campo adicional.

El método «CamposAdicionales» ofrece una funcionalidad ampliada que permite a los usuarios acceder a información detallada y específica más allá de los atributos estándar de los artículos. Esto es especialmente útil para casos en que se requiere una clasificación más precisa o se desea implementar funcionalidades adicionales.

Ambos métodos son complementarios en la gestión de la base de datos de artículos y ofrecen flexibilidad y control sobre cómo se manipulan y consultan los registros. Así, comprendiendo las características y limitaciones de cada uno, se puede realizar una gestión más efectiva y eficiente.