Get the History for a Claim

Path

GET /claims/{claimNumber}/history

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

page

integer default: 1

The current page number.

pageSize

integer default: 10

The number of items per page.

Responses

array
id

string

reference id

date

string
yyyy-MM-dd

Max length: 10

date format: yyyy-MM-dd

description

string

object

amount

number
Max length: 12

currency

string
Max length: 3

This reflects all relevant currencies in ISO-4217.

type

string
Max length: 20

Enum:
CREDIT_WAIVER
AGENCY_PAYMENT
DIRECT_PAYMENT

The type of the payment.

array

amount

number
Max length: 12

This is a description of the transaction.

allocateTo

string
Max length: 20

Enum:
PRINCIPAL_CLAIM
CLIENT_INTERESTS
ACCRUED_INTERESTS
CLIENT_COSTS
COLLECTION_COSTS
EXPENSES
OVERPAYMENT
CUSTOMER_OVERPAYMENT

The bucket to allocate the payment to. * `principalClaim` - Allocated to principal claim. * `interest` - Allocated to interest. * `fee` - Allocated to client fees. * `dunning` - Allocated to client dunning costs. * `collectionCost` - Allocated to collection cost. * `expense` - Allocated to agency expense.

documentId

string

reference id of the related document

messageId

string

reference id of the related message

type

string

Enum:
EVENT
PAYMENT
CONCERN

channel

string

Enum:
LETTER
EMAIL
PHONE
SMS
CHAT

The channel used for the communication.
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": [
  {
   "id": "string",
   "date": "2024-07-23",
   "type": "EVENT",
   "payment": {
    "amount": 0,
    "currency": "str"
   },
   "documentId": "string",
   "description": "string"
  }
 ],
 "pagination": {
  "totalItems": 0
 }
}