Skip to main content

PaymentSearchFilterInput

Defines the filter criteria used when searching for payments in EventsAir.

The following rules apply:

  • Where a field accepts a list of values as a filter, those values are applied using an OR operator.
  • If specifying multiple fields to filter on (for example both paymentIds and receiptNumbers), fields are applied using an AND operator.

Throws an error with code:

  • BAD_USER_INPUT if all fields in the input have a combined total number of values exceeding 1,000
input PaymentSearchFilterInput {
  details: PaymentDetailsSearchFilterInput
  exportedAt: OpenEndedDateTimeRangeFilter
  isExported: Boolean
  paymentIds: [ID!]
  receiptNumbers: [String!]
  recordedAt: OpenEndedDateTimeRangeFilter
  type: PaymentTypeSearchFilterInput
}

Fields​

PaymentSearchFilterInput.details ● PaymentDetailsSearchFilterInput input​

Filter payments based on their details. Optional.

PaymentSearchFilterInput.exportedAt ● OpenEndedDateTimeRangeFilter input​

Filter payments that have been exported within the specified date and time range. Optional.

PaymentSearchFilterInput.isExported ● Boolean scalar​

Filter payments based on their exported status. Optional.

true will return all payments that have an exported date and time, false will return all payments that have no exported date and time. Specifying null or omitting the input field will return all payments regardless of their exported status.

PaymentSearchFilterInput.paymentIds ● [ID!] list scalar​

Filter payments based on their identifiers. Optional.

PaymentSearchFilterInput.receiptNumbers ● [String!] list scalar​

Filter payments based on their receipt numbers. Optional.

PaymentSearchFilterInput.recordedAt ● OpenEndedDateTimeRangeFilter input​

Filter payments that have been recorded within the specified date and time range. Optional.

PaymentSearchFilterInput.type ● PaymentTypeSearchFilterInput input​

Filter payments based on their type. Optional.

Member Of​

payments query