Criação de documentos

Durante o ciclo de vida de um empréstimo, a geração de documentos é um requisito legal obrigatório.

Esses documentos incluem a Cédula de Crédito Bancário (CCB), a assinatura de contrato do empréstimo e o documento do seguro (que geralmente é opcional).

Para gerar esses documentos, é necessário configurar a etapa da Esteira tipo criação de documentos. Essa configuração permite a geração dos documentos do empréstimo quando passar por essa etapa, ou seja, eles podem ser gerados em qualquer momento durante o ciclo de vida do empréstimo.

A seguir, explicaremos como funciona a etapa de criação de documentos e como configurá-la.

Fluxo da etapa tipo criação de documentos

Parâmetros de configuração

• Documentos - Uma lista de documentos a serem criados: CCB, Assinatura e Seguro.

Parâmetros dos documentos

• Propósito do documento - O propósito do documento a ser criado;

• Configurações da engine

  • Tipo da engine - Template engine usado para gerar documentos.

  :::noteAtualmente suportamos apenas o Google Docs.:::

  • Opções da engine
    • Template - ID do template a ser usado para gerar o documento.

Exemplos de configuração

Confira os exemplos abaixo de como configurar a etapa de criação de documentos via Backoffice e via API.

Configuração para criar documento CCB

Pelo Backoffice

Em Backoffice > Configurações > Esteiras é possível configurar todos os diferentes tipos de etapa da Esteira.

Primeiramente, você deve especificar a ordem hierárquica para qual está configurando a etapa de criação de documento.

Selecione uma das opções:

• Empresa
• Produto
• Global

Para saber mais sobre ordem hierárquica, consulte a documentação: Hierarquia e exceções

1. Selecione o tipo de etapa da Esteira "Criação de documento":

2. A configuração da criação do documento CCB deve ficar da seguinte forma:

• Nome da etapa: Dê um nome para etapa, por exemplo, CCB
• URL do documento Google: Inserir o link do documento to Google Docs

3. Dependências: Selecione as etapas que gostaria que esta etapa de criação de documentos tenha dependência.

4. Ações: Defina se gostaria que algum tipo de ação seja realizado na etapa. Opções disponíveis: Ao iniciar a etapa ou Se a etapa falhar.

5. Salvar e Publicar

Pela API

Para a criação de uma CCB, configure a etapa da seguinte forma:

curl --request POST \
    --url https://api.base39.io/v1/products/<id> \
    --header 'authorization: Basic <sua-api-key>' \
    --data '
    {
        "settings": {
            "steps": {
                "criarDocumentos": {
                    "title": "Cria documentos do empréstimo",
                    "type": "create_documents",
                    "methodData": {
                        "documents": [
                            {
                                "purpose": "ccb",
                                "engine": {
                                    "options": {
                                        "template": "<template-id>"
                                    },
                                    "type": "google"
                                }
                            }
                        ]
                    },
                },
                // ...
            }
        }
    }
    '

Configuração para criar documento de Assinatura

Pelo Backoffice

Em Backoffice > Configurações > Esteiras é possível configurar todos os diferentes tipos de etapa da Esteira.

Primeiramente, você deve especificar a ordem hierárquica para qual está configurando a etapa de criação de documento.

Selecione uma das opções:

• Empresa
• Produto
• Global

Para saber mais sobre ordem hierárquica, consulte a documentação: Hierarquia e exceções

1. Selecione o tipo de etapa da Esteira "Criação de documento":

2. A configuração da criação do documento Assinatura deve ficar da seguinte forma:

• Nome da etapa: Dê um nome para etapa, por exemplo, Assinatura
• URL do documento Google: Inserir o link do documento to Google Docs

3. Dependências: Selecione as etapas que gostaria que esta etapa de criação de documentos tenha dependência.

4. Ações: Defina se gostaria que algum tipo de ação seja realizado na etapa. Opções disponíveis: Ao iniciar a etapa ou Se a etapa falhar.

5. Salvar e Publicar

Pela API

Para a criação de uma CCB e Assinatura, configure o passo da seguinte forma:

curl --request POST \
    --url https://api.base39.io/v1/products/<id> \
    --header 'authorization: Basic <sua-api-key>' \
    --data '
    {
        "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"
                                }
                            }
                        ]
                    },
                },
                // ...
            }
        }
    }
    '