Class UpdateGroupEntryData

Hierarchy

  • UpdateGroupEntryData

Constructors

constructor

Properties

addRecordIds? commonFieldsData? deleteRemovedRecords? groupEntryDataId removeRecordIds?

Constructors

constructor

Properties

Optional Readonly addRecordIds

addRecordIds?: string[]

Record ids of the clients you wish to add to this group entry data. NOTE: if the removeRecordIds parameter is also passed and there are overlapping ids, it will take priority over this

Optional Readonly commonFieldsData

commonFieldsData?: {
    [key: string]: string | string[];
}

key value pairs where the key is the formula identifier of the field you wish to update. if omitted, then no fields will be updated.

Type declaration

  • [key: string]: string | string[]

Optional Readonly deleteRemovedRecords

deleteRemovedRecords?: boolean

a boolean to indicate if any removed records must be deleted in addition to removing them from the group entry data. Default is false

Readonly groupEntryDataId

groupEntryDataId: string

See updateGroupEntryData method for usage example

Optional Readonly removeRecordIds

removeRecordIds?: string[]

Record ids of the clients you wish to remove from this group entry data. NOTE: if the addRecordIds parameter is also passed and there are overlapping ids, this parameter will take priority.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc