Skip to main content
GET
/
v1
/
{tenantId}
/
case-vouchers
/
{caseId}
Get case vouchers on a case
curl --request GET \
  --url https://api.debbiecollect.com/v1/{tenantId}/case-vouchers/{caseId} \
  --header 'Authorization: Bearer <token>'
[
  {
    "voucherTypeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "referenceId": "<string>",
    "currency": "DKK",
    "amount": 123,
    "date": "<string>",
    "dueDate": "<string>",
    "text": "<string>",
    "caseVoucherId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "id": 123,
    "tenantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "source": "CREDITOR",
    "interest": 123,
    "interestStartDate": "<string>",
    "interestEndDate": "<string>",
    "cardType": "<string>",
    "paymentType": "BANK_TRANSFER",
    "paymentMethodId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "appendix": {},
    "caseId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "tags": [
      "<any>"
    ],
    "createdAt": "<string>",
    "createdBy": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "USER"
    },
    "transactionAccountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "referenceCaseVoucherId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "details": {},
    "lineItems": [
      "<any>"
    ],
    "state": "UNMAPPED",
    "category": "principal",
    "label": "<string>",
    "settings": "<string>",
    "settingDetails": {},
    "deletedAt": "<string>",
    "deletedBy": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "USER"
    },
    "exported": true,
    "expirationDate": "<string>",
    "expired": true,
    "expirationManualSet": true,
    "expirationFromDate": "<string>",
    "irrecoverableDate": "<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

​
caseId
string
required

Case id

Query Parameters

​
pointInTime
string

Date (format YYYY-MM-DD.) to get the case vouchers for. Only case vouchers with caseVoucher.date before this date will be returned. Interests will be calculated based on the date.

Response

Successful operation

​
voucherTypeId
string<uuid>

Id of the voucher type

​
referenceId
string

Reference id of the case voucher. Invoice number for example.

​
currency
enum<string>

Currency

Available options:
DKK,
SEK,
NOK,
USD,
EUR,
GBP,
CHF
​
amount
integer

Amount in base currency. For example 1.00 will be sent as 100.

​
date
string

Date of the voucher

​
dueDate
string

Due date of the voucher

​
text
string

Text on the case voucher

​
caseVoucherId
string<uuid>

Id of the case voucher

​
id
number

Sequential id of the case voucher

​
tenantId
string<uuid>

Id of the tenant

​
source
enum<string>

The source of the case voucher. "CREDITOR" if the case voucher is imposed by the creditor (typically from an ERP system). "COLLECTOR" if the case voucher is imposed by collector (debt collection agency). If it is a deposit it is a direct payment if set to "CREDITOR".

Available options:
CREDITOR,
COLLECTOR
​
interest
number

Interest rate of the case voucher. Only on case vouchers with a voucher type of interest.

​
interestStartDate
string

Interest start date of the case voucher. Only on case vouchers with a voucher type of interest.

​
interestEndDate
string

Interest end date of the case voucher. Only on case vouchers with a voucher type of interest.

​
cardType
string

Card type of the case voucher. Only on case vouchers with a voucher type of deposit.

​
paymentType
enum<string>

Payment type of the deposit case voucher.

Available options:
BANK_TRANSFER,
MASTERCARD,
VISA,
DANKORT,
IBAN,
CREDITOR,
PAYPAL,
APPLE_PAY,
GOOGLE_PAY,
FIK,
LEVERANDØRSERVICE,
BETALINGSSERVICE,
MOBILEPAY,
SWISH,
VIPPS
​
paymentMethodId
string<uuid>

Payment method id of the case voucher. Only on case vouchers with a voucher type of deposit.

​
appendix
object

Appendix of the case voucher

​
caseId
string<uuid>

Id of the voucher type

​
tags
any[]

Tags of the case voucher

​
createdAt
string

Created at timestamp of the case voucher

​
createdBy
object

Created by user of the case voucher

​
transactionAccountId
string<uuid>

Id of the transaction account

​
referenceCaseVoucherId
string<uuid>

Id of the reference case voucher

​
details
object

Details of the case voucher

​
lineItems
any[]

Line items of the case voucher

​
state
enum<string>

State of the case voucher

Available options:
UNMAPPED,
UNKNOWN,
ARCHIVED,
OVERPAYMENT,
FULL_PAYMENT,
PARTIAL_PAYMENT,
PAYMENT_PLAN_ENTRY_PAYMENT,
UNKNOWN_PAYMENT_PLAN_PAYMENT,
ACCORD_PAYMENT,
PRINCIPAL_PAYMENT,
PENDING
​
category
enum<string>

Category of the case voucher type

Available options:
principal,
cost,
courtcost,
interest,
transaction
​
label
string

Label of the case voucher type

​
settings
string

Settings of the case voucher type

​
settingDetails
object

Setting details of the case voucher type

​
deletedAt
string

Deleted at timestamp of the case voucher

​
deletedBy
object

Deleted by of the case voucher

​
exported
boolean

Whether the case voucher is exported or not

​
expirationDate
string

Expiration date of the case voucher

​
expired
boolean

Whether the case voucher is expired or not

​
expirationManualSet
boolean

Whether the expiration date is manually set or not

​
expirationFromDate
string

If the expiration should be calculated from another date than date/dueDate

​
irrecoverableDate
string

Irrecoverable date of the case voucher