Objetos principais
Este tópico descreve os primeiros passos com a Paketa e os principais objetos que são configurados durante o processo de integração. Muitas requisições abordam e interagem com esses objetos principais.
Estrutura básica de componentes
A Paketa possui uma hierarquia de objetos. A tabela a seguir descreve a hierarquia de objetos internos da plataforma e seus relacionamentos básicos.
| Objeto | Descrição |
|---|---|
operator | Define o usuário que acessa o Backoffice e Portal Empresa. Normalmente esse usuário possui um email corporativo. Caso esse operador não faça mais parte da empresa, o acesso é completamente removido. |
customer | Define o usuário que acessar o Portal Empresa e solicita empréstimos. Normalmente esse usuário possui um email pessoal e continua com acesso mesmo após um desligamento. |
employment | Define o vínculo empregatício. Vincula um CPF a uma empresa e também armazena o status, salário bruto, salário líquido e data de admissão do funcionário. Esse objeto é imutável e, normalmente, possui validade de 30 dias. |
company | Define os dados da empresa ou convênio. |
offer | Define os valores de uma oferta/simulação. Contem apenas informações de taxas, valores e quantidade de parcelas. Esse objeto sempre é usado dentro de um empréstimo (loan). |
product | Define um produto de crédito, como Empréstimo Consignado ou Antecipação de Salário. Cada produto possui uma configuração específica de elegibilidade e oferta. |
loan | Esse objeto define uma solicitação/contrato. É responsável por gerenciar o status e vincular todos os outros objetos envolvidos na solicitação/contrato, como customer, employment e offer |
installment | Define individualmente uma parcela. Cada loan possui várias installments. Esse objeto também é imutável. Se for necessário alguma mudança nas parcelas após o desembolso, será necessário criar um novo item e anular o anterior. |
invoice | Define uma fatura. Uma fatura possui vários itens. Cada item de fatura possui um installment e um valor que pode ou não ser o total da installment. É necessário uma fatura fechada para enviar um link de pagamento e gerar o boleto de pagamento. |
tenant | Tenant ou Org define a separação da sua conta com a de outros clientes da Paketa. |