udistrital / Cumplidos_y_certificaciones_documentacion

0 stars 0 forks source link

Propuesta de controladores para revision_cumplidos_proveedores_mid #83

Closed JuanCamiloMartinezLopez closed 1 month ago

JuanCamiloMartinezLopez commented 1 month ago

Se requiere realizar la propuesta de controladores y endpoints para el mid de revisión de cumplidos proveedores, teniendo en cuenta los procesos, roles, datos de entrada y datos de salida, etc.

Sub Tareas

Criterios de aceptación

Requerimientos

No aplica

Definition of Ready - DoR

Definition of Done - DoD - Desarrollo

faidercamilo26 commented 1 month ago

Se realiza una primera versión de la propuesta que se tiene para los controladores y se adjunta en la carpeta del proyecto para su revisión y los correspondientes comentarios, en caso de ser necesarios.

Propuesta Controladores Cumplidos Proveedores

faidercamilo26 commented 1 month ago

:triangular_flag_on_post: Propuesta Controladores Cumplidos Proveedores :triangular_flag_on_post:

Se agrega el controlador de listar los documentos que se pueden subir en el cumplido y se adjunta la propuesta a la issue para que quede en la traza de la issue.

Número Carpeta Controlador Entrada Salida Metodo HTTP Endpoint Descripción Notas
1 controladores_supervisor ContratosSupervisorController documento_supervisor {
    "dependencias_supervisor":,
    "contratos": [
        {
            "tipo_contrato",
            "numero_contrato",
            "vigencia",
            "rp",
            "vigencia_rp",
            "nombre_proovedor",
            "dependencia",
            "cdp",
            "crp"
        },
    ]
}
GET /supervisor/contratos-proveedor/{documento-supervisor} Controlador que recibe el número de documento de un supervisor y retorna las dependencias a las que esta vinculado y la informacion de los contratos de los proveedores que tiene asociados.
2 controladores_supervisor SolicitudContratoController numero_contrato
{
    "id",
    "numero_contrato",
    "fecha_creacion",
    "periodo_pago",
    "estado_solicitud",
}
GET /supervisor/solicitudes-contrato/{numero_contrato} Controlador encargado de retornar el listado de solicitudes de pago de un proveedor, se buscan estas solicitudes con el número de contrato del proveedor.
3 controladores_supervisor InformeSeguimientoController numero_contrato
{
        "total_contrato",
        "saldo"
    }
GET /supervisor/balance-financiero-contrato/{numero_contrato} Controlador que se encarga de retornar el total y el saldo de un contrato.
4 controladores_supervisor
{
    "tipo_pago",
    "periodo_inicio",
    "periodo_fin",
    "tipo_soporte_pagar",
    "numero_cuenta_factura",
    "valor_pagar",
    "tipo_cuenta",
    "numero_cuenta",
    "banco"
}
{
    "status":,
    "message",
    "data",
    "succes"
}
POST /supervisor/informe-seguimiento Controlador encargado de recibir todos los datos necesarios que el supervisor debe ingresar en el formulario para con estos, generar el informe de seguimiento del proveedor
5 controladores_supervisor ListarTipoDocumentosCumplidoController {
    "status":,
    "message",
    "data": documentos [
       
    ],
    "succes"
}
GET /supervisor/listar-tipo-documentos Controlador encargado de listar el tipo de documentos que se pueden subir en la solicitud de pago.
6 controladores_contratacion RevisionCumplidoContratacionController {
    "contratos": [
        {
            "tipo_contrato",
            "numero_contrato",
            "vigencia",
            "rp",
            "vigencia_rp",
            "nombre_proovedor",
            "dependencia",
            "cdp",
            "crp"
        },
    ]
}
GET /contratacion/solicitudes-pago/ Controlador encargado de retornar la informacion de las solicitudes a cargo de una persona de contratacion para realizar la aprobación o rechazo de las solicitudes de pago.
7 controladores_ordenador RevisionCumplidoOrdenadorController documento_persona_ordenador
{
    "contratos": [
        {
            "tipo_contrato",
            "numero_contrato",
            "vigencia",
            "rp",
            "vigencia_rp",
            "nombre_proovedor",
            "dependencia",
            "cdp",
            "crp"
        },
    ]
}
GET /ordenador/solicitudes-pago/{documento_persona_ordenador} Controlador encargado de retornar la informacion de los contratos a cargo de un ordenador para realizar la aprobación o rechazo de las solicitudes de pago.
8 controladores_ordenador RevisionCumplidoOrdenadorController solicitud_pago_id
{
    "Message",
    "succes",
    "status",
    "estados_pago": [
        {
           
        }
    ]
}
POST /ordenador/revertir-solicitud-pago/{id_solicitud_pago} Controlador encargado de revertir el estado de un cumplido aprobado por parte de un ordenador, en caso, de que lo considere necesario.
9 controladores_ordenador RevisionCumplidoOrdenadorController solicitud_pago_id {
    "status":,
    "message",
    "data": certificado aprobacion pago firmado,
    "succes"
}
POST /ordenador/certificado-aprobacion-pago Conrolador encargado de retornar el certificado firmado de aprobacion pago.
10 controladores_soporte SoportesCumplidoController {
    "solicitud_pago_id"
    "item",
    "observaciones",
    "nombre_archivo",
    "archivo"
}
{
    "status":,
    "message",
    "data",
    "succes"
}
POST /solicitud-pago/soportes Controlador que se encarga de la subida de un soporte a una solicitud de pago. Falta decidir si se sube el documento en el mid o en el cliente
11 controladores_soporte SoportesCumplidoController solicitud_pago_id [
  {
    "Archivo": {
      "file": "string"
    },
    "Documento": {
      "Activo": true,
      "Descripcion": "string",
      "Enlace": "string",
      "FechaCreacion": "string",
      "FechaModificacion": "string",
      "Id": 0,
      "Metadatos": "string",
      "Nombre": "string",
      "TipoDocumento": {
        "Activo": true,
        "CodigoAbreviacion": "string",
        "Descripcion": "string",
        "DominioTipoDocumento": {
          "Activo": true,
          "CodigoAbreviacion": "string",
          "Descripcion": "string",
          "FechaCreacion": "string",
          "FechaModificacion": "string",
          "Id": 0,
          "Nombre": "string",
          "NumeroOrden": 0
        },
        "Extension": "string",
        "FechaCreacion": "string",
        "FechaModificacion": "string",
        "Id": 0,
        "Nombre": "string",
        "NumeroOrden": 0,
        "Tamano": 0,
        "TipoDocumentoNuxeo": "string",
        "Workspace": "string"
      }
    }
  }
]
GET /solicitud-pago/soportes/{id_solicitud_pago} Controlador que se encarga de retornar el Json con los soportes subidos en una solicitud de pago.
12 controladores_soporte SoportesCumplidoController id_soporte {
    "status":,
    "message",
    "data",
    "succes"
}
DELETE /solicitud-pago/soportes/{id_soporte} Controlador encargado de eliminar un soporte de una solicitud de pago.
13 controladores_soporte SoportesCumplidoController {
    "soporte_id",
    "cambio_estado_id"
    "comentario"
}
{
    "status":,
    "message",
    "data",
    "succes"
}
POST /soporte/comentario Controlador encargado de adjuntar un comentario a un soporte de pago.
14 controladores_soporte SoportesCumplidoController id_solicitud_pago
{
    "Message",
    "succes",
    "status",
    "data": {
        "nombre":,
        "file":
    }
}
GET /solicitud-pago/soportes-comprimido/{id_solicitud_pago} Controlador encargado de descargar un comprimido con todos los soportes asociados a una solicitud de pago
15 controladores_estados_pago EstadoSoporteController
{
    "cumplido_proveedor_id",
    "solicitud_pago_id",
    "responsable_id",
    "cargo_responsable",
    "estado_cumplido_id"
}
{
    "status":,
    "message",
    "data",
    "succes"
}
POST /solicitud-pago/cambio-estado Controlador encargado de cambiar el estado de una solicitud de pago, el estado puede ser aprobado o rechazado.

:triangular_flag_on_post: Propuesta Helpers Generales Cumplidos Proveedores :triangular_flag_on_post:

Número Helper Entradas Salidas Descripción
1 InformacionContratos() numero_contrato
• tipo_contrato
• numero_contrato
• vigencia
• rp
• vigencia_rp
• nombre_proovedor
• dependencia
• cdp
• crp
Helper que retorna la informacion completa de un contrato.
2 CambioEstadoSolicitudPago() • estado_solicitud_pago
• solicitud_pago_id
• responsable_id
• cargo_responsable
• estado_solicitud_pago
• cumplido_proveedor_id
• responsable_id
• cargo_responsable
Helper que retorna un cambio de estado en una solicitud de pago.
3 ConsultarGestorDocumental() id_solicitud_pago • Listado de documentos encriptados. Helper que retorna todos los soportes vinculados a una solicitud de pago.
4 AgregarObservacionSoporte() • id_soporte
• comentario
• Informacion soporte con el comentario asinado. Helper  que asocia un comentario a un soporte subido en el cumplido
5 OpcionTipoDocumentoCumplido() • Listado de opciones de archivos para subir en un cumplido. Helper que retorna un listado de los posibles documentos que se pueden subir en un cumplido.
JuanCamiloMartinezLopez commented 1 month ago

@faidercamilo26 Buen trabajo