POST

api/financas/gf/LancamentoFinanceiro/ImprimirContasPagar

Notas de Implementação:

Gerar a impressão do relatório Contas a Pagar para o usuário com os filtros informados. Nome Público: AA02428. Grupo: CPAGAR.

Informações de Envio:

Cabeçalhos de Envio:

Parâmetro Valor Descrição Tipo de parâmetro Tipo de dados
Authorization Bearer Hash gerado no login Header String

Acesse o método de login para mais informações: api/genericos/ge/Login/Autenticar

Itens de Menu:

AA02428

Modelo:

FiltrosContasPagarDTO

NomeDescriçãoTipoInformação Adicional
LancamentoInicial

integer

Opcional
LancamentoFinal

integer

Opcional
DataInicial

date

Opcional
DataFinal

date

Opcional
VencimentoInicial

date

Opcional
VencimentoFinal

date

Opcional
SerieInicial

string

Opcional
SerieFinal

string

Opcional
NFInicial

integer

Opcional
NFFinal

integer

Opcional
ContaInicial

string

Opcional
ContaFinal

string

Opcional
EmpresaInicial

string

Opcional
EmpresaFinal

string

Opcional
NomeInicial

string

Opcional
NomeFinal

string

Opcional
NominalInicial

string

Opcional
NominalFinal

string

Opcional
ChequeInicial

integer

Opcional
ChequeFinal

integer

Opcional
ProjetoInicial

string

Opcional
ProjetoFinal

string

Opcional
PortadorInicial

string

Opcional
PortadorFinal

string

Opcional
HistoricoInicial

string

Opcional
HistoricoFinal

string

Opcional
TipoPagamentoInicial

string

Opcional
TipoPagamentoFinal

string

Opcional
CodigoDarfInicial

integer

Opcional
CodigoDarfFinal

integer

Opcional
UnidadeNegocioInicial

string

Opcional
UnidadeNegocioFinal

string

Opcional
TipoControlePortador

string

Opcional
EspecieDocumentoInicial

string

Opcional
EspecieDocumentoFinal

string

Opcional
TgUnidadeNegocio

integer

Opcional
TgUnidadeCategoriaUnicoInicial

string

Opcional
TgUnidadeCategoriaUnicoFinal

string

Opcional
TgSerie

integer

Opcional
TgSerieCategoriaUnicoInicial

string

Opcional
TgSerieCategoriaUnicoFinal

string

Opcional
DuplaConversao

boolean

Opcional
Indice

string

Opcional
DataCotacao

date

Opcional
RemessaBanco

string

Opcional
TituloAuxiliar

string

Opcional
TipoImpressao

string

Opcional
SubtotalizarVencimento

boolean

Opcional
ImprimirResumoVencimentos

boolean

Opcional
Previsoes

string

Opcional
Pagamento

string

Opcional
ConsiderarDescontoAteVencimento

boolean

Opcional
AbaterRetencoesEfetivasSaldo

boolean

Opcional
ImprimirRazaoSocial

boolean

Opcional
ListarCheque

boolean

Opcional
TgPortador

integer

Opcional
TgPortadorCategoriaUnicoInicial

string

Opcional
TgPortadorCategoriaUnicoFinal

string

Opcional
ExibirValor

string

Opcional
TgEmpresa

integer

Opcional
TgEmpresaCategoriaUnicoInicial

string

Opcional
TgEmpresaCategoriaUnicoFinal

string

Opcional
SomenteSerieBranca

boolean

Opcional
NomeRelatorio

string

Opcional

Formato de Envio:

application/json, text/json

