Pular para o conteúdo principal

Criação de Ativo — CTE

Endpoint para inserir um ativo do tipo CTE (Conhecimento de Transporte Eletrônico) em um lote de cessão. O CTE é um documento fiscal eletrônico que comprova a prestação de serviço de transporte, utilizado como direito creditório na operação de cessão.

Onde estou no fluxo?

Este é o 2º passo do fluxo de cessão. Antes, você deve ter criado o lote. Após inserir os ativos, envie os documentos exigidos e encerre a inserção.

Atenção

O campo external_id do direito creditório deve ser único para cada ativo e não deve ser confundido com o external_id do lote.

Request

ENDPOINT
/trade_receivables/fund_class/{fund_class_key}/assignment_configuration/{assignment_configuration_key}/assignment/{assignment_external_id}/asset
MÉTODO
POST
Request Body
{
"asset_type": "cte",
"total_purchase_value": 1231.21,
"discounted_credit_right": {
"external_id": "ccf6f331-d55f-46c0-a32f-fb909884dbb2",
"originator_document_number": "46.282.154/0001-14",
"maturity_date": "2023-12-10",
"order_number": "18923619954796912",
"face_value": 1023.01,
"person_type": "legal_person",
"borrower": {
"name": "Transportadora Exemplo Ltda",
"document_number": "46.282.154/0001-14",
"person_type": "legal_person",
"email": "contato@transportadora.com.br",
"address": {
"street": "Avenida Paulista",
"number": "1000",
"neighborhood": "Bela Vista",
"city": "São Paulo",
"postal_code": "01310-100",
"uf": "SP",
"country": "BRA"
},
"phone": {
"area_code": "11",
"number": "936360268"
},
"legal_person": {
"activity_code": "49.30-2-01"
}
},
"participant_control_number": "ICX841HWCPUGU4U101XPLDW8D",
"bankslip": {
"our_number": {
"number": 2,
"digit": "P"
}
},
"delay": {
"fine": {
"fine_type": "percentage",
"percentage_value": 0.0
},
"interest": {
"method": "pre_fixed",
"pre_fixed": {
"daily_rate": 0.0,
"calendar_base": "calendar_360"
}
}
},
"invoice": {
"access_key": "35231146282154000114570000000001189236199547",
"total_value": 1231.21,
"serie": "001",
"number": "958431587",
"issue_date": "2023-10-10"
}
}
}

Atributos do body

CampoTipoObrigatoriedadeDescrição
asset_typestringobrigatórioTipo do ativo. Para CTE, informar cte.
total_purchase_valuenumberobrigatórioValor total da compra do ativo — efetivamente quanto o cessionário vai pagar. Até 2 casas decimais.
discounted_credit_rightobjectobrigatórioDados do direito creditório. Veja Atributos de discounted_credit_right.

Atributos de discounted_credit_right

CampoTipoObrigatoriedadeDescrição
external_idstringobrigatórioChave única de identificação deste ativo no sistema do parceiro. Máximo de 50 caracteres.
originator_document_numberstringobrigatórioCPF ou CNPJ formatado do originador/consultor que viabilizou a operação.
maturity_datestringobrigatórioData de vencimento no formato YYYY-MM-DD.
order_numberstringobrigatórioNúmero do pedido. Máximo de 45 caracteres.
face_valuenumberobrigatórioValor de face. Até 8 casas decimais.
person_typestringopcionalTipo de pessoa do sacado (natural_person ou legal_person).
borrowerobjectobrigatórioDados do sacado. Consulte os Atributos de borrower.
invoiceobjectobrigatórioDados do CT-e. Veja Atributos de invoice.
participant_control_numberstringopcionalNúmero de controle do participante no sistema do parceiro. Máximo de 25 caracteres alfanuméricos.
bankslipobjectopcionalDados do boleto. Veja Atributos de bankslip.
delayobjectopcionalDados de multa e juros por atraso. Veja Atributos de delay.

Atributos de invoice

CampoTipoObrigatoriedadeDescrição
access_keystringobrigatórioChave de acesso do CT-e. 44 caracteres. Os caracteres de posição 20 a 22 devem corresponder ao modelo do documento (57 ou 67).
total_valuenumberopcionalValor total do CT-e. Até 2 casas decimais.
seriestringobrigatórioNúmero de série do CT-e. Máximo de 3 caracteres.
numberstringobrigatórioNúmero do CT-e. Máximo de 9 caracteres.
issue_datestringobrigatórioData de emissão no formato YYYY-MM-DD.

