Skip to main content

Retrieves loan account basic info by account code.

GET 
/Loans/accounts/:code

Retrieves loan account basic info by account code.

Request​

Path Parameters

    code stringrequired

    Loan account code

Query Parameters

    api-version string

Header Parameters

    X-Request-ID stringrequired

Responses​

Loan account data.

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

Loading...