Pular para conteúdo
Postman

Filiais

Filiais são unidades opcionais vinculadas a um cliente, usadas para segregação interna. Licenças e pacientes vinculados a uma filial contabilizam nos totais do cliente.

GET /branch

Retorna a lista paginada de filiais.

Parâmetros da Query

Nome Tipo Obrigatório Descrição
page integer não Número da página (padrão: 0)
size integer não Itens por página (padrão: 20)
sort string não Ordenação (ex: name,asc)
index string não Filtro de busca por nome

Cabeçalhos

Header Valor
Authorization Bearer {token}
Accept application/hal+json

Exemplo de Requisição

Bash
curl -X GET "https://api-portal.mediquo.com.br/branch?page=0&size=20" \
  -H "Authorization: Bearer {seu_token}" \
  -H "Accept: application/hal+json"

Respostas

Código Descrição
200 Lista paginada de filiais
401 Token inválido ou expirado
403 Sem permissão

GET /branch/{id}

Retorna os dados de uma filial específica.

Parâmetros do Path

Nome Tipo Obrigatório Descrição
id integer sim ID da filial

Cabeçalhos

Header Valor
Authorization Bearer {token}
Accept application/hal+json

Exemplo de Requisição

Bash
curl -X GET https://api-portal.mediquo.com.br/branch/1 \
  -H "Authorization: Bearer {seu_token}" \
  -H "Accept: application/hal+json"

Respostas

Código Descrição
200 Dados da filial
401 Token inválido ou expirado
403 Sem permissão
404 Filial não encontrada

GET /branch/client/{id}

Retorna a lista paginada de filiais de um cliente específico.

Parâmetros do Path

Nome Tipo Obrigatório Descrição
id integer sim ID do cliente

Parâmetros da Query

Nome Tipo Obrigatório Descrição
page integer não Número da página (padrão: 0)
size integer não Itens por página (padrão: 20)
sort string não Ordenação (ex: name,asc)

Cabeçalhos

Header Valor
Authorization Bearer {token}
Accept application/hal+json

Exemplo de Requisição

Bash
curl -X GET "https://api-portal.mediquo.com.br/branch/client/1?page=0&size=20" \
  -H "Authorization: Bearer {seu_token}" \
  -H "Accept: application/hal+json"

Respostas

Código Descrição
200 Lista paginada de filiais do cliente
401 Token inválido ou expirado
403 Sem permissão
404 Cliente não encontrado

GET /branch/suspension-status/{id}

Retorna o status de suspensão de uma filial.

Suspensão de Filiais

Não existe endpoint para suspender ou desuspender uma filial diretamente. A suspensão ocorre automaticamente em cascata quando o cliente pai é suspenso via PUT /clients/suspend/{id} e é revertida via PUT /clients/unsuspend/{id}.

Parâmetros do Path

Nome Tipo Obrigatório Descrição
id integer sim ID da filial

Cabeçalhos

Header Valor
Authorization Bearer {token}
Accept application/hal+json

Exemplo de Requisição

Bash
curl -X GET https://api-portal.mediquo.com.br/branch/suspension-status/1 \
  -H "Authorization: Bearer {seu_token}" \
  -H "Accept: application/hal+json"

Resposta de Sucesso: 200 OK

JSON
{
  "id": 1,
  "name": "Filial Centro",
  "suspended": true,
  "suspensionReason": "NON_PAYMENT",
  "suspensionReasonDescription": "Fatura em aberto há 30 dias",
  "suspendedAt": "2025-01-20T10:00:00.000Z",
  "suspendedBy": 42,
  "suspendedByName": "Administrador"
}

Respostas de Erro

Código Descrição
401 Token inválido ou expirado
403 Sem permissão
404 Filial não encontrada

POST /branch

Cria uma nova filial vinculada a um cliente.

Cabeçalhos

Header Valor
Authorization Bearer {token}
Content-Type application/json
Accept application/hal+json

Corpo da Requisição

Campo Tipo Obrigatório Descrição
name string sim Nome da filial
clientId integer sim ID do cliente
personType string sim FISICA ou JURIDICA
email string não E-mail de contato
phoneNumber string não Telefone de contato
documentNumber string não CPF ou CNPJ (somente números)
maxLicenses integer não Limite máximo de licenças
userRoot object não Dados do usuário administrador da filial

Objeto userRoot

Campo Tipo Obrigatório Descrição
fullName string sim Nome completo
email string não E-mail de acesso
password string sim Senha de acesso

Exemplo de Requisição

Bash
curl -X POST https://api-portal.mediquo.com.br/branch \
  -H "Authorization: Bearer {seu_token}" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Filial Centro",
    "clientId": 1,
    "personType": "JURIDICA",
    "email": "filial.centro@empresa.com",
    "phoneNumber": "11988888888",
    "documentNumber": "12345678000199",
    "userRoot": {
      "fullName": "Gerente Filial",
      "email": "gerente@empresa.com",
      "password": "senha_segura_123"
    }
  }'

Resposta de Sucesso: 201 Created

JSON
{
  "id": 1,
  "name": "Filial Centro",
  "clientId": 1,
  "personType": "JURIDICA",
  "email": "filial.centro@empresa.com",
  "phoneNumber": "11988888888",
  "documentNumber": "12345678000199",
  "active": true,
  "maxLicenses": null,
  "createdAt": "2025-01-27T10:00:00.000Z",
  "updatedAt": "2025-01-27T10:00:00.000Z"
}

Respostas de Erro

Código Descrição
400 Campos obrigatórios ausentes ou inválidos
401 Token inválido ou expirado
403 Sem permissão
404 Cliente não encontrado
409 Já existe uma filial com esse documento

PUT /branch/{id}

Atualiza os dados de uma filial.

Parâmetros do Path

Nome Tipo Obrigatório Descrição
id integer sim ID da filial

Cabeçalhos

Header Valor
Authorization Bearer {token}
Content-Type application/json
Accept application/hal+json

Corpo da Requisição

Campo Tipo Obrigatório Descrição
name string sim Nome da filial
clientId integer sim ID do cliente
personType string sim FISICA ou JURIDICA
email string não E-mail de contato
phoneNumber string não Telefone de contato
documentNumber string não CPF ou CNPJ
active boolean não Status da filial
maxLicenses integer não Limite máximo de licenças

Exemplo de Requisição

```bash curl -X PUT https://api-portal.mediquo.com.br/branch/1 \ -H "Authorization: Bearer {seu_token}" \ -H "Content-Type: application/json" \ -d '{ "name": "Filial Centro -