riverty logo

Docs

Create a Claim

Path

POST /claims

Request Body

application/json

object
Contains all the customer data. Multiple customers can be provided.
array
Contains all known contacts needed for the collection process.
array
List of contracts including invoives as base for the claims
array
Contains all additional costs for the client.
array
Contains all interest.
locked
boolean
Max length: 5
An information about whether an claim is locked or not. In case an claim is locked, the backend system will not start any processes until the claim gets unlocked.
industry
string
Max length: 20
Enum:

UTILITY

PUBLIC_TRANSPORT

If the claim can be assigned to a specific industry, this can be entered in this field. Depending on the selected industry, there are specific fields that are available and must be partially filled.
array
Can be used to transfer payments that have already been made before the handover.
array
Can be used to transfer credit waivers that have already been made before the handover.
array
A list of addtional properties, which belongs to the claim.

Responses

Successful Request

Request Example

    
        {
 "customer": {
  "customerNumber": "B1140280585",
  "gender": "female",
  "title": "Ms.",
  "firstName": "Bianka",
  "lastName": "Hilll",
  "dateOfBirth": "1946-01-01",
  "type": "PRIVATE",
  "addresses": [
   {
    "street": "640 Carrie Crest",
    "zipCode": "56695-0518",
    "city": "West Mattiemouth",
    "countryCode": "TZ",
    "type": "billing"
   }
  ]
 },
 "contracts": [
  {
   "contractNumber": "V8157366331",
   "startDate": "2018-06-23",
   "endDate": "2023-06-23",
   "invoices": [
    {
     "invoiceNumber": "I5408705335",
     "invoiceDate": "2023-06-23",
     "remainingAmount": 100,
     "originalAmount": 120,
     "currency": "EUR"
    }
   ]
  }
 ]
}
    

Response Example

    
        {
 "requestId": "8ec4f2b1-964b-42fd-9b1a-abd9274af9c1"
}