API docs by Redocly

Aptic API Gateway - Loans (v1.0)

Download OpenAPI specification:Download

Aptic AB: api@aptic.net URL: https://www.aptic.net Terms of Service

Loan related API for Aptic solutions

Loans

Get loans using filters

Authorizations:
(oauth2apikey)
query Parameters
$filter
string

Filter conditions specified in a simplified OData format

$skip
integer <int32>

List offset when paginating (default 0)

$top
integer <int32>

Maximum size of result (default 25, max 100)

$orderby
string

Sorting conditions E.g. "fullname desc"

Responses

Response samples

Content type
{
  • "count": 0,
  • "skip": 0,
  • "total": 0,
  • "value": [
    ]
}

Creates a new loan account

Authorizations:
(oauth2apikey)
Request Body schema:

Loan information

Array
creditorReference
string or null

Party reference code.

typeCode
string or null

Loan type code.

loanType
string or null

Customer account subtype code.

currencyCode
string or null

Currency code for the loan

currentBalance
number or null <double>

Current balance of the loan (in case of account migration)

accountNumber
string or null

Loan account number.

accountDescription
string or null

Account description.

deliverySystemCode
string or null

Delivery system code.

remindedAt
string or null <date-time>

Date for latest reminder (when migrating existing accounts)

reminderCount
integer or null <int32>

Reminder count (when migrating existing accounts)

collectionDate
string or null <date-time>

Date when the account was sent to debt collection (when migrating existing accounts)

paymentReference
string or null

Payment reference.

nextSettlementDate
string or null <date-time>

Date for next account settlement

interestRate
number or null <double>

Loan interest rate.

interestType
string or null

Loan interest type.

fixedInterestTermStart
string or null <date-time>

Loan interest term start date for fixed interest terms.

creditLimit
number or null <double>

Credit limit.

Array of objects or null (LoanCustomer)

List of customers.

Array of objects or null (PutExtraFieldValue)

List of extra fields.

Array of objects or null (AccountNote)

List of notes for the invoice.

Array of objects or null (PutDocument)

List of documents for the invoice.

Array of objects or null (AccountPledge)

List of pledges.

Array of objects or null (AccountInsurance)

List of insurances.

Array of objects or null (LoanInstalment)

Optional list of instalments.

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
{
  • "loanGuids": [
    ],
  • "impStockId": 0
}

Get loan details based on the unique GUID

Authorizations:
(oauth2apikey)
path Parameters
loanGuid
required
string

The unique GUID of the loan

Responses

Response samples

Content type
{
  • "accountGuid": "string",
  • "accountNumber": "string",
  • "description": "string",
  • "accountDescription": "string",
  • "mainCustomerGuid": "string",
  • "mainCustomerFullName": "string",
  • "mainCustomerIdNumber": "string",
  • "contractNumber": "string",
  • "contractDate": "2019-08-24T14:15:22Z",
  • "issueDate": "2019-08-24T14:15:22Z",
  • "maturityDate": "2019-08-24T14:15:22Z",
  • "typeCode": "string",
  • "loanType": "string",
  • "originationCode": "string",
  • "registrationDate": "2019-08-24T14:15:22Z",
  • "settlementFee": 0,
  • "registrationFee": 0,
  • "creditInterestRate": 0,
  • "interestMarginCode": "string",
  • "creditInterestType": "string",
  • "currentCreditInterestRate": 0,
  • "loanCommitment": 0,
  • "unusedCreditAmount": 0,
  • "creditLimit": 0,
  • "nextDueDate": "2019-08-24T14:15:22Z",
  • "remainingPrincipal": 0,
  • "remainingInterest": 0,
  • "remainingFee": 0,
  • "billedPrincipal": 0,
  • "billedInterest": 0,
  • "remainingBilledPrincipal": 0,
  • "remainingBilledInterest": 0,
  • "remainingDuePrincipal": 0,
  • "remainingDueInterest": 0,
  • "remainingPenaltyInterestOnPrincipal": 0,
  • "remainingPenaltyInterestOnInterest": 0,
  • "daysPassedDuePrincipal": 0,
  • "daysPassedDueInterest": 0,
  • "paymentReference": "string",
  • "paymentBankAccountNumber": "string",
  • "loanStatus": 0,
  • "creditApplicationStatus": 0,
  • "reminderCount": 0,
  • "lastDisbursementDate": "2019-08-24T14:15:22Z",
  • "effectiveInterestRate": 0,
  • "amountSpecification": [
    ],
  • "links": [
    ]
}

Updates a loan

Authorizations:
(oauth2apikey)
path Parameters
loanGuid
required
string

The unique GUID of the loan

Request Body schema:

Fields to update

description
string or null

Description.

accountDescription
string or null

Account description.

contractNumber
string or null

Contract number.

contractDate
string or null <date-time>

Contract date.

maturityDate
string or null <date-time>

Maturity date.

settlementFee
number or null <double>

Settlement fee.

paymentReference
string or null

Payment reference.

Responses

Request samples

Content type
{
  • "description": "string",
  • "accountDescription": "string",
  • "contractNumber": "string",
  • "contractDate": "2019-08-24T14:15:22Z",
  • "maturityDate": "2019-08-24T14:15:22Z",
  • "settlementFee": 0,
  • "paymentReference": "string"
}

Response samples

Content type
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

Deletes a loan

Authorizations:
(oauth2apikey)
path Parameters
loanGuid
required
string

Responses

Response samples

Content type
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

Get loan documents using filters

Authorizations:
(oauth2apikey)
path Parameters
loanGuid
required
string

Loan guid

query Parameters
$filter
string

Filter conditions specified in a simplified OData format

$skip
integer <int32>

List offset when paginating (default 0)

$top
integer <int32>

Maximum size of result (default 25, max 100)

$orderby
string

Sorting conditions E.g. "fullname desc"

Responses

Response samples

Content type
{
  • "count": 0,
  • "skip": 0,
  • "total": 0,
  • "value": [
    ]
}

Adds a document to the loan

Authorizations:
(oauth2apikey)
path Parameters
loanGuid
required
string

