API docs by Redocly

hortas-comunitarias (1.0.0)

Download OpenAPI specification:

Sessions

Funções para entrada no sistema

login

Gera um JWT token e "loga" na aplicação. Sem ele 99% das rotas são bloqueadas.

Escopo por cargo: Rota pública.

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "email": "{{EMAIL_ADM}}",
  • "senha": "{{SENHA_ADM}}"
}

cadastro

Cria uma nova associação e um usuário administrador associado à mesma, configurando também a primeira mensalidade para 30 dias.

Escopo por cargo: Rota pública.

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "associacao": {},
  • "usuario": {
    }
}

Endereços

Gerenciamento de endereços vinculados a entidades do sistema.

endereços

Lista todos os endereços não excluídos.

Escopo por cargo:

Cargo Contexto
Administração da Plataforma Lista todos os endereços não excluídos
Administração da Associação Lista todos os endereços não excluídos
Administração da Horta Lista todos os endereços não excluídos
Canteirista Lista todos os endereços não excluídos
Dependente Lista todos os endereços não excluídos

Responses

endereços

Cria um novo endereço.

Escopo por cargo:

Cargo Contexto
Administração da Plataforma Pode criar endereços
Administração da Associação Pode criar endereços
Administração da Horta Pode criar endereços
Canteirista Sem permissão
Dependente Sem permissão
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "tipo_logradouro": "Rua",
  • "logradouro": "Sebastião Johnny",
  • "numero": "211",
  • "complemento": "Casa verde",
  • "bairro": "Costa e Silva",
  • "cidade": "Joinville",
  • "estado": "SC",
  • "cep": "123456789",
  • "latitude": 90,
  • "longitude": 180
}

endereço por UUID

Busca um endereço específico pelo UUID.

path Parameters
uuid_de_um_endereco
required
string

Responses

endereços

Atualiza um endereço existente.

Escopo por cargo:

Cargo Contexto
Administração da Plataforma Pode atualizar qualquer endereço
Administração da Associação Pode atualizar qualquer endereço
Administração da Horta Pode atualizar qualquer endereço
Canteirista Sem permissão
Dependente Sem permissão
path Parameters
uuid_de_um_endereco
required
string
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "tipo_logradouro": "Rua",
  • "logradouro": "Sebastião Bob",
  • "numero": "112",
  • "complemento": "Casa amarela",
  • "bairro": "Aventureiro",
  • "cidade": "Joinville",
  • "estado": "SC",
  • "cep": "987654321",
  • "latitude": -1,
  • "longitude": 90,
  • "excluido": false
}

endereços

Realiza exclusão lógica de um endereço (marca excluido = 1).

Escopo por cargo:

Cargo Contexto
Administração da Plataforma Pode excluir qualquer endereço
Administração da Associação Pode excluir qualquer endereço
Administração da Horta Pode excluir qualquer endereço
Canteirista Sem permissão
Dependente Sem permissão
path Parameters
uuid_de_um_endereco
required
string

Responses

Associações

Gerencia entidade Associações que representa uma associação de moradores.

associações

Lista todas as associações não excluídas do sistema.

Escopo por cargo:

Cargo Contexto
Administração da Plataforma Acesso completo. Visualiza todas as associações do sistema.
Administração da Associação Sem permissão. Lança exceção.
Administração da Horta Sem permissão. Lança exceção.
Canteirista Sem permissão. Lança exceção.
Dependente Sem permissão. Lança exceção.

Responses

associações

Cria uma nova associação no sistema.

Escopo por cargo:

Cargo Contexto
Administração da Plataforma Pode criar associações. Todos os campos são obrigatórios exceto URLs. status_aprovacao é definido automaticamente como 1.
NEW_ACCOUNT Pode criar associações (caso especial). endereco_uuid e url_estatuto_social_pdf são opcionais. status_aprovacao é definido como 1.
Administração da Associação Sem permissão. Lança exceção.
Administração da Horta Sem permissão. Lança exceção.
Canteirista Sem permissão. Lança exceção.
Dependente Sem permissão. Lança exceção.
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{}

associações por UUID

Busca uma associação específica pelo UUID.

Escopo por cargo:

Cargo Contexto
Administração da Plataforma Acesso completo. Visualiza todas as associações do sistema.
Administração da Associação Sem permissão. Lança exceção.
Administração da Horta Sem permissão. Lança exceção.
Canteirista Sem permissão. Lança exceção.
Dependente Sem permissão. Lança exceção.
path Parameters
uuid_de_uma_associacao
required
string

Responses

associações

Atualiza uma associação existente.

Escopo por cargo:

Cargo Contexto
Administração da Plataforma Acesso completo. Pode atualizar qualquer associação. Todos os campos são opcionais exceto endereco_uuid.
Administração da Associação Sem permissão. Lança exceção.
Administração da Horta Sem permissão. Lança exceção.
Canteirista Sem permissão. Lança exceção.
Dependente Sem permissão. Lança exceção.
path Parameters
uuid_de_uma_associacao
required
string
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "cnpj": "00.000.000/0003-00",
  • "razao_social": "Assoc teste LTDA",
  • "nome_fantasia": "Assoc teste LTDA",
  • "endereco_uuid": "{{uuid_de_um_endereco}}",
  • "url_estatuto_social_pdf": "https://www.google.drive.com",
  • "url_ata_associacao_pdf": "https://www.google.drive.com",
  • "status_aprovacao": "1"
}

associações

Realiza exclusão lógica de uma associação (marca como excluída).

Escopo por cargo:

Cargo Contexto
Administração da Plataforma Acesso completo. Pode excluir (logicamente) qualquer associação.
Administração da Associação Sem permissão. Lança exceção.
Administração da Horta Sem permissão. Lança exceção.
Canteirista Sem permissão. Lança exceção.
Dependente Sem permissão. Lança exceção.
path Parameters
uuid_de_uma_associacao
required
string

Responses

Hortas

Gerencia informações das hortas vinculadas às associações e usuários.

hortas

Lista todas as hortas disponíveis de acordo com o cargo do usuário.

Escopo por cargo:

Cargo Contexto
Administração da Plataforma Pode visualizar todas as hortas.
Administração da Associação Apenas hortas da sua associação.
Administração da Horta Apenas sua própria horta.
Canteirista Apenas sua própria horta.
Dependente Apenas sua própria horta.

Responses

hortas

Cria uma nova horta no sistema.

Escopo por cargo:

Cargo Contexto
Administração da Plataforma Pode criar hortas para qualquer associação.
Administração da Associação Só pode criar hortas para a própria associação.
Administração da Horta Sem permissão.
Canteirista Sem permissão.
Dependente Sem permissão.
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "nome_da_horta": "Horta Feliz Costa e Silva",
  • "percentual_taxa_associado": 25,
  • "tipo_de_liberacao": 1,
  • "associacao_vinculada_uuid": "{{uuid_de_uma_associacao}}",
  • "endereco_uuid": "{{uuid_de_um_endereco}}"
}

