OmieapiDocumentaçãoOperações
← Referência das operações

ListarAnexoconsulta

Identificação

Operaçãogeral/anexo:ListarAnexo
ServiçoDocumentoAnexo
MóduloGeral
Endpoint/api/v1/geral/anexo/

Como as pessoas pedem isso

listar anexos

Parâmetros

CampoTipoDescrição
cOrdemDecrescentestringIndica se a ordem de exibição é Decrescente caso seja informado "S".
cOrdenarPorstringOrdem os resultados da página por: ARQUIVO - Nome do arquivo.
cTabela obrigatóriostringNome 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
dDtAltAtestringData de alteração final. No formato dd/mm/aaaa.
dDtAltDestringData de alteração inicial. No formato dd/mm/aaaa.
dDtIncAtestringData de inclusão final. No formato dd/mm/aaaa.
dDtIncDestringData de inclusão inicial. No formato dd/mm/aaaa.
nId obrigatóriointegerID 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. Preenchimento obrigatório.
nPaginaintegerNúmero da página que se deseja resgatar. O padrão é "1".
nRegPorPaginaintegerNúmero de registros retornados por página. O padrão é 20. O limite máximo é 50 por página.

Exemplo de chamada

{
  "nPagina": 1,
  "nRegPorPagina": 50,
  "nId": 0,
  "cTabela": ""
}
api.omie.com.br/mcp · Documentação · Operações