Loan guid

Request Body schema:

Document information

note
required
string non-empty

Free extra information related to the document.

documentType
string or null

Document code (one of predefined types idoc / invoice / gjeldsbrev / verdict / domforlik).

loggedAt
string or null <date-time>

Document creation date.

originalFileName
required
string non-empty

The file name to be generated instead of an auto-generated one.

searchValue
string or null

Document specific search value or reference number.

externalLink
string or null

Link to the document, if it exists on external archive.

important
boolean or null

Document importancy flag.

fileDataBase64
string or null

Base64-encoded file body.

Responses

Request samples

Content type
{
  • "note": "string",
  • "documentType": "string",
  • "loggedAt": "2019-08-24T14:15:22Z",
  • "originalFileName": "string",
  • "searchValue": "string",
  • "externalLink": "string",
  • "important": true,
  • "fileDataBase64": "string"
}

Response samples

Content type
{
  • "note": "string",
  • "documentType": "string",
  • "loggedAt": "2019-08-24T14:15:22Z",
  • "originalFileName": "string",
  • "important": true,
  • "links": [
    ]
}

Get loan document details based on the unique GUID for loan and document

Authorizations:
(oauth2apikey)
path Parameters
loanGuid
required
string

The unique GUID of the loan

documentGuid
required
string

The unique GUID of the document

Responses

Response samples

Content type
{
  • "note": "string",
  • "documentType": "string",
  • "loggedAt": "2019-08-24T14:15:22Z",
  • "originalFileName": "string",
  • "important": true,
  • "links": [
    ]
}

Gets loan guarantees

Authorizations:
(oauth2apikey)
path Parameters
loanGuid
required
string

Loan guid

query Parameters
$filter
string

Filter conditions specified in a simplified OData format

$skip
integer <int32>

List offset when paginating (default 0)

$top
integer <int32>

Maximum size of result (default 25, max 100)

$orderby
string

Sorting conditions E.g. "fullname desc"

Responses

Response samples

Content type
{
  • "count": 0,
  • "skip": 0,
  • "total": 0,
  • "value": [
    ]
}

Adds a new guarantee to the loan

Authorizations:
(oauth2apikey)
path Parameters
loanGuid
required
string

Loan guid

Request Body schema:

Guarantee information

pledgeType
integer <int32>

Type of guarantee

4 = Guarantee

5 = Full guarantee

referenceNumber
string or null

Reference or identification number for pledge

guaranteeDate
string or null <date-time>

Guarantee date

guaranteeAmount
number or null <double>

Guarantee amount

description
string or null

Description of the pledge

note
string or null

Notes for this pledge

insurer
string or null

Insurer for this pledge

insuranceNumber
string or null

Insurance number for this pledge

insuredAmount
number or null <double>

Insured amount for this pledge

insuranceExpiryDate
string or null <date-time>

Expiry date of the insurance for this pledge

guaranteeType
integer or null <int32>

Guarantee type

1 = Absolute guaranty

2 = Sec.obligation

validUntil
string or null <date-time>

Full guarantee valid until

guarantors
Array of strings or null

Guarantors guids

Responses

Request samples

Content type
{
  • "pledgeType": 0,
  • "referenceNumber": "string",
  • "guaranteeDate": "2019-08-24T14:15:22Z",
  • "guaranteeAmount": 0,
  • "description": "string",
  • "note": "string",
  • "insurer": "string",
  • "insuranceNumber": "string",
  • "insuredAmount": 0,
  • "insuranceExpiryDate": "2019-08-24T14:15:22Z",
  • "guaranteeType": 0,
  • "validUntil": "2019-08-24T14:15:22Z",
  • "guarantors": [
    ]
}

Response samples

Content type
{
  • "guaranteeGuid": "string",
  • "pledgeType": 0,
  • "referenceNumber": "string",
  • "guaranteeDate": "2019-08-24T14:15:22Z",
  • "originalGuaranteeAmount": 0,
  • "guaranteeAmount": 0,
  • "description": "string",
  • "note": "string",
  • "insurer": "string",
  • "insuranceNumber": "string",
  • "insuredAmount": 0,
  • "insuranceExpiryDate": "2019-08-24T14:15:22Z",
  • "guaranteeType": 0,
  • "guarantors": [
    ],
  • "links": [
    ]
}

Get specific loan guarantee

Authorizations:
(oauth2apikey)
path Parameters
loanGuid
required
string

Loan guid

guaranteeGuid
required
string

Guarantee guid

Responses

Response samples

Content type
{
  • "guaranteeGuid": "string",
  • "pledgeType": 0,
  • "referenceNumber": "string",
  • "guaranteeDate": "2019-08-24T14:15:22Z",
  • "originalGuaranteeAmount": 0,
  • "guaranteeAmount": 0,
  • "description": "string",
  • "note": "string",
  • "insurer": "string",
  • "insuranceNumber": "string",
  • "insuredAmount": 0,
  • "insuranceExpiryDate": "2019-08-24T14:15:22Z",
  • "guaranteeType": 0,
  • "guarantors": [
    ],
  • "links": [
    ]
}

Updates a guarantee

Authorizations:
(oauth2apikey)
path Parameters
loanGuid
required
string

Loan guid

guaranteeGuid
required
string

Guarantee guid

Request Body schema:

Guarantee information

referenceNumber
string or null

Reference or identification number for pledge

guaranteeDate
string or null <date-time>

Guarantee date

guaranteeAmount
number or null <double>

Guarantee amount

description
string or null

Description of the pledge

note
string or null

Notes for this pledge

insurer
string or null

Insurer for this pledge

insuranceNumber
string or null

Insurance number for this pledge

insuredAmount
number or null <double>

Insured amount for this pledge

insuranceExpiryDate
string or null <date-time>

Expiry date of the insurance for this pledge

guaranteeType
integer or null <int32>

Guarantee type

1 = Absolute guaranty

2 = Sec.obligation

validUntil
string or null <date-time>

Full guarantee valid until

Responses

Request samples

