Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                

MBA3 - Manual API Version - 3.30 - v19.0

Descargar como pdf o txt
Descargar como pdf o txt
Está en la página 1de 131

Manual de API’s Versión: 3.

30

MANUAL DE API’s
MBA3 v 19.0
-
Con Web Services

MBA3 - ERP 1 Departamento de Desarrollo


Manual de API’s Versión: 3.30

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

MBA3 - ERP 2 Departamento de Desarrollo


Manual de API’s Versión: 3.30

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)

MBA3 - ERP 3 Departamento de Desarrollo


Manual de API’s Versión: 3.30

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”.

Nota 4: ACTUALIZACIONES.- La actualización de este documento y del Producto de Software MBA3


en relación a versiones anteriores, no implica que los procesos desarrollados de APIs anteriores se
desechen, sino más bien es un incremento a la funcionalidad existente.

MBA3 - ERP 4 Departamento de Desarrollo


Manual de API’s Versión: 3.30

ESTRUCTURA EN LA BASE DE DATOS (BD)

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:

Campo Tipo Tamaño Datos


Código de operación en procesos de
CODE_s Alfanumérico 5
ENTRADA/Salida de Información al Sistema
Código de la empresa sobre la cual se realizará la
CORP_s Alfanumérico 5
operación correspondiente.
Categoría:
• Si la información es de ENTRADA al
GROUP_CATEGORY_s Alfanumérico 5 SISTEMA, utilizaremos el código: API
• Si la información es de SALIDA del
SISTEMA, utilizaremos el código: APIOT
Estado actual del registro, que por defecto tendrá el
valor de: 1.
INTEGER_1 Integer 0 si fue procesado satisfactoriamente y otro valor si
se procesó con ERROR; dependiendo del error se
asignara su correspondiente.
Campo que indica que el API es llenado a través del
monitor de PDA:
• 0: conexión a través de Web Services o ODBC
INTEGER_3 Integer • 1: conexión a través del Monitor de
Comunicaciones
• 3: Información generada en el mismo sistema
como de salida
Número Secuencial de cada registro en SIST_API,
LONGINT_1 Longint
sirve para consultar el estado del proceso.
Fecha y hora de Ingreso en formato entero largo.
LONGINT_2 Longint
(Ref. TimeStamp VB.)
Código del usuario, identifica el usuario que crea el
TEXTO1_10 Alfanumérico 10 registro en la BDD. Dato que debe estar registrado
en la BDD.
IP de la máquina o dispositivo que se conecta a la
TEXTO1_24 Alfanumérico 24
BDD
Mensaje de Error en el proceso de almacenamiento
TEXTO1_X Text
del registro.
Campo utilizado para almacenar datos de Cabecera,
TEXTO2_X Text
tales como Pedidos, Factura, Cobros.
Campo utilizado para almacenar datos de Detalle,
TEXTO3_X Text
por ejemplo Pedidos, Facturas, Cobros, otros.
Campo utilizado para almacenar datos de Detalle de
TEXTO4_X Text
cuotas, Forma de Pago y otros.

MBA3 - ERP 5 Departamento de Desarrollo


Manual de API’s Versión: 3.30

Campo utilizado para almacenar datos de


TEXTO7_X Text
Información Adicional de Documento (Fact.)
Campo que almacena por defecto 0 y dependiendo
Opcion_i Integer
de la operación variará esta información.
Campo destinado para almacenar un identificador
IDConsulta_s Alfanumérico 50 del registro, desde aplicaciones externas, que
necesariamente debe ser única.
Número del Documento al que hace referencia en la
NumDoc_s Alfanumérico 60
operación, manejado dentro del LOG de API’s.
Campo que almacena el código de la sucursal donde
Origin Alfanumérico 3
se creó la información
Campo que almacena el código de la sucursal en la
Local_Destino Alfanumérico 3
cual se ejecutará esta operación.
Campo que almacena el código de la sucursal donde
Local_Origen Alfanumérico 3
se creó la información
Campo que almacena el número secuencial creado
Resultado_Respuesta Alfanumérico 20
por MBA en Ajustes de Inventario (MA/TE/TI).

TEXTO2B_X Text Continuación o alcance del campo TEXT02_x


TEXTO3B_X Text Continuación o alcance del campo TEXTO3_x
TEXTO3C_X Text Continuación o alcance del campo TEXTO3_x
TEXTO3D_X Text Continuación o alcance del campo TEXTO3_x
TEXTO3E_X Text Continuación o alcance del campo TEXTO3_x
TEXTO3F_X Text Continuación o alcance del campo TEXTO3_x
TEXTO3G_X Text Continuación o alcance del campo TEXTO3_x
TEXTO3H_X Text Continuación o alcance del campo TEXTO3_x
TEXTO4B_X Text Continuación o alcance del campo TEXTO4_x

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

NOTA: El código de la empresa y el password de acceso Web se especifica en la configuración de


MBA3, ruta: Administración del Sistema - Parámetros Empresa, ver anexo E para más información y
ejemplos.

MBA3 - ERP 6 Departamento de Desarrollo


Manual de API’s Versión: 3.30

DETALLE DEL PROCESO

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:

Código de operación en procesos de ENTRADA de Información al Sistema :

• 01: Código que permite identificar el proceso de Pedidos.


• 02: Código que permite identificar el proceso de Cobros.
• 04: Código que permite identificar el proceso de ingreso de Facturas.
• 05: Código que permite identificar el proceso de ingreso y actualización de Clientes.
• 08: Código que permite identificar el proceso de ingresos de transacciones Contables.
• 09: Código que permite identificar el ingreso de Depósitos Otros.
• 10: Código que permite identificar la operación Notas de Débito y Crédito.
• 12: Generar Ajuste Inventario y Transferencias de Egreso e Ingreso
• 13: Generar Órdenes de Compra
• 14: Código que identifica a las facturas de proveedores
• 16: Código de la operación para crear o actualizar Productos
• 17: Código que permite anular una factura de clientes
• 18: Código que permite crear o actualizar una Orden de Compra
• 19: Código que permite crear o actualizar datos de Proveedor
• 20: Código que identifica la operación Recepción de Inventario
• 21: Código que identifica la operación Creación Cheques Manuales
• 22: Código que identifica la operación Creación de Remisiones
• 25: Código que identifica la operación Ordenes de Producción
• 26.- Código que identifica la operación de ingreso y actualización de SubClientes
• 27.- Código que identifica la operación de Facturas Comercio Exterior – México
• 29.- Código que permite identificar el proceso de Cotizaciones.

MBA3 - ERP 7 Departamento de Desarrollo


Manual de API’s Versión: 3.30

Código de operación en procesos de SALIDA de Información a los Sistemas Externos,


En Todos los Documentos de Transacción los APIOUT se crean en el Proceso de Confirmación.

• 105 - Api de Salida - Ficha de Clientes.


• 116 - Api de Salida - Ficha de Productos
• 119 - Api de Salida - Ficha de Proveedores
• -------------------------------------------------------------------------------------
• 112 - Api de Salida - Ajustes Manuales de Inventario

• -------------------------------------------------------------------------------------
• 101 - Api de Salida - Clientes Pedidos Confirmados
• 122 - Api de Salida - Clientes Remisiones Confirmadas
• 104 - Api de Salida - Clientes Facturas Confirmadas
• -------------------------------------------------------------------------------------
• 118 - Api de Salida - Proveedores Órdenes de Compra Confirmados

• -------------------------------------------------------------------------------------
• 120 - Api de Salida Recepción de Inventario Facturas
• 120 - Api de Salida Recepción de Inventario Órdenes de Compra
• 120 - Api de Salida Recepción de Inventario Sin Documento
• -------------------------------------------------------------------------------------
• 129 - Api de Salida Pedidos de Producción Confirmados
• 125 - Api de Salida Orden de Producción – Creación
• 125 - Api de Salida Orden de Producción – Confirmación

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.

MBA3 - ERP 8 Departamento de Desarrollo


Manual de API’s Versión: 3.30

CREACIÓN Y ACTUALIZACION DE CLIENTES


Para el proceso de creación y actualización de clientes se debe tener en cuenta que el código de operación
es “05” para el INGRESO DE INFORMACION hacia el producto de Software y “105” para la SALIDA DE
INFORMACION hacia aplicaciones externas. Además los datos asignados en los campos del Web Services
o la tabla “SIST_API” son:

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

MBA3 - ERP 9 Departamento de Desarrollo


Manual de API’s Versión: 3.30

No. Nombre Campo Obl Tamaño Tipo de Dato Especificaciones


34 Impuestos 10 Alfanumérico 0;0;0;0;0; -> Solo 5 impuestos
Permite relacionar el mismo Cliente
35 Código de cliente relacionado 8 Alfanumérico
en varias empresas
36 Código Grupo de Descuentos 25 Alfanumérico Campo Relacionado
Modifica fecha de vencimiento en
37 Fecha Acuse X Booleano
función de la fecha acuse.
No permitir facturar productos que
38 Productos sin Negociación X Booleano
están fuera de Negociación.
39 Grupo Impresión Facturas X Booleano
40 Precio Convertido 1 X Booleano Uso Precio en moneda 2 convertido.
41 Precio Convertido 2 X Booleano Uso Precio en moneda 1 convertido.
42 Nombre Extenso Booleano Para Usaren Impresión
43 Número Interior 10 Alfanumérico
44 Número Exterior 10 Alfanumérico
45 Colonia 15 Alfanumérico
46 Localidad 15 Alfanumérico
47 Número Global Cliente 20 Alfanumérico Identificaciones Adicionales
48 Código Secundario Cliente 35 Alfanumérico Identificaciones Adicionales
49 Municipio 30 Alfanumérico
50 Moneda Única Booleano
51 Identificación Fiscal 2 20 Alfanumérico
52 Código de Categoría 5 Alfanumérico
53 Código Giro del Negocio 5 Alfanumérico
54 Código Régimen Fiscal 5 Alfanumérico
55 Cobro contra Entrega Booleano
56 Código Grupo de Impuestos 5 Alfanumérico
57 Cliente Inactivo Booleano
58 Cliente Control Booleano
59 Estatus No Venta Booleano
60 Motivo Texto
0 = NO VISUALIZA
61 Visualización de clientes Entero
1 = SI VISUALIZA
P=PRODUCTOS,
Tipo de Agrupación en G=GRUPOS,
62 1 Alfanumérico
Impresión I=IMPUESTOS,
BLANCO = NO APLICA
VALORES POSIBLES: 2 DATOS
TIPO TEXTO SEPARADOS POR;
Código de Agrupación de
63 10 Alfanumérico (PUNTO Y COMA), SI NO USA VA
Impresión
EN BLANCO…. EJEMPLO :
AAA;BBB;
64 Email Fiscal 50 Alfanumérico
65 Cuenta Contable Reserva 20 Alfanumérico
66 Referencia / Ubigeo 30 Alfanumérico

MBA3 - ERP 10 Departamento de Desarrollo


Manual de API’s Versión: 3.30

DATOS FISCALES – La Definición se basa en la dada en el Sistema. País: ECUADOR.

No Nombre de Campo Obl Tipo de Dato Tamaño Definición en Fiscal / Especificaciones

1 Lista Datos 1 X Texto 5 Tipo de Identificación Fiscal


2 Lista Datos 2 Texto 5 Tipo de Régimen Fiscal
3 Lista Datos 3 Texto 5 Países Paraísos Fiscales
4 Lista Datos 4 Texto 5 Tipo de Ingresos del Exterior
5 Lista Datos 5 X Texto 5 Tipo de Identificación Cliente
6 Lista Datos 6 Texto 5 Tipo de Pago
7 Lista Datos 7 Texto 5
8 Lista Datos 8 Texto 5
9 Alfanumérico 1 Alfanumérico 80
10 Alfanumérico 2 Alfanumérico 80
11 Alfanumérico 3 Alfanumérico 80
12 Alfanumérico 4 Alfanumérico 80
13 Alfanumérico 5 Alfanumérico 80
14 Valor 1 Real
15 Valor 2 Real
16 Valor 3 Real
17 Valor 4 Real
18 Valor 5 Real
19 Fecha 1 Fecha dd/mm/aa
20 Fecha 2 Fecha dd/mm/aa
21 Fecha 3 Fecha dd/mm/aa
22 Fecha 4 Fecha dd/mm/aa
23 Fecha 5 Fecha dd/mm/aa
24 Booleano 1 Booleano Si=1/No=0 Parte Relacionada
25 Booleano 2 Booleano Si=1/No=0
26 Booleano 3 Booleano Si=1/No=0
27 Booleano 4 Booleano Si=1/No=0
28 Booleano 5 Booleano Si=1/No=0
29 Booleano 6 Booleano Si=1/No=0
30 Booleano 7 Booleano Si=1/No=0
31 Texto 1
32 Texto 2
33 Texto 3

Los Campos sin Especificaciones NO son usados, pero se debe enviar su definición.

MBA3 - ERP 11 Departamento de Desarrollo


Manual de API’s Versión: 3.30

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

MBA3 - ERP 12 Departamento de Desarrollo


Manual de API’s Versión: 3.30

EJEMPLO SQL:

INSERT INTO SIST_API(CODE_s, CORP_s, GROUP_CATEGORY_s, INTEGER_1, TEXTO1_10,


TEXTO1_24, TEXTO2_X, NumDoc_s, Local_origen, Local_destino, ORIGIN, IDConsulta_s)
VALUES(‘05’,’AMERI’,’API’,1,’2’,‘192.168.181.233’, ’CL000072|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||||’, ‘API-200’, ‘ARA’, ‘PRI’, ‘ARA’, ‘AMERI_ API-200’)

EJEMPLO Web Services Entrada:

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

MBA3 - ERP 13 Departamento de Desarrollo


Manual de API’s Versión: 3.30

EJEMPLO Web Services Salida:

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

Para consultar un ID especifico, se usa el parámetro “ap_id”:


192.168.181.140:9974/wsAPIS/api_read?ap_corp=ACME&ap_pass=12345678&ap_id=502542

Para más información ver la última parte del Anexo E.

MBA3 - ERP 14 Departamento de Desarrollo


Manual de API’s Versión: 3.30

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

MBA3 - ERP 15 Departamento de Desarrollo


Manual de API’s Versión: 3.30

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

MBA3 - ERP 16 Departamento de Desarrollo


Manual de API’s Versión: 3.30

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.

Nota 4: Tome en cuenta que el campo “INTEGER_6:


0: Documento en Ver / Editar
1: Documento Confirmado.

Nota 5: Para el manejo de los impuestos o grupos de impuestos:

• 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.

Nota 6: La jerarquía para aplicar impuestos es la siguiente:


• Si en la ficha del producto en el grupo de impuesto se asigna un tipo de impuesto y es diferente
a “General”, se aplicará este impuesto.
• Si en la ficha de producto el tipo de impuesto es “General”, el sistema verificará si tiene asignado
un tipo de impuesto en la ficha del Cliente, si lo tiene, se procederá aplicar este impuesto; caso
contrario el sistema verificará si tiene asignado un grupo de impuesto en la sucursal de ser esto
verdadero aplicará este impuesto, caso contrario aplicará el impuesto asignado a nivel de
empresa.

MBA3 - ERP 17 Departamento de Desarrollo


Manual de API’s Versión: 3.30

SENTENCIA SQL:

INSERT INTO SIST_API(CODE_s, CORP_s, GROUP_CATEGORY_s, INTEGER_1, TEXTO1_10,


TEXTO1_24, TEXTO2_X, TEXTO3_X, Opcion_i, INTEGER_4, NumDoc_s, Local_origen, Local_destino,
ORIGIN, IDConsulta_s)
VALUES(‘01’, ’AMERI’, ’API’, 1, ’2’, ‘192.168.181.233’, ‘TRAMA CABECERA’, ‘TRAMA DETALLE’ , 0, 0,
‘PED-100’, ‘PRI’, ‘PRI’, ‘PRI’, ‘AMERI_200’)

EJEMPLO Web Services:

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

EJEMPLO Web Services Salida:

Consulta de nuevos pedidos sin procesar:


192.168.18.14:9974/wsAPIS/api_sel?ap_corp=DGE00&ap_pass=11112222&ap_code=101&ap_int1=1
Para más información ver la última parte del Anexo E.

MBA3 - ERP 18 Departamento de Desarrollo


Manual de API’s Versión: 3.30

CREACION DE FACTURAS DE CLIENTES


CONFIRMADAS O VER / EDITAR
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.

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:

No. Nombre Campo Obl Tamaño Tipo de Dato Especificaciones


Dato Obligatorio para Facturas
1 Número Factura X Real
Confirmadas
2 Código Cliente X 8 Alfanumérico Campo Relacionado
3 Fecha Emisión Factura Date Formato: dd/mm/aa
4 Fecha Vencimiento Factura Date Formato: dd/mm/aa
5 Identificación 15 Alfanumérico Identificación Fiscal
6 Nombre Sub-Cliente 30 Alfanumérico Campo Relacionado
7 Código Vendedor 5 Alfanumérico Campo Relacionado
8 Código Moneda 2 Alfanumérico Campo Relacionado
9 Valor de la Cotización Real Si es diferente a la del Sistema
10 Número de Pagos Factura Entero Por defecto 1
11 Código de la Bodega 3 Alfanumérico Campo Relacionado
12 Descuento de la Factura Real
13 Código del Sucursal 3 Alfanumérico
Si la parametrización del manejo
de secuenciales es por sucursal
14 Código de la Caja 3 Alfanumérico
debe ir 999 caso contrario el código
de la caja.
15 Vendedor comisiona Booleano
16 Teléfono Sub-Cliente 10 Alfanumérico
17 Dirección del Sub-Cliente 30 Alfanumérico
18 Identificación del Sub-Cliente 15 Alfanumérico
19 Código del Sub-Cliente Entero
20 Documento del Sub-Cliente 15 Alfanumérico Identificación Fiscal
21 Referencias del Sub-Cliente 20 Alfanumérico
Código de la Sucursal Origen de la
22 Origen (Código del Sucursal) X 3 Alfanumérico
Factura, igual campo 13
Al enviar el campo vacío el sistema
23 Tipo de Documento X 5 Alfanumérico lo interpretará como documento
Factura

MBA3 - ERP 19 Departamento de Desarrollo


Manual de API’s Versión: 3.30

No. Nombre Campo Obl Tamaño Tipo de Dato Especificaciones


Códigos separados y terminados en (;)
en el siguiente orden: Departamento;
24 Multidimensión 15 Alfanumérico Centro de Costo; Proyecto;
Subproyecto; Análisis 1; Análisis 2;
Análisis 3; Memo Proyecto;
25 Pago en Venta Booleano
26 Memo Factura Texto
Imprimir Campo Memo en
27 Booleano
Factura
28 Número de Aprobación Alfanumérico Emitido por el Ente Controlador (SRI)
29 Fecha Caducidad Date Emitido por el Ente Controlador (SRI)

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.

MBA3 - ERP 20 Departamento de Desarrollo


Manual de API’s Versión: 3.30

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

MBA3 - ERP 21 Departamento de Desarrollo


Manual de API’s Versión: 3.30

No. Nombre Campo Obl Tamaño Tipo de Dato Especificaciones

32 Código del Impuesto 2 Alfanumérico Campo Relacionado


33 Porcentaje del Impuesto 2 Real
34 Código del Impuesto 3 Alfanumérico Campo Relacionado
35 Porcentaje del Impuesto 3 Real
36 Código del Impuesto 4 Alfanumérico Campo Relacionado
37 Porcentaje del Impuesto 4 Real
38 Código del Impuesto 5 Alfanumérico Campo Relacionado
39 Porcentaje del Impuesto 5 Real
Separados con (;)
Lote;Cantidad;
40 Lote y Ubicación Texto
Ubicación1;Cantidad1;
Ubicación2;Cantidad2
Total Neto de la Línea de
41 Real
Detalle

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

Dato Obligatorio para Facturas


1 Número de la Factura X Real
Confirmadas
2 Fecha de Pago de la Cuota Fecha Formato: DD/MM/AAAA
3 Valor de la Cuota Real
4 Número de Días de Pago En el caso de ser a Crédito
5 Porcentaje En el caso de ser a Crédito

MBA3 - ERP 22 Departamento de Desarrollo


Manual de API’s Versión: 3.30

Datos de Información Adicional (ABC):

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.

MBA3 - ERP 23 Departamento de Desarrollo


Manual de API’s Versión: 3.30

DATOS FISCALES – La Definición se basa en la dada en el Sistema. País: ECUADOR.

No Nombre de Campo Obl Tipo de Dato Tamaño Definición en Fiscal / Especificaciones

1 Lista Datos 1 Texto 5 Distrito Aduanero


2 Lista Datos 2 Texto 5 Régimen
3 Lista Datos 3 Texto 5 Tipo de Documento
4 Lista Datos 4 Texto 5 Términos de la Factura
5 Lista Datos 5 Texto 5 País Adquisición
6 Lista Datos 6 Texto 5 País Origen
7 Lista Datos 7 Texto 5 Forma de Pago
8 Lista Datos 8 Texto 5 Tipo de Exportación (Refrendo)
9 Alfanumérico 1 Alfanumérico 80 Año
10 Alfanumérico 2 Alfanumérico 80 Correlativo
11 Alfanumérico 3 Alfanumérico 80 Verificador
12 Alfanumérico 4 Alfanumérico 80 Documento Transporte
13 Alfanumérico 5 Alfanumérico 80 Lugar de Inicio
14 Valor 1 Real
15 Valor 2 Real
16 Valor 3 Real
17 Valor 4 Real
18 Valor 5 Real
19 Fecha 1 Fecha dd/mm/aa Fecha Embarque
20 Fecha 2 Fecha dd/mm/aa
21 Fecha 3 Fecha dd/mm/aa
22 Fecha 4 Fecha dd/mm/aa
23 Fecha 5 Fecha dd/mm/aa
24 Booleano 1 Booleano Si=1/No=0 Factura de Exportación: SI=1 / NO=0
25 Booleano 2 Booleano Si=1/No=0 Refrendo: SI=1 / NO=0
26 Booleano 3 Booleano Si=1/No=0 No Reportable: SI=1 / NO=0
27 Booleano 4 Booleano Si=1/No=0 Exportación a Paraíso Fiscal: SI=1 / NO=0
28 Booleano 5 Booleano Si=1/No=0 El Ingreso del Exterior Gravado con IR: SI=1 / NO=0
29 Booleano 6 Booleano Si=1/No=0
30 Booleano 7 Booleano Si=1/No=0
Denominación del Régimen Fiscal Preferente o
31 Texto 1
Jurisdicción de Menor Imposición
32 Texto 2 Puerto Embarque
33 Texto 3 Puerto Destino

Los Campos sin Especificaciones NO son usados, pero se debe enviar su definición.

MBA3 - ERP 24 Departamento de Desarrollo


Manual de API’s Versión: 3.30

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 2: Para el caso de ingresar FACTURAS PENDIENTES A CONFIRMAR, el campo “Opcion_i”


debe estar asignado el valor UNO(1).

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 7: Toda factura NO CONFIRMADA, siempre entra en la cola de impresión.

Nota 8: En facturas NO CONFIRMADAS, no es necesario enviar la cuota de pago.

Nota 9: Para el manejo de los impuestos o grupos de impuestos:


Si el sistema detecta en el campo “Tiene iva” o “Impuesto X” (X, valor de 2 a 5) tienen valor
“VACIO”, el sistema tomará la parametrización establecida en el Producto de Software.
Si el sistema detecta en los campos “Tiene iva” o “Impuesto X” (X, valor de 2 a 5) 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.
Si el sistema detecta en los campos “Tiene iva” o “Impuesto X” (X, valor de 2 a 5) tienen valor
“0”, el sistema no aplicará el impuesto a este producto.

Nota 10: La jerarquía para aplicar impuestos es la siguiente:


Si en la ficha del producto en el grupo de impuesto se asigna un tipo de impuesto y es diferente
a “General”, se aplicará este impuesto.
Si en la ficha de producto el tipo de impuesto es “General”, el sistema verificará si tiene asignado
un tipo de impuesto en la ficha del Cliente, si lo tiene, se procederá aplicar este impuesto; caso
contrario el sistema verificará si tiene asignado un grupo de impuesto en la sucursal de ser esto
verdadero aplicará este impuesto, caso contrario aplicará el impuesto asignado a nivel de
empresa.

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.

MBA3 - ERP 25 Departamento de Desarrollo


Manual de API’s Versión: 3.30

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)

EJEMPLO Web Services Entrada:

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|||||||||||||||

MBA3 - ERP 26 Departamento de Desarrollo


Manual de API’s Versión: 3.30

NumDoc_s 9
Local_origen ARA
Local_destino PRI
IDConsulta_s AMERI_9
Opcion_i 0

EJEMPLO Web Services Salida:

Consulta de nuevas facturas confirmadas, sin procesar:


192.168.18.14:9974/wsAPIS/api_sel?ap_corp=DGE00&ap_pass=11112222&ap_code=104&ap_int1=1

Para más información ver la última parte del Anexo E.

MBA3 - ERP 27 Departamento de Desarrollo


Manual de API’s Versión: 3.30

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:

1. En el campo Opcion_i debe ir el valor 2 (Dos)

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

MBA3 - ERP 28 Departamento de Desarrollo


Manual de API’s Versión: 3.30

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

2 Número de Cuota a ser Real Si es Efectivo siempre debe ir (1)


afectada
Monto de Pago de esa
3 Factura X Real
4 Datos de Retención. Separados por punto y coma
4.1 Código del Tipo de Retención 2 Alfanumérico
4.2 Valor de la Retención Real
5 Código de Factura Alfanumérico

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

3 # del Cheque o Tarjeta de Para MX, se traslada a Comp- Pago.-


Crédito Real CtaOrdenate.

4 Nombre Entidad o Tarjeta de 25 Alfanumérico Para MX, se traslada a Comp- Pago.-


Crédito NoOperacón.
5 Fecha del Cheque o Voucher Fecha dd/mm/aaa
6 Origen de la Sucursal 3 Alfanumérico Campo Relacionado
7 Sub Tipo de Pago X Campo Relacionado
Código de la Cuenta
8 Depositada
9 Forma de Pago Depositada

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.

MBA3 - ERP 29 Departamento de Desarrollo


Manual de API’s Versión: 3.30

Nota 1: El código de operación para éste proceso de Entrada de Datos es “02”.

Nota 2: Si el sistema se ha parametrizado para manejo de Tipos de Documentos


Unificados, los cobros no se procesarán a través del Monitor de Servicios; se encolarán
en el monitor de Unificación para que el usuario del sistema seleccione los documentos
que se procesarán.

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, Local_origen, Local_destino, ORIGIN,
IDConsulta_s)
VALUES(‘02’,’AMERI’,’API’,1,’2’,‘192.168.181.233’,
22/03/12|50|MN|001|||N|R|D|4189318|001|22/03/12|DEPCL|1|PRI|11’,‘100000001|1|50||FC’,
EF|50|1||00/00/00|PRI|02||”’, ‘22354621’, ‘ARA’, ‘PRI’, ‘ARA’, ‘AMERI_22354621’)

EJEMPLO Web Services:

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||”

MBA3 - ERP 30 Departamento de Desarrollo


Manual de API’s Versión: 3.30

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.)

Ejemplo Web Services Salida:

Consulta de nuevos cobros de cliente, sin procesar:


192.168.18.14:9974/wsAPIS/api_sel?ap_corp=DGE00&ap_pass=11112222&ap_code=102&ap_int1=1

Para más información ver la última parte del Anexo E.

MBA3 - ERP 31 Departamento de Desarrollo


Manual de API’s Versión: 3.30

NOTAS DE CREDITO / DEBITO


El proceso de notas de débito / crédito, se aplica a clientes y proveedores; afectando un documento en
los mismos y a sus correspondientes cuotas de pago.

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

MBA3 - ERP 32 Departamento de Desarrollo


Manual de API’s Versión: 3.30

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

MBA3 - ERP 33 Departamento de Desarrollo


Manual de API’s Versión: 3.30

Datos Adicionales de Documento Impreso:


Tamaño Tipo de
No. Nombre Campo Obl Máx. Dato Especificaciones
1 No. Documento Impresión X
Si es el Documento del
2 Tipo de Documento Nota
Sistema dejar en blanco
3 Fecha de Impresión (00/00/00) X Fecha Si Blanco, toma del sistema
4 Hora de Impresión (00:00) X Hora Si Blanco, toma del sistema
5 Formato de Impresión Numero Valores (1 a 5), Por defecto 1
6 Espacio Disponible 1
7 Espacio Disponible 2
8 Espacio Disponible 3
9 Espacio Disponible 4
10 Espacio Disponible 5

MBA3 - ERP 34 Departamento de Desarrollo


Manual de API’s Versión: 3.30

DATOS FISCALES – La Definición se basa en la dada en el Sistema. País: ECUADOR.

No Nombre de Campo Obl Tipo de Dato Tamaño Definición en Fiscal / Especificaciones

1 Lista Datos 1 Texto 5 Distrito Aduanero


2 Lista Datos 2 Texto 5 Régimen
3 Lista Datos 3 Texto 5 Tipos de comprobante
4 Lista Datos 4 Texto 5 Términos de la Factura
5 Lista Datos 5 Texto 5 País Adquisición
6 Lista Datos 6 Texto 5 País Origen
7 Lista Datos 7 X Texto 5 Forma de Pago
8 Lista Datos 8 Texto 5 Tipo de Exportación (Refrendo)
9 Alfanumérico 1 Alfanumérico 80 Año
10 Alfanumérico 2 Alfanumérico 80 Documento Transporte
11 Alfanumérico 3 Alfanumérico 80 Lugar de Inicio
12 Alfanumérico 4 Alfanumérico 80
13 Alfanumérico 5 Alfanumérico 80
14 Valor 1 Real Correlativo
15 Valor 2 Real Verificador
16 Valor 3 Real
17 Valor 4 Real Valor FOB
18 Valor 5 Real
19 Fecha 1 Fecha dd/mm/aa Fecha Embarque Documento
20 Fecha 2 Fecha dd/mm/aa
21 Fecha 3 Fecha dd/mm/aa
22 Fecha 4 Fecha dd/mm/aa
23 Fecha 5 Fecha dd/mm/aa
24 Booleano 1 Booleano Si=1/No=0 NC / ND de Exportación, SI=1 / NO=0
25 Booleano 2 Booleano Si=1/No=0 Refrendo, SI=1 / NO=0
26 Booleano 3 Booleano Si=1/No=0 No Reportable, SI=1 / NO=0
27 Booleano 4 Booleano Si=1/No=0
28 Booleano 5 Booleano Si=1/No=0
29 Booleano 6 Booleano Si=1/No=0
30 Booleano 7 Booleano Si=1/No=0
31 Texto 1 Puerto Embarque
32 Texto 2 Puerto Destino
33 Texto 3

Los Campos sin Especificaciones NO son usados, pero se debe enviar su definición.

MBA3 - ERP 35 Departamento de Desarrollo


Manual de API’s Versión: 3.30

Nota 1: El código de operación para éste proceso de Entrada de Dato es “10”.

Nota 2: La “Opcion_i” puede tomar los siguientes valores:


“0” – Ver / Editar
“1” – Confirmada
“2” – Confirmada e Impresa
Nota 3: Si se pasa Datos Adicionales se almacena en el campo TEXTO6_X
Nota 4: Si se pasa Datos Fiscales se almacena en el campo TEXTO7_X

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; Opcion_i, Local_origen, Local_destino, ORIGIN,
IDConsulta_s)
VALUES(‘10’,’AMERI’,’API’,1,’2’,‘192.168.181.233’,
“1|FUTUR|0|2|TIJ00986|29/03/12|1000000000|||TIJ|0|0|0|0|0|0|0|0|US|REFEXT| TIPDOCFAC”,
’ CHD01|140|0|0|;;;;;;;;||140|0|0|0|0|0|0|0|0|0|0|0|0|0|0|||||’,
‘1|140’, 1, ‘ARA’, ‘PRI’, ‘ARA’, ‘AMERI_10245’)

EJEMPLO Web Services:

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|||||

MBA3 - ERP 36 Departamento de Desarrollo


Manual de API’s Versión: 3.30

TEXTO7_X ||||||||||||||||||||||||||||||||
Opcion_i 0=Ver/Editar / 1= Confirmado / 2 = Impreso
Local_origen PRI
Local_destino PRI
ORIGIN PRI
IDConsulta_s AMERI_10245

Ejemplo Web Services Salida:

Consulta de las notas crédito y débito nuevas y confirmadas, sin procesar:


192.168.18.14:9974/wsAPIS/api_sel?ap_corp=DGE00&ap_pass=11112222&ap_code=110&ap_int1=1

Para más información ver la última parte del Anexo E.

MBA3 - ERP 37 Departamento de Desarrollo


Manual de API’s Versión: 3.30

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 1: El código de operación para éste proceso de Entrada de Datos es “08”.

Nota 2: Se debe tener en cuenta que hay que enviar un detalle por Asiento.

MBA3 - ERP 38 Departamento de Desarrollo


Manual de API’s Versión: 3.30

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’)

EJEMPLO Web Services:

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

MBA3 - ERP 39 Departamento de Desarrollo


Manual de API’s Versión: 3.30

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

11 Código del tipo de Origen del X 5 Alfanumérico


Depósito

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

6 Código del Sub-tipo de la forma de


pago

MBA3 - ERP 40 Departamento de Desarrollo


Manual de API’s Versión: 3.30

Nota 1: El código de operación para éste proceso de Entrada de Datos es “09”.

Nota 2: Tener presente que este proceso ingresa el depósito confirmado.

MBA3 - ERP 41 Departamento de Desarrollo


Manual de API’s Versión: 3.30

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’)

EJEMPLO Web Services:

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

MBA3 - ERP 42 Departamento de Desarrollo


Manual de API’s Versión: 3.30

CREACION FACTURAS PROVEEDORES


El proceso de facturación a proveedores consiste en la creación del documento principal (Factura) donde
se incluye datos que identifican al documento en forma única.

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

MBA3 - ERP 43 Departamento de Desarrollo


Manual de API’s Versión: 3.30

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

4 Si aplica Impuesto 1 Booleano 0: No aplica, 1: aplica, VACIO:


toma parámetros del sistema

5 Si aplica Impuesto 2 Booleano 0: No aplica, 1: aplica, VACIO:


toma parámetros del sistema

6 Si aplica Impuesto 3 Booleano 0: No aplica, 1: aplica, VACIO:


toma parámetros del sistema

7 Si aplica Impuesto 4 Booleano 0: No aplica, 1: aplica, VACIO:


toma parámetros del sistema

8 Si aplica Impuesto 5 Booleano 0: No aplica, 1: aplica, VACIO:


toma parámetros del sistema
9 Si aplica Crédito Tributario Booleano 0: No aplica, 1: aplica
Códigos separados y terminados
en (;) Departamento; Centro de
10 Multidimensión 80 Alfanumérico Costo; Proyecto; Subproyecto;
Análisis 1; Análisis 2; Análisis 3;
Memo Proyecto;

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

Como datos de Retenciones en el caso de aplicar varias de las mismas tenemos:


Tamaño Tipo de
No. Nombre Campo Obl Máx. Dato Especificaciones
1 Código de la Retención 2 Alfanumérico Campo Relacionado
2 Base de la Retención Real
3 Total de la Retención Real
4 Memo de la Retención Texto
Códigos separados y terminados
en(;) en el siguiente orden:
Departamento; Centro de Costo;
5 Multidimensión 80 Alfanumérico
Proyecto; Subproyecto; Análisis 1;
Análisis 2; Análisis 3; Memo
Proyecto;

MBA3 - ERP 44 Departamento de Desarrollo


Manual de API’s Versión: 3.30

Nota 1: El código de operación para éste proceso en la Entrada de Datos es “14”.

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(;).

Nota 3: Para el manejo de los impuestos o grupos de impuestos:


• Si el sistema detecta en los campos “Si aplica iva X” (X, valor de 1 a 5)
tienen valor “VACIO”, el sistema tomará la parametrización establecida en
el Producto de Software.
• Si el sistema detecta en los campos “Si aplica iva X” (X, valor de 1 a 5)
tienen valor “1”, el sistema aplicará el impuesto a este producto y la
jerarquía se aplicara de acuerdo a la parametrización del Producto de
Software.
• Si el sistema detecta en los campos “Si aplica iva X” (X, valor de 1 a 5)
tienen valor “0”, el sistema no aplicara el impuesto a este producto.

Nota 4: La jerarquía para aplicar impuestos es la siguiente:


• Si en la ficha del producto en el grupo de impuesto se asigna un tipo de
impuesto y es diferente a “General”, se aplicará este impuesto.
• Si en la ficha de producto el tipo de impuesto es “General”, el sistema
verificará si tiene asignado un tipo de impuesto en la ficha de proveedor, si
lo tiene, se procederá aplicar este impuesto; caso contrario el sistema
verificará si tiene asignado un grupo de impuesto en la sucursal de ser esto
verdadero aplicará este impuesto, caso contrario aplicará el impuesto
asignado a nivel de empresa.

Nota 5: El campo “Cotización” enviado en la cabecera de la factura, si no se envía


valor o es valor CERO, el sistema obtendrá la cotización de esa fecha o una cercana
ingresada en el sistema.

Nota 6: Se debe tener muy en cuenta que el campo “Cotización” enviado en la


cabecera de la factura, el sistema tomará este valor en la recepción de inventario.

MBA3 - ERP 45 Departamento de Desarrollo


Manual de API’s Versión: 3.30

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)

EJEMPLO Web Services:

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

MBA3 - ERP 46 Departamento de Desarrollo


Manual de API’s Versión: 3.30

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

7 Código del Sub-Tipo de 3 Alfanumérico Aplica solo a Ajuste de Inventario


Ajuste
8 Código Cuenta de Ajuste 11 Alfanumérico Aplica solo a Ajuste de Inventario
9 Transferencia Manual 2 Alfanumérico
10 Referencia Externa 5 Alfanumérico
11 Orden de Compra Ligada Real Aplica para Devoluciones
Conjunto de datos separados y
terminados en (;) en el siguiente orden:
12 Multidimensión Cabecera 80 Alfanumérico Departamento; Centro de Costo;
Proyecto; Sub-Proyecto; Análisis 1;
Análisis 2; Análisis 3; Memo Proyecto;
13 Tipo de Ajuste (MA, TE, TI)

14 Código Bodega Destino 3 Alfanumérico Este campo solo aplica en


Transferencias de Egreso e Ingreso
15 Egreso Original Real
16 Código del Proveedor 5 Alfanumérico Aplica para Devoluciones

Referencia del Documento Externo del Proveedor en el caso de


17 20 Alfanumérico Devolución y Externo de Producción en
Externo
el caso de TE

18 Fecha del Ajuste o Date Formato: dd/mm/aa


Transferencia
19 Monto del Ajuste Real Aplica solo a Ajuste de Inventario

MBA3 - ERP 47 Departamento de Desarrollo


Manual de API’s Versión: 3.30

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 (;)

3 Listado de Lotes Texto Separados por (;) y terminado en (;)


Ubicación 1; Lote 1; Cantidad 1;

4 Signo de Ingreso (+/-) X Texto Ajuste"+/-", TE="-", TI= "+",


Dev Invt= "+"
5 Listado de Empaques Texto

6 Cantidad del Producto a Real


Ingresar

7 Cantidad del Producto Real


Segunda Unidad
8 Costo Promedio Real

Conjunto de datos separados y


terminados en (;) en el siguiente orden:
9 Multidimensión Detalle 80 Alfanumérico
Departamento; Centro de Costo;
Proyecto; Sub-Proyecto; Análisis 1;
Análisis 2; Análisis 3; Memo Proyecto;
10 Total por Línea de Detalle Real
11 Total por Producto Real
12 Total de Impuesto Real
13 Total Neto por Línea Real
14 Valor del Impuesto 2 Real
15 Valor del Impuesto 3 Real
16 Valor del Impuesto 4 Real
17 Valor del Impuesto 5 Real
18 Valor del Descuento Real

MBA3 - ERP 48 Departamento de Desarrollo


Manual de API’s Versión: 3.30

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:

• 1: Maneja costo promedio de la ficha del producto.


• 0: Toma el valor que se envía en el API.

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.

MBA3 - ERP 49 Departamento de Desarrollo


Manual de API’s Versión: 3.30

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')

EJEMPLO Web Services:

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'

EJEMPLO AJUSTE DE INVENTARIO

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

MBA3 - ERP 50 Departamento de Desarrollo


Manual de API’s Versión: 3.30

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')

EJEMPLO Web Services:

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

MBA3 - ERP 51 Departamento de Desarrollo


Manual de API’s Versión: 3.30

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')

EJEMPLO Web Services:

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'

EJEMPLO TRANSFERENCIAS DE INGRESO

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

Ejemplo Web Services Salida:

Consulta de nuevos ajustes y trasferencias de inventario, sin procesar:


192.168.18.14:9974/wsAPIS/api_sel?ap_corp=DGE00&ap_pass=11112222&ap_code=112&ap_int1=1

Para más información ver la última parte del Anexo E.

MBA3 - ERP 52 Departamento de Desarrollo


Manual de API’s Versión: 3.30

CREACION Y ACTUALIZACION DE PRODUCTOS


El API “Creación o Actualización de Productos”, permite crear un registro nuevo de producto o actualizar
datos del mismo, siempre y cuando este exista para el CORP correspondiente en que fue asentada la
información. Se debe tener muy en cuenta que existe información que es relacionada, es decir que debe
existir en la Base de Datos ya que se hace referencia de la misma a través de sus códigos; para lo cual
el proceso primero verifica y lo valida antes de asentar o grabar la información en las tablas
correspondientes que afecta la creación o actualización de Productos.

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

MBA3 - ERP 53 Departamento de Desarrollo


Manual de API’s Versión: 3.30

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

MBA3 - ERP 54 Departamento de Desarrollo


Manual de API’s Versión: 3.30

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

MBA3 - ERP 55 Departamento de Desarrollo


Manual de API’s Versión: 3.30

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)

MBA3 - ERP 56 Departamento de Desarrollo


Manual de API’s Versión: 3.30

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

Nota 2: Tome en cuenta que el campo “Opcion_i

• Opcion_i = 0; Creación nuevo producto – Por Defecto


• Opcion_i = 1; Actualización de un producto existente.

MBA3 - ERP 57 Departamento de Desarrollo


Manual de API’s Versión: 3.30

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, Opcion_i )
VALUES(“16”,”AMERI”,”API”,1,”2”,”192.168.181.233”,” Datos de Trama”,"","",9,”RP1-AMERI”, ”PRI”’,
PRI”, ”PRI”, 0)

EJEMPLO Web Services:

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

Ejemplo Web Services Salida:

Consulta de nuevos productos ingresados al sistema, sin procesar:


192.168.18.14:9974/wsAPIS/api_sel?ap_corp=DGE00&ap_pass=11112222&ap_code=116&ap_int1=1

Para más información ver la última parte del Anexo E.

MBA3 - ERP 58 Departamento de Desarrollo


Manual de API’s Versión: 3.30

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

MBA3 - ERP 59 Departamento de Desarrollo


Manual de API’s Versión: 3.30

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

Nota 2: El número de la Orden de compra, cuando es de CREACION el sistema lo asigna


automáticamente, caso contrario el sistema recuperará la Orden de Compra y añadirá
todas las líneas de detalle ingresadas en el API.

• Opcion_i = 0: Nueva Orden de Compra.


• Opcion_i = 1: Añadir Detalle a Orden de Compra Existente.

Nota 3: La Orden de Compra se genera como Pendiente a Confirmar.

MBA3 - ERP 60 Departamento de Desarrollo


Manual de API’s Versión: 3.30

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)

EJEMPLO Web Services:

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

Ejemplo de Órdenes de Compra:

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

Ejemplo Web Services Salida:

Consulta de nuevas Órdenes de Compra, sin procesar:


192.168.18.14:9974/wsAPIS/api_sel?ap_corp=DGE00&ap_pass=11112222&ap_code=118&ap_int1=1

Para más información ver la última parte del Anexo E.

MBA3 - ERP 61 Departamento de Desarrollo


Manual de API’s Versión: 3.30

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

MBA3 - ERP 62 Departamento de Desarrollo


Manual de API’s Versión: 3.30

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)

Conjunto de datos separados por (;)


(#Pedimento; Fecha_Pedimento;
5 Datos del Pedimento Texto Entrada_Pedimento;
Puerto_Origen_Pedimento;
Codigo_Tipo_Pedimento)
Conjunto de datos separados por (;)
Datos del Estado y
6 Texto (Codigo_Estado_Lote; Calificacion;
Calificación
Temperatura)
Datos del Peso, Embarque y Conjunto de datos separados por (;) (#
7 Texto
Memo Piezas; Codigo_Empaque_Tara; Memo)

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:

• 0: Recepción Factura de Proveedores


• 1: Recepción Órdenes de Compra
• 2: Recepción de Inventario sin Tipo de Documento especifico.

MBA3 - ERP 63 Departamento de Desarrollo


Manual de API’s Versión: 3.30

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('20','GANDH',’API’,1,’2’,’192.168.181.233’,
100|CODIGO_PROVEEDOR|20/03/12|PRI|GEN|MEMO RECEPCION 100',' 633047033496|20||',52,’REC-
52’, ‘5’, ‘PRI’, ‘PRI’,0)

EJEMPLO Web Services:

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

Ejemplo de Recepción de Inventario:

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

MBA3 - ERP 64 Departamento de Desarrollo


Manual de API’s Versión: 3.30

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('20','FRIGO',’API’,1,’1’,’192.168.181.233’,’
0|PR001|20/03/12|PRI|GEN|Recepcion_Fact000|11:42:00|LANCHAS|TARQUI|01|35|PART|01|;;;;|;;;;|0
;0;0;0;0’,’ 633047033496|15|||;;;;|;;|;;’ ,52,’EXT-52’, ‘PRI’, ‘PRI’, ‘PRI’,2)

EJEMPLO Web Services:

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

Ejemplo de Recepción de Inventario con Otro tipo de Documento:

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

Ejemplo Web Services Salida:

Consulta de Api de salida Recepción de Inventario, sin procesar:


192.168.18.14:9974/wsAPIS/api_sel?ap_corp=DGE00&ap_pass=11112222&ap_code=120&ap_int1=1
Para más información ver la última parte del Anexo E.

MBA3 - ERP 65 Departamento de Desarrollo


Manual de API’s Versión: 3.30

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

Nota 1: El código de operación para éste proceso de Entrada de Datos es “21”.

MBA3 - ERP 66 Departamento de Desarrollo


Manual de API’s Versión: 3.30

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('21',’AMERI’,’API’,1,’2’,’192.168.181.233’,‘ 0147104553|99999990000’,’ 1|26/05/11|Karina
Martinez|100|Alpallana| entregado el 26/05/11|’,102,’AMERI-102’, ‘PRI’, ‘PRI’, ‘PRI’,0)

EJEMPLO Web Services:

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

Ejemplo de Cheques Manuales:

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

MBA3 - ERP 67 Departamento de Desarrollo


Manual de API’s Versión: 3.30

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

MBA3 - ERP 68 Departamento de Desarrollo


Manual de API’s Versión: 3.30

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:

• Creación “nuevo proveedor” (Opcion_i=0)


• Actualización de un proveedor existente (Opcion_i=1); para esta
operación se debe ingresar este dato.

MBA3 - ERP 69 Departamento de Desarrollo


Manual de API’s Versión: 3.30

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, Local_origen, Local_destino, ORIGIN, Opcion_i )
VALUES ('19',’AMERI’,’API’,1,’2’,’192.168.181.233’,‘ 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|||’, ’ P0001’,’ P0001’,
‘PRI’, ‘PRI’, ‘PRI’, 0)

EJEMPLO Web Services:

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

Ejemplo de Creación de Proveedor:

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

MBA3 - ERP 70 Departamento de Desarrollo


Manual de API’s Versión: 3.30

Ejemplo Web Services Salida:

Consulta de nuevos proveedores creados en el sistema, sin procesar:


192.168.18.14:9974/wsAPIS/api_sel?ap_corp=DGE00&ap_pass=11112222&ap_code=119&ap_int1=1

Para más información ver la última parte del Anexo E.

MBA3 - ERP 71 Departamento de Desarrollo


Manual de API’s Versión: 3.30

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

MBA3 - ERP 72 Departamento de Desarrollo


Manual de API’s Versión: 3.30

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.

MBA3 - ERP 73 Departamento de Desarrollo


Manual de API’s Versión: 3.30

Campo Relacionado, Blanco si es el


33 Código del Impuesto 5
Impuesto General.
34 Disponible
Conjunto de datos separados por
35 Lote Ubicación y Valor
PUNTO Y COMA (;)
Si envía este valor en la trama este
valor será dividido para la cantidad
36 Total Neto de la Línea de detalle Real y tomara el valor unitario
independiente de lo enviado en ese
campo.

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 3: Toda remisión CONFIRMADA, siempre entra en la cola de impresión.

Nota 4: Para el manejo de los impuestos o grupos de impuestos:

• Si el sistema detecta en el campo “Tiene iva o “Impuesto X” (X, valor de 2


a 5) tienen valor “VACIO”, el sistema tomará la parametrización establecida
en el Producto de Software.
• Si el sistema detecta en los campos “Tiene iva” o “Impuesto X” (X, valor
de 2 a 5) 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.
• Si el sistema detecta en los campos “Tiene iva” o “Impuesto X” (X, valor
de 2 a 5) tienen valor “0”, el sistema no aplicará el impuesto a este producto.

Nota 5: La jerarquía para aplicar impuestos es la siguiente:

• Si en la ficha del producto en el grupo de impuesto se asigna un tipo de


impuesto y es diferente a “General”, se aplicará este impuesto.
• Si en la ficha de producto el tipo de impuesto es “General”, el sistema
verificará si tiene asignado un tipo de impuesto en la ficha del Cliente, si lo
tiene, se procederá aplicar este impuesto; caso contrario el sistema verificará
si tiene asignado un grupo de impuesto en la sucursal de ser esto verdadero
aplicará este impuesto, caso contrario aplicará el impuesto asignado a nivel
de empresa.

MBA3 - ERP 74 Departamento de Desarrollo


Manual de API’s Versión: 3.30

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:

INSERT INTO SIST_API(CODE_s, CORP_s, GROUP_CATEGORY_s, INTEGER_1, TEXTO1_10,


TEXTO1_24, TEXTO2_X, TEXTO3_X, NumDoc_s; Origin; Local_Destino; Local_Origen; IDConsulta_s;
Opcion_i)
VALUES(‘22’,’AMERI’,’API’,1,’2’,‘192.168.181.233’,’
100|019978|17/10/2013|17/10/2013|||MN|0|SEL|0|PRI||||||||;;;;;;;|MEMO|101’,’
100|RP1|1|111.00|0|0|||||||observaciones|||||||||||;;;;;;;||||||||||||111.00|100|RP2|1|211.00|0|0||||||
|observaciones2|||||||||||;;;;;;;||||||||||||211.00’,‘9’; ‘PRI, ‘PRI’, ‘PRI, ‘DERMAARA009’;0)

EJEMPLO Web Services:

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

MBA3 - ERP 75 Departamento de Desarrollo


Manual de API’s Versión: 3.30

Local_destino PRI
IDConsulta_s AMERI_9
Opcion_i 0

Ejemplo Web Services Salida:

Consulta de Remisiones Confirmadas, sin procesar:


192.168.18.14:9974/wsAPIS/api_sel?ap_corp=DGE00&ap_pass=11112222&ap_code=122&ap_int1=1

Para más información ver la última parte del Anexo E.

MBA3 - ERP 76 Departamento de Desarrollo


Manual de API’s Versión: 3.30

CREACION SOLICITUD DE REQUISICION

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 código de Operación de este Proceso es “23”


• Los datos de las columnas “origin”, “local_origen”, “local_destino”, debe ser los mismos
valores, y en función de este dato se validará el Código de la Bodega que se consta en
la trama de datos de la cabecera.
• El dato en la columna “Opcion_i”, debe ser:
o “0 = Registro Confirmados”
• Para el manejo de esta operación es necesario que el código de Usuario enviado en el
campo “TEXT1_10”; sea uno valido y tenga permisos necesarios

DESCRIPCIÓN DE LA INFORMACIÓN PRINCIPAL

El contenido de la trama de datos que ingresa la información principal del registro está
compuesto de la siguiente información:

1. Número, Corresponde a un valor numérico entero, el mismo permite identificar el


registro, es un campo obligatorio y diferente de 0, en MBA es referencial pues el proceso
el sistema MBA asigna el secuencial correspondiente.
2. Código de Departamento, Corresponde al código relacional del departamento, el
mismo es un valor tipo texto de 3 caracteres, su registro es opcional y es validado la
existencia o no en el ERP.
3. Código de Área, Corresponde al código relacional del área, el mismo es un valor tipo
texto de 3 caracteres, su registro es opcional y es validado la existencia o no en el ERP.
4. Prioridad, Corresponde a un valor entero, su registro es obligatorio y puede tomar los
valores de “1=Normal”, “2=Urgente”, “3=Reserva”.

MBA3 - ERP 77 Departamento de Desarrollo


Manual de API’s Versión: 3.30

5. Código de Bodega, Corresponde al código relacional de la bodegas, el mismo es un


valor tipo texto de 3 caracteres, su registro es opcional, pero si está definido es validado
la su existencia y su relación con la Sucursal definida para este registro.
6. Número Doc. Relacionado, Corresponde a una información alfanumérica de hasta 20
caracteres, su registro es opcional.
7. Fecha Solicitud, Corresponde a la fecha de ingreso de la solicitud, el dato debe ser
“dd/mm/yyyy”, su registro es obligatorio.
8. Fecha Requerida, Corresponde a la fecha requerida de la solicitud, el dato debe ser
“dd/mm/yyyy”, su registro es opcional, el valor en blanco es: “00/00/00”
9. Información Multidimensional, Corresponde al detalle de la información de la
multidimensión, este campo es compuesto, es decir tiene varios 8 campos internos
separados por punto y coma “;” y terminados en Punto y Coma “;”. La información es:
“Departamento; Centro de Costos; Proyecto; SubProyecto; Analisis1; Analisis2;
Analisis3; Memo;”, Todos excepto el último son valores relacionados y que son validados
si son ingresados.
10. Observaciones, Corresponde a una información alfanumérica de hasta 250 caracteres,
su registro es opcional.

MBA3 - ERP 78 Departamento de Desarrollo


Manual de API’s Versión: 3.30

DESCRIPCIÓN DE LA INFORMACIÓN DEL DETALLE

El contenido de la trama de datos que ingresa la información del detalle del registro está
compuesto de la siguiente información:

1. Tipo Producto, Corresponde a un valor texto de 1 carácter, este campo es obligatorio,


Indica P = Producto o C = Cuenta.
2. Código Producto, Corresponde a un valor texto de hasta 20 caracteres, este campo es
obligatorio
3. Cantidad. Corresponde a un valor real, este campo es obligatorio
4. Precio Referencial. Corresponde a un valor tipo real, es de tipo opcional
5. Código de Moneda. Corresponde a un valor tipo alfanumérico de 2 caracteres, este
campo es obligatorio, si ingresa valor se relaciona con las monedas
6. Fecha Requerida. Corresponde a un valor fecha, este campo es Opcional.
7. Código de Proveedor Sugerido. Corresponde a un valor tipo alfanumérico de hasta
8 caracteres, este campo es Opcional, si se ingresa valor será relacionado con la tabla
de Proveedores
8. Información Multidimensional, Corresponde al detalle de la información de la
multidimensión, este campo es compuesto, es decir tiene varios 8 campos internos
separados por punto y coma “;” y terminados en Punto y Coma “;”. La información es:
“Departamento; Centro de Costos; Proyecto; SubProyecto; Análisis1; Análisis2;
Análisis3, Memo;”, Todos excepto el último son valores relacionados y que son validados
si son ingresados
9. Especificaciones. Corresponde a un valor tipo texto de hasta 256 caracteres, este
campo es Opcional
10. Comentarios. Corresponde a un valor tipo texto de hasta 256 caracteres, este campo
es Opcional.

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

MBA3 - ERP 79 Departamento de Desarrollo


Manual de API’s Versión: 3.30

EJEMPLO DATOS EN CAMPOS:

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

Descripción de Tabla de Datos:

En la tabla se almacena un registro de remisiones con las siguientes características:

o Código de Operación No. “23” (CODE_s),


