--- title: "List invoices" method: GET path: "/object-query/invoices" tags: ["Object Queries"] --- # List invoices `GET /object-query/invoices` Lists invoices. 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` ExpandedInvoice[] - `id` string — The unique identifier of the invoice. - `createdById` string — The unique identifier of the user who created the invoice. - `createdDate` string, date-time — The time that the invoice 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 invoice. - `updatedDate` string, date-time — The time that the invoice gets updated in the system, in the `YYYY-MM-DD HH:MM:SS` format. - `accountId` string — The ID of the customer account associated with the invoice. - `adjustmentAmount` number, double — The amount of the invoice adjustments associated with the invoice. - `amount` number, double — The total amount of the invoice. - `amountWithoutTax` number, double — The invoice amount excluding tax. - `autoPay` boolean — Whether invoices are automatically picked up for processing in the corresponding payment run. - `balance` number, double — The remaining balance of the invoice after all payments, adjustments, and refunds are applied. - `billToContactId` string — The ID of the bill-to contact associated with the invoice. - `billToContactSnapshotId` string — The ID of the bill-to contact snapshot associated with the invoice. - `comments` string — Comments about the invoice. - `creditBalanceAdjustmentAmount` number, double — The currency amount of the adjustment applied to the customer's credit balance. **Note:** This field is only available if you have the Credit Balance feature enabled and the Invoice Settlement feature disabled. - `creditMemoAmount` number, double — The currency amount of all credit memos applied to this invoice. **Note:** This field is only available if you have [Invoice Settlement](https://docs.zuora.com?resourceId=billing-invoice-settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide) for more information. - `currency` string, nullable — The currency of the invoice. **Note:** By default, the currency on a billing document matches the default currency set on the associated account. However, Zuora now offers a Multiple Currencies feature to support different currencies for billing documents, allowing flexibility beyond the account-level currency. For more information, see Multiple Currency. - `dueDate` string, date — The date by which the payment for this invoice is due, in `yyyy-mm-dd` format. - `includesOneTime` boolean — Specifies whether the invoice includes one-time charges. - `includesRecurring` boolean — Specifies whether the invoice includes recurring charges. - `includesUsage` boolean — Specifies whether the invoice includes usage charges. - `invoiceDate` string, date — The date that appears on the invoice being created. - `invoiceNumber` string — The unique identification number of the invoice. - `lastEmailSentDate` string — The date when the invoice was last emailed. - `organizationId` string — ID of the organization this object belongs to. - `paymentAmount` number, double — The amount of payments applied to the invoice. - `postedBy` string — The user ID of the person who moved the invoice to Posted status. - `postedDate` string, date-time — The date when the invoice was posted. - `refundAmount` number, double — Specifies the amount of a refund that was applied against an earlier payment on the invoice. - `sequenceSetId` string, nullable — The ID of the sequence set associated with the invoice. - `communicationProfileId` string, nullable — The ID of the communication profile associated with the invoice. - `shipToContactId` string — The ID of the ship-to contact associated with the invoice. - `shipToContactSnapshotId` string — The ID of the ship-to contact snapshot associated with the invoice. - `soldToContactId` string — The ID of the sold-to contact associated with the invoice. - `soldToContactSnapshotId` string — The ID of the sold-to contact snapshot associated with the invoice. - `source` 'BillRun' | 'API' | 'ApiSubscribe' | 'ApiAmend' — The source of the invoice. - `sourceId` string — The ID of the invoice source. If an invoice is generated from a bill run, the value is the number of the corresponding bill run.Otherwise, the value is `null`. - `reversed` boolean — Whether the invoice is reversed. - `sourceType` 'Subscription' | 'Standalone' | 'Order' | 'Consolidation' — The type of the invoice source. - `status` 'Draft' | 'Posted' | 'Split' — The status of the invoice. **Note:** - The `Split` status is applicable only when you use Split Invoice feature. - When an invoice is split, its status changes from `Draft` to `Split`, and the newly created invoices retain a reference to the original invoice. - `targetDate` string, date — This date is used to determine which charges are to be billed. All charges that are to be billed on this date or prior will be included in this bill run. - `taxAmount` number, double — The amount of taxation. - `taxExemptAmount` number, double — The calculated tax amount excluded due to the exemption. - `taxMessage` string, nullable — The message that the tax engine return if it calculates the taxes of this invoice fails. - `taxStatus` 'Complete' | 'Error' | 'UnknownError' | 'DuplicateDoc' | 'InvalidRequest' | 'InvalidResponse' | 'TaxEngineError' | 'ConcurrentModify' | 'InternalServerError' | 'TaxCodeTemplateError' | 'Voided' — The status that the tax engine return after it calculates the taxes of this invoice. Also, the `Voided` status indicates that the tax transaction is successfully canceled on the tax vendor's side. If a tax transaction was successfully committed to the third-party tax engine but the invoice failed to post, Zuora automatically detects the issue and voids the tax transaction on the vendor's side. - `templateId` string — The ID of the invoice template. - If you have the Flexible Billing Attributes feature enabled, the value of this field depends on the configuration of the invoice template. - If you specify an invoice template at the subscription level, the value of this field is automatically populated from the corresponding subscription. - If you do not specify any invoice template at the subscription level, the value of this field is automatically populated from the corresponding account. - If you have the Flexible Billing Attributes feature disabled, the value of this field is `null`. - `transferredToAccounting` 'Processing' | 'Error' | 'Ignore' | 'Yes' | 'No' — Whether the invoice was transferred to an external accounting system. - `eInvoiceStatus` 'Processing' | 'RetrieveTimeOut' | 'Generated' | 'Success' | 'Failed' | 'ConditionalSuccess' | 'ApprovedByAuthority' | 'Rejected' — It could be Processing, RetrieveTimeOut, Generated, Success, ConditionalSuccess, ApprovedByAuthority, Failed, and Rejected. If it’s Failed, it will have an error code and message. If it’s Generated or Success, both error code and message are empty, and eInvoiceFileId stores the file id of e-invoice. - `eInvoiceFileId` string — The ID of the e-invoice file. - `eInvoiceErrorCode` string — The error code when status is `Failed`. This code can either be a Zuora-generated error code or one returned by a third-party e-invoice vendor. - `eInvoiceErrorMessage` string — The error message when status is "Failed". This message can either be a Zuora-generated error code or one returned by a third-party e-invoice vendor. - `paymentLink` string — A link to the Payment Link page where the customer can pay the invoice. The link is generated only if the invoice is posted after enabling the Payment Link feature on your tenant. **Note**: The Payment Link feature is in the Early Adopter phase. You can enable the Payment Link feature through a self-service configuration in the **Manage Features** setting for Zuora Payments. - `paymentTerm` string — The payment term associated with the invoice. The payment term determines the due dates of invoices. - `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. - `billToContact` 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. - `billToContactSnapshot` NestedContactSnapshotOnExpand - `id` string — The unique identifier of the contact snapshot. - `createdById` string — The unique identifier of the user who created the snapshot. - `createdDate` string, date-time — The date and time when the contact snapshot was created. - `updatedById` string — The unique identifier of the user who last updated the snapshot. - `updatedDate` string, date-time — The date and time when the contact snapshot was last updated. - `accountId` string — The unique identifier of the associated billing account. - `contactId` string — The unique identifier of the original contact. - `firstName` string — The first name of the contact. - `lastName` string — The last name of the contact. - `nickName` string — The nickname of the contact. - `address1` string — The first line of the address. - `address2` string — The second line of the address. - `city` string — The city of the contact's address. - `state` string — The state or province of the contact's address. - `postalCode` string — The postal or ZIP code. - `county` string — The county or region of the contact. - `country` string — The county or region of the contact. - `taxRegion` string — The tax region applicable to the contact. - `description` string — The free-form description of the contact snapshot. - `homePhone` string — The home phone number. - `otherPhone` string — Any other phone number. - `otherPhoneType` string — The type of the other phone number. - `fax` string — The fax number. - `personalEmail` string — The personal email address. - `workEmail` string — The personal email address. - `deleted` boolean — Indicates whether the contact snapshot is marked as deleted. - `soldToContactSnapshot` NestedContactSnapshotOnExpand - `id` string — The unique identifier of the contact snapshot. - `createdById` string — The unique identifier of the user who created the snapshot. - `createdDate` string, date-time — The date and time when the contact snapshot was created. - `updatedById` string — The unique identifier of the user who last updated the snapshot. - `updatedDate` string, date-time — The date and time when the contact snapshot was last updated. - `accountId` string — The unique identifier of the associated billing account. - `contactId` string — The unique identifier of the original contact. - `firstName` string — The first name of the contact. - `lastName` string — The last name of the contact. - `nickName` string — The nickname of the contact. - `address1` string — The first line of the address. - `address2` string — The second line of the address. - `city` string — The city of the contact's address. - `state` string — The state or province of the contact's address. - `postalCode` string — The postal or ZIP code. - `county` string — The county or region of the contact. - `country` string — The county or region of the contact. - `taxRegion` string — The tax region applicable to the contact. - `description` string — The free-form description of the contact snapshot. - `homePhone` string — The home phone number. - `otherPhone` string — Any other phone number. - `otherPhoneType` string — The type of the other phone number. - `fax` string — The fax number. - `personalEmail` string — The personal email address. - `workEmail` string — The personal email address. - `deleted` boolean — Indicates whether the contact snapshot is marked as deleted. - `shipToContactSnapshot` NestedContactSnapshotOnExpand - `id` string — The unique identifier of the contact snapshot. - `createdById` string — The unique identifier of the user who created the snapshot. - `createdDate` string, date-time — The date and time when the contact snapshot was created. - `updatedById` string — The unique identifier of the user who last updated the snapshot. - `updatedDate` string, date-time — The date and time when the contact snapshot was last updated. - `accountId` string — The unique identifier of the associated billing account. - `contactId` string — The unique identifier of the original contact. - `firstName` string — The first name of the contact. - `lastName` string — The last name of the contact. - `nickName` string — The nickname of the contact. - `address1` string — The first line of the address. - `address2` string — The second line of the address. - `city` string — The city of the contact's address. - `state` string — The state or province of the contact's address. - `postalCode` string — The postal or ZIP code. - `county` string — The county or region of the contact. - `country` string — The county or region of the contact. - `taxRegion` string — The tax region applicable to the contact. - `description` string — The free-form description of the contact snapshot. - `homePhone` string — The home phone number. - `otherPhone` string — Any other phone number. - `otherPhoneType` string — The type of the other phone number. - `fax` string — The fax number. - `personalEmail` string — The personal email address. - `workEmail` string — The personal email address. - `deleted` boolean — Indicates whether the contact snapshot is marked as deleted. ## 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)