Skip to main content

CreateEventCourseRegistrationInput

Defines the input for creating a course registration in an event.

input CreateEventCourseRegistrationInput {
  attendanceStatus: CourseAttendanceStatus!
  comment: String
  contactId: ID!
  courseFeeTypeId: ID!
  customFields: [CustomFieldInput!]
  dateTime: DateTime!
  discountCodeId: ID
  eventId: ID!
  grade: String
  itineraryConfiguration: CourseRegistrationItineraryConfigurationInput!
  overridePaymentSchedule: [CreateOverridePaymentScheduleItemInput!]
  paymentDetail: CourseRegistrationPaymentDetailsInput
  paymentDetails: CreatePaymentDetailsInput @deprecated
  paymentScheduleSource: PaymentScheduleSource
  score: NonNegativeFloat!
  taxOverrides: [TaxOverrideInput!]
  tickets: PositiveInt!
}

Fields​

CreateEventCourseRegistrationInput.attendanceStatus ● CourseAttendanceStatus! non-null enum​

The attendee's attendance status for the course.

CreateEventCourseRegistrationInput.comment ● String scalar​

Comment for the course registration. Optional.

CreateEventCourseRegistrationInput.contactId ● ID! non-null scalar​

The identifier of the contact.

CreateEventCourseRegistrationInput.courseFeeTypeId ● ID! non-null scalar​

The identifier of the course fee type for the course registration.

CreateEventCourseRegistrationInput.customFields ● [CustomFieldInput!] list input​

The custom fields to create for the course registration. Optional.

CreateEventCourseRegistrationInput.dateTime ● DateTime! non-null scalar​

The date and time that the course registration occurred.

CreateEventCourseRegistrationInput.discountCodeId ● ID scalar​

The identifier of the discount code to apply to the course registration. Optional.

CreateEventCourseRegistrationInput.eventId ● ID! non-null scalar​

The identifier of the event the course registration is associated with.

CreateEventCourseRegistrationInput.grade ● String scalar​

The grade the attendee received for the course. Optional.

CreateEventCourseRegistrationInput.itineraryConfiguration ● CourseRegistrationItineraryConfigurationInput! non-null input​

The itinerary configuration for this course registration.

CreateEventCourseRegistrationInput.overridePaymentSchedule ● [CreateOverridePaymentScheduleItemInput!] list input​

The list of payment schedule items to override the default payment schedule, required when paymentScheduleSource is set to CUSTOM. Optional.

CreateEventCourseRegistrationInput.paymentDetail ● CourseRegistrationPaymentDetailsInput input​

The payment details for the course registration. Optional.

Rules:

  • Exactly one of paymentDetails and paymentDetail must be specified.

CreateEventCourseRegistrationInput.paymentDetails ● CreatePaymentDetailsInput deprecated input​

DEPRECATED

Use paymentDetail instead. This input field will be removed in a future release.

The payment details for the course registration. Optional.

CreateEventCourseRegistrationInput.paymentScheduleSource ● PaymentScheduleSource enum​

The source of the payment schedule for the course registration. Optional.

Will default to USE_DEFAULT if the course has usePaymentSchedule set to TRUE otherwise default to NO_PAYMENT_SCHEDULE.

CreateEventCourseRegistrationInput.score ● NonNegativeFloat! non-null scalar​

The score the attendee received for the course.

CreateEventCourseRegistrationInput.taxOverrides ● [TaxOverrideInput!] list input​

The collection of taxes for the event course registration booking that will override the taxes from setup. Optional.

When set to null, the default taxes for the event course registration will be applied. When set to an empty array, no taxes will be applied.

CreateEventCourseRegistrationInput.tickets ● PositiveInt! non-null scalar​

The number of tickets to register. Defaults to 1.

Member Of​

createEventCourseRegistration mutation