Pular para o conteúdo principal

Descontos ao cedente

Um desconto ao cedente é um valor deduzido do pagamento da cessão, como o reembolso de uma despesa. Você pode enviar descontos na criação do lote, no campo assignor_discounts. Os endpoints desta página incluem, consultam e rejeitam descontos de um lote que já existe.

Disponível em
PerfilHostPermissão exigida — inclusão e rejeiçãoPermissão exigida — consulta
Gestoramanager-apiEscritaLeitura
Consultoriaconsultant-apiLotesLer Cessões

URL base de cada host: Ambientes (Hosts).

Pré-requisitos
  • A configuração de cessão do lote precisa permitir descontos ao cedente. Confira o objeto assignor_discounts_configuration na Listagem de Configurações de Cessão.
  • O lote precisa estar em um destes status: pending_assets_insertion, completed_assets_insertion, pending_eligibility, pending_consultant_approval, waiting_assignment_date ou pending_manager_approval. Depois da aprovação, os descontos não mudam mais.
Limite do total de descontos

A soma dos descontos que não estão rejected não pode passar do percentual máximo do valor do lote, definido na configuração de cessão. A inclusão não confere esse limite: a conferência é feita na aprovação do lote, que falha com TRC000149. Para aprovar, rejeite descontos até a soma ficar dentro do limite.

Inclusão de desconto​

ENDPOINT
/trade_receivables/fund_class/{fund_class_key}/assignment_configuration/{assignment_configuration_key}/assignment/{assignment_external_id}/assignor_discount
MÉTODO
POST

Path params​

ParâmetroTipoDescrição
fund_class_keystringChave única do fundo (UUID).
assignment_configuration_keystringChave da configuração de cessão (UUID).
assignment_external_idstringO external_id informado na criação do lote.
Request Body
{
"assignor_discount_key": "5b0f3c1e-8a2d-4f6b-9c7e-1d2a3b4c5d6e",
"assignor_discount_type": "expense_reimbursement",
"total_value": 1250.00,
"description": "Reembolso de custas de registro dos ativos"
}

Atributos do body​

CampoTipoObrigatoriedadeDescrição
assignor_discount_typestringobrigatórioexpense_reimbursement (reembolso de despesa) ou others.
total_valuenumberobrigatórioValor do desconto, em reais. Mínimo 0.01.
descriptionstringobrigatórioDescrição do desconto, de 1 a 500 caracteres.
assignor_discount_keystringopcionalUUID v4 do desconto. Se omitido, a QI Tech gera um. Envie a sua chave para consultar o desconto sem depender da resposta.

Response​

STATUS
201
Response Body
{
"assignor_discount_key": "5b0f3c1e-8a2d-4f6b-9c7e-1d2a3b4c5d6e",
"assignor_discount_type": "expense_reimbursement",
"status": "created",
"total_value": 1250.00,
"description": "Reembolso de custas de registro dos ativos"
}

Os atributos estão em Atributos do desconto.

Consulta dos descontos do lote​

ENDPOINT
/trade_receivables/fund_class/{fund_class_key}/assignment_configuration/{assignment_configuration_key}/assignment/{assignment_external_id}/assignor_discounts
MÉTODO
GET

Os path params são os mesmos da inclusão. A resposta lista todos os descontos do lote, inclusive os rejected.

STATUS
200
Response Body
{
"assignor_discounts": [
{
"assignor_discount_key": "5b0f3c1e-8a2d-4f6b-9c7e-1d2a3b4c5d6e",
"assignor_discount_type": "expense_reimbursement",
"status": "created",
"total_value": 1250.00,
"description": "Reembolso de custas de registro dos ativos"
}
]
}

Consulta de um desconto​

ENDPOINT
/trade_receivables/fund_class/{fund_class_key}/assignment_configuration/{assignment_configuration_key}/assignment/{assignment_external_id}/assignor_discount/{assignor_discount_key}
MÉTODO
GET

Além dos path params da inclusão, envie assignor_discount_key, a chave do desconto. A resposta, com status 200, é um único desconto, no mesmo formato da resposta da inclusão.

Rejeição de desconto​

Rejeite um desconto para que ele não seja deduzido do pagamento ao cedente. Só um desconto created pode ser rejeitado, e a rejeição não pode ser desfeita: para voltar a descontar o valor, inclua um novo desconto.

ENDPOINT
/trade_receivables/fund_class/{fund_class_key}/assignment_configuration/{assignment_configuration_key}/assignment/{assignment_external_id}/assignor_discount/{assignor_discount_key}
MÉTODO
PUT
Request Body
{
"assignor_discount_status": "rejected"
}
CampoTipoObrigatoriedadeDescrição
assignor_discount_statusstringobrigatórioNovo status do desconto. O único valor aceito é rejected.
STATUS
202

A resposta é o desconto, no mesmo formato da resposta da inclusão, com status igual a rejected.

Atributos do desconto​

CampoTipoDescrição
assignor_discount_keystringChave única do desconto (UUID).
assignor_discount_typestringexpense_reimbursement ou others.
statusstringcreated (incluído, será deduzido), pending_execution (em dedução no pagamento), executed (deduzido do pagamento) ou rejected (não será deduzido).
total_valuenumberValor do desconto, em reais.
descriptionstringDescrição do desconto.

Os descontos também aparecem em assignor_discounts na Recuperação do Lote.

Erros​

StatusCódigoQuando acontece
400TRC000087O lote não está em um status que aceita inclusão ou rejeição de desconto. Veja os pré-requisitos.
400TRC000136A configuração de cessão do lote não permite descontos ao cedente.
400TRC000148assignor_discount_type diferente de expense_reimbursement e others.
400TRC000153O desconto não está created e não pode ser rejeitado.
400TRC000154assignor_discount_status diferente de rejected.
404TRC000018Nenhum lote com esse external_id nesta configuração de cessão.
404TRC000147O lote não tem nenhum desconto ao cedente.
404TRC000150Nenhum desconto com essa assignor_discount_key no lote.

Erros de autenticação, permissão e host: veja Erros da API.