Pular para o conteúdo
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Lançamentos Contábeis Global

Lista, com paginação, os lançamentos contábeis Dataprev do originador: os descontos em folha declarados pelo empregador. Filtro opcional por período de inclusão.

Request

GET /api/v1/originator/dataprev/bookkeeping-entries

Requer autenticação: Authorization: Bearer {originatorToken}.

Parâmetros

Parâmetro
Local
Tipo
Obrigatório
Descrição

includedFrom

query

string (date-time)

Não

Data/hora mínima de inclusão na Dataprev (ISO-8601)

includedTo

query

string (date-time)

Não

Data/hora máxima de inclusão na Dataprev (ISO-8601)

page

query

integer

Não

Número da página, começando em 0. Padrão 0

size

query

integer

Não

Tamanho da página. Padrão 20

Response

Página (content + metadados de paginação).

Item (content[])

Campo
Tipo
Descrição

publicId

string (uuid)

Identificador público do lançamento na plataforma

dataprevId

integer

Identificador do lançamento na Dataprev

contractNumber

string

Número do contrato (8 dígitos com zero à esquerda)

referencePeriod

integer

Período de referência (AAAAMM)

deductionAmount

number

Valor da dedução em reais (decimal com 2 casas)

eventDeductionAmount

number

Soma de deductionAmount dos lançamentos com o mesmo eSocialEventId, contrato e competência — o desconto efetivo da folha no evento. Igual a deductionAmount quando o evento tem um lançamento só

eventEntryCount

integer

Quantidade de lançamentos que compõem o evento (1 quando o desconto não foi dividido)

eventEntries

array

Os lançamentos que compõem o evento, inclusive este, ordenados por dataprevId. Cada item: publicId, dataprevId e deductionAmount da rubrica

includedAtDataprev

string (date-time)

Data/hora de inclusão na Dataprev

eSocialEventId

string

Identificador do evento eSocial (string numérica; pode exceder 64 bits)

dataMatch

boolean

Indica se os dados conferem

eventTypeCode

integer

Código do tipo de evento

institutionCode

integer

Código da instituição

cpf

string

CPF do trabalhador

registrationNumber

string

Matrícula do trabalhador

employerTaxIdType

string

Tipo do documento em employerRegistrationNumber: CNPJ ou CPF (null quando a Dataprev não informa)

employerRegistrationNumber

string

Número de inscrição do empregador (preserva zeros à esquerda; radical do CNPJ com 8 dígitos ou CPF)

loanInstitutionCode

integer

Código da instituição do empréstimo

loanInstallmentValue

number

Valor da parcela do empréstimo

analysisContractBooked

boolean

Análise: contrato escriturado

analysisWorkerBooked

boolean

Análise: trabalhador escriturado

analysisInstitutionCorrect

boolean

Análise: instituição correta

analysisInstallmentValueCorrect

boolean

Análise: valor da parcela correto

analysisLinkCorrect

boolean

Análise: vínculo correto

exclusionEventDatetime

string

Data/hora do evento de exclusão

correctionEventDatetime

string

Data/hora do evento de correção

exclusionEventId

string

Identificador do evento de exclusão (string numérica; pode exceder 64 bits)

correctionEventId

string

Identificador do evento de correção (string numérica; pode exceder 64 bits)

  • 200 OK — página retornada (content vazio quando nada corresponde ao filtro).

Desconto dividido em mais de um lançamento

O empregador pode dividir o desconto de uma parcela em mais de uma rubrica do mesmo evento de remuneração (S-1200). Cada rubrica vira um lançamento, com o mesmo eSocialEventId.

  • A Dataprev compara cada lançamento com a parcela inteira: analysisInstallmentValueCorrect vem false em todas as partes, mesmo quando a soma bate. Para saber se a parcela foi descontada inteira, compare eventDeductionAmount com loanInstallmentValue.

  • Todo lançamento do evento traz a lista completa em eventEntries, mesmo que as partes caiam em páginas diferentes.

dataprevId

deductionAmount

loanInstallmentValue

analysisInstallmentValueCorrect

