Consulta de escriturações

A escrituração é o registro, feito pelo empregador no eSocial, do desconto da parcela do consignado na folha de pagamento do trabalhador. Este endpoint lista, de forma paginada, as escriturações que a QI Tech coletou na DATAPREV e associou aos contratos da sua integração.

Endpoint

ENDPOINT

/private_payroll_conciliation/registers

MÉTODO

GET

STATUS

200

Testar no Playground

Autenticação

Requer assinatura da requisição. Veja Troca de chaves.

Parâmetros de consulta

Campo	Tipo	Obrigatório	Descrição	Tamanho
start_date	string	Sim	Data inicial do período, no formato AAAA-MM-DD.	10
end_date	string	Sim	Data final do período, no formato AAAA-MM-DD. Não inclui o próprio dia: veja a nota após a tabela.	10
external_key	string	Não	Chave da operação de crédito (credit_operation_key). Retorna só as escriturações desse contrato.	36
reservation_key	string	Não	Chave da averbação do contrato. Retorna só as escriturações dessa averbação.	36
page_number	integer	Não	Página desejada. A primeira página é a 1. Padrão 1.	—
page_rows	integer	Não	Escriturações por página. Padrão 100.	—

O período filtra pela data em que a QI Tech coletou a escrituração na DATAPREV, e não por registered_at. A escrituração coletada no dia de start_date entra no resultado; a coletada no dia de end_date, não. Para incluir um dia como o último do período, informe o dia seguinte em end_date: para consultar agosto de 2025, use start_date=2025-08-01 e end_date=2025-09-01.

A consulta retorna só as escriturações que a QI Tech já associou a um contrato da sua integração. Uma escrituração coletada e ainda não associada a um contrato não aparece no resultado.

Resposta

A resposta tem a lista de escriturações da página (data) e os dados de paginação (pagination). As escriturações vêm em ordem crescente de inclusão na QI Tech.

{
    "data": [
        {
            "register_key": "3f0b6d1e-2a4c-4f8e-9b7d-5c1a2e3f4b6d",
            "registered_at": "2025-08-06T03:49:52Z",
            "contract_number": "1234567890",
            "amount": 2405.76,
            "reference_month": "2025-07",
            "external_reference_month": "2025-07",
            "document_number": "96969879003",
            "employer_document_type": "cnpj",
            "employer_document_number": "12345678",
            "registration_number": "11841",
            "credit_operation_key": "9c2e7a4b-1d3f-4e5a-8b6c-7d8e9f0a1b2c",
            "external_key": "9c2e7a4b-1d3f-4e5a-8b6c-7d8e9f0a1b2c",
            "register_type": "regular_pay"
        }
    ],
    "pagination": {
        "current_page": 1,
        "next_page": null,
        "rows_per_page": 100
    }
}

Campos de data

Campo	Tipo	Obrigatório	Descrição	Tamanho
register_key	string	Sim	Chave da escrituração na QI Tech.	36
registered_at	string	Sim	Data e hora do evento de escrituração no eSocial, no formato AAAA-MM-DDTHH:MM:SSZ.	20
contract_number	string	Sim	Número do contrato informado pelo empregador na escrituração.	—
amount	number	Sim	Valor da parcela escriturada para desconto, em reais.	—
reference_month	string	Sim	Competência da folha de pagamento a que a escrituração se refere, no formato AAAA-MM.	7
external_reference_month	string	Sim	Mesmo valor de reference_month.	7
document_number	string	Sim	CPF do trabalhador.	11
employer_document_type	string	Não	Tipo de inscrição do empregador. Veja Tipos de documento do empregador.	—
employer_document_number	string	Sim	Número de inscrição do empregador: raiz do CNPJ (8 dígitos) ou CPF (11 dígitos).	11
registration_number	string	Sim	Matrícula do trabalhador no empregador.	—
credit_operation_key	string	Sim	Chave da operação de crédito associada à escrituração.	36
external_key	string	Sim	Mesmo valor de credit_operation_key.	36
register_type	string	Sim	Tipo de escrituração. Veja Tipos de escrituração.	—

Dados informados pelo empregador

contract_number, employer_document_number e registration_number são os dados que o empregador informou na escrituração e podem não coincidir com os da operação de crédito. Para relacionar a escrituração ao contrato, use credit_operation_key.

Campos de pagination

Campo	Tipo	Obrigatório	Descrição	Tamanho
current_page	integer	Sim	Página retornada.	—
next_page	integer	Não	Próxima página. Vem null quando a página retornada tem menos itens que rows_per_page.	—
rows_per_page	integer	Sim	Escriturações por página, conforme page_rows.	—

Fim da paginação

Percorra as páginas até next_page vir null. Se a última página vier completa, next_page aponta para uma página vazia, e a consulta dessa página retorna 404 com o código PPC010003: trate esse retorno também como fim da paginação.

Tipos de escrituração

Valor	Descrição
regular_pay	Desconto escriturado em evento de remuneração periódico (folha mensal).
severance_pay	Desconto escriturado em evento não periódico de desligamento ou término de vínculo (rescisão).

Tipos de documento do empregador

Valor	Descrição
cnpj	Empregador pessoa jurídica
cpf	Empregador pessoa física

Erros

Status	Código	Descrição
400	QIT000400	Parâmetros de consulta inválidos: parâmetro obrigatório ausente, data fora do formato AAAA-MM-DD, chave que não é UUID ou paginação não numérica.
404	PPC010003	Nenhuma escrituração encontrada para os filtros e a página informados.

{
    "code": "PPC010003",
    "title": "Register not found",
    "description": "Register not found",
    "translation": "Registro nao encontrado"
}

Próximo passo

• Consulta de pagamentos: os pagamentos de guia que a DATAPREV informou para as escriturações.