band

Wipe a comp band column group's values from an effective date forward and set its format

Changed on
post/v1/org/{orgId}/band/clear-column

Request

  • Base URL: https://localhost
  • URL: https://localhost/v1/org/{orgId}/band/clear-column
  • Auth: none declared

Path parameters

orgIdstring required

Org identifier (either id or slug)

Request body

column'TARGET_EQUITY' | 'REFRESH_EQUITY' | 'VARIABLE_BONUS' required

Column group to wipe (TARGET_EQUITY, REFRESH_EQUITY, VARIABLE_BONUS)

formatstring

New format for the group; null disables the group, non-null records a destructive format change

effectiveDatestring date required

Effective date from which values are wiped; history before this date is preserved

Response

successful operation

bandCountinteger required

Changes