Skip to main content
PATCH
/
v1
/
{tenantId}
/
creditors
/
{creditorId}
Patch creditor
curl --request PATCH \
  --url https://api.debbiecollect.com/v1/{tenantId}/creditors/{creditorId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "acquisitionResponsibleId": "9409b6d8-cde5-45f1-b8e1-e756847a7077",
  "contactId": "bb71f936-c60c-4ad7-82f6-eddca673d30f",
  "caseworkerContactId": "9409b6d8-cde5-45f1-b8e1-e756847a7077",
  "notes": "Note to self (and my colleagues).",
  "name": "John Doe'\''s Factories",
  "defaultCollectorId": "f6700acf-edf6-4ef7-8e39-fa5f45d20c0d",
  "defaultChainId": "3057ca58-d39d-48ec-9d79-c45182b92ca0",
  "aksEnabled": true,
  "vatRegistered": true,
  "centralRegisterId": "DK40125949",
  "isCompany": true,
  "state": "ACTIVE",
  "id": "My reference",
  "selfCollection": false,
  "experianClientId": 125134,
  "creditorId": "a087de99-19aa-4f40-9883-fa4b20f3dff1",
  "debtorFAQ": "Frequently asked questions",
  "defaultClientChainId": "3057ca58-d39d-48ec-9d79-c45182b92ca0",
  "defaultBillingModelId": "9860cf1a-b4d9-4d4e-a085-298c4781eca0"
}'
This response has no body data.

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

Body

application/json

Patch creditor object

​
address
object

The creditors' address

​
referenceId
string<uuid>

Your reference id of the creditor.

​
contactId
string<uuid>

Id of the creditor user who is the contact person.

​
acquisitionResponsibleId
string<uuid>

Id of the user who acquired the customer.

​
caseworkerContactId
string<uuid>

Id of the caseworker user who is case responsible.

​
notes
string

Creditor notes.

​
erpLink
string

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

​
name
string

Name of the creditor.

​
defaultCollectorId
string<uuid>

Id of the default collector.

​
defaultWorkflowId
string<uuid>

Id of the default workflow.

​
defaultBillingModelId
string<uuid>

Id of the default billing model.

​
experianClientId
integer

Experian client id.

​
debtorFAQ
string

Frequently asked questions (shown in debtor web).

​
aksEnabled
boolean

Whether Experian AKS is enabled or not.

​
vatRegistered
boolean

Whether the creditor is vat registered or not.

​
isCompany
boolean

Whether the creditor is a company.

​
selfCollection
boolean

Whether the creditor is collecting for themselves or not.

​
centralRegisterId
string

Central register id. For example "DK40125949"

​
state
enum<string>

The state of the creditor

Available options:
LEAD,
SIGNED_ON,
ACTIVE,
CANCELLED,
CEASED