Ir para o conteúdo
prumo

documentação · v1

Uma API para o ciclo inteiro da folha

Tudo que a tela faz do lado da organização também acontece por aqui: quadro de funcionários, benefícios, férias, ponto, competências, holerites, admissão e desligamento, documentos, compras, recrutamento, chat, membros, cobrança, suporte e a análise financeira do balancete.

basehttps://api.goprumo.com.br/functions/v1/api/v1
01

Gere a chave

Em Integrações e API, dentro da organização. A chave age com o papel de quem a criou.

02

Confirme quem você é

Um GET em /v1/me devolve a organização, o ator e o nível de cada permissão. Nenhum endereço pede id de organização.

03

Cadastre alguém

Um POST em /v1/employees cria a ficha. Com o objeto access, a pessoa também ganha conta para assinar o próprio holerite.

Conta e organização5 endereços

A chave já sabe de qual organização ela é. Nenhum endereço aceita um id de organização por fora.

/v1/me
Membros e convites8 endereços

Membros são as contas com acesso ao produto. O proprietário nunca pode ser alterado nem removido pela API, e uma chave não mexe na própria conta.

/v1/members
Funcionários10 endereços

O quadro que alimenta toda competência. Desligar é um endereço próprio, porque a data entra na mesma escrita.

/v1/employees
Folha de pagamento11 endereços

A competência congela o quadro e as tabelas fiscais na abertura. Todo lançamento é recalculado pelo mesmo motor que a tela usa.

/v1/payroll-runs
Holerites7 endereços

Duas origens convivem: o holerite que sai da folha e o PDF enviado em lote. A assinatura em si só acontece na sessão do funcionário, nunca pela API.

/v1/payslips
Cobrança2 endereços

A fatura nasce quando a folha é aprovada, com o número de pessoas congelado naquele instante.

/v1/invoices
Análise financeira31 endereços

As demonstrações, os indicadores e as carteiras montados a partir do balancete importado. A importação por aqui recebe JSON já normalizado: o parser de planilha continua só na tela.

/v1/financial-periods
Férias7 endereços

O período aquisitivo sai da admissão e o saldo é consumido do mais antigo para o mais novo. O que for aprovado entra na folha da competência em que cai.

/v1/vacation-requests
Ponto14 endereços

A batida é registro imutável: só um ajuste aprovado corrige, e o horário antigo continua no histórico. Espelho, saldo do dia e banco de horas saem derivados das batidas, nunca gravados.

/v1/time-punches
Suporte13 endereços

Os chamados que os clientes da sua empresa abrem pelo link público de suporte. O prazo de resposta corre de segunda a sábado, das 7h às 18h.

/v1/support-tickets
Benefícios8 endereços

O catálogo é da organização e a adesão é da pessoa. O valor da adesão vence o do plano quando existe, e a situação sai das datas: nada de ativo ou encerrado é gravado.

/v1/benefit-plans
Compras16 endereços

A requisição anda em três etapas: quem pede abre, suprimentos confere e o financeiro libera. A trilha e o alerta de preço são derivados, nunca gravados, e o fornecedor é só nome e CNPJ, sem cadastro.

/v1/purchase-requests
Admissão e desligamento16 endereços

O ciclo de entrada e de saída como processo. A admissão prende um checklist na ficha do funcionário e segura a situação em onboarding até tudo fechar; o desligamento guarda motivo, aviso prévio e checklist de saída, e congela as verbas rescisórias na conclusão. A prévia das verbas é recalculada a cada leitura e nunca vem do corpo da requisição.

/v1/admissions
Documentos18 endereços

O acervo da empresa: arquivo com validade, acesso concedido por documento a membro, grupo, papel ou organização, e a trilha de quem fez o quê. O arquivo só sai por URL assinada, e cada emissão vira um evento.

/v1/documents
Recrutamento8 endereços

O banco de talentos é compartilhado entre as empresas do Prumo: o candidato preenche o perfil uma vez, pela página pública de quem o convidou, e aparece para toda organização com permissão de leitura. A etapa, o descarte e a contratação são de cada empresa, e um não enxerga o do outro.