Exemplo: 
{
  "LancamentoInicial": 1,
  "LancamentoFinal": 2,
  "DataInicial": "2026-01-13",
  "DataFinal": "2026-01-13",
  "VencimentoInicial": "2026-01-13",
  "VencimentoFinal": "2026-01-13",
  "SerieInicial": "string 3",
  "SerieFinal": "string 4",
  "NFInicial": 5,
  "NFFinal": 6,
  "ContaInicial": "string 7",
  "ContaFinal": "string 8",
  "EmpresaInicial": "string 9",
  "EmpresaFinal": "string 10",
  "NomeInicial": "string 11",
  "NomeFinal": "string 12",
  "NominalInicial": "string 13",
  "NominalFinal": "string 14",
  "ChequeInicial": 15,
  "ChequeFinal": 16,
  "ProjetoInicial": "string 17",
  "ProjetoFinal": "string 18",
  "PortadorInicial": "string 19",
  "PortadorFinal": "string 20",
  "HistoricoInicial": "string 21",
  "HistoricoFinal": "string 22",
  "TipoPagamentoInicial": "string 23",
  "TipoPagamentoFinal": "string 24",
  "CodigoDarfInicial": 25,
  "CodigoDarfFinal": 26,
  "UnidadeNegocioInicial": "string 27",
  "UnidadeNegocioFinal": "string 28",
  "TipoControlePortador": "string 29",
  "EspecieDocumentoInicial": "string 30",
  "EspecieDocumentoFinal": "string 31",
  "TgUnidadeNegocio": 32,
  "TgUnidadeCategoriaUnicoInicial": "string 33",
  "TgUnidadeCategoriaUnicoFinal": "string 34",
  "TgSerie": 35,
  "TgSerieCategoriaUnicoInicial": "string 36",
  "TgSerieCategoriaUnicoFinal": "string 37",
  "DuplaConversao": true,
  "Indice": "string 39",
  "DataCotacao": "2026-01-13",
  "RemessaBanco": "string 40",
  "TituloAuxiliar": "string 41",
  "TipoImpressao": "string 42",
  "SubtotalizarVencimento": true,
  "ImprimirResumoVencimentos": true,
  "Previsoes": "string 45",
  "Pagamento": "string 46",
  "ConsiderarDescontoAteVencimento": true,
  "AbaterRetencoesEfetivasSaldo": true,
  "ImprimirRazaoSocial": true,
  "ListarCheque": true,
  "TgPortador": 51,
  "TgPortadorCategoriaUnicoInicial": "string 52",
  "TgPortadorCategoriaUnicoFinal": "string 53",
  "ExibirValor": "string 54",
  "TgEmpresa": 55,
  "TgEmpresaCategoriaUnicoInicial": "string 56",
  "TgEmpresaCategoriaUnicoFinal": "string 57",
  "SomenteSerieBranca": true,
  "NomeRelatorio": "string 59"
}

Informações de Retorno:

Cabeçalhos Adicionais:

Nome Descrição Valor
cigam-api-version Versão do build/compilação dessa versão da API 2.1.8565.21067

Modelo:

HttpCustomResponse

NomeDescriçãoTipoInformação Adicional
success

boolean

Opcional
hash

string

Opcional
messages

string

Opcional
data

Object

Opcional
tipoLogin

string

Opcional

Formato de Resposta:

Retorna o relatório gerado.

Código de status HTTP Descrição Modelo de resposta
200 OK

application/json, text/json

Exemplo: 
{
  "success": true,
  "hash": "string 2",
  "messages": [
    "string 1"
  ],
  "data": {},
  "tipoLogin": "string 4"
}
400 Requisição inválida

application/json, text/json

Exemplo:
{ 
                    "success": false,
                    "hash": "string 2",
                    "messages": [
                     "string 1"
                    ],
                     "data": {},
                     "tipoLogin": "string 4"
}
401 Não autorizado

application/json, text/json

Exemplo:
{ 
                    "success": false,
                    "hash": "string 2",
                    "messages": [
                     "string 1"
                    ],
                     "data": {},
                     "tipoLogin": "string 4"
}
500 Requisição falhou

application/json, text/json

Exemplo:
{ 
                    "success": false,
                    "hash": "string 2",
                    "messages": [
                     "string 1"
                    ],
                     "data": {},
                     "tipoLogin": "string 4"
}
502 Falha de comunicação

application/json, text/json

Exemplo:
{ 
                    "success": false,
                    "hash": "string 2",
                    "messages": [
                     "string 1"
                    ],
                     "data": {},
                     "tipoLogin": "string 4"
}