Skip to main content
POST
Record what has actually been received against an agreed claim, and when.

Headers

Prefer
enum<string>

Preference

Available options:
params=single-object

Body

Record what has actually been received against an agreed claim, and when.

The amount is the total received to date rather than the payment that just arrived, so a second instalment and a correction are the same call; nought clears it and puts the claim back where the decision left it. Reaching the agreed figure is what marks a claim SETTLED — the one state the answer cannot be changed from. Not an accounting entry: this product keeps no cash ledger, and this is the register saying the credit arrived.

p_claim_id
string<uuid>
required
p_settled_to_date
number<numeric>
required
p_received_on
string<date>
p_reference
string<text>

Response

200

OK