API Documentation
Customers
Case vouchers
Billing
Webhooks
- HOOKUpdate created
- HOOKUpdate updated
- HOOKUpdate deleted
- HOOKCreditor created
- HOOKCreditor updated
- HOOKCase voucher created
- HOOKCase voucher updated
- HOOKCase voucher deleted
- HOOKPayment plan status change
- HOOKInteraction sent
- HOOKCustomer created
- HOOKCase status change
- HOOKCase merged
- HOOKCase merge undoed
- HOOKBilling created
- HOOKPayout created
Customers
Get customer by reference id
Get a customer by customer reference id
GET
/
v1
/
{tenantId}
/
customers
/
by-reference-id
/
{referenceId}
Copy
curl --request GET \
--url https://api.debbiecollect.com/v1/{tenantId}/customers/by-reference-id/{referenceId} \
--header 'Authorization: Bearer <token>'
Copy
{
"creditorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "<string>",
"customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"tenantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"referenceId": "<string>",
"isCompany": true,
"users": [
{
"userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"id": 123,
"relation": "debtor",
"contact": true,
"customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"lang": "bm",
"details": {
"name": "<string>",
"cpr": "<string>",
"cvr": "<string>",
"email": "<string>",
"phone": {
"number": "<string>",
"locale": "<string>"
},
"address": {
"address": "<string>",
"coAddress": "<string>",
"zipcode": "<string>",
"city": "<string>",
"country": "<string>"
},
"geocode": {
"latitude": 123,
"longitude": 123
}
}
}
],
"cases": [
{
"caseId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"id": 123,
"status": "PENDING",
"endReason": "PAID",
"statusTime": "<string>",
"createdAt": "<string>"
}
]
}
Authorizations
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
Id of the tenant the customer is related to
Customer id that the customer is related to
Query Parameters
Creditor id that the customer is related to
Response
200
application/json
Successful operation
The response is of type object
.
Copy
curl --request GET \
--url https://api.debbiecollect.com/v1/{tenantId}/customers/by-reference-id/{referenceId} \
--header 'Authorization: Bearer <token>'
Copy
{
"creditorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "<string>",
"customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"tenantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"referenceId": "<string>",
"isCompany": true,
"users": [
{
"userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"id": 123,
"relation": "debtor",
"contact": true,
"customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"lang": "bm",
"details": {
"name": "<string>",
"cpr": "<string>",
"cvr": "<string>",
"email": "<string>",
"phone": {
"number": "<string>",
"locale": "<string>"
},
"address": {
"address": "<string>",
"coAddress": "<string>",
"zipcode": "<string>",
"city": "<string>",
"country": "<string>"
},
"geocode": {
"latitude": 123,
"longitude": 123
}
}
}
],
"cases": [
{
"caseId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"id": 123,
"status": "PENDING",
"endReason": "PAID",
"statusTime": "<string>",
"createdAt": "<string>"
}
]
}
Assistant
Responses are generated using AI and may contain mistakes.