MBA3 - Manual API Version - 3.30 - v19.0
MBA3 - Manual API Version - 3.30 - v19.0
MBA3 - Manual API Version - 3.30 - v19.0
30
MANUAL DE API’s
MBA3 v 19.0
-
Con Web Services
INDICE
Introducción 3
Estructura de la tabla en la Base de Datos (BDD) 5
Detalle del Proceso 7
Creación y Actualización de Clientes 9
Creación de Pedidos de Clientes 15
Creación de Facturas de Clientes 19
Creación de Cobros de Clientes 28
Notas de Crédito / Débito 32
Contabilidad 38
Depósitos Otros 40
Creación Facturas de Proveedores 43
Ajuste de Inventario (MA / TE / TI) 47
Creación y Actualización de Productos 53
Creación y Actualización de Ordenes de Compras 59
Recepción de Inventario 62
Cheques Manuales 66
Creación y Actualización de Proveedores 68
Creación de Remisiones Confirmadas 72
Creación de Solicitud de Requisiciones 77
Creación de Pedidos Internos 83
Creación de Ordenes de Producción 89
Creación de SubClientes 94
Creación de Facturas de Clientes / Comercio Exterior / México 97
Creación de Cotizaciones 108
Anexos 112
INTRODUCCION
La integración de Sistemas representa un desafío continuo para las organizaciones. Las Innovaciones en
la tecnología avanzan muy rápidamente, rebasando el tiempo útil de las inversiones que hacemos en
éstas. Como consecuencia de estas innovaciones, nuestros ambientes se vuelven heterogéneos. Por lo
que ante tal desafío, ponemos a disposición la forma de interactuar información de aplicaciones externas
con nuestros Productos de Software.
Este documento pretende mostrar al técnico los pasos que tiene que seguir y la estructura que tiene que
construir para el ingreso de la información al registrar clientes, pedidos, facturas, cobros, hojas de rutas,
notas de débito / crédito, Contabilidad, Recepción de Inventario, Depósitos Otros y Cheques Manuales;
desde una fuente externa.
Además el Producto de Software presenta información que genera para que las aplicaciones EXTERNAS
puedan utilizar en sus procesos de actualización de registros.
Para facilitar al usuario la utilización de otra forma de ingresos y salida de datos desde nuestros productos
se han creado procesos internos que a través de una conexión Web Services o ODBC, podrán
almacenar y obtener la información solicitada en el formato y estructura indicada; esta información será
procesada a través de métodos creados en nuestros productos y se ejecutarán a través del servidor de
API’s (“Servidor de Servicios”) en una estación cliente, para el caso de envío de información desde
una aplicación externa hacia el Producto de Software MBA3 y obtención de información desde el mismo
repositorio para actualizar información desde el Producto de Software MBA3 hacia la aplicación externa.
Nota 1: En caso de manejar los API’s con Web Services (Ver ANEXO E)
Nota 2: En caso de manejar los API’s con una conexión externa ODBC (Ver ANEXO A)
Nota 3: Si necesita configurar y ejecutar Servidor Servicios (Ver ANEXO B)
Se debe tener muy en cuenta que para manejar los procesos API's, el cliente tiene que realizar un
desarrollo extra para inter-actuar con el Producto de Software MBA3 ERP, a través de Web Services o
ODBC y grabar la información que se necesita dependiendo del proceso que desea aplicar (Creación de
clientes, Facturas, etc) y dejarlo en el repositorio mencionado en este documento (tabla: SIST_API),
siguiendo las reglas y en el orden descrito en este manual. La herramienta que utilice queda a
disposición y experiencia de nuestros clientes. Como ejemplo se describe en el “ Anexo D” una conexión
vía ODBC al Producto de Software MBA3 colocando información de Clientes en la tabla “SIST_API” y
ejecutándolo a través del “Monitor de Servicios”.
En el diseño de la estructura de Datos del Producto de Software que posee MBA3 se encuentran creados
el servidor de Web Services y la tabla SIST_API; La estructura de los campos es la misma si se accede
con Web Services o con ODBC y es la siguiente:
Web Services:
Para el correcto acceso de los Web Services se requiere indicar en primer lugar el CORP_s y el campo
ap_pass de Password (ver anexo E) por ejemplo así:
www.miempresa.com:8080/wsAPIS/api_wr?CORP_s=AMERI&ap_pass=12345678
En el Web Services o la tabla SIST_API, dependiendo del tipo de conexión, se requiere llenar algunos
campos que son necesarios sus datos, ya que afectarán el registro de la transacción y otros que se
enviaran a los procesos respectivos con la validación correspondiente; tales campos afectaran al registro
de datos, tenemos:
Nota: Los APIOUT, con códigos de Salida Iguales corresponden al mismo API, se diferencian por el
manejo de la: opcion_i, donde se identifica el proceso diferente.
Datos de Cabecera:
No. Nombre Campo Obl Tamaño Tipo de Dato Especificaciones
1 Código Cliente X 8 Alfanumérico
2 Nombre Cliente X 30 Alfanumérico
3 Identificación X 15 Alfanumérico Identificación Fiscal
4 Número Teléfono 1 14 Alfanumérico
5 Número Teléfono 2 14 Alfanumérico
6 Número de Fax 14 Alfanumérico
7 Dirección 1 80 Alfanumérico
8 Dirección 2 80 Alfanumérico
9 Dirección 3 80 Alfanumérico
10 Código País 5 Alfanumérico Campo Relacionado
11 Código Estado 5 Alfanumérico Campo Relacionado
12 Código Ciudad 5 Alfanumérico Campo Relacionado
13 Código Sector 5 Alfanumérico Campo Relacionado
14 Código Postal 10 Alfanumérico Campo Relacionado
15 E-Mail 30 Alfanumérico
16 Límite Crédito 1 Real Permitido para la moneda 1
17 Límite Crédito 2 Real Permitido para la moneda 2
18 Término de Pagos 8 Entero Expresado en días
Si aplica a todas las monedas el
19 Código Moneda 2 Booleano
campo no debe tener dato
20 Código Zona 5 Alfanumérico Campo Relacionado
21 Código Precio Negociado 5 Alfanumérico Campo Relacionado
22 Código Tipo Cliente 5 Alfanumérico Campo Relacionado
23 Código Vendedor 5 Alfanumérico Campo Relacionado
24 Responsable de la Cuenta 25 Alfanumérico Campo Relacionado
25 Memo Texto
26 Fecha Creación Fecha Formato dd/mm/aa
27 Localización X 1 Alfanumérico L: Local ó E: Extranjero
28 Nombre Extenso 60 Alfanumérico Denominado también Razón Social
29 Código Sucursal 3 Alfanumérico Campo Relacionado
30 Código Cuenta Contable 11 Alfanumérico La cuenta contable sin separadores
31 Lista de Precios X Entero El rango de precios es de 1 a 5
El rango es del 1 al 6, tomando 6
32 Nivel de Riesgo X 2 Alfanumérico
como ninguno
33 Código Transporte 5 Alfanumérico
Los Campos sin Especificaciones NO son usados, pero se debe enviar su definición.
Especificaciones:
Nota 1:
Entrada de Datos:
Campo: CODE_s = 05,
Campo: GROUP_CATEGORY_s = API
Salida de Datos:
Campo: CODE_s = 105,
Campo: GROUP_CATEGORY_s = APIOT
Nota 3:
Tipo de Registro:
Campo: Opción_i = 0 - “Nuevo Cliente”
Campo: Opción_i = 1 - “Actualización Cliente”
Nota Varias:
1) Si NO se usa el campo “TEXTO3_X”, se puede dejar en Blanco
EJEMPLO SQL:
192.168.181.56:8093/wsAPIS/api_wr?CORP_s=AMERI&ap_pass=12345678&CODE_s=‘05’&GROUP_CAT
EGORY_s=’API’&INTEGER_1=1&TEXTO1_10=’2’&TEXTO1_24=‘192.168.181.233’&TEXTO2_X=’CL00007
2|A PRUEBAS
API|1711253573|||||||||||||0|0|0|MN|||||||08/03/2018|L||PRI||1||||||0|0|0|0|0|0||||||||0||||PF|0||0|0
|0||0||||’&NumDoc_s=‘API-
200’&Local_origen=‘ARA’&Local_destino=‘PRI’&ORIGIN=‘ARA’&IDConsulta_s=‘AMERI_ API-200’
EJEMPLO:
Campo Datos
CODE_s 05
CORP_s AMERI
GROUP_CATEGORY_s API
INTEGER_1 1
LONGINT_1 Sequence number([SIST_API])
ORIGIN ARA
TEXTO1_10 2
TEXTO1_24 192.168.181.233
CL000072|A PRUEBAS
TEXTO2_X API|1711253573|||||||||||||0|0|0|MN|||||||08/03/2018|L||PRI||1||||||0|0|0|0|0|0
||||||||0||||PF|0||0|0|0||0||||
TEXTO3_X |||||||||||||||||||||||||||||||
NumDoc_s API-200
Local_origen ARA
Local_destino PRI
IDConsulta_s AMERI_ API-200
Opcion_i 0
Hay 2 tipos de consulta a los APIs por ID o por código de grupo, por ejemplo, para consultar los
nuevos clientes creados se consulta por el código de grupo 105 y el parámetro ap_int1=1 (1= No
procesado, 0= Ya procesado)
192.168.18.14:9974/wsAPIS/api_sel?ap_corp=DGE00&ap_pass=11112222&ap_code=105
CREACION DE PEDIDOS
Para realizar el proceso de creación de pedidos a través de datos externos es decir Web Services o
ODBC, se debe tener muy en cuenta la siguiente información que es necesaria y su orden
correspondiente.
Datos de Cabecera:
Tamaño Tipo de
No. Nombre Campo Obl Máx. Dato Especificaciones
1 Número Pedido Cliente 20 Alfanumérico Referencial
2 Código Cliente 8 Alfanumérico Campo Relacionado
3 Fecha Emisión Pedido X Date Formato “dd/mm/aa”
4 Fecha Entrega Pedido X Date Formato "dd/mm/aa"
5 Código Vendedor 5 Alfanumérico Campo Relacionado
6 Código Moneda X 2 Alfanumérico Campo Relacionado
7 Código Bodega X 5 Alfanumérico Campo Relacionado
8 Código Empresa X 5 Alfanumérico Campo Relacionado
9 Nombre Sub-Cliente 30 Alfanumérico
10 Teléfono del Sub-Cliente 14 Alfanumérico
11 Dirección del Sub-Cliente 80 Alfanumérico
12 Identificación del Sub-Cliente 15 Alfanumérico
13 Código del Sub-Cliente 8 Alfanumérico
14 Identificación Sub-Cliente 15 Alfanumérico
15 Referencias del Sub-cliente 60 Alfanumérico
16 Código Sucursal Origen X 3 Alfanumérico Campo Relacionado
17 Memo Texto
18 Código de transportista 5 Alfanumérico
19 Nombre Solicitante 20 Alfanumérico
Datos de Detalle:
Tamaño Tipo de
No. Nombre Campo Obl Máx. Dato Especificaciones
1 Número del Pedido 20 Alfanumérico Referencial
2 Código del Producto X 20 Alfanumérico Campo Relacionado
3 Cantidad del Producto Real
4 Precio del Producto Real
5 Descuento por Línea del Producto Real
6 En Detalle aplica Impuesto 1-IVA Booleano 1 = Tiene IVA; 0 = No tiene IVA.
7 Secuencial Posición Entero
8 Unidades Gratis Real
9 Fecha Ingreso Producto al Pedido Date Formato "dd/mm/aa"
10 En Detalle aplica Impuesto 2-IPES Booleano 1 = Tiene IVA; 0 = No tiene IVA.
11 Código de Impuesto 2-IPES Texto En Blanco = Impuesto General
12 Precio Solicitado Real
13 Descuento Solicitado Real
Se debe enviar los campos: Text1;
Texto2; Texto3; Fecha1; Fecha2;
14 Campos Adicionales del Detalle Texto
Fecha3; Valor1; Valor2; Valor3.
Si no envía dejar en blanco.
15 Memo Solicitud de Requisición Texto
16 Aplica Promoción Entero 1=Aplica, 0=NO Aplica
Código de Promoción Aplicada, si
17 Código Promoción Texto no lleva dejar en blanco o si el
campo anterior es cero.
18 Cantidad Original Promoción Real Para uso Interno, Poner 0
Nota 1:
Entrada de Datos:
Campo: CODE_s = 01,
Campo: GROUP_CATEGORY_s = API
Salida de Datos:
Campo: CODE_s = 101,
Campo: GROUP_CATEGORY_s = APIOT
Nota 2: Para el proceso de Pedidos el valor del precio puede ser validado o no, en el caso de ser validado
no permitirá que este valor sea cero por lo que obliga a que se envíe un valor, caso contrario el sistema
tomará uno de estos valores:
• Negociado
• Mayorista
• Lista de Precio
Nota 3: Tome en cuenta que el campo “Opcion_i” por defecto se asignará el valor Cero, valida al precio
los Productos.
1: Verifica Precios
2: No valida Precios, valor por defecto.
• Si el sistema detecta en los campos “Aplica IVA” tienen valor “0”, el sistema no aplicará el
impuesto a este producto
• Si el sistema detecta en los campos “Aplica IVA” tienen valor “1”, el sistema aplicará el
impuesto a este producto y la jerarquía se aplicará de acuerdo a la parametrización del Producto
de Software.
SENTENCIA SQL:
192.168.181.56:8093/wsAPIS/api_wr?CORP_s=AMERI&ap_pass=12345678&CODE_s=‘01’&GROUP_CAT
EGORY_s=’API’&INTEGER_1=1&TEXTO1_10=’2’&TEXTO1_24=‘192.168.181.233’&TEXTO2_X=‘TRAMA
CABECERA’&TEXTO3_X=‘TRAMA DETALLE’&Opcion_i=0&INTEGER_4=0&NumDoc_s=‘PED-
100’&Local_origen=‘PRI’&Local_destino=‘PRI’&ORIGIN=‘PRI’&IDConsulta_s=‘AMERI_200’
EJEMPLO:
Campo Datos
CODE_s 01
CORP_s AMERI
GROUP_CATEGORY_s API
INTEGER_1 1
TEXTO1_10 2
TEXTO1_24 192.168.181.233
TEXTO2_X 100|PRI30002|22/03/12|22/03/12||US|GEN|TEPRI||||||||PRI|Memo||
TEXTO3_X 100|KM1|2|10|0|1|1|0|00/00/00|0||0|0||Memo|0|||
100|KM2|2|0|0|1|1|0|00/00/00|0||0|0||Memo|1|PROM001|1
Opcion_i 1
INTEGER_6 0
NumDoc_s PED-100
Local_origen PRI
Local_destino PRI
ORIGIN PRI
IDConsulta_s AMERI_200
El proceso de facturación consiste en la creación del documento principal (Factura) en tres estados;
CONFIRMADAS (Opcion_i=0)
VER-EDITAR (Opcion_i=1)
VER-EDITAR – CONFIRMACION AUTOMATICA (Opcion_i=2)
Datos de Cabecera:
NOTA:
En el caso de usar: VER-EDITAR – CONFIRMACION AUTOMATICA (Opcion_i=2), se debe considerar las
siguientes Observaciones:
1. El campo 1: Número Factura, este valor es un Identificador único de la factura este campo se
almacenará en un campo referencial de la factura, al registrar esta información será validad su
existencia en la base de datos.
2. El campo 22: Tipo de Documento, en este campo se debe registrar el dato del tipo de documento
relacionado a la factura.
3. Si las validaciones son correctas, se procederá a confirmar el documento si en el proceso de
confirmación se marca algún error el registro quedará en Ver/Editar.
Datos de Detalle:
No. Nombre Campo Obl Tamaño Tipo de Dato Especificaciones
Dato Obligatorio para Facturas
1 Número de Factura X Real
Confirmadas
2 Código del Producto X Real
3 Cantidad a Facturar Real
4 Precio Unitario Real
5 Número de Unidades Gratis Real
6 Detalle con IVA Booleano
7 Porcentaje de Descuento por Detalle Real
8 Tamaño Real
9 Valor del Peso Real
10 Valor del Peso Neto Real
11 Color del Producto Alfanumérico
12 Grosor del Producto Real
13 Identificación Alfanumérico
14 Observaciones Texto
15 Información Adicional Texto
16 Referencia Campo Adicional 1 Alfanumérico En Información Adicional TEXTO 1
17 Referencia Campo Adicional 2 Alfanumérico En Información Adicional TEXTO 2
18 Referencia Campo Adicional 3 Alfanumérico En Información Adicional TEXTO 3
19 Referencia Campo Numérico 1 Real En Información Adicional VALOR 1
20 Referencia Campo Numérico 2 Real En Información Adicional VALOR 2
21 Referencia Campo Numérico 3 Real En Información Adicional VALOR 3
22 Referencia Campo de Tipo Fecha 1 Fecha En Información Adicional
23 Referencia Campo de Tipo Fecha 2 Fecha En Información Adicional
24 Referencia Campo de Tipo Fecha 3 Fecha En Información Adicional
Códigos separados y terminados en
(;) en el siguiente orden:
Departamento; Centro de Costo;
25 Multidimensión por Detalle X Booleano
Proyecto; Subproyecto; Análisis 1;
Análisis 2; Análisis 3; Memo
Proyecto;
26 Impuesto 2 Booleano
27 Impuesto 3 Booleano
28 Impuesto 4 Booleano
29 Impuesto 5 Booleano
30 Código del Impuesto 1 Alfanumérico Campo Relacionado
31 Porcentaje del Impuesto 1 Real
Esta factura puede tener detalle de cuotas, datos no necesarios para facturas PENDIENTES A CONFIRMAR
y los datos transmitidos son:
Datos de Cuotas:
No. Nombre Campo Obl Tamaño Tipo de Dato Especificaciones
Tamaño Tipo de
No. Nombre Campo Obl Máx. Dato Especificaciones
Dato Obligatorio para Facturas
1 Número de la Factura X Real
Confirmadas
2 Pedido Manual 20 Alfanumérico
3 Fecha Pedido Manual Fecha Formato: DD/MM/AAAA.
4 Orden de Compra Cliente 20 Alfanumérico
5 Fecha Orden de Compra Fecha Formato: DD/MM/AAAA.
6 Recibo Entrega Mercadería 20 Alfanumérico
Fecha Recibo Entrega
Fecha Formato: DD/MM/AAAA.
7 Mercadería
8 Variable Adicional 1 (*) 20 Alfanumérico
9 Variable Adicional 2 (*) 20 Alfanumérico
10 Variable Adicional 3 (*) 50 Alfanumérico
11 Variable Adicional 4 (*) 50 Alfanumérico
12 Variable Adicional 5 (*) 50 Alfanumérico
13 Variable Adicional 6 (*) 50 Alfanumérico
14 Uso de Documento Digital 5 Alfanumérico Código Relacional ingresado en MBA
15 Tipo de Relación de Documento 5 Alfanumérico Código Relacional ingresado en MBA
16 Documento Relacionado 20 Alfanumérico Número de Factura Afectada
17 Tipo Documento Relacionado 5 Alfanumérico Tipo de Documento Relacionado
18 Referencia Única Interna 10 Alfanumérico Identificación Única de Ventas
(*) Estos campos varían el nombre en función de la aplicación en el manejo de las Addendas, en MBA3
el orden se maneja de izquierda - derecha y de arriba – abajo, es necesario verificar los manuales de las
adendas para determinar los campos obligatorios.
Esta Información se almacena en el campo TEXTO7_X y es obligatorio, si no pasa datos dejar los pipe,
los campos 14 / 15/ 16, se usan en Emisión Digital CFDI 3.3 (México).
Si se pasa en blanco, el campo 14 toma el dato de “G01”, que es un general en el catálogo del SAT.
Los campos 15 y 16, son obligatorios los 2 y se los toma datos de una Factura de Anticipo.
El campo 17 es obligatorio para identificar el tipo de documento a usar.
Los Campos sin Especificaciones NO son usados, pero se debe enviar su definición.
Este esquema y orden son necesarios tener presente en el momento de almacenar la información en la
base de datos (BDD) de nuestro producto para registrar las transacciones de facturas.
Nota 1:
Entrada de Datos:
Campo: CODE_s = 04,
Campo: GROUP_CATEGORY_s = API
Salida de Datos:
Campo: CODE_s = 104,
Campo: GROUP_CATEGORY_s = APIOT
Nota 3: Todos los campos numéricos al no tener un valor, por defecto es necesario enviar CERO.
Los campos de tipo Fecha que no tengan asignado un valor y no sean obligatorios es necesario
enviar el valor por defecto “00/00/00”, los campos de tipo BOOLEANO 0: Falso ó 1: Verdadero
Nota 5: Sólo en las facturas “NO CONFIRMADAS” permitirá enviar el número del documento con
CERO y se manejará el campo “Opcion_i”
Nota 6: Si la operación se utiliza con el código “04”, no es necesario enviar el API de cobros
“02”, ya que el proceso confirma y realiza el cobro con los datos enviados.
Nota 11: Los códigos y valores enviados(no necesarios) en los campos “Código del impuesto
X”; “Porcentaje del impuesto X”, serán validados en el Producto de Software, si existen y
corresponden los valores se aplicarán estos a la operación caso contrario si detecta vacío, el
sistema lo tomará de la parametrización del Producto de Software respetando la jerarquía del
sistema.
Nota 12: Los datos fiscales se almacenan en el Campo: TEXTO6_X, si no se usa dejar en
BLANCO.
SENTENCIA SQL:
INSERT INTO SIST_API(CODE_s, CORP_s, GROUP_CATEGORY_s, INTEGER_1, TEXTO1_10,
TEXTO1_24, TEXTO2_X, TEXTO3_X, TEXTO4_X, NumDoc_s; Origin; Local_Destino; Local_Origen;
IDConsulta_s; Opcion_i)
VALUES(‘04’,’AMERI’,’API’,1,’2’,‘192.168.181.233’,’
001|N0300322|19/03/2012|19/03/2012||||US|0|1|GEN|0|PRI|1|0||||0|||PRI||01;;;;0000000000;;;;|1||
0||00/00/00
001|510005822003|1|75.4464|0|1|0||0|0|||||||||0|0|0|00/00/00|00/00/00|00/00/00|01;;;;0000000000
;;;;|0|0|0|0||0||0||0||0||0||75.45’, ‘9’; ‘PRI, ‘PRI’, ‘PRI, ‘DERMAPRI009’;0)
192.168.181.56:8093/wsAPIS/api_wr?CORP_s=AMERI&ap_pass=12345678&CODE_s=‘04’&GROUP_CAT
EGORY_s=’API’&INTEGER_1=1&TEXTO1_10=’2’&TEXTO1_24=‘192.168.181.233’&TEXTO2_X=’
001|N0300322|19/03/2012|19/03/2012||||US|0|1|GEN|0|PRI|1|0||||0|||PRI||01;;;;0000000000;;;;|1||
0||00/00/00
001|510005822003|1|75.4464|0|1|0||0|0|||||||||0|0|0|00/00/00|00/00/00|00/00/00|01;;;;0000000000
;;;;|0|0|0|0||0||0||0||0||0||75.45’&TEXTO3_X=‘9’; ‘PRI&TEXTO4_X=‘PRI’&NumDoc_s; Origin;
Local_Destino; Local_Origen; IDConsulta_s; Opcion_i=‘PRI
EJEMPLO:
Campo Datos
CODE_s 04
CORP_s AMERI
GROUP_CATEGORY_s API
INTEGER_1 1
LONGINT_1 Sequence number([SIST_API])
ORIGIN ARA
TEXTO1_10 2
TEXTO1_24 192.168.181.233
001|N0300322|19/03/2012|19/03/2012||||US|0|1|GEN|0|PRI|1|0||||0|||PRI||01;;
TEXTO2_X
;;0000000000;;;;|1||0||00/00/00
001|510005822003|1|75.4464|0|1|0||0|0|||||||||0|0|0|00/00/00|00/00/00|00/00/
TEXTO3_X
00|01;;;;0000000000;;;;|0|0|0|0||0||0||0||0||0||75.45
TEXTO4_X 001|19/03/2012|84.5|0|0
TEXTO6_X ||||||||||||||||||||||||||||||||
TEXTO7_X 001|||||||||||||||
NumDoc_s 9
Local_origen ARA
Local_destino PRI
IDConsulta_s AMERI_9
Opcion_i 0
CREACION DE COBROS
Este proceso registra cobros realizados con varios detalles, es decir; aplicadas a varias facturas, con varias
formas de cobros, cuotas: Normal o de reserva; además se aplica a los depósitos correspondientes.
Antes de iniciar el proceso de creación de registros de cobros en el producto, es necesario tener en cuenta
el siguiente esquema de información:
NOTA:
Se implementó como nueva funcionalidad en el manejo de cobros, la posibilidad de hacer el registro sobre
una factura creada con la opción 3: “Ver/Editar Confirmación Automática”, en este caso se debe tomar
en cuenta los siguiente:
2. El Número de Factura que se registre en la trama será validado con el campo de referencia Api
en la Cabecera de la Factura, si existe el número se procederá a continuar con el proceso.
3. El manejo de la Identificación Externa del Cobro sigue de la misma forma, es decir se validará
su existencia.
Datos de Cabecera:
Tamaño
No. Nombre Campo Obl Máx. Tipo de Dato Especificaciones
1 Fecha del Cobro X Formato "dd/mm/aa"
2 Monto del Cobro X Real
3 Código de la Moneda 2 Alfanumérico Campo Relacionado
4 Código del Cliente X 8 Alfanumérico Campo Relacionado
5 Memo del Cobro Texto
6 Identificación Externa obro 10 Alfanumérico
N= Normal
7 Tipo de Operación 1 Alfanumérico R= Reserva
A = Auto Distribución
R = Reserva
8 Manejo de Exceso de pago 1 Alfanumérico
A = Auto Distribución a Pendientes
D = Depositado, Si no deposita
9 Cobro Depositado 1 Alfanumérico
Dejar en Blanco
10 Cuenta del Banco X 15 Campo Relacionado
11 # Papeleta Ref. de Depósito X 30 Real
12 Fecha del Depósito X Formato "dd/mm/aa"
Opciones:
TRANS = Transferencia
13 Origen del Depósito X DEPCE = Depósitos Clientes Otros
DEPCL = Depósitos Clientes
Por defecto Cero. Se pasa el número
14 Secuencial número de Cobro Real del cobro si se usa bajo modalidad
móviles directos.
15 Código Sucursal X 3 Alfanumérico Donde se realiza el Cobro
16 Cotización Real
Datos de Detalle:
Tamaño Tipo de
No. Nombre Campo Obl Máx. Dato Especificaciones
1 Número de la Factura X 30 Alfanumérico O tipo de Documento a ser afectado
Forma de Pago:
Tamaño Tipo de
No. Nombre Campo Obl Máx. Dato Especificaciones
CK = Cheque
EF = Efectivo
TC = Tarjeta de Crédito
1 Código de la Forme de Pago X 2 Alfanumérico
TD = Tarjeta de Débito
OT = Otros
TR = Transferencia
2 Monto de la Forma de Pago Real
Este esquema y orden son necesarios tener presente en el momento de almacenar la información en la
base de datos (BDD) de nuestro producto para registrar las transacciones de cobros.
SENTENCIA SQL:
192.168.181.56:8093/wsAPIS/api_wr?CORP_s=AMERI&ap_pass=12345678&CODE_s=‘02’&GROUP_CAT
EGORY_s=’API’&INTEGER_1=1&TEXTO1_10=’2’&TEXTO1_24=‘192.168.181.233’&TEXTO2_X=22/03/12
|50|MN|001|||N|R|D|4189318|001|22/03/12|DEPCL|1|PRI|11’&TEXTO3_X=‘100000001|1|50||FC’&TEX
TO4_X=EF|50|1||00/00/00|PRI|02||”’&NumDoc_s=‘22354621’&Local_origen=‘ARA’&Local_destino=‘PRI
’&ORIGIN=‘ARA’&IDConsulta_s=‘AMERI_22354621’
EJEMPLO:
Campo Datos
CODE_s 02
CORP_s AMERI
GROUP_CATEGORY_s API
INTEGER_1 1
LONGINT_1 Sequence number([SIST_API])
TEXTO1_10 2
TEXTO1_24 192.168.181.233
TEXTO2_X 22/03/12|50|MN|001|||N|R|D|4189318|001|22/03/12|DEPCL|1|PRI|11
TEXTO3_X 100000001|1|50||FC
TEXTO4_X EF|50|1||00/00/00|PRI|02||”
NumDoc_s 22354621
Local_origen PRI
Local_destino PRI
ORIGIN PRI
IDConsulta_s AMERI_22354621
Opcion_i 0 (Esta opción debe tomar el valor 2, si hace referencia al registro de datos en
facturas como ver/editar – Confirmación Automática.)
Para el proceso se ha dividido en dos partes: Detalle la nota de débito / crédito (tipo de nota utilizadas y
valores) y Distribución (cuotas); los mismos que se componen de:
Datos de Cabecera:
Tamaño Tipo de
No. Nombre Campo Obl Máx. Dato Especificaciones
1 ID del Usuario X Registro la Nota de D/C
2 Código de la Empresa X 5 Alfanumérico Denominado también "CORP"
0=> Nota de Crédito;
3 Nota de Dedito o Crédito X 1=>Nota de Débito
4 Si se Aplica X 1=>Proveedor, 2=>cliente
5 Código Cliente o Proveedor X 20 Alfanumérico
6 Fecha de la Nota de Crédito / Débito Formato dd/mm/aa
# de Factura o R1(código a la
7 Identificador del Documento X
reserva)
Si tienen Apertura en un
8 Código de Apertura Caja
mismo día
Definidos Producto de
9 Código de la Caja
Software
Definidos Producto de
10 Código del Sucursal 3 Alfanumérico
Software
11 Devolución por Inventario
12 Monto del Inventario Real Por defecto 0
13 Monto del Impuesto Real Por defecto 0
14 Monto del Descuento Real Por defecto 0
15 Monto del Impuesto 2 Real Por defecto 0
16 Monto del Impuesto 3 Real Por defecto 0
17 Monto del Impuesto 4 Real Por defecto 0
18 Monto del Impuesto 5 Real Por defecto 0
19 Código de Moneda 2 Alfanumérico
20 Referencia Externa 20 Alfanumérico
21 Tipo Documento Factura 5 Alfanumérico
Datos de Detalle:
Tamaño Tipo de
No. Nombre Campo Obl Máx. Dato Especificaciones
1 Tipo de Nota Aplicado X Alfanumérico
2 Valor Total de la Línea X Real
3 Si la Línea Aplica o no Impuesto 1 Booleano 1 = Aplica / 0 = No aplica
4 Si la Línea Aplica o no el IVA Booleano 1 = Aplica / 0 = No aplica
Códigos separados y terminados
en (;) en el siguiente orden:
Departamento; Centro de Costo;
5 Contenido de Multidimensión Booleano
Proyecto; Subproyecto; Análisis
1; Análisis 2; Análisis 3; Memo
Proyecto;
6 Memo de la Nota 50 Alfanumérico
7 Valor Proporcional de la Factura Real Por defecto 0
8 Valor Proporcional del Impuesto 1 Real Por defecto 0
9 Valor Proporcional del Impuesto 2 Real Por defecto 0
10 Valor Proporcional del Impuesto 3 Real Por defecto 0
11 Valor Proporcional del Impuesto 4 Real Por defecto 0
12 Valor Proporcional del Impuesto 5 Real Por defecto 0
13 Si la Línea aplica o no el Impuesto 2 Booleano 1 = Aplica / 0 = No aplica
14 Si la Línea aplica o no el Impuesto 3 Booleano 1 = Aplica / 0 = No aplica
15 Si la Línea aplica o no el Impuesto 4 Booleano 1 = Aplica / 0 = No aplica
16 Si la Línea aplica o no el Impuesto 5 Booleano 1 = Aplica / 0 = No aplica
17 Valor Porcentaje Impuesto 1 Real Porcentaje de Impuesto
18 Valor Porcentaje Impuesto 2 Real Porcentaje de Impuesto
19 Valor Porcentaje Impuesto 3 Real Porcentaje de Impuesto
20 Valor Porcentaje Impuesto 4 Real Porcentaje de Impuesto
21 Valor Porcentaje Impuesto 5 Real Porcentaje de Impuesto
22 Código del Impuesto 1 3 Alfanumérico
23 Código del Impuesto 2 3 Alfanumérico
24 Código del Impuesto 3 3 Alfanumérico
25 Código del Impuesto 4 3 Alfanumérico
26 Código del Impuesto 5 3 Alfanumérico
Detalle de Cuota:
Tamaño Tipo de
No. Nombre Campo Obl Máx. Dato Especificaciones
1 # de la Cuota a la cuál será Afectada X Real
2 Valor de la Cuota X Real
Los Campos sin Especificaciones NO son usados, pero se debe enviar su definición.
SENTENCIA SQL:
192.168.181.56:8093/wsAPIS/api_wr?CORP_s=AMERI&ap_pass=12345678&CODE_s=‘10’&GROUP_CAT
EGORY_s=’API’&INTEGER_1=1&TEXTO1_10=’2’&TEXTO1_24=‘192.168.181.233’&TEXTO2_X=“1|FUTU
R|0|2|TIJ00986|29/03/12|1000000000|||TIJ|0|0|0|0|0|0|0|0|US|REFEXT| TIPDOCFAC”&TEXTO3_X=’
CHD01|140|0|0|;;;;;;;;||140|0|0|0|0|0|0|0|0|0|0|0|0|0|0|||||’&TEXTO4_X;
Opcion_i=‘1|140’&Local_origen=1&Local_destino=‘ARA’&ORIGIN=‘PRI’&IDConsulta_s=‘ARA’
EJEMPLO
Campo Datos
CODE_s 10
CORP_s AMERI
GROUP_CATEGORY_s API
INTEGER_1 1
LONGINT_1 Sequence number([SIST_API])
TEXTO1_10 2
TEXTO1_24 192.168.181.233
TEXTO2_X 1|FUTUR|0|2|TIJ00986|29/03/12|1000000000|||TIJ|0|0|0|0|0|0|0|0|US|REFEXT|
TIPDOCFAC
TEXTO3_X CHD01|140|0|0|;;;;;;;;||140|0|0|0|0|0|0|0|0|0|0|0|0|0|0|||||
TEXTO4_X 1|140
TEXTO6_X 001001000000123|NCR|01/05/2018|12:45|1|||||
TEXTO7_X ||||||||||||||||||||||||||||||||
Opcion_i 0=Ver/Editar / 1= Confirmado / 2 = Impreso
Local_origen PRI
Local_destino PRI
ORIGIN PRI
IDConsulta_s AMERI_10245
CONTABILIDAD
Dentro del API para el manejo de los procesos contables, se tiene la siguiente estructura.
Datos de Cabecera:
Tamaño Tipo de
No. Nombre Campo Obl Máx. Dato Especificaciones
1 Número del Asiento X Entero Dato no debe existir en Sistema
Dato que debe estar creado en
2 Cuenta Contable X 20 Alfanumérico
el Sistema
Se debe enviar al menos 5
3 Referencia del Asiento 50 Alfanumérico
carácteres y máximo 50
4 Valor del Débito Real
5 Valor del Crédito Real
6 Código de la Moneda X 2 Alfanumérico
7 Fecha del Asiento X Date Formato "dd/mm/aa
8 Asiento a Convertir Booleanoo 1: Convierte; 0: No Convierte
Códigos separados y terminados
en (;) en el siguiente orden:
Departamento; Centro de Costo;
9 Multidimensión 15 Alfanumérico
Proyecto; Subproyecto; Análisis
1; Análisis 2; Análisis 3; Memo
Proyecto;
10 Memo Texto
Valores Posibles : 1=Ingreso , 2
= Egreso , 3 = Diario, si no
11 Tipo de Asiento 1 Entero
tiene valor por defecto se
asignada "Diario"
Estos datos serán almacenados en el campo TEXTO2_x de la tabla de API’s. Si el asiento tiene “n” líneas
de detalle, toda esta información deberá ingresar en un solo registro para dicha operación con un máximo
de 32 KB. Considerando que la información corresponda a un registro completo.
Nota 2: Se debe tener en cuenta que hay que enviar un detalle por Asiento.
SENTENCIA SQL:
INSERT INTO SIST_API(CODE_s, CORP_s, GROUP_CATEGORY_s, INTEGER_1, TEXTO1_10,
TEXTO1_24, TEXTO2_X, NumDoc_s, IDConsulta_s, Opcion_i, Local_origen, Local_destino, ORIGIN)
VALUES(‘08’,’AMERI’,’API’,1,’2’,‘192.168.181.233’,’830|99999999000|Memo_Asiento||50|
MN|27/03/2012|1|;;;;;;;MEMO PROYECTO;|Memo Linea|3’, 100,’ AMERI_100’,0, ‘ARA’, ‘PRI’, ‘ARA’)
192.168.181.56:8093/wsAPIS/api_wr?CORP_s=AMERI&ap_pass=12345678&CODE_s=‘08’&GROUP_CAT
EGORY_s=’API’&INTEGER_1=1&TEXTO1_10=’2’&TEXTO1_24=‘192.168.181.233’&TEXTO2_X=’830|999
99999000|Memo_Asiento||50|
MN|27/03/2012|1|;;;;;;;MEMO PROYECTO;|Memo Linea|3’&NumDoc_s=100&IDConsulta_s=’
AMERI_100’&Opcion_i=0&Local_origen=‘ARA’&Local_destino=‘PRI’&ORIGIN=‘ARA’
EJEMPLO:
Campo Datos
CODE_s 08
CORP_s AMERI
GROUP_CATEGORY_s API
INTEGER_1 1
LONGINT_1 Sequence number([SIST_API])
TEXTO1_10 2
TEXTO1_24 192.168.181.233
830|99999999000|ReferenciadelAsiento||50|MN|27/03/2012|1|;;;;;;;;|MemoLine
TEXTO2_X a_1|3|830|8888888000|ReferenciadelAsiento|50||MN|27/03/2012|1|;;;;;;;;|Mem
oLinea_2|3
TEXTO3_X
NumDoc_s 100
IDConsulta_s AMERI_100
Opcion_i 0
Local_origen PRI
Local_destino PRI
ORIGIN PRI
DEPOSITOS OTROS
Este proceso permite automatizar el ingreso de depósitos otros contra cuentas contables (Ejm. Ingreso
de operaciones financieras -Intereses ganado)
Datos de Cabecera:
Tamaño Tipo de
No. Nombre Campo Obl Máx. Dato Especificaciones
1 Fecha del Depósito X Date Formato dd/mm/aa
2 Cuenta del Banco X 20 Alfanumérico
3 Monto total de Depósito X Real
4 Referencia del Depósito Real
5 Moneda del Depósito X 2 Alfanumérico
6 Fecha Papeleta del Depósito X Date Formato dd/mm/aa
7 # de Cheques del Depósito Real
8 Memo del Depósito 60
Códigos separados y terminados
en(;) en el siguiente orden:
Departamento; Centro de Costo;
9 Multidimensión 15 Alfanumérico
Proyecto; Subproyecto; Análisis 1;
Análisis 2; Análisis 3; Memo
Proyecto;
10 Código Sucursal Origen Depósito X 3 Alfanumérico
Datos de Detalle:
Tamaño Tipo de
No. Nombre Campo Obl Máx. Dato Especificaciones
1 Código de la Cuenta Contable X 11 Alfanumérico
Valor que será afectado a la Cuenta
2 Contable X Real
3 Memo de la Cuenta 80 Alfanumérico
Códigos separados y terminados
en(;) en el siguiente orden:
Departamento; Centro de Costo;
4 Multidimensión 15 Alfanumérico
Proyecto; Subproyecto; Análisis 1;
Análisis 2; Análisis 3; Memo
Proyecto;
5 Código de la forma de pago
SENTENCIA SQL:
INSERT INTO SIST_API(CODE_s, CORP_s, GROUP_CATEGORY_s, INTEGER_1, TEXTO1_10,
TEXTO1_24, TEXTO2_X, TEXTO3_X ,NumDoc_s, IDConsulta_s, Local_origen, Local_destino, ORIGIN )
VALUES(‘09’,’AMERI’,’API’,1,’2’,’192.168.181.233’,‘
26/05/2011|0147104553|110|123|MN|26/05/2011|1|MEMO DEPOSITO|;;;;;;;;|PRI|DEPCL’,‘
99999990000|110|MEMOOO|01;10;10;10;A10;;;MEMOO;||’, 159789,’159789_1’, ‘ARA’, ‘PRI’, ‘ARA’)
192.168.181.56:8093/wsAPIS/api_wr?CORP_s=AMERI&ap_pass=12345678&CODE_s=‘09’&GROUP_CAT
EGORY_s=’API’&INTEGER_1=1&TEXTO1_10=’2’&TEXTO1_24=’192.168.181.233’&TEXTO2_X=‘
26/05/2011|0147104553|110|123|MN|26/05/2011|1|MEMO
DEPOSITO|;;;;;;;;|PRI|DEPCL’&TEXTO3_X=‘
99999990000|110|MEMOOO|01;10;10;10;A10;;;MEMOO;||’&NumDoc_s=159789&IDConsulta_s=’15978
9_1’&Local_origen=‘ARA’&Local_destino=‘PRI’&ORIGIN=‘ARA’
EJEMPLO
Campo Datos
CODE_s 09
CORP_s AMERI
GROUP_CATEGORY_s API
INTEGER_1 1
LONGINT_1 Sequence number([SIST_API])
TEXTO1_10 2
TEXTO1_24 192.168.181.233
26/05/2011|0147104553|110|123|MN|26/05/2011|1|MEMO
TEXTO2_X
DEPOSITO|;;;;;;;;|PRI|DEPCL
TEXTO3_X 99999990000|110|MEMOOO|01;10;10;10;A10;;;MEMOO;||
NumDoc_s 159789
IDConsulta_s 159789_1
Local_origen ARA
Local_destino PRI
ORIGIN ARA
Datos de Cabecera:
Tamaño Tipo de
No. Nombre Campo Obl Máx. Dato Especificaciones
1 Número de la Factura X Real No permite el envío de cero
2 Código del Proveedor X 8 Alfanumérico
3 Código de la Moneda X 2 Alfanumérico
4 Fecha de la Factura X Date Formato dd/mm/aa
5 Código de la Sucursal X 3 Alfanumérico
6 Valor descuento por Factura Real
7 Porcentaje de Descuento Real Rango entre 0 Y 100
8 Estado de Recepción Total o Parcial
1 = Recepcionada;
9 Si la Factura fue Recepcionada Booleano 0 = No Recepcionada (x defecto)
10 Cotización Real
11 Campo Memo de la Factura Texto
12 Documento Relacionado a la Factura 20 Alfanumérico
13 # de pagos de la Factura Real
Códigos separados y terminados
en(;) en el siguiente orden:
Departamento; Centro de Costo;
14 Multidimensión 80 Alfanumérico
Proyecto; Subproyecto; Análisis 1;
Análisis 2; Análisis 3; Memo
Proyecto;
15 Código Retención aplicada a la Factura 2 Alfanumérico
16 Porcentaje de la Retención Real
17 Monto de la Retención Real
18 Nombre en pago 30 Alfanumérico
19 Código del tipo de comprobante 5 Alfanumérico Campo Relacionado
En este campo los valores serán
separado y terminados con (;),
el orden a enviar:
5 campos alfanuméricos de 20
20 Campos Adicionales caracteres,
5 campos reales, si no se envía
valor debe ir cero y 5 campos tipo
fecha, si no se envía valor debe ir
00/00/00
21 Código de Sucursal de Recepción 3 Alfanumérico Campo Relacionado
22 Código del Bodega de Recepción 3 Alfanumérico Campo Relacionado
Datos de Detalle:
Tamaño Tipo de
No. Nombre Campo Obl Máx. Dato Especificaciones
1 Código del Producto X 20 Alfanumérico
2 Cantidad del Producto a Facturar X Real No puede ser 0
3 Valor del Costo de la Compra Real
Para este tipo de documento se generan cuotas de pago, dependiendo del número de cuotas se agregará
la información en este orden y los siguientes datos:
Datos de Cuotas:
Tamaño Tipo de
No. Nombre Campo Obl Máx. Dato Especificaciones
1 Fecha pago de la cuota Date Formato "dd/mm/aa
2 Valor de la Cuota Real
3 Valor de la Retención Real
Nota 2: Si se aplica retenciones deberá ubicar en el campo Texto 4B_x. Si son varias
retenciones deberán ir separadas por punto y coma(;).
SENTENCIA SQL:
INSERT INTO SIST_API(CODE_s, CORP_s, GROUP_CATEGORY_s, INTEGER_1, TEXTO1_10,
TEXTO1_24, TEXTO2_X, TEXTO3_X, TEXTO4_X, NumDoc_s, IDConsulta_s, Local_origen, Local_destino,
ORIGIN )
VALUES(‘14’,’AMERI’,’API’,1,’2’,’192.168.181.233’,‘
100|P0168|MN|25/01/12|PRI||0|PARCIAL|0||MEMO_FACTURA|||;;;;;;;;|||||Fact|’,‘
KM1|5|10|0|0|0|0|0|0|;;;’, ‘25/01/12|50|0’, 1231,’ AMERI_1231’, ‘PRI, ‘PRI’, ‘PRI)
192.168.181.56:8093/wsAPIS/api_wr?CORP_s=AMERI&ap_pass=12345678&CODE_s=‘14’&GROUP_CAT
EGORY_s=’API’&INTEGER_1=1&TEXTO1_10=’2’&TEXTO1_24=’192.168.181.233’&TEXTO2_X=‘
100|P0168|MN|25/01/12|PRI||0|PARCIAL|0||MEMO_FACTURA|||;;;;;;;;|||||Fact|’&TEXTO3_X=‘
KM1|5|10|0|0|0|0|0|0|;;;’&TEXTO4_X=‘25/01/12|50|0’&NumDoc_s=1231&IDConsulta_s=’
AMERI_1231’&Local_origen=‘PRI&Local_destino=‘PRI’&ORIGIN=‘PRI
EJEMPLO:
Campo Datos
CODE_s 14
CORP_s AMERI
GROUP_CATEGORY_s API
INTEGER_1 1
LONGINT_1 Sequence number([SIST_API])
TEXTO1_10 2
TEXTO1_24 192.168.181.233
TEXTO2_X FAP-1001|P9001|MN|08/12/2015|PRI|0|0|TOTAL|0|0|MEMO
FACTURA|0|1|;;;;;;;|||0|NOMBRE PAGO|TIP01||PRI|01
TEXTO3_X RP1|1|11|1|0|0|0|0|1|;;;;;;;
TEXTO4_X 31/12/2015|33|0
TEXTO4B_X Si hay datos de Retenciones :
RET01|100|10|MEMO RET|;;;;;;;
NumDoc_s 1231
IDConsulta_s AMERI_1231
Local_origen PRI
Local_destino PRI
ORIGIN PRI
AJUSTE DE INVENTARIO
El proceso de AJUSTE DE INVENTARIOS consiste en generar un ajuste de existencias (+/-) CONFIRMADO;
además tener en cuenta los Tipos de Ajustes:
Código Descripción
MA AJUSTE
TE TRANSFERENCIA DE EGRESO
TI TRANSFERENCIA DE INGRESO
Datos de Cabecera:
Tamaño Tipo de
No. Nombre Campo Obl Máx. Dato Especificaciones
Número de control externo, MBA
valida su no duplicación, el número de
1 Número de Control Externo X Entero ajuste lo asigna el Secuencial.
2 Código Bodega Origen X 3 Alfanumérico Campo Relacionado
3 Memo Texto
4 Código Sucursal Destino X 3 Alfanumérico Campo Relacionado
5 Código Sucursal Origen X 3 Alfanumérico Campo Relacionado
6 Código del Tipo de Ajuste 3 Alfanumérico Aplica solo a Ajuste de Inventario
Tamaño Tipo de
No. Nombre Campo Obl Máx. Dato Especificaciones
20 Nota Débito o Crédito Real
21 Valor del Impuesto 1 Real
22 Valor del Descuento Real
23 Valor del Impuesto 2 Real
24 Valor del Impuesto 3 Real
25 Valor del Impuesto 4 Real
26 Valor del Impuesto 5 Real
Datos de Detalle:
Tamaño Tipo de
No. Nombre Campo Obl Máx. Dato Especificaciones
1 Código del Producto X 30 Alfanumérico
2 Listado de Seriales Texto Separados por (;) y terminado en (;)
Nota 1:
Entrada de Datos:
Campo: CODE_s = 12,
Campo: GROUP_CATEGORY_s = API
Salida de Datos:
Campo: CODE_s = 112,
Campo: GROUP_CATEGORY_s = APIOT
Nota 2: Dentro del Sistema de MBA3 existe la parametrización para crear Ubicaciones
automáticamente en el manejo de Lotes.
Si éste parámetro no está habilitado, el proceso valida la Ubicación enviada a través
del API a una existente en el sistema.
Nota 3: Si en el Sistema MBA 3 existe creada la Ubicación “N/U”, el proceso pasa por
alto las Ubicaciones enviadas o no enviadas y se asigna todo a la Ubicación “N/U”.
Nota 4: Para el caso de manejo de Transferencias y ajustes para el manejo del costo
promedio, se tiene el campo “Opcion_i” el mismo que:
Nota 5: Para el manejo de Transferencias de Ingreso(TI) es necesario que los datos del
detalle sean similar a los de la Transferencia de Egreso(TE) ya que el sistema controlará
el código del producto cantidades y bodegas.
SENTENCIA SQL:
INSERT INTO SIST_API(CODE_s, CORP_s, GROUP_CATEGORY_s, INTEGER_1, TEXTO1_10,
TEXTO1_24, TEXTO2_X, TEXTO3_X, NumDoc_s, IDConsulta_s, Local_origen, Local_destino, ORIGIN )
VALUES(‘12’,’AMERI’,’API’,1,’2’,’192.168.181.233’, 100|GEN|MEMO
AJUSTE|PRI|PRI|SIN||50101010100||Ref
Externa||;;;;;;;;|MA|GEN|100|||20/03/2012|500|0|0|0|0|0|0|0',
636390502202|||+||10|0|10|;;;;;;;;|100|0|0|0|0|0|0|0|0',117,’AMRI_117’, 'PRI', ‘PRI’, 'PRI')
192.168.181.56:8093/wsAPIS/api_wr?CORP_s=AMERI&ap_pass=12345678&CODE_s=‘12’&GROUP_CAT
EGORY_s=’API’&INTEGER_1=1&TEXTO1_10=’2’&TEXTO1_24=’192.168.181.233’&TEXTO2_X=100|GEN
|MEMO AJUSTE|PRI|PRI|SIN||50101010100||Ref
Externa||;;;;;;;;|MA|GEN|100|||20/03/2012|500|0|0|0|0|0|0|0'&TEXTO3_X=636390502202|||+||10|0|
10|;;;;;;;;|100|0|0|0|0|0|0|0|0'&NumDoc_s=117&IDConsulta_s=’AMRI_117’&Local_origen='PRI'&Local
_destino=‘PRI’&ORIGIN='PRI'
Campo Datos
CODE_s 12
CORP_s AMERI
GROUP_CATEGORY_s API
INTEGER_1 1
LONGINT_1 Sequence number([SIST_API])
TEXTO1_10 2
TEXTO1_24 192.168.181.233
TEXTO2_X 100|GEN|MEMO AJUSTE|PRI|PRI|SIN||50101010100||Ref
Externa||;;;;;;;;|MA|GEN|100|||20/03/2012|500|0|0|0|0|0|0|0
TEXTO3_X 636390502202|||+||10|0|10|;;;;;;;;|100|0|0|0|0|0|0|0|0
NumDoc_s 117
IDConsulta_s AMERI_117
Local_origen PRI
Local_destino PRI
ORIGIN PRI
SENTENCIA SQL:
INSERT INTO SIST_API(CODE_s, CORP_s, GROUP_CATEGORY_s, INTEGER_1, TEXTO1_10,
TEXTO1_24, TEXTO2_X, TEXTO3_X, NumDoc_s, IDConsulta_s, Local_origen, Local_destino, ORIGIN )
VALUES(‘12’,’AMERI’,’API’,1,’2’,’192.168.181.233’,’
101|BDA|MEMOTRANSF|PRI|PRI|||51200001000||REF_EXTERNA||;;;;;;;;|TE|DES|50|00051||03/06/201
1|0|0|0|0|0|0|0|0’,’ KM1|||-||10||50||500|50|0|0|0|0|0|0|0',116,’TE-116’, 'PRI', ‘PRI’, 'PRI')
192.168.181.56:8093/wsAPIS/api_wr?CORP_s=AMERI&ap_pass=12345678&CODE_s=‘12’&GROUP_CAT
EGORY_s=’API’&INTEGER_1=1&TEXTO1_10=’2’&TEXTO1_24=’192.168.181.233’&TEXTO2_X=’
101|BDA|MEMOTRANSF|PRI|PRI|||51200001000||REF_EXTERNA||;;;;;;;;|TE|DES|50|00051||03/06/201
1|0|0|0|0|0|0|0|0’&TEXTO3_X=’ KM1|||-
||10||50||500|50|0|0|0|0|0|0|0'&NumDoc_s=116&IDConsulta_s=’TE-
116’&Local_origen='PRI'&Local_destino=‘PRI’&ORIGIN='PRI'
TRANSFERENCIAS DE EGRESO
Campo Datos
CODE_s 12
CORP_s AMERI
GROUP_CATEGORY_s API
INTEGER_1 1
LONGINT_1 Sequence number([SIST_API])
TEXTO1_10 2
TEXTO1_24 192.168.181.233
101|BDA|MEMOTRANSF|PRI|PRI|||51200001000||REF_EXTERNA||;;;;;;;;|TE|DES
TEXTO2_X
|50|00051||03/06/2011|0|0|0|0|0|0|0|0
TEXTO3_X KM1|||-||10||50||500|50|0|0|0|0|0|0|0
NumDoc_s 116
IDConsulta_s TE-116
Local_origen PRI
Local_destino PRI
ORIGIN PRI
SENTENCIA SQL:
INSERT INTO SIST_API(CODE_s, CORP_s, GROUP_CATEGORY_s, INTEGER_1, TEXTO1_10,
TEXTO1_24, TEXTO2_X, TEXTO3_X, NumDoc_s, IDConsulta_s, Local_origen, Local_destino, ORIGIN )
VALUES(‘12’,’AMERI’,’API’,1,’2’,’192.168.181.233’,’
101|BDA|MEMOTRANSF|PRI|PRI|||51200001000||REF
EXTERNA||;;;;;;;;|TI|DES|50|00051||03/06/2011|0|0|0|0|0|0|0|0’ ,’
KM1|||+||10||50||500|50|0|0|0|0|0|0|0’,116,’TI-116’, 'PRI', ‘PRI’, 'PRI')
192.168.181.56:8093/wsAPIS/api_wr?CORP_s=AMERI&ap_pass=12345678&CODE_s=‘12’&GROUP_CAT
EGORY_s=’API’&INTEGER_1=1&TEXTO1_10=’2’&TEXTO1_24=’192.168.181.233’&TEXTO2_X=’
101|BDA|MEMOTRANSF|PRI|PRI|||51200001000||REF
EXTERNA||;;;;;;;;|TI|DES|50|00051||03/06/2011|0|0|0|0|0|0|0|0’&TEXTO3_X=’
KM1|||+||10||50||500|50|0|0|0|0|0|0|0’&NumDoc_s=116&IDConsulta_s=’TI-
116’&Local_origen='PRI'&Local_destino=‘PRI’&ORIGIN='PRI'
Campo Datos
CODE_s 12
CORP_s AMERI
GROUP_CATEGORY_s API
INTEGER_1 1
LONGINT_1 Sequence number([SIST_API])
TEXTO1_10 2
TEXTO1_24 192.168.181.233
101|BDA|MEMOTRANSF|PRI|PRI|||51200001000||REF
TEXTO2_X
EXTERNA||;;;;;;;;|TI|DES|50|00051||03/06/2011|0|0|0|0|0|0|0|0
TEXTO3_X KM1|||+||10||50||500|50|0|0|0|0|0|0|0
NumDoc_s 116
IDConsulta_s TI-116
Local_origen PRI
Local_destino PRI
ORIGIN PRI
Datos de Cabecera:
Tamaño
No. Nombre Campo Obl Máx. Tipo de Dato Especificaciones
1 Código Producto X 20 Alfanumérico
2 Nombre Producto X 30 Alfanumérico
3 Categoría 15 Alfanumérico
4 Unidad de Medida 5 Alfanumérico
5 Código de Grupo 5 Alfanumérico Campo Relacionado
6 Código de Subgrupo 5 Alfanumérico Campo Relacionado
7 Paga IVA X Booleano
C: Consumo; P: Venta; S:
8 Código Tipo Producto X 1 Alfanumérico
Servicio; M: Materia Prima
9 Cuenta Costo de Venta X 11 Alfanumérico Según el Tipo de Producto
10 Cuenta Costo de Ingreso X 11 Alfanumérico Según el Tipo de Producto
11 Cuenta Costo de Inventario X 11 Alfanumérico Según el Tipo de Producto
12 Cuenta Costo de Gasto X 11 Alfanumérico Según el Tipo de Producto
13 Código Unidad de Medida 10 Alfanumérico
14 Unidad Medida de Control Booleano
15 Lotes X Booleano
16 Seriales X Booleano
17 Número Inicial de Lote Entero
18 Número Inicial de Serial Entero
19 Código Ultima Compra Real
20 Código Ultima Compra 2 Real
21 Costo Reposición Real
22 Costo Reposición 2 Real
23 Peso Neto Real
24 Peso Bruto Real
25 Porcentaje Comisión 1 Real
26 Porcentaje Comisión 2 Real
Tamaño Tipo de
No. Nombre Campo Obl Máx. Dato Especificaciones
27 Valor Comisión 1 Real
28 Valor Comisión 2 Real
29 Control Automático o Parcial X Booleano
30 Precio 1 Real Moneda 1 por Defecto
31 Precio 2 Real Moneda 1 por Defecto
32 Precio 3 Real Moneda 1 por Defecto
33 Precio 4 Real Moneda 1 por Defecto
34 Precio 5 Real Moneda 1 por Defecto
35 Precio 1 Real Segunda Moneda
36 Precio 2 Real Segunda Moneda
37 Precio 3 Real Segunda Moneda
38 Precio 4 Real Segunda Moneda
39 Precio 5 Real Segunda Moneda
40 Días Caducidad Entero Expresado en Días
Código Grupo de Impresión
41 5 Alfanumérico
Factura
42 No Generar BackOrder Entero Pedidos de Clientes
43 Largo Real
44 Ancho Real
45 Alto Real
46 Volumen Real
47 Descripción Adicional Texto
48 Nombre Alterno 2 50 Alfanumérico
49 Nombre Alterno 3 50 Alfanumérico
50 Partida Arancelaria 20 Alfanumérico
51 Presentación 20 Alfanumérico
52 Código Impuesto 5 Alfanumérico Campo Relacionado
Producto de Ingreso Automático a
53 Cuarentena X Booleano bodega de Control de Calidad /
cuarentena
54 Bodega Cuarentena 3 Alfanumérico
55 Lote Mínimo Real
56 Lote Máximo 5 Real
57 Lote Estándar Real
58 Lote Inicio Producción X Booleano
59 Fecha Creación Receta Date Formato: dd/mm/aa
60 Unidades Empaque Real Numérico
Porcentaje de Tolerancia en
61 Real El rango va desde 1 hasta 100
Recepciones
Tamaño Tipo de
No. Nombre Campo Obl Máx. Dato Especificaciones
62 Facturar Empaques Enteros X Booleano
63 Producto con Segunda Unidad X Booleano
64 Producto de Empaques X Booleano
Unidad de Medida de la
65 5 Alfanumérico
Segunda Unidad
66 Ajuste Primera Unidad X Booleano
Al Facturar Generar una línea
67 X Booleano
por Empaque
68 Análisis Adicional X Booleano
69 Código Bodega de Ingreso 3 Alfanumérico Por defecto Producto Terminado
70 Código Bodega de Ingreso X 3 Alfanumérico Por defecto Producto en Proceso
71 Código Alterno Producto 20 Alfanumérico
72 Cuenta Contable Activo X 11 Alfanumérico
DE: Desarrollo / Vegetativo; DP:
73 Tipo del Ciclo del Producto 2 Alfanumérico
Desarrollo / Productivo
74 Código Grupo de Precios 5 Alfanumérico Campo Relacionado
75 No Permitir dar Descuentos X Booleano
76 Descuento por Producto Real Numérico
77 Departamento 3 Alfanumérico Utilizado para Multidimensión
78 Centro de Costos 3 Alfanumérico Utilizado para Multidimensión
79 Proyecto 3 Alfanumérico Utilizado para Multidimensión
80 Sub-Proyecto 3 Alfanumérico Utilizado para Multidimensión
81 Análisis 1 3 Alfanumérico Utilizado para Multidimensión
82 Análisis 2 3 Alfanumérico Utilizado para Multidimensión
83 Análisis 3 3 Alfanumérico Utilizado para Multidimensión
Siempre y cuando el producto
84 Código de Grupo de Lotes 5 Alfanumérico
maneje Lotes
85 Código de Etiqueta Entero Campo Relacionado
Número de Etiquetas a
86 Entero
Imprimir
Recepción de producto Bodega de Control de Calidad /
87 Booleano
ingreso a Bodega Cuarentena
Para la bodega Control de Calidad /
88 Código de la Bodega 3 Alfanumérico
Cuarentena
89 Estatus de Ingreso 5 Alfanumérico Para Producto Lotizado
90 Ubicación 15 Alfanumérico
Producto de Ingreso A Bodega de Control de Calidad /
91 Booleano
Automático Cuarentena para Producción
Tamaño Tipo de
No. Nombre Campo Obl Máx. Dato Especificaciones
Control de Calidad / Cuarentena para Ingreso
92 Código de la Bodega 3 Alfanumérico
Automático en Producción
Para Producto Lotizado en Control de Calidad
93 Estatus de Ingreso 5 Alfanumérico
/ Cuarentena para Producción
94 Ubicación 15 Alfanumérico Control de Calidad / Cuarentena (Producción)
95 Tipo Orden de Producción 5 Alfanumérico
96 Tipo de Producto 5 Alfanumérico
97 Usar descripción en Impresión X Booleano
98 Precio Definido X Booleano
99 Precio Automático (Margen) X Booleano
100 Precio Abierto (Sin Control) X Booleano
101 Precio Abierto (Mínimo Venta) X Booleano
102 Precio Abierto (Superior Costo) X Booleano
103 Precio Abierto (Margen) X Booleano
104 Precio Referencia Mercado M1 Real Precio Moneda 1
105 Precio Referencia Mercado M2 Real Precio Moneda 2
106 Pedimento Únicamente Booleano
107 Obligatoriedad Adicionales Booleano Facturas / Pedidos
108 Grupo de Prenda 5 Alfanumérico
109 Talla 5 Alfanumérico
110 Color 5 Alfanumérico
111 Familia/Modelo 5 Alfanumérico
112 Temporada 5 Alfanumérico
113 Año Temporada 5 Alfanumérico
114 URL Producto Texto
Valores Posibles: -3,-2,-1,0,1,2,3. Por defecto
115 Nivel de Facilidad de Venta Entero el Valor es 0 (cero), si no se define toma el
valor 0 (cero)
116 Manejo Impuesto 2 Booleano
117 Código de Impuesto 2 5 Alfanumérico
118 Cuenta de Ingreso Extranjero 20 Alfanumérico
119 Fecha de Creación del Registro Fecha
120 Código Alterno 2 / Base 20 Alfanumérico
121 Código Agrupador 1 8 Alfanumérico Datos Relacional
122 Código Agrupador 2 8 Alfanumérico Datos Relacional
123 Precio Mínimo Entero
124 Sincronizar Franquicias Booleano 0 = False / 1 = True
125 Precio Incluido Impuestos Booleano 0 = False / 1 = True (A)
Tamaño Tipo de
No. Nombre Campo Obl Máx. Dato Especificaciones
126 Código de Marca 5 Alfanumérico Datos Relacional
127 Código de Modelo/Linea 5 Alfanumérico Datos Relacional
128 Código de SubModelo/Sublinea 5 Alfanumérico Datos Relacional
129 Uso de Balanza en Facturación Booleano 0 = False / 1 = True
130 Rendimiento Real
131 Tolerancia - Rendimiento Real
Valores posibles:
1=Ingreso Peso
132 Método Uso de Balanza Prod. Real 2=Ingreso Unidad/Peso
3=Ingreso solo Unidad
0=Ninguno x Defecto.
Al Utilizar Lector Código Barras 0 = False / 1 = True
133 Booleano
Asignar la Totalidad del Mismo. Aplica solo Productos Lotes.
0 = False / 1 = True
134 Bloqueado/No Ventas. Booleano
Aplica solo Productos Lotes.
0 = False / 1 = True
135 Bloqueado/No Compras. Booleano
Aplica solo Productos Lotes.
Nota 1:
Entrada de Datos:
Campo: CODE_s = 16,
Campo: GROUP_CATEGORY_s = API
Salida de Datos:
Campo: CODE_s = 116,
Campo: GROUP_CATEGORY_s = APIOT
SENTENCIA SQL:
192.168.181.56:8093/wsAPIS/api_wr?CORP_s=AMERI&ap_pass=12345678&CODE_s=“16”&GROUP_CA
TEGORY_s=”API”&INTEGER_1=1&TEXTO1_10=”2”&TEXTO1_24=”192.168.181.233”&TEXTO2_X=”
Datos de Trama”&TEXTO3_X=""&TEXTO4_X=""&NumDoc_s=9&IDConsulta_s=”RP1-
AMERI”&Local_origen=”PRI”’&Local_destino=PRI”&ORIGIN=”PRI”&Opcion_i=0
EJEMPLO
Campo Datos
CODE_s 16
CORP_s AMERI
GROUP_CATEGORY_s API
INTEGER_1 1
LONGINT_1 Sequence number([SIST_API])
TEXTO1_10 2
TEXTO1_24 192.168.181.233
RP1|RP1|||||0|S|6101010100|6101010100|1103010100|1103010100||0|0|0|0|0|
11|0|0|0|0|0|0|0|0|0|0|111|0|0|0|0|11.11|0|0|0|0|0||0|0|0|0|0|||||||0||0|0|0|0
TEXTO2_X
|17/12/2018|0|0|0|0|0||0|0|0||||1103010100|||0|0|||||||||0|0|0||||0||||||0|1|0|
0|0|0|0|0|0|0|0||||||||0|||6101010100|00/00/00|||||0|0||||0
NumDoc_s 9
IDConsulta_s PROD-AMERI
Local_origen PRI
Local_destino PRI
ORIGIN PRI
Opcion_i 0
CREACION Y ACTUALIZACION
DE ORDENES DE COMPRAS
Para el proceso de Órdenes de Compra se debe tener en cuenta que se generará un documento al
proveedor correspondiente y lo deja PENDIENTE A CONFIRMAR.
Datos de Cabecera:
Tamaño
No. Nombre Campo Obl Máx. Tipo de Dato Especificaciones
1 Código del Proveedor 5 Alfanumérico
Si es nueva lo crea
2 Número de la Orden de Compra 20 Alfanumérico automáticamente, caso
contrario primero lo verifica
3 Fecha de la Orden Date Formato: dd/mm/aa.
4 Fecha Requerida Date Formato: dd/mm/aa
5 Código de la Moneda X 2 Alfanumérico Campo Relacionado
6 Código de la Bodega 3 Alfanumérico Campo Relacionado
7 Validación de Importación 50 Alfanumérico
Solo si la cotización es
8 Valor de la Cotización Real diferente a la Moneda 1 del
Sistema
9 Memo 1 Texto
10 Memo 2 Texto
11 Referencia Proveedor 10 Alfanumérico
12 Código de Transporte 5 Alfanumérico
13 Guía de Embarque
14 Información del Transporte 20 Alfanumérico
15 Memo Transporte Texto
16 Fecha Transporte Date Formato: dd/mm/aa
17 Hora Transporte Time
18 Código País de Origen 8 Alfanumérico
19 Código Estado de Origen 8 Alfanumérico
20 Código Ciudad de Origen 8 Alfanumérico
21 Valor del Descuento Total Real Por Documento
Datos de Detalle:
Tamaño
No. Nombre Campo Obl Máx. Tipo de Dato Especificaciones
1 Código del Producto X 20 Alfanumérico
2 Validación del Impuesto Real
3 Cantidad Real
4 Cajas Real
5 Descuento por Línea de Detalle Real
6 Precio de Compra Producto Real
7 Código del Impuesto 3 Alfanumérico
Conjunto de datos separados y
terminados en (;) en el siguiente
orden Departamento; Centro de
8 Multidimensión 80 Alfanumérico
Costo; Proyecto; Sub-proyecto;
Análisis 1; Análisis 2; Análisis 3;
Memo Proyecto;
Nota 1:
Entrada de Datos:
Campo: CODE_s = 18,
Campo: GROUP_CATEGORY_s = API
Salida de Datos:
Campo: CODE_s = 118,
Campo: GROUP_CATEGORY_s = APIOT
SENTENCIA SQL:
INSERT INTO SIST_API(CODE_s, CORP_s, GROUP_CATEGORY_s, INTEGER_1, TEXTO1_10,
TEXTO1_24, TEXTO2_X, TEXTO3_X, NumDoc_s, IDConsulta_s, Local_origen, Local_destino, ORIGIN,
Opcion_i )
VALUES('18',’AMERI’,’API’,1,’2’,’192.168.181.233’,‘ 0039|0|00/00/00|00/00/00|US||0|0|MEMO
UNO|MEMO DOS||||||00/00/00|||||’, KM1||0|0||0||;;;;;;;;;',250244,’AMERI-250244’, ‘PRI’, ‘PRI’,
‘PRI’,0)
192.168.181.56:8093/wsAPIS/api_wr?CORP_s=AMERI&ap_pass=12345678&CODE_s='18'&GROUP_CAT
EGORY_s=’API’&INTEGER_1=1&TEXTO1_10=’2’&TEXTO1_24=’192.168.181.233’&TEXTO2_X=‘
0039|0|00/00/00|00/00/00|US||0|0|MEMO UNO|MEMO
DOS||||||00/00/00|||||’&TEXTO3_X=KM1||0|0||0||;;;;;;;;;'&NumDoc_s=250244&IDConsulta_s=’AMERI
-250244’&Local_origen=‘PRI’&Local_destino=‘PRI’&ORIGIN=‘PRI’&Opcion_i=0
Campo Datos
CODE_s 18
CORP_s AMERI
GROUP_CATEGORY_s API
INTEGER_1 1
LONGINT_1 Sequence number([SIST_API])
TEXTO1_10 2
TEXTO1_24 192.168.181.233
TEXTO2_X 0039|0|00/00/00|00/00/00|US||0|0|MEMOUNO|MEMO DOS||||||00/00/00|||||
TEXTO3_X KM1||0|0||0||;;;;;;;;;
NumDoc_s 250244
IDConsulta_s AMERI-250244
Local_origen PRI
Local_destino PRI
ORIGIN PRI
Opcion_i 0
RECEPCION DE INVENTARIO
Este proceso permite Recepción de Inventario desde una Factura de Proveedores; Orden de compra o
Recepción sin Documento, la misma puede ser total o parcial, este proceso registra la información de en
forma confirmada y genera sus transacciones contables correspondientes.
Datos de Cabecera:
Tamaño Tipo de
No. Nombre Campo Obl Máx. Dato Especificaciones
(# Factura Proveedor, # Orden de
Compra, son Documentos
1 Número del Documento X 20 Alfanumérico Confirmados). Cero en el caso de
utilizar a través de un Ajuste “Otros
Documentos”.
2 Código del Proveedor X 5 Alfanumérico
3 Fecha de Recepción Date Formato: dd/mm/aa.
4 Sucursal de Origen X 3 Alfanumérico
5 Código de la Bodega X 3 Alfanumérico A la cual se realizará la Recepción
6 Memo Texto
Si el Api es utilizado para la Recepción de Inventario sin Tipo de Documento especifico son
7
necesario los siguientes campos:
7.1 Hora de la Recepción Time Formato: HH:MM:SS
7.2 Nombre de la Embarcación 80 Alfanumérico
7.3 Procedencia 80 Alfanumérico
7.4 Código del Calificador X 5 Alfanumérico
Denominada también Liquidación de la
7.5 Recepción Externa 20 Alfanumérico
Recepción
7.6 Chofer 80 Alfanumérico
7.7 Código del Supervisor X 5 Alfanumérico
7.8 Cinco Campos Adicionales Alfanumérico Separados por Punto y Coma
7.9 Cinco Campos Adicionales Date Separados por Punto y Coma
7.10 Cinco Campos Adicionales Real Separados por Punto y Coma
Datos de Detalle:
Tamaño Tipo de
No. Nombre Campo Obl Máx. Dato Especificaciones
1 Código del Producto X 20 Alfanumérico Campo Relacionado
2 Cantidad Real
3 Serial Texto Depende de la definición del producto
Conjunto de datos separados por (;)
4 Datos del Lote Texto (Lote_interno_1; Lote_externo_1;
Ubicación_1; Cantidad_1)
Nota 1:
Entrada de Datos:
Campo: CODE_s = 20,
Campo: GROUP_CATEGORY_s = API
Salida de Datos:
Campo: CODE_s = 120,
Campo: GROUP_CATEGORY_s = APIOT
Nota 2: Dentro de esta operación es necesario que el campo “Opcion_i” tengan los
siguientes valores:
SENTENCIA SQL:
192.168.181.56:8093/wsAPIS/api_wr?CORP_s=AMERI&ap_pass=12345678&CODE_s='20'&GROUP_CAT
EGORY_s=’API’&INTEGER_1=1&TEXTO1_10=’2’&TEXTO1_24=’192.168.181.233’&TEXTO2_X=100|COD
IGO_PROVEEDOR|20/03/12|PRI|GEN|MEMO RECEPCION 100'&TEXTO3_X='
633047033496|20||'&NumDoc_s=52&IDConsulta_s=’REC-
52’&Local_origen=‘5’&Local_destino=‘PRI’&ORIGIN=‘PRI’&Opcion_i=0
Campo Dato
CODE_s 20
CORP_s GANDH
GROUP_CATEGORY_s API
INTEGER_1 1
LONGINT_1 Sequence number([SIST_API])
TEXTO1_10 2
TEXTO1_24 192.168.181.233
TEXTO2_X 100|CODIGO_PROVEEDOR|20/03/12|PRI|GEN|MEMO RECEPCION 100
TEXTO3_X 633047033496|20||
NumDoc_s 52
IDConsulta_s REC-52
Local_origen 5
Local_destino PRI
ORIGIN PRI
Opcion_i 0
SENTENCIA SQL:
192.168.181.56:8093/wsAPIS/api_wr?CORP_s=AMERI&ap_pass=12345678&CODE_s='20'&GROUP_CAT
EGORY_s=’API’&INTEGER_1=1&TEXTO1_10=’1’&TEXTO1_24=’192.168.181.233’&TEXTO2_X=’
0|PR001|20/03/12|PRI|GEN|Recepcion_Fact000|11:42:00|LANCHAS|TARQUI|01|35|PART|01|;;;;|;;;;|0
;0;0;0;0’&TEXTO3_X=’ 633047033496|15|||;;;;|;;|;;’&NumDoc_s=52&IDConsulta_s=’EXT-
52’&Local_origen=‘PRI’&Local_destino=‘PRI’&ORIGIN=‘PRI’&Opcion_i=2
Campo Dato
CODE_s 20
CORP_s FRIGO
GROUP_CATEGORY_s API
INTEGER_1 1
LONGINT_1 Sequence number([SIST_API])
TEXTO1_10 2
TEXTO1_24 192.168.181.233
0|PR001|20/03/12|PRI|GEN|Recepcion_Fact
TEXTO2_X
000|11:42:00|LANCHAS|TARQUI|01|35|PART|01|;;;;|;;;;|0;0;0;0;0
TEXTO3_X 633047033496|15|||;;;;|;;|;;
NumDoc_s 5
IDConsulta_s EXT-5
Local_origen PRI
Local_destino PRI
ORIGIN PRI
Opcion_i 2
CHEQUES MANUALES
Los datos que se requiere para generar este documento:
Datos de Cabecera:
Tamaño Tipo de
No. Nombre Campo Obl Máx. Dato Especificaciones
1 Número de Cuenta del Banco X 15 Alfanumérico
2 Número de Cuenta Contable X 11 Alfanumérico
Datos de Detalle:
Tamaño Tipo de
No. Nombre Campo Obl Máx. Dato Especificaciones
1 # del Cheque X Real
2 Fecha de pago X Date Formato: dd/mm/aa
3 Beneficiario 80 Alfanumérico
4 Monto del Cheque X Real
5 Dirección del Beneficiario Texto
6 Memo 1 80 Alfanumérico
7 Memo 2 Real
SENTENCIA SQL:
192.168.181.56:8093/wsAPIS/api_wr?CORP_s=AMERI&ap_pass=12345678&CODE_s='21'&GROUP_CAT
EGORY_s=’API’&INTEGER_1=1&TEXTO1_10=’2’&TEXTO1_24=’192.168.181.233’&TEXTO2_X=‘
0147104553|99999990000’&TEXTO3_X=’ 1|26/05/11|Karina Martinez|100|Alpallana| entregado el
26/05/11|’&NumDoc_s=102&IDConsulta_s=’AMERI-
102’&Local_origen=‘PRI’&Local_destino=‘PRI’&ORIGIN=‘PRI’&Opcion_i=0
Campo Datos
CODE_s 21
CORP_s AMERI
GROUP_CATEGORY_s API
INTEGER_1 1
LONGINT_1 Sequence number([SIST_API])
TEXTO1_10 2
TEXTO1_24 192.168.181.233
TEXTO2_X 0147104553|99999990000
TEXTO3_X 1|26/05/11|Karina Martinez|100|Alpallana| entregado el 26/05/11|
NumDoc_s 102
IDConsulta_s AMERI-102
Local_origen PRI
Local_destino PRI
ORIGIN PRI
Opcion_i 0
CREACIÓN Y ACTUALIZACION
DE PROVEEDORES
Este proceso está diseñado para manejar y controlar en forma clara y eficiente las compras.
Datos de Cabecera:
Tamaño Tipo de
No. Nombre Campo Obl Máx. Dato Especificaciones
1 Código del Proveedor X 5 Alfanumérico
2 Nombre del Proveedor X 30 Alfanumérico
3 RFC/RUC/CI X 15 Alfanumérico
4 Contacto 30 Alfanumérico
5 Dirección 1 80 Alfanumérico
6 Dirección 2 80 Alfanumérico
7 Código País 5 Alfanumérico Campo Relacionado
8 Código Estado 5 Alfanumérico Campo Relacionado
9 Código Ciudad 5 Alfanumérico Campo Relacionado
10 Código Sector 5 Alfanumérico Campo Relacionado
11 Código Postal o ZIP 10 Alfanumérico
12 Teléfono 1 15 Alfanumérico
13 Teléfono 2 16 Alfanumérico
14 Correo Electrónico 30 Alfanumérico
15 Fax 16 Alfanumérico
16 Términos de Pago Integer
17 Límite de Crédito 1 Real
18 Límite de Crédito 2 Real
19 Código Tipo Proveedor 5 Alfanumérico Campo Relacionado
20 Código de la Moneda 2 Alfanumérico Campo Relacionado
21 Código de la Zona 5 Alfanumérico Campo Relacionado
22 Notas o Memo 32000 Texto
23 Localización 1 Alfanumérico valores: E= Exterior L= Local
24 Nombre Extenso o Razón Social 60 Alfanumérico
25 Código Sucursal 3 Alfanumérico
26 Cuenta Contable x Pagar 20 Alfanumérico Campo Relacionado
27 Nombre del Banco 40 Alfanumérico
28 Cuenta Bancaria 1 20 Alfanumérico
29 Cuenta Bancaria 2 20 Alfanumérico
30 30. ABA, swift 15 Alfanumérico
Tamaño Tipo de
No. Nombre Campo Obl Máx. Dato Especificaciones
31 Nombre Beneficiario 30 Alfanumérico
32 Código Transferencias 25 Alfanumérico
33 Código Transacción 25 Alfanumérico
34 Definible Transferencia 1 25 Alfanumérico
35 Definible Transferencia 2 25 Alfanumérico
36 Definible Transferencia 3 25 Alfanumérico
37 Código Retenciones 30 Alfanumérico Campo Relacionado
38 Impuestos 10 Alfanumérico
39 Relacionada 5 Alfanumérico
40 Usar Nombre Alterno en Impresión
41 Número Exterior 10 Alfanumérico
42 Número Interior 10 Alfanumérico
43 Nombre Colonia 60 Alfanumérico
44 Nombre Localización 60 Alfanumérico
45 Moneda Única Booleano
46 Proveedor Global 10 Alfanumérico
47 Grupo de Impuestos 5 Alfanumérico
48 Código del Régimen Fiscal 5 Alfanumérico
49 Fecha de Creación del Registro Fecha
50 Cuenta Contable Reserva 20 Alfanumérico Campo Relacionado
Nota 1:
Entrada de Datos:
Campo: CODE_s = 19,
Campo: GROUP_CATEGORY_s = API
Salida de Datos:
Campo: CODE_s = 119,
Campo: GROUP_CATEGORY_s = APIOT
Nota 2: Todo dato numérico se debe ingresar un valor; si no aplica, por defecto
deberá ingresar el valor CERO(0).
Nota 6: Tome en cuenta que el campo “Opcion_i” por defecto se asignará valor CERO
“0”; este controla si el registro es de:
SENTENCIA SQL:
192.168.181.56:8093/wsAPIS/api_wr?CORP_s=AMERI&ap_pass=12345678&CODE_s='19'&GROUP_CAT
EGORY_s=’API’&INTEGER_1=1&TEXTO1_10=’2’&TEXTO1_24=’192.168.181.233’&TEXTO2_X=‘
P9001|PRUEBAS UNIDAS S.A.|1711253573001||DIRECCION DAULE||ECU|17|1701|||04893680
0489367||email1@unidas.com.ec|04893137|8|0|0|01.01|US|||L|PINTURAS UNIDAS
S.A.11|PRI|20101010003|||||PINTURAS UNIDAS S.A.|||||||0;0;0;0;0;||1|||||1|||’&NumDoc_s=’
P0001’&IDConsulta_s=’ P0001’&Local_origen=‘PRI’&Local_destino=‘PRI’&ORIGIN=‘PRI’&Opcion_i=0
Campo Datos
CODE_s 19
CORP_s AMERI
GROUP_CATEGORY_s API
INTEGER_1 1
LONGINT_1 Sequence number([SIST_API])
TEXTO1_10 2
TEXTO1_24 192.168.181.233
P9001|PRUEBAS UNIDAS S.A.|1711253573001||DIRECCION
DAULE||ECU|17|1701|||04893680
TEXTO2_X 0489367||email1@unidas.com.ec|04893137|8|0|0|01.01|US|||L|PINTURAS
UNIDAS S.A.11|PRI|20101010003|||||PINTURAS UNIDAS
S.A.|||||||0;0;0;0;0;||1|||||1|||
NumDoc_s P0001
IDConsulta_s P0001
Local_origen PRI
Local_destino PRI
ORIGIN PRI
Opcion_i 0
CREACION DE REMISIONES
CONFIRMADAS
Para realizar remisiones a través de Fuentes externas con conexiones Web Services o ODBC, se debe
tener muy en cuenta el proceso que se realiza en el Producto de Software.
El proceso de remisiones consiste en la creación del documento principal (remisiones) en estado;
Confirmadas, estas últimas entran en la cola de impresión.
Datos de Cabecera:
Tamaño Tipo de
No. Nombre Campo Obl Máx. Dato Especificaciones
Si es confirmada el número debe
1 Número de la Remisión X Real ser obligatorio, caso contrario
enviar cero
2 Código del Cliente X 8 Alfanumérico
3 Fecha Emisión de la Remisión Date Formato "dd/mm/aaaa"
4 Fecha de Vencimiento Remisión Date Formato "dd/mm/aaaa"
5 Nombre Sub-Cliente 30
6 Código del Vendedor 5 Alfanumérico Campo Relacionado
7 Código de la Moneda 2 Alfanumérico Campo Relacionado
8 Valor Cotización de la Moneda Real Si es diferente a la del Sistema
9 Código de la Bodega 5 Alfanumérico Campo Relacionado
10 Descuento de la Remisión Real
11 Código de la Sucursal 3 Alfanumérico Campo Relacionado
12 Número de la Caja Entero
13 Teléfono del Sub-Cliente 10 Alfanumérico
14 Dirección del Sub-Cliente 30 Alfanumérico
15 Identificación del Sub-Cliente 15 Alfanumérico
16 Código del Sub-Cliente Entero
Documento Identificación Sub-
17 Cliente 15 Alfanumérico
18 Referencias del Sub-Cliente 20 Alfanumérico
Conjunto de datos separados y
terminados en (;) Departamento;
19 Multidimensión 80 Alfanumérico Centro de Costo; Proyecto; Sub-
Proyecto; Análisis 1; Análisis 2;
Análisis 3; Memo Proyecto;
20 Memo Factura Texto
Corresponde al número de pedido
21 Número Pedido Entero generado en el sistema
Datos de Detalle:
Tamaño Tipo de
No. Nombre Campo Obl Máx. Dato Especificaciones
1 Número de la Remisión Real
2 Código del Producto X 20 Alfanumérico Campo Relacionado
3 Cantidad Real
Si envía este valor en la trama es el
valor que corresponde al precio por
4 Precio Unitario negociado Real unidad, si no envía el mismo hará
la división con el valor enviado en
el total de línea.
5 Cantidad Unidades Gratis Real
6 Aplica Impuesto 1 Entero 1 = Aplica / 0 = No Aplica.
7 Tamaño Real En información adicional
8 Valor del Peso Real En información adicional
9 Valor del Peso Neto Real En información adicional
10 Color del Producto En información adicional
11 Grosor del Producto En información adicional
12 Identificación En información adicional
13 Observaciones En información adicional
14 Información Adicional Texto
15 Referencias al Campo Adicional 1 Texto En información adicional TEXTO 1
16 Referencias al Campo Adicional 2 Texto En información adicional TEXTO 2
17 Referencias al Campo Adicional 3 Texto En información adicional TEXTO 3
18 Referencia al Campo Numérico 1 Real En información adicional VALOR 1
19 Referencia al Campo Numérico 2 Real En información adicional VALOR 2
20 Referencia al Campo Numérico 3 Real En información adicional VALOR 3
21 Referencia al Campo tipo Fecha 1 Date En información adicional
22 Referencia al Campo tipo Fecha 2 Date En información adicional
23 Referencia al Campo tipo Fecha 3 Date En información adicional
Conjunto de datos separados y
terminados en (;) Departamento;
24 Multidimensión 80 Alfanumérico Centro de Costo; Proyecto; Sub-
Proyecto; Análisis 1; Análisis 2;
Análisis 3; Memo Proyecto;
Campo Relacionado, Blanco si es el
25 Código del Impuesto 1
Impuesto General.
26 Aplica Impuesto 2 Entero 1 = Aplica / 0 = No Aplica.
Campo Relacionado, Blanco si es el
27 Código del Impuesto 2
Impuesto General.
28 Aplica Impuesto 3 Entero 1 = Aplica / 0 = No Aplica.
Campo Relacionado, Blanco si es el
29 Código del Impuesto 3
Impuesto General.
30 Aplica Impuesto 4 Entero 1 = Aplica / 0 = No Aplica.
Campo Relacionado, Blanco si es el
31 Código del Impuesto 4
Impuesto General.
32 Aplica Impuesto 5 Entero 1 = Aplica / 0 = No Aplica.
Este esquema y orden son necesarios tener presente en el momento de almacenar la información en la
base de datos (BDD) de nuestro producto para registrar las transacciones de facturas.
Nota 1:
Entrada de Datos:
Campo: CODE_s = 22,
Campo: GROUP_CATEGORY_s = API
Salida de Datos:
Campo: CODE_s = 122,
Campo: GROUP_CATEGORY_s = APIOT
Nota 2: La remisión ingresa como confirmada por lo tanto el campo “Opción_i” debe
estar asignado el valor CERO (0).
Nota 6: Los códigos y valores enviados(no necesarios) en los campos “Código del
impuesto X; “Porcentaje del impuesto X” serán validados en el Producto de
Software, si existen y corresponden los valores se aplicarán estos a la operación caso
contrario si detecta vacío, el sistema lo tomará de la parametrización del Producto de
Software respetando la jerarquía del sistema.
SENTENCIA SQL:
192.168.181.56:8093/wsAPIS/api_wr?CORP_s=AMERI&ap_pass=12345678&CODE_s=‘22’&GROUP_CAT
EGORY_s=’API’&INTEGER_1=1&TEXTO1_10=’2’&TEXTO1_24=‘192.168.181.233’&TEXTO2_X=’
100|019978|17/10/2013|17/10/2013|||MN|0|SEL|0|PRI||||||||;;;;;;;|MEMO|101’&TEXTO3_X=’
100|RP1|1|111.00|0|0|||||||observaciones|||||||||||;;;;;;;||||||||||||111.00|100|RP2|1|211.00|0|0||||||
|observaciones2|||||||||||;;;;;;;||||||||||||211.00’&NumDoc_s; Origin; Local_Destino; Local_Origen;
IDConsulta_s; Opcion_i=‘9’; ‘PRI
Ejemplo de Remisiones:
Campo Datos
CODE_s 22
CORP_s AMERI
GROUP_CATEGORY_s API
INTEGER_1 1
LONGINT_1 Sequence number([SIST_API])
ORIGIN PRI
TEXTO1_10 2
TEXTO1_24 192.168.181.233
TEXTO2_X 100|019978|17/10/2013|17/10/2013|||MN|0|SEL|0|PRI||||||||;;;;;;;|MEMO|101
TEXTO3_X 100|RP1|1|111.00|0|0|||||||observaciones|||||||||||;;;;;;;||||||||||||111.00|100|R
P2|1|211.00|0|0|||||||observaciones2|||||||||||;;;;;;;||||||||||||211.00
NumDoc_s 9
Local_origen PRI
Local_destino PRI
IDConsulta_s AMERI_9
Opcion_i 0
INFORMACIÓN GENERAL
Este proceso nos permite registrar en el sistema MBA3, la información correspondiente a las
Solicitudes de Requisiciones, desde un proceso externo.
La forma de aplicar este proceso es: Por medio de una aplicación externa (Aplicación Propia del
Cliente), utilizando una conexión hacia la base de datos (Web Services o ODBC), se registra en
el ERP-MBA3 y en específico en la Tabla “SIST_API” tramas de Datos. Internamente el ERP-
MBA3, lee la información, la valida y la procesa, Obteniendo como resultado el despliegue de la
información en el sistema o el registro de un mensaje de error.
CONSIDERACIONES ESPECIALES
El contenido de la trama de datos que ingresa la información principal del registro está
compuesto de la siguiente información:
El contenido de la trama de datos que ingresa la información del detalle del registro está
compuesto de la siguiente información:
NOTAS
✓ El registro de datos es por documento es decir un registro con varias líneas de detalle.
✓ En los campos de cabecera y detalle se registrarán como un máximo de 32000 bits.
✓ Considerar que los campos opcionales, en casos específicos si se ingresa la información
si es relacionada se validarán en el sistema.
✓ Hay que tener presente, si los campos opcionales no poseen información debe
conservarse la posición del campo separado por PIPE.
✓ El Final de la trama correspondiente no debe incluir PIPE
Campo Datos
CODE_s 23
CORP_s AMERI
GROUP_CATEGORY_s API
INTEGER_1 1
LONGINT_1 Sequence number([SIST_API])
ORIGIN PRI
TEXTO1_10 2
TEXTO1_24 192.168.181.233
TEXTO2_X 100|DP1|AR1|1|BO1|SR12345|31/12/2011|30/12/2011|;;;;;;;;|Me
mo
TEXTO3_X P|PROD1|10|12.50|USD|31/12/2011|PRV001|;;;;;;;;|ESPECIFICACI
ONES|COMENTARIOS|P|PROD2|20|22.50|USD|31/12/2011|PRV001
|;;;;;;;;|ESPECIFICACIONES|COMENTARIOS
NumDoc_s 200
Local_origen PRI
Local_destino ARA
IDConsulta_s 200-AMERI
Opcion_i 0
Cabecera:
“100|DP1|AR1|1|BOD1|SR12345|31/12/2011|30/12/2011|;;;;;;;;|Memo”
Detalle:
“P|PROD1|10|12.50|USD|31/12/2011|PRV001|;;;;;;;;|ESPECIFICACIONES|COMENT
ARIOS”
192.168.181.56:8093/wsAPIS/api_wr?CORP_s=AMERI&ap_pass=12345678&CODE_s=‘23’&GROUP_CAT
EGORY_s=’API’&INTEGER_1=1&TEXTO1_10=’2’&TEXTO1_24=‘192.168.181.233’&TEXTO2_X=’TRAMAC
ABECERA’&TEXTO3_X=’TRAMADETALLE’&NumDoc_s; Origin; Local_Destino; Local_Origen;
IDConsulta_s; Opcion_i=‘9’;‘ARA’
INFORMACIÓN INICIAL
Este proceso nos permite registrar en el sistema MBA3, la información correspondiente a Pedidos
Internos, desde un proceso externo.
La forma de aplicar este proceso es: Por medio de una aplicación externa (Aplicación Propia del
Cliente), utilizando una conexión hacia la base de datos (Web Services o ODBC), se registra en
el ERP-MBA3 y en específico en la Tabla “SIST_API” tramas de Datos. Internamente el ERP-
MBA3, lee la información, la valida y la procesa, Obteniendo como resultado el despliegue de la
información en el sistema o el registro de un mensaje de error.
CONSIDERACIONES ESPECIALES
El contenido de la trama de datos que ingresa la información principal del registro está
compuesto de la siguiente información:
El contenido de la trama de datos que ingresa la información del detalle del registro está
compuesto de la siguiente información:
NOTAS
✓ El registro de datos es por documento es decir un registro con varias líneas de detalle.
✓ En los campos de cabecera y detalle se registrarán como un máximo de 32000 bits.
✓ Considerar que los campos opcionales, en casos específicos si se ingresa la información
si es relacionada se validarán en el sistema.
✓ Hay que tener presente, si los campos opcionales no poseen información debe
conservarse la posición del campo separado por PIPE.
✓ El Final de la trama correspondiente no debe incluir PIPE
Campo Datos
CODE_s 24
CORP_s AMERI
GROUP_CATEGORY_s API
INTEGER_1 1
LONGINT_1 Sequence number([SIST_API])
ORIGIN PRI
TEXTO1_10 2
TEXTO1_24 192.168.181.233
TEXTO2_X 100|01/01/2012|31/01/2012|USUARIO|TR|MC1|TR1|VE1|BG1|BG2|MEMO
|INFPED|MESBOD|MESPROD|MESCLE|MESTRA
TEXTO3_X PROD1|10|PROD2|20| PROD3|30
NumDoc_s 200
Local_origen PRI
Local_destino ARA
IDConsulta_s 200-AMERI
Opcion_i 0
Cabecera:
“100|01/01/2012|31/01/2012|USUARIO|TR|MC1|TR1|VE1|BG1|BG2|MEMO|INFPED
|MESBOD|MESPROD|MESCLE|MESTRA”
Detalle:
“PROD1|10|PROD2|20| PROD3|30”
192.168.181.56:8093/wsAPIS/api_wr?CORP_s=AMERI&ap_pass=12345678&CODE_s=‘23’&GROUP_CAT
EGORY_s=’API’&INTEGER_1=1&TEXTO1_10=’2’&TEXTO1_24=‘192.168.181.233’&TEXTO2_X=’TRAMAC
ABECERA’&TEXTO3_X=’TRAMADETALLE’&NumDoc_s; Origin; Local_Destino; Local_Origen;
IDConsulta_s; Opcion_i=‘9’;‘ARA’
Datos de Detalle:
Tamaño Tipo de
No. Nombre Campo Obl Especificaciones
Máx. Dato
Código del Producto de la
1 X 20 Alfanumérico Campo Relacionado
Receta
MP= “Materia Prima”,
I= “INSUMOS”,
MA= “Maquinaria”,
MO= “Mano de Obra”,
2 Tipo de Producto X Texto
CI= “OTROS COSTOS”,
VA= "Valores Adicionales",
SP= "Sub Productos",
DE= “Desperdicios”.
Opciones:
“+” Agrega a la Receta de Producción.
3 Aplicación del Producto Real “-” Elimina de la Receta de Producción.
“=” Reemplaza la cantidad enviada por la
cantidad de la Receta.
4 Cantidad del Producto X Real Valor superior a “0”
Cantidad del Producto
5 Real Valor superior a “0”
Segunda Unidad
Datos separados por (;), No va al Final :
Lote; Cantidad;
Ubicacion1;Cantidad1;
6 Listado de Lotes Texto
Ubicacion2;Cantidad2
Cantidad (Lote) = Cantidad (Ubic.)
Al final de Lote poner “ : ” =“2 puntos”
7 Listado de Seriales Texto Separados por (;) y terminado en (;)
8 Listado de Empaques Texto
Conjunto de datos separados y terminados
en (;) en el siguiente orden: Departamento;
9 Multidimensión 80 Alfanumérico Centro de Costo; Proyecto; Sub-Proyecto;
Análisis 1; Análisis 2; Análisis 3; Memo
Proyecto;
10 Memo Texto
Nota 1:
Entrada de Datos:
Campo: CODE_s = 25,
Campo: GROUP_CATEGORY_s = API
Salida de Datos:
Campo: CODE_s = 125,
Campo: GROUP_CATEGORY_s = APIOT
Nota 2: Dentro del Sistema de MBA3 existe la parametrización para crear Ubicaciones
automáticamente en el manejo de Lotes.
Si éste parámetro no está habilitado, el proceso valida la Ubicación enviada a través del
API a una existente en el sistema.
Nota 3: Si en el Sistema MBA 3 existe creada la Ubicación “N/U”, el proceso pasa por
alto las Ubicaciones enviadas o no enviadas y se asigna todo a la Ubicación “N/U”.
• Opcion_i = 1: No Obligatorio.
• Opcion_i = 2: Obligatorio
• Opcion_i = 3: Obligatorio
• Opcion_i = 4: No Obligatorio.
SENTENCIA SQL:
192.168.181.56:8093/wsAPIS/api_wr?CORP_s=AMERI&ap_pass=12345678&CODE_s=‘25’&GROUP_CAT
EGORY_s=’API’&INTEGER_1=1&TEXTO1_10=’2’&TEXTO1_24=’192.168.181.233’&TEXTO2_X=0|27/04/
2015|RPR|BPS|BPR|||0|||0|104|00/00/00|00/00/00|00/00/00|00/00/00|00/00/00|00:00|00:00|00:00|0
0:00||PT1|ESTAN|10|0|;;;;;;;;||Notas|Memo GEN|Memo BOD|Memo RES|Memo
AVA&TEXTO3_X=MP1|MP|=|20|0||||;;;;;;;;|MEMO
LINEA&NumDoc_s=117&IDConsulta_s=’AMRI_117’&Local_origen='PRI'&Local_destino=‘PRI’&ORIGIN='
PRI'
Campo Datos
CODE_s 25
CORP_s AMERI
GROUP_CATEGORY_s API
INTEGER_1 1
LONGINT_1 Sequence number([SIST_API])
TEXTO1_10 2
TEXTO1_24 192.168.181.233
TEXTO2_X 0|27/04/2015|RPR|BPS|BPR|||0|||0|104|00/00/00|00/00/00|00/00/00|00/00/00|00/
00/00|00:00|00:00|00:00|00:00||PT1|ESTAN|10|0|;;;;;;;;||Notas|Memo GEN|Memo
BOD|Memo RES|Memo AVA
TEXTO3_X MP1|MP|=|20|0||||;;;;;;;;|MEMO LINEA
NumDoc_s 117
IDConsulta_s AMERI_117
Local_origen PRI
Local_destino PRI
ORIGIN PRI
Opcion_i Si = 1: Crea Orden de Producción.
Si = 2: Entrega de Materia Prima
Si = 3: Confirma Orden de Producción
Si = 4: Crea Orden, Entrega Materia Prima y Confirma Orden de Producción.
Datos de Cabecera:
No. Nombre Campo Obl Tamaño Tipo de Dato Especificaciones
1 Código de Cliente X 8 Alfanumérico
2 Código de Sub Cliente X 8 Alfanumérico
3 Nombre X 80 Alfanumérico
4 Identificación 15 Alfanumérico
5 Límite Ventas Real
6 Identificación Fiscal X 15 Alfanumérico Identificación Fiscal
7 Dirección 1 80 Alfanumérico
8 Dirección 2 80 Alfanumérico
9 Dirección 3 80 Alfanumérico
10 Código Zip 10 Alfanumérico
11 Télefono1 14 Alfanumérico
12 Télefono2 14 Alfanumérico
13 Fax 14 Alfanumérico
14 Email 50 Alfanumérico
15 Código País 8 Alfanumérico Relacional
16 Código Provincia/Estado 8 Alfanumérico Relacional
17 Código Ciudad 8 Alfanumérico Relacional
18 Código Sector 5 Alfanumérico Relacional
19 Referencia 20 Alfanumérico
20 Memo General Texto
21 Alerta en Factura 0 Booleano 0 = False / 1 = True
22 Definible Numérico 1 Real
23 Definible Numérico 2 Real
24 Definible Fecha 1 00/00/00 Fecha
25 Definible Fecha 2 00/00/00 Fecha
26 Definible Texto 1 20 Alfanumérico
27 Definible Texto 2 20 Alfanumérico
28 Municipio 30 Alfanumérico
29 Colonia 60 Alfanumérico
30 Localidad 60 Alfanumérico
31 No. Interior 10 Alfanumérico
32 No. Exterior 10 Alfanumérico
33 Memo Despachos Texto
34 Código de Régimen Fiscal 5 Texto Relacionado
Solo si cambia la Relación del
35 Código de Cliente Nuevo 8 Texto
Cliente Original y si es Actualización.
Especificaciones:
Nota 1:
Entrada de Datos:
Campo: CODE_s = 05,
Campo: GROUP_CATEGORY_s = API
Nota 2:
Tipo de Registro:
Campo: Opción_i = 0 - “Nuevo SubCliente”
Campo: Opción_i = 1 - “Actualización SubCliente”
SENTENCIA SQL:
192.168.181.56:8093/wsAPIS/api_wr?CORP_s=AMERI&ap_pass=12345678&CODE_s=‘05’&GROUP_CAT
EGORY_s=’API’&INTEGER_1=1&TEXTO1_10=’2’&TEXTO1_24=‘192.168.181.233’&TEXTO2_X=‘Datos
de Trama’&NumDoc_s=‘API-
200’&Local_origen=‘ARA’&Local_destino=‘PRI’&ORIGIN=‘ARA’&IDConsulta_s=‘AMERI_ API-200’
EJEMPLO:
Campo Datos
CODE_s 26
CORP_s ACME
GROUP_CATEGORY_s API
INTEGER_1 1
LONGINT_1 Sequence number([SIST_API])
ORIGIN PRI
TEXTO1_10 2
TEXTO1_24 192.168.181.233
148e6237|SCLI001|MARQUEZ ABAD JOSTIN
TEXTO2_X ALEXANDER|1727893180||1727893180|D1|D2|D3|ZIP|T1|T2|F1|EMAIL|||||REF|
MEMO|0|||00/00/00|00/00/00|||||||||CI|
NumDoc_s SCLI-100
Local_origen PRI
Local_destino PRI
IDConsulta_s ACME_ SCLI-100
Opcion_i 0
Para realizar la facturación a través de fuentes externas con conexiones Web Services o ODBC, se debe
tener muy en cuenta el proceso que se realiza en el producto de software.
Datos de Cabecera:
NOTAS:
En el caso de usar: VER-EDITAR – CONFIRMACION AUTOMATICA (Opcion_i=2), se debe considerar las
siguientes Observaciones:
1.- El campo 1: Número Factura, este valor es un Identificador único de la factura este campo se
almacenará en un campo referencial de la factura, al registrar esta información será validad su existencia
en la base de datos.
2.- El campo 22: Tipo de Documento, en este campo se debe registrar el dato del tipo de documento
relacionado a la factura.
3.- Si las validaciones son correctas, se procederá a confirmar el documento si en el proceso de
confirmación se marca algún error el registro quedará en Ver/Editar.
4,- Este Tipo de Factura solo aplica para el país MEXICO, y se maneje con Comercio Exterior.
Datos de Detalle:
No. Nombre Campo Obl Tamaño Tipo de Dato Especificaciones
Dato Obligatorio para Facturas
1 Número de Factura X Real
Confirmadas
2 Código del Producto X Real
3 Cantidad a Facturar Real
4 Precio Unitario Real
5 Número de Unidades Gratis Real
6 Detalle con IVA Booleano
7 Porcentaje de Descuento por Detalle Real
8 Tamaño Real
9 Valor del Peso Real
10 Valor del Peso Neto Real
11 Color del Producto Alfanumérico
12 Grosor del Producto Real
13 Identificación Alfanumérico
14 Observaciones Texto
15 Información Adicional Texto
16 Referencia Campo Adicional 1 Alfanumérico En Información Adicional TEXTO 1
17 Referencia Campo Adicional 2 Alfanumérico En Información Adicional TEXTO 2
18 Referencia Campo Adicional 3 Alfanumérico En Información Adicional TEXTO 3
19 Referencia Campo Numérico 1 Real En Información Adicional VALOR 1
20 Referencia Campo Numérico 2 Real En Información Adicional VALOR 2
21 Referencia Campo Numérico 3 Real En Información Adicional VALOR 3
22 Referencia Campo de Tipo Fecha 1 Fecha En Información Adicional
23 Referencia Campo de Tipo Fecha 2 Fecha En Información Adicional
24 Referencia Campo de Tipo Fecha 3 Fecha En Información Adicional
Códigos separados y terminados en
(;) en el siguiente orden:
Departamento; Centro de Costo;
25 Multidimensión por Detalle X Booleano
Proyecto; Subproyecto; Análisis 1;
Análisis 2; Análisis 3; Memo
Proyecto;
26 Impuesto 2 Booleano
27 Impuesto 3 Booleano
28 Impuesto 4 Booleano
29 Impuesto 5 Booleano
30 Código del Impuesto 1 Alfanumérico Campo Relacionado
31 Porcentaje del Impuesto 1 Real
Esta factura puede tener detalle de cuotas, datos no necesarios para facturas PENDIENTES A CONFIRMAR
y los datos transmitidos son:
Datos de Cuotas:
Tamaño Tipo de
No. Nombre Campo Obl Máx. Dato Especificaciones
Dato Obligatorio para Facturas
1 Número de la Factura X Real
Confirmadas
2 Pedido Manual 20 Alfanumérico
3 Fecha Pedido Manual Fecha Formato: DD/MM/AAAA.
4 Orden de Compra Cliente 20 Alfanumérico
5 Fecha Orden de Compra Fecha Formato: DD/MM/AAAA.
6 Recibo Entrega Mercadería 20 Alfanumérico
7 Fecha Recibo Entrega Mercadería Fecha Formato: DD/MM/AAAA.
8 Variable Adicional 1 (*) 20 Alfanumérico
9 Variable Adicional 2 (*) 20 Alfanumérico
10 Variable Adicional 3 (*) 50 Alfanumérico
11 Variable Adicional 4 (*) 50 Alfanumérico
12 Variable Adicional 5 (*) 50 Alfanumérico
13 Variable Adicional 6 (*) 50 Alfanumérico
14 Uso de Documento Digital 5 Alfanumérico Código Relacional ingresado en MBA
15 Tipo de Relación de Documento 5 Alfanumérico Código Relacional ingresado en MBA
16 Documento Relacionado 20 Alfanumérico Número de Factura Afectada
17 Tipo Documento Relacionado 5 Alfanumérico Tipo de Documento Relacionado
18 Referencia Única Interna 10 Alfanumérico Identificación Única de Ventas
19 Clave de pedimento 2 Alfanumérico Corresponde el valor - A1, Fijo
20 No. Certificado Origen 6-40 Alfanumérico Valor Registrado 6 -40 Caracteres
21 No. Exportador Confiable Alfanumérico Valor Registrado
22 Tipo de Operación 1 Alfanumérico Valor Relacionado x defecto 2
23 Certificado Origen 5 Alfanumérico Valor Relacionado
24 SubDivisión 5 Alfanumérico Valor Relacionado
25 Intercom 5 Alfanumérico Valor Relacionado
26 Propietario – Identificación 20 Alfanumérico Valor Registrado
27 Propietario –Residencia 5 Alfanumérico Valor Relacionado
28 Motivo Traslado 5 Alfanumérico Valor Relacionado
(*) Estos campos varían el nombre en función de la aplicación en el manejo de las Addendas /
Complemento de Comercio Exterior 1.1, en MBA3 el orden se maneja de izquierda - derecha y de arriba
– abajo, es necesario verificar los manuales de las adendas para determinar los campos obligatorios.
Esta Información se almacena en el campo TEXTO7_X y es obligatorio, si no pasa datos dejar los pipe,
los campos 14 / 15/ 16, se usan en Emisión Digital CFDI 3.3 (México).
Si se pasa en blanco, el campo 14 toma el dato de “G01”, que es un general en el catálogo del SAT.
Los campos 15 y 16, son obligatorios los 2 y se los toma datos de una Factura de Anticipo.
El campo 17 es obligatorio para identificar el tipo de documento a usar.
Los Campos sin Especificaciones NO son usados, pero se debe enviar su definición.
Este esquema y orden son necesarios tener presente en el momento de almacenar la información en la
base de datos (BDD) de nuestro producto para registrar las transacciones de facturas.
Nota 1:
Entrada de Datos:
Campo: CODE_s = 27,
Campo: GROUP_CATEGORY_s = API
Salida de Datos:
Campo: CODE_s = 127,
Campo: GROUP_CATEGORY_s = APIOT
Nota 3: Todos los campos numéricos al no tener un valor, por defecto es necesario enviar CERO.
Los campos de tipo Fecha que no tengan asignado un valor y no sean obligatorios es necesario
enviar el valor por defecto “00/00/00”, los campos de tipo BOOLEANO 0: Falso ó 1: Verdadero
Nota 5: Sólo en las facturas “NO CONFIRMADAS” permitirá enviar el número del documento con
CERO y se manejará el campo “Opcion_i”
Nota 6: Si la operación se utiliza con el código “27”, no es necesario enviar el API de cobros
“02”, ya que el proceso confirma y realiza el cobro con los datos enviados.
Nota 11: Los códigos y valores enviados (no necesarios) en los campos “Código del impuesto
X”; “Porcentaje del impuesto X”, serán validados en el Producto de Software, si existen y
corresponden los valores se aplicarán estos a la operación caso contrario si detecta vacío, el
sistema lo tomará de la parametrización del Producto de Software respetando la jerarquía del
sistema.
Nota 12: Los datos fiscales se almacenan en el Campo: TEXTO6_X, si no se usa dejar en
BLANCO.
SENTENCIA SQL:
192.168.181.56:8093/wsAPIS/api_wr?CORP_s=AMERI&ap_pass=12345678&CODE_s=‘27’&GROUP_CAT
EGORY_s=’API’&INTEGER_1=1&TEXTO1_10=’2’&TEXTO1_24=‘192.168.181.233’&TEXTO2_X=’
001|N0300322|19/03/2012|19/03/2012||||US|0|1|GEN|0|PRI|1|0||||0|||PRI||01;;;;0000000000;;;;|1||
0||00/00/00
001|510005822003|1|75.4464|0|1|0||0|0|||||||||0|0|0|00/00/00|00/00/00|00/00/00|01;;;;0000000000
;;;;|0|0|0|0||0||0||0||0||0||75.45’&TEXTO3_X=‘9’; ‘PRI&TEXTO4_X=‘PRI’&NumDoc_s; Origin;
Local_Destino; Local_Origen; IDConsulta_s; Opcion_i=‘PRI
EJEMPLO:
Campo Datos
CODE_s 27
CORP_s AMERI
GROUP_CATEGORY_s API
INTEGER_1 1
LONGINT_1 Sequence number([SIST_API])
ORIGIN ARA
TEXTO1_10 1
TEXTO1_24 192.168.181.233
001|N0300322|19/03/2012|19/03/2012||||US|0|1|GEN|0|PRI|1|0||||0|||PRI||01;;
TEXTO2_X
;;0000000000;;;;|1||0||00/00/00
001|510005822003|1|75.4464|0|1|0||0|0|||||||||0|0|0|00/00/00|00/00/00|00/00/
TEXTO3_X
00|01;;;;0000000000;;;;|0|0|0|0||0||0||0||0||0||75.45|1|C2|C3|A1|A2|A3
TEXTO4_X 001|19/03/2012|84.5|0|0
TEXTO6_X |||||||||||||||||||||||||||||||| ---- PARA MEXICO DEJAR EN BLANCO ----
TEXTO7_X |||||||||||||||||A1|1234567890|123456|2|CO1|Sv1|IN1|1001|ECU|mt1
NumDoc_s 9
Local_origen ARA
Local_destino PRI
IDConsulta_s AMERI_9
Opcion_i 0
CREACION DE COTIZACIONES
Información necesaria para registrar datos de Cotizaciones vía API.
Datos de Cabecera:
Tamaño Tipo de
No. Nombre Campo Obl Máx. Dato Especificaciones
1 Número Cotización X 20 Alfanumérico Referencial
2 Código Cliente X 8 Alfanumérico Campo Relacionado
3 Fecha Emisión X Date Formato “dd/mm/aa”
4 Fecha Validez X Date Formato "dd/mm/aa"
5 Código de SubClientes 8 Alfanumérico Campo Relacionado
6 Código Vendedor 5 Alfanumérico Campo Relacionado
7 Código Moneda X 2 Alfanumérico Campo Relacionado
8 Código Bodega X 3 Alfanumérico Campo Relacionado
9 Pedido Manual
10 Número Contrato
11 Orden Compra
12 Transportista
13 Medio Captura
14 Nombre Solicitante
15 Memo
Datos de Detalle:
Tamaño Tipo de
No. Nombre Campo Obl Máx. Dato Especificaciones
1 Número Cotización X 20 Alfanumérico Referencial
2 Secuencial Posición X Entero
3 Código del Producto X 20 Alfanumérico Campo Relacionado
4 Cantidad del Producto X Real
5 Precio del Producto X Real
Porcentaje de Descuento
6 % Descuento de Producto Real
No se Realiza Cálculos del Campo.
1 = Aplica Impuesto 1.
7 Aplica Impuesto 1 Booleano
0 = No Aplica Impuesto 1.
8 Código Impuesto 1 5 Alfa Si Aplica y es el General – Blanco.
No se Realiza Cálculos del Campo,
9 Total de Producto X Real Corresponde al Valor Sin Impuestos.
Se debe enviar los campos: Text1;
Texto2; Texto3; Fecha1; Fecha2;
10 Campos Adicionales Producto Texto
Fecha3; Valor1; Valor2; Valor3.
Si no envía dejar en blanco.
11 Memo de Producto Texto
Nota 2: Opciones del campo “Opcion_i” por defecto se asignará el valor Cero, valida al precio los
Productos.
0: Cotización en Ver / Editar
1: Cotización Confirmada.
SENTENCIA SQL:
192.168.181.56:8093/wsAPIS/api_wr?CORP_s=AMERI&ap_pass=12345678&CODE_s=‘28’&GROUP_CAT
EGORY_s=’API’&INTEGER_1=1&TEXTO1_10=’2’&TEXTO1_24=‘192.168.181.233’&TEXTO2_X=‘TRAMA
CABECERA’&TEXTO3_X=‘TRAMA DETALLE’&Opcion_i=0&INTEGER_4=0&NumDoc_s=‘PED-
100’&Local_origen=‘PRI’&Local_destino=‘PRI’&ORIGIN=‘PRI’&IDConsulta_s=‘AMERI_200’
EJEMPLO:
Campo Datos
CORP_s AMERI – CODIGO EMPRESA
ORIGIN PRI – CODIGO SUCURSAL
GROUP_CATEGORY_s API
CODE_s 28
INTEGER_1 1
TEXTO1_10 1
TEXTO1_24 192.168.181.233
TEXTO2_X 100|CLI001|06/02/2019|15/02/2019||VEN01|US|B01|PM123|CO456|OC789|TR0
01||SOLICITANTE|Memo
TEXTO3_X 100|1|PROD001|1|10|0|0||10||Memo
Opcion_i 1
NumDoc_s COT-100
IDConsulta_s AMERI-COT-100
ANEXOS
ANEXO A
NOTA: en caso de requerir el acceso por medio de Web Services, no aplica este anexo si no
el Anexo E.
Puede utilizar la Conectividad abierta de base de datos de orígenes de datos (ODBC) para tener
acceso a datos desde una gran variedad de sistemas de administración de bases de datos. Antes
de empezar con esta configuración se debe verificar que se encuentre instalado los manejadores
de 4D Server para poder realizar las correspondientes configuraciones al Producto de Software;
para instalar este controlador debe ir al Manual de Referencia de ODBC Driver 4D SERVER.
Para abrir Orígenes de datos (ODBC), haga clic en Inicio, seleccione Configuración y, a
continuación, haga clic en Panel de control. Haga doble clic en Herramientas
administrativas y, a continuación, en Orígenes de datos (ODBC).
Para obtener información acerca de cómo usar Orígenes de datos (ODBC), haga clic en Ayuda
en el cuadro de diálogo Administrador de orígenes de datos ODBC.
Se debe seleccionar el controlador con el cual se necesita trabajar o configurar. Para nuestro
caso ODBC Driver for 4D Server.
Una vez ingresada esta información, para validar estos datos compruebe con la opción Test
data source.
ANEXO B
MONITOR DE SERVICIOS
Para definir a una estación como un “Servidor de Servicios”, se necesita crear un “archivo
Plano” con el nombre “ServidorServicios.txt”. Este en su interior tendrá información del
número del SERVER definido para esta estación, es decir si esta estación fue definida como
Servidor de Servicios # n, entonces en el contenido del archivo debe colocarse el # “n” donde
n toma los valores de 1 hasta n (Números enteros positivos).
El archivo “ServidorServicios.txt”, debe ser copiado en el directorio en el cual “4D client” crea
sus recursos y bajo este la carpeta “Application Preferences”.
Por ejemplo para Windows Vista la carpeta de recursos se crea en: “
C:\Users\Karina\AppData\Roaming\4D\Application Preferences”. Si ejecutamos el 4D
Client tenemos la siguiente presentación del Producto de Software MBA3:
Nota: Una vez que los servicios se encuentran ejecutándose como se presenta en la
parte superior, este procesará toda información que sea enviada al MBA3 y afectará en
los procesos correspondientes que hace referencia dentro del sistema.
En Producto de Software MBA3 existen opciones para configurar y ejecutar el servicio de manejo
de API's.
Parametrización.
En este formulario presenta datos del servicio, tales como Código del Servicio(presentado por
el sistema), Nombre del Servicio(Presentado por el sistema), Servidor #, en el que se
ejecutará el servicio (1, 2, 3, etc.; administrado por el usuario); Permitir ejecutar en, opciones
en el cual el servicio permite ejecutarse en el servidor o en una estación cliente, para este caso
solo permite ejecutarse en una estación cliente(Administrado por el sistema); si se puede
ejecutar en varias máquinas (Administrado por el sistema); Automático; si el servicio se
ejecuta automáticamente al levantar el monitor de servicios(Administrado por el Usuario);
Delay, opción administrado por el usuario y permite ingresar que tiempo cíclico que el servicio
se ejecutará y procesará la operación correspondiente.
ANEXO C
LOG DE API’S
Una vez que el proceso se ha ejecutado, el producto tiene la posibilidad de visualizar los registros
que no fueron ejecutados en tal hecho, para lo cual el usuario puede ubicarse en:
Administración / Módulos Adicionales / Log de Comunicaciones / Log de Api’s.
1.- Pantalla que muestra un listado de todos los procesos que se ejecutaron, están por
ejecutarse o aquellos que provocaron errores, tales procesos(Operaciones), visualizando el
CORP; OPERACIÓN, DIRECCIÓN IP del que solicitó el requerimiento; # de Documento, ERROR,
una descripción del error provocado en la ejecución de la operación; FECHA de la última
ejecución de la operación; HORA de la última ejecución de la operación.
2.- Local Origen: Filtro que permite visualizar la información por el Local Origen.
3.- Local Destino: Filtro que permite visualizar la información por el Local Destino.
4.- Tipo de Operación: Filtro que permite visualizar la información por el Estado de la
Operación, pudiendo ser: Todos(por defecto), Por procesar, Procesado, Procesados con error,
Procesados sin error.
5.- Estados de Operación: Filtro que permite visualizar la información por operaciones, los
mencionados en este documento.
7.- Todos: Permite ejecutar las operaciones correspondientes a todos los registros listados con
errores y no procesados.
8.- Borrar Datos: Permite al administrador del sistema eliminar el registro seleccionado (su
eliminación será lógico).
9.- Exportar Datos: Permite exportar la información que se encuentre en el Log de Api’s a un
archivo plano
10.- Ver Detalle: Permite visualizar información almacenada en grupos binarios y ver a detalle
los datos que se envían a procesar, los descritos en el documento.
ANEXO D
CONEXIÓN VISUAL BASIC
ODBC: MBA3
Usuario: API
Password: API
Método de insersión:
Exit Sub
fincmd1:
Resume Next
End Sub
TimeStamp VB.
Para obtener la fecha y la hora en un ENTERO LARGO, se propone la utilización del siguiente
código para tal hecho y el resultado almacenarlo en el campo LONGINT_2, utilizando Visual
Basic:
ANEXO E
CONFIGURACION DE WEB SERVICES
NOTAS:
• Si se configura el Monitor de Servicios de APIs (Anexo B), este se puede usar también
para recibir las peticiones de los WebServices, por lo que la configuración de este
anexo podría saltarse.
Se debe configurar el servicio de escucha http (también conocido como Servicio Web) dentro
de parámetros del sistema / parámetros de empresa / Otros / Servicios:
2. Donde dice “Iniciar Servidor Web Automáticamente” seleccionar una de las dos opciones.
La contraseña de acceso del campo “pa_pass” (ver página 6) se configura por empresa en:
Para crear un registro en SIST_API, dentro de MBA3, se deben llenar los campos indicados
para cada API y adicional poner el campo ap_pass, definido para cada empresa, por ejemplo
para crear un cliente:
192.168.181.56:8093/wsAPIS/api_wr?CORP_s=AMERI&ap_pass=12345678&CODE_s=‘05’&GROUP
_CATEGORY_s=’API’&INTEGER_1=1&TEXTO1_10=’2’&TEXTO1_24=‘192.168.181.233’&TEXTO2_X=’CL
000072|A PRUEBAS
API|1711253573|||||||||||||0|0|0|MN|||||||08/03/2018|L||PRI||1||||||0|0|0|0|0|0||||||||0||||PF|0||0|0
|0||0||||’&NumDoc_s=‘API-
200’&Local_origen=‘ARA’&Local_destino=‘PRI’&ORIGIN=‘ARA’&IDConsulta_s=‘AMERI_ API-200’
Donde el número 502542 corresponde al ID del API (campo LONGINT_1) y permite una
posterior consulta del resultado del proceso de ese API, ver “Consulta Estado API”.
Una vez creado el API, entra en una cola de procesamiento (ver Anexo C), es decir el API no
se procesa de una vez, por ejemplo si se va a crear un Cliente, este no se crea de inmediato,
sino que hay un tiempo de espera de unos minutos a que procese (ver Anexo C).
El estado de error o proceso se puede verificar por medio del Web Services api_read y con el
número secuencial del API ap_id=NNNN (ver punto anterior).
Ejemplo:
192.168.181.140:9974/wsAPIS/api_read?ap_id=502542&ap_corp=ACME&ap_pass=12345
678
Es posible consultar los APIs por el código de operación, campos Code_s. En este caso el
resultado puede contener 0, 1 o más registros, por lo que el json que se retorna es de tipo
Array.
También el resultado incluye todos los campos leíbles de la tabla SIST_API, por lo que se
puede usar para consultar los APIs de lectura, por ejemplo cuando se adiciona un nuevo
producto, se crea un registro con Code_s='106'.
WebServices: wsAPIS/api_sel
Parámetros:
• ap_corp: código de la empresa
• ap_pass: password de acceso web para la empresa
• ap_code: código de grupo del API, por ejemplo '05' (campo Code_s)
• ap_int1: Puede ser 0 o 1, para que retorne los registros con Integer_1= 0 o 1. Es
opcional y si no se especifica asume 1 (no procesado)
Resultado:
• En caso de error: array json con los campos "ap_res1" y "ap_res2", similar a las
respuestas estándar de los APIs, pero dentro de un array.
• En caso de no error: Array Json con la lista de registros y sus campos.
Ejemplo:
Consulta de los APIs de código '52':
192.168.18.14:9974/wsAPIS/api_sel?ap_corp=DGE00&ap_pass=11112222&ap_code=52
Resultado json:
Es posible actualizar los APIs con Code_s mayor o igual a “100”. La operación de actualización
cambia el campo Integer_1 de 1 o 0 y se usa para marcar los registros de API que ya se
procesaron en una aplicación externa.
WebServices: wsAPIS/api_act
Parámetros:
• ap_corp: código de la empresa
• ap_pass: password de acceso web para la empresa
• ap_id: código del API, campo Longint1
Resultado:
• En caso de no error: "ap_res1":"OK"
• En caso de error: campo "ap_res1" y "ap_res2", con “Error” y la descripción
respectivamente