Skip to main content
POST
/
v1
/
{tenantId}
/
creditors
Create new creditor
curl --request POST \
  --url https://api.debbiecollect.com/v1/{tenantId}/creditors \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data @- <<EOF
{
  "id": "My reference",
  "name": "John Doe's Factories",
  "centralRegisterId": "DK40125949",
  "isCompany": true,
  "address": {
    "address": "Applebys Pl. 7, 1.",
    "coAddress": null,
    "city": "København K",
    "zipcode": "1411",
    "country": "Danmark"
  },
  "notes": "Note to self (and my colleagues).",
  "erpLink": "https://example.com?id={{customerReferenceId}}&test",
  "acquisitionResponsibleId": "9409b6d8-cde5-45f1-b8e1-e756847a7077",
  "contactId": "bb71f936-c60c-4ad7-82f6-eddca673d30f",
  "caseworkerContactId": "9409b6d8-cde5-45f1-b8e1-e756847a7077",
  "defaultWorkflowId": "3057ca58-d39d-48ec-9d79-c45182b92ca0",
  "state": "ACTIVE",
  "vatRegistered": true,
  "aksEnabled": true,
  "bankAccountDetails": {
    "type": "DANISH",
    "registrationNumber": "1234",
    "accountNumber": "00012345678"
  },
  "selfCollection": false
}
EOF
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "reference": "<string>"
}

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 being created for

Body

application/json

New creditor object

​
name
string
required

Name of the creditor.

​
isCompany
boolean
required

Whether the creditor is a company.

​
id
string

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

​
centralRegisterId
string

Central register id. For example "DK40125949"

​
address
object

The creditors' address

​
notes
string

Creditor notes.

​
erpLink
string

Link to creditors' ERP system ( https://example.com?id={{customerReferenceId}}&test ).

​
acquisitionResponsibleId
string<uuid>

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

​
contactId
string<uuid>

Id of the client user who is case responsible.

​
caseworkerContactId
string<uuid>

Id of the caseworker user who is case responsible.

​
defaultWorkflowId
string<uuid>

Id of the default workflow.

​
state
enum<string>

The state of the creditor

Available options:
LEAD,
SIGNED_ON,
ACTIVE,
CANCELLED,
CEASED
​
vatRegistered
boolean

Whether the creditor is vat registered or not.

​
aksEnabled
boolean

Whether Experian AKS is enabled or not.

​
bankAccountDetails
object

The creditors' bank account

​
selfCollection
boolean

Whether the creditor is collecting for themselves or not.

Response

Successful operation

​
id
string<uuid>
required

Id of the creditor

​
reference
string
required

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