API docs by Redocly

Silcube API (0.1)

Download OpenAPI specification:Download

Silcube support: info@silcube.com

Silcube API description

Authentication

Get User

Authorizations:
apikeyScheme
path Parameters
userId
required
string <uuid>

Responses

Update User

Authorizations:
apikeyScheme
path Parameters
userId
required
string <uuid>
Request Body schema: application/json
roleIds
Array of strings <uuid> unique

Responses

Request samples

Content type
application/json
{
  • "roleIds": [
    ]
}

Add User to Role

Authorizations:
apikeyScheme
path Parameters
roleId
required
string <uuid>
userId
required
string <uuid>

Responses

Verify User

Authorizations:
apikeyScheme
Request Body schema: application/json
token
string
password
string

Responses

Request samples

Content type
application/json
{
  • "token": "string",
  • "password": "string"
}

Get All Users

Authorizations:
apikeyScheme

Responses

Create User

Authorizations:
apikeyScheme
Request Body schema: application/json
username
string
password
string
campaign
string
communicationEnabled
boolean

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "password": "string",
  • "campaign": "string",
  • "communicationEnabled": true
}

Switch Subscription

Authorizations:
apikeyScheme
Request Body schema: application/json
subscriptionId
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "subscriptionId": "d079718b-ff63-45dd-947b-4950c023750f"
}

Reset Password

Authorizations:
apikeyScheme
Request Body schema: application/json
token
string
password
string

Responses

Request samples

Content type
application/json
{
  • "token": "string",
  • "password": "string"
}

Create Demo User and Login

Authorizations:
apikeyScheme
Request Body schema: application/json
key
string

Responses

Request samples

Content type
application/json
{
  • "key": "string"
}

Logout User

Authorizations:
apikeyScheme

Responses

Login User

Authorizations:
apikeyScheme
Request Body schema: application/json
username
string
password
string

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "password": "string"
}

JS Errors

Authorizations:
apikeyScheme
Request Body schema: application/json
string <byte>

Responses

Request samples

Content type
application/json
"string"

Forgot Password Request

Authorizations:
apikeyScheme
Request Body schema: application/json
username
string

Responses

Request samples

Content type
application/json
{
  • "username": "string"
}

Change Password

Authorizations:
apikeyScheme
Request Body schema: application/json
oldPassword
string
newPassword
string

Responses

Request samples

Content type
application/json
{
  • "oldPassword": "string",
  • "newPassword": "string"
}

Change Name

Authorizations:
apikeyScheme
Request Body schema: application/json
name
string

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Verify User Invitation By Token

Authorizations:
apikeyScheme
path Parameters
token
required
string

Responses

Get Current User

Authorizations:
apikeyScheme

Responses

Get Current User's Subscriptions

Authorizations:
apikeyScheme

Responses

Verify Quick Login Key

Authorizations:
apikeyScheme
path Parameters
key
required
string

Responses

Authorization

Add Role to User

Authorizations:
apikeyScheme
path Parameters
userId
required
string <uuid>
roleId
required
string <uuid>

Responses

Unassign role from user

Authorizations:
apikeyScheme
path Parameters
userId
required
string <uuid>
roleId
required
string <uuid>

Responses

Find Role

Authorizations:
apikeyScheme
path Parameters
roleId
required
string <uuid>

Responses

Update Role

Authorizations:
apikeyScheme
path Parameters
roleId
required
string <uuid>
Request Body schema: application/json
name
string
permissions
Array of strings unique
Items Enum: "NONE" "USERS__VIEW" "USERS__MANAGE" "COUNTERPARTIES__VIEW" "COUNTERPARTIES__MANAGE" "COVENANTS__VIEW" "COVENANTS__MANAGE" "ROLES__VIEW" "ROLES__MANAGE" "SUBSCRIPTIONS__VIEW" "SUBSCRIPTIONS__MANAGE" "PORTFOLIOS__VIEW" "PORTFOLIOS__MANAGE" "CREDIT_FACILITIES__VIEW" "CREDIT_FACILITIES__MANAGE" "CREDIT_FACILITY_DOCUMENTS__MANAGE" "LOANS__VIEW" "LOANS__MANAGE" "LOANS_PAYMENTS__MANAGE" "LOAN_DOCUMENTS__MANAGE" "ATTRIBUTES__VIEW" "ATTRIBUTES__MANAGE" "INSTRUMENTS__VIEW" "INSTRUMENTS__MANAGE" "PAYMENTS__VIEW" "PAYMENTS__MANAGE" "ACCOUNTING__VIEW" "ACCOUNTING__MANAGE" "NAVS__MANAGE" "LOANS__APPROVE" "FX__VIEW" "FX__MANAGE" "INTEREST_RATES__VIEW" "INTEREST_RATES__MANAGE" "CASHFLOW__VIEW" "EXPOSURE__VIEW" "GEOMAP__VIEW" "LOAN_BOOK_ANALYSIS__VIEW" "POSITIONS__VIEW" "DASHBOARDS__VIEW" "DASHBOARDS__VIEW_DIRECTLY_SHARED" "DASHBOARDS__MANAGE"

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "permissions": [
    ]
}

Delete Role

Authorizations:
apikeyScheme
path Parameters
roleId
required
string <uuid>

Responses

Add Permissions to Role

Authorizations:
apikeyScheme
path Parameters
roleId
required
string <uuid>
Request Body schema: application/json
permissions
Array of strings unique
Items Enum: "NONE" "USERS__VIEW" "USERS__MANAGE" "COUNTERPARTIES__VIEW" "COUNTERPARTIES__MANAGE" "COVENANTS__VIEW" "COVENANTS__MANAGE" "ROLES__VIEW" "ROLES__MANAGE" "SUBSCRIPTIONS__VIEW" "SUBSCRIPTIONS__MANAGE" "PORTFOLIOS__VIEW" "PORTFOLIOS__MANAGE" "CREDIT_FACILITIES__VIEW" "CREDIT_FACILITIES__MANAGE" "CREDIT_FACILITY_DOCUMENTS__MANAGE" "LOANS__VIEW" "LOANS__MANAGE" "LOANS_PAYMENTS__MANAGE" "LOAN_DOCUMENTS__MANAGE" "ATTRIBUTES__VIEW" "ATTRIBUTES__MANAGE" "INSTRUMENTS__VIEW" "INSTRUMENTS__MANAGE" "PAYMENTS__VIEW" "PAYMENTS__MANAGE" "ACCOUNTING__VIEW" "ACCOUNTING__MANAGE" "NAVS__MANAGE" "LOANS__APPROVE" "FX__VIEW" "FX__MANAGE" "INTEREST_RATES__VIEW" "INTEREST_RATES__MANAGE" "CASHFLOW__VIEW" "EXPOSURE__VIEW" "GEOMAP__VIEW" "LOAN_BOOK_ANALYSIS__VIEW" "POSITIONS__VIEW" "DASHBOARDS__VIEW" "DASHBOARDS__VIEW_DIRECTLY_SHARED" "DASHBOARDS__MANAGE"

Responses

Request samples

Content type
application/json
{
  • "permissions": [
    ]
}

Delete permissions from the role

Authorizations:
apikeyScheme
path Parameters
roleId
required
string <uuid>
Request Body schema: application/json
permissions
Array of strings unique
Items Enum: "NONE" "USERS__VIEW" "USERS__MANAGE" "COUNTERPARTIES__VIEW" "COUNTERPARTIES__MANAGE" "COVENANTS__VIEW" "COVENANTS__MANAGE" "ROLES__VIEW" "ROLES__MANAGE" "SUBSCRIPTIONS__VIEW" "SUBSCRIPTIONS__MANAGE" "PORTFOLIOS__VIEW" "PORTFOLIOS__MANAGE" "CREDIT_FACILITIES__VIEW" "CREDIT_FACILITIES__MANAGE" "CREDIT_FACILITY_DOCUMENTS__MANAGE" "LOANS__VIEW" "LOANS__MANAGE" "LOANS_PAYMENTS__MANAGE" "LOAN_DOCUMENTS__MANAGE" "ATTRIBUTES__VIEW" "ATTRIBUTES__MANAGE" "INSTRUMENTS__VIEW" "INSTRUMENTS__MANAGE" "PAYMENTS__VIEW" "PAYMENTS__MANAGE" "ACCOUNTING__VIEW" "ACCOUNTING__MANAGE" "NAVS__MANAGE" "LOANS__APPROVE" "FX__VIEW" "FX__MANAGE" "INTEREST_RATES__VIEW" "INTEREST_RATES__MANAGE" "CASHFLOW__VIEW" "EXPOSURE__VIEW" "GEOMAP__VIEW" "LOAN_BOOK_ANALYSIS__VIEW" "POSITIONS__VIEW" "DASHBOARDS__VIEW" "DASHBOARDS__VIEW_DIRECTLY_SHARED" "DASHBOARDS__MANAGE"

Responses

Request samples

Content type
application/json
{
  • "permissions": [
    ]
}

Find All Roles

Authorizations:
apikeyScheme

Responses

Create Role

Authorizations:
apikeyScheme
Request Body schema: application/json
name
string
permissions
Array of strings unique
Items Enum: "NONE" "USERS__VIEW" "USERS__MANAGE" "COUNTERPARTIES__VIEW" "COUNTERPARTIES__MANAGE" "COVENANTS__VIEW" "COVENANTS__MANAGE" "ROLES__VIEW" "ROLES__MANAGE" "SUBSCRIPTIONS__VIEW" "SUBSCRIPTIONS__MANAGE" "PORTFOLIOS__VIEW" "PORTFOLIOS__MANAGE" "CREDIT_FACILITIES__VIEW" "CREDIT_FACILITIES__MANAGE" "CREDIT_FACILITY_DOCUMENTS__MANAGE" "LOANS__VIEW" "LOANS__MANAGE" "LOANS_PAYMENTS__MANAGE" "LOAN_DOCUMENTS__MANAGE" "ATTRIBUTES__VIEW" "ATTRIBUTES__MANAGE" "INSTRUMENTS__VIEW" "INSTRUMENTS__MANAGE" "PAYMENTS__VIEW" "PAYMENTS__MANAGE" "ACCOUNTING__VIEW" "ACCOUNTING__MANAGE" "NAVS__MANAGE" "LOANS__APPROVE" "FX__VIEW" "FX__MANAGE" "INTEREST_RATES__VIEW" "INTEREST_RATES__MANAGE" "CASHFLOW__VIEW" "EXPOSURE__VIEW" "GEOMAP__VIEW" "LOAN_BOOK_ANALYSIS__VIEW" "POSITIONS__VIEW" "DASHBOARDS__VIEW" "DASHBOARDS__VIEW_DIRECTLY_SHARED" "DASHBOARDS__MANAGE"

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "permissions": [
    ]
}

Find All Roles of this User

Authorizations:
apikeyScheme
path Parameters
userId
required
string <uuid>

Responses

Find All Users of this Role

Authorizations:
apikeyScheme
path Parameters
roleId
required
string <uuid>

Responses

Portfolios

Get Portfolio

Authorizations:
apikeyScheme
path Parameters
portfolioId
required
string <uuid>

Responses

Update Portfolio

Authorizations:
apikeyScheme
path Parameters
portfolioId
required
string <uuid>
Request Body schema: application/json
name
string
currencyId
string <uuid>
currencyIsoCode
string
inceptionDate
string <date>
address
string
withShareClasses
boolean
withCashAccounts
boolean
withFXPricingSource
boolean
withSecurityAccounts
boolean
withClassifiers
boolean
withMonthlyFactsheet
boolean

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "currencyId": "2a59a322-927b-4fc7-bac8-d295c634b295",
  • "currencyIsoCode": "string",
  • "inceptionDate": "2019-08-24",
  • "address": "string",
  • "withShareClasses": true,
  • "withCashAccounts": true,
  • "withFXPricingSource": true,
  • "withSecurityAccounts": true,
  • "withClassifiers": true,
  • "withMonthlyFactsheet": true
}

Delete Portfolio

Authorizations:
apikeyScheme
path Parameters
portfolioId
required
string <uuid>

Responses

Get Portfolio's Share Class

Authorizations:
apikeyScheme
path Parameters
portfolioId
required
string <uuid>
shareClassId
required
string <uuid>

Responses

Update Portfolio's Share Class

Authorizations:
apikeyScheme
path Parameters
portfolioId
required
string <uuid>
shareClassId
required
string <uuid>
Request Body schema: application/json
name
string
isin
string
currencyId
string <uuid>
currencyIsoCode
string
nominal
number
rounding
integer <int32>
inceptionDate
string <date>

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "isin": "string",
  • "currencyId": "2a59a322-927b-4fc7-bac8-d295c634b295",
  • "currencyIsoCode": "string",
  • "nominal": 0,
  • "rounding": 0,
  • "inceptionDate": "2019-08-24"
}

Create Portfolio's Share Class

Authorizations:
apikeyScheme
path Parameters
portfolioId
required
string <uuid>
shareClassId
required
string <uuid>

Responses

Update Portfolio is with values

Authorizations:
apikeyScheme
path Parameters
portfolioId
required
string <uuid>
Request Body schema: application/json
name
string
currencyId
string <uuid>
currencyIsoCode
string
inceptionDate
string <date>
address
string
withShareClasses
boolean
withCashAccounts
boolean
withFXPricingSource
boolean
withSecurityAccounts
boolean
withClassifiers
boolean
withMonthlyFactsheet
boolean

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "currencyId": "2a59a322-927b-4fc7-bac8-d295c634b295",
  • "currencyIsoCode": "string",
  • "inceptionDate": "2019-08-24",
  • "address": "string",
  • "withShareClasses": true,
  • "withCashAccounts": true,
  • "withFXPricingSource": true,
  • "withSecurityAccounts": true,
  • "withClassifiers": true,
  • "withMonthlyFactsheet": true
}

Get Portfolio's Email Template

Authorizations:
apikeyScheme
path Parameters
portfolioId
required
string <uuid>
templateId
required
string <uuid>

Responses

Update Portfolio Email Template

Authorizations:
apikeyScheme
path Parameters
portfolioId
required
string <uuid>
templateId
required
string <uuid>
Request Body schema: application/json
name
string
subjectTemplate
string
bodyTemplate
string
type
string
Enum: "COLLATERAL_RELEASE" "LOAN_EARLY_TERMINATION" "LOAN_EXTEND_MATURITY" "LOAN_PAYOUT" "LOAN_SCHEDULE_CHANGE"
comment
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "subjectTemplate": "string",
  • "bodyTemplate": "string",
  • "type": "COLLATERAL_RELEASE",
  • "comment": "string"
}

Delete Portfolio Email Template

Authorizations:
apikeyScheme
path Parameters
portfolioId
required
string <uuid>
templateId
required
string <uuid>

Responses

Update Portfolio's Cash Account

