Compartilhamento

Este endpoint permite compartilhar períodos contábeis específicos com outros usuários do Finvy, definindo permissões de leitura ou escrita. Apenas usuários com papel de owner ou admin na organização podem gerenciar compartilhamentos.

Objeto Compartilhamento

Atributo	Tipo	Descrição
id	string	O ID único do registro de compartilhamento (UUID).
accounting_period_id	string	O ID do período contábil que está sendo compartilhado.
shared_with_user_id	string	O ID do usuário com quem o período foi compartilhado.
permission_level	string	O nível de permissão (read ou write).
shared_by_user_id	string	O ID do usuário que realizou o compartilhamento.
profiles	object	Um objeto com o username do usuário com quem o período foi compartilhado.

---

Listar Compartilhamentos de um Período

Retorna uma lista de todos os compartilhamentos para um período contábil específico.

GET/api/sharing

Parâmetros de Query

Parâmetro	Tipo	Descrição
accounting_period_id	string	Obrigatório. O ID do período contábil para listar os compartilhamentos.

Resposta

Retorna um array de objetos de Compartilhamento.

Códigos de Status HTTP

• 200 OK: Compartilhamentos listados com sucesso.
• 401 Unauthorized: Autenticação necessária ou credenciais inválidas.
• 500 Internal Server Error: Erro interno do servidor ao listar os compartilhamentos.

---

Compartilhar um Período

Cria um novo compartilhamento de um período contábil com outro usuário.

POST/api/sharing

Corpo da Requisição

Você pode identificar o usuário a receber o compartilhamento pelo seu ID (shared_with_user_id) ou pelo seu handle/email (shared_with_identifier).

{
  "accounting_period_id": "p1q2r3s4-t5u6-7890-1234-567890abcdef",
  "shared_with_identifier": "colega@email.com",
  "permission_level": "read"
}

Resposta

Retorna o objeto de compartilhamento recém-criado.

Códigos de Status HTTP

• 201 Created: Compartilhamento criado com sucesso.
• 400 Bad Request: Dados da requisição inválidos (ex: accounting_period_id ou shared_with_identifier ausente/inválido).
• 401 Unauthorized: Autenticação necessária ou credenciais inválidas.
• 403 Forbidden: Usuário não tem permissão para compartilhar o período.
• 404 Not Found: Período contábil ou usuário não encontrado.
• 409 Conflict: O período já está compartilhado com o usuário especificado.
• 500 Internal Server Error: Erro interno do servidor ao criar o compartilhamento.

---

Remover um Compartilhamento

Revoga o acesso de um usuário a um período contábil compartilhado.

DELETE/api/sharing

Parâmetros de Query

Parâmetro	Tipo	Descrição
id	string	Obrigatório. O ID do registro de compartilhamento a ser removido.

Resposta

204 No Content em caso de sucesso.

Códigos de Status HTTP

• 204 No Content: Compartilhamento removido com sucesso.
• 401 Unauthorized: Autenticação necessária ou credenciais inválidas.
• 403 Forbidden: Usuário não tem permissão para remover o compartilhamento.
• 404 Not Found: Registro de compartilhamento não encontrado.
• 500 Internal Server Error: Erro interno do servidor ao remover o compartilhamento.