Está en la página 1de 188

SDK de los sistemas

73320140115

Pgina: 1

INTRODUCCIN
Qu es un SDK
Software Development Kit (SDK) o kit de desarrollo de software. Es generalmente un conjunto de
herramientas de desarrollo que le permite a un programador crear aplicaciones para un sistema bastante
concreto, por ejemplo ciertos paquetes de software, frameworks, plataformas de hardware, ordenadores,
videoconsolas, sistemas operativos, etctera.
En el caso de AdminPAQ y CONTPAQ i FACTURA ELECTRNICA, el SDK es un conjunto de archivos que
contienen funciones publicadas, las cuales pueden ser usadas por desarrolladores externos para
manipular (consultar o modificar) informacin de la base de datos de estos sistemas.

Cmo funciona
Las funciones disponibles en el SDK se comunican con AdminPAQ o CONTPAQ i FACTURA ELECTRNICA a
travs de mtodos de clases, estas a su vez hacen llamados a las clases base de AdminPAQ o CONTPAQ
i FACTURA ELECTRNICA, es decir, a las clases usadas dentro de AdminPAQ o CONTPAQ i FACTURA
ELECTRNICA.
El SDK controla la concurrencia en un ambiente multiusuario, es decir las funciones dan el soporte para los
bloqueos y protegen los accesos. (Permite operar como si se tratara de una estacin de AdminPAQ o
CONTPAQ i FACTURA ELECTRNICA).
Protege las bases de datos, sus relaciones y sigue las reglas de negocio de AdminPAQ o CONTPAQ i
FACTURA ELECTRNICA

Pgina: 2

Requerimientos para trabajar con el SDK


Ambiente
AdminPAQ o CONTPAQ i FACTURA ELECTRNICA instalado (monousuario o como estacin).
Entorno de programacin. Editor/Compilador del lenguaje elegido
(VB / Delphi / C / Plataforma .net, etc).
Verifica contar con la licencia requerida por las funciones. Algunas funciones, como las de timbrado
requieren licencias de un nmero de usuarios especfico.
Si ests programando en VBA (Excel) el SDK solo funciona en Office de 32 bits.
Archivos usados por el SDK.
Todos estos archivos son utilizados por el SDK:
Archivo
MGW_SDK.dll
MGW_SDK.h
MGW_SDK.lib
CAC000.dll
CAC100.dll
CAC200.dll
CAC300.dll
CAC400.dll
CAC500.dll
CAC600.dll
CAC700.dll
CAC800.dll
CACc4dll.dll

Descripcin
Es la interfase del SDK con AdminPAQ .
Libreria de encadenado, aqu se encuentran
funciones del SDK.
Encabezado que contiene la declaracin de
funciones, constates y estructuras definidas
C++ Builder.
Libreria que contiene las funciones del SDK
AdminPAQ, generada con C++ Builder.
Modelo de componentes compuestos

las

Ubicacin
C:\Archivos de
programa\Compacw\AdminPAQ

las
en

C:\Archivos de
programa\Compacw\AdminPAQ\SDK

de

C:\Archivos de
programa\Compacw\AdminPAQ\SDK
C:\Archivos de
programa\Compacw\AdminPAQ

Motor BDD

caccodebase.dll

Motor BDD

CACEsp.dll

Textos

Estandar.mgw

Textos/Dialogos/Mensajes

MGW000.dll
MGW001.dll
MGW002.dll
MgwEsp.dll

Reglas de negocio AdminPAQ

DBFWIN32.DLL
BDEWIN.DLL

Funciones genricas de lectura utilizada por los


sistemas de Computacin en Accin.
En el caso de AdminPAQ se hace uso del
DBFWIN32.DLL .

Textos

C:\Archivos de
programa\Compacw\AdminPAQ
C:\Archivos de
programa\Compacw\AdminPAQ
C:\Archivos de
programa\Compacw\AdminPAQ
C:\Archivos de
programa\Compacw\AdminPAQ
C:\Archivos de
programa\Compacw\AdminPAQ
C:\Archivos de
programa\Compacw\AdminPAQ
C:\Archivos de
programa\Compacw\AdminPAQ

CONTPAQ i FACTURA ELECTRNICA: Para el caso de este sistema los archivos se encuentran en la
carpeta Facturacion en vez de la carpeta AdminPAQ.
Importante: Se debe tener especial cuidado con el control de versiones con el SDK en la que se desarrolla
una aplicacin y la versin de AdminPAQ con la que va a interactuar. Es decir, no se recomienda
desarrollar una aplicacin con el SDK de AdminPAQ 6.0.0 para interactuar con un AdminPAQ 7.0.0.

Pgina: 3

RECOMENDACIONES Y CONSIDERACIONES IMPORTANTES


Tips y Conceptos Bsicos

Siempre ten en cuenta que las funciones del SDK estn en C++, el objetivo al declarar las funciones en tu
lenguaje es pasar los tipos de datos que C++ pueda recibir. Busca el tipo de datos en tu lenguaje que
coincida mejor con el tipo de C++.

En C++ todas las cadenas son de tipo Char*, por lo que si en tu lenguaje de programacin utilizas el tipo
String estos siempre se debern pasar Por Valor.

Antes de hacer accesos mediante el SDK, asegurarse que AdminPAQ o CONTPAQ i FACTURA
ELECTRNICA funciona correctamente y que la informacin que est generando es correcta.

Estar familiarizado con la estructura de la Base de Datos de AdminPAQ o CONTPAQ i FACTURA


ELECTRNICA.

Tener claro y bien conceptualizado el fin y el alcance de la aplicacin a desarrollar.

Ir por partes, es decir: Primero crear la conexin a la base de datos, inicializar el SDK y generar un
documento desde la aplicacin; posteriormente verificar que funciona correctamente (que se crea sin
problemas el documento en AdminPAQ o CONTPAQ i FACTURA ELECTRNICA).

Modularizar el cdigo (Si el entorno de programacin lo permite). Esto es crear diversos mdulos para
separar funcionalidad global y local.
Ejemplo: Usar un mdulo en el cual se realice la declaracin de constantes, variables globales, estructuras
de datos y enlace a las funciones del archivo MGW_SDK.DLL; y usar otro modulo para las funciones
creadas por el desarrollador y que modificaran la informacin que se recibe y enva de la Base de Datos
de AdminPAQ o CONTPAQ i FACTURA ELECTRNICA.
Esto facilitar la portabilidad y la reutilizacin de cdigo, as como el mantenimiento y actualizacin de la
funcionalidad.

Revisar que los documentos y sus movimientos se graban/actualizan de manera correcta en AdminPAQ o
CONTPAQ i FACTURA ELECTRNICA.

Validar desde la aplicacin que se desarrolla que los datos que se envan sea consistente y que tenga el
formato correcto.

Probar continuamente la aplicacin con todas las posibles combinaciones que permita.

Pgina: 4

Funciones Obligatorias
Son las funciones que forzosamente deben incluirse en cualquier aplicacin que use el SDK:
El mtodo, a grandes ragos, se compone de:
Inicializar el SDK al inicio de cada proceso. fInicializaSDK.
Esta funcin se llama una sola vez al iniciar un proceso o accin completa.
Ejemplo: El alta de un documento y todos sus movimientos. Se inicia el SDK, se hace el llamado a todas
las funciones requeridas y luego se termina el SDK.
Funciones para abrir y cerrar empresa:
Se usan para indicar las bases de datos de la empresa a la cual afectar la aplicacin que hace uso
del SDK. (fAbreEmpresa / fCierraEmpresa)
Solo se puede trabajar en una empresa a la vez (a menos que se corran la misma aplicacin dos
veces).
Incluir la funcin fError del SDK para recuperar la descripcin de los posibles errores. La mayora de las
funciones regresan un cdigo de error, donde 0 indica que no se presentaron errores y un numero
diferente de 0 cuando ocurri algn error.
Se utiliza la funcin fError para recuperar la descripcin de dicho error.
Usar siempre la funcin fTerminaSDK para liberar todos los recursos solicitados por el SDK, al final de
cada proceso completo. sta funcin se llama una sola vez al finalizar un proceso o accin completa.
Estructura general de una aplicacin desarrollada con el SDK.
Establecer el directorio del MGW_SDK
Inicializar SDK
Abrir Empresa
Tu funcin o proceso completo
Cerrar Empresa
Terminar SDK

Pgina: 5

Trabajando con documentos


Cuando se trabaje con documentos siempre se deben afectar.
Al crear documentos La existencia y los costos se afectan, sin emnbargo los acumulados del sistema no, por lo que
es necesario despus de crear documentos con sus movimientos correspondientes es necsario afectarlos.
En el SDK existen dos tipos de afectacin, una para los documentos de cargo y abono y otra para los dems tipos
de documento.
Estructura general de una aplicacin que da de alta documentos y sus movimientos con el SDK.
Establecer el directorio del MGW_SDK
Inicializar SDK
Abrir Empresa
Alta de documento
Alta de movimientos
Afectar documento
Cerrar Empresa
Terminar SDK
Estructura general de una aplicacin que da de alta documentos de Cargo y Abono con el SDK.
Establecer el directorio del MGW_SDK
Inicializar SDK
Abrir Empresa
Alta de documento Cargo/Abono
Afectar documento
Cerrar Empresa
Terminar SDK
Las funciones de afectacin de documentos son:
fAfectaDocto_Param () y fAfectaDocto (), bajo y alto nivel respectivamente.
Estructura general de un documento que maneja series y/o pedimentos
Establecer el directorio del MGW_SDK
Inicializar SDK
Abrir Empresa
Alta de documento
Alta de movimientos
Alta del movimiento con series o pedimentos
Calcula los movimentos con series o pedimentos
Afectar documento
Cerrar Empresa
Terminar SDK

Pgina: 6

Trabajando con productos o clientes


Estructura general para dar de alta productos o clientes.
Establecer el directorio del MGW_SDK
Inicializar SDK
Abrir Empresa
Alta de producto o cliente
Cerrar Empresa
Terminar SDK
Estructura general para editar productos.
Establecer el directorio del MGW_SDK
Inicializar SDK
Abrir Empresa
Busca el producto o cliente
Edita el producto o cliente
Modifica el campo del producto o el cliente
Guarda el producto o cliente
Cerrar Empresa
Terminar SDK

Timbrar documentos
Estructura general para crear un documento y timbrarlo.
Establecer el directorio del MGW_SDK
Inicializar SDK
Abrir Empresa
Alta de documento
Alta de movimientos
Afectar documento
Inicializa informacin de la licencia
Emite/Timbra el documento
Entrega el documento
Cerrar Empresa
Terminar SDK
Estructura general para timbrar un XML creado por un tercero.
Establecer el directorio del MGW_SDK
Inicializar SDK
Abrir Empresa
Inicializa informacin de la licencia
Timbra el XML
Cerrar Empresa
Terminar SDK

Pgina: 7

Cundo usar funciones de Alto Nivel y cuando de Bajo Nivel


En trminos generales se recomienda usar las funciones de alto nivel debido a que estas realizan todo los
procesos necesarios para mantener las reglas de negocio y la base de datos estable.
Cualquier lenguaje de programacin que soporte estructuras de datos podr hacer uso de las funciones
de alto nivel, la razn es que como generalidad las funciones de alto nivel efectan operaciones con
registros completos.
Las funciones de bajo nivel permiten ms flexibilidad en cuanto que datos se graban el la base de datos,
pero implican ms trabajo, por realizar escritura campo por campo, y complejidad pues se tienen que
validar diversos puentos para no romper las reglas de negocio, por lo que para su uso se requiere mas
precisin al desarrollar el proceso.
Estas funciones se pueden usar en cualquier lenguaje de programacin, ms son de carcter obligatorio
en aquellos que no manejen estructuras de datos. Por ejemplo Visual FoxPro.
Ejemplo: Dar de alta de datos extras del catlogo slo se puede efectuar con las funciones de bajo
nivel
Algunos lenguajes como Visual FoxPro no soportan el uso de estructuras de datos, por lo que forzosamente
se deben usar las funciones de bajo nivel.

Pgina: 8

Restricciones al usar funciones de Bajo Nivel


Las funciones de bajo nivel permiten la escritura campo a campo en la BD de AdminPAQ, sin embargo
existen campos que no pueden ser modificadas por dichas funciones pues son valores que calcula o
modifica AdminPAQ o CONTPAQ i FACTURA ELECTRNICA.
Campo
cIdDocumento
cIdDocumentoDe
cIdConcepto
cIdCteProv
cIdAgente
cIdConcepto
cNeto
cTotal
cAfectado
cNaturaleza
cDocumentoOrigen
cPlantillacUsaProveedor
cUsaCliente
cNetocTotalUnidades
cBanObsevaciones
cBanDatosEnvio
cBanCondCredito
CUnidadesPendientes
cTimeStamp

Razn
Es un dato autogenerado.
Depende de la plantilla del documento.
Es un dato autogenerado.
Es un dato autogenerado.
Es un dato autogenerado.
Es un dato autogenerado.
Es un campo calculado.
Es un campo calculado.
Es un campo protegido.
Es un dato autogenerado.
Es un dato autogenerado.
Es un campo calculado.
Es un dato autogenerado.
Es un campo calculado.
Es un dato autogenerado.
Es un dato autogenerado.
Es un dato autogenerado.
Es un campo calculado.
Es un dato autogenerado.

Pgina: 9

Recomendaciones para el manejo de cadenas


La forma en que cada lenguaje de programacin define los tipos de datos cadena es vara entre
lenguajes (en cuanto a su tamao en bytes). Por esta razon los tipos de datos manejados por distintos
lenguajes pueden presentar problemas al pasar informacin al SDK. En C++ Builder y Delphi este
inconveniente no se presenta.
Al usar el SDK en Visual Basic. Para llenar los campos cadena que forman parte de la estructura, es
necesario llenar con espacios en blanco las variables tipo cadena hasta alcanzar la longitud requerida
por el SDK, por la diferencia que existe con este lenguaje al manejar los tipos de datos.
El error que se produce cuando no se llenan adecuadamente las estructuras es codigo no existe
Para contrarrestar este error se usan dos funciones de manipulacin de cadenas.
La funcin para llenar espacios en Visual Basic es la siguiente:
' Funcin f_RellenaConBlancos
Public Sub f_RellenaConBlancos(ByRef aCadena As String, aTamanio As Integer)
Dim lEspacios As String
Dim lTamanio As Long
lEspacios = Space(aTamanio)
lTamanio = aTamanio - Len(Trim(aCadena)) - 1
aCadena = Trim(aCadena) & Left(lEspacios, lTamanio) & Chr(0)
End Sub
Para realizar comparaciones dentro de VB es necesario quitar el carcter nlo.
' Funcion Quita Caracteres nulos
Public Function f_QuitaCaracterNulo(aCadena As String) As String
Dim lCadenaTemp As String
lCadenaTemp = Replace(aCadena, Chr(0), " ")
if_QuitaCaracterNulo = Trim(lCadenaTemp)
End Function

Pgina: 10

FUNCIONES GENERALES
Inicializacin / Terminacin
fInicializaSDK ()
Disponibilidad

AdminPAQ 2002.

Sintaxis

fInicializaSDK()

Parmetros

No usa.

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.
Inicializa el SDK de AdminPAQ. Se requiere llamar esta funcin al inicio de
cualquier aplicacin que utilice el SDK.

Descripcin

Establece la conexin entre la aplicacin desarrollada y la Base de datos de AdminPAQ. Su


uso es obligatorio.
Ejemplo

El siguiente cdigo inicializa el SDK de AdminPAQ y asigna el resultado a una variable entera
que se evala posteriormente; si su valor es distinto de 0 (cero) la aplicacin se detiene.
lError = fInicializaSDK()
If lError <> 0 Then
MensajeError lError
End
End If

Ver tambin

fTerminaSDK ()

fTerminaSDK (), fError()

Disponibilidad

AdminPAQ 2002.

Sintaxis

fTerminaSDK ()

Parmetros

No usa.

Retorna

No tiene valor de retorno.

Descripcin

Libera todos los recursos solicitados por el SDK, se requiere llamar al terminar de
utilizar el SDK.

Ejemplo

El siguiente cdigo termina el SDK de AdminPAQ.


fTerminaSDK()

Ver tambin

fInicializaSDK (), fError()

Pgina: 11

fSetNombrePAQ ()
Disponibilidad

AdminPAQ 2.2.0. CONTPAQ i FACTURA ELECTRNICA 1.0.0

Sintaxis

fSetNombrePAQ(aSistema)

Parmetros

Retorna
Descripcin

Ejemplo

Nombre
aSistema

Tipo
Cadena

Uso
Por referencia

Para establecer una conexin


a CONTPAQ i FACTURA
ELECTRNICA este parmetro
deber ser igual a CONTPAQ I
Facturacion

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.
Esta funcin define el sistema al que se conectar el SDK. Sino se usa esta funcin la conexin
por omisin ser al sistema AdminPAQ.
Si se desea establecer una conexin a CONTPAQ i FACTURA ELECTRNICA el parmetro
aSistema deber ser CONTPAQ I Facturacion y se deber utilizar en vez de la funcin
fInicializaSDK().
El siguiente cdigo crea una conexin al SDK de CONTPAQ i FACTURA ELECTRNICA.
Public Const kFACTURACION_I = "CONTPAQ I Facturacion"
Call fSetNombrePAQ(kFACTURACION_I)

Ver tambin

Descripcin
Nombre del sistema al que se
conectar el SDK.

fInicializaSDK (), fTerminaSDK ()

Pgina: 12

Manejo de errores
fError ()

Disponibilidad

AdminPAQ 2002.

Sintaxis

fError(aNumError, aMensaje, aLen )

Parmetros

Nombre
aNumError
aMensaje
aLen

Tipo
Entero
Cadena
Entero

Uso
Por valor
Por referencia
Por valor

Descripcin
Nmero del error.
Descripcin del error.
Longitud del mensaje de error.

Retorna

aMensaje: Al finalizar la funcin este parmetro contiene el mensaje de error correspondiente


al nmero de error especificado en aNumError.

Descripcin

Esta funcin recupera el mensaje de error del SDK.

Ejemplo

El siguiente cdigo asigna a la variable lError el resultado de la funcin fInicializaSDK(), en caso


de que suceda algn error (valor distinto de 0), la funcin fError se ejecuta obteniendo el
mensaje correspondiente al nmero de error enviado, mostrando una longitud de mensaje de
350 caracteres.
lError = fInicializaSDK()
If lError <> 0 Then
fError lError, lMensaje, 350
End
End If

Ver tambin

fInicializaSDK (), fTerminaSDK ()

Pgina: 13

FUNCIONES DE EMPRESAS
Navegacin
fPosPrimerEmpresa ()
Disponibilidad

AdminPAQ 2002.

Sintaxis

fPosPrimerEmpresa(aIdEmpresa, aNombreEmpresa, aDirectorioEmpresa )

Parmetros

Retorna

Nombre
aIdEmpresa
aNombreEmpresa
aDirectorioEmpresa

Tipo
Entero
Cadena
Cadena

Uso
Por referencia
Por referencia
Por referencia

Descripcin
Identificador de la empresa.
Nombre de la empresa.
Directorio de la empresa.

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.
aIdEmpresa: Al finalizar la funcin este parmetro contiene el identificador de la primera
empresa registrada en la Base de Datos.
aNombreEmpresa: Al finalizar la funcin este parmetro contiene el nombre de la primera
empresa registrada en la Base de Datos.
aDirectorioEmpresa: Al finalizar la funcin este parmetro contiene el directorio de la primera
empresa registrada en la base de datos.

Descripcin

Esta funcin se posiciona en el primer registro de la base de datos de empresas de AdminPAQ,


modifica los parmetros aNombreEmpresa y aDirectorioEmpresa, en los cuales guarda el
nombre de la primera empresa y su ruta, correspondientemente.

Ejemplo

El siguiente cdigo indica a la aplicacin que se posicione en el primer registro de empresas


de la base de datos de AdminPAQ.
fPosPrimerEmpresa(lIdEmpresa, lNombreEmpresa, lDirectorioEmpresa)

Ver tambin

fPosSiguienteEmpresa (), fAbreEmpresa (), fCierraEmpresa ()

Pgina: 14

fPosSiguienteEmpresa ()
Disponibilidad

AdminPAQ 2002.

Sintaxis

fPosSiguienteEmpresa (aIdEmpresa, aNombreEmpresa, aDirectorioEmpresa )

Parmetros

Retorna

Nombre
aIdEmpresa
aNombreEmpresa
aDirectorioEmpresa

Tipo
Entero
Cadena
Cadena

Uso
Por referencia
Por referencia
Por referencia

Descripcin
Identificador de la empresa.
Nombre de la empresa.
Directorio de la empresa.

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.
aIdEmpresa: Al finalizar la funcin este parmetro contiene el identificador de la siguiente
empresa registrada en la Base de Datos.
aNombreEmpresa: Al finalizar la funcin este parmetro contiene el nombre de la siguiente
empresa registrada en la base de datos.
aDirectorioEmpresa: Al finalizar la funcin este parmetro contiene el directorio de la siguiente
empresa registrada en la base de datos.

Descripcin

Esta funcin avanza al siguiente registro en la tabla de Empresas de AdminPAQ; en caso de


que no exista un siguiente registro, la funcin retorna un valor distinto de 0 (cero).

Ejemplo

El siguiente cdigo termina el SDK de AdminPAQ.


fPosSiguienteEmpresa (lIdEmpresa, lNombreEmpresa, lDirectorioEmpresa )

Ver tambin

fPosPrimerEmpresa (), fAbreEmpresa (), fCierraEmpresa ()

Pgina: 15

Apertura / Cierre
fAbreEmpresa ()
Disponibilidad

AdminPAQ 2002.

Sintaxis

fAbreEmpresa (aDirectorioEmpresa )

Parmetros

Nombre
aDirectorioEmpresa

Tipo
Cadena

Uso
Por Referencia

Descripcin
Directorio de la empresa.

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin abre la empresa que corresponde a la ruta especificada en el parmetro


aDirectorioEmpresa.

Ejemplo

El siguiente cdigo indica a la aplicacin que abra la empresa ubicada el la ruta


C:\Compacw\Empresas\EmpresaEjemplo.
lDirectorioEmpresa = C:\Compacw\Empresas\EmpresaEjemplo
fAbreEmpresa (lDirectorioEmpresa)

Ver tambin

fPosPrimerEmpresa (), fPosSiguienteEmpresa (), fCierraEmpresa (),fInicializaSDK (),


fTerminaSDK ()

fCierraEmpresa ()
Disponibilidad

AdminPAQ 2002.

Sintaxis

fCierraEmpresa ()

Parmetros

No usa.

Retorna

No tiene valor de retorno.

Descripcin

Cierra la conexin con la empresa activa en la aplicacin que usa el SDK.

Ejemplo

El siguiente cdigo cierra la empresa activa.


fCierraEmpresa()

Ver tambin

fPosPrimerEmpresa (), fPosSiguienteEmpresa (), fAbreEmpresa (),fInicializaSDK (), fTerminaSDK ()

Pgina: 16

FUNCIONES DE DOCUMENTOS
Bajo Nivel Lectura/Escritura
fInsertarDocumento ()
Disponibilidad

AdminPAQ 2002.

Sintaxis

fInsertarDocumento ()

Parmetros

No usa.

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error
Adiciona un nuevo registro en la tabla de Documentos en modo de insercin.

Descripcin
Ejemplo

El siguiente cdigo indica a la aplicacin que inserte un nuevo registro en la tabla de


Documentos.
fInsertarDocumento ()

Ver tambin

fEditarDocumento (), fGuardaDocumento (), fBorraDocumento (), fAfectaDocto_Param (),


fCancelarModificacionDocumento (),fCancelaDocumento (), fSaldarDocumento_Param (),
fBorrarAsociacion_Param (), fSetDatoDocumento (), fLeeDatoDocumento (), fSiguienteFolio (),
fSetFiltroDocumento (), fCancelaFiltroDocumento (), fBuscarDocumento (),
fBuscarIdDocumento (), fAltaDocumento (), fAltaDocumentoCargoAbono (), fAfectaDocto (),
fSaldarDocumento (),fBuscaDocumento ()

Pgina: 17

fEditarDocumento ()
Disponibilidad

AdminPAQ 2002.

Sintaxis

fEditarDocumento ()

Parmetros

No usa.

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error

Descripcin

Activa el modo de Edicin de un registro en la tabla de Documentos.

Ejemplo

El siguiente cdigo busca un documento por su llave, si lo encuentra lo activa en modo


edicin, en caso de no encontrarlo enva el mensaje de error correspondiente
lError = fBuscaDocumento(lLlaveDocto )
If lError <> 0 Then
MensajeError lError
Else
fEditarDocumento ()
End If

Ver tambin

fInsertarDocumento (), fGuardaDocumento (), fBorraDocumento (),


fCancelarModificacionDocumento (),fCancelaDocumento (), fSetDatoDocumento (),
fLeeDatoDocumento (), fSiguienteFolio (), fSetFiltroDocumento (), fCancelaFiltroDocumento (),
fDocumentoImpreso (), fBuscarDocumento (), fAltaDocumento (), fAfectaDocto (),
fSaldarDocumento (), fSaldarDocumentoCheqPAQ (), fBorrarAsociacion (), fRegresaIVACargo
(), fRegresaIVAPago (), fBuscaDocumento ()

Pgina: 18

fGuardaDocumento ()
Disponibilidad

AdminPAQ 2002.

Sintaxis

fGuardaDocumento ()

Parmetros

No usa.

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Guarda los cambios realizados a un documento.

Ejemplo

El siguiente cdigo indica a la aplicacin que guarde los cambios al documento activo. Esta
funcin se llama despus de que se utiliza la funcin fInsertarDocumento() o fEditarDocumento
y se graban los valores en los campos correspondientes.
fGuardaDocumento ()

Ver tambin

fInsertarDocumento (), fEditarDocumento (), fBorraDocumento(),fCancelaDocumento


(),fCancelarModificacionDocumento (), fSetDatoDocumento (), fLeeDatoDocumento (),
fSetFiltroDocumento (), fCancelaFiltroDocumento (), fAltaDocumento (),
fAltaDocumentoCargoAbono (),fAfectaDocto_Param (), fAfectaDocto (), fSaldarDocumento
(), fBorrarAsociacion (), fRegresaIVACargo (), fRegresaIVAPago (), fBuscaDocumento ()

Pgina: 19

fCancelarModificacionDocumento ()
Disponibilidad

AdminPAQ 2002.

Sintaxis

fCancelarModificacionDocumento ()

Parmetros

No usa.

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin cancela las modificaciones al registro actual de documentos. El registro debe
estar en modo de edicin o insercin.

Ejemplo

El siguiente cdigo indica a la aplicacin que cancele la modificacin a un registro de


documentos que estaba en modo de insercin o edicin.

Ver tambin

fInsertarDocumento (), fEditarDocumento (), fGuardaDocumento (), fBorraDocumento (),


fCancelaDocumento () ,fSetDatoDocumento (), fLeeDatoDocumento (), fSiguienteFolio (),
fBuscarDocumento (), fAltaDocumento (), fAltaDocumentoCargoAbono (), fAfectaDocto (),
fSaldarDocumento (), fSaldarDocumentoCheqPAQ (), fBorrarAsociacion (), fRegresaIVACargo
(), fRegresaIVAPago (), fBuscaDocumento ()

fCancelarModificacionDocumento ()

Pgina: 20

fBorraDocumento ()
Disponibilidad

AdminPAQ 2002.

Sintaxis

fBorraDocumento ()

Parmetros

No usa.

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.
Borra un registro en la tabla de Documentos.
El siguiente cdigo busca un documento por su llave, si lo encuentra lo borra, en caso
contrario enva el mensaje de error correspondiente

Descripcin
Ejemplo

lError = fBuscaDocumento(lLlaveDocto )
If lError <> 0 Then
MensajeError lError
Else
fBorraDocumento ()
End If

Ver tambin

fInsertarDocumento (), fEditarDocumento (), fGuardaDocumento (),


fCancelarModificacionDocumento (),fCancelaDocumento (), fSetDatoDocumento (),
fLeeDatoDocumento (), fBuscarDocumento (), fBuscaDocumento ()

Pgina: 21

fCancelaDocumento ()
Disponibilidad

AdminPAQ 2006 v. 3.2.2.

Sintaxis

fCancelaDocumento ()

Parmetros
Retorna

No usa.
Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin cancela documentos de AdminPAQ.

Ejemplo

El siguiente cdigo indica a la aplicacin que cancele la modificacin a un registro de


documentos que estaba en modo de insercin o edicin.

Ver tambin

lError = fBuscaDocumento(lLlaveDocto )
If lError <> 0 Then
MensajeError lError
Else
fCancelaDocumento ()
End If

fCancelaDocumento (), fCancelaDocumento_CW (), fAfectaDocto_Param (),


fSaldarDocumento_Param (), fBorrarAsociacion_Param (), fBuscarDocumento (),
fBuscarIdDocumento (), fAfectaDocto (), fSaldarDocumento (), fSaldarDocumentoCheqPAQ
(), fBorrarAsociacion (), fBuscaDocumento ()

Pgina: 22

fBorraDocumento_CW ()
Disponibilidad

AdminPAQ 2005.

Sintaxis
Parmetros

fBorraDocumento_CW ()
No usa.

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.
Borra un documento de AdminPAQ y si este estuviera contabilizacin tambin borra la pliza
correspondiente en ContPAQ.

Descripcin
Ejemplo

El siguiente cdigo busca un documento por su llave, si lo encuentra lo borra, en caso


contrario enva el mensaje de error correspondiente.
lError = fBuscaDocumento(lLlaveDocto )
If lError <> 0 Then
MensajeError lError
Else
fBorraDocumento_CW ()
End If

Ver tambin

fGuardaDocumento (), fBorraDocumento (), fCancelarModificacionDocumento


(),fBorraDocumento_CW (), fBuscarDocumento (), fBuscarIdDocumento (),fAltaDocumento (),
fAltaDocumentoCargoAbono (), fBorrarAsociacion (), fBuscaDocumento ()

Pgina: 23

fCancelaDocumento_CW ()
Disponibilidad

AdminPAQ 2006 v. 3.2.2.

Sintaxis

fCancelaDocumento ()

Parmetros

No usa.

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin cancela un documento de AdminPAQ y borra la poliza correspondiente en


ContPAQ.
El siguiente cdigo busca un documento por su llave, si lo encuentra lo cancela, en caso
contrario enva el mensaje de error correspondiente.

Ejemplo

lError = fBuscaDocumento(lLlaveDocto )
If lError <> 0 Then
MensajeError lError
Else
fCancelaDocumento ()
End If

Ver tambin

fCancelaDocumento_CW (), fAfectaDocto_Param (), fSaldarDocumento_Param (),


fBorrarAsociacion_Param (), fBuscarDocumento (), fBuscarIdDocumento (), fAltaDocumento (),
fAltaDocumentoCargoAbono (), fAfectaDocto (), fSaldarDocumento (),
fSaldarDocumentoCheqPAQ (), fBorrarAsociacion (), fBuscaDocumento ()

Pgina: 24

fAfectaDocto_Param ()
Disponibilidad

AdminPAQ 2005.

Sintaxis

fAfectaDocto (aCodConcepto, aSerie, aFolio, aAfecta)

Parmetros

Nombre
aCodConcepto

Tipo
Cadena

Uso
Por valor

aSerie
aFolio
aAfecta

Cadena
Doble
Lgico (Bool)

Por valor
Por valor
Por valor

Descripcin
Cdigo del concepto del
documento.
Serie del documento
Folio del documento
Verdadero o falso.
Afectar o desafectar.

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin utiliza aCodConcepto, aSerie, y aFolio como llave del documento y aAfecta para
afectar o desafectarlo.