eventDeductionAmount

eventEntryCount

456790

158.35

179.27

false

179.27

2

456791

20.92

179.27

false

179.27

2

Nos dois lançamentos, eventEntries é:

Neste exemplo a parcela de R$ 179,27 foi descontada inteira, em duas rubricas: R$ 158,35 + R$ 20,92.

Estes são lançamentos da folha (o que o empregador declarou ter descontado), não repasses. O dinheiro que efetivamente chegou aparece nas transferências de pagamento.

Exemplo

Resposta 200:

Erros

Código
Situação

401

Token ausente, expirado ou inválido

403

Token válido sem permissão para este recurso

Formato dos erros: Erros da API.

Listar lançamentos contábeis (paginado)

get
/api/v1/originator/dataprev/bookkeeping-entries

Retorna os lançamentos contábeis Dataprev do originador autenticado, com paginação e filtros opcionais por data de inclusão e por vigência (status).

A listagem devolve o histórico completo: um lançamento por evento do eSocial. Para obter só o que vale hoje, use status=ACTIVE.

O filtro por inclusão é um intervalo fechado: includedFrom e includedTo precisam vir juntos. Informar só uma das pontas responde 400 (errorCode: INCOMPLETE_DATE_RANGE) — antes, a ponta isolada era ignorada em silêncio e a listagem inteira voltava com 200.

Sem sort, a ordem é id crescente. Com sort, o id é acrescentado como desempate, então a paginação não repete nem pula linhas quando várias têm o mesmo valor no campo ordenado.

Autorizações
AuthorizationstringObrigatório

JWT token fornecido pelo administrador

Parâmetros de consulta
includedFromstring · date-timeOpcional

Data/hora mínima de inclusão na Dataprev (ISO-8601). Exige includedTo.

includedTostring · date-timeOpcional

Data/hora máxima de inclusão na Dataprev (ISO-8601). Exige includedFrom.

ingestedFromstring · date-timeOpcional

Data/hora mínima (inclusive, ISO-8601) em que a plataforma gravou a linha (ingestedAt) — o cursor da sincronização incremental. Guarde o maior ingestedAt recebido e passe-o na chamada seguinte; como a comparação é >=, a última linha volta de novo, então deduplique por publicId.

Diferente de includedFrom/includedTo, que filtram pela data da Dataprev e perdem linhas que ela publica com carimbo antigo, ingestedFrom acompanha a ordem em que a plataforma recebeu os dados. Vale para linhas gravadas depois de o carimbo existir (ingestedAt: null não aparece aqui); para o histórico anterior use o intervalo de inclusão. A plataforma recebe os dados em ciclos (hoje 06h e 18h, horário de Brasília): uma linha só aparece depois do ciclo que a traz. Não exige includedTo.

statusstring · enumOpcional

Filtra por vigência do lançamento. Sem o parâmetro, a listagem traz o histórico completo. ACTIVE devolve apenas os lançamentos que não foram excluídos nem retificados.

Valores possíveis:
pageintegerOpcional

Número da página (0-based)

Default: 0
sizeintegerOpcional

Tamanho da página

Default: 20
Respostas
200

Página de lançamentos retornada com sucesso

application/json
totalElementsinteger · int64Opcional
totalPagesintegerOpcional
sizeintegerOpcional
numberintegerOpcional
numberOfElementsintegerOpcional
firstbooleanOpcional
lastbooleanOpcional
emptybooleanOpcional
get/api/v1/originator/dataprev/bookkeeping-entries
GET /api/v1/originator/dataprev/bookkeeping-entries HTTP/1.1
Host: ingress.gtpayroll.staging.giro.tech
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "content": [
    {
      "id": 201,
      "dataprevId": 456789,
      "contractNumber": "00345678",
      "referencePeriod": 202404,
      "deductionAmount": 593.78
    }
  ],
  "totalElements": 1,
  "totalPages": 1,
  "size": 20,
  "number": 0,
  "numberOfElements": 1,
  "first": true,
  "last": true,
  "empty": false
}

Atualizado