Skip to content

Member Groups

Representative Model Class Update Model Class Create Model Class
MemberGroup MemberGroupUpdate MemberGroupCreate

Member groups are used to categorize members into different groups. They can then be used to manage the members permissions, their membersip fee or to send out messages to specific groups of members.

Member Groups vs associations

This endpoint is used to manage the member groups themselves, not the assignment of members to groups.

agePermission class-attribute instance-attribute

agePermission: PositiveIntWithZero | None = None

assignmentDeleteAfterBooking class-attribute instance-attribute

assignmentDeleteAfterBooking: bool | None = None

billingAccount class-attribute instance-attribute

billingAccount: EasyVereinReference | None = None

color class-attribute instance-attribute

color: HexColor = None

costCentre class-attribute instance-attribute

costCentre: str | None = Field(default=None, max_length=8)

descriptionOnInvoice class-attribute instance-attribute

descriptionOnInvoice: str | None = None

isOnlyVisibleToAdmins class-attribute instance-attribute

isOnlyVisibleToAdmins: bool | None = None

name class-attribute instance-attribute

name: str | None = Field(default=None, max_length=200)

nameOnInvoice class-attribute instance-attribute

nameOnInvoice: str | None = Field(default=None, max_length=256)

nextGroup class-attribute instance-attribute

nextGroup: EasyVereinReference | None = None

paymentAmount class-attribute instance-attribute

paymentAmount: float | None = None

paymentFormula class-attribute instance-attribute

paymentFormula: str | None = Field(default=None, max_length=512)

paymentInterval class-attribute instance-attribute

paymentInterval: PositiveInt | None = None

short class-attribute instance-attribute

short: str | None = Field(default=None, max_length=4)

showInApplicationform class-attribute instance-attribute

showInApplicationform: bool | None = None

taxRate class-attribute instance-attribute

taxRate: float | None = None

usePaymentFormula class-attribute instance-attribute

usePaymentFormula: bool | None = None

userGroupAccount class-attribute instance-attribute

userGroupAccount: EasyVereinReference | None = None

user_board class-attribute instance-attribute

user_board: Literal['n', 'a', 'd'] | None = None
  • n: standard
  • a: allowed
  • d: forbidden
user_boardLinks: Literal['n', 'a', 'd'] | None = None
  • n: standard
  • a: allowed
  • d: forbidden

user_bookings class-attribute instance-attribute

user_bookings: Literal['n', 'a', 'd'] | None = None
  • n: standard
  • a: allowed
  • d: forbidden

user_edit class-attribute instance-attribute

user_edit: Literal['n', 'a', 'd'] | None = None
  • n: standard
  • a: allowed
  • d: forbidden

user_forum class-attribute instance-attribute

user_forum: Literal['n', 'a', 'd'] | None = None
  • n: standard
  • a: allowed
  • d: forbidden

user_importcalendar class-attribute instance-attribute

user_importcalendar: Literal['n', 'a', 'd'] | None = None
  • n: standard
  • a: allowed
  • d: forbidden

user_inventory class-attribute instance-attribute

user_inventory: Literal['n', 'a', 'd'] | None = None
  • n: standard
  • a: allowed
  • d: forbidden

user_invoiceRequest class-attribute instance-attribute

user_invoiceRequest: Literal['n', 'a', 'd'] | None = None
  • n: standard
  • a: allowed
  • d: forbidden

user_members class-attribute instance-attribute

user_members: Literal['n', 'a', 'd'] | None = None
  • n: standard
  • a: allowed
  • d: forbidden

user_members_groupaccess class-attribute instance-attribute

user_members_groupaccess: Literal['n', 'a', 'd', 'x'] | None = None
  • n: standard
  • a: limited
  • d: unlimited
  • x: ignore group

user_membershipCte class-attribute instance-attribute

user_membershipCte: Literal['n', 'a', 'd'] | None = None
  • n: standard
  • a: allowed
  • d: forbidden

user_protocols class-attribute instance-attribute

user_protocols: Literal['n', 'a', 'd'] | None = None
  • n: standard
  • a: allowed
  • d: forbidden

user_shares class-attribute instance-attribute

user_shares: Literal['n', 'a', 'd'] | None = None
  • n: standard
  • a: allowed
  • d: forbidden