Migração da criação de documentos

Detalhes de como realizar a migração da criação de documentos do empréstimo para as etapas da Esteira

Como funciona hoje

Atualmente, a configuração necessária para a criação de documentos do empréstimo, como ccb e assinatura, é feita via configurações do produto na propriedade ‘products.documents.toCreate`. Veja abaixo um exemplo de como é a configuração atual:

Pela API

{
  "settings": {
    "products": {
      "documents": {
        "toCreate": [
          {
            "methodData": {
              "template": "<template-id>"
            },
            "purpose": "ccb",
            "method": "google"
          },
          {
            "methodData": {
              "template": "<template-id>"
            },
            "purpose": "insurance",
            "method": "google"
          }
        ]
      }
    }
  }
}

De acordo com esta configuração, a criação dos documentos ocorre durante a etapa de desembolso do empréstimo. Quando o desembolso é realizado, o sistema gera um arquivo de CCB e um arquivo de assinatura.

Fluxo atual

Confira abaixo o fluxo de como ocorre a atual criação dos documentos do empréstimo:

Como irá funcionar

Ao invés de configurar a criação dos documentos no produto será necessário realizar a configuração de uma nova etapa da Esteira para criação de documentos. Esta nova etapa segue um contrato semelhante ao definido nas configurações do produto, confira o exemplo abaixo:

Pela API

{
  "settings": {
    "steps": {
      "criarDocumentos": {
        "title": "Cria documentos do empréstimo",
        "type": "create_documents",
        "methodData": {
          "documents": [
            {
              "purpose": "ccb",
              "engine": {
                "options": {
                  "template": "<template-id>"
                },
                "type": "google"
              }
            },
            {
              "purpose": "signature",
              "engine": {
                "options": {
                  "template": "<template-id>"
                },
                "type": "google"
              }
            }
          ]
        },
      },
      // ...
    }
  }
}

Com esta nova configuração, os documentos do empréstimo serão criados ao passar por esta etapa. Ou seja, os documentos poderão ser gerados a qualquer momento do fluxo de vida de um empréstimo. Anteriormente, a criação de documentos ocorria apenas na etapa de desembolso

Novo fluxo

Confira abaixo o novo fluxo de como será a criação dos documentos do empréstimo: