Retrieves loan accounts basic info for given parameters.

GET 
/Loans/accounts

Retrieves loan accounts basic info for given parameters.

Request

Query Parameters

accountType LoanAccountType

Possible values: [OpenRevolving, Amortized, FullyAmortized]

Loan account type.

customerCode string

Loan account code.

page int32

Page number.

pageSize int32

Page size.

api-version string

Header Parameters

X-Request-ID stringrequired

Responses

200

Loan accounts data.

application/json

Schema

Schema

• Array [
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
DebtorType
string
Possible values: [MainDebtor, CoDebtor, Guarantor, Heir, BenefitOfInventoryHeir, ThirdPartyParticipant]
]
accountType object nullable

Loan account type (OpenRevolving, Amortized or FullyAmortized)

oneOf

LoanAccountType

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

• ]

Example (from schema)

[
  {
    "id": 21100,
    "code": "7010000720183-0",
    "title": "John Smith Mortgage",
    "iban": "GR7507500100007010000720183",
    "currency": "EUR",
    "isActive": true,
    "debtors": [
      {
        "sn": 1,
        "customerCode": 464,
        "firstName": "John",
        "lastName": "Smith",
        "fathersName": "George",
        "fullName": "John Smith / George",
        "tin": 70449977,
        "debtorType": "MainDebtor"
      }
    ],
    "accountType": "OpenRevolving",
    "dateCreated": "2024-11-01T13:10:11.30",
    "dateClosed": null,
    "loanStartDate": "2024-11-01",
    "agreementCode": 32897,
    "agreementTitle": "John Smith mortgage agreement"
  }
]

404

application/json

Schema

Schema

type stringnullablerequired
title stringnullablerequired
status int32nullablerequired
detail stringnullablerequired
instance stringnullablerequired

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

500

application/json

Schema

Schema

type stringnullablerequired
title stringnullablerequired
status int32nullablerequired
detail stringnullablerequired
instance stringnullablerequired

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

Loading...