> ## Documentation Index
> Fetch the complete documentation index at: https://bmpmoneyplus-sandbox.mintlify.site/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 **consulta de repasses**, no contexto da integração entre instituições financeiras, **DATAPREV/eSocial** e a BMP.

> **Atualização dos dados:**\
> As APIs são atualizadas **diariamente com dados D-1**.

***

## 1. Consulta de Escrituração

***

**Tipo:** Síncrona Após o processamento das folhas de pagamento e a **escrituração das informações no eSocial pelo empregador**, a instituição financeira pode consultar os **eventos escriturados** associados aos contratos de consignado. A consulta é realizada por **intervalo de datas** e **paginação**. Como retorno, são exibidas as informações da página solicitada, além de uma lista de registros contendo dados como vínculo, período de referência e valor da parcela descontada.

***

### Endpoint

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

***

### Parâmetros da Requisição (Query Params)

| Campo            | Obrigatório | Descrição                                                    |
| ---------------- | ----------- | ------------------------------------------------------------ |
| `dataHoraInicio` | Sim         | Data e hora inicial da consulta no formato `ddMMyyyyHHmmss`. |
| `dataHoraFim`    | Sim         | Data e hora final da consulta no formato `ddMMyyyyHHmmss`.   |
| `nropagina`      | Sim         | Número da página a ser consultada.                           |

***

<AccordionGroup>
  <Accordion title="Exemplo de requisição">
    ```bash theme={null}
    	curl --location --request GET \ 'https://econsignadotrabalhador.moneyp.dev.br/contrato/consultar-escrituracoes?dataHoraInicio=01082025000000&dataHoraFim=14082025000000&nropagina=1' \ --header 'Authorization: Bearer <token>'
    ```
  </Accordion>

  <Accordion title="Exemplo de retorno">
    ```json theme={null}
      {
      "CodigoRequisicao": "7b307672-a414-4b8b-9bb6-e38482581765",
      "Origem": "/consultar-escrituracoes",
      "Conteudo": {
      	"nroPaginaAtual": 1,
      	"nroTotalPaginas": 3,
      	"nroTotalRegistros": 105,
      	"qtdRegistrosPorPagina": 50,
      	"qtdRegistrosPaginaAtual": 50,
      	"dataHoraInicio": "ddMMyyyyHHmmss",
      	"dataHoraFim": "ddMMyyyyHHmmss",
      	"conteudo": [
      		{
      			"id": 123,
      			"idEvento": "string",
      			"periodoReferencia": 202505,
      			"codigoIF": 999,
      			"contrato": "string",
      			"valorParcelaDesconto": 0,
      			"cpf": 0,
      			"inscricaoEmpregador": {
      				"codigo": 0,
      				"descricao": "string"
      			},
      			"numeroInscricaoEmpregador": 0,
      			"matricula": "string",
      			"dataHoraInclusaoDataprev": "ddMMyyyyHHmmss",
      			"idEventoExclusao": 0,
      			"dataHoraEventoExclusao": "ddMMyyyyHHmmss",
      			"idEventoRetificacao": 0,
      			"dataHoraEventoRetificacao": "ddMMyyyyHHmmss",
      			"emprestimo": {
      				"codigoIf": 0,
      				"contrato": "string",
      				"valorParcela": 0
      			},
      			"analise": {
      				"existeTrabalhadorEscriturado": true,
      				"existeNumeroContratoEscriturado": true,
      				"vinculoCorreto": true,
      				"instituicaoFinanceiraCorreta": true,
      				"valorParcelaCorreta": true,
      				"dadosCorrespondentes": true
      			}
      		}
      	]
      },
      "Erros": []
      }
    ```
  </Accordion>
</AccordionGroup>

***

### Considerações Técnicas — Escrituração

* Os dados retornados refletem **informações escrituradas no eSocial**;
* Registros podem sofrer **exclusões ou retificações**, identificadas pelos campos de evento;
* A análise apresentada indica consistência entre vínculo, contrato e valores informados;
* Os dados são disponibilizados com **defasagem D-1**.

***

## 2. Consulta de Repasse

***

**Tipo:** Síncrona Este endpoint permite à instituição financeira **consultar os repasses realizados**, normalmente efetuados pela **Caixa**, dentro de um intervalo de tempo. A consulta retorna informações paginadas contendo, entre outros dados, **guias pagas**, valor da parcela, datas de pagamento e repasse, e identificação do contrato.

***

### Endpoint

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

***

### Parâmetros da Requisição (Query Params)

| Campo            | Obrigatório | Descrição                                                    |
| ---------------- | ----------- | ------------------------------------------------------------ |
| `dataHoraInicio` | Sim         | Data e hora inicial da consulta no formato `ddMMyyyyHHmmss`. |
| `dataHoraFim`    | Sim         | Data e hora final da consulta no formato `ddMMyyyyHHmmss`.   |
| `nropagina`      | Sim         | Número da página a ser consultada.                           |

***

<AccordionGroup>
  <Accordion title="Exemplo de requisição">
    ```bash theme={null}
    	curl --location --request GET \ 'https://econsignadotrabalhador.moneyp.dev.br/contrato/consultar-repasses?dataHoraInicio=01082025000000&dataHoraFim=14082025000000&nropagina=1' \ --header 'Authorization: Bearer <token>'

    ```
  </Accordion>

  <Accordion title="Exemplo de retorno">
    ```json theme={null}
      {
      "CodigoRequisicao": "7b307672-a414-4b8b-9bb6-e38482581765",
      "Origem": "/consultar-repasses",
      "Conteudo": {
      	"NroPaginaAtual": 1,
      	"NroTotalPaginas": 1,
      	"NroTotalRegistros": 10,
      	"QtdRegistrosPorPagina": 250,
      	"QtdRegistrosPaginaAtual": 10,
      	"DataHoraInicio": "01082025000000",
      	"DataHoraFim": "14082025000000",
      	"Conteudo": [
      		{
      			"Id": 4146,
      			"CodigoIF": 531,
      			"Contrato": "5094853",
      			"ValorParcelaPaga": 600,
      			"DataHoraPagamentoGuia": "11082025000000",
      			"DataHoraInclusaoDataprev": "13082025110600",
      			"DataHoraRepasseIF": "12082025000000",
      			"NumeroGuia": 1755093960
      		}
      	]
      },
      "Erros": []
    }
    ```
  </Accordion>
</AccordionGroup>

***

### Considerações Técnicas — Repasse

* Os registros retornados correspondem a **parcelas efetivamente pagas**;
* A data de pagamento da guia pode diferir da data de repasse à instituição financeira;
* Os dados também seguem o critério de **atualização D-1**;
* Recomenda-se utilizar este endpoint para **conciliação financeira**.