Enums

Names and values for all enumerations used in the Bunny GraphQL API.

An enum is a fixed set of values that a field or argument will accept. Each enum below lists the values it allows and what each value means.

AccountActivityCategoryLink to AccountActivityCategory section

The part of an account an activity event belongs to

Name	Description
QUOTES	Quote events
SUBSCRIPTIONS	Subscription events
INVOICES_PAYMENTS	Invoice, credit note and payment events
ACCOUNT_TENANTS	Account and tenant events

ActivityRecordTypeLink to ActivityRecordType section

Account-owned record whose activity is requested

Name	Description
SUBSCRIPTION
QUOTE
INVOICE
CREDIT_NOTE
CONTACT
DEAL
DISPUTE
EMAIL
LEAD
TENANT

ApprovalRequestStateLink to ApprovalRequestState section

Name	Description
PENDING	Pending
APPROVED	Approved
REJECTED	Rejected

BankConnectionStateLink to BankConnectionState section

Name	Description
PENDING	Link session started but not yet completed
ACTIVE	Connection is live and synchronizing
REAUTHENTICATION_REQUIRED	The bank link expired and must be re-authorized
REVOKED	Access to the bank was withdrawn

BankTransactionImportStateLink to BankTransactionImportState section

Name	Description
RUNNING	Import is in progress
COMPLETED	Import finished successfully
FAILED	Import did not finish

BankTransactionImportTriggerLink to BankTransactionImportTrigger section

Name	Description
SCHEDULED	Started by the nightly cron
MANUAL	Started from the “Sync now” action

BankTransactionStateLink to BankTransactionState section

Name	Description
UNMATCHED	No invoice has been suggested for this transaction
SUGGESTED	An invoice has been suggested and is awaiting approval
APPROVED	A manual payment has been created for this transaction
IGNORED	Transaction has been hidden as not relevant to billing

BatchMutationNameLink to BatchMutationName section

Name	Description
SUBSCRIPTION_CANCEL
QUOTE_CHANGE_UPDATE
QUOTE_CHANGE_ADD
QUOTE_CHANGE_DELETE

BillingPeriodLink to BillingPeriod section

Name	Description
ONCE	Billed Once
MONTHLY	Billed Monthly
QUARTERLY	Billed Quarterly
SEMI_ANNUAL	Billed Semi_annual
ANNUAL	Billed Annual

ChargeTypeLink to ChargeType section

Name	Description
ONE_TIME	One_time charge
RECURRING	Recurring charge
USAGE	Usage charge

CouponDiscountKindLink to CouponDiscountKind section

Name	Description
PERCENTAGE	Percentage
AMOUNT	Amount

CreditBalanceStateLink to CreditBalanceState section

Where a credit balance stands after the latest usage

Name	Description
OK	Credits remain
LOW	Credits remain, below the alert threshold
DEPLETED	No credits remain; usage bills as overage
BLOCKED	No credits remain and usage is not billed; stop serving until credits are added

CreditDepletionPolicyLink to CreditDepletionPolicy section

What happens to usage when a credit balance reaches zero

Name	Description
OVERAGE	Remaining usage bills at the charge price
TOP_UP	Buy more credits through the usage charge’s top-up charge
BLOCK	Usage after zero is recorded but not billed, and the balance reads blocked

CreditGrantKindLink to CreditGrantKind section

Name	Description
PREPAID	Prepaid credits
RECURRING	Recurring credits
PROMO	Promo credits
ROLLOVER	Rollover credits
ADJUSTMENT	Adjustment credits

CreditGrantStatusLink to CreditGrantStatus section

Name	Description
SCHEDULED
ACTIVE
DEPLETED
EXPIRED
VOIDED

CreditKindLink to CreditKind section

Whether a one-time or recurring charge grants credits, and what kind: the three choices of the charge form stored as usageCredits plus whether the charge has a feature

