apiDocumentaçãoOperaçõesapiDocumentaçãoOperaçõesIncluirTarefaaltera dadosMétodo para realizar a inclusão de uma tarefa.
| Operação | geral/tarefas:IncluirTarefa |
|---|---|
| Serviço | Tarefas |
| Módulo | Geral |
| Endpoint | /api/v1/geral/tarefas/ |
incluir tarefa
| Campo | Tipo | Descrição |
|---|---|---|
cCodIntTarefa | string | Código de Integração. |
cDescricao | lista de string | Descrição da tarefa. |
cImportante | lista de string | Indica se a tarefa é importante (S/N). |
cOrigem obrigatório | lista de string | Origem da tarefa. Para método de criação: Preenchimento obrigatório. Pode ser: oportunidade geral cliente produto servico pedido-venda pedido-compra pedido-importacao contas-pagar contas-receber ordem-producao ordem-servico contrato-servico |
cSituacao | lista de string | Situaçã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) |
cUrgente | lista de string | Indica se a tarefa é urgente (S/N). |
dData obrigatório | lista de string | Data |
hHora obrigatório | lista de string | Hora |
nCodAtividade | lista de integer | Código do tipo de tarefa vinculado. Para métodos de criação e edição: Preenchimento opcional. Para obter os tipos de tarefa, utilize o método ObterTiposTarefa da API: /api/v1/geral/tipostarefa/ |
nCodDoc | lista de integer | Id 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. |
nCodNotif | lista de integer | Código da notificação. Para métodos de criação e edição: Preenchimento opcional. Como default será utilizado "Não notificar". 99999 (Não notificar) 15 (15 minutos antes) 30 (30 minutos antes) 60 (1 hora antes) 120 (2 horas antes) 180 (3 horas antes) 1001 (1 dia antes) 1002 (2 dias antes) 1003 (3 dias antes) 2001 (1 semana antes) 2002 (2 semanas antes) |
nCodUserAtb obrigatório | lista de integer | Código do usuário atribuído. Para método de criação: Preenchimento obrigatório. Para método de edição: Preenchimento opcional. Para obter os possíveis usuários para alocar a tarefa, utilize o método ListarUsuarios da API: /api/v1/geral/usuarios/ |
{
"cCodIntTarefa": "",
"cOrigem": "",
"cDescricao": "",
"dData": "#TODAY#",
"hHora": "12:30",
"cImportante": "N",
"cUrgente": "N",
"cSituacao": "pendente",
"nCodAtividade": 0,
"nCodNotif": 0,
"nCodUserAtb": 0,
"nCodDoc": 0
}