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

ListarTarefasconsulta

Método para realizar a listagem de tarefas cadastradas no ERP.

Identificação

Operaçãogeral/tarefas:ListarTarefas
ServiçoTarefas
MóduloGeral
Endpoint/api/v1/geral/tarefas/

Como as pessoas pedem isso

listar tarefas

Parâmetros

CampoTipoDescrição
cAtribuidasAMimlista de stringIndica se deve retornar apenas as tarefas atribuídas ao usuário (S/N).
cCriadasPorMimlista de stringIndica se deve retornar apenas as tarefas criadas pelo usuário (S/N).
cImportantestringIndica se a tarefa é importante (S/N).
cIntervalolista de stringFiltrar tarefas a partir de intervalos específicos. Quando preenchida essa tag, não informar as tags 'dDataInicial' e 'dDataFinal' Pode ser: hoje semana-atual proxima-semana mes (mês atual)
cOrdemDesclista de stringIndica se a ordem de exibição é decrescente (S/N). Caso não informado, o padrão é "N".
cOrdenarPorlista de stringOrdem de exibição dos dados. Quando não preenchido o padrão será por código Pode ser: codigo codint data descricao
cOrigemlista de stringOrigem da tarefa. Preenchimento obrigatório para o método de criação. Pode ser: oportunidade geral cliente produto servico pedido-venda pedido-compra pedido-importacao contas-pagar contas-receber ordem-producao ordem-servico contrato-servico
cSituacaostringSituação da tarefa. Para métodos de criação e edição: Preenchimento opcional. Como default será utilizado "Pendente". Pode ser: pendente (Pendente) em-execucao (Em execução) realizada (Realizada)
cUrgentestringIndica se a tarefa é urgente (S/N).
dDataFinallista de stringFiltrar tarefas até essa data
dDataIniciallista de stringFiltrar tarefas a partir dessa data
nCodDoclista de integerId do documento vinculado a tarefa. Esse campo varia conforme a origem da tarefa. Ele permite vincular a tarefa a um documento específico, seja ele relacionado a uma oportunidade, contas a pagar, contas a receber, entre outros. Exemplo: Se a origem da tarefa for "pedido-compra", esse campo reflete o código do pedido de compra. Se a origem da tarefa for "contas-receber", esse campo reflete o código da conta a receber. No cadastro de uma tarefa, quando a origem for "geral", não é permitido informar esse campo.
nPaginaintegerNúmero da página que será listada.
nRegPorPaginaintegerNúmero de registros retornados.

Exemplo de chamada

{
  "nPagina": 1,
  "nRegPorPagina": 100,
  "cOrigem": "",
  "cImportante": "",
  "cUrgente": "",
  "cSituacao": "",
  "dDataInicial": "",
  "dDataFinal": ""
}
api.omie.com.br/mcp · Documentação · Operações