📚 Referência — Cadastros

GET /empresas

Listar empresas/unidades · Permissão: empresa:read

Sem paginação — devolve todas as empresas cadastradas na clínica, ativas e inativas.

Respostas

• 200 — Lista de empresas
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

POST /empresas

Cadastrar empresa/unidade · Permissão: empresa:create

Corpo (application/json) — obrigatório

Campos obrigatórios: razaoSocial, nomeFantasia, cnpj, endereco

Respostas

• 201 — Empresa criada
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 409 — CNPJ já cadastrado (para outra empresa ativa ou desativada)
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

GET /empresas/{id}

Consultar empresa/unidade · Permissão: empresa:read

Parâmetros

Respostas

• 200 — Empresa
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 404 — Empresa não encontrada
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

PUT /empresas/{id}

Atualizar empresa/unidade · Permissão: empresa:update

Substitui o cadastro por completo (mesmo comportamento do PUT /convenios/{id}), não faz merge parcial — envie a empresa inteira.

Parâmetros

Corpo (application/json) — obrigatório

Campos obrigatórios: razaoSocial, nomeFantasia, cnpj, endereco

Respostas

• 200 — Empresa atualizada
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 404 — Empresa não encontrada
• 409 — CNPJ já cadastrado (para outra empresa ativa ou desativada)
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

DELETE /empresas/{id}

Desativar empresa/unidade · Permissão: empresa:delete

É uma desativação (ativo = false), não uma exclusão física. Recusa (400) se a empresa tiver atendimentos, colaboradores, convênios, depósitos, locais ou movimentações financeiras ativas vinculadas.

Parâmetros

Respostas

• 200 — Empresa desativada
• 400 — Empresa possui relações ativas vinculadas
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 404 — Empresa não encontrada
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

GET /depositos

Listar depósitos · Permissão: deposito:read

Parâmetros

Respostas

• 200 — Lista paginada
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

POST /depositos

Cadastrar depósito · Permissão: deposito:create

Corpo (application/json) — obrigatório

Campos obrigatórios: empresaId, descricaoDeposito

Respostas

• 201 — Depósito criado
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 409 — Já existe um depósito com este nome nesta unidade
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

POST /depositos/bulk

Cadastrar vários depósitos de uma vez · Permissão: deposito:create

Até 50 itens por requisição (chave depositos). 207 = falha parcial.

Corpo (application/json) — obrigatório

Campos obrigatórios: depositos, depositos[].empresaId, depositos[].descricaoDeposito

Cada item de depositos[] tem os mesmos campos de POST /depositos (máx. 50 itens).

Respostas

• 201 — Todos criados
• 207 — Falha parcial
• 400 — Lote vazio ou acima de 50 itens
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 429 — Já existe um lote em andamento para esta clínica e recurso
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

GET /depositos/{id}

Consultar depósito · Permissão: deposito:read

Parâmetros

Respostas

• 200 — Depósito
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 404 — Depósito não encontrado
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

PUT /depositos/{id}

Atualizar depósito · Permissão: deposito:update

Bloqueia nome duplicado ativo na mesma empresa (409).

Parâmetros

Corpo (application/json) — obrigatório

Campos obrigatórios: empresaId, descricaoDeposito

Respostas

• 200 — Row crua, sem include — confirmado batendo com o schema Deposito, com uma ressalva: o real também tem produtoId (integer, nullable), não documentado no schema hoje.
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 404 — Depósito não encontrado
• 409 — Já existe um depósito ativo com este nome nesta empresa
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

DELETE /depositos/{id}

Desativar depósito · Permissão: deposito:delete

Desativação lógica, não exclusão física.

Parâmetros

Respostas

• 200 — Corpo de sucesso é o número cru 201, não um objeto.
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 404 — "Failed in Delete Deposito." — mensagem em inglês, inconsistente com o padrão em português do resto da API
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

GET /locais

Listar locais · Permissão: local:read

Sem paginação — devolve todos os locais cadastrados na clínica.

Respostas

• 200 — Lista de locais
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

POST /locais

Cadastrar local · Permissão: local:create

Corpo (application/json) — obrigatório

Campos obrigatórios: nome, empresaId, depositoPadraoSaidaId

Respostas

• 201 — Local criado
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 409 — Já existe um local com esse nome nessa empresa
• 422 — O depósito padrão de saída selecionado está inativo ou não existe
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

GET /locais/{id}

Consultar local · Permissão: local:read

Parâmetros

Respostas

• 200 — Local
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 404 — Local não encontrado
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

PUT /locais/{id}

Atualizar local · Permissão: local:update

Parâmetros

Corpo (application/json) — obrigatório

Campos obrigatórios: nome, empresaId, depositoPadraoSaidaId

Respostas

• 200 — Local atualizado
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 404 — Local não encontrado
• 422 — O depósito padrão de saída selecionado está inativo ou não existe
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

DELETE /locais/{id}

Desativar local · Permissão: local:delete

É uma desativação (ativo = false), não uma exclusão física. Recusa (409) se houver agendamentos, orçamentos, grades de colaborador/equipamento ou vínculos de serviço no local.

Parâmetros

Respostas

• 200 — Local desativado
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 404 — Local não encontrado
• 409 — Existem registros vinculados a este local
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

GET /auxiliares/tipos-produto

Listar tipos de produto · Permissão: auxiliar:read

Respostas

• 200 — Lista
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

GET /auxiliares/tipos-codigo

Listar tipos de código · Permissão: auxiliar:read

Respostas

• 200 — Lista
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

GET /auxiliares/tabelas-ans87

Listar tabelas de domínio ANS 87 · Permissão: auxiliar:read

Respostas

• 200 — Lista
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

GET /auxiliares/regimes-atendimento

Listar regimes de atendimento · Permissão: auxiliar:read

Respostas

• 200 — Lista
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

GET /auxiliares/tipos-servico

Listar tipos de serviço · Permissão: auxiliar:read

Respostas

• 200 — Lista
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

GET /auxiliares/tipos-guia

Listar tipos de guia · Permissão: auxiliar:read

Respostas

• 200 — Lista
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

GET /auxiliares/tipos-taxa

Listar tipos de taxa · Permissão: auxiliar:read

Respostas

• 200 — Lista
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

GET /auxiliares/unidades-medida

Listar unidades de medida · Permissão: auxiliar:read

Respostas

• 200 — Lista
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

GET /auxiliares/principios-ativos

Listar princípios ativos · Permissão: auxiliar:read

Respostas

• 200 — Lista
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

GET /auxiliares/sexos

Listar sexos · Permissão: auxiliar:read

Respostas

• 200 — Lista
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

GET /auxiliares/estados-civis

Listar estados civis · Permissão: auxiliar:read

Respostas

• 200 — Lista
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

GET /auxiliares/conselhos-profissionais

Listar conselhos profissionais · Permissão: auxiliar:read

Respostas

• 200 — Lista
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

GET /auxiliares/unidades-federativas

Listar unidades federativas · Permissão: auxiliar:read

Respostas

• 200 — Lista
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

GET /auxiliares/tipos-atendimento

Listar tipos de atendimento · Permissão: auxiliar:read

Respostas

• 200 — Lista
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

GET /operadoras

Listar operadoras · Permissão: operadora:read

Parâmetros

Respostas

• 200 — Lista paginada
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

POST /operadoras

Cadastrar operadora · Permissão: operadora:create

Corpo (application/json) — obrigatório

Campos obrigatórios: nome, descricao, registroANS, cnpj, codigoCNES, endereco, endereco.cep, endereco.endereco, endereco.numero, endereco.bairro, endereco.cidade, endereco.unidadeFederativa

Se enviar plano, exige: plano[].nome

Respostas

• 201 — Operadora criada
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 404 — Unidade Federativa não encontrada
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

POST /operadoras/bulk

Cadastrar várias operadoras de uma vez · Permissão: operadora:create

Até 50 itens por requisição (chave operadoras). 207 = falha parcial, ver resultados; reenvie só os itens com erro.

Corpo (application/json) — obrigatório

Campos obrigatórios: operadoras, operadoras[].nome, operadoras[].descricao, operadoras[].registroANS, operadoras[].cnpj, operadoras[].codigoCNES, operadoras[].endereco, operadoras[].endereco.cep, operadoras[].endereco.endereco, operadoras[].endereco.numero, operadoras[].endereco.bairro, operadoras[].endereco.cidade, operadoras[].endereco.unidadeFederativa

Se enviar operadoras[].plano, exige: operadoras[].plano[].nome

Cada item de operadoras[] tem os mesmos campos de POST /operadoras (máx. 50 itens).

Respostas

• 201 — Todas criadas
• 207 — Falha parcial
• 400 — Lote vazio ou acima de 50 itens
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 429 — Já existe um lote em andamento para esta clínica e recurso
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

GET /operadoras/{id}

Consultar operadora · Permissão: operadora:read

Parâmetros

Respostas

• 200 — Operadora
• 400 — id inválido
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 404 — Operadora não encontrada
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

PUT /operadoras/{id}

Atualizar operadora · Permissão: operadora:update

Envie as listas completas de plano e contato — o servidor compara com o estado atual e cria, atualiza ou remove pra bater com o que foi enviado.

Parâmetros

Corpo (application/json) — obrigatório

Campos obrigatórios: nome, descricao, registroANS, cnpj, codigoCNES, endereco, endereco.cep, endereco.endereco, endereco.numero, endereco.bairro, endereco.cidade, endereco.unidadeFederativa

Se enviar plano, exige: plano[].nome

Respostas

• 202 — Operadora atualizada
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 404 — Operadora ou Unidade Federativa não encontrada
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

DELETE /operadoras/{id}

Desativar operadora · Permissão: operadora:delete

É uma desativação (ativo = false), não uma exclusão física. Recusa (400) se houver convênio ativo vinculado a esta operadora.

Parâmetros

Respostas

• 200 — Diferente do padrão de outros cadastros (sem status/aviso).
• 400 — Existem convênios ativos vinculados a esta operadora — a mensagem inclui o nome da operadora e a contagem
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

GET /fornecedores

Listar fornecedores · Permissão: fornecedor:read

Parâmetros

Respostas

• 200 — Lista paginada
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

POST /fornecedores

Cadastrar fornecedor · Permissão: fornecedor:create

Corpo (application/json) — obrigatório

Campos obrigatórios: nome, cnpj, inscricao, telefoneFornecedor

Respostas

• 201 — Fornecedor criado
• 400 — Dados inválidos
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

POST /fornecedores/bulk

Cadastrar vários fornecedores de uma vez · Permissão: fornecedor:create

Até 50 itens por requisição (chave fornecedores). 207 = falha parcial, ver resultados; reenvie só os itens com erro.

Corpo (application/json) — obrigatório

Campos obrigatórios: fornecedores, fornecedores[].nome, fornecedores[].cnpj, fornecedores[].inscricao, fornecedores[].telefoneFornecedor

Cada item de fornecedores[] tem os mesmos campos de POST /fornecedores (máx. 50 itens).

Respostas

• 201 — Todos criados
• 207 — Falha parcial
• 400 — Lote vazio ou acima de 50 itens
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 429 — Já existe um lote em andamento para esta clínica e recurso
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

GET /fornecedores/{id}

Consultar fornecedor · Permissão: fornecedor:read

Inclui endereço e contatos.

Parâmetros

Respostas

• 200 — Fornecedor
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 404 — Fornecedor não encontrado
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

PUT /fornecedores/{id}

Atualizar fornecedor · Permissão: fornecedor:update

Parâmetros

Corpo (application/json) — obrigatório

Campos obrigatórios: nome, cnpj, inscricao, telefoneFornecedor

Respostas

• 200 — Fornecedor atualizado
• 400 — Dados inválidos
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

GET /fabricantes

Listar fabricantes · Permissão: fabricante:read

Parâmetros

Respostas

• 200 — Lista paginada
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

POST /fabricantes

Cadastrar fabricante · Permissão: fabricante:create

Corpo (application/json) — obrigatório

Campos obrigatórios: nome

Respostas

• 201 — Fabricante criado
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 422 — Falha ao criar fabricante
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

POST /fabricantes/bulk

Cadastrar vários fabricantes de uma vez · Permissão: fabricante:create

Até 50 itens por requisição (chave fabricantes). 207 = falha parcial, ver resultados; reenvie só os itens com erro.

Corpo (application/json) — obrigatório

Campos obrigatórios: fabricantes, fabricantes[].nome

Cada item de fabricantes[] tem os mesmos campos de POST /fabricantes (máx. 50 itens).

Respostas

• 201 — Todos criados
• 207 — Falha parcial
• 400 — Lote vazio ou acima de 50 itens
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 429 — Já existe um lote em andamento para esta clínica e recurso
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

GET /fabricantes/{id}

Consultar fabricante · Permissão: fabricante:read

Parâmetros

Respostas

• 200 — Fabricante
• 400 — id inválido
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 404 — Fabricante não encontrado
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

PUT /fabricantes/{id}

Atualizar fabricante · Permissão: fabricante:update

anexos enviados no corpo vão pra uma tabela separada e não aparecem na resposta.

Parâmetros

Corpo (application/json) — obrigatório

Campos obrigatórios: nome

Respostas

• 202 — Fabricante atualizado — row completa, confirmado batendo com o schema Fabricante.
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 404 — "Failed in Update Fabricante." — mensagem em inglês, inconsistente com o padrão em português do resto da API
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

DELETE /fabricantes/{id}

Desativar fabricante · Permissão: fabricante:delete

É uma desativação lógica, não uma exclusão física.

Parâmetros

Respostas

• 200 — Corpo de sucesso é o número cru 201, não um objeto.
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 404 — "Failed in Delete Grupo Fabricante." — mensagem parece copy-paste de outro contexto ("Grupo Fabricante" não existe aqui)
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

GET /taxas

Listar taxas · Permissão: taxa:read

Parâmetros

Respostas

• 200 — Lista paginada
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

POST /taxas

Cadastrar taxa · Permissão: taxa:create

Corpo (application/json) — obrigatório

Campos obrigatórios: taxas, codigoTaxa, tipoTaxaId, valor

Respostas

• 200 — Taxa criada
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 422 — Erro ao criar taxa (referência inválida)
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

POST /taxas/bulk

Cadastrar várias taxas de uma vez · Permissão: taxa:create

Até 50 itens por requisição (chave taxas). 207 = falha parcial, ver resultados; reenvie só os itens com erro.

Corpo (application/json) — obrigatório

Campos obrigatórios: taxas, taxas[].taxas, taxas[].codigoTaxa, taxas[].tipoTaxaId, taxas[].valor

Cada item de taxas[] tem os mesmos campos de POST /taxas (máx. 50 itens).

Respostas

• 201 — Todas criadas
• 207 — Falha parcial
• 400 — Lote vazio ou acima de 50 itens
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 429 — Já existe um lote em andamento para esta clínica e recurso
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

GET /taxas/{id}

Consultar taxa · Permissão: taxa:read

Parâmetros

Respostas

• 200 — Taxa
• 400 — id inválido
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 404 — Taxa não encontrada
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

PUT /taxas/{id}

Atualizar taxa · Permissão: taxa:update

Parâmetros

