Allegro GraphQL Interface

Custom Scalars

Enums

Query: searchTransactionUnits

Use searchTransactionUnits to search rated charges with filtering and sorting. This query supports usage, recurring, one-time, adjustment, and credit transaction types.

query {
  searchTransactionUnits(
    page: 1
    size: 20
    transactionUnitFilter: {
      clientId: 7000215
      accountId: 100001
      type: USAGE
      startDate: "2025-03-01"
      endDate: "2025-03-31"
    }
    transactionUnitSort: { createdDate: "DESC" }
  ) {
    id
    type
    source
    accountId
    billUnitId
    serviceType
    netAmount
    grossAmount
    aggregationStatus
    startDate
    endDate
    createdDate
    balances {
      balanceType
      offerType
      offerId
      currency
      amount
      quantity
      unitPrice
    }
    txnUsageData {
      usageType
      usageId
      fileName
      quantity
      rateUnit
      direction
      apartyNumber
      bpartyNumber
    }
    allowances {
      allowanceId
      allowanceType
      amount
      validStart
      validEnd
    }
    accumulators {
      accumulatorId
      amount
    }
    recurringData {
      type
      cycleUnit
      cycleStart
      cycleEnd
      scale
    }
  }
}

Query: getTransactionUnitById

Use getTransactionUnitById to retrieve a single transaction unit by its unique identifier. This query requires id: BigInteger! and clientId: BigInteger!. It returns the same TransactionUnit type as searchTransactionUnits.

Query: getTransactionSummary

Use getTransactionSummary to retrieve summarized transaction totals for an account, grouped by service type and transaction type.

Input: GetTransactionSummaryInput

The response returns a TransactionSummary containing clientId, accountId, billUnitId, and a summaryData list. Each TransactionSummaryData entry includes serviceType, transactionType, netAmount, grossAmount, count, startDate, and endDate.

Queries: Transaction Aggregation

The following four queries support transaction aggregation reporting. All require clientId: BigInteger!.

Queries: Balance Unit

The following four queries support balance unit retrieval. All require clientId: BigInteger!.

Mutation: createTransactionUnit

Use createTransactionUnit to create a new rated charge against an account.

The mutation returns the created TransactionUnit. See searchTransactionUnits for all response fields.

Query: searchPriceOffer

Use searchPriceOffer to search price offers with full nested pricing structures including flat, tiered, recurring, attribute-based, and composite models.

PriceOfferFilter fields

Key response fields (PriceOffer)

The shared Price sub-type appears within any pricing model and contains index, currencyId, amount, flatRate, startDate, endDate, and futureRate. The Tiers sub-type contains index, minimum, maximum, prices, allowances, and accumulators.

Query: searchDiscountOffer

Use searchDiscountOffer to search discount offers with nested discounting structures including flat, tiered, attribute-based, and composite models.

DiscountOfferFilter fields

Key response fields include id, name, status, discountingModel, scope, durationUnit, duration, applicableAmount, and the nested discounting structures flatDiscounting, tierDiscounting, complexDiscounting, and usageAttributeDiscounting.

Query: getBillableServiceConfig

Use getBillableServiceConfig to retrieve billable service configurations including service types, accounting codes, and tax codes.

BillableServiceFilter fields

The response returns a BillableService with id, name, description, transactionType, serviceType, usageTypeNo, taxCode, status, creditGlAccount, and debitGlAccount.

Queries: Pricing Configuration

The following queries retrieve pricing configuration data. All require clientId: BigInteger! and return their respective configuration objects.

Mutations: Price Offers

Use createPriceOffer to create a new price offer, or modifyPriceOffer to update an existing one.

createPriceOffer key input fields

modifyPriceOffer requires id, priceOfferId, clientId, and effectiveDate. Only the fields you provide are updated.

Mutations: Discount Offers

