--- title: "List prepaid balance transactions" method: GET path: "/object-query/prepaid-balance-transactions" tags: ["Object Queries"] --- # List prepaid balance transactions `GET /object-query/prepaid-balance-transactions` Lists prepaid balance transactions. You can use the query parameters to filter, expand, and sort the returned results. ## Query parameters - `pageSize` integer - `cursor` string - `sort[]` string[] - `expand[]` string[] - `filter[]` string[] - `fields[]` string[] - `includeNullFields` boolean ## Headers - `Idempotency-Key` string - `Accept-Encoding` string - `Content-Encoding` string - `Zuora-Track-Id` string - `Zuora-Entity-Ids` string - `Zuora-Org-Ids` string - `Zuora-Version` string ## Response `200` OK - object - `nextPage` string, nullable — A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent. - `data` ExpandedPrepaidBalanceTransaction[] - `id` string — The unique identifier of the prepaid balance transaction. - `createdById` string — The unique identifier of the user who created the prepaid balance transaction. - `createdDate` string, date-time — The date and time when the prepaid balance transaction was created. - `updatedById` string — The unique identifier of the user who last updated the prepaid balance transaction. - `updatedDate` string, date-time — The date and time when the prepaid balance transaction was last updated. - `accountId` string — The ID of the customer account on which the prepaid balance transaction occurs. - `prepaidBalanceId` string — The ID of the prepaid balance. - `fundId` string — The ID of the prepaid balance fund. - `amount` number — The amount of units to be adjusted to the prepaid balance (could be positive or negative). - `balance` number — The prepaid balance after a transaction. - `sourceId` string — The transaction source id (original Charge Id, Guided Usage Id, Order Line Item Id). - `transactionDate` string, date — The date when the prepaid balance transaction occurs. - `transactionSourceType` 'CHARGE' | 'ORDER_LINE_ITEM' | 'USAGE' — The type of the transaction source. - `prepaidBalanceTransactionType` 'PREPAYMENT' | 'DRAWDOWN' | 'PREPAYMENT_ADJUSTMENT' | 'DRAWDOWN_ADJUSTMENT' | 'DRAWDOWN_REVERSAL' | 'PREPAYMENT_CREDIT_BACK' | 'PREPAYMENT_CREDIT_BACK_REVERSAL' — The type of the Prepaid Balance Transaction. - `usageUom` string - `drawdownRate` number, nullable — **Note**: This field is only available if you have the [Prepaid with Drawdown](https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview) feature enabled. The [conversion rate](https://docs.zuora.com?resourceId=billing-create-drawdown-charge) between Usage UOM and Drawdown UOM for a [drawdown charge](https://docs.zuora.com?resourceId=billing-create-drawdown-charge). Must be a positive number (>0). - `account` NestedAccountOnExpand - `id` string — The unique identifier of the account. - `createdById` string — The unique identifier of the user who created the account. - `createdDate` string, date-time — The date and time when the account was created. - `updatedById` string — The unique identifier of the user who last updated the account. - `updatedDate` string, date-time — The date and time when the account was last updated. - `accountNumber` string — The account number that identifies the account. - `additionalEmailAddresses` string — An additional email address to receive email notifications. - `allowInvoiceEdit` boolean — Indicates whether associated invoices can be edited. - `autoPay` boolean — Indicates whether future payments are automatically collected when they are due during a payment run. - `balance` number, double — The customer's total invoice balance minus credit balance. - `batch` string — The alias name given to a batch. A string of 50 characters or less. - `bcdSettingOption` 'ManualSet' | 'AutoSet' — The billing cycle day setting option for the account. - `billCycleDay` integer — Billing cycle day (BCD), the day of the month when a bill run generates invoices for the account. - `billToId` string — The unique identifier of the bill-to contact associated with the account. - `communicationProfileId` string — The unique identifier of the communication profile that Zuora uses when sending notifications to the account's contacts. - `creditBalance` number, double — The current credit balance on the account. - `crmId` string — External identifier of the account in a CRM system. - `currency` string — A currency defined in the web-based UI administrative settings. - `customerServiceRepName` string — Name of the account's customer service representative, if applicable. - `defaultPaymentMethodId` string — ID of the default payment method for the account. - `eInvoiceProfileId` string — ID of the e-invoice profile for this account. **Note**: This field is available only if you have the E-Invoicing feature in **Early Adopter** phase enabled. - `invoiceDeliveryPrefsEmail` boolean — Indicates whether the customer wants to receive invoices through email. - `invoiceDeliveryPrefsPrint` boolean — Whether the customer wants to receive printed invoices, such as through postal mail. - `invoiceTemplateId` string — Invoice template ID, configured in Billing Settings in the Zuora UI. - `lastInvoiceDate` string, date — Date of the most recent invoice for the account; null if no invoice has ever been generated. - `lastMetricsUpdate` string, date-time — The date and time when account metrics are last updated, if the account is a partner account. **Note**: - This field is available only if you have the Reseller Account feature enabled. - If you ever set the `partnerAccount` field to `true` for an account, the value of `lastMetricsUpdate` field is the time when the account metrics are last updated. - `name` string — The name of the account. - `notes` string — A string of up to 65,535 characters. - `organizationId` string — The unique identifier of the organization to which the account belongs. - `parentId` string — Identifier of the parent customer account for this Account object. The length is 32 characters. Use this field if you have Customer Hierarchy enabled. - `partnerAccount` boolean — Whether the customer account is a partner, distributor, or reseller. **Note**: This field is available only if you have the Reseller Account feature enabled. - `paymentMethodCascadingConsent` boolean — `true` indicates the consent from your customer to use the Cascading Payment Method feature was collected. `false` indicates the consent was not collected and the Cascading Payment Method feature is not enabled. - `purchaseOrderNumber` string — The purchase order number provided by your customer for services, products, or both purchased. - `salesRepName` string — Name of the account's sales representative, if applicable. - `sequenceSetId` string, nullable — The ID of the billing document sequence set to assign to the customer account. The billing documents to generate for this account will adopt the prefix and starting document number configured in the sequence set. If a customer account has no assigned billing document sequence set, billing documents generated for this account adopt the prefix and starting document number from the default sequence set. - `shipToId` string — The unique identifier of the ship-to contact associated with the account. - `soldToId` string — The unique identifier of the sold-to contact associated with the account. - `status` 'Active' | 'Draft' | 'Canceled' — The account status. - `taxCompanyCode` string — Unique code that identifies a company account in Avalara. **Note:** This feature is in Limited Availability. If you wish to have access to the feature, submit a request at [Zuora Global Support](https://support.zuora.com). - `taxExemptCertificateID` string — ID of the customer tax exemption certificate. Applicable if you use Zuora Tax or Connect tax engines. - `taxExemptCertificateType` string — Type of tax exemption certificate that the customer holds. Applicable if you use Zuora Tax or Connect tax engines. - `taxExemptDescription` string — Description of the tax exemption certificate that the customer holds. Applicable if you use Zuora Tax or Connect tax engines. - `taxExemptEffectiveDate` string, date — Date when the customer tax exemption starts, in `YYYY-MM-DD` format. Applicable if you use Zuora Tax or Connect tax engines. - `taxExemptEntityUseCode` string — A unique entity use code to apply exemptions in Avalara AvaTax. See Exempt Transactions for more details. - `taxExemptExpirationDate` string, date — Date when the customer tax exemption expires, in `YYYY-MM-DD` format. Applicable if you use Zuora Tax or Connect tax engines. - `taxExemptIssuingJurisdiction` string — Jurisdiction in which the customer tax exemption certificate was issued. - `taxExemptStatus` 'No' | 'Yes' | 'PendingVerification' — Status of the account tax exemption. Applicable if you use Zuora Tax or Connect tax engines. Required if you use Zuora Tax. - `totalInvoiceBalance` number, double — Total balance of all posted invoices. - `unappliedBalance` number — Total unapplied balance in this currency. - `vATId` string — EU Value Added Tax ID. - `mrr` number — Monthly recurring revenue for the account. - `totalDebitMemoBalance` number, double — Total balance of all posted debit memos. - `unappliedCreditMemoAmount` number, double — The total unapplied amount of all posted credit memos in this currency. - `creditMemoTemplateId` string — ID of the credit memo template that is used to generate credit memos for the account. - `debitMemoTemplateId` string — ID of the debit memo template that is used to generate debit memos for the account. - `paymentGateway` string — The name of the payment gateway instance. If null or left unassigned, the account will use the default gateway. - `paymentTerm` string — A payment-terms indicator defined in the web-based UI administrative settings, for example, `Net 30`. - `billTo` object — The bill-to contact on this account. - `shipTo` object — The ship-to contact on the account. - `soldTo` object — The sold-to contact on the account. - `defaultPaymentMethod` object — The default payment method associated with the account. - `subscriptions` object[] — The subscriptions associated with the account. - `payments` object[] — The payments associated with the account. - `refunds` object[] — The refunds associated with the account. - `creditMemos` object[] — The credit memos associated with the account. - `debitMemos` object[] — The debit memos associated with the account. - `invoices` object[] — The invoices associated with the account. - `usages` object[] — The usage records associated with the account. - `paymentMethods` object[] — The payment methods associated with the account. - `prepaidBalance` NestedPrepaidBalanceOnExpand - `id` string — The unique identifier of the prepaid balance. - `createdById` string — The unique identifier of the user who created the payment application. - `createdDate` string, date-time — The date and time when the payment application was created. - `updatedById` string — The unique identifier of the user who last updated the payment application. - `updatedDate` string, date-time — The date and time when the payment application was last updated. - `name` string — The name of the prepaid balance. - `totalFund` number — The total amount of all prepaid balance funds. - `balance` number — The current prepaid balance. - `endDate` string, date — End date of the validity period. - `startDate` string, date — Start date of the validity period. - `accountId` string — The ID of the customer account to which the prepaid balance belongs. - `origSubscriptionId` string — If it belongs to a subscription, the original subscription ID. - `uOM` string — The units of measure for prepayment charge. Units of measure are configured in the web-based UI. Your values depend on your configuration in **Billing Settings**. **Values**: a valid unit of measure - `prepaidBalanceState` 'ACTIVE' | 'EXPIRED' — The state of the prepaid balance. - `prepaidType` integer, nullable — The type of the prepaid balance. - `account` object — The account associated with the prepaid balance. - `origSubscription` object — The subscription associated with the prepaid balance. - `fund` NestedPrepaidBalanceFundOnExpand - `id` string — The unique identifier of the prepaid balance fund. - `createdById` string — The unique identifier of the user who created the prepaid balance fund. - `createdDate` string, date-time — The date and time when the prepaid balance fund was created. - `updatedById` string — The unique identifier of the user who last updated the prepaid balance fund. - `updatedDate` string, date-time — The date and time when the prepaid balance fund was last updated. - `accountId` string — The ID of the customer account to which the prepaid balance fund belongs. - `balance` number — The remaining balance (remaining units) on the fund. - `chargeSegmentNumber` integer — The number of the charge segment. One prepaid balance fund can only belong to one charge segment. - `endDate` string, date — End date of the fund effective period. - `fundedBalance` number — The total units of the fund. - `fundSourceType` 'CHARGE' | 'ORDER_LINE_ITEM' | 'CREDIT_MEMO_ITEM' | 'DEBIT_MEMO_ITEM' — The type of the Prepaid Balance Fund. - `fundingPrice` number — The price amount of a fund. A rounded value that follows the associated invoice owner's currency rounding rule. **Calculation**: (Number of billing periods in one fund validity period) * (price in one billing period) - `totalBilled` number - `totalBalance` number - `originalTotalBalance` number - `originalFundingPrice` number - `originalFundEndDate` string, date - `rolloverValidityPeriodStartDate` string, date - `rolloverValidityPeriodEndDate` string, date - `prepaidBalanceId` string — The ID of the prepaid balance associated to which this prepaid balance fund belongs. - `priority` 10 | 50 | 100 — The priority of the Fund. Possible values include: 10(high), 50(medium),100(low) - `sourceId` string — The source Id of the fund. It is the original charge ID. - `startDate` string, date — Start date of the fund effective period. - `vpSummaryId` string - `rolloverCount` integer - `originFundId` string - `rolloverApplyOption` string - `done` integer - `account` object — The account associated with the prepaid balance fund. - `prepaidBalance` object — The prepaid balance that contains the prepaid balance fund. - `source` object — The rate plan charge associated with the prepaid balance fund. - `vpSummary` object — The validity period summary associated with the prepaid balance fund. ## Other responses - `500` — Internal server error - `4XX` — Invalid input --- [API](https://skmtc.dev/zuora/apis/api-reference.md) · [All operations](https://skmtc.dev/zuora/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/zuora/api-reference/revisions/d11e237f3e54/schema)