Ejemplo

El siguiente cdigo indica a la aplicacin que de afecte un documento, en caso de


presentarse algn error manda el mensaje correspondiente.
lError = fAfectaDocto (lCodConcepto, lSerie, lFolio, lAfecta)
If lError <> 0 Then
MensajeError lError
Else

Ver tambin

fCancelaDocumento (), fCancelaDocumento_CW (), fBuscarDocumento (), fAltaDocumento


(), fAltaDocumentoCargoAbono (), fAfectaDocto (), fSaldarDocumentoCheqPAQ (),
fBorrarAsociacion (), fBuscaDocumento ()

Pgina: 25

fSaldarDocumento_Param ()
Disponibilidad

AdminPAQ 2005.

Sintaxis

fSaldarDocumento_Param (aCodConcepto_Pagar, aSerie_Pagar, aFolio_Pagar


aCodConcepto_Pago, aSerie_Pago, aFolio_Pago, aImporte,
aIdMoneda, aFecha)
Nombre
Tipo
Uso
Descripcin
aCodConcepto_Pagar Cadena
Por valor
Cdigo del concepto del
documento a pagar.
aSerie_Pagar
Cadena
Por valor
Serie del documento a pagar.
aFolio_Pagar
Doble
Por valor
Folio del documento a pagar.
aCodConcepto_Pago Cadena
Por valor
Cdigo del concepto del
documento que paga.
aSerie_Pago
Cadena
Por valor
Serie del documento que
paga.
aFolio_Pago
Cadena
Por valor
Folio del documento que
paga.
aImporte
Doble
Por valor
Importe del pago.
aIdMoneda
Entero
Por valor
Moneda del pago.
aFecha
Cadena
Por valor
Fecha del pago.

Parmetros

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin asocia documentos y salda sus importes.

Ejemplo

El siguiente cdigo indica a la aplicacin que de salde un documento con la informacin


enviada, en caso de presentarse algn error manda el mensaje correspondiente.
lError = fSaldarDocumento_Param (lCodConcepto_Pagar, lSerie_Pagar, lFolio_Pagar
lCodConcepto_Pago, lSerie_Pago, lFolio_Pago, lImporte, lIdMoneda, lFecha)
If lError <> 0 Then
MensajeError lError
Else

Ver tambin

fBorrarAsociacion_Param (), fBuscarDocumento (), fBuscarIdDocumento (), fAltaDocumento (),


fAltaDocumentoCargoAbono (), fAfectaDocto (), fSaldarDocumento (),
fSaldarDocumentoCheqPAQ (), fBorrarAsociacion (), fBuscaDocumento ()

Pgina: 26

fBorrarAsociacion_Param ()
Disponibilidad

AdminPAQ 2005.

Sintaxis

fBorrarAsociacion (aCodConcepto_Pagar, aSerie_Pagar, aFolio_Pagar


aCodConcepto_Pago, aSerie_Pago, aFolio_Pago)

Parmetros

Nombre
aCodConcepto_Pagar

Tipo
Cadena

Uso
Por valor

aSerie_Pagar
aFolio_Pagar
aCodConcepto_Pago

Cadena
Double
Cadena

Por valor
Por valor
Por valor

aSerie_Pago

Cadena

Por valor

aFolio_Pago

Double

Por valor

Descripcin
Cdigo del concepto del
documento pagado.
Serie del documento pagado.
Folio del documento pagado.
Cdigo del concepto del
documento que pag.
Serie del documento que
pag..
Folio del documento que
pag.

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin la asociacin de documentos.

Ejemplo

El siguiente cdigo indica a la aplicacin que elimine la asociacin entre el documento


pagado y el que pag ; en caso de presentarse algn error manda el mensaje
correspondiente.
lError = fBorrarAsociacion (lCodConcepto_Pagar, lSerie_Pagar, lFolio_Pagar
lCodConcepto_Pago, lSerie_Pago, lFolio_Pago)
If lError <> 0 Then
MensajeError lError
Else

Ver tambin

fBuscarDocumento (), fAfectaDocto (), fSaldarDocumento (), fSaldarDocumentoCheqPAQ (),


fBorrarAsociacion (), fBuscaDocumento ()

Pgina: 27

fSetDatoDocumento ()
Disponibilidad

AdminPAQ 2002.

Sintaxis

fSetDatoDocumento (aCampo, aValor)

Parmetros

Nombre
aCampo
aValor

Tipo
Cadena
Cadena

Uso
Por Valor
Por Valor

Descripcin
Campo destino
Valor de escritura

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin escribe el valor indicado en el campo correspondiente en el registro activo de la


tabla de documentos.

Ejemplo

El siguiente cdigo indica a la aplicacin que busque un documento por su llave, en caso de
que lo encuentre escribe el contenido de la variable lFecha en el campo cFecha de la tabla
de documentos; en caso contrario muestra el mensaje de error correspondiente.
lError = fBuscaDocumento(lLlaveDocto )
If lError <> 0 Then
MensajeError lError
Else
lError = fSetDatoDocumento("cFecha", lFecha)
End If

Ver tambin

fInsertarDocumento (), fEditarDocumento (), fGuardaDocumento (), fBorraDocumento (),


fCancelarModificacionDocumento (), fLeeDatoDocumento (), fSiguienteFolio (),
fSetFiltroDocumento (), fCancelaFiltroDocumento (), fBuscarDocumento (),
fBuscarIdDocumento (), fAltaDocumento (), fAltaDocumentoCargoAbono (), fAfectaDocto (),
fBuscaDocumento ()

Pgina: 28

fLeeDatoDocumento ()
Disponibilidad

AdminPAQ 2002.

Sintaxis

fLeeDatoDocumento (aCampo, aValor)

Parmetros

Nombre
Tipo
Uso
Descripcin
aCampo
Cadena
Por valor
Campo destino
aValor
Cadena
Por referencia Valor de escritura
alen
Entero
Por valor
Longitud del dato de lectura
Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Retorna

aValor: Al finalizar la funcin este parmetro contiene el valor del campo especificado.
Descripcin

Esta funcin lee el valor indicado del campo correspondiente en el registro activo de la tabla
de documentos.

Ejemplo

El siguiente cdigo indica a la aplicacin que busque un documento por su llave, en caso de
que lo encuentre lee el contenido del campo cFecha de la tabla de documentos y lo asigna
a la variable lFecha; en caso contrario muestra el mensaje de error correspondiente.
lError = fBuscaDocumento(lLlaveDocto )
If lError <> 0 Then
MensajeError lError
Else
lError = fLeeDatoDocumento("cFecha", lFecha,llen)
End If

Ver tambin

fSetDatoDocumento (), fInsertarDocumento (), fEditarDocumento (), fGuardaDocumento


(),fBuscaDocumento () , fCancelarModificacionDocumento (), fSaldarDocumento_Param (),
fSetFiltroDocumento (), fCancelaFiltroDocumento (), fBuscarDocumento (),
fPosPrimerDocumento (), fPosUltimoDocumento (), fRegresaIVACargo (), fRegresaIVAPago ()

Pgina: 29

fSiguienteFolio ()
Disponibilidad

AdminPAQ 2002.

Sintaxis

fSiguienteFolio(aCodigoConcepto, aSerie, aFolio )

Parmetros

Retorna

Nombre
aCodigoConcepto

Tipo
Cadena

Uso
Por valor

aSerie
aFolio

Cadena
Doble

Por referencia
Por referencia

Descripcin
Cdigo del concepto del
documento.
Serie del documento
Folio del documento

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.
aSerie: Al finalizar la funcin este parmetro contiene el valor de la serie del documento
especificado.
aFolio: Al finalizar la funcin este parmetro contiene el siguiente folio del documento
especificado.

Descripcin

Esta funcin lee el valor indicado del campo correspondiente en el registro activo de la tabla
de documentos.

Ejemplo

El siguiente cdigo indica a la aplicacin que obtenga


lError = fSiguienteFolio(lCodigoConcepto, lSerie, lFolio )

Ver tambin

fInsertarDocumento (), fEditarDocumento (), fLeeDatoDocumento (), fSetFiltroDocumento (),


fCancelaFiltroDocumento (), fBuscarDocumento (), fBuscarIdDocumento (),
fBuscaDocumento ()

Pgina: 30

fSetFiltroDocumento ()

Disponibilidad

AdminPAQ 2002.

Sintaxis

fSetFiltroDocumento(aFechaInicio, aFechaFin, aCodigoConcepto, aCodigoCteProv)

Parmetros

Nombre
aFechaInicio
aFechaFin
aCodigoConcepto
aCodigoCteProv

Tipo
Cadena
Cadena
Cadena
Cadena

Uso
Por valor
Por valor
Por valor
Por valor

Descripcin
Fecha inicial del rango.
Fecha final del rango.
Cdigo del concepto a filtrar.
Cdigo del Cliente/Proveedor
a filtrar.

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin aplica un filtro a los documentos de acuerdo a su cdigo y al cdigo del
cliente/proveedor en un rango de fechas especificados.

Ejemplo

El siguiente cdigo indica a la aplicacin que realice un filtro de documentos para el primer
semestre del ao 2006, para el cdigo de concepto 4 y el cdigo de Cliente/Proveedor
CTE002.
lFechaInicio = 01/01/2006
lFechaFin = 06/30/2006
lCodConcepto = 4"
lCodCteProv = CTE002

Ver tambin

lError = fSetFiltroDocumento (aFechaInicio, aFechaFin, aCodigoConcepto,


aCodigoCteProv)

fSetDatoDocumento (), fLeeDatoDocumento (), fSiguienteFolio (), fCancelaFiltroDocumento (),


fBuscarDocumento (), fBuscarIdDocumento (), fPosPrimerDocumento (), fPosUltimoDocumento
(), fPosSiguienteDocumento (), fPosAnteriorDocumento (), fPosBOF (), fPosEOF (),
fBuscaDocumento ()

Pgina: 31

fCancelaFiltroDocumento ()
Disponibilidad

AdminPAQ 2002.

Sintaxis

fCancelaFiltroDocumento ()

Parmetros

No usa.

Retorna
Descripcin

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.
Esta funcin cancela el ultimo filtro activo de documentos.

Ejemplo

El siguiente cdigo cancela el ultimo filtro activo de documentos.


fCancelaFiltroDocumento ()

Ver tambin

fInsertarDocumento (), fEditarDocumento (), fGuardaDocumento (), fBorraDocumento (),


fCancelarModificacionDocumento (), fSetFiltroDocumento (), fBuscarDocumento (),
fBuscarIdDocumento (), fPosPrimerDocumento (), fPosUltimoDocumento (),
fPosSiguienteDocumento (), fPosAnteriorDocumento (), fBuscaDocumento ()

fDocumentoImpreso ()
Disponibilidad

AdminPAQ 2003.

Sintaxis

fDocumentoImpreso (aImpreso)

Parmetros

Nombre
aImpreso

Tipo
Lgico (bool)

Uso
Por referencia

Descripcin
Valor lgico.
Verdadero o Falso.

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin cambia la bandera de documento impreso.


Es necesario estar en el registro del documento que se quiere actualizar la bandera.
El siguiente cdigo indica a la aplicacin que cambie el estado de impresin del documento
a Falso.

Ejemplo

lImpreso = False
lError = fDocumentoImpreso (lImpreso)

Ver tambin

fBuscarDocumento (), fBuscarIdDocumento (), fBuscaDocumento (),fSetDatoDocumento (),


fLeeDatoDocumento ()

Pgina: 32

Bajo Nivel Bsqueda/Navegacin


fBuscarDocumento ()
Disponibilidad

AdminPAQ 2002.

Sintaxis

fBuscarDocumento (aCodConcepto, aSerie, aFolio)

Parmetros

Nombre
aCodConcepto

Tipo
Cadena

Uso
Por valor

aSerie
aFolio

Cadena
Cadena

Por valor
Por valor

Descripcin
Cdigo del concepto del
documento.
Serie del documento.
Folio del documento.

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin busca un documento por su llave, si lo encuentra se posiciona en el registro


correspondiente.
El siguiente cdigo indica a la aplicacin que busque un documento por su cdigo de
concepto, serie y folio.

Ejemplo

lError = fBuscarDocumento (aCodConcepto, aSerie, aFolio)

Ver tambin

fCancelaDocumento (), fBorraDocumento_CW (), fCancelaDocumento_CW (),


fAfectaDocto_Param (), fSaldarDocumento_Param (), fBuscarIdDocumento (),
fBuscaDocumento ()

fBuscarIdDocumento ()
Disponibilidad

AdminPAQ 2005.

Sintaxis

fBuscarIdDocumento (aIdDocumento)

Parmetros

Nombre
aIdDocumento

Tipo
Entero

Uso
Por valor

Descripcin
Identificador del documento.

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin busca un documento por su identificador.

Ejemplo

El siguiente cdigo busca un documento por su identificador.


fBuscarIdDocumento (lIdDocumento)

Ver tambin

fCancelaDocumento (), fBorraDocumento_CW (), fCancelaDocumento_CW (),


fAfectaDocto_Param (), fSaldarDocumento_Param (), fBorrarAsociacion_Param (),
fBuscarDocumento (), fAfectaDocto (), fBuscaDocumento ()

fPosPrimerDocumento ()
Disponibilidad

AdminPAQ 2002.

Sintaxis

fPosPrimerDocumento ()

Parmetros
Retorna

No usa.
Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin se ubica en el primer registro de la tabla de documentos.

Pgina: 33

Ejemplo

El siguiente cdigo indica a la aplicacin que se posicione en el primer registro de la tabla de


Documentos.
lError = fPosPrimerDocumento ()

Ver tambin

fBuscarDocumento (), fBuscarIdDocumento (), fPosPrimerDocumento (), fPosUltimoDocumento


(), fPosSiguienteDocumento (), fPosAnteriorDocumento (), fPosBOF (), fPosEOF (),
fBuscaDocumento ()

fPosUltimoDocumento ()
Disponibilidad

AdminPAQ 2002.

Sintaxis

fPosUltimoDocumento ()

Parmetros

No usa.

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin se ubica en el ltimo registro de la tabla de documentos.

Ejemplo

El siguiente cdigo indica a la aplicacin que se posicione en el ltimo registro de la tabla de


Documentos.
lError = fPosUltimoDocumento ()

Ver tambin

fBuscarDocumento (), fBuscarIdDocumento (), fPosPrimerDocumento (), fPosUltimoDocumento


(), fPosSiguienteDocumento (), fPosAnteriorDocumento (), fPosBOF (), fPosEOF ()
fBuscaDocumento ()

Pgina: 34

fPosSiguienteDocumento ()
Disponibilidad

AdminPAQ 2002.

Sintaxis

fPosSiguienteDocumento ()

Parmetros
Retorna

No usa.
Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin se ubica en el siguiente registro de la posicin actual de la tabla de documentos.

Ejemplo

El siguiente cdigo indica a la aplicacin que se posicione en el siguiente registro de la tabla


de documentos.
lError = fPosSiguienteDocumento ()

Ver tambin

fBuscarDocumento (), fBuscarIdDocumento (), fPosPrimerDocumento (), fPosUltimoDocumento


(), fPosAnteriorDocumento (), fPosBOF (), fPosEOF (), fBuscaDocumento ()

fPosAnteriorDocumento ()
Disponibilidad

AdminPAQ 2002.

Sintaxis

fPosAnteriorDocumento ()

Parmetros

No usa.

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin se ubica en el registro anterior de la posicin actual de la tabla de documentos.

Ejemplo

El siguiente cdigo indica a la aplicacin que se posicione en el registro anterior de la tabla


de documentos.
lError = fPosAnteriorDocumento ()

Ver tambin

fBuscarDocumento (), fBuscarIdDocumento (), fPosPrimerDocumento (), fPosUltimoDocumento


(), fPosSiguienteDocumento (), fPosAnteriorDocumento (), fPosBOF (), fPosEOF (),
fBuscaDocumento ()

Pgina: 35

fPosBOF ()

Disponibilidad

AdminPAQ 2002.

Sintaxis

fPosBOF ()

Parmetros
Retorna

No usa.
Valores enteros:
1 (uno) Verdadero.
0 (cero) Falso.

Descripcin

Informa si el registro activo se encuentra en el inicio de la tabla de Documentos

Ejemplo

El siguiente cdigo indica a la aplicacin que asigne a la variable lInicioTablaDocto el


resultado de la funcin fPosBOF.
lInicioTablaDocto = fPosBOF ()

Ver tambin

fPosEOF ()

fBuscarDocumento (), fBuscarIdDocumento (), fPosPrimerDocumento (), fPosUltimoDocumento


(), fPosSiguienteDocumento (), fPosAnteriorDocumento (), fPosBOF (), fPosEOF (),
fBuscaDocumento ()

Disponibilidad

AdminPAQ 2002.

Sintaxis

fPosEOF ()

Parmetros
Retorna

No usa.
Valores enteros:
1 (uno) Verdadero.
0 (cero) Falso.

Descripcin

Informa si el registro activo se encuentra en el fin de la tabla de Documentos

Ejemplo

El siguiente cdigo indica a la aplicacin que asigne a la variable lFinTablaDocto el resultado


de la funcin fPosEOF.
lFinTablaDocto = fPosEOF ()

Ver tambin

fBuscarDocumento (), fBuscarIdDocumento (), fPosPrimerDocumento (), fPosUltimoDocumento


(), fPosSiguienteDocumento (), fPosAnteriorDocumento (), fPosBOF (), fPosEOF (),
fBuscaDocumento ()

Pgina: 36

Alto Nivel Lectura/Escritura


fAltaDocumento ()
Disponibilidad

AdminPAQ 2002.

Sintaxis

fAltaDocumento (aIdDocumento, aDocumento )

Parmetros

Retorna

Descripcin
Ejemplo

Nombre
aIdDocumento
aDocumento

Tipo
Entero largo
tDocumento

Uso
Por referencia
Por valor

Descripcin
Identificador del documento.
Tipo de dato abstracto.

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.
aIdDocumento: Al finalizar la funcin este parmetro contiene el identificador del nuevo
documento.
Esta funcin da de alta documentos de cargo o abono.
El siguiente cdigo indica a la aplicacin que de alta un documento, en caso de presentarse
algn error manda el mensaje correspondiente.
lError = fAltaDocumento (lIdDocto, lDocumento)
If lError <> 0 Then
MensajeError lError
Else

Ver tambin

fInsertarDocumento (), fEditarDocumento (), fGuardaDocumento (), fBorraDocumento (),


fCancelarModificacionDocumento (), fBuscarDocumento (), fBuscarIdDocumento (),
fAltaDocumentoCargoAbono (), fAfectaDocto (), fBuscaDocumento ()

Pgina: 37

fAltaDocumentoCargoAbono ()
Disponibilidad

AdminPAQ 2002.

Sintaxis

fAltaDocumentoCargoAbono (aDocumento)

Parmetros

Nombre
aDocumento

Tipo
tDocumento

Uso
Por valor

Descripcin
Tipo de dato abstracto.

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin da de alta documentos de cargo o abono.

Ejemplo

El siguiente cdigo indica a la aplicacin que de alta un documento de cargo/abono, en


caso de presentarse algn error manda el mensaje correspondiente.
lError = fAltaDocumentoCargoAbono (lDocumento)
If lError <> 0 Then
MensajeError lError
Else

Ver tambin

fInsertarDocumento (), fEditarDocumento (), fGuardaDocumento (), fAfectaDocto_Param (),


fSaldarDocumento_Param (), fBuscarDocumento (), fBuscarIdDocumento (), fAltaDocumento
(), fAfectaDocto (), fSaldarDocumento (), fSaldarDocumentoCheqPAQ (), fBorrarAsociacion (),
fRegresaIVACargo (), fRegresaIVAPago (), fBuscaDocumento ()

Pgina: 38

fAfectaDocto ()
Disponibilidad

AdminPAQ 2002.

Sintaxis

fAfectaDocto (aLlaveDocto, aAfecta)

Parmetros

Nombre
aLlaveDocto
aAfecta

Tipo
tLlaveDocto
Lgico (Bool)

Uso
Por valor
Por valor

Descripcin
Tipo de dato abstracto.
Verdadero o falso. Afectar o
desafectar.

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin utiliza aLlaveDocto como llave del documento y aAfecta para afectar o
desafectarlo.

Ejemplo

El siguiente cdigo indica a la aplicacin que de afecte un documento, en caso de


presentarse algn error manda el mensaje correspondiente.
lError = fAfectaDocto (lDocumento, True)
If lError <> 0 Then
MensajeError lError
Else

Ver tambin

fCancelaDocumento (), fBorraDocumento_CW (), fCancelaDocumento_CW (),


fAfectaDocto_Param (), fSaldarDocumento_Param (), fBorrarAsociacion_Param (),
fBuscarDocumento (), fBuscarIdDocumento (), fAltaDocumento (),
fAltaDocumentoCargoAbono (), fAfectaDocto (), fSaldarDocumento (),
fSaldarDocumentoCheqPAQ (), fBorrarAsociacion (), fBuscaDocumento ()

Pgina: 39

fSaldarDocumento ()
Disponibilidad

AdminPAQ 2002.

Sintaxis

fSaldarDocumento (aDoctoaPagar, aDoctoPago, aImporte, aIdMoneda, aFecha)

Parmetros

Nombre
aDoctoaPagar
aDoctoPago
aImporte
aIdMoneda
aFecha

Tipo
tLlaveDocto
tLlaveDocto
Doble
Entero
Cadena

Uso
Por valor
Por valor
Por valor
Por valor
Por valor

Descripcin
Tipo de dato abstracto.
Tipo de dato abstracto.
Importe del pago.
Moneda del pago.
Fecha del pago.

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin asocia documentos y salda sus importes.

Ejemplo

El siguiente cdigo indica a la aplicacin que de salde un documento con la informacin


enviada, en caso de presentarse algn error manda el mensaje correspondiente.
lError = fSaldarDocumento (lDoctoaPagar, lDoctoPago, lImporte, lIdMoneda, lFecha)
If lError <> 0 Then
MensajeError lError
Else

Ver tambin

fInsertarDocumento (), fEditarDocumento (), fGuardaDocumento (), fBorraDocumento (),


fCancelarModificacionDocumento (),fCancelaDocumento (), fBorraDocumento_CW (),
fCancelaDocumento_CW (), fAfectaDocto_Param (), fSaldarDocumento_Param (),
fBorrarAsociacion_Param (), fSetDatoDocumento (), fLeeDatoDocumento (), fSiguienteFolio (),
fSetFiltroDocumento (), fCancelaFiltroDocumento (), fDocumentoImpreso (),
fBuscarDocumento (), fBuscarIdDocumento (), fPosPrimerDocumento (), fPosUltimoDocumento
(), fPosSiguienteDocumento (), fPosAnteriorDocumento (), fPosBOF (), fPosEOF (),
fAltaDocumento (), fAltaDocumentoCargoAbono (), fAfectaDocto (), fSaldarDocumento (),
fSaldarDocumentoCheqPAQ (), fBorrarAsociacion (), fRegresaIVACargo (), fRegresaIVAPago
(), fBuscaDocumento ()

Pgina: 40

fSaldarDocumentoCheqPAQ ()
Disponibilidad

AdminPAQ 2004.

Sintaxis

fSaldarDocumentoCheqPAQ (aDoctoaPagar, aDoctoPago, aImporte, aIdMoneda, aFecha,


aTipoCambioCheqPAQ)
Nombre
Tipo
Uso
Descripcin
aDoctoaPagar
tLlaveDocto
Por valor
Tipo de dato abstracto.
aDoctoPago
tLlaveDocto
Por valor
Tipo de dato abstracto.
aImporte
Doble
Por valor
Importe del pago.
aIdMoneda
Entero
Por valor
Moneda del pago.
aFecha
Cadena
Por valor
Fecha del pago.
aTipoCambioCheqPAQ Doble
Por valor
Tipo de cambio de la moneda
extranjera que interviene en el
cargo-abono del da de pago.

Parmetros

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin asocia documentos y salda sus importes.

Ejemplo

El siguiente cdigo indica a la aplicacin que de salde un documento con el documento


correspondiente en CheqPAQ usando el tipo de cambio del da de pago; en caso de
presentarse algn error manda el mensaje correspondiente.
lError = fSaldarDocumentoCheqPAQ (lDoctoaPagar, lDoctoPago, lImporte, lIdMoneda, lFecha)
If lError <> 0 Then
MensajeError lError
Else

Ver tambin

fInsertarDocumento (), fEditarDocumento (), fGuardaDocumento (), fBorraDocumento (),


fCancelarModificacionDocumento (),fCancelaDocumento (), fBorraDocumento_CW (),
fCancelaDocumento_CW (), fAfectaDocto_Param (), fSaldarDocumento_Param (),
fBorrarAsociacion_Param (), fSetDatoDocumento (), fLeeDatoDocumento (), fSiguienteFolio (),
fSetFiltroDocumento (), fCancelaFiltroDocumento (), fDocumentoImpreso (),
fBuscarDocumento (), fBuscarIdDocumento (), fPosPrimerDocumento (), fPosUltimoDocumento
(), fPosSiguienteDocumento (), fPosAnteriorDocumento (), fPosBOF (), fPosEOF (),
fAltaDocumento (), fAltaDocumentoCargoAbono (), fAfectaDocto (), fSaldarDocumento (),
fSaldarDocumentoCheqPAQ (), fBorrarAsociacion (), fRegresaIVACargo (), fRegresaIVAPago
(), fBuscaDocumento ()

Pgina: 41

fBorrarAsociacion ()
Disponibilidad

AdminPAQ 2002.

Sintaxis

fBorrarAsociacion (aDoctoaPagar, aDoctoPago)

Parmetros

Nombre
aDoctoaPagar
aDoctoPago

Tipo
tLlaveDocto
tLlaveDocto

Uso
Por valor
Por valor

Descripcin
Tipo de dato abstracto.
Tipo de dato abstracto.

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin la asociacin de documentos.

Ejemplo

El siguiente cdigo indica a la aplicacin que elimine la asociacin entre lDoctoaPagar y


lDoctoPago ; en caso de presentarse algn error manda el mensaje correspondiente.
lError = fBorrarAsociacion (lDoctoaPagar, lDoctoPago)
If lError <> 0 Then
MensajeError lError
Else

Ver tambin

fInsertarDocumento (), fEditarDocumento (), fGuardaDocumento (), fBorraDocumento (),


fCancelarModificacionDocumento (),fCancelaDocumento (), fBorraDocumento_CW (),
fCancelaDocumento_CW (), fAfectaDocto_Param (), fSaldarDocumento_Param (),
fBorrarAsociacion_Param (), fSetDatoDocumento (), fLeeDatoDocumento (), fSiguienteFolio (),
fSetFiltroDocumento (), fCancelaFiltroDocumento (), fDocumentoImpreso (),
fBuscarDocumento (), fBuscarIdDocumento (), fPosPrimerDocumento (), fPosUltimoDocumento
(), fPosSiguienteDocumento (), fPosAnteriorDocumento (), fPosBOF (), fPosEOF (),
fAltaDocumento (), fAltaDocumentoCargoAbono (), fAfectaDocto (), fSaldarDocumento (),
fSaldarDocumentoCheqPAQ (), fBorrarAsociacion (), fRegresaIVACargo (), fRegresaIVAPago
(), fBuscaDocumento ()

Pgina: 42

fRegresaIVACargo ()
Disponibilidad

AdminPAQ 2002.

Sintaxis

fRegresaIVACargo (aLlaveDocto, aNetoTasa15, aNetoTasa10, aNetoTasaCero,


aNetoTasaExcenta, aNetoOtrasTasas, aIVATasa15, aIVATasa10,
aIVAOtrasTasas)
Nombre
Tipo
Uso
Descripcin
aLlaveDocto
tLlaveDocto
Por valor
Tipo de dato abstracto.
aNetoTasa15
Doble
Por referencia Base de la tasa de 15%
aNetoTasa10
Doble
Por referencia Base de la tasa de 10%
aNetoTasaCero
Doble
Por referencia Base de la tasa cero
aNetoTasaExcenta
Doble
Por referencia Base de productos exentos
aNetoOtrasTasas
Doble
Por referencia Base de otras tasas
aIVATasa15
Doble
Por referencia IVA de la tasa de 15%
aIVATasa10
Doble
Por referencia IVA de la tasa de 10%
aIVAOtrasTasas
Doble
Por referencia IVA de otras tasas

Parmetros

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin regresa el desglose de IVA de un documento.

Ejemplo

El siguiente cdigo indica a la aplicacin que obtenga el desglose del IVA del documento
especificado en el parmetro lLlaveDocto y que regrese los valores correspondientes a los
parmetros por valor especificados.
lError = fRegresaIVACargo (lLlaveDocto, lNetoTasa15, lNetoTasa10, lNetoTasaCero,
lNetoTasaExcenta, lNetoOtrasTasas, lIVATasa15, lIVATasa10, lIVAOtrasTasas)

Ver tambin

fInsertarDocumento (), fEditarDocumento (), fGuardaDocumento (), fBorraDocumento (),


fCancelarModificacionDocumento (),fCancelaDocumento (), fBorraDocumento_CW (),
fCancelaDocumento_CW (), fAfectaDocto_Param (), fSaldarDocumento_Param (),
fBorrarAsociacion_Param (), fSetDatoDocumento (), fLeeDatoDocumento (), fSiguienteFolio (),
fSetFiltroDocumento (), fCancelaFiltroDocumento (), fDocumentoImpreso (),
fBuscarDocumento (), fBuscarIdDocumento (), fPosPrimerDocumento (), fPosUltimoDocumento
(), fPosSiguienteDocumento (), fPosAnteriorDocumento (), fPosBOF (), fPosEOF (),
fAltaDocumento (), fAltaDocumentoCargoAbono (), fAfectaDocto (), fSaldarDocumento (),
fSaldarDocumentoCheqPAQ (), fBorrarAsociacion (), fRegresaIVACargo (), fRegresaIVAPago
(), fBuscaDocumento ()

Pgina: 43

fGetTamSelloDigitalYCadena ()
Disponibilidad

AdminPAQ 2007. Versin 4.1.4

Sintaxis

fGetTamSelloDigitalYCadena (atPtrPassword, aEspSelloDig, aEspCadOrig)

Parmetros

Nombre
atPtrPassword
aEspSelloDig
aEspCadOrig

Tipo
Cadena
Entero
Entero

Uso
Por referencia
Por referencia
Por referencia

Descripcin
Contrasea del certificado.
Tamao del Sello digital.
Tamao de la Cadena original.

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Con esta funcin se obtiene el tamao de la cadena original y el sello digital, mismas que se
guardarn en las variables aEspSelloDig y aEspCadOrig.
En el siguiente cdigo se pasa como parmetro la contrasea del certificado almacenada en
la variable lPassword e indica a la aplicacin que obtenga el tamao del sello digital y cadena
original del documento, recibindolos en las variables lEspSello y lEspSello.

Ejemplo

lError = fGetTamSelloDigitalYCadena (lPassword, lEspSello, lEspCadOrig)

Ver tambin

fGetSelloDigitalYCadena()

Pgina: 44

fGetSelloDigitalYCadena ()
Disponibilidad

AdminPAQ 2007. Versin 4.1.4

Sintaxis

fGetSelloDigitalYCadena (char *atPtrPassword, char* atPtrSelloDigital, char*


atPtrCadenaOriginal)

Parmetros

Nombre
atPtrPassword
atPtrSelloDigital
atPtrCadenaOriginal

Tipo
Cadena
Cadena
Cadena

Uso
Por referencia
Por referencia
Por referencia

Descripcin
Contrasea del certificado.
Sello digital.
Cadena original.

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Con esta funcin se obtiene el sello digital y la cadena original de un CFD.