Use createDiscountOffer to create a discount offer, or modifyDiscountOffer to update one. Key input fields for createDiscountOffer include clientId (required), name (required), discountingModel, scope, durationUnit, duration, flatDiscounting, and tierDiscounting.

Mutations: Pricing Configuration

Each configuration area has a paired create and modify mutation: createCurrencyConfig / modifyCurrencyConfig, createAccumulatorConfig / modifyAccumulatorConfig, createAllowanceConfig / modifyAllowanceConfig, createRateUnit / modifyRateUnit, createZoneUnit / modifyZoneUnit, and createMultiRating / modifyMultiRating. Each create mutation accepts the full configuration object. Each modify mutation requires the configuration id and clientId, and updates only the fields you provide.

Query: searchAccounts

Use searchAccounts to search customer accounts with filtering and sorting. The response includes contacts and addresses.

AccountFilter fields

The Account response includes id, uuid, status, currency, accountCategory, type, organization, customerId, hasChildAccounts, contacts, and addresses.

Queries: Subscriptions

The following queries retrieve subscription data. Key response fields on the Subscription type include id, name, status, category, startDate, endDate, initialTerm, renewalTerm, payingResponsibility, and balanceUnitId.

Queries: Price Units and Discount Units

Key PriceUnit response fields include id, priceOfferId, subscriptionId, serviceUnitId, status, planName, pricingModel, priceOverride, and commitmentTerm.

Queries: Service Units, Contracts, and Billing

Mutations: Accounts

Use createAccount to create a customer account. Required input fields are clientId, status, userId, and currency. Optional fields include accountCategory, type, contacts, and addresses. Use modifyAccount with id and clientId to update any fields on an existing account.

Mutations: Price Units, Discount Units, and Contracts

Query: getTxnAggregationConfig

Use getTxnAggregationConfig to retrieve the transaction aggregation configuration, including attribute definitions. Requires clientId: BigInteger!. Returns a TxnAggregation with a list of TxnAggregationAttributes defining which fields participate in aggregation grouping (attributeName, category, aggregate, coreAttribute, editable).

Queries: Object Synchronization

The ObjectSyncActivity response type includes id, accountId, eventId, eventTime, actionName, objectName, status (PENDING, ERROR, COMPLETE, IGNORED, INCOMPLETE), errorCode, and errorMessage.

Mutations: Gateway Configuration

Use createTxnAggregationConfig or modifyTxnAggregationConfig to manage aggregation configuration. Both accept a TxnAggregationInput or ModifyTxnAggregationInput containing clientId and a list of attribute definitions.

Use processSyncError to retry failed synchronization events. This mutation accepts a SyncErrorObjectInput with clientId, objectName, actionName, and status filters, and re-publishes matching failed events for retry. It returns a confirmation string.

Queries: CDR File Statistics

Use searchCdrStats or getCdrStatsByFileName to retrieve CDR file processing statistics with a per-stage breakdown.

CdrFileProcessingStatsFilter fields

The CdrFileProcessingStats response includes fileName, fileDate, sourcePlatform, startTime, endTime, elapsedTime, and stageStats. Each stageStats entry contains pendingCount, processedCount, errorCount, and suspendedCount per processing stage.

Queries: Usage Records

Queries: Error and Suspension Reporting

Queries: Common Hub

Mutations: Common Hub

Queries: Operations Hub

Mutations: Operations Hub

Queries: Usage Process Hub

The DetailRecord response type includes the following key fields:

Mutations: Usage Process Hub

Each configuration area has a paired create and modify mutation: createUsageProcessStreamMap / modifyUsageProcessStreamMap, createUsageSourcePlatform / modifyUsageSourcePlatform, createUsageFileMap / modifyUsageFileMap, and createCustomUsageRecord / modifyCustomUsageRecord. Each create mutation accepts the full configuration object. Each modify mutation requires the configuration id and clientId, and updates only the fields you provide.

Use discardUsageRecord to mark one or more usage records as discarded. This mutation requires clientId and a list of usage record identifiers.