--- title: "Retrieve a processed usage record" method: GET path: "/object-query/processed-usages/{key}" tags: ["Object Queries"] --- # Retrieve a processed usage record `GET /object-query/processed-usages/{key}` Retrieve the details of a specific Processed Usage Record object. ## Path parameters - `key` string, required ## 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 - ExpandedProcessedUsage - `id` string — The unique identifier of the processed usage. - `createdById` string — The unique identifier of the user who created the processed usage. - `createdDate` string, date-time — The date and time when the processed usage was created. - `updatedById` string — The unique identifier of the user who last updated the processed usage. - `updatedDate` string, date-time — The date and time when the processed usage was last updated. - `usageId` string — The unique identifier of the usage. - `amount` number — The amount of the processed usage. - `billingPeriodEndDate` string — The end date of the billing period for the processed usage. - `billingPeriodStartDate` string — The start date of the billing period for the processed usage. - `invoiceItemId` string — The unique identifier of the invoice item associated with the processed usage. - `creditMemoItemId` string — The unique identifier of the credit memo item associated with the processed usage. - `ratePlanChargeId` string — ID of the rate plan charge associated with the processed usage. - `usage` NestedUsageOnExpand - `id` string — The unique identifier of the usage. - `createdById` string — The unique identifier of the user who created the usage. - `createdDate` string, date-time — The date and time when the usage was created. - `updatedById` string — The unique identifier of the user who last updated the usage. - `updatedDate` string, date-time — The date and time when the usage was last updated. - `accountId` string — The ID of the customer account associated with the usage. - `accountNumber` string — The number of the customer account associated with the usage. - `ratePlanChargeId` string — ID of the rate plan charge that pays for this usage. - `endDateTime` string, date-time — End date of the time period in which usage is tracked. Zuora uses this field value to determine the usage date. - `productRatePlanChargeId` string — The product rate plan charge number that you use for a dynamic usage charge. - `quantity` number — Number of units used. - `rbeStatus` 'Importing' | 'Pending' | 'Processed' — Indicates if the rating and billing engine (RBE) processed usage data for an invoice. - `sourceType` 'API' | 'Import' — Indicates if the usage records were imported from the web-based UI or the API. - `startDateTime` string, date-time — Start date of the time period in which usage is tracked. Zuora uses this field value to determine the usage date. - `subscriptionId` string — The original ID of the subscription that contains the fees related to the usage data. - `submissionDateTime` string, date-time — The date and time when the usage was submitted. - `uOM` string — The units to measure usage. Units of measure are configured in the web-based UI. Your values depend on your configuration in **Billing Settings**. - `description` string — A description of the usage record. - `importId` string — The unique identifier of the import. - `uniqueKey` string — a customer-defined specific identifier of a usage record. **Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature or the Unbilled Usage feature enabled. See [Upload usage record with unique key](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Prepaid_balance_transactions#Upload_usage_record_with_unique_key) for more information. - `fileId` string — File ID of the uploaded usage records file. You can use this file ID with [Get files](https://developer.zuora.com/api-references/api/operation/GET_Files) to download the file. - `fileName` string — The name of the import file when the usage record is imported from the file. - `account` object — The account associated with the usage. - `invoiceItem` NestedInvoiceItemOnExpand - `id` string — The unique identifier of the invoice item. - `createdById` string — The unique identifier of the user who created the invoice item. - `createdDate` string, date-time — The date and time when the invoice item was created. - `updatedById` string — The unique identifier of the user who last updated the invoice item. - `updatedDate` string, date-time — The date and time when the invoice item was last updated. - `invoiceId` string — The unique identifier of the invoice to which this invoice item belongs. - `invoiceScheduleId` string — The ID of the invoice schedule associated with the rate plan charge on the subscription. **Note**: This field is available only if you have the Billing Schedule feature enabled. - `invoiceScheduleItemId` string — The ID of the invoice schedule item that generates this invoice item. **Note**: This field is available only if you have the Billing Schedule feature enabled. - `ratePlanChargeId` string — The ID of the rate plan charge associated with the invoice item. - `accountingCode` string — The accounting code associated with the invoice item. - `appliedToInvoiceItemId` string — The unique ID of the invoice item that the discount charge is applied to. - `chargeAmount` number, double — The amount of the charge. **Note**: This amount does not include taxes regardless if the charge's tax mode is inclusive or exclusive. This is the discount amount actually applied when the invoice item is a discount charge. - `chargeDate` string, date-time — The date when the invoice item is charged, in `yyyy-mm-dd hh:mm:ss` format. - `chargeName` string — The name of the charge. - `chargeNumber` string — Number of the charge. - `commitmentChargeNumber` string - `commitmentChargeSegmentNumber` string - `description` string — The description of the invoice item. - `discountAmount` number — The amount of the discount. - `excludeItemBillingFromRevenueAccounting` boolean — The flag to exclude the invoice item from revenue accounting. **Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. - `fulfillmentId` string — The reference ID of the fulfillment associated with the invoice item. - `itemShipToContactId` string — The ID of the ship-to contact associated with the invoice item. **Note**: If you have the Flexible Billing Attributes feature disabled, the value of this field is `null`. - `itemSoldToContactId` string — The ID of the sold-to contact associated with the invoice item. **Note**: If you have the Flexible Billing Attributes feature disabled, the value of this field is `null`. - `itemSoldToContactSnapshotId` string — The ID of the sold-to contact snapshot associated with the invoice item. **Note**: If you have the Flexible Billing Attributes feature disabled, the value of this field is `null`. - `processingType` '0' | '1' | '2' | '3' — The kind of the charge for the invoice item. - `0`: charge - `1`: discount - `2`: prepayment - `3`: tax - `quantity` number — The quantity of this item, in the configured unit of measure for the charge. - `reflectDiscountInNetAmount` boolean — When you apply percentage discounts to either of the following charges, you need to set the `reflectDiscountInNetAmount` field on your discount charge to `true`, to enable calculating and displaying the net amount of the following charges in Zuora Revenue. * delivery pricing charge * prepayment charge * drawdown charge Note the following: * If you are an Order to Revenue customer, when you set the `reflectDiscountInNetAmount` field to `true`, you must also set the `excludeItemBillingFromRevenueAccounting` field to `true`. * If you are a Billing - Revenue Integration customer, you must set the `reflectDiscountInNetAmount` field to `false`, otherwise an error will be returned. Billing - Revenue Integration does not support discounts on the preceding charges. * If you are a Zuora Billing customer who does not enable the Order to Revenue or Billing - Revenue Integration feature, when you apply percentage discounts to the preceding charges, you also need to set the `reflectDiscountInNetAmount` field to `true`. - `revRecStartDate` string, date - `serviceEndDate` string, date — The end date of the service period for this item, i.e., the last day of the service period, as _yyyy-mm-dd_. - `serviceStartDate` string, date — The start date of the service period for this item, as _yyyy-mm-dd_. For a one-time fee item, the date of the charge. - `sKU` string — The SKU of the product associated with the invoice item. - `sourceItemType` 'SubscriptionComponent' | 'Rounding' | 'ProductRatePlanCharge' | 'None' | 'OrderLineItem' — The type of the source item. - `subscriptionId` string — ID of the subscription associated with the invoice item. - `subscriptionNumber` string — Number of the subscription associated with the invoice item. - `taxAmount` number, double — The amount of tax applied to the charge. - `taxCode` string — The tax code of the invoice item. **Note** Only when taxation feature is enabled, this field can be presented. - `taxExemptAmount` number - `taxMode` 'TaxExclusive' | 'TaxInclusive' — The tax mode of the invoice item, indicating whether the amount of the invoice item includes tax. - `unitPrice` number, double — The per-unit price of the invoice item. **Note**: For discount charges, this represents the discount percentage (for percentage-based discounts) or the discount amount (for fixed-amount discounts). - `uOM` string — The unit of measure (UOM) that is configured in **Settings > Billing** for the product rate plan charge. - `balance` number — The balance of the invoice item. **Note**: This field is only available if you have the Invoice Settlement feature enabled. - `numberOfDeliveries` number — The number of deliveries dedicated to the Delivery Pricing charges. **Note**: This field is available only if you have the Delivery Pricing feature enabled. - `accountReceivableAccountingCodeId` string — ID of the account receivable accounting code associated with the invoice item. **Note:** This field is only available if you have Zuora Finance enabled. - `recognizedRevenueAccountingCodeId` string — ID of the recognized revenue accounting code associated with the invoice item. **Note:** This field is only available if you have Zuora Finance enabled. - `deferredRevenueAccountingCodeId` string — ID of the deferred revenue accounting code associated with the invoice item. **Note:** This field is only available if you have Zuora Finance enabled. - `contractAssetAccountingCodeId` string — ID of the accounting code for contract asset. **Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. - `contractLiabilityAccountingCodeId` string — ID of the accounting code for contract liability. **Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. - `contractRecognizedRevenueAccountingCodeId` string — ID of the accounting code for contract recognized revenue. **Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. - `unbilledReceivablesAccountingCodeId` string - `adjustmentRevenueAccountingCodeId` string — The accounting code for adjustment revenue. **Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. - `adjustmentLiabilityAccountingCodeId` string — ID of the accounting code for adjustment liability. **Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. - `journalEntryId` string — The ID of the journal entry that corresponds to this invoice item. - `accountId` string — The ID of the account associated with the invoice item. - `billToContactSnapshotId` string — The ID of the bill-to contact snapshot associated with the invoice. - `shipToContactSnapshotId` string — The ID of the ship-to contact snapshot associated with the invoice. - `soldToContactSnapshotId` string — The ID of the sold-to contact snapshot associated with the invoice. - `parentAccountId` string — The parent account of the account associated with the invoice. **Note**: This field is available only if you have Customer Hierarchy enabled for your tenant. - `billToContactId` string — The ID of the bill-to contact associated with the invoice. - `shipToContactId` string — The ID of the ship-to contact associated with the invoice. - `soldToContactId` string — The ID of the sold-to contact associated with the invoice. - `defaultPaymentMethodId` string — The ID of the default payment method on the associated account. - `ratePlanId` string — The ID of the rate plan that the invoice is created from. - `amendmentId` string — The ID of the amendment associated with the subscription. **Note**: This field is available only if you do not have Orders enabled for your tenant. - `productRatePlanChargeId` string — The ID of the product rate plan charge that the invoice item is created from. - `productRatePlanId` string — The ID of the product rate plan that the invoice item is created from. - `productId` string — The ID of the product that the invoice item is created from. - `bookingReference` string — The booking reference of the invoice item. - `itemType` string — The type of the invoice item. - `purchaseOrderNumber` string — The purchase order number associated with the invoice item. - `revRecCode` string — The revenue recognition code. - `revRecTriggerCondition` 'ContractEffectiveDate' | 'ServiceActivationDate' | 'CustomerAcceptanceDate' — The date when revenue recognition is triggered. - `revenueRecognitionRuleName` string — The revenue recognition rule of the invoice item. **Note:** This field is only available if you have Zuora Finance enabled. - `subscriptionOwnerId` string — The ID of the subscription owner associated with the invoice item. - `orderLineItemId` string — The reference ID of the oder line item associated with the invoice item. - `invoice` object — The invoices to which the invoice item belongs. - `subscription` object — The invoice to which the invoice item belongs. - `ratePlanCharge` object — The rate plan charge associated with the invoice item. - `orderLineItem` object — The order line item associated with the invoice item. - `creditMemoItem` NestedCreditMemoItemOnExpand - `id` string — The unique identifier of the credit memo item. - `createdById` string — The unique identifier of the user who created the credit memo item. - `createdDate` string, date-time — The date and time when the credit memo item was created. - `updatedById` string — The unique identifier of the user who last updated the credit memo item. - `updatedDate` string, date-time — The date and time when the credit memo item was last updated. - `amount` number — The amount of the credit memo item. For tax-inclusive credit memo items, the amount indicates the credit memo item amount including tax. For tax-exclusive credit memo items, the amount indicates the credit memo item amount excluding tax. - `amountWithoutTax` number, double — The credit memo item amount excluding tax. - `appliedToItemId` string — The unique ID of the credit memo item that the discount charge is applied to. - `appliedToOthersAmount` number — The amount of the credit memo that is applied to other credit memo items. - `beAppliedByOthersAmount` number - `chargeDate` string, date-time — The date when the credit memo item is charged, in `yyyy-mm-dd hh:mm:ss` format. - `description` string — The description of the credit memo item. **Note**: This field is only available if you set the `Zuora-Version` request header to `257.0` or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version). - `excludeItemBillingFromRevenueAccounting` boolean — The flag to exclude the credit memo item from revenue accounting. **Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. - `fulfillmentId` string — The reference ID of the fulfillment associated with the credit memo item. - `invoiceScheduleId` string — The ID of the invoice schedule associated with the credit memo item. **Note**: This field is available only if you have the Billing Schedule feature enabled. - `invoiceScheduleItemId` string — The ID of the invoice schedule item associated with the credit memo item. The credit memo item is generated during the processing of the invoice schedule item. **Note**: This field is available only if you have the Billing Schedule feature enabled. - `itemShipToContactId` string — The ID of the ship-to contact associated with the credit memo item. **Note**: If you have the Flexible Billing Attributes feature disabled, the value of this field is `null`. - `itemSoldToContactId` string — The ID of the sold-to contact associated with the credit memo item. **Note**: If you have the Flexible Billing Attributes feature disabled, the value of this field is `null`. - `itemSoldToContactSnapshotId` string — The ID of the sold-to contact snapshot associated with the credit memo item. **Note**: If you have the Flexible Billing Attributes feature disabled, the value of this field is `null`. - `itemType` string — The type of the credit memo item. - `orderLineItemId` string — The ID of the order line item associated with the credit memo item, if applicable. - `processingType` '0' | '1' — The type of the charge for the credit memo item. - `0`: Charge - `1`: Discount - `quantity` number, double — The number of units for the credit memo item. - `purchaseOrderNumber` string — The purchase order number associated the credit memo item. - `creditFromItemSource` 'InvoiceItem' | 'CreditMemoItem' — The type of the credit from item. - `creditFromItemId` string — The ID of the credit from item. - `reflectDiscountInNetAmount` boolean — When you apply percentage discounts to either of the following charges, you need to set the `reflectDiscountInNetAmount` field on your discount charge to `true`, to enable calculating and displaying the net amount of the following charges in Zuora Revenue. * delivery pricing charge * prepayment charge * drawdown charge Note the following: * If you are an Order to Revenue customer, when you set the `reflectDiscountInNetAmount` field to `true`, you must also set the `excludeItemBillingFromRevenueAccounting` field to `true`. * If you are a Billing - Revenue Integration customer, you must set the `reflectDiscountInNetAmount` field to `false`, otherwise an error will be returned. Billing - Revenue Integration does not support discounts on the preceding charges. * If you are a Zuora Billing customer who does not enable the Order to Revenue or Billing - Revenue Integration feature, when you apply percentage discounts to the preceding charges, you also need to set the `reflectDiscountInNetAmount` field to `true`. - `serviceEndDate` string, date — The service end date of the credit memo item. - `serviceStartDate` string, date — The service start date of the credit memo item. - `sku` string — The SKU for the product associated with the credit memo item. - `sourceItemType` 'SubscriptionComponent' | 'InvoiceDetail' | 'ProductRatePlanCharge' | 'OrderLineItem' — The type of the source item. - If a credit memo is not created from an invoice or a product rate plan charge or a return order line item, the value of this field is `SubscriptionComponent`. - If a credit memo is created from an invoice, the value of this field is `InvoiceDetail`. - If a credit memo is created from a product rate plan charge, the value of this field is `ProductRatePlanCharge`. - If a credit memo is created from a return order line item, the value of this field is `OrderLineItem`. - `subscriptionId` string — The ID of the subscription associated with the credit memo item. - `taxMode` 'TaxExclusive' | 'TaxInclusive' — The tax mode of the credit memo item, indicating whether the amount of the credit memo item includes tax. - `chargeName` string — The name of the charge associated with the credit memo item. - `chargeNumber` string — The number of the product rate plan charge that the credit memo is created from. - `commitmentChargeSegmentNumber` string - `commitmentChargeNumber` string - `taxAmount` number, double — The amount of the tax applied to the credit memo item. - `taxCodeName` string — The tax code identifies which tax rules and tax rates to apply to a specific credit memo item. - `taxExemptAmount` number — The calculated tax amount excluded due to the exemption. - `unappliedAmount` number, double — The unapplied amount of the credit memo item. - `unitOfMeasure` string — The units to measure usage. - `unitPrice` number, double — The per-unit price of the credit memo item. - `subscriptionNumber` string — The number of the subscription associated with the credit memo item. - `invoiceItemId` string — The ID of the invoice item associated with the credit memo item. - `productRatePlanChargeId` string — The ID of the product rate plan charge that the credit memo is created from. - `ratePlanChargeId` string — The ID of the rate plan charge associated with the credit memo item. - `revenueRecognitionRuleName` string — The name of the revenue recognition rule governing the revenue schedule. - `revenueImpacting` 'Yes' | 'No' — Indicates whether this write off operation impacts the revenue. If `revenueImpacting` = `Yes`, the deferred revenue accounting code will be automatically selected from the associated invoice. If `revenueImpacting` = `No`, users can select an accounting code such as bad-debt expense accounting code for the write off operation. - `creditMemoId` string — The ID of the credit memo to which this credit memo item belongs. - `numberOfDeliveries` number — The number of deliveries dedicated to the Delivery Pricing charges. The value might be different, as follows: - For the credit memo generated by a bill run, this field has a value. - For the credit memo generated from an invoice, this field is blank. **Note**: This field is available only if you have the Delivery Pricing feature enabled. - `recognizedRevenueAccountingCodeId` string — The Recognized Revenue accounting code for the credit memo item. - `accountReceivableAccountingCodeId` string — The Account Receivable accounting code for the credit memo item. - `onAccountAccountingCodeId` string — The On Account accounting code for the credit memo item. - `deferredRevenueAccountingCodeId` string — The Deferred Revenue accounting code for the credit memo item. - `journalEntryId` string — The ID of the journal entry that corresponds to this transaction. - `shipToContactSnapshotId` string — The ID of the ship-to contact snapshot associated with the credit memo. - `soldToContactSnapshotId` string — The ID of the sold-to contact snapshot associated with the credit memo. - `billToContactSnapshotId` string — The ID of the bill-to contact snapshot associated with the credit memo. - `subscription` object — The subscription associated with the credit memo item. - `ratePlanCharge` object — The rate plan charge associated with the credit memo item. ## 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/702f3caf3985/schema)