Query Keys

The following table shows the query keys for each entity for a simple DataQuery.

Query Keys for Entities
Entity	Key Required?	Keys	Datatype	Keys	Datatype
Actions (for Entity info, see ProductSaleAction or ServiceAction)	Y	eid productEid	Long Long	- -	- -
AdditionalFeeInvoiceItem	Y	eid invoiceEid	Long Long	invoiceNum serviceEid	String Long
Adjustment	Y	eid billingAccountEid accountNum status creditNumber	Long Long String - - String	invoiceEid invoiceNum occurredOn unappliedAmount credit	Long String DateTime BigDec Boolean
AdjustmentApplication	Y	eid adjustmentEid billingAccountEid accountNum	Long Long Long String	occurredOn unappliedAmount type	DateTime BigDec AdjustmentApplicationType
AdjustmentCategory		eid name status	Long String PriceCategoryStatus	- -	- -
AdjustmentInvoiceItem	Y	eid invoiceEid invoiceNum	Long Long String	- -	- -
AdjustmentReason		eid name level	Long String AdjustmentReasonLevel	status creditOnly	AdjustmentReasonStatus Boolean
Agreement		eid name productEid status	Long String Long - -	terminationFeeCurrencyType maxTerminationFeeCurrencyType fromDate thruDate	String String DateTime DateTime
AgreementService	Y	eid serviceEid serviceResourceIdentifier childServiceResourceIdentifier	Long Long String String	productEid accountNum serviceStatus	Long String String
ApprovalOperation (in this table, see Operations)
BillCycle		eid name type	Long String BillCycleType	status currencyType	AccountingStatus String
BillCycleRun	Y	eid billCycleEid billCycleName sequence globalStatus	Long Long String Integer BillCycleRunGlobalStatus	status step openDate closeDate	BillCycleRunStatus BillCycleStepRun DateTime DateTime
BillingAccount		eid accountNum externalAccountNum partyEid status emailAddress billingAccountCategoryEid purchaseOrderNumber orderNum orderEid blllType referral customFieldValueEid	Long String String Long - - String Long String String Long BillType String Long	billingAccountSegmentEid currencyType productEid serviceEid parentEid billCycleEid customFieldValue customFieldEid serviceCustomFieldValue serviceCustomFieldEid orderCustomFieldValue orderCustomFieldEid usagePoolEid	Long - - Long Long Long Long String Long String Long String Long Long
BillingAccountCategory		eid desc status	Long String BilingAccountCategoryStatus	- -	- -
BillingAccountRecurringPayment	Y	eid accountNum billingAccountEid	Long String Long	token validTo	String DateTime
BillingAccountSegment		eid name status	Long String BillingAccountSegmentStatus	- -	- -
BillingAccountSegmentField	Y	eid billingAccountSegmentEid billingAccountSegmentName	Long Long String	type required	BillingAccountSegmentFieldType Boolean
changeOrder	Y	eid billingAccountEid externalAccountNum purchaseOrderNumber customFieldValueEid	Long Long String String Long	status orderNum accountNum orderDate referral	OrderStatus String String dateTime String
Counter UsageChargeCounter UsageEventCounter UsageRuleCounter You must use eid or serviceEid and entityRelationType when querying this entity	Y	eid* name serviceEid* entityRelationType*	Long String Long CounterEntityRelationType	type status fromDate thruDate	CounterType CounterStatus DateTime DateTime
Currency		currencyType	CurrencyType	- -	- -
CustomField		eid name type	Long String CustomFieldType	enabled searchable	Boolean Boolean
CustomFieldValue Value must be paired with an eid or num identifier	Y	eid billingAccountEid accountNum externalAccountNum value serviceEid	Long Long String String String Long	customFieldEid customFieldName orderEid orderNum orderItemEid	String Long Long String Long
deactivationReason
Discount		eid name status type discountIdentifier	Long String DiscountStatus DiscountType String	discountCategoryEid oneTime recurring currencyType discountIdentifierEid	Long Boolean Boolean String Long
DiscountCategory		eid name status	Long String DiscountCategoryStatus	- -	- -
DiscountChargeCategory		eid name status	Long String DiscountChargeCategoryStatus	- -	- -
DiscountCode		eid name status discountChargeCategoryEid validFrom validTo	Long String DiscountCodeStatus Long DateTime DateTime	discountEid discountIdentifier priceListEid priceListIsMaster currencyType productEid discountIdentifierEid	Long String Long Boolean String Long Long
DiscountCodeService	Y	eid serviceEid discountIdentifier discountIdentifierEid discountCodeEid type	Long String Long Long Long DiscountType	billingAccountEid accountNum validFrom validTo productEid	Long String DateTime DateTime Long
DiscountIdentifier		eid identifier orderItemEid	Long String Long	- -
EmailOperation (in this table, see Operations)
General Ledger		eid name status	Long String AccountingStatus	- -	- -
GLAccount	Y	eid accountNum	Long String	name generalLedgerEid	String Long
GLAccountCategory		eid name status	Long String AccountingStatus	- -	- -
GLAccountingEntry		eid glAccountEid glAccountingTransactionEid	Long Long Long	glTransactionBatchNum glAggregateEid glAggregateBatchNum	String Long String
GLAccountingTransaction	Y	eid batchNum glTransactionBatchEid	Long String Long	batchPostedOn urredOn currencyType originalCurrencyType	Date Date Currency Currency
GLAdjustmentAccountingTransaction	Y	eid batchNum glTransactionBatchEid	Long String Long	batchPostedOn occurredOn currencyType originalCurrencyType	Date Date Currency Currency
GLInvoiceAccountingTransaction	Y	eid batchNum glTransactionBatchEid	Long String Long	batchPostedOn occurredOn currencyType originalCurrencyType	Date Date Currency Currency
GLAggregateBatch	Y	eid postedOn batchNum	Long Date String	status exported	GLExtractBatchStatus Boolean
GLAggregateEntry	Y	eid glAggregateBatchEid batchNum	Long Long String	glAccountEid batchPostedOn	Long Date
GlobalUsageRule		eid isGlobal status	Long Boolean GlobalUsageRuleStatus	- -	- -
GLPaymentAccountingTransaction	Y	eid batchNum glTransactionBatchEid	Long String Long	batchPostedOn occurredOn currencyType originalCurrencyType	DateTime DateTime Currency Currency
GLTransactionBatch	Y	eid batchNum postedOn	Long String Date	exported status	Boolean GLExtractBatchStatus
httpRequestOperation (in this table, see Operations)
Invoice	Y	eid invoiceNum billingAccountEid accountNum billCycleRunEid	Long String Long String Long	adjustmentEid occurredOn status eventEid discountCodeServiceEid	Long DateTime - - Long Long
InvoiceAdjustmentApplication StandardInvoiceAdjustmentApplication ReversedInvoiceAdjustmentApplication NegativeInvoiceAdjustmentApplication WriteOffAdjustmentApplication (in this table, see AdjustmentApplications)	Y	eid adjustmentEid billingaccountEid accountNum type	Long Long Long String AdjustmentApplicationType	invoiceEid invoiceNum occuredOn unappliedAmount creditNumber	Long String DateTime BigDec String
InvoiceItem AdditionalFeeInvoiceItem AdjustmentInvoiceItem ProductInvoiceItem ServiceInvoiceItem TaxInvoiceItem UsageInvoiceItem	Y	eid invoiceEid type	Long Long InvoiceItemType	invoicenum serviceEid	String Long
invoiceItemCharge	Y	eid invoiceItemEid	Long Long	invoiceEid invoiceNum type	Long String InvoiceItemChargeType
NegativeInvoiceAdjustmentApplication (in this table, seeInvoiceAdjustmentApplications andAdjustmentApplications)	Y	eid adjustmentEid billingAccountEid accountNum	Long Long Long String	invoiceEid invoiceNum occurredOn unappliedAmount	Long String DateTime BigDec
OneTimeProductPrice	Y	eid productEid fromDate thruDate	Long Long dateTime dateTime	priceListEid priceListIsMaster currencyType chargeDuringRenewal	Long Boolean Currency Boolean
Operation ApprovalOperation httpRequestOperation EmailOperation	Y	eid actionEid	Long Long	- -	- -
OperationAttribute ProductSaleOperationAttribute	Y	eid productOrderItemEid	Long Long	- -	- -
OperationRun		eid operationEid startDate endDate billingAccountEid accountNum	Long Long DateTime DateTime Long String	actionType actionName type operationType status	ActionType String OperationRunType OperationType OperationStatus
SalesOrder, RenewalOrder, and ChangeOrder	Y	eid orderNum billingAccountEid accountNum externalAccountNum customFieldValue	Long Long String String String String	status orderDate referral purchaseOrderNumber customFieldValueEid customFieldEid	OrderStatus Date String String Long Long
OrderItem	Y	eid parentOrderItemEid orderEid serviceEid	Long Long Long Long	orderNum serviceIdentifier discountIdentifier productEid	String String String Long
orderItemCharge	Y	eid orderEid orderItemEid billingAccountEid	Long Long Long Long	accountNum notToInvoice invoiced	String Boolean Boolean
OrderItemUsageRule	Y	eid orderItemEid status	Long Long OrderItemUsageStatus	- -	- -
organization		eid name	Long String	- -	- -
PartyCategory		eid name	Long String	description status	String ContactCategoryStatus
Payment	Y	eid accountNum billingAccountEid occurredOn unappliedAmount	Long String Long dateTime BigDec	reference status authorization token	String PaymentStatus String String
PaymentApplication	Y	eid paymentEid invoiceEid invoiceNum billingAccountEid	Long Long Long String Long	accountNum occurredOn updatedOn unappliedAmount type	String DateTime DateTime BigDec PaymentApplicationType
PaymentTerm		eid name	Long String	billingAccountEid billingAccountCategoryEid	Long Long
Person		eid billingAccountEid	Long Long	firstName lastName	String String
PriceList		eid name	Long String	- -	- -
Product		eid name internalName externalProductNumber sku productTypeCode productState serviceResourceCategoryEi discountCodeEid	Long String String String String ProductTypeCode String Long Long	serviceResourceCategoryName productCategoryEid productCategoryName priceListEid priceListIsMaster currencyType productTagEid discountIdentifier	String String Long Long Boolean String Long String
ProductCategory		eid name status	Long String PoductCategoryStatus	- -	- -
ProductInvoiceItem	Y	eid invoiceEid invoiceNum	Long Long String	- -	- -
ProductPrice	Y	eid productEid fromDate thruDate	Long Long Date Date	priceListEid priceListIsMaster currencyType	Long Boolean String
PriceRange	Y	eid productPriceEid productEid	Long Long Long	priceListEid priceListIsMaster currencyType	Long Boolean String
ProductRelation	Y	eid productEid type	Long Long ProductRelationType	--	--
ProductSaleAction (in this table, see Actions)
ProductSaleOperationAttribute (in this table, see OperationAttributes)
ProductTag		eid name productEid	Long String Long	- -	- -
ProductUsageRule	Y	eid productEid	Long Long	productPriceEid status	Long ProductUsageRuleStatus
Promotion		eid productEid name	Long Long String	type status	PromotionType PromotionStatus
rateTable		eid name	Long String	- -	- -
Reason		eid name type	Long String ReasonType	- -	- -
recurringProductPrice	Y	eid productEid fromDate thruDate priceListEid priceListIsMaster currencyType	Long Long Date Date Long Boolean String	recurrencePeriod recurrenceAmount recurringPaymentRequired billInAdvance proratedOnCancel proratedOnOrder proratedOnOrderNoCharge	- - BigDec Boolean Boolean Boolean Boolean Boolean
refund	Y	eid paymentEid accountNum billingAccountEid	Long Long String Long	occurredOn reference status authorization	Date String - - String
refundReason (in this table, see Reasons)
RenewalOrder (in this table, also see Orders)	Y	eid orderNum billingAccountEid accountNum externalAccountNum	Long String Long String String	orderDate customFieldValueEid referral purchaseOrderNumber renewalDate	Date Long String String Date
ReversedInvoiceAdjustmentApplication (in this table, also see InvoiceAdjustmentApplications and AdjustmentApplications)	Y	eid adjustmentEid billingAccountEid accountNum	Long Long Long String	invoiceEid invoiceNum occurredOn unappliedAmount	Long String DateTime BigDec
ReversedInvoicePaymentApplication	Y	eid paymentEid invoiceEid invoiceNum billingAccountEid	Long Long Long String Long	accountNum occurredOn updatedOn unappliedAmount	String DateTime DateTime BigDec
salesOrder (in this table, also see Orders)	Y	eid status orderNum billingAccountEid ccountNum	Long OrderStatus String Long String	externalAccountNum orderDate referral purchaseOrderNumber customFieldValueEid	String Date String String Long
ScheduledCharge	Y	eid servicePriceEid status	Long Long PriceChargeStatus	orderItemEid invoiced serviceEid	Long Boolean Long
ScheduledOneTimePriceCharge	Y	eid serviceEid status	Long Long PriceChargeStatus	orderItemEid invoiced	Long Boolean
Service	Y	eid accountNum billingAccountEid productEid agreementEid serviceResourceIdentifier parentEid externalAccountNum usagePoolEid originalOrderNum originalOrderEid	Long String Long Long Long String Long String Long String Long	renewalCount customFieldValue customFieldValueEid customFieldEid status startDate endDate invoiceItemEid previousServiceEid nextServiceEid originalOrderItemSequence	Integer String Long Long ServiceStatus Timestamp Timestamp Long Long Long Long
ServiceAction (in this table, see Actions)
serviceDeactivationReason (in this table, see Reasons)
serviceDeviceInventoryItem	Y	eid serialNumber	Long String	productEid status	Long InventoryItemStatus
ServiceInvoiceItem	Y	eid invoiceEid	Long Long	invoiceNum serviceEid	String Long
ServicePeriod	Y	eid serviceEid closed	Long Long Boolean	startDate endDate productPriceEid	Date Date Long
ServicePrice	Y	eid serviceEid recurrencePeriod	Long Long - -	startDate endDate	Date Date
ServicePriceRange	Y	eid servicePriceEid	Long Long	- -	- -
ServiceResource	Y	eid identifier orderItemEid serviceEid	Long String Long Long	serviceResourceCategoryEid status description	Long GenericServiceResourceStatus String
ServiceResourceCategory		eid name type	Long String ServiceResourceType	- -	- -
serviceSuspensionReason (in this table, see Reasons)
ServiceUsageRule	Y	eid serviceEid status	Long Long ServiceUsageRuleStatus	- -	- -
StandardInvoiceAdjustmentApplication (in this table, see InvoiceAdjustmentApplications and AdjustmentApplications)	Y	eid adjustmentEid billingAccountEid accountNum	Long Long Long String	invoiceEid invoiceNum occurredOn unappliedAmount	Long String TimeStamp BigDec
StandardInvoicePaymentApplication	Y	eid paymentEid invoiceEid invoiceNum billingAccountEid	Long Long Long String Long	accountNum occurredOn updatedOn unappliedAmount type	String TimeStamp TimeStamp BigDec PaymentApplicationType
suspensionReason (in this table, see Reasons")
SystemSetting		name	String	- -	- -
TaxInvoiceItem	Y	eid invoiceEid invoiceNum	Long Long String	- -	- -
UsageChargeCounter (in this table, see Counters)
UsageEvent Some of these Query Keys MUST be used in pairs. See UsageEvent for complete information.	Y	eid billingAccountEid accountNum servicePeriodEid serviceResourceIdentifier	Long Long String Long String	startTime endTime closed referenceId sequenceId	DateTime DateTime Boolean String String
UsageEventCounter (in this table, see Counters)
UsageInvoiceItem	Y	eid invoiceEid	Long Long	invoiceNum serviceEid	String Long
UsageLookupTable		eid name status	Long String UsageLookupTableStatus
UsageLookupTableEntry	Y	eid usageLookupTableEid	Long Long	key value	String String
UsagePool (serviceId and validFrom must be used in conjunction)	Y	eid name billingAccountEid	Long String Long	serviceEidd* validFrom*	Long DateTime
UsagePoolPeriod	Y	eid usagePoolEid poolSize used	LongLong BigDec BigDec	startDate endDate overage	DateTime DateTime BigDec
UsagePriceCategory		eid name	Long String	- -	- -
UsageRule	Y	eid servicePeriodEid	Long Long	- -	- -
UsageRuleCounter (in this table, see Counters)
WriteOffAdjustmentApplication (in this table, see InvoiceAdjustmentApplications and AdjustmentApplications)	Y	eid adjustmentEid billingAccountEid	Long Long Long	accountNum occurredOn unappliedAmount	String TimeStamp BigDec