API docs by Redocly

Aptic API Gateway - Clients (v1.0)

Download OpenAPI specification:Download

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

Clients related API for Aptic solutions

Clients

Get clients 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 client

Authorizations:
(oauth2apikey)
Request Body schema:
referenceCode
string or null

Client's client number.

parentPartyUniqueId
string or null

Parent client's unique identifier.

ledgerType
integer or null <int32>

Ledger Type.

informalName
string or null

Informal name of the client

fullName
string or null

Legal name of the client

contactPerson
string or null

Primary contact person

idNumber
string or null

Organisation number

street
string or null

Main address - Street

houseNo
string or null

Main address - House number

houseNoExtension
string or null

Main address - House number extension

city
string or null

Main address - City

zipCode
string or null

Main address - ZipCode

stateCode
string or null

Main address - State code

countryCode
string or null

Main address - Country code

companyPhone
string or null

Client company PBX phone number

cellularPhone
string or null

Client contact person cellular phone

email
string or null

Client company email

webPage
string or null

Client company web page

vatNumber
string or null

VAT number

vatRate
number or null <double>

VAT rate

municipalCode
string or null

Municipal code

naceCode
string or null

NACE code

leiNumber
string or null

LEI number

glnNumber
string or null

GLN number

registeredForTAX
boolean or null

Client is registered for tax

languageCode
string or null

Perferred language code

currencyCode
string or null

Client ledger currency code

active
boolean or null

Client is active

blocked
boolean or null

Client is blocked for remittance

companyType
integer or null <int32>

Client company type

1 = SE, Stat, landsting eller kommun

2 = SE, Aktiebolag

3 = SE, Ekonomisk förening

4 = SE, Stiftelse eller ideell förening

5 = SE, Handelsbolag, kommanditbolag

6 = GB, Limited company

7 = GB, Public limited company

8 = FI, Yksityinen elinkeinonharjoittaja

9 = FI, Kommandiittiyhtiö (KY)

10 = FI, Avoin yhtiö

11 = FI, Osakeyhtiö (OY, Oyj)

12 = FI, Osuuskunta (Osk.)

13 = FI, Rekisteröity yhdistys (Ry)

14 = NL, Eenmanszaak

15 = NL, Besloten Vennootschap

16 = NL, Naamloze Vennootschap

17 = NL, Maatschap

18 = NL, Vennootschap onder Firma

19 = NL, Commanditaire Vennootschap

20 = NL, Vereniging met volledige rechtsbevoegdheid

21 = NL, Vereniging mt beperkte volledige rechtsbevoegdheid

22 = NL, Cooperatieve/ Onderlinge waarborgmaatschappij

23 = NL, Stichting

24 = NL, Kerkgenootschap

25 = NL, Vereniging van eigenaars

26 = NL, Overheid

27 = NL, Buitenlandse vennootschap

28 = FI, Säätiö

29 = FI, Asunto-Osakeyhtiö

30 = FI, Kiinteistöosakeyhtiö

defaultCultureCode
string or null

Client's preferred culture code

countryCodeOfOperation
string or null

Country where the client is operational

logotype
string or null

Base64 encoded PNG logotype for the client to use in documents

webLogotype
string or null

Base64 encoded PNG logotype for the client to use in web portals

pricelistTemplate
string or null

Name of default pricelist template to apply to the client

parameterTemplate
string or null

Name of default parameter template to apply to the client

chartOfAccountTemplate
string or null

Name of chart of account template to apply to the client

Responses

Request samples

Content type
{
  • "referenceCode": "string",
  • "parentPartyUniqueId": "string",
  • "ledgerType": 0,
  • "informalName": "string",
  • "fullName": "string",
  • "contactPerson": "string",
  • "idNumber": "string",
  • "street": "string",
  • "houseNo": "string",
  • "houseNoExtension": "string",
  • "city": "string",
  • "zipCode": "string",
  • "stateCode": "string",
  • "countryCode": "string",
  • "companyPhone": "string",
  • "cellularPhone": "string",
  • "email": "string",
  • "webPage": "string",
  • "vatNumber": "string",
  • "vatRate": 0,
  • "municipalCode": "string",
  • "naceCode": "string",
  • "leiNumber": "string",
  • "glnNumber": "string",
  • "registeredForTAX": true,
  • "languageCode": "string",
  • "currencyCode": "string",
  • "active": true,
  • "blocked": true,
  • "companyType": 0,
  • "defaultCultureCode": "string",
  • "countryCodeOfOperation": "string",
  • "logotype": "string",
  • "webLogotype": "string",
  • "pricelistTemplate": "string",
  • "parameterTemplate": "string",
  • "chartOfAccountTemplate": "string"
}

Response samples

Content type
{
  • "uniqueId": "string",
  • "referenceCode": "string",
  • "masterPinCode": "string",
  • "informalName": "string",
  • "fullName": "string",
  • "contactPerson": "string",
  • "street": "string",
  • "houseNo": "string",
  • "houseNoExtension": "string",
  • "city": "string",
  • "zipCode": "string",
  • "stateCode": "string",
  • "countryCode": "string",
  • "fullAddress": "string",
  • "idNumber": "string",
  • "companyPhone": "string",
  • "cellularPhone": "string",
  • "email": "string",
  • "webPage": "string",
  • "vatNumber": "string",
  • "vatRate": 0,
  • "municipalCode": "string",
  • "naceCode": "string",
  • "leiNumber": "string",
  • "glnNumber": "string",
  • "registeredForTAX": true,
  • "languageCode": "string",
  • "currencyCode": "string",
  • "active": true,
  • "blocked": true,
  • "companyType": 0,
  • "defaultCultureCode": "string",
  • "countryCodeOfOperation": "string",
  • "addresses": [
    ],
  • "links": [
    ]
}

