> ## 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 Escrituração e Repasse

> Este documento descreve os endpoints disponíveis para consulta de escriturações e repasses.

<Info>
  Novos registros são incluídos diariamente 07h00 com dados D-1.
</Info>

## 1. Consulta de Escrituração

Este serviço retorna, de forma paginada, as informações de descontos de empréstimos consignados escrituradas pelos empregadores no eSocial, filtradas pelo período em que os registros foram incluídos no sistema da Dataprev e filtrado por originador que está executando a consulta.

Os valores lançados representam os descontos efetuados na folha de pagamento do trabalhador para posterior pagamento da guia do FGTS Digital e repasse à Instituição Financeira.

<Info>
  A escrituração é um processo obrigatório que deve ser realizado pela empresa. Caso a empresa não a realize, o desconto referente ao empréstimo consignado não será efetuado na folha de pagamento do trabalhador.
</Info>

### Endpoint

**GET** `/contrato/consultar-escrituracoes`

<AccordionGroup>
  <Accordion title="Descrição da requisição">
    <ParamField path="dataHoraInicio" type="string" required>
      Data e hora inicial da consulta no formato `ddMMyyyyHHmmss`.
    </ParamField>

    <ParamField path="dataHoraFim" type="string" required>
      Data e hora final da consulta no formato `ddMMyyyyHHmmss`.
    </ParamField>

    <ParamField path="nropagina" type="number">
      Número da página a ser consultada. Por padrão, a primeira página será consultada se este parâmetro não for preenchido.
    </ParamField>
  </Accordion>

  <Accordion title="Descrição do retorno">
    <ResponseField name="conteudo[].Id" type="number">
      Identificador do registro de escrituração na Dataprev.
    </ResponseField>

    <ResponseField name="conteudo[].IdEvento" type="string">
      Identificador do evento do eSocial que originou a escrituração.
    </ResponseField>

    <ResponseField name="conteudo[].PeriodoReferencia" type="number">
      Período de referência da escrituração, no formato `yyyyMM`.
    </ResponseField>

    <ResponseField name="conteudo[].CodigoIF" type="number">
      Código da IF beneficiária do desconto. Sempre 531 (BMP).
    </ResponseField>

    <ResponseField name="conteudo[].Contrato" type="string">
      Número do contrato escriturado pelo empregador.

      <Info>
        O empregador pode as vezes escriturar o número do contrato com zeros a esquerda, neste caso a BMP persiste o dado igual a como recebemos da Dataprev, mas para finalidade de identificação do detentor do contrato, buscamos uma correspondência por este valor sem zeros a esquerda dentro dos contratos averbados pelo parceiro.
      </Info>
    </ResponseField>

    <ResponseField name="conteudo[].ValorParcelaDesconto" type="number">
      Valor da parcela descontada na folha de pagamento do trabalhador.
    </ResponseField>

    <ResponseField name="conteudo[].Cpf" type="number">
      CPF do trabalhador titular do contrato.
    </ResponseField>

    <ResponseField name="conteudo[].InscricaoEmpregador.Codigo" type="number">
      Código do tipo de inscrição do empregador (1 - CNPJ, 2 - CPF).
    </ResponseField>

    <ResponseField name="conteudo[].InscricaoEmpregador.Descricao" type="string">
      Descrição do tipo de inscrição do empregador.
    </ResponseField>

    <ResponseField name="conteudo[].NumeroInscricaoEmpregador" type="string">
      Número de inscrição do empregador (CNPJ/CPF).
    </ResponseField>

    <ResponseField name="conteudo[].Matricula" type="string">
      Matrícula do trabalhador junto ao empregador.
    </ResponseField>

    <ResponseField name="conteudo[].DataHoraInclusaoDataprev" type="string<date-time>">
      Data-Hora de recebimento da informação na Dataprev
    </ResponseField>

    <ResponseField name="conteudo[].IdEventoExclusao" type="string">
      Identificador do evento de exclusão da escrituração no eSocial, quando houver.
    </ResponseField>

    <ResponseField name="conteudo[].DataHoraEventoExclusao" type="string">
      Data-Hora do evento de exclusão da escrituração no formato `ddMMyyyyHHmmss`, quando houver.
    </ResponseField>

    <ResponseField name="conteudo[].IdEventoRetificacao" type="string">
      Identificador do evento de retificação da escrituração no eSocial, quando houver.
    </ResponseField>

    <ResponseField name="conteudo[].DataHoraEventoRetificacao" type="string">
      Data-Hora do evento de retificação da escrituração no formato `ddMMyyyyHHmmss`, quando houver.
    </ResponseField>

    <ResponseField name="conteudo[].Emprestimo" type="object">
      Validação da Dataprev quanto ao empréstimo da Escrituração. Se o empréstimo foi escriturado com zero a esquerda, a Dataprev não preenche este objeto, pois ela faz uma busca de correspondência exata.

      <ResponseField name="conteudo[].Emprestimo.CodigoIf" type="number">
        Código da IF do empréstimo consignado associado ao contrato escriturado.
      </ResponseField>

      <ResponseField name="conteudo[].Emprestimo.Contrato" type="string">
        Número do contrato do empréstimo consignado tal como averbado pela IF.
      </ResponseField>

      <ResponseField name="conteudo[].Emprestimo.ValorParcela" type="number">
        Valor da parcela do empréstimo consignado conforme averbado pela IF.
      </ResponseField>
    </ResponseField>

    <ResponseField name="conteudo[].Analise" type="object">
      Indicadores de análise da escrituração pela Dataprev. Se o empréstimo foi escriturado com zero a esquerda, a Dataprev não preenche este objeto, pois ela faz uma busca de correspondência exata.

      <ResponseField name="conteudo[].Analise.ExisteTrabalhadorEscriturado" type="boolean">
        Indica se o trabalhador informado na escrituração foi encontrado.
      </ResponseField>

      <ResponseField name="conteudo[].Analise.ExisteNumeroContratoEscriturado" type="boolean">
        Indica se o número de contrato escriturado foi encontrado entre os contratos averbados.
      </ResponseField>

      <ResponseField name="conteudo[].Analise.VinculoCorreto" type="boolean">
        Indica se o vínculo entre trabalhador e contrato está correto.
      </ResponseField>

      <ResponseField name="conteudo[].Analise.InstituicaoFinanceiraCorreta" type="boolean">
        Indica se a instituição financeira escriturada corresponde à instituição financeira do contrato.
      </ResponseField>

      <ResponseField name="conteudo[].Analise.ValorParcelaCorreta" type="boolean">
        Indica se o valor da parcela escriturada corresponde ao valor da parcela do contrato.
      </ResponseField>

      <ResponseField name="conteudo[].Analise.DadosCorrespondentes" type="boolean">
        Indica se todos os dados analisados (trabalhador, contrato, vínculo, IF e valor da parcela) estão corretos.
      </ResponseField>
    </ResponseField>

    <ResponseField name="conteudo[].TipoEventoESocial.Codigo" type="number">
      Código do tipo de evento do eSocial que originou a escrituração.
    </ResponseField>

    <ResponseField name="conteudo[].TipoEventoESocial.Descricao" type="string">
      Descrição do tipo de evento do eSocial (ex.: "Evento de remuneração periódico").
    </ResponseField>
  </Accordion>