Authorizations:
apikeyScheme
path Parameters
portfolioId
required
string <uuid>
cashAccountId
required
string <uuid>
Request Body schema: application/json
name
string
currencyId
string <uuid>
currencyIsoCode
string
bankName
string
bankIdentifierCode
string
bankAccountNumber
string
bankAddress
string
correspondentBankName
string
correspondentBankIdentifierCode
string
correspondentBankAccountNumber
string
correspondentBankAddress
string
default
boolean
active
boolean

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "currencyId": "2a59a322-927b-4fc7-bac8-d295c634b295",
  • "currencyIsoCode": "string",
  • "bankName": "string",
  • "bankIdentifierCode": "string",
  • "bankAccountNumber": "string",
  • "bankAddress": "string",
  • "correspondentBankName": "string",
  • "correspondentBankIdentifierCode": "string",
  • "correspondentBankAccountNumber": "string",
  • "correspondentBankAddress": "string",
  • "default": true,
  • "active": true
}

Delete Portfolio's Cash Account

Authorizations:
apikeyScheme
path Parameters
portfolioId
required
string <uuid>
cashAccountId
required
string <uuid>

Responses

Get All Portfolios Cash

Authorizations:
apikeyScheme

Responses

Create Portfolio

Authorizations:
apikeyScheme
Request Body schema: application/json
name
string
currencyId
string <uuid>
currencyIsoCode
string
inceptionDate
string <date>
address
string
withShareClasses
boolean
withCashAccounts
boolean
withFXPricingSource
boolean
withSecurityAccounts
boolean
withClassifiers
boolean
withMonthlyFactsheet
boolean

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "currencyId": "2a59a322-927b-4fc7-bac8-d295c634b295",
  • "currencyIsoCode": "string",
  • "inceptionDate": "2019-08-24",
  • "address": "string",
  • "withShareClasses": true,
  • "withCashAccounts": true,
  • "withFXPricingSource": true,
  • "withSecurityAccounts": true,
  • "withClassifiers": true,
  • "withMonthlyFactsheet": true
}

Get Portfolio's All Share Classes

Authorizations:
apikeyScheme
path Parameters
portfolioId
required
string <uuid>

Responses

Create Portfolio Share Class

Authorizations:
apikeyScheme
path Parameters
portfolioId
required
string <uuid>
Request Body schema: application/json
name
string
isin
string
currencyId
string <uuid>
currencyIsoCode
string
nominal
number
rounding
integer <int32>
inceptionDate
string <date>

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "isin": "string",
  • "currencyId": "2a59a322-927b-4fc7-bac8-d295c634b295",
  • "currencyIsoCode": "string",
  • "nominal": 0,
  • "rounding": 0,
  • "inceptionDate": "2019-08-24"
}

List Portfolio's All Email Templates

Authorizations:
apikeyScheme
path Parameters
portfolioId
required
string <uuid>

Responses

Create Portfolio Email Template

Authorizations:
apikeyScheme
path Parameters
portfolioId
required
string <uuid>
Request Body schema: application/json
name
string
subjectTemplate
string
bodyTemplate
string
type
string
Enum: "COLLATERAL_RELEASE" "LOAN_EARLY_TERMINATION" "LOAN_EXTEND_MATURITY" "LOAN_PAYOUT" "LOAN_SCHEDULE_CHANGE"
comment
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "subjectTemplate": "string",
  • "bodyTemplate": "string",
  • "type": "COLLATERAL_RELEASE",
  • "comment": "string"
}

Create Portfolio's All Cash Accounts

Authorizations:
apikeyScheme
path Parameters
portfolioId
required
string <uuid>

Responses

Create Portfolio Cash Account

Authorizations:
apikeyScheme
path Parameters
portfolioId
required
string <uuid>
Request Body schema: application/json
name
string
currencyId
string <uuid>
currencyIsoCode
string
bankName
string
bankIdentifierCode
string
bankAccountNumber
string
bankAddress
string
correspondentBankName
string
correspondentBankIdentifierCode
string
correspondentBankAccountNumber
string
correspondentBankAddress
string
default
boolean
active
boolean

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "currencyId": "2a59a322-927b-4fc7-bac8-d295c634b295",
  • "currencyIsoCode": "string",
  • "bankName": "string",
  • "bankIdentifierCode": "string",
  • "bankAccountNumber": "string",
  • "bankAddress": "string",
  • "correspondentBankName": "string",
  • "correspondentBankIdentifierCode": "string",
  • "correspondentBankAccountNumber": "string",
  • "correspondentBankAddress": "string",
  • "default": true,
  • "active": true
}

Get Counterparties with loans

Authorizations:
apikeyScheme
path Parameters
portfolioId
required
string <uuid>

Responses

Get Portfolio's Cash Account

Authorizations:
apikeyScheme
path Parameters
portfolioId
required
string <uuid>
shareClassId
required
string <uuid>

Responses

Get All Portfolios Cash Accounts

Authorizations:
apikeyScheme

Responses

Payments

Update Receivable in Portfolio

Authorizations:
apikeyScheme
path Parameters
portfolioId
required
string <uuid>
receivableId
required
string <uuid>
Request Body schema: application/json
comment
string

Responses

Request samples

Content type
application/json
{
  • "comment": "string"
}

Delete Portfolio's Receivable

Authorizations:
apikeyScheme
path Parameters
portfolioId
required
string <uuid>
receivableId
required
string <uuid>

Responses

Get Payment

Authorizations:
apikeyScheme
path Parameters
paymentId
required
string <uuid>

Responses

Update Payment

Authorizations:
apikeyScheme
path Parameters
paymentId
required
string <uuid>
Request Body schema: application/json
direction
string
Enum: "IN" "OUT"
currencyIsoCode
string
currencyId
string <uuid>
counterpartyId
string <uuid>
date
string <date>
amount
number
remitterName
string
remitterAccountNumber
string
beneficiaryName
string
beneficiaryAccountNumber
string
description
string
referenceNumber
string

Responses

Request samples

Content type
application/json
{
  • "direction": "IN",
  • "currencyIsoCode": "string",
  • "currencyId": "2a59a322-927b-4fc7-bac8-d295c634b295",
  • "counterpartyId": "55bd9d74-f636-4cc8-885a-e78ea532e2ad",
  • "date": "2019-08-24",
  • "amount": 0,
  • "remitterName": "string",
  • "remitterAccountNumber": "string",
  • "beneficiaryName": "string",
  • "beneficiaryAccountNumber": "string",
  • "description": "string",
  • "referenceNumber": "string"
}

Delete Payment

Authorizations:
apikeyScheme
path Parameters
paymentId
required
string <uuid>

Responses

Update an FX Trade

Authorizations:
apikeyScheme
path Parameters
tradeId
required
string <uuid>
Request Body schema: application/json
portfolioId
string <uuid>
tradeDate
string <date>
settlementDate
string <date>
captureType
string
Enum: "AMOUNT" "BUY_AMOUNT_RATE" "SELL_AMOUNT_RATE"
object (FxTradeSide)
object (FxTradeSide)
comment
string
Array of objects (DocumentRequest)

Responses

Request samples

Content type
application/json
{
  • "portfolioId": "2a9b0ad6-e5de-4239-a282-527c92c7c0f1",
  • "tradeDate": "2019-08-24",
  • "settlementDate": "2019-08-24",
  • "captureType": "AMOUNT",
  • "buySide": {
    },
  • "sellSide": {
    },
  • "comment": "string",
  • "supportingDocuments": [
    ]
}

Create And Settle Payment

Authorizations:
apikeyScheme
Request Body schema: application/json
direction
string
Enum: "IN" "OUT"
currencyIsoCode
string
currencyId
string <uuid>
counterpartyId
string <uuid>
date
string <date>
amount
number
remitterName
string
remitterAccountNumber
string
beneficiaryName
string
beneficiaryAccountNumber
string
description
string
referenceNumber
string
comment
string
receivableIds
Array of strings <uuid> unique
payableIds
Array of strings <uuid> unique

Responses

Request samples

Content type
application/json
{
  • "direction": "IN",
  • "currencyIsoCode": "string",
  • "currencyId": "2a59a322-927b-4fc7-bac8-d295c634b295",
  • "counterpartyId": "55bd9d74-f636-4cc8-885a-e78ea532e2ad",
  • "date": "2019-08-24",
  • "amount": 0,
  • "remitterName": "string",
  • "remitterAccountNumber": "string",
  • "beneficiaryName": "string",
  • "beneficiaryAccountNumber": "string",
  • "description": "string",
  • "referenceNumber": "string",
  • "comment": "string",
  • "receivableIds": [
    ],
  • "payableIds": [
    ]
}

Create Receivable in Portfolio

Authorizations:
apikeyScheme
path Parameters
portfolioId
required
string <uuid>
Request Body schema: application/json
loanId
string <uuid>
cashAccountId
string <uuid>
date
string <date>
type
string
Enum: "PRINCIPAL" "INTEREST" "FEE" "PENALTY" "TRANSFER_IN" "OTHER"
amount
number
comment
string

Responses

Request samples

Content type
application/json
{
  • "loanId": "7f89c4c5-c1d0-4b4b-ae8c-fb112b2c21a4",
  • "cashAccountId": "6affaff6-e8a8-4587-b0ba-439af8fc3538",
  • "date": "2019-08-24",
  • "type": "PRINCIPAL",
  • "amount": 0,
  • "comment": "string"
}

Create Payable

Authorizations:
apikeyScheme
path Parameters
portfolioId
required
string <uuid>
Request Body schema: application/json
currencyId
string <uuid>
currencyIsoCode
string
loanId
string <uuid>
date
string <date>
type
string
Enum: "PAYABLE" "LOAN_PAYOUT"
amount
number
description
string

Responses

Request samples

Content type
application/json
{
  • "currencyId": "2a59a322-927b-4fc7-bac8-d295c634b295",
  • "currencyIsoCode": "string",
  • "loanId": "7f89c4c5-c1d0-4b4b-ae8c-fb112b2c21a4",
  • "date": "2019-08-24",
  • "type": "PAYABLE",
  • "amount": 0,
  • "description": "string"
}

Get All Payments

Authorizations:
apikeyScheme

Responses

Create Payment

Authorizations:
apikeyScheme
Request Body schema: application/json
direction
string
Enum: "IN" "OUT"
currencyIsoCode
string
currencyId
string <uuid>
counterpartyId
string <uuid>
date
string <date>
amount
number
remitterName
string
remitterAccountNumber
string
beneficiaryName
string
beneficiaryAccountNumber
string
description
string
referenceNumber
string

Responses

Request samples

Content type
application/json
{
  • "direction": "IN",
  • "currencyIsoCode": "string",
  • "currencyId": "2a59a322-927b-4fc7-bac8-d295c634b295",
  • "counterpartyId": "55bd9d74-f636-4cc8-885a-e78ea532e2ad",
  • "date": "2019-08-24",
  • "amount": 0,
  • "remitterName": "string",
  • "remitterAccountNumber": "string",
  • "beneficiaryName": "string",
  • "beneficiaryAccountNumber": "string",
  • "description": "string",
  • "referenceNumber": "string"
}

Create Payment Manual Settlement

Authorizations:
apikeyScheme
path Parameters
paymentId
required
string <uuid>
Request Body schema: application/json
counterpartyId
string <uuid>
comment
string
Array of objects (ManualReceivableSettlementRequest)

Responses

Request samples

Content type
application/json
{
  • "counterpartyId": "55bd9d74-f636-4cc8-885a-e78ea532e2ad",
  • "comment": "string",
  • "settlements": [
    ]
}

Parse payments from excel file

Authorizations:
apikeyScheme
Request Body schema: application/json
content
string

Responses

Request samples

Content type
application/json
{
  • "content": "string"
}

Upload Statement

Authorizations:
apikeyScheme
Request Body schema: application/json
content
string

Responses

Request samples

Content type
application/json
{
  • "content": "string"
}

Create an Invoice

Authorizations:
apikeyScheme
Request Body schema: application/json
documentContent
string
receivables
Array of strings <uuid>
invoiceNumber
string

Responses

Request samples

Content type
application/json
{
  • "documentContent": "string",
  • "receivables": [
    ],
  • "invoiceNumber": "string"
}

Invoice File Data generate

Authorizations:
apikeyScheme
Request Body schema: application/json
documentContent
string
receivables
Array of strings <uuid>
invoiceNumber
string

Responses

Request samples

Content type
application/json
{
  • "documentContent": "string",
  • "receivables": [
    ],
  • "invoiceNumber": "string"
}

Get All FX Trades

Authorizations:
apikeyScheme

Responses

Create an FX Trade

Authorizations:
apikeyScheme
Request Body schema: application/json
portfolioId
string <uuid>
tradeDate
string <date>
settlementDate
string <date>
captureType
string
Enum: "AMOUNT" "BUY_AMOUNT_RATE" "SELL_AMOUNT_RATE"
object (FxTradeSide)
object (FxTradeSide)
comment
string
Array of objects (DocumentRequest)

Responses

Request samples

Content type
application/json
{
  • "portfolioId": "2a9b0ad6-e5de-4239-a282-527c92c7c0f1",
  • "tradeDate": "2019-08-24",
  • "settlementDate": "2019-08-24",
  • "captureType": "AMOUNT",
  • "buySide": {
    },
  • "sellSide": {
    },
  • "comment": "string",
  • "supportingDocuments": [
    ]
}

Get Unsettled Receivables

Authorizations:
apikeyScheme
query Parameters
counterpartyId
required
string <uuid>
currencyId
required
string <uuid>

Responses

Get All Receivables

Authorizations:
apikeyScheme
query Parameters
fromDate
string <date>
toDate
string <date>

Responses

Get Receivable

Authorizations:
apikeyScheme
path Parameters
receivableId
required
string <uuid>

Responses

Get Unmatched Payments

Authorizations:
apikeyScheme

Responses

Get All Payables

Authorizations:
apikeyScheme

Responses

Get Receivable_1

Authorizations:
apikeyScheme
path Parameters
payableId
required
string <uuid>

Responses

Get Invoice's Document

Authorizations:
apikeyScheme
path Parameters
invoiceId
required
string <uuid>
documentId
required
string <uuid>

Responses

Get Trade's Document

Authorizations:
apikeyScheme
path Parameters
tradeId
required
string <uuid>
documentId
required
string <uuid>

Responses

Delete Portfolio's Payable

Authorizations:
apikeyScheme
path Parameters
portfolioId
required
string <uuid>
payableId
required
string <uuid>

Responses

Delete a FX Trade

Authorizations:
apikeyScheme
path Parameters
fxTradeId
required
string <uuid>

Responses

Notifications

execute

Authorizations:
apikeyScheme
path Parameters
notificationId
required
string <uuid>
Request Body schema: application/json
read
boolean

Responses

Request samples

Content type
application/json
{
  • "read": true
}

Create or update Firebase registration token

Authorizations:
apikeyScheme
path Parameters
token
required
string

Responses

Delete Firebase registration token