Get client details based on the unique GUID

Authorizations:
(oauth2apikey)
path Parameters
clientGuid
required
string

The unique GUID of the client

Responses

Response samples

Content type
{
  • "uniqueId": "string",
  • "referenceCode": "string",
  • "masterPinCode": "string",
  • "informalName": "string",
  • "fullName": "string",
  • "contactPerson": "string",
  • "street": "string",
  • "houseNo": "string",
  • "houseNoExtension": "string",
  • "city": "string",
  • "zipCode": "string",
  • "stateCode": "string",
  • "countryCode": "string",
  • "fullAddress": "string",
  • "idNumber": "string",
  • "companyPhone": "string",
  • "cellularPhone": "string",
  • "email": "string",
  • "webPage": "string",
  • "vatNumber": "string",
  • "vatRate": 0,
  • "municipalCode": "string",
  • "naceCode": "string",
  • "leiNumber": "string",
  • "glnNumber": "string",
  • "registeredForTAX": true,
  • "languageCode": "string",
  • "currencyCode": "string",
  • "active": true,
  • "blocked": true,
  • "companyType": 0,
  • "defaultCultureCode": "string",
  • "countryCodeOfOperation": "string",
  • "addresses": [
    ],
  • "links": [
    ]
}

Updates a client

Authorizations:
(oauth2apikey)
path Parameters
clientGuid
required
string
Request Body schema:
referenceCode
string or null

Client's client number.

informalName
string or null

Informal name of the client

fullName
string or null

Legal name of the client

contactPerson
string or null

Primary contact person

idNumber
string or null

Organisation number

companyPhone
string or null

Client company PBX phone number

cellularPhone
string or null

Client contact person cellular phone

email
string or null

Client company email

webPage
string or null

Client company web page

vatNumber
string or null

VAT number

vatRate
number <double>

VAT rate

municipalCode
string or null

Municipal code

naceCode
string or null

NACE code

leiNumber
string or null

LEI number

glnNumber
string or null

GLN number

registeredForTAX
boolean or null

Client is registered for tax

languageCode
string or null

Perferred language code

active
boolean or null

Client is active

blocked
boolean or null

Client is blocked for remittance

companyType
integer or null <int32>

Client company type

1 = SE, Stat, landsting eller kommun

2 = SE, Aktiebolag

3 = SE, Ekonomisk förening

4 = SE, Stiftelse eller ideell förening

5 = SE, Handelsbolag, kommanditbolag

6 = GB, Limited company

7 = GB, Public limited company

8 = FI, Yksityinen elinkeinonharjoittaja

9 = FI, Kommandiittiyhtiö (KY)

10 = FI, Avoin yhtiö

11 = FI, Osakeyhtiö (OY, Oyj)

12 = FI, Osuuskunta (Osk.)

13 = FI, Rekisteröity yhdistys (Ry)

14 = NL, Eenmanszaak

15 = NL, Besloten Vennootschap

16 = NL, Naamloze Vennootschap

17 = NL, Maatschap

18 = NL, Vennootschap onder Firma

19 = NL, Commanditaire Vennootschap

20 = NL, Vereniging met volledige rechtsbevoegdheid

21 = NL, Vereniging mt beperkte volledige rechtsbevoegdheid

22 = NL, Cooperatieve/ Onderlinge waarborgmaatschappij

23 = NL, Stichting

24 = NL, Kerkgenootschap

25 = NL, Vereniging van eigenaars

26 = NL, Overheid

27 = NL, Buitenlandse vennootschap

28 = FI, Säätiö

29 = FI, Asunto-Osakeyhtiö

30 = FI, Kiinteistöosakeyhtiö

defaultCultureCode
string or null

Client's preferred culture code

countryCodeOfOperation
string or null

Country where the client is operational

logotype
string or null

Base64 encoded PNG logotype for the client to use in documents

webLogotype
string or null

Base64 encoded PNG logotype for the client to use in web portals

Responses

Request samples

Content type
{
  • "referenceCode": "string",
  • "informalName": "string",
  • "fullName": "string",
  • "contactPerson": "string",
  • "idNumber": "string",
  • "companyPhone": "string",
  • "cellularPhone": "string",
  • "email": "string",
  • "webPage": "string",
  • "vatNumber": "string",
  • "vatRate": 0,
  • "municipalCode": "string",
  • "naceCode": "string",
  • "leiNumber": "string",
  • "glnNumber": "string",
  • "registeredForTAX": true,
  • "languageCode": "string",
  • "active": true,
  • "blocked": true,
  • "companyType": 0,
  • "defaultCultureCode": "string",
  • "countryCodeOfOperation": "string",
  • "logotype": "string",
  • "webLogotype": "string"
}

Response samples

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

Deletes a client

