API Reference

Endpoint

GET /v1/debt-collection/configuration

Responses

Response Body application/json

Contains the debt collection configuration for the partner.

client

The client matches a studio or location. The complete element should identify the person or company with its details of address, taxId, contact data and bank account information. An address should be complete, but only fields mandatory for all countries are marked as such

name1 required

Name first line

Example: "GYMLAB Hamburg"

name2

Name second line

Example: "GMBH"

legalForm

Legal form of the company

Example: "GmbH"

preTaxAttribute required

Possible to deduct tax up front

Default: "false"

Example: false

vatSerialNo

Tax ID of the client

Example: "DE 142156559"

postalCode required

Postal code of the client

Example: "1180"

city required

Cite code of the client

Example: "Vienna"

countryCode

Country code of the client, ISO Alpha-2

Example: "AT"

country

Country of the client

Example: "Australia"

paymentDetails

Describes the payment data.

accountNumber

Account number of the debtor

Example: "91 1000 0000 0123 4567 89"

bankCode

Bank code of the clients account

Example: "DE"

iban

Iban of the clients account

Example: "DE91 1000 0000 0123 4567 89"

bic

Bic of the clients account

Example: "DEUTDEFFXXX"

bank required

Bank name of the client

Example: "Deutsche Bank"

bankCountryCode

Bank country code of the client

Example: "DE"

accountHolder

The account holder of the bank account

Example: "Sven Hannawald"

contactDetails array[object]

List of contact details

type required

Type of contact data

Allowed values:

`TEL_PRIVATE`	Private phone number
`TEL_PRIVATE_MOBILE`	Private mobile phone number
`TEL_BUSINESS`	Business phone number
`TEL_BUSINESS_MOBILE`	Business mobile phone number
`FAX`	Fax number
`EMAIL`	Email address

Example: "TEL_BUSINESS"

value required

Value of contact data

Example: "s.hannawald@sportaliance.com"

status

Describes the status of the contact data.

type required

Type of contact status

Allowed values:

`NO_EMAIL`	No email provided.
`NOT_YET_USED`	Email is provided, but not yet used to send one.
`VALIDATION_IN_PROGRESS`	Email is provided, but currently under validation.
`VALID`	At least one Email was sent successfully.
`VALID_READ`	At least one Email was sent successfully and read.
`INVALID`	Email is provided, but bounced on delivery as invalid email address. No further emailing will happen.
`WARNING`	Email is provided, but bounced on delivery without a reason. Delivery will be tried again.
`REFUSED`	Email is provided, but bounced on delivery with a reason. Delivery will be tried again.
`REFUSED_FULL`	Email is provided, but bounced on delivery because the postbox is full. Delivery will be tried again.
`REFUSED_VIRUS`	Email is provided, but bounced on delivery because it failed the virus test. Delivery will be tried again.

Example: "VALID"

statusInformation

More details to the overall status

Example: "The mail server for the recipient domain does not accept messages to this address."

addressLine1

Address first line

Example: "Burgring 22"

addressLine2

Address second line

Example: "1180 Vienna"

addressLine3

Address third line

Example: "Austria"

region

Region of the client

Example: "Vienna"

addressData

Describes the address in detail, so every country has its own fields filled. Use addressLines for preformatted address.

street

Street of the client

Example: "Burgring"

houseNumber

House number of the client

Example: "23A"

addressStatus

Describes the status of the address.

type required

Type of address status

Allowed values:

`VALID`	Default status of an address.
`INVALID`	The address status is proven as invalid.

Example: "VALID"

statusInformation

More details on the overall status

Example: "Letter could not be delivered"

since string(date)

Current status unchanged since

Example: "2000-01-01"

debtCollectionType

Type of debt collection

Allowed values:

`TRUST`	Claims are transferred, but still managed by the studio.
`PURCHASE`	Claims are transferred and bought by the debt collection agency.

Default: "TRUST"

Example: "TRUST"

derecognizeRemainingDebtsOnClosure

Debt handling on positive or negative closure of case

Allowed values:

`BY_PARTNER`	Indicates that the partner decides in update if the debt is written off.
`ALWAYS`	Indicates that the debt is always written off.

Example: "BY_PARTNER"

derecognizeRemainingDebtsOnRejection

Debt handling on rejection or reversal of case

Allowed values:

`BY_PARTNER`	Indicates that the partner decides in update if the debt is written off.
`ALWAYS`	Indicates that the debt is always written off.

Example: "BY_PARTNER"

Validation of the request failed.

Response Body application/json

Error data

errorMessage required

Resolved message in the context-specific default locale

errorCode

Key for translation files

traceId

Datadog trace id

args array[object] deprecated

Arguments referenced by format specifiers while resolving the message from translation files

typedArgs array[object] deprecated

Same as `args` but with type information

value

type

Allowed values:

TIMESTAMP BOOLEAN DATE MONTH_DAY TIME TERM TERM_LIST INTEGER DECIMAL STRING MONEY LIMITABLE_CONFIG_PROPERTY I18N_KEY I18N_KEY_LIST PERMISSION_LIST ENUM AVAILABILITY_LIST

reference

Reference to validation error

Example: "parent.child"

Authentication failed. No api-key, wrong api-key or wrong header name.

Response Body application/json

Error data

errorMessage required

Resolved message in the context-specific default locale

errorCode

Key for translation files

traceId

Datadog trace id

args array[object] deprecated

Arguments referenced by format specifiers while resolving the message from translation files

typedArgs array[object] deprecated

Same as `args` but with type information

value

type

Allowed values:

reference

Reference to validation error

Example: "parent.child"

Authorization failed. The caller has no privilege to the given resource.

Response Body application/json

Error data

errorMessage required

Resolved message in the context-specific default locale

errorCode

Key for translation files

traceId

Datadog trace id

args array[object] deprecated

Arguments referenced by format specifiers while resolving the message from translation files

typedArgs array[object] deprecated

Same as `args` but with type information

value

type

Allowed values:

reference

Reference to validation error

Example: "parent.child"

Entity does not exists.

Response Body application/json

Error data

errorMessage required

Resolved message in the context-specific default locale

errorCode

Key for translation files

traceId

Datadog trace id

args array[object] deprecated

Arguments referenced by format specifiers while resolving the message from translation files

typedArgs array[object] deprecated

Same as `args` but with type information

value

type

Allowed values:

reference

Reference to validation error

Example: "parent.child"

Concurrent modification detected. The entity was modified by another request.

Response Body application/json

Error data

errorMessage required

Resolved message in the context-specific default locale

errorCode

Key for translation files

traceId

Datadog trace id

args array[object] deprecated

Arguments referenced by format specifiers while resolving the message from translation files

typedArgs array[object] deprecated

Same as `args` but with type information

value

type

Allowed values:

reference

Reference to validation error

Example: "parent.child"

Access denied - rate limit is exceeded.

Response Body application/json

Error data

errorMessage required

Resolved message in the context-specific default locale

errorCode

Key for translation files

traceId

Datadog trace id

args array[object] deprecated

Arguments referenced by format specifiers while resolving the message from translation files

typedArgs array[object] deprecated

Same as `args` but with type information

value

type

Allowed values:

reference

Reference to validation error

Example: "parent.child"

Unexpected system error.

Response Body application/json

Error data

errorMessage required

Resolved message in the context-specific default locale

errorCode

Key for translation files

traceId

Datadog trace id

args array[object] deprecated

Arguments referenced by format specifiers while resolving the message from translation files

typedArgs array[object] deprecated

Same as `args` but with type information

value

type

Allowed values:

reference

Reference to validation error

Example: "parent.child"