AdjustmentType

Describes the target, action and value type of a change to a numeric data register.

Field

Data Type

Description

target

string

Required

The full path to the value target.

For example, if you are changing a Borrower's credit limit, the target would be profile.credit.limit .

Read-only after creation

action

string

( “add”, “deduct”, “set” )

Required The operation to be performed on the target. Note thatset overwrites the current value.

Read-only after creation

valueType

string

( “absolute”, “relative” )

Required The type of input value to be used in the adjustment.

An absolute value will be added/deducted/set on the target as is while a relative value will be added/deducted/set on the target as a ratio of the target value.

For instance, if we are doing an addition on the target, an absolute adjustment would be,

target += value

while a relative adjustment would be,

target += (value * target).

As such values for relative adjustments must be between 0 and 1.

Read-only after creation

AdjustmentDetail

Describes both the AdjustmentType and the adjustment value. It inherits all the fields found in AdjustmentType.

Field

Data Type

Description

name

string

Required

The adjustment resource name.

For example, a service charge adjustment on a lending product has the following name ,adjustments/lending.wezaapis.com/product/service_charge.

This field is read only and as such, it is not allowed in write requests.

Read-only

kind

string

Required

The adjustment type.

For example, a service charge adjustment on a lending product is of type lending.wezaapis.com/product/service_charge.

Read-only after creation

value

number

Required

The adjustment value.

Read-only after creation

displayName

string

Required

A human readable name for the adjustment.

Read-write

description

string

Optional adjustment description.

Read-write

Last updated