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

Adicionar anexos as tabelas do sistema

POSThttps://app.omie.com.br/api/v1/geral/anexo/WSDL
3consultas
2alterações
Claude · MCPpelos assistentes de IA
JSON · XMLformato

ConsultarAnexo

consultaClaudeMCP

Consulta os dados de um anexo vinculado a um documento.

Obrigatórios 2

CampoTipoDescrição
cTabelatexto · até 100Nome 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
nIdnúmero inteiroID 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
CampoTipoDescrição
cCodIntAnexotexto · até 20Có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.
cNomeArquivotexto · até 100Nome do arquivo do anexo.
nIdAnexonúmero inteiroID 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
CampoTipoDescrição
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.
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.
cTabelatextoNome 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
cTipoArquivotextoTipo de Arquivo.
infoobjetoInformações complementares do anexo.
info.cImpAPItextoImportado pela API (S/N).
info.dAlttextoData da Alteração. No formato dd/mm/aaaa.
info.dInctextoData da Inclusão. No formato dd/mm/aaaa.
info.hAlttextoHora da Alteração. No formato hh:mm:ss.
info.hInctextoHora da Inclusão. No formato hh:mm:ss.
info.uAlttextoUsuário da Alteração.
info.uInctextoUsuário da Inclusão.
nIdnúmero inteiroID 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.
nIdAnexonúmero inteiroID 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": ""}]}'

ExcluirAnexo

altera dadosClaudeMCP

Exclui um anexo vinculado a um documento.

Obrigatórios 2

CampoTipoDescrição
cTabelatexto · até 100Nome 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
nIdnúmero inteiroID 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
CampoTipoDescrição
cCodIntAnexotexto · até 20Có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.
cNomeArquivotexto · até 100Nome do arquivo do anexo.
nIdAnexonúmero inteiroID 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
CampoTipoDescrição
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.
cCodStatustextoCó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.
cDesStatustextoDescrição do status do processamento. Essa tag explica o resultado da tag "cCodigoStatus".
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.
cTabelatextoNome 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
nIdnúmero inteiroID 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.
nIdAnexonúmero inteiroID 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": ""}]}'

IncluirAnexo

altera dadosClaudeMCP

Inclui o anexo para um documento.

Obrigatórios 5

CampoTipoDescrição
cArquivotextoConteúdo do arquivo a ser anexado, compactado (zip) e convertido em base 64.
cMd5texto · até 32MD5 do arquivo enviado na tag "cArquivo".
cNomeArquivotexto · até 100Nome do arquivo do anexo.
cTabelatexto · até 100Nome 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
nIdnúmero inteiroID 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
CampoTipoDescrição
cCodIntAnexotexto · até 20Có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.
cTipoArquivotexto · até 10Tipo de Arquivo.
Retorno 7O que volta numa chamada bem-sucedida
CampoTipoDescrição
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.
cCodStatustextoCó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.
cDesStatustextoDescrição do status do processamento. Essa tag explica o resultado da tag "cCodigoStatus".
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.
cTabelatextoNome 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
nIdnúmero inteiroID 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.
nIdAnexonúmero inteiroID 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": ""}]}'

ListarAnexo

consultaClaudeMCP

Lista os anexos vinculados a um documento.

Obrigatórios 2

CampoTipoDescrição
cTabelatexto · até 100Nome 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
nIdnúmero inteiroID 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
CampoTipoDescrição
cOrdemDecrescentetexto · até 1Indica se a ordem de exibição é Decrescente caso seja informado "S".Ex.: S
cOrdenarPortexto · até 100Ordem os resultados da página por: ARQUIVO - Nome do arquivo.Ex.: ARQUIVO
dDtAltAtetexto · até 10Data de alteração final. No formato dd/mm/aaaa.
dDtAltDetexto · até 10Data de alteração inicial. No formato dd/mm/aaaa.
dDtIncAtetexto · até 10Data de inclusão final. No formato dd/mm/aaaa.
dDtIncDetexto · até 10Data de inclusão inicial. No formato dd/mm/aaaa.
nPaginanúmero inteiroNúmero da página que se deseja resgatar. O padrão é "1".
nRegPorPaginanúmero inteiroNú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
CampoTipoDescrição
listaAnexoslista de objetosLista de anexos do título do contas a receber encontrados.
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: 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[].cTipoArquivotextoTipo de Arquivo.
listaAnexos[].infoobjetoInformações complementares do anexo.
listaAnexos[].info.cImpAPItextoImportado pela API (S/N).
listaAnexos[].info.dAlttextoData da Alteração. No formato dd/mm/aaaa.
listaAnexos[].info.dInctextoData da Inclusão. No formato dd/mm/aaaa.
listaAnexos[].info.hAlttextoHora da Alteração. No formato hh:mm:ss.
listaAnexos[].info.hInctextoHora da Inclusão. No formato hh:mm:ss.
listaAnexos[].info.uAlttextoUsuário da Alteração.
listaAnexos[].info.uInctextoUsuário da Inclusão.
listaAnexos[].nIdnúmero inteiroID 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[].nIdAnexonúmero inteiroID do anexo. Gerado automático na inclusão. Informe esse campo para Obter, Consultar e Excluir o anexo.
nPaginanúmero inteiroNúmero da página resgatada.
nRegistrosnúmero inteiroNúmero de registros retornados na página.
nTotPaginasnúmero inteiroNúmero total de páginas encontradas.
nTotRegistrosnúmero inteiroNú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": ""}]}'

ObterAnexo

consultaClaudeMCP

Obtém o link de download de um anexo vinculado a um documento.

Obrigatórios 2

CampoTipoDescrição
cTabelatexto · até 100Nome 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
nIdnúmero inteiroID 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
CampoTipoDescrição
cCodIntAnexotexto · até 20Có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.
cNomeArquivotexto · até 100Nome do arquivo do anexo.
nIdAnexonúmero inteiroID 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
CampoTipoDescrição
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.
cCodStatustextoCó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.
cDesStatustextoDescrição do status do processamento. Essa tag explica o resultado da tag "cCodigoStatus".
cLinkDownloadtextoURL para download do anexo solicitado.
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.
cTabelatextoNome 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
dDtExpiracaotextoData de expiração da url disponibilizada. No formato dd/mm/aaaa.
nIdnúmero inteiroID 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.
nIdAnexonúmero inteiroID 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": ""}]}'