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

GET

/private_payroll_conciliation/registers

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

info

A paginação é baseada em um, portanto a primeira página é a página 1.

Response

STATUS

200 OK

{
    "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",
            "external_reference_month": "2024-06",
            "document_number": "29883927061",
            "employer_document_number": "12345678",
            "registration_number": "11841",
            "registered_at": "2025-08-06T03:49:52Z",
            "register_type":"regular_pay"
        }
    ],
    "pagination": {
        "current_page": 1,
        "next_page": 2,
        "rows_per_page": 100,
    }
}

Atributos da escrituração

Os atributos 'contract_number', 'employer_document_number' e 'registration_number' não coincidem necessariamente com os dados da operação de crédito, pois são referentes aos dados digitados pelo RH do empregador, para associar a escrituração com a operação de crédito deve ser utilizada a chave "credit_operation_key".

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	Descrição
register_key	string	Identificacor da escrituração
contract_number	string	Número do contrato escriturado pelo empregador
amount	decimal	Valor total da escrituração
reference_month	string	Mês de vencimento no qual a escrituração se refere
external_reference_month	string	Mês de competência informada pela DATAPREV
registered_at	string	Data de escrituração
document_number	string	CPF do cliente
employer_document_number	string	CNPJ ou CPF do empregador
registration_number	string	Matrícula do funcionário
credit_operation_key	string	Identificador da Operação de crédito
register_type	string	Tipo de escrituração, consulte os possíveis enumeradores na tabela Tipos de escrituração
credit_operation_key	string	Identificador 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

Tipos de escrituração

ENUMERADOR

register_type

Enumerador	Descrição
regular_pay	Desconto ordinário
severance_pay	Desconto de verba rescisória