OpenAPITodas as operações em OpenAPI (Postman, Insomnia).
Finanças · ResumoFinancas

Resumo das finanças

POSThttps://app.omie.com.br/api/v1/financas/resumo/WSDL
4consultas
0alterações
Claude 4 de 4 · ChatGPT 1 de 4 · MCP 4 de 4pelos assistentes de IA
JSON · XMLformato

ObterDetalhesLancamento

consultaClaudeMCP

Detalhes do lançamento em aberto.

Obrigatórios 1

CampoTipoDescrição
nIdTitulonúmero inteiroInforme aqui o código da conta pagar ou receber.
Opcionais 1Campos e estruturas que você pode enviar
CampoTipoDescrição
cIncluirTarefastexto · até 1Indica se deve incluir as tarefas vinculadas ao lançamento no retorno (S/N). Como default é "N".Ex.: S, N
Retorno 26O que volta numa chamada bem-sucedida
CampoTipoDescrição
boletoInfoobjetoDetalhes do boleto gerado. Retornado apenas para contas a receber.
boletoInfo.cCodBarrastextoCódigo de barras do boleto.
boletoInfo.cLinkBoletotextoLink do boleto.
boletoInfo.cNumBancariotextoNosso número impresso no boleto (formatado).
boletoInfo.cNumBoletotextoNosso número (sequencial).
boletoInfo.dEmissaotextoData de emissão.
boletoInfo.dVencimentotextoData de vencimento.
boletoInfo.nPerJurosdecimalPercentual de juros ao mês.
boletoInfo.nPerMultadecimalPercentual de multa.
cBolGeradotextoIndica se o boleto foi gerado. Retornado apenas para contas a receber.
cBolPodeGerartextoIndica se o boleto pode ser gerado. (S/N) Retornado apenas para contas a receber.
cCodCategtextoCódigo da Categoria
cCortexto
cDescCategtextoDescrição da categoria.
cDescCtaCorrtextoDescrição da conta corrente.
cIconetexto
cNomeClientetextoNome do Cliente ou Fornecedor.
cPixGeradotextoIndica se o PIX foi gerado. Retornado apenas para contas a receber.
cPixPodeGerartextoIndica se o PIX pode ser gerado. (S/N) Retornado apenas para contas a receber.
cSituacaotextoSituação do lançamento. Ex: Atrasado desde 30/10 Qua
cTipoLanctextoTipo do lançamento retornado. P - Lançamento a Pagar R - Lançamento a Receber
cUrlLogoBancotextoURL da Imagem do Logo do Banco.
dEmissaotextoData de emissão do lançamento.
dPrevisaotextoData de previsão do lançamento.
dVencimentotextoData de vencimento do lançamento.
listaAnexoslista de objetosLista de anexos do lançamento.
listaAnexos[].cCodIntAnexotextoCódigo de integração do anexo. (Interno, utilizado apenas na integração via API, não é exibido na tela). Utilize esse campo para informar o código do anexo utilizado no seu aplicativo quando incluir o anexo no Omie. Assim, poderá utilizar esse campo para resgatar o anexo desejado.
listaAnexos[].cNomeArquivotextoNome do arquivo que foi adicionado. Preencha essa tag, apenas se você não tiver ou souber qual é o código de integração do anexo (tag cCodIntAnexo). Caso a tag cCodIntAnexo esteja preenchida, o conteúdo dessa tag será desconsiderado.
listaAnexos[].cTabelatextoNome da tabela onde o anexo está incluído. Pode ser: conta-pagar conta-receber
listaAnexos[].cTipoArquivotextoTipo de arquivo.
listaAnexos[].nIdAnexonúmero inteiroID do anexo. Gerado automático na inclusão. Informe esse campo para Obter, Consultar e Excluir o anexo.
listaTarefaslista de objetosLista com as tarefas relacionadas ao lançamento. Retornado quando preenchida a tag "cIncluirTarefas" como "S".
listaTarefas[].cCodIntTarefatexto
listaTarefas[].cDescricaotextoDescrição da tarefa.
listaTarefas[].cNomeUserAtbtexto
listaTarefas[].dDatatexto
listaTarefas[].hHoratexto
listaTarefas[].nCodDocnúmero inteiroId do documento vinculado a tarefa. Esse campo varia conforme a origem da tarefa. Ele permite vincular a tarefa a um documento específico, seja ele relacionado a uma oportunidade, contas a pagar, contas a receber, entre outros. Exemplo: Se a origem da tarefa for "pedido-compra", esse campo reflete o código do pedido de compra. Se a origem da tarefa for "contas-receber", esse campo reflete o código da conta a receber.
listaTarefas[].nCodTarefanúmero inteiroCódigo único da tarefa.
listaTarefas[].nCodUserAtbnúmero inteiroCódigo do usuário atribuído.
nDiasAtrasodecimalDias de atraso do lançamento.
nIdClientenúmero inteiroCódigo do cliente ou Fornecedor. (Gerado internamente, não é visualizado na tela)
nIdTitulonúmero inteiroCódigo do lançamento. (Gerado internamente, não é visualizado na tela)
nQtdeAnexosnúmero inteiroIndica a quantidade de anexos.
nQtdeTarefasnúmero inteiroIndica a quantidade de tarefas.
pixInfoobjetoDetalhes do boleto gerado. Retornado apenas para contas a receber.
pixInfo.cCodIntPixtextoCódigo do lançamento gerado pelo integrador.
pixInfo.cCopiaColatextoCódigo gerado a partir do QR Code para pagamento do PIX.
pixInfo.cStatustextoStatus do PIX na API do banco.
pixInfo.cUrlPixtextoLink para obter o PDF do QrCode do PIX.
pixInfo.dEmissaotextoData de emissão.
pixInfo.dVencimentotextoData de vencimento.
pixInfo.nIdPixnúmero inteiroID do lançamento PIX. O conteúdo desse campo é o código interno gerado pelo Omie ao gerar o PIX. Esse campo não é exibido na tela do Omie, mas é a chave de integração via API. É uma informação interna, utilizada apenas nas APIs.
pixInfo.vValordecimalValor do PIX.
vDocdecimalValor do lançamento.
POST /api/v1/financas/resumo/
curl -s https://app.omie.com.br/api/v1/financas/resumo/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "ObterDetalhesLancamento", "param": [{"nIdTitulo": 0}]}'