Authorizations:
(oauth2apikey)
path Parameters
clientGuid
required
string

Responses

Response samples

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

Get clients summary

Authorizations:
(oauth2apikey)
query Parameters
$select
string

Selects parts of summary to request

$expand
string

Expand summary with additional objects

Responses

Response samples

Content type
{
  • "accessableClients": 0,
  • "myClients": 0,
  • "favorites": {
    },
  • "latestOpened": {
    },
  • "charts": [
    ]
}

Get specific client summary

Authorizations:
(oauth2apikey)
path Parameters
clientGuid
required
string

The unique GUID of the client

query Parameters
$select
string

Selects parts of summary to request

$expand
string

Expand summary with additional objects

Responses

Response samples

Content type
{
  • "referenceCode": "string",
  • "fullName": "string",
  • "invoices": 0,
  • "purchasedInvoices": 0,
  • "accounts": 0,
  • "cases": 0,
  • "charts": [
    ]
}

Get client contract

Authorizations:
(oauth2apikey)
path Parameters
clientGuid
required
string

Client guid

Responses

Response samples

Content type
{
  • "contractType": 0,
  • "contractNumber": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "invoiceDate": "2019-08-24T14:15:22Z",
  • "cancelDate": "2019-08-24T14:15:22Z",
  • "idNumber": "string",
  • "contractCancelReason": "string",
  • "periodFee": 0,
  • "contractLength": 0,
  • "periodLength": 0,
  • "note": "string",
  • "customerCategory": "string",
  • "instructions": "string",
  • "invoiceItem": "string"
}

Creates a new client contract

Authorizations:
(oauth2apikey)
path Parameters
clientGuid
required
string

Client guid

Request Body schema:

Client contract details

contractType
integer or null <int32>

Contract type.

contractNumber
string or null

Contract number.

startDate
string or null <date-time>

Contract commencement date.

endDate
string or null <date-time>

Contract expiration date.

invoiceDate
string or null <date-time>

Contract invoice date.

cancelDate
string or null <date-time>

Contract cancel date.

idNumber
string or null

Organisation number

contractCancelReason
string or null

Contract cancel reason.

periodFee
number or null <double>

Contract period fee.

contractLength
integer or null <int32>

Contract duration (month).

periodLength
integer or null <int32>

Contract period duration (month).

note
string or null

Contract note.

customerCategory
string or null

Customer category id (lookup to cfg_customercategory).

instructions
string or null

Special instructions to the agents.

invoiceItem
string or null

Invoice item number for contract period fee.

Responses

Request samples

Content type
{
  • "contractType": 0,
  • "contractNumber": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "invoiceDate": "2019-08-24T14:15:22Z",
  • "cancelDate": "2019-08-24T14:15:22Z",
  • "idNumber": "string",
  • "contractCancelReason": "string",
  • "periodFee": 0,
  • "contractLength": 0,
  • "periodLength": 0,
  • "note": "string",
  • "customerCategory": "string",
  • "instructions": "string",
  • "invoiceItem": "string"
}

Response samples

Content type
{
  • "contractType": 0,
  • "contractNumber": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "invoiceDate": "2019-08-24T14:15:22Z",
  • "cancelDate": "2019-08-24T14:15:22Z",
  • "idNumber": "string",
  • "contractCancelReason": "string",
  • "periodFee": 0,
  • "contractLength": 0,
  • "periodLength": 0,
  • "note": "string",
  • "customerCategory": "string",
  • "instructions": "string",
  • "invoiceItem": "string"
}

Updates a client contract

Authorizations:
(oauth2apikey)
path Parameters
clientGuid
required
string

Client guid

Request Body schema:

Client contract details

contractType
integer or null <int32>

Contract type.

contractNumber
string or null

Contract number.

startDate
string or null <date-time>

Contract commencement date.

endDate
string or null <date-time>

Contract expiration date.

invoiceDate
string or null <date-time>

Contract invoice date.

cancelDate
string or null <date-time>

Contract cancel date.

idNumber
string or null

Organisation number

contractCancelReason
string or null

Contract cancel reason.

periodFee
number or null <double>

Contract period fee.

contractLength
integer or null <int32>

Contract duration (month).

periodLength
integer or null <int32>

Contract period duration (month).

note
string or null

Contract note.

customerCategory
string or null

Customer category id (lookup to cfg_customercategory).

instructions
string or null

Special instructions to the agents.

invoiceItem
string or null

Invoice item number for contract period fee.

Responses

Request samples

Content type
{
  • "contractType": 0,
  • "contractNumber": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "invoiceDate": "2019-08-24T14:15:22Z",
  • "cancelDate": "2019-08-24T14:15:22Z",
  • "idNumber": "string",
  • "contractCancelReason": "string",
  • "periodFee": 0,
  • "contractLength": 0,
  • "periodLength": 0,
  • "note": "string",
  • "customerCategory": "string",
  • "instructions": "string",
  • "invoiceItem": "string"
}

Response samples

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

Deletes a client contract

Authorizations:
(oauth2apikey)
path Parameters
clientGuid
required
string

Client guid

Responses

Response samples

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

Get client factoring loan contract

Authorizations:
(oauth2apikey)
path Parameters
clientGuid
required
string

Client guid

Responses

Response samples

