Skip to main content
Consulte em tempo real o consumo de autorizações e consultas de trabalhadores utilizados na competência vigente.
Funcionalidade prevista para 01/09 19:00.

Headers de consumo na resposta

Os endpoints abaixo passam a retornar headers informando a quantidade e a competência da fatura vigente:
  • /trabalhador/termo-autorizacao
  • /trabalhador/listar-vinculos
  • /trabalhador/consultar-vinculos
  • /trabalhador/consultar-saldo-fgts

Headers retornados

number
Quantidade de consultas cobráveis do parceiro dentro da competenciaFaturaAtual.
string
Competência de cobrança vigente, no formato AAAAMM.
O ciclo de competência vai do dia 15 de um mês até o dia 14 do mês seguinte. Exemplo: a competência 202607 corresponde ao período de 15/06/2026 00:00:00 até 14/07/2026 23:59:59. Ao virar o dia 15, este valor passa a refletir automaticamente o novo período vigente.

Consulta de saldo da fatura atual

Este serviço permite ao parceiro consultar, sob demanda, o consumo detalhado da competência vigente, decomposto por serviço.

Endpoint

GET /trabalhador/consultar-saldo-fatura
number
Soma da contagem de todos os serviços na competência vigente.
number
Contagem de consultas cobráveis do endpoint /trabalhador/consultar-vinculos na competência vigente.
number
Contagem de consultas cobráveis do endpoint /trabalhador/listar-vinculos na competência vigente.
number
Contagem de consultas cobráveis do endpoint /trabalhador/termo-autorizacao na competência vigente.
number
Contagem de consultas cobráveis do endpoint /trabalhador/consultar-saldo-fgts na competência vigente.
string<date-time>
Data de referência de início da competência vigente.
string<date-time>
Data de referência de fim da competência vigente.