Emissão de dívida PJ

Request

ENDPOINT

/debt

MÉTODO

POST

Request Body

{
    "borrower": {
        "address": {
            "street": "Av. Brigadeiro Faria Lima",
            "state": "SP",
            "city": "São Paulo",
            "neighborhood": "Jardim Paulistano",
            "number": "2391",
            "postal_code": "01452905",
            "complement": "1º Andar"
        },
        "cnae_code": "6499-9/99",
        "company_document_number": "30620610000159",
        "company_statute": "ff26d5cb-b4e4-477f-9341-645d3e1d65de",
        "company_type": "ltda",
        "directors_election_minute": "8c33ccc4-18b5-4985-87fb-b8fbb9c56a65",
        "email": "api@qitech.com.br",
        "foundation_date": "2018-06-05",
        "name": "Qi Tech Ltda.",
        "person_type": "legal",
        "phone": {
            "country_code": "055",
            "area_code": "11",
            "number": "999999999"
        },
        "trading_name": "Qi Tech"
    },
    "financial": {
        "amount": 50000.37,
        "disbursed_amount": "50000.37",
        "interest_type": "pre_price_days",
        "credit_operation_type": "ccb",
        "annual_interest_rate": 0.02,
        "disbursement_date": "2019-07-25",
        "disbursement_start_date": "2019-07-25",
        "disbursement_end_date": "2019-07-29",
        "issue_date": "2019-07-25",
        "interest_grace_period": 2,
        "principal_grace_period": 0,
        "number_of_installments": "10",
        "fine_configuration": {
            "contract_fine_rate": 0.02,
            "interest_base": "workdays",
            "monthly_rate": 0.01
        },
        "entry": {
            "deadline": "1000.0",
            "amount": 1000,
            "entry_type": "bank_slip"
        },
        "first_due_date": "2019-07-25",
        "first_due_date_delay": 38
    },
    "simplified": True
}

Atributos de uma Emissão

A criação de uma emissão consiste em 4 objetos:

borrower: tomador da dívida (que por sua vez pode ser um, Objeto PF ou Objeto PJ)
guarantors: garantidores da operação (que pode ser uma lista de Objeto PF e/ou Objeto PJ e não é um campo obrigatório)
disbursement_bank_accounts: lista de informações bancárias para o desembolso (Objeto Conta Bancária)
financial: dados do fluxo financeiro da operação (Objeto Financeiro)

Temos dois campos que também vão na raíz do payload: purchaser_document_number é o número do CNPJ do comprador da dívida. Permite a cessão automática da dívida.

Ou seja, enviando apenas:

{
    "borrower": Dados do mutuário [Objeto borrower (PJ)] ou [Objeto borrower (PF)],
    "guarantors": Garantidores da operação (que pode ser uma lista de Objeto PF e/ou Objeto PJ e não é um campo obrigatório). [Objeto PJ e/ou Objeto PF] ou nulo ou [],
    "disbursement_bank_accounts": Lista de informações bancárias para o desembolso [Objeto Conta Bancária].,
    "financial": [Objeto Financeiro],
    "simplified": Campo booleano OBRIGATÓRIO para solicitações simplificadas. Caso falso a solicitação não será aceita.,
    "purchaser_document_number": CNPJ do comprador da dívida - é obrigatório o apenas caso a operação possua mais de um comprador cadastrado.
}

BODY PARAMS

Campo	Descrição
`borrower` *	Dados do mutuário.
`guarantors`	Garantidores da operação (que pode ser uma lista de Objeto PF e/ou Objeto PJ e não é um campo obrigatório).
`disbursement_bank_accounts` *	Dados do mutuário.
`financial` *	O objeto financeiro descreve as informações financeiras da emissão. Aqui são definidas a taxa de juros, carência e valor da dívida entre outros.
`purchaser_document_number`	CNPJ do comprador da dívida - é obrigatório o apenas caso a operação possua mais de um comprador cadastrado.
`simplified` *	Campo booleano OBRIGATÓRIO para solicitações simplificadas. Caso falso a solicitação não será aceita.

Objeto borrower (PJ)

Como mostrado acima tanto o campo "borrower" quanto os campos "guarantors" podem ser populados por Objeto PF ou Objeto PJ. Objeto PJ é o descritivo de uma pessoa jurídica na QI Tech.

