riverty logo

Docs

Create a Credit Waiver

When creating a credit waiver, clients are able to request a reduction of a debtor's outstanding balance. The process of creating a credit waiver is similar to that of making a payment, with the primary difference being that the paymentNumber field is replaced by creditWaiverNumber in the response body.

Additionally, because this process involves a monetary transaction, an accounting document of type creditWaiver is generated for each credit waiver processed. This document provides a detailed record of the transaction, ensuring accurate financial tracking.

Endpoint

POST {{collection_api_base_url}}/v1/claims/{claimNumber}/creditWaivers

Sample Request Body

{
  "invoiceNumber": "I0417211448",
  "creditWaiverNumber": "D488839937733",
  "contractNumber": "166271782837",
  "date": "2023-06-23",
  "description": "Quia molestias voluptates vero harum ea ea iste animi est.",
  "amount": 100,
  "currency": "EUR"
}

Sample Response


"requestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"

Please Note: Only one credit waiver can be processed per call or request. If multiple credit waivers need to be created, a separate API call must be made for each individual credit.