Corpo (application/json) — obrigatório

Campos obrigatórios: taxas, codigoTaxa, tipoTaxaId, valor

Respostas

• 200 — Taxa atualizada
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 422 — Erro ao atualizar taxa (referência inválida)
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

DELETE /taxas/{id}

Desativar taxa · Permissão: taxa:delete

É uma desativação lógica — mas diferente dos outros cadastros, o model Taxas não tem campo ativo; usa delete: true (mapeado pra coluna deleted), é o único recurso desta lista que funciona assim. Recusa com 409 se a taxa estiver na composição de algum serviço ativo: a resposta traz a lista em servicos; corrija a composição e tente de novo. Serviço inativo não bloqueia.

Parâmetros

Respostas

• 200 — Corpo de sucesso é o número cru 201, não um objeto.
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 404 — Taxa não encontrada
• 409 — Taxa na composição de serviço ativo
• 422 — Erro ao excluir taxa
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

GET /produtos

Listar produtos · Permissão: produto:read

Parâmetros

Respostas

• 200 — Lista paginada
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

POST /produtos

Cadastrar produto · Permissão: produto:create

Corpo (application/json) — obrigatório

Campos obrigatórios: nome, codigoProduto, apresentacao, contendo, depositoId, tipoProdutoId, fabricanteId, unidadeDeMedidaId, prazoDeReposicao

Respostas

• 201 — Produto criado
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 422 — Falha ao criar produto (referência inválida)
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

POST /produtos/bulk

Cadastrar vários produtos de uma vez · Permissão: produto:create

Até 50 itens por requisição (chave produtos). 207 = falha parcial, ver resultados; reenvie só os itens com erro.

Corpo (application/json) — obrigatório

Campos obrigatórios: produtos, produtos[].nome, produtos[].codigoProduto, produtos[].apresentacao, produtos[].contendo, produtos[].depositoId, produtos[].tipoProdutoId, produtos[].fabricanteId, produtos[].unidadeDeMedidaId, produtos[].prazoDeReposicao

Cada item de produtos[] tem os mesmos campos de POST /produtos (máx. 50 itens).

Respostas

• 201 — Todos criados
• 207 — Falha parcial
• 400 — Lote vazio ou acima de 50 itens
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 429 — Já existe um lote em andamento para esta clínica e recurso
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

GET /produtos/{id}

Consultar produto · Permissão: produto:read

Parâmetros

Respostas

• 200 — Produto
• 400 — id inválido
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 404 — Produto não encontrado
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

PUT /produtos/{id}

Atualizar produto · Permissão: produto:update

Status HTTP real é 200, não 202. Devolve a row crua do Prisma (update sem include) — FKs como fabricanteId/tipoProdutoId/depositoId/etc aparecem como inteiros, não como os objetos aninhados que o schema Produto usa nas rotas de leitura (aquele formato só existe nos GETs, que fazem include). fornecedores e anexos enviados no corpo são persistidos, mas não aparecem na resposta.

Parâmetros

Corpo (application/json) — obrigatório

Campos obrigatórios: nome, codigoProduto, apresentacao, contendo, depositoId, tipoProdutoId, fabricanteId, unidadeDeMedidaId, prazoDeReposicao

Respostas

• 200 — Row crua de Produto, sem includes — ver descrição.
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 409 — ativo: false recusado: produto na composição de serviço ativo
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

DELETE /produtos/{id}

Desativar produto · Permissão: produto:delete

É uma desativação (ativo = false), não uma exclusão física. Também desativa os fornecedores vinculados e remove a configuração de estoque do produto (hard delete). Recusa com 409 se o produto estiver na composição de algum serviço ativo: a resposta traz a lista em servicos; corrija a composição (substitua ou retire o produto) e tente de novo. Serviço inativo não bloqueia. O mesmo bloqueio vale para PUT /produtos/{id} com ativo: false.

Parâmetros

Respostas

• 200 — Corpo de sucesso é o número cru 201, não um objeto.
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 404 — Produto não encontrado
• 409 — Produto na composição de serviço ativo
• 500 — Erro ao excluir produto
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

GET /equipamentos

Listar equipamentos · Permissão: equipamento:read

Parâmetros

Respostas

• 200 — Lista paginada
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

POST /equipamentos

Cadastrar equipamento · Permissão: equipamento:create

Recusa (409) se já existir um equipamento ativo com o mesmo nome.

Corpo (application/json) — obrigatório

Campos obrigatórios: nome

Respostas

• 201 — Equipamento criado
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 409 — Este equipamento já foi cadastrado
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

POST /equipamentos/bulk

Cadastrar vários equipamentos de uma vez · Permissão: equipamento:create

Até 50 itens por requisição (chave equipamentos). 207 = falha parcial, ver resultados; reenvie só os itens com erro.

Corpo (application/json) — obrigatório

Campos obrigatórios: equipamentos, equipamentos[].nome

Cada item de equipamentos[] tem os mesmos campos de POST /equipamentos (máx. 50 itens).

Respostas

• 201 — Todos criados
• 207 — Falha parcial
• 400 — Lote vazio ou acima de 50 itens
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 429 — Já existe um lote em andamento para esta clínica e recurso
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

