API docs by Redocly

Aptic API Gateway - Customers (v1.0)

Download OpenAPI specification:

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

Customers related API for Aptic solutions

Customers

Get customers 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 customer

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

Customer reference

idNumber
string or null

Customer ID

juridicalType
integer or null <int32>
Enum: 0 1

Type of credit applicant, juridically

Possible values:
0 = Actual person
1 = Juridical person, e.g a company

placeOfBirth
string or null

Place of birth

dateOfBirth
string or null <date-time>

Date of birth

deceasedDate
string or null <date-time>

Deceased

vatNumber
string or null

VAT number

naceCode
string or null

NACE code

homePhone
string or null

Home phone

workPhone
string or null

Work phone

cellularPhone
string or null

Cell phone

email
string or null

Email

languageCode
string or null

Language code e.g. sv, en etc.

currencyCode
string or null

Currency code, e.g. SEK, NOK, EUR etc.

gender
integer or null <int32>
Enum: 0 1 2

Customer gender

Possible values:
0 = Female
1 = Male
2 = Unknown, or neither Female nor Male

cultureCode
string or null

Culture code

firstname
string or null

First name of the customer

middlename
string or null

Middle name of the customer

lastname
string or null

Last name of the customer

nameSuffix
string or null

Name suffix

domicile
string or null

Domicile

municipalCode
string or null

Municipal code

companyType
string or null

Company type code

glnNumber
string or null

GLN number

telefax
string or null

Telefax number

preferredChannel
string or null

Preffered communication channel, e.g. LETTER, E-INVOICE, EMAIL, SMS etc. Should be used one of predefined values using correct letter case.

underAged
boolean or null

Under aged boolean flag

invoiceChannel
string or null

Preffered invoice channel, e.g. LETTER, E-INVOICE, EMAIL, SMS etc. Should be used one of predefined values using correct letter case.

maritalStatus
integer or null <int32>

Marital status

1 = Unmarried

2 = Married

3 = Common law spouse

4 = Widow

5 = Divorced

6 = Partner

passportNumber
string or null

Passport number used for identification

driversLicenseNumber
string or null

Drivers license number used for identification

clientReference
string or null

Client reference.

parentCustomer
string or null

Parent customer's guid.

fullName
string or null

Full name of the customer. Optional if FirstName and LastName is used.

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

fullAddress
string or null

Main address - Full address with all parts combined

customerGuid
string or null

Optional customer guid, if you don't want CLVR to assign a GUID

Responses

Request samples

Content type
{
  • "customerReference": "string",
  • "idNumber": "string",
  • "juridicalType": 0,
  • "placeOfBirth": "string",
  • "dateOfBirth": "2019-08-24T14:15:22Z",
  • "deceasedDate": "2019-08-24T14:15:22Z",
  • "vatNumber": "string",
  • "naceCode": "string",
  • "homePhone": "string",
  • "workPhone": "string",
  • "cellularPhone": "string",
  • "email": "string",
  • "languageCode": "string",
  • "currencyCode": "string",
  • "gender": 0,
  • "cultureCode": "string",
  • "firstname": "string",
  • "middlename": "string",
  • "lastname": "string",
  • "nameSuffix": "string",
  • "domicile": "string",
  • "municipalCode": "string",
  • "companyType": "string",
  • "glnNumber": "string",
  • "telefax": "string",
  • "preferredChannel": "string",
  • "underAged": true,
  • "invoiceChannel": "string",
  • "maritalStatus": 0,
  • "passportNumber": "string",
  • "driversLicenseNumber": "string",
  • "clientReference": "string",
  • "parentCustomer": "string",
  • "fullName": "string",
  • "street": "string",
  • "houseNo": "string",
  • "houseNoExtension": "string",
  • "city": "string",
  • "zipCode": "string",
  • "stateCode": "string",
  • "countryCode": "string",
  • "fullAddress": "string",
  • "customerGuid": "string"
}

Response samples