Authorizations:
apikeyScheme
path Parameters
token
required
string

Responses

execute_1

Authorizations:
apikeyScheme

Responses

Send Test notification

Authorizations:
apikeyScheme

Responses

Get All Notifications

Authorizations:
apikeyScheme

Responses

Loans

Get Loan

Authorizations:
apikeyScheme
path Parameters
loanId
required
string <uuid>

Responses

Update Loan

Authorizations:
apikeyScheme
path Parameters
loanId
required
string <uuid>
Request Body schema: application/json
fixedRate
number
principal
number
penaltyRate
number
drawdownLimitAmount
number
generalType
string
Enum: "PERIODIC" "AT_MATURITY" "DISCOUNTED" "CUSTOM"
tradeType
string
Enum: "LEND" "BORROW"
interestType
string
Enum: "FIXED" "FLOATING"
amortizationType
string
Enum: "NONE" "LINEAR" "ANNUITY"
dayCount
string
Enum: "ACT360" "ACT365" "ACTACTAFB" "ACTACTISDA" "E30360" "BOND30360" "ISDA30360"
payDateRollConv
string
Enum: "NONE" "FOLLOWING" "MODIFIED_FOLLOWING" "PREVIOUS"
paymentFrequency
string
Enum: "MONTHLY" "QUARTERLY" "SEMIANNUALLY" "YEARLY" "AT_MATURITY"
maturityDate
string <date>
tradeDate
string <date>
valueDate
string <date>
portfolioId
string <uuid>
cashAccountId
string <uuid>
currencyId
string <uuid>
counterpartyId
string <uuid>
firstPaymentDate
string <date>
commission
number
fees
number
feesPaymentMode
string
Enum: "AT_INCEPTION" "AT_MATURITY"
description
string
externalId
string
countrySDGId
string <uuid>
object (FloatingInterestOptions)
object (AmortizationOptions)
creditFacilityId
string <uuid>
status
string
Enum: "ACCELERATED" "ANNULLED" "APPROVED" "DISBURSED" "DRAFT" "MATURED" "ENDED" "REJECTED" "TERMINATED_EARLY" "WAITING_FOR_APPROVAL"
interestBasedOnInitialPrincipal
boolean
endOfMonthAdjustment
boolean
roundCouponAmount
boolean

Responses

Request samples

Content type
application/json
{
  • "fixedRate": 0,
  • "principal": 0,
  • "penaltyRate": 0,
  • "drawdownLimitAmount": 0,
  • "generalType": "PERIODIC",
  • "tradeType": "LEND",
  • "interestType": "FIXED",
  • "amortizationType": "NONE",
  • "dayCount": "ACT360",
  • "payDateRollConv": "NONE",
  • "paymentFrequency": "MONTHLY",
  • "maturityDate": "2019-08-24",
  • "tradeDate": "2019-08-24",
  • "valueDate": "2019-08-24",
  • "portfolioId": "2a9b0ad6-e5de-4239-a282-527c92c7c0f1",
  • "cashAccountId": "6affaff6-e8a8-4587-b0ba-439af8fc3538",
  • "currencyId": "2a59a322-927b-4fc7-bac8-d295c634b295",
  • "counterpartyId": "55bd9d74-f636-4cc8-885a-e78ea532e2ad",
  • "firstPaymentDate": "2019-08-24",
  • "commission": 0,
  • "fees": 0,
  • "feesPaymentMode": "AT_INCEPTION",
  • "description": "string",
  • "externalId": "string",
  • "countrySDGId": "fa126286-c24e-4e8d-b73e-f0ff49eb0aa5",
  • "floatingInterest": {
    },
  • "amortization": {
    },
  • "creditFacilityId": "c7369ee1-04fd-41bb-86b3-50a8a0b0d5c1",
  • "status": "ACCELERATED",
  • "interestBasedOnInitialPrincipal": true,
  • "endOfMonthAdjustment": true,
  • "roundCouponAmount": true
}

Delete Loan

Authorizations:
apikeyScheme
path Parameters
loanId
required
string <uuid>

Responses

Get Loan's Todo

Authorizations:
apikeyScheme
path Parameters
loanId
required
string <uuid>
todoId
required
string <uuid>

Responses

Update Loan's Todo

Authorizations:
apikeyScheme
path Parameters
loanId
required
string <uuid>
todoId
required
string <uuid>
Request Body schema: application/json
attributeId
string <uuid>
parentId
string <uuid>
preparedReviewerUserId
string <uuid>
checkedReviewerUserId
string <uuid>
preparerUserIds
Array of strings <uuid> unique
reviewerUserIds
Array of strings <uuid> unique
attributeName
string
deadline
string <date>
custom
boolean
active
boolean

Responses

Request samples

Content type
application/json
{
  • "attributeId": "4373db18-af63-40d4-ad40-80a2c734bfcf",
  • "parentId": "70850378-7d3c-4f45-91b7-942d4dfbbd43",
  • "preparedReviewerUserId": "6c34f464-caa9-49e0-8119-24de832af73c",
  • "checkedReviewerUserId": "76d6eeee-d11b-41f4-8e96-562e737f92a8",
  • "preparerUserIds": [
    ],
  • "reviewerUserIds": [
    ],
  • "attributeName": "string",
  • "deadline": "2019-08-24",
  • "custom": true,
  • "active": true
}

Delete Loan's Todo

Authorizations:
apikeyScheme
path Parameters
loanId
required
string <uuid>
todoId
required
string <uuid>

Responses

Review Loan's Todo

Authorizations:
apikeyScheme
path Parameters
loanId
required
string <uuid>
todoId
required
string <uuid>
Request Body schema: application/json
preparedReviewerUserId
string <uuid>
checkedReviewerUserId
string <uuid>
deadline
string <date>
active
boolean

Responses

Request samples

Content type
application/json
{
  • "preparedReviewerUserId": "6c34f464-caa9-49e0-8119-24de832af73c",
  • "checkedReviewerUserId": "76d6eeee-d11b-41f4-8e96-562e737f92a8",
  • "deadline": "2019-08-24",
  • "active": true
}

Update Loan Document

Authorizations:
apikeyScheme
path Parameters
loanId
required
string <uuid>
loanDocumentId
required
string <uuid>
Request Body schema: application/json
attributeId
string <uuid>
name
string
content
string
documentUrl
string
comment
string
ownerUserId
string <uuid>
reviewerUserIds
Array of strings <uuid> unique

Responses

Request samples

Content type
application/json
{
  • "attributeId": "4373db18-af63-40d4-ad40-80a2c734bfcf",
  • "name": "string",
  • "content": "string",
  • "documentUrl": "string",
  • "comment": "string",
  • "ownerUserId": "283eeac5-beea-465a-80a5-763009480d0f",
  • "reviewerUserIds": [
    ]
}

Delete Loan's Single Document

Authorizations:
apikeyScheme
path Parameters
loanId
required
string <uuid>
loanDocumentId
required
string <uuid>

Responses

Get Loan Covenant

Authorizations:
apikeyScheme
path Parameters
loanId
required
string <uuid>
covenantId
required
string <uuid>

Responses

Update Loan Covenant

Authorizations:
apikeyScheme
path Parameters
loanId
required
string <uuid>
covenantId
required
string <uuid>
Request Body schema: application/json
name
string
reportingEntity
string
Enum: "BORROWER" "LENDER"
frequency
string
Enum: "ON_DRAWDOWN" "MONTHLY" "BIMONTHLY" "QUARTERLY" "SEMIANNUALLY" "YEARLY"
deadline
string
Enum: "ONE_WEEK" "TWO_WEEKS" "ONE_MONTH" "TWO_MONTHS"
firstKPIDate
string <date>
object (Condition)
changeDate
string <date>
supportingDocumentRequired
boolean

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "reportingEntity": "BORROWER",
  • "frequency": "ON_DRAWDOWN",
  • "deadline": "ONE_WEEK",
  • "firstKPIDate": "2019-08-24",
  • "condition": {
    },
  • "changeDate": "2019-08-24",
  • "supportingDocumentRequired": true
}

Delete Loan Covenant

Authorizations:
apikeyScheme
path Parameters
loanId
required
string <uuid>
covenantId
required
string <uuid>

Responses

Get Loan's Collateral

Authorizations:
apikeyScheme
path Parameters
loanId
required
string <uuid>
collateralId
required
string <uuid>

Responses

Update Loan's Collateral

Authorizations:
apikeyScheme
path Parameters
loanId
required
string <uuid>
collateralId
required
string <uuid>
Request Body schema: application/json
instrumentId
string <uuid>
stageId
string <uuid>
validFromDate
string <date>
validUntilDate
string <date>
quantity
number
haircut
number
comment
string
released
boolean

Responses

Request samples

Content type
application/json
{
  • "instrumentId": "48367a03-b541-4ea7-88a6-ae604df75c64",
  • "stageId": "4ac83d66-64fa-48da-9505-57df43404af7",
  • "validFromDate": "2019-08-24",
  • "validUntilDate": "2019-08-24",
  • "quantity": 0,
  • "haircut": 0,
  • "comment": "string",
  • "released": true
}

Update Loan's Collateral Stages

Authorizations:
apikeyScheme
path Parameters
loanId
required
string <uuid>
collateralId
required
string <uuid>
Request Body schema: application/json
changeDate
string <date>
Array of objects (LoanCollateralRequest)

Responses

Request samples

Content type
application/json
{
  • "changeDate": "2019-08-24",
  • "stages": [
    ]
}

Delete Loan's Collateral Document

Authorizations:
apikeyScheme
path Parameters
loanId
required
string <uuid>
collateralId
required
string <uuid>

Responses

Update Loan's Attribute

Authorizations:
apikeyScheme
path Parameters
loanId
required
string <uuid>
valueId
required
string <uuid>
Request Body schema: application/json
attributeId
string <uuid>
value
string
date
string <date>
object (DocumentUploadRequest)

Responses

Request samples

Content type
application/json
{
  • "attributeId": "4373db18-af63-40d4-ad40-80a2c734bfcf",
  • "value": "string",
  • "date": "2019-08-24",
  • "document": {
    }
}

Delete Loan's Attribute

Authorizations:
apikeyScheme
path Parameters
loanId
required
string <uuid>
valueId
required
string <uuid>

Responses

Parse todos from Excel file

Authorizations:
apikeyScheme
Request Body schema: application/json
content
string

Responses

Request samples

Content type
application/json
{
  • "content": "string"
}

Get All Loans

Authorizations:
apikeyScheme

Responses

Create Loan

Authorizations:
apikeyScheme
Request Body schema: application/json
fixedRate
number
principal
number
penaltyRate
number
drawdownLimitAmount
number
generalType
string
Enum: "PERIODIC" "AT_MATURITY" "DISCOUNTED" "CUSTOM"
tradeType
string
Enum: "LEND" "BORROW"
interestType
string
Enum: "FIXED" "FLOATING"
amortizationType
string
Enum: "NONE" "LINEAR" "ANNUITY"
dayCount
string
Enum: "ACT360" "ACT365" "ACTACTAFB" "ACTACTISDA" "E30360" "BOND30360" "ISDA30360"
payDateRollConv
string
Enum: "NONE" "FOLLOWING" "MODIFIED_FOLLOWING" "PREVIOUS"
paymentFrequency
string
Enum: "MONTHLY" "QUARTERLY" "SEMIANNUALLY" "YEARLY" "AT_MATURITY"
maturityDate
string <date>
tradeDate
string <date>
valueDate
string <date>
portfolioId
string <uuid>
cashAccountId
string <uuid>
currencyId
string <uuid>
counterpartyId
string <uuid>
firstPaymentDate
string <date>
commission
number
fees
number
feesPaymentMode
string
Enum: "AT_INCEPTION" "AT_MATURITY"
description
string
externalId
string
countrySDGId
string <uuid>
object (FloatingInterestOptions)
object (AmortizationOptions)
creditFacilityId
string <uuid>
status
string
Enum: "ACCELERATED" "ANNULLED" "APPROVED" "DISBURSED" "DRAFT" "MATURED" "ENDED" "REJECTED" "TERMINATED_EARLY" "WAITING_FOR_APPROVAL"
interestBasedOnInitialPrincipal
boolean
endOfMonthAdjustment
boolean
roundCouponAmount
boolean

Responses

Request samples

Content type
application/json
{
  • "fixedRate": 0,
  • "principal": 0,
  • "penaltyRate": 0,
  • "drawdownLimitAmount": 0,
  • "generalType": "PERIODIC",
  • "tradeType": "LEND",
  • "interestType": "FIXED",
  • "amortizationType": "NONE",
  • "dayCount": "ACT360",
  • "payDateRollConv": "NONE",
  • "paymentFrequency": "MONTHLY",
  • "maturityDate": "2019-08-24",
  • "tradeDate": "2019-08-24",
  • "valueDate": "2019-08-24",
  • "portfolioId": "2a9b0ad6-e5de-4239-a282-527c92c7c0f1",
  • "cashAccountId": "6affaff6-e8a8-4587-b0ba-439af8fc3538",
  • "currencyId": "2a59a322-927b-4fc7-bac8-d295c634b295",
  • "counterpartyId": "55bd9d74-f636-4cc8-885a-e78ea532e2ad",
  • "firstPaymentDate": "2019-08-24",
  • "commission": 0,
  • "fees": 0,
  • "feesPaymentMode": "AT_INCEPTION",
  • "description": "string",
  • "externalId": "string",
  • "countrySDGId": "fa126286-c24e-4e8d-b73e-f0ff49eb0aa5",
  • "floatingInterest": {
    },
  • "amortization": {
    },
  • "creditFacilityId": "c7369ee1-04fd-41bb-86b3-50a8a0b0d5c1",
  • "status": "ACCELERATED",
  • "interestBasedOnInitialPrincipal": true,
  • "endOfMonthAdjustment": true,
  • "roundCouponAmount": true
}

Get Loan's All todo

Authorizations:
apikeyScheme
path Parameters
loanId
required
string <uuid>

Responses

Create Loan's Todo

Authorizations:
apikeyScheme
path Parameters
loanId
required
string <uuid>
Request Body schema: application/json
attributeId
string <uuid>
parentId
string <uuid>
preparedReviewerUserId
string <uuid>
checkedReviewerUserId
string <uuid>
preparerUserIds
Array of strings <uuid> unique
reviewerUserIds
Array of strings <uuid> unique
attributeName
string
deadline
string <date>
custom
boolean
active
boolean

Responses

Request samples

Content type
application/json
{
  • "attributeId": "4373db18-af63-40d4-ad40-80a2c734bfcf",
  • "parentId": "70850378-7d3c-4f45-91b7-942d4dfbbd43",
  • "preparedReviewerUserId": "6c34f464-caa9-49e0-8119-24de832af73c",
  • "checkedReviewerUserId": "76d6eeee-d11b-41f4-8e96-562e737f92a8",
  • "preparerUserIds": [
    ],
  • "reviewerUserIds": [
    ],
  • "attributeName": "string",
  • "deadline": "2019-08-24",
  • "custom": true,
  • "active": true
}

