Criar consulta | Simplifica Gestão

Cria uma nova consulta seguindo as mesmas validações operacionais usadas no sistema.

Regras:

informe cliente_id, consultor_id, profissional_id, data_consulta, hora_inicial, hora_final, motivo_consulta_id e procedimentos;
data_consulta usa YYYY-MM-DD;
hora_inicial e hora_final usam HH24:MI;
a hora final deve ser maior que a inicial;
procedimentos deve ser uma lista de ids de serviços válidos e ativos da empresa;
a rota valida conflito de agenda do cliente;
o restante das regras de agenda e recorrência segue a procedure operacional já usada na tela;
encaixe, quando enviado, aceita apenas S ou N;
repeticao é opcional e ativa o agendamento recorrente quando presente;
em repeticao, use frequencia com SEMANAL, QUINZENAL ou MENSAL;
em repeticao, quantidade deve estar entre 2 e 6.

Exemplo de uso:

1 POST {{base_url}}/simplificav2/consulta
2 Authorization: Bearer {{bearer_token}}
3 Content-Type: application/json
4 
5 {
6   "cliente_id": 164272,
7   "consultor_id": 52,
8   "profissional_id": 18,
9   "data_consulta": "2026-04-10",
10   "hora_inicial": "14:00",
11   "hora_final": "15:00",
12   "descricao": "Primeiro atendimento da paciente.",
13   "motivo_consulta_id": 7,
14   "encaixe": "N",
15   "procedimentos": [981, 982],
16   "repeticao": {
17     "frequencia": "SEMANAL",
18     "quantidade": 4
19   }
20 }

Cria uma nova consulta seguindo as mesmas validações operacionais usadas no sistema. Regras: - informe `cliente_id`, `consultor_id`, `profissional_id`, `data_consulta`, `hora_inicial`, `hora_final`, `motivo_consulta_id` e `procedimentos`; - `data_consulta` usa `YYYY-MM-DD`; - `hora_inicial` e `hora_final` usam `HH24:MI`; - a hora final deve ser maior que a inicial; - `procedimentos` deve ser uma lista de ids de serviços válidos e ativos da empresa; - a rota valida conflito de agenda do cliente; - o restante das regras de agenda e recorrência segue a procedure operacional já usada na tela; - `encaixe`, quando enviado, aceita apenas `S` ou `N`; - `repeticao` é opcional e ativa o agendamento recorrente quando presente; - em `repeticao`, use `frequencia` com `SEMANAL`, `QUINZENAL` ou `MENSAL`; - em `repeticao`, `quantidade` deve estar entre `2` e `6`. Exemplo de uso: ```http POST {{base_url}}/simplificav2/consulta Authorization: Bearer {{bearer_token}} Content-Type: application/json { "cliente_id": 164272, "consultor_id": 52, "profissional_id": 18, "data_consulta": "2026-04-10", "hora_inicial": "14:00", "hora_final": "15:00", "descricao": "Primeiro atendimento da paciente.", "motivo_consulta_id": 7, "encaixe": "N", "procedimentos": [981, 982], "repeticao": { "frequencia": "SEMANAL", "quantidade": 4 } } ```

Authentication

AuthorizationBearer

Token privado usado para consultar dados da plataforma.

Como usar:

obtenha o token privado da sua empresa;
envie Authorization: Bearer SEU_TOKEN_PRIVADO;
não use x-api-key neste módulo.

Token privado usado para consultar dados da plataforma. Como usar: - obtenha o token privado da sua empresa; - envie `Authorization: Bearer SEU_TOKEN_PRIVADO`; - não use `x-api-key` neste módulo.

Request

This endpoint expects an object.

cliente_idintegerRequired

Pessoa da base que será atendida na consulta.

consultor_idintegerRequired

Consultor responsável pela consulta.

profissional_idintegerRequired

Profissional que executará o atendimento.

data_consultastringRequired

Data da consulta no formato YYYY-MM-DD.

hora_inicialstringRequired

Hora inicial no formato HH24:MI.

hora_finalstringRequired

Hora final no formato HH24:MI.

motivo_consulta_idintegerRequired

Motivo de consulta ativo usado no cadastro.

procedimentoslist of integersRequired

Lista de ids dos procedimentos da consulta.

descricaostring or nullOptional

Observação opcional da consulta.

encaixestring or nullOptional

Use S para permitir encaixe ou N para seguir a validação padrão de agenda.

repeticaoobject or nullOptional

Objeto opcional para gerar agendamento recorrente.

Response

Consulta criada com sucesso.

statusstring

mensagemstring

dataobject

Errors

400

Bad Request Error

401

Unauthorized Error

409

Conflict Error

422

Unprocessable Entity Error

500

Internal Server Error

Cria uma nova consulta seguindo as mesmas validações operacionais usadas no sistema.

Regras:

informe cliente_id, consultor_id, profissional_id, data_consulta, hora_inicial, hora_final, motivo_consulta_id e procedimentos;
data_consulta usa YYYY-MM-DD;
hora_inicial e hora_final usam HH24:MI;
a hora final deve ser maior que a inicial;
procedimentos deve ser uma lista de ids de serviços válidos e ativos da empresa;
a rota valida conflito de agenda do cliente;
o restante das regras de agenda e recorrência segue a procedure operacional já usada na tela;
encaixe, quando enviado, aceita apenas S ou N;
repeticao é opcional e ativa o agendamento recorrente quando presente;
em repeticao, use frequencia com SEMANAL, QUINZENAL ou MENSAL;
em repeticao, quantidade deve estar entre 2 e 6.

Exemplo de uso:

1 POST {{base_url}}/simplificav2/consulta
2 Authorization: Bearer {{bearer_token}}
3 Content-Type: application/json
4 
5 {
6   "cliente_id": 164272,
7   "consultor_id": 52,
8   "profissional_id": 18,
9   "data_consulta": "2026-04-10",
10   "hora_inicial": "14:00",
11   "hora_final": "15:00",
12   "descricao": "Primeiro atendimento da paciente.",
13   "motivo_consulta_id": 7,
14   "encaixe": "N",
15   "procedimentos": [981, 982],
16   "repeticao": {
17     "frequencia": "SEMANAL",
18     "quantidade": 4
19   }
20 }

$	curl -X POST https://gestao.simplificagestao.com.br/ords/gestao/simplificav2/consulta \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"cliente_id": 1,
>	"consultor_id": 1,
>	"profissional_id": 1,
>	"data_consulta": "2026-04-10",
>	"hora_inicial": "14:00",
>	"hora_final": "15:00",
>	"motivo_consulta_id": 1,
>	"procedimentos": [
>	1
>	]
>	}'

1	{
2	"status": "sucesso",
3	"mensagem": "Consulta criada com sucesso.",
4	"data": {
5	"id": 145
6	}
7	}

1	POST {{base_url}}/simplificav2/consulta
2	Authorization: Bearer {{bearer_token}}
3	Content-Type: application/json
4
5	{
6	"cliente_id": 164272,
7	"consultor_id": 52,
8	"profissional_id": 18,
9	"data_consulta": "2026-04-10",
10	"hora_inicial": "14:00",
11	"hora_final": "15:00",
12	"descricao": "Primeiro atendimento da paciente.",
13	"motivo_consulta_id": 7,
14	"encaixe": "N",
15	"procedimentos": [981, 982],
16	"repeticao": {
17	"frequencia": "SEMANAL",
18	"quantidade": 4
19	}
20	}