Content type
{
  • "customerGuid": "string",
  • "customerReference": "string",
  • "idNumber": "string",
  • "juridicalType": 0,
  • "placeOfBirth": "string",
  • "dateOfBirth": "2019-08-24T14:15:22Z",
  • "deceasedDate": "2019-08-24T14:15:22Z",
  • "fullName": "string",
  • "vatNumber": "string",
  • "naceCode": "string",
  • "homePhone": "string",
  • "workPhone": "string",
  • "cellularPhone": "string",
  • "email": "string",
  • "languageCode": "string",
  • "currencyCode": "string",
  • "gender": 0,
  • "cultureCode": "string",
  • "firstname": "string",
  • "middlename": "string",
  • "lastname": "string",
  • "nameSuffix": "string",
  • "domicile": "string",
  • "municipalCode": "string",
  • "companyType": "string",
  • "glnNumber": "string",
  • "telefax": "string",
  • "preferredChannel": "string",
  • "underAged": true,
  • "invoiceChannel": "string",
  • "maritalStatus": 0,
  • "passportNumber": "string",
  • "driversLicenseNumber": "string",
  • "regDate": "2019-08-24T14:15:22Z",
  • "contactPerson": "string",
  • "addresses": [
    ],
  • "links": [
    ]
}

Get customer details.

Authorizations:
(oauth2apikey)
path Parameters
guid
required
string

The GUID representing the customer.

Responses

Response samples

Content type
{
  • "customerGuid": "string",
  • "customerReference": "string",
  • "idNumber": "string",
  • "juridicalType": 0,
  • "placeOfBirth": "string",
  • "dateOfBirth": "2019-08-24T14:15:22Z",
  • "deceasedDate": "2019-08-24T14:15:22Z",
  • "fullName": "string",
  • "vatNumber": "string",
  • "naceCode": "string",
  • "homePhone": "string",
  • "workPhone": "string",
  • "cellularPhone": "string",
  • "email": "string",
  • "languageCode": "string",
  • "currencyCode": "string",
  • "gender": 0,
  • "cultureCode": "string",
  • "firstname": "string",
  • "middlename": "string",
  • "lastname": "string",
  • "nameSuffix": "string",
  • "domicile": "string",
  • "municipalCode": "string",
  • "companyType": "string",
  • "glnNumber": "string",
  • "telefax": "string",
  • "preferredChannel": "string",
  • "underAged": true,
  • "invoiceChannel": "string",
  • "maritalStatus": 0,
  • "passportNumber": "string",
  • "driversLicenseNumber": "string",
  • "regDate": "2019-08-24T14:15:22Z",
  • "contactPerson": "string",
  • "addresses": [
    ],
  • "links": [
    ]
}

Updates a customer

Authorizations:
(oauth2apikey)
path Parameters
customerGuid
required
string
Request Body schema:
customerReference
string or null

Customer reference

idNumber
string or null

Customer ID

juridicalType
integer or null <int32>
Enum: 0 1

Type of credit applicant, juridically

Possible values:
0 = Actual person
1 = Juridical person, e.g a company

placeOfBirth
string or null

Place of birth

dateOfBirth
string or null <date-time>

Date of birth

deceasedDate
string or null <date-time>

Deceased

vatNumber
string or null

VAT number

naceCode
string or null

NACE code

homePhone
string or null

Home phone

workPhone
string or null

Work phone

cellularPhone
string or null

Cell phone

email
string or null

Email

languageCode
string or null

Language code e.g. sv, en etc.

currencyCode
string or null

Currency code, e.g. SEK, NOK, EUR etc.

gender
integer or null <int32>
Enum: 0 1 2

Customer gender

Possible values:
0 = Female
1 = Male
2 = Unknown, or neither Female nor Male

cultureCode
string or null

Culture code

firstname
string or null

First name of the customer

middlename
string or null

Middle name of the customer

lastname
string or null

Last name of the customer

nameSuffix
string or null

Name suffix

domicile
string or null

Domicile

municipalCode
string or null

