Informe de Rendimentos
Este endpoint é responsável por retornar os dados necessários para gerar informes de rendimentos das contas de pagamento (pessoa física e jurídica) e de outras fontes pagadoras dos clientes do parceiro Celcoin, bem como o PDF pronto com essas informações. Cabe aos nossos parceiros decidir qual a melhor opção a ser utilizada.
Caso nosso parceiro queira estruturar seu próprio documento de informe de rendimentos para disponibilizá-lo a seus clientes, o mesmo deve seguir o seguinte padrão de layout:
Como Integrar:
Passos para integrar
- Realizar autenticação na API - [API Reference]
- Consultar Informe - [API Reference]
cURL da Chamada
curl -X 'GET' \
'https://sandbox.openfinance.celcoin.dev/baas-accountmanager/v1/account/income-report?Account=300578778788&CalendarYear=2023' \
-H 'accept: application/json'
Informação
O PDF será retornado em base64 na propriedade incomeFile, o mesmo é protegido por senha, que corresponde aos seis primeiros dígitos do seu CPF ou CNPJ.s
Exemplo de retorno
Sucesso 200
{
"version": "1.0.0",
"status": "SUCCESS",
"body": {
"payerSource": {
"name": "Celcoin Teste S/A",
"documentNumber": "123456"
},
"owner": {
"documentNumber": "34335125070",
"name": "Iago Daniel Souza",
"type": "NATURAL_PERSON",
"createDate": "15-07-1986"
},
"account": {
"branch": "1234",
"account": "123456"
},
"balances": [
{
"calendarYear": "2025",
"amount": 10.5,
"currency": "BRL",
"type": "SALDO"
}
],
"incomeFile": "string",
"fileType": "string"
}
}
Descrição dos Campos
| Nome | Descrição |
|---|---|
| payerSource | Identificador da fonte pagadora |
| name | Nome |
| documentNumber | Documento |
| owner | Pessoa Beneficiaria dos rendimentos (Física ou Jurídica) |
| documentNumber | Documento (CPF ou CNPJ) |
| name | Nome |
| type | Tipo NATURAL_PERSON ou LEGAL_PERSON |
| createDate | Data de criação da conta. |
| account | Dados da Conta |
| branch | Agência da conta. |
| account | Número da conta. |
| balances | Dados do informe de rendimento. |
| calendarYear | Ano-calendário. |
| amount | Valor do saldo no ano-calendario. |
| currency | Tipo da moeda. |
| type | SALDO |
| incomeFile | Pdf no formato base64. |
| fileType | Tipo do arquivo. |
Error 400
{
"version": "1.0.0",
"status": "ERROR",
"error": {
"errorCode": "CIE999",
"message": "Ocorreu um erro interno durante a chamada da api."
}
}
Updated 3 months ago