GuidesRecipesAPI Reference
Log In
API Reference

đźš§ Update a specific income record. (BETA)

đźš§

Under construction

This endpoint is in beta. Functionality may change without notice, support is limited, and use in production is not recommended. Your feedback is appreciated.

Updates a specific income record by ID. Pass only the fields to
change; omitted fields keep their current values. A field set to
null is stored as null. owner cannot be updated — since the
record's owner is echoed back on every read, a client sending a
full representation back unmodified still succeeds; only an actual
attempt to change it is rejected.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

Loan application ID.

string
required

Income record ID.

Body Params

Body for updating an income record. Pass only the fields to update.
owner cannot be updated — it is fixed at creation, and changing it
would change the record's id.

string | null

The type of employment this income is derived from.

string | null

This income source's type.

number | null

The amount of income from this source.

string | null

The frequency at which this income is earned.

Headers
string

Specify API version, for example '1.0'. By default, the version configured in the company settings is used.

Responses

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json