Municipal code

companyType
string or null

Company type code

glnNumber
string or null

GLN number

telefax
string or null

Telefax number

preferredChannel
string or null

Preffered communication channel, e.g. LETTER, E-INVOICE, EMAIL, SMS etc. Should be used one of predefined values using correct letter case.

underAged
boolean or null

Under aged boolean flag

invoiceChannel
string or null

Preffered invoice channel, e.g. LETTER, E-INVOICE, EMAIL, SMS etc. Should be used one of predefined values using correct letter case.

maritalStatus
integer or null <int32>

Marital status

1 = Unmarried

2 = Married

3 = Common law spouse

4 = Widow

5 = Divorced

6 = Partner

passportNumber
string or null

Passport number used for identification

driversLicenseNumber
string or null

Drivers license number used for identification

parentCustomer
string or null

Parent customer's guid.

Responses

Request samples

Content type
{
  • "customerReference": "string",
  • "idNumber": "string",
  • "juridicalType": 0,
  • "placeOfBirth": "string",
  • "dateOfBirth": "2019-08-24T14:15:22Z",
  • "deceasedDate": "2019-08-24T14:15:22Z",
  • "vatNumber": "string",
  • "naceCode": "string",
  • "homePhone": "string",
  • "workPhone": "string",
  • "cellularPhone": "string",
  • "email": "string",
  • "languageCode": "string",
  • "currencyCode": "string",
  • "gender": 0,
  • "cultureCode": "string",
  • "firstname": "string",
  • "middlename": "string",
  • "lastname": "string",
  • "nameSuffix": "string",
  • "domicile": "string",
  • "municipalCode": "string",
  • "companyType": "string",
  • "glnNumber": "string",
  • "telefax": "string",
  • "preferredChannel": "string",
  • "underAged": true,
  • "invoiceChannel": "string",
  • "maritalStatus": 0,
  • "passportNumber": "string",
  • "driversLicenseNumber": "string",
  • "parentCustomer": "string"
}

Response samples

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

Deletes a customer

Authorizations:
(oauth2apikey)
path Parameters
customerGuid
required
string

Responses

Response samples

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

Get customer ledger summary.

Authorizations:
(oauth2apikey)
path Parameters
guid
required
string

The GUID representing the customer.

Responses

Response samples

Content type
{
  • "totalBalance": 0.1,
  • "accountBalance": 0.1,
  • "currencyCode": "string",
  • "unsettledPaymentBalance": 0.1,
  • "purchases": [
    ],
  • "invoices": [
    ],
  • "accounts": [
    ],
  • "guarantees": [
    ],
  • "collaterals": [
    ],
  • "myGuarantors": [
    ],
  • "guaranteeFor": [
    ],
  • "allRelatedCustomers": [
    ]
}

Get customer parameters using filters

Authorizations:
(oauth2apikey)
path Parameters
customerGuid
required
string

Customer 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 customer parameter

Authorizations:
(oauth2apikey)
path Parameters
customerGuid
required
string

Customer 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
{
  • "name": "string",
  • "type": "string",
  • "value": "string",
  • "href": "string"
}

Get customer details based on the unique GUID

Authorizations:
(oauth2apikey)
path Parameters
customerGuid
required
string

The unique GUID of the customer

name
required
string

Name of the parameter

Responses

Response samples

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

Updates a customer parameter

Authorizations:
(oauth2apikey)
path Parameters
customerGuid
required
string

Customer 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 customer parameter

Authorizations:
(oauth2apikey)
path Parameters
customerGuid
required
string

Customer 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 customer addresses using filters

Authorizations:
(oauth2apikey)
path Parameters
customerGuid
required
string

Customer 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 customer address

Authorizations:
(oauth2apikey)
path Parameters
customerGuid
required
string

Customer guid

Request Body schema:

New customer address

addressType
string or null

Type of address. LEGAL or user defined.

fullName
string or null

Name to use instead on the real name when using this address, e.g. an invoice reading service. Usually null.