Atributos de borrower

CampoTipoObrigatoriedadeDescrição
namestringobrigatórioNome do sacado. Máximo de 255 caracteres.
document_numberstringobrigatórioCPF ou CNPJ do sacado.
person_typestringobrigatórioTipo de pessoa.
emailstringopcionalE-mail do sacado. Máximo de 255 caracteres.
addressobjectobrigatórioEndereço do sacado. Veja Atributos de address.
phoneobjectopcionalTelefone do sacado. Veja Atributos de phone.

Enumeradores de person_type:

ValorDescrição
natural_personPessoa Física. Quando informado, incluir o objeto natural_person dentro de borrower. Veja Atributos de natural_person.
legal_personPessoa Jurídica. Quando informado, incluir o objeto legal_person dentro de borrower. Veja Atributos de legal_person.

Atributos de address

CampoTipoObrigatoriedadeDescrição
streetstringobrigatórioLogradouro. Caso não tenha todas as informações, enviar o compilado neste campo. Máximo de 255 caracteres.
numberstringopcionalNúmero do endereço. Máximo de 40 caracteres.
neighborhoodstringopcionalBairro. Máximo de 255 caracteres.
citystringopcionalCidade. Máximo de 255 caracteres.
ufstringopcionalSigla do estado. 2 caracteres.
complementstringopcionalComplemento. Máximo de 255 caracteres.
postal_codestringobrigatórioCEP. 9 caracteres (com hífen).
countrystringopcionalPaís no formato ISO 3166-1 alpha-3. 3 caracteres.

Atributos de phone

CampoTipoObrigatoriedadeDescrição
area_codestringobrigatórioCódigo de área (DDD). 2 dígitos.
numberstringobrigatórioNúmero de telefone. Até 9 dígitos.

Atributos de natural_person

CampoTipoObrigatoriedadeDescrição
birthdatestringopcionalData de nascimento no formato YYYY-MM-DD.
genderstringopcionalGênero.
mother_namestringopcionalNome da mãe. Máximo de 255 caracteres.

Enumeradores de gender:

ValorDescrição
maleMasculino.
femaleFeminino.
CampoTipoObrigatoriedadeDescrição
foundation_datestringopcionalData de fundação no formato YYYY-MM-DD.
activity_codestringobrigatórioCódigo de atividade no formato 11.11-1-11.
annual_revenuesintegeropcionalReceita anual em centavos.
representativesarrayopcionalLista de representantes legais. Veja Atributos de representatives.

Atributos de representatives

CampoTipoObrigatoriedadeDescrição
namestringobrigatórioNome do representante. Máximo de 255 caracteres.
document_numberstringobrigatórioCPF ou CNPJ do representante.
emailstringopcionalE-mail do representante. Máximo de 255 caracteres.
phoneobjectopcionalTelefone. Mesma estrutura de Atributos de phone.
addressobjectopcionalEndereço. Mesma estrutura de Atributos de address.
person_typestringobrigatórioTipo de pessoa (natural_person ou legal_person).
representative_typestringopcionalTipo do representante. Máximo de 50 caracteres.

Atributos de bankslip

CampoTipoObrigatoriedadeDescrição
our_numberobjectopcionalDados do nosso número. Aplicável apenas quando o nosso número é emitido pelo cliente. Veja Atributos de our_number.

Atributos de our_number

CampoTipoObrigatoriedadeDescrição
numbernumberobrigatórioNosso número. Número bancário para cobrança com registro. 1 a 11 caracteres numéricos.
digitstringobrigatórioDígito verificador de auto conferência do nosso número. 1 caractere alfanumérico.

Atributos de delay

CampoTipoObrigatoriedadeDescrição
fineobjectopcionalDados da multa por atraso. Veja Atributos de fine.
interestobjectopcionalDados do juros de mora. Veja Atributos de interest.

Atributos de fine

CampoTipoObrigatoriedadeDescrição
fine_typestringobrigatórioTipo da multa.
percentage_valuenumbercondicionalValor da multa quando fine_type for percentage. De 0 a 1, representando 0% a 100%. Até 2 casas decimais.
amountnumbercondicionalValor fixo da multa quando fine_type for fixed. Até 2 casas decimais.

Enumeradores de fine_type:

ValorDescrição
percentageMulta percentual sobre o valor da parcela.
fixedValor fixo de multa.

Atributos de interest