</AccordionGroup>

***

## 2. Consulta de Repasse

Este serviço retorna, de forma paginada, as informações dos pagamentos de empréstimos consignados repassados à instituição financeira, filtradas pelo período em que os registros foram incluídos no sistema da Dataprev e filtrado por originador que está executando a consulta.

<Info>
  Os valores informados correspondem aos repasses realizados pela Caixa Econômica Federal (CEF) conforme as guias pagas pelos empregadores. O prazo para o repasse é de 2 dias após o pagamento da guia pelo empregador. Caso o empregador não tenha realizado o pagamento da guia, a parcela correspondente não constará no retorno deste serviço.
</Info>

### Endpoint

**GET** `/contrato/consultar-repasses`

<AccordionGroup>
  <Accordion title="Descrição da requisição">
    <ParamField path="dataHoraInicio" type="string" required>
      Data e hora inicial da consulta no formato `ddMMyyyyHHmmss`.
    </ParamField>

    <ParamField path="dataHoraFim" type="string" required>
      Data e hora final da consulta no formato `ddMMyyyyHHmmss`.
    </ParamField>

    <ParamField path="nropagina" type="number">
      Número da página a ser consultada. Por padrão, a primeira página será consultada se este parâmetro não for preenchido.
    </ParamField>
  </Accordion>

  <Accordion title="Descrição do retorno">
    <ResponseField name="conteudo[].Id" type="number">
      Identificador do registro de repasse na Dataprev.
    </ResponseField>

    <ResponseField name="conteudo[].CodigoIF" type="number">
      Código da IF que recebeu o repasse. Sempre 531 (BMP).
    </ResponseField>

    <ResponseField name="conteudo[].Contrato" type="string">
      Número do contrato escriturado pelo empregador.

      <Info>
        O empregador pode as vezes escriturar o número do contrato com zeros a esquerda, neste caso a BMP persiste o dado  igual a como recebemos da Dataprev, mas para finalidade de identificação do detentor do contrato, buscamos uma correspondência por este valor sem zeros a esquerda dentro dos contratos averbados pelo parceiro.
      </Info>
    </ResponseField>

    <ResponseField name="conteudo[].ValorParcelaPaga" type="number">
      Valor da parcela paga.
    </ResponseField>

    <ResponseField name="conteudo[].DataHoraPagamentoGuia" type="string">
      Data-Hora de pagamento da guia no formato ddMMyyyyHHmmss.
    </ResponseField>

    <ResponseField name="conteudo[].DataHoraInclusaoDataprev" type="string">
      Data-Hora de recebimento da informação na Dataprev no formato ddMMyyyyHHmmss. Com base nesta informação que a BMP pode fazer a conciliação.
    </ResponseField>

    <ResponseField name="conteudo[].DataHoraRepasseIF" type="string">
      Data-Hora de repasse pra Instituição Financeira no formato ddMMyyyyHHmmss.
    </ResponseField>

    <ResponseField name="conteudo[].NumeroGuia" type="number">
      Número da guia de recolhimento do FGTS e consignado paga pelo empregador.
    </ResponseField>

    <ResponseField name="conteudo[].Competencia" type="number">
      Competência informada na guia do eSocial.
    </ResponseField>

    <ResponseField name="conteudo[].Nsu" type="number">
      NSU (Número Sequencial Único) atribuído pela CEF.
    </ResponseField>
  </Accordion>
