Skip to main content

StatementsFilterInput

Filter criteria for querying multiple statements

input StatementsFilterInput {
  benefitIds: [ID!]
  benefitTypes: [BenefitType!]
  individualId: ID!
  periodEndsOnOrBefore: LocalDate
  periodStartsOnOrAfter: LocalDate
}

Fields​

StatementsFilterInput.benefitIds ● [ID!] list scalar​

When specified, only returns statements for accounts associated with these Benefits. Yields an empty list when the Individual has no statement-bearing account under any of these Benefits.

StatementsFilterInput.benefitTypes ● [BenefitType!] list enum​

When specified, only returns statements for accounts of these Benefit types. Today only HSA accounts produce statements; other types yield an empty list.

StatementsFilterInput.individualId ● ID! non-null scalar​

The ID of the Individual whose statements to list.

StatementsFilterInput.periodEndsOnOrBefore ● LocalDate scalar​

When specified, only returns statements whose period ends on or before this date.

StatementsFilterInput.periodStartsOnOrAfter ● LocalDate scalar​

When specified, only returns statements whose period starts on or after this date.

Member Of​

statements query