| Funciones básicas | ||
| Funciones básicas | ||
| Nombre función | Nombre corto | Descripción |
| GetDatosTrabajo() | Retorna los datos de trabajo del usuario logueado. | Función mediante la cual se pueden obtener los datos de trabajo del usuario, estos datos son: área de trabajo y empresa de trabajo activa, fecha de trabajo, licencia asignada, perfil definido, entre otros. |
| GetMenuReportesEmpresa() | Retorna el listado de reportes disponibles en el sistema. | Función encargada de retornar el listado de informes que tiene disponibles el usuario, este listado incluye los informes propios del tipo de empresa de trabajo que están disponibles por licenciamiento y por los permisos del perfil del usuario activo |
| GetPermisosPorAcciones() | Retorna si el usuario tiene o no permiso sobre una acción del sistema. |
Función que retorna si se tiene o no permiso sobre las acciones del sistema. La seguridad de acciones está definida a nivel de perfil de usuario, es decir, cada perfil tiene la definición de las acciones que puede o no ejecutar.
Cada acción del sistema tiene un código definido por defecto, por lo cual si se va a implementar la seguridad de acciones se deben manejar dichos códigos. Para conocer más sobre la seguridad de acciones, consultar su manejo en el sistema ContaPyme o AgroWin. |
| SetDatosTrabajo() | Modifica los datos de trabajo de un usuario del sistema. | Función mediante la cual se pueden modificar los datos de trabajo para un usuario, los datos que se pueden actualizar son: Empresa de trabajo activa, fecha de trabajo, sede y lista de precios por defecto. |
| GetInfoPorId() | Retorna la información solicitada de los campos de un registro. |
Función encargada de retornar la información solicitada de los campos de un registro, es decir nos permite obtener datos particulares de un elemento del que conocemos su código. Por ejemplo podemos obtener el nombre, apellido, profesión y tratamiento de un tercero cuyo código sea 1053845789.
Esta función retorna sólo un registro. |
| GetEmailFavoritos() | Retorna el listado de emails favoritos de un usuario | Esta función es la encargada de retornar el listado de los correos electrónicos que tiene asociados un usuario del sistema, estos correos se conocen como los email’s favoritos del usuario y es posible configurar uno o más emails favoritos. |
| SetEmailFavoritos() | Modifica los emails favoritos de un usuario | Esta función es la encargada de almacenar en la base de datos los emails favoritos de un usuario del sistema, un usuario puede tener uno o más emails favoritos. |
| DoEnviarEmail() | Envía un reporte o documento por email. |
Esta función es la encargada de enviar reportes o documentos en PDF por email. Para poder utilizar esta función es necesario tener en el licenciamiento el módulo de Campañas y alertas tempranas por email.
Recibe la información que se enviará por email para que así el Agente se encargue de construir el email y despacharlo al destinatario indicado. |
| GetSQL() | Ejecuta un SQL de tipo Get sobre la base de datos. |
Esta función es la encargada de ejecutar un SQL de tipo “Select” directamente en la base de datos, a través de esta función se puede obtener la información de cualquier tabla del sistema. Para poder ejecutar esta función es necesario tener conocimiento del modelo entidad relación del sistema, es decir, conocer los nombres de las tablas, campos y relaciones entre tablas.
Para poder ejecutar esta función se debe contar con un permiso específico, el cual se configura en el sistema ContaPyme entrando por la pestaña Básico – Móvil – Perfiles de seguridad para clientes móviles – Usuario a configurar – API abierta (licencia desarrollador) – Opciones. |
| SetSQL() | Ejecuta una sentencia SQL de tipo Set sobre la base de datos |
Esta función es la encargada de ejecutar un SQL de tipo “Insert”, “Update” o “Delete” directamente sobre la base de datos, a través de esta función se puede crear, modificar o eliminar un registro del sistema.
Para poder ejecutar esta función es necesario tener conocimiento del modelo entidad relación del sistema, es decir, conocer los nombres de las tablas, campos y relaciones entre tablas. Para poder ejecutar esta función se debe contar con un permiso específico, el cual se configura en el sistema ContaPyme entrando por la pestaña Básico – Móvil – Perfiles de seguridad para clientes móviles – Usuario a configurar – API abierta (licencia desarrollador) – Opciones. |
| MD5() | Encripta una cadena en MD5 | Esta función es la encargada de encriptar en MD5 cualquier string que se envíe en el llamado de la función, retornará el string ya encriptado. |
| GetListaTitulos() | Retorna el listado de valores de un campo del sistema. |
Esta función es la encargada de retornar los valores para las listas de selección del sistema, como por ejemplo: Tipos de unidad de medida, Clases de operaciones, Tipos de documentos de los terceros, entre otros.
Estos listados de selección están almacenados en el sistema como tablas virtuales, es decir, tabla de tablas. En una tabla de la base de datos se almacena información de muchas tablas, esto aplica cuando las tablas son pequeñas. Las listas de selección pueden tener código y nombre o pueden contener otros valores adicionales, para conocer la información de cada lista de selección disponible en el sistema, consulte el “Anexo 1” de este documento. |
| Documentación de apoyo | ||
| Nombre documento | Tipo | Descripción |
| SeguridadAcciones | Documentación de las acciones del sistema | |
| Arriba↑ | ||
| Catálogo de terceros | ||
| Funciones relacionadas con terceros | ||
| Nombre función | Nombre corto | Descripción |
| GetListaTerceros() | Retorna el listado de terceros registrados en el sistema |
Esta función es la encargada de retornar la información de un listado de terceros registrados en el sistema. Retornará para cada tercero la información que sea solicitada.
Esta función aplica seguridad de datos para retornar el listado de terceros y seguridad de acciones para determinar si se tiene o no acceso al catálogo de terceros. Esta función se debe utilizar cuando se van mostrar los terceros a manera de catálogo. |
| GetListaSeleccion() | Retorna un listado de terceros para ser presentado en un selector. |
Esta función es la encargada de retornar un listado de terceros registrados en el sistema, generalmente retorna de cada tercero el código y el nombre.
Esta función se debe utilizar cuando se requiera mostrar un listado de terceros en un selector, es decir, una lista de selección en la que el usuario pueda elegir una opción. Esta función aplica seguridad de datos al momento de retornar el listado de terceros para el selector. Solo retorna los terceros que estén marcados como “Visible en selección”. |
| GetInfoTercero() | Retorna la información de un tercero registrado en el sistema. |
Función encargada de retornar la información de un tercero. Existen 3 formas de obtener la información de un tercero:
|
| DoCrearTercero() | Crea un tercero. |
Función encargada de registrar toda la información de un tercero en la base de datos. Esta función retorna true cuando el tercero se crea satisfactoriamente o false cuando no se puede crear.
Esta función recibe en el parámetro “datajson” toda la información que se registrará en la base de datos, es obligatorio que dicha información vaya agrupada por secciones tal y como se explica más adelante. |
| SetInfoTercero() | Modifica la información de un tercero | Esta función es la encargada de modificar la información de un tercero en la base de datos, recibe los datos que se actualizarán agrupados por secciones. Si no se envía una sección el agente la omitirá, pero si se envía una sección vacía la información que haya almacenada en la base de datos se eliminará. Por ejemplo, si se envía la sección “lista de direcciones” así: {"listadirecciones":[]} el sistema eliminará toda la información que haya registrada de la lista de otras direcciones del tercero. |
| GetConfigCampos() | Retorna la configuración de los campos del catálogo de terceros |
Esta función es la encargada de retornar la configuración para cada campo del catálogo de terceros, dicha configuración es asignada en el sistema ContaPyme / AgroWin en la opción “Configuración” del catálogo de terceros.
Por cada campo retorna: Si es visible, requerido o de solo lectura, valor por defecto, etiqueta, tipo de lista y configuración para las listas. |
| GetExisteTercero() | Valida si un tercero ya existe | Esta función es la encargada de validar si un tercero ya existe en la base de datos, recibe el código del tercero a validar y retorna True si el tercero existe o False si el tercero no existe en la base de datos. |
| GetValidarNuevoIdTercero() | Valida si el código de un tercero es correcto | Esta función es la encargada de validar si el código (init) de un nuevo tercero y su dígito de verificación son correctos, es decir, valida que no contengan caracteres especiales. También valida que el dígito de verificación sea el correspondiente para el código recibido. |
| DoEliminarTercero() | Elimina un tercero del sistema. |
Esta función es la encargada de eliminar un tercero de la base de datos, esta función se debe ejecutar en dos pasos, así:
|
| DoRecodificarTercero() | Recodifica un tercero | Esta función es la encargada de recodificar un tercero, es decir, cambia el código de identificación del tercero tanto en el catálogo de terceros como en las operaciones en las que esté relacionado. |
| DoConsolidarTercero() | Consolida la información de dos terceros. | Esta función es la encargada de consolidar la información de un tercero con otro, para poder llamar la función es necesario conocer el código del tercero origen y el código del tercero destino. |
| GetAutoLista() | Retorna el listado de valores que posee un campo en particular |
Esta función es la encargada de retornar la lista de valores que tiene registrados un campo en el catálogo de terceros. Por ejemplo, permite obtener las diferentes profesiones o tratamientos registrados en los terceros, los listados para los campos Clase 1, Clase 2, Dato 1, Dato 2, entre otros.
Las auto-listas retornan datos que generalmente son presentados en campos de tipo Combobox. Esta función se debe llamar en cada campo que presente un listado de datos; para saber cuáles campos son de tipo auto-lista, la función GetConfigCampos retornará en estos campos el parámetro “itdlista” en 1. |
| GetFotoTercero() | Retorna la foto de un tercero. | Esta función es la encargada de retornar la foto que tenga asignada el tercero en el sistema. |
| GetClasificacionSegunPerfil() | Retorna los perfiles de clasificación tributaria registrados en el sistema |
Esta función es la encargada de retornar la información de los perfiles de clasificación tributaria que se encuentran registrados en el sistema y que se pueden asignar a un tercero.
Hay dos perfiles de clasificación tributaria definidos por defecto:
Estos perfiles contienen la definición de la clasificación tributaria y por cada uno de ellos se retornan las opciones de Clasificación tributaria que se deben activar para el tercero. |
| GetClasificacionTributaria() | Retorna los tipos de clasificación tributaria registrados en el sistema. |
Esta función es la encargada de retornar la información de los tipos de clasificación tributaria que se pueden asignar a un tercero.
Un ejemplo de clasificación tributaria es: Persona natural, persona jurídica, régimen común, régimen simplificado, entre otros. |
| GetOperacionesPorTercero() | Retorna la cantidad de operaciones en las que está relacionado un tercero. | Esta función es la encargada de retornar la cantidad de operaciones por cada tipo de documento en las que está relacionado el tercero dado, bien sea como tercero de transacción o como tercero de cartera, se incluyen las operaciones tanto procesadas como no procesadas. |
| GetDefDigitoVerif() | Valida si el campo dígito de verificación es visible o no | Esta función es la encargada de validar si el campo dígito de verificación es visible o no cuando se cree un tercero. El dígito de verificación va asociado al tipo de documento del tercero. |
| GetDefEntidades() | Retorna el listado de entidades a las que puede estar asociado un tercero de tipo empleado. | Esta función es la encargada de retornar la información de las diferentes entidades a las que puede estar afiliado un tercero de tipo empleado, entidades tales como: EPS, Pensión, Cesantías, ARL, entre otras. |
| GetDigitoVerifEsperado() | Calcula y retorna el dígito de verificación para la identificación de un nuevo tercero | Esta función es la encargada de calcular y retornar el dígito de verificación para el código de un tercero que se esté creando. |
| GetListaFichas() | Retorna la información de las fichas en las que se puede presentar la información financiera de un tercero. | Función encargada de retornar el código y nombre de las fichas en las que se puede presentar la información financiera del tercero. Con estas fichas se define la presentación que tendrá la información financiera del tercero en la aplicación ContaPyme móvil. |
| GetFichaFinanciera() | Retorna el listado de fichas de favoritos financieros para un tipo de tercero |
Esta función es la encargada de retornar la lista de fichas de favoritos financieros que aplican para un tipo de tercero dado. Las fichas de información financiera según tipo de tercero se configuran en ContaPyme / AgroWin – en la pestaña Básico – Opción: Móvil – Opción: Saldos favoritos por terceros
Esta función retorna las cuentas que se deben consultar obtener el saldo del favorito financiero. |
| Documentación de apoyo | ||
| Nombre documento | Tipo | Descripción |
| InfoBasica | Documentación de los campos de la información básica del tercero. | |
| TipoTercero | Documentación de los campos de la información de los tipos de tercero. | |
| ListaContactos | Documentación de los campos relacionados con los contactos asociados a un tercero | |
| ListaDirecciones | Documentación de los campos relacionados con lista de direcciones asociadas a un tercero | |
| DatosVendedor | Documentación de los campos relacionados con los perfiles de vendedor | |
| EntidadesEmpleado | Documentación de los campos relacionados con las entidades de un tercero de tipo empleado | |
| ConceptosNominaContable | Documentación de los campos relacionados con los conceptos de nómina contable de un tercero de tipo empleado | |
| LineasProductos | Documentación de los campos relacionados con las líneas de productos que ofrece un proveedor | |
| ListaElemInvProveedor | Documentación de los campos relacionados con elementos de inventario que ofrece un proveedor | |
| ListaProductosComprados | Documentación de los campos relacionados con los productos comprados a un proveedor. | |
| Arriba↑ | ||
| Catálogo de operaciones | ||
| Funciones relacionadas con operaciones | ||
| Nombre función | Nombre corto | Descripción |
| GetListaOperaciones() | Retorna un listado de operaciones registradas en el sistema. |
Esta función es la encargada de retornar el listado de las operaciones registradas en el catálogo de operaciones del sistema, retorna para cada operación la información que sea solicitada.
Con esta función es posible obtener todas las operaciones registradas u obtener un tipo de operación en particular, por ejemplo: obtener todos los pedidos o facturas registradas en el sistema. |
| GetCountOperaciones() | Retorna la cantidad de operaciones registradas en el sistema | Esta función es la encargada de retornar la cantidad de operaciones que hay registradas en el sistema, agrupadas por tipo de operación. |
| DoExecuteOprAction() | Permite la ejecución de una acción sobre una o varias operaciones en el sistema. Acciones como Crear, guardar, cargar, procesar, desprocesar, verificar o anular. |
Función que permite la ejecución de una acción sobre una o varias operaciones según el caso. Esta función permite:
Para ejecutar alguna de las acciones descritas anteriormente, es necesario conocer el tipo de operación sobre la que se realizará la acción, en algunos casos es necesario conocer el número de la operación sobre la que se ejecutará la acción. Para conocer los tipos de operación (itdoper) disponibles, consulte el documento “InfoOperaciones\TiposDeOperaciones” |
| GetAutoLista() | Retorna los valores que tiene registrados un campo en el catálogo de operaciones |
Esta función es la encargada de retornar la lista de valores que tiene registrados un campo en el catálogo de operaciones.
Las auto-listas retornan datos que generalmente son presentados en campos de tipo Combobox. Esta función se debe llamar en cada campo que presente un listado de datos; para saber cuáles campos son de tipo auto-lista, la función “GetConfig” de cada operación, retornará en estos campos el parámetro “itdlista” en 1. |
| GetListaCondicionesAdicionales() | Condiciones adicionales para las operaciones de cotización y pedido de un cliente | Esta función es la encargada de retornar el listado de condiciones adicionales que se pueden definir para las operaciones de pedido de un cliente y cotización. Este listado va asociado a las condiciones comerciales de un pedido o una cotización. |
| GetListaFormasEnvio() | Formas de envío que se pueden definir para las operaciones de cotización y pedido. |
Esta función es la encargada de retornar el listado de las formas de envío que se pueden definir para las operaciones de pedido de un cliente y cotización.
Este listado va asociado a las condiciones comerciales de un pedido o una cotización. |
| GetListaFormasPago() | Formas de pago que se pueden definir para las operaciones de cotización y pedido de un cliente |
Esta función es la encargada de retornar el listado de formas de pago que se pueden definir para las operaciones de pedido de un cliente y cotización.
Este listado va asociado a las condiciones comerciales de un pedido o una cotización. |
| GetListaSucursales() | Listas de sucursales (otras direcciones) que tiene registradas un tercero. |
Esta función es la encargada de retornar el código y nombre de las sucursales (otras direcciones) que tenga configuradas el tercero principal de la operación.
Esta función se utiliza en la operación de pedido de un cliente. |
| GetValoresVentaProducto() | Retorna el precio de venta de un producto |
Esta función es la encargada de retornar el precio de venta de un producto de acuerdo a la bodega de la que se egresará el mismo, la lista de precios que tenga definida y la fecha de soporte de la operación.
Adicionalmente, retorna el porcentaje de IVA y el porcentaje de descuento aplicable al producto de acuerdo a la configuración del tercero de la operación. También, retorna el código del centro de costos por defecto al que se debe cargar el valor del ingreso recibido por la orden o venta del producto. |
| GetValoresVentaCliente() | Retorna el código de la lista de precios por defecto de un tercero de tipo cliente. |
Esta función es la encargada de retornar el código de la lista de precios que tiene asignada por defecto un tercero de tipo cliente, esto con el fin de poder mostrar en las operaciones los precios de los productos según dicha lista de precios.
También retorna el código del vendedor asignado al cliente. |
| GetOpcionesCuentaFormaCobro() | Retorna la configuración que se debe aplicar a una cuenta cuando se utilice en la forma de cobre de una operación |
Esta función es la encargada de retornar la configuración que se debe aplicar a una cuenta cuando se utilice en la forma de cobro de una operación.
Estas configuraciones están relacionadas principalmente con el manejo de flujo de efectivo y de conciliación bancaria, pueden ser usadas en las aplicaciones cliente para ocultar o visualizar campos en la forma de cobro por cada medio de pago. |
| GetDocumentoOperacion() | Retorna el documento de impresión de la operación, en PDF. | Esta función es la encargada de retornar el documento de impresión en PDF de una operación dada. Para realizar el llamado de esta función es necesario enviar el tipo de documento de impresión en el cual se imprimirá la operación y el número de la operación a imprimir. |
| GetProductosPorReferencia() | Retorna los productos de una referencia |
Esta función es la encargada de retornar los productos asociados a una referencia dada, permitiendo cargar productos de otra operación en la operación actual. Por ejemplo, estando en un pedido es posible cargar como referencia una cotización para que así no sea necesario volver a registrar todos los productos nuevamente.
El manejo de referencias aplica para las operaciones relacionadas con compras y ventas en inventarios. |
| GetListaClasesOperacion() | Retorna las clases de operación registradas en el sistema | Esta función es la encargada de retornar el código y nombre de las clases de operación registradas en el sistema. La clase de operación permite clasificar las operaciones de acuerdo a las necesidades particulares del usuario. |
| GetDiasHabiles() | Retorna la cantidad de días hábiles que hay entre dos fechas. |
Esta función es la encargada de calcular y retornar la cantidad de días hábiles que hay entre dos fechas o la fecha hábil de acuerdo a un número de días dados.
El sistema permite configurar los días hábiles de trabajo en la semana, teniendo en cuenta esta configuración la función calculará las fechas o el número de días hábiles. Hay dos posibilidades de respuesta de acuerdo a los parámetros que se envíen a la función:
Esta función se utiliza para calcular la fecha estimada de entrega de las órdenes de producción, pedidos, etc. También se utiliza para calcular la fecha de vigencia de una cotización. |
| GetListaMonedas() | Retorna la lista de monedas registradas en el sistema. | Esta función es la encargada de retornar la información de las monedas configuradas en el sistema. |
| GetNumeroDocumento() | Retorna el número de documento de una operación |
Esta función es la encargada de retornar el número de documento de una operación ya formateado según la configuración del tipo de documento de soporte.
Esta función se debe llamar cada vez que se cambie alguno de los siguientes datos de una operación:
|
| GetSimboloMoneda() | Retorna el simbolo que identifica a una moneda |
Esta función es la encargada de retornar el símbolo de una moneda especificada en la petición.
Esta función es utilizada para que al momento de mostrar valores en las operaciones éstos se presenten con el símbolo de moneda correspondiente, bien sea la moneda de la operación o la moneda local por defecto. |
| GetTasaCambioPorMoneda() | Retorna la tasa de cambio actual para una moneda | Esta función es la encargada de calcular y retornar la tasa de cambio actual para la moneda que se envía en el llamado de la función. |
| GetValoresAbonoPorICxX() | Retorna el saldo actual de una cuenta por cobrar o por pagar de un tercero. | Esta función es la encargada de retornar el saldo actual de una cuenta por cobrar o por pagar de un tercero, esto con el fin de mostrar el valor de la deuda y poder registrar el abono. También retorna el código del vendedor que originó la venta (si aplica). |
| GetRefCotizaciones() | Retorna el listado de referencias de cotizaciones que tenga registradas un tercero | Esta función es la encargada de retornar un listado de referencias de cotizaciones que tenga registradas un tercero a una fecha determinada. Esto aplica para cargar referencias en las operaciones de cotización al cliente y pedido de un cliente. |
| GetListaSaldosCxC() | Retorna el listado de saldos de cuentas por cobrar que tiene un tercero | Esta función es la encargada de retornar el listado de saldos de cuentas por cobrar que tiene un tercero. Es utilizada para registrar abonos a cuentas por cobrar. |
| GetSaldosCuentasPorCobrar() | Retorna el listado de saldos de cuentas por cobrar y sus datos asociados, hasta una fecha determinada. |
Esta función es la encargada de retornar el listado de saldos de cuentas por cobrar y sus datos asociados, hasta una fecha determinada.
Retorna un arreglo de objetos que contienen la cuenta, tercero, referencia, saldo en moneda local y extranjera (si es del caso), fecha de último pago, fecha de vencimiento, etc. |
| GetListaSaldosCxP() | Retorna un Json con la lista de saldos de cuentas por pagar a un tercero. | Esta función es la encargada de retornar el listado de saldos de cuentas por pagar que se tiene con un tercero. Generalmente es utilizada para realizar abonos a cuentas por pagar, generar listados de pagos a proveedores o consultar cuentas por pagar a vencer. |
| Documentación de apoyo | ||
| Nombre documento | Tipo | Descripción |
| InfoBasicaOperacion | Documentación de los campos de la información básica de una operación | |
| TiposDeOperaciones | Listado de los tipos de operación que tiene el sistema | |
| InfoRefCotizaciones | Documentación de los campos de información de las referencias de cotizaciones | |
| InfoSaldoCxC | Documentación de los campos que almacenan la información calculada de los saldos de cuentas por cobrar o por pagar en un momento dado. | |
| Arriba↑ | ||
| Catálogo de empresas | ||
| Funciones relacionadas con empresas | ||
| Nombre función | Nombre corto | Descripción |
| GetListaEmpresas() | Retorna el listado de empresas creadas en el sistema | Función encargada de retornar la información de las empresas de trabajo registradas en el sistema. |
| GetListaSedes() | Retorna el listado de sedes creadas en el sistema | Función encargada de retornar el código y nombre de todas las sedes asociadas a la empresa de trabajo a la que el usuario está conectado. |
| GetInfoEmpresa() | Retorna la información de la empresa de trabajo a la que el usuario se encuentra conectado | Esta función es la encargada de retorna la información básica de la empresa de trabajo a la que el usuario se encuentra conectado. |
| GetLogoEmpresa() | Retorna el logo de la empresa de trabajo a la que está conectado el usuario | Esta función es la encargada de retornar el logo que tiene la empresa de trabajo en el sistema. |
| Arriba↑ | ||
| Catálogo de centros de costos | ||
| Funciones relacionadas con centros de costos | ||
| Nombre función | Nombre corto | Descripción |
| GetListaCentrosCostos() | Retorna el listado de centros de costos registrados en el sistema | Esta función es la encargada de retornar la información de todos los centros de costos registrados en el sistema. Este listado se retorna de acuerdo a la empresa de trabajo a la que el usuario esté conectado. |
| GetListaClasesCC() | Retorna un listado de centros de costos para ser presentado en un selector. | Esta función es la encargada de retornar el código y nombre de las clases de centros de costos creados en el sistema. |
| Arriba↑ | ||
| Catálogo de países | ||
| Funciones relacionadas con países | ||
| Nombre función | Nombre corto | Descripción |
| GetListaPaises() | Retorna la información de todos los paises registrados en el sistema | Esta función es la encargada de retornar el código y el nombre de todos los países que se encuentren registrados en el sistema. |
| GetListaDepartamentos() | Retorna la información de los departamentos de un país. | Esta función es la encargada de retornar el código y nombre de todos los departamentos registrados en el sistema para un país. |
| GetListaMunicipios() | Retorna la información de los municipios de un departamento | Esta función es la encargada de retornar el código y nombre de los municipios registrados en el sistema para un departamento. Estos municipios se pueden obtener de dos formas: enviando el código del país y el código del departamento o enviando solo el código del país, pues hay municipios asociados a un país pero que no tienen departamento. |
| Arriba↑ | ||
| Catálogo de tipos de documento de soporte | ||
| Funciones relacionadas con tipos de documento de soporte | ||
| Nombre función | Nombre corto | Descripción |
| GetListaTiposDocSop() | Retorna el listado de los tipos de documento de soporte registrados en el sistema |
Esta función es la encargada de retornar la información de un listado de tipos de documento de soporte registrados en el sistema. Retornará para cada tipo de documento la información que sea solicitada.
Esta función se debe utilizar cuando se van mostrar los tipos de documento de soporte a manera de catálogo. |
| GetListaSeleccion() | Retorna un listado de tipos de documento de soporte para ser presentado en un selector. |
Esta función es la encargada de retornar un listado de tipos de documento de soporte registrados en el sistema, generalmente retorna de cada tipo de documento el código y el nombre.
Esta función se debe utilizar cuando se requiera mostrar un listado de tipos de documento de soporte en un selector, es decir, una lista de selección en la que el usuario pueda elegir una opción. |
| Documentación de apoyo | ||
| Nombre documento | Tipo | Descripción |
| InfoBasica | Documentación de los campos de la información básica de los tipos de documento de soporte. | |
| Arriba↑ | ||
| Catálogo de perfiles de cliente - proveedor | ||
| Funciones relacionadas con perfiles de cliente - proveedor | ||
| Nombre función | Nombre corto | Descripción |
| GetListaPerfiles() | Retorna el listado de los perfiles de cliente o vendedor registrados en el sistema |
Esta función es la encargada de retornar la información de un listado de perfiles de cliente o vendedor registrados en el sistema. Retornará para cada perfil la información que sea solicitada.
Esta función se debe utilizar cuando se van mostrar los perfiles de cliente a manera de catálogo. |
| Documentación de apoyo | ||
| Nombre documento | Tipo | Descripción |
| InfoBasica | Documentación de los campos de la información básica de los perfiles de cliente o vendedor | |
| Arriba↑ | ||
| Catálogo de observaciones de operaciones | ||
| Funciones relacionadas con observaciones de operaciones | ||
| Nombre función | Nombre corto | Descripción |
| GetListaObservacionesOprs() | Retorna el listado de las observaciones que se pueden asignar a una operación |
Esta función es la encargada de retornar la información de un listado de observaciones para las operaciones registradas en el sistema. Retornará para cada observación la información que sea solicitada.
Esta función se debe utilizar cuando se van mostrar las observaciones para las operaciones a manera de catálogo. |
| GetListaSeleccion() | Retorna un listado de observaciones de operaciones para ser presentado en un selector. |
Esta función es la encargada de retornar un listado de observaciones para las operaciones registradas en el sistema, generalmente retorna de cada observación el código y el nombre.
Esta función se debe utilizar cuando se requiera mostrar un listado de observaciones para las operaciones en un selector, es decir, una lista de selección en la que el usuario pueda elegir una opción. |
| Documentación de apoyo | ||
| Nombre documento | Tipo | Descripción |
| InfoBasica | Documentación de los campos de la información las observaciones para operaciones | |
| Arriba↑ | ||
| Catálogo de plan de cuentas | ||
| Funciones relacionadas con plan de cuentas | ||
| Nombre función | Nombre corto | Descripción |
| GetListaCuentas() | Retorna el listado de cuentas del Plan único de cuentas registradas en el sistema. |
Esta función es la encargada de retornar la información de un listado de cuentas registradas en el sistema. Retornará para cada cuenta la información que sea solicitada.
Esta función aplica seguridad de datos para retornar el listado de cuentas y seguridad de acciones para determinar si se tiene o no acceso al catálogo de Plan de cuentas. Esta función se debe utilizar cuando se van mostrar las cuentas a manera de catálogo. |
| GetListaSeleccion() | Retorna un listado de cuentas para ser presentadas en un selector. |
Esta función es la encargada de retornar un listado de cuentas registradas en el sistema, generalmente retorna de cada cuenta el código y el nombre.
Esta función se debe utilizar cuando se requiera mostrar un listado de cuentas en un selector, es decir, una lista de selección en la que el usuario pueda elegir una opción. Esta función aplica seguridad de datos al momento de retornar el listado de cuentas para el selector. Sólo retorna las cuentas que estén marcadas como “Visible en selección”. |
| GetInfoCuenta() | Retorna la información de una cuenta registrada en el sistema. |
Función encargada de retornar la información de una cuenta. Existen 3 formas de obtener la información de una cuenta:
|
| DoCrearCuenta() | Crea una cuenta en el Plan único de cuentas. |
Función encargada de registrar toda la información de una cuenta en la base de datos. Esta función retorna true cuando la cuenta se crea satisfactoriamente o false cuando no se puede crear.
Esta función recibe en el parámetro “datajson” toda la información que se registrará en la base de datos, es obligatorio que dicha información vaya agrupada por secciones tal y como se |
| SetInfoCuenta() | Modifica la información de una cuenta. | Esta función es la encargada de modificar la información de una cuenta en la base de datos, recibe los datos que se actualizarán agrupados por secciones, si no se envía una sección el agente la omitirá, pero si se envía una sección vacía la información que haya almacenada en la base de datos se eliminará. Por ejemplo, si se envía la sección “Conceptos de nómina contable” así: {"conceptosnominacontable":[ ]} el sistema eliminará toda la información que haya registrada de los conceptos de nómina contable asociados a una cuenta. |
| GetConfigCampos() | Retorna la configuración de los campos del catálogo de plan de cuentas. |
Esta función es la encargada de retornar la configuración para cada campo del catálogo de Plan de cuentas, dicha configuración es asignada en el sistema ContaPyme / AgroWin en la opción “Configuración” del catálogo de Plan de cuentas.
Por cada campo retorna: Si es visible, requerido o de solo lectura, valor por defecto, etiqueta, tipo de lista y configuración para las listas. |
| GetExisteCuenta() | Valida si una cuenta ya existe. | Esta función es la encargada de validar si una cuenta ya existe en la base de datos, recibe el código de la cuenta a validar y retorna True si la cuenta existe o False si la cuenta no existe en la base de datos. |
| GetValidarNuevoIdCuenta() | Valida si el código de una cuenta es correcto. | Esta función es la encargada de validar si el código (icuenta) de una nueva cuenta es correcto, es decir, valida que no contenga caracteres especiales. Agente retornará solo los elementos de inventario que tengan activa la opción de “Visible en internet (programa Agente)”. |
| DoEliminarCuenta() | Elimina una cuenta del sistema. |
Esta función es la encargada de eliminar una cuenta de la base de datos, esta función se debe ejecutar en dos pasos, así:
|
| DoRecodificarCuenta() | Recodifica una cuenta. | Esta función es la encargada de recodificar una cuenta, es decir, cambia el código de identificación de la cuenta tanto en el catálogo de plan de cuentas como en las operaciones en las que esté relacionada. |
| DoConsolidarCuenta() | Consolida la información de dos cuentas. | Esta función es la encargada de consolidar la información de una cuenta con otra, para poder llamar la función es necesario conocer el código de la cuenta origen y el código de la cuenta destino. |
| GetListaClases() | Retorna el listado de clases de cuenta registrados en el sistema. |
Esta función es la encargada de retornar el código y la descripción de cada una de las clases que se pueden asignar a una cuenta.
Una cuenta puede ser de clase normal, de efectivo, de impuestos, de ajustes por inflación o de nómina contable. |
| GetListaTiposImpuestos() | Retorna el listado de los tipos de impuestos que se pueden asignar a una cuenta. | Esta función es la encargada de retornar el código y la descripción de los tipos de impuestos que se pueden asignar a una cuenta, esto aplica cuando la cuenta de tipo 3 “De impuestos”. |
| GetListaTipoCuenta() | Retorna el listado de tipos de cuenta registradas en el sistema. |
Esta función es la encargada de retornar el código y nombre de los tipos de cuentas disponibles en el sistema.
Una cuenta puede tener uno de los siguientes tipos: Activo, Pasivo, Patrimonio, Ingresos, Egresos, De orden deudora o De orden acreedora. |
| GetMaxNivelDetalle() | Retorna el número máximo de niveles que tiene la estructura del plan de cuentas. | Esta función es la encargada de retornar el número máximo de niveles que tiene la estructura del plan de cuentas en el sistema. |
| GetIsBalance() | Valida si una cuenta es de balance o no. | Esta función es la encargada de validar de acuerdo al tipo de cuenta si es de balance o no. Recibe el tipo de cuenta y retorna True si es de balance o false si no lo es. |
| GetIngresoEgresoForICuenta() | Retorna el tipo de concepto de liquidación de una cuenta. |
Esta función es la encargada de retornar el tipo de concepto de liquidación de una cuenta, para ello es necesario enviar en el llamado de la función el tipo de cuenta.
Una cuenta puede tener el tipo de concepto de liquidación en ingreso o en egreso. |
| GetTipoContabilizacion() | Retorna el tipo de contabilización (local o NIIF) que tiene configurada el sistema. | Esta función es la encargada de retornar el tipo de contabilización que tiene configurado el sistema a una fecha determinada. La contabilización puede ser solo LOCAL, solo NIIF o Ambas. |
| Documentación de apoyo | ||
| Nombre documento | Tipo | Descripción |
| InfoBasica | Documentación de los campos de la información básica de las cuentas. | |
| ConceptosNominaContable | Documentación de los campos relacionados con los conceptos de nómina contable de una cuenta. | |
| Arriba↑ | ||
|
Aún no hay operaciones disponibles para éste módulo. |
| Informes | ||
| Funciones relacionadas informes | ||
| Nombre función | Nombre corto | Descripción |
| GetPDF() | Retorna el PDF de cualquier reporte disponible en el sistema. |
Esta función es la encargada de retornar en formato PDF cualquier reporte disponible en el sistema.
Para llamar un reporte se debe definir en el parámetro “datajson” los siguientes elementos:
|
| GetTiposPapel() | Retorna los tipos de papel en los que se pueden generar los informes del sistema | Esta función es la encargada de retornar el listado de tipos de papel que se pueden usar para generar algunos informes del sistema. |
| Arriba↑ | ||
|
Usted no tiene permisos para acceder a la documentación de la API del Agente de servicios web. |