Ejemplo

En el siguiente cdigo se pasa como parmetro la contrasea del certificado almacenada en


la variable lPassword e indica a la aplicacin que obtenga el tamao del sello digital y cadena
original del documento, recibindolos en las variables lEspSello y lEspSello.
lError = fGetSelloDigitalYCadena (lPassword, lEspSello, lEspCadOrig)

Ver tambin

fGetTamSelloDigitalYCadena()

Pgina: 45

fInicializaLicenseInfo()
Disponibilidad

AdminPAQ 2011. Versin 6.2.1

Sintaxis

fInicializaLicenseInfo (aSistema)

Parmetros

Nombre
aSistema

Tipo
Unsigned char

Uso
Por valor

Descripcin
Sistema:
0 = AdminPAQ
1 = CONTPAQ i Factura
Electrnica

Retorna

Valores enteros:
kSIN_ERRORES =
0 (cero) que significa que se pudo conectar y obtener informacin del
Servidor de Licencias, aunque la verificacin del nmero de usuarios se hace hasta el uso
de la funcin fEmitirDocumento.
!kSIN_ERRORES = -1 que significa que hubo un error al intentar obtener informacin del
Servidor de Licencias del sistema especificado.

Descripcin

Esta funcin verifica que el sistema est activado y tenga una licencia vlida.

Ejemplo

En el siguiente cdigo pasa como parmetro un 0 indicando que se trata del sistema
AdminPAQ para saber si el sistema est activado.
lError = fInicializaLicenseInfo (0)

Ver tambin

fEmitirDocumento()

Pgina: 46

fEmitirDocumento ()
Disponibilidad

AdminPAQ 2011. Versin 6.2.1

Sintaxis

fEmitirDocumento (aCodConcepto, aSerie, aFolio, aPassword, aArchivoAdicional)

Parmetros

Retorna

Descripcin

Nombre
aCodConcepto
aSerie
aFolio
aPassword

Tipo
Cadena
Cadena
Doble
Cadena

Uso
Por referencia
Por referencia
Por valor
Por referencia

aArchivoAdicional

Cadena

Por referencia

Descripcin
Cdigo del concepto
Serie del documento
Folio del documento
Contrasea del certificado de
sello digital
Nombre del archivo con el
complemento, este archivo ya
debe existir en la carpeta
Adicionales dentro de la
empresa.

Valores enteros:
kSIN_ERRORES =
0 (cero) si no hubo error.
!kSIN_ERRORES = -1
-1 que significa que hubo un error con la Licencia (la licencia
es para menos de 10 usuarios, es temporal, de evaluacin, no est activada, etc.)
!kSIN_ERRORES = Un nmero de error positivo del que se puede obtener la descripcin
con la funcin fError.
Para poder utilizar la funcin fEmitirDocumento, se deber ejecutar primero la funcin
fInicializaLicenseInfo.
La funcin fEmitirDocumento recibe como parmetro el nombre de un archivo el cual
contiene un complemento que se insertar al CFD/CFDI al emitirse.
Esta funcin requeire una liciencia monousuario. Si cuentas con un licenciamiento anual
adems se requeire que la licencia sea multiempresa.

Ejemplo

Esta funcin solo soporta los divisas, EstadoDeCuentaBancario, EstadoDeCuentaCombustible,


PrestadoresDeServiciosDeCFD y la combinacion de estos.
La siguiente funcin emite un documento, pasando como parmetros el cdigo = 1001,
serie=CFDI, folio = 154 del concepto, contrasea del certificado a0123456789, y nombre del

archivo complemento divisas.xml.

lError = fEmitirDocumento("1001", "CFDI", 154, "a0123456789", "divisas.xml")

Ver tambin

fInicializaLicenseInfo()

Pgina: 47

fDocumentoUUID()
Disponibilidad

AdminPAQ 2011. Versin 6.2.3

Sintaxis

fDocumentoUUID (aCodigoConcepto, aSerie, aFolio, atPtrCFDIUUID)

Parmetros

Nombre
aCodConcepto
aSerie
aFolio
atPtrCFDIUUID

Tipo
Cadena
Cadena
Doble
Cadena

Uso
Por referencia
Por referencia
Por valor
Por referencia

Descripcin
Cdigo del concepto
Serie del documento
Folio del documento
Cadena para colocar el valor
de UUID

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin despliega el UUID de un documento.

Ejemplo

En el siguiente cdigo se pasan el cdigo, serie y folio del concepto para recibir el UUID en la
variable lUUID.
lError = fDocumentoUUID (lConcepto, lSerie, lFolio, lUUID)

fGetSerieCertificado ()
Disponibilidad

AdminPAQ 2007. Versin 4.3.1

Sintaxis

fGetSerieCertificado (atPtrPassword, aPtrSerieCertificado)

Parmetros

Nombre
atPtrPassword
aPtrSerieCertificado

Tipo
Cadena
Cadena

Uso
Por referencia
Por referencia

Descripcin
Contrasea del certificado
Serie del certificado

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin regresa la serie de un Certificado utilizado por una factura electrnica.

fActivarPrecioCompra ()
Disponibilidad

AdminPAQ 2007. Versin 4.3.2

Sintaxis

fActivarPrecioCompra (aActivar)

Parmetros

Nombre
aActivar

Tipo
Entero

Uso
Por valor

Descripcin
0 = No busca el precio
1 = Valor asumido (busca el
precio)

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin determina si al momento de registrar una compra va SDK se ejecutar la funcin
que busca el ltimo precio de compra registrado en caso de que el precio sea igual a cero.

Pgina: 48

fDocumentoDevuelto ()
Disponibilidad

AdminPAQ 2007. Versin 4.3.2

Sintaxis

fDocumentoDevuelto (aDevuelto)

Parmetros

Nombre
aDevuelto

Tipo
Entero

Uso
Por valor

Descripcin
0 = No devuelto
1 = Devuelto

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin ajusta el estado de un documento en devuelto o no devuelto.

fEntregEnDiscoXML ()
Disponibilidad

AdminPAQ 2011. Versin 7.0.0

Sintaxis

fEntregEnDiscoXML (aCodConcepto, aSerie, aFolio, aFormato, aFormatoAmig)

Parmetros

Retorna

Nombre
aCodConcepto
aSerie
aFolio
aFormato

Tipo
Cadena
Cadena
Doble
Entero

Uso
Por referencia
Por referencia
Por valor
Por valor

Descripcin
Cdigo del concepto
Serie del documento
Folio del documento
Formato de entrega (0 = XML, 1
= PDF)
Nota: Al seleccionar la opcin
de entrega 1= PDF, por
disposicin fiscal tambin se
generar el XML.
Plantilla de impresin

aFormatoAmig
Cadena
Por referencia
Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin entrega el XML en un archivo.

Ejemplo

En el siguiente ejemplo, se entrega el XML del concepto 4 (factura), Serie B1, folio 45, en
formato PDF, en la ruta C:\Compacw\Empresas\Reportes\AdminPAQ\Plantilla_Factura_cfdi_1.html
lError = fEntregEnDiscoXML (4, B1, 45, 1,
C:\Compacw\Empresas\Reportes\AdminPAQ\Plantilla_Factura_cfdi_1.html)

Pgina: 49

fObtieneDatosCFDI ()
Disponibilidad

AdminPAQ 2012. Versin 7.2.0

Sintaxis

fObtieneDatosCFDI (atPtrPassword)

Parmetros

Nombre
atPtrPassword

Tipo
Cadena

Uso
Por referencia

Descripcin
Contrasea del certificado

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

La funcin fObtieneDatosCFDI obtiene los datos del CFDI del documento previamente definido
con la funcin fBuscarDocumento. Esta funcin almacena en variables globales los datos del
CFDI dentro del mismo SDK para posteriormente ser ledos con la funcin fLeeDatoCFDI.
El siguiente ejemplo obtiene los datos del CFDI previamente ubicado con la funcin
fBuscarDocumento pasando como parmetro la contrasea del certificado en la variable
lPassword.

Ejemplo

lError = fObtieneDatosCFDI(lPassword)

Ver tambin

fBuscarDocumento(), fLeeDatoCFDI()

Pgina: 50

fLeeDatoCFDI ()
Disponibilidad

AdminPAQ 2012. Versin 7.2.0

Sintaxis

fLeeDatoCFDI (aValor, aDato)

Parmetros

Nombre
aValor

Tipo
Cadena

Uso
Por referencia

aDato

Entero

Por valor

Descripcin
Cadena donde se regresar el
dato requerido
1 = Serie del Certificado del
Emisor
2 = Folio Fiscal (UUID)
3 = Nmero de Serie del
Certificado del SAT
4 = Fecha y Hora de
Certificacin
5 = Sello Digital del CFDI
6 = Sello SAT
7 = Cadena Original del
Complemento de Certificacin
Digital del SAT
8 = Mtodo de Pago
9 = Lugar de expedicin
10 = Rgimen Fiscal
11 = Folio Fiscal de origen*
12 = Serie del Folio Fiscal de
origen*
13 = Fecha del Folio Fiscal de
origen*
14 = Monto del Folio Fiscal de
origen*
* Para documentacin de
Deuda o Pago en
Parcialidades

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

La funcin fLeeDatoCFDI lee los datos previamente accedidos con la funcin


fObtieneDatosCFDI.
La funcin recibe como parmetros, la cadena donde copiar el dato requerido y un entero
donde se indica qu dato se desea y regresar un nmero de error en caso de existir alguno.

Ejemplo

El siguiente ejemplo el UUID de un documento y lo almacena en la variable lUUID.


lError = fLeeDatoCFDI (lUUID, 2)

Ver tambin

fBuscarDocumento(), fObtieneDatosCFDI()

Pgina: 51

Alto Nivel Bsqueda/Navegacin


fBuscaDocumento ()
Disponibilidad

AdminPAQ 2002.

Sintaxis

fBuscaDocumento (aLlaveDocto)

Parmetros

Nombre
aLlaveDocto

Tipo
tLlaveDocto

Uso
Por valor

Descripcin
Tipo de dato abstracto.

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin busca un documento por su llave, si lo encuentra se posiciona en el registro


correspondiente.
El siguiente cdigo indica a la aplicacin que busque el documento cuya llave es el
contenido del parmetro lLlaveDocto.

Ejemplo

lError = fBuscaDocumento (lLlaveDocto )

Ver tambin

fInsertarDocumento (), fEditarDocumento (), fGuardaDocumento (), fBorraDocumento (),


fCancelarModificacionDocumento (),fCancelaDocumento (), fBorraDocumento_CW (),
fCancelaDocumento_CW (), fAfectaDocto_Param (), fSaldarDocumento_Param (),
fBorrarAsociacion_Param (), fSetDatoDocumento (), fLeeDatoDocumento (), fSiguienteFolio (),
fSetFiltroDocumento (), fCancelaFiltroDocumento (), fDocumentoImpreso (),
fBuscarDocumento (), fBuscarIdDocumento (), fPosPrimerDocumento (), fPosUltimoDocumento
(), fPosSiguienteDocumento (), fPosAnteriorDocumento (), fPosBOF (), fPosEOF (),
fAltaDocumento (), fAltaDocumentoCargoAbono (), fAfectaDocto (), fSaldarDocumento (),
fSaldarDocumentoCheqPAQ (), fBorrarAsociacion (), fRegresaIVACargo (), fRegresaIVAPago
(), fBuscaDocumento ()

Pgina: 52

Funciones de Movimientos
Bajo Nivel Lectura/Escritura
fInsertarMovimiento ()
Disponibilidad

AdminPAQ 2002.

Sintaxis

fInsertarMovimiento ()

Parmetros

No usa.

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error
Adiciona un nuevo registro en la tabla de Movimientos en modo de insercin.

Descripcin
Ejemplo

El siguiente cdigo indica a la aplicacin que inserte un nuevo registro en la tabla de


Movimientos.
fInsertarMovimiento ()

Ver tambin

fInsertarDocumento(),fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(), fCancelarModificacionDocumento(),

fEditarMovimiento ()
Disponibilidad

AdminPAQ 2002.

Sintaxis

fEditarMovimiento ()

Parmetros

No usa.

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error

Descripcin

Activa el modo de Edicin de un registro en la tabla de Movimientos.

Ejemplo

El siguiente cdigo busca un movimiento por su Identificador, si lo encuentra lo activa en


modo edicin, en caso de no encontrarlo enva el mensaje de error correspondiente
lError = fBuscarIdMovimiento (lIdMovto)
If lError <> 0 Then
MensajeError lError
Else
fEditarMovimiento ()
End If

Ver tambin

fInsertarDocumento(),fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(),fCancelarModificacionDocumento(),

Pgina: 53

fGuardaMovimiento ()
Disponibilidad

AdminPAQ 2002.

Sintaxis

fGuardaMovimiento ()

Parmetros

No usa.

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Guarda los cambios realizados a un movimiento.

Ejemplo

El siguiente cdigo indica a la aplicacin que guarde cierto registro en la tabla de


Documentos. Esta funcin se llama despus de que se utiliza la funcin fInsertarMovimiento() o
fEditarMovimiento() y se graban los valores en los campos correspondientes.
fGuardaMovimiento ()

Ver tambin

fInsertarDocumento(),fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(), fCancelarModificacionDocumento(),

fCancelaCambiosMovimiento ()
Disponibilidad

AdminPAQ 2002.

Sintaxis

fCancelaCambiosMovimiento ()

Parmetros

No usa.

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin cancela las modificaciones al registro actual de movimientos. El registro debe
estar en modo de edicin o insercin.

Ejemplo

El siguiente cdigo indica a la aplicacin que cancele la modificacin a un registro de


Movimientos que estaba en modo de insercin o edicin.
fCancelaCambiosMovimiento ()

Ver tambin

fInsertarDocumento(),fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(), fCancelarModificacionDocumento(),

Pgina: 54

fAltaMovimientoCaracteristicas_Param ()
Disponibilidad

AdminPAQ 2003.

Sintaxis

fAltaMovimientoCaracteristicas_Param (aIdMovimiento, aIdMovtoCaracteristicas, aUnidades,


aValorCaracteristica1, aValorCaracteristica2,
aValorCaracteristica3)
Nombre
Tipo
Uso
Descripcin
aIdMovimiento
Cadena
Por valor
Identificador del movimiento.
aIdMovtoCaracteristicas
Cadena
Por valor
Identificador del movimiento
con caractersticas.
aUnidades
Cadena
Por valor
Unidades.
aValorCaracteristica1
Cadena
Por valor
Valor de la caracterstica 1.
aValorCaracteristica2
Cadena
Por valor
Valor de la caracterstica 2.
aValorCaracteristica3
Cadena
Por valor
Valor de la caracterstica 3.

Parmetros

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin inserta un movimiento con caractersticas.

Ejemplo

El siguiente cdigo indica a la aplicacin que inserte un movimiento con caractersticas en la


base de datos, en caso de que ocurra un error muestra el mensaje de error correspondiente.
lError = fAltaMovimientoCaracteristicas_Param ("lIdMovimiento, lIdMovtoCaracteristicas,
lUnidades, lValorCaracteristica1, lValorCaracteristica2, lValorCaracteristica3)
If lError <> 0 Then
MensajeError lError
Else

Ver tambin

fInsertarDocumento(),fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(), fCancelarModificacionDocumento(),

Pgina: 55

fAltaMovtoCaracteristicasUnidades_Param ()
Disponibilidad

AdminPAQ 2005.

Sintaxis

fAltaMovtoCaracteristicasUnidades_Param (aIdMovimiento, aIdMovtoCaracteristicas,


aUnidad, aUnidades, aUnidadesNC,
aValorCaracteristica1, aValorCaracteristica2,
aValorCaracteristica3)

Parmetros

Nombre
Tipo
aIdMovimiento
Cadena
aIdMovtoCaracteristicas Cadena

Uso
Por valor
Por valor

aUnidad

Cadena

Por valor

aUnidades

Cadena

Por valor

aUnidadesNC

Cadena

Por valor

aValorCaracteristica1
aValorCaracteristica2
aValorCaracteristica3

Cadena
Cadena
Cadena

Por valor
Por valor
Por valor

Descripcin
Identificador del movimiento.
Identificador del movimiento
con caractersticas.
Abreviatura de la unidad de
compra venta
Las unidades del movimiento
de caractersticas.
Abreviatura de la unidad de
compra venta no
convertible.
Valor de la caracterstica 1.
Valor de la caracterstica 2.
Valor de la caracterstica 3.

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin da de alta movimiento de caractersticas con unidades de compra venta.

Ejemplo

El siguiente da de alta movimiento de caractersticas con unidades de compra venta.


fAltaMovtoCaracteristicasUnidades_Param (lIdDocumento, lIdMovimiento, lMovimiento)

Ver tambin

fInsertarDocumento(),fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(),fCancelarModificacionDocumento(),

Pgina: 56

fAltaMovimientoSeriesCapas_Param ()
Disponibilidad

AdminPAQ 2003.

Sintaxis

fAltaMovimientoSeriesCapas _Param (aIdMovimiento, aUnidades, aTipoCambio, aSeries,


aPedimento, aAgencia, aFechaPedimento,
aNumeroLote, aFechaFabricacion, aFechaCaducidad)

Parmetros

Nombre
aIdMovimiento
aUnidades
aTipoCambio
aSeries
aPedimento
aAgencia
aFechaPedimento
aNumeroLote
aFechaFabricacion
aFechaCaducidad

Tipo
Cadena
Cadena
Cadena
Cadena
Cadena
Cadena
Cadena
Cadena
Cadena
Cadena

Uso
Por valor
Por valor
Por valor
Por valor
Por valor
Por valor
Por valor
Por valor
Por valor
Por valor

Descripcin
Identificador del movimiento.
Unidad de peso y medida.
Tipo de cambio.
Series.
Referencia del pedimento.
Referencia de la agencia.
Fecha del pedimento.
Nmero de lote.
Fecha de fabricacin.
Fecha de caducidad.

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin agrega el movimiento de numero de serie, lote y/o pedimento asociados un
movimiento cuyo producto maneje cualquiera de estas posibles configuraciones.

Ejemplo

El siguiente cdigo da de alta un movimiento para un producto con numero de serie, lote y/o
pedimento asociado.
lError = fAltaMovimientoSeriesCapas _Param (lIdMovimiento, lUnidades, lTipoCambio, lSeries,
lPedimento, lAgencia, lFechaPedimento, lNumeroLote, lFechaFabricacion,
lFechaCaducidad)

Ver tambin

fInsertarDocumento(),fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(),fCancelarModificacionDocumento(),

Pgina: 57

fCalculaMovtoSerieCapa ()
Disponibilidad

AdminPAQ 2004.

Sintaxis

fCalculaMovtoSerieCapa (aIdMovimiento)

Parmetros

Nombre
aIdMovimiento

Tipo
Entero largo

Uso
Por valor

Descripcin
Identificador del movimiento
a recalcular.

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin recalcula el movimiento cuando este pertenece a un producto con series, lotes o
pedimentos.

Ejemplo

El siguiente cdigo recalcula el movimiento cuando este pertenece a un producto con series,
lotes o pedimentos.
lError = fCalculaMovtoSerieCapa (lIdMovimiento)

Ver tambin

fInsertarDocumento(),fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(),fCancelarModificacionDocumento(),

Pgina: 58

fObtieneUnidadesPendientes ()
Disponibilidad

AdminPAQ 2004.

Sintaxis

fObtieneUnidadesPendientes (aConceptoDocto, aCodigoProducto, aCodigoAlmacen,


aUnidades)
Nombre
Tipo
Uso
Descripcin
aConceptoDocto
Cadena
Por valor
Cdigo del concepto del
documento a buscar.
aCodigoProducto
Cadena
Por valor
Cdigo del producto a buscar
su unidades pendientes.
aCodigoAlmacen
Cadena
Por valor
Cdigo del almacn a buscar
si es igual a 0 (cero) busca en
todos los almacenes.
aUnidades
Cadena
Por referencia Valor de retorno con las
unidades pendientes.

Parmetros

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.
aUnidades: Al finalizar la funcin este parmetro contiene las unidades pendientes.

Descripcin

Esta funcin obtiene la cantidad de unidades pendientes de cierto concepto de documento


para un almacn/almacenes de un determinado producto en toda la historia del sistema.

Ejemplo

El siguiente cdigo indica a la aplicacin que obtenga las unidades pendientes para el
producto especificado en lCodigoProducto del almacen lCodigoAlmacen, del documento
lConceptoDocto.
lError = fObtieneUnidadesPendientes (lConceptoDocto, lCodigoProducto, lCodigoAlmacen,
lUnidades)

Ver tambin

fInsertarDocumento(),fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(),fCancelarModificacionDocumento(),

Pgina: 59

fObtieneUnidadesPendientesCarac ()
Disponibilidad

AdminPAQ 2004.

Sintaxis

fObtieneUnidadesPendientesCarac (aConceptoDocto, aCodigoProducto, aCodigoAlmacen,


aValorCaracteristica1, aValorCaracteristica2,
aValorCaracteristica3, aUnidades)
Nombre
Tipo
Uso
Descripcin
aConceptoDocto
Cadena
Por valor
Cdigo del concepto del
documento a buscar.
aCodigoProducto
Cadena
Por valor
Cdigo del producto a buscar
su unidades pendientes.
aCodigoAlmacen
Cadena
Por valor
Cdigo del almacn a buscar
si es igual a 0 (cero) busca en
todos los almacenes.
aValorCaracteristica1
Cadena
Por valor
Valor caracterstica 1
aValorCaracteristica2
Cadena
Por valor
Valor caracterstica 2
aValorCaracteristica3
Cadena
Por valor
Valor caracterstica 3
aUnidades
Cadena
Por referencia Valor de retorno con las
unidades pendientes.

Parmetros

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.
aUnidades: Al finalizar la funcin este parmetro contiene las unidades pendientes.

Descripcin

Esta funcin obtiene la cantidad de unidades pendientes de cierto concepto de documento


para un almacn/almacenes de un determinado producto con caracteristicas en toda la
historia del sistema.

Ejemplo

El siguiente cdigo indica a la aplicacin que obtenga las unidades pendientes para el
producto especificado en lCodigoProducto del almacen lCodigoAlmacen, del documento
lConceptoDocto.
lError = fObtieneUnidadesPendientes (lConceptoDocto, lCodigoProducto, lCodigoAlmacen,

lValorCaracteristica1, lValorCaracteristica2, lValorCaracteristica3,


lUnidades)

Ver tambin

fInsertarDocumento(),fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(),fCancelarModificacionDocumento(),

Pgina: 60

fModificaCostoEntrada ()
Disponibilidad

AdminPAQ 2005.

Sintaxis

fModificaCostoEntrada (aIdMovimiento, aCostoEntrada)

Parmetros

Nombre
aIdMovimiento

Tipo
Cadena

Uso
Por valor

aCostoEntrada

Cadena

Por valor

Descripcin
Identificador del movimiento a
modificar.
Valor del costo a asignar al
movimiento.

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin modifica el costo de una entrada de inventario.

Ejemplo

El siguiente cdigo indica a la aplicacin que modifique el costo de la entrada de inventario


especificada en lIdMovimiento.
lError = fModificaCostoEntrada (lIdMovimiento, lCostoEntrada)

Ver tambin

fInsertarDocumento(),fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(),fCancelarModificacionDocumento(),

Pgina: 61

fSetDatoMovimiento ()
Disponibilidad

AdminPAQ 2002.

Sintaxis

fSetDatoMovimiento (aCampo, aValor)

Parmetros

Nombre
aCampo
aValor

Tipo
Cadena
Cadena

Uso
Por valor
Por valor

Descripcin
Campo destino
Valor de escritura

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin escribe el valor indicado en el campo correspondiente en el registro activo de la


tabla de documentos.

Ejemplo

El siguiente cdigo indica a la aplicacin que busque un movimiento por su identificador, en


caso de que lo encuentre escribe el contenido de la variable lDescuento en el campo
cDescuen01 de la tabla de movimientos; en caso contrario muestra el mensaje de error
correspondiente.
lError = fBuscarIdMovimiento (lIdMovto)
If lError <> 0 Then
MensajeError lError
Else
lError = fSetDatoMovimiento ("cDescuen01 ", lDescuento)
End If

Ver tambin

fInsertarDocumento(),fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(), fCancelarModificacionDocumento(),

Pgina: 62

fLeeDatoMovimiento ()
Disponibilidad

AdminPAQ 2002.

Sintaxis

fLeeDatoMovimiento (aCampo, aValr, aLen)

Parmetros

Retorna

Nombre
aCampo
aValor
aLen

Tipo
Cadena
Cadena
Entero

Uso
Por valor
Por referencia
Por valor

Descripcin
Campo destino.
Valor de lectura.
Longitud del dato de lectura.

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.
aValor: Al finalizar la funcin este parmetro contiene el valor del campo especificado.

Descripcin

Esta funcin lee el valor indicado del campo correspondiente en el registro activo de la tabla
de documentos.

Ejemplo

El siguiente cdigo indica a la aplicacin que busque un movimiento por su identificador, en


caso de que lo encuentre escribe el contenido del campo cDescuen01 en la variable
lDescuento con una longitud de 8 caracteres; en caso contrario muestra el mensaje de error
correspondiente.
lError = fBuscarIdMovimiento (lIdMovto)
If lError <> 0 Then
MensajeError lError
Else
lError = fLeeDatoMovimiento ("cDescuen01 ", lDescuento, 8)
End If

Ver tambin

fInsertarDocumento(),fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(), fCancelarModificacionDocumento(),

Pgina: 63

Bajo Nivel Bsqueda/Navegacin


fSetFiltroMovimiento ()
Disponibilidad

AdminPAQ 2002.

Sintaxis

fSetFiltroMovimiento(aIdDocumento )

Parmetros

Nombre
aIdDocumento

Tipo
Long

Uso
Por valor

Descripcin
Identificador del documento.

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin aplica un filtro de movimientos de acuerdo al documento indicado.

Ejemplo

El siguiente cdigo indica a la aplicacin que realice un filtro de movimientos para el


documento especificado en el parmetro lIdDocto.
lError = fSetFiltroMovimiento (lIdDocto)

Ver tambin

fInsertarDocumento(), fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(), fCancelarModificacionDocumento(),

fCancelaFiltroMovimiento ()
Disponibilidad

AdminPAQ 2002.

Sintaxis

fCancelaFiltroMovimiento ()

Parmetros
Retorna

No usa.
Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin aplica un filtro de movimientos de acuerdo al documento indicado.

Ejemplo

El siguiente cdigo indica a la aplicacin que cancele el filtro de movimientos activo.


fCancelaFiltroMovimiento ()

Ver tambin

fInsertarDocumento(), fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(), fCancelarModificacionDocumento(),

Pgina: 64

fBuscarIdMovimiento ()
Disponibilidad

AdminPAQ 2004.

Sintaxis

fBuscarIdMovimiento (aIdMovimiento)

Parmetros

Nombre
aIdMovimiento

Tipo
Entero largo

Uso
Por valor

Descripcin
Identificador del movimiento.

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin busca un movimiento por su identificador. Si lo encuentra se posiciona en el


registro correspondiente.

Ejemplo

El siguiente cdigo busca un movimiento por su identificador.


fBuscarIdMovimiento (lIdMovimiento)

Ver tambin

fInsertarDocumento(),fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(),fCancelarModificacionDocumento(),

Pgina: 65

fPosPrimerMovimiento ()
Disponibilidad

AdminPAQ 2002.

Sintaxis

fPosPrimerMovimiento ()

Parmetros
Retorna

No usa.
Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin se ubica en el primer registro de la tabla de movimientos.

Ejemplo

El siguiente cdigo indica a la aplicacin que se posicione en el primer registro de la tabla de


Movimientos.
lError = fPosPrimerMovimiento ()

Ver tambin

fInsertarDocumento(), fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(), fCancelarModificacionDocumento(),

fPosUltimoMovimiento ()
Disponibilidad

AdminPAQ 2002.

Sintaxis

fPosUltimoMovimiento ()

Parmetros

No usa.

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin se ubica en el ultimo registro de la tabla de documentos.

Ejemplo

El siguiente cdigo indica a la aplicacin que se posicione en el ultimo registro de la tabla de


Movimientos.
lError = fPosUltimoMovimiento ()

Ver tambin

fInsertarDocumento(), fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(), fCancelarModificacionDocumento(),

Pgina: 66

fPosSiguienteMovimiento ()
Disponibilidad

AdminPAQ 2002.

Sintaxis

fPosSiguienteMovimiento ()

Parmetros
Retorna

No usa.
Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin se ubica en el siguiente registro de la posicin actual de la tabla de documentos.

Ejemplo

El siguiente cdigo indica a la aplicacin que se posicione en el siguiente registro de la tabla


de Movimientos.
lError = fPosSiguienteMovimiento ()

Ver tambin

fInsertarDocumento(), fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(), fCancelarModificacionDocumento(),

fPosAnteriorMovimiento ()
Disponibilidad

AdminPAQ 2002.

Sintaxis

fPosAnteriorMovimiento ()

Parmetros

No usa.

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin se ubica en el registro anterior de la posicin actual de la tabla de documentos.

Ejemplo

El siguiente cdigo indica a la aplicacin que se posicione en el registro anterior de la tabla


de Movimientos.
lError = fPosAnteriorMovimiento ()

Ver tambin

fInsertarDocumento(), fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(), fCancelarModificacionDocumento(),

Pgina: 67

fPosMovimientoBOF ()
Disponibilidad

AdminPAQ 2002.

Sintaxis

fPosMovimientoBOF ()

Parmetros
Retorna

No usa.
Valores enteros:
1 (uno) Verdadero.
0 (cero) Falso.

Descripcin

Informa si el registro activo se encuentra en el inicio de la tabla de Movimientos.

Ejemplo

El siguiente cdigo indica a la aplicacin que asigne a la variable lInicioTablaMovto el


resultado de la funcin fPosMovimientoBOF.
lInicioTablaMovto = fPosMovimientoBOF ()

Ver tambin

fInsertarDocumento(), fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(), fCancelarModificacionDocumento(),

fPosMovimientoEOF ()
Disponibilidad

AdminPAQ 2002.

Sintaxis

fPosMovimientoEOF ()

Parmetros
Retorna

No usa.
Valores enteros:
1 (uno) Verdadero.
0 (cero) Falso.

Descripcin

Informa si el registro activo se encuentra en el fin de la tabla de Documentos

Ejemplo

El siguiente cdigo indica a la aplicacin que asigne a la variable lFinTablaMovto el resultado


de la funcin fPosMovimientoEOF.
lFinTablaMovto = fPosMovimientoEOF ()

Ver tambin

fInsertarDocumento(), fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(), fCancelarModificacionDocumento(),

Pgina: 68

Alto Nivel Lectura/Escritura


fAltaMovimiento ()
Disponibilidad

AdminPAQ 2002.

Sintaxis

fAltaMovimiento (aIdDocumento, aIdMovimiento, astMovimiento)

Parmetros

Retorna

Nombre
aIdDocumento
aIdMovimiento
astMovimiento

Tipo
Entero largo
Entero largo
tMovimiento

Uso
Por valor
Por referencia
Por valor

Descripcin
Identificador del movimiento.
Identificador del documento.
Tipo de dato abstracto.

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

aIdMovimiento: Al finalizar la funcin este parmetro contiene el identificador del nuevo


movimiento.
Esta funcin da de alta un nuevo registro en la tabla de Movimientos.

Ejemplo

El siguiente cdigo da de alta un nuevo movimiento.


fAltaMovimiento (lIdDocumento, lIdMovimiento, lMovimiento)

Ver tambin

fInsertarDocumento(),fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(),fCancelarModificacionDocumento(),

Pgina: 69