GET /equipamentos/{id}

Consultar equipamento · Permissão: equipamento:read

Parâmetros

Respostas

• 200 — Equipamento
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 404 — Equipamento não encontrado
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

PUT /equipamentos/{id}

Atualizar equipamento · Permissão: equipamento:update

Recusa (422) se já existir outro equipamento ativo com o mesmo nome.

Parâmetros

Corpo (application/json) — obrigatório

Campos obrigatórios: nome

Respostas

• 202 — Equipamento atualizado
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 422 — Nome já usado por outro equipamento
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

DELETE /equipamentos/{id}

Desativar equipamento · Permissão: equipamento:delete

É uma desativação (ativo = false), não uma exclusão física.

Parâmetros

Respostas

• 200 — Corpo de sucesso é o número cru 201, não um objeto.
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 404 — Equipamento não encontrado
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

GET /servicos

Listar serviços · Permissão: servico:read

Parâmetros

Respostas

• 200 — Lista paginada (versão resumida de cada serviço)
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

POST /servicos

Cadastrar serviço · Permissão: servico:create

Corpo (application/json) — obrigatório

Campos obrigatórios: nome, descricao

Se enviar documentos, exige: documentos[].id

Se enviar servicoTaxa, exige: servicoTaxa[].taxaId

Respostas

• 201 — Serviço criado
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

POST /servicos/bulk

Cadastrar vários serviços de uma vez · Permissão: servico:create

Até 50 itens por requisição (chave servicos). 207 = falha parcial, ver resultados; reenvie só os itens com erro.

Corpo (application/json) — obrigatório

Campos obrigatórios: servicos, servicos[].nome, servicos[].descricao

Se enviar servicos[].documentos, exige: servicos[].documentos[].id

Se enviar servicos[].servicoTaxa, exige: servicos[].servicoTaxa[].taxaId

Cada item de servicos[] tem os mesmos campos de POST /servicos (máx. 50 itens).

Respostas

• 201 — Todos criados
• 207 — Falha parcial
• 400 — Lote vazio ou acima de 50 itens
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 429 — Já existe um lote em andamento para esta clínica e recurso
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

GET /servicos/{id}

Consultar serviço · Permissão: servico:read

Traz o serviço completo, incluindo composição (servicosRelacionados), especialidades (especialidadesId), documentos obrigatórios (documentos), produtos (produtoIds, valor em reais), equipamentos (equipamentoIds) e taxas (servicoTaxa) — com os mesmos nomes que o PUT aceita (também somarItems, procedimentos, tipoAtendimento, perfilFiscalId). Ler e reenviar sem alterar não muda nada.

Parâmetros

Respostas

• 200 — Serviço
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 404 — Serviço não encontrado
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

PUT /servicos/{id}

Atualizar serviço · Permissão: servico:update

Atualização parcial: envie só o que quer mudar — todos os campos são opcionais.

• Campo omitido: mantém o valor atual.
• null: limpa o campo (ex.: linkAuxiliar: null, perfilFiscalId: null; valor: null vira 0).
• Lista omitida (documentos, produtoIds, equipamentoIds, servicoTaxa, especialidadesId, servicosRelacionados): mantém os vínculos atuais.
• Lista enviada: substitui os vínculos por exatamente o que veio. Para remover todos, envie [].

Ex.: { "nome": "X" } só renomeia; { "documentos": [{ "id": 3 }] } deixa só o documento 3.

Parâmetros

Corpo (application/json) — obrigatório

Campos obrigatórios: nome, descricao

Se enviar documentos, exige: documentos[].id

Se enviar servicoTaxa, exige: servicoTaxa[].taxaId

Respostas

• 202 — Serviço atualizado
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

DELETE /servicos/{id}

Desativar serviço · Permissão: servico:delete

É uma desativação (ativo = false), não uma exclusão física.

Parâmetros

Respostas

• 200 — Corpo de sucesso é o número cru 201, não um objeto.
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 404 — Serviço não encontrado
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

GET /colaboradores

Listar colaboradores · Permissão: colaborador:read

Parâmetros

Respostas

• 200 — Lista paginada
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

POST /colaboradores

Cadastrar colaborador · Permissão: colaborador:create

Não cria acesso de login ao sistema — só o cadastro.

Corpo (application/json) — obrigatório

Campos obrigatórios: nome, cpf, dataDeNascimento, sexoId, telefone, celular, email, endereco, endereco.cep, endereco.endereco, endereco.numero, endereco.bairro, endereco.cidade, endereco.unidadeFederativa

Se enviar conselho, exige: conselho[].uf, conselho[].descricao, conselho[].registroConselho

Se enviar especialidades, exige: especialidades[].uf, especialidades[].numeroConselho, especialidades[].especialidadeId, especialidades[].conselhoProfissionalId

Se enviar vinculoRepasse.produtos, exige: vinculoRepasse.produtos[].valorPercentual, vinculoRepasse.produtos[].valorMonetario, vinculoRepasse.produtos[].tipoCalculo

Se enviar vinculoRepasse.servicos, exige: vinculoRepasse.servicos[].valorPercentual, vinculoRepasse.servicos[].valorMonetario, vinculoRepasse.servicos[].tipoCalculo

