Lançamentos Contábeis por Contrato

Retorna os lançamentos contábeis Dataprev de um contrato específico do originador autenticado. Inclui movimentações de débito e crédito registradas pelo Dataprev.

Parâmetros

Parâmetro	Local	Tipo	Descrição
contractId	path	integer	ID do contrato

O contrato deve pertencer ao originador autenticado. Contratos de outros originadores retornam 404.

Listar lançamentos contábeis por contrato

get

https://consignado.staging.giro.techhttps://consignado.giro.tech

/api/v1/originator/contracts/{contractId}/dataprev/bookkeeping-entries

Retorna os lançamentos contábeis Dataprev do contrato informado (do originador autenticado).

Autorizações

BearerAuth

AuthorizationstringObrigatório

JWT token fornecido pelo administrador

Parâmetros de rota

contractIdinteger · int64Obrigatório

ID do contrato

Respostas

200

Lista de lançamentos retornada com sucesso

application/json

idinteger · int64OpcionalExample: 201

dataprevIdinteger · int64OpcionalExample: 456789

contractNumberstringOpcional

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

Example: 345678

referencePeriodintegerOpcionalExample: 202404

deductionAmountnumber · decimalOpcional

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

Example: 593.78

includedAtDataprevstring · date-timeOpcional

eSocialEventIdinteger · int64Opcional

dataMatchbooleanOpcional

eventTypeCodeintegerOpcional

institutionCodeintegerOpcional

cpfstringOpcional

registrationNumberstringOpcional

employerRegistrationTypeCodeintegerOpcional

employerRegistrationNumberinteger · int64Opcional

loanInstitutionCodeintegerOpcional

loanInstallmentValuenumber · decimalOpcional

analysisContractBookedbooleanOpcional

analysisWorkerBookedbooleanOpcional

analysisInstitutionCorrectbooleanOpcional

analysisInstallmentValueCorrectbooleanOpcional

analysisLinkCorrectbooleanOpcional

exclusionEventDatetimestringOpcional

correctionEventDatetimestringOpcional

exclusionEventIdinteger · int64Opcional

correctionEventIdinteger · int64Opcional

401

Não autenticado

403

Permissão insuficiente

404

Contrato não encontrado ou não pertence ao originador

get

/api/v1/originator/contracts/{contractId}/dataprev/bookkeeping-entries

HTTPcURLJavaScriptPython

GET /api/v1/originator/contracts/{contractId}/dataprev/bookkeeping-entries HTTP/1.1
Host: consignado.staging.giro.tech
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "id": 201,
    "dataprevId": 456789,
    "contractNumber": 345678,
    "referencePeriod": 202404,
    "deductionAmount": 593.78,
    "includedAtDataprev": "2024-04-30T12:00:00Z"
  }
]

Central de Atendimento | Giro.TechGiro.Tech