Content type
{
  • "decisionDate": "2019-08-24T14:15:22Z",
  • "limit": 0,
  • "autopercent": 0,
  • "maxpercent": 0,
  • "yourReference": "string",
  • "ourReference": "string",
  • "interestRate": 0,
  • "interestCode": "string",
  • "limitFeeAmount": 0,
  • "limitFeePercentage": 0,
  • "limitFeeInterval": 0,
  • "limitFeeDate": "2019-08-24T14:15:22Z",
  • "limitFeeInvoiceItem": "string",
  • "note": "string"
}

Creates a new client factoring loan contract

Authorizations:
(oauth2apikey)
path Parameters
clientGuid
required
string

Client guid

Request Body schema:

Client factoring loan contract details

decisionDate
string or null <date-time>

Decision date.

limit
number or null <double>

Limit value.

autopercent
number or null <double>

Auto percent value (a percentage from 0 to 100).

maxpercent
number or null <double>

Max percent value (a percentage from 0 to 100).

yourReference
string or null

Your reference value.

ourReference
string or null

Our reference value.

interestRate
number or null <double>

Interest rate in percent.

interestCode
string or null

Interest code value (cfg_interest).

limitFeeAmount
number or null <double>

Limit fee amount.

limitFeePercentage
number or null <double>

Limit fee in percentage.

limitFeeInterval
integer or null <int32>

Limit fee interval specified as interest days.

limitFeeDate
string or null <date-time>

Next date to charge limit fee.

limitFeeInvoiceItem
string or null

Invoice item to use when carging limit fee

limitFeePartOfPeriod
boolean or null

Charge limit fee for part of starting period

limitFeePartOfPeriodAmount
number or null <double>

Amount to charge as limit fee for starting period

note
string or null

Factoring loan contract note.

Responses

Request samples

Content type
{
  • "decisionDate": "2019-08-24T14:15:22Z",
  • "limit": 0,
  • "autopercent": 0,
  • "maxpercent": 0,
  • "yourReference": "string",
  • "ourReference": "string",
  • "interestRate": 0,
  • "interestCode": "string",
  • "limitFeeAmount": 0,
  • "limitFeePercentage": 0,
  • "limitFeeInterval": 0,
  • "limitFeeDate": "2019-08-24T14:15:22Z",
  • "limitFeeInvoiceItem": "string",
  • "limitFeePartOfPeriod": true,
  • "limitFeePartOfPeriodAmount": 0,
  • "note": "string"
}

Response samples

Content type
{
  • "decisionDate": "2019-08-24T14:15:22Z",
  • "limit": 0,
  • "autopercent": 0,
  • "maxpercent": 0,
  • "yourReference": "string",
  • "ourReference": "string",
  • "interestRate": 0,
  • "interestCode": "string",
  • "limitFeeAmount": 0,
  • "limitFeePercentage": 0,
  • "limitFeeInterval": 0,
  • "limitFeeDate": "2019-08-24T14:15:22Z",
  • "limitFeeInvoiceItem": "string",
  • "note": "string"
}

Updates a client factoring loan contract

Authorizations:
(oauth2apikey)
path Parameters
clientGuid
required
string

Client guid

Request Body schema:

Client contract details

decisionDate
string or null <date-time>

Decision date.

limit
number or null <double>

Limit value.

autopercent
number or null <double>

Auto percent value (a percentage from 0 to 100).

maxpercent
number or null <double>

Max percent value (a percentage from 0 to 100).

yourReference
string or null

Your reference value.

ourReference
string or null

Our reference value.

interestRate
number or null <double>

Interest rate in percent.

interestCode
string or null

Interest code value (cfg_interest).

limitFeeAmount
number or null <double>

Limit fee amount.

limitFeePercentage
number or null <double>

Limit fee in percentage.

limitFeeInterval
integer or null <int32>

Limit fee interval specified as interest days.

limitFeeDate
string or null <date-time>

Next date to charge limit fee.

limitFeeInvoiceItem
string or null

Invoice item to use when carging limit fee

note
string or null

Factoring loan contract note.

Responses

Request samples

Content type
{
  • "decisionDate": "2019-08-24T14:15:22Z",
  • "limit": 0,
  • "autopercent": 0,
  • "maxpercent": 0,
  • "yourReference": "string",
  • "ourReference": "string",
  • "interestRate": 0,
  • "interestCode": "string",
  • "limitFeeAmount": 0,
  • "limitFeePercentage": 0,
  • "limitFeeInterval": 0,
  • "limitFeeDate": "2019-08-24T14:15:22Z",
  • "limitFeeInvoiceItem": "string",
  • "note": "string"
}

Response samples

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

Deletes a client factoring loan contract

Authorizations:
(oauth2apikey)
path Parameters
clientGuid
required
string

Client guid

Responses

Response samples

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

Get current summary of client factoring loan

Authorizations:
(oauth2apikey)
path Parameters
clientGuid
required
string

Client guid

Responses

Response samples

Content type
{
  • "untransactedInterest": 0,
  • "totalCreditorFeeAmount": 0,
  • "currentBalance": 0,
  • "currentPercent": 0,
  • "totalInvoiceAmount": 0,
  • "totalPledgeAmount": 0,
  • "totLoanAvailable": 0,
  • "maxAvailable": 0,
  • "autoAvailable": 0
}

