Consulta de pagamentos
Lista, de forma paginada, os pagamentos de desconto em folha que a QI Tech coletou na DATAPREV e associou aos contratos da sua integração. Cada pagamento corresponde ao recolhimento, pelo empregador, de uma ou mais escriturações.
Endpoint
/private_payroll_conciliation/paymentsAutenticaçã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ó os pagamentos desse contrato. | 36 |
reservation_key | string | Não | Chave da averbação do contrato. Retorna só os pagamentos 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 | Pagamentos por página. Padrão 100. | — |
O período filtra pela data em que a QI Tech coletou o pagamento na DATAPREV. Ele não considera a data de pagamento da guia (paid_at) nem a data do repasse (transferred_at). O pagamento coletado no dia de start_date entra no resultado; o coletado 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ó os pagamentos que a QI Tech já conciliou com as escriturações e associou a um contrato da sua integração. Um pagamento coletado e ainda não conciliado não aparece no resultado.
Resposta
A resposta tem a lista de pagamentos da página (data) e os dados de paginação (pagination). Os pagamentos vêm em ordem crescente de inclusão na QI Tech.
{
"data": [
{
"payment_key": "8f14e45f-ceea-467a-9575-0e2b4a1d1c2b",
"external_id": "000123456789",
"contract_number": "1234567890",
"amount": 2405.76,
"reference_month": "2025-07",
"payment_type": "regular_pay",
"transfer_code": "145645096",
"document_number": "96969879003",
"employer_document_type": "cnpj",
"employer_document_number": "12345678",
"registration_number": "11841",
"monetary_adjustment_amount": 12.30,
"late_payment_interest_amount": 8.15,
"late_payment_fine_amount": 48.12,
"paid_at": "2025-08-07T10:15:00",
"transferred_at": "2025-08-10T09:00:00"
}
],
"pagination": {
"current_page": 1,
"next_page": null,
"rows_per_page": 100
}
}
Campos de data
| Campo | Tipo | Obrigatório | Descrição | Tamanho |
|---|---|---|---|---|
payment_key | string | Sim | Chave do pagamento na QI Tech. | 36 |
external_id | string | Sim | Identificador do pagamento na DATAPREV. | — |
contract_number | string | Sim | Número do contrato informado no pagamento. | — |
amount | number | Sim | Valor da parcela paga, em reais. Não inclui atualização monetária, juros de mora e multa, que vêm nos três campos abaixo. | — |
reference_month | string | Sim | Competência da folha de pagamento a que o pagamento se refere, no formato AAAA-MM. | 7 |
payment_type | string | Não | Tipo de pagamento. Veja Tipos de pagamento. | — |
transfer_code | string | Não | Código da transferência (TRF) do repasse da Caixa Econômica Federal à instituição financeira. Um repasse pode agrupar vários pagamentos. | — |
document_number | string | Não | 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 | Não | Número de inscrição do empregador: raiz do CNPJ (8 dígitos) ou CPF (11 dígitos). | 11 |
registration_number | string | Não | Matrícula do trabalhador no empregador. | — |
monetary_adjustment_amount | number | Não | Valor de atualização monetária, em reais. | — |
late_payment_interest_amount | number | Não | Valor de juros de mora, em reais. | — |
late_payment_fine_amount | number | Não | Valor de multa, em reais. | — |
paid_at | string | Sim | Data e hora do pagamento da guia pelo empregador, no formato AAAA-MM-DDTHH:MM:SS. | 19 |
transferred_at | string | Sim | Data e hora do repasse do valor à instituição financeira, no formato AAAA-MM-DDTHH:MM:SS. | 19 |
Campo com Obrigatório igual a Não pode vir null.
contract_number, employer_document_number e registration_number são os dados informados pelo empregador e podem não coincidir com os da operação de crédito. Para consultar os pagamentos de um contrato, filtre por external_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 | Pagamentos por página, conforme page_rows. | — |
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 PPC020002: trate esse retorno também como fim da paginação.
Tipos de pagamento
| Valor | Descrição |
|---|---|
regular_pay | Pagamento de desconto da folha mensal. |
severance_pay | Pagamento de desconto de verbas rescisórias. |
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 | PPC020002 | Nenhum pagamento encontrado para os filtros e a página informados. |
{
"code": "PPC020002",
"title": "Payment not found",
"description": "Payment not found",
"translation": "Pagamento nao encontrado"
}
Próximo passo
- Consulta de escriturações: as escriturações que deram origem aos pagamentos.