Se enviar vinculoRepasse.taxas, exige: vinculoRepasse.taxas[].valorPercentual, vinculoRepasse.taxas[].valorMonetario, vinculoRepasse.taxas[].tipoCalculo

Respostas

• 201 — Colaborador criado
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

POST /colaboradores/bulk

Cadastrar vários colaboradores de uma vez · Permissão: colaborador:create

Até 50 itens por requisição (chave colaboradores). 207 = falha parcial, ver resultados; reenvie só os itens com erro. Não cria acesso de login.

Corpo (application/json) — obrigatório

Campos obrigatórios: colaboradores, colaboradores[].nome, colaboradores[].cpf, colaboradores[].dataDeNascimento, colaboradores[].sexoId, colaboradores[].telefone, colaboradores[].celular, colaboradores[].email, colaboradores[].endereco, colaboradores[].endereco.cep, colaboradores[].endereco.endereco, colaboradores[].endereco.numero, colaboradores[].endereco.bairro, colaboradores[].endereco.cidade, colaboradores[].endereco.unidadeFederativa

Se enviar colaboradores[].conselho, exige: colaboradores[].conselho[].uf, colaboradores[].conselho[].descricao, colaboradores[].conselho[].registroConselho

Se enviar colaboradores[].especialidades, exige: colaboradores[].especialidades[].uf, colaboradores[].especialidades[].numeroConselho, colaboradores[].especialidades[].especialidadeId, colaboradores[].especialidades[].conselhoProfissionalId

Se enviar colaboradores[].vinculoRepasse.produtos, exige: colaboradores[].vinculoRepasse.produtos[].valorPercentual, colaboradores[].vinculoRepasse.produtos[].valorMonetario, colaboradores[].vinculoRepasse.produtos[].tipoCalculo

Se enviar colaboradores[].vinculoRepasse.servicos, exige: colaboradores[].vinculoRepasse.servicos[].valorPercentual, colaboradores[].vinculoRepasse.servicos[].valorMonetario, colaboradores[].vinculoRepasse.servicos[].tipoCalculo

Se enviar colaboradores[].vinculoRepasse.taxas, exige: colaboradores[].vinculoRepasse.taxas[].valorPercentual, colaboradores[].vinculoRepasse.taxas[].valorMonetario, colaboradores[].vinculoRepasse.taxas[].tipoCalculo

Cada item de colaboradores[] tem os mesmos campos de POST /colaboradores (máx. 50 itens).

Respostas

• 201 — Todos criados
• 207 — Falha parcial
• 400 — Lote vazio ou acima de 50 itens
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 429 — Já existe um lote em andamento para esta clínica e recurso
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

GET /colaboradores/{id}

Consultar colaborador · Permissão: colaborador:read

Parâmetros

Respostas

• 200 — Colaborador
• 400 — id inválido
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 404 — Colaborador não encontrado
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

PUT /colaboradores/{id}

Atualizar colaborador · Permissão: colaborador:update

Não devolve o colaborador atualizado — o corpo de sucesso é o número cru 201. É a exceção real dentro do padrão "PUT devolve o recurso" usado no resto da API.

Atualização parcial: campo omitido mantém o valor atual; null limpa; lista omitida mantém; lista enviada substitui ([] apaga).

• Não reativa colaborador desativado.
• vinculoRepasse: tipoVinculo omitido mantém (null desvincula); produtos, servicos e taxas são trocadas só quando enviadas.
• perguntasIds omitido mantém.
• endereco: aceita os nomes da leitura (Cep, Endereco, Numero...) e unidadeFederativaId; sem UF mantém a atual.
• O GET /colaboradores/{id} devolve perguntasIds, vinculoRepasse e mensagem no formato deste PUT.

Parâmetros

Corpo (application/json) — obrigatório

Campos obrigatórios: nome, cpf, dataDeNascimento, sexoId, telefone, celular, email, endereco, endereco.cep, endereco.endereco, endereco.numero, endereco.bairro, endereco.cidade, endereco.unidadeFederativa

Se enviar conselho, exige: conselho[].uf, conselho[].descricao, conselho[].registroConselho

Se enviar especialidades, exige: especialidades[].uf, especialidades[].numeroConselho, especialidades[].especialidadeId, especialidades[].conselhoProfissionalId

Se enviar vinculoRepasse.produtos, exige: vinculoRepasse.produtos[].valorPercentual, vinculoRepasse.produtos[].valorMonetario, vinculoRepasse.produtos[].tipoCalculo

Se enviar vinculoRepasse.servicos, exige: vinculoRepasse.servicos[].valorPercentual, vinculoRepasse.servicos[].valorMonetario, vinculoRepasse.servicos[].tipoCalculo

Se enviar vinculoRepasse.taxas, exige: vinculoRepasse.taxas[].valorPercentual, vinculoRepasse.taxas[].valorMonetario, vinculoRepasse.taxas[].tipoCalculo

Respostas

• 202 — Corpo de sucesso é o número cru 201, não o objeto Colaborador.
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

DELETE /colaboradores/{id}

Desativar colaborador · Permissão: colaborador:delete