Get latest transactions from client factoring loan

Authorizations:
(oauth2apikey)
path Parameters
clientGuid
required
string

Client guid

Responses

Response samples

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

Get client factoring purchase contract

Authorizations:
(oauth2apikey)
path Parameters
clientGuid
required
string

Client guid

Responses

Response samples

Content type
{
  • "active": true,
  • "decisionDate": "2019-08-24T14:15:22Z",
  • "deposit": "string",
  • "limit": 0,
  • "customerLimit": 0,
  • "recourseLimit": 0,
  • "nonRecourseLimit": 0,
  • "defaultGroupLimit": 0,
  • "recourse": true,
  • "recourseDays": 0,
  • "blockedAccount": "string",
  • "blockedAccountTotal": 0,
  • "blockedAccountInterestRate": 0,
  • "blockedAccountInterestCode": "string",
  • "note": "string",
  • "overInterestAfterDays": 0,
  • "overInterestRate": 0,
  • "overInterestCode": "string",
  • "financingInterestCalculateFrom": 0,
  • "financingInterestCalculateTo": 0,
  • "financingInterestFeeInsertTrigger": 0,
  • "financingInterestRate": 0,
  • "financingInterestCode": "string"
}

Creates a new client factoring purchase contract

Authorizations:
(oauth2apikey)
path Parameters
clientGuid
required
string

Client guid

Request Body schema:

Client factoring purchase contract details

active
boolean or null

Is the purchase contract active?

decisionDate
string or null <date-time>

Decision date.

deposit
string or null

Deposit code, amount or percentage

limit
number or null <double>

Limit for the client.

customerLimit
number or null <double>

Limit for a single customer.

recourseLimit
number or null <double>

Total limit for att invoices purchased with recourse.

nonRecourseLimit
number or null <double>

Total limit for att invoices purchased without recourse.

defaultGroupLimit
number or null <double>

Default group limit

recourse
boolean or null

Purchase with recourse?

recourseDays
integer or null <int32>

Number of days after due date before automatic recourse

blockedAccount
string or null

Maximum amount to reserve on blocked account per invoice, amount or percentage

blockedAccountTotal
number or null <double>

Maximum amount to reserve on blocked account

blockedAccountInterestRate
number or null <double>

Interest rate for blocked account

blockedAccountInterestCode
string or null

Interest code for Blocked Account (cfg_interest).

note
string or null

Contract note (max 2000 characters)

overInterestAfterDays
integer or null <int32>

Number of days after due date before over interest calculation

overInterestRate
number or null <double>

Over-interest rate in percent.

overInterestCode
string or null

Over-interest code value (cfg_interest).

financingInterestCalculateFrom
integer or null <int32>

Start calculating financing interest calculation from

1 = Bill date

2 = Registration date

3 = Due date

4 = Purchase date

5 = Recourse date

financingInterestCalculateTo
integer or null <int32>

End calculating financing interest calculation at

1 = Bill date

2 = Registration date

3 = Due date

4 = Purchase date

5 = Recourse date

6 = Closure date

financingInterestFeeInsertTrigger
integer or null <int32>

Trigger financing interest fee at

1 = Purchase

2 = Recourse

3 = Closure

4 = Full payment

financingInterestRate
number or null <double>

Financing interest rate in percent.

financingInterestCode
string or null

Financing interest code value (cfg_interest).

Responses

Request samples

Content type
{
  • "active": true,
  • "decisionDate": "2019-08-24T14:15:22Z",
  • "deposit": "string",
  • "limit": 0,
  • "customerLimit": 0,
  • "recourseLimit": 0,
  • "nonRecourseLimit": 0,
  • "defaultGroupLimit": 0,
  • "recourse": true,
  • "recourseDays": 0,
  • "blockedAccount": "string",
  • "blockedAccountTotal": 0,
  • "blockedAccountInterestRate": 0,
  • "blockedAccountInterestCode": "string",
  • "note": "string",
  • "overInterestAfterDays": 0,
  • "overInterestRate": 0,
  • "overInterestCode": "string",
  • "financingInterestCalculateFrom": 0,
  • "financingInterestCalculateTo": 0,
  • "financingInterestFeeInsertTrigger": 0,
  • "financingInterestRate": 0,
  • "financingInterestCode": "string"
}

Response samples

Content type
{
  • "active": true,
  • "decisionDate": "2019-08-24T14:15:22Z",
  • "deposit": "string",
  • "limit": 0,
  • "customerLimit": 0,
  • "recourseLimit": 0,
  • "nonRecourseLimit": 0,
  • "defaultGroupLimit": 0,
  • "recourse": true,
  • "recourseDays": 0,
  • "blockedAccount": "string",
  • "blockedAccountTotal": 0,
  • "blockedAccountInterestRate": 0,
  • "blockedAccountInterestCode": "string",
  • "note": "string",
  • "overInterestAfterDays": 0,
  • "overInterestRate": 0,
  • "overInterestCode": "string",
  • "financingInterestCalculateFrom": 0,
  • "financingInterestCalculateTo": 0,
  • "financingInterestFeeInsertTrigger": 0,
  • "financingInterestRate": 0,
  • "financingInterestCode": "string"
}

Updates a client factoring purchase contract

