FunctionRegistration

Function registration encapsulates information about the attendee and the options selected when registering to attend the function in an event.

type FunctionRegistration {
  cancelationTaxes: [AppliedTax!]!
  checkInDate: DateTime
  checkOutDate: DateTime
  contact: Contact!
  createdAt: DateTime!
  createdBy: String
  customFields(
    input: CustomFieldSearchFilterInput! = [object Object]
    limit: PaginationLimit! = 100
    offset: NonNegativeInt! = 0
  ): [CustomField!]! @deprecated
  customFieldsPaged(
    filterInput: CustomFieldAdvancedSearchFilterInput! = [object Object]
    limit: PaginationLimit! = 100
    offset: NonNegativeInt! = 0
  ): CustomFieldPage!
  fee: Fee!
  feeType: FunctionFeeType!
  function: Function!
  guests: [FunctionGuest!]!
  id: ID!
  isGroupInventory: Boolean!
  lastModifiedAt: DateTime!
  lastModifiedBy: String
  paymentDetails: FunctionRegistrationPaymentDetails!
  paymentSchedule: [AppliedPaymentScheduleItem!]
  paymentScheduleSource: PaymentScheduleSource!
  taxes: [AppliedTax!]!
  tickets: PositiveInt!
}

Fields

FunctionRegistration.cancelationTaxes ● [AppliedTax!]! non-null object

The list of cancelation taxes that apply to the function registration booking.

FunctionRegistration.checkInDate ● DateTime scalar

The date and time at which the attendee checked into the function. Optional.

FunctionRegistration.checkOutDate ● DateTime scalar

The date and time at which the attendee checked out of the function. Optional.

FunctionRegistration.contact ● Contact! non-null object

The contact who registered.

FunctionRegistration.createdAt ● DateTime! non-null scalar

The date and time the record was created.

FunctionRegistration.createdBy ● String scalar

UTF-8 string value that represents the username of the user who created the record. Optional.

FunctionRegistration.customFields ● [CustomField!]! deprecated non-null object

DEPRECATED

Use customFieldsPaged instead. It returns the same custom fields together with pagination metadata (total count, has-next-page) and exposes a richer filter input supporting both inclusion and exclusion semantics (eq, ne, in, notIn). This field will be removed in a future release.

A list of custom field values associated with this function registration.

CustomFields and CustomFieldDefinitions can be matched through the definitionId and id fields, respectively.

See CustomFieldSearchFilterInput for details on how the optional input argument can be used to filter custom fields.

Optionally, the offset and limit arguments can be used to page through multiple items:

• offset must be a non-negative integer (defaults to 0).
• limit must be a positive integer from 1 to 2000 (defaults to 100).

FunctionRegistration.customFields.input ● CustomFieldSearchFilterInput! non-null input

FunctionRegistration.customFields.limit ● PaginationLimit! non-null scalar

FunctionRegistration.customFields.offset ● NonNegativeInt! non-null scalar

FunctionRegistration.customFieldsPaged ● CustomFieldPage! non-null object

Custom fields associated with this record that match the filter criteria specified in the optional filterInput argument, returned together with pagination metadata.

See CustomFieldAdvancedSearchFilterInput for details on how the filterInput argument can be used. The filter supports both inclusion and exclusion semantics (eq, ne, in, notIn).

Optionally, the offset and limit arguments can be used to page through multiple items:

• offset must be a non-negative integer (defaults to 0).
• limit must be a positive integer from 1 to 2000 (defaults to 100).

Throws an error with code:

• BAD_USER_INPUT if all fields in the filterInput argument have a combined total number of values exceeding 1,000.

FunctionRegistration.customFieldsPaged.filterInput ● CustomFieldAdvancedSearchFilterInput! non-null input

FunctionRegistration.customFieldsPaged.limit ● PaginationLimit! non-null scalar

FunctionRegistration.customFieldsPaged.offset ● NonNegativeInt! non-null scalar

FunctionRegistration.fee ● Fee! non-null object

The fee including both the amount and currency.

FunctionRegistration.feeType ● FunctionFeeType! non-null object

The fee type that applied to the function registration.

FunctionRegistration.function ● Function! non-null object

The function this function registration pertains to.

FunctionRegistration.guests ● [FunctionGuest!]! non-null object

A list of function guests.

FunctionRegistration.id ● ID! non-null scalar

The unique identifier for a function registration.

FunctionRegistration.isGroupInventory ● Boolean! non-null scalar

A flag indicating whether the function registration is inventory being held for a group on a Group Co-ordinator.

FunctionRegistration.lastModifiedAt ● DateTime! non-null scalar

The date and time the record was last modified.

FunctionRegistration.lastModifiedBy ● String scalar

UTF-8 string value that represents the username of the user who last modified the record. Optional.

FunctionRegistration.paymentDetails ● FunctionRegistrationPaymentDetails! non-null object

The payment details for the registration.

FunctionRegistration.paymentSchedule ● [AppliedPaymentScheduleItem!] list object

The list of payment schedule items that apply to the function registration. Optional.

FunctionRegistration.paymentScheduleSource ● PaymentScheduleSource! non-null enum

The source of the payment schedule for the function registration.

FunctionRegistration.taxes ● [AppliedTax!]! non-null object

The list of taxes that apply to the function registration booking.

FunctionRegistration.tickets ● PositiveInt! non-null scalar

The number of tickets registered.

Member Of

CancelFunctionRegistrationPayload object ● CeContactStore object ● CeContactStoreContact object ● Contact object ● CreateFunctionRegistrationPayload object ● Event object ● Function object ● FunctionRegistrationPage object ● MembershipContactStore object ● MembershipContactStoreContact object ● RestoreFunctionRegistrationPayload object ● UpdateFunctionRegistrationPayload object ● UpdateFunctionRegistrationStatusPayload object