o Registro de la Empresa “AMERI” (CORP_s),
o Categoría “API” (GROUP_CATEGORY_s),
o Como es registro para procesar se debe enviar el valor “1” (INTEGER_1),
o Automáticamente se genera un número secuencia de la tabla (LONGINT_1),

MBA3 - ERP 80 Departamento de Desarrollo


Manual de API’s Versión: 3.30

o La siguiente columna indica el código de la sucursal donde se originó el registro “PRI”


(ORIGIN), como este valor es generado por una aplicación externa se recomienda ubicar
el código de la sucursal principal,
o El registro fue creado por el usuario de código “2” (TEXTO1_10)
o La dirección IP “192.168.181.233” (TEXTO1_24), corresponde al número de la máquina
fuente,
o El número de documento “200” (NUMDOC_S),
o Se debe especificar el Local origen “PRI” (LOCAL_ORIGEN),
o Se debe especificar el Local destino “ARAI” (LOCAL_DESTINO),
o Se debe especificar el ID del registro que viene hacer el mismo del número del
documento, más el código de la empresa “200-AMERI” (ID_CONSULTA_S)
o Se debe especificar el tipo de acción especial del registro en este caso “0”,(Opcion_i),
por ser confirmado.
o Los datos de “Cabecera” (TEXTO2_X) y “Detalle” (TEXTO3_X), como se muestra a
continuación:

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”

MBA3 - ERP 81 Departamento de Desarrollo


Manual de API’s Versión: 3.30

EJEMPLO 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; Origin; Local_Destino; Local_Origen; IDConsulta_s; Opcion_i)
VALUES
(‘23’,’AMERI’,’API’,1,’2’,‘192.168.181.233’,’TRAMACABECERA’,’TRAMADETALLE’,‘9’;‘ARA’,‘PRI’,‘ARA’,‘INF1
2345’;0)

EJEMPLO Web Services:

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’

MBA3 - ERP 82 Departamento de Desarrollo


Manual de API’s Versión: 3.30

PEDIDOS INTERNOS DIRECTOS CONFIRMADOS

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 código de Operación de este Proceso es “24”


• Los datos de las columnas “origin”, “local_origen”, corresponden a los datos de la
Sucursal Solicitante, debe ser los mismos valores, y en función de este dato se validará
el código de la Bodega Solicitante, que consta en la trama de datos de la cabecera.
• Los datos de las columnas “local_destino”, corresponden los datos de la Sucursal
Solicitada de Egreso de Inventario, en función de este dato se validará el código de la
Bodega Solicitada del Egreso de Inventario que consta en la trama de datos de la
cabecera.
• El dato en la columna “Opcion_i”, puede ser:
o “0 = Registro Confirmado”
• Para el manejo de esta operación es necesario que el código de Usuario enviado en el
campo “TEXT1_10”; sea uno valido y tenga permisos necesarios

MBA3 - ERP 83 Departamento de Desarrollo


Manual de API’s Versión: 3.30

DESCRIPCIÓN DE LA INFORMACIÓN PRINCIPAL

El contenido de la trama de datos que ingresa la información principal del registro está
compuesto de la siguiente información:

1. Número, Corresponde a un valor numérico entero, el mismo permite identificar el


registro, es un campo obligatorio y diferente de 0, en MBA es referencial pues el proceso
el sistema MBA asigna el secuencial correspondiente.
2. Fecha de Pedido, Corresponde a la fecha del pedido, el dato debe ser “dd/mm/yyyy”,
su registro es obligatorio no puede ser blanco.
3. Fecha de Entrega, Corresponde a la fecha del entrega, el dato debe ser “dd/mm/yyyy”,
su registro es obligatorio no puede ser blanco.
4. Nombre de Solicitante, Corresponde a una información alfanumérica de hasta 30
caracteres, su registro es opcional.
5. Tipo de Pedido, Corresponde a una información de 2 caracteres los valores posibles
pueden ser: TR = Transferencias o AK = Armado de Kits.
6. Código Medio de Captura, Corresponde a un valor alfanumérico de hasta 5
caracteres, este campo es opcional y si es ingresado se validada su relación en la base.
7. Código de Transporte, Corresponde a un valor alfanumérico de hasta 5 caracteres,
este campo es opcional y si es ingresado se validada su relación en la base.
8. Código del Vendedor; Corresponde a un valor alfanumérico de hasta 5 caracteres,
este campo es opcional y si es ingresado se validada su relación en la base.
9. Código de Bodega Solicitante; Corresponde a un valor alfanumérico de hasta 3
caracteres, este campo es obligatorio, se validada su relación en la base con la Sucursal
Solicitante.
10. Código de Bodega Solicitada; Corresponde a un valor alfanumérico de hasta 3
caracteres, este campo es obligatorio, se validada su relación en la base con la Sucursal
Solicitada.
11. Memo General, Corresponde a un valor texto este campo es opcional.
12. Información Pedido, Corresponde a un valor texto este campo es opcional.
13. Mensaje a Bodegas, Corresponde a un valor texto este campo es opcional.
14. Mensaje a Producción, Corresponde a un valor texto este campo es opcional.
15. Mensaje a Cliente, Corresponde a un valor texto este campo es opcional.
16. Mensaje a Transporte, Corresponde a un valor texto este campo es opcional.

DESCRIPCIÓN DE LA INFORMACIÓN DEL DETALLE

El contenido de la trama de datos que ingresa la información del detalle del registro está
compuesto de la siguiente información:

1. Código Producto, Corresponde a un valor texto de hasta 20 caracteres, este campo es


obligatorio

MBA3 - ERP 84 Departamento de Desarrollo


Manual de API’s Versión: 3.30

2. Cantidad. Corresponde a un valor real, este campo es obligatorio

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

MBA3 - ERP 85 Departamento de Desarrollo


Manual de API’s Versión: 3.30

EJEMPLO DATOS EN CAMPOS:

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

Descripción de Tabla de Datos:

En la tabla se almacena un registro de remisiones con las siguientes características:

o Código de Operación No. “24” (CODE_s),


o Registro de la Empresa “AMERI” (CORP_s),
o Categoría “API” (GROUP_CATEGORY_s),
o Como es registro para procesar se debe enviar el valor “1” (INTEGER_1),
o Automáticamente se genera un número secuencia de la tabla (LONGINT_1),
o La siguiente columna indica el código de la sucursal donde se originó el registro “PRI”
(ORIGIN), como este valor es generado por una aplicación externa se recomienda ubicar
el código de la sucursal principal,
o El registro fue creado por el usuario de código “2” (TEXTO1_10)
o La dirección IP “192.168.181.233” (TEXTO1_24), corresponde al número de la máquina
fuente,
o El número de documento “200” (NUMDOC_S),
o Se debe especificar el Local origen “PRI” (LOCAL_ORIGEN),
o Se debe especificar el Local destino “ARAI” (LOCAL_DESTINO),
o Se debe especificar el ID del registro que viene hacer el mismo del número del
documento, más el código de la empresa “200-AMERI” (ID_CONSULTA_S)
o Se debe especificar el tipo de acción especial del registro en este caso “0”,(Opcion_i),
por ser confirmado.

MBA3 - ERP 86 Departamento de Desarrollo


Manual de API’s Versión: 3.30

o Los datos de “Cabecera” (TEXTO2_X) y “Detalle” (TEXTO3_X), como se muestra a


continuación:

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”

MBA3 - ERP 87 Departamento de Desarrollo


Manual de API’s Versión: 3.30

EJEMPLO 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; Origin; Local_Destino; Local_Origen; IDConsulta_s; Opcion_i)
VALUES
(‘23’,’AMERI’,’API’,1,’2’,‘192.168.181.233’,’TRAMACABECERA’,’TRAMADETALLE’,‘9’;‘ARA’,‘PRI’,‘ARA’,‘INF1
2345’;0)

EJEMPLO Web Services:

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’

MBA3 - ERP 88 Departamento de Desarrollo


Manual de API’s Versión: 3.30

API DE ORDENES DE PRODUCCION


Datos de Cabecera:
Tamaño Tipo de
No. Nombre Campo Obl Especificaciones
Máx. Dato
El campo es requerido en función
Numero de Orden de
1 X Entero de la configuración dada en el
Producción campo : Opcion_i (Ver detalles)
Formato: dd/mm/aa; Si no hay
2 Fecha del Ajuste X Date
información debe ir: 00/00/00
Código Bodega Materia
3 X 3 Alfanumérico Campo Relacionado
Prima
Código Bodega Productos
4 X 3 Alfanumérico Campo Relacionado
en Proceso
Código Bodega Producto
5 X 3 Alfanumérico Campo Relacionado
Terminado
6 Tipo Orden de Producción 5 Alfanumérico Campo Relacionado
Prioridad Orden de
7 5 Alfanumérico Campo Relacionado
Producción
Campo Relacionado; Valores
posibles
1=Planificado
Estatus Orden de 2=Planificado en Espera
8 2 Alfanumérico
Producción 3=En Proceso
4=En Proceso en Espera
5=Finalizado
0=Ninguno
Campo Relacionado; Si no hay
9 Documento de Control Entero
información debe ir “0”
10 Número Lote 25 Alfanumérico Campo Relacionado
Campo Relacionado; Si no hay
11 Unidad de Control Entero
información debe ir “0”
Campo Relacionado, si se ingresa
este valor se verificara, datos del
Número Pedido de Pedido de Producción Confirmado
12 X 25 Alfanumérico
Producción contra los datos registrados en la
trama, si no es necesario se debe
enviar Cero “0”
Formato: dd/mm/aa; Si no hay
13 Fecha Requerida Interna Date
información debe ir: 00/00/00
Formato: dd/mm/aa; Si no hay
14 Fecha Requerida Cliente Date
información debe ir: 00/00/00
Formato: dd/mm/aa; Si no hay
15 Fecha Programada Inicio Date
información debe ir: 00/00/00
Formato: dd/mm/aa; Si no hay
16 Fecha Estimada Entrega Date
información debe ir: 00/00/00
Formato: dd/mm/aa; Si no hay
17 Fecha Real Inicio Date
información debe ir: 00/00/00
Formato: HH:mm:ss; Si no hay
18 Hora Requerida Interna Time
información debe ir: 00:00:00
Formato: HH:mm:ss; Si no hay
19 Hora Requerida Cliente Time
información debe ir: 00:00:00
Formato: HH:mm:ss; Si no hay
20 Hora Programada Inicio Time
información debe ir: 00:00:00

MBA3 - ERP 89 Departamento de Desarrollo


Manual de API’s Versión: 3.30

Formato: HH:mm:ss; Si no hay


21 Hora Real Inicio Time
información debe ir: 00:00:00
Código Cliente Pedido de
22 8 Alfanumérico Campo Relacionado
Producción
Código Producto
23 X 20 Alfanumérico Campo Relacionado
Terminado
24 Ruta de Producción X 5 Alfanumérico Si es la Ruta Estandar = ESTAN
25 Cantidad X 5 Real Valor superior a “0”
26 Cantidad Segunda Unidad 5 Real Valor superior a “0”
Conjunto de datos separados y
terminados en (;) en el siguiente
orden: Departamento; Centro de
27 Multidimensión 80 Alfanumérico
Costo; Proyecto; Sub-Proyecto;
Análisis 1; Análisis 2; Análisis 3;
Memo Proyecto;
Datos separados por (;), No va al
Final ;
Lote/Ubicación Texto Lote; Cantidad;
28
del Producto Terminado Ubicacion1;Cantidad1;
Ubicacion2;Cantidad2
Cantidad (Lote) = Cantidad (Ubic.)
29 Notas Orden Texto