Authorizations:
(oauth2apikey)
path Parameters
clientGuid
required
string

Client guid

Request Body schema:

Client contract details

active
boolean or null

Is the purchase contract active?

decisionDate
string or null <date-time>

Decision date.

deposit
string or null

Deposit code, amount or percentage

limit
number or null <double>

Limit for the client.

customerLimit
number or null <double>

Limit for a single customer.

recourseLimit
number or null <double>

Total limit for att invoices purchased with recourse.

nonRecourseLimit
number or null <double>

Total limit for att invoices purchased without recourse.

defaultGroupLimit
number or null <double>

Default group limit

recourse
boolean or null

Purchase with recourse?

recourseDays
integer or null <int32>

Number of days after due date before automatic recourse

blockedAccount
string or null

Maximum amount to reserve on blocked account per invoice, amount or percentage

blockedAccountTotal
number or null <double>

Maximum amount to reserve on blocked account

blockedAccountInterestRate
number or null <double>

Interest rate for blocked account

blockedAccountInterestCode
string or null

Interest code for Blocked Account (cfg_interest).

note
string or null

Contract note (max 2000 characters)

overInterestAfterDays
integer or null <int32>

Number of days after due date before over interest calculation

overInterestRate
number or null <double>

Over-interest rate in percent.

overInterestCode
string or null

Over-interest code value (cfg_interest).

financingInterestCalculateFrom
integer or null <int32>

Start calculating financing interest calculation from

1 = Bill date

2 = Registration date

3 = Due date

4 = Purchase date

5 = Recourse date

financingInterestCalculateTo
integer or null <int32>

End calculating financing interest calculation at

1 = Bill date

2 = Registration date

3 = Due date

4 = Purchase date

5 = Recourse date

6 = Closure date

financingInterestFeeInsertTrigger
integer or null <int32>

Trigger financing interest fee at

1 = Purchase

2 = Recourse

3 = Closure

4 = Full payment

financingInterestRate
number or null <double>

Financing interest rate in percent.

financingInterestCode
string or null

Financing interest code value (cfg_interest).

Responses

Request samples

Content type
{
  • "active": true,
  • "decisionDate": "2019-08-24T14:15:22Z",
  • "deposit": "string",
  • "limit": 0,
  • "customerLimit": 0,
  • "recourseLimit": 0,
  • "nonRecourseLimit": 0,
  • "defaultGroupLimit": 0,
  • "recourse": true,
  • "recourseDays": 0,
  • "blockedAccount": "string",
  • "blockedAccountTotal": 0,
  • "blockedAccountInterestRate": 0,
  • "blockedAccountInterestCode": "string",
  • "note": "string",
  • "overInterestAfterDays": 0,
  • "overInterestRate": 0,
  • "overInterestCode": "string",
  • "financingInterestCalculateFrom": 0,
  • "financingInterestCalculateTo": 0,
  • "financingInterestFeeInsertTrigger": 0,
  • "financingInterestRate": 0,
  • "financingInterestCode": "string"
}

Response samples

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

Deletes a client factoring loan contract

Authorizations:
(oauth2apikey)
path Parameters
clientGuid
required
string

Client guid

Responses

Response samples

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

Get current summary of client factoring purchases

Authorizations:
(oauth2apikey)
path Parameters
clientGuid
required
string

Client guid

Responses

Response samples

Content type
{
  • "numberOfInvoices": 0,
  • "currentPurchaseNonRecourse": 0,
  • "currentPurchaseRecourse": 0,
  • "currentPurchase": 0,
  • "remainingDeposit": 0,
  • "totalNumberOfInvoices": 0,
  • "totalPurchaseNonRecourse": 0,
  • "totalPurchaseRecourse": 0,
  • "totalPurchase": 0,
  • "totalDeposit": 0
}

Insert client pricelist

Authorizations:
(oauth2apikey)
path Parameters
clientGuid
required
string

Client guid

Request Body schema:

Pricelist details

pricelistName
string or null

Pricelist name

currencyCode
string or null

Pricelist currency code

isActive
boolean

Pricelist active status

serviceId
integer <int32>

Service ID

isDefaultPricelist
boolean

Default pricelist indicator

condition
string or null

Pricelist condition

validFrom
string <date-time>

Pricelist valid from date

creditorFeeEvents
boolean

Creditor fee event indicator

templatePricelistId
integer <int32>

Template pricelist ID

Responses

Request samples

Content type
{
  • "pricelistName": "string",
  • "currencyCode": "string",
  • "isActive": true,
  • "serviceId": 0,
  • "isDefaultPricelist": true,
  • "condition": "string",
  • "validFrom": "2019-08-24T14:15:22Z",
  • "creditorFeeEvents": true,
  • "templatePricelistId": 0
}

Response samples

Content type
{
  • "pricelistGUID": "string"
}

Insert client pricelist

Authorizations:
(oauth2apikey)
path Parameters
clientGuid
required
string

Client guid

Responses

Response samples

Content type
{
  • "templates": [
    ],
  • "services": [
    ]
}

Get client bank accounts using filters

Authorizations:
(oauth2apikey)
path Parameters
clientGuid
required
string

Client 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 client bank account

Authorizations:
(oauth2apikey)
path Parameters
clientGuid
required
string

Client guid

Request Body schema:

