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

Anexos do Contas a Pagar

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

lcpConsultarAnexo

consultaClaudeMCP

Consulta um anexo de um título do Contas a Pagar.

Obrigatórios 0

Nenhum campo obrigatório.

Opcionais 4Campos 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.
cCodIntTitulotexto · até 60Código de integração do título do Contas a Pagar. (Interno, utilizado apenas na Integração via API, não aparece na tela). Utilize esse campo para informar o código do título utilizado no seu aplicativo quando incluir um título no Omie. Assim, poderá utilizar esse campo para resgatar as informações do título desejado. Caso informe esse campo, não informe a tag nCodInt. Caso isso aconteça, o conteúdo dessa tag seja desconsiderada.
cNomeArqtexto · até 100Nome 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.
nCodTitulonúmero inteiroCódigo do título do Contas a Pagar. (Interno, utilizado apenas na integração via API, não é exibido na tela). O conteúdo desse campo é o código interno do título do contas a pagar gerado pelo Omie.
Retorno 5O 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.
cCodIntTitulotextoCódigo de integração do título do Contas a Pagar. (Interno, utilizado apenas na Integração via API, não aparece na tela). Utilize esse campo para informar o código do título utilizado no seu aplicativo quando incluir um título no Omie. Assim, poderá utilizar esse campo para resgatar as informações do título desejado. Caso informe esse campo, não informe a tag nCodInt. Caso isso aconteça, o conteúdo dessa tag seja desconsiderada.
cNomeArqtextoNome 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.
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.
nCodTitulonúmero inteiroCódigo do título do Contas a Pagar. (Interno, utilizado apenas na integração via API, não é exibido na tela). O conteúdo desse campo é o código interno do título do contas a receber gerado pelo Omie.
POST /api/v1/financas/contapagaranexos/
curl -s https://app.omie.com.br/api/v1/financas/contapagaranexos/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "lcpConsultarAnexo", "param": [{"nCodTitulo": 0, "cCodIntTitulo": "", "cCodIntAnexo": "", "cNomeArq": ""}]}'

lcpExcluirAnexo

altera dadosClaudeMCP

Exclui um anexo de um título do Contas a Pagar.

Obrigatórios 0

Nenhum campo obrigatório.

Opcionais 4Campos 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.
cCodIntTitulotexto · até 60Código de integração do título do Contas a Pagar. (Interno, utilizado apenas na Integração via API, não aparece na tela). Utilize esse campo para informar o código do título utilizado no seu aplicativo quando incluir um título no Omie. Assim, poderá utilizar esse campo para resgatar as informações do título desejado. Caso informe esse campo, não informe a tag nCodInt. Caso isso aconteça, o conteúdo dessa tag seja desconsiderada.
cNomeArqtexto · até 100Nome 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.
nCodTitulonúmero inteiroCódigo do título do Contas a Pagar. (Interno, utilizado apenas na integração via API, não é exibido na tela). O conteúdo desse campo é o código interno do título do contas a pagar gerado pelo Omie.
Retorno 6O 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.
cCodIntTitulotextoCódigo de integração do título do Contas a Pagar. (Interno, utilizado apenas na Integração via API, não aparece na tela). Utilize esse campo para informar o código do título utilizado no seu aplicativo quando incluir um título no Omie. Assim, poderá utilizar esse campo para resgatar as informações do título desejado. Caso informe esse campo, não informe a tag nCodInt. Caso isso aconteça, o conteúdo dessa tag seja desconsiderada.
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".
cNomeArqtextoNome 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.
nCodTitulonúmero inteiroCódigo do título do Contas a Pagar. (Interno, utilizado apenas na integração via API, não é exibido na tela). O conteúdo desse campo é o código interno do título do contas a pagar gerado pelo Omie.
POST /api/v1/financas/contapagaranexos/
curl -s https://app.omie.com.br/api/v1/financas/contapagaranexos/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "lcpExcluirAnexo", "param": [{"nCodTitulo": 0, "cCodIntTitulo": "", "cCodIntAnexo": "", "cNomeArq": ""}]}'

lcpIncluirAnexo

altera dadosClaudeMCP

Inclui um anexo no Contas a Pagar.

Obrigatórios 3

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".
cNomeArqtexto · até 100Nome 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.
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.
cCodIntTitulotexto · até 60Código de integração do título do Contas a Pagar. (Interno, utilizado apenas na Integração via API, não aparece na tela). Utilize esse campo para informar o código do título utilizado no seu aplicativo quando incluir um título no Omie. Assim, poderá utilizar esse campo para resgatar as informações do título desejado. Caso informe esse campo, não informe a tag nCodInt. Caso isso aconteça, o conteúdo dessa tag seja desconsiderada.
nCodTitulonúmero inteiroCódigo do título do Contas a Pagar. (Interno, utilizado apenas na integração via API, não é exibido na tela). O conteúdo desse campo é o código interno do título do contas a pagar gerado pelo Omie.
Retorno 6O 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.
cCodIntTitulotextoCódigo de integração do título do Contas a Pagar. (Interno, utilizado apenas na Integração via API, não aparece na tela). Utilize esse campo para informar o código do título utilizado no seu aplicativo quando incluir um título no Omie. Assim, poderá utilizar esse campo para resgatar as informações do título desejado. Caso informe esse campo, não informe a tag nCodInt. Caso isso aconteça, o conteúdo dessa tag seja desconsiderada.
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".
cNomeArqtextoNome 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.
nCodTitulonúmero inteiroCódigo do título do Contas a Pagar. (Interno, utilizado apenas na integração via API, não é exibido na tela). O conteúdo desse campo é o código interno do título do contas a pagar gerado pelo Omie.
POST /api/v1/financas/contapagaranexos/
curl -s https://app.omie.com.br/api/v1/financas/contapagaranexos/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "lcpIncluirAnexo", "param": [{"nCodTitulo": 0, "cCodIntTitulo": "", "cCodIntAnexo": "", "cNomeArq": "", "cArquivo": "", "cMd5": ""}]}'

