API docs by Redocly

Aptic API Gateway - Debtors (v1.0)

Download OpenAPI specification:Download

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

Debt collection debtor related API for Aptic solutions

Debtors

Get debtors 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 debtor

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

Debtor ID number (SSN or company registration number).

juridicalType
integer <int32> (JuridicalType)
Enum: 0 1

Type of person, juridically.

placeOfBirth
string or null

Place of birth.

dateOfBirth
string or null <date-time>

Date of birth.

gender
integer <int32> (GenderType)
Enum: 0 1 2

Gender of a person.

cultureCode
string or null

Culture code.

fullName
string or null

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

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.

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

domicile
string or null

Domicile.

municipalCode
string or null

Municipal code.

vatNumber
string or null

VAT number.

naceCode
string or null

NACE code.

homePhone
string or null

Home phone number.

workPhone
string or null

Work phone number.

cellularPhone
string or null

Cellular phone number.

telefax
string or null

Telefax number.

email
string or null

E-mail.

languageCode
string or null

Language code e.g. sv, en etc.

currencyCode
string or null

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

underAged
boolean or null

Under aged boolean flag.

conversationNotificationChannel
integer <int32> (ConversationNotificationChannel)
Enum: 0 1 2 3

Preferred communication channel for conversation notifications.

conversationNotificationEmail
string or null

Debtor's e-mail for conversation notification.

conversationNotificationCellularPhone
string or null

Debtor's cellular phone number for conversation notification.

Responses

Request samples

Content type
{
  • "idNumber": "string",
  • "juridicalType": 0,
  • "placeOfBirth": "string",
  • "dateOfBirth": "2019-08-24T14:15:22Z",
  • "gender": 0,
  • "cultureCode": "string",
  • "fullName": "string",
  • "firstname": "string",
  • "middlename": "string",
  • "lastname": "string",
  • "nameSuffix": "string",
  • "street": "string",
  • "houseNo": "string",
  • "houseNoExtension": "string",
  • "city": "string",
  • "zipCode": "string",
  • "stateCode": "string",
  • "countryCode": "string",
  • "fullAddress": "string",
  • "domicile": "string",
  • "municipalCode": "string",
  • "vatNumber": "string",
  • "naceCode": "string",
  • "homePhone": "string",
  • "workPhone": "string",
  • "cellularPhone": "string",
  • "telefax": "string",
  • "email": "string",
  • "languageCode": "string",
  • "currencyCode": "string",
  • "underAged": true,
  • "conversationNotificationChannel": 0,
  • "conversationNotificationEmail": "string",
  • "conversationNotificationCellularPhone": "string"
}

Response samples

Content type
{
  • "debtorGuid": "string",
  • "debtorReference": "string",
  • "idNumber": "string",
  • "juridicalType": 0,
  • "placeOfBirth": "string",
  • "dateOfBirth": "2019-08-24T14:15:22Z",
  • "gender": 0,
  • "cultureCode": "string",
  • "firstname": "string",
  • "middlename": "string",
  • "lastname": "string",
  • "nameSuffix": "string",
  • "domicile": "string",
  • "municipalCode": "string",
  • "naceCode": "string",
  • "homePhone": "string",
  • "workPhone": "string",
  • "cellularPhone": "string",
  • "telefax": "string",
  • "email": "string",
  • "languageCode": "string",
  • "currencyCode": "string",
  • "preferredChannel": "string",
  • "underAged": true,
  • "conversationNotificationChannel": 0,
  • "conversationNotificationEmail": "string",
  • "conversationNotificationCellularPhone": "string",
  • "regDate": "2019-08-24T14:15:22Z",
  • "links": [
    ]
}

Get debtor details.

Authorizations:
(oauth2apikey)
path Parameters
guid
required
string

The GUID representing the debtor.

Responses

Response samples