ObterListaEmAberto

consultaClaudeMCP

Lista de lançamentos em aberto.

Obrigatórios 1

CampoTipoDescrição
cTipotexto · até 1Informe aqui o tipo de Lançamento. Pode ser: P - Lançamentos a Pagar. R - Lançamentos a Receber.Ex.: P, R
Opcionais 5Campos e estruturas que você pode enviar
CampoTipoDescrição
cNomeClientetexto · até 100Nome do Cliente ou Fornecedor.
dDiatexto · até 10Informe aqui a data de registro para listar os lançamentos. Default data atual.
nCodClientenúmero inteiro
nPaginanúmero inteiroNúmero da página para resgatar os dados.
nRegPorPaginanúmero inteiroNúmero de registros a serem exibidos por página.
Retorno 5O que volta numa chamada bem-sucedida
CampoTipoDescrição
ListaEmEbertolista de objetosLista de Lançamentos em aberto.
ListaEmEberto[].cBolGeradotextoIndica se o boleto foi gerado. Retornado apenas para contas a receber.
ListaEmEberto[].cBolPodeGerartextoIndica se o boleto pode ser gerado. (S/N) Retornado apenas para contas a receber.
ListaEmEberto[].cCodCategtextoCódigo da Categoria
ListaEmEberto[].cCortexto
ListaEmEberto[].cDescCategtextoDescrição da categoria.
ListaEmEberto[].cIconetexto
ListaEmEberto[].cNomeClientetextoNome do Cliente ou Fornecedor.
ListaEmEberto[].cPixGeradotextoIndica se o PIX foi gerado. Retornado apenas para contas a receber.
ListaEmEberto[].cPixPodeGerartextoIndica se o PIX pode ser gerado. (S/N) Retornado apenas para contas a receber.
ListaEmEberto[].cUrlLogoBancotextoURL da Imagem do Logo do Banco.
ListaEmEberto[].dEmissaotextoData de emissão do lançamento.
ListaEmEberto[].dVencimentotextoData de vencimento do lançamento.
ListaEmEberto[].nDiasAtrasodecimalDias de atraso do lançamento.
ListaEmEberto[].nIdClientenúmero inteiroCódigo do cliente ou Fornecedor. (Gerado internamente, não é visualizado na tela)
ListaEmEberto[].nIdTitulonúmero inteiroCódigo do lançamento. (Gerado internamente, não é visualizado na tela)
ListaEmEberto[].nQtdeAnexosnúmero inteiroIndica a quantidade de anexos.
ListaEmEberto[].nQtdeTarefasnúmero inteiroIndica a quantidade de tarefas.
ListaEmEberto[].vDocdecimalValor do lançamento.
nPaginanúmero inteiro
nRegistrosnúmero inteiro
nTotPaginasnúmero inteiro
nTotRegistrosnúmero inteiro
POST /api/v1/financas/resumo/
curl -s https://app.omie.com.br/api/v1/financas/resumo/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "ObterListaEmAberto", "param": [{"dDia": "30/09/2026", "cTipo": "P", "nPagina": 1, "nRegPorPagina": 50}]}'