30 Memo General Texto


31 Memo Bodega Texto
32 Memo Responsable Texto

33 Memo Avance Texto

MBA3 - ERP 90 Departamento de Desarrollo


Manual de API’s Versión: 3.30

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

MBA3 - ERP 91 Departamento de Desarrollo


Manual de API’s Versión: 3.30

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”.

Nota 4: Opciones específicas de API:

• Opcion_i = 1: Crea Orden de Producción,


• Opcion_i = 2: Entrega de Materia Prima
• Opcion_i = 3: Confirma Orden de Producción
• Opcion_i = 4: Crea Orden de Producción, Entrega Materia Prima y Confirma
Orden de Producción.

Nota 5: Dada la Opcion_i el campo “Número de Orden de Producción” será:

• Opcion_i = 1: No Obligatorio.
• Opcion_i = 2: Obligatorio
• Opcion_i = 3: Obligatorio
• Opcion_i = 4: No Obligatorio.

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(‘25’,’AMERI’,’API’,1,’2’,’192.168.181.233’,
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,
MP1|MP|=|20|0||||;;;;;;;;|MEMO LINEA,117,’AMRI_117’, 'PRI', ‘PRI’, 'PRI')

EJEMPLO Web Services:

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'

MBA3 - ERP 92 Departamento de Desarrollo


Manual de API’s Versión: 3.30

EJEMPLO AJUSTE DE INVENTARIO

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.

Ejemplo Web Services Salida:

Consulta de API Ordenes de Producción, sin procesar:


192.168.18.14:9974/wsAPIS/api_sel?ap_corp=DGE00&ap_pass=11112222&ap_code=125&ap_int1=1

Para más información ver la última parte del Anexo E.

MBA3 - ERP 93 Departamento de Desarrollo


Manual de API’s Versión: 3.30

CREACIÓN Y ACTUALIZACION SUBCLIENTES


Para el proceso de creación y actualización de SubClientes se debe tener en cuenta que el código de
operación es “26” para el INGRESO DE INFORMACION hacia el producto de Software
Además los datos asignados en los campos del Web Services o la tabla “SIST_API” son:

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.

MBA3 - ERP 94 Departamento de Desarrollo


Manual de API’s Versión: 3.30

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”

MBA3 - ERP 95 Departamento de Desarrollo


Manual de API’s Versión: 3.30

SENTENCIA SQL:

INSERT INTO SIST_API(CODE_s, CORP_s, GROUP_CATEGORY_s, INTEGER_1, TEXTO1_10,


TEXTO1_24, TEXTO2_X, NumDoc_s, Local_origen, Local_destino, ORIGIN, IDConsulta_s)
VALUES(‘05’,’AMERI’,’API’,1,’2’,‘192.168.181.233’, ‘Datos de Trama’, ‘API-200’, ‘ARA’, ‘PRI’, ‘ARA’,
‘AMERI_ API-200’)

EJEMPLO Web Services:

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

MBA3 - ERP 96 Departamento de Desarrollo


Manual de API’s Versión: 3.30

CREACION DE FACTURAS DE CLIENTES


COMERCIO-EXTERIOR - MEXICO
VER / EDITAR - CONFIRMADAS

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.

El proceso de facturación consiste en la creación del documento en tres estados;


CONFIRMADAS (Opcion_i=0)
VER-EDITAR (Opcion_i=1)
VER-EDITAR – CONFIRMACION AUTOMATICA (Opcion_i=2)

Datos de Cabecera:

No. Nombre Campo Obl Tamaño Tipo de Dato Especificaciones


Dato Obligatorio para Facturas
1 Número Factura X Real
Confirmadas
2 Código Cliente X 8 Alfanumérico Campo Relacionado
3 Fecha Emisión Factura Date Formato: dd/mm/aa
4 Fecha Vencimiento Factura Date Formato: dd/mm/aa
5 Identificación 15 Alfanumérico Identificación Fiscal
6 Nombre Sub-Cliente 30 Alfanumérico Campo Relacionado
7 Código Vendedor 5 Alfanumérico Campo Relacionado
8 Código Moneda 2 Alfanumérico Campo Relacionado
9 Valor de la Cotización Real Si es diferente a la del Sistema
10 Número de Pagos Factura Entero Por defecto 1
11 Código de la Bodega 3 Alfanumérico Campo Relacionado
12 Descuento de la Factura Real
13 Código del Sucursal 3 Alfanumérico
Registro el Código de la Caja, si el
14 Código de la Caja 3 Alfanumérico
manejo es por Sucursal registre 999.
15 Vendedor comisiona Booleano
16 Teléfono Sub-Cliente 10 Alfanumérico
17 Dirección del Sub-Cliente 30 Alfanumérico
18 Identificación del Sub-Cliente 15 Alfanumérico
19 Código del Sub-Cliente Entero
20 Documento del Sub-Cliente 15 Alfanumérico Identificación Fiscal
21 Referencias del Sub-Cliente 20 Alfanumérico
Código de la Sucursal Origen de la
22 Origen (Código del Sucursal) X 3 Alfanumérico
Factura, igual campo 13
Al enviar el campo vacío el sistema lo
23 Tipo de Documento X 5 Alfanumérico
interpretará como documento Factura

MBA3 - ERP 97 Departamento de Desarrollo


Manual de API’s Versión: 3.30

No. Nombre Campo Obl Tamaño Tipo de Dato Especificaciones


Códigos separados y terminados en (;)
en el siguiente orden: Departamento;
24 Multidimensión 15 Alfanumérico Centro de Costo; Proyecto;
Subproyecto; Análisis 1; Análisis 2;
Análisis 3; Memo Proyecto;
25 Pago en Venta Booleano
26 Memo Factura Texto
Imprimir Campo Memo en
27 Booleano
Factura
28 Número de Aprobación Alfanumérico Emitido por el Ente Controlador (SRI)
29 Fecha Caducidad Date Emitido por el Ente Controlador (SRI)

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.

MBA3 - ERP 98 Departamento de Desarrollo


Manual de API’s Versión: 3.30

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

MBA3 - ERP 99 Departamento de Desarrollo


Manual de API’s Versión: 3.30

No. Nombre Campo Obl Tamaño Tipo de Dato Especificaciones

32 Código del Impuesto 2 Alfanumérico Campo Relacionado


33 Porcentaje del Impuesto 2 Real
34 Código del Impuesto 3 Alfanumérico Campo Relacionado
35 Porcentaje del Impuesto 3 Real
36 Código del Impuesto 4 Alfanumérico Campo Relacionado
37 Porcentaje del Impuesto 4 Real
38 Código del Impuesto 5 Alfanumérico Campo Relacionado
39 Porcentaje del Impuesto 5 Real
Separados con (;)
Lote;Cantidad;
40 Lote y Ubicación Texto
Ubicación1;Cantidad1;
Ubicación2;Cantidad2
Total Neto de la Línea de
41 Rea
Detalle
42 Complemento 1 Real Cantidad de Comercio Exterior 1.1
43 Complemento 2 Adicional Complemento 2
44 Complemento 3 Adicional Complemento 3

45 Addenda 1 Adicional Addenda 1

46 Addenda 2 Adicional Addenda 2


47 Addenda 3 Adicional Addenda 3

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

Dato Obligatorio para Facturas


1 Número de la Factura X Real
Confirmadas
2 Fecha de Pago de la Cuota Fecha Formato: DD/MM/AAAA
3 Valor de la Cuota Real
4 Número de Días de Pago En el caso de ser a Crédito
5 Porcentaje En el caso de ser a Crédito

MBA3 - ERP 100 Departamento de Desarrollo


Manual de API’s Versión: 3.30

Datos de Información Adicional (ABC):

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

MBA3 - ERP 101 Departamento de Desarrollo


Manual de API’s Versión: 3.30

(*) 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.

MBA3 - ERP 102 Departamento de Desarrollo


Manual de API’s Versión: 3.30

DATOS FISCALES – La Definición se basa en la dada en el Sistema. País: ECUADOR.

No Nombre de Campo Obl Tipo de Dato Tamaño Definición en Fiscal / Especificaciones

1 Lista Datos 1 Texto 5 Distrito Aduanero


2 Lista Datos 2 Texto 5 Régimen
3 Lista Datos 3 Texto 5 Tipo de Documento
4 Lista Datos 4 Texto 5 Términos de la Factura
5 Lista Datos 5 Texto 5 País Adquisición
6 Lista Datos 6 Texto 5 País Origen
7 Lista Datos 7 Texto 5 Forma de Pago
8 Lista Datos 8 Texto 5 Tipo de Exportación (Refrendo)
9 Alfanumérico 1 Alfanumérico 80 Año
10 Alfanumérico 2 Alfanumérico 80 Correlativo
11 Alfanumérico 3 Alfanumérico 80 Verificador
12 Alfanumérico 4 Alfanumérico 80 Documento Transporte
13 Alfanumérico 5 Alfanumérico 80 Lugar de Inicio
14 Valor 1 Real
15 Valor 2 Real
16 Valor 3 Real
17 Valor 4 Real
18 Valor 5 Real
19 Fecha 1 Fecha dd/mm/aa Fecha Embarque
20 Fecha 2 Fecha dd/mm/aa
21 Fecha 3 Fecha dd/mm/aa
22 Fecha 4 Fecha dd/mm/aa
23 Fecha 5 Fecha dd/mm/aa
24 Booleano 1 Booleano Si=1/No=0 Factura de Exportación: SI=1 / NO=0
25 Booleano 2 Booleano Si=1/No=0 Refrendo: SI=1 / NO=0
26 Booleano 3 Booleano Si=1/No=0 No Reportable: SI=1 / NO=0
27 Booleano 4 Booleano Si=1/No=0 Exportación a Paraíso Fiscal: SI=1 / NO=0
28 Booleano 5 Booleano Si=1/No=0 El Ingreso del Exterior Gravado con IR: SI=1 / NO=0
29 Booleano 6 Booleano Si=1/No=0
30 Booleano 7 Booleano Si=1/No=0
Denominación del Régimen Fiscal Preferente o
31 Texto 1
Jurisdicción de Menor Imposición
32 Texto 2 Puerto Embarque
33 Texto 3 Puerto Destino

Los Campos sin Especificaciones NO son usados, pero se debe enviar su definición.

MBA3 - ERP 103 Departamento de Desarrollo


Manual de API’s Versión: 3.30

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 2: Para el caso de ingresar FACTURAS PENDIENTES A CONFIRMAR, el campo “Opcion_i”


debe estar asignado el valor UNO(1).

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 7: Toda factura NO CONFIRMADA, siempre entra en la cola de impresión.

Nota 8: En facturas NO CONFIRMADAS, no es necesario enviar la cuota de pago.

Nota 9: Para el manejo de los impuestos o grupos de impuestos:


Si el sistema detecta en el campo “Tiene iva” o “Impuesto X” (X, valor de 2 a 5) tienen valor
“VACIO”, el sistema tomará la parametrización establecida en el Producto de Software.
Si el sistema detecta en los campos “Tiene iva” o “Impuesto X” (X, valor de 2 a 5) 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.
Si el sistema detecta en los campos “Tiene iva” o “Impuesto X” (X, valor de 2 a 5) tienen valor
“0”, el sistema no aplicará el impuesto a este producto.

Nota 10: La jerarquía para aplicar impuestos es la siguiente:


Si en la ficha del producto en el grupo de impuesto se asigna un tipo de impuesto y es diferente
a “General”, se aplicará este impuesto.
Si en la ficha de producto el tipo de impuesto es “General”, el sistema verificará si tiene asignado
un tipo de impuesto en la ficha del Cliente, si lo tiene, se procederá aplicar este impuesto; caso
contrario el sistema verificará si tiene asignado un grupo de impuesto en la sucursal de ser esto
verdadero aplicará este impuesto, caso contrario aplicará el impuesto asignado a nivel de
empresa.

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.

MBA3 - ERP 104 Departamento de Desarrollo


Manual de API’s Versión: 3.30

Nota 12: Los datos fiscales se almacenan en el Campo: TEXTO6_X, si no se usa dejar en
BLANCO.

MBA3 - ERP 105 Departamento de Desarrollo


Manual de API’s Versión: 3.30

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(‘27’,’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)

EJEMPLO Web Services:

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

MBA3 - ERP 106 Departamento de Desarrollo


Manual de API’s Versión: 3.30

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

MBA3 - ERP 107 Departamento de Desarrollo


Manual de API’s Versión: 3.30

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

MBA3 - ERP 108 Departamento de Desarrollo


Manual de API’s Versión: 3.30

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

MBA3 - ERP 109 Departamento de Desarrollo


Manual de API’s Versión: 3.30

Nota 1: El código de operación para éste proceso de Entrada de Datos es “28”

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.

MBA3 - ERP 110 Departamento de Desarrollo


Manual de API’s Versión: 3.30

SENTENCIA SQL:

INSERT INTO SIST_API(CODE_s, CORP_s, GROUP_CATEGORY_s, INTEGER_1, TEXTO1_10,


TEXTO1_24, TEXTO2_X, TEXTO3_X, Opcion_i, INTEGER_4, NumDoc_s, Local_origen, Local_destino,
ORIGIN, IDConsulta_s)
VALUES(‘28’, ’AMERI’, ’API’, 1, ’2’, ‘192.168.181.233’, ‘TRAMA CABECERA’, ‘TRAMA DETALLE’ , 0, 0,
‘PED-100’, ‘PRI’, ‘PRI’, ‘PRI’, ‘AMERI_200’)

EJEMPLO Web Services:

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

MBA3 - ERP 111 Departamento de Desarrollo


Manual de API’s Versión: 3.30

ANEXOS

ANEXO A

CONFIGURACION DE ORIGENES DE DATOS (ODBC)

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.

Gráfico 1: Administrador de Orígenes de Datos

MBA3 - ERP 112 Departamento de Desarrollo


Manual de API’s Versión: 3.30

En este punto debe seleccionar Agregar, y aparecerá la siguiente opción:

Gráfico 2: Creación de Nuevo Orígen de Datos

Se debe seleccionar el controlador con el cual se necesita trabajar o configurar. Para nuestro
caso ODBC Driver for 4D Server.

Gráfico 3: Ingreso de Datos de Conexión y Validación

MBA3 - ERP 113 Departamento de Desarrollo


Manual de API’s Versión: 3.30

Luego de seleccionar el controlador, se presentará la pantalla de configuración; en el cual


solicitará: Data Source Name, el mismo que lo llamaremos ODBC4D8; Network Path, para
lo cual se recomienda se digite el IP del SERVER y el Puerto de CONEXIÓN (Puerto de
conexión por defecto es 19813) en el formato que presenta la pantalla;

User Name: API


Password: API

Una vez ingresada esta información, para validar estos datos compruebe con la opción Test
data source.

MBA3 - ERP 114 Departamento de Desarrollo


Manual de API’s Versión: 3.30

CONFIGURACION DE ORIGENES DE DATOS (ODBC)

Cuando es de 64 bits el ODBC se encuentra en la siguiente ruta:


Equipo / Disco C / Windows / SysWOW64 / odbcad32.exe.

El Puerto que se registra es el de SQL. Ej 19812.

MBA3 - ERP 115 Departamento de Desarrollo


Manual de API’s Versión: 3.30

ANEXO B
MONITOR DE SERVICIOS

El Producto de Software MBA3, maneja el concepto de “SERVIDOR DE SERVICIOS”; es un tipo


especial de proceso informático que se ejecuta en segundo plano en vez de ser controlado
directamente por el usuario (es un proceso no interactivo). Estos tipos de procesos se ejecutan
de forma continua (infinita) , vale decir, que funciona sin tener relación con una terminal o
consola y, consecuentemente, sin interactuar con un humano; permitiendo ejecutar varios
procesos en una estación específica a través de una conexión 4D Client, que se encuentra
escuchando los diferentes requerimientos de otras estaciones en la RED Empresarial.

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:

Gráfico 4: Archivo ServidorServicios.txt

MBA3 - ERP 116 Departamento de Desarrollo


Manual de API’s Versión: 3.30

Gráfico 5: Monitor de Servicios activado Servicio de API’s

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.

MBA3 - ERP 117 Departamento de Desarrollo


Manual de API’s Versión: 3.30

PARAMETRIZACION SERVICIOS API’S

En Producto de Software MBA3 existen opciones para configurar y ejecutar el servicio de manejo
de API's.

Parametrización.

En Administración de MBA3: Parámetros/ Parámetros Otros/ Parámetros – Servicios;


presenta un formulario en el cual se parametriza todos los servicios que se ejecutan en el
producto de Software MBA3 en el TAB de API’s.

Gráfico 6: Parametrización del Servicio de API’s

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.

MBA3 - ERP 118 Departamento de Desarrollo


Manual de API’s Versión: 3.30

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.

Gráfico 7: Log de API’s

MBA3 - ERP 119 Departamento de Desarrollo


Manual de API’s Versión: 3.30

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.

6.- Procesar: Permite ejecutar la operación definida en el registro seleccionado.

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

MBA3 - ERP 120 Departamento de Desarrollo


Manual de API’s Versión: 3.30

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.

MBA3 - ERP 121 Departamento de Desarrollo


Manual de API’s Versión: 3.30

ANEXO D
CONEXIÓN VISUAL BASIC

Como ejemplo de conexión, utilizaremos la herramienta Visual Basic y nos conectaremos a


la Estructura de 4D vía ODBC (En el Anexo E hay ejemplo con Web Services) e insertaremos
un registro a la tabla “SIST_API” la operación “Creación de Clientes”.

ODBC: MBA3
Usuario: API
Password: API

Comandos de conexión en VB:

Dim conec As adodb.Connection


Dim rst As adodb.Recordset

Set conec = New adodb.Connection


conec.Open ("Provider=MSDASQL;DSN=MBA3;UID=RUN")
Set rst = New adodb.Recordset

Método de insersión:

Private Sub Command1_Click()


On Error GoTo fincmd1

Dim sql As String


sql = "INSERT INTO SIST_API(CODE_s, CORP_s, GROUP_CATEGORY_s, INTEGER_1,
TEXTO1_10, TEXTO1_24, TEXTO2_X, NumDoc_s, Local_origen, Local_destino, ORIGIN,
IDConsulta_s)
VALUES(‘05’,’AMERI’,’API’,1,’2’,‘192.168.181.233’,’AMERI|API-200|Cliente
Demo|0501764884001|Av. Brasil y Av.
America|59322460555|59322460666|59322460777|clientedemo
@ameri.com|JULIO|1|API|200|JULIO|US|Direccion 2|Direccion
3|Casilla|0|0|0|Memo|19/10/07|Pruebas de Cliente
DEMO|PRI|MEX|CHIS|112||CZONE|PRICE|WHDIS|L|1103001000|1|6|||0;0;0;0;0;||0|0|6|0|0|0
|Exterior|Interior|Colonia|Localidad||’, ‘API-200’, ‘ARA’, ‘PRI’, ‘ARA’, ‘AMERI_ API-200’)"
Set rst = conec.Execute(sql)

Exit Sub
fincmd1:
Resume Next
End Sub

MBA3 - ERP 122 Departamento de Desarrollo


Manual de API’s Versión: 3.30

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:

Dim FechaHoy_d As Date

Dim HoraHoy_t As Date

Dim LongInt_l As Long

FechaHoy_d = Date ‘Fecha actual del sistema, puede utilizarse el paso de

‘parámetros a través de una función.

HoraHoy_t = Time ‘Hora actual del sistema, puede utilizarse el paso de

‘parámetros a través de una función.

LongInt_l = (FechaHoy_d - #3/23/2002#) * 86400

LongInt_l = LongInt_l + (Hour(HoraHoy_t) * 3600)

LongInt_l = LongInt_l + (Minute(HoraHoy_t) * 60)

LongInt_l = LongInt_l + Second(HoraHoy_t)

Donde LongInt_l, es el resultado final, Fecha y Hora en formato ENTERO LARGO.

MBA3 - ERP 123 Departamento de Desarrollo


Manual de API’s Versión: 3.30

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.

• Si se usa Web Services no es necesario ejecutar el anexo A de configuración ODBC.

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:

1. Se debe configurar la IP de escucha, normalmente una IP publica y el puerto.

2. Donde dice “Iniciar Servidor Web Automáticamente” seleccionar una de las dos opciones.

MBA3 - ERP 124 Departamento de Desarrollo


Manual de API’s Versión: 3.30

CONFIGURACION DE CONTRASEÑA DE ACCESO WEB SERVICES

La contraseña de acceso del campo “pa_pass” (ver página 6) se configura por empresa en:

Parámetros del sistema / Parámetros Generales / Accesos:

Nota: la contraseña debe tener al menos 8 caracteres.

MBA3 - ERP 125 Departamento de Desarrollo


Manual de API’s Versión: 3.30

ESCRITURA / CREACION DE APIS

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: 192.168.181.56:8093 corresponde a la IP y puerto del monitor de servicios (ver


Anexo B para configuración del Monitor de Servicios)

wsAPIS/api_wr es el punto de entrada al WebServices

CORP_s=AMERI&ap_pass=12345678 corresponden al código de la empresa y el password


de esa empresa.

Los demás datos varían según el API que se está creando.

Respuesta del Web Service:


El Web Services en cualquier caso, error o éxito, retorna un json así:

• "ap_res1": “Error” o “OK” dependiendo del resultado


• "ap_res2": Detalle del error o en caso de éxito el ID del registro en SIST_API, campo
LONGINT_1.

MBA3 - ERP 126 Departamento de Desarrollo


Manual de API’s Versión: 3.30

Por ejemplo en un error:

Por ejemplo, en caso de éxito:

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”.

MBA3 - ERP 127 Departamento de Desarrollo


Manual de API’s Versión: 3.30

CONSULTA ESTADO API POR ID

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).

En cualquier caso, error o éxito, se retorna un json así:

• "ap_res1": “Error” o “OK” dependiendo del resultado


• "ap_res2": Detalle del error o en caso de éxito fecha y hora de procesamiento.

Ejemplo:

192.168.181.140:9974/wsAPIS/api_read?ap_id=502542&ap_corp=ACME&ap_pass=12345
678

MBA3 - ERP 128 Departamento de Desarrollo


Manual de API’s Versión: 3.30

CONSULTA ESTADO API POR CODIGO DE GRUPO

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

MBA3 - ERP 129 Departamento de Desarrollo


Manual de API’s Versión: 3.30

Resultado json:

MBA3 - ERP 130 Departamento de Desarrollo


Manual de API’s Versión: 3.30

ACTUALIZACION API POR CODIGO

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

MBA3 - ERP 131 Departamento de Desarrollo

También podría gustarte