Positions
Override a position's status, frequency or payment amount
Saves a customer edit to a position. Each save is a new entry in the position’s edit history and replaces the previous edit. Values left null are not overridden.
POST
Override a position's status, frequency or payment amount
Authorizations
Path Parameters
The position heron ID
Body
application/json
Overridden latest repayment amount
Required range:
x >= 0Overridden current repayment frequency
Available options:
not_enough_data, same_day, irregular, daily, weekly, biweekly, monthly, quarterly, annually, weekday, twice_weekly, null Overridden status
Available options:
none, active, inactive, defaulted, potential_default, renewal_active, renewal_inactive, new_position, likely_paid_off, null Response
Override saved
Email of the person who made the edit
Heron ID of the override
Available options:
not_enough_data, same_day, irregular, daily, weekly, biweekly, monthly, quarterly, annually, weekday, twice_weekly, null Funder of the edited position
Available options:
not_enough_data, same_day, irregular, daily, weekly, biweekly, monthly, quarterly, annually, weekday, twice_weekly, null Available options:
none, active, inactive, defaulted, potential_default, renewal_active, renewal_inactive, new_position, likely_paid_off Position the override applies to; null when positions were rebuilt and it no longer applies
Shared by every edit to the same position
Available options:
mca, line_of_credit, reverse_consolidation, revenue_share Available options:
none, active, inactive, defaulted, potential_default, renewal_active, renewal_inactive, new_position, likely_paid_off, null