Comprovantes
Disponibilizamos operações de consulta e exportação de comprovantes em PDF de pagamentos.
Consulta Comprovantes
A funcionalidade permite a consulta por um comprovante de pagamento.
Solicitamos os campos:
| Campo | Descrição | Formato | Obrigatório |
|---|---|---|---|
| dataInicial | Data inicial da pesquisa | date-time | Sim |
| dataFinal | Data final da pesquisa | date-time | Sim |
| tipoFiltro | Código do tipo de filtro, conforme tabela [Tipo de filtro] | integer | Sim |
Resposta:
| Campo | Descrição | Formato | Nullable |
|---|---|---|---|
| comprovanteId | Identificador único do comprovante | string | Não |
| empresa | Dados da empresa | Object | Sim |
| EfetuadoEm | Data em que o pagamento foi efetuado | date-time | Sim |
| EfetuarEm | Data em que o pagamento será efetuado, e nesse caso o pagamento está agendado | date-time | Sim |
| tipo | Código do tipo de comprovante, conforme tabela [Tipo de comprovante] | integer | Não |
| protocolo | Número do protocolo do pagamento | string | Sim |
| dadosTransferencia | Apresenta valor, favorecido e dados bancários do favorecido | object | Sim |
| dadosPagamento | Apresenta beneficiário, sacador avalista, pagador, cedente, banco emissor do pagamento, linha digitável, vencimento e valores (pago, desconto, mora, deduções, acréscimos, encargos etc.) do boleto | object | Sim |
| dadosTributo | Apresenta dados do pagador, pagador final, vencimento, valores (pago, juros etc.) do tributo | object | Sim |
| dadosPagamentoPix | Apresenta os dados de recebedor (nome, CPF/CNPJ e dados bancários), valor, valor de tarifa, chave e endToEndId | objetc | Sim |
Gera comprovante em PDF
A funcionalidade permite gerar o comprovante de pagamento no formato PDF.
Solicitamos os campos:
| Campo | Descrição | Formato | Obrigatório |
|---|---|---|---|
| comprovanteId | Identificador do comprovante | string | Sim |
| TipoComprovante | Código do tipo de comprovante, conforme tabela [Tipo de comprovante] | integer | Sim |
E como resultado é efetuado o download do PDF.
Tipo de filtro
Na tabela abaixo, listamos os tipos de filtros:
| Enumeração | Descrição |
|---|---|
| 1 | Transferência |
| 2 | Pagamento |
| 3 | Agendamento Transferência |
| 4 | Agendamento Pagamento |
| 5 | Efetuados |
| 6 | Agendados |
Tipo de comprovante
Na tabela a seguir, são listados os tipos de comprovantes:
| Enumeração | Descrição |
|---|---|
| 1 | Transferência |
| 2 | Pagamento |
| 3 | Pagamento Tributo |
| 4 | Agendamento Transferência |
| 5 | Agendamento Pagamento |
| 6 | Agendamento Pagamento Tributo |
| 7 | Pagamento Pix |
Updated 6 months ago