Listar processos

Permite obter uma lista paginada de até 100 processos vinculados a um escritório contábil, com suporte a OData.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Dicionário para propriedades retornadas

status

Essa propriedade representa o status do processo:

  • 1- Agendado
  • 2- Em andamento
  • 3- Concluído
  • 4- Cancelado

Processos agendados de clientes inativados não são retornados.


Response body

  • id - Id do processo
  • title - Título do processo, o mesmo do modelo de processo
  • complement - Complemento do processo
  • processTemplateId - Id do modelo de processo
  • customer - Cliente do processo (id e nome)
  • inChargeUser - Responsável pelo processo (id e nome)
  • department - Departamento do processo (id e nome)
  • status - Status do processo
  • startDate - Data de início do processo
  • deadLine - Prazo do processo: a maior data de entrega entre as tarefas. Em processo agendado, é o prazo previsto
  • completedAt - Data de conclusão do processo
  • totalTasks - Total de tarefas do processo. Em processo agendado é 0: as tarefas são criadas na data de início
  • completedTasks - Total de tarefas concluídas do processo
  • createdAt - Data de criação do processo
  • createdBy - Usuário que criou o processo
  • updatedAt - Data da última alteração do processo
  • updatedBy - Usuário que fez a última alteração do processo
Path Params
string
required

Id do escritório.

Query Params
string

Filtra os resultados com base em critérios específicos. Exemplo: filter=Name eq 'Usuário X'.

string

Define o número de resultados a serem ignorados. Exemplo: skip=10.

string

Limita o número de resultados retornados. Exemplo: top=5.

string

Ordena os resultados. Exemplo: orderby=Name asc.

Headers
string

Requer autenticação via API Key no header da requisição. Exemplo: X-API-Key: Sua chave.

string

Requer autenticação via Id do usuário no header da requisição. Exemplo: X-User-Id: Id do usuário.

Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json