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
Cases
Create case
Create new case allows the api consumer to create new cases
POST
/
v1
/
{tenantId}
/
cases
Copy
curl --request POST \
--url https://api.debbiecollect.com/v1/{tenantId}/cases \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"creditorId": "245ac5f9-2795-4a91-8201-cb762dc88f70",
"isCompany": false,
"currency": "EUR",
"customerId": "a7fcf07c-74f2-40d9-8ea6-e67b07b14ca4",
"caseVouchers": [
{
"referenceId": "Fakt. 123456",
"voucherTypeId": "eb41e58e-fccf-419d-a771-cd5027fe6e87",
"amount": -259900,
"source": "CREDITOR",
"date": "2024-05-01 00:00:00.000+01",
"dueDate": "2024-05-08 00:00:00.000+01",
"referenceVouchers": [
{
"interestStartDate": "2024-06-01 00:00:00.000+01",
"amount": 0,
"source": "COLLECTOR",
"voucherTypeId": "ca4af363-9925-436c-83d6-23b3db6ed5d2",
"date": "2024-06-01 00:00:00.000+01"
},
{
"voucherTypeId": "3e51bf87-3c8f-4dd5-abd5-69417d113c89",
"amount": -10000,
"source": "CREDITOR",
"date": "2024-05-28 00:00:00.000+01"
},
{
"voucherTypeId": "3e51bf87-3c8f-4dd5-abd5-69417d113c89",
"amount": -10000,
"source": "CREDITOR",
"date": "2024-06-07 00:00:00.000+01"
}
]
}
]
}'
Copy
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"caseSeqId": 123
}
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 case is being created for
Body
application/json
New case object
The body is of type object
.
Response
200
application/json
Successful operation
The response is of type object
.
Copy
curl --request POST \
--url https://api.debbiecollect.com/v1/{tenantId}/cases \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"creditorId": "245ac5f9-2795-4a91-8201-cb762dc88f70",
"isCompany": false,
"currency": "EUR",
"customerId": "a7fcf07c-74f2-40d9-8ea6-e67b07b14ca4",
"caseVouchers": [
{
"referenceId": "Fakt. 123456",
"voucherTypeId": "eb41e58e-fccf-419d-a771-cd5027fe6e87",
"amount": -259900,
"source": "CREDITOR",
"date": "2024-05-01 00:00:00.000+01",
"dueDate": "2024-05-08 00:00:00.000+01",
"referenceVouchers": [
{
"interestStartDate": "2024-06-01 00:00:00.000+01",
"amount": 0,
"source": "COLLECTOR",
"voucherTypeId": "ca4af363-9925-436c-83d6-23b3db6ed5d2",
"date": "2024-06-01 00:00:00.000+01"
},
{
"voucherTypeId": "3e51bf87-3c8f-4dd5-abd5-69417d113c89",
"amount": -10000,
"source": "CREDITOR",
"date": "2024-05-28 00:00:00.000+01"
},
{
"voucherTypeId": "3e51bf87-3c8f-4dd5-abd5-69417d113c89",
"amount": -10000,
"source": "CREDITOR",
"date": "2024-06-07 00:00:00.000+01"
}
]
}
]
}'
Copy
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"caseSeqId": 123
}
Assistant
Responses are generated using AI and may contain mistakes.