É uma desativação (ativo = false), não uma exclusão física. Desativa também as grades, especialidades e vínculos de empresa do colaborador. Avisa (mas não bloqueia) se houver agendamento futuro.

Parâmetros

Respostas

• 200 — Segue o padrão canônico (igual convênio).
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 404 — Colaborador não encontrado
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

POST /colaboradores/{id}/usuario

Criar login (Keycloak) para o colaborador · Permissão: colaborador:update

Cria um acesso de login de verdade ao sistema para este colaborador (email + senha) — diferente do POST /colaboradores/PUT /colaboradores/{id}, que só cadastram dados e nunca criam acesso. Falha se o colaborador já tiver login.

Parâmetros

Corpo (application/json) — obrigatório

Campos obrigatórios: email, senha

Respostas

• 201 — Login criado
• 400 — Email ausente, ou senha com menos de 8 caracteres
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 404 — Colaborador não encontrado
• 409 — Este colaborador já tem login
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

GET /grades-colaborador

Listar grade de colaborador · Permissão: gradeColaborador:read

Paginado de verdade — use page/pageSize e os filtros abaixo para não trazer a grade inteira da clínica.

Parâmetros

Respostas

• 200 — Lista paginada
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

POST /grades-colaborador

Cadastrar horário(s) de grade · Permissão: gradeColaborador:create

Já checa conflito de horário — retorna erro se o novo horário colidir com um existente.

Corpo (application/json) — obrigatório

Campos obrigatórios: colaboradorGrade, colaboradorGrade[].colaboradorId, colaboradorGrade[].inicioAtendimento, colaboradorGrade[].fimAtendimento, colaboradorGrade[].tempoAtendimento, colaboradorGrade[].repetir, colaboradorGrade[].diasDaSemana

Respostas

• 201 — Grade(s) criada(s) — comportamento real, não o esperado: o corpo é um array de null, um por item enviado (ex.: [null, null] para 2 horários). A resposta não devolve os registros criados nem seus ids; se precisar do id, consulte depois por GET /grades-colaborador?colaboradorId=....
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 409 — Conflito de horário com uma grade já existente
• 422 — Falha ao criar grade do colaborador
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

GET /grades-colaborador/filter

Filtrar grade de colaborador · Permissão: gradeColaborador:read

Parâmetros

Respostas

• 200 — Lista filtrada
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

GET /grades-colaborador/{id}

Consultar horário de grade · Permissão: gradeColaborador:read

Parâmetros

Respostas

• 200 — Horário de grade
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 404 — Grade não encontrada
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

PUT /grades-colaborador/{id}

Atualizar horário de grade · Permissão: gradeColaborador:update

O id do path é ignorado — o corpo é um array direto (não um envelope) e cada item precisa ter o próprio id. Erros de negócio (ex.: grade não encontrada) caem no tratamento genérico e viram 500, não 404.

Atualização parcial: campo omitido mantém o valor atual; null limpa; lista omitida mantém; lista enviada substitui ([] apaga).

• agendamentoOnline e modoConvenio (INCLUIR/EXCLUIR) omitidos mantêm — trocar o modo inverte o sentido da lista de convênios.
• limitesConvenio (limites por convênio no modo EXCLUIR) só muda quando enviado; mandar só a lista de convênios não apaga os limites.

Parâmetros

Corpo (application/json) — obrigatório

Campos obrigatórios: [].colaboradorId, [].inicioAtendimento, [].fimAtendimento, [].tempoAtendimento, [].repetir, [].diasDaSemana, [].id

Respostas

• 202 — Status real é 202, não 200. O corpo de sucesso é o número cru 201 (não um objeto, não a grade atualizada) — comportamento observado, não documentação de intenção.
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

DELETE /grades-colaborador/{id}

Excluir este e os próximos horários da série · Permissão: gradeColaborador:delete

Inativação lógica (ativo=false).

Parâmetros

Respostas

• 200 — O corpo de sucesso é o número cru 201, não um objeto — mesmo padrão de PUT.
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 404 — Grade não encontrada
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

DELETE /grades-colaborador/unique/{id}

Excluir só este horário (não a série) · Permissão: gradeColaborador:delete

Diferente do DELETE de série: este é uma exclusão física (prisma.colaboradorGrade.delete), não inativação lógica.

Parâmetros

Respostas

• 200 — O corpo de sucesso é o número cru 201, não um objeto.
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 404 — Grade não encontrada — inclusive em erro de integridade referencial (FK), não só "não existe"
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

GET /grades-equipamento

Listar grade de equipamento · Permissão: gradeEquipamento:read

Paginado de verdade — use page/pageSize e os filtros abaixo para não trazer a grade inteira da clínica.

Parâmetros

Respostas

• 200 — Lista paginada
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

POST /grades-equipamento

Cadastrar horário(s) de grade · Permissão: gradeEquipamento:create

O corpo é a lista direto (sem envelope). Já checa conflito de horário. Bug conhecido: essa rota (e o PUT/DELETE de /grades-equipamento/{id}) chama redis.deleteByPattern(...) sem checar se redis existe — como a autenticação por chave de API nunca popula isso, a chamada quebra depois que a escrita no banco já foi commitada. Na prática, hoje, criar/atualizar/excluir grade de equipamento por API key grava certo mas devolve 500 em vez do sucesso esperado. Reportado ao time; use com cautela até ser corrigido.