Create Loan suspend payment

Authorizations:
apikeyScheme
path Parameters
loanId
required
string <uuid>
Request Body schema: application/json
id
string <uuid>
commissionAccountId
string <uuid>
feeAccountId
string <uuid>
comment
string
object (DocumentMetadata)
startDate
string <date>
endDate
string <date>
feeAmount
number
commissionAmount
number

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "commissionAccountId": "ae6a322d-d28f-4b05-9aae-00550c397cb2",
  • "feeAccountId": "1354d929-c29d-408c-a96b-92c34247a039",
  • "comment": "string",
  • "document": {
    },
  • "startDate": "2019-08-24",
  • "endDate": "2019-08-24",
  • "feeAmount": 0,
  • "commissionAmount": 0
}

Get Loan's Status history

Authorizations:
apikeyScheme
path Parameters
loanId
required
string <uuid>

Responses

Create Loan Status

Authorizations:
apikeyScheme
path Parameters
loanId
required
string <uuid>
Request Body schema: application/json
status
string
Enum: "ACCELERATED" "ANNULLED" "APPROVED" "DISBURSED" "DRAFT" "MATURED" "ENDED" "REJECTED" "TERMINATED_EARLY" "WAITING_FOR_APPROVAL"
comment
string

Responses

Request samples

Content type
application/json
{
  • "status": "ACCELERATED",
  • "comment": "string"
}

Create Loan Send for Approval

Authorizations:
apikeyScheme
path Parameters
loanId
required
string <uuid>
Request Body schema: application/json
email
string
comment
string
skipNotification
boolean

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "comment": "string",
  • "skipNotification": true
}

Get loan's payment schedule

Authorizations:
apikeyScheme
path Parameters
loanId
required
string <uuid>

Responses

Upload custom loan payment schedule

Authorizations:
apikeyScheme
path Parameters
loanId
required
string <uuid>
Request Body schema: application/json
Array of objects (CustomScheduledPayment)

Responses

Request samples

Content type
application/json
{
  • "payments": [
    ]
}

Create Loan Schedule New Payment

Authorizations:
apikeyScheme
path Parameters
loanId
required
string <uuid>
Request Body schema: application/json
id
string <uuid>
comment
string
object (DocumentMetadata)
payDate
string <date>
principalAmount
number
interestAmount
number
commissionAmount
number
feesAmount
number
interestAccountId
string <uuid>
commissionAccountId
string <uuid>
feesAccountId
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "comment": "string",
  • "document": {
    },
  • "payDate": "2019-08-24",
  • "principalAmount": 0,
  • "interestAmount": 0,
  • "commissionAmount": 0,
  • "feesAmount": 0,
  • "interestAccountId": "b45bdf62-08b8-4e13-a427-abd0be30b67f",
  • "commissionAccountId": "ae6a322d-d28f-4b05-9aae-00550c397cb2",
  • "feesAccountId": "4f23f8c6-9340-48fc-be2f-3dfe92f755fb"
}

Get Loan Schedule Change Calculated Parameters

Authorizations:
apikeyScheme
path Parameters
loanId
required
string <uuid>
query Parameters
payDate
required
string <date>

Responses

Create Loan Schedule Change

Authorizations:
apikeyScheme
path Parameters
loanId
required
string <uuid>
Request Body schema: application/json
id
string <uuid>
commissionAccountId
string <uuid>
feeAccountId
string <uuid>
interestAccountId
string <uuid>
comment
string
interestAmount
number
principalAmount
number
commissionAmount
number
feeAmount
number
payDate
string <date>
newMaturityDate
string <date>
object (DocumentUploadRequest)
documentUrl
string
type
string
Enum: "EXTEND_MATURITY" "SCHEDULE_CHANGE"
registerPayment
boolean
approvedImmediately
boolean
interestDeferred
boolean

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "commissionAccountId": "ae6a322d-d28f-4b05-9aae-00550c397cb2",
  • "feeAccountId": "1354d929-c29d-408c-a96b-92c34247a039",
  • "interestAccountId": "b45bdf62-08b8-4e13-a427-abd0be30b67f",
  • "comment": "string",
  • "interestAmount": 0,
  • "principalAmount": 0,
  • "commissionAmount": 0,
  • "feeAmount": 0,
  • "payDate": "2019-08-24",
  • "newMaturityDate": "2019-08-24",
  • "document": {
    },
  • "documentUrl": "string",
  • "type": "EXTEND_MATURITY",
  • "registerPayment": true,
  • "approvedImmediately": true,
  • "interestDeferred": true
}

Validate Loan Schedule Change

Authorizations:
apikeyScheme
path Parameters
loanId
required
string <uuid>
Request Body schema: application/json
id
string <uuid>
commissionAccountId
string <uuid>
feeAccountId
string <uuid>
interestAccountId
string <uuid>
comment
string
interestAmount
number
principalAmount
number
commissionAmount
number
feeAmount
number
payDate
string <date>
newMaturityDate
string <date>
object (DocumentUploadRequest)
documentUrl
string
type
string
Enum: "EXTEND_MATURITY" "SCHEDULE_CHANGE"
registerPayment
boolean
approvedImmediately
boolean
interestDeferred
boolean

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "commissionAccountId": "ae6a322d-d28f-4b05-9aae-00550c397cb2",
  • "feeAccountId": "1354d929-c29d-408c-a96b-92c34247a039",
  • "interestAccountId": "b45bdf62-08b8-4e13-a427-abd0be30b67f",
  • "comment": "string",
  • "interestAmount": 0,
  • "principalAmount": 0,
  • "commissionAmount": 0,
  • "feeAmount": 0,
  • "payDate": "2019-08-24",
  • "newMaturityDate": "2019-08-24",
  • "document": {
    },
  • "documentUrl": "string",
  • "type": "EXTEND_MATURITY",
  • "registerPayment": true,
  • "approvedImmediately": true,
  • "interestDeferred": true
}

Render Loan Schedule Change Template

Authorizations:
apikeyScheme
path Parameters
loanId
required
string <uuid>
templateId
required
string <uuid>
Request Body schema: application/json
id
string <uuid>
commissionAccountId
string <uuid>
feeAccountId
string <uuid>
interestAccountId
string <uuid>
comment
string
interestAmount
number
principalAmount
number
commissionAmount
number
feeAmount
number
payDate
string <date>
newMaturityDate
string <date>
object (DocumentUploadRequest)
documentUrl
string
type
string
Enum: "EXTEND_MATURITY" "SCHEDULE_CHANGE"
registerPayment
boolean
approvedImmediately
boolean
interestDeferred
boolean

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "commissionAccountId": "ae6a322d-d28f-4b05-9aae-00550c397cb2",
  • "feeAccountId": "1354d929-c29d-408c-a96b-92c34247a039",
  • "interestAccountId": "b45bdf62-08b8-4e13-a427-abd0be30b67f",
  • "comment": "string",
  • "interestAmount": 0,
  • "principalAmount": 0,
  • "commissionAmount": 0,
  • "feeAmount": 0,
  • "payDate": "2019-08-24",
  • "newMaturityDate": "2019-08-24",
  • "document": {
    },
  • "documentUrl": "string",
  • "type": "EXTEND_MATURITY",
  • "registerPayment": true,
  • "approvedImmediately": true,
  • "interestDeferred": true
}

Revert Loan Early Termination or Acceleration

Authorizations:
apikeyScheme
path Parameters
loanId
required
string <uuid>

Responses

Render Loan Payout Template

Authorizations:
apikeyScheme
path Parameters
loanId
required
string <uuid>
templateId
required
string <uuid>

Responses

Get Loan Payment in Kind Calculated Parameters

Authorizations:
apikeyScheme
path Parameters
loanId
required
string <uuid>
query Parameters
payDate
required
string <date>

Responses

Create Loan Payment in Kind

Authorizations:
apikeyScheme
path Parameters
loanId
required
string <uuid>
Request Body schema: application/json
id
string <uuid>
commissionAccountId
string <uuid>
feeAccountId
string <uuid>
interestAccountId
string <uuid>
comment
string
interestPaidInCashAmount
number
commissionAmount
number
feeAmount
number
commissionRate
number
feeRate
number
payDate
string <date>
object (DocumentUploadRequest)
documentUrl
string
registerPayment
boolean

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "commissionAccountId": "ae6a322d-d28f-4b05-9aae-00550c397cb2",
  • "feeAccountId": "1354d929-c29d-408c-a96b-92c34247a039",
  • "interestAccountId": "b45bdf62-08b8-4e13-a427-abd0be30b67f",
  • "comment": "string",
  • "interestPaidInCashAmount": 0,
  • "commissionAmount": 0,
  • "feeAmount": 0,
  • "commissionRate": 0,
  • "feeRate": 0,
  • "payDate": "2019-08-24",
  • "document": {
    },
  • "documentUrl": "string",
  • "registerPayment": true
}

Import Loan's Todos

Authorizations:
apikeyScheme
path Parameters
loanId
required
string <uuid>
Request Body schema: application/json
Array of objects (ImportLoanTodoRequest)

Responses

Request samples

Content type
application/json
{
  • "todos": [
    ]
}

Create Loan Contact Document

Authorizations:
apikeyScheme
path Parameters
loanId
required
string <uuid>
Request Body schema: application/json
Array of objects (ImportLoanDocumentRequest)

Responses

Request samples

Content type
application/json
{
  • "documents": [
    ]
}

Create Loan extend maturity

Authorizations:
apikeyScheme
path Parameters
loanId
required
string <uuid>
Request Body schema: application/json
commissionAccountId
string <uuid>
feeAccountId
string <uuid>
comment
string
object (DocumentUploadRequest)
documentUrl
string
payDate
string <date>
feeAmount
number
commissionAmount
number

Responses

Request samples

Content type
application/json
{
  • "commissionAccountId": "ae6a322d-d28f-4b05-9aae-00550c397cb2",
  • "feeAccountId": "1354d929-c29d-408c-a96b-92c34247a039",
  • "comment": "string",
  • "document": {
    },
  • "documentUrl": "string",
  • "payDate": "2019-08-24",
  • "feeAmount": 0,
  • "commissionAmount": 0
}

Get Loan Early Termination Calculated Parameters

Authorizations:
apikeyScheme
path Parameters
loanId
required
string <uuid>
query Parameters
finalPaymentDate
required
string <date>

Responses

Create Loan Early Termination

Authorizations:
apikeyScheme
path Parameters
loanId
required
string <uuid>
Request Body schema: application/json
id
string <uuid>
commissionAccountId
string <uuid>
feeAccountId
string <uuid>
interestAccountId
string <uuid>
comment
string
commissionAmount
number
feeAmount
number
finalPaymentDate
string <date>
object (DocumentUploadRequest)
documentUrl
string
registerPayment
boolean

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "commissionAccountId": "ae6a322d-d28f-4b05-9aae-00550c397cb2",
  • "feeAccountId": "1354d929-c29d-408c-a96b-92c34247a039",
  • "interestAccountId": "b45bdf62-08b8-4e13-a427-abd0be30b67f",
  • "comment": "string",
  • "commissionAmount": 0,
  • "feeAmount": 0,
  • "finalPaymentDate": "2019-08-24",
  • "document": {
    },
  • "documentUrl": "string",
  • "registerPayment": true
}

Validate Loan Early Termination

Authorizations:
apikeyScheme
path Parameters
loanId
required
string <uuid>
Request Body schema: application/json
id
string <uuid>
commissionAccountId
string <uuid>
feeAccountId
string <uuid>
interestAccountId
string <uuid>
comment
string
commissionAmount
number
feeAmount
number
finalPaymentDate
string <date>
object (DocumentUploadRequest)
documentUrl
string
registerPayment
boolean

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "commissionAccountId": "ae6a322d-d28f-4b05-9aae-00550c397cb2",
  • "feeAccountId": "1354d929-c29d-408c-a96b-92c34247a039",
  • "interestAccountId": "b45bdf62-08b8-4e13-a427-abd0be30b67f",
  • "comment": "string",
  • "commissionAmount": 0,
  • "feeAmount": 0,
  • "finalPaymentDate": "2019-08-24",
  • "document": {
    },
  • "documentUrl": "string",
  • "registerPayment": true
}

Render Loan Early Termination Template

Authorizations:
apikeyScheme
path Parameters
loanId
required
string <uuid>
templateId
required
string <uuid>
Request Body schema: application/json
id
string <uuid>
commissionAccountId
string <uuid>
feeAccountId
string <uuid>
interestAccountId
string <uuid>
comment
string
commissionAmount
number
feeAmount
number
finalPaymentDate
string <date>
object (DocumentUploadRequest)
documentUrl
string
registerPayment
boolean

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "commissionAccountId": "ae6a322d-d28f-4b05-9aae-00550c397cb2",
  • "feeAccountId": "1354d929-c29d-408c-a96b-92c34247a039",
  • "interestAccountId": "b45bdf62-08b8-4e13-a427-abd0be30b67f",
  • "comment": "string",
  • "commissionAmount": 0,
  • "feeAmount": 0,
  • "finalPaymentDate": "2019-08-24",
  • "document": {
    },
  • "documentUrl": "string",
  • "registerPayment": true
}

Get Loan Drawdown Calculated Parameters

Authorizations:
apikeyScheme
path Parameters
loanId
required
string <uuid>
query Parameters
payDate
required
string <date>

Responses

Create Loan drawdown

Authorizations:
apikeyScheme
path Parameters
loanId
required
string <uuid>
Request Body schema: application/json
commissionAccountId
string <uuid>
feesAccountId
string <uuid>
interestAccountId
string <uuid>
comment
string
payDate
string <date>
principal
number
commissionAmount
number
fees
number
upfrontInterest
number
object (DocumentUploadRequest)
documentUrl
string

Responses

Request samples

Content type
application/json
{
  • "commissionAccountId": "ae6a322d-d28f-4b05-9aae-00550c397cb2",
  • "feesAccountId": "4f23f8c6-9340-48fc-be2f-3dfe92f755fb",
  • "interestAccountId": "b45bdf62-08b8-4e13-a427-abd0be30b67f",
  • "comment": "string",
  • "payDate": "2019-08-24",
  • "principal": 0,
  • "commissionAmount": 0,
  • "fees": 0,
  • "upfrontInterest": 0,
  • "document": {
    },
  • "documentUrl": "string"
}

Get Loan's All Documents

Authorizations:
apikeyScheme
path Parameters
loanId
required
string <uuid>

Responses

Create Loan Contact Document_1

Authorizations:
apikeyScheme
path Parameters
loanId
required
string <uuid>
Request Body schema: application/json
attributeId
string <uuid>
name
string
content
string
documentUrl
string
comment
string
ownerUserId
string <uuid>
reviewerUserIds
Array of strings <uuid> unique

