Create a Credit Waiver

Path

POST /claims/{claimNumber}/creditWaivers

Request Parameters

claimNumber

required

string

Refers to an existing claim

Request Body

application/json

invoiceNumber

string

Max length: 40

The invoice number assigned by the client for each invoice.

creditWaiverNumber

string

Max length: 40

The credit waiver number assigned by the client for each payment. It is optional, but it should be included if possible, as it allows us to ensure that payments sent twice are only processed once.

contractNumber

string

Max length: 40

A client-assigned contract number associated with this credit waiver.

date

string

yyyy-MM-dd

Max length: 10

The date of the credit waiver.

description

string

Max length: 256

This is a description of the credit waiver.

amount

number

Max length: 12

This is a description of the credit waiver.

currency

string

Max length: 3

This reflects all relevant currencies in ISO-4217.

Responses

Successful Request

Request Example

    
        {
 "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"
}

Response Example

    
        {
 "requestId": "224e8e3f-3508-4305-83b3-ddc96fde7ca4"
}