Skip to Main Content
Riverty Docs
    riverty logo Docs

    Get the Costs for a Claim

    Path

    GET /claims/{claimNumber}/costs

    Request Parameters

    X-Client-Global-Id
    number
    Client Global Id header. Used for internal communication only
    X-Client-Reference
    array
    Client reference header. Used for internal communication only
    claimNumber
    required
    string
    claim number of the requested claim
    view
    string
    Enum:

    CLIENT

    CONSUMER

    Changes the point of view of a response. If no value is provided, the default point of view is CLIENT.
    page
    integer default: 1
    The current page number.
    pageSize
    integer default: 10
    The number of items per page.

    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 (client costs, fees, third-party costs), reduced by all allocations, 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
      • COURT_COSTS
      • LAWYER_FEE
      • TITLING_COSTS
      • COST_ASSESSMENT_COSTS
      • BAILIFF_COSTS
      • AGREEMENT_REMUNERATION
      • COLLECTION_COSTS
      • CASH_EXPENSES
      • TICKET_CONTROL_COSTS
      • INVESTIGATION_COSTS
      • INTEREST_BEARING_REMINDER_FEE
      • EU_LATE_PAYMENT_FEE
      • DEFERMENT_COSTS
      • OTHER_COSTS
      Represents the type of a cost. Possible values and their meaning: * `CHARGEBACK` - A chargeback or refund initiated by a payment provider or bank. * `REMINDER_FEE` - Fee charged for sending a payment reminder. * `COMPENSATION` - General compensation or damages-related cost. * `INTEREST_BEARING_COMPENSATION` - Compensation amount that accrues interest. * `LOAN_FEE` - Fees related to loans (administration, processing). * `COSTS_OF_TURNING_OFF` - Costs incurred when turning off a service (e.g., disconnecting utilities). * `BLOCKING_FINE` - Fines related to blocking (e.g., account or service blocking). * `COURT_COSTS` - Costs imposed by or arising from court proceedings. * `LAWYER_FEE` - Fees charged by legal counsel. * `TITLING_COSTS` - Costs for establishing or registering titles or legal notices. * `COST_ASSESSMENT_COSTS` - Costs to assess or appraise other costs or damages. * `BAILIFF_COSTS` - Enforcement/bailiff fees when executing judgments. * `AGREEMENT_REMUNERATION` - Remuneration or fees agreed in a contract. * `COLLECTION_COSTS` - Costs arising from collection activities. * `CASH_EXPENSES` - Small cash expenses or out-of-pocket costs. * `TICKET_CONTROL_COSTS` - Costs related to ticket control (e.g., parking or transit enforcement). * `INVESTIGATION_COSTS` - Costs for investigations (tracing, identity checks). * `INTEREST_BEARING_REMINDER_FEE` - Reminder fee that accrues interest. * `EU_LATE_PAYMENT_FEE` - Late payment fee as defined by EU rules/regulation. * `DEFERMENT_COSTS` - Costs charged for deferring or postponing a payment. * `OTHER_COSTS` - Other costs that do not match a more specific cost category.
      array
      A list of additional properties, which belongs to the claim.
      key
      string
      value
      string
      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
    Successful Request

    Request Example

        
        null

    Response Example

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