/v1/candidates
Chat8 endereços

O canal interno da empresa: conversa direta entre duas pessoas e grupo com três ou mais. A chave fala como a pessoa que a criou: ela enxerga as conversas dessa pessoa e escreve em nome dela, e nada mais. Quem não participa de uma conversa recebe 404, mesmo com manage_chat.

/v1/chat-conversations
Afiliados3 endereços

O programa de indicação da própria Prumo. A organização da chave vira afiliada, ganha um link e recebe 10% de cada cobrança paga pelas empresas que criarem a conta por ele, enquanto elas forem clientes. Nada é gravado sobre a comissão: ela é derivada das faturas a cada leitura.

/v1/affiliate

referência

Todos os endereços

185 chamadas em 17 recursos. Uma linha por endereço, com a permissão que ela exige e quantos campos ela documenta.

Todos os endereços da API da Prumo
métodocaminho
GET/v1/meQuem sou euqualquer chave
GET/v1/organizationDados da empresaqualquer chave
PATCH/v1/organizationAtualizar a empresamanage_members
POST/v1/organization/closeEncerrar a organizaçãomanage_members
GET/v1/permissionsMatriz de permissõesqualquer chave
GET/v1/membersListar membrosqualquer chave
POST/v1/membersCriar membromanage_members
PATCH/v1/members/:userIdTrocar o papelmanage_members
DELETE/v1/members/:userIdRemover membromanage_members
GET/v1/invitationsListar convitesmanage_members
POST/v1/invitationsConvidar por e-mailmanage_members
POST/v1/invitations/:invitationId/resendReenviar convitemanage_members
DELETE/v1/invitations/:invitationIdRevogar convitemanage_members
GET/v1/employeesListar funcionáriosview_all_employees (ver)
POST/v1/employeesCadastrar funcionáriomanage_employees, mais manage_members quando access.role não é employee
POST/v1/employees/batchImportar em lotemanage_employees
GET/v1/employees/:employeeIdVer funcionárioview_all_employees (ver)
PATCH/v1/employees/:employeeIdAtualizar funcionáriomanage_employees
POST/v1/employees/:employeeId/terminateDesligarmanage_employees
GET/v1/employees/:employeeId/bank-proofBaixar o comprovante bancárioview_all_employees (ver)
POST/v1/employees/:employeeId/bank-proofAnexar o comprovante bancáriomanage_employees
POST/v1/employees/:employeeId/grant-accessDar acesso ao holeriteissue_payslips
GET/v1/employees/:employeeId/payslipsHolerites da pessoaview_payroll (ver)
GET/v1/payroll-runsListar competênciasview_payroll (ver)
POST/v1/payroll-runsAbrir competênciaedit_payroll_entries
GET/v1/payroll-runs/:runIdVer competênciaview_payroll (ver)
PUT/v1/payroll-runs/:runId/entries/:employeeIdLançar horas e descontosedit_payroll_entries
POST/v1/payroll-runs/:runId/recomputeRecalcular a competênciaedit_payroll_entries
POST/v1/payroll-runs/:runId/approveAprovarapprove_payroll
POST/v1/payroll-runs/:runId/reopenReabrirapprove_payroll
POST/v1/payroll-runs/:runId/payMarcar como pagaapprove_payroll
GET/v1/payroll-runs/:runId/payslipsHolerites da competênciaview_payroll (ver)
POST/v1/payroll-runs/:runId/payslipsEmitir holeritesissue_payslips
GET/v1/tax-tablesTabelas de INSS e IRRFqualquer chave
GET/v1/payslipsListar holerites da folhaview_payroll (ver)
GET/v1/payslips/:payslipIdVer holerite da folhaview_payroll (ver)
GET/v1/payslip-uploadsListar lotes de PDFview_payroll (ver)
POST/v1/payslip-uploadsEnviar holerites em PDFissue_payslips
GET/v1/uploaded-payslips/:payslipIdVer holerite em PDFview_payroll (ver)
DELETE/v1/uploaded-payslips/:payslipIdRemover holerite em PDFissue_payslips
GET/v1/uploaded-payslips/:payslipId/fileBaixar o PDFview_payroll (ver)
GET/v1/invoicesListar faturasview_billing (ver)
POST/v1/invoices/:invoiceId/chargeGerar o link de pagamentoview_billing
GET/v1/financial-periodsListar competências disponíveisview_financials (ver)
GET/v1/financial-overviewVisão geral da competênciaview_financials (ver)
GET/v1/financial-statements/incomeDemonstração do resultadoview_financials (ver)
GET/v1/financial-statements/balanceBalanço patrimonialview_financials (ver)
GET/v1/financial-statements/cash-flowFluxo de caixaview_financials (ver)
GET/v1/financial-indicatorsIndicadoresview_financials (ver)
GET/v1/receivablesCarteira de recebíveisview_financials (ver)
GET/v1/payablesCarteira de pagáveisview_financials (ver)
GET/v1/ledger-importsListar importaçõesview_financials (ver)
POST/v1/ledger-importsImportar balancetemanage_financials
GET/v1/ledger-imports/:importIdVer uma importaçãoview_financials (ver)
POST/v1/ledger-imports/:importId/completeConcluir a importaçãomanage_financials
GET/v1/ledger-accountsListar o plano de contasview_financials (ver)
PATCH/v1/ledger-accounts/:accountIdClassificar uma contamanage_financials
GET/v1/financial-settingsVer metas e pesosview_financials (ver)
PATCH/v1/financial-settingsAlterar metas e pesosmanage_financials
GET/v1/financial-scenariosListar conjuntos de cenáriosview_financials (ver)
POST/v1/financial-scenariosSalvar um conjunto de cenáriosmanage_financials
GET/v1/financial-scenario-projectionProjeção dos três cenáriosview_financials (ver)
POST/v1/ledger-imports/:importId/receivablesEnviar a carteira de recebíveismanage_financials
POST/v1/ledger-imports/:importId/payablesEnviar a carteira de pagáveismanage_financials
POST/v1/ledger-imports/:importId/validateRodar as conferênciasmanage_financials
POST/v1/ledger-accounts/batchClassificar contas em lotemanage_financials
GET/v1/financial-cash-projectionProjeção de treze semanasview_financials (ver)
GET/v1/financial-payment-calendarCalendário de compromissosview_financials (ver)
GET/v1/financial-breakevenPonto de equilíbrioview_financials (ver)
GET/v1/financial-riskEstrutura e riscoview_financials (ver)
GET/v1/financial-peoplePessoas e resultadoview_financials (ver)
GET/v1/financial-settings/changesHistórico de alteraçõesview_financials (ver)
GET/v1/financial-reportsListar pacotes geradosview_financials (ver)
POST/v1/financial-reportsGerar o pacote em PDFmanage_financials
GET/v1/vacation-requestsListar pedidos de fériasview_vacations (ver)
POST/v1/vacation-requestsAgendar fériasmanage_vacations
GET/v1/vacation-requests/:requestIdVer pedido de fériasview_vacations (ver)
POST/v1/vacation-requests/:requestId/approveAprovarmanage_vacations
POST/v1/vacation-requests/:requestId/rejectRecusarmanage_vacations
POST/v1/vacation-requests/:requestId/cancelCancelarmanage_vacations
GET/v1/employees/:employeeId/vacation-balanceSaldo de férias do funcionárioview_vacations (ver)
GET/v1/time-punchesListar batidasview_timesheets (ver)
POST/v1/time-punchesLançar batidamanage_timesheets
GET/v1/employees/:employeeId/timesheetEspelho do funcionárioview_timesheets (ver)
GET/v1/time-boardPainel do pontoview_timesheets (ver)
GET/v1/time-adjustmentsListar ajustesview_timesheets (ver)
POST/v1/time-adjustmentsAbrir ajustemanage_timesheets
POST/v1/time-adjustments/:adjustmentId/approveAprovar ajustemanage_timesheets
POST/v1/time-adjustments/:adjustmentId/rejectRecusar ajustemanage_timesheets
GET/v1/work-schedulesListar jornadasview_timesheets (ver)
POST/v1/work-schedulesCriar jornadamanage_timesheets
PATCH/v1/work-schedules/:scheduleIdAtualizar jornadamanage_timesheets
GET/v1/time-importsListar importaçõesview_timesheets (ver)
POST/v1/time-importsImportar batidasmanage_timesheets
POST/v1/time-periods/closeFechar período do pontomanage_timesheets
GET/v1/support-ticketsListar chamadosview_tickets (ver)
POST/v1/support-ticketsAbrir chamadomanage_tickets
GET/v1/support-tickets/:ticketIdVer chamadoview_tickets (ver)
GET/v1/support-tickets/:ticketId/messagesListar mensagensview_tickets (ver)
POST/v1/support-tickets/:ticketId/messagesRespondermanage_tickets
POST/v1/support-tickets/:ticketId/assignAtribuirmanage_tickets
POST/v1/support-tickets/:ticketId/priorityMudar prioridademanage_tickets
POST/v1/support-tickets/:ticketId/statusMudar situaçãomanage_tickets
GET/v1/support-metricsPainel de SLAview_tickets (ver)
GET/v1/support-macrosListar respostas prontasview_tickets (ver)
POST/v1/support-macrosCriar resposta prontamanage_tickets
PATCH/v1/support-macros/:macroIdEditar resposta prontamanage_tickets
DELETE/v1/support-macros/:macroIdRemover resposta prontamanage_tickets
GET/v1/benefit-plansListar planos de benefícioview_all_employees
POST/v1/benefit-plansCadastrar planomanage_employees
PATCH/v1/benefit-plans/:planIdEditar planomanage_employees
DELETE/v1/benefit-plans/:planIdArquivar planomanage_employees
GET/v1/employees/:employeeId/benefitsBenefícios de uma pessoaview_all_employees
POST/v1/employees/:employeeId/benefitsVincular a um planomanage_employees
PATCH/v1/employee-benefits/:benefitIdEditar adesãomanage_employees
DELETE/v1/employee-benefits/:benefitIdRemover adesãomanage_employees
GET/v1/purchase-requestsListar requisiçõesview_purchases (ver)
POST/v1/purchase-requestsAbrir requisiçãorequest_own_purchase
GET/v1/purchase-requests/:requestIdVer requisiçãoview_purchases (ver)
POST/v1/purchase-requests/:requestId/approveAprovar a etapa correntemanage_purchases ou approve_purchases, conforme a etapa
POST/v1/purchase-requests/:requestId/rejectReprovar a requisiçãomanage_purchases ou approve_purchases, conforme a etapa
GET/v1/purchase-requests/:requestId/messagesLer a conversa do pedidoview_purchases (ver)
POST/v1/purchase-requests/:requestId/messagesEscrever na conversa do pedidoview_purchases (ver)
GET/v1/purchase-itemsListar o catálogo de itensview_purchases (ver)
PATCH/v1/purchase-items/:itemIdAjustar a faixa de referênciamanage_purchases
GET/v1/purchase-items/:itemId/pricesVer a série de preço do itemview_purchases (ver)
GET/v1/purchase-quotesListar cotaçõesview_purchases (ver)
POST/v1/purchase-quotesAbrir cotaçãomanage_purchases
GET/v1/purchase-quotes/:quoteIdVer cotaçãoview_purchases (ver)
POST/v1/purchase-quotes/:quoteId/roundsRegistrar rodadamanage_purchases
POST/v1/purchase-quotes/:quoteId/requestGerar requisição da cotaçãomanage_purchases
GET/v1/purchase-metricsNúmeros do mêsview_purchases (ver)
GET/v1/admissionsAdmissões em andamentoview_all_employees (ver)
POST/v1/admissionsAbrir admissãomanage_employees
GET/v1/admissions/:employeeIdDetalhe da admissãoview_all_employees (ver)
POST/v1/admissions/:employeeId/tasksAcrescentar tarefas à admissãomanage_employees
POST/v1/admissions/:employeeId/completeConcluir admissãomanage_employees
POST/v1/admissions/:employeeId/cancelCancelar admissãomanage_employees
GET/v1/lifecycle-tasks/:taskIdUma tarefaview_all_employees (ver)
PATCH/v1/lifecycle-tasks/:taskIdConcluir ou reabrir tarefamanage_employees
DELETE/v1/lifecycle-tasks/:taskIdRemover tarefamanage_employees
GET/v1/terminationsDesligamentosview_all_employees (ver)
POST/v1/terminationsAbrir desligamentomanage_employees
GET/v1/terminations/:terminationIdDetalhe do desligamentoview_all_employees (ver)
GET/v1/terminations/:terminationId/settlementVerbas rescisóriasview_all_employees (ver)
POST/v1/terminations/:terminationId/tasksAcrescentar tarefas à saídamanage_employees
POST/v1/terminations/:terminationId/completeConcluir desligamentomanage_employees
POST/v1/terminations/:terminationId/cancelCancelar desligamentomanage_employees
GET/v1/documentsListar documentosview_documents (ver)
POST/v1/documentsEnviar documentomanage_documents
GET/v1/documents/:documentIdVer documentoview_documents (ver)
PATCH/v1/documents/:documentIdAlterar metadadosview_documents (ver)
DELETE/v1/documents/:documentIdApagar documentoview_documents (ver)
GET/v1/documents/:documentId/fileURL do arquivoview_documents (ver)
POST/v1/documents/:documentId/fileSubstituir arquivoview_documents (ver)
GET/v1/documents/:documentId/sharesListar concessõesview_documents (ver)
POST/v1/documents/:documentId/sharesConceder acessoview_documents (ver)
DELETE/v1/documents/:documentId/shares/:shareIdRevogar acessoview_documents (ver)
GET/v1/documents/:documentId/eventsTrilha do documentoview_documents (ver)
GET/v1/document-accessMatriz de concessõesview_documents (ver)
DELETE/v1/document-access/members/:userIdRevogar concessões diretas de um membroview_documents (ver)
GET/v1/document-groupsListar gruposview_documents (ver)
POST/v1/document-groupsCriar grupomanage_documents
PATCH/v1/document-groups/:groupIdRenomear grupomanage_documents
DELETE/v1/document-groups/:groupIdApagar grupomanage_documents
PUT/v1/document-groups/:groupId/membersDefinir membros do grupomanage_documents
GET/v1/candidatesListar candidatosview_candidates (ver)
POST/v1/candidatesCadastrar candidatomanage_candidates
GET/v1/candidates/:candidateIdVer candidatoview_candidates (ver)
POST/v1/candidates/:candidateId/stageMover de etapamanage_candidates
POST/v1/candidates/:candidateId/discardDescartar candidatomanage_candidates
POST/v1/candidates/:candidateId/hireRegistrar contrataçãomanage_candidates
GET/v1/candidates/:candidateId/cvBaixar o currículoview_candidates (ver)
GET/v1/talent-statsIndicadores do bancoview_candidates (ver)
GET/v1/chat-conversationsListar conversasuse_chat (ver)
POST/v1/chat-conversationsAbrir conversause_chat
GET/v1/chat-conversations/:conversationIdVer conversause_chat (ver)
PATCH/v1/chat-conversations/:conversationIdRenomear ou arquivar grupomanage_chat
POST/v1/chat-conversations/:conversationId/readMarcar como lidause_chat
GET/v1/chat-conversations/:conversationId/messagesListar mensagensuse_chat (ver)
POST/v1/chat-conversations/:conversationId/messagesEnviar mensagemuse_chat
POST/v1/chat-messages/:messageId/reactionsReagir a uma mensagemuse_chat
GET/v1/affiliatePainel de afiliadomanage_affiliates (ver)
POST/v1/affiliateEntrar no programamanage_affiliates
PATCH/v1/affiliateTrocar o código ou pausarmanage_affiliates