Content type
{
  • "debtorGuid": "string",
  • "debtorReference": "string",
  • "idNumber": "string",
  • "juridicalType": 0,
  • "placeOfBirth": "string",
  • "dateOfBirth": "2019-08-24T14:15:22Z",
  • "gender": 0,
  • "cultureCode": "string",
  • "firstname": "string",
  • "middlename": "string",
  • "lastname": "string",
  • "nameSuffix": "string",
  • "domicile": "string",
  • "municipalCode": "string",
  • "naceCode": "string",
  • "homePhone": "string",
  • "workPhone": "string",
  • "cellularPhone": "string",
  • "telefax": "string",
  • "email": "string",
  • "languageCode": "string",
  • "currencyCode": "string",
  • "preferredChannel": "string",
  • "underAged": true,
  • "conversationNotificationChannel": 0,
  • "conversationNotificationEmail": "string",
  • "conversationNotificationCellularPhone": "string",
  • "regDate": "2019-08-24T14:15:22Z",
  • "links": [
    ]
}

Updates a debtor

Authorizations:
(oauth2apikey)
path Parameters
debtorGuid
required
string
Request Body schema:
idNumber
string or null

Customer ID number.

juridicalType
integer <int32> (JuridicalType)
Enum: 0 1

Type of person, juridically.

placeOfBirth
string or null

Place of birth.

dateOfBirth
string or null <date-time>

Date of birth.

gender
integer <int32> (GenderType)
Enum: 0 1 2

Gender of a person.

cultureCode
string or null

Culture code.

fullName
string or null

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

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.

vatNumber
string or null

VAT number.

naceCode
string or null

NACE code.

homePhone
string or null

Home phone number.

workPhone
string or null

Work phone number.

cellularPhone
string or null

Cellular phone number.

telefax
string or null

Telefax number.

email
string or null

E-mail.

languageCode
string or null

Language code e.g. sv, en etc.

currencyCode
string or null

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

underAged
boolean or null

Under aged boolean flag.

conversationNotificationChannel
integer <int32> (ConversationNotificationChannel)
Enum: 0 1 2 3

Preferred communication channel for conversation notifications.

conversationNotificationEmail
string or null

Debtor's e-mail for conversation notification.

conversationNotificationCellularPhone
string or null

Debtor's cellular phone number for conversation notification.

Responses

Request samples

Content type
{
  • "idNumber": "string",
  • "juridicalType": 0,
  • "placeOfBirth": "string",
  • "dateOfBirth": "2019-08-24T14:15:22Z",
  • "gender": 0,
  • "cultureCode": "string",
  • "fullName": "string",
  • "firstname": "string",
  • "middlename": "string",
  • "lastname": "string",
  • "nameSuffix": "string",
  • "domicile": "string",
  • "municipalCode": "string",
  • "vatNumber": "string",
  • "naceCode": "string",
  • "homePhone": "string",
  • "workPhone": "string",
  • "cellularPhone": "string",
  • "telefax": "string",
  • "email": "string",
  • "languageCode": "string",
  • "currencyCode": "string",
  • "underAged": true,
  • "conversationNotificationChannel": 0,
  • "conversationNotificationEmail": "string",
  • "conversationNotificationCellularPhone": "string"
}

Response samples

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

Deletes a debtor

Authorizations:
(oauth2apikey)
path Parameters
debtorGuid
required
string

Responses

Response samples

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

Get debtor case summary.

Authorizations:
(oauth2apikey)
path Parameters
guid
required
string

The GUID representing the debtor.

Responses

Response samples

Content type
{
  • "fullName": "string",
  • "idNumber": "string",
  • "debtorGuid": "string",
  • "paymentReference": "string",
  • "bankAccountNo": "string",
  • "remainingPrincipal": 0,
  • "remainingInterest": 0,
  • "remaininFee": 0,
  • "remainingSum": 0,
  • "activeCases": 0,
  • "closedCases": 0,
  • "cases": [
    ]
}

Get cases using filters for specified debtor

Authorizations:
(oauth2apikey)
path Parameters
guid
required
string

The GUID representing the debtor.

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 case details for a debtor case

Authorizations:
(oauth2apikey)
path Parameters
guid
required
string

The GUID representing the debtor.

caseGuid
required
string

The GUID representing the case.

Responses

Response samples

Content type
{
  • "caseNumber": "string",
  • "clientName": "string",
  • "clientReferenceNumber": "string",
  • "closureCode": "string",
  • "closureDate": "2019-08-24T14:15:22Z",
  • "currencyCode": "string",
  • "description": "string",
  • "originalFee": 0,
  • "originalInterest": 0,
  • "originalPrincipal": 0,
  • "originalSum": 0,
  • "paidFee": 0,
  • "paidInterest": 0,
  • "paidPrincipal": 0,
  • "paidSum": 0,
  • "paidToThirdParty": 0,
  • "paymentReferenceNumber": "string",
  • "remainingFee": 0,
  • "remainingInterest": 0,
  • "remainingPrincipal": 0,
  • "remainingSum": 0,
  • "service": "string",
  • "status": "string",
  • "subStatus": "string",
  • "registrationDate": "2019-08-24T14:15:22Z",
  • "links": [
    ]
}