street
string or null

Street

houseNo
string or null

House number

houseNoExtension
string or null

House number extension

city
string or null

City

zipCode
string or null

Zipcode

stateCode
string or null

State code

countryCode
string or null

Country code

addressNotValidDate
string or null <date-time>

Date when the address was marked as not valid anymore

defaultAddress
boolean or null

Flag if this address should be treated as the default address

validFrom
string or null <date-time>

Date when the address is valid from

validTo
string or null <date-time>

Date when the address is valid to

addressNotValidReason
string or null

Reason why the address is not valid

reasonForChange
string or null

The reason for the address change. Text is not used when marking the address as not valid.

Responses

Request samples

Content type
{
  • "addressType": "string",
  • "fullName": "string",
  • "street": "string",
  • "houseNo": "string",
  • "houseNoExtension": "string",
  • "city": "string",
  • "zipCode": "string",
  • "stateCode": "string",
  • "countryCode": "string",
  • "addressNotValidDate": "2019-08-24T14:15:22Z",
  • "defaultAddress": true,
  • "validFrom": "2019-08-24T14:15:22Z",
  • "validTo": "2019-08-24T14:15:22Z",
  • "addressNotValidReason": "string",
  • "reasonForChange": "string"
}

Response samples

Content type
{
  • "addressGuid": "string",
  • "addressType": "string",
  • "fullName": "string",
  • "street": "string",
  • "houseNo": "string",
  • "houseNoExtension": "string",
  • "city": "string",
  • "zipCode": "string",
  • "stateCode": "string",
  • "countryCode": "string",
  • "fullAddress": "string",
  • "addressNotValidDate": "2019-08-24T14:15:22Z",
  • "defaultAddress": true,
  • "validFrom": "2019-08-24T14:15:22Z",
  • "validTo": "2019-08-24T14:15:22Z",
  • "validatedAt": "2019-08-24T14:15:22Z",
  • "validOverride": true,
  • "lastUpdatedAt": "2019-08-24T14:15:22Z"
}

Get customer address details based on the unique GUID

Authorizations:
(oauth2apikey)
path Parameters
customerGuid
required
string

The unique GUID of the customer

addressGuid
required
string

The unique GUID of the address

Responses

Response samples

Content type
{
  • "addressGuid": "string",
  • "addressType": "string",
  • "fullName": "string",
  • "street": "string",
  • "houseNo": "string",
  • "houseNoExtension": "string",
  • "city": "string",
  • "zipCode": "string",
  • "stateCode": "string",
  • "countryCode": "string",
  • "fullAddress": "string",
  • "addressNotValidDate": "2019-08-24T14:15:22Z",
  • "defaultAddress": true,
  • "validFrom": "2019-08-24T14:15:22Z",
  • "validTo": "2019-08-24T14:15:22Z",
  • "validatedAt": "2019-08-24T14:15:22Z",
  • "validOverride": true,
  • "lastUpdatedAt": "2019-08-24T14:15:22Z"
}

Updates a customer address

Authorizations:
(oauth2apikey)
path Parameters
customerGuid
required
string

Customer guid

addressGuid
required
string

Address guid

Request Body schema:

Address details

addressType
string or null

Type of address. LEGAL or user defined.

fullName
string or null

Name to use instead on the real name when using this address, e.g. an invoice reading service. Usually null.

street
string or null

Street

houseNo
string or null

House number

houseNoExtension
string or null

House number extension

city
string or null

City

zipCode
string or null

Zipcode

stateCode
string or null

State code

countryCode
string or null

Country code

addressNotValidDate
string or null <date-time>

Date when the address was marked as not valid anymore

defaultAddress
boolean or null

Flag if this address should be treated as the default address

validFrom
string or null <date-time>

Date when the address is valid from

validTo
string or null <date-time>

Date when the address is valid to

addressNotValidReason
string or null

Reason why the address is not valid

reasonForChange
string or null

The reason for the address change. Text is not used when marking the address as not valid.

