Manual Consignado Privado - Consulta de Escriturações
A escrituração é o processo obrigatório que o setor de Recursos Humanos (RH) ou Departamento Pessoal (DP) da empresa realiza para registrar no sistema governamental (via eSocial) o desconto da parcela de um empréstimo consignado ativo do colaborador em sua folha de pagamento, em essência, a escrituração é a formalização contábil e fiscal do desconto. Após o pagamento do valor formalizado, o valor é direcionado para a Caixa Econômica Federal, que encaminha para a instituição financeira credora.
A escrituração do desconto referente à folha de pagamento da competência deve ser realizada até o dia 15 de cada mês.
1 - Consulta de escriturações conciliadas
Query Parameters
| Parâmetro | Tipo | Obrigatório | Descrição | Valor Padrão |
|---|---|---|---|---|
| start_date | date | Sim | Data mínima da escrituração (YYYY-mm-dd) | |
| end_date | date | Sim | Data máxima da escrituração (YYYY-mm-dd) | |
| page_number | integer | Não | Número da página a ser retornada | 1 |
| page_rows | integer | Não | Quantidade de registros por página | 100 |
A paginação é baseada em um, portanto a primeira página é a página 1.
Response
{
"data": [
{
"register_key": "123e4567-e89b-12d3-a456-426614174000",
"contract_number": "1234567890",
"credit_operation_key": "123e4567-e89b-12d3-a456-426614174000",
"amount": 2405.76,
"reference_month": "2024-07",
"document_number": "29883927061",
"employer_document_number": "123456788990",
"registration_number": "11841",
"registred_at": "2025-08-06T03:49:52Z",
"payment_key": "123e4567-e89b-12d3-a456-426614174000"
}
],
"pagination": {
"current_page": 1,
"next_page": 2,
"rows_per_page": 100,
"total_pages": 1,
"total_rows": 1
}
}
Response Body
A resposta paginada é composta por um array de escriturações (data) e um objeto de paginação (pagination).
Lista de atributos
Descrição dos itens do array data:
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| register_key | string | Sim | Identificacor da escrituração |
| contract_number | string | Sim | Número do contrato |
| amount | decimal | Sim | Valor total da escrituração |
| reference_month | string | Sim | Mês no qual a escrituração se refere |
| document_number | string | Sim | CPF do cliente |
| employer_document_number | string | Sim | CNPJ ou CPF do empregador |
| registration_number | string | Sim | Matrícula do funcionário |
| credit_operation_key | string | Não | Identificador da Operação de crédito |
Os atributos 'contract_number', 'employer_document_number' e 'registration_number' não coincidem necessariamente com os dados da operação de crédito.
Dados de paginação
Dados contidos no objeto pagination:
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| current_page | integer | Sim | Página atual |
| next_page | integer | Sim | Próxima página |
| rows_per_page | integer | Sim | Quantidade de registros por página |
| total_pages | integer | Sim | Total de páginas |
| total_rows | integer | Sim | Total de registros |