--- title: "List debit memos" method: GET path: "/object-query/debit-memos" tags: ["Object Queries"] --- # List debit memos `GET /object-query/debit-memos` Lists debit memos. 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` ExpandedDebitMemo[] - `id` string — The unique identifier of the debit memo. - `createdById` string — The unique identifier of the user who created the debit memo. - `createdDate` string, date-time — The date and time when the debit memo was created. - `updatedById` string — The unique identifier of the user who last updated the debit memo. - `updatedDate` string, date-time — The date and time when the debit memo was last updated. - `autoPay` boolean — Whether debit memos are automatically picked up for processing in the corresponding payment run. By default, debit memos are automatically picked up for processing in the corresponding payment run. - `creditMemoId` string, nullable — The ID of the credit memo from which the debit memo was created. - `balance` number — The remaining balance of debit memo. - `billToContactId` string — The ID of the bill-to contact associated with the debit memo. The value of this field is `null` if you have the [Flexible Billing Attributes](https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes) feature disabled. - `billToContactSnapshotId` string — The ID of the bill-to contact snapshot associated with the debit memo. The value of this field is `null` if the bill rule [Preserve snapshot of bill-to and sold-to contacts when billing documents are posted](https://docs.zuora.com?resourceId=billing-billing-rules-billing-document) is disabled. - `cancelledById` string, nullable — The ID of the Zuora user who cancelled the debit memo. - `cancelledOn` string, date-time, nullable — The date and time when the debit memo was cancelled, in `yyyy-mm-dd hh:mm:ss` format. - `comments` string — Comments about the debit memo. - `currency` string, nullable — The currency of the debit memo. **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. - `discountAmount` number — The amount of the discount on the debit memo. - `dueDate` string, date — The date by which the payment for the debit memo is due, in `yyyy-mm-dd` format. - `einvoiceErrorCode` string — The error code returned when the e-invoice file status is `Failed`. This code can either be a Zuora-generated error code or one returned by a third-party e-invoicing service provider. **Note**: This field is available only if you have the E-Invoicing feature in **Early Adopter** phase enabled. - `einvoiceErrorMessage` string — The error message returned when the e-invoice file status is `Failed`. This message can either be a Zuora-generated error message or one returned by a third-party e-invoicing service provider. **Note**: This field is available only if you have the E-Invoicing feature in **Early Adopter** phase enabled. - `einvoiceFileId` string — The ID of the e-invoice file generated for the debit memo. **Note**: This field is available only if you have the E-Invoicing feature in **Early Adopter** phase enabled. - `einvoiceStatus` 'Processing' | 'RetrieveTimeOut' | 'Generated' | 'Success' | 'Failed' | 'ConditionalSuccess' | 'ApprovedByAuthority' | 'Rejected' — The status of the e-invoice file generation for the credit memo. - If e-invoice file generation succeeds, this field is either `Generated` or `Success`, and both the error code and message are empty, and the `eInvoiceFileId` field stores the ID of the generated e-invoice file. - If the responses from tax vendors such as Sovos or Avalara are taking too long, this field becomes `RetrieveTimeOut`. Once the vendor responds successfully, you can use the 'Resync E-Invoice Status' action to update the status automatically. You can view these updates in System Health telemetry. - If a failure occurs during e-invoice file generation, this field is `Failed` and an error code and an error message are returned respectively in the `einvoiceErrorCode` and `einvoiceErrorMessage` fields. - If e-invoice file generation conditionally succeeds, this field is `ConditionalSuccess` and an error code and an error message are returned respectively in the `einvoiceErrorCode` and `einvoiceErrorMessage` fields. - If the e-invoice file has been approved by the tax authority, this field is `ApprovedByAuthority`. The next status will be either `Success` or `Rejected`. - If the e-invoice file has been rejected by the government, this field is `Rejected`. You cannot resend this e-invoice; you must create a new invoice instead. **Note**: This field is available only if you have the E-Invoicing feature in **Early Adopter** phase enabled. - `exchangeRateDate` string, date — The date of the exchange rate used. The date is in `yyyy-mm-dd` format. Corresponds to the value specified in the Provider Exchange Rate Date column in the Import Foreign Exchange Rates template when you uploaded the rates through the Mass Updater. - `memoDate` string, date — The date when the debit memo takes effect, in `yyyy-mm-dd` format. For example, `2024-01-01`. - `memoNumber` string — The unique identification number of the debit memo. - `postedById` string — The ID of the Zuora user who posted the debit memo. - `postedOn` string, date-time — The date and time when the debit memo was posted, in `yyyy-mm-dd hh:mm:ss` format. - `reasonCode` string — A code identifying the reason for the transaction. The value must be an existing reason code or empty. - `sequenceSetId` string, nullable — The ID of the sequence set associated with the debit memo. The value of this field is `null` if you have the [Flexible Billing Attributes](https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes) feature disabled. - `source` 'BillRun' | 'API' | 'ApiSubscribe' | 'ApiAmend' | 'AdhocFromPrpc' | 'AdhocFromInvoice' — The source of the debit memo. Possible values: - `BillRun`: The debit memo is generated by a bill run. - `API` - `ApiSubscribe`: The debit memo is created by calling the [Create subscription](https://developer.zuora.com/api-references/api/operation/POST_Subscription) and [Create account](https://developer.zuora.com/api-references/api/operation/POST_Account) operation. - `ApiAmend`: The debit memo is created by calling the [Update subscription](https://developer.zuora.com/api-references/api/operation/PUT_Subscription) operation. - `AdhocFromPrpc`: The debit memo is created from a product rate plan charge through the Zuora UI or by calling the [Create a debit memo from a charge](https://developer.zuora.com/api-references/api/operation/POST_DebitMemoFromPrpc/) operation. - `AdhocFromInvoice`: The debit memo is created from an invoice or created by reversing an invoice. You can create a debit memo from an invoice through the Zuora UI or by calling the [Create a debit memo from an invoice](https://developer.zuora.com/api-references/api/operation/POST_DebitMemoFromInvoice/) operation. - `sourceId` string — The ID of the debit memo source. If a debit memo is generated from a bill run, the value is the number of the corresponding bill run. Otherwise, the value is `null`. - `sourceType` 'Subscription' | 'Standalone' | 'Order' | 'Consolidation' | 'Invoice' | 'CreditMemo' — The type of the debit memo source. - `status` 'Draft' | 'Posted' | 'Canceled' | 'Error' | 'PendingForTax' | 'Generating' | 'CancelInProgress' — The status of the debit memo. - `targetDate` string, date — The target date for the debit memo, in `yyyy-mm-dd` format. For example, `2024-01-01`. - `taxAmount` number, double — The amount of taxation. - `taxMessage` string, nullable — The message about the status of tax calculation related to the debit memo. If tax calculation fails in one debit memo, this field displays the reason for the failure. - `taxStatus` 'Complete' | 'Error' | 'UnknownError' | 'DuplicateDoc' | 'InvalidRequest' | 'InvalidResponse' | 'TaxEngineError' | 'ConcurrentModify' | 'InternalServerError' | 'TaxCodeTemplateError' | 'Voided' — The status of tax calculation related to the debit memo. **Note**: This field is only applicable to tax calculation by third-party tax engines. 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. - `shipToContactSnapshotId` string — The ID of the ship-to contact snapshot associated with the debit memo. **Note**: If you have the Flexible Billing Attributes feature disabled, the value of this field is `null`. - `soldToContactSnapshotId` string — The ID of the sold-to contact snapshot associated with the debit memo. **Note**: If you have the Flexible Billing Attributes feature disabled, the value of this field is `null`. - `taxAutoCalculation` boolean — Whether to automatically calculate taxes in the debit memo. - `totalAmount` number, double — The total amount of the debit memo, including taxes. - `totalAmountWithoutTax` number, double — The total amount of the debit memo, excluding taxes. - `totalTaxExemptAmount` number, double — The calculated tax amount excluded due to the exemption. - `transferredToAccounting` 'Processing' | 'Yes' | 'No' | 'Error' | 'Ignore' — Whether the debit memo was transferred to an external accounting system. This field is used for integration with accounting systems such as NetSuite. - `invoiceId` string — The ID of a referred invoice. - `accountId` string — The ID of the customer account associated with the debit memo. - `paymentTerm` string — The name of the payment term assoicated with the debit memo. The value of this field is `null` if you have the [Flexible Billing Attributes](https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes) feature disabled. - `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. - `debitMemoItems` NestedDebitMemoItemOnExpand[] - `id` string — The unique identifier of the debit memo item. - `createdById` string — The unique identifier of the user who created the debit memo item. - `createdDate` string, date-time — The date and time when the debit memo item was created. - `updatedById` string — The unique identifier of the user who last updated the debit memo item. - `updatedDate` string, date-time — The date and time when the debit memo item was last updated. - `amount` number, double — The amount of the debit memo item. For tax-inclusive debit memo items, the amount indicates the debit memo item amount including tax. For tax-exclusive debit memo items, the amount indicates the debit memo item amount excluding tax. - `amountWithoutTax` number, double — The debit memo item amount excluding tax. - `appliedToItemId` string — The parent debit memo item that this debit memo items is applied to if this item is discount. - `appliedToOthersAmount` number - `beAppliedByOthersAmount` number - `chargeDate` string, date-time — The date when the debit memo item is charged, in `yyyy-mm-dd hh:mm:ss` format. - `creditMemoItemId` string - `excludeItemBillingFromRevenueAccounting` boolean — The flag to exclude the debit memo item from revenue accounting. **Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. - `description` string — The description of the debit memo item. - `itemShipToContactId` unknown - `itemSoldToContactId` string — The ID of the sold-to contact associated with the debit 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 debit memo item. **Note**: If you have the Flexible Billing Attributes feature disabled, the value of this field is `null`. - `processingType` '0' | '1' — The type of the charge for the debit memo item. - `0`: charge - `1`: discount - `quantity` number, double — The number of units for the debit memo 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 end date of the service period associated with this debit memo item. Service ends one second before the date specified in this field. - `serviceStartDate` string, date — The start date of the service period associated with this debit memo item. If the associated charge is a one-time fee, this date is the date of that charge. - `sku` string — The SKU for the product associated with the debit memo item. - `sourceItemType` 'CreditMemoItem' | 'SubscriptionComponent' | 'InvoiceDetail' | 'ProductRatePlanCharge' — The type of the source item. - `chargeName` string — The name of the charge associated with the debit memo item. - `chargeNumber` string — The number of the charge associated with the debit memo item. - `taxAmount` number, double — The amount of tax on this debit memo. - `taxCodeName` string — Name of the tax code identifies which tax rules and tax rates to apply to a specific debit memo item. - `taxExemptAmount` number, double — The calculated tax amount excluded due to the exemption. - `taxMode` 'TaxExclusive' | 'TaxInclusive' — The tax mode of the debit memo item, indicating whether the amount of the debit memo item includes tax. - `unitOfMeasure` string — The units to measure usage. - `unitPrice` number, double — The per-unit price of the debit memo item. - `subscriptionId` string — The ID of the subscription associated with the debit memo item. - `subscriptionNumber` string — The number of the subscription associated with the debit memo item. - `invoiceItemId` string — The ID of the invoice item associated with the debit memo item. - `productRatePlanChargeId` string — The ID of the product rate plan charge based on which the debit memo item is created. - `ratePlanChargeId` string — The ID of the rate plan charge associated with the debit memo item. - `debitMemoId` string — The ID of the debit memo to which this debit memo item belongs. - `balance` number, double — The balance of the debit memo item. - `recognizedRevenueAccountingCodeId` string — The Recognized Revenue accounting code for the credit memo item. - `accountReceivableAccountingCodeId` string — The Account Receivable 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. - `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 debit memo item. - `ratePlanCharge` object — The rate plan charge associated with the debit memo 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)