HEherondata
Positions

Override a position's status, frequency or payment amount

Changed on

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/api/positions/{position_heron_id}/overrides

Request

  • Base URL
    https://app.herondata.io
  • URL
    https://app.herondata.io/api/positions/{position_heron_id}/overrides
  • Auth
    API key in header x-api-key

Path parameters

position_heron_idstring required

The position heron ID

Request body

latest_repayment_amountnumber nullable required

Overridden latest repayment amount

repayment_frequency'not_enough_data' | 'same_day' | 'irregular' | 'daily' | 'weekly' | 'biweekly' | 'monthly' | 'quarterly' | 'annually' | 'weekday' | 'twice_weekly' | 'null' nullable required

Overridden repayment frequency; regular cadences only

status'none' | 'active' | 'inactive' | 'defaulted' | 'potential_default' | 'renewal_active' | 'renewal_inactive' | 'new_position' | 'likely_paid_off' | 'null' nullable required

Overridden status

Response

Override saved

createdstring date-time
created_bystring

Email of the person who made the edit

heron_idstring

Heron ID of the override

is_deletedboolean nullable
latest_repayment_amountnumber nullable
merchant_namestring nullable

Funder of the edited position

original_latest_repayment_amountnumber nullable
original_repayment_frequency'not_enough_data' | 'same_day' | 'irregular' | 'daily' | 'weekly' | 'biweekly' | 'monthly' | 'quarterly' | 'annually' | 'weekday' | 'twice_weekly' | 'null' nullable
original_status'none' | 'active' | 'inactive' | 'defaulted' | 'potential_default' | 'renewal_active' | 'renewal_inactive' | 'new_position' | 'likely_paid_off'
position_heron_idunknown
position_override_set_idstring uuid

Shared by every edit to the same position

product_type'mca' | 'line_of_credit' | 'reverse_consolidation' | 'revenue_share'
repayment_frequency'not_enough_data' | 'same_day' | 'irregular' | 'daily' | 'weekly' | 'biweekly' | 'monthly' | 'quarterly' | 'annually' | 'weekday' | 'twice_weekly' | 'null' nullable
status'none' | 'active' | 'inactive' | 'defaulted' | 'potential_default' | 'renewal_active' | 'renewal_inactive' | 'new_position' | 'likely_paid_off' | 'null' nullable

Changes