lcpListarAnexos

consultaClaudeChatGPTMCP

Lista os anexos de um título do Contas a Pagar.

Obrigatórios 0

Nenhum campo obrigatório.

Opcionais 10Campos e estruturas que você pode enviar
CampoTipoDescrição
cCodIntTitulotexto · até 60Código de integração do título do Contas a Receber. (Interno, utilizado apenas na Integração via API, não aparece na tela). Utilize esse campo para informar o código do título utilizado no seu aplicativo quando incluir um título no Omie. Assim, poderá utilizar esse campo para resgatar as informações do título desejado. Caso informe esse campo, não informe a tag nCodInt. Caso isso aconteça, o conteúdo dessa tag seja desconsiderada.
cOrdemDecrescentetexto · até 1Indica se a ordem de exibição é Decrescente caso seja informado "S".
cOrdenarPortexto · até 100Ordem os resultados da página por: CODIGO - Código do Título. CODINT - Código de Integração do Título. ARQUIVO - Nome do 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.
nCodTitulonúmero inteiroCódigo do título do Contas a Receber. (Interno, utilizado apenas na integração via API, não é exibido na tela). O conteúdo desse campo é o código interno do título do contas a receber gerado pelo Omie.
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[].cCodIntTitulotextoCódigo de integração do título do Contas a Receber. (Interno, utilizado apenas na Integração via API, não aparece na tela). Utilize esse campo para informar o código do título utilizado no seu aplicativo quando incluir um título no Omie. Assim, poderá utilizar esse campo para resgatar as informações do título desejado. Caso informe esse campo, não informe a tag nCodInt. Caso isso aconteça, o conteúdo dessa tag seja desconsiderada.
listaAnexos[].cNomeArqtextoNome 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[].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[].nCodTitulonúmero inteiroCódigo do título do Contas a Receber. (Interno, utilizado apenas na integração via API, não é exibido na tela). O conteúdo desse campo é o código interno do título do contas a receber gerado pelo Omie.
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/financas/contapagaranexos/
curl -s https://app.omie.com.br/api/v1/financas/contapagaranexos/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "lcpListarAnexos", "param": [{"nPagina": 1, "nRegPorPagina": 50, "nCodTitulo": 0}]}'

lcpObterAnexo

consultaClaudeMCP

Obtém um anexo de um título do Contas a Pagar.

Obrigatórios 0

Nenhum campo obrigatório.

Opcionais 4Campos 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.
cCodIntTitulotexto · até 60Código de integração do título do Contas a Pagar. (Interno, utilizado apenas na Integração via API, não aparece na tela). Utilize esse campo para informar o código do título utilizado no seu aplicativo quando incluir um título no Omie. Assim, poderá utilizar esse campo para resgatar as informações do título desejado. Caso informe esse campo, não informe a tag nCodInt. Caso isso aconteça, o conteúdo dessa tag seja desconsiderada.
cNomeArqtexto · até 100Nome 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.
nCodTitulonúmero inteiroCódigo do título do Contas a Pagar. (Interno, utilizado apenas na integração via API, não é exibido na tela). O conteúdo desse campo é o código interno do título do contas a pagar gerado pelo Omie.
Retorno 8O 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.
cCodIntTitulotextoCódigo de integração do título do Contas a Pagar. (Interno, utilizado apenas na Integração via API, não aparece na tela). Utilize esse campo para informar o código do título utilizado no seu aplicativo quando incluir um título no Omie. Assim, poderá utilizar esse campo para resgatar as informações do título desejado. Caso informe esse campo, não informe a tag nCodInt. Caso isso aconteça, o conteúdo dessa tag seja desconsiderada.
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.
cNomeArqtextoNome 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.
dDtExpiracaotextoData de expiração da url disponibilizada. No formato dd/mm/aaaa.
nCodTitulonúmero inteiroCódigo do título do Contas a Pagar. (Interno, utilizado apenas na integração via API, não é exibido na tela). O conteúdo desse campo é o código interno do título do contas a pagar gerado pelo Omie.
POST /api/v1/financas/contapagaranexos/
curl -s https://app.omie.com.br/api/v1/financas/contapagaranexos/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "lcpObterAnexo", "param": [{"nCodTitulo": 0, "cCodIntTitulo": "", "cCodIntAnexo": "", "cNomeArq": ""}]}'