Bank account

bankaccountNo
string or null

Bank account number.

description
string or null

Short description to identifiy the bank account.

bankaccountClass
integer or null <int32>

Bank account class. Can be used in export files to determine layout.

0 = Unknown.

1 = Plusgiro (Sweden).

2 = Bankgiro (Sweden).

3 = Bank account (Netherlands).

4 = Foreign bank account

5 = Bankgiro (Denmark)

7 = Bankgiro (Norway)

8 = Bankaccount (Norway)

9 = Bankaccount(Sweden)

10 = Bank account (Finland)

ownerType
integer <int32>

To who does the bank account belong.

1 = Solicitor (internal)

2 = Creditor (external)

3 = Debtor (external)

4 = Shared (external with creditor account settlement)

internalCode
string or null

Internal code of the bank account.

priority
integer or null <int32>

Priority when multiple bank accounts are suitable.

agreementNo
string or null

Agreement number of the bank account.

bankCode
string or null

Code identifying the bank holding the bank account.

bankDescription
string or null

Name or description of the bank holding the bank account.

countryCode
string or null

Country code of the bank holding the bank account.

zipCode
string or null

Postal zip code to the bank holding the bank account.

city
string or null

City where the bank is holding the bank account.

allowPayments
integer or null <int32>

Is the bank account available for payments or nettings?

0 = No

1 = Payments

2 = Nettings

allowDisbursementsFrom
boolean or null

Is it allowed to disburse from the bank account?

allowDisbursementsTo
boolean or null

Is it allowed to disburse to the bank account?

businessAccount
boolean or null

Is this the business account?

thirdPartyRemittance
boolean or null

Is this account used for 3rd party remittences, like from the bailiff?

powerOfAttorney
boolean or null

Do we have a power of attorney agreement on this bank account?

currencyCode
string or null

Currency code the bank account.

iban
string or null

IBAN number of the bank account.

bic
string or null

BIC code of the bank holding the bank account.

blz
string or null

BLZ number of the bank account.

swift
string or null

Swift number of the bank account.

Responses

Request samples

Content type
{
  • "bankaccountNo": "string",
  • "description": "string",
  • "bankaccountClass": 0,
  • "ownerType": 0,
  • "internalCode": "string",
  • "priority": 0,
  • "agreementNo": "string",
  • "bankCode": "string",
  • "bankDescription": "string",
  • "countryCode": "string",
  • "zipCode": "string",
  • "city": "string",
  • "allowPayments": 0,
  • "allowDisbursementsFrom": true,
  • "allowDisbursementsTo": true,
  • "businessAccount": true,
  • "thirdPartyRemittance": true,
  • "powerOfAttorney": true,
  • "currencyCode": "string",
  • "iban": "string",
  • "bic": "string",
  • "blz": "string",
  • "swift": "string"
}

Response samples

Content type
{
  • "bankaccountGuid": "string",
  • "bankaccountNo": "string",
  • "description": "string",
  • "bankaccountClass": 0,
  • "ownerType": 0,
  • "internalCode": "string",
  • "priority": 0,
  • "agreementNo": "string",
  • "bankCode": "string",
  • "bankDescription": "string",
  • "countryCode": "string",
  • "zipCode": "string",
  • "city": "string",
  • "allowPayments": 0,
  • "allowDisbursementsFrom": true,
  • "allowDisbursementsTo": true,
  • "businessAccount": true,
  • "thirdPartyRemittance": true,
  • "powerOfAttorney": true,
  • "currencyCode": "string",
  • "accountBalance": 0,
  • "iban": "string",
  • "bic": "string",
  • "blz": "string",
  • "swift": "string",
  • "links": [
    ]
}

Get client bank account based on the unique GUID

Authorizations:
(oauth2apikey)
path Parameters
clientGuid
required
string

The unique GUID of the client

bankaccountGuid
required
string

The unique GUID of the bank account

Responses

Response samples

Content type
{
  • "bankaccountGuid": "string",
  • "bankaccountNo": "string",
  • "description": "string",
  • "bankaccountClass": 0,
  • "ownerType": 0,
  • "internalCode": "string",
  • "priority": 0,
  • "agreementNo": "string",
  • "bankCode": "string",
  • "bankDescription": "string",
  • "countryCode": "string",
  • "zipCode": "string",
  • "city": "string",
  • "allowPayments": 0,
  • "allowDisbursementsFrom": true,
  • "allowDisbursementsTo": true,
  • "businessAccount": true,
  • "thirdPartyRemittance": true,
  • "powerOfAttorney": true,
  • "currencyCode": "string",
  • "accountBalance": 0,
  • "iban": "string",
  • "bic": "string",
  • "blz": "string",
  • "swift": "string",
  • "links": [
    ]
}

Get client parameters using filters

Authorizations:
(oauth2apikey)
path Parameters
clientGuid
required
string

Client 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 client parameter

Authorizations:
(oauth2apikey)
path Parameters
clientGuid
required
string

Client guid

Request Body schema:

Parameter details

Array
name
string or null

Name of party parameter

type
string or null

Type of party parameter

value
string or null

The value of the party parameter

href
string or null

Link to party parameter

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
[
  • {
    }
]

Get client details based on the unique GUID

Authorizations:
(oauth2apikey)
path Parameters
clientGuid
required
string