horta por UUID

Busca uma horta específica pelo UUID.

path Parameters
uuid_de_uma_horta
required
string

Responses

hortas

Atualiza informações de uma horta existente.

Escopo por cargo:

Cargo Contexto
Administração da Plataforma Pode atualizar qualquer horta.
Administração da Associação Pode atualizar apenas hortas da sua associação.
Administração da Horta Pode atualizar apenas sua própria horta.
Canteirista Sem permissão.
Dependente Sem permissão.
path Parameters
uuid_de_uma_horta
required
string
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "nome_da_horta": "Horta Triste Fátima",
  • "percentual_taxa_associado": 20,
  • "associacao_vinculada_uuid": "{{uuid_de_uma_associacao}}",
  • "endereco_uuid": "{{uuid_de_um_endereco}}",
  • "excluido": false
}

hortas

Realiza exclusão lógica de uma horta.

Escopo por cargo:

Cargo Contexto
Administração da Plataforma Pode excluir qualquer horta.
Administração da Associação Pode excluir apenas hortas da sua associação.
Administração da Horta Pode excluir apenas sua própria horta.
Canteirista Sem permissão.
Dependente Sem permissão.
path Parameters
uuid_de_uma_horta
required
string

Responses

Cargos

Gerencia os cargos do sistema, permitindo criar, consultar, atualizar e excluir logicamente.

cargos

Lista todos os cargos não excluídos.

Escopo por cargo:

Cargo Contexto
Administração da Plataforma Lista todos os cargos.
Administração da Associação Lista todos os cargos.
Administração da Horta Lista todos os cargos.
Canteirista Sem permissão.
Dependente Sem permissão.

Responses

cargos

Cria um novo cargo.

Escopo por cargo:

Cargo Contexto
Administração da Plataforma Pode criar cargos.
Administração da Associação Sem permissão.
Administração da Horta Sem permissão.
Canteirista Sem permissão.
Dependente Sem permissão.
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "codigo": 5,
  • "slug": "cargo-teste",
  • "nome": "Cargo teste",
  • "descricao": "Cargo para testar",
  • "cor": "#ffffff"
}

cargos por UUID

Busca um cargo específico pelo UUID.

Escopo por cargo:

Cargo Contexto
Administração da Plataforma Lista todos os cargos.
Administração da Associação Lista todos os cargos.
Administração da Horta Lista todos os cargos.
Canteirista Sem permissão.
Dependente Sem permissão.
path Parameters
uuid_de_um_cargo
required
string

Responses

cargos

Atualiza um cargo existente.

Escopo por cargo:

Cargo Contexto
Administração da Plataforma Pode atualizar qualquer cargo.
Administração da Associação Sem permissão.
Administração da Horta Sem permissão.
Canteirista Sem permissão.
Dependente Sem permissão.
path Parameters
uuid_de_um_cargo
required
string
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "slug": "cargo-alterado",
  • "nome": "Cargo alterado",
  • "descricao": "Cargo que alterou",
  • "cor": "#ffffff"
}

cargos

Exclui logicamente um cargo (marca excluido = 1).

Escopo por cargo:

Cargo Contexto
Administração da Plataforma Pode excluir qualquer cargo.
Administração da Associação Sem permissão.
Administração da Horta Sem permissão.
Canteirista Sem permissão.
Dependente Sem permissão.
path Parameters
uuid_de_um_cargo
required
string

Responses

Usuarios

Gerencia os vínculos entre canteiros e usuários, permitindo criar, atualizar, consultar e excluir relações.

usuarios

Lista todos os usuários conforme permissão do cargo.

Escopo por cargo:

Cargo Contexto
Administração da Plataforma Lista todos os vínculos existentes.
Administração da Associação Lista apenas vínculos de usuários pertencentes à sua associação.
Administração da Horta Lista apenas vínculos em canteiros da horta administrada.
Canteirista Lista apenas seus próprios vínculos.
Dependente Lista apenas seus próprios vínculos.

Responses

usuarios

Cria um novo usuário.

Escopo por cargo:

Cargo Contexto
Administração da Plataforma Pode criar vínculos entre qualquer usuário e qualquer canteiro.
Administração da Associação Pode criar vínculos apenas para usuários da sua associação.
Administração da Horta Pode criar vínculos apenas em canteiros da sua horta.
Canteirista Sem permissão.
Dependente Sem permissão.
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "nome_completo": "João Armless",
  • "apelido": "João sem braço",
  • "cpf": "767.360.290-31",
  • "email": "joao@plataforma.com",
  • "senha": "senha12345",
  • "taxa_associado_em_centavos": 1500,
  • "data_de_nascimento": "2002-02-02",
  • "dias_ausente": 1,
  • "associacao_uuid": "{{uuid_de_uma_associacao}}",
  • "horta_uuid": "{{uuid_de_uma_horta}}",
  • "endereco_uuid": "{{uuid_de_um_endereco}}",
  • "cargo_uuid": "{{uuid_de_um_cargo}}"
}

usuarios por UUID

Busca um usuário específico pelo UUID.

Escopo por cargo:

Cargo Contexto
Administração da Plataforma Acesso completo. Visualiza todos os usuários.
Administração da Associação Visualiza apenas usuários da própria associação.
Administração da Horta Visualiza apenas usuários da própria horta.
Canteirista Sem permissão. Lança exceção.
Dependente Sem permissão. Lança exceção.
path Parameters
uuid_de_um_user
required
string

Responses

usuarios

Atualiza um usuário existente.

Escopo por cargo:

Cargo Contexto
Administração da Plataforma Pode atualizar qualquer vínculo.
Administração da Associação Pode atualizar vínculos apenas de usuários da sua associação.
Administração da Horta Pode atualizar vínculos apenas em canteiros da sua horta.
Canteirista Sem permissão.
Dependente Sem permissão.
path Parameters
uuid_de_um_user
required
string
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "nome_completo": "Alterado da Silva",
  • "email": "super_admin@plataforma.com",
  • "senha": "senha12345",
  • "taxa_associado_em_centavos": 1500,
  • "data_de_nascimento": "2002-02-02",
  • "associacao_uuid": "{{uuid_de_uma_associacao}}",
  • "horta_uuid": "{{uuid_de_uma_horta}}",
  • "endereco_uuid": "{{uuid_de_um_endereco}}",
  • "cargo_uuid": "{{uuid_de_um_cargo}}"
}

usuarios

Realiza exclusão lógica de um usuário.

Escopo por cargo:

Cargo Contexto
Administração da Plataforma Pode excluir qualquer vínculo.
Administração da Associação Pode excluir vínculos apenas de usuários da sua associação.
Administração da Horta Pode excluir vínculos apenas de canteiros da sua horta.
Canteirista Sem permissão.
Dependente Sem permissão.
path Parameters
uuid_de_um_user
required
string