fAltaMovimientoEx ()
Disponibilidad

AdminPAQ 2002.

Sintaxis

fAltaMovimientoEx (aIdMovimiento, aTipoProducto)

Parmetros

Nombre
aIdMovimiento
aTipoProducto

Tipo
Entero largo
tTipoProducto

Uso
Por referencia
Por valor

Descripcin
Identificador del documento.
Tipo de dato abstracto.

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin da de alta de un movimento los datos adicionales de un producto con series,
lotes, pedimientos o caracteristicas.
El siguiente cdigo da de alta un movimento los datos adicionales de un producto con series,
lotes, pedimientos o caracteristicas.

Ejemplo

fAltaMovimientoEx (aIdMovimiento, aTipoProducto)

Ver tambin

fInsertarDocumento(),fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(),fCancelarModificacionDocumento(),

Pgina: 70

fAltaMovimientoCDesct ()
Disponibilidad

AdminPAQ 2007.

Sintaxis

fAltaMovimientoCDesct (aIdDocumento, aIdMovimiento, astMovimiento)

Parmetros

Nombre
Tipo
Uso
Descripcin
aIdDocumento
Entero largo
Por valor
Identificador del documento.
aIdMovimiento
Entero largo
Por Referencia Identificador del movimiento
astMovimiento
tMovmientoDesc Por valor
Tipo de dato abstracto.
Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Retorna

Descripcin
Ejemplo

Esta funcin da de alta un nuevo registro en la tabla de Movimientos.


Esta funcin incluye Importes y Porcentajes de Descuentos, a diferencia de la funcin
fAltaMovimiento.
El siguiente cdigo da de alta un movimento los datos adicionales de un producto con series,
lotes, pedimientos o caracteristicas.
fAltaMovimientoCDesct (aIdDocumento, aIdMovimiento, astMovimiento)

Ver tambin

fInsertarDocumento(),fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(),fCancelarModificacionDocumento(),

Pgina: 71

fAltaMovimientoCaracteristicas ()
Disponibilidad

AdminPAQ 2004.

Sintaxis

fAltaMovimientoCaracteristicas (aIdMovimiento, aIdMovtoCaracteristicas, aCaracteristicas)

Parmetros

Retorna

Nombre
aIdMovimiento
aIdMovtoCaracteristicas
aCaracteristicas

Tipo
Entero largo
Entero largo
tCaracteristicas

Uso
Por valor
Por referencia
Por valor

Descripcin
Identificador del movimiento.
Identificador del documento.
Tipo de dato abstracto.

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

aIdMovtoCaracteristicas: Al finalizar la funcin este parmetro contiene el identificador del


nuevo movimiento.
Esta funcin inserta un movimiento con caractersticas.

Ejemplo

El siguiente cdigo da de alta un movimiento con caractersticas.


fAltaMovimientoCaracteristicas (lIdDocumento, lIdMovimiento, lMovimiento)

Ver tambin

fInsertarDocumento(),fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(),fCancelarModificacionDocumento(),

Pgina: 72

fAltaMovtoCaracteristicasUnidades ()
Disponibilidad

AdminPAQ 2005.

Sintaxis

fAltaMovtoCaracteristicasUnidades (aIdMovimiento, aIdMovtoCaracteristicas,


aCaracteristicasUnidades)
Nombre
Tipo
Uso
Descripcin
aIdMovimiento
Entero largo
Por valor
Identificador del
movimiento.
aIdMovtoCaracteristicas Entero largo
Por
Identificador del
referencia
documento.
aCaracteristicasUnidades tCaracteristicasUnidades Por valor
Tipo de dato
abstracto.

Parmetros

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

aIdMovtoCaracteristicas: Al finalizar la funcin este parmetro contiene el identificador del


nuevo movimiento.
Esta funcin da de alta movimiento de caractersticas con unidades de compra venta.

Ejemplo

El siguiente da de alta movimiento de caractersticas con unidades de compra venta.


fAltaMovtoCaracteristicasUnidades (lIdDocumento, lIdMovimiento, lMovimiento)

Ver tambin

fInsertarDocumento(),fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(),fCancelarModificacionDocumento(),

Pgina: 73

fAltaMovimientoSeriesCapas ()
Disponibilidad

AdminPAQ 2002.

Sintaxis

fAltaMovimientoSeriesCapas (aIdMovimiento, aSeriesCapas)

Parmetros

Nombre
aIdMovimiento
aSeriesCapas

Tipo
long
tSeriesCapas

Uso
Por valor
Por valor

Descripcin
Identificador del movimiento.
Tipo de dato abstracto.

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin agrega el movimiento de numero de serie, lote y/o pedimento asociados un
movimiento cuyo producto maneje cualquiera de estas posibles configuraciones.

Ejemplo

El siguiente da de alta un movimiento para un producto con numero de serie, lote y/o
pedimento asociado.
lError = fAltaMovimientoSeriesCapas (lIdMovimiento, lSeriesCapas)

Ver tambin

fInsertarDocumento(),fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(),fCancelarModificacionDocumento(),

Pgina: 74

FUNCIONES DE CLIENTES / PROVEEDORES


Bajo Nivel Lectura/Escritura
fInsertaCteProv ()
Disponibilidad

AdminPAQ 2003.

Sintaxis

fInsertaCteProv ()

Parmetros

No usa.

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error
Adiciona un nuevo registro en la tabla de Clientes / Proveedores en modo de insercin.

Descripcin
Ejemplo

El siguiente cdigo indica a la aplicacin que inserte un nuevo registro en la tabla de Clientes
/ Proveedores.
fInsertaCteProv ()

Ver tambin

fEditaCteProv ()

fInsertarDocumento(), fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(), fCancelarModificacionDocumento(),

Disponibilidad

AdminPAQ 2003.

Sintaxis

fEditaCteProv ()

Parmetros

No usa.

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error

Descripcin

Activa el modo de Edicin de un registro en la tabla de Clientes / Proveedores.

Ejemplo

El siguiente cdigo busca un cliente/proveedor por su Identificador, si lo encuentra lo activa


en modo edicin, en caso de no encontrarlo enva el mensaje de error correspondiente
lError = fBuscaIdCteProv (lIdCteProv)
If lError <> 0 Then
MensajeError lError
Else
fEditaCteProv ()
End If

Ver tambin

fInsertarDocumento(),fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(),fCancelarModificacionDocumento(),

Pgina: 75

fGuardaCteProv ()
Disponibilidad

AdminPAQ 2002.

Sintaxis

fGuardaCteProv ()

Parmetros

No usa.

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Guarda los cambios realizados a un registro de cliente/proveedor.

Ejemplo

El siguiente cdigo indica a la aplicacin que guarde cierto registro en la tabla de Clientes /
Proveedores. Esta funcin se llama despus de que se utiliza la funcin fInsertaCteProv() o
fEditaCteProv() y se graban los valores en los campos correspondientes.
fGuardaCteProv ()

Ver tambin

fBorraCteProv ()

fInsertarDocumento(),fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(), fCancelarModificacionDocumento(),

Disponibilidad

AdminPAQ 2003.

Sintaxis

fBorraCteProv ()

Parmetros

No usa.

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.
Borra un registro en la tabla de Clientes / Proveedores.

Descripcin
Ejemplo

El siguiente cdigo busca un documento por su identificador, si lo encuentra lo borra, en caso


contrario enva el mensaje de error correspondiente
lError = fBuscaIdCteProv (lIdCteProv)
If lError <> 0 Then
MensajeError lError
Else
fBorraCteProv ()
End If

Ver tambin

fInsertarDocumento(), fEditarDocumento(), fGuardaDocumento(), fBorraDocumento_CW(),


fCancelarModificacionDocumento(),

Pgina: 76

fCancelarModificacionCteProv ()
Disponibilidad

AdminPAQ 2003.

Sintaxis

fCancelarModificacionCteProv ()

Parmetros

No usa.

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin cancela las modificaciones al registro actual de Clientes / Proveedores. El registro
debe estar en modo de edicin o insercin.

Ejemplo

El siguiente cdigo indica a la aplicacin que cancele la modificacin a un registro de


Clientes / Proveedores que estaba en modo de insercin o edicin.

Ver tambin

fInsertarDocumento(),fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(), fCancelarModificacionDocumento(),

fCancelarModificacionCteProv ()

fEliminarCteProv ()
Disponibilidad

AdminPAQ 2003.

Sintaxis

fEliminarCteProv (aCodigoCteProv)

Parmetros

Nombre
aCodigoCteProv

Tipo
Cadena

Uso
Por valor

Descripcin
Cdigo del Cliente / Proveedor

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin elimina un Cliente / Proveedor usando su cdigo.

Ejemplo

El siguiente cdigo elimina un Cliente / Proveedor, si lo encuentra lo borra, en caso contrario


enva el mensaje de error correspondiente
lError = fEliminarCteProv (aCodigoCteProv)
If lError <> 0 Then
MensajeError lError
End If

Ver tambin

fInsertarDocumento(),fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(),fCancelarModificacionDocumento(),

Pgina: 77

fSetDatoCteProv ()
Disponibilidad

AdminPAQ 2002.

Sintaxis

fSetDatoCteProv (aCampo, aValor)

Parmetros

Retorna

Descripcin
Ejemplo

Nombre
aCampo
aValor

Tipo
Cadena
Cadena

Uso
Por valor
Por valor

Descripcin
Campo destino
Valor de escritura

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.
Esta funcin escribe el valor indicado en el campo correspondiente en el registro activo de la
tabla de Cliente / Proveedor.
El siguiente cdigo indica a la aplicacin que busque un movimiento por su cdigo, en caso
de que lo encuentre escribe el contenido de la variable lRFC en el campo cRFC de la tabla
de Cliente / Proveedor; en caso contrario muestra el mensaje de error correspondiente.
lError = fBuscaCteProv (lCodCteProv)
If lError <> 0 Then
MensajeError lError
Else
lError = fSetDatoCteProv ("cRFC ", lRFC)
End If

Ver tambin

fInsertarDocumento(),fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(), fCancelarModificacionDocumento(),

Pgina: 78

fLeeDatoCteProv ()
Disponibilidad

AdminPAQ 2002.

Sintaxis

fLeeDatoCteProv (aCampo, aValr, aLen)

Parmetros

Retorna

Nombre
aCampo
aValor
aLen

Tipo
Cadena
Cadena
Entero

Uso
Por valor
Por referencia
Por valor

Descripcin
Campo destino.
Valor de lectura.
Longitud del dato de lectura.

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.
aValor: Al finalizar la funcin este parmetro contiene el valor del campo especificado.

Descripcin

Esta funcin lee el valor indicado del campo correspondiente en el registro activo de la tabla
de Cliente / Proveedor.

Ejemplo

El siguiente cdigo indica a la aplicacin que busque un movimiento por su identificador, en


caso de que lo encuentre escribe el contenido de l campo cRFC en la variable la variable
lRFC con una longitud de 20 caracteres; en caso contrario muestra el mensaje de error
correspondiente.

Ver tambin

lError = fBuscarIdMovimiento (lIdMovto)


If lError <> 0 Then
MensajeError lError
Else
lError = fLeeDatoCteProv ("cRFC ", lRFC, 20)
End If

fInsertarDocumento(),fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(), fCancelarModificacionDocumento(),

Pgina: 79

Bajo Nivel Bsqueda/Navegacin


fBuscaCteProv ()
Disponibilidad

AdminPAQ 2002.

Sintaxis

fBuscaCteProv (aCodCteProv)

Parmetros

Nombre
aCodCteProv

Tipo
Cadena

Uso
Por valor

Descripcin
Cdigo del Cliente /
Proveedor.

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin busca un Cliente / Proveedor por su cdigo.

Ejemplo

El siguiente cdigo busca un Cliente / Proveedor por su cdigo.


fBuscaIdCteProv (lCodCteProv)

Ver tambin

fInsertarDocumento(),fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(),fCancelarModificacionDocumento(),

fBuscaIdCteProv ()
Disponibilidad

AdminPAQ 2003.

Sintaxis

fBuscaIdCteProv (aIdCteProv)

Parmetros

Nombre
aIdCteProv

Tipo
Entero

Uso
Por valor

Descripcin
Identificador del Cliente /
Proveedor.

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin busca un Cliente / Proveedor por su Identificador.

Ejemplo

El siguiente cdigo busca un Cliente / Proveedor por su identificador.


fBuscaIdCteProv (lIdCteProv)

Ver tambin

fInsertarDocumento(),fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(),fCancelarModificacionDocumento(),

Pgina: 80

fPosPrimerCteProv ()
Disponibilidad

AdminPAQ 2002.

Sintaxis

fPosPrimerCteProv ()

Parmetros
Retorna

No usa.
Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin se ubica en el primer registro de la tabla de Clientes / Proveedores.

Ejemplo

El siguiente cdigo indica a la aplicacin que se posicione en el primer registro de la tabla de


Clientes / Proveedores.
lError = fPosPrimerCteProv ()

Ver tambin

fInsertarDocumento(), fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(), fCancelarModificacionDocumento(),

fPosUltimoCteProv ()
Disponibilidad

AdminPAQ 2002.

Sintaxis

fPosUltimoCteProv ()

Parmetros
Retorna

No usa.
Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin se ubica en el ultimo registro de la tabla de Clientes / Proveedores.

Ejemplo

El siguiente cdigo indica a la aplicacin que se posicione en el ultimo registro de la tabla de


Clientes / Proveedores.
lError = fPosUltimoCteProv ()

Ver tambin

fInsertarDocumento(), fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(), fCancelarModificacionDocumento(),

Pgina: 81

fPosSiguienteCteProv ()
Disponibilidad

AdminPAQ 2002.

Sintaxis

fPosSiguienteCteProv ()

Parmetros
Retorna

No usa.
Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin se ubica en el siguiente registro de la posicin actual de la tabla de Clientes /


Proveedores.
El siguiente cdigo indica a la aplicacin que se posicione en el siguiente registro de la tabla
de Clientes / Proveedores.

Ejemplo

lError = fPosSiguienteCteProv ()

Ver tambin

fInsertarDocumento(), fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(), fCancelarModificacionDocumento(),

fPosAnteriorCteProv ()
Disponibilidad

AdminPAQ 2002.

Sintaxis

fPosAnteriorCteProv ()

Parmetros

No usa.

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin se ubica en el registro anterior de la posicin actual de la tabla de Clientes /


Proveedores.
El siguiente cdigo indica a la aplicacin que se posicione en el registro anterior de la tabla
de Clientes / Proveedores.

Ejemplo

lError = fPosAnteriorCteProv ()

Ver tambin

fInsertarDocumento(), fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(), fCancelarModificacionDocumento(),

Pgina: 82

fPosBOFCteProv ()
Disponibilidad

AdminPAQ 2002.

Sintaxis

fPosBOFCteProv()

Parmetros
Retorna

No usa.
Valores enteros:
1 (uno) Verdadero.
0 (cero) Falso.

Descripcin

Informa si el registro activo se encuentra en el inicio de la tabla de Documentos

Ejemplo

El siguiente cdigo indica a la aplicacin que asigne a la variable lInicioTablaCteProv el


resultado
de la funcin fPosBOFCteProv.
lInicioTablaCteProv= fPosBOFCteProv ()

Ver tambin

fInsertarDocumento(), fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(), fCancelarModificacionDocumento(),

fPosEOFCteProv ()
Disponibilidad

AdminPAQ 2002.

Sintaxis

fPosEOFCteProv ()

Parmetros
Retorna

No usa.
Valores enteros:
1 (uno) Verdadero.
0 (cero) Falso.

Descripcin

Informa si el registro activo se encuentra en el fin de la tabla de Documentos

Ejemplo

El siguiente cdigo indica a la aplicacin que asigne a la variable lFinTablaCteProvel resultado


de la funcin fPosEOFCteProv.
lFinTablaCteProv = fPosEOFCteProv ()

Ver tambin

fInsertarDocumento(), fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(), fCancelarModificacionDocumento(),

Pgina: 83

Alto Nivel Lectura/Escritura


fAltaCteProv ()

Disponibilidad

AdminPAQ 2003.

Sintaxis

fAltaCteProv (aIdCteProv, astCteProv)

Parmetros

Nombre
aIdCteProv
astCteProv

Retorna

Tipo
Entero
tCteProv

Uso
Por referencia
Por valor

Descripcin
Identificador del Cliente /
Proveedor.
Tipo de dato abstracto.

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

aIdCteProv: Al finalizar la funcin este parmetro contiene el identificador del nuevo Cliente /
Proveedor.
Esta funcin da de alta un nuevo Cliente / Proveedor.

Ejemplo

El siguiente cdigo da de alta un nuevo Cliente / Proveedor.


fAltaCteProv (ldCteProv, lCteProv)

Ver tambin

fInsertarDocumento(),fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(),fCancelarModificacionDocumento(),

Pgina: 84

fActualizaCteProv ()
Disponibilidad

AdminPAQ 2003.

Sintaxis

fActualizaCteProv (aCodigoCteProv, astCteProv)

Parmetros

Nombre
aCodigoCteProv

Tipo
Cadena

Uso
Por referencia

astCteProv

tCteProv

Por valor

Descripcin
Identificador del Cliente /
Proveedor.
Tipo de dato abstracto.

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin actualiza un Cliente / Proveedor por medio su cdigo.

Ejemplo

El siguiente cdigo actualiza un Cliente / Proveedor por medio su cdigo.


fActualizaCteProv (lCodigoCteProv, lCteProv)

Ver tambin

fInsertarDocumento(),fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(),fCancelarModificacionDocumento(),

Pgina: 85

fLlenaRegistroCteProv ()
Disponibilidad

AdminPAQ 2003.

Sintaxis

fLlenaRegistroCteProv (astCteProv, aEsAlta )

Parmetros

Nombre
astCteProv
aEsAlta

Tipo
tCteProv
Entero

Uso
Por valor
Por valor

Descripcin
Tipo de dato abstracto.
1 = Nuevo Cliente / Proveedor.
2 = Actualizacion Cliente /
Proveedor.

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin asigna al registro de la tabla de Clientes / Proveedores los valores de la estructura
de datos astCteProv.
El siguiente cdigo da de alta un nuevo Cliente / Proveedor en la tabla de Clientes /
Proveedores.

Ejemplo

fLlenaRegistroCteProv (ltCteProv, 1)

Ver tambin

fInsertarDocumento(),fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(),fCancelarModificacionDocumento(),

Pgina: 86

FUNCIONES DE PRODUCTOS
Bajo Nivel Lectura/Escritura
fInsertaProducto ()
Disponibilidad

AdminPAQ 2003.

Sintaxis

fInsertaProducto ()

Parmetros

No usa.

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error
Adiciona un nuevo registro en la tabla de productos en modo de insercin.

Descripcin
Ejemplo

El siguiente cdigo indica a la aplicacin que inserte un nuevo registro en la tabla de


Productos.
fInsertaProducto ()

Ver tambin

fEditaProducto ()

fInsertarDocumento(), fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(), fCancelarModificacionDocumento(),

Disponibilidad

AdminPAQ 2003.

Sintaxis

fEditaProducto ()

Parmetros

No usa.

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error

Descripcin

Activa el modo de Edicin de un registro en la tabla de Productos.

Ejemplo

El siguiente cdigo busca un producto por su cdigo , si lo encuentra lo activa en modo


edicin, en caso de no encontrarlo enva el mensaje de error correspondiente
lError = fBuscaProducto (aCodProducto)
If lError <> 0 Then
MensajeError lError
Else
fEditaProducto ()
End If

Ver tambin

fInsertarDocumento(),fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(),fCancelarModificacionDocumento(),

Pgina: 87

fGuardaProducto ()
Disponibilidad

AdminPAQ 2002.

Sintaxis

fGuardaProducto ()

Parmetros

No usa.

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Guarda los cambios realizados a un registro de productos.

Ejemplo

El siguiente cdigo indica a la aplicacin que guarde cierto registro en la tabla de productos.
Esta funcin se llama despus de que se utiliza la funcin fInsertaProducto() o fEditaProducto()
y se graban los valores en los campos correspondientes.
fGuardaProducto ()

Ver tambin

fBorraProducto ()

fInsertarDocumento(),fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(), fCancelarModificacionDocumento(),

Disponibilidad

AdminPAQ 2003.

Sintaxis

fBorraProducto ()

Parmetros

No usa.

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.
Borra un registro en la tabla de productos.

Descripcin
Ejemplo

El siguiente cdigo busca un productos por su cdigo, si lo encuentra lo borra, en caso


contrario enva el mensaje de error correspondiente
lError = fBuscaProducto (aCodProducto)
If lError <> 0 Then
MensajeError lError
Else
fBorraProducto ()
End If

Ver tambin

fInsertarDocumento(), fEditarDocumento(), fGuardaDocumento(), fBorraDocumento_CW(),


fCancelarModificacionDocumento(),

Pgina: 88

fCancelarModificacionProducto ()
Disponibilidad

AdminPAQ 2003.

Sintaxis

fCancelarModificacionProducto ()

Parmetros

No usa.

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin cancela las modificaciones al registro actual de productos. El registro debe estar
en modo de edicin o insercin.

Ejemplo

El siguiente cdigo indica a la aplicacin que cancele la modificacin a un registro de


productos que estaba en modo de insercin o edicin.
fCancelarModificacionProducto ()

Ver tambin

fInsertarDocumento(),fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(), fCancelarModificacionDocumento(),

fEliminarProducto ()
Disponibilidad

AdminPAQ 2003.

Sintaxis

fEliminarProducto (aCodigoProducto)

Parmetros

Nombre
aCodigoProducto

Tipo
Cadena

Uso
Por valor

Descripcin
Cdigo del producto.

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin elimina un producto usando su cdigo.

Ejemplo

El siguiente cdigo elimina un producto, si lo encuentra lo borra, en caso contrario enva el


mensaje de error correspondiente
lError = fEliminarProducto (aCodigoProducto)
If lError <> 0 Then
MensajeError lError
End If

Ver tambin

fInsertarDocumento(),fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(),fCancelarModificacionDocumento(),

Pgina: 89

fSetDatoProducto ()
Disponibilidad

AdminPAQ 2003.

Sintaxis

fSetDatoProducto (aCampo, aValor)

Parmetros

Retorna

Descripcin
Ejemplo

Nombre
aCampo
aValor

Tipo
Cadena
Cadena

Uso
Por valor
Por valor

Descripcin
Campo destino
Valor de escritura

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.
Esta funcin escribe el valor indicado en el campo correspondiente en el registro activo de la
tabla Productos.
El siguiente cdigo indica a la aplicacin que busque un movimiento por su cdigo, en caso
de que lo encuentre escribe el contenido de la variable lFechaAlta en el campo cFechaAl01
de la tabla Productos; en caso contrario muestra el mensaje de error correspondiente.
lError = fBuscaProducto (aCodProducto)
If lError <> 0 Then
MensajeError lError
Else
lError = fSetDatoProducto ("cFechaAl01 ", lFechaAlta)
End If

Ver tambin

fInsertarDocumento(),fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(), fCancelarModificacionDocumento(),

Pgina: 90

fLeeDatoProducto ()
Disponibilidad

AdminPAQ 2003.

Sintaxis

fLeeDatoProducto (aCampo, aValr, aLen)

Parmetros

Retorna

Nombre
aCampo
aValor
aLen

Tipo
Cadena
Cadena
Entero

Uso
Por valor
Por referencia
Por valor

Descripcin
Campo destino.
Valor de lectura.
Longitud del dato de lectura.

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.
aValor: Al finalizar la funcin este parmetro contiene el valor del campo especificado.

Descripcin

Esta funcin lee el valor indicado del campo correspondiente en el registro activo de la tabla
de productos.

Ejemplo

El siguiente cdigo indica a la aplicacin que busque un producto por su cdigo, en caso de
que lo encuentre escribe el contenido de l campo cFechaAl01 en la variable la variable
lFechaAlta con una longitud de 20 caracteres; en caso contrario muestra el mensaje de error
correspondiente.

Ver tambin

lError = fBuscaProducto (aCodProducto)


If lError <> 0 Then
MensajeError lError
Else
lError = fLeeDatoProducto ("cFechaAl01", lFechaAlta, 8)
End If

fInsertarDocumento(),fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(), fCancelarModificacionDocumento(),

Pgina: 91

fRecuperaTipoProducto ()
Disponibilidad

AdminPAQ 2002.

Sintaxis

fRecuperaTipoProducto(aUnidades, aSerie, aLote, aPedimento, aCaracteristicas)

Parmetros

Retorna

Nombre
aUnidades

Tipo
Lgico (bool)

Uso
Por referencia

aSerie

Lgico (bool)

Por referencia

aLote

Lgico (bool)

Por referencia

aPedimento

Lgico (bool)

Por referencia

aCaracteristicas

Lgico (bool)

Por referencia

Descripcin
Valor lgico. Verdadero o
Falso. Maneja unidades o no.
Valor lgico. Verdadero o
Falso. Maneja series o no.
Valor lgico. Verdadero o
Falso. Maneja lotes o no.
Valor lgico. Verdadero o
Falso. Maneja pedimentos o
no.
Valor lgico. Verdadero o
Falso. Maneja caracterisricas o
no.

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

aUnidades: Al finalizar la funcin este parmetro indica si el producto maneja unidades o no.
aSerie: Al finalizar la funcin este parmetro indica si el producto maneja series o no.
aLote: Al finalizar la funcin este parmetro indica si el producto maneja lotes o no.
aPedimento: Al finalizar la funcin este parmetro indica si el producto maneja
pedimentos o no.
aCaracteristicas: Al finalizar la funcin este parmetro indica si el producto maneja
caractersticas o no.
Descripcin

Esta funcin define el tipo de producto, indicando si maneja series, lotes, pedimentos,
unidades y/o caractersticas.

Ejemplo

El siguiente cdigo indica a la aplicacin que recupere las cualidades del producto
especificado.
lError = fRecuperaTipoProducto(lUnidades, lSerie, lLote, lPedimento, lCaracteristicas)
If lError <> 0 Then
MensajeError lError
End If

Ver tambin

fInsertarDocumento(),fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(), fCancelarModificacionDocumento(),

Pgina: 92

fRecosteoProducto ()
Disponibilidad

AdminPAQ 2004.

Sintaxis

fRecosteoProducto (aCodigoProducto, aEjercicio, aPeriodo, aCodigoClasificacion1,


aCodigoClasificacion2, aCodigoClasificacion3, aCodigoClasificacion4,
aCodigoClasificacion5, aCodigoClasificacion6, aNombreBitacora,
aSobreEscribirBitacora , aEsCalculoArimetico)
Nombre
Tipo
Uso
Descripcin
aCodigoProducto
Cadena
Por valor
Cdigo del producto.
aEjercicio
Entero
Por valor
Ejercicio a partir del cual se recostea.
aPeriodo
Entero
Por valor
Periodo a partir del cual se recostea.
aCodigoClasificacion1 Cadena
Por valor
Cdigo de la clasificacin 1.
aCodigoClasificacion2 Cadena
Por valor
Cdigo de la clasificacin 2.
aCodigoClasificacion3 Cadena
Por valor
Cdigo de la clasificacin 3.
aCodigoClasificacion4 Cadena
Por valor
Cdigo de la clasificacin 4.
aCodigoClasificacion5 Cadena
Por valor
Cdigo de la clasificacin 5.
aCodigoClasificacion6 Cadena
Por valor
Cdigo de la clasificacin 6.
aNombreBitacora
Cadena
Por valor
Nombre de la bitcora a escribir.
aSobreEscribirBitacora Entero
Por valor
Sobrescribir la bitcora, si sta existe.
0 - Sobrescribe la bitcora
1 - No Sobrescribe la bitcora
aEsCalculoArimetico
Entero
Por valor
Determina el tipo de calculo para el
costo promedio.
0 = MegaPAQ.
1 = AdminPAQ.

Parmetros

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin recostea un producto determinado a partir de un periodo y un ejercicio.

Ejemplo

El siguiente cdigo recostea un producto a partir de un periodo y un ejercicio; sobrescribe la


bitcora, si esta existe y utiliza el costo promedio de AdminPAQ.
lError = fRecosteoProducto (lCodigoProducto, lEjercicio, lPeriodo, lCodigoClasificacion1,
lCodigoClasificacion2, lCodigoClasificacion3, lCodigoClasificacion4, lCodigoClasificacion5,
lCodigoClasificacion6, lNombreBitacora, 0 , 1)
If lError <> 0 Then
MensajeError lError
End If

Ver tambin

fInsertarDocumento(),fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(), fCancelarModificacionDocumento(),

Pgina: 93

fRegresaPrecioVenta ()
Disponibilidad

AdminPAQ 2005.

Sintaxis

fRegresaPrecioVenta (aCodigoConcepto, aCodigoCliente, aCodigoProducto, aPrecioVenta)

Parmetros

Retorna

Descripcin
Ejemplo

Nombre
aCodigoConcepto
aCodigoCliente
aCodigoProducto
aPrecioVenta

Tipo
Cadena
Cadena
Cadena
Cadena

Uso
Por valor
Por valor
Por valor
Por referencia

Descripcin
Cdigo del concepto.
Cdigo del cliente.
Cdigo del producto.
Precio de venta.

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.
aPrecioVenta: Al finalizar la funcin este parmetro contiene el precio de venta del producto
solicitado.
Esta funcin obtiene el precio de venta de un producto de un determinado cliente para un
concepto de documento en especifico.
El siguiente cdigo obtiene el precio de venta de un producto de un determinado cliente
para un concepto de documento en especifico.
lError = fRegresaPrecioVenta (lCodigoConcepto, lCodigoCliente, lCodigoProducto,
aPrecioVenta)
If lError <> 0 Then
MensajeError lError
End If

Ver tambin

fInsertarDocumento(),fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(), fCancelarModificacionDocumento(),

Pgina: 94

Bajo Nivel Bsqueda/Navegacin


fBuscaProducto ()
Disponibilidad

AdminPAQ 2002.

Sintaxis

fBuscaProducto (aCodProducto)

Parmetros

Nombre
aCodProducto

Tipo
Cadena

Uso
Por valor

Descripcin
Cdigo del producto.

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin busca un producto por su cdigo.

Ejemplo

El siguiente cdigo busca un producto por su cdigo.


fBuscaProducto (lCodProducto)

Ver tambin

fInsertarDocumento(),fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(),fCancelarModificacionDocumento(),

fBuscaIdProducto ()
Disponibilidad

AdminPAQ 2003.

Sintaxis

fBuscaIdProducto (aIdProducto)

Parmetros

Nombre
aIdProducto

Tipo
Entero

Uso
Por valor

Descripcin
Identificador del producto.

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin busca un producto por su Identificador.

Ejemplo

El siguiente cdigo busca un producto por su identificador.


fBuscaIdProducto (lIdProducto)

Ver tambin

fInsertarDocumento(),fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(),fCancelarModificacionDocumento(),

Pgina: 95

fPosPrimerProducto ()
Disponibilidad

AdminPAQ 2002.

Sintaxis

fPosPrimerProducto ()

Parmetros
Retorna

No usa.
Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin se ubica en el primer registro de la tabla de Productos.

Ejemplo

El siguiente cdigo indica a la aplicacin que se posicione en el primer registro de la tabla de


Productos.
lError = fPosPrimerProducto ()

Ver tambin

fInsertarDocumento(), fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(), fCancelarModificacionDocumento(),

fPosUltimoProducto ()
Disponibilidad

AdminPAQ 2002.

Sintaxis

fPosUltimoProducto ()

Parmetros
Retorna

No usa.
Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin se ubica en el ultimo registro de la tabla de Productos.

Ejemplo

El siguiente cdigo indica a la aplicacin que se posicione en el ultimo registro de la tabla de


Productos.
lError = fPosUltimoProducto ()

