Referência técnica de empresa, colaboradores e contratos
Domínios Business, Collaborator, Role, RoleType e Agreement da pepper-api. As telas ficam em pepper-front/src/app/{business,collaborator,agreement}.
Entidades
| Coleção | Campos principais |
|---|---|
Business | profile (ProfileBusiness), owner, name (razão social), fantasyName, cnpj, phone, email, address, userApi/userApiUrl/key (integração), shipping (contato público, fiscal, embalagem padrão), bankAccount (ATLA Pay: mode subaccount/main, platformFeePercent, openingEnabled, openingRequest, dados do titular) |
ProfileCollaborator | business, user, role (RoleCollaborator), status, publicFlag, mainEmail, mainPhone, respondsTo, days, trelloUser, features |
RoleType | profileType, name, description, features[], assignments[], stepsTemplate[] |
Role / RoleCollaborator | roleType, agreement, assignments[], owner (colaborador) |
Agreement | owner (empresa), customer, type (work/supply), periodicity (fixed/temporary), status, fixedValue, steps[], attachments[], subscriptions[] |
Rotas principais
| Rota | Uso |
|---|---|
GET/PUT /business/:id | Dados da empresa (o GET devolve o endereço também achatado) |
/business/:id/bank-account/* | ATLA Pay: status, main, open, mode, fee, opening-enabled, opening-request, cancellation |
/business/:id/api-keys | Chaves de API (integração milie) |
GET /business/:id/collaborators · /collaborators/:cid | Lista (com roleName, contatos e contrato) e detalhe |
POST /business/:id/collaborator/check-user · POST /business/:id/collaborator | Verificar usuário e convidar |
GET/PUT/DELETE /collaborator/:id · /days · /notifications · /user-contacts | Perfil, jornada e contatos |
GET /role-type · /by-profile/:profileType · /:id/roles | Papéis do app |
GET/POST /agreement · GET/PUT/DELETE /agreement/:id | Contratos |
Permissões
- Colaborador Admin:
isAdminCollaborator(utils/permissions/collaborator-role.js) reconhece o colaborador cujo papel tem "Admin" no nome. É ele quem libera Financeiro, Impostos, Pessoas e Folha e quem edita a empresa. - Módulos visíveis na home: saem da lista
featuresdo perfil ou, na falta dela, do papel. Os módulos beta (CRM, Financeiro, Pessoas) só aparecem com liberação explícita.