Skip to main content

Retrieves fully amortized account info by account code

HEAD 
/Loans/fullyamortized/accounts/:code

Retrieves fully amortized account info by account code

Request​

Path Parameters

    code stringrequired

Query Parameters

    includeCurrentInstallment boolean
    api-version string

Header Parameters

    X-Request-ID stringrequired

Responses​

Schema
    id int32required

    Loan account id.

    code stringrequired

    Loan account number.

    title stringnullablerequired

    Loan account title.

    iban stringnullablerequired

    Loan account IBAN.

    currency stringnullablerequired

    Account currency code.

    isActive booleannullablerequired

    true if account is active, false if it is closed.

    debtors object[]nullable

    Model's list of the debtors of the loan

  • Array [
    • sn int32required

    Sequence number of the debtor for a specific loan.

    customerCode stringnullablerequired

    Customer code of the debtor.

    firstName stringnullablerequired

    First name.

    lastName stringnullablerequired

    Surname.

    fathersName stringnullablerequired

    Father's name.

    fullName stringnullablerequired

    Full customer name in this format "FirstName LastName / FathersName".

    tin stringnullablerequired

    Tax identification number.

    debtorType object nullable

    Debtor type (MainDebtor, CoDebtor or Guarantor).

    oneOf

    string

    Possible values: [MainDebtor, CoDebtor, Guarantor, Heir, BenefitOfInventoryHeir, ThirdPartyParticipant]

  • ]
    • accountType object nullable

    Loan account type (OpenRevolving, Amortized or FullyAmortized)

    oneOf

    string

    Possible values: [OpenRevolving, Amortized, FullyAmortized]

    dateCreated date-timenullablerequired

    Creation date of the loan

    dateClosed date-timenullablerequired

    The date the loan was closed. Null if still active.

    loanStartDate datenullablerequired

    Gets or sets the start date of the loan.

    agreementCode stringnullablerequired

    The customer agreement (contract) code.

    agreementTitle stringnullablerequired

    Agreement title

    productCode stringnullablerequired

    Fully amortized product code.

    productTitle stringnullablerequired

    Product title.

    financialActivityCode stringnullablerequired

    Financial activity code.

    financialActivityTitle stringnullablerequired

    Financial activity title.

    occupationCode stringnullablerequired

    Occupation code.

    occupationTitle stringnullablerequired

    Occupation title.

    accountStatusCode stringnullablerequired

    Fully amortized account status code.

    accountStatusTitle stringnullablerequired

    Account status title.

    delinquencyStateCode stringnullablerequired

    Fully amortized delinquency status code.

    delinquencyStateTitle stringnullablerequired

    Delinquency status title.

    loanAmount decimalrequired

    Total loan disbursement amount.

    loanLimit decimalrequired

    Total limit amount of the loan.

    creditLimitType object nullable

    Credit limit type.

    oneOf

    string

    Possible values: [CorporateAmortizedLoan, CommercialProperty, ConsumerAmortizedLoan, Mortgage, Leasing]

    maxDisbursementNumber int32required

    Max number of disbursements allowed (0 for infinite).

    provisionsAmount decimalrequired

    Provisions amount.

    interestFreeFrom date-timenullablerequired

    The date after which the loan is interest free. Null if the loan is interest bearing.

    fixedInterestRateFrom date-timenullablerequired

    The date after which the loan has fixed interest rate (won't change even if the rate is variable). Null if not set.

    fixedInterestRateUpTo date-timenullablerequired

    The date until which the loan has fixed interest rate (won't change even if the rate is variable). Null if not set.

    rfCode stringnullablerequired

    RF code.

    rfEntity stringnullablerequired

    Dias Organization code.

    autoRfCode booleannullablerequired

    If RF code is auto generated.

    definiteDelayDate date-timenullablerequired

    The date the loan was set to definite delay / denounced. Null otherwise.

    loanEndDate date-timenullablerequired

    Loan end date (due date of last installment).

    currentInstallment object nullable

    The installment that is currently accruing interest.

    oneOf
    installmentId int32required

    Installment unique id.

    installmentNumber int32nullablerequired

    Installment sequence number.

    calendarDueDate date-timerequired

    Original due date (regardless of holidays or user changes).

    dueDate date-timerequired

    Due date of installment.

    paymentDate date-timerequired

    Date the installment can be paid without arrears.

    interestRate decimalrequired

    Interest rate in decimal (divided by 100). E.g. 5% rate is expressed as 0.05 . It is the total interest rate of the installment (product rate plus margin).

    levyRate decimalrequired

    Interest levy rate in decimal (divided by 100). E.g. 0.6% rate is expressed as 0.006

    interestSpreadRate decimalrequired

    Interest rate margin for the specific account/installment.

    levySpreadRate decimalrequired

    Levy rate margin for the specific account/installment.

    subsidyRate decimalnullablerequired

    Subsidized interest rate. Null for non subsidized loans.

    initialCapital decimalnullablerequired

    Initial total capital of the installment.

    principalAmount decimalrequired

    Principal amount of the installment.

    interestAmount decimalrequired

    Debit Interest amount of the installment.

    levyAmount decimalrequired

    Levy amount of the installment.

    loanFeesAmount decimalrequired

    Fees amount of the installment.

    insuranceFeesAmount decimalrequired

    Insurance fees amount of the installment.

    subsidyAmount decimalnullablerequired

    Subsidized interest amount of the installment. Null for non subsidized loans.

    isInterestInstallment booleannullablerequired

    True only for separate interest installments of amortized loans.

    totalIntallmentAmount decimalrequired

    Total payment amount of the installment.

    totalInterestRate decimalrequired

    Total interest rate of the installment (interest rate plus levy rate).

Loading...