El web service (Agente) de ContaPyme, expone una serie de funciones que le permitirán acceder a la información almacenada en su sistema central. Aquí encontrará la documentación de cada función con sus respectivos parámetros de entrada y de salida.

Tenga en cuenta que:

  • El protocolo de transferencia de datos es Rest
  • Los llamados y las respuestas de las peticiones están en formato Json



¿Cómo establecer comunicación con el Agente?


Lo primero que usted debe hacer para trabajar con el Agente es iniciar sesión, con ello obtendrá un identificador de usuario que le permitirá realizar cualquier petición al Agente.
La función que debe llamar para iniciar sesión en el Agente es: GetAuth()




Ver documentación
¿Cómo realizar una petición al Agente?


Después de obtener el identificador del usuario, puede realizar cualquier petición al Agente para obtener o insertar información en su sistema ContaPyme.
Para conocer los nombres de las funciones y sus respectivos parámetros, consulte la documentación de los módulos disponibles







¿Cómo registrar una operación a través de el Agente?


Para registrar una operación en el sistema se debe llamar la función DoExecuteOprAction() enviando la acción "New", el identificador del tipo de operación a crear y los datos a registrar de la operación.
Cada operación posee la documentación del Json que recibe la función, ésta se encuentra en el módulo al que pertenece la operación a crear.


Ver documentación


¿Cómo obtener un informe en PDF a través del Agente?


A través del Agente es posible obtener cualquier informe del sistema en formato PDF, para ello se debe llamar la función GetPDF() enviando el código del reporte a obtener y los parámetros necesarios para la generación del mismo.
La función retornará el informe en formato PDF.



Ver documentación
¿Cómo cerrar la conexión con el Agente?


Para cerrar la conexión con el Agente se debe llamar la función Logout() enviando sólo el identificador de la sesión del usuario. La función retornará la confirmación del cierre de la sesión del usuario.






Ver documentación
¿Cómo verificar el estado del Agente?


Por medio de la función Test() es posible conocer el estado del Agente, es decir si está en ejecución, detenido, conectado al área de trabajo o no conectado.








Ver documentación



Documentación por módulo



Módulo básico

Módulo cartera y proveedores


Módulo contabilidad

Módulo costos


Módulo inventarios

Módulo activos


Módulo inventarios plus

Módulo actividades


Módulo automatización de documentos







Usted no tiene permisos para acceder a la documentación de la API del Agente de servicios web.