Notas de Implementação:
Listagem dos lançamentos financeiros. É realizado a junção entre as demais tabelas relacionadas para vincular os campos de outras tabelas.
Esse método suporta a passagem de parâmetros de consultas OData para restringir os resultados. Mais informações em: https://learn.microsoft.com/pt-br/odata/overview
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
Direitos:
GFLANCTO_P
Itens de Menu:
CG00003,CG00026,CG00027,CG00031
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:
| Nome | Descrição | Tipo | Informação Adicional |
|---|---|---|---|
| Codigo | integer |
Opcional |
|
| Data | date |
Opcional |
|
| Vencimento | date |
Opcional |
|
| Emissao | date |
Opcional |
|
| DataInclusao | date |
Opcional |
|
| DataModificacao | date |
Opcional |
|
| DataAutorizado | date |
Opcional |
|
| DataUltimaLiquidacao | date |
Opcional |
|
| Nf | decimal number |
Opcional |
|
| Serie | string |
Opcional |
|
| Fatura | decimal number |
Opcional |
|
| Complemento | string |
Opcional |
|
| Contabilidade | string |
Opcional |
|
| ContabilidadeDescricao | string |
Opcional |
|
| CodigoContaFinanceira | string |
Opcional |
|
| ContaFinanceiraDescricao | string |
Opcional |
|
| CodigoTipoPagamento | string |
Opcional |
|
| TipoPagamentoDescricao | string |
Opcional |
|
| CodigoContraPartida | integer |
Opcional |
|
| CodigoVinculado | integer |
Opcional |
|
| CodigoCobranca | string |
Opcional |
|
| Documento | string |
Opcional |
|
| TipoDocumento | string |
Opcional |
|
| TipoDocumentoDescricao | string |
Opcional |
|
| Cheque | integer |
Opcional |
|
| Valor | decimal number |
Opcional |
|
| Saldo | decimal number |
Opcional |
|
| Historico | string |
Opcional |
|
| CodigoHistorico | string |
Opcional |
|
| DescricaoHistorico | string |
Opcional |
|
| Tipo | string |
Opcional |
|
| TipoDescricao | string |
Opcional |
|
| Situacao | string |
Opcional |
|
| SituacaoDescricao | string |
Opcional |
|
| CodigoEmpresa | string |
Opcional |
|
| NomeEmpresa | string |
Opcional |
|
| NomeFantasia | string |
Opcional |
|
| CodigoUnidadeNegocio | string |
Opcional |
|
| DescricaoUnidadeNegocio | string |
Opcional |
|
| CodigoPortador | string |
Opcional |
|
| DescricaoPortador | string |
Opcional |
|
| BloquetoImpresso | boolean |
Opcional |
|
| RemessaEnviada | boolean |
Opcional |
|
| ToleranciaVencimento | integer |
Opcional |
|
| ToleranciaMulta | integer |
Opcional |
|
| ToleranciaJuros | integer |
Opcional |
|
| ValorDesconto | decimal number |
Opcional |
|
| ValorMulta | decimal number |
Opcional |
|
| ValorJurosDia | decimal number |
Opcional |
|
| TipoJuros | string |
Opcional |
|
| TipoJurosDescricao | string |
Opcional |
|
| TipoMulta | string |
Opcional |
|
| Pagamento | string |
Opcional |
|
| PagamentoDescricao | string |
Opcional |
|
| CodigoBarrasLido | string |
Opcional |
|
| Previsao | boolean |
Opcional |
|
| LimiteMultaFracionada | decimal number |
Opcional |
|
| Sessao | integer |
Opcional |
|
| Usuario | string |
Opcional |
|
| UsuarioModificacao | string |
Opcional |
|
| UsuarioCriacao | string |
Opcional |
|
| DiasAtrasoCalculado | integer |
Opcional |
|
| ValorAtualizadoCalculado | decimal number |
Opcional |
|
| Correlacao | string |
Opcional |
Formato de Resposta:
Classe de Resposta (Status 200)
OK
application/json, text/json
[
{
"Codigo": 1,
"Data": "2026-01-13",
"Vencimento": "2026-01-13",
"Emissao": "2026-01-13",
"DataInclusao": "2026-01-13",
"DataModificacao": "2026-01-13",
"DataAutorizado": "2026-01-13",
"DataUltimaLiquidacao": "2026-01-13",
"Nf": 2.0,
"Serie": "string 3",
"Fatura": 4.1,
"Complemento": "string 5",
"Contabilidade": "string 6",
"ContabilidadeDescricao": " ",
"CodigoContaFinanceira": "string 7",
"ContaFinanceiraDescricao": "string 8",
"CodigoTipoPagamento": "string 9",
"TipoPagamentoDescricao": "string 10",
"CodigoContraPartida": 11,
"CodigoVinculado": 12,
"CodigoCobranca": "string 13",
"Documento": "string 14",
"TipoDocumento": "string 15",
"TipoDocumentoDescricao": " ",
"Cheque": 16,
"Valor": 17.1,
"Saldo": 18.1,
"Historico": "string 19",
"CodigoHistorico": "string 20",
"DescricaoHistorico": "string 21",
"Tipo": "string 22",
"TipoDescricao": " ",
"Situacao": "string 23",
"SituacaoDescricao": " ",
"CodigoEmpresa": "string 24",
"NomeEmpresa": "string 25",
"NomeFantasia": "string 26",
"CodigoUnidadeNegocio": "string 27",
"DescricaoUnidadeNegocio": "string 28",
"CodigoPortador": "string 29",
"DescricaoPortador": "string 30",
"BloquetoImpresso": true,
"RemessaEnviada": true,
"ToleranciaVencimento": 33,
"ToleranciaMulta": 34,
"ToleranciaJuros": 35,
"ValorDesconto": 36.1,
"ValorMulta": 37.1,
"ValorJurosDia": 38.1,
"TipoJuros": "string 39",
"TipoJurosDescricao": " ",
"TipoMulta": "string 40",
"Pagamento": "string 41",
"PagamentoDescricao": " ",
"CodigoBarrasLido": "string 42",
"Previsao": true,
"LimiteMultaFracionada": 44.1,
"Sessao": 45,
"Usuario": "string 46",
"UsuarioModificacao": "string 47",
"UsuarioCriacao": "string 48",
"DiasAtrasoCalculado": 0,
"ValorAtualizadoCalculado": -18.0,
"Correlacao": " no valor de R$ 17,10 no dia 13/01/2026"
}
]