Ver tambin

fInsertarDocumento(), fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(), fCancelarModificacionDocumento(),

Pgina: 96

fPosSiguienteProducto ()
Disponibilidad

AdminPAQ 2002.

Sintaxis

fPosSiguienteProducto ()

Parmetros
Retorna

No usa.
Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin se ubica en el siguiente registro de la posicin actual de la tabla de Productos.

Ejemplo

El siguiente cdigo indica a la aplicacin que se posicione en el siguiente registro de la tabla


de Productos.
lError = fPosSiguienteProducto ()

Ver tambin

fInsertarDocumento(), fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(), fCancelarModificacionDocumento(),

fPosAnteriorProducto ()
Disponibilidad

AdminPAQ 2002.

Sintaxis

fPosAnteriorProducto ()

Parmetros

No usa.

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin se ubica en el registro anterior de la posicin actual de la tabla de Productos.

Ejemplo

El siguiente cdigo indica a la aplicacin que se posicione en el registro anterior de la tabla


de Productos.
lError = fPosAnteriorProducto ()

Ver tambin

fInsertarDocumento(), fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(), fCancelarModificacionDocumento(),

Pgina: 97

fPosBOFProducto ()
Disponibilidad

AdminPAQ 2002.

Sintaxis

fPosBOFProducto ()

Parmetros
Retorna

No usa.
Valores enteros:
1 (uno) Verdadero.
0 (cero) Falso.

Descripcin

Informa si el registro activo se encuentra en el inicio de la tabla de Productos

Ejemplo

El siguiente cdigo indica a la aplicacin que asigne a la variable lInicioTablaProductos el


resultado de la funcin fPosBOFProducto.
lInicioTablaProductos = fPosBOFProducto ()

Ver tambin

fInsertarDocumento(), fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(), fCancelarModificacionDocumento(),

fPosEOFProducto ()
Disponibilidad

AdminPAQ 2002.

Sintaxis

fPosEOFProducto ()

Parmetros
Retorna

No usa.
Valores enteros:
1 (uno) Verdadero.
0 (cero) Falso.

Descripcin

Informa si el registro activo se encuentra en el fin de la tabla de Productos

Ejemplo

El siguiente cdigo indica a la aplicacin que asigne a la variable lFinTablaProductos el


resultado
de la funcin fPosEOFProducto.

Ver tambin

lFinTablaProductos = fPosEOFProducto ()
fInsertarDocumento(), fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),
fBorraDocumento_CW(), fCancelarModificacionDocumento(),

Pgina: 98

Alto Nivel Lectura/Escritura


fAltaProducto ()
Disponibilidad

AdminPAQ 2003.

Sintaxis

fAltaProducto (aIdProducto, astProducto)

Parmetros

Retorna

Nombre
aIdProducto
astProducto

Tipo
Entero
tProducto

Uso
Por referencia
Por valor

Descripcin
Identificador del producto.
Tipo de dato abstracto.

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

aIdProducto: Al finalizar la funcin este parmetro contiene el identificador del nuevo


producto.
Esta funcin da de alta un nuevo Producto.

Ejemplo

El siguiente cdigo da de alta un nuevo producto.


fAltaProducto (lIdProducto, ltProducto)

Ver tambin

fInsertarDocumento(),fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(),fCancelarModificacionDocumento(),

Pgina: 99

fActualizaProducto ()
Disponibilidad

AdminPAQ 2003.

Sintaxis

fActualizaProducto (aCodigoProducto, astCteProv)

Parmetros

Nombre
aCodigoProducto
astProducto

Tipo
Entero largo
tProducto

Uso
Por referencia
Por valor

Descripcin
Cdigo del producto.
Tipo de dato abstracto.

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin actualiza un producto.

Ejemplo

El siguiente cdigo actualiza un producto.


fActualizaProducto (lCodigoProducto, ltProducto)

Ver tambin

fInsertarDocumento(),fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(),fCancelarModificacionDocumento(),

Pgina: 100

fLlenaRegistroProducto ()
Disponibilidad

AdminPAQ 2003.

Sintaxis

fLlenaRegistroCteProv (astProducto, aEsAlta )

Parmetros

Nombre
astProducto
aEsAlta

Tipo
tProducto
Entero

Uso
Por valor
Por valor

Descripcin
Tipo de dato abstracto.
1 = Nuevo Producto.
2 = Actualizacion Producto.

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin asigna al registro de la tabla de productos los valores de la estructura de datos
astCteProv.
El siguiente cdigo da de alta un nuevo producto en la tabla de productos.

Ejemplo

fLlenaRegistroProducto (astProducto, 1)

Ver tambin

fInsertarDocumento(),fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(),fCancelarModificacionDocumento(),

Pgina: 101

FUNCIONES DE ADDENDAS
Bajo Nivel Lectura/Escritura
fInsertaDatoCompEducativo ()
Disponibilidad

AdminPAQ 7.2.1. CONTPAQ i FACTURA ELECTRNICA 1.0.1

Sintaxis

fInsertaDatoCompEducativo(int aIdServicio, int aNumCampo, char *aDato )

Parmetros

Nombre
Tipo
Uso
Descripcin
aIdServicio
Entero
Por valor
Identificador del servicio
aNumCampo
Entero
Por valor
Nmero de campo
aDato
Cadena
Por referencia Valor a insertar
Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error
Esta funcin inserta un registro correspondiente a los datos adicionales para el complemento
educativo del catlogo servicios.
El siguiente cdigo indica a la aplicacin que inserten los datos adicionales del complemento
educativo.

Retorna
Descripcin
Ejemplo

fInsertaDatoCompEducativo (aIdServicio, aNumCampo, aDato)

Ver tambin

fInsertaDatoAddendaDocto(), fObtieneLicencia(), fObtienePassProxy().

fInsertaDatoAddendaDocto ()
Disponibilidad

AdminPAQ 7.3.2. CONTPAQ i FACTURA ELECTRNICA 2.5.1

Sintaxis

fInsertaDatoAddendaDocto(aIdAddenda, aIdCatalogo, aNumCampo, aDato)

Parmetros

Nombre
Tipo
Uso
Descripcin
aIdAddenda
Entero
Por valor
Identificador de la Addenda
aIdCatalogo
Entero
Por valor
Identificador del documento
aNumCampo
Entero
Por valor
Nmero de campo
aDato
Cadena
Por referencia Valor a insertar
Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error
Agrega los datos de la addenda para los documentos.

Retorna
Descripcin
Ejemplo

El siguiente cdigo indica a la aplicacin que inserte los datos de la addenda para los
documentos.
fInsertaDatoAddendaDocto(aIdAddenda, aIdCatalogo, aNumCampo, aDato)

Ver tambin

fInsertaDatoCompEducativo (), fObtieneLicencia(), fObtienePassProxy().

Pgina: 102

fObtieneLicencia ()
Disponibilidad

AdminPAQ 7.3.0. CONTPAQ i FACTURA ELECTRNICA 2.2.1

Sintaxis

fObtieneLicencia (aCodActiva, aCodSitio, aSerie, aTagVersion)

Parmetros

Retorna

Nombre
aCodActiva

Tipo
Cadena

Uso
Por referencia

aCodSitio

Cadena

Por referencia

aSerie

Cadena

Por referencia

aTagVersion

Cadena

Por referencia

Descripcin
Variable en la que regresa el
cdigo de activacin del
Sistema
Variable en la que regresa el
cdigo de sitio del Sistema
Variable en la que regresa el
nmero de serie del Sistema
Variable en la que regresa el
versin del Sistema

Descripcin

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error
Esta funcin regresa la licencia del producto.

Ejemplo

Nota: Antes de llamar la funcin fObtieneLicencia se deber llamar la funcin


fInicializaLicenseInfo.
El siguiente cdigo regresa la licencia del producto.
fInicializaLicenseInfo(aSistema)
fObtieneLicencia (aCodActiva, aCodSitio, aSerie, aTagVersion)

Ver tambin

fInicializaLicenseInfo(), fInsertaDatoCompEducativo (),fInsertaDatoAddendaDocto(),


fObtienePassProxy().

fObtienePassProxy ()
Disponibilidad

AdminPAQ 7.3.0. CONTPAQ i FACTURA ELECTRNICA 2.2.1

Sintaxis

fObtienePassProxy(aPassProxy )

Parmetros
Retorna

Nombre
aPassProxy

Tipo
Cadena

Uso
Por referencia

Descripcin
Variable en la que regresa la
contrasea del Proxy

Descripcin

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error
Regresa la contrasea del Proxy.

Ejemplo

El siguiente cdigo regresa la contrasea del Proxy.


fObtienePassProxy (aPassProxy)

Ver tambin

fInsertaDatoCompEducativo (),fInsertaDatoAddendaDocto(), fObtieneLicencia().

Pgina: 103

fTimbraXML ()

Disponibilidad

AdminPAQ 7.3.2

Sintaxis

fTimbraXML( char *aRutaXML, char *aCodConcepto, char *aUUID, char *aRutaDDA, char
*aRutaResultado, char *aPass, char *aRutaFormato );

Parmetros

Retorna
Descripcin

Nombre
aRutaXML

Tipo
Cadena

Uso
Por referencia

aCodConcepto

Cadena

Por referencia

aUUID

Cadena

Por referencia

aRutaDDA

Cadena

Por referencia

aRutaResultado

Cadena

Por referencia

aPass

Cadena

Por referencia

aRutaFormato

Cadena

Por referencia

Descripcin
Variable donde se especifica
la ruta y archivo donde est
ubicado el XML a timbrar.
Variable donde se pasa el
cdigo del concepto a utilizar
para timbrar el XML. Este
concepto deber estar
configurado como CFDI.
Variable donde se regresa el
UUID del XML timbrado.
Variable donde se especifica
la ruta y archivo DDA que
contiene informacin adicional
del XML.
Variable donde se especifica
la ruta donde se generar el
XML, HTML y las imgenes
para la entrega en formato
amigable.
Variable donde se especifica
la contrasea del certificado
para timbrar el XML.
Variable con la ruta y archivo
del formato de impresin.

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error
Esta funcin timbra un XML creado con una aplicacin de un tercero.
El XML deber estar sin emitir, sin sello y sin certificado.

Esta funcin requeire una liciencia de 2 o ms usuarios. Si cuentas con un licenciamiento anual
adems se requeire que la licencia sea multiempresa.
Ejemplo

El siguiente cdigo timbra un XML.


fInicializaLicenseInfo(aSistema)
aRutaXML = C:\CompacW\Empresas\adPrueba\F001.XML
aCodConcepto = 4
aRutaDDA = C:\CompacW\Empresas\adPrueba\ F001.DDA
aPass = 12345678a
aRutaFormato = C:\CompacW\Empresas\adPrueba\Plantilla_Factura_CFDI.htm

Ver tambin

fTimbraXML(aRutaXML, aCodConcepto, aUUID, aRutaDDA, aRutaResultado, aPass,


aRutaFormato )
fInicializaLicenseInfo(), fInsertaDatoCompEducativo (),fInsertaDatoAddendaDocto(),
fObtieneLicencia().

Pgina: 104

fTimbraNominaXML ()
Disponibilidad

AdminPAQ 7.3.3

Sintaxis

fTimbraNominaXML( char *aRutaXML, char *aCodConcepto, char *aUUID, char *aRutaDDA,


char *aRutaResultado, char *aPass, char *aRutaFormato );

Parmetros

Retorna
Descripcin

Nombre
aRutaXML

Tipo
Cadena

Uso
Por referencia

aCodConcepto

Cadena

Por referencia

aUUID

Cadena

Por referencia

aRutaDDA

Cadena

Por referencia

aRutaResultado

Cadena

Por referencia

aPass

Cadena

Por referencia

aRutaFormato

Cadena

Por referencia

Descripcin
Variable donde se especifica
la ruta y archivo donde est
ubicado el XML a timbrar.
Variable donde se pasa el
cdigo del concepto a utilizar
para timbrar el XML. Este
concepto deber estar
configurado como CFDI.
Variable donde se regresa el
UUID del XML timbrado.
Variable donde se especifica
la ruta y archivo DDA que
contiene informacin adicional
del XML.
Variable donde se especifica
la ruta donde se generar el
XML, HTML y las imgenes
para la entrega en formato
amigable.
Variable donde se especifica
la contrasea del certificado
para timbrar el XML.
Variable con la ruta y archivo
del formato de impresin.

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error
Esta funcin timbra un XML de una nmina creado con una aplicacin de un tercero.

El XML deber estar sin emitir, sin sello y sin certificado.


Es obligatorio que el XML lleve el domicilio del emisor.
Si deseas ver en la impresin del formato amigable algn dato del complemento de nmina
se deber insertar en el DDA.
Esta funcin requeire una liciencia de 5 o ms usuarios. Si cuentas con un licenciamiento anual
adems se requeire que la licencia sea multiempresa.
Ejemplo

El siguiente cdigo timbra un XML.


fInicializaLicenseInfo(aSistema)
aRutaXML = C:\CompacW\Empresas\adPrueba\F001.XML
aCodConcepto = 4
aRutaDDA = C:\CompacW\Empresas\adPrueba\ F001.DDA
aPass = 12345678a
aRutaFormato = C:\CompacW\Empresas\adPrueba\Plantilla_Factura_CFDI.htm

Ver tambin

fTimbraNominaXML(aRutaXML, aCodConcepto, aUUID, aRutaDDA, aRutaResultado,


aPass, aRutaFormato )
fInicializaLicenseInfo(), fInsertaDatoCompEducativo (),fInsertaDatoAddendaDocto(),
fObtieneLicencia().

Pgina: 105

FUNCIONES DE DIRECCIONES
Bajo Nivel Lectura/Escritura
fInsertaDireccion ()
Disponibilidad

AdminPAQ 2004.

Sintaxis

fInsertaDireccion ()

Parmetros

No usa.

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error
Adiciona un nuevo registro en la tabla de Direcciones en modo de insercin.

Descripcin
Ejemplo

El siguiente cdigo indica a la aplicacin que inserte un nuevo registro en la tabla de


Direcciones.
fInsertaDireccion ()

Ver tambin

fEditaDireccion ()

fInsertarDocumento(), fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(), fCancelarModificacionDocumento(),

Disponibilidad

AdminPAQ 2004.

Sintaxis

fEditaDireccion ()

Parmetros

No usa.

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error

Descripcin

Activa el modo de Edicin de un registro en la tabla de Direcciones.

Ejemplo

El siguiente cdigo busca la direccin de la empresa, si la encuentra activa el registro en


modo edicin, en caso de no encontrarlo enva el mensaje de error correspondiente
lError = fBuscaDireccionEmpresa ()
If lError <> 0 Then
MensajeError lError
Else
fEditaDireccion ()
End If

Ver tambin

fInsertarDocumento(),fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(),fCancelarModificacionDocumento(),

Pgina: 106

fGuardaDireccion ()
Disponibilidad

AdminPAQ 2004.

Sintaxis

fGuardaDireccion ()

Parmetros

No usa.

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Guarda los cambios realizados a un registro de productos.

Ejemplo

El siguiente cdigo indica a la aplicacin que guarde cierto registro en la tabla de


Direcciones. Esta funcin se llama despus de que se utiliza la funcin fInsertaDireccion () o
fEditaDireccion () y se graban los valores en los campos correspondientes.
fGuardaDireccion ()

Ver tambin

fInsertarDocumento(),fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(), fCancelarModificacionDocumento(),

fCancelarModificacionDireccion ()
Disponibilidad

AdminPAQ 2003.

Sintaxis

fCancelarModificacionDireccion ()

Parmetros

No usa.

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin cancela las modificaciones al registro actual de direcciones. El registro debe estar
en modo de edicin o insercin.

Ejemplo

El siguiente cdigo indica a la aplicacin que cancele la modificacin a un registro de


direccin que estaba en modo de insercin o edicin.
fCancelarModificacionDireccion ()

Ver tambin

fInsertarDocumento(),fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(), fCancelarModificacionDocumento(),

Pgina: 107

fLeeDatoDireccion ()
Disponibilidad

AdminPAQ 2003.

Sintaxis

fLeeDatoDireccion (aCampo, aValr, aLen)

Parmetros

Retorna

Nombre
aCampo
aValor
aLen

Tipo
Cadena
Cadena
Entero

Uso
Por valor
Por referencia
Por valor

Descripcin
Campo destino.
Valor de lectura.
Longitud del dato de lectura.

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.
aValor: Al finalizar la funcin este parmetro contiene el valor del campo especificado.

Descripcin

Esta funcin lee el valor indicado del campo correspondiente en el registro activo de la tabla
de Direcciones.

Ejemplo

El siguiente cdigo busca la direccin de la empresa, en caso de que lo encuentre guarda el


contenido del campo cColonia en la variable la variable lColonia con una longitud de 60
caracteres; en caso contrario muestra el mensaje de error correspondiente.
lError = fBuscaDireccionEmpresa ()
If lError <> 0 Then
MensajeError lError
Else
lError = fLeeDatoDireccion ("cColonia", lColonia, 60)
End If

Ver tambin

fInsertarDocumento(),fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(), fCancelarModificacionDocumento(),

Pgina: 108

fSetDatoDireccion ()
Disponibilidad

AdminPAQ 2003.

Sintaxis

fSetDatoDireccion (aCampo, aValor)

Parmetros

Retorna

Descripcin
Ejemplo

Nombre
aCampo
aValor

Tipo
Cadena
Cadena

Uso
Por valor
Por valor

Descripcin
Campo destino
Valor de escritura

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.
Esta funcin escribe el valor indicado en el campo correspondiente en el registro activo de la
tabla de Cliente / Proveedor.
El siguiente cdigo busca la direccin de la empresa, en caso de que la encuentre escribe el
contenido de la variable lColonia en el campo cColonia de la tabla de direcciones; en caso
contrario muestra el mensaje de error correspondiente.
lError = fBuscaDireccionEmpresa ()
If lError <> 0 Then
MensajeError lError
Else
lError = fSetDatoDireccion ("cColonia ", lColonia)
End If

Ver tambin

fInsertarDocumento(),fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(), fCancelarModificacionDocumento(),

Pgina: 109

Bajo Nivel Bsqueda/Navegacin


fBuscaDireccionEmpresa ()
Disponibilidad

AdminPAQ 2002.

Sintaxis

fBuscaDireccionEmpresa ()

Parmetros
Retorna

No usa.
Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin busca la direccin de la empresa.

Ejemplo

El siguiente cdigo indica a la aplicacin que busque la direccin de la empresa.


lError = fBuscaDireccionEmpresa ()

Ver tambin

fInsertarDocumento(), fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(), fCancelarModificacionDocumento(),

fBuscaDireccionCteProv ()
Disponibilidad

AdminPAQ 2002.

Sintaxis

fBuscaDireccionCteProv (aCodCteProv, aTipoDireccion)

Parmetros

Retorna

Descripcin
Ejemplo

Nombre
aCampo
aValor

Tipo
Cadena
Cadena

Uso
Por valor
Por valor

Descripcin
Cdigo del cliente/proveedor.
Tipo de direccin
0 = Fiscal, 1 = Envo

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.
Esta funcin busca una direccin de un cliente/proveedor.
El siguiente cdigo busca una direccin de un cliente/proveedor, en caso de que la
encuentre se posiciona en el registro encontrado; en caso contrario muestra el mensaje de
error correspondiente.
lError = fBuscaDireccionCteProv (lCodCteProv, lTipoDireccion)
If lError <> 0 Then
MensajeError lError
End If

Ver tambin

fInsertarDocumento(),fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(), fCancelarModificacionDocumento(),

Pgina: 110

fBuscaDireccionDocumento ()
Disponibilidad

AdminPAQ 2002.

Sintaxis

fBuscaDireccionDocumento (aIdDocumento, aTipoDireccion)

Parmetros

Retorna

Descripcin
Ejemplo

Nombre
aIdDocumento
aValor

Tipo
Entero largo
Cadena

Uso
Por valor
Por valor

Descripcin
Identificador del documento.
Tipo de direccin
0 = Fiscal, 1 = Envo

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.
Esta funcin busca una direccin de un documento.
El siguiente cdigo busca una direccin de un documento, en caso de que la encuentre se
posiciona en el registro encontrado; en caso contrario muestra el mensaje de error
correspondiente.
lError = fBuscaDireccionDocumento (lIdDocumento, lTipoDireccion)
If lError <> 0 Then
MensajeError lError
End If

Ver tambin

fInsertarDocumento(),fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(), fCancelarModificacionDocumento(),

Pgina: 111

fPosPrimerDireccion ()
Disponibilidad

AdminPAQ 2002.

Sintaxis

fPosPrimerDireccion ()

Parmetros
Retorna

No usa.
Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin se ubica en el primer registro de la tabla de Direcciones.

Ejemplo

El siguiente cdigo indica a la aplicacin que se posicione en el primer registro de la tabla de


Direcciones.
lError = fPosPrimerDireccion ()

Ver tambin

fInsertarDocumento(), fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(), fCancelarModificacionDocumento(),

fPosUltimaDireccion ()
Disponibilidad

AdminPAQ 2002.

Sintaxis

fPosUltimaDireccion ()

Parmetros
Retorna

No usa.
Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin se ubica en el ultimo registro de la tabla de Direcciones.

Ejemplo

El siguiente cdigo indica a la aplicacin que se posicione en el ultimo registro de la tabla de


Direcciones.
lError = fPosUltimaDireccion ()

Ver tambin

fInsertarDocumento(), fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(), fCancelarModificacionDocumento(),

Pgina: 112

fPosSiguienteDireccion ()
Disponibilidad

AdminPAQ 2002.

Sintaxis

fPosSiguienteDireccion ()

Parmetros
Retorna

No usa.
Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin se ubica en el siguiente registro de la posicin actual de la tabla de Direcciones.

Ejemplo

El siguiente cdigo indica a la aplicacin que se posicione en el siguiente registro de la tabla


de Direcciones.
lError = fPosSiguienteDireccion ()

Ver tambin

fInsertarDocumento(), fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(), fCancelarModificacionDocumento(),

fPosAnteriorDireccion ()
Disponibilidad

AdminPAQ 2002.

Sintaxis

fPosAnteriorDireccion ()

Parmetros

No usa.

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin se ubica en el registro anterior de la posicin actual de la tabla de Direcciones.

Ejemplo

El siguiente cdigo indica a la aplicacin que se posicione en el registro anterior de la tabla


de Direcciones.
lError = fPosAnteriorDireccion ()

Ver tambin

fInsertarDocumento(), fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(), fCancelarModificacionDocumento(),

Pgina: 113

fPosBOFDireccion ()
Disponibilidad

AdminPAQ 2002.

Sintaxis

fPosBOFDireccion ()

Parmetros
Retorna

No usa.
Valores enteros:
1 (uno) Verdadero.
0 (cero) Falso.

Descripcin

Informa si el registro activo se encuentra en el inicio de la tabla de Direcciones.

Ejemplo

El siguiente cdigo indica a la aplicacin que asigne a la variable lInicioTablaDirs el resultado


de la funcin fPosBOFDireccion.
lInicioTablaDirs = fPosBOFDireccion ()

Ver tambin

fInsertarDocumento(), fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(), fCancelarModificacionDocumento(),

fPosEOFDireccion ()
Disponibilidad

AdminPAQ 2002.

Sintaxis

fPosEOFDireccion ()

Parmetros
Retorna

No usa.
Valores enteros:
1 (uno) Verdadero.
0 (cero) Falso.

Descripcin

Informa si el registro activo se encuentra en el fin de la tabla de Direcciones

Ejemplo

El siguiente cdigo indica a la aplicacin que asigne a la variable lFinTablaDirs el resultado


de la funcin fPosEOFDireccion.
lFinTablaDirs = fPosEOFDireccion ()

Ver tambin

fInsertarDocumento(), fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(), fCancelarModificacionDocumento(),

Pgina: 114

Alto Nivel Lectura/Escritura


fAltaDireccion ()
Disponibilidad

AdminPAQ 2003.

Sintaxis

fAltaDireccion (aIdDireccion, astDireccion)

Parmetros

Retorna

Nombre
aIdDireccion
astDireccion

Tipo
Entero
tDireccion

Uso
Por referencia
Por valor

Descripcin
Identificador de la direccin.
Tipo de dato abstracto.

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

aIdDireccion: Al finalizar la funcin este parmetro contiene el identificador del nuevo


producto.
Esta funcin da de alta una nueva direccin.

Ejemplo

El siguiente cdigo da de alta una nueva direccin.


fAltaDireccion (lIdDireccion, ltDireccion)

Ver tambin

fInsertarDocumento(),fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(),fCancelarModificacionDocumento(),

Importante: Al usar esta funcin de alto nivel es necesario asignar al campo cTipoDireccion alguno de los
siguientes valores: 1 = Domicilio Fiscal, 2 = Domicilio Envo

Pgina: 115

fActualizaDireccion ()
Disponibilidad

AdminPAQ 2004.

Sintaxis

fActualizaProducto (astDireccion)

Parmetros

Nombre
astDireccion

Tipo
tDireccion

Uso
Por valor

Descripcin
Tipo de dato abstracto.

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin actualiza la direccin del registro de Cliente/Proveedor activo.

Ejemplo

El siguiente cdigo actualiza la direccin del registro de Cliente/Proveedor activo.


fActualizaProducto (ltDireccion)

Ver tambin

fInsertarDocumento(),fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(),fCancelarModificacionDocumento(),

Importante: Al usar esta funcin de alto nivel es necesario asignar al campo cTipoDireccion alguno de los
siguientes valores: 1 = Domicilio Fiscal, 2 = Domicilio Envo

fLlenaRegistroDireccion ()
Disponibilidad

AdminPAQ 2004.

Sintaxis

fLlenaRegistroDireccion (astDireccion, aEsAlta )

Parmetros

Nombre
astDireccion
aEsAlta

Tipo
tDireccion
Entero

Uso
Por valor
Por valor

Descripcin
Tipo de dato abstracto.
1 = Nueva direccin.
2 = Actualizacin.

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin aigna al registro de la base de datos los valores de la estructura de datos de la
Direccin.
El siguiente cdigo da de alta una nueva direccin.

Ejemplo

fLlenaRegistroDireccion (ltDireccion, 1)

Ver tambin

fInsertarDocumento(),fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(),fCancelarModificacionDocumento(),

Importante: Al usar esta funcin de alto nivel es necesario asignar al campo cTipoDireccion alguno de los
siguientes valores: 1 = Domicilio Fiscal, 2 = Domicilio Envo

Pgina: 116

FUNCIONES DE EXISTENCIAS
Bajo Nivel Lectura/Escritura
fRegresaExistencia ()
Disponibilidad

AdminPAQ 2003.

Sintaxis

fRegresaExistencia (aCodigoProducto, aCodigoAlmacen, aAnio, aMes, aDia, aExistencia)

Parmetros

Retorna

Nombre
aCodigoProducto
aCodigoAlmacen
aAnio
aMes
aDia
aExistencia

Tipo
Cadena
Cadena
Cadena
Cadena
Cadena
Doble

Uso
Por valor
Por valor
Por valor
Por valor
Por valor
Por referencia

Descripcin
Cdigo del producto.
Cdigo del almacn.
Ao.
Mes.
Da.
Existencia

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.
aExistencia: Al finalizar la funcin este parmetro contiene la existencia del producto
requerido.

Descripcin

Esta funcin regresa la existencia de un producto en un almacn a una determinada fecha.

Ejemplo

El siguiente cdigo obtiene la existencia de determinado producto en cierto almacn, en la


fecha especificada.
lError = fRegresaExistencia (lCodigoProducto, lCodigoAlmacen, lAnio, lMes, lDia, lExistencia)
If lError <> 0 Then
MensajeError lError
End If

Ver tambin

fInsertarDocumento(),fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(), fCancelarModificacionDocumento(),

Pgina: 117

fRegresaExistenciaCaracteristicas ()
Disponibilidad

AdminPAQ 2003.

Sintaxis

fRegresaExistenciaCaracteristicas (aCodigoProducto, aCodigoAlmacen, aAnio, aMes, aDia,


aValorCaracteristica1, aValorCaracteristica2,
aValorCaracteristica3, aExistencia)
Nombre
Tipo
Uso
Descripcin
aCodigoProducto
Cadena
Por valor
Cdigo del producto.
aCodigoAlmacen
Cadena
Por valor
Cdigo del almacn.
aAnio
Cadena
Por valor
Ao.
aMes
Cadena
Por valor
Mes.
aDia
Cadena
Por valor
Da.
aValorCaracteristica1
Cadena
Por valor
Valor caracterstica 1.
aValorCaracteristica2
Cadena
Por valor
Valor caracterstica 2.
aValorCaracteristica3
Cadena
Por valor
Valor caracterstica 3.
aExistencia
Doble
Por referencia
Existencia

Parmetros

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.
aExistencia: Al finalizar la funcin este parmetro contiene la existencia del producto
requerido.

Descripcin

Esta funcin regresa la existencia de un producto con caractersticas en un almacn a una


determinada fecha.

Ejemplo

El siguiente cdigo obtiene la existencia de determinado producto con caractersticas en


cierto almacn, en la fecha especificada.
lError = fRegresaExistenciaCaracteristicas (lCodigoProducto, lCodigoAlmacen, lAnio, lMes, lDia,
lValorCaracteristica1, lValorCaracteristica2, lValorCaracteristica3, lExistencia)
If lError <> 0 Then
MensajeError lError
End If

Ver tambin

fInsertarDocumento(),fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(), fCancelarModificacionDocumento(),

Pgina: 118

FUNCIONES DE COSTO HISTRICO


Bajo Nivel Lectura/Escritura
fRegresaCostoPromedio ()
Disponibilidad

AdminPAQ 2003.

Sintaxis

fRegresaCostoPromedio (aCodigoProducto, aCodigoAlmacen, aAnio, aMes, aDia,


aCostoPromedio)
Nombre
Tipo
Uso
Descripcin
aCodigoProducto
Cadena
Por valor
Cdigo del producto.
aCodigoAlmacen
Cadena
Por valor
Cdigo del almacn.
0 (cero) Todos los almacenes.
aAnio
Cadena
Por valor
Ao.
aMes
Cadena
Por valor
Mes.
aDia
Cadena
Por valor
Da.
aCostoPromedio
Cadena
Por referencia Costo promedio

Parmetros

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.
aCostoPromedio: Al finalizar la funcin este parmetro contiene el costo promedio del
producto requerido.

Descripcin

Esta funcin se encarga de obtener el costo promedio de un producto en determinada fecha


para todos los almacenes o para uno solo.

Ejemplo

El siguiente cdigo obtiene el costo promedio de un producto en una fecha para todos los
almacenes o para uno solo.
lError = fRegresaCostoPromedio (lCodigoProducto, lCodigoAlmacen, lAnio, lMes, lDia, lCostoP)
If lError <> 0 Then
MensajeError lError
End If

Ver tambin

fInsertarDocumento(),fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(), fCancelarModificacionDocumento(),

Pgina: 119

fRegresaUltimoCosto ()
Disponibilidad

AdminPAQ 2003.

Sintaxis

fRegresaUltimoCosto (aCodigoProducto, aCodigoAlmacen, aAnio, aMes, aDia,


aUltimoCosto)
Nombre
Tipo
Uso
Descripcin
aCodigoProducto
Cadena
Por valor
Cdigo del producto.
aCodigoAlmacen
Cadena
Por valor
Cdigo del almacn.
0 (cero) Todos los almacenes.
aAnio
Cadena
Por valor
Ao.
aMes
Cadena
Por valor
Mes.
aDia
Cadena
Por valor
Da.
aUltimoCosto
Cadena
Por referencia Ultimo costo.

Parmetros

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.
aUltimoCosto: Al finalizar la funcin este parmetro contiene el ultimo costo del producto
requerido.