Name	Description
NONE	A normal charge that grants no credits
UNITS	Grants credits that prepay units of the charge’s feature
BALANCE	Grants a balance in the price list currency that credits-mode usage charges draw down

CreditLedgerEntryKindLink to CreditLedgerEntryKind section

Name	Description
GRANT
ROLLOVER_IN
REVERSAL
TRANSFER_IN
DRAWDOWN
EXPIRY
VOID
ROLLOVER_OUT
TRANSFER_OUT
ADJUSTMENT

CreditNoteKindLink to CreditNoteKind section

Name	Description
WRITE_OFF	Write_off credit note
REFUND	Refund credit note
CREDIT	Credit credit note

CreditNoteStateLink to CreditNoteState section

Name	Description
PREPARING	Preparing credit note
DRAFT	Draft credit note
READY	Ready credit note
PARTIALLY_APPLIED	Partially_applied credit note
APPLIED	Applied credit note

CurrencyConversionTypeLink to CurrencyConversionType section

Name	Description
fixed	Convert to base currency via fixed conversion rate
lookup	Convert to base currency using conversion rate lookup

DealKindLink to DealKind section

Kind of deal

Name	Description
NEW	New business
EXISTING	Existing business

DealOriginLink to DealOrigin section

Origin of deal

Name	Description
SALES	Sales
PORTAL	Portal
SIGNUP	Signup
OTHER	Existing business

DealStageKindLink to DealStageKind section

Name	Description
OPEN	OPEN
CLOSED_WON	CLOSED_WON
CLOSED_LOST	CLOSED_LOST

DisputeInvoiceActionLink to DisputeInvoiceAction section

Name	Description
DO_NOTHING	Take no action on invoices when dispute is lost
UNPAY_AND_REFUND	Unpay the invoice and create a refund when dispute is lost
CREDIT_NOTE_AND_REFUND	Create a credit note and refund when dispute is lost

DisputeProcessingStateLink to DisputeProcessingState section

Name	Description
OPEN	Dispute processing is open
CLOSED	Dispute processing is closed

DisputeStateLink to DisputeState section

Name	Description
OPEN	Dispute is open and under review
WON	Dispute has been won by the merchant
LOST	Dispute has been lost by the merchant

DisputeSubscriptionActionLink to DisputeSubscriptionAction section

Name	Description
DO_NOTHING	Take no action on subscriptions when dispute is lost
DO_NOT_AUTO_RENEW	Disable auto-renewal for subscriptions when dispute is lost
CANCEL_IMMEDIATELY	Cancel subscriptions immediately when dispute is lost

DocumentTemplateComponentKindLink to DocumentTemplateComponentKind section

Name	Description
IMAGE	Image
HEADING	Heading
PAGEBREAK	Pagebreak
PARAGRAPH	Paragraph
QUOTE	Quote
SEPARATOR	Separator
SIGNATURES	Signatures
SPACER	Spacer
ENTITY	Entity
ACCOUNT	Account
HEADER	Header
FOOTER	Footer

EmailStateLink to EmailState section

Name	Description
queued	Email is being procesed
processing	Email is being procesed
retrying	Email is delayed
delivered	Email was delivered successfully
failed	Email delivery failed
disabled	Outbound emails disabled

EventWrittenByLink to EventWrittenBy section

Name	Description
JOB	Written by a background job
REQUEST	Written outside any job (a web request, console or script)

FeatureKindLink to FeatureKind section

Name	Description
BOOLEAN	True or false
VALUE	Takes a value when used on a plan
QUANTITY	Quantity
GROUP	Feature group

FieldKindLink to FieldKind section

Name	Description
CURRENCY	Currency
INT	Integer
DECIMAL	Decimal
STRING	String
DATE	Date
TIMESTAMP	Timestamp
BOOL	Boolean
RELATION	Relation
MANY_RELATION	Many Relation
ENUM	Enumerable

FinancialAccountTypeLink to FinancialAccountType section

