API — RH, contabilidade e outros

OpenAPI: packages/openapi/openapi.v1.yaml
Atualizado: 2026-09-13

Resumo dos demais módulos. Listas longas (RH, contabilidade) mostram os endpoints mais usados; o restante está no OpenAPI / api.php.

RH / folha

Method	Path	Permissão	Descrição
GET	/hr/dashboard	hr.employee.read	Dashboard
GET	/hr/employees	hr.employee.read	Listar funcionários
POST	/hr/employees	hr.employee.create	Criar
GET	/hr/employees/{id}	hr.employee.read	Detalhe
PATCH	/hr/employees/{id}	hr.employee.update	Atualizar
GET	/hr/employees/next-registration	hr.employee.create	Próxima matrícula
GET	/hr/payrolls	hr.payroll.read	Folhas
POST	/hr/payrolls	hr.payroll.create	Criar folha
POST	/hr/payrolls/{id}/calculate	hr.payroll.process	Calcular
POST	/hr/payrolls/{id}/review	hr.payroll.update	Revisar
POST	/hr/payrolls/{id}/close	hr.payroll.close	Fechar
POST	/hr/payrolls/{id}/reopen	hr.payroll.reopen	Reabrir
GET	/hr/entries	hr.entry.read	Lançamentos
POST	/hr/entries	hr.entry.create	Criar lançamento
GET	/hr/advances	hr.advance.read	Adiantamentos
GET	/hr/advance-batches	hr.advance.read	Lotes de adiantamento
GET	/hr/tax-tables	hr.payroll.read	Tabelas fiscais
GET/PATCH	/hr/settings	(HR settings)	Parâmetros RH

