Skip to main content
PATCH
Update an advance

Authorizations

Authorization
string
header
required

API key (nlmca_live_…) or OAuth access token

Path Parameters

id
string
required

Advance id

Body

application/json
status
enum<string>

New repayment status.

Available options:
on-track,
missed-payments,
defaulted,
paid-off
paid_amount
number

Total paid so far, USD (absolute value, not a delta).

Required range: x >= 0
payments_made
number

Payments made so far.

Required range: x >= 0
renewal_threshold_override
number | null

Renewal threshold override for this advance (0–100). Send null to fall back to the location default.

Required range: 0 <= x <= 100

Response

OK

data
object
required
meta
object
required