Registro de Identificação
É possível enviar instruções de Pagamento, Pagamento Parcial, Recompra, Amortização e Tarifa.
Para todas as requisições, autenticação via Bearer Token no header.
POST http://host/api/v1/identifica/fundo/fundoCnpj/registro
Parameters
fundoCNPJ | string | CNPJ do Fundo.: "99999999999999"
host
Homologação: https://hom.api.hmra.com.br
Produção: https://api.hmra.com.br
REQUEST
Attributes
tipoOperacao | required | string | "Pagamento, Pagamento Parcial, Recompra, Amortizacao e Tarifa"
isParcial | boolean | Obrigatório para "Pagamento Parcial" - true
provisoes | required | array
id | required | number | Código do depósito. Informação disponível na api "Consulta Depósitos (valid)"
valor | required | number | Valor total que vai ser utilizado do depósito
titulos | required | array
titulo | required | object | Dados para identificação do titulo
id | number | [IdTituloVX] Prioridade de busca - Número gerado pela sistema Zheus no momento da aquisição - informação disponível no relatório de estoque do fundo.
numeroControleParticipante | string | [CampoChave] Opção de busca - Número informado pelo cliente na remessa de aquisição no campo numeroControleParticipante
cmc7 | string | [CMC7 do Cheque] Opção de busca - Número informado pelo cliente na remessa de aquisição de cheque no campo CMC7
valorEfetivo | required | number | Valor que vai ser utilizado no título informado
motivo | object | Obrigatório para Recompra e Tarifas
id | required | number | Código do motivo - Disponível na api "Motivos"
saldoResidual | number | Obrigatório para "Pagamento Parcial" - Informar o Valor Pendente de Pago considerando Juros e Abatimento
juros | number | Obrigatório para "Pagamento Parcial" - Informar o Valor dos Juros
abatimento | number | Obrigatório para "Pagamento Parcial" - Informar o Valor dos Abatimentos
Headers
Accept:application/json
Content-Type:application/json
Authorization:Bearer fsdfsdfsaf.fsadfsafsafsa.fsdafsadfsa
BODY
{
"tipoOperacao": "Pagamento", 'fixo "Pagamento"
"isParcial": false, 'fixo "false", "true" para Pagamento Parcial
"provisoes": [{ 'É um array, pode ser indicado mais de um depósito/provisão
"id": 0, 'Id do depósito
"valor": 0.00 'Valor a ser consumido do depósito
}
],
"titulos": [{ 'É um array, pode ser indicado mais de um título
"titulo": { 'Informar um dos três itens abaixo para localizar o titulo
"id": null, 'IdHmra - Código interno do título na Hemera
"numeroControleParticipante": "", 'Campo único do titulo - informado na remessa de aquisição
"cmc7": "" 'Campo único do titulo - informado na remessa de aquisição - apenas para cheque
},
"valorEfetivo": 0.00, 'Valor a ser consumido no título. A soma dos valores efetivos tem que ser igual a somas dos valores das provisões
"motivo": {
"id": 0 'Utilizado apenas para Recompra e Tarifas
},
"saldoResidual": 0.00, 'Utilizado apenas para Pagamento Parcial
"juros": 0.00, 'Utilizado apenas para Pagamento Parcial
"abatimentos": 0.00 'Utilizado apenas para Pagamento Parcial
}
]
}
Pagamento
É a liquidação de recebíveis através de depósitos realizados pelo devedor (sacado) na conta do fundo.
Para realização de um pagamento integral as regras são:
O título deve estar em estoque
O título não pode estar vinculado a outra operação de identificação de valores (exceto Tarifas)
Os depósitos que podem ser utilizados são os do tipo Pagamento
O mesmo título ou provisão não pode ser lançado duas vezes na mesma operação.
Pagamento Parcial
É a liquidação parcial de recebíveis através de depósitos realizados pelo devedor na conta do fundo. Para realizar esta operação algumas informações deverão ser enviadas.
IsParcial: [true] É o que tornará esta liquidação parcial.
Saldo Residual: Informar o saldo que vai ficar pendente de pagamento. Considerando o acréscimo de juros ou desconto de abatimentos
Juros*: Representa os juros que foram adicionados ao recebível.
Abatimentos*: Representa o desconto aplicado ao recebível.
*Os valores informados devem respeitar a fórmula:
X = (ValorEfetivo + SaldoResidual) - ValorNominal¹
Se X > 0 Juros = X
Se X < 0 Abatimentos = |X|
¹A cada Pagamento Parcial o SaldoResidual passa a ser o novo ValorNominal
Para realização de um pagamento parcial as regras são:
O título deve estar em estoque;
O título não pode estar vinculado a outra operação de identificação de valores (exceto Tarifas);
Os depósitos que podem ser utilizados são os do tipo Pagamento;
O mesmo título ou provisão não pode ser lançado duas vezes na mesma operação;
O título deve estar:
a. Sem Cobrança
b. Baixado da Cobrança
c. 1ª Devolução
d. 2ª Devolução
BODY
{
"tipoOperacao": "Pagamento", 'fixo "Pagamento"
"isParcial": true, 'fixo "true"
"provisoes": [{ 'É um array, pode ser indicado mais de um depósito/provisão
"id": 0, 'Id do depósito
"valor": 0.00 'Valor a ser consumido do depósito
}
],
"titulos": [{ 'É um array, pode ser indicado mais de um título
"titulo": { 'Informar um dos três itens abaixo para localizar o titulo
"id": null, 'IdHmra - Código interno do título na Hemera
"numeroControleParticipante": "", 'Campo único do titulo - informado na remessa de aquisição
"cmc7": "" 'Campo único do titulo - informado na remessa de aquisição - apenas para cheque
},
"valorEfetivo": 0.00, 'Valor a ser consumido no título. A soma dos valores efetivos tem que ser igual a somas dos valores das provisões
"motivo": {
"id": 0 'Utilizado apenas para Recompra e Tarifas
},
"saldoResidual": 0.00, 'Valor Pendente de Pagamento que vai ficar em aberto.
"juros": 0.00, 'Valor do Juros Aplicado ao Recebível - Seguir fórmula acima
"abatimentos": 0.00 'Valor do Abatimento Aplicado ao Recebível - Seguir fórmula acima
}
]
}
Recompra
É a liquidação de recebíveis através de depósitos realizados pelo cedente na conta do fundo.
Para realização de uma recompra as regras são:
O título deve estar em estoque
O título não pode estar vinculado a outra operação de identificação de valores (exceto Tarifas)
Os depósitos que podem ser utilizados são os do tipo Recompra
O mesmo título ou provisão não pode ser lançado duas vezes na mesma operação.
A ValorEfetivo da Recompra não pode ser menor que o valor de aquisição do título.
BODY
{
"tipoOperacao": "Recompra", 'fixo "Recompra"
"isParcial": false, 'fixo "false", "true" para Pagamento Parcial
"provisoes": [{ 'É um array, pode ser indicado mais de um depósito/provisão
"id": 0, 'Id do depósito
"valor": 0.00 'Valor a ser consumido do depósito
}
],
"titulos": [{ 'É um array, pode ser indicado mais de um título
"titulo": { 'Informar um dos três itens abaixo para localizar o titulo
"id": null, 'IdHmra - Código interno do título na Hemera
"numeroControleParticipante": "", 'Campo único do titulo - informado na remessa de aquisição
"cmc7": "" 'Campo único do titulo - informado na remessa de aquisição - apenas para cheque
},
"valorEfetivo": 0.00, 'Valor a ser consumido no título. A soma dos valores efetivos tem que ser igual a somas dos valores das provisões
"motivo": {
"id": 0 'Informar o id do motivo da Recompra - Ids dos motivos disponíveis na api "Motivos"
},
"saldoResidual": 0.00, 'Utilizado apenas para Pagamento Parcial
"juros": 0.00, 'Utilizado apenas para Pagamento Parcial
"abatimentos": 0.00 'Utilizado apenas para Pagamento Parcial
}
]
}
Tarifa
É a identificação de valores como receita vinculando o valor aos títulos que deram origem a receita.
Para adição de uma tarifa as regras são:
O mesmo título ou provisão não pode ser lançado duas vezes na mesma operação.
BODY
{
"tipoOperacao": "Tarifa", 'fixo "Tarifa"
"isParcial": false, 'fixo "false", "true" para Pagamento Parcial
"provisoes": [{ 'É um array, pode ser indicado mais de um depósito/provisão
"id": 0, 'Id do depósito
"valor": 0.00 'Valor a ser consumido do depósito
}
],
"titulos": [{ 'É um array, pode ser indicado mais de um título
"titulo": { 'Informar um dos três itens abaixo para localizar o titulo
"id": null, 'IdHmra - Código interno do título na Hemera
"numeroControleParticipante": "", 'Campo único do titulo - informado na remessa de aquisição
"cmc7": "" 'Campo único do titulo - informado na remessa de aquisição - apenas para cheque
},
"valorEfetivo": 0.00, 'Valor a ser consumido no título. A soma dos valores efetivos tem que ser igual a somas dos valores das provisões
"motivo": {
"id": 0 'Informar o id do motivo da Tarifa - Ids dos motivos disponíveis na api "Motivos"
},
"saldoResidual": 0.00, 'Utilizado apenas para Pagamento Parcial
"juros": 0.00, 'Utilizado apenas para Pagamento Parcial
"abatimentos": 0.00 'Utilizado apenas para Pagamento Parcial
}
]
}
Amortização
É a liquidação parcial de recebíveis através de depósitos realizados pelo cedente na conta do fundo. Para realizar esta operação algumas informações deverão ser enviadas.
Para realização de uma amortização as regras são:
O título deve estar em estoque;
O título não pode estar vinculado a outra operação de identificação de valores (exceto Tarifas);
Os depósitos que podem ser utilizados são os do tipo Recompra;
O mesmo título ou provisão não pode ser lançado duas vezes na mesma operação;
BODY
{
"tipoOperacao": "Amortização", 'fixo "Amortização"
"provisoes": [{ 'É um array, pode ser indicado mais de um depósito/provisão
"id": 0, 'Id do depósito
"valor": 0.00 'Valor a ser consumido do depósito
}
],
"titulos": [{ 'É um array, pode ser indicado mais de um título
"titulo": { 'Informar um dos três itens abaixo para localizar o titulo
"id": null, 'IdHmra - Código interno do título na Hemera
"numeroControleParticipante": "", 'Campo único do titulo - informado na remessa de aquisição
"cmc7": "" 'Campo único do titulo - informado na remessa de aquisição - apenas para cheque
},
"valorEfetivo": 0.00, 'Valor a ser consumido no título. A soma dos valores efetivos tem que ser igual a somas dos valores das provisões
}
]
}