Transferências de Pagamento por Contrato

Retorna as transferências de pagamento Dataprev de um contrato específico do originador autenticado. Inclui registros de desembolsos, liquidações e demais movimentações financeiras.

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 transferências de pagamento por contrato

get

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

/api/v1/originator/contracts/{contractId}/dataprev/payment-transfers

Retorna as transferências de pagamento 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 transferências retornada com sucesso

application/json

idinteger · int64OpcionalExample: 89

dataprevIdinteger · int64OpcionalExample: 456789

contractNumberstringOpcional

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

Example: 345678

amountPaidnumber · decimalOpcional

Valor pago em reais (decimal com 2 casas decimais).

Example: 593.78

guidePaymentAtstring · date-timeOpcionalExample: 2024-04-25T00:00:00Z

transferAtstring · date-timeOpcionalExample: 2024-04-28T14:30:00Z

guideNumberinteger · int64OpcionalExample: 123456

trfCodeinteger · int64OpcionalExample: 1

competenceintegerOpcionalExample: 202404

nsuinteger · int64OpcionalExample: 987654

lateInterestAmountnumber · decimalOpcional

Juros de mora em reais (decimal com 2 casas decimais).

Example: 0

penaltyAmountnumber · decimalOpcional

Multa em reais (decimal com 2 casas decimais).

Example: 0

monetaryAdjustmentAmountnumber · decimalOpcional

Ajuste monetário em reais (decimal com 2 casas decimais).

Example: 0

includedAtDataprevstring · date-timeOpcional

institutionCodeintegerOpcional

cpfstringOpcional

registrationNumberstringOpcional

operatorTaxIdinteger · int64Opcional

employerRegistrationTypeCodeintegerOpcional

employerRegistrationNumberinteger · 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/payment-transfers

HTTPcURLJavaScriptPython

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

[
  {
    "id": 89,
    "dataprevId": 456789,
    "contractNumber": 345678,
    "amountPaid": 593.78,
    "guidePaymentAt": "2024-04-25T00:00:00Z",
    "transferAt": "2024-04-28T14:30:00Z",
    "guideNumber": 123456,
    "trfCode": 1,
    "competence": 202404,
    "nsu": 987654,
    "lateInterestAmount": 0,
    "penaltyAmount": 0,
    "monetaryAdjustmentAmount": 0
  }
]

Central de Atendimento | Giro.TechGiro.Tech