Responses

Request samples

Content type
{
  • "addressType": "string",
  • "fullName": "string",
  • "street": "string",
  • "houseNo": "string",
  • "houseNoExtension": "string",
  • "city": "string",
  • "zipCode": "string",
  • "stateCode": "string",
  • "countryCode": "string",
  • "addressNotValidDate": "2019-08-24T14:15:22Z",
  • "defaultAddress": true,
  • "validFrom": "2019-08-24T14:15:22Z",
  • "validTo": "2019-08-24T14:15:22Z",
  • "addressNotValidReason": "string",
  • "reasonForChange": "string"
}

Response samples

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

Deletes a customer address

Authorizations:
(oauth2apikey)
path Parameters
customerGuid
required
string

Customer guid

addressGuid
required
string

Address guid

Responses

Response samples

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

Get customer extra fields using filters

Authorizations:
(oauth2apikey)
path Parameters
customerGuid
required
string

Customer 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 customer extra field

Authorizations:
(oauth2apikey)
path Parameters
customerGuid
required
string

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

Authorizations:
(oauth2apikey)
path Parameters
customerGuid
required
string

The unique GUID of the customer

name
required
string

The unique GUID of the customer

Responses

Response samples

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

Updates a customer extra field

Authorizations:
(oauth2apikey)
path Parameters
customerGuid
required
string

Customer 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
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

Deletes a customer extra field

Authorizations:
(oauth2apikey)
path Parameters
customerGuid
required
string

Customer 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 customer direct debit mandates using filters

Authorizations:
(oauth2apikey)
path Parameters
customerGuid
required
string

Customer 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 customer direct debit mandate

Authorizations:
(oauth2apikey)
path Parameters
customerGuid
required
string

Customer 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 customer direct debit mandate based on the unique GUID

Authorizations:
(oauth2apikey)
path Parameters
customerGuid
required
string

The unique GUID of the customer

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 customer credit insurances using filters

Authorizations:
(oauth2apikey)
path Parameters
customerGuid
required
string

Customer 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 credit insurance for the customer

Authorizations:
(oauth2apikey)
path Parameters
customerGuid
required
string

Customer guid

Request Body schema:

Credit insurance information

insuranceCompanyReferenceCode
string or null

Reference code of the credit insurance company, eg. ATRADIUS, EULERHERMES.

insuranceCompanyNumber
string or null

Reference number at the credit insurance company.

insuranceCompanyCustomerNumber
string or null

Customer number at the credit insurance company.

note
string or null

Free text note

endDate
string or null <date-time>

End date for the credit insurance

currencyCode
string or null

Currency code of the insured amount

amount
number or null <double>

The insured amount

extraLimitAmount
number or null <double>

The extra limit amount caused by the credit insurance

extraLimitEndDate
string or null <date-time>

End date for the extra limit

paymentTerm
integer or null <int32>

The payment term

graceDays
integer or null <int32>

Grace days

Responses

Request samples

Content type
{
  • "insuranceCompanyReferenceCode": "string",
  • "insuranceCompanyNumber": "string",
  • "insuranceCompanyCustomerNumber": "string",
  • "note": "string",
  • "endDate": "2019-08-24T14:15:22Z",
  • "currencyCode": "string",
  • "amount": 0.1,
  • "extraLimitAmount": 0.1,
  • "extraLimitEndDate": "2019-08-24T14:15:22Z",
  • "paymentTerm": 0,
  • "graceDays": 0
}

Response samples

Content type
{
  • "insuranceGuid": "string",
  • "insuranceDate": "2019-08-24T14:15:22Z",
  • "insuranceCompanyName": "string",
  • "insuranceCompanyNumber": "string",
  • "insuranceCompanyCustomerNumber": "string",
  • "note": "string",
  • "endDate": "2019-08-24T14:15:22Z",
  • "currencyCode": "string",
  • "amount": 0.1,
  • "extraLimitAmount": 0.1,
  • "extraLimitEndDate": "2019-08-24T14:15:22Z",
  • "paymentTerm": 0,
  • "graceDays": 0,
  • "links": [
    ]
}

