Geral ·
DocumentoAnexoAdicionar anexos as tabelas do sistema
3consultas
2alterações
Claude · MCPpelos assistentes de IA
JSON · XMLformato
Consulta os dados de um anexo vinculado a um documento.
Obrigatórios 2
| Campo | Tipo | Descrição |
|---|---|---|
cTabela | texto · até 100 | Nome da tabela onde o anexo está incluído.
Pode ser:
cliente
produto
servico
pedido-venda
remessa-produto
ordem-servico
contrato-servico
pedido-compra
nota-entrada
ordem-producao
conta-pagar
conta-receber
conta-corrente
conta-corrente-lancamento
crm-contas
crm-contatos
crm-oportunidades
com-recebimentoEx.: cliente, produto, servico |
nId | número inteiro | ID do documento de acordo com a tabela especificada. Por exemplo: Caso você informe "cliente" na tag "cTabela" você deve informar o ID do cliente neste campo. |
Opcionais 3Campos e estruturas que você pode enviar
| Campo | Tipo | Descrição |
|---|---|---|
cCodIntAnexo | texto · até 20 | Có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. |
cNomeArquivo | texto · até 100 | Nome do arquivo do anexo. |
nIdAnexo | número inteiro | ID do anexo. Gerado automático na inclusão. Informe esse campo para Obter, Consultar e Excluir o anexo. |
Retorno 7O que volta numa chamada bem-sucedida
| Campo | Tipo | Descrição |
|---|---|---|
cCodIntAnexo | texto | Có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. |
cNomeArquivo | texto | Nome 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. |
cTabela | texto | Nome da tabela onde o anexo está incluído. Pode ser: cliente produto servico pedido-venda remessa-produto ordem-servico contrato-servico pedido-compra nota-entrada ordem-producao conta-pagar conta-receber conta-corrente conta-corrente-lancamento crm-contas crm-contatos crm-oportunidades com-recebimento |
cTipoArquivo | texto | Tipo de Arquivo. |
info | objeto | Informações complementares do anexo. |
info.cImpAPI | texto | Importado pela API (S/N). |
info.dAlt | texto | Data da Alteração. No formato dd/mm/aaaa. |
info.dInc | texto | Data da Inclusão. No formato dd/mm/aaaa. |
info.hAlt | texto | Hora da Alteração. No formato hh:mm:ss. |
info.hInc | texto | Hora da Inclusão. No formato hh:mm:ss. |
info.uAlt | texto | Usuário da Alteração. |
info.uInc | texto | Usuário da Inclusão. |
nId | número inteiro | ID do documento de acordo com a tabela especificada. Por exemplo: Caso você informe "cliente" na tag "cTabela" você deve informar o ID do cliente neste campo. |
nIdAnexo | número inteiro | ID do anexo. Gerado automático na inclusão. Informe esse campo para Obter, Consultar e Excluir o anexo. |
POST /api/v1/geral/anexo/
curl -s https://app.omie.com.br/api/v1/geral/anexo/ \
-H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
-H 'Content-Type: application/json' \
-d '{"call": "ConsultarAnexo", "param": [{"cCodIntAnexo": "", "cTabela": "", "nId": 0, "nIdAnexo": 0, "cNomeArquivo": ""}]}'import os
import requests
corpo = {'call': 'ConsultarAnexo',
'param': [{'cCodIntAnexo': '',
'cTabela': '',
'nId': 0,
'nIdAnexo': 0,
'cNomeArquivo': ''}]}
resp = requests.post(
"https://app.omie.com.br/api/v1/geral/anexo/",
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/anexo/", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"call": "ConsultarAnexo",
"param": [
{
"cCodIntAnexo": "",
"cTabela": "",
"nId": 0,
"nIdAnexo": 0,
"cNomeArquivo": ""
}
]
}),
});
console.log(await resp.json());<?php
$ch = curl_init("https://app.omie.com.br/api/v1/geral/anexo/");
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": "ConsultarAnexo",
"param": [
{
"cCodIntAnexo": "",
"cTabela": "",
"nId": 0,
"nIdAnexo": 0,
"cNomeArquivo": ""
}
]
}
JSON,
]);
echo curl_exec($ch);require "net/http"
uri = URI("https://app.omie.com.br/api/v1/geral/anexo/")
corpo = <<~'JSON'
{
"call": "ConsultarAnexo",
"param": [
{
"cCodIntAnexo": "",
"cTabela": "",
"nId": 0,
"nIdAnexo": 0,
"cNomeArquivo": ""
}
]
}
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": "ConsultarAnexo",
"param": [
{
"cCodIntAnexo": "",
"cTabela": "",
"nId": 0,
"nIdAnexo": 0,
"cNomeArquivo": ""
}
]
}
""";
var pedido = HttpRequest.newBuilder()
.uri(URI.create("https://app.omie.com.br/api/v1/geral/anexo/"))
.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/anexo/",
[
Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
Content = Text.ToBinary("{""call"": ""ConsultarAnexo"", ""param"": [{""cCodIntAnexo"": """", ""cTabela"": """", ""nId"": 0, ""nIdAnexo"": 0, ""cNomeArquivo"": """"}]}")
]
),
Dados = Json.Document(Resposta)
in
DadosExclui um anexo vinculado a um documento.
Obrigatórios 2
| Campo | Tipo | Descrição |
|---|---|---|
cTabela | texto · até 100 | Nome da tabela onde o anexo está incluído.
Pode ser:
cliente
produto
servico
pedido-venda
remessa-produto
ordem-servico
contrato-servico
pedido-compra
nota-entrada
ordem-producao
conta-pagar
conta-receber
conta-corrente
conta-corrente-lancamento
crm-contas
crm-contatos
crm-oportunidades
com-recebimentoEx.: cliente, produto, servico |
nId | número inteiro | ID do documento de acordo com a tabela especificada. Por exemplo: Caso você informe "cliente" na tag "cTabela" você deve informar o ID do cliente neste campo. |
Opcionais 3Campos e estruturas que você pode enviar
| Campo | Tipo | Descrição |
|---|---|---|
cCodIntAnexo | texto · até 20 | Có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. |
cNomeArquivo | texto · até 100 | Nome do arquivo do anexo. |
nIdAnexo | número inteiro | ID do anexo. Gerado automático na inclusão. Informe esse campo para Obter, Consultar e Excluir o anexo. |
Retorno 7O que volta numa chamada bem-sucedida
| Campo | Tipo | Descrição |
|---|---|---|
cCodIntAnexo | texto | Có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. |
cCodStatus | texto | Código do status do processamento. Se o retorno for "0" significa que a solicitação foi executada com sucesso. Se o retorno for maior que "0" ocorreu algum erro duranteo o processamento da solicitação. A tag "cDesStatus" descreve o problema ocorrido. |
cDesStatus | texto | Descrição do status do processamento. Essa tag explica o resultado da tag "cCodigoStatus". |
cNomeArquivo | texto | Nome 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. |
cTabela | texto | Nome da tabela onde o anexo está incluído. Pode ser: cliente produto servico pedido-venda remessa-produto ordem-servico contrato-servico pedido-compra nota-entrada ordem-producao conta-pagar conta-receber conta-corrente conta-corrente-lancamento crm-contas crm-contatos crm-oportunidades com-recebimento |
nId | número inteiro | ID do documento de acordo com a tabela especificada. Por exemplo: Caso você informe "cliente" na tag "cTabela" você deve informar o ID do cliente neste campo. |
nIdAnexo | número inteiro | ID do anexo. Gerado automático na inclusão. Informe esse campo para Obter, Consultar e Excluir o anexo. |
POST /api/v1/geral/anexo/
curl -s https://app.omie.com.br/api/v1/geral/anexo/ \
-H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
-H 'Content-Type: application/json' \
-d '{"call": "ExcluirAnexo", "param": [{"cCodIntAnexo": "", "cTabela": "", "nId": 0, "nIdAnexo": 0, "cNomeArquivo": ""}]}'import os
import requests
corpo = {'call': 'ExcluirAnexo',
'param': [{'cCodIntAnexo': '',
'cTabela': '',
'nId': 0,
'nIdAnexo': 0,
'cNomeArquivo': ''}]}
resp = requests.post(
"https://app.omie.com.br/api/v1/geral/anexo/",
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/anexo/", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"call": "ExcluirAnexo",
"param": [
{
"cCodIntAnexo": "",
"cTabela": "",
"nId": 0,
"nIdAnexo": 0,
"cNomeArquivo": ""
}
]
}),
});
console.log(await resp.json());<?php
$ch = curl_init("https://app.omie.com.br/api/v1/geral/anexo/");
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": "ExcluirAnexo",
"param": [
{
"cCodIntAnexo": "",
"cTabela": "",
"nId": 0,
"nIdAnexo": 0,
"cNomeArquivo": ""
}
]
}
JSON,
]);
echo curl_exec($ch);require "net/http"
uri = URI("https://app.omie.com.br/api/v1/geral/anexo/")
corpo = <<~'JSON'
{
"call": "ExcluirAnexo",
"param": [
{
"cCodIntAnexo": "",
"cTabela": "",
"nId": 0,
"nIdAnexo": 0,
"cNomeArquivo": ""
}
]
}
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": "ExcluirAnexo",
"param": [
{
"cCodIntAnexo": "",
"cTabela": "",
"nId": 0,
"nIdAnexo": 0,
"cNomeArquivo": ""
}
]
}
""";
var pedido = HttpRequest.newBuilder()
.uri(URI.create("https://app.omie.com.br/api/v1/geral/anexo/"))
.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/anexo/",
[
Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
Content = Text.ToBinary("{""call"": ""ExcluirAnexo"", ""param"": [{""cCodIntAnexo"": """", ""cTabela"": """", ""nId"": 0, ""nIdAnexo"": 0, ""cNomeArquivo"": """"}]}")
]
),
Dados = Json.Document(Resposta)
in
DadosInclui o anexo para um documento.
Obrigatórios 5
| Campo | Tipo | Descrição |
|---|---|---|
cArquivo | texto | Conteúdo do arquivo a ser anexado, compactado (zip) e convertido em base 64. |
cMd5 | texto · até 32 | MD5 do arquivo enviado na tag "cArquivo". |
cNomeArquivo | texto · até 100 | Nome do arquivo do anexo. |
cTabela | texto · até 100 | Nome da tabela onde o anexo está incluído.
Pode ser:
cliente
produto
servico
pedido-venda
remessa-produto
ordem-servico
contrato-servico
pedido-compra
nota-entrada
ordem-producao
conta-pagar
conta-receber
conta-corrente
conta-corrente-lancamento
crm-contas
crm-contatos
crm-oportunidades
com-recebimentoEx.: cliente, produto, servico |
nId | número inteiro | ID do documento de acordo com a tabela especificada. Por exemplo: Caso você informe "cliente" na tag "cTabela" você deve informar o ID do cliente neste campo. |
Opcionais 2Campos e estruturas que você pode enviar
| Campo | Tipo | Descrição |
|---|---|---|
cCodIntAnexo | texto · até 20 | Có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. |
cTipoArquivo | texto · até 10 | Tipo de Arquivo. |
Retorno 7O que volta numa chamada bem-sucedida
| Campo | Tipo | Descrição |
|---|---|---|
cCodIntAnexo | texto | Có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. |
cCodStatus | texto | Código do status do processamento. Se o retorno for "0" significa que a solicitação foi executada com sucesso. Se o retorno for maior que "0" ocorreu algum erro duranteo o processamento da solicitação. A tag "cDesStatus" descreve o problema ocorrido. |
cDesStatus | texto | Descrição do status do processamento. Essa tag explica o resultado da tag "cCodigoStatus". |
cNomeArquivo | texto | Nome 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. |
cTabela | texto | Nome da tabela onde o anexo está incluído. Pode ser: cliente produto servico pedido-venda remessa-produto ordem-servico contrato-servico pedido-compra nota-entrada ordem-producao conta-pagar conta-receber conta-corrente conta-corrente-lancamento crm-contas crm-contatos crm-oportunidades com-recebimento |
nId | número inteiro | ID do documento de acordo com a tabela especificada. Por exemplo: Caso você informe "cliente" na tag "cTabela" você deve informar o ID do cliente neste campo. |
nIdAnexo | número inteiro | ID do anexo. Gerado automático na inclusão. Informe esse campo para Obter, Consultar e Excluir o anexo. |
POST /api/v1/geral/anexo/
curl -s https://app.omie.com.br/api/v1/geral/anexo/ \
-H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
-H 'Content-Type: application/json' \
-d '{"call": "IncluirAnexo", "param": [{"cCodIntAnexo": "", "cTabela": "", "nId": 0, "cNomeArquivo": "", "cTipoArquivo": "", "cArquivo": "", "cMd5": ""}]}'import os
import requests
corpo = {'call': 'IncluirAnexo',
'param': [{'cCodIntAnexo': '',
'cTabela': '',
'nId': 0,
'cNomeArquivo': '',
'cTipoArquivo': '',
'cArquivo': '',
'cMd5': ''}]}
resp = requests.post(
"https://app.omie.com.br/api/v1/geral/anexo/",
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/anexo/", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"call": "IncluirAnexo",
"param": [
{
"cCodIntAnexo": "",
"cTabela": "",
"nId": 0,
"cNomeArquivo": "",
"cTipoArquivo": "",
"cArquivo": "",
"cMd5": ""
}
]
}),
});
console.log(await resp.json());<?php
$ch = curl_init("https://app.omie.com.br/api/v1/geral/anexo/");
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": "IncluirAnexo",
"param": [
{
"cCodIntAnexo": "",
"cTabela": "",
"nId": 0,
"cNomeArquivo": "",
"cTipoArquivo": "",
"cArquivo": "",
"cMd5": ""
}
]
}
JSON,
]);
echo curl_exec($ch);require "net/http"
uri = URI("https://app.omie.com.br/api/v1/geral/anexo/")
corpo = <<~'JSON'
{
"call": "IncluirAnexo",
"param": [
{
"cCodIntAnexo": "",
"cTabela": "",
"nId": 0,
"cNomeArquivo": "",
"cTipoArquivo": "",
"cArquivo": "",
"cMd5": ""
}
]
}
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": "IncluirAnexo",
"param": [
{
"cCodIntAnexo": "",
"cTabela": "",
"nId": 0,
"cNomeArquivo": "",
"cTipoArquivo": "",
"cArquivo": "",
"cMd5": ""
}
]
}
""";
var pedido = HttpRequest.newBuilder()
.uri(URI.create("https://app.omie.com.br/api/v1/geral/anexo/"))
.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/anexo/",
[
Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
Content = Text.ToBinary("{""call"": ""IncluirAnexo"", ""param"": [{""cCodIntAnexo"": """", ""cTabela"": """", ""nId"": 0, ""cNomeArquivo"": """", ""cTipoArquivo"": """", ""cArquivo"": """", ""cMd5"": """"}]}")
]
),
Dados = Json.Document(Resposta)
in
DadosLista os anexos vinculados a um documento.
Obrigatórios 2
| Campo | Tipo | Descrição |
|---|---|---|
cTabela | texto · até 100 | Nome da tabela onde o anexo está incluído.
Pode ser:
cliente
produto
servico
pedido-venda
remessa-produto
ordem-servico
contrato-servico
pedido-compra
nota-entrada
ordem-producao
conta-pagar
conta-receber
conta-corrente
conta-corrente-lancamento
crm-contas
crm-contatos
crm-oportunidades
com-recebimentoEx.: cliente, produto, servico |
nId | número inteiro | ID do documento de acordo com a tabela especificada. Por exemplo: Caso você informe "cliente" na tag "cTabela" você deve informar o ID do cliente neste campo. |
Opcionais 8Campos e estruturas que você pode enviar
| Campo | Tipo | Descrição |
|---|---|---|
cOrdemDecrescente | texto · até 1 | Indica se a ordem de exibição é Decrescente caso seja informado "S".Ex.: S |
cOrdenarPor | texto · até 100 | Ordem os resultados da página por:
ARQUIVO - Nome do arquivo.Ex.: ARQUIVO |
dDtAltAte | texto · até 10 | Data de alteração final. No formato dd/mm/aaaa. |
dDtAltDe | texto · até 10 | Data de alteração inicial. No formato dd/mm/aaaa. |
dDtIncAte | texto · até 10 | Data de inclusão final. No formato dd/mm/aaaa. |
dDtIncDe | texto · até 10 | Data de inclusão inicial. No formato dd/mm/aaaa. |
nPagina | número inteiro | Número da página que se deseja resgatar. O padrão é "1". |
nRegPorPagina | número inteiro | Número de registros retornados por página. O padrão é 20. O limite máximo é 50 por página. |
Retorno 5O que volta numa chamada bem-sucedida
| Campo | Tipo | Descrição |
|---|---|---|
listaAnexos | lista de objetos | Lista de anexos do título do contas a receber encontrados. |
listaAnexos[].cCodIntAnexo | texto | Có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[].cNomeArquivo | texto | Nome 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[].cTabela | texto | Nome da tabela onde o anexo está incluído. Pode ser: cliente produto servico pedido-venda remessa-produto ordem-servico contrato-servico pedido-compra nota-entrada ordem-producao conta-pagar conta-receber conta-corrente conta-corrente-lancamento crm-contas crm-contatos crm-oportunidades com-recebimento |
listaAnexos[].cTipoArquivo | texto | Tipo de Arquivo. |
listaAnexos[].info | objeto | Informações complementares do anexo. |
listaAnexos[].info.cImpAPI | texto | Importado pela API (S/N). |
listaAnexos[].info.dAlt | texto | Data da Alteração. No formato dd/mm/aaaa. |
listaAnexos[].info.dInc | texto | Data da Inclusão. No formato dd/mm/aaaa. |
listaAnexos[].info.hAlt | texto | Hora da Alteração. No formato hh:mm:ss. |
listaAnexos[].info.hInc | texto | Hora da Inclusão. No formato hh:mm:ss. |
listaAnexos[].info.uAlt | texto | Usuário da Alteração. |
listaAnexos[].info.uInc | texto | Usuário da Inclusão. |
listaAnexos[].nId | número inteiro | ID do documento de acordo com a tabela especificada. Por exemplo: Caso você informe "cliente" na tag "cTabela" você deve informar o ID do cliente neste campo. |
listaAnexos[].nIdAnexo | número inteiro | ID do anexo. Gerado automático na inclusão. Informe esse campo para Obter, Consultar e Excluir o anexo. |
nPagina | número inteiro | Número da página resgatada. |
nRegistros | número inteiro | Número de registros retornados na página. |
nTotPaginas | número inteiro | Número total de páginas encontradas. |
nTotRegistros | número inteiro | Número total de registros encontrados. |
POST /api/v1/geral/anexo/
curl -s https://app.omie.com.br/api/v1/geral/anexo/ \
-H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
-H 'Content-Type: application/json' \
-d '{"call": "ListarAnexo", "param": [{"nPagina": 1, "nRegPorPagina": 50, "nId": 0, "cTabela": ""}]}'import os
import requests
corpo = {'call': 'ListarAnexo',
'param': [{'nPagina': 1, 'nRegPorPagina': 50, 'nId': 0, 'cTabela': ''}]}
resp = requests.post(
"https://app.omie.com.br/api/v1/geral/anexo/",
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/anexo/", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"call": "ListarAnexo",
"param": [
{
"nPagina": 1,
"nRegPorPagina": 50,
"nId": 0,
"cTabela": ""
}
]
}),
});
console.log(await resp.json());<?php
$ch = curl_init("https://app.omie.com.br/api/v1/geral/anexo/");
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": "ListarAnexo",
"param": [
{
"nPagina": 1,
"nRegPorPagina": 50,
"nId": 0,
"cTabela": ""
}
]
}
JSON,
]);
echo curl_exec($ch);require "net/http"
uri = URI("https://app.omie.com.br/api/v1/geral/anexo/")
corpo = <<~'JSON'
{
"call": "ListarAnexo",
"param": [
{
"nPagina": 1,
"nRegPorPagina": 50,
"nId": 0,
"cTabela": ""
}
]
}
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": "ListarAnexo",
"param": [
{
"nPagina": 1,
"nRegPorPagina": 50,
"nId": 0,
"cTabela": ""
}
]
}
""";
var pedido = HttpRequest.newBuilder()
.uri(URI.create("https://app.omie.com.br/api/v1/geral/anexo/"))
.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/anexo/",
[
Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
Content = Text.ToBinary("{""call"": ""ListarAnexo"", ""param"": [{""nPagina"": 1, ""nRegPorPagina"": 50, ""nId"": 0, ""cTabela"": """"}]}")
]
),
Dados = Json.Document(Resposta)
in
DadosObtém o link de download de um anexo vinculado a um documento.
Obrigatórios 2
| Campo | Tipo | Descrição |
|---|---|---|
cTabela | texto · até 100 | Nome da tabela onde o anexo está incluído.
Pode ser:
cliente
produto
servico
pedido-venda
remessa-produto
ordem-servico
contrato-servico
pedido-compra
nota-entrada
ordem-producao
conta-pagar
conta-receber
conta-corrente
conta-corrente-lancamento
crm-contas
crm-contatos
crm-oportunidades
com-recebimentoEx.: cliente, produto, servico |
nId | número inteiro | ID do documento de acordo com a tabela especificada. Por exemplo: Caso você informe "cliente" na tag "cTabela" você deve informar o ID do cliente neste campo. |
Opcionais 3Campos e estruturas que você pode enviar
| Campo | Tipo | Descrição |
|---|---|---|
cCodIntAnexo | texto · até 20 | Có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. |
cNomeArquivo | texto · até 100 | Nome do arquivo do anexo. |
nIdAnexo | número inteiro | ID do anexo. Gerado automático na inclusão. Informe esse campo para Obter, Consultar e Excluir o anexo. |
Retorno 9O que volta numa chamada bem-sucedida
| Campo | Tipo | Descrição |
|---|---|---|
cCodIntAnexo | texto | Có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. |
cCodStatus | texto | Código do status do processamento. Se o retorno for "0" significa que a solicitação foi executada com sucesso. Se o retorno for maior que "0" ocorreu algum erro duranteo o processamento da solicitação. A tag "cDesStatus" descreve o problema ocorrido. |
cDesStatus | texto | Descrição do status do processamento. Essa tag explica o resultado da tag "cCodigoStatus". |
cLinkDownload | texto | URL para download do anexo solicitado. |
cNomeArquivo | texto | Nome 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. |
cTabela | texto | Nome da tabela onde o anexo está incluído. Pode ser: cliente produto servico pedido-venda remessa-produto ordem-servico contrato-servico pedido-compra nota-entrada ordem-producao conta-pagar conta-receber conta-corrente conta-corrente-lancamento crm-contas crm-contatos crm-oportunidades com-recebimento |
dDtExpiracao | texto | Data de expiração da url disponibilizada. No formato dd/mm/aaaa. |
nId | número inteiro | ID do documento de acordo com a tabela especificada. Por exemplo: Caso você informe "cliente" na tag "cTabela" você deve informar o ID do cliente neste campo. |
nIdAnexo | número inteiro | ID do anexo. Gerado automático na inclusão. Informe esse campo para Obter, Consultar e Excluir o anexo. |
POST /api/v1/geral/anexo/
curl -s https://app.omie.com.br/api/v1/geral/anexo/ \
-H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
-H 'Content-Type: application/json' \
-d '{"call": "ObterAnexo", "param": [{"cCodIntAnexo": "", "cTabela": "", "nId": 0, "nIdAnexo": 0, "cNomeArquivo": ""}]}'import os
import requests
corpo = {'call': 'ObterAnexo',
'param': [{'cCodIntAnexo': '',
'cTabela': '',
'nId': 0,
'nIdAnexo': 0,
'cNomeArquivo': ''}]}
resp = requests.post(
"https://app.omie.com.br/api/v1/geral/anexo/",
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/anexo/", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"call": "ObterAnexo",
"param": [
{
"cCodIntAnexo": "",
"cTabela": "",
"nId": 0,
"nIdAnexo": 0,
"cNomeArquivo": ""
}
]
}),
});
console.log(await resp.json());<?php
$ch = curl_init("https://app.omie.com.br/api/v1/geral/anexo/");
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": "ObterAnexo",
"param": [
{
"cCodIntAnexo": "",
"cTabela": "",
"nId": 0,
"nIdAnexo": 0,
"cNomeArquivo": ""
}
]
}
JSON,
]);
echo curl_exec($ch);require "net/http"
uri = URI("https://app.omie.com.br/api/v1/geral/anexo/")
corpo = <<~'JSON'
{
"call": "ObterAnexo",
"param": [
{
"cCodIntAnexo": "",
"cTabela": "",
"nId": 0,
"nIdAnexo": 0,
"cNomeArquivo": ""
}
]
}
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": "ObterAnexo",
"param": [
{
"cCodIntAnexo": "",
"cTabela": "",
"nId": 0,
"nIdAnexo": 0,
"cNomeArquivo": ""
}
]
}
""";
var pedido = HttpRequest.newBuilder()
.uri(URI.create("https://app.omie.com.br/api/v1/geral/anexo/"))
.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/anexo/",
[
Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
Content = Text.ToBinary("{""call"": ""ObterAnexo"", ""param"": [{""cCodIntAnexo"": """", ""cTabela"": """", ""nId"": 0, ""nIdAnexo"": 0, ""cNomeArquivo"": """"}]}")
]
),
Dados = Json.Document(Resposta)
in
Dados