--- title: "Retrieve an order line item" method: GET path: "/object-query/order-line-items/{key}" tags: ["Object Queries"] --- # Retrieve an order line item `GET /object-query/order-line-items/{key}` Retrieve the details of a specific Order Line Item 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 - ExpandedOrderLineItem - `id` string — The unique identifier of the order line item. - `createdById` string — The unique identifier of the user who created the order line item. - `createdDate` string, date-time — The time that the order line item gets created in the system, in the `YYYY-MM-DD HH:MM:SS` format. - `updatedById` string — The unique identifier of the user who last updated the order line item. - `updatedDate` string, date-time — The date and time when the order line item was last updated. - `accountingCode` string, nullable — The accountingCode for the Order Line Item (OLI). You can update this field only for a sales OLI and only when the sales OLI is in the `Executing` state (when the `itemState` field is set as `Executing`). - `billTargetDate` string, date — The target date for the Order Line Item (OLI) to be picked up by bill run for generating billing documents. To generate billing documents for an OLI, you must set this field and set the `itemState` field to `SentToBilling`. You can update this field for a sales or return OLI only when the OLI is in the `Executing` state (when the `itemState` field is set as `Executing`). - `amountPerUnit` number — The actual charged amount per unit for the Order Line Item (OLI). You can update this field only for a sales OLI and only when the sales OLI is in the `Executing` state (when the `itemState` field is set as `Executing`). - `description` string — The description of the Order Line Item. - `amount` number — The total amount for the Order Line Item (OLI). - `amountWithoutTax` number — The total amount for the Order Line Item (OLI) excluding tax. - `itemName` string — The name of the Order Line Item (OLI). You can update this field for a sales or return OLI only when the OLI is in the `Executing` state (when the `itemState` field is set as `Executing`). - `itemNumber` string — The number for the Order Line Item (OLI). You can update this field for a sales or return OLI only when the OLI is in the `Executing` state (when the `itemState` field is set as `Executing`). - `itemState` 'Executing' | 'Booked' | 'SentToBilling' | 'Complete' | 'Cancelled' — The state of the Order Line Item (OLI). See [State transitions for an order, order line item, and fulfillment](https://docs.zuora.com?resourceId=billing-state-transitions-order-line-items) for more information. To generate invoice for an OLI, you must set this field to `SentToBilling` and set the `billTargetDate` field . You can update this field for a sales or return OLI only when the OLI is in the `Executing` or 'Booked' or `SentToBilling`state (when the `itemState` field is set as `Executing` or `SentToBilling`). - `itemType` 'Product' | 'Fee' | 'Services' — The type of the Order Line Item (OLI). You can update this field only for a sales OLI and only when the sales OLI is in the `Executing` state (when the `itemState` field is set as `Executing`). - `listPricePerUnit` number — The list price per unit for the Order Line Item (OLI). You can update this field only for a sales OLI and only when the sales OLI is in the `Executing` state (when the `itemState` field is set as `Executing`). - `listPrice` number — The extended list price for an order line item, calculated by the formula: listPrice = listPricePerUnit * quantity - `orderId` string — The ID of the order that the order line item belongs to. - `orderNumber` string — The number of the order that the order line item belongs to. - `productCode` string — The product code for the Order Line Item (OLI). You can update this field only for a sales OLI and only when the sales OLI is in the `Executing` state (when the `itemState` field is set as `Executing`). - `purchaseOrderNumber` string — Used by customers to specify the Purchase Order Number provided by the buyer. You can update this field only for a sales OLI and only when the sales OLI is in the `Executing` state (when the `itemState` field is set as `Executing`). - `quantity` number — The quantity of units, such as the number of authors in a hosted wiki service. You can update this field for a sales or return OLI only when the OLI in the `Executing` state (when the `itemState` field is set as `Executing`). - `revenueRecognitionRule` string — The Revenue Recognition rule for the Order Line Item. - `productRatePlanChargeId` string — ID of a Product Rate Plan Charge. Only one-time charges are supported. - `billToId` string — The ID of a contact that belongs to the billing account of the order line item. Use this field to assign an existing account as the bill-to contact of an order line item. - `billToSnapshotId` string — The snapshot of the ID for an account used as the bill-to contact of an order line item. This field is used to store the original information about the account, in case the information about the account is changed after the creation of the order line item. The `billToSnapshotId` field is exposed while retrieving the order line item details. - `shipTo` string — The ID of a contact that belongs to the owner acount or billing account of the order line item. Use this field to assign an existing account as the ship-to contact of an order line item. - `shipToSnapshotId` string — The snapshot of the ID for an account used as the ship-to contact of an order line item. This field is used to store the original information about the account, in case the information about the account is changed after the creation of the order line item. The `shipToSnapshotId` field is exposed while retrieving the order line item details. - `soldTo` string — The ID of a contact that belongs to the owner acount or billing account of the order line item. Use this field to assign an existing account as the sold-to contact of an order line item. - `soldToSnapshotId` string — The snapshot of the ID for an account used as the sold-to contact of an order line item. This field is used to store the original information about the account, in case the information about the account is changed after the creation of the order line item. The `soldToSnapshotId` field is exposed while retrieving the order line item details. - `soldToOrderContactId` string — The ID of the sold-to contact for the order. - `ownerAccountId` string — The account ID of the owner of the order line item. - `invoiceOwnerAccountId` string — The account ID of the invoice owner of the order line item. - `taxCode` string — The tax code for the Order Line Item (OLI). You can update this field only for a sales OLI and only when the sales OLI is in the `Executing` state (when the `itemState` field is set as `Executing`). - `taxMode` 'TaxInclusive' | 'TaxExclusive' — The tax mode for the Order Line Item (OLI). You can update this field only for a sales OLI and only when the sales OLI is in the `Executing` state (when the `itemState` field is set as `Executing`). - `transactionDate` string, date — The date when the transaction occurs. - `uOM` string — Specifies the units to measure usage. You can update this field only for a sales OLI and only when the sales OLI is in the `Executing` state (when the `itemState` field is set as `Executing`). - `relatedSubscriptionNumber` string — This field is used to relate an order line item to an subscription. You can update this field only for a sales OLI and only when the sales OLI is in the `Executing` state (when the `itemState` field is set as `Executing`). - `transactionEndDate` string, date — The date a transaction is completed. The default value of this field is the transaction start date. Also, the value of this field should always equal or be later than the value of the `transactionStartDate` field. You can update this field for a sales or return OLI only when the OLI is in the `Executing` state (when the `itemState` field is set as `Executing`). - `transactionStartDate` string, date — The date a transaction starts. The default value of this field is the order date. You can update this field for a sales or return OLI only when the OLI is in the `Executing` state (when the `itemState` field is set as `Executing`). - `excludeItemBillingFromRevenueAccounting` boolean — Indicates whether to exclude the related invoice items, invoice item adjustments, credit memo items, and debit memo items from revenue accounting. **Note**: This field is only available if you have the Order to Revenue or Billing - Revenue Integration feature enabled. - `excludeItemBookingFromRevenueAccounting` boolean — Indicates whether to exclude the related rate plan charges and order line items from revenue accounting. **Note**: This field is only available if you have the Order to Revenue or Billing - Revenue Integration feature enabled. - `originalOrderDate` string, date — The date of the original sale order for a return order line item. - `amendedByOrderOn` string, date — The date of the amended order for a return order line item. - `itemCategory` 'Sales' | 'Return' — The category of the Order Line Item, to indicate a product sale or return. - `originalOrderId` string — The ID of the original sale order for a return order line item. - `originalOrderLineItemId` string — The ID of the original sale order line item for a return order line item. - `originalOrderLineItemNumber` string — The number of the original sale order line item for a return order line item. - `originalOrderNumber` string — The number of the original sale order for a return order line item. - `quantityAvailableForReturn` number — The quantity that can be returned for an order line item. - `quantityFulfilled` number — The fulfilled quantity for an order line item. - `quantityPendingFulfillment` number — The quantity to fulfill for an order line item. - `requiresFulfillment` boolean — The flag to show whether fulfillment is needed or not. It's derived from billing rule of the Order Line Item. - `billingRule` 'TriggerWithoutFulfillment' | 'TriggerAsFulfillmentOccurs' — The billing rule of the Order Line Item. - `inlineDiscountPerUnit` number — This field is used in accordance with the `inlineDiscountType` field, in the following manner: * If the `inlineDiscountType` field is set as `Percentage`, this field specifies the discount percentage for each unit of the order line item. For exmaple, if you specify `5` in this field, the discount percentage is 5%. * If the `inlineDiscountType` field is set as `FixedAmount`, this field specifies the discount amount on each unit of the order line item. For exmaple, if you specify `10` in this field, the discount amount on each unit of the order line item is 10. Once you set the `inlineDiscountType`, `inlineDiscountPerUnit`, and `listPricePerUnit` fields, the system will automatically generate the `amountPerUnit` field. You shall not set the `amountPerUnit` field by yourself. - `inlineDiscountType` 'Percentage' | 'FixedAmount' | 'None' — This field is used to specify the inline discount type, which can be `Percentage`, `FixedAmount`, or `None`. The default value is `Percentage`. This field is used together with the `inlineDiscountPerUnit` field to specify inline discounts for order line items. The inline discount is applied to the list price of an order line item. Once you set the `inlineDiscountType`, `inlineDiscountPerUnit`, and `listPricePerUnit` fields, the system will automatically generate the `amountPerUnit` field. You shall not set the `amountPerUnit` field by yourself. - `discount` number — This field shows the total discount amount that is applied to an order line item after the `inlineDiscountType`, `inlineDiscountPerUnit` and `quantity` fields are set. The inline discount is applied to the list price of an order line item. - `recognizedRevenueAccountingCodeId` string — The recognized revenue accounting code for the Order Line Item. - `deferredRevenueAccountingCodeId` string — The deferred revenue accounting code for the Order Line Item. - `contractAssetAccountingCode` string — The accounting code on the Order Line Item object for customers using [Zuora Billing - Revenue Integration](https://docs.zuora.com?resourceId=revenue-billing-integration). - `contractLiabilityAccountingCode` string — The accounting code on the Order Line Item object for customers using [Zuora Billing - Revenue Integration](https://docs.zuora.com?resourceId=revenue-billing-integration). - `contractRecognizedRevenueAccountingCodeId` string — The accounting code on the Order Line Item object for customers using [Zuora Billing - Revenue Integration](https://docs.zuora.com?resourceId=revenue-billing-integration). - `unbilledReceivablesAccountingCodeId` string — The accounting code on the Order Line Item object for customers using [Zuora Billing - Revenue Integration](https://docs.zuora.com?resourceId=revenue-billing-integration). - `adjustmentRevenueAccountingCodeId` string — The accounting code on the Order Line Item object for customers using [Zuora Billing - Revenue Integration](https://docs.zuora.com?resourceId=revenue-billing-integration). - `adjustmentLiabilityAccountingCodeId` string — The accounting code on the Order Line Item object for customers using [Zuora Billing - Revenue Integration](https://docs.zuora.com?resourceId=revenue-billing-integration). - `billTo` ExpandedContact - `id` string — The unique identifier of the contact. - `createdById` string — The unique identifier of the user who created the contact. - `createdDate` string, date-time — The date and time when the contact was created. - `updatedById` string — The unique identifier of the user who last updated the contact. - `updatedDate` string, date-time — The date and time when the contact was last updated. - `accountId` string — The ID of the account associated with the contact. - `address1` string — The first line of the contact's address, which is often a street address or business name. - `address2` string — The second line of the contact's address. - `asBillTo` boolean — Indicates whether the contact can be specified as a bill-to contact. - `asShipTo` boolean — Indicates whether the contact can be specified as a ship-to contact. - `asSoldTo` boolean — Indicates whether the contact can be specified as a sold-to contact. - `city` string — The city of the contact's address. - `country` string — The country of the contact's address. - `county` string — The county. May optionally be used by Zuora Tax to calculate county tax. - `fax` string — The contact's fax number. - `description` string — A description for the contact. - `firstName` string — The contact's first name. - `homePhone` string — The contact's home phone number. - `lastName` string — The contact's last name. - `mobilePhone` string — The mobile phone number of the contact. - `nickname` string — A nickname for the contact. - `otherPhone` string — An additional phone number for the contact. - `otherPhoneType` 'Work' | 'Mobile' | 'Home' | 'Other' — The type of the additional phone number. - `personalEmail` string — The contact's personal email address. - `state` string — The state or province of the contact's address. - `postalCode` string — ZIP code or other postal code of the contact's address. - `taxRegion` string — If using Zuora Tax, a region string as optionally defined in your tax rules. - `workEmail` string — The contact's business email address. - `workPhone` string — The contact's business phone number. - `invoiceItems` 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. - `invoiceOwnerAccount` 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. - `ownerAccount` 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. - `soldToInfo` ExpandedContact - `id` string — The unique identifier of the contact. - `createdById` string — The unique identifier of the user who created the contact. - `createdDate` string, date-time — The date and time when the contact was created. - `updatedById` string — The unique identifier of the user who last updated the contact. - `updatedDate` string, date-time — The date and time when the contact was last updated. - `accountId` string — The ID of the account associated with the contact. - `address1` string — The first line of the contact's address, which is often a street address or business name. - `address2` string — The second line of the contact's address. - `asBillTo` boolean — Indicates whether the contact can be specified as a bill-to contact. - `asShipTo` boolean — Indicates whether the contact can be specified as a ship-to contact. - `asSoldTo` boolean — Indicates whether the contact can be specified as a sold-to contact. - `city` string — The city of the contact's address. - `country` string — The country of the contact's address. - `county` string — The county. May optionally be used by Zuora Tax to calculate county tax. - `fax` string — The contact's fax number. - `description` string — A description for the contact. - `firstName` string — The contact's first name. - `homePhone` string — The contact's home phone number. - `lastName` string — The contact's last name. - `mobilePhone` string — The mobile phone number of the contact. - `nickname` string — A nickname for the contact. - `otherPhone` string — An additional phone number for the contact. - `otherPhoneType` 'Work' | 'Mobile' | 'Home' | 'Other' — The type of the additional phone number. - `personalEmail` string — The contact's personal email address. - `state` string — The state or province of the contact's address. - `postalCode` string — ZIP code or other postal code of the contact's address. - `taxRegion` string — If using Zuora Tax, a region string as optionally defined in your tax rules. - `workEmail` string — The contact's business email address. - `workPhone` string — The contact's business phone number. ## 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)