> ## Documentation Index
> Fetch the complete documentation index at: https://bmpdocs.moneyp.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# Consulta de quantidade de autorizações e consultas de trabalhadores

> Este documento descreve os headers de consumo em tempo real e o serviço de consulta de saldo da fatura atual.

Consulte em tempo real o consumo de autorizações e consultas de trabalhadores utilizados na competência vigente.

<Info>
  Funcionalidade prevista para 01/09 19:00.
</Info>

## 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

<AccordionGroup>
  <Accordion title="Descrição do retorno">
    <ResponseField name="quantidadeFaturaAtual" type="number">
      Quantidade de consultas cobráveis do parceiro dentro da `competenciaFaturaAtual`.
    </ResponseField>

    <ResponseField name="competenciaFaturaAtual" type="string">
      Competência de cobrança vigente, no formato `AAAAMM`.

      <Info>
        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.
      </Info>
    </ResponseField>
  </Accordion>
</AccordionGroup>

***

## 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`

<AccordionGroup>
  <Accordion title="Descrição do retorno">
    <ResponseField name="ConsumoTotal" type="number">
      Soma da contagem de todos os serviços na competência vigente.
    </ResponseField>

    <ResponseField name="ConsultarVinculos" type="number">
      Contagem de consultas cobráveis do endpoint `/trabalhador/consultar-vinculos` na competência vigente.
    </ResponseField>

    <ResponseField name="ListarVinculos" type="number">
      Contagem de consultas cobráveis do endpoint `/trabalhador/listar-vinculos` na competência vigente.
    </ResponseField>

    <ResponseField name="TermoAutorizacao" type="number">
      Contagem de consultas cobráveis do endpoint `/trabalhador/termo-autorizacao` na competência vigente.
    </ResponseField>

    <ResponseField name="ConsultarFGTS" type="number">
      Contagem de consultas cobráveis do endpoint `/trabalhador/consultar-saldo-fgts` na competência vigente.
    </ResponseField>

    <ResponseField name="CompetenciaInicio" type="string<date-time>">
      Data de referência de início da competência vigente.
    </ResponseField>

    <ResponseField name="CompetenciaFim" type="string<date-time>">
      Data de referência de fim da competência vigente.
    </ResponseField>
  </Accordion>
</AccordionGroup>

<RequestExample>
  ```shellscript /consultar-saldo-fatura theme={null}
  curl --location --request GET \
    'https://econsignadotrabalhador.moneyp.dev.br/parceiro/consultar-consumo' \
    --header 'Authorization: Bearer <token>'
  ```
</RequestExample>

<ResponseExample>
  ```json /consultar-saldo-fatura theme={null}
  {
    "ConsumoTotal": 492,
    "ConsultarVinculos": 123,
    "ListarVinculos": 123,
    "TermoAutorizacao": 123,
    "ConsultarFGTS": 123,
    "CompetenciaInicio": "15-07-2026 00:00:00",
    "CompetenciaFim": "14-08-2026 23:59:59"
  }
  ```
</ResponseExample>