Skip to main content
GET
Get creditor

Authorizations

Authorization
string
header
required

Authentication can be done by using a bearer token in the Authorization header. This is done using the following format Authorization: Bearer {token}.

Path Parameters

tenantId
string<uuid>
required

Id of the tenant the creditor is related to

creditorId
string<uuid>
required

Id of the creditor

Response

Successful operation

acquisitionResponsibleId
string<uuid>

Id of the user who is responsible for the acquisition of the creditor.

contactId
string<uuid>

Id of the creditor user who is case responsible.

caseworkerContactId
string<uuid>

Id of the caseworker user who is case responsible.

aksEnabled
boolean

Whether Experian AKS is enabled or not.

centralRegisterId
string<uuid>

Central register id. For example "DK40125949".

creditorId
string<uuid>

Id for the Creditor.

debtorFAQ
string

A FAQ for the debtor web.

defaultWorkflowId
string<uuid>

Id of the default workflow.

defaultCollectorId
string<uuid>

Id of the default collector.

defaultBillingModelId
string<uuid>

Id for the default billing model.

experianClientId
string

Experian client identifier.

id
string

Id for your internal systems. For example your ERP creditor id.

isCompany
boolean

Whether the creditor is a company.

name
string

Name of the creditor.

notes
string

Creditor notes.

selfCollection
boolean

Whether the creditor is collecting for themselves or not.

state
enum<string>

The state of the creditor

Available options:
LEAD,
SIGNED_ON,
ACTIVE,
CANCELLED,
CEASED
vatRegistered
string<uuid>

Whether the creditor is vat registered or not.