RecurringRefundReceiptTransactions

Stores recurring templates for customer refund receipts, enabling businesses to automate returning funds to customers on a scheduled basis.

Columns


Name	Type	ReadOnly	References	Filterable	Sortable	Description
RefundReceipt_Id [KEY]	String	True		True	True	The identifier (Id) of the recurringrefund-receipt transaction. This uniquely identifies the refund receipt record within QuickBooks Online.
RefundReceipt_SyncToken	String	True		False	False	The version number of the object that is used to lock the recurring refund-receipt transaction for use by one application at a time. As soon as an application modifies an object, its sync token is incremented. Attempts to modify an object specifying an older sync token fail. Only the latest version of the object is maintained by QuickBooks Online.
RefundReceipt_MetaData_CreateTime	Datetime	True		True	True	The date and time when the recurring refund-receipt record was created in QuickBooks Online.
RefundReceipt_MetaData_LastUpdatedTime	Datetime	True		True	True	The date and time when the recurring refund-receipt record was last updated in QuickBooks Online.
RefundReceipt_CustomFieldAggregate	String	False		False	False	An XML aggregate containing all custom fields that are associated with the recurring refund-receipt transaction. This collection enables storage of additional user-defined information beyond standard fields.
RefundReceipt_DocNumber	String	False		True	True	The reference number that is assigned to the recurring refund-receipt transaction for tracking and reconciliation purposes.
RefundReceipt_TxnDate	Date	False		True	True	The date that is entered by the user when this recurring refund-receipt transaction occurred. This date represents the transaction date used for accounting and reporting.
RefundReceipt_PrivateNote	String	False		False	False	A private note for the recurring refund-receipt transaction that does not appear on transaction records by default.
RefundReceipt_DepartmentRef	String	False	Departments.Id	False	False	The unique Id of the department or location that is associated with the recurring refund-receipt transaction as defined by using location tracking in QuickBooks Online.
RefundReceipt_DepartmentRef_Name	String	True	Departments.Name	False	False	The name of the department or location that is associated with the recurring refund-receipt transaction as defined by using location tracking in QuickBooks Online.
RefundReceipt_TxnStatus	String	False		False	False	Indicates the current status of the recurring refund-receipt transaction. Depending on the transaction type, this field can have different values. For sales transactions, the acceptable values are defined in by the PaymentStatusEnum data type. For estimates, the accepted values are defined by the QboEstimateStatusEnum data type.
RefundReceipt_LinkedTxnAggregate	String	False		False	False	An XML aggregate of zero or more linked transactions that are associated with the recurring refund receipt.
RefundReceipt_RecurDataRef	String	False		False	False	The unique Id of the recurrence data reference that identifies the recurring refund receipt template or schedule.
RefundReceipt_RecurDataRef_Name	String	True		False	False	The name of the recurrence data reference that identifies the recurring refund receipt template or schedule.
RefundReceipt_RecurringInfo_Name	String	False		False	False	The descriptive name of the recurring refund-receipt schedule or template.
RefundReceipt_RecurringInfo_RecurType	String	False		False	False	The recurring type of the refund receipt schedule, such as scheduled, reminder, or unscheduled. The allowed values are Automated, Reminded, UnScheduled.
RefundReceipt_RecurringInfo_Active	Boolean	False		False	False	Indicates whether the recurring refund-receipt schedule is currently active or inactive.
RefundReceipt_RecurringInfo_ScheduleInfo_IntervalType	String	False		False	False	Defines how often the recurring refund-receipt transaction occurs (for example, weekly, monthly, or yearly). The allowed values are Yearly, Monthly, Weekly, Daily.
RefundReceipt_RecurringInfo_ScheduleInfo_NumInterval	Integer	False		False	False	Specifies the number of intervals for the recurring refund-receipt schedule. This value determines how frequently the transaction recurs based on the interval type.
RefundReceipt_RecurringInfo_ScheduleInfo_DayOfWeek	String	False		False	False	The day of the week on which the recurring refund-receipt transaction is scheduled to occur when the interval type is weekly.
RefundReceipt_RecurringInfo_ScheduleInfo_WeekOfMonth	String	False		False	False	The week of the month on which the recurring refund-receipt transaction is scheduled to occur when the interval type is monthly.
RefundReceipt_RecurringInfo_ScheduleInfo_MaxOccurrences	String	False		False	False	The maximum number of occurrences that is allowed for the recurring refund-receipt schedule.
RefundReceipt_RecurringInfo_ScheduleInfo_RemindDays	String	False		False	False	The number of days before the start date on which a reminder for the recurring refund receipt should be sent.
RefundReceipt_RecurringInfo_ScheduleInfo_MonthOfYear	String	False		False	False	The month of the year on which the recurring refund-receipt transaction is scheduled to occur when the interval type is yearly.
RefundReceipt_RecurringInfo_ScheduleInfo_DaysBefore	String	False		False	False	The number of days before the scheduled date on which the recurring refund receipt is processed or triggered.
RefundReceipt_RecurringInfo_ScheduleInfo_DayOfMonth	String	False		False	False	The day of the month on which the recurring refund-receipt transaction is scheduled to occur.
RefundReceipt_RecurringInfo_ScheduleInfo_StartDate	Datetime	False		False	False	The start date of the recurring refund-receipt schedule that is associated with the recurrence template.
RefundReceipt_RecurringInfo_ScheduleInfo_NextDate	Datetime	False		False	False	The next scheduled date for the recurring refund-receipt transaction to occur.
RefundReceipt_RecurringInfo_ScheduleInfo_EndDate	Datetime	False		False	False	The end date of the recurring refund-receipt schedule when no further occurrences are generated.
RefundReceipt_RecurringInfo_ScheduleInfo_PreviousDate	Datetime	False		False	False	The date on which the previous occurrence of the recurring refund-receipt transaction was processed. This value is helpful for tracking the transaction history of the schedule.
RefundReceipt_LineAggregate	String	False		False	False	An XML aggregate containing all line items included in the refund-receipt transaction. This collection provides a detailed breakdown of each item or service refunded within the transaction.
RefundReceipt_TxnTaxDetail_TxnTaxCodeRef	String	False	TaxCodes.Id	False	False	The unique tax code that is applied to the refund-receipt transaction. This code determines how taxes are calculated and reported for the refund.
RefundReceipt_TxnTaxDetail_TotalTax	String	False		False	False	The total tax amount that is calculated for the refund-receipt transaction, excluding any tax lines that are manually inserted into the transaction line list. This field shows the summed tax liability that is associated with the refund.
RefundReceipt_TxnTaxDetail_TaxLineAggregate	String	False		False	False	An XML aggregate containing all tax line items that are associated with the refund-receipt transaction. Each entry shows how individual tax components contribute to the total tax for the refund.
RefundReceipt_CustomerRef	String	False	Customers.Id	True	False	The Id of the customer who is receiving the refund. This Id links the refund receipt to the corresponding customer record in QuickBooks Online.
RefundReceipt_CustomerRef_Name	String	True	Customers.DisplayName	False	False	The name of the customer who is receiving the refund. This name provides a human-readable reference alongside the customer Id.
RefundReceipt_CustomerMemo	String	False		False	False	The message to the customer that appears on the refund receipt and in the printed document. This message can include notes, acknowledgements, or instructions.
RefundReceipt_BillAddr_Id	String	False		False	False	The Id of the billing address entity that is associated with the refund receipt. This Id is mainly used for modifying or verifying the address record in QuickBooks Online.
RefundReceipt_BillAddr_Line1	String	False		False	False	The first line of the customer's billing address for the refund receipt.
RefundReceipt_BillAddr_Line2	String	False		False	False	The second line of the customer's billing address for the refund receipt.
RefundReceipt_BillAddr_Line3	String	False		False	False	The third line of the customer's billing address for the refund receipt.
RefundReceipt_BillAddr_Line4	String	False		False	False	The fourth line of the customer's billing address for the refund receipt.
RefundReceipt_BillAddr_Line5	String	False		False	False	The fifth line of the customer's billing address for the refund receipt.
RefundReceipt_BillAddr_City	String	False		False	False	The city portion of the customer's billing address for the refund receipt.
RefundReceipt_BillAddr_Country	String	False		False	False	The country portion of the customer's billing address for the refund receipt.
RefundReceipt_BillAddr_CountrySubDivisionCode	String	False		False	False	The region within the customer's country for the billing address, such as the state for the USA or the province for Canada.
RefundReceipt_BillAddr_PostalCode	String	False		False	False	The postal code for the customer's billing address. For example, this value is the ZIP code for the USA and the postal code for Canada.
RefundReceipt_BillAddr_Note	String	False		False	False	A note about the customer's billing address that is associated with the refund receipt.
RefundReceipt_BillAddr_Lat	String	False		False	False	The latitude coordinate of the geocoded billing address that is associated with the refund receipt.
RefundReceipt_BillAddr_Long	String	False		False	False	The longitude coordinate of the geocoded billing address that is associated with the refund receipt.
RefundReceipt_ShipAddr_Id	String	False		False	False	The Id of the shipping address entity that is associated with the refund receipt. ThisId is used mainly for modifying or verifying the address record in QuickBooks Online.
RefundReceipt_ShipAddr_Line1	String	False		False	False	The first line of the shipping address for the refund receipt.
RefundReceipt_ShipAddr_Line2	String	False		False	False	The second line of the shipping address for the refund receipt.
RefundReceipt_ShipAddr_Line3	String	False		False	False	The third line of the shipping address for the refund receipt.
RefundReceipt_ShipAddr_Line4	String	False		False	False	The fourth line of the shipping address for the refund receipt.
RefundReceipt_ShipAddr_Line5	String	False		False	False	The fifth line of the shipping address for the refund receipt.
RefundReceipt_ShipAddr_City	String	False		False	False	The city portion of the shipping address for the refund receipt.
RefundReceipt_ShipAddr_Country	String	False		False	False	The country portion of the shipping address for the refund receipt.
RefundReceipt_ShipAddr_CountrySubDivisionCode	String	False		False	False	The region within the shipping address country, such as the state for the USA or the province for Canada.
RefundReceipt_ShipAddr_PostalCode	String	False		False	False	The postal code for the shipping address. For example, this value is the ZIP code for the USA and the postal code for Canada.
RefundReceipt_ShipAddr_Note	String	False		False	False	A note about the shipping address that is associated with the refund receipt.
RefundReceipt_ShipAddr_Lat	String	False		False	False	The latitude coordinate of the geocoded shipping address that is associated with the refund receipt.
RefundReceipt_ShipAddr_Long	String	False		False	False	The longitude coordinate of the geocoded shipping address that is associated with the refund receipt.
RefundReceipt_ClassRef	String	False	Class.Id	False	False	The Id of the class that is associated with the refund-receipt transaction. This Id supports class-based tracking for reporting purposes.
RefundReceipt_ClassRef_Name	String	True	Class.FullyQualifiedName	False	False	The name of the class associated with the refund-receipt transaction.
RefundReceipt_CheckPayment_CheckNum	String	True		False	False	The check number that is printed on the check used for the refund payment.
RefundReceipt_CheckPayment_Status	String	False		False	False	The status of the check that is used for the refund payment. Values are determined by QuickBooks service or business logic.
RefundReceipt_CheckPayment_NameOnAccount	String	False		False	False	The name of the person or entity holding the account, as printed on the check that is used for the refund.
RefundReceipt_CheckPayment_AcctNum	String	False		False	False	The checking-account number from which the refund payment was drawn, as printed on the check.
RefundReceipt_CheckPayment_BankName	String	True		False	False	The name of the bank on which the refund check was drawn.
RefundReceipt_CreditCardPayment_CreditChargeInfo_Type	String	False		False	False	The type of credit card that is used for the refund payment (such as Visa or MasterCard).
RefundReceipt_CreditCardPayment_CreditChargeInfo_NameOnAcct	String	False		False	False	The name of the account holder, as printed on the credit card that is used for the refund.
RefundReceipt_CreditCardPayment_CreditChargeInfo_CcExpiryMonth	Integer	False		False	False	The expiration month of the credit card that is used for the refund.
RefundReceipt_CreditCardPayment_CreditChargeInfo_CcExpiryYear	Integer	False		False	False	The four-digit expiration year of the credit card that is used for the refund.
RefundReceipt_CreditCardPayment_CreditChargeInfo_BillAddrStreet	String	False		False	False	The street portion of the billing address for the credit card that is used for the refund.
RefundReceipt_CreditCardPayment_CreditChargeInfo_PostalCode	String	False		False	False	The postal code of the billing address for the credit card that is used for the refund.
RefundReceipt_CreditCardPayment_CreditChargeInfo_Amount	Decimal	False		False	False	The total amount that is processed, using the credit card for the refund payment.
RefundReceipt_CreditCardPayment_CreditChargeInfo_ProcessPayment	Boolean	False		False	False	Indicates whether to store only the credit-card information (false) or to store the credit-card payment transaction information in the CreditChargeResponse attribute (true).
RefundReceipt_CreditCardPayment_CreditChargeResponse_CCTransId	String	False		False	False	The unique Id of the credit-card payment transaction that is associated with the refund receipt.
RefundReceipt_CreditCardPayment_CreditChargeResponse_AuthCode	String	False		False	False	The authorization code that is returned by the credit-card processor, indicating that the refund charge was approved by the card issuer.
RefundReceipt_CreditCardPayment_CreditChargeResponse_TxnAuthorizationTime	Datetime	False		False	False	The timestamp indicating when the credit-card processor authorized the refund transaction.
RefundReceipt_CreditCardPayment_CreditChargeResponse_Status	String	False		False	False	The status of the credit-card refund transaction. Possible values include Completed or Unknown.
RefundReceipt_SalesTermRef	String	False	Terms.Id	False	False	The Id of the sales term that is that is associated with the refund-receipt transaction.
RefundReceipt_SalesTermRef_Name	String	True	Terms.Name	False	False	The name of the sales term that is associated with the refund-receipt transaction.
RefundReceipt_DueDate	Date	False		True	False	The date by which the refunded invoice was originally due to be paid, excluding any early-payment discounts or late-payment penalties. If the date is not supplied, the current server date is used.
RefundReceipt_ShipMethodRef	String	False		False	False	The Id of the shipping method that is associated with the refund-receipt transaction.
RefundReceipt_ShipMethodRef_Name	String	True		False	False	The name of the shipping method that is associated with the refund-receipt transaction.
RefundReceipt_ShipDate	Date	False		False	False	The date on which the goods or services for which a refund was issued were scheduled for delivery.
RefundReceipt_TotalAmt	Decimal	True		True	True	The total amount of the refund-receipt transaction. This amount includes the combined value of all charges, allowances, taxes, and any applicable adjustments, giving the full monetary impact of the refund.
RefundReceipt_ApplyTaxAfterDiscount	Boolean	False		False	False	Sets whether any discounts are applied before taxes are calculated for the refund-receipt transaction. This flag determines the order of operations for tax computation.
RefundReceipt_PrintStatus	String	False		False	False	Indicates the current print status of the refund receipt (for example, NotSet, NeedToPrint, or Printed) so you can see whether the document still needs to be printed or re-printed. The allowed values are NotSet, NeedToPrint, PrintComplete.
RefundReceipt_BillEmail_Address	String	False		False	False	The email address where the refund receipt is sent to the customer. If the the EmailStatus attribute value is NeedToSend, the billing email address is required.
RefundReceipt_Balance	Decimal	False		False	False	Shows whether the refund-receipt transaction has an outstanding balance. This field can be used to identify whether the refund fully offsets the original charge or leaves a remaining credit/charge.
RefundReceipt_PaymentMethodRef	String	False	PaymentMethods.Id	False	False	The Id of the payment method that is used for the refund transaction (such as Check, CreditCard, or Cash).
RefundReceipt_PaymentMethodRef_Name	String	True	PaymentMethods.Name	False	False	The name of the payment method used for the refund transaction. This gives a human-readable version of the payment method payment-method reference.
RefundReceipt_PaymentRefNum	String	False		False	False	The reference number for the payment instrument or transaction that is associated with the refund (such as the check number, EFT reference, or credit card transaction ID).
RefundReceipt_PaymentType	String	False		False	False	Specifies the type of payment that is used to issue the refund, such as Check, CreditCard, or Cash. The allowed values are Cash, Check, CreditCard, Other.
RefundReceipt_DepositToAccountRef	String	False	Accounts.Id	False	False	The Id)of the asset account where the refund money is deposited. If this account is not specified, QuickBooks Online uses the Undeposited Funds account by default.
RefundReceipt_DepositToAccountRef_Name	String	True	Accounts.Name	False	False	The name of the asset account where the refund money is deposited. If not specified, QuickBooks Online uses the Undeposited Funds account by default.
RefundReceipt_CurrencyRef	String	False		False	False	The Id of the currency that is used in the refund-receipt transaction. This Id links the refund to the correct currency in multicurrency companies.
RefundReceipt_CurrencyRef_Name	String	True		False	False	The name of the currency that is used in the refund-receipt transaction, providing a human-readable currency label alongside the Id.
RefundReceipt_ExchangeRate	Decimal	False		False	False	The currency exchange rate that is applied to the refund-receipt transaction. This field is valid only when the company file is set up to use the multicurrency feature. In QuickBooks, exchange rates are always recorded as the number of home currency units it takes to equal one foreign currency unit. This field is available in the UK, AU, and CA editions.
RefundReceipt_GlobalTaxCalculation	String	False		False	False	Specifies the method in which tax is applied to the refund-receipt transaction. This field is valid in the UK, AU, and CA editions. The allowed values are TaxExcluded, TaxInclusive, NotApplicable.
RefundReceipt_HomeTotalAmt	Decimal	True		False	False	The total amount of the refund-receipt transaction expressed in the home currency. This amount includes the total of all charges, allowances, and taxes, and is valid in the UK, AU, and CA editions.

CData Python Connector for QuickBooks Online

RecurringRefundReceiptTransactions

Columns