diff --git a/apigee/credito-creditos.json b/apigee/credito-creditos.json index e09c771..cfcd8ce 100644 --- a/apigee/credito-creditos.json +++ b/apigee/credito-creditos.json @@ -38,7 +38,7 @@ } ], "paths": { - "/v2/credito/obligaciones/pago": { + "/v2/credito/obligaciones/pago": { "get": { "tags": [ "cols-credito-obligaciones" @@ -82,6 +82,77 @@ ] } }, + "/v2/credito/obligaciones/extracto/credito": { + "get": { + "tags": [ + "cols-credito-obligaciones" + ], + "summary": "Consulta de extracto de credito consumo.", + "description": "Consulta de extracto de credito consumo.", + "operationId": "consultaExtractoCredito.v2", + "parameters": [ + { + "name": "tipoId", + "in": "query", + "description": "Tipo de identificacion.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "numId", + "in": "query", + "description": "Numero de identificacion.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "mes", + "in": "query", + "description": "Mes que desea la consulta del extracto.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "ano", + "in": "query", + "description": "Año que desea la consulta del extracto.", + "required": true, + "schema": { + "type": "string" + } + }, + ], + "responses": { + "200": { + "description": "Operación exitosa", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/consultaExtractoCreditoResponse" + } + } + } + }, + "400": { + "description": "Estado inválido" + } + }, + "security": [ + { + "apigee_auth": [ + "write:apigee", + "read:apigee" + ] + } + ] + } + }, "/v2/credito/obligaciones/{obligacionId}": { "get": { "tags": [ @@ -248,6 +319,305 @@ }, "components": { "schemas": { + "consultaExtractoCreditoResponse": { + "type": "object", + "required": [ + "resultado" + ], + "properties": { + "resultado": { + "type": "array", + "xml": { + "name": "resultado" + }, + "items": { + "$ref": "#/components/schemas/resultado" + } + }, + "extractoCreditoConsumo": { + "type": "array", + "items": { + "$ref": "#/components/schemas/consultaExtractoCredito" + } + } + } + }, + "afiliadoConsultaExtractoCredito": { + "type": "object", + "properties": { + "nombre": { + "type": "object", + "properties":{ + "completo": { + "type": "string", + "description": "Nombre completo de afiliado." + } + } + }, + "direccion": { + "type": "object", + "properties":{ + "direccionPrincipal": { + "type": "string", + "description": "Direccion principal del afiliado." + } + } + }, + "ciudad": { + "type": "object", + "properties":{ + "nombre": { + "type": "string", + "description": "Nombre de la ciudad." + } + } + } + } + }, + "creditoConsultaExtractoCredito": { + "type": "object", + "properties": { + "tipo": { + "type": "string", + "description": "Tipo de credito." + }, + "numero": { + "type": "string", + "description": "Numero de credito." + }, + "fechaCorte": { + "type": "string", + "format": "date-time", + "description": "Fecha de corte." + }, + "saldoActual": { + "type": "string", + "description": "Saldo actual." + }, + "tarifaActual": { + "type": "string", + "description": "Tarifa actual." + }, + "amortizacion": { + "type": "string", + "description": "Plan de amortizacion." + }, + "cuota": { + "type": "object", + "properties":{ + "valor": { + "type": "string", + "description": "Valor de la cuota." + }, + "atrasada": { + "type": "string", + "description": "Numero de cuotas atrasadas." + }, + "pendiente": { + "type": "string", + "description": "Numero de cuotas pendientes." + }, + "numero": { + "type": "string", + "description": "Numero de cuotas." + } + } + }, + "capital": { + "type": "object", + "properties":{ + "pagado": { + "type": "string", + "description": "Capital pagado." + }, + "balance": { + "type": "string", + "description": "Balance del capital." + } + } + }, + "interes": { + "type": "object", + "properties":{ + "tasa": { + "type": "string", + "description": "Tasa de interes." + }, + "mora": { + "$ref": "#/components/schemas/moraConsultaExtractoCredito" + } + } + }, + "pago": { + "$ref": "#/components/schemas/pagoConsultaExtractoCredito" + } + } + }, + "pagoConsultaExtractoCredito": { + "type": "object", + "properties": { + "previo": { + "$ref": "#/components/schemas/previoConsultaExtractoCredito" + }, + "actual": { + "$ref": "#/components/schemas/actualConsultaExtractoCredito" + } + } + }, + "actualConsultaExtractoCredito": { + "type": "object", + "properties": { + "fecha": { + "type": "string", + "format": "date-time", + "description": "Fecha del pago actual." + }, + "seguro": { + "type": "string", + "description": "Pago del seguro." + }, + "saldoAnterior": { + "type": "string", + "description": "Saldo anterior." + }, + "comisionIva": { + "type": "string", + "description": "Comision Iva." + }, + "capital": { + "type": "object", + "properties":{ + "abono": { + "type": "string", + "description": "Abono a capital." + } + } + }, + "interes": { + "type": "object", + "properties":{ + "corriente": { + "type": "string", + "description": "Interes corriente pagado." + }, + "mora": { + "$ref": "#/components/schemas/moraConsultaExtractoCredito" + } + } + }, + "gastos": { + "type": "object", + "properties":{ + "administrativos": { + "type": "string", + "description": "Gastos administrativos." + }, + "procedimiento": { + "type": "string", + "description": "Gastos por procedimiento." + }, + "otros": { + "type": "string", + "description": "Otros gastos." + } + } + }, + "minimo": { + "type": "object", + "properties":{ + "valor": { + "type": "string", + "description": "Valor del pago minimo." + } + } + } + } + }, + "previoConsultaExtractoCredito": { + "type": "object", + "properties": { + "fecha": { + "type": "string", + "format": "date-time", + "description": "Fecha del pago previo." + }, + "seguro": { + "type": "string", + "description": "Pago del seguro." + }, + "comisionIva": { + "type": "string", + "description": "Comision Iva." + }, + "capital": { + "type": "object", + "properties":{ + "abono": { + "type": "string", + "description": "Abono a capital." + } + } + }, + "interes": { + "type": "object", + "properties":{ + "corriente": { + "type": "string", + "description": "Interes corriente pagado." + }, + "mora": { + "$ref": "#/components/schemas/moraConsultaExtractoCredito" + } + } + }, + "gastos": { + "type": "object", + "properties":{ + "administrativos": { + "type": "string", + "description": "Gastos administrativos." + }, + "procedimiento": { + "type": "string", + "description": "Gastos por procedimiento." + }, + "otros": { + "type": "string", + "description": "Otros gastos." + } + } + }, + "total": { + "type": "object", + "properties":{ + "valor": { + "type": "string", + "description": "Valor del pago total." + } + } + } + } + }, + "moraConsultaExtractoCredito": { + "type": "object", + "properties": { + "valor": { + "type": "string", + "description": "Valor del interes en mora." + }, + } + }, + "consultaExtractoCredito": { + "type": "object", + "properties": { + "afiliado": { + "$ref": "#/components/schemas/afiliadoConsultaExtractoCredito" + }, + "credito": { + "$ref": "#/components/schemas/creditoConsultaExtractoCredito" + } + } + }, "consultaPagoCreditoResponse": { "type": "object", "required": [