Responses

Request samples

Content type
application/json
{
  • "attributeId": "4373db18-af63-40d4-ad40-80a2c734bfcf",
  • "name": "string",
  • "content": "string",
  • "documentUrl": "string",
  • "comment": "string",
  • "ownerUserId": "283eeac5-beea-465a-80a5-763009480d0f",
  • "reviewerUserIds": [
    ]
}

Create Loan Document Review

Authorizations:
apikeyScheme
path Parameters
loanId
required
string <uuid>
documentId
required
string <uuid>
Request Body schema: application/json
status
string
Enum: "APPROVED" "REJECTED"
comment
string

Responses

Request samples

Content type
application/json
{
  • "status": "APPROVED",
  • "comment": "string"
}

Get Loan Debt-To-Equity Swap Calculated Parameters

Authorizations:
apikeyScheme
path Parameters
loanId
required
string <uuid>
query Parameters
payDate
required
string <date>

Responses

Create Loan Debt-To-Equity Swap

Authorizations:
apikeyScheme
path Parameters
loanId
required
string <uuid>
Request Body schema: application/json
id
string <uuid>
commissionAccountId
string <uuid>
feeAccountId
string <uuid>
interestAccountId
string <uuid>
instrumentId
string <uuid>
shareClass
string
comment
string
numberOfShares
number
interestPaidInCashAmount
number
principalPaidInCashAmount
number
convertedToEquityAmount
number
conversionPrice
number
commissionAmount
number
feeAmount
number
commissionRate
number
feeRate
number
payDate
string <date>
conversionDate
string <date>
object (DocumentUploadRequest)
documentUrl
string
registerPayment
boolean

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "commissionAccountId": "ae6a322d-d28f-4b05-9aae-00550c397cb2",
  • "feeAccountId": "1354d929-c29d-408c-a96b-92c34247a039",
  • "interestAccountId": "b45bdf62-08b8-4e13-a427-abd0be30b67f",
  • "instrumentId": "48367a03-b541-4ea7-88a6-ae604df75c64",
  • "shareClass": "string",
  • "comment": "string",
  • "numberOfShares": 0,
  • "interestPaidInCashAmount": 0,
  • "principalPaidInCashAmount": 0,
  • "convertedToEquityAmount": 0,
  • "conversionPrice": 0,
  • "commissionAmount": 0,
  • "feeAmount": 0,
  • "commissionRate": 0,
  • "feeRate": 0,
  • "payDate": "2019-08-24",
  • "conversionDate": "2019-08-24",
  • "document": {
    },
  • "documentUrl": "string",
  • "registerPayment": true
}

Get All Loan Covenants

Authorizations:
apikeyScheme
path Parameters
loanId
required
string <uuid>

Responses

Create Loan Covenant

Authorizations:
apikeyScheme
path Parameters
loanId
required
string <uuid>
Request Body schema: application/json
object (AssignExistingCovenantRequest)
object (CovenantRequest)

Responses

Request samples

Content type
application/json
{
  • "existingCovenant": {
    },
  • "newCovenant": {
    }
}

Create Loan Covenant Input

Authorizations:
apikeyScheme
path Parameters
loanId
required
string <uuid>
loanCovenantId
required
string <uuid>
Request Body schema: application/json
value
string
reportingDate
string <date>
object (DocumentUploadRequest)
comment
string

Responses

Request samples

Content type
application/json
{
  • "value": "string",
  • "reportingDate": "2019-08-24",
  • "supportingDocument": {
    },
  • "comment": "string"
}

Get Loan's All Collaterals

Authorizations:
apikeyScheme
path Parameters
loanId
required
string <uuid>

Responses

Create Loan Collateral

Authorizations:
apikeyScheme
path Parameters
loanId
required
string <uuid>
Request Body schema: application/json
instrumentId
string <uuid>
stageId
string <uuid>
validFromDate
string <date>
validUntilDate
string <date>
quantity
number
haircut
number
comment
string
released
boolean

Responses

Request samples

Content type
application/json
{
  • "instrumentId": "48367a03-b541-4ea7-88a6-ae604df75c64",
  • "stageId": "4ac83d66-64fa-48da-9505-57df43404af7",
  • "validFromDate": "2019-08-24",
  • "validUntilDate": "2019-08-24",
  • "quantity": 0,
  • "haircut": 0,
  • "comment": "string",
  • "released": true
}

Release Loan's Collateral

Authorizations:
apikeyScheme
path Parameters
loanId
required
string <uuid>
collateralId
required
string <uuid>
Request Body schema: application/json
changeDate
string <date>
quantity
number
stageId
string <uuid>
comment
string

Responses

Request samples

Content type
application/json
{
  • "changeDate": "2019-08-24",
  • "quantity": 0,
  • "stageId": "4ac83d66-64fa-48da-9505-57df43404af7",
  • "comment": "string"
}

Render Release Loan's Collateral Template

Authorizations:
apikeyScheme
path Parameters
loanId
required
string <uuid>
collateralId
required
string <uuid>
Request Body schema: application/json
changeDate
string <date>
quantity
number
stageId
string <uuid>
comment
string

Responses

Request samples

Content type
application/json
{
  • "changeDate": "2019-08-24",
  • "quantity": 0,
  • "stageId": "4ac83d66-64fa-48da-9505-57df43404af7",
  • "comment": "string"
}

Render Release Loan's Collateral Template_1

Authorizations:
apikeyScheme
path Parameters
loanId
required
string <uuid>
collateralId
required
string <uuid>
templateId
required
string <uuid>
Request Body schema: application/json
changeDate
string <date>
quantity
number
stageId
string <uuid>
comment
string

Responses

Request samples

Content type
application/json
{
  • "changeDate": "2019-08-24",
  • "quantity": 0,
  • "stageId": "4ac83d66-64fa-48da-9505-57df43404af7",
  • "comment": "string"
}

Get Loan's All Collateral Documents

Authorizations:
apikeyScheme
path Parameters
loanId
required
string <uuid>
collateralId
required
string <uuid>

Responses

Create Loan Collateral Document

Authorizations:
apikeyScheme
path Parameters
loanId
required
string <uuid>
collateralId
required
string <uuid>
Request Body schema: application/json
name
string
content
string
comment
string
documentUrl
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "content": "string",
  • "comment": "string",
  • "documentUrl": "string"
}

Get Loan's All Attributes

Authorizations:
apikeyScheme
path Parameters
loanId
required
string <uuid>

Responses

Create Loan's Attribute

Authorizations:
apikeyScheme
path Parameters
loanId
required
string <uuid>
Request Body schema: application/json
attributeId
string <uuid>
value
string
date
string <date>
object (DocumentUploadRequest)

Responses

Request samples

Content type
application/json
{
  • "attributeId": "4373db18-af63-40d4-ad40-80a2c734bfcf",
  • "value": "string",
  • "date": "2019-08-24",
  • "document": {
    }
}

Create Loan acceleration

Authorizations:
apikeyScheme
path Parameters
loanId
required
string <uuid>
Request Body schema: application/json
commissionAccountId
string <uuid>
feeAccountId
string <uuid>
interestAccountId
string <uuid>
comment
string
object (DocumentUploadRequest)
documentUrl
string
finalPaymentDate
string <date>
finalAmount
number
commissionAmount
number
interestAmount
number
feeAmount
number

Responses

Request samples

Content type
application/json
{
  • "commissionAccountId": "ae6a322d-d28f-4b05-9aae-00550c397cb2",
  • "feeAccountId": "1354d929-c29d-408c-a96b-92c34247a039",
  • "interestAccountId": "b45bdf62-08b8-4e13-a427-abd0be30b67f",
  • "comment": "string",
  • "document": {
    },
  • "documentUrl": "string",
  • "finalPaymentDate": "2019-08-24",
  • "finalAmount": 0,
  • "commissionAmount": 0,
  • "interestAmount": 0,
  • "feeAmount": 0
}

Parse loan payment schedule from Excel file

Authorizations:
apikeyScheme
Request Body schema: application/json
content
string

Responses

Request samples

Content type
application/json
{
  • "content": "string"
}

Send a payment reminder

Authorizations:
apikeyScheme
Request Body schema: application/json
counterpartyId
string <uuid>
recipients
Array of strings unique
emailSubject
string
emailBody
string

Responses

Request samples

Content type
application/json
{
  • "counterpartyId": "55bd9d74-f636-4cc8-885a-e78ea532e2ad",
  • "recipients": [
    ],
  • "emailSubject": "string",
  • "emailBody": "string"
}

Parse loans from excel file

Authorizations:
apikeyScheme
Request Body schema: application/json
content
string

Responses

Request samples

Content type
application/json
{
  • "content": "string"
}

Import Loans

Authorizations:
apikeyScheme
Request Body schema: application/json
Array of objects (LoanRequest)

Responses

Request samples

Content type
application/json
{
  • "loans": [
    ]
}

Parse loan payment schedule from Excel file_1

Authorizations:
apikeyScheme
Request Body schema: application/json
content
string

Responses

Request samples

Content type
application/json
{
  • "content": "string"
}

Create Loan Contact Document_2

Authorizations:
apikeyScheme
path Parameters
creditFacilityId
required
string <uuid>
Request Body schema: application/json
Array of objects (ImportLoanDocumentRequest)

Responses

Request samples

Content type
application/json
{
  • "documents": [
    ]
}

Get Credit Facility Renewal Calculated Parameters

Authorizations:
apikeyScheme
path Parameters
creditFacilityId
required
string <uuid>
query Parameters
scheduleDate
required
string <date>

Responses

Get the Loan's Counterparty snapshot

Authorizations:
apikeyScheme
path Parameters
loanId
required
string <uuid>

Responses

Get the Loan's snapshot

Authorizations:
apikeyScheme
path Parameters
loanId
required
string <uuid>
query Parameters
date
string <date>

Responses

Get Loan's Document

Authorizations:
apikeyScheme
path Parameters
loanId
required
string <uuid>
documentId
required
string <uuid>

Responses

Get Loan Covenant Input by Loan ID

Authorizations:
apikeyScheme
path Parameters
loanId
required
string <uuid>
covenantId
required
string <uuid>
inputId
required
string <uuid>

Responses

Get Loan Covenant Input's Document

Authorizations:
apikeyScheme
path Parameters
loanId
required
string <uuid>
covenantId
required
string <uuid>
inputId
required
string <uuid>
documentId
required
string <uuid>

Responses

Get All Loan Covenants Inputs by Loan ID

Authorizations:
apikeyScheme
path Parameters
loanId
required
string <uuid>

Responses

Get Loan's Collateral Document

Authorizations:
apikeyScheme
path Parameters
loanId
required
string <uuid>
collateralId
required
string <uuid>
documentId
required
string <uuid>

Responses

Get Loan's Balance on Date

Authorizations:
apikeyScheme
path Parameters
loanId
required
string <uuid>
date
required
string <date>

Responses

Get Loan's Attribute

Authorizations:
apikeyScheme
path Parameters
loanId
required
string <uuid>
attributeId
required
string <uuid>

Responses

Get Loan Covenant Input's Document_1

Authorizations:
apikeyScheme
path Parameters
loanId
required
string <uuid>
attributeId
required
string <uuid>
documentId
required
string <uuid>

Responses

Get Loan's Allowed Actions

Authorizations:
apikeyScheme
path Parameters
loanId
required
string <uuid>

Responses

export

Authorizations:
apikeyScheme

Responses

Get All Documents

Authorizations:
apikeyScheme

Responses

Get All Collaterals

Authorizations:
apikeyScheme
query Parameters
reportDate
string <date>
reportCurrencyId
string <uuid>
portfolioIds
Array of strings <uuid> unique

Responses

Get Covenant Inputs

Authorizations:
apikeyScheme
path Parameters
covenantId
required
string <uuid>

Responses

Interest rates

Update interest rate value on selected date

Authorizations:
apikeyScheme
path Parameters
interestRateId
required
string <uuid>
date
required
string <date>
Request Body schema: application/json
rate
number

Responses

Request samples

Content type
application/json
{
  • "rate": 0
}

Get a List of Interest Rates

Authorizations:
apikeyScheme

Responses

Create a new interest rate

Authorizations:
apikeyScheme
Request Body schema: application/json
description
string
date
string <date>
rate
number

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "date": "2019-08-24",
  • "rate": 0
}

Parse interest rates from Excel file

Authorizations:
apikeyScheme
Request Body schema: application/json
content
string

Responses

Request samples

Content type
application/json
{
  • "content": "string"
}

Create or update interest rate values on selected date

Authorizations:
apikeyScheme
Request Body schema: application/json
interestRateId
string <uuid>
description
string
Array of objects (InterestRatePriceRequest)

Responses

Request samples

Content type
application/json
{
  • "interestRateId": "2c5c2feb-c82b-4392-a441-25df7fa314f2",
  • "description": "string",
  • "rates": [
    ]
}

Import interest rates

Authorizations:
apikeyScheme
Request Body schema: application/json
Array
date
string <date>
rate
number

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Get Interest Rate Price

Authorizations:
apikeyScheme
path Parameters
type
required
string
Enum: "MANUAL" "EURIBOR_1W" "EURIBOR_1M" "EURIBOR_3M" "EURIBOR_6M" "EURIBOR_12M" "SOFR" "SONIA"
date
required
string <date>

Responses

Get a List of Interest Rates with Prices

Authorizations:
apikeyScheme

Responses

Dashboards

Get Dashboard

Authorizations:
apikeyScheme
path Parameters
dashboardId
required
string <uuid>

Responses

Update Dashboard

Authorizations:
apikeyScheme
path Parameters
dashboardId
required
string <uuid>
Request Body schema: application/json
name
string
content
string
description
string
state
string
Enum: "ME" "TEAM"
publishStatus
string
Enum: "HIDDEN" "VISIBLE"

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "content": "string",
  • "description": "string",
  • "state": "ME",
  • "publishStatus": "HIDDEN"
}

Delete Dashboard

Authorizations:
apikeyScheme
path Parameters
dashboardId
required
string <uuid>

Responses

Get Shared User for Dashboard

Authorizations:
apikeyScheme
path Parameters
dashboardId
required
string <uuid>
userId
required
string <uuid>

Responses

Update User Share for Dashboard

Authorizations:
apikeyScheme
path Parameters
dashboardId
required
string <uuid>
userId
required
string <uuid>
Request Body schema: application/json
accessLevel
string
Enum: "OWNER" "CAN_EDIT" "READ_ONLY"

Responses

Request samples

Content type
application/json
{
  • "accessLevel": "OWNER"
}

Remove User from Dashboard

Authorizations:
apikeyScheme
path Parameters
dashboardId
required
string <uuid>
userId
required
string <uuid>

Responses

Get All Dashboards

Authorizations:
apikeyScheme

Responses

Create Dashboard

