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.
| Perfil | Host | Permissão exigida — inclusão e rejeição | Permissão exigida — consulta |
|---|---|---|---|
| Gestora | manager-api | Escrita | Leitura |
| Consultoria | consultant-api | Lotes | Ler Cessões |
URL base de cada host: Ambientes (Hosts).
- A configuração de cessão do lote precisa permitir descontos ao cedente. Confira o objeto
assignor_discounts_configurationna 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_dateoupending_manager_approval. Depois da aprovação, os descontos não mudam mais.
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
Path params
| Parâmetro | Tipo | Descrição |
|---|---|---|
fund_class_key | string | Chave única do fundo (UUID). |
assignment_configuration_key | string | Chave da configuração de cessão (UUID). |
assignment_external_id | string | O external_id informado na criação do lote. |
{
"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
| Campo | Tipo | Obrigatoriedade | Descrição |
|---|---|---|---|
assignor_discount_type | string | obrigatório | expense_reimbursement (reembolso de despesa) ou others. |
total_value | number | obrigatório | Valor do desconto, em reais. Mínimo 0.01. |
description | string | obrigatório | Descrição do desconto, de 1 a 500 caracteres. |
assignor_discount_key | string | opcional | UUID v4 do desconto. Se omitido, a QI Tech gera um. Envie a sua chave para consultar o desconto sem depender da resposta. |
Response
{
"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
Os path params são os mesmos da inclusão. A resposta lista todos os descontos do lote, inclusive os rejected.
{
"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
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.
{
"assignor_discount_status": "rejected"
}
| Campo | Tipo | Obrigatoriedade | Descrição |
|---|---|---|---|
assignor_discount_status | string | obrigatório | Novo status do desconto. O único valor aceito é rejected. |
A resposta é o desconto, no mesmo formato da resposta da inclusão, com status igual a rejected.
Atributos do desconto
| Campo | Tipo | Descrição |
|---|---|---|
assignor_discount_key | string | Chave única do desconto (UUID). |
assignor_discount_type | string | expense_reimbursement ou others. |
status | string | created (incluído, será deduzido), pending_execution (em dedução no pagamento), executed (deduzido do pagamento) ou rejected (não será deduzido). |
total_value | number | Valor do desconto, em reais. |
description | string | Descrição do desconto. |
Os descontos também aparecem em assignor_discounts na Recuperação do Lote.
Erros
| Status | Código | Quando acontece |
|---|---|---|
| 400 | TRC000087 | O lote não está em um status que aceita inclusão ou rejeição de desconto. Veja os pré-requisitos. |
| 400 | TRC000136 | A configuração de cessão do lote não permite descontos ao cedente. |
| 400 | TRC000148 | assignor_discount_type diferente de expense_reimbursement e others. |
| 400 | TRC000153 | O desconto não está created e não pode ser rejeitado. |
| 400 | TRC000154 | assignor_discount_status diferente de rejected. |
| 404 | TRC000018 | Nenhum lote com esse external_id nesta configuração de cessão. |
| 404 | TRC000147 | O lote não tem nenhum desconto ao cedente. |
| 404 | TRC000150 | Nenhum desconto com essa assignor_discount_key no lote. |
Erros de autenticação, permissão e host: veja Erros da API.