Content type
{
  • "referenceNumber": "string",
  • "guaranteeDate": "2019-08-24T14:15:22Z",
  • "guaranteeAmount": 0,
  • "description": "string",
  • "note": "string",
  • "insurer": "string",
  • "insuranceNumber": "string",
  • "insuredAmount": 0,
  • "insuranceExpiryDate": "2019-08-24T14:15:22Z",
  • "guaranteeType": 0,
  • "validUntil": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

Deletes a loan guarantee

Authorizations:
(oauth2apikey)
path Parameters
loanGuid
required
string

Loan guid

guaranteeGuid
required
string

Guarantee guid

Responses

Response samples

Content type
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

Gets loan collaterals

Authorizations:
(oauth2apikey)
path Parameters
loanGuid
required
string

Loan guid

query Parameters
$filter
string

Filter conditions specified in a simplified OData format

$skip
integer <int32>

List offset when paginating (default 0)

$top
integer <int32>

Maximum size of result (default 25, max 100)

$orderby
string

Sorting conditions E.g. "fullname desc"

Responses

Response samples

Content type
{
  • "count": 0,
  • "skip": 0,
  • "total": 0,
  • "value": [
    ]
}

Adds a new collateral to the loan

Authorizations:
(oauth2apikey)
path Parameters
loanGuid
required
string

Loan guid

Request Body schema:

Collateral information

pledgeType
integer <int32>

Type of pledge

1 = Fixed asset

2 = Movable/personal property

3 = Company mortgage

6 = Seizure

referenceNumber
string or null

Reference or identification number for pledge

pledgeDate
string or null <date-time>

Pledge date

pledgeAmount
number or null <double>

Pledge amount

description
string or null

Description of the pledge

note
string or null

Notes for this pledge

insurer
string or null

Insurer for this pledge

insuranceNumber
string or null

Insurance number for this pledge

insuredAmount
number or null <double>

Insured amount for this pledge

insuranceExpiryDate
string or null <date-time>

Expiry date of the insurance for this pledge

realized
boolean or null

The collateral has been sold/realized

object (AccountCollateralFixedAsset)

Fixed asset information

object (AccountCollateralMovableproperty)

Movable property information

object (AccountCollateralCompanyMortgage)

Company mortgage information

object (AccountCollateralSeizure)

Seizure information

Array of objects or null (LienpriorityElm)

All known mortgage lien priorities

Array of objects or null (OwnerElm)

Land certificates (only valid when PledgeType = 1)

otherPledgers
Array of strings or null

Guids for other pledgers not included as borrower for the loan

Responses

Request samples

Content type
{
  • "pledgeType": 0,
  • "referenceNumber": "string",
  • "pledgeDate": "2019-08-24T14:15:22Z",
  • "pledgeAmount": 0,
  • "description": "string",
  • "note": "string",
  • "insurer": "string",
  • "insuranceNumber": "string",
  • "insuredAmount": 0,
  • "insuranceExpiryDate": "2019-08-24T14:15:22Z",
  • "realized": true,
  • "fixedAsset": {
    },
  • "movableproperty": {
    },
  • "companyMortgage": {
    },
  • "seizure": {
    },
  • "lienPriorities": [
    ],
  • "landCertificates": [
    ],
  • "otherPledgers": [
    ]
}

Response samples

Content type
{
  • "collateralGuid": "string",
  • "pledgeType": 0,
  • "referenceNumber": "string",
  • "pledgeDate": "2019-08-24T14:15:22Z",
  • "pledgeAmount": 0,
  • "description": "string",
  • "note": "string",
  • "insurer": "string",
  • "insuranceNumber": "string",
  • "insuredAmount": 0,
  • "insuranceExpiryDate": "2019-08-24T14:15:22Z",
  • "realized": true,
  • "fixedAsset": {
    },
  • "movableproperty": {
    },
  • "companyMortgage": {
    },
  • "seizure": {
    },
  • "lienPriorities": [
    ],
  • "landCertificates": [
    ],
  • "links": [
    ]
}

Get specific loan collateral

Authorizations:
(oauth2apikey)
path Parameters
loanGuid
required
string

Loan guid

collateralGuid
required
string

Collateral guid

Responses

Response samples

Content type
{
  • "collateralGuid": "string",
  • "pledgeType": 0,
  • "referenceNumber": "string",
  • "pledgeDate": "2019-08-24T14:15:22Z",
  • "pledgeAmount": 0,
  • "description": "string",
  • "note": "string",
  • "insurer": "string",
  • "insuranceNumber": "string",
  • "insuredAmount": 0,
  • "insuranceExpiryDate": "2019-08-24T14:15:22Z",
  • "realized": true,
  • "fixedAsset": {
    },
  • "movableproperty": {
    },
  • "companyMortgage": {
    },
  • "seizure": {
    },
  • "lienPriorities": [
    ],
  • "landCertificates": [
    ],
  • "links": [
    ]
}

Updates a collateral

Authorizations:
(oauth2apikey)
path Parameters
loanGuid
required
string

Loan guid

collateralGuid
required
string

Collateral guid

Request Body schema:

Collateral information

referenceNumber
string or null

Reference or identification number for pledge

pledgeDate
string or null <date-time>

Pledge date

pledgeAmount
number or null <double>

Pledge amount

description
string or null

Description of the pledge

note
string or null

Notes for this pledge

insurer
string or null

Insurer for this pledge

insuranceNumber
string or null

Insurance number for this pledge

insuredAmount
number or null <double>

Insured amount for this pledge

insuranceExpiryDate
string or null <date-time>

Expiry date of the insurance for this pledge

realized
boolean or null

The collateral has been sold/realized

object (AccountCollateralFixedAsset)

Fixed asset information

object (AccountCollateralMovableproperty)

Movable property information

object (AccountCollateralCompanyMortgage)

Company mortgage information

object (AccountCollateralSeizure)

Seizure information

Array of objects or null (LienpriorityElm)

All known mortgage lien priorities

Array of objects or null (OwnerElm)

Land certificates (only valid when PledgeType = 1)

Responses

Request samples

Content type
{
  • "referenceNumber": "string",
  • "pledgeDate": "2019-08-24T14:15:22Z",
  • "pledgeAmount": 0,
  • "description": "string",
  • "note": "string",
  • "insurer": "string",
  • "insuranceNumber": "string",
  • "insuredAmount": 0,
  • "insuranceExpiryDate": "2019-08-24T14:15:22Z",
  • "realized": true,
  • "fixedAsset": {
    },
  • "movableproperty": {
    },
  • "companyMortgage": {
    },
  • "seizure": {
    },
  • "lienPriorities": [
    ],
  • "landCertificates": [
    ]
}

Response samples

Content type
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

Deletes a loan collateral

Authorizations:
(oauth2apikey)
path Parameters
loanGuid
required
string

Loan guid

collateralGuid
required
string

Collateral guid

Responses

Response samples

Content type
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

Get loan transactions using filters

Authorizations:
(oauth2apikey)
path Parameters
loanGuid
required
string

Loan guid

query Parameters
$filter
string

Filter conditions specified in a simplified OData format

$skip
integer <int32>

List offset when paginating (default 0)

$top
integer <int32>

Maximum size of result (default 25, max 100)

$orderby
string

Sorting conditions E.g. "fullname desc"

Responses

Response samples

Content type
{
  • "count": 0,
  • "skip": 0,
  • "total": 0,
  • "value": [
    ]
}

Get loan's future expected cashflow

Authorizations:
(oauth2apikey)
path Parameters
loanGuid
required
string

Loan guid

query Parameters
$filter
string

Filter conditions specified in a simplified OData format

$skip
integer <int32>

List offset when paginating (default 0)

$top
integer <int32>

Maximum size of result (default 25, max 100)

$orderby
string

Sorting conditions E.g. "fullname desc"

Responses

Response samples

Content type
[
  • {
    }
]

Get loan extra fields using filters

Authorizations:
(oauth2apikey)
path Parameters
loanGuid
required
string

Loan guid

query Parameters
$filter
string

Filter conditions specified in a simplified OData format

$skip
integer <int32>

List offset when paginating (default 0)

$top
integer <int32>

Maximum size of result (default 25, max 100)

$orderby
string

Sorting conditions E.g. "fullname desc"

Responses

Response samples

Content type
{
  • "count": 0,
  • "skip": 0,
  • "total": 0,
  • "value": [
    ]
}

Creates a new loan extra field

Authorizations:
(oauth2apikey)
path Parameters
loanGuid
required
string

The unique GUID of the loan

Request Body schema:

Extra field value

name
string or null

Name of Extra field data

value
Array of strings or null

The value of the extra field

Responses

Request samples

Content type
{
  • "name": "string",
  • "value": [
    ]
}

Response samples

Content type
{
  • "name": "string",
  • "value": [
    ]
}

Get loan extra field details based on the unique GUID and extra field name

Authorizations:
(oauth2apikey)
path Parameters
loanGuid
required
string

The unique GUID of the loan

name
required
string

The name of the extra field

Responses

Response samples

Content type
{
  • "name": "string",
  • "value": [
    ]
}

Updates a loan extra field

Authorizations:
(oauth2apikey)
path Parameters
loanGuid
required
string

The unique GUID of the loan

name
required
string

Extrafield name

Request Body schema:

Extrafield value

value
Array of strings or null

The value of the extra field

Responses

Request samples

Content type
{
  • "value": [
    ]
}

Response samples

Content type
{
  • "name": "string",
  • "value": [
    ]
}

Deletes a loan extra field

Authorizations:
(oauth2apikey)
path Parameters
loanGuid
required
string

The unique GUID of the loan

name
required
string

Extrafield name

Responses

Response samples

Content type
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

Gets loan instalment plan details.

Authorizations:
(oauth2apikey)
path Parameters
loanGuid
required
string

Loan guid

query Parameters
$filter
string

Filter conditions specified in a simplified OData format

$skip
integer <int32>

List offset when paginating (default 0)

$top
integer <int32>

Maximum size of result (default 25, max 100)

$orderby
string

Sorting conditions E.g. "fullname desc"

Responses

Response samples

Content type
{
  • "count": 0,
  • "skip": 0,
  • "total": 0,
  • "value": [
    ]
}

Creates a new loan instalment plan (proposal)

Authorizations:
(oauth2apikey)
path Parameters
loanGuid
required
string

Loan guid

Request Body schema:

Instalment plan information

loanType
string or null

Customer account subtype code.

proposal
boolean or null

The instalment plan is a non-approved proposal

paymentPlanType
integer <int32>

Payment plan type.

1 = Linear amortization, and all accrued interest.

2 = Annuity, over time increase amortization as interest amount decreases.

3 = InterestOnly, only pay for interest, no amortization. A.k.a. bullet loan.

totalPayments
integer or null <int32>

Suggested number of instalment periods

instalmentAmount
number or null <double>

Suggested instalment amount for each period

interestRate
number or null <double>

New interest rate to use for instalment plan

interestCode
string or null

New interest code to use for instalment plan (one of predefined values depending on country)

fixedInterestTermStart
string or null <date-time>

Fixed interest term date

Array of objects or null (PutLoanPaymentPlanPayment)

List of instalments.

Responses

Request samples

Content type
{
  • "loanType": "string",
  • "proposal": true,
  • "paymentPlanType": 0,
  • "totalPayments": 0,
  • "instalmentAmount": 0,
  • "interestRate": 0,
  • "interestCode": "string",
  • "fixedInterestTermStart": "2019-08-24T14:15:22Z",
  • "payments": [
    ]
}

Response samples

Content type
{
  • "planGuid": "string",
  • "active": "Inactive",
  • "loanType": "string",
  • "paymentPlanType": "Flat",
  • "registrationDate": "2019-08-24T14:15:22Z",
  • "interestTerm": 0,
  • "instalmentTerm": 0,
  • "maturityDate": "2019-08-24T14:15:22Z",
  • "interestTypeCode": "string",
  • "interestMarginCode": "string",
  • "interestDiscount": 0,
  • "fixedInterestRate": 0,
  • "currentInterestRate": 0,
  • "totalPayments": 0,
  • "remainingPayments": 0,
  • "totalPrincipal": 0,
  • "totalInterest": 0,
  • "totalFee": 0,
  • "apr": 0,
  • "payments": [
    ]
}

Get specific loan instalment plan details.

Authorizations:
(oauth2apikey)
path Parameters
loanGuid
required
string

Loan guid

planGuid
required
string

Instalment plan guid

Responses

Response samples

Content type
{
  • "planGuid": "string",
  • "active": "Inactive",
  • "loanType": "string",
  • "paymentPlanType": "Flat",
  • "registrationDate": "2019-08-24T14:15:22Z",
  • "interestTerm": 0,
  • "instalmentTerm": 0,
  • "maturityDate": "2019-08-24T14:15:22Z",
  • "interestTypeCode": "string",
  • "interestMarginCode": "string",
  • "interestDiscount": 0,
  • "fixedInterestRate": 0,
  • "currentInterestRate": 0,
  • "totalPayments": 0,
  • "remainingPayments": 0,
  • "totalPrincipal": 0,
  • "totalInterest": 0,
  • "totalFee": 0,
  • "apr": 0,
  • "payments": [
    ]
}

Deletes a loan instalment plan proposal

Authorizations:
(oauth2apikey)
path Parameters
loanGuid
required
string
planGuid
required
string

Responses

Response samples

Content type
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

Calculates a loan instalment plan (proposal). Nothing is stored permanently.

Authorizations:
(oauth2apikey)
path Parameters
loanGuid
required
string

Loan guid

Request Body schema:

Instalment plan information

loanType
string or null

Customer account subtype code.

proposal
boolean or null

The instalment plan is a non-approved proposal

paymentPlanType
integer <int32>

Payment plan type.

1 = Linear amortization, and all accrued interest.

2 = Annuity, over time increase amortization as interest amount decreases.

3 = InterestOnly, only pay for interest, no amortization. A.k.a. bullet loan.

totalPayments
integer or null <int32>

Suggested number of instalment periods

instalmentAmount
number or null <double>

Suggested instalment amount for each period

interestRate
number or null <double>

New interest rate to use for instalment plan

interestCode
string or null

New interest code to use for instalment plan (one of predefined values depending on country)

fixedInterestTermStart
string or null <date-time>

Fixed interest term date

Array of objects or null (PutLoanPaymentPlanPayment)

List of instalments.

Responses

Request samples

Content type
{
  • "loanType": "string",
  • "proposal": true,
  • "paymentPlanType": 0,
  • "totalPayments": 0,
  • "instalmentAmount": 0,
  • "interestRate": 0,
  • "interestCode": "string",
  • "fixedInterestTermStart": "2019-08-24T14:15:22Z",
  • "payments": [
    ]
}

Response samples

Content type
{
  • "planGuid": "string",
  • "active": "Inactive",
  • "loanType": "string",
  • "paymentPlanType": "Flat",
  • "registrationDate": "2019-08-24T14:15:22Z",
  • "interestTerm": 0,
  • "instalmentTerm": 0,
  • "maturityDate": "2019-08-24T14:15:22Z",
  • "interestTypeCode": "string",
  • "interestMarginCode": "string",
  • "interestDiscount": 0,
  • "fixedInterestRate": 0,
  • "currentInterestRate": 0,
  • "totalPayments": 0,
  • "remainingPayments": 0,
  • "totalPrincipal": 0,
  • "totalInterest": 0,
  • "totalFee": 0,
  • "apr": 0,
  • "payments": [
    ]
}

Activates a loan instalment plan proposal

Authorizations:
(oauth2apikey)
path Parameters
loanGuid
required
string
planGuid
required
string

Responses

Response samples

Content type
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

Get instalment plan's future expected cashflow

Authorizations:
(oauth2apikey)
path Parameters
loanGuid
required
string

Loan guid

planGuid
required
string

Instalment plan guid

query Parameters
$filter
string

Filter conditions specified in a simplified OData format

$skip
integer <int32>

List offset when paginating (default 0)

$top
integer <int32>

Maximum size of result (default 25, max 100)

$orderby
string

Sorting conditions E.g. "fullname desc"

Responses

Response samples

Content type
[
  • {
    }
]

Gets loan interest term details.

Authorizations:
(oauth2apikey)
path Parameters
loanGuid
required
string

Loan guid

Responses

Response samples

Content type
[
  • {
    }
]

Gets loan interest rates.

Authorizations:
(oauth2apikey)
path Parameters
loanGuid
required
string

Loan guid

query Parameters
$filter
string

Filter conditions specified in a simplified OData format

$skip
integer <int32>

List offset when paginating (default 0)

$top
integer <int32>

Maximum size of result (default 25, max 100)

$orderby
string

Sorting conditions E.g. "fullname desc"

Responses

Response samples

Content type
{
  • "count": 0,
  • "skip": 0,
  • "total": 0,
  • "values": [
    ]
}

Gets loan accrued interest.

Authorizations:
(oauth2apikey)
path Parameters
loanGuid
required
string

Loan guid

query Parameters
$filter
string

Filter conditions specified in a simplified OData format

$skip
integer <int32>

List offset when paginating (default 0)

$top
integer <int32>

Maximum size of result (default 25, max 100)

$orderby
string

Sorting conditions E.g. "fullname desc"

Responses

Response samples

Content type
{
  • "loanGuid": "string",
  • "loanNumber": "string",
  • "periods": [
    ]
}

Close the loan

Authorizations:
(oauth2apikey)
path Parameters
loanGuid
required
string

The unique GUID of the loan

Request Body schema:

Closure information

closureCode
string or null

Closure code

reason
string or null

Reason description

Responses

Request samples

Content type
{
  • "closureCode": "string",
  • "reason": "string"
}

Response samples

Content type
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

Add a respite to the loan

Authorizations:
(oauth2apikey)
path Parameters
loanGuid
required
string

The unique GUID of the loan

Request Body schema:

Respite request information, like the number of days

days
integer <int32>

Days to give respite for

Responses

Request samples

Content type
{
  • "days": 0
}

Response samples

Content type
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

Get pre-redemption of the loan

Authorizations:
(oauth2apikey)
path Parameters
loanGuid
required
string

The unique GUID of the loan

Responses

Response samples

Content type
{
  • "preRedemptionDate": "2019-08-24T14:15:22Z",
  • "principalToRedeem": 0,
  • "interestCompensation": 0,
  • "accruedInterest": 0,
  • "remainingFees": 0,
  • "capitalizedInterest": 0,
  • "preredemptionAmount": 0,
  • "instalmentPlanCalcType": 0,
  • "creditUnpaidInvoices": true,
  • "createBillingDebt": true,
  • "letterDate": "2019-08-24T14:15:22Z",
  • "invoiceNumber": "string",
  • "creditInvoiceNumber": "string"
}

Initiate a pre-redemption of the loan

Authorizations:
(oauth2apikey)
path Parameters
loanGuid
required
string

The unique GUID of the loan

Request Body schema:

Respite request information, like the number of days

preRedemptionDate
string <date-time>

Pre-redemption date

calculateInterestCompensation
boolean

Calculate interest compensation (penalty fee)

deductInterest
integer <int32>

How to deduct accrued interest from preredemption amount

0 = No accrued interest

1 = Yes, calculated on full principal amount

2 = Yes, calculated on preredemption principal

principalToRedeem
number or null <double>

Principal amount to redeem

preredemptionAmount
number or null <double>

Total preredemption amount

instalmentPlanCalcType
integer or null <int32>

Specifies how the instalment should be recalculated

1 = Keep maturity length and lower instalment amount

2 = Keep instalment amount and shorten plan

creditUnpaidInvoices
boolean or null

Specifies if credit invoices should be created for already existing unpaid invoices

createBillingDebt
boolean or null

Specifies if a regular invoice should be created for the pre-redemption

letterDate
string or null <date-time>

Date when the invoice should be produced

note
string or null

Note regarding preredemption request

Responses

Request samples

Content type
{
  • "preRedemptionDate": "2019-08-24T14:15:22Z",
  • "calculateInterestCompensation": true,
  • "deductInterest": 0,
  • "principalToRedeem": 0,
  • "preredemptionAmount": 0,
  • "instalmentPlanCalcType": 0,
  • "creditUnpaidInvoices": true,
  • "createBillingDebt": true,
  • "letterDate": "2019-08-24T14:15:22Z",
  • "note": "string"
}

Response samples

Content type
{
  • "preRedemptionDate": "2019-08-24T14:15:22Z",
  • "principalToRedeem": 0,
  • "interestCompensation": 0,
  • "accruedInterest": 0,
  • "remainingFees": 0,
  • "capitalizedInterest": 0,
  • "preredemptionAmount": 0,
  • "instalmentPlanCalcType": 0,
  • "creditUnpaidInvoices": true,
  • "createBillingDebt": true,
  • "letterDate": "2019-08-24T14:15:22Z",
  • "invoiceNumber": "string",
  • "creditInvoiceNumber": "string"
}

Inactivates the current pre-redemption of the loan

Authorizations:
(oauth2apikey)
path Parameters
loanGuid
required
string

The unique GUID of the loan

Responses

Response samples

Content type
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

Calculate a pre-redemption of the loan

Authorizations:
(oauth2apikey)
path Parameters
loanGuid
required
string

The unique GUID of the loan

Request Body schema:

Respite request information, like the number of days

preRedemptionDate
string <date-time>

Pre-redemption date

calculateInterestCompensation
boolean

Calculate interest compensation (penalty fee)

deductInterest
integer <int32>

How to deduct accrued interest from preredemption amount

0 = No accrued interest

1 = Yes, calculated on full principal amount

2 = Yes, calculated on preredemption principal

principalToRedeem
number or null <double>

Principal amount to redeem

preredemptionAmount
number or null <double>

Total preredemption amount

instalmentPlanCalcType
integer or null <int32>

Specifies how the instalment should be recalculated

1 = Keep maturity length and lower instalment amount

2 = Keep instalment amount and shorten plan

creditUnpaidInvoices
boolean or null

Specifies if credit invoices should be created for already existing unpaid invoices

createBillingDebt
boolean or null

Specifies if a regular invoice should be created for the pre-redemption

letterDate
string or null <date-time>

Date when the invoice should be produced

note
string or null

Note regarding preredemption request

Responses

Request samples

Content type
{
  • "preRedemptionDate": "2019-08-24T14:15:22Z",
  • "calculateInterestCompensation": true,
  • "deductInterest": 0,
  • "principalToRedeem": 0,
  • "preredemptionAmount": 0,
  • "instalmentPlanCalcType": 0,
  • "creditUnpaidInvoices": true,
  • "createBillingDebt": true,
  • "letterDate": "2019-08-24T14:15:22Z",
  • "note": "string"
}

Response samples

Content type
{
  • "preRedemptionDate": "2019-08-24T14:15:22Z",
  • "principalToRedeem": 0,
  • "interestCompensation": 0,
  • "accruedInterest": 0,
  • "remainingFees": 0,
  • "capitalizedInterest": 0,
  • "preredemptionAmount": 0,
  • "instalmentPlanCalcType": 0,
  • "creditUnpaidInvoices": true,
  • "createBillingDebt": true,
  • "letterDate": "2019-08-24T14:15:22Z",
  • "invoiceNumber": "string",
  • "creditInvoiceNumber": "string"
}

Calculate a pre-redemption penalty fee of the loan

Authorizations:
(oauth2apikey)
path Parameters
loanGuid
required
string

The unique GUID of the loan

Request Body schema:

Inpout for calculating penalty fee

preRedemptionDate
string <date-time>

Pre-redemption date

principalToRedeem
number <double>

Principal amount to redeem

calcType
string or null

Calculation type

3MONTHS - 3 months interest using current rate

STANDARDIRD - Standard Interest Rate Differential calculation

DISCOUNTEDIRD - Discounted Interest Rate Differential calculation

PRESENTVALUE - Present value calculation until next interest term change

NOMINAL - Expected interest cashflow until next interest term change

currentLendersRate
number or null <double>

Current lender's interest rate

currentLendersMargin
number or null <double>

Margin to add to lender's interest rate

originalDiscount
number or null <double>

Original interest rate discount for the fixed interest compared to lender's standard rate

marketInterestCode
string or null

Market interest code for reference interest rate or lender's interest rate

fixedInterestTermEnd
string or null <date-time>

Deviating fixed interest term end date used for the calculation

maturityDate
string or null <date-time>

Deviating maturity date for calculation

roundingBase
integer or null <int32>

Rounding base to use, value 100 rounds up to nearest integer, while 10000 round up to nearest 100. Negative amount rounds downwards.

Responses

Request samples

Content type
{
  • "preRedemptionDate": "2019-08-24T14:15:22Z",
  • "principalToRedeem": 0,
  • "calcType": "string",
  • "currentLendersRate": 0,
  • "currentLendersMargin": 0,
  • "originalDiscount": 0,
  • "marketInterestCode": "string",
  • "fixedInterestTermEnd": "2019-08-24T14:15:22Z",
  • "maturityDate": "2019-08-24T14:15:22Z",
  • "roundingBase": 0
}

Response samples

Content type
{
  • "preRedemptionDate": "2019-08-24T14:15:22Z",
  • "principalToRedeem": 0,
  • "interestCompensation": 0
}

Credit unpaid invoice for the loan

Authorizations:
(oauth2apikey)
path Parameters
loanGuid
required
string

The unique GUID of the loan

Responses

Response samples

Content type
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

Initiate pre-termination of the loan

Authorizations:
(oauth2apikey)
path Parameters
loanGuid
required
string

The unique GUID of the loan

Request Body schema:

Pre-termination information

terminationStatus
integer or null <int32>

Status of pre-termination.

0 = Pretermination (default)

1 = Termination

nextStatusCheck
string or null <date-time>

Next status check date for pre-termination

minAmountBackToNormal
number or null <double>

Minimal amount to be paid to reserver back to normal Loan from (pre)termination status

Responses

Request samples

Content type
{
  • "terminationStatus": 0,
  • "nextStatusCheck": "2019-08-24T14:15:22Z",
  • "minAmountBackToNormal": 0
}

Response samples

Content type
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

Initiate a payment request for payment service provider.

Authorizations:
(oauth2apikey)
path Parameters
loanGuid
required
string

The unique GUID of the loan

Request Body schema:

Initiate payment request data, payment service provider unique

paymentServiceProviderCode
string or null

Code of the payment service provider.

amount
number <double>

Payment amount

currencyCode
string or null

Payment currency code

additionalInput
any

A json object used for additional input into payment service provider.

Responses

Request samples

Content type
{
  • "paymentServiceProviderCode": "string",
  • "amount": 0,
  • "currencyCode": "string",
  • "additionalInput": {
    }
}

Response samples

Content type
{
  • "completed": false,
  • "transactionReferenceNumber": "string",
  • "additionalOutput": {
    }
}

Get list of insurances based on specified parameters.

Authorizations:
(oauth2apikey)
query Parameters
$filter
string

Filter conditions specified in a simplified OData format

$skip
integer <int32>

List offset when paginating (default 0)

$top
integer <int32>

Maximum size of result (default 25, max 100)

$orderby
string

Sorting conditions E.g. "fullname desc"

Responses

Response samples

Content type
{
  • "count": 0,
  • "skip": 0,
  • "total": 0,
  • "value": [
    ]
}

Get insurance

Authorizations:
(oauth2apikey)
path Parameters
guid
required
string

The GUID representing the insurance.

Responses

Response samples

Content type
{
  • "creditInsuranceGuid": "string",
  • "type": "string",
  • "insuranceCompany": "string",
  • "status": 0,
  • "reference": "string",
  • "endDate": "2019-08-24T14:15:22Z",
  • "insuranceCalcType": 1,
  • "feePercent": 0,
  • "minPeriodicFee": 0,
  • "insuredAmount": 0,
  • "periodAmount": 0,
  • "maxPeriodicFee": 0,
  • "note": "string",
  • "links": [
    ]
}

Delete insurance by unique identifier.

Authorizations:
(oauth2apikey)
path Parameters
guid
required
string

The unique GUID of the insurnace

Responses

Response samples

Content type
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

Updates an Insurance based on specified parameters.

Authorizations:
(oauth2apikey)
path Parameters
guid
required
string

Insurance GUID identifyer.

Request Body schema:

Insurance detailed information.

type
string or null

Insurance type code

insuranceCompany
string or null

Insurance company reference

status
integer <int32> (InsuranceStatus)
Enum: 0 1 2 3 4
reference
string or null

Insurance reference

endDate
string or null <date-time>

Insruace end date

clearEndDate
boolean or null

Clear insruace end date

insuranceCalcType
integer <int32> (InsuranceCalcType)
Enum: 1 4
feePercent
number or null <double>

Insurance fee amount

minPeriodicFee
number or null <double>

Minumal periodic fee

maxPeriodicFee
number or null <double>

Maximal periodic fee

clearMaxPeriodicFee
boolean or null

Clear maximal periodic fee

insuredAmount
number or null <double>

Insured amount

periodAmount
number or null <double>

Period amount

note
string or null

Note

Responses

Request samples

Content type
{
  • "type": "string",
  • "insuranceCompany": "string",
  • "status": 0,
  • "reference": "string",
  • "endDate": "2019-08-24T14:15:22Z",
  • "clearEndDate": true,
  • "insuranceCalcType": 1,
  • "feePercent": 0,
  • "minPeriodicFee": 0,
  • "maxPeriodicFee": 0,
  • "clearMaxPeriodicFee": true,
  • "insuredAmount": 0,
  • "periodAmount": 0,
  • "note": "string"
}

Response samples

Content type
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

Create insurance

Authorizations:
(oauth2apikey)
path Parameters
guid
required
string
Request Body schema:

Insurance data

type
string or null

Insurance type code

insuranceCompany
string or null

Insurance company reference

status
integer <int32> (InsuranceStatus)
Enum: 0 1 2 3 4
reference
string or null

Insurance reference

endDate
string or null <date-time>

Insruace end date

insuranceCalcType
integer <int32> (InsuranceCalcType)
Enum: 1 4
feePercent
number <double>

Insurance fee amount

minPeriodicFee
number <double>

Minumal periodic fee

maxPeriodicFee
number or null <double>

Maximal periodic fee

note
string or null

Note

Responses

Request samples

Content type
{
  • "type": "string",
  • "insuranceCompany": "string",
  • "status": 0,
  • "reference": "string",
  • "endDate": "2019-08-24T14:15:22Z",
  • "insuranceCalcType": 1,
  • "feePercent": 0,
  • "minPeriodicFee": 0,
  • "maxPeriodicFee": 0,
  • "note": "string"
}

Response samples

Content type
{
  • "creditInsuranceGuid": "string",
  • "type": "string",
  • "insuranceCompany": "string",
  • "status": 0,
  • "reference": "string",
  • "endDate": "2019-08-24T14:15:22Z",
  • "insuranceCalcType": 1,
  • "feePercent": 0,
  • "minPeriodicFee": 0,
  • "insuredAmount": 0,
  • "periodAmount": 0,
  • "maxPeriodicFee": 0,
  • "note": "string"
}

Get list of related 3rd parties based on specified parameters.

Authorizations:
(oauth2apikey)
path Parameters
loanGuid
required
string

Loan guid

query Parameters
$filter
string

Filter conditions specified in a simplified OData format

$skip
integer <int32>

List offset when paginating (default 0)

$top
integer <int32>

Maximum size of result (default 25, max 100)

$orderby
string

Sorting conditions E.g. "fullname desc"

Responses

Response samples

Content type
{
  • "count": 0,
  • "skip": 0,
  • "total": 0,
  • "value": [
    ]
}

Create a new loan relation

Authorizations:
(oauth2apikey)
path Parameters
loanGuid
required
string

Loan guid

Request Body schema:

Relation data

relationType
string or null

Type of relation

PAYING_BANK = Paying bank during a settlement or refinancing

RECEIVING_BANK = Receiving bank during a settlement or refinancing

partyTypeCode
string or null

Type of 3rd party in the relation, e.g. BANK

subCode
string or null

Sub type of 3rd party in the relation, e.g. NL-BAILIFF

partyGuid
string or null

Guid to a 3rd party in the relation

partyReferenceCode
string or null

Reference code to a 3rd party in the relation

partyIdNumber
string or null

Organization number of a 3rd party in the relation

bankAccountGuid
string or null

Bank account guid

validUntil
string or null <date-time>

Limited period of time when this relation is valid

description
string or null

Free text description of the relationship

Responses

Request samples

Content type
{
  • "relationType": "string",
  • "partyTypeCode": "string",
  • "subCode": "string",
  • "partyGuid": "string",
  • "partyReferenceCode": "string",
  • "partyIdNumber": "string",
  • "bankAccountGuid": "string",
  • "validUntil": "2019-08-24T14:15:22Z",
  • "description": "string"
}

Response samples

Content type
{
  • "relationGuid": "string",
  • "relationType": "string",
  • "partyTypeCode": "string",
  • "subCode": "string",
  • "partyName": "string",
  • "bankAccount": "string",
  • "validUntil": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "links": [
    ]
}

Get a specific loan relation

Authorizations:
(oauth2apikey)
path Parameters
loanGuid
required
string

Loan guid

guid
required
string

The GUID representing the relation.

Responses

Response samples

Content type
{
  • "relationGuid": "string",
  • "relationType": "string",
  • "partyTypeCode": "string",
  • "subCode": "string",
  • "partyName": "string",
  • "bankAccount": "string",
  • "validUntil": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "links": [
    ]
}

Updates a loan relation.

Authorizations:
(oauth2apikey)
path Parameters
loanGuid
required
string

Loan guid

guid
required
string

Relation GUID identifier

Request Body schema:

Updated relation information

relationType
string or null

Type of relation

PAYING_BANK = Paying bank during a settlement or refinancing

RECEIVING_BANK = Receiving bank during a settlement or refinancing

bankAccountGuid
string or null

Bank account guid

validUntil
string or null <date-time>

Limited period of time when this relation is valid

description
string or null

Free text description of the relationship

Responses

Request samples

Content type
{
  • "relationType": "string",
  • "bankAccountGuid": "string",
  • "validUntil": "2019-08-24T14:15:22Z",
  • "description": "string"
}

Response samples

Content type
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

Removes a specific loan relation

Authorizations:
(oauth2apikey)
path Parameters
loanGuid
required
string

Loan guid

guid
required
string

The unique GUID of the relation

Responses

Response samples

Content type
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

Invokes a custom action based on a service definition.

Execute custom service definition in CLVR with possibility to pass in JSON into definition.

Authorizations:
(oauth2apikey)
path Parameters
guid
required
string

Account unique id

serviceDefinition
required
string

The invoke service definition request.

query Parameters
async
boolean

Specify if custom action should be performed asynchronously

Request Body schema:

JSON body

any

Responses

Request samples

Content type
{
  • "name1": "string",
  • "name2": false,
  • "name3": {
    }
}

Response samples

Content type
{ }

Invokes a custom action based on a service definition.

Execute custom service definition in CLVR with possibility to pass in JSON into definition.

Authorizations:
(oauth2apikey)
path Parameters
serviceDefinition
required
string

The invoke service definition request.

query Parameters
async
boolean

Specify if custom action should be performed asynchronously

Request Body schema:

JSON body

any

Responses

Request samples

Content type
{
  • "name1": "string",
  • "name2": false,
  • "name3": {
    }
}

Response samples

Content type
{ }

Make a ping request to see that the service is up and running.

This operation enables to check if service is available. The service will return code 200 and an empty json object.

Authorizations:
(oauth2apikey)

Responses

Response samples

Content type
{ }