Campo	Tipo	Descrição	Caracteres
`address` *	object	Objeto Endereço	-
`cnae_code` *	string	Classificação Nacional de Atividades Econômicas
`company_document_number` *	string	CNPJ (apenas números)	14
`company_representatives` *	array of objects	Lista de representante legais da empresa	Objeto company_representatives
`company_statute` *	string	`document_key` do PDF do estatuto da empresa
`company_type` *	enum	Tipo da empresa: "ltda", "sa", "micro_enterprise" ou "freelancer"
`directors_election_minute`	string	`document_key` do PDF da Ata de eleição da empresa (obrigatório apenas para emrpresas com company_type "sa")
`email` *	string	Email institucional da empresa
`foundation_date` *	date	Data de abertura da empresa (formato "AAAA-MM-DD")
`name` *	string	Razão social
`person_type` *	string	Identificador de que o objeto enviado é uma pessoa jurídica. Deve conter SEMPRE o valor "legal" para Objeto PJ
`phone` *	string	Telefone da empresa	Objeto Telefone
`trading_name` *	string	Nome fantasia

Objeto address

Este objeto, presente tanto no objeto PF quanto no objeto PJ, é um simples objeto para representar um endereço.

Campo	Descrição	Exemplo	Caracteres
`street` *	string	Rua do endereço	100
`state` *	string	Estado do endereço (com dois caracteres maiúsculos)	2
`city` *	string	Cidade do endereço	100
`neighborhood` *	string	Bairro do endereço	100
`number` *	string	Número da rua	10
`postal_code` *	string	CEP do endereço (http://www.buscacep.correios.com.br/sistemas/buscacep/) (apenas números)	8
`complement` *	string	Complemento do endereço (texto livre)	100

Objeto company_representatives

Campo	Descrição	Exemplo	Caracteres
`person_type` *	string	Identificador de que o objeto enviado é uma pessoa física ou jurídica.	11
`name` *	string	Razão social em caso de operações PJ ou Nome da pessoa em caso de operações PF. Limitado a 100 caracteres.	11
`mother_name` *	string	Nome da mãe do cliente em caso de PF. Limitado a 100 caracteres.	11
`birth_date` *	string	Data de nascimento da pessoa (formato "AAAA-MM-DD")	11
`profession` *	string	Profissão do cliente. Limitado a 64 caracteres.	11
`nationality` *	string	Nacionalidade do cliente. Limitado a 50 caracteres.	11
`marital_status` *	string	Estado civil do cliente.
`property_system` *	string	Regime de separação de bens (obrigatório apenas para pessoas com marital_status "married").	11
`wedding_certificate` *	string	DOCUMENT_KEY do PDF do certificado de casamento da pessoa (enviado previamente). No caso de marital_status ser "single", o valor deste campo deve ser NULL.	11
`spouse` *	string	Objeto PF do esposo/esposa da pessoa (obrigatório apenas quando "compulsory_separation_of_goods" for "total_communion_of_goods", "partial_communion_of_goods", "final_participation_of_acquisitions" ou "compulsory_separation_of_goods"). No caso de marital_status ser "single", o valor deste campo deve ser NULL.	11
`is_pep` *	boolean	Declaração se a pessoa é PEP (http://www.portaldatransparencia.gov.br/download-de-dados/pep).	11
`individual_document_number` *	string	CPF da pessoa (apenas números).	11
`document_identification` *	string	DOCUMENT_KEY do PDF do documento de identificação da pessoa com foto (RG ou CNH) (enviado previamente)	11
`document_identification_back`	string	DOCUMENT_KEY do PDF da parte de trás do documento de identificação da pessoa com foto (RG ou CNH) (enviado previamente).	11
`document_identification_type` *	string	Qual o tipo do documento de identificação enviado.	11
`document_identification_number` *	string	Número do documento de identificação da pessoa enviado em "document_identification". Limitado a 16 caracteres.	11
`email` *	string	Email do cliente.	10
`phone` *	object	Telefone do cliente	Objeto phone
`proof_of_residence` *	string	DOCUMENT_KEY do PDF do comprovante de endereço do endereço enviado (enviado previamente).	11
`adress`	object	Endereço do cliente.	Objeto address

Objeto phone

Este objeto, presente tanto no objeto PF quanto no objeto PJ, é um simples objeto para representar um número telefônico.

Campo	Descrição	Exemplo	Máx. Caracteres
`country_code` *	string	Código DDI do telefone (https://ddi.guiamais.com.br/)	3
`area_code` *	string	Código DDD do telefone (https://ddd.guiamais.com.br/)	2
`number` *	string	Número de telefone (apenas números)	10

Objeto guarantor

Assim como o Objeto PF, descrito acima, os campos "borrower" e "guarantors" podem ser populados tanto por Objeto PF ou Objeto PJ. Objeto PF é o descritivo de uma pessoa física na QI Tech.

Campo	Tipo	Descrição	Máx. Caracteres
`person_type` *	string	Identificador de que o objeto enviado é uma pessoa física. Deve conter SEMPRE o valor "natural" para borrower PF	-
`name` *	string	Nome da pessoa	100
`mother_name` *	string	Nome da mãe da pessoa	100
`birth_date` *	date	Data de nascimento da pessoa (formato "AAAA-MM-DD")	-
`profession` *	string	Profissão da pessoa	64
`nationality` *	string	Nacionalidade da pessoa	50
`marital_status` *	enum	Estado civil da pessoa	Enumeradores
`property_system`	enum	Regime de separação de bens (obrigatório apenas para pessoas com marital_status "married")	-
`wedding_certificate` *	string	DOCUMENT_KEY do PDF do certificado de casamento da pessoa. No caso de marital_status ser "single", o valor deste campo deve ser `null`	-
`spouse` *	enum	Objeto PF do esposo/esposa da pessoa (obrigatório apenas quando "compulsory_separation_of_goods" for "total_communion_of_goods", "partial_communion_of_goods", "final_participation_of_acquisitions" ou "compulsory_separation_of_goods"). No caso de marital_status ser "single", o valor deste campo deve ser `null`	Objeto Spouse
`is_pep` *	boolean	Declaração se a pessoa é PEP (http://www.portaldatransparencia.gov.br/download-de-dados/pep) valor booleano	-
`individual_document_number` *	string	CPF da pessoa (apenas números)	11
`document_identification` *	string	DOCUMENT_KEY do PDF do documento de identificação da pessoa com foto (RG ou CNH)	-
`document_identification_number` *	string	Número do documento de identificação da pessoa enviado em document_identification	16
`email` *	string	Email da pessoa	254
`phone` *	object	Telefone da pessoa	Objeto phone
`address` *	object	Endereço da pessoa	Objeto address
`proof_of_residence` *	string	DOCUMENT_KEY do PDF do comprovante de endereço do endereço enviado	-

Objeto disbursement_bank_accounts

Uma emissão de dívida deve conter as informações bancárias para desembolso, por padrão, uma conta do tomador. Este objeto deve ser uma lista com uma ou mais contas. O Objeto disbursement_bank_accounts (Conta Bancária) deve conter:

Campo	Tipo	Descrição	Caracteres
`bank_code` *	string	Código COMPE da instituição financeira (https://www.bcb.gov.br/pom/spb/estatistica/port/ASTR003.pdf) (com 3 dígitos)	3
`branch_number` *	string	Número da agência - Obrigatório apenas se o método de transferência for ted ou pix.	4
`account_number` *	string	Número da conta - Obrigatório apenas se o método de transferência for ted ou pix - Obrigatório apenas se o método de transferência for ted ou pix.	10
`account_digit`	string	Dígito verificador da conta (obrigatório caso haja)	1
`document_number`	string	CPF ou CNPJ do dono da conta para desembolso - Obrigatório apenas se o método de transferência for ted ou pix. e caso haja mais de uma conta para desembolso.	11 ou 14
`name`	string	Nome do dono da conta para desembolso - Obrigatório apenas se o método de transferência for ted ou pix. e caso haja mais de uma conta para desembolso (Limite de 50 caracteres).	50
`percentage_receivable`	string	Valor em porcentagem que a conta receberá no desembolso. Este campo é utilizado para definir a quantidade a ser dividida caso haja mais de uma conta para desembolso (no caso de ser somente uma conta, o valor integral será transferido). Caso a porcentagem não seja enviada (de uma, ou de todas as contas), a porcentagem restante será dividida igualmente entre as contas sem porcentagem definida. Caso todas as porcentagens sejam enviadas, a soma delas não pode passar de 100 - Obrigatório apenas se o método de transferência for ted ou pix.	-
`ispb_number`	string	Identificador da instituição no Sistema de Pagamentos Brasileiro - Obrigatório apenas se o método de transferência for ted ou pix e se o "bank_code" não for enviado.	confirmar
`qr_code_key`	string	Chave fornecida no momento da criação de um QR Code PIX - Pode ser enviado como o único parâmetro deste objeto, assim o desembolso acontece como pagamento desse QR code PIX.	confirmar
`digitable_line`	string	Representação numérica de um código de barras de um boleto - Pode ser enviado como o único parâmetro deste objeto, assim o desembolso acontece como pagamento desse boleto.	confirmar
`transfer_method`	string	Por padrão as operações são desembolsadas via PIX, então quando existir a necessidade de que uma operação seja desembolsada via TED este campo pode ser enviado.	1
`account_type`	string	Tipo da conta de desembolso do Tomador do crédito	1

Objeto financial

O objeto financial descreve as informações financeiras da emissão. Aqui são definidas a taxa de juros, carência e valor da dívida entre outros. O Objeto Financeiro possui os campos descritos abaixo, porém é importante notar que alguns campos são opicionais e excludentes (caso um esteja disponível o outro não deverá ser enviado).

Campo	Descrição	Tipo	Caracteres
`amount` (excludente de disbursed_amount)	double	Valor total da dívida emitida - Os valores de fees e rebates são descontados do valor enviado no momento do desembolso. Se enviado este campo exclui a obrigatoriedade do campo "disbursed_amount".
`disbursed_amount` (excludente de amount)	double	Valor de desembolso da dívida emitida - os valores de fees e rebates são SOMADOS Aa valor enviado no momento do desembolso. Se enviado este campo exclui a obrigatoriedade do campo "amount".
`interest_type` *	string	Tipo de juros aplicado na dívida
`credit_operation_type` *	string	Tipo de operação de crédito
`annual_interest_rate`	double	Valor porcentual da parcela prefixada de juros (atenção: 1 = 100%)
`disbursement_date` (excludente de disbursement_start_date e disbursement_end_date)	date	Data de desembolso (formato "AAAA-MM-DD")
`disbursement_start_date` (excludente de disbursement_date)	date	Data início do período de desembolso (formato "AAAA-MM-DD")
`disbursement_end_date` (excludente de disbursement_date)	date	Data final do período de desembolso (formato "AAAA-MM-DD")
`issue_date` *	date	Data de emissão da CCB (formato "AAAA-MM-DD")
`interest_grace_period` *	int32	Carência de juros (em meses)
`principal_grace_period` *	int32	Carência do principal (em meses)
`number_of_installments` *	int32	Número de parcelas (mensais)
`rebates` *	object	Lista de objetos Rebate com valores de tarifa configurada pela QI. Se nulo a configuração default do cliente será utilizada.	Objeto Rebate
`fine_configuration` *	string	Objeto que descreve a multa de uma dívida	Objeto fine_configuration
`entry` *	object	Configuração do valor de entrada (garantia) para a operação, caso exista - Se este parâmetro for enviado, o pagamento da entrada se torna um pré-requisito para o desembolso da operação.	Objeto entry
`first_due_date` (excludente de first_due_date_delay e opcional)	date	Data da primeira parcela da dívida (formato "AAAA-MM-DD")
`first_due_date_delay` (excludente de first_due_date e opcional)	int32	Dias até a primeira parcela após o desembolso da dívida.

Enumeradores

Enumerador Person Type

Enumerador	Descrição
legal	Pessoa juridica
natural	Pesso física

Enumerador Account Type

Enumerador	Descrição
checking_account	Conta corrente
deposit_account	Conta de depósito
guaranteed_account	Conta de garantia
investment_account	Conta de investimento
payment_account	Conta de pagamento
saving_account	Conta poupança
salary_account	Conta salário

Enumerador Interest Type

Enumerador	Descrição
pre_price_days	Método de amortização Price (parcelas iguais) com cálculo do juros pré-fixado ao dia
pre_price	Método de amortização Price (parcelas iguais) com cálculo do juros pré-fixado em períodos fixos (30 dias)
pre_sac	Método de amortização SAC (amortização constante) com cálculo do juros pré-fixado ao dia
post_sac	Método de amortização SAC (amortização constante) com cálculo do juros baseado em uma taxa pré-fixada + indexador pós-fixado (cdi, ipca ou igpm) ao dia
post_price	Método de amortização Price (parcelas iguais) com cálculo do juros baseado em uma taxa pré-fixada + indexador pós-fixado (cdi, ipca ou igpm) em períodos fixos (30 dias)
post_price_days	Método de amortização Price (parcelas iguais) com cálculo do juros baseado em uma taxa pré-fixada + indexador pós-fixado (cdi, ipca ou igpm) ao dia

Enumerador Credit Operation Type

Enumerador	Descrição
ccb	Cédula de Crédito Bancário
cce	Cédula de Crédito à Exportação
cci	Cédula de Crédito Imobiliário
nce	Nota de Crédito à Exportação

Enumerador Interest Base

Enumerador	Descrição
workdays	Base de cálculo de juros em dias úteis considerando um ano de 252 dias
calendar_days	Base de cálculo de juros em dias corridos considerando um ano de 360 dias
calendar_days_365	Base de cálculo de juros em dias corridos considerando um ano de 365 dias

Enumerador Fee Type

Cada tipo de fee deve ser previamente habilitado e configurado pela QI Tech

Enumerador	Descrição
tac	Tarifa de abertura de cadastro
spread	Ágio cobrado no valor de aquisição da operação de crédito
warranty_analysis	Tarifa de análise de garantias
ted_fee	Tarifa de TED
spread_ted_fee	Ágio da tarifa de TED cobrado no valor de aquisição da operação de crédito

Emissão de dívida PJ

Request​

Atributos de uma Emissão​

BODY PARAMS​

Objeto borrower (PJ)​

Objeto address​

Objeto company_representatives​

Objeto phone​

Objeto guarantor​

Objeto disbursement_bank_accounts​

Objeto financial​