ObterListaFinancas

consultaClaudeMCP

Obtém a lista de lançamentos.

Obrigatórios 2

CampoTipoDescrição
cCodCategtexto · até 20Informe aqui o código da categoria de acordo com o preenchimento da tag "cTipo". Para lançamentos a pagar ("cTipo" = "P") você deve informar uma categoria do tipo Despesa e para lançamentos a receber ("cTipo" = "R") deve informar uma categoria do tipo Receita. Utilize a tag "codigo" do método "ListarCategorias" da API /api/v1/geral/categorias/ para obter essa informação.
cTipotexto · até 1Informe aqui o tipo de Lançamento. Pode ser: P - Lançamentos a Pagar. R - Lançamentos a Receber.Ex.: P, R
Opcionais 1Campos e estruturas que você pode enviar
CampoTipoDescrição
dDiatexto · até 10Informe aqui a data de registro para listar os lançamentos. Default data atual.
Retorno 1O que volta numa chamada bem-sucedida
CampoTipoDescrição
listaDetalhesFinancaslista de objetosLista de Lançamentos.
listaDetalhesFinancas[].cNomeClientetextoNome do Cliente ou Fornecedor.
listaDetalhesFinancas[].cNomeContatextoNome da Conta Corrente.
listaDetalhesFinancas[].cNumDocumentotextoNúmero do documento.
listaDetalhesFinancas[].cNumDocumentoFiscaltextoNúmero do Documento fiscal.
listaDetalhesFinancas[].dEmissaotextoData de emissão do lançamento.
listaDetalhesFinancas[].dPrevisaotextoData de previsão do Lançamento.
listaDetalhesFinancas[].dVencimentotextoData de vencimento do lançamento.
listaDetalhesFinancas[].nIdClientenúmero inteiroCódigo do cliente ou Fornecedor. (Gerado internamente, não é visualizado na tela)
listaDetalhesFinancas[].nIdContanúmero inteiroCódigo da Conta Corrente. (Gerado internamente, não é visualizado na tela)
listaDetalhesFinancas[].nIdTitulonúmero inteiroCódigo do lançamento. (Gerado internamente, não é visualizado na tela)
listaDetalhesFinancas[].vDocdecimalValor do lançamento.
POST /api/v1/financas/resumo/
curl -s https://app.omie.com.br/api/v1/financas/resumo/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "ObterListaFinancas", "param": [{"dDia": "30/09/2026", "cCodCateg": "1.01.01", "cTipo": "R"}]}'

ObterResumoFinancas

consultaClaudeChatGPTMCP

Obtém o resumo das finanças.

Obrigatórios 0

Nenhum campo obrigatório.

Opcionais 3Campos e estruturas que você pode enviar
CampoTipoDescrição
dDiatexto · até 10Data da Consulta.Ex.: 18/06/2026
lApenasResumosim/nãoExibir apenas o resumo. Quando true será retornado as estruturas: contaCorrente contaPagar contaReceber Quando false retornará todas as estruturas. Default = true
lExibirCategoriasim/nãoExibir os valores dos lançamentos por categoria. Quando true será retornado as estruturas: contaPagarCategoria contaReceberCategoria Default = true
Retorno 9O que volta numa chamada bem-sucedida
CampoTipoDescrição
contaCorrenteobjetoExibe o total de saldo das contas correntes.
contaCorrente.cCortexto
contaCorrente.cIconetexto
contaCorrente.vLimiteCreditodecimalValor total Saldo + Limite de Crédito.
contaCorrente.vTotaldecimalValor total.
contaPagarobjetoExibe os totais dos lançamentos a pagar.
contaPagar.cCortexto
contaPagar.cIconetexto
contaPagar.nTotaldecimalQuantidade de lançamentos.
contaPagar.vAtrasodecimalValor total dos lançamentos em atraso.
contaPagar.vTotaldecimalValor total dos lançamentos.
contaPagarAtrasolista de objetosExibe os lançamentos a pagar atrasados.
contaPagarAtraso[].cCodCategtextoCódigo da Categoria
contaPagarAtraso[].cCortexto
contaPagarAtraso[].cDescCategtextoDescrição da categoria.
contaPagarAtraso[].cIconetexto
contaPagarAtraso[].cNomeClientetextoNome do Cliente ou Fornecedor.
contaPagarAtraso[].cUrlLogoBancotextoURL da Imagem do Logo do Banco.
contaPagarAtraso[].dEmissaotextoData de emissão do lançamento.
contaPagarAtraso[].dVencimentotextoData de vencimento do lançamento.
contaPagarAtraso[].nDiasAtrasodecimalDias de atraso do lançamento.
contaPagarAtraso[].nIdClientenúmero inteiroCódigo do cliente ou Fornecedor. (Gerado internamente, não é visualizado na tela)
contaPagarAtraso[].nIdTitulonúmero inteiroCódigo do lançamento. (Gerado internamente, não é visualizado na tela)
contaPagarAtraso[].vDocdecimalValor do lançamento.
contaPagarCategorialista de objetosExibe os totais por categoria dos lançamentos a pagar.
contaPagarCategoria[].cCodCategtextoCódigo da Categoria
contaPagarCategoria[].cCortexto
contaPagarCategoria[].cDescCategtextoDescrição da categoria.
contaPagarCategoria[].cIconetexto
contaPagarCategoria[].nTotaldecimalQuantidade total de lançamentos.
contaPagarCategoria[].vTotaldecimalValor total.
contaReceberobjetoExibe os totais dos lançamentos a receber.
contaReceber.cCortexto
contaReceber.cIconetexto
contaReceber.nTotaldecimalQuantidade de lançamentos.
contaReceber.vAtrasodecimalValor total dos lançamentos em atraso.
contaReceber.vTotaldecimalValor total dos lançamentos.
contaReceberAtrasolista de objetosExibe os lançamentos a receber atrasados.
contaReceberAtraso[].cCodCategtextoCódigo da Categoria
contaReceberAtraso[].cCortexto
contaReceberAtraso[].cDescCategtextoDescrição da categoria.
contaReceberAtraso[].cIconetexto
contaReceberAtraso[].cNomeClientetextoNome do Cliente ou Fornecedor.
contaReceberAtraso[].cUrlLogoBancotextoURL da Imagem do Logo do Banco.
contaReceberAtraso[].dEmissaotextoData de emissão do lançamento.
contaReceberAtraso[].dVencimentotextoData de vencimento do lançamento.
contaReceberAtraso[].nDiasAtrasodecimalDias de atraso do lançamento.
contaReceberAtraso[].nIdClientenúmero inteiroCódigo do cliente ou Fornecedor. (Gerado internamente, não é visualizado na tela)
contaReceberAtraso[].nIdTitulonúmero inteiroCódigo do lançamento. (Gerado internamente, não é visualizado na tela)
contaReceberAtraso[].vDocdecimalValor do lançamento.
contaReceberCategorialista de objetosExibe os totais por categoria dos lançamentos a receber.
contaReceberCategoria[].cCodCategtextoCódigo da Categoria
contaReceberCategoria[].cCortexto
contaReceberCategoria[].cDescCategtextoDescrição da categoria.
contaReceberCategoria[].cIconetexto
contaReceberCategoria[].nTotaldecimalQuantidade total de lançamentos.
contaReceberCategoria[].vTotaldecimalValor total.
dDiatextoData da Consulta.
fluxoCaixaobjetoExibe as informações de resumo do caixa.
fluxoCaixa.dDiatextoData da Consulta.
fluxoCaixa.vPagardecimalValor total de títulos a pagar.
fluxoCaixa.vReceberdecimalValor total de títulos a receber.
fluxoCaixa.vSaldodecimalValor total do saldo bancário.
POST /api/v1/financas/resumo/
curl -s https://app.omie.com.br/api/v1/financas/resumo/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "ObterResumoFinancas", "param": [{"dDia": "30/09/2026", "lApenasResumo": true}]}'