Skip to main content

SurchargeSearchInput

Search criteria for filtering and paginating surcharge results.

Provides comprehensive filtering options including type, tax codes, activation status, and date ranges. All filters are optional and can be combined for precise result sets.

input SurchargeSearchInput {
  type: SurchargeType
  taxCode: TaxCode
  enabled: Boolean
  taxZone: String
  page: Int
  offset: Int
  createdAt: DateSearchInput
  lastModifiedAt: DateSearchInput
}

Fields​

SurchargeSearchInput.type ● SurchargeType enum​

Filter surcharges by calculation method type.

When specified, only returns surcharges matching the selected type (flat fee or percentage). If not provided, returns all types.

SurchargeSearchInput.taxCode ● TaxCode enum​

Filter surcharges by tax classification code.

When specified, only returns surcharges with the matching tax code (H, L, or N). If not provided, returns all tax codes.

SurchargeSearchInput.enabled ● Boolean scalar​

Filter surcharges by activation status.

When true, returns only active surcharges. When false, returns only inactive surcharges. Defaults to true if not specified.

SurchargeSearchInput.taxZone ● String scalar​

Filter surcharges by geographic tax zone.

When specified, only returns surcharges applicable to the specified tax zone. Must be exactly 2 characters if provided.

SurchargeSearchInput.page ● Int scalar​

Page number for pagination.

Determines which page of results to return. Must be a positive integer. Defaults to 1 if not specified.

SurchargeSearchInput.offset ● Int scalar​

Number of items to return per page.

Controls the size of each page in paginated results. Must be a positive integer with maximum of 100. Defaults to 12 if not specified.

SurchargeSearchInput.createdAt ● DateSearchInput input​

Filter surcharges by creation date range.

Allows filtering based on when surcharges were created. Supports date range queries with before, after, and exact date matching.

SurchargeSearchInput.lastModifiedAt ● DateSearchInput input​

Filter surcharges by last modification date range.

Allows filtering based on when surcharges were last updated. Supports date range queries with before, after, and exact date matching.

Member Of​

productSurcharges query ● surcharges query