Descripcin

Esta funcin se encarga de obtener el ltimo costo de un producto en determinada fecha


para todos los almacenes o para uno solo.

Ejemplo

El siguiente cdigo obtiene el ltimo costo de un producto en una fecha para todos los
almacenes o para uno solo.
lError = fRegresaCostoPromedio (lCodigoProducto, lCodigoAlmacen, lAnio, lMes, lDia, lCostoU)
If lError <> 0 Then
MensajeError lError
End If

Ver tambin

fInsertarDocumento(),fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(), fCancelarModificacionDocumento(),

Pgina: 120

fRegresaCostoEstandar ()
Disponibilidad

AdminPAQ 2003.

Sintaxis

fRegresaCostoEstandar (aCodigoProducto, aCostoEstandar)

Parmetros

Retorna

Nombre
aCodigoProducto
aCostoEstandar

Tipo
Cadena
Cadena

Uso
Por valor
Por referencia

Descripcin
Cdigo del producto.
Costo estndar.

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.
aCostoEstandar: Al finalizar la funcin este parmetro contiene el costo estndar del producto
requerido.

Descripcin

Esta funcin se encarga de obtener el costo estndar de un producto.

Ejemplo

El siguiente cdigo obtiene el costo estndar de un producto.


lError = fRegresaCostoEstandar (lCodigoProducto, lCostoEstandar)
If lError <> 0 Then
MensajeError lError
End If

Ver tambin

fInsertarDocumento(),fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(), fCancelarModificacionDocumento(),

Pgina: 121

fRegresaCostoCapa ()
Disponibilidad

AdminPAQ 2003.

Sintaxis

fRegresaCostoCapa (aCodigoProducto, aCodigoAlmacen, aUnidades, aImporteCosto)

Parmetros

Retorna

Nombre
aCodigoProducto
aCodigoAlmacen
aUnidades
aImporteCosto

Tipo
Cadena
Cadena
Doble
Cadena

Uso
Por valor
Por valor
Por valor
Por referencia

Descripcin
Cdigo del producto.
Cdigo del almacn.
Unidades a costear.
Importe del costo de la
unidades recibidas.

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.
aImporteCosto: Al finalizar la funcin este parmetro contiene el costo UEPS o PEPS del
producto requerido.

Descripcin

Esta funcin obtiene el costo UEPS o PEPS de un producto en un almacn en base a una
cantidad de unidades proporcionadas.

Ejemplo

El siguiente cdigo obtiene el costo UEPS o PEPS de un producto en un almacn en base a


una cantidad de unidades proporcionadas.

Ver tambin

lError = fRegresaCostoCapa (lCodigoProducto, lCodigoAlmacen, lUnidades, lImporteCosto)


If lError <> 0 Then
MensajeError lError
End If

fInsertarDocumento(),fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(), fCancelarModificacionDocumento(),

Pgina: 122

FUNCIONES DE CONCEPTOS DE DOCUMENTOS


Bajo Nivel Lectura/Escritura
fLeeDatoConceptoDocto ()
Disponibilidad

AdminPAQ 2003.

Sintaxis

fLeeDatoConceptoDocto (aCampo, aValor, aLen)

Parmetros

Retorna

Nombre
aCampo
aValor
aLen

Tipo
Cadena
Cadena
Entero

Uso
Por valor
Por referencia
Por valor

Descripcin
Campo destino.
Valor de lectura.
Longitud del dato de lectura.

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.
aValor: Al finalizar la funcin este parmetro contiene el valor del campo especificado.

Descripcin

Esta funcin lee un campo del registro actual de conceptos documentos.

Ejemplo

El siguiente cdigo busca un concepto por su cdigo, en caso de que lo encuentre guarda el
contenido del campo cNombreC01 en la variable la variable lNombreC con una longitud de
60 caracteres; en caso contrario muestra el mensaje de error correspondiente.
lError = fBuscaConceptoDocto (lCodConcepto)
If lError <> 0 Then
MensajeError lError
Else
lError = fLeeDatoConceptoDocto ("cNombreC01", lNombreC, 60)
End If

Ver tambin

fInsertarDocumento(),fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(), fCancelarModificacionDocumento(),

Pgina: 123

fRegresPorcentajeImpuesto ()
Disponibilidad

AdminPAQ 2003.

Sintaxis

fRegresPorcentajeImpuesto (aIdConceptoDocumento, aIdClienteProveedor, aIdProducto,


aPorcentajeImpuesto)
Nombre
Tipo
Uso
Descripcin
aIdConceptoDocumento
Entero
Por valor
Identificador del concepto
del documento.
aIdClienteProveedor
Entero
Por valor
Identificador del cliente o
proveedor.
aIdProducto
Entero
Por valor
Identificador del producto.
aPorcentajeImpuesto
Doble
Por referencia Porcentaje de impuesto.

Parmetros

Retorna

Descripcin
Ejemplo

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.
aPorcentajeImpuesto: Al finalizar la funcin este parmetro contiene el porcentaje del
impuesto requerido.
Esta funcin regresa el porcentaje de impuesto de un concepto documento, del cual se
obtiene su configuracin y se busca el porcentaje de la tabla de Clientes/Proveedores,
Productos o de Parmetros generales.
El siguiente cdigo obtiene el porcentaje de impuesto para el concepto de un documento.
lError = fRegresPorcentajeImpuesto (lIdConceptoDocumento, lIdClienteProveedor, lIdProducto,
lPorcentajeImpuesto)

Ver tambin

fInsertarDocumento(),fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(), fCancelarModificacionDocumento(),

Pgina: 124

fEditaConceptoDocto()
Disponibilidad

AdminPAQ 2011. Versin 6.2.3

Sintaxis

fEditaConceptoDocto ()

Parmetros

No recibe parmetros.

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin activa el modo de edicin de un registro del catlogo Conceptos.

Ejemplo

El siguiente cdigo:

Busca el concepto con la funcin fBuscaConceptoDocto.


Abre la edicin de ese concepto con la funcin fEditaConceptoDocto.
Asigna al campo CSERIEPO01 el contenido de la variable lSerie.
Asigna al campo CIDDIRSUCU el contenido de la variable lDireccion.
Guarda los cambios al concepto con la funcin fGuardaConceptoDocto.

lerror = fBuscaConceptoDocto(lConcepto)
lerror = fEditaConceptoDocto
lerror = fSetDatoConceptoDocto("CSERIEPO01", lSerie)
lerror = fSetDatoConceptoDocto("CIDDIRSUCU", lDireccion)
lerror = fGuardaConceptoDocto()

Ver tambin

fBuscaConceptoDocto(),fSetDatoConceptoDocto(), fGuardaConceptoDocto()

Pgina: 125

fSetDatoConceptoDocto ()
Disponibilidad

AdminPAQ 2011. Versin 6.2.3

Sintaxis

fSetDatoConceptoDocto (const char *aCampo, char *aValor)

Parmetros

Nombre
aCampo
aValor

Tipo
Cadena
Cadena

Uso
Por referencia
Por referencia

Descripcin
Nombre del campo
Valor del campo

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin escribe el valor indicado en el campo correspondiente en el registro activo de la


tabla Conceptos.
El siguiente cdigo:

Ejemplo

Busca el concepto con la funcin fBuscaConceptoDocto.


Abre la edicin de ese concepto con la funcin fEditaConceptoDocto.
Asigna al campo CSERIEPO01 el contenido de la variable lSerie.
Asigna al campo CIDDIRSUCU el contenido de la variable lDireccion.
Guarda los cambios al concepto con la funcin fGuardaConceptoDocto.

lerror = fBuscaConceptoDocto(lConcepto)
lerror = fEditaConceptoDocto
lerror = fSetDatoConceptoDocto("CSERIEPO01", lSerie)
lerror = fSetDatoConceptoDocto("CIDDIRSUCU", lDireccion)
lerror = fGuardaConceptoDocto()

Ver tambin

fBuscaConceptoDocto(), fEditaConceptoDocto(), fGuardaConceptoDocto()

Pgina: 126

fGuardaConceptoDocto()
Disponibilidad

AdminPAQ 2011. Versin 6.2.3

Sintaxis

fGuardaConceptoDocto()

Parmetros

No recibe parmetros.

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin guarda los cambios efectuados al registro de la tabla Conceptos.

Ejemplo

El siguiente cdigo:

Busca el concepto con la funcin fBuscaConceptoDocto.


Abre la edicin de ese concepto con la funcin fEditaConceptoDocto.
Asigna al campo CSERIEPO01 el contenido de la variable lSerie.
Asigna al campo CIDDIRSUCU el contenido de la variable lDireccion.
Guarda los cambios al concepto con la funcin fGuardaConceptoDocto.

lerror = fBuscaConceptoDocto(lConcepto)
lerror = fEditaConceptoDocto
lerror = fSetDatoConceptoDocto("CSERIEPO01", lSerie)
lerror = fSetDatoConceptoDocto("CIDDIRSUCU", lDireccion)
lerror = fGuardaConceptoDocto()

Ver tambin

fBuscaConceptoDocto(), fEditaConceptoDocto(), fSetDatoConceptoDocto()

Pgina: 127

Bajo Nivel Bsqueda/Navegacin


fBuscaConceptoDocto ()
Disponibilidad

AdminPAQ 2003.

Sintaxis

fBuscaConceptoDocto (aCodConcepto)

Parmetros

Nombre
aCodConcepto

Tipo
Cadena

Uso
Por valor

Descripcin
Cdigo del concepto.

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin busca un concepto por su cdigo.

Ejemplo

El siguiente cdigo busca un concepto por su cdigo.


fBuscaConceptoDocto (lCodConcepto)

Ver tambin

fInsertarDocumento(),fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(),fCancelarModificacionDocumento(),

fBuscaIdConceptoDocto ()
Disponibilidad

AdminPAQ 2003.

Sintaxis

fBuscaIdConceptoDocto (aIdConcepto)

Parmetros

Nombre
aIdConcepto

Tipo
Entero

Uso
Por valor

Descripcin
Identificador del concepto.

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin busca un concepto por su Identificador.

Ejemplo

El siguiente cdigo busca un concepto por su identificador.


fBuscaIdConceptoDocto (lIdConcepto)

Ver tambin

fInsertarDocumento(),fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(),fCancelarModificacionDocumento(),

Pgina: 128

fPosPrimerConceptoDocto ()
Disponibilidad

AdminPAQ 2003.

Sintaxis

fPosPrimerConceptoDocto ()

Parmetros
Retorna

No usa.
Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin se ubica en el primer registro de la tabla de Conceptos.

Ejemplo

El siguiente cdigo indica a la aplicacin que se posicione en el primer registro de la tabla de


Conceptos.
lError = fPosPrimerConceptoDocto ()

Ver tambin

fInsertarDocumento(), fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(), fCancelarModificacionDocumento(),

fPosUltimaConceptoDocto ()
Disponibilidad

AdminPAQ 2003.

Sintaxis

fPosUltimaConceptoDocto ()

Parmetros
Retorna

No usa.
Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin se ubica en el ultimo registro de la tabla de Conceptos.

Ejemplo

El siguiente cdigo indica a la aplicacin que se posicione en el ultimo registro de la tabla de


Conceptos.
lError = fPosUltimaConceptoDocto ()

Ver tambin

fInsertarDocumento(), fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(), fCancelarModificacionDocumento(),

Pgina: 129

fPosSiguienteConceptoDocto ()
Disponibilidad

AdminPAQ 2003.

Sintaxis

fPosSiguienteConceptoDocto ()

Parmetros
Retorna

No usa.
Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin se ubica en el siguiente registro de la posicin actual de la tabla de Conceptos.

Ejemplo

El siguiente cdigo indica a la aplicacin que se posicione en el siguiente registro de la tabla


de Conceptos.
lError = fPosSiguienteConceptoDocto ()

Ver tambin

fInsertarDocumento(), fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(), fCancelarModificacionDocumento(),

fPosAnteriorConceptoDocto ()
Disponibilidad

AdminPAQ 2003.

Sintaxis

fPosAnteriorConceptoDocto ()

Parmetros

No usa.

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin se ubica en el registro anterior de la posicin actual de la tabla de Conceptos.

Ejemplo

El siguiente cdigo indica a la aplicacin que se posicione en el registro anterior de la tabla


de Conceptos.
lError = fPosAnteriorConceptoDocto ()

Ver tambin

fInsertarDocumento(), fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(), fCancelarModificacionDocumento(),

Pgina: 130

fPosBOFConceptoDocto ()
Disponibilidad

AdminPAQ 2003.

Sintaxis

fPosBOFConceptoDocto ()

Parmetros
Retorna

No usa.
Valores enteros:
1 (uno) Verdadero.
0 (cero) Falso.

Descripcin

Informa si el registro activo se encuentra en el inicio de la tabla de Conceptos.

Ejemplo

El siguiente cdigo indica a la aplicacin que asigne a la variable lInicioTablaConcepto el


resultado de la funcin fPosBOFConceptoDocto.
lInicioTablaConcepto = fPosBOFConceptoDocto ()

Ver tambin

fInsertarDocumento(), fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(), fCancelarModificacionDocumento(),

fPosEOFConceptoDocto ()
Disponibilidad

AdminPAQ 2003.

Sintaxis

fPosEOFConceptoDocto ()

Parmetros
Retorna

No usa.
Valores enteros:
1 (uno) Verdadero.
0 (cero) Falso.

Descripcin

Informa si el registro activo se encuentra en el fin de la tabla de Conceptos

Ejemplo

El siguiente cdigo indica a la aplicacin que asigne a la variable lFinTablaConcepto el


resultado
de la funcin fPosEOFConceptoDocto.

Ver tambin

fInsertarDocumento(), fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(), fCancelarModificacionDocumento(),

lFinTablaConcepto = fPosEOFConceptoDocto ()

Pgina: 131

Funciones de Parametros
Bajo Nivel Lectura/Escritura
fLeeDatoParametros ()
Disponibilidad

AdminPAQ 2003.

Sintaxis

fLeeDatoParametros (aCampo, aValor, aLen)

Parmetros

Retorna

Nombre
aCampo
aValor
aLen

Tipo
Cadena
Cadena
Entero

Uso
Por valor
Por referencia
Por valor

Descripcin
Campo destino.
Valor de lectura.
Longitud del dato de lectura.

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.
aValor: Al finalizar la funcin este parmetro contiene el valor del campo especificado.

Descripcin

Esta funcin lee un campo del registro actual de parametros.

Ejemplo

El siguiente cdigo busca un concepto por su cdigo, en caso de que lo encuentre guarda el
contenido del campo cRFCEmpr01en la variable la variable lRFC con una longitud de 60
caracteres; en caso contrario muestra el mensaje de error correspondiente.
lError = fLeeDatoParametros ("cRFCEmpr01", lRFC, 60)

Ver tambin

fInsertarDocumento(),fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(), fCancelarModificacionDocumento(),

fEditaParametros ()
Disponibilidad

AdminPAQ 2.2.0 CONTPAQ i FACTURA ELECTRNICA 1.0.0

Sintaxis

fEditaParametros ()

Parmetros

No recibe parmetros.

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin activa el modo de edicin de un registro de los Parmetros.

Ejemplo

El siguiente cdigo:

Abre la edicin de los parmetros con la funcin fEditaParametros.


Asigna al campo cRFCEmpr01 el contenido de la variable lRFC.

Guarda los cambios a los parmetros con la funcin fGuardaParametros.

lerror = fEditaParametros
lerror = fSetDatoParametros ("cRFCEmpr01", lRFC)
lerror = fGuardaParametros ()

Ver tambin

fLeeDatoParametros(), fGuardaParametros(), fSetDatoParametros()

Pgina: 132

fSetDatoParametros ()
Disponibilidad

AdminPAQ 2.4.0, CONTPAQ i FACTURA ELECTRNICA 1.0.0

Sintaxis

fSetDatoParametros(aCampo, aValor )

Parmetros

Nombre
aCampo
aValor

Tipo
Cadena
Cadena

Uso
Por referencia
Por referencia

Descripcin
Nombre del campo
Valor del campo

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin escribe el valor indicado en el campo correspondiente en el registro activo de la


tabla Parmetros.
El siguiente cdigo:

Ejemplo

Abre la edicin de los parmetros con la funcin fEditaParametros.


Asigna al campo cRFCEmpr01 el contenido de la variable lRFC.

Guarda los cambios a los parmetros con la funcin fGuardaParametros.

lerror = fEditaParametros
lerror = fSetDatoParametros ("cRFCEmpr01", lRFC)
lerror = fGuardaParametros ()

Ver tambin

fLeeDatoParametros(), fGuardaParametros(), fSetDatoParametros()

fGuardaParametros ()
Disponibilidad

AdminPAQ 2.4.0. CONTPAQ i FACTURA ELECTRNICA 1.0.0

Sintaxis

fGuardaParametros()

Parmetros

No recibe parmetros.

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin guarda los cambios efectuados al registro de la tabla Parmetros.

Ejemplo

El siguiente cdigo:

Abre la edicin de los parmetros con la funcin fEditaParametros.


Asigna al campo cRFCEmpr01 el contenido de la variable lRFC.

Guarda los cambios a los parmetros con la funcin fGuardaParametros.

lerror = fEditaParametros
lerror = fSetDatoParametros ("cRFCEmpr01", lRFC)
lerror = fGuardaParametros ()

Ver tambin

fLeeDatoParametros(), fGuardaParametros(), fSetDatoParametros()

Pgina: 133

FUNCIONES DEL CATLOGO DE CLASIFICACIONES


Bajo Nivel Lectura/Escritura
fEditaClasificacion ()
Disponibilidad

AdminPAQ 2004.

Sintaxis

fEditaClasificacion ()

Parmetros

No usa.

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error

Descripcin

Activa el modo de Edicin de un registro en la tabla de Clasificaciones.

Ejemplo

El siguiente cdigo clasificacin por su identificador, si la encuentra activa el registro en modo


edicin, en caso de no encontrarlo enva el mensaje de error correspondiente
lError = fBuscaIdClasificacion (lIdClasificacion)
If lError <> 0 Then
MensajeError lError
Else
fEditaClasificacion ()
End If

Ver tambin

fInsertarDocumento(),fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(),fCancelarModificacionDocumento(),

fGuardaClasificacion ()
Disponibilidad

AdminPAQ 2003.

Sintaxis

fGuardaClasificacion ()

Parmetros

No usa.

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Guarda los cambios realizados a un registro de clasificaciones.

Ejemplo

El siguiente cdigo indica a la aplicacin que guarde cierto registro en la tabla de


Clasificaciones. Esta funcin se llama despus de que se utiliza la funcin fInsertaDireccion () o
fEditaDireccion () y se graban los valores en los campos correspondientes.
fGuardaClasificacion ()

Ver tambin

fInsertarDocumento(),fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(), fCancelarModificacionDocumento(),

Pgina: 134

fCancelarModificacionClasificacion ()
Disponibilidad

AdminPAQ 2003.

Sintaxis

fCancelarModificacionClasificacion ()

Parmetros

No usa.

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin cancela las modificaciones al registro actual de clasificaciones. El registro debe
estar en modo de edicin o insercin.

Ejemplo

El siguiente cdigo indica a la aplicacin que cancele la modificacin a un registro de


clasificaciones que estaba en modo de insercin o edicin.
fCancelarModificacionClasificacion()

Ver tambin

fInsertarDocumento(),fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(), fCancelarModificacionDocumento(),

fActualizaClasificacion ()
Disponibilidad

AdminPAQ 2004.

Sintaxis

fActualizaClasificacion (aClasificacionDe, aNumClasificacion, aNombreClasificacion)

Parmetros

Nombre
aClasificacionDe

Tipo
Entero

aNumClasificacion
Entero
aNombreClasificacion Cadena

Uso
Por valor

Por valor
Por valor

Descripcin
Clasificacin de
1 Agente
2 Cliente
3 Proveedor 4 Almacen
5 Producto.
Numero de la clasificacion (1-6)
Texto a actualizar en la clasificacin.

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin actualiza la direccin del registro de Cliente/Proveedor activo.

Ejemplo

El siguiente cdigo actualiza la direccin del registro de Cliente/Proveedor activo.


fActualizaClasificacion (ltDireccion)

Ver tambin

fInsertarDocumento(),fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(),fCancelarModificacionDocumento(),

Pgina: 135

fLeeDatoClasificacion ()
Disponibilidad

AdminPAQ 2003.

Sintaxis

fLeeDatoClasificacion (aCampo, aValr, aLen)

Parmetros

Retorna

Nombre
aCampo
aValor
aLen

Tipo
Cadena
Cadena
Entero

Uso
Por valor
Por referencia
Por valor

Descripcin
Campo destino.
Valor de lectura.
Longitud del dato de lectura.

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.
aValor: Al finalizar la funcin este parmetro contiene el valor del campo especificado.

Descripcin

Esta funcin lee el valor indicado del campo correspondiente en el registro activo de la tabla
de Clasificaciones.

Ejemplo

El siguiente cdigo busca la direccin de la empresa, en caso de que lo encuentre guarda el


contenido del campo cNombreC01 en la variable la variable lClasif con una longitud de 60
caracteres; en caso contrario muestra el mensaje de error correspondiente.
lError = fBuscaIdClasificacion ()
If lError <> 0 Then
MensajeError lError
Else
lError = fLeeDatoClasificacion ("cNombreC01", lClasif, 60)
End If

Ver tambin

fInsertarDocumento(),fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(), fCancelarModificacionDocumento(),

Pgina: 136

fSetDatoClasificacion ()
Disponibilidad

AdminPAQ 2003.

Sintaxis

fSetDatoClasificacion (aCampo, aValor)

Parmetros

Retorna

Descripcin
Ejemplo

Nombre
aCampo
aValor

Tipo
Cadena
Cadena

Uso
Por valor
Por valor

Descripcin
Campo destino
Valor de escritura

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.
Esta funcin escribe el valor indicado en el campo correspondiente en el registro activo de la
tabla de Clasificaciones.
El siguiente cdigo busca la direccin de la empresa, en caso de que la encuentre escribe el
contenido de la variable lClasif en el campo cNombreC01 de la tabla de direcciones; en caso
contrario muestra el mensaje de error correspondiente.
lError = fBuscaDireccionEmpresa ()
If lError <> 0 Then
MensajeError lError
Else
lError = fSetDatoClasificacion ("cNombreC01 ", lClasif)
End If

Ver tambin

fInsertarDocumento(),fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(), fCancelarModificacionDocumento(),

Pgina: 137

Bajo Nivel Bsqueda/Navegacin


fBuscaClasificacion ()
Disponibilidad

AdminPAQ 2003.

Sintaxis

fBuscaClasificacion (aClasificacionDe, aNumClasificacion)

Parmetros

Nombre
aClasificacionDe

Tipo
Entero

Uso
Por valor

aNumClasificacion

Entero

Por valor

Descripcin
Clasificacin de
1 Agente
2 Cliente
3 Proveedor 4 Almacen
5 Producto.
Numero de la clasificacion (1-6)

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin busca una clasificacion de acuerdo a los parmetros recibidos y se posiciona en
el registro correspondiente.
El siguiente cdigo busca una clasificacin.

Ejemplo

fBuscaClasificacion (lClasificacionDe, lNumClasificacion)

Ver tambin

fInsertarDocumento(),fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(),fCancelarModificacionDocumento(),

fBuscaIdClasificacion ()
Disponibilidad

AdminPAQ 2003.

Sintaxis

fBuscaIdClasificacion (aIdClasificacion)

Parmetros

Nombre
aIdClasificacion

Tipo
Entero

Uso
Por valor

Descripcin
Identificador del concepto.

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin busca un concepto por su Identificador.

Ejemplo

El siguiente cdigo busca un concepto por su identificador.


fBuscaIdClasificacion (lIdClasificacion)

Ver tambin

fInsertarDocumento(),fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(),fCancelarModificacionDocumento(),

Pgina: 138

fPosPrimerClasificacion ()
Disponibilidad

AdminPAQ 2.2.0, CONTPAQ i FACTURA ELECTRNICA 1.0.0

Sintaxis

fPosPrimerClasificacion()

Parmetros
Retorna

No usa.
Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin se ubica en el primer registro de la tabla Clasificaciones.

Ejemplo

El siguiente cdigo indica a la aplicacin que se posicione en el primer registro de la tabla


Clasificaciones.
lError = fPosPrimerClasificacion ()

Ver tambin

fBuscaIdClasificacion(), fBuscaClasificacion()

fPosUltimoClasificacion ()
Disponibilidad

AdminPAQ 2.2.0, CONTPAQ i FACTURA ELECTRNICA 1.0.0.

Sintaxis

fPosUltimoClasificacion()

Parmetros
Retorna

No usa.
Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin se ubica en el ltimo registro de la tabla Clasificaciones.

Ejemplo

El siguiente cdigo indica a la aplicacin que se posicione en el ltimo registro de la tabla


Clasificaciones.
fPosUltimoClasificacion ()

Ver tambin

fBuscaIdClasificacion(), fBuscaClasificacion()

fPosSiguienteClasificacion ()
Disponibilidad

AdminPAQ 2.2.0, CONTPAQ i FACTURA ELECTRNICA 1.0.0.

Sintaxis

fPosSiguienteClasificacion()

Parmetros
Retorna

No usa.
Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin se ubica en el siguiente registro de la posicin actual de la tabla Clasificaciones.

Ejemplo

El siguiente cdigo indica a la aplicacin que se posicione en el siguiente registro de la tabla


Clasificaciones.
lError = fPosSiguienteClasificacion ()

Ver tambin

fBuscaIdClasificacion(), fBuscaClasificacion()

Pgina: 139

fPosAnteriorClasificacion ()
Disponibilidad

AdminPAQ 2.2.0, CONTPAQ i FACTURA ELECTRNICA 1.0.0.

Sintaxis

fPosAnteriorClasificacion()

Parmetros

No usa.

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin se ubica en el registro anterior de la posicin actual de la tabla Clasificaciones.

Ejemplo

El siguiente cdigo indica a la aplicacin que se posicione en el registro anterior de la tabla


Clasificaciones.
lError = fPosAnteriorClasificacion ()

Ver tambin

fBuscaIdClasificacion(), fBuscaClasificacion()

fPosBOFClasificacion ()
Disponibilidad

AdminPAQ 2.2.0, CONTPAQ i FACTURA ELECTRNICA 1.0.0.

Sintaxis

fPosBOFClasificacion()

Parmetros
Retorna

No usa.
Valores enteros:
1 (uno) Verdadero.
0 (cero) Falso.

Descripcin

Informa si el registro activo se encuentra en el inicio de la tabla Clasificaciones.

Ejemplo

El siguiente cdigo indica a la aplicacin que asigne a la variable lInicioTablaVC el resultado


de la funcin fPosBOFClasificacion.
lInicioTablaC = fPosBOFClasificacion ()

Ver tambin

fBuscaIdClasificacion(), fBuscaClasificacion()

fPosEOFClasificacion ()
Disponibilidad

AdminPAQ 2.2.0, CONTPAQ i FACTURA ELECTRNICA 1.0.0..

Sintaxis

fPosEOFClasificacion()

Parmetros
Retorna

No usa.
Valores enteros:
1 (uno) Verdadero.
0 (cero) Falso.

Descripcin

Informa si el registro activo se encuentra en el fin de la tabla Clasificaciones.

Ejemplo

El siguiente cdigo indica a la aplicacin que asigne a la variable lFinTablaVC el resultado


de la funcin fPosEOFClasificacion.
lFinTablaC = fPosEOFClasificacion()

Ver tambin

fBuscaIdClasificacion(), fBuscaClasificacion()

Pgina: 140

FUNCIONES DEL CATLOGO DE VALORES DE CLASIFICACIONES


Bajo Nivel Lectura/Escritura
fInsertaValorClasif ()
Disponibilidad

AdminPAQ 2003.

Sintaxis

fInsertaValorClasif ()

Parmetros

No usa.

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error
Adiciona un nuevo registro en la tabla de Valores de Clasificacin en modo de insercin.

Descripcin
Ejemplo

El siguiente cdigo indica a la aplicacin que inserte un nuevo registro en la tabla de Valores
de Clasificacin.
fInsertaValorClasif ()

Ver tambin

fInsertarDocumento(), fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(), fCancelarModificacionDocumento(),

fEditaValorClasif ()
Disponibilidad

AdminPAQ 2003.

Sintaxis

fEditaValorClasif ()

Parmetros

No usa.

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error

Descripcin

Activa el modo de Edicin de un registro en la tabla de Valores de Clasificacin.

Ejemplo

El siguiente cdigo busca un cliente/proveedor por su Identificador, si lo encuentra lo activa


en modo edicin, en caso de no encontrarlo enva el mensaje de error correspondiente
lError = fBuscaIdValorClasif (lIdValorClasif)
If lError <> 0 Then
MensajeError lError
Else
fEditaValorClasif ()
End If

Ver tambin

fInsertarDocumento(),fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(),fCancelarModificacionDocumento(),

Pgina: 141

fGuardaValorClasif ()
Disponibilidad

AdminPAQ 2002.

Sintaxis

fGuardaValorClasif ()

Parmetros

No usa.

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Guarda los cambios realizados a un registro de Valores de Clasificacin.

Ejemplo

El siguiente cdigo indica a la aplicacin que guarde cierto registro en la tabla de Valores de
Clasificacin. Esta funcin se llama despus de que se utiliza la funcin fInsertaValorClasif () o
fEditaValorClasif () y se graban los valores en los campos correspondientes.
fGuardaValorClasif ()

Ver tambin

fInsertarDocumento(),fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(), fCancelarModificacionDocumento(),

fBorraValorClasif ()
Disponibilidad

AdminPAQ 2003.

Sintaxis

fBorraValorClasif ()

Parmetros

No usa.

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.
Borra un registro en la tabla de Valores de Clasificacin.

Descripcin
Ejemplo

El siguiente cdigo busca un documento por su identificador, si lo encuentra lo borra, en caso


contrario enva el mensaje de error correspondiente
lError = fBuscaIdValorClasif (lIdValorClasif)
If lError <> 0 Then
MensajeError lError
Else
fBorraValorClasif ()
End If

Ver tambin

fInsertarDocumento(), fEditarDocumento(), fGuardaDocumento(), fBorraDocumento_CW(),


fCancelarModificacionDocumento(),

Pgina: 142

fCancelarModificacionValorClasif ()
Disponibilidad

AdminPAQ 2003.

Sintaxis

fCancelarModificacionValorClasif ()

Parmetros

No usa.

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin cancela las modificaciones al registro actual de Valores de Clasificacin. El


registro debe estar en modo de edicin o insercin.

Ejemplo

El siguiente cdigo indica a la aplicacin que cancele la modificacin a un registro de Valores


de Clasificacin que estaba en modo de insercin o edicin.

Ver tambin

fInsertarDocumento(),fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(), fCancelarModificacionDocumento(),

fCancelarModificacionValorClasif ()

Pgina: 143

fEliminarValorClasif ()
Disponibilidad

AdminPAQ 2003.

Sintaxis

fEliminarValorClasif (aClasificacionDe, aNumClasificacion, aCodValorClasif)

Parmetros

Nombre
aClasificacionDe

Tipo
Entero

Uso
Por valor

aNumClasificacion
aCodValorClasif

Entero
Cadena

Por valor
Por valor

Descripcin
Clasificacin de
1 Agente
2 Cliente
3 Proveedor 4 Almacen
5 Producto.
Numero de la clasificacion (1-6)
Cdigo del Valor Clasificacion
Producto

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin elimina un registro de la tabla Valores de Clasificacin usando su cdigo.

Ejemplo

El siguiente cdigo elimina un registro de la tabla Valores de Clasificacin, si lo encuentra lo


