curl --request GET \
--url https://api.debbiecollect.com/v1/{tenantId}/billings/{billingId}/deposit-distribution \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.debbiecollect.com/v1/{tenantId}/billings/{billingId}/deposit-distribution"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.debbiecollect.com/v1/{tenantId}/billings/{billingId}/deposit-distribution', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.debbiecollect.com/v1/{tenantId}/billings/{billingId}/deposit-distribution",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.debbiecollect.com/v1/{tenantId}/billings/{billingId}/deposit-distribution"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.debbiecollect.com/v1/{tenantId}/billings/{billingId}/deposit-distribution")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.debbiecollect.com/v1/{tenantId}/billings/{billingId}/deposit-distribution")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"meta": {
"currentPage": 0,
"pageSize": 25
},
"items": [
{
"currency": "DKK",
"depositCaseVoucher": {
"caseVoucherId": "<string>",
"id": 123,
"amount": 123,
"paymentType": "BANK_TRANSFER",
"source": "CREDITOR",
"state": "UNMAPPED",
"transactionAccountId": "<string>"
},
"customer": {
"referenceId": "<string>"
},
"case": {
"caseId": "<string>",
"id": 123,
"groupId": "<string>",
"groupLabel": "<string>"
},
"caseVouchers": [
{
"caseVoucherId": "<string>",
"voucherTypeId": "<string>",
"amount": 123,
"source": "CREDITOR",
"referenceId": "<string>",
"collectionCommission": true
}
],
"overpayment": 123,
"isAdjustment": true
}
]
}Get deposit distribution
How each payment in a settlement was split — what went to your debt collection partner, and what is yours. Every entry carries source, which tells you whether you already have the posting in your own books (CREDITOR) or whether your debt collection partner added it (COLLECTOR).
The fees and disbursements charged on the settlement are reported by Get billing vouchers; the two do not overlap.
Required scope: read:billings
curl --request GET \
--url https://api.debbiecollect.com/v1/{tenantId}/billings/{billingId}/deposit-distribution \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.debbiecollect.com/v1/{tenantId}/billings/{billingId}/deposit-distribution"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.debbiecollect.com/v1/{tenantId}/billings/{billingId}/deposit-distribution', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.debbiecollect.com/v1/{tenantId}/billings/{billingId}/deposit-distribution",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.debbiecollect.com/v1/{tenantId}/billings/{billingId}/deposit-distribution"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.debbiecollect.com/v1/{tenantId}/billings/{billingId}/deposit-distribution")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.debbiecollect.com/v1/{tenantId}/billings/{billingId}/deposit-distribution")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"meta": {
"currentPage": 0,
"pageSize": 25
},
"items": [
{
"currency": "DKK",
"depositCaseVoucher": {
"caseVoucherId": "<string>",
"id": 123,
"amount": 123,
"paymentType": "BANK_TRANSFER",
"source": "CREDITOR",
"state": "UNMAPPED",
"transactionAccountId": "<string>"
},
"customer": {
"referenceId": "<string>"
},
"case": {
"caseId": "<string>",
"id": 123,
"groupId": "<string>",
"groupLabel": "<string>"
},
"caseVouchers": [
{
"caseVoucherId": "<string>",
"voucherTypeId": "<string>",
"amount": 123,
"source": "CREDITOR",
"referenceId": "<string>",
"collectionCommission": true
}
],
"overpayment": 123,
"isAdjustment": true
}
]
}Authorizations
Authentication with an API key can be done by using a bearer token in the Authorization header. This is done using the following format Authorization: Bearer {token}. API keys are issued and revoked directly from the creditor portal under Developers > API.
Path Parameters
Id of your debt collection partner's tenant. You can find it on the API page in the creditor portal.
Id of the billing, from the billings.create webhook
Query Parameters
Zero-based page number
x >= 0Number of payments per page
1 <= x <= 1000Include the payments made directly to you. Without it, the commission charged on those payments is reported as a separate fee on the billing rather than as part of the distribution.