Skip to main content
A tag Payment Sheet consolida os eventos da folha de pagamento da UN — proventos (salário, HE, adicional noturno, comissões) e descontos (faltas, vale-transporte, INSS) — e exporta no layout específico do seu sistema de folha externa. É o principal use case de integradores B2B porque resolve o problema clássico: ter o cálculo de jornada Pontua-side e a folha em um sistema externo (Domínio Sistemas, Sage Senior, Alterdata, ContabilQuasar, etc.).

​
Conceitos

Source

Origem do evento: SISTEMA (cálculo automático), PONTO (derivado de batidas), AJUSTE (correção manual), e outros conforme configuração. Veja GET /payment-sheet/source.

System Event

Eventos pré-cadastrados pelo sistema (ex.: HE 50%, HE 100%, Adicional Noturno, Faltas). Cada evento tem código próprio que mapeia para rúbrica da folha externa. Veja GET /payment-sheet/system-event.

Export Layout

Layout do arquivo TXT esperado pelo seu sistema de folha. Cada sistema tem seu formato (Domínio Sistemas usa um, Sage outro). Cadastrado uma vez por UN, reutilizado em todo export.

Parameter

Parâmetros de configuração específicos do export — quais eventos incluir, regra de arredondamento, agrupamentos. Avançado.

​
Endpoints

​
Eventos (Event)

MétodoRotaDescrição
GET/payment-sheet/eventLista eventos cadastrados
GET/payment-sheet/event/{id}Detalhe
POST/payment-sheet/eventCria evento custom
POST/payment-sheet/event/syncSincronização em massa
PATCH/payment-sheet/event/{id}/statusAtiva/inativa
DELETE/payment-sheet/event/{id}Remove

​
Exportações (Export)

MétodoRotaDescrição
GET/payment-sheet/exportLista exports gerados
GET/payment-sheet/export/{id}Detalhe + status
GET/payment-sheet/export/{id}/downloadConteúdo (URL S3 ou base64)
GET/payment-sheet/export/{id}/{collaboratorId}Eventos de um colaborador específico
POST/payment-sheet/exportDisparar nova exportação
PATCH/payment-sheet/export/{id}/status/processedMarcar como processado pela folha
PATCH/payment-sheet/export/{id}/{collaboratorId}Editar valores de eventos
DELETE/payment-sheet/export/{id}Remove export
DELETE/payment-sheet/export/{id}/{collaboratorId}Remove colaborador do export

​
Layout e Parâmetros

MétodoRotaDescrição
GET/payment-sheet/export-layoutLista layouts cadastrados
GET/payment-sheet/export-layout/{id}Detalhe do layout
POST/payment-sheet/export-layoutCria layout custom (avançado)
PUT/payment-sheet/export-layout/{id}Atualiza
DELETE/payment-sheet/export-layout/{id}Remove
GET/payment-sheet/parameterLista parâmetros
GET/payment-sheet/parameter/{id}Detalhe
GET/payment-sheet/parameter/{id}/collaboratorsColaboradores vinculados a um parâmetro
MétodoRotaDescrição
GET/payment-sheet/sourceLista origens de eventos disponíveis
GET/payment-sheet/system-eventLista eventos pré-cadastrados pelo sistema
Schema completo em Referência da API.

​
Fluxo end-to-end típico

1. Setup (uma vez):
   ├── Cadastrar Layout (POST /export-layout) — formato do TXT
   └── Cadastrar Parâmetros (POST /parameter) — quais eventos, regras

2. Mensalmente (após fechamento):
   ├── POST /export — dispara exportação
   ├── GET /export/{id} — polling até CONCLUIDO
   ├── GET /export/{id}/download — baixa TXT
   ├── (Seu sistema importa o TXT na folha externa)
   └── PATCH /export/{id}/status/processed — marca como integrado
Ver guia detalhado Puxar folha do mês.

​
Gotchas conhecidos

POST /export falha com 400 se a UN não tem layout cadastrado. Cadastre o layout primeiro (via dashboard tipicamente, ou via API em setup automatizado).
Cheque que o período tem fechamento concluído antes de exportar. Exportar com ajustes em curso pode gerar TXT que diverge da folha oficial. Ver Fechamento.
PATCH /export/{id}/status/processed é a forma de fechar o ciclo Pontua → folha externa. Em caso de fiscalização, esse marcador prova que a folha foi efetivamente importada. Sempre marque após confirmação do sistema downstream.
Layouts pré-cadastrados pela Pontua cobrem maioria dos sistemas BR. Criar layout custom (POST /export-layout) é necessário só em formato proprietário não suportado. Erro no layout custom causa folha errada — valide caso a caso.

​
Veja também