The unique GUID of the client

name
required
string

Name of the parameter

Responses

Response samples

Content type
{
  • "name": "string",
  • "type": "string",
  • "value": "string",
  • "href": "string"
}

Updates a client parameter

Authorizations:
(oauth2apikey)
path Parameters
clientGuid
required
string

Client guid

name
required
string

Parameter name

Request Body schema:

Parameter details

Array
name
string or null

Name of party parameter

type
string or null

Type of party parameter

value
string or null

The value of the party parameter

href
string or null

Link to party parameter

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

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

Deletes a client parameter

Authorizations:
(oauth2apikey)
path Parameters
clientGuid
required
string

Client guid

name
required
string

Parameter name

Responses

Response samples

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

Get client extra fields using filters

Authorizations:
(oauth2apikey)
path Parameters
clientGuid
required
string

Client 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 client extra field

Authorizations:
(oauth2apikey)
path Parameters
clientGuid
required
string

Client guid

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

Authorizations:
(oauth2apikey)
path Parameters
clientGuid
required
string

The unique GUID of the client

name
required
string

The name of the extra field

Responses

Response samples

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

Updates a client extra field

Authorizations:
(oauth2apikey)
path Parameters
clientGuid
required
string

Client guid

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 client extra field

Authorizations:
(oauth2apikey)
path Parameters
clientGuid
required
string

Client guid

name
required
string

Extrafield name

Responses

Response samples

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

Get client direct debit mandates using filters

Authorizations:
(oauth2apikey)
path Parameters
clientGuid
required
string

Client 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 client direct debit mandate

Authorizations:
(oauth2apikey)
path Parameters
clientGuid
required
string

Client guid

Request Body schema:

Direct debit mandate

directDebitMandateType
required
integer <int32>

Direct debit type.

1 = SwedishAutogiro, Autogiro (Sweden).

2 = DutchIncasso, Incasso (the Netherlands).

3 = SEPAConsumerRecurring, SEPA consumer recurring

4 = SEPAConsumerOneoOff, SEPA consumer one-off

5 = SEPABusinessRecurring, SEPA business recurring

7 = SEPABusinessOneOff, SEPA business one-off

receivingBankAccountNo
required
string non-empty

Bank account number of the receiving part.

sendingBankAccountClass
integer or null <int32>

Sending (payer) bankaccount class

1 = Plusgiro(Sweden)

2 = Bankgiro(Sweden)

3 = Bank account, IBAN (Netherlands)

4 = Foreign bank account, IBAN

5 = Bankgiro(Denmark)

7 = Bankgiro(Norway)

8 = Bankaccount(Norway)

9 = Bankaccount(Sweden)

10 = Bank account(Finland)

sendingBankAccountNo
string or null

Direct debit bank account number of the sending (payer) part.

referenceNo
string or null

Direct debit mandate reference number.

requestedAt
string or null <date-time>

Direct debit date of request.

approvedAt
string or null <date-time>

Direct debit date of approval.

signedDate
string or null <date-time>

Direct debit date of signature.

validfrom
string or null <date-time>

Direct debit "valid from" date.

validuntil
string or null <date-time>

Direct debit "valid to" date.

Responses

Request samples

Content type
{
  • "directDebitMandateType": 0,
  • "receivingBankAccountNo": "string",
  • "sendingBankAccountClass": 0,
  • "sendingBankAccountNo": "string",
  • "referenceNo": "string",
  • "requestedAt": "2019-08-24T14:15:22Z",
  • "approvedAt": "2019-08-24T14:15:22Z",
  • "signedDate": "2019-08-24T14:15:22Z",
  • "validfrom": "2019-08-24T14:15:22Z",
  • "validuntil": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "mandateGuid": "string",
  • "directDebitMandateType": 0,
  • "referenceNo": "string",
  • "bankAccountNo": "string",
  • "requestedAt": "2019-08-24T14:15:22Z",
  • "approvedAt": "2019-08-24T14:15:22Z",
  • "signedDate": "2019-08-24T14:15:22Z",
  • "validfrom": "2019-08-24T14:15:22Z",
  • "validuntil": "2019-08-24T14:15:22Z",
  • "closedAt": "2019-08-24T14:15:22Z",
  • "links": [
    ]
}

Get client direct debit mandate based on the unique GUID

Authorizations:
(oauth2apikey)
path Parameters
clientGuid
required
string

The unique GUID of the client

directDebitGuid
required
string

The unique GUID of the direct debit mandate

Responses

Response samples

Content type
{
  • "mandateGuid": "string",
  • "directDebitMandateType": 0,
  • "referenceNo": "string",
  • "bankAccountNo": "string",
  • "requestedAt": "2019-08-24T14:15:22Z",
  • "approvedAt": "2019-08-24T14:15:22Z",
  • "signedDate": "2019-08-24T14:15:22Z",
  • "validfrom": "2019-08-24T14:15:22Z",
  • "validuntil": "2019-08-24T14:15:22Z",
  • "closedAt": "2019-08-24T14:15:22Z",
  • "links": [
    ]
}

Get summary of client accounts

Authorizations:
(oauth2apikey)
path Parameters
clientGuid
required
string

The unique GUID of the client

Responses

Response samples

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

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
clientGuid
required
string

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