OpenAPITodas as operações em OpenAPI (Postman, Insomnia).
Geral · CategoriasCadastro

Cadastro de Categorias

POSThttps://app.omie.com.br/api/v1/geral/categorias/WSDL
2consultas
4alterações
Claude 6 de 6 · ChatGPT 2 de 6 · MCP 6 de 6pelos assistentes de IA
JSON · XMLformato

AlterarCategoria

altera dadosClaudeMCP

Alteração de categoria.

Obrigatórios 2

CampoTipoDescrição
codigotexto · até 20Código para a Categoria. Informação obrigatória para o método AlterarCategoria e AlterarGrupoCategoria.
descricaotexto · até 50Descrição para a Categoria Informação obrigatória para os métodos IncluirCategoria e IncluirGrupoCategoria.
Opcionais 4Campos e estruturas que você pode enviar
CampoTipoDescrição
codigo_dretexto · até 10Código no DRE (Demonstrativo de Resultados do Exercício) Essa informação pode ser obtida pela API: /api/v1/geral/dre/ Utilizando o método ListarCadastroDRE, o código é retornado na tag "codigoDRE" Para que esse código seja válido, é necessário que: - "nivelDRE" seja igual a 3 - "naoExibirDRE" seja igual a "N" - "totalizaDRE" seja igual a "N".
conta_inativatexto · até 1Indica que a categoria ou grupo de categoria está inativo.
naturezatexto · até 50Descrição da Natureza da conta.
tipo_categoriatexto · até 3Tipo de gasto/receita realizado com esta categoria Essa informação pode ser obtida pela API: /api/v1/geral/tipocategoria/ Utilizando o método ListarTipoCategoria, o código é retornado na tag "cCodigo" Para que esse código seja válido, é necessário que: Inclusão: - "categoria_superior" começar com "1", então "cTipo" deve ser igual a "R" - "categoria_superior" começar com "2", então "cTipo" deve ser igual a "P" Alteração: - "codigo" começar com "1", então "cTipo" deve ser igual a "R" - "codigo" começar com "2", então "cTipo" deve ser igual a "P".
Retorno 3O que volta numa chamada bem-sucedida
CampoTipoDescrição
codigotextoCódigo da categoria.
codigo_statustexto
descricao_statustexto
POST /api/v1/geral/categorias/
curl -s https://app.omie.com.br/api/v1/geral/categorias/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "AlterarCategoria", "param": [{"codigo": "", "descricao": "", "natureza": "", "tipo_categoria": "", "codigo_dre": "", "conta_inativa": ""}]}'

AlterarGrupoCategoria

altera dadosClaudeMCP

Alteração de um grupo totalizador de categoria.

Obrigatórios 2

CampoTipoDescrição
codigotexto · até 20Código para a Categoria. Informação obrigatória para o método AlterarCategoria e AlterarGrupoCategoria.
descricaotexto · até 50Descrição para a Categoria Informação obrigatória para os métodos IncluirCategoria e IncluirGrupoCategoria.
Opcionais 1Campos e estruturas que você pode enviar
CampoTipoDescrição
naturezatexto · até 50Descrição da Natureza da conta.
Retorno 3O que volta numa chamada bem-sucedida
CampoTipoDescrição
codigotextoCódigo da categoria.
codigo_statustexto
descricao_statustexto
POST /api/v1/geral/categorias/
curl -s https://app.omie.com.br/api/v1/geral/categorias/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "AlterarGrupoCategoria", "param": [{"codigo": "", "descricao": "", "natureza": ""}]}'

ConsultarCategoria

consultaClaudeMCP

Consulta uma categoria.

Obrigatórios 1

