From 1ff34ead548150150c8206fcc9104fd267d421b4 Mon Sep 17 00:00:00 2001 From: Cristian_Camargo Date: Fri, 7 Jun 2019 19:14:53 +0000 Subject: [PATCH] Update recreacionyturismo-venta.json --- apigee/recreacionyturismo-venta.json | 348 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++------------------ 1 file changed, 330 insertions(+), 18 deletions(-) diff --git a/apigee/recreacionyturismo-venta.json b/apigee/recreacionyturismo-venta.json index 37fe3fd..0174dc3 100644 --- a/apigee/recreacionyturismo-venta.json +++ b/apigee/recreacionyturismo-venta.json @@ -262,6 +262,22 @@ "name": "resultado" } }, + "resultadoCotizacion": { + "type": "object", + "properties": { + "codigo": { + "type": "string", + "description": "Estado de la cotización. Posibles Valores\n - 1) PAGO PENDIENTE > No ha sido pagada *nueva*\n - 2) PAGO REALIZADO > Ya ha sido pagada *facturada*\n - 3) RECHAZADA > El pago no ha sido exitoso *cancelada*\n - 4) CHECKOUT > En espera del medio de pago *en proceso de pago*" + }, + "descripcion": { + "type": "string", + "description": "Mensaje de la cotización" + } + }, + "xml": { + "name": "resultado" + } + }, "consultaCotizacionIdResponse": { "type": "object", "required": [ @@ -274,7 +290,7 @@ "name": "resultado" }, "items": { - "$ref": "#/components/schemas/resultado" + "$ref": "#/components/schemas/resultadoCotizacion" } }, "obtenerCotizacion": { @@ -298,54 +314,123 @@ "$ref": "#/components/schemas/transaccion" }, "logs": { - "$ref": "#/components/schemas/logs" + "type": "array", + "items":{ + "$ref": "#/components/schemas/logs" + } + } + } + }, + "logs": { + "type": "object", + "description": "Cambio realizado en la cotización en un instante de tiempo", + "properties": { + "tipo": { + "type": "string", + "description": "Tipo de modificación que se realiza Tipo:\n * 1) CREACION\n * 2) ACTUALIZACION\n * 3) INFORMATIVO\n * 4) PRUEBAS" + }, + "descripcion": { + "type": "string", + "description": "Descripción del log" + } + } + }, + "transaccion": { + "type": "object", + "description": "Propiedades de la transacción de pago de una cotización", + "properties": { + "id": { + "type": "string", + "description": "El id de la transacción enviado por el sistema de pago." + }, + "fecha": { + "type": "string", + "description": "Fecha en la que se completó la transacción de pago" + }, + "canal": { + "type": "string", + "description": "Identificador del canal de pago - 1) Caja - 2) Módulos - 3) Web - 4) App - 5) IVR - 6) Interno", + "enum": [ + 1, + 2, + 3, + 4, + 5, + 6 + ] + }, + "idCaja": { + "type": "string", + "description": "Identificador de la máquina que hizo el pago (Módulo, Caja). En caso de transacción en línea se usará algún identificador del proveedor de pago." + }, + "idCajero": { + "type": "string", + "description": "Identificador del cajero quien realiza la cotización en el sistema Hércules (Normalmente la cédula o código de máquina)" + }, + "pago": { + "type": "object", + "properties":{ + "id": { + "type": "string", + "description": "Consecutivo generado por el medio de pago" + }, + "medio": { + "type": "string", + "description": "Código del medio de pago" + }, + "valor": { + "type": "string", + "description": "Valor pagado con este medio de pago" + } + } } } }, "cotizacion": { "type": "object", + "description": "Información de una cotización. Las cotizaciones se componen de Ítems de Cotización que indican los servicios a adquirir. Los Ítems tiene diferntes tipos dependiendo del servicio que se adquirió. Además las Cotizaciones tienen un log de auditoría y una Transacción de pago asociada que incluye la forma de pago detallada", "properties": { "id": { "type": "string", - "description": "Número de telefono del titular" + "description": "Id de la cotización en Hércules" }, "idFactura": { "type": "string", - "description": "Número de telefono del titular" + "description": "Identificador de la Cotización en el sistema facturador. ( Por ejemplo Número de Factura o de la Orden de Venta)" }, "idFacturaSecundario": { "type": "string", - "description": "Número de telefono del titular" + "description": "Identificador secundario de la Cotización en el sistema facturador. (Por ejemplo Número de Factura Empresarial)" }, "idParticipacionOrganizacion": { "type": "string", - "description": "Número de telefono del titular" + "description": "Id de la ParticipacionOrganizacion en Hércules de la cotización (uso interno)" }, "fechaCreacion": { "type": "string", - "description": "Número de telefono del titular" + "description": "Fecha de creación de la cotización" }, "fechaActualizacion": { "type": "string", - "description": "Número de telefono del titular" + "description": "Fecha de actualización de la cotización" }, "fechaExpiracion": { "type": "string", - "description": "Número de telefono del titular" + "description": "Fecha de expiración de la cotización" }, "usuario": { "type": "object", "properties": { "id": { "type": "string", - "description": "Nombre del titular que realizó la cotización" + "description": "Id del usuario en Hércules que realiza la cotización (si se hace por servicio sería el client_id)" }, "nombre": { "type": "object", "properties":{ "completo": { "type": "string", - "description": "Nombre del titular que realizó la cotización" + "description": "Nombre del usuario que reqliza la cotización" }, } } @@ -353,19 +438,233 @@ }, "empresa": { "type": "object", - "description": "Número de telefono del titular" + "properties":{ + "nombre": { + "type": "string", + "description": "Nombre de la organización o empresa" + }, + } }, "proveedor": { "type": "object", - "description": "Número de telefono del titular" + "properties":{ + "nombre": { + "type": "string", + "description": "Nombre del proveedor de pago de la cotización" + }, + } }, "costo": { "type": "object", - "description": "Número de telefono del titular" + "properties":{ + "reversion": { + "type": "string", + "description": "Suma del total de las reversiones de cada ítem" + }, + "base": { + "type": "string", + "description": "Valor de la base del IVA en la cotización" + }, + "iva": { + "type": "string", + "description": "Valor total del IVA en la cotización" + }, + "total": { + "type": "object", + "properties":{ + "valor": { + "type": "string", + "description": "Suma del total de cada ítem en la cotización. Total Pagado" + }, + } + } + } }, "articulo": { + "type": "array", + "items":{ + "$ref": "#/components/schemas/articulo" + } + } + } + }, + "articulo": { + "type": "object", + "description": "Hace referencia al servicio que se quiere inscribit, a la persona, y el valor de la inscripción al servicio ", + "properties": { + "tipo": { + "type": "string", + "description": "Tipo del ítem (INSCRIPCION = 1, MATRICULA = 2, MATERIAL = 3, AFILIACION = 4, RESERVA_TURNO = 5, CITA = 6)", + "enum": [ + 1, + 2, + 3, + 4, + 5, + 6 + ] + }, + "cantidad": { + "type": "string", + "description": "Cantidad del ítem adquirida" + }, + "descripcion": { + "type": "string", + "description": "Descripción del ítem" + }, + "centroBeneficio": { + "type": "string", + "description": "Código del centro de beneficios (Centro de Beneficios SAP)" + }, + "persona": { "type": "object", - "description": "Número de telefono del titular" + "properties":{ + "nombre": { + "type": "object", + "properties":{ + "completo": { + "type": "string", + "description": "Nombre de la persona asociada al ítem" + } + } + }, + "documento": { + "type": "object", + "properties":{ + "numero": { + "type": "string", + "description": "NNúmero de documento de la persona asociada al ítem" + } + } + }, + } + }, + "categoria": { + "type": "object", + "properties":{ + "sigla": { + "type": "string", + "description": "Nombre de la categoría de precio" + } + } + }, + "costo": { + "type": "object", + "properties": { + "nombre": { + "type": "string", + "description": "Nombre del precio aplicado." + }, + "codigo": { + "type": "string", + "description": "Código del precio según la tabla de productos enviada. Id Material en SAP" + }, + "base": { + "type": "string", + "description": "Valor base del ítem sin impuesto." + }, + "impuesto": { + "type": "string", + "description": "Valor del impuesto aplicado sobre el valor" + }, + "total": { + "type": "object", + "properties":{ + "valor": { + "type": "string", + "description": "Valor total de la suma del valor más el impuesto" + } + } + } + } + }, + "servicio": { + "type": "object", + "properties":{ + "nombre": { + "type": "string", + "description": "Nombre del titular que realizó la cotización" + }, + "costo": { + "$ref": "#/components/schemas/costoServicioCotizacion" + } + } + }, + "descuento": { + "type": "array", + "description": "Lista de descuentos aplicados al ítem", + "items":{ + "$ref": "#/components/schemas/descuento" + } + } + } + }, + "descuento": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Identificador del descuento" + }, + "tipo": { + "type": "string", + "description": "Parametro para saber el tipo del descuento.\nLos tipos son los siguientes:\n - 0) CONVENIO: Los convenios son aquellos que no tienen recobro por subsidio a la demanda.\n - 1) DESCUENTO\n - 2) MERCADEO\n\nUn ítem de cotización puede tener a lo sumo tres descuentos, uno de cada tipo entre: convenio, no convenio y mercadeo.", + "enum": [ + 0, + 1, + 2 + ], + }, + "codigo": { + "type": "string", + "description": "Código de descuento a aplicar (en caso de escritura) o aplicado (en caso de lectura), puede ser un código único o un código repetible (Cupón)" + }, + "nombre": { + "type": "string", + "description": "Nombre del descuento" + }, + "mercadeo": { + "type": "string", + "description": "Parámetro que indica que el precio fue modificado por un sistema externo con autorización para cambiar precios." + }, + "total": { + "type": "object", + "properties":{ + "valor": { + "type": "string", + "description": "Valor final con el descuento aplicado al valor del ítem consultado." + } + } + } + } + }, + "costoServicioCotizacion": { + "type": "object", + "properties": { + "base": { + "type": "string", + "description": "Valor de la base (Sin IVA) del precio" + }, + "iva": { + "type": "string", + "description": "Valor del IVA para el precio" + }, + "fechaInicioVigencia": { + "type": "string", + "description": "Fecha de inicio de la vigencia del precio" + }, + "fechaFinVigencia": { + "type": "string", + "description": "Fecha de fin de la vigencia del precio" + }, + "total": { + "type": "object", + "properties":{ + "valor": { + "type": "string", + "description": "Valor total (incluye IVA) del precio" + } + } } } }, @@ -394,7 +693,20 @@ "properties": { "tipo": { "type": "string", - "description": "Tipo de documento del titular de la cotización" + "description": "Tipo de documento del titular de la cotización", + "enum": [ + "CC", + "CE", + "NIT", + "TI", + "PAS", + "FN", + "RC", + "NUIP", + "MSI", + "CD", + "PEP" + ] }, "numero": { "type": "string", @@ -403,10 +715,10 @@ } }, "direccion": { - "type": "string", + "type": "object", "properties": { "direccionPrincipal": { - "type": "object", + "type": "string", "description": "Dirección del titular" } } -- libgit2 0.26.0