Get customer credit insurance details based on the unique GUID for customer and credit insurance

Authorizations:
(oauth2apikey)
path Parameters
customerGuid
required
string

The unique GUID of the customer

insuranceGuid
required
string

The unique GUID of the credit insurance

Responses

Response samples

Content type
{
  • "insuranceGuid": "string",
  • "insuranceDate": "2019-08-24T14:15:22Z",
  • "insuranceCompanyName": "string",
  • "insuranceCompanyNumber": "string",
  • "insuranceCompanyCustomerNumber": "string",
  • "note": "string",
  • "endDate": "2019-08-24T14:15:22Z",
  • "currencyCode": "string",
  • "amount": 0.1,
  • "extraLimitAmount": 0.1,
  • "extraLimitEndDate": "2019-08-24T14:15:22Z",
  • "paymentTerm": 0,
  • "graceDays": 0,
  • "links": [
    ]
}

Updates an customer credit insurance

Authorizations:
(oauth2apikey)
path Parameters
customerGuid
required
string

Customer guid

insuranceGuid
required
string

Credit insurance GUID

Request Body schema:

New credit insurance information

insuranceCompanyNumber
string or null

Reference number at the credit insurance company.

insuranceCompanyCustomerNumber
string or null

Customer number at the credit insurance company.

note
string or null

Free text note

endDate
string or null <date-time>

End date for the credit insurance

currencyCode
string or null

Currency code of the insured amount

amount
number or null <double>

The insured amount

extraLimitAmount
number or null <double>

The extra limit amount caused by the credit insurance

extraLimitEndDate
string or null <date-time>

End date for the extra limit

paymentTerm
integer or null <int32>

The payment term

graceDays
integer or null <int32>

Grace days

Responses

Request samples

Content type
{
  • "insuranceCompanyNumber": "string",
  • "insuranceCompanyCustomerNumber": "string",
  • "note": "string",
  • "endDate": "2019-08-24T14:15:22Z",
  • "currencyCode": "string",
  • "amount": 0.1,
  • "extraLimitAmount": 0.1,
  • "extraLimitEndDate": "2019-08-24T14:15:22Z",
  • "paymentTerm": 0,
  • "graceDays": 0
}

Response samples

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

Deletes an customer credit insurance

Authorizations:
(oauth2apikey)
path Parameters
customerGuid
required
string

Customer guid

insuranceGuid
required
string

Credit insurance GUID

Responses

Response samples

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

Get customer user questions using filters

Authorizations:
(oauth2apikey)
path Parameters
customerGuid
required
string

Customer 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 customer question based on the unique GUID

Authorizations:
(oauth2apikey)
path Parameters
customerGuid
required
string

The unique GUID of the customer

actionGuid
required
string

The unique GUID of the question/action

Responses

Response samples

Content type
{
  • "actionGuid": "string",
  • "loggedAt": "2019-08-24T14:15:22Z",
  • "processAt": "2019-08-24T14:15:22Z",
  • "actionItemCode": "string",
  • "message": "string",
  • "allowPostpone": true,
  • "actionCategoryCode": "string",
  • "actionCategoryDescription": "string",
  • "responses": [
    ],
  • "links": [
    ]
}

Respons to a customer question

Authorizations:
(oauth2apikey)
path Parameters
customerGuid
required
string

Customer guid

actionGuid
required
string

Action Guid

Request Body schema:

The response to the customer question

response
string or null

Response code

note
string or null

Note or message from the customer

postponeTo
string or null <date-time>

Postpone to

Responses

Request samples

Content type
{
  • "response": "string",
  • "note": "string",
  • "postponeTo": "2019-08-24T14:15:22Z"
}

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

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

Gets loan accrued interest.

Authorizations:
(oauth2apikey)
path Parameters
guid
required
string

The GUID representing the customer.

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
[
  • {
    }
]

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