Dados para informe de rendimentos

📘
Nota
O endpoint de Dados para informe de rendimentos está disponível na versão 2.

Este endpoint possibilita que nossos parceiros tenham acesso aos dados de rendimento de todos os seus clientes. A partir das informações obtidas, os parceiros poderão compor o documento de informe de rendimentos.

Pré-requisito

Para que seja possível utilizar este endpoint, é necessário que:

O cliente de nosso parceiro possua uma conta ativa.

Requisição (Request)

Requisição HTTP

GET https://api-mtls.sandbox.bankly.com.br/accounts/{{accountNumber}}/income-report?calendar={{2021}}

--request GET 
--url 'https://api-mtls.sandbox.bankly.com.br/accounts/{{accountNumber}}/income-report?calendar={{2021}}' \  
--header 'Accept: application/json' \  
--header 'Content-Type: application/json' \  
--header 'api-version:1.0' \  
--header 'Authorization: Bearer {{accessToken}}' \

Autorização

Para garantir a segurança nas requisições, todos os endpoints do Bankly utilizam scopes como parte do seu fluxo de autorização.
Esta requisição requer o scope descrito a seguir:

Scope	Descrição
`income.report.read`	Concede acesso para a leitura do recurso de informe de rendimento.

Cabeçalhos (Headers)

Nome	Descrição
`api-verion`	Obrigatório. Versão da API.
`Authorization`	Obrigatório. Token de autorização do tipo Bearer.

Parâmetros da rota (Path)

No path desta requisição envie os seguintes campos:

Nome	Tipo	Descrição
`accountNumber`	`path`	Obrigatório. Número da conta ao qual se deseja obter os dados para o informe.
`calendar`	`query`	Ano para a geração das informações do informe de rendimento. O valor padrão é o ano atual da consulta menos um.

📘
Nota
Caso o campo calendar não seja preenchido, será considerado o ano calendário como padrão, que é o ano atual da consulta menos um.

Corpo da requisição (Body)

Não é necessário enviar campos no body desta requisição.

Resposta (Response)

O status code 200 indicará que a solicitação foi completada com sucesso.

Sendo bem-sucedido, o retorno irá trazer os seguintes campos em formato JSON:

Nome	Tipo	Descrição
`payerSource`	`object`	Objeto que contém informações sobre a fonte pagadora.
`payerSource.name`	`string`	Razão social da fonte pagadora.
`payerSource.documentNumber`	`string`	Número do documento CNPJ da fonte pagadora.
`holder`	`object`	Objeto que contém informações sobre o titular da conta.
`holder.name`	`string`	Nome do titular.
`holder.documentNumber`	`string`	Número do documento.
`account`	`object`	Objeto que contém informações sobre a conta.
`account.branch`	`string`	Número da agência.
`account.number`	`string`	Número da conta.
`balances`	`array of objects`	Lista de objetos contendo informações sobre o saldo do ano vigente (ou do ano enviado no campo `calendar`) e o saldo do ano anterior.
`balances.year`	`string`	Ano do saldo.
`balances.amount`	`number`	Valor referente ao saldo da conta.
`balances.currency`	`string`	Código da moeda com base na ISO-4217. Exemplo: “BRL”.
`netIncome`	`object`	Objeto que contém informações sobre os rendimentos líquidos do cliente.
`netIncome.amount`	`number`	Valor do rendimento líquido.
`netIncome.currency`	`string`	Código da moeda com base na ISO-4217. Exemplo: “BRL”.

{
   "payerSource": {
      "name": "Acesso Soluções de Pagamentos S.A",
      "documentNumber": "13140088000199"
   },
   "holder": {
      "name": "Nísia Floresta",
      "documentNumber": "47742663023"
   },
   "account": {
      "branch": "0001",
      "number": "15164"
   },
   "balances": [
      {
         "year": "2020",
         "amount": 10.45,
         "currency": "BRL"
      },
      {
         "year": "2021",
         "amount": 105.78,
         "currency": "BRL"
      }
   ],
   "netIncome": {
      "amount": 0,
      "currency": "BRL"
   }
}

📘
Nota
Este endpoint possibilita que nossos parceiros estruturem um documento de informe de rendimentos para seus clientes. Se desejarem que os dados se apresentem com o layout do Bankly, recomendamos a utilização do endpoint a seguir.

Erros

Este endpoint pode retornar erros específicos, conforme a tabela a seguir:

Status Code	Código	Mensagem	Descrição
400	INCOME_REPORT_NOT_AVAILABLE	Income report is not available in the moment, please later try again.	Informe de rendimento para um determinado ano calendário não disponível para consulta.
400	CALENDAR_NOT_ALLOWED	The calendar informed is not allowed.	Ano calendário informado não permitido para realização da consulta.

Recordamos que esta API também poderá retornar erros comuns entre todos os endpoints. Portanto, recomendamos a consulta da documentação de erros, onde é possível encontrar as mensagens comuns em inglês que acompanham os erros 400 (se houver).

Eventos

Este endpoint não possui eventos relacionados a ele.