RecurringSalesReceiptTransactions
Holds recurring templates for sales receipts, automating the recording of repeat customer sales that are paid at the point of sale.
Columns
| Name | Type | ReadOnly | References | Filterable | Sortable | Description |
| SalesReceipt_Id [KEY] | String | True | True | True |
The Id of the sales receipt. | |
| SalesReceipt_SyncToken | String | True | False | False |
The version control token for the recurring sales-receipt transaction that is used to prevent conflicting updates. QuickBooks Online increments this sync token each time the record is modified, and only the latest sync token can be used when making changes. | |
| SalesReceipt_MetaData_CreateTime | Datetime | True | True | True |
The date and time stamp (in Coordinated Universal Time) when QuickBooks Online created the recurring sales receipt record. This field provides an immutable audit trail of the creation event. | |
| SalesReceipt_MetaData_LastUpdatedTime | Datetime | True | True | True |
The date and time stamp (in Coordinated Universal Time) when the recurring sales receipt record was last updated. This field is important for synchronization and detecting recent changes. | |
| SalesReceipt_CustomFieldAggregate | String | False | False | False |
An XML aggregate that is serialized into a single string containing all custom fields that are associated with this recurring sales receipt. Each CustomField element can include Name, Type, and Value attributes that define additional metadata applied to the transaction. | |
| SalesReceipt_DocNumber | String | False | True | True |
The external or system-generated reference number that is assigned to the recurring sales receipt. If no number is provided, QuickBooks Online automatically assigns the next sequential document number based on the company's numbering preferences. | |
| SalesReceipt_TxnDate | Date | False | True | True |
The transaction date that determines when this recurring sales receipt is posted to the books. For example, a sales receipt can be created on one date but backdated to affect a prior period's financial statements. | |
| SalesReceipt_DepartmentRef | String | False |
Departments.Id | False | False |
The unique identifier (Id) of the department or location that is linked to this recurring sales receipt when location tracking is enabled in QuickBooks Online. This Id helps classify revenue or activity by department. |
| SalesReceipt_DepartmentRef_Name | String | True |
Departments.Name | False | False |
The display name of the department or location that is linked to this recurring sales receipt when location tracking is enabled in QuickBooks Online. |
| SalesReceipt_PrivateNote | String | False | False | False |
An internal memo or private note that is recorded on the recurring sales receipt. These notes are not printed on customer-facing documents by default and are intended for internal reference. | |
| SalesReceipt_TxnStatus | String | False | False | False |
The current workflow or posting status of the recurring sales receipt. Depending on the transaction type, this field can display different enumerated values such as Paid, Partially Paid, or Pending. For sales transactions, the acceptable values are defined by the PaymentStatusEnum data type. For estimates, the acceptable values are defined by the QboEstimateStatusEnum data type. | |
| SalesReceipt_LinkedTxnAggregate | String | False | False | False |
An XML aggregate that is serialized into a single string representing all transactions that are linked to this recurring sales receipt. Each LinkedTxn element typically includes Id, Type, and optional sequence details to identify how this sales receipt is applied to other transactions. | |
| SalesReceipt_RecurDataRef | String | False | False | False |
The unique Id of the recurrence data record that governs how this recurring sales receipt is generated automatically. | |
| SalesReceipt_RecurDataRef_Name | String | True | False | False |
The descriptive name for the recurrence data record that is associated with this recurring sales receipt. | |
| SalesReceipt_RecurringInfo_Name | String | False | False | False |
The descriptive name of the recurring template or schedule that generates this recurring sales receipt. | |
| SalesReceipt_RecurringInfo_RecurType | String | False | False | False |
The recurrence pattern type (such as Scheduled, Unscheduled, or Reminder) that is associated with this recurring sales receipt. The allowed values are Automated, Reminded, UnScheduled. | |
| SalesReceipt_RecurringInfo_Active | Boolean | False | False | False |
Indicates whether the recurring sales-receipt schedule is currently active (true) or inactive (false). Inactive schedules do not generate new transactions. | |
| SalesReceipt_RecurringInfo_ScheduleInfo_IntervalType | String | False | False | False |
The unit of time that defines the recurrence interval for this recurring sales receipt (for example, such as Daily, Weekly, Monthly, or Yearly). The allowed values are Yearly, Monthly, Weekly, Daily. | |
| SalesReceipt_RecurringInfo_ScheduleInfo_NumInterval | Integer | False | False | False |
The numeric interval that determines how often this recurring sales receipt occurs, based on the interval type (for example, every 2 weeks). | |
| SalesReceipt_RecurringInfo_ScheduleInfo_DayOfWeek | String | False | False | False |
The day of the week on which this recurring sales receipt is scheduled to occur (for example, Monday or Friday). | |
| SalesReceipt_RecurringInfo_ScheduleInfo_WeekOfMonth | String | False | False | False |
The week of the month on which this recurring sales receipt is scheduled to occur (for example, First, Second, or Last). | |
| SalesReceipt_RecurringInfo_ScheduleInfo_MaxOccurrences | String | False | False | False |
The maximum number of recurring sales-receipt transactions that are generated under this schedule before it stops automatically. | |
| SalesReceipt_RecurringInfo_ScheduleInfo_RemindDays | String | False | False | False |
The number of days in advance of the scheduled start date when QuickBooks Online should send a reminder for a recurring sales receipt of type Reminder. | |
| SalesReceipt_RecurringInfo_ScheduleInfo_MonthOfYear | String | False | False | False |
The month of the year when the recurring sales receipt is scheduled to occur if using an annual recurrence (for example, January or July). | |
| SalesReceipt_RecurringInfo_ScheduleInfo_DaysBefore | String | False | False | False |
The number of days before the scheduled date that QuickBooks Online should create or notify about this recurring sales-receipt transaction. | |
| SalesReceipt_RecurringInfo_ScheduleInfo_DayOfMonth | String | False | False | False |
The calendar day of the month on which this recurring sales receipt is scheduled to occur (for example, 1, 15, or 30). | |
| SalesReceipt_RecurringInfo_ScheduleInfo_StartDate | Datetime | False | False | False |
The date and time stamp when the recurring sales-receipt schedule becomes effective in QuickBooks Online. | |
| SalesReceipt_RecurringInfo_ScheduleInfo_NextDate | Datetime | False | False | False |
The date and time stamp of the next scheduled occurrence of this recurring sales receipt. | |
| SalesReceipt_RecurringInfo_ScheduleInfo_EndDate | Datetime | False | False | False |
The date and time stamp when the recurring sales-receipt schedule ends and no further transactions are generated. | |
| SalesReceipt_RecurringInfo_ScheduleInfo_PreviousDate | Datetime | False | False | False |
The date and time stamp of the most recent occurrence of this recurring sales receipt under the recurrence schedule. | |
| SalesReceipt_LineAggregate | String | False | False | False |
An XML aggregate that is serialized into a single string representing all line items that are contained in this recurring sales receipt. Each line typically includes elements such as Line/Id, Line/LineNum, Line/Amount, Line/DetailType, and detail substructures (for example, SalesItemLineDetail or GroupLineDetail) that define the product, service, tax, and quantity that are linked to the transaction. | |
| SalesReceipt_TxnTaxDetail_TxnTaxCodeRef | String | False |
TaxCodes.Id | False | False |
The unique Id of the transaction-level tax code that is applied to this recurring sales receipt. |
| SalesReceipt_TxnTaxDetail_TotalTax | String | False | False | False |
The total amount of tax that is calculated for this recurring sales-receipt transaction, excluding any tax lines that are manually inserted into the line list. | |
| SalesReceipt_TxnTaxDetail_TaxLineAggregate | String | False | False | False |
An XML aggregate that is serialized into a single string representing all tax line items that QuickBooks Online calculates or applies to this recurring sales receipt. Each TaxLine element can include details such as TaxRateRef, PercentBased, NetAmountTaxable, and TaxAmount. | |
| SalesReceipt_CustomerRef | String | False |
Customers.Id | True | False |
The unique Id of the customer to whom this recurring sales receipt is issued. |
| SalesReceipt_CustomerRef_Name | String | True |
Customers.DisplayName | False | False |
The display name of the customer to whom this recurring sales receipt is issued. |
| SalesReceipt_CustomerMemo | String | False | False | False |
The free-form message that appears on the recurring sales receipt and is visible to the customer. | |
| SalesReceipt_BillAddr_Id | String | False | False | False |
The unique Id of the billing address record that is associated with this recurring sales receipt. This Id is system-assigned by the data service and is primarily used when modifying the billing address. | |
| SalesReceipt_BillAddr_Line1 | String | False | False | False |
The first line of the billing address for the customer on this recurring sales receipt, typically containing the street address or P.O. Box. | |
| SalesReceipt_BillAddr_Line2 | String | False | False | False |
The second line of the billing address for the customer on this recurring sales receipt, often used for suite numbers, building names, or additional address details. | |
| SalesReceipt_BillAddr_Line3 | String | False | False | False |
The third line of the billing address for the customer on this recurring sales receipt. This line is typically used for apartment, suite, or unit numbers, or other secondary address information. | |
| SalesReceipt_BillAddr_Line4 | String | False | False | False |
The fourth line of the billing address for the customer on this recurring sales receipt. This line provides additional flexibility for complex addresses, such as multiple building identifiers. | |
| SalesReceipt_BillAddr_Line5 | String | False | False | False |
The fifth line of the billing address for the customer on this recurring sales receipt. This field is rarely used but is available for extended address details if required. | |
| SalesReceipt_BillAddr_City | String | False | False | False |
The city name of the billing address for the customer on this recurring sales receipt. | |
| SalesReceipt_BillAddr_Country | String | False | False | False |
The country name of the billing address for the customer on this recurring sales receipt. | |
| SalesReceipt_BillAddr_CountrySubDivisionCode | String | False | False | False |
The region within a country for the billing address. For example, this value is the state name for the USA and the province name for Canada. | |
| SalesReceipt_BillAddr_PostalCode | String | False | False | False |
The postal code of the billing address. For example, this value is the ZIP code for the USA and the postal code for Canada. | |
| SalesReceipt_BillAddr_Note | String | False | False | False |
An optional note that is associated with the billing address for the customer. This note is typically used for delivery instructions or additional customer-specific address details. | |
| SalesReceipt_BillAddr_Lat | String | False | False | False |
The latitude coordinate of the geocoded billing address. This value is automatically generated by the QuickBooks Online geocoding service if geolocation is enabled. | |
| SalesReceipt_BillAddr_Long | String | False | False | False |
The longitude coordinate of the geocoded billing address. This value is automatically generated by the QuickBooks Online geocoding service if geolocation is enabled. | |
| SalesReceipt_ShipAddr_Id | String | False | False | False |
The unique Id of the shipping address entity that is associated with this recurring sales receipt. This Id is system-assigned by the data service and is primarily used when modifying the shipping address. | |
| SalesReceipt_ShipAddr_Line1 | String | False | False | False |
The first line of the shipping address for the customer on this recurring sales receipt, typically containing the street address or P.O. Box. | |
| SalesReceipt_ShipAddr_Line2 | String | False | False | False |
The second line of the shipping address for the customer on this recurring sales receipt, often used for suite numbers, building names, or additional address details. | |
| SalesReceipt_ShipAddr_Line3 | String | False | False | False |
The third line of the shipping address for the customer on this recurring sales receipt. This line is often used for apartment, floor, or complex information. | |
| SalesReceipt_ShipAddr_Line4 | String | False | False | False |
The fourth line of the shipping address for the customer on this recurring sales receipt. This line provides additional flexibility for multi-part addresses. | |
| SalesReceipt_ShipAddr_Line5 | String | False | False | False |
The fifth line of the shipping address for the customer on this recurring sales receipt. This field is rarely used but allows entry of extended address details if needed. | |
| SalesReceipt_ShipAddr_City | String | False | False | False |
The city name of the shipping address for the customer on this recurring sales receipt. | |
| SalesReceipt_ShipAddr_Country | String | False | False | False |
The country name of the shipping address for the customer on this recurring sales receipt. | |
| SalesReceipt_ShipAddr_CountrySubDivisionCode | String | False | False | False |
The region within a country for the shipping address. For example, this value is the state name for the USA and the province name for Canada. | |
| SalesReceipt_ShipAddr_PostalCode | String | False | False | False |
The postal code of the shipping address. For example, this value is the ZIP code for the USA and the postal code for Canada. | |
| SalesReceipt_ShipAddr_Note | String | False | False | False |
An optional note that is associated with the shipping address for the customer. This note is typically used for delivery instructions, access codes, or other customer-specific details. | |
| SalesReceipt_ShipAddr_Lat | String | False | False | False |
The latitude coordinate of the geocoded shipping address. This value is automatically generated by the QuickBooks Online geocoding service if geolocation is enabled. | |
| SalesReceipt_ShipAddr_Long | String | False | False | False |
The longitude coordinate of the geocoded shipping address. This value is automatically generated by the QuickBooks Online geocoding service if geolocation is enabled. | |
| SalesReceipt_ClassRef | String | False |
Class.Id | True | False |
The unique Id of the class that is associated with this recurring sales receipt. Classes allow businesses to track income and expenses by category such as department, product line, or business unit. |
| SalesReceipt_ClassRef_Name | String | True |
Class.FullyQualifiedName | False | False |
The display name of the class that is associated with this recurring sales receipt. |
| SalesReceipt_ShipMethodRef | String | False | False | False |
The unique Id of the shipping method that is associated with this recurring sales receipt. For example, this Id can represent UPS, FedEx, or USPS. | |
| SalesReceipt_ShipMethodRef_Name | String | True | False | False |
The display name of the shipping method that is associated with this recurring sales receipt. | |
| SalesReceipt_ShipDate | Date | False | False | False |
The scheduled date for delivery of goods or services associated with this recurring sales receipt. | |
| SalesReceipt_TrackingNum | String | False | False | False |
The tracking number that is provided by the shipping carrier for the delivery of goods associated with this recurring sales receipt. This value allows businesses and customers to monitor shipment progress. | |
| SalesReceipt_TotalAmt | Decimal | False | True | False |
The total monetary amount of the recurring sales-receipt transaction. This total includes all charges, allowances, discounts, and taxes. By default, QuickBooks Online recalculates this amount based on the total of all line items. This field is calculated by QuickBooks Online business logic and cannot be written to directly. | |
| SalesReceipt_PrintStatus | String | False | False | False |
Indicates the print status of the recurring sales receipt. This status helps identify whether the receipt has been printed, is marked as 'to be printed,' or has not been scheduled for printing. Businesses often use this field to manage outstanding receipts that need to be physically delivered or archived. The allowed values are NotSet, NeedToPrint, PrintComplete. The default value is NotSet. | |
| SalesReceipt_EmailStatus | String | False | False | False |
Indicates the email delivery status of the recurring sales receipt. This field reflects whether the sales receipt has been sent, is scheduled to be sent, or remains unsent. Monitoring this status helps ensure that customers receive electronic copies in a timely manner. The allowed values are NotSet, NeedToSend, EmailSent. The default value is NotSet. | |
| SalesReceipt_BillEmail_Address | String | False | False | False |
The email address where the sales receipt is sent when electronic delivery is enabled. This field is required if the EmailStatus field has a value of 'NeedToSend.' It ensures that QuickBooks Online knows the intended recipient of the digital copy. | |
| SalesReceipt_Balance | Decimal | True | True | True |
The outstanding balance remaining on the recurring sales receipt after any payments or credits are applied. This value provides a real-time view of what is still owed by the customer. | |
| SalesReceipt_PaymentRefNum | String | False | False | False |
The reference number for the payment that is associated with the recurring sales receipt. This value typically corresponds to a check number, electronic payment confirmation, or other payment tracking identifier provided by the customer. | |
| SalesReceipt_PaymentMethodRef | String | False | False | False |
The unique Id of the payment method that is used for the transaction. Examples include cash, check, credit card, or electronic funds transfer. QuickBooks Online uses this Id internally to link the receipt to the defined payment method. | |
| SalesReceipt_PaymentMethodRef_Name | String | True |
PaymentMethods.Name | False | False |
The display name of the payment method that is used for the recurring sales receipt. This field allows users to view the method of payment in a readable format, such as 'Visa,' 'Cash,' or 'Bank Transfer.' |
| SalesReceipt_DepositToAccountRef | String | False |
Accounts.Id | False | False |
The unique Id of the asset account where the payment from the recurring sales receipt is deposited. If this field is not specified, QuickBooks Online defaults to using the Undeposited Funds account to hold payments temporarily until they are moved to a designated bank account. |
| SalesReceipt_DepositToAccountRef_Name | String | True |
Accounts.Name | False | False |
The display name of the asset account where the payment from the recurring sales receipt is deposited. If this field is not specified, QuickBooks Online defaults to the Undeposited Funds account. This field allows users to easily see which account the funds are routed to. |
| SalesReceipt_ApplyTaxAfterDiscount | Boolean | False | False | False |
Specifies whether discounts are applied before or after tax calculation for the recurring sales receipt. A value of true indicates that discounts are applied first and then tax is calculated. A value of false means that tax is calculated on the full amount before discounts are deducted. | |
| SalesReceipt_CurrencyRef | String | False | False | False |
The unique Id of the currency that is used for the recurring sales-receipt transaction. This field is necessary in multi-currency environments to specify which currency the receipt is denominated in. | |
| SalesReceipt_CurrencyRef_Name | String | True | False | False |
The display name of the currency used for the recurring sales receipt transaction. Examples include 'US Dollar,' 'Canadian Dollar,' or 'British Pound.' | |
| SalesReceipt_ExchangeRate | Decimal | False | False | False |
The currency exchange rate that is applied when the recurring sales receipt involves a currency other than the company's home currency. Exchange rates in QuickBooks Online are always expressed as the number of home currency units required to equal one foreign currency unit. This field is valid only when the company file is enabled for multi-currency and is available in the UK, AU, and CA editions. | |
| SalesReceipt_GlobalTaxCalculation | String | False | False | False |
Specifies the method by which tax is calculated for the recurring sales receipt. This field is used to configure whether tax is applied on a transaction-wide basis or at the line-item level. This field is valid in the UK, AU, and CA editions. The allowed values are TaxExcluded, TaxInclusive, NotApplicable. | |
| SalesReceipt_HomeTotalAmt | Decimal | False | False | False |
The total amount of the recurring sales-receipt transaction expressed in the company's home currency. This field ensures that businesses using multiple currencies can maintain consistent reporting in their base currency. It is valid in the UK, AU, and CA editions. |