Name	Description
earned_revenue	Earned revenue
deferred_revenue	Deferred revenue
accounts_receivable	Accounts receivable
cpca	CPCA
tax_payable	Tax payable
conversion_gain	Conversion gain
conversion_loss	Conversion loss
banking_fees	Banking fees
payments	Payments
bad_debt	Bad debt
customer_advances	Customer advances
accounts_payable	Accounts payable

HistogramDataIntervalEnumLink to HistogramDataIntervalEnum section

Name	Description
DAILY	Monthly interval
MONTHLY	Monthly interval
QUARTERLY	Quarterly interval
SEMIANNUALLY	Semiannually interval
YEARLY	Yearly interval

InvoiceStateLink to InvoiceState section

Name	Description
NOT_DUE	Not_due invoice
DUE	Due invoice
UNPAID	Unpaid invoice
PAID	Paid invoice
VOIDED	Voided invoice
READY	Ready invoice
FAILED	Failed invoice
PREPARING	Preparing invoice
PROCESSING_PAYMENT	Processing_payment invoice
DRAFT	Draft invoice
MERGED	Merged invoice
QUEUED	Queued invoice
CONSOLIDATED	Consolidated invoice

JobStatusLink to JobStatus section

Name	Description
running	Job is running
completed	Job completed successfully
failed	Job failed

PayingStatusLink to PayingStatus section

Account paying status

Name	Description
FREE	Free
TRIAL	Trial
NOT_PAYING	Free
PAYING	Free
CHURNED_FROM_FREE	Free
CHURNED_FROM_PAYING	Free

PaymentHoldStateLink to PaymentHoldState section

Name	Description
SUCCEEDED	Payment hold is successful
CANCELLED	Payment hold is cancelled

PaymentMethodStateLink to PaymentMethodState section

Name	Description
UNKNOWN	Payment method has not ben used or unknown state
SUCCESS	Payment method has been succesfully used
FAILED	Payment method has failed during use

PaymentProcessingStateLink to PaymentProcessingState section

Name	Description
SUCCEEDED	Payment is successful
FAILED	Payment is failed
PENDING	Payment is pending
PROCESSING	Payment is processing
DISPUTED	Payment is disputed

PaymentStateLink to PaymentState section

Name	Description
UNAPPLIED	Payment is not yet applied
PARTIALLY_APPLIED	Payment is partially applied
APPLIED	Payment is applied

PaymentTypeLink to PaymentType section

Name	Description
card	Credit or Debit Card payment
wire	Wire transfer payment
ach	ACH payment
other	Uncategorized payment

PlanPricingStylesLink to PlanPricingStyles section

Pricing styles options for creating plans

Name	Description
PRICED	Priced
FREE	Free
CONTACT_US	Contact us

PluginParameterKindLink to PluginParameterKind section

Name	Description
SECRET	Secret parameter type
STRING	String parameter type
NUMBER	Number parameter type
BOOLEAN	Boolean parameter type
COPY	Copy parameter type
HIDDEN	Hidden parameter type
DATE	Date parameter type

PluginStatusLink to PluginStatus section

Name	Description
VALID	Plugin is valid
INVALID	Plugin is invalid

PriceAdjustmentActionLink to PriceAdjustmentAction section

Controls how the price adjustment is applied

Name	Description
NO_CHANGE	No price adjustment will be applied
PERCENTAGE	Price will be adjusted by a percentage
CATALOG	Price will be adjusted based on catalog prices

PriceAdjustmentTimingLink to PriceAdjustmentTiming section

Controls when the price adjustment takes effect

Name	Description
AT_RENEWAL	Price adjustment will be applied at the renewal date
JANUARY	Price adjustment will be applied on January
FEBRUARY	Price adjustment will be applied on February
MARCH	Price adjustment will be applied on March
APRIL	Price adjustment will be applied on April
MAY	Price adjustment will be applied on May
JUNE	Price adjustment will be applied on June
JULY	Price adjustment will be applied on July
AUGUST	Price adjustment will be applied on August
SEPTEMBER	Price adjustment will be applied on September
OCTOBER	Price adjustment will be applied on October
NOVEMBER	Price adjustment will be applied on November
DECEMBER	Price adjustment will be applied on December

