API docs by Redocly

Aptic API Gateway - Leasing (v1.0)

Download OpenAPI specification:

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

Leasing related API for Aptic solutions

Leasing

Get leasing accounts 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 new leasing contract(s)

Authorizations:
(oauth2apikey)
Request Body schema:

Leasing account information

Array
creditorReference
string or null

Party reference code.

typeCode
string or null

Loan type code.

currencyCode
string or null

Currency code for the leasing account

currentBalance
number or null <double>

Current balance of the leasing account (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.

interestRate
number or null <double>

Leasing account interest rate.

interestType
string or null

Leasing account interest type.

fixedInterestTermStart
string or null <date-time>

Leasing account interest term start date for fixed interest terms.

creditLimit
number or null <double>

Credit limit.

object (ContractBase)

Contract properties

Array of objects or null (LoanCustomer)

List of customers.

Array of objects or null (LeasingAsset)

List of assets (leasing objects)

Array of objects or null (LeaseTerm)

Optional lease terms.

Array of objects or null (PutExtraFieldValue)

List of extra fields.

Array of objects or null (PutDocument)

List of documents for the leasing account.

Array of objects or null (AccountPledge)

List of pledges.

Array of objects or null (AccountInsurance)

List of insurances.

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

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

Get leasing account details based on the unique GUID

Authorizations:
(oauth2apikey)
path Parameters
guid
required
string

The unique GUID of the leasing account

Responses

Response samples

Content type
{
  • "accountGuid": "string",
  • "accountNumber": "string",
  • "typeCode": "string",
  • "description": "string",
  • "creditorType": "Solicitor",
  • "creditorGuid": "string",
  • "creditorRef": "string",
  • "creditorName": "string",
  • "mainCustomerGuid": "string",
  • "mainCustomerFullName": "string",
  • "mainCustomerIdNumber": "string",
  • "currencyCode": "EUR, USD, SEK, NOK, DKK",
  • "registrationDate": "2019-08-24T14:15:22Z",
  • "creditInterestRate": 0.1,
  • "creditInterestType": "string",
  • "interestMarginCode": "string",
  • "currentCreditInterestRate": 0.1,
  • "actionStatusCode": "string",
  • "actionSubStatusCode": "string",
  • "accountDescription": "string",
  • "contractNumber": "string",
  • "contractDate": "2019-08-24T14:15:22Z",
  • "issueDate": "2019-08-24T14:15:22Z",
  • "originationCode": "string",
  • "billedPrincipal": 0.1,
  • "billedInterest": 0.1,
  • "settlementFee": 0.1,
  • "registrationFee": 0.1,
  • "remainingPrincipal": 0.1,
  • "remainingInterest": 0.1,
  • "remainingFee": 0.1,
  • "remainingBilledPrincipal": 0.1,
  • "remainingBilledInterest": 0.1,
  • "remainingDuePrincipal": 0.1,
  • "remainingDueInterest": 0.1,
  • "remainingPenaltyInterestOnPrincipal": 0.1,
  • "remainingPenaltyInterestOnInterest": 0.1,
  • "daysPassedDuePrincipal": 0,
  • "daysPassedDueInterest": 0,
  • "paymentReference": "string",
  • "paymentBankAccountNumber": "string",
  • "creditApplicationStatus": 0,
  • "reminderCount": 0,
  • "amountSpecification": [
    ],
  • "assets": [
    ],
  • "leaseTerms": [
    ],
  • "links": [
    ]
}

Update leasing contract

Authorizations:
(oauth2apikey)
path Parameters
guid
required
string

The unique GUID of the leasing contract

Request Body schema:

Leasing account detail information

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.

settlementFee
number or null <double>

Settlement fee.

paymentReference
string or null

Payment reference.

Array of objects or null (LeasingAsset)

List of assets (leasing objects)

Array of objects or null (LeaseTerm)

Optional lease terms.

Responses

Request samples

Content type
{
  • "description": "string",
  • "accountDescription": "string",
  • "contractNumber": "string",
  • "contractDate": "2019-08-24T14:15:22Z",
  • "settlementFee": 0.1,
  • "paymentReference": "string",
  • "assets": [
    ],
  • "leaseTerms": [
    ]
}

Response samples

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

Get leasing account documents using filters

Authorizations:
(oauth2apikey)
path Parameters
leasingAccountGuid
required
string

Leasing account 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 leasing account

Authorizations:
(oauth2apikey)
path Parameters
leasingAccountGuid
required
string

Leasing account 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 leasing document details based on the unique GUID for leasing account and document

Authorizations:
(oauth2apikey)
path Parameters
leasingAccountGuid
required
string

The unique GUID of the leasing account

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": [
    ]
}

Get leasing account extra fields using filters

Authorizations:
(oauth2apikey)
path Parameters
leasingAccountGuid
required
string

Leasing account 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 leasing account extra field

Authorizations:
(oauth2apikey)
path Parameters
leasingAccountGuid
required
string

The unique GUID of the leasing account

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 leasing account extra field details based on the unique GUID and extra field name

Authorizations:
(oauth2apikey)
path Parameters
name
required
string

The name of the extra field

loanGuid
required
string
query Parameters
leasingAccountGuid
string

The unique GUID of the leasing account

Responses

Response samples

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

Updates a leasing account extra field

Authorizations:
(oauth2apikey)
path Parameters
leasingAccountGuid
required
string

The unique GUID of the leasing account

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 leasing account extra field

Authorizations:
(oauth2apikey)
path Parameters
leasingAccountGuid
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
}

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
{ }