Get debtor addresses using filters

Authorizations:
(oauth2apikey)
path Parameters
debtorGuid
required
string

Debtor 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 debtor address

Authorizations:
(oauth2apikey)
path Parameters
debtorGuid
required
string

Debtor guid

Request Body schema:

Address values

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

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

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 debtor address based on the unique GUID

Authorizations:
(oauth2apikey)
path Parameters
debtorGuid
required
string

The unique GUID of the debtor

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 debtor address

Authorizations:
(oauth2apikey)
path Parameters
debtorGuid
required
string

Debtor guid

addressGuid
required
string

The unique GUID of the address

Request Body schema:

Address values

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

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

Response samples

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

Deletes a debtor address

Authorizations:
(oauth2apikey)
path Parameters
debtorGuid
required
string

Debtor guid

addressGuid
required
string

The unique GUID of the address

Responses

Response samples

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

Get debtor payment plans using filters

Authorizations:
(oauth2apikey)
path Parameters
debtorGuid
required
string

Debtor 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 payment plan

Authorizations:
(oauth2apikey)
path Parameters
debtorGuid
required
string

Debtor guid

Request Body schema:

Payment plan data

active
integer or null <int32>

Type of payment plan

1 = Active

2 = Proposal (default)

paymentPlanType
integer <int32>

Type of payment plan

1 = Annuity

2 = Annuity, limited

3 = Linear

4 = Linear, limited

5 = Debt relief

numberOfPayments
integer or null <int32>

Total number of payments

amount
number or null <double>

Amount to pay per period (typically monthly)

currencyCode
string or null

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

registrationFee
number or null <double>

Registration fee for the plan

invoiceFee
number or null <double>

Invoice fee for each payment in the plan

reminderFee
number or null <double>

Reminder fee for late payment

feeCurrencyCode
string or null

Currency code, e.g. SEK, NOK, EUR, etc. for the fees

Array of objects or null (DebtorPaymentplanSpecifiedPayment)

Deviating payments/instalments in the payment plan

cases
Array of strings or null

Cases (Guid) that should be covered by the payment plan. If not given, all active cases without an active payment plan will be selected

Responses

Request samples

Content type
{
  • "active": 0,
  • "paymentPlanType": 0,
  • "numberOfPayments": 0,
  • "amount": 0,
  • "currencyCode": "string",
  • "registrationFee": 0,
  • "invoiceFee": 0,
  • "reminderFee": 0,
  • "feeCurrencyCode": "string",
  • "payments": [
    ],
  • "cases": [
    ]
}

Response samples

Content type
{
  • "paymentPlanGuid": "string",
  • "registrationDate": "2019-08-24T14:15:22Z",
  • "active": 0,
  • "paymentPlanType": 0,
  • "numberOfPayments": 0,
  • "remainingNumberOfPayments": 0,
  • "currencyCode": "string",
  • "registrationFee": 0,
  • "invoiceFee": 0,
  • "reminderFee": 0,
  • "feeCurrencyCode": "string",
  • "totalAmount": 0,
  • "totalPrincipal": 0,
  • "totalInterest": 0,
  • "totalFee": 0,
  • "annualPercentage": 0,
  • "payments": [
    ],
  • "cases": [
    ],
  • "periods": [
    ]
}

Get debtor payment plan based on the unique GUID

Authorizations:
(oauth2apikey)
path Parameters
debtorGuid
required
string

The unique GUID of the debtor

paymentplanGuid
required
string

The unique GUID of the paymentplan

Responses

Response samples

Content type
{
  • "paymentPlanGuid": "string",
  • "registrationDate": "2019-08-24T14:15:22Z",
  • "active": 0,
  • "paymentPlanType": 0,
  • "numberOfPayments": 0,
  • "remainingNumberOfPayments": 0,
  • "currencyCode": "string",
  • "registrationFee": 0,
  • "invoiceFee": 0,
  • "reminderFee": 0,
  • "feeCurrencyCode": "string",
  • "totalAmount": 0,
  • "totalPrincipal": 0,
  • "totalInterest": 0,
  • "totalFee": 0,
  • "annualPercentage": 0,
  • "payments": [
    ],
  • "cases": [
    ],
  • "periods": [
    ]
}