CampoTipoDescrição
codigotexto · até 20Código da categoria.
Retorno 17O que volta numa chamada bem-sucedida
CampoTipoDescrição
categoria_superiortextoCódigo do grupo da categoria Para inclusão essa informação pode ser obtida pela API: /api/v1/geral/categorias/ Utilizando o método ListarCategorias, o código é retornado na tag "codigo" Para que esse código seja válido, é necessário que: - "codigo" tenha 4 dígitos - "totalizadora" deve ser igual a "S".
codigotextoCódigo para a Categoria. Informação obrigatória para o método AlterarCategoria.
codigo_dretextoCódigo no DRE (Demonstrativo de Resultados do Exercício) Para inclusão ou alteração essa informação pode ser obtida pela API: /api/v1/geral/dre/ Utilizando o método ListarCadastroDRE, o código é retornado na tag "codigoDRE" Para que esse código seja válido, é necessário que: - "nivelDRE" seja igual a 3 - "naoExibirDRE" seja igual a "N" - "totalizaDRE" seja igual a "N".
conta_despesatextoQuando S, indica que é conta de despesa.
conta_inativatextoIndica que a categoria ou grupo de categoria está inativo.
conta_receitatextoQuando S, indica que é conta de receita.
dadosDREobjetoDetalhes da conta do DRE.
dadosDRE.codigoDREtextoCódigo da Conta do DRE.
dadosDRE.descricaoDREtextoDescrição da Conta do DRE.
dadosDRE.naoExibirDREtextoIndica se a Conta está marcada para não exibir no DRE.
dadosDRE.nivelDREnúmero inteiroNível da Conta da DRE.
dadosDRE.sinalDREtextoSinal da Conta para o DRE.
dadosDRE.totalizaDREtextoIndica se a Conta do DRE é Totalizadora.
definida_pelo_usuariotextoIndica que a conta financeira é definida pelo usuário.
descricaotextoDescrição para a Categoria Informação obrigatória para os métodos IncluirCategoria e IncluirGrupoCategoria.
descricao_padraotextoDescrição Padrão para a Categoria.
id_conta_contabilnúmero inteiroID da Conta Contábil.
nao_exibirtextoIndica que a Categoria não deve ser exibida em ComboBox.
naturezatextoDescrição da Natureza da conta, equivalente ao campo "Observação" da categoria no ERP.
tag_conta_contabiltextoTag para Conta Contábil.
tipo_categoriatextoTipo de gasto/receita realizado com esta categoria Para inclusão ou alteração essa informação pode ser obtida pela API: /api/v1/geral/tipocategoria/ Utilizando o método ListarTipoCategoria, o código é retornado na tag "cCodigo" Para que esse código seja válido, é necessário que: Inclusão: - "categoria_superior" começar com "1", então "cTipo" deve ser igual a "R" - "categoria_superior" começar com "2", então "cTipo" deve ser igual a "P" Alteração: - "codigo" começar com "1", então "cTipo" deve ser igual a "R" - "codigo" começar com "2", então "cTipo" deve ser igual a "P".
totalizadoratextoQuando S, indica que é totalizadora de conta.
transferenciatextoQuando S, indica que é categoria de transferência.
POST /api/v1/geral/categorias/
curl -s https://app.omie.com.br/api/v1/geral/categorias/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "ConsultarCategoria", "param": [{"codigo": ""}]}'

IncluirCategoria

altera dadosClaudeChatGPTMCP

Inclusão de categoria.

Obrigatórios 2

