sdk contpaq i bancos
-
Upload
kamilo-rodriguez -
Category
Documents
-
view
351 -
download
28
description
Transcript of sdk contpaq i bancos
SDK CONTPAQ i
PAGE
SDK CONTPAQ i
BANCOS
www.contpaqi-bancos.comAviso de derechos del propietario
Este Manual es una Obra Literaria protegida en favor de Computacin en Accin, S.A. de C.V.; Copyright 2005-2006 Derechos Reservados2005-2006 Computacin en Accin, S.A. de C.V., Pablo Villaseor No. 435, Col. Ladrn de Guevara, Guadalajara, Jalisco, Mxico. C.P. 44600. Los Derechos de este Manual se encuentran reconocidos por la Ley Federal del Derecho de Autor. Se prohbe su produccin, reproduccin, publicacin, edicin o fijacin material en copias o ejemplares, por cualquier medio, importacin,almacenamiento, transporte, distribucin, comercializacin, venta o arrendamiento, as como sucomunicacin y transmisin pblica por cualquier medio, su divulgacin en cualquier modalidad, su traduccin, adaptacin, parfrasis, arreglos, transformaciones u otras similares, sin previa autorizacin por escrito de su titular. La violacin de esta prohibicin constituyen un delito y una infraccin administrativa que estn sancionados conforme a los artculos 424 fraccin III, 424 bis fraccin I y 424 ter, del Cdigo Penal Federal;as como los artculos 229 fracciones VII y XVI y 231 fracciones I, III,IV y X, de laLey Federal del Derecho de Autor y dems normas aplicables vigentes.
Las marcas COMPUTACIN EN ACCIN , EN ACCIN, PAQ y sus respectivos diseos; la marca y nombre comercial COMPAC y su diseo; las marcas ES TIEMPO DE PODER, LA CONEXIN DE TU NEGOCIO, TU NEGOCIO SIEMPRE EN MARCHA, SOAR. PODER. CRECER.; Los avisos comerciales Bien Pensado, Respuesta Oportuna, y La Forma ms Amigable de Controlar tu Negocio; as como la Imagen del Foquito y del Diseo de la Portada, son signos distintivos registrados y protegidos propiedad de Computacin en Accin, S.A. de C.V.
AdminPAQ, MegaPAQ, Exin, ContPAQ , CONTPAQ i , CheqPAQ, NomiPAQ, WinPAQ, Solucin Contable PAQ,ProduPAQ y VentPAQ, tambin son marcas registradas y protegidas propiedad de Computacin en Accin, S.A. de C.V., la que ostenta de igual forma los derechos patrimoniales de autor
Microsoft , MS-D.O.S. , WINDOWS y Excel , son marcas y en su caso productos de Microsoft Corporation.
Fecha de edicin: 21 de Abril de 2009Versin: CONTPAQ i BANCOS 1.1.0ndice
TemaPgina
SDK CONTPAQ i BANCOSConceptos generales
Qu es el SDKEs una serie de recursos que permiten interactuar a nivel programacin a travs de funciones o mtodos con la base de datos de CONTPAQ i BANCOS, asegurando la integridad y consistencia de la misma.
Obtiene su nombre por sus siglas en ingls SDK (Software Development Kit).
Beneficios del SDKAl utilizar el SDK podr tener acceso de lectura y escritura a las bases de datos de las empresas instaladas en CONTPAQ i BANCOS desde un accesorio o aplicacin externa; garantizando la integridad y consistencia de la informacin as como la concurrencia de las aplicaciones en un ambiente multiusuario.
Funcionamiento del SDK de CONTPAQ i BANCOSLa comunicacin entre la plataforma de CONTPAQ i BANCOS y el accesorio o aplicacin de un tercero se realiza a travs de un componente COM, que a su vez tiene Dlls auxiliares.
Este componente COM funciona como intermediario entre la aplicacin o mdulo con la plataforma.
En el siguiente grfico se muestra el funcionamiento de SDK de CONTPAQ i BANCOS.
Contina en la siguiente pginaConceptos generales, Continuacin
Que es un componente COMEs una arquitectura de software que permite construir aplicaciones a partir de componentes (mdulos) de software binarios esto implica que es independiente del lenguaje de programacin para objetos y la intercomunicacin entre ellos.
Obtiene el nombre por sus siglas en ingls COM (Component Object Model).
Funcionamiento de un COMEs un componente de software que provee servicios orientados a objetos a travs de interfaces, una interfaz se define como un conjunto de mtodos (funciones) y propiedades relacionadas. El componente COM por definicin utiliza mtodos y propiedades.
El modelo de COM se forma de una relacin maestro-esclavo, es decir, existe un Servidor, que pone a disposicin un conjunto de servicios y un cliente que es cualquier cdigo u objeto que hace uso de los servicios que este posee cuando llama sus interfaces.
Requerimientos para desarrollarLos requisitos para desarrollar un modelo com se debe tener en cuenta lo siguiente:
Especificar de manera independiente el lenguaje de programacin, cualquier lenguaje que soporte la interfaz COM puede hacer uso del SDK de CONTPAQ i BANCOS Tener instalado el SDK de CONTPAQ i BANCOS a partir de la versin 1.1.0. Se sugiere instalar la ltima versin sin costo disponible de CONTPAQ i BANCOS Espacio disponible de disco duro de 157 MB
Beneficios y limitantes de desarrolloEn la siguiente tabla se compara los beneficios contra las limitantes del desarrollo de aplicaciones utilizando el componente COM.
BeneficiosLimitantes
Reglas de negocio validadas por el SDK.Dependiente del lenguaje en la capacidad de cargar un componente COM.
Conexin a varias empresas a la vez.No se pueden realizar procesos.- verificacin de plizas, reconstruccin de saldos.
Instalador independiente.No se pueden crear preplizas.
Documentacin y ayuda dentro del mismo componente.Migracin de mdulos desarrollados con el Poldll32, Catadll32 y BDFWin32 de ContPAQ Windows, requiere reprogramar.
Creacin, modificacin y borrado de catlogos y documentos (Plizas).-----
Soporta el acceso remoto.-----
Funciones de la hoja Electrnica.-----
Contina en la siguiente pginaConceptos generales, Continuacin
Archivos que se instalanAl instalar el SDK de CONTPAQ i BANCOS se crea la carpeta Cliente en la ruta .Dentro de ella se crean entradas en el registro para SDKContPAQNG.dll, en la siguiente tabla se muestran los archivos restantes que se instalan, as como una breve descripcin:
ArchivoDescripcin
ContPAQ_NG_DLL.dllContiene el SDK de CONTPAQ i BANCOS y sus reglas de negocio.
SDKContPAQNG.dll (COM.dll)Funciones, mtodos y propiedades.
ContPAQ_NG_Config.exePrograma configuracin del acceso como cliente de CONTPAQ i BANCOS
*C4dll32.dll
*catadll32.dll
*poldll32.dll
*dbfwin32.dllSon Dlls con compatibilidad CONTPAQ i BANCOS
NotasTome en cuenta lo siguiente:
El SDK es un cliente de CONTPAQ i BANCOS por lo tanto consumir licencia.
Dependiendo de los recursos de la mquina (memoria) es posible manejar informacin de varias empresas a la vez.
Qu no est soportadoEn cuanto a lo que no est soportado en este momento por el componente COM:
Consultas No se puede ejecutar un listado, consulta de saldos, etctera Ejecutar procesos No permite verificacin de plizas, reconstruccin de saldos u otros tipos de procesos propios de CONTPAQ i BANCOS Preplizas No se podr generar preplizas
Objetos generales
TSDKSesionIntroduccinEste objeto representa a una sesin nica.
PropiedadesLas propiedades que tiene el objeto TSDKSesion son:
PropiedadTipoEntrada/SalidaDescripcin
conexionActivaLongEvala si la conexin se realiz con xito. Su uso es obligatorio.0 = Conexin no iniciada
1 = Conexin iniciada
DespliegaMensajeErrorLongObtiene el valor del ltimo mensaje.0 = Conexin no iniciada
1 = Conexin iniciada
ingresoUsuarioLongEvala si el usuario se ha conectado o no. Es de slo lectura.0 = No se firm el usuario
1 = El usuario se ha conectado
ultimoMsjErrorStringObtiene el ltimo error ocurrido en la sesin. Es de slo lectura.
MtodosLos mtodos quese pueden utilizar en el objeto TSDKSesion son:
MtodoParmetrosRetornoDescripcin
iniciaConexion--------------------Inicia la conexin al Servidor de CONTPAQ i BANCOS.
abreEmpresaLong aAliasEmpresaAbre una base de datos de empresas:
0 = No existe o no se pudo abrir la empresa.
1 = Se abre empresa.
firmaUsuario--------------------Identifica el usuario para realizar la conexin.
cierraEmpresa--------------------Finaliza la sesin de la empresa activa.
finalizaConexion--------------------Finaliza la conexin con el servidor de CONTPAQ i BANCOS.
getSdkSesionLong aSdkSesionObtiene una sesin de usuario. Valor de error o xito
0 = xito
1 = Error
Consideraciones especialesTome en cuenta lo siguiente:
Por omisin el usuario identificado se mantiene para nuevas instancias del objeto TSdkSesion a menos que para una sesin en particular se llame nuevamente el mtodo firmaUsuario.
Para abrir distintas bases de datos de empresa se requiere un objeto TSdkSesion por empresa.
Por cada empresa abierta, en una configuracin Cliente/Servidor, el nombre del usuario se registrar en la consola del Servidor de Aplicaciones COMPAC.
Objetos EmpresaTSdkEmpresa
IntroduccinEste objeto representa los datos generales de la empresa almacenada en la redefinicin de la empresa.
PropiedadesLas propiedades que tiene el objeto TSdkEmpresa son:
PropiedadTipoEntrada/SalidaDescripcin
NombreStringObtiene el nombre de la empresa activa.
IdEmpresaLongObtiene el id correspondiente a la empresa activa.
MascarillaStringObtiene la mascarilla de la estructura de cuenta en la empresa activa.
CodigoCuentaFlujo
EfectivoStringObtiene el cdigo de la cuenta para el flujo de efectivo de la empresa activa.
EjercicioActualLongObtiene el ejercicio actual de la empresa activa.
EstructuraCuentaStringObtiene la estructura de la cuenta de la empresa activa.
FechaInicioHistoriaDateObtiene la fecha en la cual se dio de alta la empresa en CONTPAQ i BANCOS.
NumeroEjerciciosLongObtiene los periodos totales del ejercicio vigente de la empresa activa.
PeriodoActualLongObtiene el periodo actual de la empresa activa.
UsaModificarPeriodos
AnterioresLongPermite registrar plizas de periodos anteriores.
0 = No permite.
1 = S permite
UsaModificarPeriodos
FuturosLongPermite registrar plizas de periodos futuros.
0 = No permite.
1 = S permite
MtodosLos mtodos que se pueden utilizar en el objeto TSdkEmpresa son:
MtodoParmetrosRetornoDescripcin
calculaEjercicioDate aFechaObtiene el ejercicio correspondiente a una fecha.
calculaPeriodoDate aFechaObtiene el nmero del periodo correspondiente a una fecha.
getEjercicioAnteriorLong aSdkEjercicio
Long pValRetObtiene el ejercicio anterior de la empresa activa.
getEjercicioPrimeroObtiene el primer ejercicio de la empresa activa.
getEjercicioSiguienteObtiene el siguiente ejercicio de la empresa activa.
getEjercicioUltimoObtiene el ltimo ejercicio de la empresa activa.
getSesionLong pValRetObtiene el objeto de la sesin de la empresa.
setSesionnewValEstabece el objeto del SDK de la sesin de la empresa.
TSdkListaEmpresas
IntroduccinPermite controlar las empresas que se manejan, de manera en la que se puede realizar listados de empresas o incluso conseguir dentro de la hoja electrnica insertar empresas con la ayuda de macros mediante VBA (Visual Basic for Applications).
PropiedadesLas propiedades que tiene el objeto TSdkListaEmpresas son:
PropiedadTipoEntrada/SalidaDescripcin
IdLongObtiene el nmero identificador de la empresa. Es de slo lectura.
NombreStringObtiene el nombre de la empresa desde la lista de empresas. Es de slo lectura.
NombreBDDStringObtiene el alias BDD de la empresa desde la lista de empresas. Es de slo lectura.
RutaDatosStringObtiene la ruta de archivos de salida de la empresa desde la lista de empresas.
RutaRespStringObtiene la ruta de respaldo de la empresa desde la lista de empresas. Es de slo lectura.
UltimaRestauracionDateObtiene el ao, mes y da de la ltima restauracin de la empresa desde la lista de empresas. Es de slo lectura.
UltimoRespaldoDateObtiene el ao, mes y da del ltimo respaldo de la empresa desde la lista de empresas. Es de slo lectura.
UltimoArchivoRespaldoStringObtiene el ltimo archivo de respaldo de la empresa desde la lista de empresas.
MtodosLos mtodos que se pueden utilizar en el objeto TSdkListaEmpresas son:
MtodoParmetrosRetornoDescripcin
buscaPorldLong aIdBusca, por nmero identificador, un registro de la lista de ermpresas.
buscaAnteriorObtiene el anterior registro de la consulta de la lista de empresas ordenada por nombre.
buscaPrimeroObtiene el primer registro de la consulta de la lista de empresas ordenadas por nombre.
buscaSiguienteObtiene el siguiente registro de la consulta de la lista de empresas ordenadas por nombre.
buscaUltimoObtiene el ltimo registro de la consulta de la lista de empresas ordenadas por nombre.
Objetos Catlogos bancariosTSdkBancoIntroduccinEste objeto representa una entidad bancaria. Esta informacin es de solo lectura, es decir, no tiene la capacidad de crear informacin en la base de datos.
PropiedadesLas propiedades del objeto TSdkBanco son:
PropiedadTipoEntrada/SalidaDescripcin
IdLongSalidaNmero identificador del banco.
CodigoStringSalidaCdigo asignado al banco.
NombreStringSalidaRazn social del banco.
LogotipoStringSalidaObtiene la ruta de donde se encuentra el logotipo del banco.
PaginaWebStringSalidaContiene la pgina oficial del banco.
ClaveFiscalStringSalidaObtiene la clave fiscal del banco.
MtodosLos mtodos del objeto TSdkBanco son:
MtodoParmetrosRetornoDescripcin
buscaPorCodigoCodigoBancoTrue/FalseVerifica la existencia de un banco en base a su cdigo.
buscaPorClaveFiscalClaveFiscalTrue/FalseVerifica la existencia de un banco en base a su clave fiscal.
buscaPorIdidBancoTrue/FalseVerifica la existencia de un banco en base al id.
getSesion----------SesionObtiene la sesion asignada al banco.
setSesionSesion----------Establece una sesin.
getCodigoError----------StringTrae el mensaje con la excepcin generada en caso de que ocurra algn error al realizar una bsqueda.
getMensajeError----------StringTrae el mensaje con la excepcin generada en caso de que ocurra algn error al realizar una bsqueda.
TSdkCategora
IntroduccinEste objeto representa las categoras de gastos. Esta informacin es de solo lectura, es decir, no tiene la capacidad de crear informacin en la base de datos.
PropiedadesLas propiedades que tiene el objeto TSdkCategoria son:
PropiedadTipoEntrada/SalidaDescripcin
IdLongSalidaNmero identificador de la categora.
CodigoStringSalidaCdigo de la categora.
NombreStringSalidaNombre de la categora.
CodigoMonedaStringSalidaCdigo de la Moneda asignada a la categora.
TipoStringSalidaIdentifica la naturaleza de la categora. Los valores que recibe son:E = Egresos
I =Ingresos
PresupuestoStringSalidaIdentifica de qu manera lleva el presupuesto:N = Ninguno
M = Mensual
A = Anual
CodigoCuentaStringSalidaCdigo de la cuenta bancaria.
CodigoCtaComplementariaStringSalidaCdigo de la cuenta complementaria.
CodigoPrepolizaStringSalidaCdigo de la prepliza de contabilidad.
IdSegNegLongSalidaIdentificador del Segmento de Negocio al que se asocia la categora.
IdDatoExtraLongSalidaIdentificador del Dato Extra al que se asocia la categora.
NivelStringSalidaDetermina si la categora es padre o hija:S = Sub-Categora o Categora sin padre
C = Categora Padre
MtodosLos mtodos que se pueden utilizar en el objeto TSdkCategoria son:
MtodoParmetrosRetornoDescripcin
buscaPorCodigoCodigoBancoTrue/FalseVerifica la existencia de un documento en base a su cdigo.
buscaPorId--------------------
buscaPorCodigo--------------------
consultaHijas_buscaPorLlaveLong IdCategoriaPadreTrue/FalseBusca todas las categoras hijas asignadas a una categora padre.
consultaHijas_buscaAnteriorLong por ReferenciaLongObtiene la categora hija anterior asignada a un padre.
consultaHijas_buscaPrimeroObtiene la primera categora hija asignada a un padre.
consultaHijas_buscaSiguienteObtiene la siguiente categora hija asignada a un padre.
consultaHijas_buscaUltimoObtiene la ltima categora hija asignada a un padre.
consultaPadres_buscaPorLlaveLong aIdCategoriaHijaTrue/FalseBusca todas las categoras padres asignadas a una categora hija.
Contina en la siguiente pginaTSdkCategora, Continuacin
Mtodos (contina)
MtodoParmetrosRetornoDescripcin
consultaPadres_buscaAnteriorLong por ReferenciaLongObtiene la categora padre anterior asignada a una categora hija.
consultaPadres_buscaPrimeroObtiene la primera categora padre asignada a una categora hija.
consultaPadres_buscaSiguienteObtiene la siguiente categora padre asignada a una categora hija
consultaPadres_buscaUltimoObtiene la ltima categora padre asignada a una categora hija.
getPorcentajeAsignacionLong aIdCategoriaPadre
Long aIdCategoriaHijaDoubleBusca la asociacin de la categora padre con su hija y devuelve el porcentaje de asignacin que tiene la categora hija.
Las categoras padre tienen asignado el 100% y pueden tener categoras hijas a las cuales les corresponde un porcentaje determinado. Entre todas las hijas debe dar el 100% que corresponde al padre.
getSesion----------SesionObtiene la sesin asignada al banco.
setSesionSesionEstablece una sesin.
getCodigoError----------StringTrae el mensaje con la excepcin generada en caso de que ocurra algn error al realizar una bsqueda.
getMensajeError----------StringTrae el mensaje con la excepcin generada en caso de que ocurra algn error al realizar una bsqueda.
TSdkPresupuestoCategoria
IntroduccinEste objeto representa el presupuesto categora. Esta informacin es de solo lectura, es decir, no tiene la capacidad de crear informacin en la base de datos.
PropiedadesLas propiedades que tiene el objeto TSdkPresupuestoCategoria son:
PropiedadTipoEntrada/SalidaDescripcin
IdLongSalidaNmero identificador del presupuesto categora.
IdCategoriaLongSalidaNmero identificador de la categora.
EjercicioLongSalidaAo de vigencia del presupuesto
Importe1CurrencySalidaImporte monetario correspondiente al periodo 1
Importe2CurrencySalidaImporte monetario correspondiente al periodo 1
Importe3CurrencySalidaImporte monetario correspondiente al periodo 1
Importe4CurrencySalidaImporte monetario correspondiente al periodo 1
Importe5CurrencySalidaImporte monetario correspondiente al periodo 1
Importe6CurrencySalidaImporte monetario correspondiente al periodo 1
Importe7CurrencySalidaImporte monetario correspondiente al periodo 1
Importe8CurrencySalidaImporte monetario correspondiente al periodo 1
Importe9CurrencySalidaImporte monetario correspondiente al periodo 1
Importe10CurrencySalidaImporte monetario correspondiente al periodo 1
Importe11CurrencySalidaImporte monetario correspondiente al periodo 1
Importe12CurrencySalidaImporte monetario correspondiente al periodo 1
Importe13CurrencySalidaImporte monetario correspondiente al periodo 1
MtodosLos mtodos que se pueden utilizar en el objeto TSdkPresupuestoCategoria son:
MtodoParmetrosRetornoDescripcin
buscaPorIdLong aIdPresupuestoCategoriaTrue/FalseBusca en base al nmero identificador del presupuesto.
buscaPorIdCategoriaEjercicioLong aIdCategoriaLong aEjercicioTrue/FalseBusca en base al nmero identificador de una categora y un ejercicio especifico.
consultaPorCodigoCategoria_buscaPorLlaveString aCodigoCategoriaTrue/FalseBusca todos los presupuestos asociados a una categora en diferentes ejercicios.
consultaPorCodigo
Categoria_buscaAnteriorObtiene el presupuesto anterior asignado a una categora.
consultaPorCodigo
Categoria_buscaPrimeroObtiene el primer presupuesto asignado a una categora.
consultaPorCodigo
Categoria_buscaSiguienteObtiene el siguiente presupuesto asignado a una categora.
consultaPorCodigo
Categoria_buscaUltimoObtiene el ltimo presupuesto asignado a una categora.
Contina en la siguiente pginaTSdkPresupuestoCategoria, Continuacin
Mtodos (contina)
MtodoParmetrosRetornoDescripcin
consultaPorEjercicio_buscaPorLlaveLong aEjercicioTrue/FalseBusca todos los presupuestos de categoras asociados a un ejercicio especfico.
consultaPorEjercicio_buscaPrimero
consultaPorEjercicio_buscaSiguiente
consultaPorEjercicio_buscaUltimo
consultaPorEjercicio_buscaAnterior
getSesion----------SesionObtiene la sesin asignada al banco.
setSesionSesion----------Establece una sesin.
getCodigoError----------StringTrae el mensaje con la excepcin generada en caso de que ocurra algn error al realizar una bsqueda.
getMensajeError----------StringTrae el mensaje con la excepcin generada en caso de que ocurra algn error al realizar una bsqueda.
Objetos Tipo de documentos bancariosTSdkDocumentoDeIntroduccinEste objeto representa al documento modelo del cual se derivan diversos documentos, que el usuario puede crear. Esta informacin es de solo lectura, es decir, no tiene la capacidad de crear informacin en la base de datos.
PropiedadesLas propiedades que tiene el objeto TSdkDocumentoDe son:
PropiedadTipoEntrada/SalidaDescripcin
IdLongSalidaNmero identificador del documento modelo.
CdigoStringSalidaCdigo asignado al documento modelo.
NombreStringSalidaNombre del documento modelo.
AsocTablaLongSalidaObtiene la tabla a la que estar asociado:1 = Clientes
2 = Proveedores
3 = Inventarios
4 = Doctos bancarios
MtodosLos mtodos que se pueden utilizar en el objeto TSdkDocumentoDe son:
MtodoParmetrosRetornoDescripcin
buscaPorCodigoString CodigoBanco True/FalseVerifica la existencia de un documento en base a su cdigo.
buscaPorIdLong idBancoTrue/FalseVerifica la existencia de un documento en base a su nmero identificador.
getSesion----------SesionObtiene la sesion asignada al banco.
setSesionTSdkSesion Sesion----------Establece una sesion.
getCodigoError----------StringTrae el mensaje con la excepcin generada en caso de que ocurra algn error al realizar una bsqueda.
getMensajeError----------StringTrae el mensaje con la excepcin generada en caso de que ocurra algn error al realizar una bsqueda.
TSdkTipoDocumento
IntroduccinEste objeto representa a los documentos creados por el usuario segn sus necesidades, en base al documento modelo. Esta informacin es de solo lectura, es decir, no tiene la capacidad de crear informacin en la base de datos.
PropiedadesLas propiedades que tiene el objeto TSdkTipoDocumento son:
PropiedadTipoEntrada/SalidaDescripcin
IdLongSalidaNmero identificador del documento.
CdigoStringSalidaCdigo asignado al documento.
NombreStringSalidaNombre del documento.
FechaRegistroDateSalidaFecha de registro del tipo documento.
ModuloLongSalidaFunciona como SistOrig?Valores
IdDocumentoDeLongSalidaNmero identificador del documento modelo.
NaturalezaLongSalidaIndica la naturaleza contable del documento:
0 = Cargo
2 = Abono
NatBancariaLongSalidaIndica la naturalza bancaria del documento:
0 = Cargo
2 = Abono
AfectaExistenciaLongSalidaIndica si el tipo de documento afecta existencias:
0 = No afecta1 = Si afecta
TipoGeneracionLongSalidaSirve para identificar a qu tipo de documento va orientado:0 = Documento Modelo
1 = Tipo de documentoNota: Se puede llevar un control de foliacin a nivel de documento modelo o documento personalizado.
CodigoFolioTipoDocumentoStringSalidaCdigo del folio asignado.
CodigoFolioDocumentoDeStringSalidaCdigo de folio asignado al documento de.
CodigoFolioDigitalStringSalidaFolios para documentos electrnicos.
FormaPreimpresaStringSalidaRuta donde se encuentra la forma preimpresa.
MaximoMovimientosLongSalidaNumero de partidas que tiene un documento.
Nota: Necesita tener el valor 0.
DoctoBancarioLongSalidaTiene el valor 2 ya que ndica que son documentos bancarios.
ContabilizarPorLongSalidaIdentifica el medio para contabilizar:
0 = Sin contabilizacin
1 = Por beneficiario pagador
3 = Por Categora
4 = Seleccionar prepoliza al crear la pliza por Tipo de documento.
CodigoPrepolizaStringSalidaCdigo de la prepliza asociada.
AgruparMovtosBancoBooleanoSalidaIndica si agrega movimientos bancarios.Nmero de movimientos de la pliza.
AgruparMovtosPolizaBooleanoSalidaIdentifica si agrupa movimientos de pliza.
Nmero de movimientos de la pliza.
Contina en la siguiente pginaTSdkTipoDocumento, Continuacin
Propiedades (contina)
PropiedadTipoEntrada/SalidaDescripcin
EsFiscalBooleanoSalidaIdentifica si los documentos estn impresos.
EsFolioDigitalBooleanoSalidaIdentifica si el folio pertenece a los documentos electrnicos.
UsaAsignaNumeroBooleanoSalida
UsaAsignaSerieFolioBooleanoSalidaIdentifica si el tipo de documento utiliza serie.
MtodosLos mtodos que se pueden utilizar en el objeto TSdkTipoDocumento son:
MtodoParmetrosRetornoDescripcin
buscaPorCodigoCodigoBancoTrue/FalseVerifica la existencia de un documento en base a su cdigo.
buscaPorIdLong IdTipoDocumentoTrue/FalseBusca en base al nmero identificador del tipo documento.
buscaPorCodigoString CodigoTipoDocumentoTrue/FalseBusca por cdigo de un tipo documento.
consultaTipoDocumentosPorDocumentoDe_buscaPorLlaveString aCodigoDocumentoDeTrue/FalseBusca todos los tipo de documento asignados a un documento modelo.
consultaTipoDocumentosPorDocumentoDe_buscaAnteriorLong (por Referencia)True/False
consultaTipoDocumentosPorDocumentoDe_buscaPrimero
consultaTipoDocumentosPorDocumentoDe_buscaSiguiente
consultaTipoDocumentosPorDocumentoDe_buscaUltimo
getSesion----------SesionObtiene la sesin asignada al banco.
setSesionSesionEstablece una sesin.
getCodigoError----------StringTrae el cdigo de la excepcin generada en caso de que ocurra algn error al realizar una bsqueda.
getMensajeError----------StringTrae el mensaje con la excepcin generada en caso de que ocurra algn error al realizar una bsqueda.
TSdkFolioIntroduccinEste objeto representa la foliacin de los documentos. Esta informacin es de solo lectura, es decir, no tiene la capacidad de crear informacin en la base de datos.
PropiedadesLas propiedades que tiene el objeto TSdkFolio son:
PropiedadTipoEntrada/SalidaDescripcin
IdLongSalidaNmero identificador de la foliacin.
CodigoStringSalidaCdigo del folio.
IdDocumentoDeIdSalidaNmero identificador del documento asignado al folio.
FechaRegistroDateSalidaFecha de alta del folio.
NoAprobacionLongSalidaNumero de aprobacin para documentos electrnicos.
SerieStringSalidaClasificador de folios. Se utiliza normalmente para sucursales.
FolioActualStringSalidaEs el siguiente folio disponible para documentos.
FolioInicialStringSalidaFolio inicial de la numeracin.
FolioFinalStringSalidaFolio final de la numeracin.
TipoGeneracionLongSalidaTipo de generacin sirve para identificar a que tipo de documento va orientado:0 = Documentos Modelo
1 = Tipo de documento especifico
Esto es por que se puede llevar un control de foliacin a nivel de documento modelo o documento personalizado
MtodosLos mtodos que se utilizan en el objeto TSdkFolio son:
MtodoParmetrosRetornoDescripcin
buscaPorCodigoLong CodigoBancoTrue/FalseVerifica la existencia de un documento en base a su cdigo.
buscaPorId--------------------
buscaPorCodigo--------------------
getSesion----------SesionObtiene la sesin asignada al banco.
setSesionLong Sesion----------Establece una sesin.
getCodigoError----------StringTrae el cdigo de la excepcin generada en caso de que ocurra algn error al realizar una bsqueda.
getMensajeError----------StringTrae el cdigo de la excepcin generada en caso de que ocurra algn error al realizar una bsqueda.
Objetos Documentos bancarios
TSdkCheque
IntroduccinEste objeto representa el cheque bancario. Esta informacin es de solo lectura, es decir, no tiene la capacidad de crear informacin en la base de datos.
PropiedadesLas propiedades que tiene el objeto TSdkCheque son:
PropiedadTipoEntrada/SalidaDescripcin
IdLongAmbasNmero identificador del cheque.
IdDocumentoDeLongAmbasNmero identificador para la asociacin con un documento modelo.
idTipoDocumentoLongAmbasNmero Identificador para la asociacin con un tipo documento.
FolioStringAmbasFolio del cheque.
FechaDateAmbasFecha de emisin del cheque.
EjercicioLongAmbasAo de emisin del cheque.
PeriodoLongAmbasNmero de periodo de emisin del cheque.
FechaAplicacionDateAmbasFecha en la que se aplica el cheque.
EjercicioApLongAmbasAo en el que se aplic el cheque.
PeriodoApLongAmbasNmero de periodo en el que se aplic el cheque.
CodigoPersonaStringAmbasCdigo del Beneficiario/Pagador que esta asignado al cheque.
BeneficiarioPagadorStringAmbasRazn social del Beneficiario/ Pagador que est asignado al cheque.
IdCuentaChequesLongAmbasNmero identificador de la cuenta bancaria asignada al cheque.
NatBancariaLongAmbasNaturaleza bancaria del cheque.
0 = Cargo
1 = Sin naturaleza
2 = Abono
NaturalezaLongAmbasNaturaleza contable del cheque.
0 = Abono2 = Cargo
CodigoMonedaStringAmbasCdigo de la moneda que tiene asignado el cheque.
CodigoMonedaTipoCambioStringAmbasCdigo de la moneda registrada en la pestaa Otros datos, que servir para hacer el clculo de conversin de divisas.
TipoCambioMonedaAmbasTipo de cambio del cheque.
TotalMonedaAmbasImporte total del cheque.
PendienteMonedaAmbasImporte pendiente por cobrar.
TotMonBaseMonedaAmbasImporte total de la moneda base del documento.
PendMonBaseMonedaAmbasImporte pendiente de la moneda base.
TipoCambioCteProvMonedaAmbasFactor multiplicador segn sea cliente o proveedor.
TotMonCteProvMonedaAmbasImporte total segn el tipo de cambio del cliente proveedor.
PendMonCteProvMonedaAmbasImporte pendiente segn el tipo de cambio del cliente proveedor.
ReferenciaStringAmbasReferencia bancaria.
ConceptoStringAmbasConcepto por el cual fue emitido el cheque.
EsImpresoBooleanoAmbasIndica si el cheque ha sido impreso o no:
0 = No Impreso ?1 = Impreso
EsCanceladoBooleanoAmbasIndica si el cheque ha sido cancelado o no:
0 = No cancelado ?1 = Cancelado
EsAutorizadoBooleanoAmbasIndica si el cheque ha sido autorizado o no:
0 = No autorizado ?1 = Autorizado
EsDevueltoBooleanoAmbasIndica si el cheque ha sido devuelto o no:
0 = No devuelto ?1 = Devuelto
EsConciliadoBooleanoAmbasIndica si el cheque est conciliado o no:
0 = No conciliado
1 = Conciliado
EsAsociadoBooleanoAmbasIndica si el cheque ha sido asociado a algn documento de AdminPAQ o no:
0 = No asociado
1 = Asociado
EsParaAbonoCtaBooleanoAmbasIndica si el cheque incluye la leyenda Para abono en cuenta del beneficiario.
UsuAutoriza (no est en los otros doctos)StringAmbasIndica el usuario que autoriz el cheque.
UsuAutorizaPresupuestoStringAmbasIndica el usuario que autoriz el presupuesto del cheque.
IdMovEdoCtaLongAmbasNmero identificador del movimiento del estado de cuenta.
Prioridad (no est en los otros doctos)StringAmbas
TraspasadoStringAmbasIndica si el cheque forma parte de un traspaso entre cuentas:
0 = No es traspaso
1 = Es el documento origen del traspaso
2 = Es el documento destino del traspaso
EjercicioPolLongAmbasAo de la pliza del cheque.
PeriodoPolLongAmbasNmero del periodo de la pliza.
TipoPolLongAmbasTipo de pliza del cheque.
NumPolLongAmbasNumero de la pliza del cheque.
PosibilidadPagoLongAmbasPosibilidad de pago del cheque:
0 = Alta
1 = Media
2 = Baja
EsProyectadoBooleanoAmbasDetermina si el cheque es proyectado o no.
MtodosLos mtodos que tiene el objeto TSdkCheque son:
MtodoParmetrosRetornoDescripcin
creaBooleanoCrea un cheque, una vez que sus propiedades han sido inicializadas.
modificaBooleanoModifica un cheque existente.
Borra??BooleanoBorra un cheque existente.
buscaPorIdLong aIdCuentaChequeBooleanoBusca un cheque por su nmero identificador.
iniciarInfo (no est en los otros doctos)VoidSe encarga de inicializar los parmetros del objeto a valores vacos.
buscaPorCuentaIdDoctoDeFolioLong aIdCuentaCheques
Long aIdDocumentoDeString aFolioBooleanoBusca por el id de una cuenta de cheques, el Id del documento de y el cdigo del folio especficos.
buscaPorIdDoctoDeFolioLong aIdDocumentoDe
String aFolioBooleanoBusca por id de un documento de y un cdigo de folio especifico.
conciliaDocumentoLong aIdDoctoBancario
Long aIdDocumentoDe
Date aFechaAplicacionBooleanoConcilia un documento bancario.
desconciliaDocumentoLong aIdDoctoBancario
Long aIdDocumentoDeBooleanoDesconcilia un documento bancario.
existeDoctoBancarioDePersonaString aCodigoPersonaBooleanoVerifica que el documento pertenezca a un Beneficiario/Pagador.
existeDoctoBancarioDeTipoString aCodigoTipoDocumentoBooleanoVerifica que el tipo de documento exista.
consultaPorCuenta_buscaPorLlaveLong aIdCuenta?Consulta todos los documentos bancarios asociados a una cuenta bancaria.
consultaPorCuenta_buscaPrimero??
consultaPorCuenta_buscaSiguiente
consultaPorCuenta_buscaAnterior
consultaPorCuenta_buscaUltimo
consultaPorFechaAplicacion_buscaPorLlaveDate aFechaAplicacionInicialDate aFechaAplicacionFinal?Consulta documentos en base a un rango de aplicacin.
consultaPorFechaAplicacion_buscaPrimero?
consultaPorFechaAplicacion_buscaSiguiente
consultaPorFechaAplicacion_buscaAnterior
consultaPorFechaAplicacion_buscaUltimo
consultaPorBeneficiarioPagador_buscaPorLlave??
cancelaLong aIdCuentaChequeBooleanoCancela un cheque.
devuelveLong aIdCuentaChequeBooleanoDevuelve un cheque.
getUltimoFolioLong aIdCuentaChequeStringObtiene el ltimo folio utilizado para el documento de cheque.
getSesion----------SesionObtiene la sesin asignada al banco.
setSesionSesion----------Establece una sesin.
getCodigoError----------StringTrae el cdigo de la excepcin generada en caso de que ocurra algn error al realizar una bsqueda.
getMensajeError----------StringTrae el cdigo de la excepcin generada en caso de que ocurra algn error al realizar una bsqueda.
TSdkIngreso
IntroduccinEste objeto representa un movimiento de abono a una cuenta bancaria. Contiene todas las propiedades y mtodos que permiten la creacin, modificacin, eliminacin y consulta de documentos de ingreso.
PropiedadesLas propiedades que tiene el objeto TSdkIngreso son:
PropiedadTipoEntrada/SalidaDescripcin
IdDocumentoDeLongNmero identificador del documento modelo:33 = Ingreso no depositado
34 = Ingreso
35 = Depsito
36 = Egreso
37 = Cheque
TipoDocumentoStringCdigo del tipo de documento bancario:
40 = Ingreso no depositado
42 = Ingreso
44 = Depsito
45 = Egreso
49 = Cheque
Nota: El campo es de 30 caracteres, por lo que este valor debe completarse con espacios en blanco al inicio.
FolioStringFolio del documento bancario.
FechaDateFecha del ingreso.
EjercicioLongAo correspondiente a la fecha del ingreso.
PeriodoLongPeriodo correspondiente a la fecha del ingreso.
FechaAplicacinDateFecha en que se deposit aplic el ingreso.
EjercicioApLongAo correspondiente a la fecha en que se aplic el ingreso.
PeriodoApLongPeriodo correspondiente a la fecha en que se aplic el ingreso.
CodigoPersonaStringCdigo del usuario que gener el ingreso.
BeneficiarioPagadorStringRazn social del Beneficiario/Pagador correspondiente al ingreso.
IdCuentaChequesLongNmero identificador de la cuenta bancaria.
NatBancariaLongNaturaleza bancaria del ingreso:
0 = Cargo
1 = Sin naturaleza
2 = Abono
NaturalezaLongNaturaleza contable del ingreso:0 = Abono2 = Cargo
CodigoMonedaStringCdigo de la moneda de la cuenta bancaria.
CodigoMonedaTipoCambioStringCdigo de la moneda registrada en la pestaa Otros datos, que servir para hacer el clculo de conversin de divisas.
TipoCambioCurrencyTipo de cambio del ingreso.
TotalCurrencyImporte total del ingreso.
Contina en la siguiente pginaTSdkIngreso, Continuacin
Propiedades (contina)
PropiedadTipoEntrada/SalidaDescripcin
ReferenciaStringReferencia del ingreso.
ConceptoStringConcepto del ingreso.
EsConciliadoLongIndica si el ingreso ha sido conciliado o no:
0 = No conciliado
1 = Conciliado
EsAsociadoLongIndica si el ingreso ha sido asociado a algn documento de AdminPAQ o no:
0 = No asociado
1 = Asociado
UsuAutorizaPresupuestoStringIndica el usuario que autoriz el presupuesto.
IdMovtoEdoCtaLongNmero identificador del movimiento del estado de cuenta bancario.
TrapasadoLongIndica si el ingreso forma parte de un traspaso entre cuentas:
0 = No es traspaso
1 = Es el documento origen del traspaso
2 = Es el documento destino del traspaso
EjercicioPolLongAo de la pliza del ingreso.
PeriodoPolLongAmbasNmero del periodo de la pliza.
TipoPolLongAmbasTipo de pliza del ingreso.
NumPolLongAmbasNumero de la pliza del ingreso.
PosibilidadPagoLongAmbasPosibilidad de pago del ingreso:
0 = Alta
1 = Media
2 = Baja
EsProyectadoBooleanoAmbasDetermina si el ingreso es proyectado o no.
MtodosLos mtodos que tiene el objeto TSdkIngreso son:
MtodoParmetrosRetornoDescripcin
crea----------BooleanoCrea un ingreso, una vez que sus propiedades han sido inicializadas.
modifica----------BooleanoModifica un ingreso existente.
borra----------BooleanoBorra un ingreso existente.
buscaPorIdLong aIdCuentaChequeBooleanoBusca un ingreso por su id.
buscaPorCuentaIdDoctoDeFolioLong aIdCuentaCheques
Long aIdDocumentoDeString aFolioBooleanoBusca por el id de una cuenta de cheques, el Id del documento de y el cdigo del folio especficos.
Contina en la siguiente pginaTSdkIngreso, Continuacin
Mtodos (continued)
MtodoParmetrosRetornoDescripcin
buscaPorIdDoctoDeFolioLong aIdDocumentoDe
String aFolioBooleanoBusca por id de un documento de y un cdigo de folio especifico.
conciliaDocumentoLong aIdDoctoBancario
Long aIdDocumentoDe
Date aFechaAplicacionBooleanoConcilia un documento bancario.
desconciliaDocumentoLong aIdDoctoBancario
Long aIdDocumentoDeBooleanoDesconcilia un documento bancario.
existeDoctoBancarioDePersonaString aCodigoPersonaBooleanoVerifica que el documento pertenezca a un Beneficiario/Pagador.
existeDoctoBancarioDeTipoString aCodigoTipoDocumentoBooleanoVerifica que el tipo de documento exista.
consultaPorCuenta_buscaPorLlaveLong aIdCuenta?Consulta todos los documentos bancarios asociados a una cuenta bancaria.
consultaPorCuenta_buscaPrimero??
consultaPorCuenta_buscaSiguiente
consultaPorCuenta_buscaAnterior
consultaPorCuenta_buscaUltimo
consultaPorFechaAplicacion_buscaPorLlaveDate aFechaAplicacionInicialDate aFechaAplicacionFinal?Consulta documentos en base a un rango de aplicacin.
consultaPorFechaAplicacion_buscaPrimero??
consultaPorFechaAplicacion_buscaSiguiente
consultaPorFechaAplicacion_buscaAnterior
consultaPorFechaAplicacion_buscaUltimo
Contina en la siguiente pginaTSdkIngreso, Continuacin
Mtodos (continued)
MtodoParmetrosRetornoDescripcin
consultaPorCodigoBeneficiarioPagador_buscaPorLlaveaCodigoBeneficiarioPagadorStringConsulta los ingresos por el cdigo de un Beneficiario/Pagador, ordenado por el identificador del ingreso.
consultaPorCodigoBeneficiarioPagador_buscaPrimero??
consultaPorCodigoBeneficiarioPagador_buscaSiguiente
consultaPorCodigoBeneficiarioPagador_buscaAnterior
consultaPorCodigoBeneficiarioPagador_buscaUltimo
getCodigoError----------StringTrae el cdigo de la excepcin generada en caso de que ocurra algn error al realizar una bsqueda.
getMensajeError----------StringTrae el cdigo de la excepcin generada en caso de que ocurra algn error al realizar una bsqueda.
TSdkIngresoNoDepositado
IntroduccinEste objeto representa un movimiento de abono que an no ha sido depositado ni asociado a alguna cuenta bancaria.
PropiedadesLas propiedades que tiene el objeto TSdkIngresoNoDepositado son:
PropiedadTipoEntrada/SalidaDescripcin
IdDocumentoDeLongNmero identificador del documento modelo:
33 = Ingreso no depositado
34 = Ingreso
35 = Depsito
36 = Egreso
37 = Cheque
TipoDocumentoStringCdigo del tipo de documento:40 = Ingreso no depositado
42 = Ingreso
44 = Depsito
45 = Egreso
49 = Cheque
Nota: El campo es de 30 caracteres, por lo que este valor debe completarse con espacios en blanco al inicio.
SerieStringSerie del documento.
FolioStringFolio del documento.
FechaDateFecha del ingreso no depositado.
EjercicioLongAo correspondiente a la fecha del ingreso no depositado.
PeriodoLongPeriodo correspondiente a la fecha del ingreso no depositado.
FechaAplicacinDateFecha en que se deposit aplic el ingreso no depositado.
EjercicioApLongAo correspondiente a la fecha en que se aplic el ingreso no depositado.
PeriodoApLongPeriodo correspondiente a la fecha en que se aplic el ingreso no depositado.
CodigoPersonaStringCdigo del usuario que gener el ingreso no depositado.
BeneficiarioPagadorStringRazn social del Beneficiario/Pagador correspondiente al ingreso no depositado.
IdCuentaChequesLongNmero identificador de la cuenta bancaria.
NatBancariaLongNaturaleza bancaria del ingreso no depositado:
0 = Cargo
1 = Sin naturaleza
2 = Abono
NaturalezaLongNaturaleza contable del ingreso no depositado:
0 = Abono2 = Cargo
CodigoMonedaStringCdigo de la moneda de la cuenta bancaria.
CodigoMonedaTipoCambioStringCdigo de la moneda registrada en la pestaa Otros datos, que servir para hacer el clculo de conversin de divisas.
Contina en la siguiente pginaTSdkIngresoNoDepositado, Continuacin
Propiedades (continued)
PropiedadTipoEntrada/SalidaDescripcin
TipoCambioCurrencyTipo de cambio del ingreso no depositado.
TotalCurrencyImporte total del ingreso no depositado.
ReferenciaStringReferencia del ingreso no depositado.
ConceptoStringConcepto del ingreso no depositado.
EsDepositadoLongIndica si el ingreso no depositado ya fue depositado:
0 = No depositado
1 = Depositado
EsAsociadoLongIndica si el ingreso no depositado ha sido asociado a algn documento de AdminPAQ o no:
0 = No asociado
1 = Asociado
UsuAutorizaPresupuestoStringIndica el cdigo del usuario que autoriz el presupuesto.
PosibilidadPagoLongAmbasPosibilidad de pago del ingreso:
0 = Alta
1 = Media
2 = Baja
EsProyectadoBooleanoAmbasDetermina si el ingreso es proyectado o no.
MtodosLos mtodos que tiene el objeto TSdkIngresoNoDepositado son:
MtodoParmetrosRetornoDescripcin
crea----------BooleanoCrea un ingreso no depositado, una vez que sus propiedades han sido inicializadas.
modifica----------BooleanoModifica un ingreso no depositado existente.
borra----------BooleanoBorra un ingreso no depositado existente.
buscaPorIdLong aIdCuentaChequeBooleanoBusca un ingreso no depositado por su id.
buscaPorIdDoctoDeFolioLong aIdDocumentoDe
String aFolioBooleanoBusca por id de un documento de y un cdigo de folio especifico.
existeDoctoBancarioDePersonaString aCodigoPersonaBooleanoVerifica que el documento pertenezca a un Beneficiario/Pagador.
existeDoctoBancarioDeTipoString aCodigoTipoDocumentoBooleanoVerifica que el tipo de documento exista.
consultaPorFechaAplicacion_buscaPorLlaveDate aFechaAplicacionInicialDate aFechaAplicacionFinal?Consulta documentos en base a un rango de aplicacin.
consultaPorFechaAplicacion_buscaPrimero??
Contina en la siguiente pginaTSdkIngresoNoDepositado, Continuacin
Mtodos (contina)
MtodoParmetrosRetornoDescripcin
consultaPorFechaAplicacion_buscaSiguiente
consultaPorFechaAplicacion_buscaAnterior
consultaPorFechaAplicacion_buscaUltimo
consultaIngresosPendientesDeDepositar_buscaPorLlaveDate aFechaInicial
Date aFechaFinal?Consulta ingresos no depositados, qu an no estn asociados a algn depsito, por un rango de fechas ordenada por la fecha y por el identificador del documento bancario.
consultaIngresosPendientesDeDepositar_buscaPrimero??
consultaIngresosPendientesDeDepositar_buscaUltimo
consultaIngresosPendientesDeDepositar_buscaSiguiente
consultaIngresosPendientesDeDepositar_buscaAnterior
consultaPorFolioDeposito_buscaPorLlaveLong aFolioDepositoStringConsulta los ingresos no depositados qu ya estn asociados a algn depsito. La consulta es por el folio del depsito.
consultaPorFolioDeposito_buscaPrimero??
consultaPorFolioDeposito_buscaUltimo
consultaPorFolioDeposito_buscaSiguiente
consultaPorFolioDeposito_buscaAnterior
consultaPorCodigoBeneficiarioPagador_buscaPorLlaveaCodigoBeneficiarioPagadorStringConsulta los ingresos no depositados por el cdigo de un Beneficiario/Pagador, ordenado por el identificador del ingreso.
consultaPorCodigoBeneficiarioPagador_buscaPrimero??
consultaPorCodigoBeneficiarioPagador_buscaSiguiente
consultaPorCodigoBeneficiarioPagador_buscaAnterior
Contina en la siguiente pginaTSdkIngresoNoDepositado, Continuacin
Mtodos (contina)
MtodoParmetrosRetornoDescripcin
consultaPorCodigoBeneficiarioPagador_buscaUltimo
getCodigoError----------StringTrae el cdigo de la excepcin generada en caso de que ocurra algn error al realizar una bsqueda.
getMensajeError----------StringTrae el cdigo de la excepcin generada en caso de que ocurra algn error al realizar una bsqueda.
TSdkEgreso
IntroduccinEste objeto representa un movimiento de cargo a una cuenta bancaria.
PropiedadesLas propiedades que tiene el objeto TSdkEgresoson:
PropiedadTipoEntrada/SalidaDescripcin
IdDocumentoDeLongAmbasNmero identificador para la asociacin con un documento de.
idTipoDocumentoLongAmbasNmero identificador para la asociacin con un tipo documento.
FolioStringAmbasFolio del egreso.
FechaDateAmbasFecha de emisin del egreso.
EjercicioLongAmbasAo de emisin del egreso.
PeriodoLongAmbasNumero de periodo de emisin del egreso.
FechaAplicacionDateAmbasFecha en la que se aplica el egreso.
EjercicioApLongAmbasAo en el que se aplic el egreso.
PeriodoApLongAmbasNmero de periodo en el que se aplic el egreso.
CodigoPersonaStringAmbasCdigo del Beneficiario/Pagador que esta asignado al egreso.
BeneficiarioPagadorStringAmbasRazn social del Beneficiario/ Pagador que est asignado al egreso.
IdCuentaChequesLongAmbasNmero identificador de la cuenta bancaria asignada al egreso
NatBancariaLongAmbasNaturaleza bancaria del egreso:0 = Cargo
1 = Sin naturaleza
2 = Abono
NaturalezaLongAmbasNaturaleza contable del egreso:0 = Abono2 = Cargo
CodigoMonedaStringAmbasCdigo de la moneda que tiene asignado el egreso.
CodigoMonedaTipoCambioStringAmbasCdigo de la moneda registrada en la pestaa Otros datos, que servir para hacer el clculo de conversin de divisas.
TipoCambioMonedaAmbasTipo de cambio del egreso.
TotalMonedaAmbasImporte total del egreso.
PendienteMonedaAmbasImporte pendiente por cobrar.
ReferenciaStringAmbasReferencia bancaria.
ConceptoStringAmbasConcepto por el cual fue emitido el egreso.
EsConciliadoBooleanoAmbasIndica si el egreso ha sido conciliado o no:0 = No conciliado
1 = Conciliado
EsAsociadoBooleanoAmbasIndica si el egreso ha sido asociado a algn documento de AdminPAQ o no:
0 = No asociado
1 = Asociado
UsuAutorizaPresupuestoStringAmbasIndica el usuario que autoriz el presupuesto del egreso.
IdMovEdoCtaLongAmbasNmero identificador del movimiento del estado de cuenta.
Contina en la siguiente pginaTSdkEgreso, Continuacin
Propiedades (contina)
PropiedadTipoEntrada/SalidaDescripcin
TraspasadoStringAmbasIndica si el egreso forma parte de un traspaso entre cuentas:
0 = No es traspaso
1 = Es el documento origen del traspaso
2 = Es el documento destino del traspaso
EjercicioPolLongAmbasAo de la pliza del egreso.
PeriodoPolLongAmbasNmero del periodo de la pliza.
TipoPolLongAmbasTipo de pliza del egreso.
NumPolLongAmbasNumero de la pliza del egreso.
PosibilidadPagoLongAmbasPosibilidad de pago del egreso:
0 = Alta
1 = Media
2 = Baja
EsProyectadoBooleanoAmbasDetermina si el egreso es proyectado o no.
MtodosLos mtodos que se pueden utilizar en el objeto TSdkEgreso son:
MtodoParmetrosRetornoDescripcin
crea----------BooleanoCrea un egreso, una vez que sus propiedades han sido inicializadas.
modifica----------BooleanoModifica un egreso existente.
borra----------BooleanoBorra un egreso existente.
buscaPorIdLong aIdCuentaChequeBooleanoBusca un egreso por su id.
buscaPorCuentaIdDoctoDeFolioLong aIdCuentaCheques
Long aIdDocumentoDeString aFolioBooleanoBusca por el id de una cuenta de cheques, el Id del documento de y el cdigo del folio especficos.
buscaPorIdDoctoDeFolioLong aIdDocumentoDe
String aFolioBooleanoBusca por id de un documento de y un cdigo de folio especifico.
conciliaDocumentoLong aIdDoctoBancario
Long aIdDocumentoDe
Date aFechaAplicacionBooleanoConcilia un documento bancario.
desconciliaDocumentoLong aIdDoctoBancario
Long aIdDocumentoDeBooleanoDesconcilia un documento bancario.
existeDoctoBancarioDePersonaString aCodigoPersonaBooleanoVerifica que el documento pertenezca a un Beneficiario/Pagador.
Contina en la siguiente pginaTSdkEgreso, Continuacin
Mtodos (contina)
MtodoParmetrosRetornoDescripcin
existeDoctoBancarioDeTipoString aCodigoTipoDocumentoBooleanoVerifica que el tipo de documento exista.
consultaPorCuenta_buscaPorLlaveLong aIdCuenta?Consulta todos los documentos bancarios asociados a una cuenta bancaria.
consultaPorCuenta_buscaPrimero??
consultaPorCuenta_buscaSiguiente
consultaPorCuenta_buscaAnterior
consultaPorCuenta_buscaUltimo
consultaPorFechaAplicacion_buscaPorLlaveDate aFechaAplicacionInicialDate aFechaAplicacionFinal?Consulta documentos en base a un rango de aplicacin.
consultaPorFechaAplicacion_buscaPrimero??
consultaPorFechaAplicacion_buscaSiguiente
consultaPorFechaAplicacion_buscaAnterior
consultaPorFechaAplicacion_buscaUltimo
consultaPorCodigoBeneficiarioPagador_buscaPorLlaveaCodigoBeneficiarioPagadorStringConsulta los egresos por el cdigo de un Beneficiario/Pagador, ordenado por el identificador del egreso.
consultaPorCodigoBeneficiarioPagador_buscaPrimero??
consultaPorCodigoBeneficiarioPagador_buscaSiguiente
consultaPorCodigoBeneficiarioPagador_buscaAnterior
consultaPorCodigoBeneficiarioPagador_buscaUltimo
getCodigoError----------StringTrae el cdigo de la excepcin generada en caso de que ocurra algn error al realizar una bsqueda.
getMensajeError----------StringTrae el cdigo de la excepcin generada en caso de que ocurra algn error al realizar una bsqueda.
Objetos Plizas contablesTSdkPoliza
IntroduccinEl objeto TSdkPoliza representa el encabezado de la pliza y es de slo lectura. Esta informacin pertenece a CONTPAQ i CONTABILIDAD.
PropiedadesLas propiedades que tiene el objeto TSdkPoliza son:
PropiedadTipoEntrada/SalidaDescripcin
AbonosCurrencySuma de los importes de los movimientos de abono. Es de slo lectura.
AjusteLongIndica si la pliza se registr en el periodo de ajuste (Periodo 14).
0 = No est registrada.
1 = S est registrada.
CargosCurrencySuma de los importes de los movimientos de cargo. Es de slo lectura.
ClaseECLASEPOLIZAObtiene el estado de afectacin de la pliza.1 = Afecta
2 = No afecta o Sin afectar.
ConceptoStringConcepto de la pliza.
DiarioLongNmero del diario especial de la pliza.
EjercicioLongAo de la pliza. Es de slo lectura.
FechaDateFecha de la pliza.
IdLongNmero identificador de la pliza. Es de slo lectura.
ImpresaLongEstado de impresin de la pliza.
0 = No impresa
1 = Impresa
NumeroLongNnmero de la pliza.
NumeroMovtosLongNmero de movimientos que tiene la pliza. Es de slo lectura.
NumeroMovtosControlIVALongNmero de movimientos de control de IVA de la pliza.
PeriodosLongNmero de periodo correspondiente a la fecha de la pliza. Es de slo lectura.
SistorigenESISTORIGENIndica en qu sistema se cre la pliza contable:
1 = ContPAQ Windows
5 = CheqPAQ Windows
6 = NomiPAQ Windows
7 = AdminPAQ Windows11 = CONTPAQ i CONTABILIDAD
15 = CONTPAQ i BANCOS
16 (&H10) = CONTPAQ i NMINAS
TipoETIPOPOLIZAIndica el tipo de pliza.
1 = Ingresos
2 = Egresos
3 = Diario
4 = Orden
5 = Estadisticas
MtodosLos mtodos que se pueden utilizar para el objeto TSdkPoliza son:
MtodoParmetrosRetornoDescripcin
agregaControlIVATSdkControlIVA Long aSdkControlIVAAgrega un movimiento de control de IVA.
agregaMovimientoTSdkControlIVA Long aSdkControlIVAAgrega un movimiento a los datos de una pliza:0 = No se pudo agregar el movimiento
1 = Se agreg el movimiento
borraLongBorra un registro existente de pliza:
0 = El registro no existe y no pudo eliminarse
1 = Se elimin el registro
borraCausacionIVAECAUSACIONTIPOIVALong aTipoBorra los datos del registro de causacin de IVA de la pliza.
borraControlIVATSdkControlIVA Long aSdkControlIVABorra los datos del registro de control de IVA de la pliza.
borraMovimientoSdkMovimientoPoliza Long aSdkMovimientoPolizaBorra un movimiento de los datos de una pliza existente.
buscaMovimientosPorNumMovtoaSdkMovimientoPoliza Long
aSdkMovimientoPoliza
Long aNumMovtoBusca un movimiento por el consecutivo de movimiento.
buscaPorIdLong aIdBusca un registro existente de pliza por nmero identificador.
buscaPorLlavePrimariaLong Ejercicio
Long aPeriodo
ETIPOPOLIZA aTipo
Long aNumeroBusca un registro existente de pliza por la llave principal, fecha, tipo y nmero.
consultaPorClaseFechaTipoNumero_buscaPorLlaveECLASEPOLIZA aClase
Date aFecha
ETIPOPOLIZA aTipo
Long aNumeroObtiene el registro por llave dela consulta ordenadas por clase, fecha, tipo y nmero de pliza.
consultaPorClaseFechaTipoNumero_buscaAnterior
consultaPorClaseFechaTipoNumero_buscaSiguiente
consultaPorClaseFechaTipoNumero_buscaPrimero
consultaPorClaseFechaTipoNumero_buscaUltimo
consultaPorEjercicioPeriodoTipoNumero_buscaPorLlaveLong aEjercicioDate aPeriodo
ETIPOPOLIZA aTipo
Long aNumeroObtiene el registro por llave de la consulta de todas las plizas ordenadas por ejercicio, periodo, tipo y nmero de pliza.
consultaPorEjercicioPeriodoTipoNumero_buscaPrimero
consultaPorEjercicioPeriodoTipoNumero_buscaUltimo
consultaPorEjercicioPeriodoTipoNumero_buscaSiguiente
consultaPorEjercicioPeriodoTipoNumero_buscaAnterior
consultaPorFechaTipoNumero_buscaPorLlaveDate aFecha
ETIPOPOLIZA aTipo
Long aNumeroObtine el registro por llave de la consulta de todas las plizas ordenadas por fecha, tipo y nmero de pliza.
consultaPorFechaTipoNumero_buscaPrimero
consultaPorFechaTipoNumero_buscaUltimo
consultaPorFechaTipoNumero_buscaSiguiente
consultaPorFechaTipoNumero_buscaAnterior
consultaPorSistOrigenFechaTipoNumero_buscaPorLlaveLong aSistOrigen
ETIPOPOLIZA aTipo
Long aNumero
Date aFechaObtiene el registro por llave de la consulta de todas las plizas ordenadas por sistema origen, fecha, tipo y nmero de pliza.
consultaPorSistOrigenFechaTipoNumero_buscaPrimero
consultaPorSistOrigenFechaTipoNumero_buscaUltimo
consultaPorSistOrigenFechaTipoNumero_buscaSiguiente
consultaPorSistOrigenFechaTipoNumero_buscaAnterior
consultaPorTipoEjercicioPeriodoNumero_buscaPorLlaveLong aEjercicio
ETIPOPOLIZA aTipo
Long aPeriodo
Long aNumeroObtiene el registro por llave de la consulta de todas las plizas ordenadas plizas por tipo, ejercicio, periodo y nmero de pliza.
consultaPorTipoEjercicioPeriodoNumero_buscaPrimero
consultaPorTipoEjercicioPeriodoNumero_buscaUltimo
consultaPorTipoEjercicioPeriodoNumero_buscaSiguiente
consultaPorTipoEjercicioPeriodoNumero_buscaAnterior
creaLongCrea el encabezado de una pliza.
creaMovimientoTSdkMovimientoPoliza Long aSdkMovimientoPolizaGenera un movimiento de una pliza.
getCausacionIVATSdkCausacionIVA aSdkMovimientoPolizaECAUSACIONTIPOIVA ATipoObtiene los datos del registro de Causacin de IVA de la pliza.
getControlIVAPorNumeroLong aNumeroTSdkControlIVA aSdkControlIVAObtiene los datos del movimiento de control de IVA por nmero.
getControlIVAAnterior
getControlIVASiguiente
getControlIVAPrimero
getControlIVAUltimo
getSesionSesionObtiene la sesion asignada al banco.
getTipoPolizaTSdkTipoPoliza Long aSdkTipoPolizaObtiene los datos del tipo de pliza de una pliza existente.
getUltimoNumeroLong aEjercicio
Long aPeriodo
ETIPOPOLIZA aTipoPolizaObtiene el ltimo nmero de pliza.
getUsuarioTSdkUsuario Long aSdkUsuarioObtiene los datos del usuario de una pliza existente.
iniciarInfoInicializa los datos del objeto del Sdk de Plizas.
modificaBooleanoModifica una pliza existente.
modificaControlIVAModifica los datos del control de IVA existentes de la pliza.
modificaMovimientoModifica los movimientos existentes de una pliza.
setCausacionIVAAsigna los datos del registro de Causacin de IVA de la pliza.
setSesion
TSdkTipoPoliza
IntroduccinEl objeto TSdkTipoPoliza representa a los 5 tipos bsicos de tipo de pliza y a los creados por el usuario los cuales se almacenan en el catlogo Tipo de plizas. . Esta informacin pertenece a CONTPAQ i CONTABILIDAD.
PropiedadesLas propiedades que tiene el objeto TSdkTipoPoliza son:
PropiedadTipoEntrada/SalidaDescripcin
esNumeroPorEjercicioLongIndica si el nmero es por ejercicio de los datos del tipo de pliza. ???????
IdLongNmero identificador del tipo de pliza.
NombreStringNombre del tipo de pliza.
NumeroLongNmero de cdigo del tipo de pliza.
RangoInicialLongObtiene el rango inicial del tipo de pliza.
RangoFinalLongObtiene el rango final del tipo de pliza.
setIdLongAsigna el nmero identificador de los datos del tipo de pliza.
TipoETIPOPOLIZAIndica el tipo de pliza:1 = Ingresos
2 = Egresos
3 = Diario
4 = Orden
5 = Estadisticas
UltimoNumeroLongObtiene el ltimo nmero de los datos del tipo de pliza.
UltimoNumeroEjercicioLongObtiene el ltimo nmero del ejercicio de los datos del tipo de pliza.
UltimoNumeroPer1LongObtiene el ltimo nmero de pliza del periodo 1 del tipo de pliza.
UltimoNumeroPer2LongObtiene el ltimo nmero de pliza del periodo 2 del tipo de pliza.
UltimoNumeroPer3LongObtiene el ltimo nmero de pliza del periodo 3 del tipo de pliza.
UltimoNumeroPer4LongObtiene el ltimo nmero de pliza del periodo 4 del tipo de pliza.
UltimoNumeroPer5LongObtiene el ltimo nmero de pliza del periodo 5 del tipo de pliza.
UltimoNumeroPer6LongObtiene el ltimo nmero de pliza del periodo 6 del tipo de pliza.
UltimoNumeroPer7LongObtiene el ltimo nmero de pliza del periodo 7 del tipo de pliza.
UltimoNumeroPer8LongObtiene el ltimo nmero de pliza del periodo 8 del tipo de pliza.
UltimoNumeroPer9LongObtiene el ltimo nmero de pliza del periodo 9 del tipo de pliza.
UltimoNumeroPer10LongObtiene el ltimo nmero de pliza del periodo 10 del tipo de pliza.
UltimoNumeroPer11LongObtiene el ltimo nmero de pliza del periodo 11 del tipo de pliza.
UltimoNumeroPer12LongObtiene el ltimo nmero de pliza del periodo 12 del tipo de pliza.
UltimoNumeroPer13LongObtiene el ltimo nmero de pliza del periodo 13 del tipo de pliza.
UltimoNumeroPer14LongObtiene el ltimo nmero de pliza del periodo 14 del tipo de pliza.
MtodosLos mtodos que se pueden utilizar para el objeto TSdkTipoPoliza son:
MtodoParmetrosRetornoDescripcin
borraLong pValRetBorra un registro en el catlogo Tipo de plizas.
buscaPorIdLong aIdBusca un registro existente de tipo de pliza por el nmero identificador.
consultaPorNumero_buscaPorLlaveLong aNumero
Long pValRetBusca un registro del catlogo Tipos de plizas por nmero.
consultaPorNumero_buscaAnteriorLong pValRetObtiene el anterior registro del catlogo de tipos de plizas por nmero.
consultaPorNumero_buscaSiguiente
consultaPorNumero_buscaPrimero
consultaPorNumero_buscaUltimo
creaLong pValRetCrea un registro en el catlogo Tipo de Plizas.
getSesionLong pValRetPermite obtener el objeto del Sdk de la sesin de la empresa.
iniciarInfoInicializa los datos del objeto del Sdk de Tipo de Plizas.
modificaLong pValRetModifica un registro existente en el catlogo Tipo de plizas.
setSesionTSdkSesion newValContiene el objeto de la sesin.
TSdkMovimientoPoliza
IntroduccinUn objeto TSdkMovimientoPoliza representa los movimientos de pliza.
PropiedadesLas propiedades que tiene el objeto TSdkMovimientoPoliza son:
PropiedadTipoEntrada/SalidaDescripcin
CodigoCuentaStringCdigo de la cuenta del movimiento de la pliza.
conceptoStringConcepto del movimiento de la pliza.
DiarioLongNmero del diario especial del movimiento de la pliza.
IdLongNmero identificador del movimiento de la pliza. Es de slo lectura.
IdPolizaLongNmero identificador de la pliza al a que pertenece el movimiento. Es de slo lectura.
ImporteCurrencyImporte del movimiento en la moneda base.
ImporteMECurrencyImporte del movimiento en moneda extranjera.
NumMvtoLongNmero consecutivo del movimiento en la pliza.
ReferenciaStringReferencia del movimiento de la pliza.
SegmentoNegocioLongNmero del segmento de negocio del movimiento de la pliza.
TipoMovtoETIPOIMPORTEMOVPOLIZATipo de importe del movimiento de la pliza:1 = Cargo
2 = Abono
MtodosLos mtodos que se pueden utilizar para el objeto TSdkMovimientoPoliza son:
MtodoParmetrosRetornoDescripcin
buscaPorCuentaRangoFechas_buscaPorLlaveString aCodigoCuentaDate aFechaInicial
Date aFechaFinalBusca por rango de fechas las cuentas de la pliza.
buscaPorCuentaRangoFechas_buscaAnterior Long
buscaPorCuentaRangoFechas_buscaSiguiente
buscaPorCuentaRangoFechas_buscaPrimero
buscaPorCuentaRangoFechas_buscaUltimo
Contina en la siguiente pginaTSdkMovimientoPoliza, Continuacin
Mtodos (contina)
MtodoParmetrosRetornoDescripcin
getCuentaTSdkCuenta
Long aSdkCuentaCopia la informacin de la cuenta en un nuevo objeto TSdkCuenta.
getDiarioTSdkDiarioEspe cial Long aSdkDiarioCopia la informacin del diario especial de un movimiento de pliza.
getSegNegTSdkSegmentoNegocio Long aSdkSegNegCopia la informacin del segmento de negocio de un movimiento de pliza.
iniciarInfoInicializa los datos del objeto del Sdk de movimientos de plizas.
setSdkCuentaEstablece el objeto del Sdk de la Cuenta.
Objetos Catlogos contablesTSdkCuenta
IntroduccinEl objeto TSdkCuenta representa a todos los datos almacenados en el Catlogo de cuentas. Esta informacin pertenece a CONTPAQ i CONTABILIDAD.
PropiedadesLas propiedades que tiene el objeto TSdkCuenta son:
PropiedadTipoEntrada/SalidaDescripcin
CodigoStringCdigo de la cuenta contable.
AplicaSegNegLongIndica si la cuenta contable aplica para captura de segmento de negocio en movimientos:0 = No aplica
1 = Si aplica
CodigoCuentaAcumulaStringIndica el cdigo de la cuenta contable a la que acumula la cuesta actual.
CtaMayoECUENTADEMAYORIndica si la cuenta contable se utilizar como cuenta de mayor:
1 = Si
2 = No
3 = Ttulo
4 = Subtitulo
DigitoAgrupadoLongDgito agrupador de la cuenta contable.
DigitoFiscal1LongDgito fiscal 1 (Dgito1) de la cuenta contable.
DigitoFiscal2LongDgito fiscal 2 (Dgito2) de la cuenta contable.
EsAfectableLongIndica si la cuenta contable es afectable o acumulable:
0 = No es afectable
1 = S es afectable
EsBajaLongIndica si la cuenta contable est dada de baja:
0 = No1 = S
EsCtaEfectivoLongIndica si la cuenta contable es de flujo de efectivo. Es de slo lectura.
FechaAltaDateFecha de alta de la cuenta contable.
IdLongNmero identificador de la cuenta contable.
MonedaLongCdigo de la moneda de la cuenta contable.
NombreStringNombre de la cuenta contable.
SegNegLongSegmento de negocio de la cuenta contable.
SistOrigenESISTORIGENIndica en qu sistema se cre la cuenta contable:
1 = ContPAQ Windows
5 = CheqPAQ Windows
6 = NomiPAQ Windows
7 = AdminPAQ Windows11 = CONTPAQ i CONTABILIDAD
15 = CONTPAQ i BANCOS
16 (&H10) = CONTPAQ i NMINAS
Contina en la siguiente pginaTSdkCuenta, Continuacin
Propiedades (contina)
PropiedadTipoEntrada/SalidaDescripcin
TipoECUENTATIPOIndica de qu tipo es la cuenta contable:
1 = Activo Deudora
2 = activo Acreedora
3 = Pasivo Deudora
4 = Pasivo Acreedora
5 = Capital Deudora
6 = Capital Acreedora
7 = Resultados Deudora
8 = Resultados Acreedora
9 = Estadisticas Deudora
10 = Estadisticas Acreedora
11 = orden Deudora
12 = Orden Acreedora
MtodosLos mtodos que se pueden utilizar en el objeto TSdkCuenta son:
MtodoParmetrosRetornoDescripcin
borraLong pValRetBorra un registro en el catlogo de cuentas.
buscaPorCodigoString aCodigoCuentaBusca un registro existente por el cdigo de la cuenta contable.
buscaPorIdLong aIdBusca un registro existente de cuenta por el nmero identificador.
buscaPorCodigoString aCodigoCuentaBusca un registro existente de cuenta contable por el cdigo de la cuenta.
consultaPorCodigo_buscaPorLlaveString aCodigoBusca un registro del catlogo de cuentas por cdigo.
consultaPorCodigo_buscaAnteriorLong pValRet
consultaPorCodigo_buscaSiguiente
consultaPorCodigo_buscaPrimero
consultaPorCodigo_buscaUltimo
consultaPorNombre_buscaPorLlaveLong pValRetBusca un registro del catlogo de cuentas por nombre.
consultaPorNombre_buscaAnteriorLong pValRet
consultaPorNombreo_buscaSiguiente
consultaPorNombreo_buscaPrimero
consultaPorNombre_buscaUltimo
creaLong pValRetCrea un registro en el catlogo de cuentas.
Contina en la siguiente pginaTSdkCuenta, Continuacin
Mtodos (contina)
MtodoParmetrosRetornoDescripcin
ejecutaBusquedaCuentaLong ahWnd
Long aPosX
Long aPosY
String CodigoCuentaEjecuta el dilogo de la bsqueda de cuentas contables.
getCodigoSubCuentaAnteriorString aCodigoSubCuentaObtiene el cdigo de la subcuenta anterior de los datos de la cuenta contable.
getCodigoSubCuentaSiguienteObtiene el cdigo de la siguiente subcuenta de los datos de la cuenta contable.
getCodigoSubCuentaPrimeroString aCodigoSubCuentaObtiene el cdigo de la primera subcuenta de los datos de la cuenta contable.
getCodigoSubCuentaUltimoString aCodigoSubCuentaObtiene el cdigo de la ltima subcuenta de los datos de la cuenta contable.
getMonedaTSdkMoneda Long aSdkMonedaCopia los datos de la moneda de la cuenta contable.
getSegNegTSdkSegNeg Long aSdkSegNegCopia los datos del segmento de negocio de la cuenta contable.
getSesionTSdkSesion Long pValRetObtiene el objeto del Sdk de la Sesion de la cuenta.
iniciarInfoInicializa los datos del objeto del Sdk de cuentas.
modificaModifica un registro existente en el catlogo de cuentas.
setSesionTSdkSesion Long newValEstablece el objeto del Sdk de la Sesin de la cuenta.
TSdkSegmentoNegocio
IntroduccinEste objeto representa a los segmentos de negocio que majeja la empresa. Esta informacin pertenece a CONTPAQ i CONTABILIDAD.
PropiedadesLas propiedades que tiene el objeto TSdkSegmentoNegocio son:
PropiedadTipoEntrada/SalidaDescripcin
IdLongNumero identificador del segmento de negocio. Es de slo lectura.
NombreStringNombre del segmento de negocio.
NmeroLongNumero que se le asigna al segmento de negocio.
MtodosLos mtodos que se pueden utilizar en el objeto TSdkSegmentoNegocio son:
MtodoParmetrosRetornoDescripcin
borraLong pValRetBorra un registro en el catlogo Segmentos de negocio.
buscaPorIdLong aIdBusca un segmento de negocio existente d por el nmero identificador.
buscaPorNumeroLong aNumeroBusca un segmento de negocio por el nmero que se le asign.
consultaPorNumero_buscaPorLlaveLong aNumero
Lon pValRetBusca un registro del catlogo Segmentos de negocio por nmero.
consultaPorNumero_buscaAnteriorLong pValRet
consultaPorNumero_buscaSiguiente
consultaPorNumero_buscaPrimero
consultaPorNumero_buscaUltimo
creaLong pValRetCrea un registro en el catlogo Segmentos de negocio.
getSesionTSdkSesion Long pValRetObtiene el objeto del Sdk de la Sesion del segmento de negocio.
iniciarInfoInicializa los datos del objeto del Sdk del segmento de negocio.
modificaModifica un segmento de negocio existente.
TSdkDiarioEspecial
IntroduccinEste objeto representa los diarios especiales de la empresa. Esta informacin pertenece a CONTPAQ i CONTABILIDAD.
PropiedadesLas propiedades que tiene el objeto TSdkDiarioEspecial son:
PropiedadTipoEntrada/SalidaDescripcin
IdLongNumero identificador del diario especial. Es de slo lectura.
NombreStringNombre del diario especial.
NmeroLongNumero del diario especial.
TipoEDIARIOTIPOIndica el tipo de diario especial:
1 = Polizas
2 = Movimientos
3 = Efectivo Ingresos
4 = Efectivo Egresos
MtodosLos mtodos que se pueden utilizar en el objeto TSdkDiarioEspecial son:
MtodoParmetrosRetornoDescripcin
borraLong pValRetBorra un registro en el catlogo Diarios especiales.
buscaPorIdLong aIdBusca un diario especial por el nmero identificador.
buscaPorNumeroLong aNumeroBusca un diario especial por el nmero que lo identifica.
consultaPorNumero_buscaPorLlaveLong aNumero
Lon pValRetBusca un registro del catlogo Diarios especiales por nmero.
consultaPorNumero_buscaAnteriorLong pValRet
consultaPorNumero_buscaSiguiente
consultaPorNumero_buscaPrimero
consultaPorNumero_buscaUltimo
creaLong pValRetCrea un registro en el catlogo Diarios especiales.
modificaLong pValRetModifica un diario especial existente.
getSesionTSdkSesion Long pValRetObtiene el objeto del Sdk de la Sesion del diario especial.
setSesionTSdkSesion Long newValAsigna el objeto del Sdk de la sesion de la empresa.
iniciarInfoInicializa los datos del objeto del Sdk de diario especial.
TSdkDigitoFiscal
IntroduccinEste objeto representa los datos relacionados con el Mdulo Fiscal a fin de obtener los reportes fiscales. Esta informacin pertenece a CONTPAQ i CONTABILIDAD.
PropiedadesLas propiedades que tiene el objeto TSdkDigitoFiscal son:
PropiedadTipoEntrada/SalidaDescripcin
IdLongNumero identificador del dgito fiscal. Es de slo lectura.
NaturalezaStringIndica el tipo de naturaleza del dgito fiscal (deudora o acreedora),
NombreStringNombre del dgito fiscal.
NmeroLongNumero del dgito fiscal asignado.
TipoCuentasStringObtiene el tipo de cuentas contables del registro del dgito fiscal.
MtodosLos mtodos que se pueden utilizar en el objeto TSdkDigitoFiscal son:
MtodoParmetrosRetornoDescripcin
borraLong pValRetBorra un dgito fiscal.
buscaPorIdLong aIdBusca un dgito fiscal por el nmero identificador.
buscaPorNumeroLong aNumeroBusca un dgito fiscal por el nmero que se asign.
buscaAnteriorLong
buscaSiguiente
buscaPrimero
buscaUltimo
creaLongCrea un registro de dgito fiscal.
modificaLong pValRetModifica un dgito fiscal existente.
getSesionTSdkSesion Long pValRetObtiene el objeto del Sdk de la Sesion de la emprsa
setSesionTSdkSesion Long newValAsigna el objeto del Sdk de la sesion de la empresa.
iniciarInfoInicializa los datos del objeto del Sdk de dgitos fiscales.
Constantes
EACTIVOFIJOTIPODEPRECIACIONESEsta constante muestra los Tipos de depreciacin de Activos fijos y tiene los siguientes valores:
ValorNombre de la constanteDescripcin
1ACTIVOFIJO_DEPRECIACIONCONTABLEDepreciacin Contable del Activo Fijo
2ACTIVOFIJO_DEPRECIACIONFISCALDepreciacin Fiscal del Activo Fijo
ECAUSACIONDESGLOSETASAIVAEsta constante muestra el Desglose de Causacin de IVA y tiene los siguientes valores:
ValorNombre de la constanteDescripcin
1CAUSACION_DESGLOSEIVA15Desglose IVA 15%
2CAUSACION_DESGLOSEIVA10Desglose IVA 10%
3CAUSACION_DESGLOSEIVA0Desglose IVA 0%
4CAUSACION_DESGLOSEIVAEXENTODesglose IVA Exento
5CAUSACION_DESGLOSEIVAOTRASTASASDesglose IVA Otras Tasas
6CAUSACION_DESGLOSEIMPTOSUNTUARIODesglose Impuesto Suntuario
7CAUSACION_DESGLOSEIVAOTROSDesglose IVA Otros
8CAUSACION_DESGLOSEIVARETENIDODesglose IVA Retenido
ECAUSACIONTIPOIMPORTESEsta constante muestra los Tipos de importes en Causacin de IVA y tiene los siguientes valores:
ValorNombre de la constanteDescripcin
1CAUSACION_IMPORTETOTALImporte Total
2CAUSACION_IMPORTEIVAImporte del IVA
3CAUSACION_IMPORTEBASEIVAImporte Base del IVA
ECAUSACIONTIPOIVAEsta constante muestra los Tipos de IVA en Causacin y tiene los siguientes valores:
ValorNombre de la constanteDescripcin
1CAUSACION_IVACAUSADOTipo de IVA Causado
2CAUSACION_IVAACREDITABLETipo de IVA Acreditable
ECAUSACIONTIPOOPERACIONEsta constante muestra los Tipos de operacin en Causacin de IVAy tiene los siguientes valores:
ValorNombre de la constanteDescripcin
1CAUSACION_IVARELACIONADOTipo de IVA Relacionado
2CAUSACION_IVANORELACIONADOTipo de IVA No Relacionado
ECAUSACIONTIPOPEREsta constante muestra los Tipos de periodos asignados en Causacin de IVA y tiene los siguientes valores:
ValorNombre de la constanteDescripcin
1CAUSACION_EJERCICIOASIGNADOEjercicio de Causacin Asignado
2CAUSACION_PERIODOASIGNADOPeriodo de Causacin Asignado
ECLASEPOLIZAEsta constante muestra las Clases de afectacin de plizas y tiene los siguientes valores:
ValorNombre de la constanteDescripcin
1CLASE_AFECTARClase Afectar de la Pliza
2CLASE_SINAFECTARClase Sin Afectar de la Pliza
ECUENTADEMAYOREsta constante muestra los Tipos de Cuenta de Mayor y tiene los siguientes valores:
ValorNombre de la constanteDescripcin
1CUENTA_CUENTADEMAYORSISi es cuenta de Mayor
2CUENTA_CUENTADEMAYORNONo es cuenta de Mayor
3CUENTA_CUENTADETITULOEs cuenta de Ttulo
4CUENTA_CUENTADESUBTITULOEs cuenta de Subttulo
Tipos de CuentasLa constante ECUENTATIPO tiene los siguientes valores:
ValorNombre de la constanteDescripcin
1CUENTA_ACTIVOACREEDORAActivo Deudora
2CUENTA_ACTIVODEUDORAActivo Acreedora
3CUENTA_PASIVODEUDORAPasivo Deudora
4CUENTA_PASIVOACREEDORAPasivo Acreedora
5CUENTA_CAPITALDEUDORACapital Deudora
6CUENTA_CAPITALACREEDORACapital Acreedora
7CUENTA_RESULTADOSDEUDORAResultados Deudora
8CUENTA_RESULTADOSACREEDORAResultados Acreedora
9CUENTA_ESTADISTICASDEUDORAEstadsticas Deudora
10CUENTA_ESTADISTICASACREEDORAEstadsticas Acreedora
11CUENTA_ORDENDEUDORAOrden Deudora
12CUENTA_ORDENACREEDORAOrden Acreedora
Tipos de Aplicacin en Devolucin de IVALa constante EDEVOLUCIONTIPOAPLICACION tiene los siguientes valores:
ValorNombre de la constanteDescripcin
1DEVOLUCION_IVAAPLICABLETipo de IVA Aplicable
2DEVOLUCION_IVANOAPLICABLETipo de IVA No Aplicable
EDEVOLUCIONTIPOIMPORTES Esta constante muestra los Tipos de Importes en Devolucin de IVA y tiene los siguientes valores:
ValorNombre de la constanteDescripcin
1DEVOLUCION_IMPORTEBASEIVAImporte Base del IVA
2DEVOLUCION_IMPORTEIVAImporte del IVA
EDIARIOTIPOEsta constante muestra los Tipos de Diarios Especiales y tiene los siguientes valores:
ValorNombre de la constanteDescripcin
1DIARIO_POLIZASDiario de Plizas
2DIARIO_MOVIMIENTOSDiario de Movimientos
3DIARIO_EFECTIVOINGRESOSDiario de Efectivo Ingresos
4DIARIO_EFECTIVOEGRESOSDiario de Efectivo Egresos
EIMPRIMEORDENEsta constante muestra las opciones para Imprimir Cuentas de Orden y tiene los siguientes valores:
ValorNombre de la constanteDescripcin
0IMPRIMEORDEN_NOIMPRIMIRNo imprimir
1IMPRIMEORDEN_TODASImprimir Todas
2IMPRIMEORDEN_DEUDORASImprimir Deudoras
3IMPRIMEORDEN_ACREEDORASImprimir Acreedoras
4IMPRIMEORDEN_ALGUNASImprimir Algunas
EMONEDAPOSICIONSIMBOLOEsta constante muestra las Posiciones del Smbolo de Moneda y tiene los siguientes valores:
ValorNombre de la constanteDescripcin
1MONEDA_POSICIONSIMBOLOALINICIOPosicin al inicio del smbolo de la moneda
2MONEDA_POSICIONSIMBOLOALFINALPosicin al final del smbolo de la moneda
Constantes
ccccccTipos de depreciacin de Activos fijosLa constante EACTIVOFIJOTIPODEPRECIACIONES tiene los siguientes valores:
ValorNombre de la constanteDescripcin
1ACTIVOFIJO_DEPRECIACIONCONTABLEDepreciacin Contable del Activo Fijo
2ACTIVOFIJO_DEPRECIACIONFISCALDepreciacin Fiscal del Activo Fijo
Desglose de Causacin de IVA La constante ECAUSACIONDESGLOSETASAIVA tiene los siguientes valores:
ValorNombre de la constanteDescripcin
1CAUSACION_DESGLOSEIVA15Desglose IVA 15%
2CAUSACION_DESGLOSEIVA10Desglose IVA 10%
3CAUSACION_DESGLOSEIVA0Desglose IVA 0%
4CAUSACION_DESGLOSEIVAEXENTODesglose IVA Exento
5CAUSACION_DESGLOSEIVAOTRASTASASDesglose IVA Otras Tasas
6CAUSACION_DESGLOSEIMPTOSUNTUARIODesglose Impuesto Suntuario
7CAUSACION_DESGLOSEIVAOTROSDesglose IVA Otros
8CAUSACION_DESGLOSEIVARETENIDODesglose IVA Retenido
Tipos de importes en Causacin de IVALa constante ECAUSACIONTIPOIMPORTES tiene los siguientes valores:
ValorNombre de la constanteDescripcin
1CAUSACION_IMPORTETOTALImporte Total
2CAUSACION_IMPORTEIVAImporte del IVA
3CAUSACION_IMPORTEBASEIVAImporte Base del IVA
Tipos de IVA en CausacinLa constante ECAUSACIONTIPOIVA tiene los siguientes valores:
ValorNombre de la constanteDescripcin
1CAUSACION_IVACAUSADOTipo de IVA Causado
2CAUSACION_IVAACREDITABLETipo de IVA Acreditable
Tipos de operacin en Causacin de IVALa constante ECAUSACIONTIPOOPERACION tiene los siguientes valores:
ValorNombre de la constanteDescripcin
1CAUSACION_IVARELACIONADOTipo de IVA Relacionado
2CAUSACION_IVANORELACIONADOTipo de IVA No Relacionado
Tipos de periodos asignados en Causacin de IVALa constante ECAUSACIONTIPOPER tiene los siguientes valores:
ValorNombre de la constanteDescripcin
1CAUSACION_EJERCICIOASIGNADOEjercicio de Causacin Asignado
2CAUSACION_PERIODOASIGNADOPeriodo de Causacin Asignado
Clases de afectacin de plizasLa constante ECLASEPOLIZA tiene los siguientes valores:
ValorNombre de la constanteDescripcin
1CLASE_AFECTARClase Afectar de la Pliza
2CLASE_SINAFECTARClase Sin Afectar de la Pliza
Tipos de Cuenta de MayorLa constante ECUENTADEMAYOR tiene los siguientes valores:
ValorNombre de la constanteDescripcin
1CUENTA_CUENTADEMAYORSISi es cuenta de Mayor
2CUENTA_CUENTADEMAYORNONo es cuenta de Mayor
3CUENTA_CUENTADETITULOEs cuenta de Ttulo
4CUENTA_CUENTADESUBTITULOEs cuenta de Subttulo
Tipos de CuentasLa constante ECUENTATIPO tiene los siguientes valores:
ValorNombre de la constanteDescripcin
1CUENTA_ACTIVOACREEDORAActivo Deudora
2CUENTA_ACTIVODEUDORAActivo Acreedora
3CUENTA_PASIVODEUDORAPasivo Deudora
4CUENTA_PASIVOACREEDORAPasivo Acreedora
5CUENTA_CAPITALDEUDORACapital Deudora
6CUENTA_CAPITALACREEDORACapital Acreedora
7CUENTA_RESULTADOSDEUDORAResultados Deudora
8CUENTA_RESULTADOSACREEDORAResultados Acreedora
9CUENTA_ESTADISTICASDEUDORAEstadsticas Deudora
10CUENTA_ESTADISTICASACREEDORAEstadsticas Acreedora
11CUENTA_ORDENDEUDORAOrden Deudora
12CUENTA_ORDENACREEDORAOrden Acreedora
Tipos de Aplicacin en Devolucin de IVALa constante EDEVOLUCIONTIPOAPLICACION tiene los siguientes valores:
ValorNombre de la constanteDescripcin
1DEVOLUCION_IVAAPLICABLETipo de IVA Aplicable
2DEVOLUCION_IVANOAPLICABLETipo de IVA No Aplicable
Tipos de Importes en Devolucin de IVALa constante EDEVOLUCIONTIPOIMPORTES tiene los siguientes valores:
ValorNombre de la constanteDescripcin
1DEVOLUCION_IMPORTEBASEIVAImporte Base del IVA
2DEVOLUCION_IMPORTEIVAImporte del IVA
Tipos de Diarios EspecialesLa constante EDIARIOTIPO tiene los siguientes valores:
ValorNombre de la constanteDescripcin
1DIARIO_POLIZASDiario de Plizas
2DIARIO_MOVIMIENTOSDiario de Movimientos
3DIARIO_EFECTIVOINGRESOSDiario de Efectivo Ingresos
4DIARIO_EFECTIVOEGRESOSDiario de Efectivo Egresos
Imprimir Cuentas de OrdenLa constante EIMPRIMEORDEN tiene los siguientes valores:
ValorNombre de la constanteDescripcin
0IMPRIMEORDEN_NOIMPRIMIRNo imprimir
1IMPRIMEORDEN_TODASImprimir Todas
2IMPRIMEORDEN_DEUDORASImprimir Deudoras
3IMPRIMEORDEN_ACREEDORASImprimir Acreedoras
4IMPRIMEORDEN_ALGUNASImprimir Algunas
Posiciones del Smbolo de MonedaLa constante EMONEDAPOSICIONSIMBOLO tiene los siguientes valores:
ValorNombre de la constanteDescripcin
1MONEDA_POSICIONSIMBOLOALINICIOPosicin al inicio del smbolo de la moneda
2MONEDA_POSICIONSIMBOLOALFINALPosicin al final del smbolo de la moneda
DescripcinNmeros de campos para la funcin CATALOGO ENUMCAMPOSCATALOGO
ValoresA continuacin se listan los posibles valores:
Nombre de la constanteValorDescripcin
CATALOGO_TIPOCUENTA1Nmero de campo correspondiente al tipo de cuenta
CATALOGO_CODIGOMONEDA2Nmero de campo correspondiente al cdigo de la moneda
CATALOGO_DIGITOAGRUPADOR3Nmero de campo correspondiente al dgito agrupador
CATALOGO_CODIGOSEGNEG4Nmero de campo correspondiente al cdigo del segmento de negocio
ENUMCAMPOSPOLIZA
DescripcinNmeros de campos para la funcin POLIZA
ValoresA continuacin se listan los posibles valores:
Nombre de la constanteValorDescripcin
POLIZA_CONCEPTO1Nmero de campo correspondiente al concepto de la pliza
POLIZA_CARGOS2Nmero de campo correspondiente al total de cargos de la pliza
POLIZA_ABONOS3Nmero de campo correspondiente al total de abonos de la pliza
POLIZA_CODIGODIARIO4Nmero de campo correspondiente al cdigo del diario especial de la pliza
ENUMCAMPOSPOLMOV
DescripcinNmeros de campos para la funcin POLMOV
ValoresA continuacin se listan los posibles valores:
Nombre de la constanteValorDescripcin
POLMOV_CODIGOCUENTA1Nmero de campo correspondiente al cdigo de la cuenta del movimiento de la pliza
POLMOV_REFERENCIA2Nmero de campo correspondiente a la referencia del movimiento de la pliza
POLMOV_CARGO3Nmero de campo correspondiente al cargo en moneda base del movimiento de la pliza
POLMOV_ABONO4Nmero de campo correspondiente al abono en moneda base del movimiento de la pliza
POLMOV_CODIGODIARIO5Nmero de campo correspondiente al cdigo del diario especial del movimiento de la pliza
POLMOV_CARGOME6Nmero de campo correspondiente al cargo en moneda extranjera del movimiento de la pliza
POLMOV_ABONOME7Nmero de campo correspondiente al abono en moneda extranjera del movimiento de la pliza
POLMOV_CONCEPTO8Nmero de campo correspondiente al concepto del movimiento de la pliza
ENUMCAMPOSPROVEEDOR
DescripcinNmeros de campos para la funcin PROVEEDOR
ValoresA continuacin se listan los posibles valores:
Nombre de la constanteValorDescripcin
PROVEEDOR_RAZONSOCIAL1Nmero de campo correspondiente a la razn social del proveedor
PROVEEDOR_RFC2Nmero de campo correspondiente al R.F.C. del proveedor
PROVEEDOR_CURP3Nmero de campo correspondiente al C.U.R.P. del proveedor
PROVEEDOR_TIPOOPERACION4Nmero de campo correspondiente al tipo de operacin del proveedor
PROVEEDOR_CODIGOCUENTA5Nmero de campo correspondiente al cdigo de la cuenta del proveedor
EREPFORMAEDORES
DescripcinForma Reporte Estado de Resultados
ValoresA continuacin se listan los posibles valores:
Nombre de la constanteValorDescripcin
REPFORMAEDORES_PERIODOYACUMULADO1Periodo y Acumulado
REPFORMAEDORES_EJEACTUALYEJEANT2Ejercicio Actual vs Ejercicio Anterior
REPFORMAEDORES_REALVSPRESUPUESTO3Real vs Presupuesto
EREPIDIOMA
DescripcinIdioma de Reportes
ValoresA continuacin se listan los posibles valores:
Nombre de la constanteValorDescripcin
REPIDIOMA_BASE0Idioma base
REPIDIOMA_OTROIDIOMA1Otro idioma
EREPNIVELBALANZA
DescripcinNivel de cuentas
ValoresA continuacin se listan los posibles valores:
Nombre de la constanteValorDescripcin
REPNIVELBALANZA_TODOS1Todos
REPNIVELBALANZA_MAYOR2Mayor
REPNIVELBALANZA_ULTIMONIVEL3Ultimo Nivel
EREPPERIODOS
DescripcinNmero de Periodos para Reportes
ValoresA continuacin se listan los posibles valores:
Nombre de la constanteValorDescripcin
REPPER_PRIMERO1Primer Periodo
REPPER_SEGUNDO2Segundo Periodo
REPPER_TERCERO3Tercer Periodo
REPPER_CUARTO4Cuarto Periodo
REPPER_QUINTO5Quinto Periodo
REPPER_SEXTO6Sexto Periodo
REPPER_SPTIMO7Sptimo Periodo
REPPER_OCTAVO8Octavo Periodo
REPPER_NOVENO9Noveno Periodo
REPPER_DECIMO10Dcimo Periodo
REPPER_DECIMOPRIMERO11Dcimo primer Periodo
REPPER_DECIMOSEGUNDO12Dcimo segundo Periodo
REPPER_DECIMOTERCERO13Dcimo tercer Periodo
REPPER_AJUSTE14Periodo de ajuste
REPPER_DELEJERCICIO15Del ejercicio
ESISTORIGEN
DescripcinSistemas Origen de Plizas
ValoresA continuacin se listan los posibles valores:
Nombre de la constanteValorDescripcin
ORIG_ADMINPAQNG17 (&H11)Sistema Origen AdminPAQ NG
ORIG_ADMINPAQWIN7Sistema Origen AdminPAQ Windows
ORIG_CHEQPAQN15Sistema Origen CheqPAQ NG
ORIG_CHEQPAQWIN5Sistema Origen CheqPAQ Windows
ORIG_CONTPAQNG11Sistema Origen ContPAQ NG
ORIG_CONTPAQWIN1Sistema Origen ContPAQ Windows
ORIG_EXION8Sistema Origen Exin Windows
ORIG_NOMIPAQNG16 (&H10)Sistema Origen NomiPAQ NG
ORIG_NOMIPAQWIN6Sistema Origen NomiPAQ Windows
ETASAASUMIDAPROV
DescripcinTasas Asumidas de Proveedores
ValoresA continuacin se listan los posibles valores:
Nombre de la constanteValorDescripcin
TAASUPRO_TASA03Tasa 0%
TAASUPRO_TASA102Tasa 10%
TAASUPRO_TASA151Tasa 15%
TAASUPRO_TASAEXENTO4Tasa Exento
TAASUPRO_TASAOTRA15Tasa Otra 1
TAASUPRO_TASAOTRA26Tasa Otra 1
ETIPOCODIGOAF
DescripcinTipo de Cdigo de Activo Fijo
ValoresA continuacin se listan los posibles valores:
Nombre de la constanteValorDescripcin
TIPOCODIGOAF_CUENTA2Cuenta
TIPOCODIGOAF_NUMERO1Nmero
ETIPOIMPORTEMOVPOLIZA
DescripcinTipos de Importes en Movimientos de Plizas
ValoresA continuacin se listan los posibles valores:
Nombre de la constanteValorDescripcin
MOVPOLIZA_CARGO1Importe de Cargo
MOVPOLIZA_ABONO2Importe de Abono
ETIPOOPERACION
DescripcinTipos de Operacin
ValoresA continuacin se listan los posibles valores:
Nombre de la constanteValorDescripcin
TIPOOPE_ADQBIENINTAN29 (&H1D)Adquisicin de otros bienes intangibles
TIPOOPE_ARRENINMUEBLE6Arrendamiento de Inmuebles
TIPOOPE_DIVCUFIN13Dividendos provenientes de CUFIN
TIPOOPE_DIVCUFINRE17 (&H11)Dividendos provenientes de CUFINRE
TIPOOPE_DIVNOCUFIN14Dividendos no provenientes de CUFIN
T