SettingsSteps

Configurações do modo passo a passo

title

string

Título identificador do passo.

type

enum<string>

Tipo identificador do passo.

Available options:

signature,

disburse,

document_verification,

pass,

valid_employment,

custom_request,

create_documents,

attachments_to_request,

unico

methodData

object

Objeto que contém dados específicos para o tipo de etapa. Por exemplo, se a etapa for do tipo signature, este objeto conterá os dados necessários para a assinatura do documento.

needs

string[]

Array de dependência (slugs) entre os passos necessarios para que esse seja executado.

Slug do passo (step) dependente.

slug

string

Identificador único do passo.

hooks

object

Definição de hooks da esteira.

hooks.onFailure

object[]

Lista de ações que serão executadas se um passo da esteira falhar.

hooks.onStart

object[]

Lista de ações que serão executadas ao iniciar um passo da esteira.

SettingsProducts SettingsDisbursements

{
  "title": "<string>",
  "type": "signature",
  "methodData": {
    "type": "operator",
    "role": "approver"
  },
  "needs": [
    "<string>"
  ],
  "slug": "<string>",
  "hooks": {
    "onFailure": [
      {
        "action": [
          "void_loan"
        ],
        "description": "Ação de cancelamento de empréstimo."
      }
    ],
    "onStart": [
      {
        "action": [
          "mark_loan_as_pending"
        ],
        "description": "Marcar o empréstimo como pendente."
      }
    ]
  }
}

Empréstimos

Empresas

Clientes

Fundos

Eventos

Cobrança

Arquivos

Configurações

Entidades

Automações

Modelos