CampoTipoDescrição
categoria_superiortextoCódigo do grupo da categoria Para inclusão essa informação pode ser obtida pela API: /api/v1/geral/categorias/ Utilizando o método ListarCategorias, o código é retornado na tag "codigo" Para que esse código seja válido, é necessário que: - "codigo" tenha 4 dígitos - "totalizadora" deve ser igual a "S".
descricaotexto · até 50Descrição para a Categoria Informação obrigatória para os métodos IncluirCategoria e IncluirGrupoCategoria.
Opcionais 3Campos e estruturas que você pode enviar
CampoTipoDescrição
codigo_dretexto · até 10Código no DRE (Demonstrativo de Resultados do Exercício) Essa informação pode ser obtida pela API: /api/v1/geral/dre/ Utilizando o método ListarCadastroDRE, o código é retornado na tag "codigoDRE" Para que esse código seja válido, é necessário que: - "nivelDRE" seja igual a 3 - "naoExibirDRE" seja igual a "N" - "totalizaDRE" seja igual a "N".
naturezatexto · até 50Descrição da Natureza da conta, equivalente ao campo "Observação" da categoria no ERP.
tipo_categoriatexto · até 3Tipo de gasto/receita realizado com esta categoria Essa informação pode ser obtida pela API: /api/v1/geral/tipocategoria/ Utilizando o método ListarTipoCategoria, o código é retornado na tag "cCodigo" Para que esse código seja válido, é necessário que: Inclusão: - "categoria_superior" começar com "1", então "cTipo" deve ser igual a "R" - "categoria_superior" começar com "2", então "cTipo" deve ser igual a "P" Alteração: - "codigo" começar com "1", então "cTipo" deve ser igual a "R" - "codigo" começar com "2", então "cTipo" deve ser igual a "P".
Retorno 3O que volta numa chamada bem-sucedida
CampoTipoDescrição
codigotextoCódigo da categoria.
codigo_statustexto
descricao_statustexto
POST /api/v1/geral/categorias/
curl -s https://app.omie.com.br/api/v1/geral/categorias/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "IncluirCategoria", "param": [{"categoria_superior": "", "descricao": "", "natureza": "", "tipo_categoria": "", "codigo_dre": ""}]}'

IncluirGrupoCategoria

altera dadosClaudeMCP

Inclusão de um grupo totalizador de categoria.

Obrigatórios 2

CampoTipoDescrição
descricaotexto · até 50Descrição para a Categoria Informação obrigatória para os métodos IncluirCategoria e IncluirGrupoCategoria.
tipo_grupotexto · até 1Tipo de grupo de categorias ( R = Receita ou D = Despesa ). Informação obrigatória para o método IncluirGrupoCategoria.
Opcionais 1Campos e estruturas que você pode enviar
CampoTipoDescrição
naturezatexto · até 50Descrição da Natureza da conta.
Retorno 3O que volta numa chamada bem-sucedida
CampoTipoDescrição
codigotextoCódigo da categoria.
codigo_statustexto
descricao_statustexto
POST /api/v1/geral/categorias/
curl -s https://app.omie.com.br/api/v1/geral/categorias/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "IncluirGrupoCategoria", "param": [{"descricao": "", "tipo_grupo": "", "natureza": ""}]}'

ListarCategorias

consultaClaudeChatGPTMCP

Lista as categorias cadastradas.

Obrigatórios 0

Nenhum campo obrigatório.