borra, en caso contrario enva el mensaje de error correspondiente
lError = fEliminarValorClasif (lClasificacionDe, lNumClasificacion, lCodValorClasif)
If lError <> 0 Then
MensajeError lError
End If

Ver tambin

fInsertarDocumento(),fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(),fCancelarModificacionDocumento(),

Pgina: 144

fSetDatoValorClasif ()
Disponibilidad

AdminPAQ 2002.

Sintaxis

fSetDatoValorClasif (aCampo, aValor)

Parmetros

Retorna

Descripcin
Ejemplo

Nombre
aCampo
aValor

Tipo
Cadena
Cadena

Uso
Por valor
Por valor

Descripcin
Campo destino
Valor de escritura

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.
Esta funcin escribe el valor indicado en el campo correspondiente en el registro activo de la
tabla de Valores de Clasificacin.
El siguiente cdigo indica a la aplicacin que busque un valor de clasificacin por su
identificador, en caso de que lo encuentre escribe el contenido de la variable lCasif en el
campo cIdClasi01 de la tabla de Valores de Clasificacin; en caso contrario muestra el
mensaje de error correspondiente.
lError = fBuscaIdValorClasif (lIdValorClasif)
If lError <> 0 Then
MensajeError lError
Else
lError = fSetDatoValorClasif ("cIdClasi01", lCasif)
End If

Ver tambin

fInsertarDocumento(),fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(), fCancelarModificacionDocumento(),

Pgina: 145

Bajo Nivel Bsqueda/Navegacin


fLeeDatoValorClasif ()
Disponibilidad

AdminPAQ 2002.

Sintaxis

fLeeDatoValorClasif (aCampo, aValor, aLen)

Parmetros

Retorna

Nombre
aCampo
aValor
aLen

Tipo
Cadena
Cadena
Entero

Uso
Por valor
Por referencia
Por valor

Descripcin
Campo destino.
Valor de lectura.
Longitud del dato de lectura.

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.
aValor: Al finalizar la funcin este parmetro contiene el valor del campo especificado.

Descripcin

Esta funcin lee el valor indicado del campo correspondiente en el registro activo de la tabla
de Valores de Clasificacin.

Ejemplo

El siguiente cdigo indica a la aplicacin que busque un valor de clasificacin por su


identificador, en caso de que lo encuentre escribe el contenido de l campo cIdClasi01 en la
variable la variable lCasif con una longitud de 11 caracteres; en caso contrario muestra el
mensaje de error correspondiente.
lError = fBuscarIdMovimiento (lIdMovto)
If lError <> 0 Then
MensajeError lError
Else
lError = fLeeDatoValorClasif ("cIdClasi01", lCasif, 11)
End If

Ver tambin

fInsertarDocumento(),fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(), fCancelarModificacionDocumento(),

Pgina: 146

fBuscaValorClasif ()
Disponibilidad

AdminPAQ 2003.

Sintaxis

fBuscaClasificacion (aClasificacionDe, aNumClasificacion, aCodValorClasif)

Parmetros

Nombre
aClasificacionDe

Tipo
Entero

Uso
Por valor

aNumClasificacion
aCodValorClasif

Entero
Cadena

Por valor
Por valor

Descripcin
Clasificacin de
1 Agente
2 Cliente
3 Proveedor 4 Almacen
5 Producto.
Numero de la clasificacion (1-6)
Cdigo del Valor Clasificacion
Producto

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin busca una clasificacion de acuerdo a los parmetros recibidos y se posiciona en
el registro correspondiente.
El siguiente cdigo busca una clasificacin.

Ejemplo

fBuscaClasificacion (lClasificacionDe, lNumClasificacion)

Ver tambin

fInsertarDocumento(),fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(),fCancelarModificacionDocumento(),

fBuscaIdValorClasif ()
Disponibilidad

AdminPAQ 2003.

Sintaxis

fBuscaIdValorClasif (aIdValorClasif)

Parmetros

Nombre
aIdValorClasif

Tipo
Entero

Uso
Por valor

Descripcin
Identificador del valor de clasificacin.

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin busca un valor de clasificacin por su Identificador y se posiciona en el registro


correspondiente.
El siguiente cdigo busca un valor de clasificacin por su identificador.

Ejemplo

fBuscaIdValorClasif (lIdValorClasif)

Ver tambin

fInsertarDocumento(),fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(),fCancelarModificacionDocumento(),

Pgina: 147

fPosPrimerValorClasif ()
Disponibilidad

AdminPAQ 2003.

Sintaxis

fPosPrimerValorClasif ()

Parmetros
Retorna

No usa.
Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin se ubica en el primer registro de la tabla de Valores de Clasificacin.

Ejemplo

El siguiente cdigo indica a la aplicacin que se posicione en el primer registro de la tabla de


Valores de Clasificacin.
lError = fPosPrimerValorClasif ()

Ver tambin

fInsertarDocumento(), fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(), fCancelarModificacionDocumento(),

fPosUltimoValorClasif ()
Disponibilidad

AdminPAQ 2003.

Sintaxis

fPosUltimoValorClasif ()

Parmetros
Retorna

No usa.
Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin se ubica en el ultimo registro de la tabla de Valores de Clasificacin.

Ejemplo

El siguiente cdigo indica a la aplicacin que se posicione en el ultimo registro de la tabla de


Valores de Clasificacin.
fPosUltimoValorClasif()

Ver tambin

fInsertarDocumento(), fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(), fCancelarModificacionDocumento(),

Pgina: 148

fPosSiguienteValorClasif ()
Disponibilidad

AdminPAQ 2003.

Sintaxis

fPosSiguienteValorClasif ()

Parmetros
Retorna

No usa.
Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin se ubica en el siguiente registro de la posicin actual de la tabla de Valores de


Clasificacin.
El siguiente cdigo indica a la aplicacin que se posicione en el siguiente registro de la tabla
de Valores de Clasificacin.

Ejemplo

lError = fPosSiguienteValorClasif ()

Ver tambin

fInsertarDocumento(), fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(), fCancelarModificacionDocumento(),

fPosAnteriorValorClasif ()
Disponibilidad

AdminPAQ 2003.

Sintaxis

fPosAnteriorValorClasif ()

Parmetros

No usa.

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin se ubica en el registro anterior de la posicin actual de la tabla de Valores de


Clasificacin.
El siguiente cdigo indica a la aplicacin que se posicione en el registro anterior de la tabla
de Valores de Clasificacin.

Ejemplo

lError = fPosAnteriorValorClasif ()

Ver tambin

fInsertarDocumento(), fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(), fCancelarModificacionDocumento(),

Pgina: 149

fPosBOFValorClasif ()
Disponibilidad

AdminPAQ 2003.

Sintaxis

fPosBOFValorClasif ()

Parmetros
Retorna

No usa.
Valores enteros:
1 (uno) Verdadero.
0 (cero) Falso.

Descripcin

Informa si el registro activo se encuentra en el inicio de la tabla de Valores de Clasificacin.

Ejemplo

El siguiente cdigo indica a la aplicacin que asigne a la variable lInicioTablaVC el resultado


de la funcin fPosBOFValorClasif.
lInicioTablaVC = fPosBOFValorClasif ()

Ver tambin

fInsertarDocumento(), fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(), fCancelarModificacionDocumento(),

fPosEOFValorClasif ()
Disponibilidad

AdminPAQ 2003.

Sintaxis

fPosEOFValorClasif ()

Parmetros
Retorna

No usa.
Valores enteros:
1 (uno) Verdadero.
0 (cero) Falso.

Descripcin

Informa si el registro activo se encuentra en el fin de la tabla de Valores de Clasificacin

Ejemplo

El siguiente cdigo indica a la aplicacin que asigne a la variable lFinTablaVC el resultado


de la funcin fPosEOFValorClasif.
lFinTablaVC = fPosEOFValorClasif ()

Ver tambin

fInsertarDocumento(), fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(), fCancelarModificacionDocumento(),

Pgina: 150

FUNCIONES DEL CATLOGO DE VALORES DE CLASIFICACIONES


Alto Nivel Lectura/Escritura
fAltaValorClasif ()
Disponibilidad

AdminPAQ 2003.

Sintaxis

fAltaValorClasif (aIdValorClasif, astValorClasif)

Parmetros

Retorna

Nombre
aIdValorClasif
astValorClasif

Tipo
Entero
tValorClasif

Uso
Por referencia
Por valor

Descripcin
Identificador de la direccin.
Tipo de dato abstracto.

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

aIdValorClasif: Al finalizar la funcin este parmetro contiene el identificador del nuevo valor
de clasificacin.
Esta funcin da de alta un nuevo valor de clasificacin.

Ejemplo

El siguiente cdigo da de alta un nuevo valor de clasificacin.


fAltaValorClasif (lIdValorClasif, lstValorClasif)

Ver tambin

fInsertarDocumento(),fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(),fCancelarModificacionDocumento(),

Pgina: 151

fActualizaValorClasif ()
Disponibilidad

AdminPAQ 2003.

Sintaxis

fActualizaProducto (aCodigoValorClasif, astValorClasif)

Parmetros

Nombre
aCodigoValorClasif

Tipo
Cadena

Uso
Por valor

astValorClasif

tValorClasif

Por valor

Descripcin
Cdigo del valor de
clasificacin.
Tipo de dato abstracto.

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin actualiza el valor de clasificacin del registro especificado por el parametro
aCodigoValorClasif.
El siguiente cdigo actualiza el valor de clasificacin del registro especificado por el
parametro aCodigoValorClasif.

Ejemplo

fActualizaProducto (lCodigoValorClasif, lstValorClasif)

Ver tambin

fInsertarDocumento(),fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(),fCancelarModificacionDocumento(),

fLlenaRegistroValorClasif ()
Disponibilidad

AdminPAQ 2003.

Sintaxis

fLlenaRegistroValorClasif (astValorClasif)

Parmetros

Nombre
astValorClasif

Tipo
tValorClasif

Uso
Por valor

Descripcin
Tipo de dato abstracto.

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin asigna al registro de la base de datos los valores de la estructura e datos del valor
de clasificacion.
El siguiente cdigo asigna al registro de la base de datos los valores de la estructura e datos
del valor de clasificacion.
fLlenaRegistroValorClasif (lstValorClasif)

Ejemplo

Ver tambin

fInsertarDocumento(),fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(),fCancelarModificacionDocumento(),

Pgina: 152

FUNCIONES CATLOGO DE UNIDADES DE MEDIDA Y PESO


Bajo Nivel Lectura/Escritura
fInsertaUnidad ()
Disponibilidad

AdminPAQ 2003.

Sintaxis

fInsertaUnidad ()

Parmetros

No usa.

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error
Adiciona un nuevo registro en la tabla de Unidades de Medida y Peso en modo de insercin.

Descripcin
Ejemplo

El siguiente cdigo indica a la aplicacin que inserte un nuevo registro en la tabla de


Unidades de Medida y Peso.
fInsertaUnidad ()

Ver tambin

fEditaUnidad ()

fInsertarDocumento(), fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(), fCancelarModificacionDocumento(),

Disponibilidad

AdminPAQ 2003.

Sintaxis

fEditaUnidad ()

Parmetros

No usa.

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error

Descripcin

Activa el modo de Edicin de un registro en la tabla de Unidades de Medida y Peso.

Ejemplo

El siguiente cdigo busca una unidad por su identificador, si lo encuentra lo activa en modo
edicin, en caso de no encontrarlo enva el mensaje de error correspondiente
lError = fBuscaIdUnidad(lIdUnidad)
If lError <> 0 Then
MensajeError lError
Else
fEditaUnidad ()
End If

Ver tambin

fInsertarDocumento(),fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(),fCancelarModificacionDocumento(),

Pgina: 153

fGuardaUnidad ()
Disponibilidad

AdminPAQ 2003.

Sintaxis

fGuardaUnidad ()

Parmetros

No usa.

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Guarda los cambios realizados a un registro de Unidades de Medida y Peso.

Ejemplo

El siguiente cdigo indica a la aplicacin que guarde cierto registro en la tabla de Unidades
de Medida y Peso. Esta funcin se llama despus de que se utiliza la funcin fInsertaUnidad ()
o fEditaUnidad() y se graban los valores en los campos correspondientes.
fGuardaUnidad ()

Ver tambin

fBorraUnidad ()

fInsertarDocumento(),fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(), fCancelarModificacionDocumento(),

Disponibilidad

AdminPAQ 2003.

Sintaxis

fBorraUnidad ()

Parmetros

No usa.

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.
Borra un registro en la tabla de Unidades de Medida y Peso.

Descripcin
Ejemplo

El siguiente cdigo busca un documento por su identificador, si lo encuentra lo borra, en caso


contrario enva el mensaje de error correspondiente
lError = fBuscaIdUnidad(lIdUnidad)
If lError <> 0 Then
MensajeError lError
Else
fBorraUnidad ()
End If

Ver tambin

fInsertarDocumento(), fEditarDocumento(), fGuardaDocumento(), fBorraDocumento_CW(),


fCancelarModificacionDocumento(),

Pgina: 154

fCancelarModificacionUnidad ()
Disponibilidad

AdminPAQ 2003.

Sintaxis

fCancelarModificacionUnidad ()

Parmetros

No usa.

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin cancela las modificaciones al registro actual de Unidades de Medida y Peso. El
registro debe estar en modo de edicin o insercin.

Ejemplo

El siguiente cdigo indica a la aplicacin que cancele la modificacin a un registro de


Unidades de Medida y Peso que estaba en modo de insercin o edicin.

Ver tambin

fInsertarDocumento(),fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(), fCancelarModificacionDocumento(),

fCancelarModificacionUnidad ()

fEliminarUnidad ()
Disponibilidad

AdminPAQ 2003.

Sintaxis

fEliminarUnidad (aNombreUnidad)

Parmetros

Nombre
aNombreUnidad

Tipo
Cadena

Uso
Por valor

Descripcin
Nombre de la unidad.

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin elimina un registro de la tabla Medida y Peso usando su nombre.

Ejemplo

El siguiente cdigo elimina un registro de la tabla Medida y Peso; si lo encuentra lo borra, en


caso contrario enva el mensaje de error correspondiente
lError = fEliminarUnidad (lNombreUnidad)
If lError <> 0 Then
MensajeError lError
End If

Ver tambin

fInsertarDocumento(),fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(),fCancelarModificacionDocumento(),

Pgina: 155

fSetDatoUnidad ()
Disponibilidad

AdminPAQ 2003.

Sintaxis

fSetDatoUnidad (aCampo, aValor)

Parmetros

Retorna

Descripcin
Ejemplo

Nombre
aCampo
aValor

Tipo
Cadena
Cadena

Uso
Por valor
Por valor

Descripcin
Campo destino
Valor de escritura

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.
Esta funcin escribe el valor indicado en el campo correspondiente en el registro activo de la
tabla de Medida y Peso.
El siguiente cdigo indica a la aplicacin que busque una unidad por su identificador, en caso
de que lo encuentre escribe el contenido de la variable lNombreU en el campo
cNombreU01de la tabla de Medida y Peso; en caso contrario muestra el mensaje de error
correspondiente.
lError = fBuscaIdUnidad(lIdUnidad)
If lError <> 0 Then
MensajeError lError
Else
lError = fSetDatoUnidad ("cNombreU01", lNombreU)
End If

Ver tambin

fInsertarDocumento(),fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(), fCancelarModificacionDocumento(),

Pgina: 156

fLeeDatoUnidad ()
Disponibilidad

AdminPAQ 2003.

Sintaxis

fLeeDatoUnidad (aCampo, aValor, aLen)

Parmetros

Retorna

Nombre
aCampo
aValor
aLen

Tipo
Cadena
Cadena
Entero

Uso
Por valor
Por referencia
Por valor

Descripcin
Campo destino.
Valor de lectura.
Longitud del dato de lectura.

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.
aValor: Al finalizar la funcin este parmetro contiene el valor del campo especificado.

Descripcin

Esta funcin lee el valor indicado del campo correspondiente en el registro activo de la tabla
de Unidades de Medida y Peso.

Ejemplo

El siguiente cdigo indica a la aplicacin que busque una unidad por su identificador, en caso
de que lo encuentre escribe el contenido de l campo cNombreU01 en la variable la variable
lNombreU con una longitud de 60 caracteres; en caso contrario muestra el mensaje de error
correspondiente.
lError = fBuscaIdUnidad(lIdUnidad)
If lError <> 0 Then
MensajeError lError
Else
lError = fLeeDatoUnidad ("cNombreU01", lNombreU, 60)
End If

Ver tambin

fInsertarDocumento(),fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(), fCancelarModificacionDocumento(),

Pgina: 157

Bajo Nivel Bsqueda/Navegacin


fBuscaUnidad ()
Disponibilidad

AdminPAQ 2003.

Sintaxis

fBuscaUnidad (aNombreUnidad)

Parmetros

Nombre
aNombreUnidad

Tipo
Cadena

Uso
Por valor

Descripcin
Nombre de la unidad.

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin busca una Unidad de Medida y Peso de acuerdo a los parmetros recibidos y se
posiciona en el registro correspondiente.
El siguiente cdigo busca una clasificacin.

Ejemplo

fBuscaUnidad (lNombreUnidad)

Ver tambin

fInsertarDocumento(),fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(),fCancelarModificacionDocumento(),

fBuscaIdUnidad ()
Disponibilidad

AdminPAQ 2003.

Sintaxis

fBuscaIdUnidad (aIdUnidad)

Parmetros

Nombre
aIdValorClasif

Tipo
Entero

Uso
Por valor

Descripcin
Identificador de la Unidad.

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin busca una unidad de medida y peso por su Identificador y se posiciona en el
registro correspondiente.
El siguiente cdigo busca una unidad de medida y peso por su identificador.

Ejemplo

fBuscaIdUnidad (aIdUnidad)

Ver tambin

fInsertarDocumento(),fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(),fCancelarModificacionDocumento(),

Pgina: 158

fPosPrimerUnidad ()
Disponibilidad

AdminPAQ 2003.

Sintaxis

fPosPrimerUnidad ()

Parmetros
Retorna

No usa.
Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin se ubica en el primer registro de la tabla de Unidades de Medida y Peso.

Ejemplo

El siguiente cdigo indica a la aplicacin que se posicione en el primer registro de la tabla de


Unidades de Medida y Peso.
lError = fPosPrimerUnidad ()

Ver tambin

fInsertarDocumento(), fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(), fCancelarModificacionDocumento(),

fPosUltimoUnidad ()
Disponibilidad

AdminPAQ 2003.

Sintaxis

fPosUltimoUnidad ()

Parmetros
Retorna

No usa.
Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin se ubica en el ultimo registro de la tabla de Unidades de Medida y Peso.

Ejemplo

El siguiente cdigo indica a la aplicacin que se posicione en el ultimo registro de la tabla de


Unidades de Medida y Peso.
fPosUltimoUnidad ()

Ver tambin

fInsertarDocumento(), fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(), fCancelarModificacionDocumento(),

Pgina: 159

fPosSiguienteUnidad ()
Disponibilidad

AdminPAQ 2003.

Sintaxis

fPosSiguienteUnidad ()

Parmetros
Retorna

No usa.
Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin se ubica en el siguiente registro de la posicin actual de la tabla de Unidades de


Medida y Peso.
El siguiente cdigo indica a la aplicacin que se posicione en el siguiente registro de la tabla
de Unidades de Medida y Peso.

Ejemplo

lError = fPosSiguienteUnidad ()

Ver tambin

fInsertarDocumento(), fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(), fCancelarModificacionDocumento(),

fPosAnteriorUnidad ()
Disponibilidad

AdminPAQ 2003.

Sintaxis

fPosAnteriorUnidad ()

Parmetros

No usa.

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin se ubica en el registro anterior de la posicin actual de la tabla de Unidades de


Medida y Peso.
El siguiente cdigo indica a la aplicacin que se posicione en el registro anterior de la tabla
de Unidades de Medida y Peso.

Ejemplo

lError = fPosAnteriorUnidad ()

Ver tambin

fInsertarDocumento(), fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(), fCancelarModificacionDocumento(),

Pgina: 160

fPosBOFUnidad ()
Disponibilidad

AdminPAQ 2003.

Sintaxis

fPosBOFUnidad ()

Parmetros
Retorna

No usa.
Valores enteros:
1 (uno) Verdadero.
0 (cero) Falso.

Descripcin

Informa si el registro activo se encuentra en el inicio de la tabla de Unidades de Medida y


Peso.
El siguiente cdigo indica a la aplicacin que asigne a la variable lInicioTablaUnidades el
resultado de la funcin fPosBOFUnidad.

Ejemplo

lInicioTablaUnidades = fPosBOFUnidad ()

Ver tambin

fPosEOFUnidad ()

fInsertarDocumento(), fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(), fCancelarModificacionDocumento(),

Disponibilidad

AdminPAQ 2003.

Sintaxis

fPosEOFUnidad ()

Parmetros
Retorna

No usa.
Valores enteros:
1 (uno) Verdadero.
0 (cero) Falso.

Descripcin

Informa si el registro activo se encuentra en el fin de la tabla de Unidades de Medida y Peso

Ejemplo

El siguiente cdigo indica a la aplicacin que asigne a la variable lFinTablaUnidades el


resultado
de la funcin fPosEOFUnidad.

Ver tambin

fInsertarDocumento(), fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(), fCancelarModificacionDocumento(),

lFinTablaUnidades = fPosEOFUnidad ()

Pgina: 161

Alto Nivel Lectura/Escritura


fAltaUnidad ()

Disponibilidad

AdminPAQ 2003.

Sintaxis

fAltaUnidad (aIdUnidad,

Parmetros

Retorna

Nombre
aIdUnidad
astUnidad

LPFREGUNIDAD astUnidad)
Tipo
Uso
Entero
Por referencia
tUnidad
Por valor

Descripcin
Identificador de la unidad.
Tipo de dato abstracto.

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

aIdUnidad: Al finalizar la funcin este parmetro contiene el identificador del nuevo valor de
clasificacin.
Esta funcin da de alta un nuevo valor de clasificacin.

Ejemplo

El siguiente cdigo da de alta un nuevo valor de clasificacin.


fAltaUnidad (lIdValorClasif, lstValorClasif)

Ver tambin

fInsertarDocumento(),fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(),fCancelarModificacionDocumento(),

Pgina: 162

Alto Nivel Lectura/Escritura


fActualizaUnidad ()
Disponibilidad

AdminPAQ 2003.

Sintaxis

fActualizaUnidad (aNombreUnidad, astUnidad)

Parmetros

Nombre
aNombreUnidad
astUnidad

Tipo
Cadena
tUnidad

Uso
Por valor
Por valor

Descripcin
Nombre de la unidad.
Tipo de dato abstracto.

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin actualiza la unidad de medida y pesodel registro especificado por el parametro
aCodigoValorClasif.
El siguiente cdigo actualiza la unidad de medida y peso del registro especificado por el
parametro aCodigoValorClasif.

Ejemplo

fActualizaUnidad (lNombreUnidad, lstValorClasif)

Ver tambin

fInsertarDocumento(),fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(),fCancelarModificacionDocumento(),

fLlenaRegistroUnidad ()
Disponibilidad

AdminPAQ 2003.

Sintaxis

fLlenaRegistroUnidad (astUnidad)

Parmetros

Nombre
astUnidad

Tipo
tUnidad

Uso
Por valor

Descripcin
Tipo de dato abstracto.

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin asigna al registro de la base de datos los valores de la estructura de datos de la
unidad de medida peso.
El siguiente cdigo asigna al registro de la base de datos los valores de la estructura de datos
unidad de medida peso.

Ejemplo

fLlenaRegistroUnidad (lstValorClasif)

Ver tambin

fInsertarDocumento(),fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(),fCancelarModificacionDocumento(),

Pgina: 163

FUNCIONES CATLOGO DE AGENTES


Bajo Nivel Lectura/Escritura
fInsertaAgente ()
Disponibilidad

AdminPAQ 2004.

Sintaxis

fInsertaAgente ()

Parmetros

No usa.

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error
Adiciona un nuevo registro en el catlogo de Agentes en modo de insercin.

Descripcin
Ejemplo

El siguiente cdigo indica a la aplicacin que inserte un nuevo registro en el catlogo de


Agentes.
fInsertaAgente ()

Ver tambin

fEditaAgente ()

fInsertarDocumento(), fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(), fCancelarModificacionDocumento(),

Disponibilidad

AdminPAQ 2006 v3.2.2.

Sintaxis

fEditaAgente ()

Parmetros

No usa.

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Activa el modo de Edicin de un registro en el catlogo de agentes.

Ejemplo

El siguiente cdigo busca una unidad por su identificador, si lo encuentra lo activa en modo
edicin, en caso de no encontrarlo enva el mensaje de error correspondiente

Ver tambin

lError = fBuscaAgente (lCodigoAgente)


If lError <> 0 Then
MensajeError lError
Else
fEditaAgente ()
End If

fInsertarDocumento(),fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(), fCancelarModificacionDocumento(),

Pgina: 164

fGuardaAgente ()
Disponibilidad

AdminPAQ 2004.

Sintaxis

fGuardaAgente ()

Parmetros

No usa.

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Guarda los cambios realizados a un registro en el catlogo de agentes.

Ejemplo

El siguiente cdigo indica a la aplicacin que guarde cierto registro en el catlogo de


Agentes. Esta funcin se llama despus de que se utiliza la funcin fInsertaAgente () y se
graban los valores en los campos correspondientes.
fGuardaAgente ()

Ver tambin

fInsertarDocumento(),fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(), fCancelarModificacionDocumento(),

fCancelarModificacionAgente ()
Disponibilidad

AdminPAQ 2004.

Sintaxis

fCancelarModificacionAgente ()

Parmetros

No usa.

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin cancela las modificaciones al registro actual del catlogo de Agentes. El registro
debe estar en modo de edicin o insercin.

Ejemplo

El siguiente cdigo indica a la aplicacin que cancele la modificacin a un registro del


catlogo de Agentes que estaba en modo de insercin o edicin.

Ver tambin

fInsertarDocumento(),fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(), fCancelarModificacionDocumento(),

fCancelarModificacionAgente ()

Pgina: 165

fSetDatoAgente ()
Disponibilidad

AdminPAQ 2004.

Sintaxis

fSetDatoAgente (aCampo, aValor)

Parmetros

Retorna

Descripcin
Ejemplo

Nombre
aCampo
aValor

Tipo
Cadena
Cadena

Uso
Por valor
Por valor

Descripcin
Campo destino
Valor de escritura

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.
Esta funcin escribe el valor indicado en el campo correspondiente en el registro activo del
catlogo de Agentes.
El siguiente cdigo indica a la aplicacin que busque un agente por su cdigo, en caso de
que lo encuentre escribe el contenido de la variable lNombreA en el campo cNombreA01 del
catlogo de Agentes; en caso contrario muestra el mensaje de error correspondiente.
lError = fBuscaAgente (lCodigoAgente)
If lError <> 0 Then
MensajeError lError
Else
lError = fSetDatoAgente ("cNombreA01", lNombreA)
End If

Ver tambin

fInsertarDocumento(),fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(), fCancelarModificacionDocumento(),

Pgina: 166

fLeeDatoAgente ()
Disponibilidad

AdminPAQ 2004.

Sintaxis

fLeeDatoAgente (aCampo, aValor, aLen)

Parmetros

Retorna

Nombre
aCampo
aValor
aLen

Tipo
Cadena
Cadena
Entero

Uso
Por valor
Por referencia
Por valor

Descripcin
Campo destino.
Valor de lectura.
Longitud del dato de lectura.

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.
aValor: Al finalizar la funcin este parmetro contiene el valor del campo especificado.

Descripcin

Esta funcin lee el valor indicado del campo correspondiente en el registro activo de la tabla
del catlogo de Agentes.

Ejemplo

El siguiente cdigo indica a la aplicacin que busque un agente por su cdigo, en caso de
que lo encuentre escribe el contenido de l campo cNombreA01 en la variable la variable
lNombreA con una longitud de 60 caracteres; en caso contrario muestra el mensaje de error
correspondiente.
lError = fBuscaIdUnidad(lIdUnidad)
If lError <> 0 Then
MensajeError lError
Else
lError = fLeeDatoAgente ("cNombreA01", lNombreA, 60)
End If

Ver tambin

fInsertarDocumento(),fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(), fCancelarModificacionDocumento(),

Pgina: 167

Bajo Nivel Bsqueda/Navegacin


fBuscaAgente ()
Disponibilidad

AdminPAQ 2004.

Sintaxis

fBuscaAgente (aCodigoAgente)

Parmetros

Nombre
aCodigoAgente

Tipo
Cadena

Uso
Por valor

Descripcin
Cdigo del agente.

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin busca un agente por su cdigo y se posiciona en el registro correspondiente.

Ejemplo

El siguiente cdigo busca un agente.


fBuscaAgente (lCodigoAgente)

Ver tambin

fInsertarDocumento(),fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(),fCancelarModificacionDocumento(),

fBuscaIdAgente ()
Disponibilidad

AdminPAQ 2004.

Sintaxis

fBuscaIdAgente (aIdAgente)

Parmetros

Nombre
aIdAgente

Tipo
Entero

Uso
Por valor

Descripcin
Identificador de la Unidad.

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin busca un agente y peso por su Identificador y se posiciona en el registro


correspondiente.
El siguiente cdigo busca un agente por su identificador.

Ejemplo

fBuscaIdAgente (lIdAgente)

Ver tambin

fInsertarDocumento(),fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(),fCancelarModificacionDocumento(),

Pgina: 168

fPosPrimerAgente ()
Disponibilidad

AdminPAQ 2004.

Sintaxis

fPosPrimerAgente ()

Parmetros
Retorna

No usa.
Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin se ubica en el primer registro de la tabla de Agentes.

Ejemplo

El siguiente cdigo indica a la aplicacin que se posicione en el primer registro de la tabla de


Agentes.
lError = fPosPrimerAgente ()

Ver tambin

fInsertarDocumento(), fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(), fCancelarModificacionDocumento(),

fPosUltimoAgente ()
Disponibilidad

AdminPAQ 2004.

Sintaxis

fPosUltimoAgente ()

Parmetros
Retorna

No usa.
Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin se ubica en el ultimo registro de la tabla de Agentes.

Ejemplo

El siguiente cdigo indica a la aplicacin que se posicione en el ultimo registro de la tabla de


Agentes.
fPosUltimoAgente ()

Ver tambin

fInsertarDocumento(), fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(), fCancelarModificacionDocumento(),

Pgina: 169

fPosSiguienteAgente ()
Disponibilidad

AdminPAQ 2004.

Sintaxis

fPosSiguienteAgente ()

Parmetros
Retorna

No usa.
Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin se ubica en el siguiente registro de la posicin actual de la tabla de Agentes.

Ejemplo

El siguiente cdigo indica a la aplicacin que se posicione en el siguiente registro de la tabla


de Agentes.
lError = fPosSiguienteAgente ()

Ver tambin

fInsertarDocumento(), fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(), fCancelarModificacionDocumento(),

fPosAnteriorAgente ()
Disponibilidad

AdminPAQ 2004.

Sintaxis

fPosAnteriorAgente ()

Parmetros

No usa.

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin se ubica en el registro anterior de la posicin actual de la tabla de Agentes.

Ejemplo

El siguiente cdigo indica a la aplicacin que se posicione en el registro anterior de la tabla


de Agentes.
lError = fPosAnteriorAgente ()

Ver tambin

fInsertarDocumento(), fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(), fCancelarModificacionDocumento(),

Pgina: 170

fPosBOFAgente ()
Disponibilidad

AdminPAQ 2004.

Sintaxis

fPosBOFAgente ()

Parmetros
Retorna

No usa.
Valores enteros:
1 (uno) Verdadero.
0 (cero) Falso.

Descripcin

Informa si el registro activo se encuentra en el inicio de la tabla de Agentes.

Ejemplo

El siguiente cdigo indica a la aplicacin que asigne a la variable lInicioTablaAgentes el


resultado de la funcin fPosBOFAgente.
lInicioTablaAgentes = fPosBOFAgente ()

Ver tambin

fPosEOFAgente ()

fInsertarDocumento(), fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(), fCancelarModificacionDocumento(),

Disponibilidad

AdminPAQ 2004.

Sintaxis

fPosEOFAgente ()

Parmetros
Retorna

No usa.
Valores enteros:
1 (uno) Verdadero.
0 (cero) Falso.

Descripcin

Informa si el registro activo se encuentra en el fin de la tabla de Agentes

Ejemplo

El siguiente cdigo indica a la aplicacin que asigne a la variable lFinTablaAgentes el


resultado
de la funcin fPosEOFAgente.

Ver tambin

fInsertarDocumento(), fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(), fCancelarModificacionDocumento(),

lFinTablaAgentes = fPosEOFAgente ()

Pgina: 171

Funciones Catlogo de Almacenes


Bajo Nivel Lectura/Escritura
fInsertaAlmacen ()
Disponibilidad

AdminPAQ 2004.

Sintaxis

fInsertaAlmacen ()

Parmetros

No usa.

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error
Adiciona un nuevo registro en el catlogo de Almacenesen modo de insercin.

Descripcin
Ejemplo

El siguiente cdigo indica a la aplicacin que inserte un nuevo registro en el catlogo de


Almacenes.
fInsertaAlmacen ()

Ver tambin

fEditaAlmacen ()

fInsertarDocumento(), fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(), fCancelarModificacionDocumento(),

Disponibilidad

AdminPAQ 2006.

Sintaxis

fEditaAlmacen ()

Parmetros

No usa.

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Activa el modo de Edicin de un registro en el catlogo de agentes.

Ejemplo

El siguiente cdigo busca una unidad por su identificador, si lo encuentra lo activa en modo
edicin, en caso de no encontrarlo enva el mensaje de error correspondiente

Ver tambin

lError = fBuscaAlmacen (lCodigoAlmacen)


If lError <> 0 Then
MensajeError lError
Else
fEditaAlmacen ()
End If

fInsertarDocumento(),fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(), fCancelarModificacionDocumento(),

Pgina: 172

fGuardaAlmacen ()
Disponibilidad

AdminPAQ 2004.

Sintaxis

fGuardaAlmacen ()

Parmetros

No usa.

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Guarda los cambios realizados a un registro en el catlogo de Almacenes.

Ejemplo

El siguiente cdigo indica a la aplicacin que guarde cierto registro en el catlogo de


Almacenes. Esta funcin se llama despus de que se utiliza la funcin fInsertaAgente () y se
graban los valores en los campos correspondientes.
fGuardaAlmacen ()

Ver tambin

fInsertarDocumento(),fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(), fCancelarModificacionDocumento(),

fCancelarModificacionAlmacen ()
Disponibilidad

AdminPAQ 2004.

Sintaxis

fCancelarModificacionAlmacen ()

Parmetros

No usa.

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin cancela las modificaciones al registro actual del catlogo de Almacenes. El
registro debe estar en modo de edicin o insercin.

Ejemplo

El siguiente cdigo indica a la aplicacin que cancele la modificacin a un registro del


catlogo de Almacenesque estaba en modo de insercin o edicin.

Ver tambin

fInsertarDocumento(),fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(), fCancelarModificacionDocumento(),

fCancelarModificacionAlmacen ()

Pgina: 173

fSetDatoAlmacen ()
Disponibilidad

AdminPAQ 2004.

Sintaxis

fSetDatoAlmacen (aCampo, aValor)

Parmetros

Retorna

Descripcin
Ejemplo

Nombre
aCampo
aValor

Tipo
Cadena
Cadena

Uso
Por valor
Por valor

Descripcin
Campo destino
Valor de escritura

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.
Esta funcin escribe el valor indicado en el campo correspondiente en el registro activo del
catlogo de Almacenes.
El siguiente cdigo indica a la aplicacin que busque un agente por su cdigo, en caso de
que lo encuentre escribe el contenido de la variable lNombreA en el campo cNombreA01 del
catlogo de Almacenes; en caso contrario muestra el mensaje de error correspondiente.
lError = fBuscaAlmacen (lCodigoAgente)
If lError <> 0 Then
MensajeError lError
Else
lError = fSetDatoAlmacen ("cNombreA01", lNombreA)
End If

Ver tambin

fInsertarDocumento(),fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(), fCancelarModificacionDocumento(),

Pgina: 174

fLeeDatoAlmacen ()
Disponibilidad

AdminPAQ 2004.

Sintaxis

fLeeDatoAlmacen (aCampo, aValor, aLen)

Parmetros

Retorna

Nombre
aCampo
aValor
aLen

Tipo
Cadena
Cadena
Entero

Uso
Por valor
Por referencia
Por valor

Descripcin
Campo destino.
Valor de lectura.
Longitud del dato de lectura.

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.
aValor: Al finalizar la funcin este parmetro contiene el valor del campo especificado.

Descripcin

Esta funcin lee el valor indicado del campo correspondiente en el registro activo de la tabla
del catlogo de Almacenes.

Ejemplo

El siguiente cdigo indica a la aplicacin que busque un agente por su cdigo, en caso de
que lo encuentre escribe el contenido de l campo cNombreA01 en la variable la variable
lNombreA con una longitud de 60 caracteres; en caso contrario muestra el mensaje de error
correspondiente.
lError = fBuscaIdUnidad(lIdUnidad)
If lError <> 0 Then
MensajeError lError
Else
lError = fLeeDatoAlmacen ("cNombreA01", lNombreA, 60)
End If

Ver tambin

fInsertarDocumento(),fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(), fCancelarModificacionDocumento(),

Pgina: 175

Bajo Nivel Bsqueda/Navegacin


fBuscaAlmacen ()
Disponibilidad

AdminPAQ 2004.

Sintaxis

fBuscaAlmacen (aCodigoAlmacen)

Parmetros

Nombre
aCodigoAlmacen

Tipo
Cadena

Uso
Por valor

Descripcin
Cdigo del almacn.

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin busca un agente por su cdigo y se posiciona en el registro correspondiente.

Ejemplo

El siguiente cdigo busca un Almacen.


fBuscaAlmacen (lCodigoAlmacen)

Ver tambin

fInsertarDocumento(),fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(),fCancelarModificacionDocumento(),

fBuscaIdAlmacen ()
Disponibilidad

AdminPAQ 2004.

Sintaxis

fBuscaIdAlmacen (aIdAgente)

Parmetros

Nombre
aIdAgente

Tipo
Entero

Uso
Por valor

Descripcin
Identificador del almacn.

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin busca un Almacen por su Identificador y se posiciona en el registro


correspondiente.
El siguiente cdigo busca un agente por su identificador.

Ejemplo

fBuscaIdAlmacen (lCodigoAlmacen)

Ver tambin

fInsertarDocumento(),fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(),fCancelarModificacionDocumento(),

Pgina: 176

fPosPrimerAlmacen ()
Disponibilidad

AdminPAQ 2004.

Sintaxis

fPosPrimerAlmacen ()

Parmetros
Retorna

No usa.
Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin se ubica en el primer registro de la tabla de Almacenes.

Ejemplo

El siguiente cdigo indica a la aplicacin que se posicione en el primer registro de la tabla de


Almacenes.
lError = fPosPrimerAlmacen ()

Ver tambin

fInsertarDocumento(), fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(), fCancelarModificacionDocumento(),

fPosUltimoAlmacen ()
Disponibilidad

AdminPAQ 2004.

Sintaxis

fPosUltimoAlmacen ()

Parmetros
Retorna

No usa.
Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin se ubica en el ultimo registro de la tabla de Almacenes.

Ejemplo

El siguiente cdigo indica a la aplicacin que se posicione en el ultimo registro de la tabla de


Almacenes.
lError = fPosUltimoAlmacen ()

Ver tambin

fInsertarDocumento(), fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(), fCancelarModificacionDocumento(),

Pgina: 177

fPosSiguienteAlmacen ()
Disponibilidad

AdminPAQ 2004.

Sintaxis

fPosSiguienteAlmacen ()

Parmetros
Retorna

No usa.
Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin se ubica en el siguiente registro de la posicin actual de la tabla de Almacenes.

Ejemplo

El siguiente cdigo indica a la aplicacin que se posicione en el siguiente registro de la tabla


de Almacenes.
lError = fPosSiguienteAlmacen ()

Ver tambin

fInsertarDocumento(), fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(), fCancelarModificacionDocumento(),

fPosAnteriorAlmacen ()
Disponibilidad

AdminPAQ 2004.

Sintaxis

fPosAnteriorAlmacen ()

Parmetros

No usa.

Retorna

Valores enteros:
kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito.
!kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin

Esta funcin se ubica en el registro anterior de la posicin actual de la tabla de Almacenes.

Ejemplo

El siguiente cdigo indica a la aplicacin que se posicione en el registro anterior de la tabla


de Almacenes.
lError = fPosAnteriorAlmacen ()

Ver tambin

fInsertarDocumento(), fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(), fCancelarModificacionDocumento(),

Pgina: 178

fPosBOFAlmacen ()
Disponibilidad

AdminPAQ 2004.

Sintaxis

fPosBOFAlmacen ()

Parmetros
Retorna

No usa.
Valores enteros:
1 (uno) Verdadero.
0 (cero) Falso.

Descripcin

Informa si el registro activo se encuentra en el inicio de la tabla de Almacenes.

Ejemplo

El siguiente cdigo indica a la aplicacin que asigne a la variable lInicioTablaAlmacenes el


resultado de la funcin fPosBOFAlmacen.
lInicioTablaAlmacenes = fPosBOFAlmacen ()

Ver tambin

fInsertarDocumento(), fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(), fCancelarModificacionDocumento(),

fPosEOFAlmacen ()
Disponibilidad

AdminPAQ 2004.

Sintaxis

fPosEOFAlmacen ()

Parmetros
Retorna

No usa.
Valores enteros:
1 (uno) Verdadero.
0 (cero) Falso.

Descripcin

Informa si el registro activo se encuentra en el fin de la tabla de Almacenes

Ejemplo

El siguiente cdigo indica a la aplicacin que asigne a la variable lFinTablaAlmacenes el


resultado de la funcin fPosEOFAlmacen.
lFinTablaAlmacenes = fPosEOFAlmacen ()

Ver tambin

fInsertarDocumento(), fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),


fBorraDocumento_CW(), fCancelarModificacionDocumento(),

Pgina: 179

CONSTANTES DEL SDK


Constantes de longitud
Nombre
kLongFecha
kLongSerie
kLongCodigo
kLongNombre
kLongReferencia
kLongDescripcion
kLongCuenta
kLongMensaje
kLongNombreProducto
kLongAbreviatura
kLongCodValorClasif
kLongDenComercial
kLongRepLegal
kLongTextoExtra
kLongRFC
kLongCURP
kLongDesCorta
kLongNumeroExtInt
kLongNumeroExpandido
kLongCodigoPostal
kLongTelefono
kLongEmailWeb
kLongSelloSat
kLonSerieCertSAT
kLongFechaHora
kLongSelloCFDI
kLongCadOrigComplSAT
kLongitudUUID
kLongitudRegimen
kLongitudMoneda
kLongitudFolio
kLongitudMonto
kLogitudLugarExpedicion

Longitud
23
11
30
60
20
60
100
3000
255
3
3
50
50
50
20
20
20
6
30
6
15
50
175
20
35
175
500
36
100
60
16
30
400

Descripcin
Longitud mxima de caracteres para los campos de fechas.
Longitud mxima de caracteres para las series.
Longitud mxima de caracteres usada para los cdigos.
Longitud mxima de caracteres para los nombres.
Longitud mxima de caracteres para las referencias.
Longitud mxima de caracteres para las descripciones.
Longitud mxima de caracteres para las cuentas.
Longitud mxima de caracteres para los mensajes.
Longitud mxima de caracteres para los nombres de producto.
Longitud mxima de caracteres para las abreviaturas.
Longitud mxima de caracteres para los valores de clasificacin.
Longitud mxima de caracteres para la denominacin comercial.
Longitud mxima de caracteres para el representante legal.
Longitud mxima de caracteres para los textos extra.
Longitud mxima de caracteres para el RFC.
Longitud mxima de caracteres para el CURP.
Longitud mxima de caracteres para descripciones cortas.
Longitud mxima de caracteres para el nmero exterior/interior.
Longitud mxima de caracteres para el nmero expandido.
Longitud mxima de caracteres para el cdigo postal.
Longitud mxima de caracteres para nmeros de telfono.
Longitud mxima de caracteres para direcciones de correo electrnico.
Longitud mxima de caracteres para el sello del SAT
Longitud mxima de caracteres para la serie del certificado del SAT.
Longitud mxima de caracteres para la fecha y hora.
Longitud mxima de caracteres para el sello del CFDI.
Longitud mxima de caracteres para la cadena original.
Longitud mxima de caracteres para el UUID.
Longitud mxima de caracteres para el rgimen fiscal de la empresa.
Longitud mxima de caracteres para la moneda.
Longitud mxima de caracteres para el folio.
Longitud mxima de caracteres para el monto.
Longitud mxima de caracteres para el lugar de expedicin.

Pgina: 180

TIPOS DE DATO ABSTRACTOS DEL SDK


Definicin de las Estructuras de Datos
Documentos RegDocumento tDocumento
Campo
aFolio
aNumMoneda

Tipo
Doble
Entero

Longitud
NA
NA

aTipoCambio
aImporte

Doble
Doble

NA
NA

aDescuentoDoc1
aDescuentoDoc2
aSistemaOrigen

Doble
Doble
Entero

NA
NA
NA

aCodConcepto
aSerie
aFecha

Cadena
Cadena
Cadena

kLongCodigo + 1
kLongSerie + 1
kLongFecha + 1

aCodigoCteProv
aCodigoAgente
aReferencia
aAfecta
aGasto1
aGasto2
aGasto3

Cadena
Cadena
Cadena
Entero
Double
Double
Double

kLongCodigo + 1
kLongCodigo + 1
kLongReferencia + 1
NA
NA
NA
NA

Descripcin
Folio del documento.
Moneda del documento.
1 = Pesos MN, 2 = Moneda extranjera.
Tipo de cambio del documento.
Importe del documento. Slo se usa en
documentos de cargo/abono.
No tiene uso, valor por omisin = 0 (cero).
No tiene uso, valor por omisin = 0 (cero).
Valor mayor a 5 que indica una aplicacin
diferente a los PAQ's.
Cdigo del concepto del documento.
Serie del documento.
Fecha del documento. Formato mm/dd/aaaa
Las / diagonales son parte del formato.
Cdigo del Cliente/Proveedor.
Cdigo del Agente.
Referencia del Documento.
No tiene uso, valor por omisin = 0 (cero).
Valor por omisin = 0 (cero).
Valor por omisin = 0 (cero).
Valor por omisin = 0 (cero).

Llave del Documento RegLlaveDoc tLlaveDoc*


Campo
aConsepto
aSerie
aFolio

Tipo
Cadena
Cadena
Doble

Longitud
kLongCodigo + 1
kLongSerie + 1
NA

Pgina: 181

Descripcin
Cdigo del concepto del documento.
Serie del documento.
Folio del documento.

Movimientos RegMovimiento tMovimiento


Campo
aConsecutivo
aUnidades
aPrecio
aCosto
aCodProdSer
aCodAlmacen
aReferencia
aCodClasificacion

Tipo
Entero
Doble
Doble
Doble
Cadena
Cadena
Cadena
Cadena

Longitud
NA
NA
NA
NA
kLongCodigo + 1
kLongCodigo + 1
kLongReferencia + 1
kLongCodigo + 1

Descripcin
Consecutivo del movimiento.
Unidades del movimiento.
Precio del movimiento (para doctos. de venta ).
Costo del movimiento (para doctos. de compra).
Cdogo del producto o servicio.
Cdigo del Almacn.
Referencia del movimiento.
Cdigo de la clasificacuin

Movimientos RegMovimiento tMovimientoDesc


Campo
aConsecutivo
aUnidades
aPrecio
aCosto
aPorcDescto1
aImporteDescto1
aPorcDescto2
aImporteDescto2
aPorcDescto3
aImporteDescto3
aPorcDescto4
aImporteDescto4
aPorcDescto5
aImporteDescto5
aCodProdSer
aCodAlmacen
aReferencia
aCodClasificacion

Tipo
Entero
Doble
Doble
Doble
Doble
Doble
Doble
Doble
Doble
Doble
Doble
Doble
Doble
Doble
Cadena
Cadena
Cadena
Cadena

Longitud
NA
NA
NA
NA
NA
NA
NA
NA
NA
NA
NA
NA
NA
NA
kLongCodigo + 1
kLongCodigo + 1
kLongReferencia + 1
kLongCodigo + 1

Pgina: 182

Descripcin
Consecutivo del movimiento.
Unidades del movimiento.
Precio del movimiento (para doctos. de venta ).
Costo del movimiento (para doctos. de compra).
Porcentaje del Descuento 1
Importe del Descuento 1
Porcentaje del Descuento 2
Importe del Descuento 2
Porcentaje del Descuento 3
Importe del Descuento 3
Porcentaje del Descuento 4
Importe del Descuento 4
Porcentaje del Descuento 5
Importe del Descuento 5
Cdogo del producto o servicio.
Cdigo del Almacn.
Referencia del movimiento.
Cdigo de la clasificacuin

Movimientos con Serie/Capas SeriesCapas tSeriesCapas


Campo
aUnidades
aTipoCambio
aSeries
aPedimento
aAgencia
aFechaPedimento
aNumeroLote
aFechaFabricacion
aFechaCaducidad

Tipo
Doble
Doble
Cadena
Cadena
Cadena
Cadena
Cadena
Cadena
Cadena

Longitud
NA
NA
kLongCodigo + 1
kLongDescripcion + 1
kLongDescripcion + 1
kLongFecha + 1
kLongDescripcion + 1
kLongFecha + 1
kLongFecha + 1

Descripcin
Unidades del movimiento.
Tipo de cambio del movimiento.
Series del movimiento.
Pedimento del movimiento.
Agencia aduanal del movimiento.
Fecha de pedimento del movimiento.
Nmero de lote del movimiento.
Fecha de fabricacin del movimiento.
Fecha de Caducidad del movimiento.

Movimientos con Caracteristicas Caracteristicas tCaracteristicas


Campo
aUnidades
aValorCaracteristica1
aValorCaracteristica2
aValorCaracteristica3

Tipo
Doble
Cadena
Cadena
Cadena

Longitud
NA
kLongDescripcion + 1
kLongDescripcion + 1
kLongDescripcion + 1

Pgina: 183

Descripcin
Unidades del movimiento.
Valor de la xaracteristica 1 del movimiento.
Valor de la xaracteristica 2 del movimiento.
Valor de la xaracteristica 3 del movimiento.

Movimientos con datos adicionales RegTipoProducto tTipoProducto


Campo
aSeriesCapas
aCaracteristicas

Tipo
aSeriesCapas
aCaracteristicas

Longitud
NA
NA

Descripcin
Tipo de dato abstracto: tSeriesCapas.
Tipo de dato abstracto: Caracteristicas.

Llave de aperturas RegLlaveAper - tLlaveAper


Campo
aCodCaja
aFechaApe

Tipo
Cadena
Cadena

Longitud
kLongCodigo + 1
kLongFecha + 1

Pgina: 184

Descripcin
Cdigo de la caja.
Fecha de apertura.

Productos RegProducto tProducto


Campo

Tipo

Longitud

cCodigoProducto
cNombreProducto
cDescripcionProducto
cTipoProducto
cFechaAltaProducto
cFechaBaja
cStatusProducto
cControlExistencia
cMetodoCosteo

Cadena
Cadena
Cadena
Entero
Cadena
Cadena
Entero
Entero
Entero

kLongCodigo + 1
kLongNombre + 1
kLongNombreProducto + 1
NA
kLongFecha + 1
kLongFecha + 1
NA
NA
NA

cCodigoUnidadBase
cCodigoUnidadNoConvertible
cPrecio1
cPrecio2
cPrecio3
cPrecio4
cPrecio5
cPrecio6
cPrecio7
cPrecio8
cPrecio9
cPrecio10
cImpuesto1
cImpuesto2
cImpuesto3
cRetencion1
cRetencion2
cNombreCaracteristica1
cNombreCaracteristica2
cNombreCaracteristica3
cCodigoValorClasificacion1
cCodigoValorClasificacion2
cCodigoValorClasificacion3
cCodigoValorClasificacion4
cCodigoValorClasificacion5
cCodigoValorClasificacion6
cTextoExtra1
cTextoExtra2
cTextoExtra3
cFechaExtra
cImporteExtra1
cImporteExtra2
cImporteExtra3
cImporteExtra4

Cadena
Cadena
Doble
Doble
Doble
Doble
Doble
Doble
Doble
Doble
Doble
Doble
Doble
Doble
Doble
Doble
Doble
Cadena
Cadena
Cadena
Cadena
Cadena
Cadena
Cadena
Cadena
Cadena
Cadena
Cadena
Cadena
Cadena
Doble
Doble
Doble
Doble

kLongCodigo + 1
kLongCodigo + 1
NA
NA
NA
NA
NA
NA
NA
NA
NA
NA
NA
NA
NA
NA
NA
kLongAbreviatura + 1
kLongAbreviatura + 1
kLongAbreviatura + 1
kLongCodValorClasif + 1
kLongCodValorClasif + 1
kLongCodValorClasif + 1
kLongCodValorClasif + 1
kLongCodValorClasif + 1
kLongCodValorClasif + 1
kLongTextoExtra + 1
kLongTextoExtra + 1
kLongTextoExtra + 1
kLongFecha + 1
NA
NA
NA
NA

Pgina: 185

Descripcin

Cdigo del producto.


Nombre del producto.
Descripcin del producto.
1- Producto, 2 - Paquete, 3 - Servicio
Fecha de alta del producto.
Fecha de baja del producto.
0 - Baja Lgica, 1 Alta
Control de exixtencia.
1 - Costo Promedio Base a Entradas,
2 - Costo Promedio Base a Entradas Almacen
3 - ltimo costo, 4 - UEPS, 5 - PEPS,
6 - Costo especfico, 7 - Costo Estandar.
Cdigo de la unidad base.
Cdigo de la unidad no convertible.
Lista de precios 1.
Lista de precios 2.
Lista de precios 3.
Lista de precios 4.
Lista de precios 5.
Lista de precios 6.
Lista de precios 7.
Lista de precios 8.
Lista de precios 9.
Lista de precios 10.
Impuesto 1.
Impuesto 2.
Impuesto 3.
Retencin 1.
Retencin 2.
Nombre de la caracteristica 1.
Nombre de la caracteristica 2.
Nombre de la caracteristica 3.
Cdigo del valor de la clasificacin 1.
Cdigo del valor de la clasificacin 2.
Cdigo del valor de la clasificacin 3.
Cdigo del valor de la clasificacin 4.
Cdigo del valor de la clasificacin 5.
Cdigo del valor de la clasificacin 6.
Texto extra 1.
Texto extra 2.
Texto extra 3.
Fecha extra
Importe Extra 1.
Importe Extra 2.
Importe Extra 3.
Importe Extra 4.

Cliente/Proveedor RegCteProv tCteProv


Campo

Tipo

Longitud

cCodigoCliente
cRazonSocial
cFechaAlta
cRFC
cCURP
cDenComercial
cRepLegal
cNombreMoneda
cListaPreciosCliente
cDescuentoMovto
cBanVentaCredito

Cadena
Cadena
Cadena
Cadena
Cadena
Cadena
Cadena
Cadena
Entero
Doble
Entero

kLongCodigo + 1
kLongNombre + 1
kLongFecha + 1
kLongRFC + 1
kLongCURP + 1
kLongDenComercial + 1
kLongRepLegal + 1
kLongNombre + 1
NA
NA
NA

cCodigoValorClasificacionCliente1
cCodigoValorClasificacionCliente2
cCodigoValorClasificacionCliente3
cCodigoValorClasificacionCliente4
cCodigoValorClasificacionCliente5
cCodigoValorClasificacionCliente6
cTipoCliente

Cadena
Cadena
Cadena
Cadena
Cadena
Cadena
Entero

kLongCodValorClasif + 1
kLongCodValorClasif + 1
kLongCodValorClasif + 1
kLongCodValorClasif + 1
kLongCodValorClasif + 1
kLongCodValorClasif + 1
NA

Entero

NA

cFechaBaja
cFechaUltimaRevision
cLimiteCreditoCliente
cDiasCreditoCliente
cBanExcederCredito

Cadena
Cadena
Doble
Entero
Entero

kLongFecha + 1
kLongFecha + 1
NA
NA
NA

cDescuentoProntoPago
cDiasProntoPago
cInteresMoratorio
cDiaPago
cDiasRevision
cMensajeria
cCuentaMensajeria
cDiasEmbarqueCliente
cCodigoAlmacen
cCodigoAgenteVenta
cCodigoAgenteCobro
cRestriccionAgente
cImpuesto1
cImpuesto2
cImpuesto3
cRetencionCliente1
cRetencionCliente2

Doble
Entero
Doble
Entero
Entero
Cadena
Cadena
Entero
Cadena
Cadena
Cadena
Entero
Doble
Doble
Doble
Doble
Doble

NA
NA
NA
NA
NA
kLongDesCorta + 1
kLongDescripcion + 1
NA
kLongCodigo + 1
kLongCodigo + 1
kLongCodigo + 1
NA
NA
NA
NA
NA
NA

cEstatus

...

...

...

Pgina: 186

Descripcin

Cdigo del Cliente / Proveedor.


Razn social.
Fecha de alta.
RFC.
CURP.
Denominacin comercial.
Representante legal.
Nombre de la moneda.
Lista de precios.
Descuento.
Bandera de venta a crdito.
0 No se permite, 1 Se permite.
Cdigo del valor de clasificacin 1.
Cdigo del valor de clasificacin 2.
Cdigo del valor de clasificacin 3.
Cdigo del valor de clasificacin 4.
Cdigo del valor de clasificacin 5.
Cdigo del valor de clasificacin 6.
1 Cliente, 2 Cliente/Proveedor,
3 Proveedor.
Estado:
0 Inactivo, 1 Activo.
Fecha de baja.
Fecha de ltima revisin.
Limite de crdito.
Das de crdito del cliente.
Bandera de exceder crdito.
0 No se permite, 1 Se permite.
Descuento por pronto pago.
Das para pronto pago.
Interes moratorio.
Da de pago.
Das de revisin.
Mensajeria.
Cuenta de mensajeria.
Dias de embarque del cliente.
Cdigo del almacn.
Cdigo del agente de venta.
Cdigo del agente de cobro.
Restriccin de agente.
Impuesto 1.
Impuesto 2.
Impuesto 3.
Retencin al cliente 1.
Retencin al cliente 2.

Continua en la siguiente pgina.

Cliente/Proveedor RegCteProv tCteProv


Campo

Tipo

Longitud

Descripcin

cCodigoValorClasificacionProveedor1
cCodigoValorClasificacionProveedor2
cCodigoValorClasificacionProveedor3
cCodigoValorClasificacionProveedor4
cCodigoValorClasificacionProveedor5
cCodigoValorClasificacionProveedor6
cLimiteCreditoProveedor
cDiasCreditoProveedor
cTiempoEntrega
cDiasEmbarqueProveedor
cImpuestoProveedor1
cImpuestoProveedor2
cImpuestoProveedor3
cRetencionProveedor1
cRetencionProveedor2
cBanInteresMoratorio

Cadena
Cadena
Cadena
Cadena
Cadena
Cadena
Doble
Entero
Entero
Entero
Doble
Doble
Doble
Doble
Doble
Entero

kLongCodValorClasif + 1
kLongCodValorClasif + 1
kLongCodValorClasif + 1
kLongCodValorClasif + 1
kLongCodValorClasif + 1
kLongCodValorClasif + 1
NA
NA
NA
NA
NA
NA
NA
NA
NA
NA

cTextoExtra1
cTextoExtra2
cTextoExtra3
cFechaExtra
cImporteExtra1
cImporteExtra2
cImporteExtra3
cImporteExtra4

Cadena
Cadena
Cadena
Cadena
Doble
Doble
Doble
Doble

kLongTextoExtra + 1
kLongTextoExtra + 1
kLongTextoExtra + 1
kLongFecha + 1
NA
NA
NA
NA

Cdigo del valor de clasificacin 1.


Cdigo del valor de clasificacin 2.
Cdigo del valor de clasificacin 3.
Cdigo del valor de clasificacin 4.
Cdigo del valor de clasificacin 5.
Cdigo del valor de clasificacin 6.
Limite de credito del proveedor.
Das de credito del proveedor.
Tiempo de entrega.
Das de embarque.
Impuesto proveedor 1.
Impuesto proveedor 2.
Impuesto proveedor 3.
Retencin proveedor 1.
Retencin proveedor 2.
Bandera de clculo de interes moratorio.
0 No se calculan, 1 Si se calculan.
Texto extra 1.
Texto extra 2.
Texto extra 3.
Fecha extra.
Importe extra 1.
Importe extra 2.
Importe extra 3.
Importe extra 4.

...

...

...

Pgina: 187

Contina.

Valor de Clasificacion RegValorClasificacion tValorClasificacion


Campo
Tipo
Longitud
NA
cClasificacionDe
Entero
NA
cNumClasificacion
Entero
cCodigoValorClasificacion Cadena kLongCodValorClasif + 1
cValorClasificacion
Cadena
kLongDescripcion + 1

Descripcin
Clasificacin.
Nmero de la clasificacin.
Cdigo del valor de la clasificacin.
Valor de la clasificacin.

Unidad RegUnidad tUnidad


Campo
cNombreUnidad
cAbreviatura
cDespliegue

Tipo
Cadena
Cadena
Cadena

Longitud
kLongNombre + 1
kLongAbreviatura + 1
kLongAbreviatura + 1

Descripcin
Nombre de la unidad.
Abreviatura.
Valor de despliegue.

Direcciones RegDireccion tDireccion


Campo

cCodCteProv
cTipoCatalogo
cTipoDireccion
cNombreCalle
cNumeroExterior
cNumeroInterior
cColonia
cCodigoPostal
cTelefono1
cTelefono2
cTelefono3
cTelefono4
cEmail
cDireccionWeb
cCiudad
cEstado
cPais
cTextoExtra

Tipo

Cadena
Entero
Entero
Cadena
Cadena
Cadena
Cadena
Cadena
Cadena
Cadena
Cadena
Cadena
Cadena
Cadena
Cadena
Cadena
Cadena
Cadena

Longitud

kLongCodigo + 1
NA
NA
kLongDescripcion + 1
kLongNumeroExtInt + 1
kLongNumeroExtInt + 1
kLongDescripcion + 1
kLongCodigoPostal + 1
kLongTelefono + 1
kLongTelefono + 1
kLongTelefono + 1
kLongTelefono + 1
kLongEmailWeb + 1
kLongEmailWeb + 1
kLongDescripcion + 1
kLongDescripcion + 1
kLongDescripcion + 1
kLongDescripcion + 1

Pgina: 188

Descripcin

Cdigo cliente / proveedor.


Tipo de catlogo.
Tipo de direccin.
Calle.
Nmero exterior.
Nmero interior.
Colonia.
Cdigo postal.
Telefono 1.
Telefono 2.
Telefono 3.
Telefono 4.
Correo electrnico.
Pgina web.
Ciudad,
Estado.
Pas.
Texto extra.