Pular para o conteúdo principal

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çãoCampos principais
Businessprofile (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)
ProfileCollaboratorbusiness, user, role (RoleCollaborator), status, publicFlag, mainEmail, mainPhone, respondsTo, days, trelloUser, features
RoleTypeprofileType, name, description, features[], assignments[], stepsTemplate[]
Role / RoleCollaboratorroleType, agreement, assignments[], owner (colaborador)
Agreementowner (empresa), customer, type (work/supply), periodicity (fixed/temporary), status, fixedValue, steps[], attachments[], subscriptions[]

Rotas principais​

RotaUso
GET/PUT /business/:idDados 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-keysChaves de API (integração milie)
GET /business/:id/collaborators · /collaborators/:cidLista (com roleName, contatos e contrato) e detalhe
POST /business/:id/collaborator/check-user · POST /business/:id/collaboratorVerificar usuário e convidar
GET/PUT/DELETE /collaborator/:id · /days · /notifications · /user-contactsPerfil, jornada e contatos
GET /role-type · /by-profile/:profileType · /:id/rolesPapéis do app
GET/POST /agreement · GET/PUT/DELETE /agreement/:idContratos

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 features do perfil ou, na falta dela, do papel. Os módulos beta (CRM, Financeiro, Pessoas) só aparecem com liberação explícita.