Authorizations:
apikeyScheme
Request Body schema: application/json
name
string
content
string
description
string
state
string
Enum: "ME" "TEAM"
publishStatus
string
Enum: "HIDDEN" "VISIBLE"

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "content": "string",
  • "description": "string",
  • "state": "ME",
  • "publishStatus": "HIDDEN"
}

Get All Shared Users for Dashboard

Authorizations:
apikeyScheme
path Parameters
dashboardId
required
string <uuid>

Responses

Invite User to Dashboard

Authorizations:
apikeyScheme
path Parameters
dashboardId
required
string <uuid>
Request Body schema: application/json
email
string
accessLevel
string
Enum: "OWNER" "CAN_EDIT" "READ_ONLY"

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "accessLevel": "OWNER"
}

Get Dashboard Report Data

Authorizations:
apikeyScheme
path Parameters
dashboardId
required
string <uuid>
Request Body schema: application/json
object (GlobalFilters)
Array of objects (ItemOptions)

Responses

Request samples

Content type
application/json
{
  • "globalFilters": {
    },
  • "items": [
    ]
}

Get Dashboard Report Preview

Authorizations:
apikeyScheme
Request Body schema: application/json
aggregatedByAttributeId
string <uuid>
aggregationOperation
string
Enum: "COUNT" "SUM" "AVERAGE" "NONE"
sumBy
string
Enum: "LOAN_CONTRACT_DATE" "LOAN_MATURITY_DATE" "LOAN_INTEREST_RATE" "LOAN_INITIAL_PRINCIPAL" "LOAN_REMAINING_PRINCIPAL" "LOAN_STATUS" "ATTRIBUTE_DATE" "COUNT"
object (Operand)
object (Operand)
object (Operand)
object (Operand)

Responses

Request samples

Content type
application/json
{
  • "aggregatedByAttributeId": "dcaa8396-25a6-4657-85b9-eba90f2fe547",
  • "aggregationOperation": "COUNT",
  • "sumBy": "LOAN_CONTRACT_DATE",
  • "xAxis": {
    },
  • "yAxis": {
    },
  • "xaxis": {
    },
  • "yaxis": {
    }
}

Get Dashboard Filter Options

Authorizations:
apikeyScheme
path Parameters
dashboardId
required
string <uuid>

Responses

Credit Facilities

Get Credit Facility

Authorizations:
apikeyScheme
path Parameters
creditFacilityId
required
string <uuid>

Responses

Update Credit Facility

Authorizations:
apikeyScheme
path Parameters
creditFacilityId
required
string <uuid>
Request Body schema: application/json
commitmentFeeRate
number
transactionFeeAmount
number
upfrontFeeRate
number
utilizationFeeRate
number
collateralLevel
string
Enum: "LOAN" "CREDIT_FACILITY" "LOAN_AND_CREDIT_FACILITY"
facilityFeeRate
number
limitAmount
number
tradeType
string
Enum: "LEND" "BORROW"
paymentFrequency
string
Enum: "MONTHLY" "QUARTERLY" "SEMIANNUALLY" "YEARLY" "AT_MATURITY"
payDateRollConv
string
Enum: "NONE" "FOLLOWING" "MODIFIED_FOLLOWING" "PREVIOUS"
dayCount
string
Enum: "ACT360" "ACT365" "ACTACTAFB" "ACTACTISDA" "E30360" "BOND30360" "ISDA30360"
maturityDate
string <date>
tradeDate
string <date>
valueDate
string <date>
portfolioId
string <uuid>
counterpartyId
string <uuid>
currencyId
string <uuid>
cashAccountId
string <uuid>
firstPaymentDate
string <date>
penaltyRate
number
description
string
countrySDGId
string <uuid>
revolving
boolean
endOfMonthAdjustment
boolean
roundCouponAmount
boolean

Responses

Request samples

Content type
application/json
{
  • "commitmentFeeRate": 0,
  • "transactionFeeAmount": 0,
  • "upfrontFeeRate": 0,
  • "utilizationFeeRate": 0,
  • "collateralLevel": "LOAN",
  • "facilityFeeRate": 0,
  • "limitAmount": 0,
  • "tradeType": "LEND",
  • "paymentFrequency": "MONTHLY",
  • "payDateRollConv": "NONE",
  • "dayCount": "ACT360",
  • "maturityDate": "2019-08-24",
  • "tradeDate": "2019-08-24",
  • "valueDate": "2019-08-24",
  • "portfolioId": "2a9b0ad6-e5de-4239-a282-527c92c7c0f1",
  • "counterpartyId": "55bd9d74-f636-4cc8-885a-e78ea532e2ad",
  • "currencyId": "2a59a322-927b-4fc7-bac8-d295c634b295",
  • "cashAccountId": "6affaff6-e8a8-4587-b0ba-439af8fc3538",
  • "firstPaymentDate": "2019-08-24",
  • "penaltyRate": 0,
  • "description": "string",
  • "countrySDGId": "fa126286-c24e-4e8d-b73e-f0ff49eb0aa5",
  • "revolving": true,
  • "endOfMonthAdjustment": true,
  • "roundCouponAmount": true
}

Delete Credit Facility

Authorizations:
apikeyScheme
path Parameters
creditFacilityId
required
string <uuid>

Responses

Get Credit Facility's Todo

Authorizations:
apikeyScheme
path Parameters
creditFacilityId
required
string <uuid>
todoId
required
string <uuid>

Responses

Update Credit Facility's Todo

Authorizations:
apikeyScheme
path Parameters
creditFacilityId
required
string <uuid>
todoId
required
string <uuid>
Request Body schema: application/json
attributeId
string <uuid>
parentId
string <uuid>
preparedReviewerUserId
string <uuid>
checkedReviewerUserId
string <uuid>
preparerUserIds
Array of strings <uuid> unique
reviewerUserIds
Array of strings <uuid> unique
attributeName
string
deadline
string <date>
custom
boolean
active
boolean

Responses

Request samples

Content type
application/json
{
  • "attributeId": "4373db18-af63-40d4-ad40-80a2c734bfcf",
  • "parentId": "70850378-7d3c-4f45-91b7-942d4dfbbd43",
  • "preparedReviewerUserId": "6c34f464-caa9-49e0-8119-24de832af73c",
  • "checkedReviewerUserId": "76d6eeee-d11b-41f4-8e96-562e737f92a8",
  • "preparerUserIds": [
    ],
  • "reviewerUserIds": [
    ],
  • "attributeName": "string",
  • "deadline": "2019-08-24",
  • "custom": true,
  • "active": true
}

Delete Credit Facility's Todo

Authorizations:
apikeyScheme
path Parameters
creditFacilityId
required
string <uuid>
todoId
required
string <uuid>

Responses

Review Credit Facility's Todo

Authorizations:
apikeyScheme
path Parameters
creditFacilityId
required
string <uuid>
todoId
required
string <uuid>
Request Body schema: application/json
preparedReviewerUserId
string <uuid>
checkedReviewerUserId
string <uuid>
deadline
string <date>
active
boolean

Responses

Request samples

Content type
application/json
{
  • "preparedReviewerUserId": "6c34f464-caa9-49e0-8119-24de832af73c",
  • "checkedReviewerUserId": "76d6eeee-d11b-41f4-8e96-562e737f92a8",
  • "deadline": "2019-08-24",
  • "active": true
}

Update Credit Facility Contact Document

Authorizations:
apikeyScheme
path Parameters
creditFacilityId
required
string <uuid>
loanDocumentId
required
string <uuid>
Request Body schema: application/json
attributeId
string <uuid>
name
string
content
string
documentUrl
string
comment
string
ownerUserId
string <uuid>
reviewerUserIds
Array of strings <uuid> unique

Responses

Request samples

Content type
application/json
{
  • "attributeId": "4373db18-af63-40d4-ad40-80a2c734bfcf",
  • "name": "string",
  • "content": "string",
  • "documentUrl": "string",
  • "comment": "string",
  • "ownerUserId": "283eeac5-beea-465a-80a5-763009480d0f",
  • "reviewerUserIds": [
    ]
}

Get Credit Facility Covenant

Authorizations:
apikeyScheme
path Parameters
creditFacilityId
required
string <uuid>
covenantId
required
string <uuid>

Responses

Update Loan Covenant_1

Authorizations:
apikeyScheme
path Parameters
creditFacilityId
required
string <uuid>
covenantId
required
string <uuid>
Request Body schema: application/json
name
string
reportingEntity
string
Enum: "BORROWER" "LENDER"
frequency
string
Enum: "ON_DRAWDOWN" "MONTHLY" "BIMONTHLY" "QUARTERLY" "SEMIANNUALLY" "YEARLY"
deadline
string
Enum: "ONE_WEEK" "TWO_WEEKS" "ONE_MONTH" "TWO_MONTHS"
firstKPIDate
string <date>
object (Condition)
changeDate
string <date>
supportingDocumentRequired
boolean

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "reportingEntity": "BORROWER",
  • "frequency": "ON_DRAWDOWN",
  • "deadline": "ONE_WEEK",
  • "firstKPIDate": "2019-08-24",
  • "condition": {
    },
  • "changeDate": "2019-08-24",
  • "supportingDocumentRequired": true
}

Delete Credit Facility Covenant

Authorizations:
apikeyScheme
path Parameters
creditFacilityId
required
string <uuid>
covenantId
required
string <uuid>

Responses

Get Credit Facility's Collateral

Authorizations:
apikeyScheme
path Parameters
creditFacilityId
required
string <uuid>
collateralId
required
string <uuid>

Responses

Update Credit Facility's Collateral

Authorizations:
apikeyScheme
path Parameters
creditFacilityId
required
string <uuid>
collateralId
required
string <uuid>
Request Body schema: application/json
instrumentId
string <uuid>
stageId
string <uuid>
validFromDate
string <date>
validUntilDate
string <date>
quantity
number
haircut
number
comment
string
released
boolean

Responses

Request samples

Content type
application/json
{
  • "instrumentId": "48367a03-b541-4ea7-88a6-ae604df75c64",
  • "stageId": "4ac83d66-64fa-48da-9505-57df43404af7",
  • "validFromDate": "2019-08-24",
  • "validUntilDate": "2019-08-24",
  • "quantity": 0,
  • "haircut": 0,
  • "comment": "string",
  • "released": true
}

Update Credit Facility's Collateral Stages

Authorizations:
apikeyScheme
path Parameters
creditFacilityId
required
string <uuid>
collateralId
required
string <uuid>
Request Body schema: application/json
changeDate
string <date>
Array of objects (CreditFacilityCollateralRequest)

Responses

Request samples

Content type
application/json
{
  • "changeDate": "2019-08-24",
  • "stages": [
    ]
}

Delete Credit Facility's Collateral

Authorizations:
apikeyScheme
path Parameters
creditFacilityId
required
string <uuid>
collateralId
required
string <uuid>

Responses

Get All CreditFacilities

Authorizations:
apikeyScheme

Responses

Create Credit Facility

Authorizations:
apikeyScheme
Request Body schema: application/json
commitmentFeeRate
number
transactionFeeAmount
number
upfrontFeeRate
number
utilizationFeeRate
number
collateralLevel
string
Enum: "LOAN" "CREDIT_FACILITY" "LOAN_AND_CREDIT_FACILITY"
facilityFeeRate
number
limitAmount
number
tradeType
string
Enum: "LEND" "BORROW"
paymentFrequency
string
Enum: "MONTHLY" "QUARTERLY" "SEMIANNUALLY" "YEARLY" "AT_MATURITY"
payDateRollConv
string
Enum: "NONE" "FOLLOWING" "MODIFIED_FOLLOWING" "PREVIOUS"
dayCount
string
Enum: "ACT360" "ACT365" "ACTACTAFB" "ACTACTISDA" "E30360" "BOND30360" "ISDA30360"
maturityDate
string <date>
tradeDate
string <date>
valueDate
string <date>
portfolioId
string <uuid>
counterpartyId
string <uuid>
currencyId
string <uuid>
cashAccountId
string <uuid>
firstPaymentDate
string <date>
penaltyRate
number
description
string
countrySDGId
string <uuid>
revolving
boolean
endOfMonthAdjustment
boolean
roundCouponAmount
boolean

Responses

Request samples

Content type
application/json
{
  • "commitmentFeeRate": 0,
  • "transactionFeeAmount": 0,
  • "upfrontFeeRate": 0,
  • "utilizationFeeRate": 0,
  • "collateralLevel": "LOAN",
  • "facilityFeeRate": 0,
  • "limitAmount": 0,
  • "tradeType": "LEND",
  • "paymentFrequency": "MONTHLY",
  • "payDateRollConv": "NONE",
  • "dayCount": "ACT360",
  • "maturityDate": "2019-08-24",
  • "tradeDate": "2019-08-24",
  • "valueDate": "2019-08-24",
  • "portfolioId": "2a9b0ad6-e5de-4239-a282-527c92c7c0f1",
  • "counterpartyId": "55bd9d74-f636-4cc8-885a-e78ea532e2ad",
  • "currencyId": "2a59a322-927b-4fc7-bac8-d295c634b295",
  • "cashAccountId": "6affaff6-e8a8-4587-b0ba-439af8fc3538",
  • "firstPaymentDate": "2019-08-24",
  • "penaltyRate": 0,
  • "description": "string",
  • "countrySDGId": "fa126286-c24e-4e8d-b73e-f0ff49eb0aa5",
  • "revolving": true,
  • "endOfMonthAdjustment": true,
  • "roundCouponAmount": true
}

Get Credit Facility's All Todos

Authorizations:
apikeyScheme
path Parameters
creditFacilityId
required
string <uuid>

Responses

Create Credit Facility's Todo

Authorizations:
apikeyScheme
path Parameters
creditFacilityId
required
string <uuid>
Request Body schema: application/json
attributeId
string <uuid>
parentId
string <uuid>
preparedReviewerUserId
string <uuid>
checkedReviewerUserId
string <uuid>
preparerUserIds
Array of strings <uuid> unique
reviewerUserIds
Array of strings <uuid> unique
attributeName
string
deadline
string <date>
custom
boolean
active
boolean

Responses

Request samples

Content type
application/json
{
  • "attributeId": "4373db18-af63-40d4-ad40-80a2c734bfcf",
  • "parentId": "70850378-7d3c-4f45-91b7-942d4dfbbd43",
  • "preparedReviewerUserId": "6c34f464-caa9-49e0-8119-24de832af73c",
  • "checkedReviewerUserId": "76d6eeee-d11b-41f4-8e96-562e737f92a8",
  • "preparerUserIds": [
    ],
  • "reviewerUserIds": [
    ],
  • "attributeName": "string",
  • "deadline": "2019-08-24",
  • "custom": true,
  • "active": true
}

Get Credit Facility's Status history

Authorizations:
apikeyScheme
path Parameters
creditFacilityId
required
string <uuid>

Responses

Create Credit Facility Status