Opcionais 5Campos e estruturas que você pode enviar
CampoTipoDescrição
descricaotexto · até 50
filtrar_apenas_ativotexto · até 1Filtrar apenas categorias ativas.
filtrar_por_tipotexto · até 1Filtrar categorias por tipo Pode ser: R - Receita D - Despesa Retorna apenas as categorias ativas, não totalizadoras e que estejam configuradas para serem exibidas.
paginanúmero inteiroNúmero da página para resgatar os dados.
registros_por_paginanúmero inteiroNúmero de registros a serem exibidos por página. Máximo 50.
Descontinuados 3Ainda aceitos, fora do fluxo principal
CampoTipoDescrição
apenas_importado_apidescontinuadotexto · até 1DEPRECATED
ordem_descrescentedescontinuadotexto · até 1DEPRECATED
ordenar_pordescontinuadotexto · até 100DEPRECATED
Retorno 5O que volta numa chamada bem-sucedida
CampoTipoDescrição
categoria_cadastrolista de objetosCadastro de Categorias.
categoria_cadastro[].categoria_superiortextoCódigo do grupo da categoria Para inclusão essa informação pode ser obtida pela API: /api/v1/geral/categorias/ Utilizando o método ListarCategorias, o código é retornado na tag "codigo" Para que esse código seja válido, é necessário que: - "codigo" tenha 4 dígitos - "totalizadora" deve ser igual a "S".
categoria_cadastro[].codigotextoCódigo para a Categoria. Informação obrigatória para o método AlterarCategoria.
categoria_cadastro[].codigo_dretextoCódigo no DRE (Demonstrativo de Resultados do Exercício) Para inclusão ou alteração essa informação pode ser obtida pela API: /api/v1/geral/dre/ Utilizando o método ListarCadastroDRE, o código é retornado na tag "codigoDRE" Para que esse código seja válido, é necessário que: - "nivelDRE" seja igual a 3 - "naoExibirDRE" seja igual a "N" - "totalizaDRE" seja igual a "N".
categoria_cadastro[].conta_despesatextoQuando S, indica que é conta de despesa.
categoria_cadastro[].conta_inativatextoIndica que a categoria ou grupo de categoria está inativo.
categoria_cadastro[].conta_receitatextoQuando S, indica que é conta de receita.
categoria_cadastro[].dadosDREobjetoDetalhes da conta do DRE.
categoria_cadastro[].dadosDRE.codigoDREtextoCódigo da Conta do DRE.
categoria_cadastro[].dadosDRE.descricaoDREtextoDescrição da Conta do DRE.
categoria_cadastro[].dadosDRE.naoExibirDREtextoIndica se a Conta está marcada para não exibir no DRE.
categoria_cadastro[].dadosDRE.nivelDREnúmero inteiroNível da Conta da DRE.
categoria_cadastro[].dadosDRE.sinalDREtextoSinal da Conta para o DRE.
categoria_cadastro[].dadosDRE.totalizaDREtextoIndica se a Conta do DRE é Totalizadora.
categoria_cadastro[].definida_pelo_usuariotextoIndica que a conta financeira é definida pelo usuário.
categoria_cadastro[].descricaotextoDescrição para a Categoria Informação obrigatória para os métodos IncluirCategoria e IncluirGrupoCategoria.
categoria_cadastro[].descricao_padraotextoDescrição Padrão para a Categoria.
categoria_cadastro[].id_conta_contabilnúmero inteiroID da Conta Contábil.
categoria_cadastro[].nao_exibirtextoIndica que a Categoria não deve ser exibida em ComboBox.
categoria_cadastro[].naturezatextoDescrição da Natureza da conta, equivalente ao campo "Observação" da categoria no ERP.
categoria_cadastro[].tag_conta_contabiltextoTag para Conta Contábil.
categoria_cadastro[].tipo_categoriatextoTipo de gasto/receita realizado com esta categoria Para inclusão ou alteração essa informação pode ser obtida pela API: /api/v1/geral/tipocategoria/ Utilizando o método ListarTipoCategoria, o código é retornado na tag "cCodigo" Para que esse código seja válido, é necessário que: Inclusão: - "categoria_superior" começar com "1", então "cTipo" deve ser igual a "R" - "categoria_superior" começar com "2", então "cTipo" deve ser igual a "P" Alteração: - "codigo" começar com "1", então "cTipo" deve ser igual a "R" - "codigo" começar com "2", então "cTipo" deve ser igual a "P".
categoria_cadastro[].totalizadoratextoQuando S, indica que é totalizadora de conta.
categoria_cadastro[].transferenciatextoQuando S, indica que é categoria de transferência.
paginanúmero inteiroNúmero da página retornada.
registrosnúmero inteiroNúmero de registros retornados na página.
total_de_paginasnúmero inteiroNúmero total de páginas.
total_de_registrosnúmero inteiroTotal de registros encontrados.
POST /api/v1/geral/categorias/
curl -s https://app.omie.com.br/api/v1/geral/categorias/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "ListarCategorias", "param": [{"pagina": 1, "registros_por_pagina": 50, "descricao": ""}]}'