Também existem CRUD de cargos, departamentos, tipos de contrato, jornadas, eventos, benefícios e treinamentos sob /hr/*.

Contabilidade

Method	Path	Permissão	Descrição
GET	/chart-accounts	accounting.account.read	Plano de contas
POST	/chart-accounts	accounting.account.create	Criar conta
POST	/chart-accounts/seed-template	accounting.account.seed	Seed template
PATCH	/chart-accounts/{id}	accounting.account.update	Atualizar
GET	/cost-centers	accounting.cost_center.read	Centros de custo
POST	/cost-centers	accounting.cost_center.create	Criar
POST	/cost-centers/{id}/deactivate	accounting.cost_center.update	Desativar
GET	/cost-center-budgets	accounting.budget.read	Orçamentos
POST	/cost-center-budgets	accounting.budget.create	Criar
POST	/cost-center-budgets/{id}/submit	accounting.budget.update	Submeter
POST	/cost-center-budgets/{id}/approve	accounting.budget.approve	Aprovar
POST	/cost-center-budgets/{id}/activate	accounting.budget.approve	Ativar
POST	/cost-center-budgets/transfers	accounting.budget.update	Transferência
POST	/cost-center-budgets/exceptions/{id}/approve	accounting.budget.approve_exception*	Excedente
GET	/accounting/events	accounting.event.read	Eventos do motor
GET	/accounting/rules	accounting.rule.read	Regras
PATCH	/accounting/rules/{id}	accounting.rule.update	Atualizar regra
GET	/accounting/periods	accounting.period.read	Períodos
GET	/accounting/periods/checklist	accounting.period.read	Checklist fechamento
POST	/accounting/periods/close	accounting.period.close	Fechar período
POST	/accounting/periods/reopen	accounting.period.reopen	Reabrir
GET	/accounting/health	accounting.report.read	Saúde contábil
GET	/accounting/batches	accounting.batch.read	Lotes
POST	/accounting/manual-entries	accounting.entry.create	Lançamento manual
GET	/accounting/reports/*	accounting.report.read	Balancete, diário, razão, DRE, BP
POST	/accounting/sped/ecd	accounting.report.read	SPED ECD
POST	/accounting/sped/efd-contribuicoes	accounting.report.read	EFD Contribuições
POST	/accounting/compliance/generate	accounting.report.read	Gerar exportações oficiais
GET	/accounting/compliance/exports	accounting.report.read	Listar exports
GET	/accounting/compliance/exports/{id}/download	accounting.report.read	Download

Suporte (atendimento / OS)

Method	Path	Permissão	Descrição
GET	/support/tickets	support.ticket.read	Atendimentos
POST	/support/tickets	support.ticket.create	Abrir
POST	/support/tickets/{id}/transition	support.ticket.update	Transicionar status
POST	/support/tickets/{id}/messages	support.ticket.update	Mensagem
GET	/support/work-orders	support.work_order.read	Ordens de serviço
POST	/support/work-orders	support.work_order.create	Criar OS
POST	/support/work-orders/{id}/transition	support.work_order.update	Transicionar OS
GET	/support/processes	support.process.read	Processos
GET	/support/subjects	support.subject.read	Assuntos
GET	/support/departments	support.department.read	Setores

Telecom (alto nível)

Method	Path	Permissão	Descrição
GET	/speed-plans	telecom.speed_plan.read	Planos de velocidade
POST	/speed-plans	telecom.speed_plan.create	Criar
GET	/olts	telecom.olt.read	OLTs
POST	/olts	telecom.olt.create	Criar OLT
GET	/onus	telecom.onu.read	ONUs
POST	/onus	telecom.onu.create	Criar ONU
GET	/access-logins	telecom.login.read	Logins
POST	/access-logins	telecom.login.create	Criar login
GET	/nas	telecom.nas.read	NAS
POST	/radius/authenticate	telecom.login.read	Auth RADIUS
GET	/radius/auth-logs	telecom.login.read	Logs RADIUS

IAM, parâmetros e auditoria

Method	Path	Permissão	Descrição
GET	/users	iam.user.read	Usuários
POST	/users	iam.user.create	Criar
PATCH	/users/{id}	iam.user.update	Atualizar
GET	/roles	iam.role.read	Grupos
GET	/roles/permissions	iam.role.read	Catálogo de permissões
PATCH	/roles/{id}	iam.role.update	Atualizar grupo
GET	/audit-logs	iam.audit.read	Auditoria global
GET	/audit-logs/{resourceType}/{resourceId}	iam.audit.read	Por recurso
GET	/settings	settings.parameter.read	Parâmetros
PATCH	/settings	settings.parameter.update	Atualizar

Integrações Telvora

Method	Path	Permissão	Descrição
GET/PUT	/integrations/telvora-tv/connection	integration.tv.read / update	Conexão TV
GET	/integrations/telvora-tv/channels	integration.tv.read	Canais
GET/PUT	/integrations/telvora-tv/packages	integration.tv.read / update	Pacotes
GET/PUT	/integrations/telvora-learning/connection	integration.learning.read / update	Learning
GET/PUT	/integrations/telvora-book/connection	integration.book.read / update	Book
GET	/smtp-accounts	communication.smtp.read	Contas SMTP
GET	/email-templates	communication.email_template.read	Modelos de e-mail

Agenda e backup

Method	Path	Permissão	Descrição
GET	/scheduled-tasks	scheduling.task.read	Agenda / tarefas
POST	/scheduled-tasks	scheduling.task.create	Criar tarefa
PATCH	/scheduled-tasks/{id}	scheduling.task.update	Atualizar
POST	/scheduled-tasks/{id}/run	scheduling.task.update	Executar
GET	/system-backups	tools.backup.read	Listar backups
GET	/system-backups/config	tools.backup.read	Configuração
PATCH	/system-backups/config	tools.backup.run	Atualizar config
POST	/system-backups/run	tools.backup.run	Rodar backup
GET	/system-backups/{id}/download	tools.backup.read	Download

Ver também

• Visão geral
• Compras e estoque
• Financeiro e fiscal
• Cadastros e comercial
• Wiki operador: 23-WIKI/

Referências