add readme

This commit is contained in:
2025-05-26 08:48:34 -03:00
parent b2314a003f
commit 002705864b
2 changed files with 20 additions and 6 deletions

31
README.md Normal file
View File

@@ -0,0 +1,31 @@
# Compras
### Relacionamentos
Toda compra feita é relacionada com a empresa responsável, que é definida como o `tenant` da compra. Essa relação é estabelecida com base no CNPJ presente na compra.
O gestor responsável pela ação também é relacionado à compra.
```json
{"id": "10", "sk": "0", "metadata__tenant_id": "100", "metadata__related_ids": ["100", "123"]}
{"id": "10", "sk": "metadata#tenant", "tenant_id": "100"}
{"id": "10", "sk": "related_ids#org", "org_id": "100"}
{"id": "10", "sk": "related_ids#user", "user_id": "123"}
```
# Matrículas
### Eventos agendados
### Proteção contra duplicação
### Política de cancelamento
Apenas matrículas com `metadata#cancel_policy` podem ser canceladas.
```json
{"id": "9omWNKymwU5U4aeun6mWzZ", "sk": "0"}
{"id": "9omWNKymwU5U4aeun6mWzZ", "sk": "metadata#cancel_policy"}
```
### Relacionamentos