CampoTipoObrigatoriedadeDescrição
methodstringobrigatórioMétodo do juros de mora.
pre_fixedobjectobrigatórioDados da taxa pré-fixada. Veja Atributos de pre_fixed.

Enumeradores de method:

ValorDescrição
compoundJuros de mora composto.
simpleJuros de mora simples.
pre_fixedJuros de mora pré-fixado.

Atributos de pre_fixed

CampoTipoObrigatoriedadeDescrição
daily_ratenumbercondicionalTaxa diária. Informar quando method for pre_fixed. Para 1%, informar 0.01. Até 8 casas decimais.
calendar_basestringobrigatórioBase de cálculo utilizada.

Enumeradores de calendar_base:

ValorDescrição
workdaysBase de cálculo em dias úteis (252).
calendar_365Base de cálculo em 365 dias.
calendar_360Base de cálculo em 360 dias.

Response

STATUS
201
Response Body
{
"asset_key": "41d6ff41-1dac-4df7-9e50-d15210ec57f3",
"external_id": "ccf6f331-d55f-46c0-a32f-fb909884dbb2",
"status": "pending_eligibility"
}

Atributos da resposta

CampoTipoDescrição
asset_keystringIdentificador único do ativo gerado pela QI Tech (UUID).
external_idstringA mesma chave externa fornecida no campo external_id do discounted_credit_right.
statusstringStatus inicial do ativo. Sempre retorna pending_eligibility, indicando que o ativo foi inserido e aguarda análise de elegibilidade.

Possíveis erros

STATUS
404
Lote não encontrado

O assignment_external_id informado na URL não corresponde a nenhum lote existente nesta configuração de cessão. Verifique se o identificador está correto.

{
"title": "Assignment not found",
"description": "Assignment not found",
"translation": "Lote não encontrado",
"code": "TRC000018"
}
STATUS
404
Tipo de ativo não existe

O valor informado no campo asset_type não é um tipo válido. Verifique se o tipo está correto (ex: cte).

{
"title": "Asset type does not exist",
"description": "Asset type 'invalid_asset_type' does not exist",
"translation": "Tipo do ativo 'invalid_asset_type' nao existe",
"code": "TRC000015"
}
STATUS
400
Tipo de ativo incompatível com o lote

O lote foi configurado para receber um tipo de ativo diferente do informado. Cada configuração de cessão aceita apenas um tipo de ativo específico. Verifique a configuração de cessão utilizada.

{
"title": "Invalid asset type configuration",
"description": "This assignment can not receive this asset type: cte",
"translation": "Esse lote não pode receber esse tipo de ativo: cte",
"code": "TRC000025"
}
STATUS
400
Lote fechado para inserção

O lote já foi encerrado para inserção de novos ativos. Após o encerramento, não é possível adicionar mais ativos. Caso precise, reabra o lote antes de inserir novos ativos.

{
"title": "Assignment is closed",
"description": "Assignment is closed to insert new assets",
"translation": "Lote esta fechado para inserir novos ativos",
"code": "TRC000022"
}
STATUS
400
Chave de acesso do CT-e ausente

O campo access_key dentro de invoice é obrigatório para ativos do tipo cte. Inclua a chave de acesso do CT-e no request body.

{
"title": "Access Key Required",
"description": "Access key is required for cte asset type",
"translation": "Chave de acesso é obrigatória para o tipo de ativo cte",
"code": "TRC000134"
}
STATUS
400
Chave de acesso do CT-e inválida

A access_key informada não corresponde a um CT-e válido. Os caracteres de posição 20 a 22 da chave de acesso devem ser 57 ou 67, que identificam o modelo do documento fiscal CT-e.

{
"title": "Invalid CTE Access Key",
"description": "Access key is not valid for a CTE document",
"translation": "Chave de acesso não é válida para um documento CT-e",
"code": "TRC000133"
}
STATUS
400
External ID duplicado

Já existe um ativo cadastrado com o external_id informado. Cada ativo deve ter um identificador único. Gere um novo external_id e tente novamente.

{
"title": "Already Exist This External Id",
"description": "Already exist an asset with this External Id",
"translation": "Ja existe um ativo com esse External Id",
"code": "TRC000054"
}

Próximos passos

Após inserir o ativo, o fluxo continua com:

  1. Envio dos documentos — envie a documentação exigida para cada ativo aprovado na elegibilidade.
  2. Encerramento da inserção — sinalize que todos os ativos foram inseridos para que o lote siga para a análise de elegibilidade.