ResponseWrapperCreditClientDto

Wrapper to credit client dto

statusstring

Status of the response

Possible values: [SUCCESS, ERROR]

Example: ERROR/SUCCESS

messagestring

Message describing the response

Example: Request failed/Request successful

codeMessagestring

Code message describing the response

Example: ERR-001/SUC-001

data object

DTO representing detailed information of a credit client.

remainingCapitalFormattedstring

Remaining capital to be paid, formatted

Example: 10,000.50

borrowedCapitalFormattedstring

Borrowed capital, formatted

Example: 15,000.00

overallCreditRateFormattedstring

Overall credit rate, formatted

Example: 4.5%

installmentWithInsuranceFormattedstring

Installment with insurance, formatted

Example: 200.0

disbursementDateFormattedstring

Disbursement date, formatted

Example: 2023-12-01

firstInstallmentDateFormattedstring

First installment date, formatted

Example: 2024-01-01

lastInstallmentDateFormattedstring

Last installment date, formatted

Example: 2029-12-01

fileNumberstring

Credit file number

Example: CREDIT12345

orderstring

File order

Example: 1

agencyCodestring

Agency code

Example: AG123

identifierstring

Client's unique identifier

Example: CLIENT12345

titlestring

File title

Example: Home Loan

statusstring

File status

Example: IN_PROGRESS

borrowedCapitalnumber

Borrowed capital

Example: 15000

remainingCapitalnumber

Remaining capital

Example: 10000.5

totalCreditCostnumber

Total cost of the credit

Example: 25000

installmentWithoutInsurancenumber

Installment without insurance

Example: 180

numberOfInstallmentsint32

Number of installments

Example: 60

numberOfPaidInstallmentsint32

Number of paid installments

Example: 10

numberOfUpcomingInstallmentsint32

Number of upcoming installments

Example: 50

overallCreditRatenumber

Overall credit rate

Example: 4.5

installmentWithInsurancenumber

Installment with insurance

Example: 200

newDebtRationumber

New debt ratio

Example: 0.35

creditFileFeenumber

Credit file fee

Example: 100

flatInsurancePremiumnumber

Flat insurance premium

Example: 50

projectCostnumber

Project cost

Example: 50000

personalContributionnumber

Personal contribution

Example: 10000

spouseContributionnumber

Spouse's contribution

Example: 5000

selfFinancingRatenumber

Self-financing rate of the project

Example: 0.2

loanAmountnumber

Loan amount

Example: 20000

deferredAmountnumber

Deferred amount

Example: 5000

remainingInterestnumber

Remaining interest

Example: 1500

loanTypestring

Type of loan

Example: Mortgage

installmentTypestring

Type of installment

Example: Monthly

loanDurationint32

Loan duration in months

Example: 60

deferredDurationint32

Deferred duration in months

Example: 12

insuranceTypestring

Type of insurance

Example: Life Insurance

insuranceRatenumber

Insurance rate

Example: 0.02

notaryRatenumber

Notary rate

Example: 0.01

notaryAndFeeCostnumber

Notary and fees cost

Example: 500

disbursementDatedate-time

Disbursement date

firstInstallmentDatedate-time

First installment date

lastInstallmentDatedate-time

Last installment date

accountNumberstring

Account number

Example: 1234567890

subscriberIdstring

Subscriber's ID

Example: SUBSCRIBER12345

interestPeriodicitystring

Interest periodicity

Example: Annual

principalPeriodicitystring

Principal periodicity

Example: Monthly

statusDatestring

Status date

Example: 2024-01-01

outstandingAmountstring

Outstanding amount

Example: 5000.0

penaltyAmountstring

Penalty amount

Example: 200.0

advanceAmountstring

Advance amount

Example: 1000.0

chargesAndCommissionsAmountstring

Charges and commissions amount

Example: 150.0

outstandingAmountNotFormattednumber

Outstanding amount not formatted

Example: 5000

penaltyAmountNotFormattednumber

Penalty amount not formatted

Example: 200

advanceAmountNotFormattednumber

Advance amount not formatted

Example: 1000

chargesAndCommissionsAmountNotFormattednumber

Charges and commissions amount not formatted

Example: 150

nextInstallmentDatestring

Next installment date

Example: 2024-02-01

unpaidAmountstring

Unpaid amount

Example: 300.0

lastDisbursementDatestring

Last disbursement date

Example: 2023-11-01

penaltyRatestring

Penalty rate

Example: 0.05

fixedRatestring

Fixed rate

Example: 0.03

amortizationModestring

Amortization mode

Example: Linear

currencystring

Currency

Example: EUR

nextInstallmentAmountnumber

Next installment amount

Example: 250

creditClientIdint64

Credit client ID

Example: 123456

installmentDatestring

Installment date

Example: 2024-01-01

outstandingLoanAmountstring

Outstanding loan amount

Example: 20000.0

disbursedLoanstring

Disbursed loan amount

Example: 15000.0

startDatestring

Start date

Example: 2023-12-01

installmentPeriodsstring

Installment periods

Example: 12

installmentArrearsstring

Installment arrears

Example: 5

numberOfUnpaidInstallmentsint32

Number of unpaid installments

Example: 3

remainingCapitalDuenumber

Remaining capital due

Example: 8000

disbursedCapitalnumber

Disbursed capital

Example: 12000

amendmentnumber

Amendment

Example: 500

remainingInstallmentsint32

Remaining installments

Example: 48

nextInstallmentAmountFormattedstring

Next installment amount formatted

Example: 200.0