PricingModelLink to PricingModel section

Name	Description
FLAT	Flat pricing
TIERED	Tiered pricing
VOLUME	Volume pricing
BANDS	Bands pricing

ProductKindLink to ProductKind section

How a product is sold

Name	Description
SUBSCRIPTION	Sold through plans, with recurring or usage-based charges
ONE_TIME	Sold as one-time charges, outside any plan

QuoteChangeKindLink to QuoteChangeKind section

Name	Description
SUBSCRIBE	Subscribe quote
UPDATE	Update quote
RENEW	Renew quote
REINSTATE	Reinstate quote
UNSUBSCRIBE	Unsubscribe quote
ADJUSTMENT	Adjustment quote
COUPON	Coupon quote
DISCOUNT	Discount quote
PERCENTAGE_DISCOUNT	Percentage_discount quote
CREDIT	Credit quote
PRICE_UPDATE	Price_update quote
QUANTITY_UPDATE	Quantity_update quote
FREE_PERIOD_DISCOUNT	Free_period_discount quote
ACTIVATE	Activate quote
ONE_TIME	One_time quote
USAGE_CREDIT	Usage paid from a usage credit grant (invoice lines only)

QuoteStateLink to QuoteState section

Name	Description
DRAFT	Draft quote
SHARED	Shared quote
VIEWED	Viewed quote
ACCEPTED	Accepted quote
IN_APPROVAL	In_approval quote
APPROVED	Approved quote
REJECTED	Rejected quote
APPLIED	Applied quote
UNDONE	Undone quote

SsoModeLink to SsoMode section

Name	Description
prompt	prompt
auto	auto

SubscriptionStateLink to SubscriptionState section

Name	Description
ACTIVE	Active subscription
TRIAL	Trial subscription
CANCELED	Cancelled subscription
EXPIRED	Expired subscription
TRIAL_EXPIRED	Expired trial subscription
PENDING	Pending subscription

TaxTypeLink to TaxType section

Name	Description
GENERIC	General tax number
EIN	EIN number
GST	GST number
VAT	VAT number

TransactionKindLink to TransactionKind section

Name	Description
INVOICE	Invoice transaction
PAYMENT	Payment transaction
CREDIT_NOTE	Credit_note transaction

TrialExpirationActionLink to TrialExpirationAction section

Name	Description
CANCEL	Cancel subscription after trial expires
ACTIVATE	Activate subscription after trial expires

UnitPricingLink to UnitPricing section

How a product charge is priced on a line, read from whether it has a unit label

Name	Description
FLAT	Billed once per line
PER_UNIT	Priced per unit, e.g. per day, with an editable quantity

UsageCalculationLink to UsageCalculation section

Name	Description
SUM	The billing process will take the sum of quantity across all records in the billing period.
MAX	The billing process will take the maximum quantity across all records in the billing period.
LAST	The billing process will take the quantity of the last usage entry for the billing period.
AVERAGE	The billing process will take the average quantity across all records in the billing period.

UsageModeLink to UsageMode section

How a usage charge bills its usage

Name	Description
POSTPAID	Usage is aggregated and billed in arrears; credits are never touched
CREDITS	Each usage record draws unit credits, then the dollar balance, as it arrives; the rest bills as overage

WarrenRecordTypeLink to WarrenRecordType section

A record belonging to the warren

Name	Description
APPROVER
API_CLIENT
APPROVAL_RULE
COUPON
COMPANY
ENTITY
PLAN
PLUGIN
PRICE_LIST
PRICE_LIST_CHARGE
PRODUCT
USER
WORKFLOW

WorkflowJobLogStatusLink to WorkflowJobLogStatus section

Name	Description
SKIPPED	Skipped
INITIALIZING	Initializing
RUNNING	Running
COMPLETED	Completed