Responses

Permissões

Gerencia as permissões atribuídas a cada cargo, com controle de acesso baseado no cargo do usuário logado.

permissões

Retorna todas as permissões do sistema que não foram excluídas.

Escopo por cargo:

Cargo Contexto
Administração da Plataforma Acesso completo. Visualiza qualquer permissão de cargo.
Administração da Associação Sem permissão. Lança exceção.
Administração da Horta Sem permissão. Lança exceção.
Canteirista Sem permissão. Lança exceção.
Dependente Sem permissão. Lança exceção.

Responses

permissões

Cria uma nova permissão no sistema.

Escopo por cargo:

Cargo Contexto
Administração da Plataforma Pode criar permissão para qualquer cargo.
Administração da Associação Sem permissão. Lança exceção.
Administração da Horta Sem permissão. Lança exceção.
Canteirista Sem permissão. Lança exceção.
Dependente Sem permissão. Lança exceção.
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "slug": "recurso_get",
  • "tipo": 1,
  • "modulo": 1,
  • "descricao": "Permissão dummy"
}

permissões por UUID

Busca uma permissão específica pelo UUID.

Escopo por cargo:

Cargo Contexto
Administração da Plataforma Acesso completo. Visualiza todas as permissões.
Administração da Associação Sem permissão. Lança exceção.
Administração da Horta Sem permissão. Lança exceção.
Canteirista Sem permissão. Lança exceção.
Dependente Sem permissão. Lança exceção.
path Parameters
uuid_de_uma_permissao
required
string

Responses

permissões

Atualiza uma permissão existente.

Escopo por cargo:

Cargo Contexto
Administração da Plataforma Pode atualizar qualquer permissão de cargo.
Administração da Associação Sem permissão. Lança exceção.
Administração da Horta Sem permissão. Lança exceção.
Canteirista Sem permissão. Lança exceção.
Dependente Sem permissão. Lança exceção.
path Parameters
uuid_de_uma_permissao
required
string
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "slug": "recurso_get",
  • "tipo": 1,
  • "modulo": 1,
  • "descricao": "Permissão dummy"
}

permissões

Realiza exclusão lógica de uma permissão (marca como excluída).

Escopo por cargo:

Cargo Contexto
Administração da Plataforma Pode excluir qualquer permissão de cargo.
Administração da Associação Sem permissão. Lança exceção.
Administração da Horta Sem permissão. Lança exceção.
Canteirista Sem permissão. Lança exceção.
Dependente Sem permissão. Lança exceção.
path Parameters
uuid_de_uma_permissao
required
string

Responses

Permissões do Usuário

Gerencia e retorna todas as permissões de um usuário, combinando permissões do cargo e exceções individuais.

permissões do usuário por UUID

Retorna todas as permissões associadas a um usuário específico.

Escopo por cargo:

Cargo Contexto
Administração da Plataforma Acesso completo. Visualiza todas as permissões.
Administração da Associação Sem permissão. Lança exceção.
Administração da Horta Sem permissão. Lança exceção.
Canteirista Sem permissão. Lança exceção.
Dependente Sem permissão. Lança exceção.
path Parameters
uuid_de_um_user
required
string

Responses

Chaves

Gerencia as chaves vinculadas às hortas, permitindo criar, consultar, atualizar e excluir logicamente.

chaves

Lista todas as chaves não excluídas, respeitando os filtros por cargo.

Escopo por cargo:

Cargo Contexto
Administração da Plataforma Lista todas as chaves de todas as hortas.
Administração da Associação Lista somente chaves das hortas da associação vinculada.
Administração da Horta Lista somente chaves da horta vinculada.
Canteirista Sem permissão. Lança exceção.
Dependente Sem permissão. Lança exceção.

Responses

chaves

Cria uma nova chave vinculada a uma horta.

Escopo por cargo:

Cargo Contexto
Administração da Plataforma Pode criar chave para qualquer horta.
Administração da Associação Pode criar chave apenas para hortas da associação vinculada.
Administração da Horta Pode criar chave apenas para a horta vinculada.
Canteirista Sem permissão. Lança exceção.
Dependente Sem permissão. Lança exceção.
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "codigo": "CHV-001",
  • "horta_uuid": "{{uuid_de_uma_horta}}",
  • "observacoes": "Chave para acesso principal da horta",
  • "disponivel": true
}

chaves por UUID

Busca uma chave específica pelo UUID.

Escopo por cargo:

Cargo Contexto
Administração da Plataforma Lista todas as chaves de todas as hortas.
Administração da Associação Lista somente chaves das hortas da associação vinculada.
Administração da Horta Lista somente chaves da horta vinculada.
Canteirista Sem permissão. Lança exceção.
Dependente Sem permissão. Lança exceção.
path Parameters
uuid_de_uma_chave
required
string

Responses

chaves

Atualiza os dados de uma chave existente.

Escopo por cargo:

Cargo Contexto
Administração da Plataforma Pode atualizar qualquer chave.
Administração da Associação Pode atualizar apenas chaves de hortas da associação vinculada.
Administração da Horta Pode atualizar apenas chaves da horta vinculada.
Canteirista Sem permissão. Lança exceção.
Dependente Sem permissão. Lança exceção.
path Parameters
uuid_de_uma_chave
required
string
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "disponivel": false
}

chaves

Exclui logicamente uma chave (marca excluido = 1).

Escopo por cargo:

Cargo Contexto
Administração da Plataforma Pode excluir qualquer chave.
Administração da Associação Pode excluir apenas chaves de hortas da associação vinculada.
Administração da Horta Pode excluir apenas chaves da horta vinculada.
Canteirista Sem permissão. Lança exceção.
Dependente Sem permissão. Lança exceção.
path Parameters
uuid_de_uma_chave
required
string

Responses

Filas de Usuários

Gerencia a fila de usuários vinculados às hortas, permitindo criar, consultar, atualizar e excluir logicamente.

fila de usuários

Lista todas as filas de usuários não excluídas, com filtros conforme cargo.

Escopo por cargo:

Cargo Contexto
Administração da Plataforma Lista todas as filas.
Administração da Associação Lista apenas filas de hortas da associação.
Administração da Horta Lista apenas filas da horta administrada.
Canteirista Lista apenas filas da sua horta.
Dependente Lista apenas filas da sua horta.

Responses

fila de usuários por UUID

Busca uma fila específica pelo UUID.

Escopo por cargo:

Cargo Contexto
Administração da Plataforma Lista todas as filas.
Administração da Associação Lista apenas filas de hortas da associação.
Administração da Horta Lista apenas filas da horta administrada.
Canteirista Lista apenas filas da sua horta.
Dependente Lista apenas filas da sua horta.
path Parameters
uuid_de_uma_fila
required
string

Responses

fila de usuários

Atualiza uma fila de usuário existente.

Escopo por cargo:

Cargo Contexto
Administração da Plataforma Pode atualizar qualquer fila.
Administração da Associação Pode atualizar apenas filas da associação.
Administração da Horta Pode atualizar apenas filas da horta administrada.
Canteirista Sem permissão.
Dependente Sem permissão.
path Parameters
uuid_de_uma_fila
required
string
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "ordem": 1
}

fila de usuários

Exclui logicamente uma fila de usuário (marca excluido = 1).

Escopo por cargo:

Cargo Contexto
Administração da Plataforma Pode excluir qualquer fila.
Administração da Associação Pode excluir apenas filas da associação.
Administração da Horta Pode excluir apenas filas da horta administrada.
Canteirista Sem permissão.
Dependente Sem permissão.
path Parameters
uuid_de_uma_fila
required
string

Responses

fila de usuários por Usuário UUID

Busca todas as filas de um usuário específico.

Escopo por cargo:

Cargo Contexto
Administração da Plataforma Lista todas as filas.
Administração da Associação Lista apenas filas de hortas da associação.
Administração da Horta Lista apenas filas da horta administrada.
Canteirista Lista apenas filas da sua horta.
Dependente Lista apenas filas da sua horta.
path Parameters
uuid_de_um_user_na_fila
required
string

Responses

fila de usuários por Horta UUID

Lista as filas de usuários de uma horta específica.

Escopo por cargo:

Cargo Contexto
Administração da Plataforma Lista todas as filas.
Administração da Associação Lista apenas filas de hortas da associação.
Administração da Horta Lista apenas filas da horta administrada.
Canteirista Lista apenas filas da sua horta.
Dependente Lista apenas filas da sua horta.
path Parameters
uuid_de_uma_horta_na_fila
required
string

Responses

Canteiros

Gerencia os vínculos entre canteiros e usuários, permitindo criar, atualizar, consultar e excluir relações.

canteiros

Lista todos os canteiros de acordo com o escopo do usuário logado.

Escopo por cargo:

Cargo Contexto
Administração da Plataforma Lista todos os vínculos existentes.
Administração da Associação Lista apenas vínculos de usuários pertencentes à sua associação.
Administração da Horta Lista apenas vínculos em canteiros da horta administrada.
Canteirista Lista apenas seus próprios vínculos.
Dependente Lista apenas seus próprios vínculos.

Responses

canteiros

Cria um novo canteiro.

Escopo por cargo:

Cargo Contexto
Administração da Plataforma Pode criar vínculos entre qualquer usuário e qualquer canteiro.
Administração da Associação Pode criar vínculos apenas para usuários da sua associação.
Administração da Horta Pode criar vínculos apenas em canteiros da sua horta.
Canteirista Sem permissão.
Dependente Sem permissão.
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "numero_identificador": "A-000",
  • "tamanho_m2": 20.5,
  • "horta_uuid": "{{uuid_de_uma_horta}}"
}

canteiros por UUID

Busca um canteiro específico pelo UUID.

Escopo por cargo:

Cargo Contexto
Administração da Plataforma Lista todos os canteiros.
Administração da Associação Lista apenas canteiros de hortas da sua associação.
Administração da Horta Lista apenas canteiros da sua horta.
Canteirista Lista apenas canteiros da horta da sua associação vinculada.
Dependente Lista apenas canteiros da horta da sua associação vinculada.
path Parameters
uuid_de_um_canteiro
required
string

Responses

canteiros

Atualiza os dados de um canteiro.

Escopo por cargo:

Cargo Contexto
Administração da Plataforma Pode atualizar qualquer vínculo.
Administração da Associação Pode atualizar vínculos apenas de usuários da sua associação.
Administração da Horta Pode atualizar vínculos apenas em canteiros da sua horta.
Canteirista Sem permissão.
Dependente Sem permissão.
path Parameters
uuid_de_um_canteiro
required
string
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "numero_identificador": "Z-999",
  • "tamanho_m2": 10.25,
  • "horta_uuid": "{{uuid_de_uma_horta}}"
}

canteiros

Exclui logicamente um canteiro (marca excluido = 1).

Escopo por cargo:

Cargo Contexto
Administração da Plataforma Pode excluir qualquer vínculo.
Administração da Associação Pode excluir vínculos apenas de usuários da sua associação.
Administração da Horta Pode excluir vínculos apenas de canteiros da sua horta.
Canteirista Sem permissão.
Dependente Sem permissão.
path Parameters
uuid_de_um_canteiro
required
string

Responses

Vínculo: Canteiro e Usuário

Gerencia os vínculos entre canteiros e usuários, permitindo criar, atualizar, consultar e excluir relações.

canteiros e usuários

Lista os vínculos de usuários com canteiros, aplicando filtro de acordo com o cargo do usuário logado.

Escopo por cargo:

Cargo Contexto
Administração da Plataforma Lista todos os vínculos existentes.
Administração da Associação Lista apenas vínculos de usuários pertencentes à sua associação.
Administração da Horta Lista apenas vínculos em canteiros da horta administrada.
Canteirista Lista apenas seus próprios vínculos.
Dependente Lista apenas seus próprios vínculos.

Responses

canteiros e usuários

Cria um novo vínculo entre um usuário e um canteiro.

Escopo por cargo:

Cargo Contexto
Administração da Plataforma Pode criar vínculos entre qualquer usuário e qualquer canteiro.
Administração da Associação Pode criar vínculos apenas para usuários da sua associação.
Administração da Horta Pode criar vínculos apenas em canteiros da sua horta.
Canteirista Sem permissão.
Dependente Sem permissão.
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "usuario_uuid": "{{uuid_de_um_user}}",
  • "canteiro_uuid": "{{uuid_canteiro_de_um_vinculo}}",
  • "tipo_vinculo": 1,
  • "data_inicio": "2025-01-01",
  • "data_fim": "2025-01-02",
  • "percentual_responsabilidade": 25,
  • "observacoes": "Teste"
}

canteiros e usuários por UUID

Busca um vínculo específico entre usuário e canteiro pelo UUID.

Escopo por cargo:

Cargo Contexto
Administração da Plataforma Lista todos os canteiros.
Administração da Associação Lista apenas canteiros de hortas da sua associação.
Administração da Horta Lista apenas canteiros da sua horta.
Canteirista Lista apenas canteiros da horta da sua associação vinculada.
Dependente Lista apenas canteiros da horta da sua associação vinculada.
path Parameters
uuid_de_um_vinculo_canteiro_user
required
string

Responses

canteiros e usuários

Atualiza os dados de um vínculo já existente.

Escopo por cargo:

Cargo Contexto
Administração da Plataforma Pode atualizar qualquer vínculo.
Administração da Associação Pode atualizar vínculos apenas de usuários da sua associação.
Administração da Horta Pode atualizar vínculos apenas em canteiros da sua horta.
Canteirista Sem permissão.
Dependente Sem permissão.
path Parameters
uuid_de_um_vinculo_canteiro_user
required
string
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "usuario_uuid": "{{uuid_user_de_um_vinculo_canteiro}}",
  • "canteiro_uuid": "{{uuid_canteiro_de_um_vinculo}}",
  • "tipo_vinculo": 2,
  • "data_inicio": "2025-01-01",
  • "data_fim": "2025-01-02",
  • "percentual_responsabilidade": 50,
  • "observacoes": "Teste",
  • "ativo": 0
}

canteiros e usuários

Realiza exclusão lógica de um vínculo (marca como excluído).

Escopo por cargo:

Cargo Contexto
Administração da Plataforma Pode excluir qualquer vínculo.
Administração da Associação Pode excluir vínculos apenas de usuários da sua associação.
Administração da Horta Pode excluir vínculos apenas de canteiros da sua horta.
Canteirista Sem permissão.
Dependente Sem permissão.
path Parameters
uuid_de_um_vinculo_canteiro_user
required
string

Responses

Permissões de Cargos

Gerencia os cargos do sistema, permitindo criar, consultar, atualizar e excluir logicamente.

permissões de cargo

Lista todas as permissões de cargo.

Escopo por cargo:

Cargo Contexto
Administração da Plataforma Acesso completo. Visualiza qualquer permissão de cargo.
Administração da Associação Sem permissão. Lança exceção.
Administração da Horta Sem permissão. Lança exceção.
Canteirista Sem permissão. Lança exceção.
Dependente Sem permissão. Lança exceção.

Responses

permissões de cargo

Cria uma nova permissão para um cargo.

Escopo por cargo:

Cargo Contexto
Administração da Plataforma Pode criar permissão para qualquer cargo.
Administração da Associação Sem permissão. Lança exceção.
Administração da Horta Sem permissão. Lança exceção.
Canteirista Sem permissão. Lança exceção.
Dependente Sem permissão. Lança exceção.
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "cargo_uuid": "{{uuid_de_um_cargo}}",
  • "permissao_uuid": "{{uuid_de_uma_permissao}}"
}

permissões de cargo por UUID

Busca uma permissão específica de cargo pelo UUID.

Escopo por cargo:

Cargo Contexto
Administração da Plataforma Acesso completo. Visualiza qualquer permissão de cargo.
Administração da Associação Sem permissão. Lança exceção.
Administração da Horta Sem permissão. Lança exceção.
Canteirista Sem permissão. Lança exceção.
Dependente Sem permissão. Lança exceção.
path Parameters
uuid_de_uma_tupla_permissao_cargo
required
string

Responses

permissões de cargo

Atualiza uma permissão existente de cargo.

Escopo por cargo:

Cargo Contexto
Administração da Plataforma Pode atualizar qualquer permissão de cargo.
Administração da Associação Sem permissão. Lança exceção.
Administração da Horta Sem permissão. Lança exceção.
Canteirista Sem permissão. Lança exceção.
Dependente Sem permissão. Lança exceção.
path Parameters
uuid_de_uma_tupla_permissao_cargo
required
string
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "permissao_uuid": "{{uuid_de_uma_permissao}}"
}

permissões de cargo

Exclusão lógica de uma permissão de cargo.

Escopo por cargo:

Cargo Contexto
Administração da Plataforma Pode excluir qualquer permissão de cargo.
Administração da Associação Sem permissão. Lança exceção.
Administração da Horta Sem permissão. Lança exceção.
Canteirista Sem permissão. Lança exceção.
Dependente Sem permissão. Lança exceção.
path Parameters
uuid_de_uma_tupla_permissao_cargo
required
string

Responses

permissões de cargo por Cargo UUID

Lista todas as permissões atribuídas a um cargo específico.

Escopo por cargo:

Cargo Contexto
Administração da Plataforma Acesso completo. Visualiza qualquer permissão de cargo.
Administração da Associação Sem permissão. Lança exceção.
Administração da Horta Sem permissão. Lança exceção.
Canteirista Sem permissão. Lança exceção.
Dependente Sem permissão. Lança exceção.
path Parameters
uuid_cargo_com_permissao
required
string

Responses

Permissões de Exceção

Gerencia permissões de exceção atribuídas a usuários específicos.

permissões de exceção

Lista todas as permissões de exceção.

Escopo por cargo:

Cargo Contexto
Administração da Plataforma Visualiza todas as permissões de exceção.
Administração da Associação Sem permissão. Lança exceção.
Administração da Horta Sem permissão. Lança exceção.
Canteirista Sem permissão. Lança exceção.
Dependente Sem permissão. Lança exceção.

Responses

permissões de exceção

Cria uma nova permissão de exceção para um usuário.

Escopo por cargo:

Cargo Contexto
Administração da Plataforma Pode criar permissão de exceção para qualquer usuário.
Administração da Associação Sem permissão. Lança exceção.
Administração da Horta Sem permissão. Lança exceção.
Canteirista Sem permissão. Lança exceção.
Dependente Sem permissão. Lança exceção.
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "usuario_uuid": "{{uuid_de_um_user}}",
  • "permissao_uuid": "{{uuid_de_uma_permissao}}",
  • "liberado": 1
}

permissões de exceção por UUID

Busca uma permissão de exceção pelo UUID.

Escopo por cargo:

Cargo Contexto
Administração da Plataforma Visualiza todas as permissões de exceção.
Administração da Associação Sem permissão. Lança exceção.
Administração da Horta Sem permissão. Lança exceção.
Canteirista Sem permissão. Lança exceção.
Dependente Sem permissão. Lança exceção.
path Parameters
uuid_de_uma_tupla_permissao_excecao
required
string

Responses

permissões de exceção

Atualiza uma permissão de exceção existente.

Escopo por cargo:

Cargo Contexto
Administração da Plataforma Pode atualizar qualquer permissão de exceção.
Administração da Associação Sem permissão. Lança exceção.
Administração da Horta Sem permissão. Lança exceção.
Canteirista Sem permissão. Lança exceção.
Dependente Sem permissão. Lança exceção.
path Parameters
uuid_de_uma_tupla_permissao_excecao
required
string
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "liberado": "1"
}

permissões de exceção

Exclusão lógica de uma permissão de exceção.

Escopo por cargo:

Cargo Contexto
Administração da Plataforma Pode excluir qualquer permissão de exceção.
Administração da Associação Sem permissão. Lança exceção.
Administração da Horta Sem permissão. Lança exceção.
Canteirista Sem permissão. Lança exceção.
Dependente Sem permissão. Lança exceção.
path Parameters
uuid_de_uma_tupla_permissao_excecao
required
string

Responses

Categorias Financeiras

Gerencia categorias financeiras vinculadas a Associações ou Hortas.

categorias financeiras

Lista todas as categorias financeiras conforme escopo do cargo.

Escopo por cargo:

Cargo Contexto
Administração da Plataforma Lista todas categorias do sistema.
Administração da Associação Lista apenas categorias da própria associação.
Administração da Horta Lista apenas categorias da própria horta.
Canteirista Sem permissão.
Dependente Sem permissão.

Responses

categorias financeiras

Cria uma nova categoria financeira.

Escopo por cargo:

Cargo Contexto
Administração da Plataforma Pode criar para qualquer associação ou horta.
Administração da Associação Pode criar somente para sua associação. Não pode informar horta_uuid.
Administração da Horta Pode criar somente para sua horta. Não pode informar associacao_uuid.
Canteirista Sem permissão.
Dependente Sem permissão.
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "nome": "Teste",
  • "descricao": "Pagamento",
  • "tipo": 1,
  • "icone": "standard-icon",
  • "cor": "#800080",
  • "associacao_uuid": "{{uuid_de_uma_associacao}}"
}

categorias financeiras por UUID

Busca categoria financeira pelo uuid.

Escopo por cargo:

Cargo Contexto
Administração da Plataforma Lista todas categorias do sistema.
Administração da Associação Lista apenas categorias da própria associação.
Administração da Horta Lista apenas categorias da própria horta.
Canteirista Sem permissão.
Dependente Sem permissão.
path Parameters
uuid_de_uma_categoria_financeira
required
string

Responses

categorias financeiras

Atualiza categoria financeira existente.

Escopo por cargo:

Cargo Contexto
Administração da Plataforma Pode editar qualquer categoria.
Administração da Associação Apenas categorias da própria associação.
Administração da Horta Apenas categorias da própria horta.
Canteirista Sem permissão.
Dependente Sem permissão.
path Parameters
uuid_de_uma_categoria_financeira
required
string
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "nome": "Insumos"
}

categorias financeiras

Exclusão lógica de categoria financeira (marca excluido = 1).

Escopo por cargo:

Cargo Contexto
Administração da Plataforma Pode excluir qualquer categoria.
Administração da Associação Apenas categorias da própria associação.
Administração da Horta Apenas categorias da própria horta.
Canteirista Sem permissão.
Dependente Sem permissão.
path Parameters
uuid_de_uma_categoria_financeira
required
string

Responses

categorias financeira por Associação UUID

Lista categorias financeiras de uma associação específica.

path Parameters
uuid_de_uma_associacao_categoria_financeira
required
string

Responses

categorias financeiras por Horta UUID

Lista categorias financeiras de uma horta específica.

Escopo por cargo:

Cargo Contexto
Administração da Plataforma Lista todas categorias do sistema.
Administração da Associação Lista apenas categorias da própria associação.
Administração da Horta Lista apenas categorias da própria horta.
Canteirista Sem permissão.
Dependente Sem permissão.
path Parameters
uuid_de_uma_horta_categoria_financeira
required
string

Responses

Financeiro da Horta

Gerencia lançamentos financeiros relacionados a uma horta específica.

financeiro da horta

Lista todos os lançamentos financeiros de hortas, respeitando o escopo do cargo.

Escopo por cargo:

Cargo Contexto
Administração da Plataforma Visualiza lançamentos de todas as hortas.
Administração da Associação Visualiza lançamentos apenas de hortas da associação.
Administração da Horta Visualiza lançamentos apenas da horta que administra.
Canteirista Visualiza lançamentos apenas da sua horta.
Dependente Visualiza lançamentos apenas da sua horta.

Responses

financeiro da horta

Cria um novo lançamento financeiro para uma horta.

Escopo por cargo:

Cargo Contexto
Administração da Plataforma Pode criar para qualquer horta.
Administração da Associação Pode criar apenas para hortas da sua associação.
Administração da Horta Pode criar apenas para sua horta.
Canteirista Sem permissão.
Dependente Sem permissão.
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "valor_em_centavos": 25999,
  • "descricao_do_lancamento": "Pagamento de conta de água",
  • "categoria_uuid": "{{uuid_de_uma_categoria_financeira}}",
  • "url_anexo": "https://www.google.drive.com/10293sad1@3",
  • "data_do_lancamento": "2025-01-01",
  • "horta_uuid": "{{uuid_de_uma_horta_financeiro}}"
}

financeiro da horta por UUID

Busca um lançamento financeiro específico pelo UUID.

path Parameters
uuid_de_uma_tupla_financeiro_horta
required
string

Responses

financeiro da horta

Atualiza um lançamento financeiro existente.

Escopo por cargo:

Cargo Contexto
Administração da Plataforma Pode atualizar qualquer lançamento.
Administração da Associação Pode atualizar apenas lançamentos de hortas da sua associação.
Administração da Horta Pode atualizar apenas lançamentos da sua horta.
Canteirista Sem permissão.
Dependente Sem permissão.
path Parameters
uuid_de_uma_tupla_financeiro_horta
required
string
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "valor_em_centavos": 111111
}

financeiro da horta

Realiza exclusão lógica de um lançamento financeiro.

Escopo por cargo:

Cargo Contexto
Administração da Plataforma Pode excluir qualquer lançamento.
Administração da Associação Pode excluir apenas lançamentos de hortas da sua associação.
Administração da Horta Pode excluir apenas lançamentos da sua horta.
Canteirista Sem permissão.
Dependente Sem permissão.
path Parameters
uuid_de_uma_tupla_financeiro_horta
required
string

Responses

financeiro da horta por Horta UUID

Lista os lançamentos financeiros de uma horta específica.

path Parameters
uuid_de_uma_horta_financeiro
required
string

Responses

Financeiro da Associação

Gerencia os lançamentos financeiros vinculados às associações, permitindo criação, consulta, atualização e exclusão lógica.

financeiro da associação

Lista todos os lançamentos financeiros da associação.

Escopo por cargo:

Cargo Contexto
Administração da Plataforma Visualiza todos os lançamentos de todas as associações.
Administração da Associação Visualiza apenas lançamentos da sua associação.
Administração da Horta Visualiza apenas lançamentos da sua associação.
Canteirista Visualiza apenas lançamentos da sua associação.
Dependente Visualiza apenas lançamentos da sua associação.

Responses

financeiro da associação

Cria um novo lançamento financeiro.

Escopo por cargo:

Cargo Contexto
Administração da Plataforma Pode criar para qualquer associação.
Administração da Associação Pode criar apenas para sua associação.
Administração da Horta Sem permissão.
Canteirista Sem permissão.
Dependente Sem permissão.
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "valor_em_centavos": 24999,
  • "descricao_do_lancamento": "Pagamento de conta de água",
  • "categoria_uuid": "{{uuid_de_uma_categoria_financeira}}",
  • "url_anexo": "https://www.google.drive.com/10293sad1@3",
  • "data_do_lancamento": "2025-01-01",
  • "associacao_uuid": "{{uuid_de_uma_associacao}}",
  • "mensalidade_uuid": null
}

financeiro da associação por UUID

Busca um lançamento financeiro específico pelo UUID.

path Parameters
uuid_de_uma_tupla_financeiro_associacao
required
string

Responses

financeiro da associação

Atualiza um lançamento financeiro existente.

Escopo por cargo:

Cargo Contexto
Administração da Plataforma Pode atualizar qualquer lançamento.
Administração da Associação Pode atualizar apenas lançamentos da sua associação.
Administração da Horta Sem permissão.
Canteirista Sem permissão.
Dependente Sem permissão.
path Parameters
uuid_de_uma_tupla_financeiro_associacao
required
string
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "data_do_lancamento": "2025-03-01"
}

financeiro da associação

Realiza exclusão lógica de um lançamento financeiro (marca excluido = 1).

Escopo por cargo:

Cargo Contexto
Administração da Plataforma Pode excluir qualquer lançamento.
Administração da Associação Pode excluir apenas lançamentos da sua associação.
Administração da Horta Sem permissão.
Canteirista Sem permissão.
Dependente Sem permissão.
path Parameters
uuid_de_uma_tupla_financeiro_associacao
required
string

Responses

financeiro da associação por Associação UUID

Lista os lançamentos financeiros de uma associação específica.

path Parameters
uuid_de_uma_associacao_financeiro
required
string

Responses

Mensalidades da Plataforma

Gerencia mensalidades da plataforma, vinculadas a usuários e planos, com controle de acesso baseado no cargo.

mensalidades da plataforma

Lista todas as mensalidades disponíveis (apenas para Admin Plataforma e Admin Associação).

Escopo por cargo:

Cargo Contexto
Administração da Plataforma Visualiza todas as mensalidades.
Administração da Associação Visualiza todas as mensalidades.
Administração da Horta Sem permissão.
Canteirista Sem permissão.
Dependente Sem permissão.

Responses

mensalidades da plataforma

Cria uma nova mensalidade.

Escopo por cargo:

Cargo Contexto
Administração da Plataforma Pode criar mensalidades para qualquer usuário. Todos os campos podem ser informados.
NEW_ACCOUNT Pode criar mensalidade com valor_em_centavos, usuario_uuid e plano_uuid. Campos de datas e status são opcionais.
Administração da Associação Sem permissão.
Administração da Horta Sem permissão.
Canteirista Sem permissão.
Dependente Sem permissão.
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "valor_em_centavos": 25000,
  • "usuario_uuid": "{{uuid_de_um_user}}",
  • "plano_uuid": "{{uuid_de_um_plano}}",
  • "data_vencimento": "2025-12-11",
  • "data_pagamento": "2025-12-12",
  • "status": 1,
  • "url_anexo": "https://www.google.drive.com/test.pdf",
  • "dias_atraso": 1
}

mensalidades da plataforma por UUID

Busca uma mensalidade específica pelo UUID.

Escopo por cargo:

Cargo Contexto
Administração da Plataforma Visualiza todas as mensalidades.
Administração da Associação Visualiza todas as mensalidades.
Administração da Horta Sem permissão.
Canteirista Sem permissão.
Dependente Sem permissão.
path Parameters
uuid_de_uma_mensalidade_plataforma
required
string

Responses

mensalidades da plataforma

Atualiza uma mensalidade existente.

Escopo por cargo:

Cargo Contexto
Administração da Plataforma Pode atualizar qualquer mensalidade.
Administração da Associação Sem permissão.
Administração da Horta Sem permissão.
Canteirista Sem permissão.
Dependente Sem permissão.
path Parameters
uuid_de_uma_mensalidade_plataforma
required
string
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "valor_em_centavos": 860,
  • "data_vencimento": "2026-01-01"
}

mensalidades da plataforma

Exclusão lógica de uma mensalidade.

Escopo por cargo:

Cargo Contexto
Administração da Plataforma Pode excluir qualquer mensalidade.
Administração da Associação Sem permissão.
Administração da Horta Sem permissão.
Canteirista Sem permissão.
Dependente Sem permissão.
path Parameters
uuid_de_uma_mensalidade_plataforma
required
string

Responses

mensalidades da plataforma por Usuário UUID

Lista mensalidades filtradas por usuário (apenas Admin Plataforma).

Escopo por cargo:

Cargo Contexto
Administração da Plataforma Visualiza todas as mensalidades.
Administração da Associação Visualiza todas as mensalidades.
Administração da Horta Sem permissão.
Canteirista Sem permissão.
Dependente Sem permissão.
path Parameters
uuid_user_de_uma_mensalidade_plataforma
required
string

Responses

Mensalidades da Associação

Gerencia mensalidades vinculadas a usuários e associações, com controle de acesso baseado no cargo do usuário.

mensalidades da associação

Lista todas as mensalidades disponíveis de acordo com o cargo do usuário.

Escopo por cargo:

Cargo Contexto
Administração da Plataforma Visualiza todas as mensalidades.
Administração da Associação Visualiza apenas mensalidades da própria associação.
Administração da Horta Visualiza mensalidades de usuários da própria horta.
Canteirista Visualiza apenas suas próprias mensalidades.
Dependente Visualiza apenas suas próprias mensalidades.

Responses

mensalidades da associação

Cria uma nova mensalidade.

Escopo por cargo:

Cargo Contexto
Administração da Plataforma Pode criar para qualquer associação.
Administração da Associação Apenas para própria associação.
Administração da Horta Sem permissão.
Canteirista Sem permissão.
Dependente Sem permissão.
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "valor_em_centavos": 25000,
  • "usuario_uuid": "{{uuid_de_um_user}}",
  • "associacao_uuid": "{{uuid_associacao_de_um_user}}",
  • "data_vencimento": "2025-12-30",
  • "data_pagamento": null,
  • "status": 1,
  • "dias_atraso": 1,
  • "url_anexo": "https://www.google.drive.com/test"
}

mensalidades da associação por UUID

Busca uma mensalidade específica pelo UUID.

Escopo por cargo:

Cargo Contexto
Administração da Plataforma Visualiza todas as mensalidades.
Administração da Associação Visualiza apenas mensalidades da própria associação.
Administração da Horta Visualiza mensalidades de usuários da própria horta.
Canteirista Visualiza apenas suas próprias mensalidades.
Dependente Visualiza apenas suas próprias mensalidades.
path Parameters
uuid_de_uma_mensalidade_associacao
required
string

Responses

mensalidades da associação

Atualiza uma mensalidade existente.

Escopo por cargo:

Cargo Contexto
Administração da Plataforma Pode atualizar qualquer mensalidade.
Administração da Associação Apenas mensalidades da própria associação.
Administração da Horta Sem permissão.
Canteirista Sem permissão.
Dependente Sem permissão.
path Parameters
uuid_de_uma_mensalidade_associacao
required
string
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "status": 2
}

mensalidades da associação

Exclusão lógica de uma mensalidade.

Escopo por cargo:

Cargo Contexto
Administração da Plataforma Pode excluir qualquer mensalidade.
Administração da Associação Apenas mensalidades da própria associação.
Administração da Horta Sem permissão.
Canteirista Sem permissão.
Dependente Sem permissão.
path Parameters
uuid_de_uma_mensalidade_associacao
required
string

Responses

mensalidades da associação por Usuário UUID

Lista mensalidades filtradas por usuário.

Escopo por cargo:

Cargo Contexto
Administração da Plataforma Visualiza todas as mensalidades.
Administração da Associação Visualiza apenas mensalidades da própria associação.
Administração da Horta Visualiza mensalidades de usuários da própria horta.
Canteirista Visualiza apenas suas próprias mensalidades.
Dependente Visualiza apenas suas próprias mensalidades.
path Parameters
uuid_user_em_mensalidade_associacao
required
string

Responses

mensalidades da associação por Associação UUID

Lista mensalidades filtradas por associação.

Escopo por cargo:

Cargo Contexto
Administração da Plataforma Visualiza todas as mensalidades.
Administração da Associação Visualiza apenas mensalidades da própria associação.
Administração da Horta Visualiza mensalidades de usuários da própria horta.
Canteirista Visualiza apenas suas próprias mensalidades.
Dependente Visualiza apenas suas próprias mensalidades.
path Parameters
uuid_associacao_em_mensalidade_associacao
required
string

Responses

Recurso do Plano

Gerencia os recursos associados aos planos da plataforma, incluindo criação, atualização, exclusão e consulta de recursos individuais ou por plano.

recursos do plano

Retorna todos os recursos ativos cadastrados na plataforma.

Escopo por cargo:

Cargo Contexto
Administração da Plataforma Acesso completo. Visualiza todos os recursos do plano.
Administração da Associação Sem permissão. Lança exceção.
Administração da Horta Sem permissão. Lança exceção.
Canteirista Sem permissão. Lança exceção.
Dependente Sem permissão. Lança exceção.

Responses

recursos do plano

Cria um novo recurso para um plano existente.

Escopo por cargo:

Cargo Contexto
Administração da Plataforma Pode criar recursos para qualquer plano existente.
Administração da Associação Sem permissão. Lança exceção.
Administração da Horta Sem permissão. Lança exceção.
Canteirista Sem permissão. Lança exceção.
Dependente Sem permissão. Lança exceção.
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "nome_do_recurso": "Criar usuários",
  • "quantidade": 3,
  • "descricao": "Teste",
  • "plano_uuid": "{{uuid_de_um_plano}}"
}

recursos do plano por UUID

Busca um recurso específico pelo UUID.

Escopo por cargo:

Cargo Contexto
Administração da Plataforma Acesso completo. Visualiza todos os recursos do plano.
Administração da Associação Sem permissão. Lança exceção.
Administração da Horta Sem permissão. Lança exceção.
Canteirista Sem permissão. Lança exceção.
Dependente Sem permissão. Lança exceção.
path Parameters
uuid_recursos_de_um_plano
required
string

Responses

recursos do plano

Atualiza um recurso existente de um plano.

Escopo por cargo:

Cargo Contexto
Administração da Plataforma Pode atualizar qualquer recurso do plano. Campos opcionais.
Administração da Associação Sem permissão. Lança exceção.
Administração da Horta Sem permissão. Lança exceção.
Canteirista Sem permissão. Lança exceção.
Dependente Sem permissão. Lança exceção.
path Parameters
uuid_recursos_de_um_plano
required
string
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "quantidade": 1,
  • "descricao": "Teste"
}

recursos do plano

Realiza exclusão lógica de um recurso do plano (marca como excluído).

Escopo por cargo:

Cargo Contexto
Administração da Plataforma Pode excluir (logicamente) qualquer recurso do plano.
Administração da Associação Sem permissão. Lança exceção.
Administração da Horta Sem permissão. Lança exceção.
Canteirista Sem permissão. Lança exceção.
Dependente Sem permissão. Lança exceção.
path Parameters
uuid_recursos_de_um_plano
required
string

Responses

recursos do plano por Plano UUID

Consulta todos os recursos associados a um plano específico.

Escopo por cargo:

Cargo Contexto
Administração da Plataforma Acesso completo. Visualiza todos os recursos do plano.
Administração da Associação Sem permissão. Lança exceção.
Administração da Horta Sem permissão. Lança exceção.
Canteirista Sem permissão. Lança exceção.
Dependente Sem permissão. Lança exceção.
path Parameters
uuid_de_um_plano_com_recursos
required
string

Responses

Planos

Gerencia os planos disponíveis na plataforma, incluindo criação, atualização, exclusão e consulta de planos individuais ou por usuário.

planos

Retorna todos os planos ativos da plataforma.

Escopo por cargo:

Cargo Contexto
Administração da Plataforma Acesso completo. Visualiza todos os planos.
Administração da Associação Sem permissão. Lança exceção.
Administração da Horta Sem permissão. Lança exceção.
Canteirista Sem permissão. Lança exceção.
Dependente Sem permissão. Lança exceção.

Responses

planos por UUID

Busca um plano específico pelo UUID.

Escopo por cargo:

Cargo Contexto
Administração da Plataforma Acesso completo. Visualiza todos os planos.
Administração da Associação Sem permissão. Lança exceção.
Administração da Horta Sem permissão. Lança exceção.
Canteirista Sem permissão. Lança exceção.
Dependente Sem permissão. Lança exceção.
path Parameters
uuid_de_um_plano
required
string

Responses

planos

Atualiza um plano existente.

Escopo por cargo:

Cargo Contexto
Administração da Plataforma Pode atualizar qualquer plano. Campos opcionais.
Administração da Associação Sem permissão. Lança exceção.
Administração da Horta Sem permissão. Lança exceção.
Canteirista Sem permissão. Lança exceção.
Dependente Sem permissão. Lança exceção.
path Parameters
uuid_de_um_plano
required
string
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "codigo": "4"
}

planos

Realiza exclusão lógica de um plano (marca como excluído).

Escopo por cargo:

Cargo Contexto
Administração da Plataforma Pode excluir (logicamente) qualquer plano.
Administração da Associação Sem permissão. Lança exceção.
Administração da Horta Sem permissão. Lança exceção.
Canteirista Sem permissão. Lança exceção.
Dependente Sem permissão. Lança exceção.
path Parameters
uuid_de_um_plano
required
string

Responses

planos por Usuário UUID

Consulta o plano associado a um usuário específico.

Escopo por cargo:

Cargo Contexto
Administração da Plataforma Acesso completo. Visualiza todos os planos.
Administração da Associação Sem permissão. Lança exceção.
Administração da Horta Sem permissão. Lança exceção.
Canteirista Sem permissão. Lança exceção.
Dependente Sem permissão. Lança exceção.
path Parameters
uuid_user_de_uma_mensalidade_plataforma
required
string

Responses