</AccordionGroup>

<RequestExample>
  ```shellscript /consultar-escrituracoes theme={null}
  curl --location --request GET \
    'https://econsignadotrabalhador.moneyp.dev.br/contrato/consultar-escrituracoes?dataHoraInicio=01082025000000&dataHoraFim=14082025000000&nropagina=1' \
    --header 'Authorization: Bearer <token>'
  ```

  ```shellscript /consultar-repasses theme={null}
  curl --location --request GET \
    'https://econsignadotrabalhador.moneyp.dev.br/contrato/consultar-repasses?dataHoraInicio=01082025000000&dataHoraFim=14082025000000&nropagina=1' \
    --header 'Authorization: Bearer <token>'
  ```
</RequestExample>

<ResponseExample>
  ```json /consultar-escrituracoes theme={null}
  {
    "CodigoRequisicao": "bdf2a784-53ac-410c-818c-4efc061535f2",
    "Origem": "/consultar-escrituracoes",
    "Conteudo": {
      "NroPaginaAtual": 1,
      "NroTotalPaginas": 1,
      "NroTotalRegistros": 57,
      "QtdRegistrosPorPagina": 250,
      "QtdRegistrosPaginaAtual": 57,
      "DataHoraInicio": "2025-07-01T00:00:00",
      "DataHoraFim": "2026-07-28T00:00:00",
      "Conteudo": [
        {
          "Id": 9383,
          "IdEvento": "1234",
          "PeriodoReferencia": 202507,
          "CodigoIF": 531,
          "Contrato": "5124954",
          "ValorParcelaDesconto": 95.470000,
          "Cpf": 26421184014,
          "InscricaoEmpregador": {
            "Codigo": 1,
            "Descricao": "CNPJ"
          },
          "NumeroInscricaoEmpregador": "49451375",
          "Matricula": "1809",
          "DataHoraInclusaoDataprev": "2026-02-03T16:17:07",
          "IdEventoExclusao": null,
          "DataHoraEventoExclusao": null,
          "IdEventoRetificacao": null,
          "DataHoraEventoRetificacao": null,
          "Emprestimo": {
            "CodigoIf": 531,
            "Contrato": "5124954",
            "ValorParcela": 95.470000
          },
          "Analise": {
            "ExisteTrabalhadorEscriturado": true,
            "ExisteNumeroContratoEscriturado": true,
            "VinculoCorreto": true,
            "InstituicaoFinanceiraCorreta": true,
            "ValorParcelaCorreta": true,
            "DadosCorrespondentes": true
          },
          "TipoEventoESocial": {
            "Codigo": 0,
            "Descricao": "Evento de remuneração periódico"
          }
        }
      ]
    },
    "Erros": []
  }
  ```

  ```json /consultar-repasses theme={null}
  {
    "CodigoRequisicao": "c3c998c8-a276-4d2d-90ea-f4f9f738dafa",
    "Origem": "/consultar-repasses",
    "Conteudo": {
      "NroPaginaAtual": 1,
      "NroTotalPaginas": 1,
      "NroTotalRegistros": 1,
      "QtdRegistrosPorPagina": 250,
      "QtdRegistrosPaginaAtual": 1,
      "DataHoraInicio": "01082025000000",
      "DataHoraFim": "28072026000000",
      "Conteudo": [
        {
          "Id": 916,
          "CodigoIF": 531,
          "Contrato": "5063297",
          "ValorParcelaPaga": 494.920000,
          "DataHoraPagamentoGuia": "07082025000000",
          "DataHoraInclusaoDataprev": "08082025143419",
          "DataHoraRepasseIF": "08082025000000",
          "NumeroGuia": 8082025,
          "Competencia": 202507,
          "Nsu": 12345678
        }
      ]
    },
    "Erros": []
  }
  ```
</ResponseExample>