Updates a payment plan

Authorizations:
(oauth2apikey)
path Parameters
debtorGuid
required
string

Debtor guid

paymentplanGuid
required
string

The unique GUID of the payment plan

Request Body schema:

Paymentplan settings

Array of objects or null (DebtorPaymentplanSpecifiedPayment)

Deviating payments/instalments in the payment plan

Responses

Request samples

Content type
{
  • "payments": [
    ]
}

Response samples

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

Deletes a payment plan

Authorizations:
(oauth2apikey)
path Parameters
debtorGuid
required
string

Debtor guid

paymentplanGuid
required
string

The unique GUID of the paymentplan

Responses

Response samples

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

Calculates a payment plan. Nothing is stored. PUT needs to be called to actually store the plan for the debtor.

Authorizations:
(oauth2apikey)
path Parameters
debtorGuid
required
string

Debtor guid

Request Body schema:

The payment plan data used for calculation

active
integer or null <int32>

Type of payment plan

1 = Active

2 = Proposal (default)

paymentPlanType
integer <int32>

Type of payment plan

1 = Annuity

2 = Annuity, limited

3 = Linear

4 = Linear, limited

5 = Debt relief

numberOfPayments
integer or null <int32>

Total number of payments

amount
number or null <double>

Amount to pay per period (typically monthly)

currencyCode
string or null

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

registrationFee
number or null <double>

Registration fee for the plan

invoiceFee
number or null <double>

Invoice fee for each payment in the plan

reminderFee
number or null <double>

Reminder fee for late payment

feeCurrencyCode
string or null

Currency code, e.g. SEK, NOK, EUR, etc. for the fees

Array of objects or null (DebtorPaymentplanSpecifiedPayment)

Deviating payments/instalments in the payment plan

cases
Array of strings or null

Cases (Guid) that should be covered by the payment plan. If not given, all active cases without an active payment plan will be selected

Responses

Request samples

Content type
{
  • "active": 0,
  • "paymentPlanType": 0,
  • "numberOfPayments": 0,
  • "amount": 0,
  • "currencyCode": "string",
  • "registrationFee": 0,
  • "invoiceFee": 0,
  • "reminderFee": 0,
  • "feeCurrencyCode": "string",
  • "payments": [
    ],
  • "cases": [
    ]
}

Response samples

Content type
{
  • "paymentPlanGuid": "string",
  • "registrationDate": "2019-08-24T14:15:22Z",
  • "active": 0,
  • "paymentPlanType": 0,
  • "numberOfPayments": 0,
  • "remainingNumberOfPayments": 0,
  • "currencyCode": "string",
  • "registrationFee": 0,
  • "invoiceFee": 0,
  • "reminderFee": 0,
  • "feeCurrencyCode": "string",
  • "totalAmount": 0,
  • "totalPrincipal": 0,
  • "totalInterest": 0,
  • "totalFee": 0,
  • "annualPercentage": 0,
  • "payments": [
    ],
  • "cases": [
    ],
  • "periods": [
    ]
}

Activates a payment plan

Authorizations:
(oauth2apikey)
path Parameters
debtorGuid
required
string

Debtor guid

paymentplanGuid
required
string

The unique GUID of the paymentplan

Responses

Response samples

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

Get Debtor extra fields using filters

Authorizations:
(oauth2apikey)
path Parameters
debtorGuid
required
string

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

Authorizations:
(oauth2apikey)
path Parameters
debtorGuid
required
string

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

Authorizations:
(oauth2apikey)
path Parameters
debtorGuid
required
string

The unique GUID of the Debtor

name
required
string

The unique GUID of the Debtor

Responses

Response samples

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

Updates a Debtor extra field

Authorizations:
(oauth2apikey)
path Parameters
debtorGuid
required
string

Debtor guid

name
required
string

Extrafield name

Request Body schema:

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

Deletes a Debtor extra field

Authorizations:
(oauth2apikey)
path Parameters
debtorGuid
required
string

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

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

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