Skip to main content

Sponsorship

Defines a sponsorship for an event.

type Sponsorship {
  additionalCharges: [AppliedAdditionalCharge!]!
  brochures: [Brochure!]!
  cancelationTaxes: [AppliedTax!]!
  checklist: [AppliedChecklistItem!]!
  companyLogo: Image
  confirmationDate: LocalDate
  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!
  documents(
    limit: PaginationLimit! = 100
    offset: NonNegativeInt! = 0
  ): [AttachedDocument!]!
  fee: Fee!
  id: ID!
  inclusions: [SponsorshipItem!]!
  lastModifiedAt: DateTime!
  lastModifiedBy: String
  notes: String
  package: SponsorshipPackage!
  paymentDetails: SponsorshipPaymentDetails!
  paymentSchedule: [AppliedPercentagePaymentScheduleItem!]!
  profile: String
  quantity: PositiveInt!
  sponsor: Contact!
  status: SponsorshipStatus!
  taxes: [AppliedTax!]!
}

Fields​

Sponsorship.additionalCharges ● [AppliedAdditionalCharge!]! non-null object​

The list of additional charge details for the sponsorship.

Sponsorship.brochures ● [Brochure!]! non-null object​

A list of brochures associated with the company who sponsors the event.

Sponsorship.cancelationTaxes ● [AppliedTax!]! non-null object​

The list of cancelation taxes that apply to the sponsorship.

Sponsorship.checklist ● [AppliedChecklistItem!]! non-null object​

The list of checklist item details for the sponsorship.

The logo of the company who sponsors the event. Optional.

Sponsorship.confirmationDate ● LocalDate scalar​

The date at which the sponsorship was confirmed. Optional.

Sponsorship.createdAt ● DateTime! non-null scalar​

The date and time the record was created.

Sponsorship.createdBy ● String scalar​

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

Sponsorship.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 sponsorship.

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).
Sponsorship.customFields.input ● CustomFieldSearchFilterInput! non-null input​
Sponsorship.customFields.limit ● PaginationLimit! non-null scalar​
Sponsorship.customFields.offset ● NonNegativeInt! non-null scalar​

Sponsorship.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.
Sponsorship.customFieldsPaged.filterInput ● CustomFieldAdvancedSearchFilterInput! non-null input​
Sponsorship.customFieldsPaged.limit ● PaginationLimit! non-null scalar​
Sponsorship.customFieldsPaged.offset ● NonNegativeInt! non-null scalar​

Sponsorship.documents ● [AttachedDocument!]! non-null interface​

A list of the documents supplied for the sponsorship.

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).
Sponsorship.documents.limit ● PaginationLimit! non-null scalar​
Sponsorship.documents.offset ● NonNegativeInt! non-null scalar​

Sponsorship.fee ● Fee! non-null object​

The fee for the sponsorship, including both the amount and currency.

Sponsorship.id ● ID! non-null scalar​

The unique identifier for the sponsorship.

Sponsorship.inclusions ● [SponsorshipItem!]! non-null object​

A list of items included within a sponsorship.

Sponsorship.lastModifiedAt ● DateTime! non-null scalar​

The date and time the record was last modified.

Sponsorship.lastModifiedBy ● String scalar​

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

Sponsorship.notes ● String scalar​

The notes associated with the sponsorship. Optional.

Sponsorship.package ● SponsorshipPackage! non-null object​

The package for the sponsorship.

Sponsorship.paymentDetails ● SponsorshipPaymentDetails! non-null object​

The payment details for the sponsorship.

Sponsorship.paymentSchedule ● [AppliedPercentagePaymentScheduleItem!]! non-null object​

The applied payment schedule for the sponsorship.

Sponsorship.profile ● String scalar​

The profile of the company who sponsors the event. Optional.

Sponsorship.quantity ● PositiveInt! non-null scalar​

The number of packages for the sponsorship.

The sponsor who registered the sponsorship.

Sponsorship.status ● SponsorshipStatus! non-null enum​

The status for the sponsorship.

Sponsorship.taxes ● [AppliedTax!]! non-null object​

The list of taxes that apply to the sponsorship.

Member Of​

CancelSponsorshipPayload object ● Contact object ● CreateSponsorshipPayload object ● Event object ● RestoreSponsorshipPayload object ● SponsorshipPage object ● UpdateSponsorshipPayload object ● UpdateSponsorshipStatusPayload object