Geral ·
CategoriasCadastroCadastro de Categorias
2consultas
4alterações
Claude 6 de 6 · ChatGPT 2 de 6 · MCP 6 de 6pelos assistentes de IA
JSON · XMLformato
Alteração de categoria.
Obrigatórios 2
| Campo | Tipo | Descrição |
|---|---|---|
codigo | texto · até 20 | Código para a Categoria. Informação obrigatória para o método AlterarCategoria e AlterarGrupoCategoria. |
descricao | texto · até 50 | Descrição para a Categoria Informação obrigatória para os métodos IncluirCategoria e IncluirGrupoCategoria. |
Opcionais 4Campos e estruturas que você pode enviar
| Campo | Tipo | Descrição |
|---|---|---|
codigo_dre | texto · até 10 | Có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_inativa | texto · até 1 | Indica que a categoria ou grupo de categoria está inativo. |
natureza | texto · até 50 | Descrição da Natureza da conta. |
tipo_categoria | texto · até 3 | Tipo 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
| Campo | Tipo | Descrição |
|---|---|---|
codigo | texto | Código da categoria. |
codigo_status | texto | |
descricao_status | texto |
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": ""}]}'import os
import requests
corpo = {'call': 'AlterarCategoria',
'param': [{'codigo': '',
'descricao': '',
'natureza': '',
'tipo_categoria': '',
'codigo_dre': '',
'conta_inativa': ''}]}
resp = requests.post(
"https://app.omie.com.br/api/v1/geral/categorias/",
headers={"Authorization": f"Bearer {os.environ['TOKEN_DO_APLICATIVO']}"},
json=corpo,
timeout=60,
)
print(resp.json())const resp = await fetch("https://app.omie.com.br/api/v1/geral/categorias/", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"call": "AlterarCategoria",
"param": [
{
"codigo": "",
"descricao": "",
"natureza": "",
"tipo_categoria": "",
"codigo_dre": "",
"conta_inativa": ""
}
]
}),
});
console.log(await resp.json());<?php
$ch = curl_init("https://app.omie.com.br/api/v1/geral/categorias/");
curl_setopt_array($ch, [
CURLOPT_POST => true,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("TOKEN_DO_APLICATIVO"),
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => <<<'JSON'
{
"call": "AlterarCategoria",
"param": [
{
"codigo": "",
"descricao": "",
"natureza": "",
"tipo_categoria": "",
"codigo_dre": "",
"conta_inativa": ""
}
]
}
JSON,
]);
echo curl_exec($ch);require "net/http"
uri = URI("https://app.omie.com.br/api/v1/geral/categorias/")
corpo = <<~'JSON'
{
"call": "AlterarCategoria",
"param": [
{
"codigo": "",
"descricao": "",
"natureza": "",
"tipo_categoria": "",
"codigo_dre": "",
"conta_inativa": ""
}
]
}
JSON
resp = Net::HTTP.post(uri, corpo,
"Authorization" => "Bearer #{ENV.fetch('TOKEN_DO_APLICATIVO')}",
"Content-Type" => "application/json")
puts resp.bodyimport java.net.URI;
import java.net.http.*;
var corpo = """
{
"call": "AlterarCategoria",
"param": [
{
"codigo": "",
"descricao": "",
"natureza": "",
"tipo_categoria": "",
"codigo_dre": "",
"conta_inativa": ""
}
]
}
""";
var pedido = HttpRequest.newBuilder()
.uri(URI.create("https://app.omie.com.br/api/v1/geral/categorias/"))
.header("Authorization", "Bearer " + System.getenv("TOKEN_DO_APLICATIVO"))
.header("Content-Type", "application/json")
.POST(HttpRequest.BodyPublishers.ofString(corpo))
.build();
var resp = HttpClient.newHttpClient().send(pedido, HttpResponse.BodyHandlers.ofString());
System.out.println(resp.body());// TokenDoAplicativo: parâmetro do Power BI (Página Inicial > Gerenciar parâmetros)
let
Resposta = Web.Contents(
"https://app.omie.com.br/api/v1/geral/categorias/",
[
Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
Content = Text.ToBinary("{""call"": ""AlterarCategoria"", ""param"": [{""codigo"": """", ""descricao"": """", ""natureza"": """", ""tipo_categoria"": """", ""codigo_dre"": """", ""conta_inativa"": """"}]}")
]
),
Dados = Json.Document(Resposta)
in
DadosAlteração de um grupo totalizador de categoria.
Obrigatórios 2
| Campo | Tipo | Descrição |
|---|---|---|
codigo | texto · até 20 | Código para a Categoria. Informação obrigatória para o método AlterarCategoria e AlterarGrupoCategoria. |
descricao | texto · até 50 | Descrição para a Categoria Informação obrigatória para os métodos IncluirCategoria e IncluirGrupoCategoria. |
Opcionais 1Campos e estruturas que você pode enviar
| Campo | Tipo | Descrição |
|---|---|---|
natureza | texto · até 50 | Descrição da Natureza da conta. |
Retorno 3O que volta numa chamada bem-sucedida
| Campo | Tipo | Descrição |
|---|---|---|
codigo | texto | Código da categoria. |
codigo_status | texto | |
descricao_status | texto |
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": ""}]}'import os
import requests
corpo = {'call': 'AlterarGrupoCategoria',
'param': [{'codigo': '', 'descricao': '', 'natureza': ''}]}
resp = requests.post(
"https://app.omie.com.br/api/v1/geral/categorias/",
headers={"Authorization": f"Bearer {os.environ['TOKEN_DO_APLICATIVO']}"},
json=corpo,
timeout=60,
)
print(resp.json())const resp = await fetch("https://app.omie.com.br/api/v1/geral/categorias/", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"call": "AlterarGrupoCategoria",
"param": [
{
"codigo": "",
"descricao": "",
"natureza": ""
}
]
}),
});
console.log(await resp.json());<?php
$ch = curl_init("https://app.omie.com.br/api/v1/geral/categorias/");
curl_setopt_array($ch, [
CURLOPT_POST => true,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("TOKEN_DO_APLICATIVO"),
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => <<<'JSON'
{
"call": "AlterarGrupoCategoria",
"param": [
{
"codigo": "",
"descricao": "",
"natureza": ""
}
]
}
JSON,
]);
echo curl_exec($ch);require "net/http"
uri = URI("https://app.omie.com.br/api/v1/geral/categorias/")
corpo = <<~'JSON'
{
"call": "AlterarGrupoCategoria",
"param": [
{
"codigo": "",
"descricao": "",
"natureza": ""
}
]
}
JSON
resp = Net::HTTP.post(uri, corpo,
"Authorization" => "Bearer #{ENV.fetch('TOKEN_DO_APLICATIVO')}",
"Content-Type" => "application/json")
puts resp.bodyimport java.net.URI;
import java.net.http.*;
var corpo = """
{
"call": "AlterarGrupoCategoria",
"param": [
{
"codigo": "",
"descricao": "",
"natureza": ""
}
]
}
""";
var pedido = HttpRequest.newBuilder()
.uri(URI.create("https://app.omie.com.br/api/v1/geral/categorias/"))
.header("Authorization", "Bearer " + System.getenv("TOKEN_DO_APLICATIVO"))
.header("Content-Type", "application/json")
.POST(HttpRequest.BodyPublishers.ofString(corpo))
.build();
var resp = HttpClient.newHttpClient().send(pedido, HttpResponse.BodyHandlers.ofString());
System.out.println(resp.body());// TokenDoAplicativo: parâmetro do Power BI (Página Inicial > Gerenciar parâmetros)
let
Resposta = Web.Contents(
"https://app.omie.com.br/api/v1/geral/categorias/",
[
Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
Content = Text.ToBinary("{""call"": ""AlterarGrupoCategoria"", ""param"": [{""codigo"": """", ""descricao"": """", ""natureza"": """"}]}")
]
),
Dados = Json.Document(Resposta)
in
DadosConsulta uma categoria.
Obrigatórios 1
| Campo | Tipo | Descrição |
|---|---|---|
codigo | texto · até 20 | Código da categoria. |
Retorno 17O que volta numa chamada bem-sucedida
| Campo | Tipo | Descrição |
|---|---|---|
categoria_superior | texto | Có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". |
codigo | texto | Código para a Categoria. Informação obrigatória para o método AlterarCategoria. |
codigo_dre | texto | Có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_despesa | texto | Quando S, indica que é conta de despesa. |
conta_inativa | texto | Indica que a categoria ou grupo de categoria está inativo. |
conta_receita | texto | Quando S, indica que é conta de receita. |
dadosDRE | objeto | Detalhes da conta do DRE. |
dadosDRE.codigoDRE | texto | Código da Conta do DRE. |
dadosDRE.descricaoDRE | texto | Descrição da Conta do DRE. |
dadosDRE.naoExibirDRE | texto | Indica se a Conta está marcada para não exibir no DRE. |
dadosDRE.nivelDRE | número inteiro | Nível da Conta da DRE. |
dadosDRE.sinalDRE | texto | Sinal da Conta para o DRE. |
dadosDRE.totalizaDRE | texto | Indica se a Conta do DRE é Totalizadora. |
definida_pelo_usuario | texto | Indica que a conta financeira é definida pelo usuário. |
descricao | texto | Descrição para a Categoria Informação obrigatória para os métodos IncluirCategoria e IncluirGrupoCategoria. |
descricao_padrao | texto | Descrição Padrão para a Categoria. |
id_conta_contabil | número inteiro | ID da Conta Contábil. |
nao_exibir | texto | Indica que a Categoria não deve ser exibida em ComboBox. |
natureza | texto | Descrição da Natureza da conta, equivalente ao campo "Observação" da categoria no ERP. |
tag_conta_contabil | texto | Tag para Conta Contábil. |
tipo_categoria | texto | Tipo 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". |
totalizadora | texto | Quando S, indica que é totalizadora de conta. |
transferencia | texto | Quando 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": ""}]}'import os
import requests
corpo = {'call': 'ConsultarCategoria', 'param': [{'codigo': ''}]}
resp = requests.post(
"https://app.omie.com.br/api/v1/geral/categorias/",
headers={"Authorization": f"Bearer {os.environ['TOKEN_DO_APLICATIVO']}"},
json=corpo,
timeout=60,
)
print(resp.json())const resp = await fetch("https://app.omie.com.br/api/v1/geral/categorias/", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"call": "ConsultarCategoria",
"param": [
{
"codigo": ""
}
]
}),
});
console.log(await resp.json());<?php
$ch = curl_init("https://app.omie.com.br/api/v1/geral/categorias/");
curl_setopt_array($ch, [
CURLOPT_POST => true,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("TOKEN_DO_APLICATIVO"),
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => <<<'JSON'
{
"call": "ConsultarCategoria",
"param": [
{
"codigo": ""
}
]
}
JSON,
]);
echo curl_exec($ch);require "net/http"
uri = URI("https://app.omie.com.br/api/v1/geral/categorias/")
corpo = <<~'JSON'
{
"call": "ConsultarCategoria",
"param": [
{
"codigo": ""
}
]
}
JSON
resp = Net::HTTP.post(uri, corpo,
"Authorization" => "Bearer #{ENV.fetch('TOKEN_DO_APLICATIVO')}",
"Content-Type" => "application/json")
puts resp.bodyimport java.net.URI;
import java.net.http.*;
var corpo = """
{
"call": "ConsultarCategoria",
"param": [
{
"codigo": ""
}
]
}
""";
var pedido = HttpRequest.newBuilder()
.uri(URI.create("https://app.omie.com.br/api/v1/geral/categorias/"))
.header("Authorization", "Bearer " + System.getenv("TOKEN_DO_APLICATIVO"))
.header("Content-Type", "application/json")
.POST(HttpRequest.BodyPublishers.ofString(corpo))
.build();
var resp = HttpClient.newHttpClient().send(pedido, HttpResponse.BodyHandlers.ofString());
System.out.println(resp.body());// TokenDoAplicativo: parâmetro do Power BI (Página Inicial > Gerenciar parâmetros)
let
Resposta = Web.Contents(
"https://app.omie.com.br/api/v1/geral/categorias/",
[
Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
Content = Text.ToBinary("{""call"": ""ConsultarCategoria"", ""param"": [{""codigo"": """"}]}")
]
),
Dados = Json.Document(Resposta)
in
DadosInclusão de categoria.
Obrigatórios 2
| Campo | Tipo | Descrição |
|---|---|---|
categoria_superior | texto | Có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". |
descricao | texto · até 50 | Descrição para a Categoria Informação obrigatória para os métodos IncluirCategoria e IncluirGrupoCategoria. |
Opcionais 3Campos e estruturas que você pode enviar
| Campo | Tipo | Descrição |
|---|---|---|
codigo_dre | texto · até 10 | Có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". |
natureza | texto · até 50 | Descrição da Natureza da conta, equivalente ao campo "Observação" da categoria no ERP. |
tipo_categoria | texto · até 3 | Tipo 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
| Campo | Tipo | Descrição |
|---|---|---|
codigo | texto | Código da categoria. |
codigo_status | texto | |
descricao_status | texto |
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": ""}]}'import os
import requests
corpo = {'call': 'IncluirCategoria',
'param': [{'categoria_superior': '',
'descricao': '',
'natureza': '',
'tipo_categoria': '',
'codigo_dre': ''}]}
resp = requests.post(
"https://app.omie.com.br/api/v1/geral/categorias/",
headers={"Authorization": f"Bearer {os.environ['TOKEN_DO_APLICATIVO']}"},
json=corpo,
timeout=60,
)
print(resp.json())const resp = await fetch("https://app.omie.com.br/api/v1/geral/categorias/", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"call": "IncluirCategoria",
"param": [
{
"categoria_superior": "",
"descricao": "",
"natureza": "",
"tipo_categoria": "",
"codigo_dre": ""
}
]
}),
});
console.log(await resp.json());<?php
$ch = curl_init("https://app.omie.com.br/api/v1/geral/categorias/");
curl_setopt_array($ch, [
CURLOPT_POST => true,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("TOKEN_DO_APLICATIVO"),
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => <<<'JSON'
{
"call": "IncluirCategoria",
"param": [
{
"categoria_superior": "",
"descricao": "",
"natureza": "",
"tipo_categoria": "",
"codigo_dre": ""
}
]
}
JSON,
]);
echo curl_exec($ch);require "net/http"
uri = URI("https://app.omie.com.br/api/v1/geral/categorias/")
corpo = <<~'JSON'
{
"call": "IncluirCategoria",
"param": [
{
"categoria_superior": "",
"descricao": "",
"natureza": "",
"tipo_categoria": "",
"codigo_dre": ""
}
]
}
JSON
resp = Net::HTTP.post(uri, corpo,
"Authorization" => "Bearer #{ENV.fetch('TOKEN_DO_APLICATIVO')}",
"Content-Type" => "application/json")
puts resp.bodyimport java.net.URI;
import java.net.http.*;
var corpo = """
{
"call": "IncluirCategoria",
"param": [
{
"categoria_superior": "",
"descricao": "",
"natureza": "",
"tipo_categoria": "",
"codigo_dre": ""
}
]
}
""";
var pedido = HttpRequest.newBuilder()
.uri(URI.create("https://app.omie.com.br/api/v1/geral/categorias/"))
.header("Authorization", "Bearer " + System.getenv("TOKEN_DO_APLICATIVO"))
.header("Content-Type", "application/json")
.POST(HttpRequest.BodyPublishers.ofString(corpo))
.build();
var resp = HttpClient.newHttpClient().send(pedido, HttpResponse.BodyHandlers.ofString());
System.out.println(resp.body());// TokenDoAplicativo: parâmetro do Power BI (Página Inicial > Gerenciar parâmetros)
let
Resposta = Web.Contents(
"https://app.omie.com.br/api/v1/geral/categorias/",
[
Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
Content = Text.ToBinary("{""call"": ""IncluirCategoria"", ""param"": [{""categoria_superior"": """", ""descricao"": """", ""natureza"": """", ""tipo_categoria"": """", ""codigo_dre"": """"}]}")
]
),
Dados = Json.Document(Resposta)
in
DadosInclusão de um grupo totalizador de categoria.
Obrigatórios 2
| Campo | Tipo | Descrição |
|---|---|---|
descricao | texto · até 50 | Descrição para a Categoria Informação obrigatória para os métodos IncluirCategoria e IncluirGrupoCategoria. |
tipo_grupo | texto · até 1 | Tipo 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
| Campo | Tipo | Descrição |
|---|---|---|
natureza | texto · até 50 | Descrição da Natureza da conta. |
Retorno 3O que volta numa chamada bem-sucedida
| Campo | Tipo | Descrição |
|---|---|---|
codigo | texto | Código da categoria. |
codigo_status | texto | |
descricao_status | texto |
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": ""}]}'import os
import requests
corpo = {'call': 'IncluirGrupoCategoria',
'param': [{'descricao': '', 'tipo_grupo': '', 'natureza': ''}]}
resp = requests.post(
"https://app.omie.com.br/api/v1/geral/categorias/",
headers={"Authorization": f"Bearer {os.environ['TOKEN_DO_APLICATIVO']}"},
json=corpo,
timeout=60,
)
print(resp.json())const resp = await fetch("https://app.omie.com.br/api/v1/geral/categorias/", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"call": "IncluirGrupoCategoria",
"param": [
{
"descricao": "",
"tipo_grupo": "",
"natureza": ""
}
]
}),
});
console.log(await resp.json());<?php
$ch = curl_init("https://app.omie.com.br/api/v1/geral/categorias/");
curl_setopt_array($ch, [
CURLOPT_POST => true,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("TOKEN_DO_APLICATIVO"),
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => <<<'JSON'
{
"call": "IncluirGrupoCategoria",
"param": [
{
"descricao": "",
"tipo_grupo": "",
"natureza": ""
}
]
}
JSON,
]);
echo curl_exec($ch);require "net/http"
uri = URI("https://app.omie.com.br/api/v1/geral/categorias/")
corpo = <<~'JSON'
{
"call": "IncluirGrupoCategoria",
"param": [
{
"descricao": "",
"tipo_grupo": "",
"natureza": ""
}
]
}
JSON
resp = Net::HTTP.post(uri, corpo,
"Authorization" => "Bearer #{ENV.fetch('TOKEN_DO_APLICATIVO')}",
"Content-Type" => "application/json")
puts resp.bodyimport java.net.URI;
import java.net.http.*;
var corpo = """
{
"call": "IncluirGrupoCategoria",
"param": [
{
"descricao": "",
"tipo_grupo": "",
"natureza": ""
}
]
}
""";
var pedido = HttpRequest.newBuilder()
.uri(URI.create("https://app.omie.com.br/api/v1/geral/categorias/"))
.header("Authorization", "Bearer " + System.getenv("TOKEN_DO_APLICATIVO"))
.header("Content-Type", "application/json")
.POST(HttpRequest.BodyPublishers.ofString(corpo))
.build();
var resp = HttpClient.newHttpClient().send(pedido, HttpResponse.BodyHandlers.ofString());
System.out.println(resp.body());// TokenDoAplicativo: parâmetro do Power BI (Página Inicial > Gerenciar parâmetros)
let
Resposta = Web.Contents(
"https://app.omie.com.br/api/v1/geral/categorias/",
[
Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
Content = Text.ToBinary("{""call"": ""IncluirGrupoCategoria"", ""param"": [{""descricao"": """", ""tipo_grupo"": """", ""natureza"": """"}]}")
]
),
Dados = Json.Document(Resposta)
in
DadosLista as categorias cadastradas.
Obrigatórios 0
Nenhum campo obrigatório.
Opcionais 5Campos e estruturas que você pode enviar
| Campo | Tipo | Descrição |
|---|---|---|
descricao | texto · até 50 | |
filtrar_apenas_ativo | texto · até 1 | Filtrar apenas categorias ativas. |
filtrar_por_tipo | texto · até 1 | Filtrar categorias por tipo Pode ser: R - Receita D - Despesa Retorna apenas as categorias ativas, não totalizadoras e que estejam configuradas para serem exibidas. |
pagina | número inteiro | Número da página para resgatar os dados. |
registros_por_pagina | número inteiro | Número de registros a serem exibidos por página. Máximo 50. |
Descontinuados 3Ainda aceitos, fora do fluxo principal
| Campo | Tipo | Descrição |
|---|---|---|
apenas_importado_apidescontinuado | texto · até 1 | DEPRECATED |
ordem_descrescentedescontinuado | texto · até 1 | DEPRECATED |
ordenar_pordescontinuado | texto · até 100 | DEPRECATED |
Retorno 5O que volta numa chamada bem-sucedida
| Campo | Tipo | Descrição |
|---|---|---|
categoria_cadastro | lista de objetos | Cadastro de Categorias. |
categoria_cadastro[].categoria_superior | texto | Có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[].codigo | texto | Código para a Categoria. Informação obrigatória para o método AlterarCategoria. |
categoria_cadastro[].codigo_dre | texto | Có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_despesa | texto | Quando S, indica que é conta de despesa. |
categoria_cadastro[].conta_inativa | texto | Indica que a categoria ou grupo de categoria está inativo. |
categoria_cadastro[].conta_receita | texto | Quando S, indica que é conta de receita. |
categoria_cadastro[].dadosDRE | objeto | Detalhes da conta do DRE. |
categoria_cadastro[].dadosDRE.codigoDRE | texto | Código da Conta do DRE. |
categoria_cadastro[].dadosDRE.descricaoDRE | texto | Descrição da Conta do DRE. |
categoria_cadastro[].dadosDRE.naoExibirDRE | texto | Indica se a Conta está marcada para não exibir no DRE. |
categoria_cadastro[].dadosDRE.nivelDRE | número inteiro | Nível da Conta da DRE. |
categoria_cadastro[].dadosDRE.sinalDRE | texto | Sinal da Conta para o DRE. |
categoria_cadastro[].dadosDRE.totalizaDRE | texto | Indica se a Conta do DRE é Totalizadora. |
categoria_cadastro[].definida_pelo_usuario | texto | Indica que a conta financeira é definida pelo usuário. |
categoria_cadastro[].descricao | texto | Descrição para a Categoria Informação obrigatória para os métodos IncluirCategoria e IncluirGrupoCategoria. |
categoria_cadastro[].descricao_padrao | texto | Descrição Padrão para a Categoria. |
categoria_cadastro[].id_conta_contabil | número inteiro | ID da Conta Contábil. |
categoria_cadastro[].nao_exibir | texto | Indica que a Categoria não deve ser exibida em ComboBox. |
categoria_cadastro[].natureza | texto | Descrição da Natureza da conta, equivalente ao campo "Observação" da categoria no ERP. |
categoria_cadastro[].tag_conta_contabil | texto | Tag para Conta Contábil. |
categoria_cadastro[].tipo_categoria | texto | Tipo 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[].totalizadora | texto | Quando S, indica que é totalizadora de conta. |
categoria_cadastro[].transferencia | texto | Quando S, indica que é categoria de transferência. |
pagina | número inteiro | Número da página retornada. |
registros | número inteiro | Número de registros retornados na página. |
total_de_paginas | número inteiro | Número total de páginas. |
total_de_registros | número inteiro | Total 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": ""}]}'import os
import requests
corpo = {'call': 'ListarCategorias',
'param': [{'pagina': 1, 'registros_por_pagina': 50, 'descricao': ''}]}
resp = requests.post(
"https://app.omie.com.br/api/v1/geral/categorias/",
headers={"Authorization": f"Bearer {os.environ['TOKEN_DO_APLICATIVO']}"},
json=corpo,
timeout=60,
)
print(resp.json())const resp = await fetch("https://app.omie.com.br/api/v1/geral/categorias/", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"call": "ListarCategorias",
"param": [
{
"pagina": 1,
"registros_por_pagina": 50,
"descricao": ""
}
]
}),
});
console.log(await resp.json());<?php
$ch = curl_init("https://app.omie.com.br/api/v1/geral/categorias/");
curl_setopt_array($ch, [
CURLOPT_POST => true,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("TOKEN_DO_APLICATIVO"),
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => <<<'JSON'
{
"call": "ListarCategorias",
"param": [
{
"pagina": 1,
"registros_por_pagina": 50,
"descricao": ""
}
]
}
JSON,
]);
echo curl_exec($ch);require "net/http"
uri = URI("https://app.omie.com.br/api/v1/geral/categorias/")
corpo = <<~'JSON'
{
"call": "ListarCategorias",
"param": [
{
"pagina": 1,
"registros_por_pagina": 50,
"descricao": ""
}
]
}
JSON
resp = Net::HTTP.post(uri, corpo,
"Authorization" => "Bearer #{ENV.fetch('TOKEN_DO_APLICATIVO')}",
"Content-Type" => "application/json")
puts resp.bodyimport java.net.URI;
import java.net.http.*;
var corpo = """
{
"call": "ListarCategorias",
"param": [
{
"pagina": 1,
"registros_por_pagina": 50,
"descricao": ""
}
]
}
""";
var pedido = HttpRequest.newBuilder()
.uri(URI.create("https://app.omie.com.br/api/v1/geral/categorias/"))
.header("Authorization", "Bearer " + System.getenv("TOKEN_DO_APLICATIVO"))
.header("Content-Type", "application/json")
.POST(HttpRequest.BodyPublishers.ofString(corpo))
.build();
var resp = HttpClient.newHttpClient().send(pedido, HttpResponse.BodyHandlers.ofString());
System.out.println(resp.body());// TokenDoAplicativo: parâmetro do Power BI (Página Inicial > Gerenciar parâmetros)
let
Resposta = Web.Contents(
"https://app.omie.com.br/api/v1/geral/categorias/",
[
Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
Content = Text.ToBinary("{""call"": ""ListarCategorias"", ""param"": [{""pagina"": 1, ""registros_por_pagina"": 50, ""descricao"": """"}]}")
]
),
Dados = Json.Document(Resposta)
in
Dados