Authorizations:
apikeyScheme
path Parameters
creditFacilityId
required
string <uuid>
Request Body schema: application/json
status
string
Enum: "ACCELERATED" "ANNULLED" "APPROVED" "DISBURSED" "DRAFT" "MATURED" "ENDED" "REJECTED" "TERMINATED_EARLY" "WAITING_FOR_APPROVAL"
comment
string

Responses

Request samples

Content type
application/json
{
  • "status": "ACCELERATED",
  • "comment": "string"
}

Create Credit Facility Send for Approval

Authorizations:
apikeyScheme
path Parameters
creditFacilityId
required
string <uuid>
Request Body schema: application/json
email
string
comment
string
skipNotification
boolean

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "comment": "string",
  • "skipNotification": true
}

Import Credit Facility's Todos

Authorizations:
apikeyScheme
path Parameters
creditFacilityId
required
string <uuid>
Request Body schema: application/json
Array of objects (ImportLoanTodoRequest)

Responses

Request samples

Content type
application/json
{
  • "todos": [
    ]
}

Renew Credit Facility

Authorizations:
apikeyScheme
path Parameters
creditFacilityId
required
string <uuid>
Request Body schema: application/json
id
string <uuid>
commissionAccountId
string <uuid>
feeAccountId
string <uuid>
comment
string
object (DocumentUploadRequest)
documentUrl
string
scheduleDate
string <date>
newMaturityDate
string <date>
newLimitAmount
number
feeAmount
number
commissionAmount
number
newFacilityFeeRate
number
newUpfrontFeeRate
number
newUtilizationFeeRate
number
newCommitmentFeeRate
number
newPenaltyRate
number
accruedFacilityFeeAmount
number
accruedCommitmentFeeAmount
number

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "commissionAccountId": "ae6a322d-d28f-4b05-9aae-00550c397cb2",
  • "feeAccountId": "1354d929-c29d-408c-a96b-92c34247a039",
  • "comment": "string",
  • "document": {
    },
  • "documentUrl": "string",
  • "scheduleDate": "2019-08-24",
  • "newMaturityDate": "2019-08-24",
  • "newLimitAmount": 0,
  • "feeAmount": 0,
  • "commissionAmount": 0,
  • "newFacilityFeeRate": 0,
  • "newUpfrontFeeRate": 0,
  • "newUtilizationFeeRate": 0,
  • "newCommitmentFeeRate": 0,
  • "newPenaltyRate": 0,
  • "accruedFacilityFeeAmount": 0,
  • "accruedCommitmentFeeAmount": 0
}

Get Credit Facility's All Documents

Authorizations:
apikeyScheme
path Parameters
creditFacilityId
required
string <uuid>

Responses

Create Credit Facility Contact Document

Authorizations:
apikeyScheme
path Parameters
creditFacilityId
required
string <uuid>
Request Body schema: application/json
attributeId
string <uuid>
name
string
content
string
documentUrl
string
comment
string
ownerUserId
string <uuid>
reviewerUserIds
Array of strings <uuid> unique

Responses

Request samples

Content type
application/json
{
  • "attributeId": "4373db18-af63-40d4-ad40-80a2c734bfcf",
  • "name": "string",
  • "content": "string",
  • "documentUrl": "string",
  • "comment": "string",
  • "ownerUserId": "283eeac5-beea-465a-80a5-763009480d0f",
  • "reviewerUserIds": [
    ]
}

Create Credit Facility Document Review

Authorizations:
apikeyScheme
path Parameters
creditFacilityId
required
string <uuid>
documentId
required
string <uuid>
Request Body schema: application/json
status
string
Enum: "APPROVED" "REJECTED"
comment
string

Responses

Request samples

Content type
application/json
{
  • "status": "APPROVED",
  • "comment": "string"
}

Get All Credit Facility Covenants

Authorizations:
apikeyScheme
path Parameters
creditFacilityId
required
string <uuid>

Responses

Create Credit Facility Covenant

Authorizations:
apikeyScheme
path Parameters
creditFacilityId
required
string <uuid>
Request Body schema: application/json
object (AssignExistingCovenantRequest)
object (CovenantRequest)

Responses

Request samples

Content type
application/json
{
  • "existingCovenant": {
    },
  • "newCovenant": {
    }
}

Create Credit Facility Covenant Input

Authorizations:
apikeyScheme
path Parameters
creditFacilityId
required
string <uuid>
loanCovenantId
required
string <uuid>
Request Body schema: application/json
value
string
reportingDate
string <date>
object (DocumentUploadRequest)
comment
string

Responses

Request samples

Content type
application/json
{
  • "value": "string",
  • "reportingDate": "2019-08-24",
  • "supportingDocument": {
    },
  • "comment": "string"
}

Get Credit Facility's All Collaterals

Authorizations:
apikeyScheme
path Parameters
creditFacilityId
required
string <uuid>

Responses

Create Credit Facility Collateral

Authorizations:
apikeyScheme
path Parameters
creditFacilityId
required
string <uuid>
Request Body schema: application/json
instrumentId
string <uuid>
stageId
string <uuid>
validFromDate
string <date>
validUntilDate
string <date>
quantity
number
haircut
number
comment
string
released
boolean

Responses

Request samples

Content type
application/json
{
  • "instrumentId": "48367a03-b541-4ea7-88a6-ae604df75c64",
  • "stageId": "4ac83d66-64fa-48da-9505-57df43404af7",
  • "validFromDate": "2019-08-24",
  • "validUntilDate": "2019-08-24",
  • "quantity": 0,
  • "haircut": 0,
  • "comment": "string",
  • "released": true
}

Release Credit Facility's Collateral

Authorizations:
apikeyScheme
path Parameters
creditFacilityId
required
string <uuid>
collateralId
required
string <uuid>
Request Body schema: application/json
changeDate
string <date>
quantity
number
stageId
string <uuid>
comment
string

Responses

Request samples

Content type
application/json
{
  • "changeDate": "2019-08-24",
  • "quantity": 0,
  • "stageId": "4ac83d66-64fa-48da-9505-57df43404af7",
  • "comment": "string"
}

Validate Release Credit Facility's Collateral

Authorizations:
apikeyScheme
path Parameters
creditFacilityId
required
string <uuid>
collateralId
required
string <uuid>
Request Body schema: application/json
changeDate
string <date>
quantity
number
stageId
string <uuid>
comment
string

Responses

Request samples

Content type
application/json
{
  • "changeDate": "2019-08-24",
  • "quantity": 0,
  • "stageId": "4ac83d66-64fa-48da-9505-57df43404af7",
  • "comment": "string"
}

Render Release Credit Facility's Collateral Template

Authorizations:
apikeyScheme
path Parameters
creditFacilityId
required
string <uuid>
collateralId
required
string <uuid>
templateId
required
string <uuid>
Request Body schema: application/json
changeDate
string <date>
quantity
number
stageId
string <uuid>
comment
string

Responses

Request samples

Content type
application/json
{
  • "changeDate": "2019-08-24",
  • "quantity": 0,
  • "stageId": "4ac83d66-64fa-48da-9505-57df43404af7",
  • "comment": "string"
}

Get Credit Facility's All Collateral Documents

Authorizations:
apikeyScheme
path Parameters
creditFacilityId
required
string <uuid>
collateralId
required
string <uuid>

Responses

Create Credit Facility Collateral Document

Authorizations:
apikeyScheme
path Parameters
creditFacilityId
required
string <uuid>
collateralId
required
string <uuid>
Request Body schema: application/json
name
string
content
string
comment
string
documentUrl
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "content": "string",
  • "comment": "string",
  • "documentUrl": "string"
}

Get Loan's Change history

Authorizations:
apikeyScheme
path Parameters
loanId
required
string <uuid>

Responses

Get credit facility schedule

Authorizations:
apikeyScheme
path Parameters
creditFacilityId
required
string <uuid>

Responses

Get Credit Facility's Change history

Authorizations:
apikeyScheme
path Parameters
creditFacilityId
required
string <uuid>

Responses

Get Credit Facility's Document

Authorizations:
apikeyScheme
path Parameters
creditFacilityId
required
string <uuid>
documentId
required
string <uuid>

Responses

Delete Credit Facility's Single Document

Authorizations:
apikeyScheme
path Parameters
creditFacilityId
required
string <uuid>
documentId
required
string <uuid>

Responses

Get Credit Facility Covenant Input by Credit Facility ID

Authorizations:
apikeyScheme
path Parameters
creditFacilityId
required
string <uuid>
covenantId
required
string <uuid>
inputId
required
string <uuid>

Responses

Get Credit Facility Covenant Input's Document

Authorizations:
apikeyScheme
path Parameters
creditFacilityId
required
string <uuid>
covenantId
required
string <uuid>
inputId
required
string <uuid>
documentId
required
string <uuid>

Responses

Get All Credit Facility Covenants Inputs by Loan ID

Authorizations:
apikeyScheme
path Parameters
creditFacilityId
required
string <uuid>

Responses

Get Credit Facility's Collateral Document

Authorizations:
apikeyScheme
path Parameters
creditFacilityId
required
string <uuid>
collateralId
required
string <uuid>
documentId
required
string <uuid>

Responses

Get Credit Facility's Allowed Actions

Authorizations:
apikeyScheme
path Parameters
creditFacilityId
required
string <uuid>

Responses

Covenants

Get Covenant

Authorizations:
apikeyScheme
path Parameters
covenantId
required
string <uuid>

Responses

Update Covenant

Authorizations:
apikeyScheme
path Parameters
covenantId
required
string <uuid>
Request Body schema: application/json
name
string
reportingEntity
string
Enum: "BORROWER" "LENDER"
frequency
string
Enum: "ON_DRAWDOWN" "MONTHLY" "BIMONTHLY" "QUARTERLY" "SEMIANNUALLY" "YEARLY"
deadline
string
Enum: "ONE_WEEK" "TWO_WEEKS" "ONE_MONTH" "TWO_MONTHS"
firstKPIDate
string <date>
object (Condition)
changeDate
string <date>
supportingDocumentRequired
boolean

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "reportingEntity": "BORROWER",
  • "frequency": "ON_DRAWDOWN",
  • "deadline": "ONE_WEEK",
  • "firstKPIDate": "2019-08-24",
  • "condition": {
    },
  • "changeDate": "2019-08-24",
  • "supportingDocumentRequired": true
}

Delete Covenant

Authorizations:
apikeyScheme
path Parameters
covenantId
required
string <uuid>

Responses

Get All Covenants

Authorizations:
apikeyScheme

Responses

Create Covenant

Authorizations:
apikeyScheme
Request Body schema: application/json
name
string
reportingEntity
string
Enum: "BORROWER" "LENDER"
frequency
string
Enum: "ON_DRAWDOWN" "MONTHLY" "BIMONTHLY" "QUARTERLY" "SEMIANNUALLY" "YEARLY"
deadline
string
Enum: "ONE_WEEK" "TWO_WEEKS" "ONE_MONTH" "TWO_MONTHS"
firstKPIDate
string <date>
object (Condition)
changeDate
string <date>
supportingDocumentRequired
boolean

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "reportingEntity": "BORROWER",
  • "frequency": "ON_DRAWDOWN",
  • "deadline": "ONE_WEEK",
  • "firstKPIDate": "2019-08-24",
  • "condition": {
    },
  • "changeDate": "2019-08-24",
  • "supportingDocumentRequired": true
}

Get All Loan Covenants_1

Authorizations:
apikeyScheme
query Parameters
reportDate
string <date>

Responses

Counterparties

Get Counterparty

Authorizations:
apikeyScheme
path Parameters
counterpartyId
required
string <uuid>

Responses

Update Counterparty

Authorizations:
apikeyScheme
path Parameters
counterpartyId
required
string <uuid>
Request Body schema: application/json
name
string
countryId
string <uuid>
referenceNumber
string
address
string
email
string
phoneNumber
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "countryId": "bd2b151e-bbbf-43a3-8058-286e653dfac0",
  • "referenceNumber": "string",
  • "address": "string",
  • "email": "string",
  • "phoneNumber": "string"
}

Delete Counterparty

Authorizations:
apikeyScheme
path Parameters
counterpartyId
required
string <uuid>

Responses

Get All Counterparties

Authorizations:
apikeyScheme

Responses

Create Counterparty

Authorizations:
apikeyScheme
Request Body schema: application/json
name
string
countryId
string <uuid>
referenceNumber
string
address
string
email
string
phoneNumber
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "countryId": "bd2b151e-bbbf-43a3-8058-286e653dfac0",
  • "referenceNumber": "string",
  • "address": "string",
  • "email": "string",
  • "phoneNumber": "string"
}

Get Counterparty's Change history

Authorizations:
apikeyScheme
path Parameters
counterpartyId
required
string <uuid>

Responses

Get Counterparty communications

Authorizations:
apikeyScheme
path Parameters
counterpartyId
required
string <uuid>

Responses

Attributes

Get Attribute

Authorizations:
apikeyScheme
path Parameters
attributeId
required
string <uuid>

Responses

Update Attribute

Authorizations:
apikeyScheme
path Parameters
attributeId
required
string <uuid>
Request Body schema: application/json
name
string
formula
string
type
string
Enum: "NUMBER" "DOCUMENT" "RANGE" "BOOLEAN" "DATE" "LIST" "FORMULA"
unit
string
Enum: "NONE" "UNITS" "BARRELS" "BUSHELS" "POUNDS" "SHORT_TONS" "HUNDREDWEIGHTS" "GALLONS" "US_GALLONS" "TROY_OUNCES" "KILOGRAMS" "METRIC_TONS" "SQUARE_METERS" "DAYS" "MONTHS" "YEARS" "SMALL_INPUT"
usage
string
Enum: "COLLATERAL_STAGES" "COVENANTS" "DOCUMENT_TYPES" "TODO_LISTS" "LOAN_ATTRIBUTES"
rangeFrom
number
rangeTo
number
listTypeId
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "formula": "string",
  • "type": "NUMBER",
  • "unit": "NONE",
  • "usage": "COLLATERAL_STAGES",
  • "rangeFrom": 0,
  • "rangeTo": 0,
  • "listTypeId": "593ac350-090f-422d-8c72-08b28c9f7d8f"
}

Delete Attribute

Authorizations:
apikeyScheme
path Parameters
attributeId
required
string <uuid>

Responses

Get Attribute List Type

Authorizations:
apikeyScheme
path Parameters
attributeId
required
string <uuid>

Responses

Update Attribute of List Type

Authorizations:
apikeyScheme
path Parameters
attributeId
required
string <uuid>
Request Body schema: application/json
name
string

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Delete Attribute of List Type

Authorizations:
apikeyScheme
path Parameters
attributeId
required
string <uuid>

Responses

Get All Attributes

Authorizations:
apikeyScheme

Responses

Create Attribute