deferredAmountFormattedstring

Deferred amount formatted

Example: 1000.0

monthlyInstallmentnumber

Monthly Installment

Example: 1000

monthlyInstallmentFormattedstring

Monthly installment formatted

Example: 200.0

disbursedCapitalFormattedstring

Disbursed capital formatted

Example: 12000.0

remainingInterestFormattedstring

Remaining interest formatted

Example: 1500.0

processingCodestring

Processing code

Example: PC123

statestring

State

Example: Active

error object

Detailed information about the error response

codestring

Error code

Example: ERR-142

messagestring

Error message

Example: Resource not found / Internal server error

details object[]

List of error details

Array [

codestring

Error code

Example: ER4001

messagestring

Detailed error message

Example: Invalid input

targetstring

Target of the error

Example: username

]

suggestionsstring[]

List of suggestions for resolving the error

Example: ["Check the resource ID","Ensure the resource exists"]

metaData object

Additional metadata about the error, that could help in debugging

property name*string

Additional metadata about the error, that could help in debugging

Example: {"requestId":"3c5e4cebf39cbc5b","operationId":"66fd4d2ae6b6"}

timestampdate-time

Timestamp of when the response was generated

ResponseWrapperCreditClientDto

{
  "status": "ERROR/SUCCESS",
  "message": "Request failed/Request successful",
  "codeMessage": "ERR-001/SUC-001",
  "data": {
    "remainingCapitalFormatted": "10,000.50",
    "borrowedCapitalFormatted": "15,000.00",
    "overallCreditRateFormatted": "4.5%",
    "installmentWithInsuranceFormatted": "200.0",
    "disbursementDateFormatted": "2023-12-01",
    "firstInstallmentDateFormatted": "2024-01-01",
    "lastInstallmentDateFormatted": "2029-12-01",
    "fileNumber": "CREDIT12345",
    "order": "1",
    "agencyCode": "AG123",
    "identifier": "CLIENT12345",
    "title": "Home Loan",
    "status": "IN_PROGRESS",
    "borrowedCapital": 15000,
    "remainingCapital": 10000.5,
    "totalCreditCost": 25000,
    "installmentWithoutInsurance": 180,
    "numberOfInstallments": 60,
    "numberOfPaidInstallments": 10,
    "numberOfUpcomingInstallments": 50,
    "overallCreditRate": 4.5,
    "installmentWithInsurance": 200,
    "newDebtRatio": 0.35,
    "creditFileFee": 100,
    "flatInsurancePremium": 50,
    "projectCost": 50000,
    "personalContribution": 10000,
    "spouseContribution": 5000,
    "selfFinancingRate": 0.2,
    "loanAmount": 20000,
    "deferredAmount": 5000,
    "remainingInterest": 1500,
    "loanType": "Mortgage",
    "installmentType": "Monthly",
    "loanDuration": 60,
    "deferredDuration": 12,
    "insuranceType": "Life Insurance",
    "insuranceRate": 0.02,
    "notaryRate": 0.01,
    "notaryAndFeeCost": 500,
    "disbursementDate": "2024-07-29T15:51:28.071Z",
    "firstInstallmentDate": "2024-07-29T15:51:28.071Z",
    "lastInstallmentDate": "2024-07-29T15:51:28.071Z",
    "accountNumber": "1234567890",
    "subscriberId": "SUBSCRIBER12345",
    "interestPeriodicity": "Annual",
    "principalPeriodicity": "Monthly",
    "statusDate": "2024-01-01",
    "outstandingAmount": "5000.0",
    "penaltyAmount": "200.0",
    "advanceAmount": "1000.0",
    "chargesAndCommissionsAmount": "150.0",
    "outstandingAmountNotFormatted": 5000,
    "penaltyAmountNotFormatted": 200,
    "advanceAmountNotFormatted": 1000,
    "chargesAndCommissionsAmountNotFormatted": 150,
    "nextInstallmentDate": "2024-02-01",
    "unpaidAmount": "300.0",
    "lastDisbursementDate": "2023-11-01",
    "penaltyRate": "0.05",
    "fixedRate": "0.03",
    "amortizationMode": "Linear",
    "currency": "EUR",
    "nextInstallmentAmount": 250,
    "creditClientId": 123456,
    "installmentDate": "2024-01-01",
    "outstandingLoanAmount": "20000.0",
    "disbursedLoan": "15000.0",
    "startDate": "2023-12-01",
    "installmentPeriods": "12",
    "installmentArrears": "5",
    "numberOfUnpaidInstallments": 3,
    "remainingCapitalDue": 8000,
    "disbursedCapital": 12000,
    "amendment": 500,
    "remainingInstallments": 48,
    "nextInstallmentAmountFormatted": "200.0",
    "deferredAmountFormatted": "1000.0",
    "monthlyInstallment": 1000,
    "monthlyInstallmentFormatted": "200.0",
    "disbursedCapitalFormatted": "12000.0",
    "remainingInterestFormatted": "1500.0",
    "processingCode": "PC123",
    "state": "Active"
  },
  "error": {
    "code": "ERR-142",
    "message": "Resource not found / Internal server error",
    "details": [
      {
        "code": "ER4001",
        "message": "Invalid input",
        "target": "username"
      }
    ],
    "suggestions": [
      "Check the resource ID",
      "Ensure the resource exists"
    ],
    "metaData": {
      "requestId": "3c5e4cebf39cbc5b",
      "operationId": "66fd4d2ae6b6"
    }
  },
  "timestamp": "2024-07-29T15:51:28.071Z"
}