Create a Payment

Path

POST /claims/{claimNumber}/payments

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.

paymentNumber

string

Max length: 40

The payment 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 payment.

date

string

yyyy-MM-dd

Max length: 10

The date of the payment.

description

string

Max length: 256

This is a description of the payment.

amount

number

Max length: 12

This is a description of the payment.

currency

string

Max length: 3

This reflects all relevant currencies in ISO-4217.

allocateTo

string

Max length: 20

Enum:

PRINCIPAL_CLAIM

CLIENT_COSTS

CLIENT_INTERESTS

The bucket to allocate the payment to. This is a desired allocation, which we try to follow. In certain cases depending on the legal basis or other restrictions, we might change the allocation accordingly.

Responses

Successful Request

Request Example

    
        {
 "invoiceNumber": "I0417211448",
 "paymentNumber": "P5803137068",
 "date": "2023-06-23",
 "contractNumber": "12677889976666",
 "description": "Quia molestias voluptates vero harum ea ea iste animi est.",
 "amount": 150,
 "currency": "EUR",
 "allocateTo": "PRINCIPAL_CLAIM"
}

Response Example

    
        {
 "requestId": "13fd0e6c-3bc5-4242-a246-cda29c052273"
}