Get the Interests for a Claim

Responses

• 200 successfull request
  items

  array

  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 interest cannot be allocated to a specific invoice, the field can be left blank (`null`).

  currency

  string

  Max length: 3

  This reflects all relevant currencies in ISO-4217.

  originalAmount

  number

  Max length: 12

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

  remainingAmount

  number

  Max length: 12

  This is the outstanding amount of the interest 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.

  fromDate

  string

  yyyy-MM-dd

  Max length: 10

  The date when the interest occurred.

  toDate

  string

  yyyy-MM-dd

  Max length: 10

  When the interest rate has changed over time, an end date can be communicated here.

  capitalized

  boolean

  Max length: 10

  This information is particularly important in the context of loans, especially in Nordic countries, where creditors have the ability to charge interest on claims that are marked as capitalized, commonly known as compound interest.

  description

  string

  Max length: 256

  This is a description of the interest.

  pagination

  object

  Pagination information for the response.

  totalItems

  required

  integer

  The total number of items available.

  pageSize

  required

  integer

  The number of items per page.

  currentPage

  required

  integer

  The current page number.

  totalPages

  required

  integer

  The total number of pages.
• 401 request not authorized
• 404 claim not found