Get the Costs for a Claim

Path

GET /claims/{claimNumber}/costs

Request Parameters

X-Client-Reference

array

Client reference header

claimNumber

required

string

claim number of the requested claim

Responses

array

currency

string

Max length: 3

This reflects all relevant currencies in ISO-4217.

remainingAmount

number

Max length: 12

This is the outstanding amount of the cost which needs to be collected by the Debt Collection Agency. A positive amount indicates a claim against the debtor. Negative amounts or 0 amounts are not allowed.

originalAmount

number

Max length: 12

This is the original amount of the cost. A positive amount indicates a claim against the debtor. Negative amounts or 0 amounts are not allowed.

taxRate

number

Max length: 12

The tax rate that was used.

date

string

yyyy-MM-dd

Max length: 10

The date when the costs occurred.

description

string

Max length: 256

This is a description of the costs.

invoiceNumber

string

Max length: 40

The invoice number assigned by the customer to the invoice to which the costs are to be allocated. If the costs cannot be allocated to a specific invoice, the field can be left blank (`null`).

type

string

Max length: 20

Enum:

CHARGEBACK

REMINDER_FEE

COMPENSATION

INTEREST_BEARING_COMPENSATION

LOAN_FEE

COSTS_OF_TURNING_OFF

BLOCKING_FINE

Represents the type of a cost.

object

Successful Request

Request Example

    
        null

Response Example

    
        {
 "items": [
  {
   "currency": "str",
   "remainingAmount": 0,
   "originalAmount": 0,
   "taxRate": 0,
   "date": "2024-07-23",
   "description": "string",
   "invoiceNumber": "string",
   "type": "CHARGEBACK"
  }
 ],
 "pagination": {
  "totalItems": 0
 }
}