Corpo (application/json) — obrigatório

Campos obrigatórios: [].localId, [].equipamentoId, [].diaDaSemana, [].inicioAtendimento, [].fimAtendimento, [].gradeEmMinutos

Respostas

• 201 — Sujeito ao bug de redis acima. Quando não bate no bug, o corpo de sucesso é o número cru 201, não um objeto.
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 422 — Falha ao criar grade de equipamento (conflito de horário, entre outros)
• 500 — Bug conhecido de redis undefined — ver descrição acima. A escrita pode ter sido efetivada mesmo com esse erro.
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

GET /grades-equipamento/{id}

Consultar horário de grade · Permissão: gradeEquipamento:read

Parâmetros

Respostas

• 200 — Horário de grade
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 404 — Grade não encontrada
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

PUT /grades-equipamento/{id}

Atualizar horário de grade · Permissão: gradeEquipamento:update

Mesmo bug de redis undefined do POST — ver descrição de POST /grades-equipamento.

Atualização parcial: campo omitido mantém o valor atual; null limpa; lista omitida mantém; lista enviada substitui ([] apaga).

• Listas profissionais (aceita também colaboradores, nome usado na leitura), convenios e servicos: omitidas mantêm, enviadas substituem.
• exibirNoAgendamento omitido mantém.

Parâmetros

Corpo (application/json) — obrigatório

Campos obrigatórios: localId, equipamentoId, diaDaSemana, inicioAtendimento, fimAtendimento, gradeEmMinutos

Respostas

• 202 — Status real 202, não 200. Sujeito ao bug de redis (500). Corpo de sucesso, quando não bate no bug: número cru 201.
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 404 — Grade não encontrada
• 500 — Bug conhecido de redis undefined — ver descrição de POST /grades-equipamento.
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

DELETE /grades-equipamento/{id}

Excluir horário de grade · Permissão: gradeEquipamento:delete

Inativação lógica (ativo=false). Mesmo bug de redis undefined do POST.

Parâmetros

Respostas

• 200 — Sujeito ao bug de redis (500). Corpo de sucesso, quando não bate no bug: número cru 201.
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 404 — Grade não encontrada
• 500 — Bug conhecido de redis undefined — ver descrição de POST /grades-equipamento.
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

GET /convenios

Listar convênios · Permissão: convenio:read

Parâmetros

Respostas

• 200 — Lista paginada
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

POST /convenios

Cadastrar convênio · Permissão: convenio:create

Corpo (application/json) — obrigatório

Campos obrigatórios: descricao, dataInicio, empresaId, unidadesIds

Se enviar politicasPorTipoProduto, exige: politicasPorTipoProduto[].tipoProdutoId, politicasPorTipoProduto[].fatorK, politicasPorTipoProduto[].idJson

Respostas

• 201 — Convênio criado
• 401 — Token ausente, inválido, revogado ou expirado
• 403 — A chave não tem a permissão exigida pela rota (devolvida em escopoFaltante)
• 409 — CNPJ já existe no sistema
• 422 — Referência inválida (empresa, operadora ou kit não encontrado)
• 503 — Não foi possível validar a chave no momento — falha de rede/indisponibilidade, não problema com a chave em si

POST /convenios/bulk

Cadastrar vários convênios de uma vez · Permissão: convenio:create

Cria até 50 convênios por requisição. Cada convênio é validado e gravado de forma independente: um item com erro não impede os demais, e um convênio nunca fica gravado pela metade (cada um é gravado em uma transação própria).

Validações feitas antes de gravar

• Formato de cada item (campos obrigatórios, tipos, datas, CNPJ com 14 dígitos).
• empresaId, unidadesIds e operadoraId existem na clínica.
• CNPJ já cadastrado na clínica (com ou sem máscara) ou repetido dentro do próprio lote. Nesse caso, apenas a primeira ocorrência é criada.

Como interpretar a resposta

• 201: todos os convênios foram criados.
• 207: ao menos um item falhou. Confira resultados, item a item, pelo indice. Os itens CRIADO já foram gravados.
• Para tentar de novo, reenvie apenas os itens com ERRO ou NAO_PROCESSADO. Reenviar o lote inteiro é seguro: os já criados serão recusados por CNPJ duplicado.

Limites

• Máximo de 50 convênios por requisição (400 acima disso).
• Só um lote por vez por clínica: um segundo lote enquanto o primeiro roda recebe 429.
• O processamento é interrompido após 45 segundos. Os itens restantes voltam como NAO_PROCESSADO.

Corpo (application/json) — obrigatório

Campos obrigatórios: convenios, convenios[].cnpj, convenios[].descricao, convenios[].dataInicio, convenios[].empresaId, convenios[].unidadesIds

Se enviar convenios[].politicasPorTipoProduto, exige: convenios[].politicasPorTipoProduto[].tipoProdutoId, convenios[].politicasPorTipoProduto[].fatorK, convenios[].politicasPorTipoProduto[].idJson