Authorizations:
apikeyScheme
Request Body schema: application/json
parentId
string <uuid>
object (CloneFrom)
name
string
type
string
Enum: "NUMBER" "DOCUMENT" "RANGE" "BOOLEAN" "DATE" "LIST" "FORMULA"
unit
string
Enum: "NONE" "UNITS" "BARRELS" "BUSHELS" "POUNDS" "SHORT_TONS" "HUNDREDWEIGHTS" "GALLONS" "US_GALLONS" "TROY_OUNCES" "KILOGRAMS" "METRIC_TONS" "SQUARE_METERS" "DAYS" "MONTHS" "YEARS" "SMALL_INPUT"
formula
string
usage
string
Enum: "COLLATERAL_STAGES" "COVENANTS" "DOCUMENT_TYPES" "TODO_LISTS" "LOAN_ATTRIBUTES"
rangeFrom
number
rangeTo
number
listTypeId
string <uuid>
Array of objects (NewAttributeData)

Responses

Request samples

Content type
application/json
{
  • "parentId": "70850378-7d3c-4f45-91b7-942d4dfbbd43",
  • "cloneFrom": {
    },
  • "name": "string",
  • "type": "NUMBER",
  • "unit": "NONE",
  • "formula": "string",
  • "usage": "COLLATERAL_STAGES",
  • "rangeFrom": 0,
  • "rangeTo": 0,
  • "listTypeId": "593ac350-090f-422d-8c72-08b28c9f7d8f",
  • "children": [
    ]
}

Get All Attribute List Types

Authorizations:
apikeyScheme

Responses

Create Attribute of List Type

Authorizations:
apikeyScheme
Request Body schema: application/json
parentId
string <uuid>
name
string

Responses

Request samples

Content type
application/json
{
  • "parentId": "70850378-7d3c-4f45-91b7-942d4dfbbd43",
  • "name": "string"
}

Get All Default Attributes

Authorizations:
apikeyScheme

Responses

Accounting

Update accounting transaction route

Authorizations:
apikeyScheme
path Parameters
routeId
required
string <uuid>
Request Body schema: application/json
portfolioId
string <uuid>
transactionType
string
Enum: "RECEIVABLE_INTEREST" "RECEIVABLE_LOAN_PRINCIPAL_SHORT_TERM" "RECEIVABLE_LOAN_PRINCIPAL_LONG_TERM" "RECEIVABLE_FEE" "RECEIVABLE_PENALTY" "RECEIVABLE_TRANSFER_IN" "RECEIVABLE_OTHER" "PAYABLE_LOAN_PAYOUT_SHORT_TERM" "PAYABLE_LOAN_PAYOUT_LONG_TERM" "PAYABLE_PAYABLE"
journalSourceType
string
Enum: "INVOICE" "INVOICE_PAYMENT" "PAYABLE" "PAYABLE_PAYMENT" "RECEIVABLE_PAYMENT"
debitAccountNumber
string
creditAccountNumber
string

Responses

Request samples

Content type
application/json
{
  • "portfolioId": "2a9b0ad6-e5de-4239-a282-527c92c7c0f1",
  • "transactionType": "RECEIVABLE_INTEREST",
  • "journalSourceType": "INVOICE",
  • "debitAccountNumber": "string",
  • "creditAccountNumber": "string"
}

Delete accounting transaction route

Authorizations:
apikeyScheme
path Parameters
routeId
required
string <uuid>

Responses

Get chart of accounts

Authorizations:
apikeyScheme
path Parameters
portfolioId
required
string <uuid>
chartId
required
string <uuid>

Responses

Update chart of accounts

Authorizations:
apikeyScheme
path Parameters
portfolioId
required
string <uuid>
chartId
required
string <uuid>
Request Body schema: application/json
name
string
draft
boolean

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "draft": true
}

Get accounting account

Authorizations:
apikeyScheme
path Parameters
portfolioId
required
string <uuid>
chartId
required
string <uuid>
accountId
required
string <uuid>

Responses

Update accounting account

Authorizations:
apikeyScheme
path Parameters
portfolioId
required
string <uuid>
chartId
required
string <uuid>
accountId
required
string <uuid>
Request Body schema: application/json
parentId
string <uuid>
category
string
Enum: "ASSETS" "LIABILITIES" "EQUITY" "REVENUE" "EXPENSES"
name
string
description
string
number
string
comment
string

Responses

Request samples

Content type
application/json
{
  • "parentId": "70850378-7d3c-4f45-91b7-942d4dfbbd43",
  • "category": "ASSETS",
  • "name": "string",
  • "description": "string",
  • "number": "string",
  • "comment": "string"
}

Delete accounting account

Authorizations:
apikeyScheme
path Parameters
portfolioId
required
string <uuid>
chartId
required
string <uuid>
accountId
required
string <uuid>
query Parameters
required
object (DeleteAccountingAccountRequest)

Responses

Create accounting transaction route

Authorizations:
apikeyScheme
Request Body schema: application/json
portfolioId
string <uuid>
transactionType
string
Enum: "RECEIVABLE_INTEREST" "RECEIVABLE_LOAN_PRINCIPAL_SHORT_TERM" "RECEIVABLE_LOAN_PRINCIPAL_LONG_TERM" "RECEIVABLE_FEE" "RECEIVABLE_PENALTY" "RECEIVABLE_TRANSFER_IN" "RECEIVABLE_OTHER" "PAYABLE_LOAN_PAYOUT_SHORT_TERM" "PAYABLE_LOAN_PAYOUT_LONG_TERM" "PAYABLE_PAYABLE"
journalSourceType
string
Enum: "INVOICE" "INVOICE_PAYMENT" "PAYABLE" "PAYABLE_PAYMENT" "RECEIVABLE_PAYMENT"
debitAccountNumber
string
creditAccountNumber
string

Responses

Request samples

Content type
application/json
{
  • "portfolioId": "2a9b0ad6-e5de-4239-a282-527c92c7c0f1",
  • "transactionType": "RECEIVABLE_INTEREST",
  • "journalSourceType": "INVOICE",
  • "debitAccountNumber": "string",
  • "creditAccountNumber": "string"
}

Clone chart of accounts for portfolio based on default type

Authorizations:
apikeyScheme
path Parameters
portfolioId
required
string <uuid>
Request Body schema: application/json
name
string
defaultType
string
Value: "SILCUBE"

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "defaultType": "SILCUBE"
}

Clone chart of accounts for portfolio based on another chart of accounts

Authorizations:
apikeyScheme
path Parameters
portfolioId
required
string <uuid>
Request Body schema: application/json
name
string
defaultType
string
Value: "SILCUBE"

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "defaultType": "SILCUBE"
}

Get charts of accounts

Authorizations:
apikeyScheme
path Parameters
portfolioId
required
string <uuid>

Responses

Create chart of accounts

Authorizations:
apikeyScheme
path Parameters
portfolioId
required
string <uuid>
Request Body schema: application/json
name
string
draft
boolean

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "draft": true
}

Create accounting account

Authorizations:
apikeyScheme
path Parameters
portfolioId
required
string <uuid>
chartId
required
string <uuid>
Request Body schema: application/json
parentId
string <uuid>
category
string
Enum: "ASSETS" "LIABILITIES" "EQUITY" "REVENUE" "EXPENSES"
name
string
description
string
number
string
comment
string

Responses

Request samples

Content type
application/json
{
  • "parentId": "70850378-7d3c-4f45-91b7-942d4dfbbd43",
  • "category": "ASSETS",
  • "name": "string",
  • "description": "string",
  • "number": "string",
  • "comment": "string"
}

Get chart of accounts_1

Authorizations:
apikeyScheme
path Parameters
portfolioId
required
string <uuid>
query Parameters
chartId
string <uuid>
from
string <date>

Responses

Bulk create chart of accounts

Authorizations:
apikeyScheme
path Parameters
portfolioId
required
string <uuid>
Request Body schema: application/json
name
string
defaultType
string
Value: "SILCUBE"

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "defaultType": "SILCUBE"
}

Create default accounting transaction routes

Authorizations:
apikeyScheme
path Parameters
portfolioId
required
string <uuid>
Request Body schema: application/json
name
string
defaultType
string
Value: "SILCUBE"

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "defaultType": "SILCUBE"
}

Parse Chart of Accounts from excel file

Authorizations:
apikeyScheme
Request Body schema: application/json
content
string

Responses

Request samples

Content type
application/json
{
  • "content": "string"
}

Get accounting transaction routes

Authorizations:
apikeyScheme
path Parameters
portfolioId
required
string <uuid>

Responses

export_1

Authorizations:
apikeyScheme
query Parameters
portfolioId
required
string <uuid>
chartId
required
string <uuid>
from
string <date>

Responses

execute_2

Authorizations:
apikeyScheme
query Parameters
portfolioId
required
string <uuid>
from
required
string <date-time>
to
required
string <date-time>

Responses

export_2

Authorizations:
apikeyScheme
query Parameters
portfolioId
required
string <uuid>
from
required
string <date-time>
to
required
string <date-time>

Responses

Subscriptions

Get All Subscriptions

Authorizations:
apikeyScheme

Responses

Create Subscription

Authorizations:
apikeyScheme
Request Body schema: application/json
name
string

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Invite New User To Subscription

Authorizations:
apikeyScheme
path Parameters
subscriptionId
required
string <uuid>
Request Body schema: application/json
email
string
name
string

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "name": "string"
}

Accept Invite to Subscription

Authorizations:
apikeyScheme
Request Body schema: application/json
token
string

Responses

Request samples

Content type
application/json
{
  • "token": "string"
}

Get Subscription

Authorizations:
apikeyScheme
path Parameters
subscriptionId
required
string <uuid>

Responses

Check User Invitation Token

Authorizations:
apikeyScheme
path Parameters
token
required
string

Responses

Delete User From Subscription

Authorizations:
apikeyScheme
path Parameters
subscriptionId
required
string <uuid>
userId
required
string <uuid>

Responses

Navs

Instruments

Get All Instruments

Authorizations:
apikeyScheme

Responses

Create Instrument

Authorizations:
apikeyScheme
Request Body schema: application/json
name
string
type
string
Enum: "LOAN" "EQUITY" "BOND" "FUND" "REAL_ESTATE" "COMMODITY" "CASH" "ACCOUNTS_RECEIVABLES" "GENERIC"
unit
string
Enum: "UNITS" "BARRELS" "BUSHELS" "POUNDS" "SHORT_TONS" "HUNDREDWEIGHTS" "GALLONS" "US_GALLONS" "TROY_OUNCES" "KILOGRAMS" "METRIC_TONS" "PERCENT" "SHARES"
currencyId
string <uuid>
counterpartyId
string <uuid>
loanId
string <uuid>
riskCountryId
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "type": "LOAN",
  • "unit": "UNITS",
  • "currencyId": "2a59a322-927b-4fc7-bac8-d295c634b295",
  • "counterpartyId": "55bd9d74-f636-4cc8-885a-e78ea532e2ad",
  • "loanId": "7f89c4c5-c1d0-4b4b-ae8c-fb112b2c21a4",
  • "riskCountryId": "b66e4bc6-950c-438e-9535-ce49c9ec5d71"
}

Create Instrument Price

Authorizations:
apikeyScheme
path Parameters
instrumentId
required
string <uuid>
Request Body schema: application/json
date
string <date>
value
number

Responses

Request samples

Content type
application/json
{
  • "date": "2019-08-24",
  • "value": 0
}

Create or update Instrument Prices on selected date

Authorizations:
apikeyScheme
path Parameters
instrumentId
required
string <uuid>
Request Body schema: application/json
Array of objects (InstrumentPriceRequest)

Responses

Request samples

Content type
application/json
{
  • "values": [
    ]
}

Get import history

Authorizations:
apikeyScheme

Responses

Create import history entry

Authorizations:
apikeyScheme
Request Body schema: application/json
type
string
Enum: "NAV_HISTORY" "LOAN_DEALS" "LOAN_DEALS_SIMPLE" "LOAN_PAYMENTS_PLAN" "LOAN_DOCUMENTS" "LOAN_TODOS" "INTEREST_RATES" "PAYMENTS"
fileName
string

Responses

Request samples

Content type
application/json
{
  • "type": "NAV_HISTORY",
  • "fileName": "string"
}

Get Instrument's Price On Date

Authorizations:
apikeyScheme
path Parameters
instrumentId
required
string <uuid>
date
required
string <date>

Responses

Get Instrument's Latest Price

Authorizations:
apikeyScheme
path Parameters
instrumentId
required
string <uuid>

Responses

Get All Instruments with Prices

Authorizations:
apikeyScheme

Responses

Currencies

Get All Currencies

Authorizations:
apikeyScheme

Responses

Create Currency

Authorizations:
apikeyScheme
Request Body schema: application/json
name
string
iso
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "iso": "string"
}

Get Currency

Authorizations:
apikeyScheme
path Parameters
currencyId
required
string <uuid>

Responses

Get the latest currency rate

Authorizations:
apikeyScheme
path Parameters
currencyIsoCode1
required
string
currencyIsoCode2
required
string

Responses

Get currency rate on selected date

Authorizations:
apikeyScheme
path Parameters
currencyIsoCode1
required
string
currencyIsoCode2
required
string
date
required
string <date>

Responses

Reports

Loan Book Analysis Report

Authorizations:
apikeyScheme
query Parameters
reportDate
required
string <date>
portfolioId
required
string <uuid>
counterpartyId
string <uuid>

Responses

GeoMap Report

Authorizations:
apikeyScheme
query Parameters
reportDate
required
string <date>
portfolioId
required
string <uuid>
originAttributeId
string <uuid>
destinationAttributeId
string <uuid>
property
string
Default: "COUNT"
Enum: "LOAN_CONTRACT_DATE" "LOAN_MATURITY_DATE" "LOAN_INTEREST_RATE" "LOAN_INITIAL_PRINCIPAL" "LOAN_REMAINING_PRINCIPAL" "LOAN_STATUS" "ATTRIBUTE_DATE" "COUNT"
requiredStatus
string
Default: "APPROVED"
Enum: "DRAFT" "WAITING_FOR_APPROVAL" "APPROVED"

Responses

Exposure Report

Authorizations:
apikeyScheme
query Parameters
reportDate
required
string <date>
portfolioId
required
string <uuid>
counterpartyId
string <uuid>

Responses

Get Cashflow Report By Date

Authorizations:
apikeyScheme
path Parameters
date
required
string <date>
query Parameters
projectionDaysForward
integer <int32>
Default: 10
currencyId
string <uuid>
cashflowStatus
string
Default: "APPROVED"
Enum: "SETTLED_ONLY" "ALL"
portfolioIds
Array of strings <uuid>

Responses

Positions

Get Positions on date

Authorizations:
apikeyScheme
query Parameters
portfolioId
required
string <uuid>
date
required
string <date>
cashflowStatus
string
Default: "ALL"
Enum: "SETTLED_ONLY" "ALL"

Responses

Countries

Get All Countries

Authorizations:
apikeyScheme

Responses

Get Country

Authorizations:
apikeyScheme
path Parameters
countryId
required
string <uuid>

Responses