ReceivePaymentsAppliedTo

Tracks individual transactions to which a QuickBooks Receive Payment is applied, supporting creation, updates, and queries. In a Receive Payment, each AppliedTo aggregate represents the transaction to which this part of the payment is being applied. Requires QBXML Version 6.0 or higher.

Table Specific Information

ReceivePayments may be inserted, queried, or updated via the ReceivePayments or ReceivePaymentsAppliedTo tables. ReceivePayments may be deleted by using the ReceivePayments table.

This table has a Custom Fields column. See the Custom Fields page for more information.

Select

By default, SupportEnhancedSQL is set to true, and the following will be honored if present. Other filters will be executed client side. If SupportEnhancedSQL is set to false, only the following filters will be honored.

QuickBooks allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only the equals or = comparison. The available columns for ReceivePayments are Id, Date, TimeModified, ReferenceNumber, CustomerName, CustomerId, DepositToAccountName, and DepositToAccountId. TimeModified and Date may be used with the >, >=, <, <=, or = conditions and may be used twice to specify a range. ReferenceNumber may be used with the = or LIKE conditions to establish a starts-with, ends-with, or contains syntax. For example:

SELECT * FROM ReceivePaymentsAppliedTo WHERE TimeModified > '1/1/2011' AND TimeModified < '2/1/2011' AND ReferenceNumber LIKE '%12345%'

Insert

To add a ReceivePayment, specify the Customer and the Amount. All AppliedTo columns can be used to explicitly identify the transactions the payment is applied to. An AppliedTo entry must at the minimum specify the AppliedToRefId and AppliedToPaymentAmount. Optionally, the INSERT may specify the AutoApply behavior.

For example, the following will insert a new ReceivePayment with two AppliedTo entries:

INSERT INTO ReceivePaymentsAppliedTo#TEMP (CustomerName, AppliedToAmount, AutoApply, AppliedToRefId, AppliedToPaymentAmount) VALUES ('Cook, Brian', '300.00', 'Custom', '178C1-1450221347', '200.00')
INSERT INTO ReceivePaymentsAppliedTo#TEMP (CustomerName, AppliedToAmount, AutoApply, AppliedToRefId, AppliedToPaymentAmount) VALUES ('Cook, Brian', '300.00', 'Custom', '881-933371709', '100.00')
INSERT INTO ReceivePaymentsAppliedTo (CustomerName, AppliedToAmount, AutoApply, AppliedToRefId, AppliedToPaymentAmount) SELECT CustomerName, AppliedToAmount, AutoApply, AppliedToRefId, AppliedToPaymentAmount FROM ReceivePaymentsAppliedTo#TEMP

If you would like to insert a ReceivePayment and let QuickBooks automatically determine which transaction to apply it to, you can use the AutoApply pseudo column to apply the transaction to an existing transaction. For example:

INSERT INTO ReceivePaymentsAppliedTo (CustomerName, Amount, AutoApply) VALUES ('Cook, Brian', '300.00', 'ExistingTransactions')

Columns


Name	Type	ReadOnly	References	ColumnSize	Description
ID [KEY]	String	True		255	A unique identifier formatted as ReceivePaymentId\|AppliedToRefId, used to track specific applications of payments.
ReceivePaymentId	String	False	ReceivePayments.ID	255	The unique identifier of the bill-payment transaction to which this payment is associated.
ReferenceNumber	String	False		21	The transaction reference number used for identification. Supports flexible search options such as starts with, ends with, or contains, as well as range searches.
TxnNumber	Integer	True			An identifying number for the transaction, distinct from the Quickbooks generated Id, useful for tracking and reconciliation.
Date	Date	False			The date when the payment transaction occurred, relevant for accounting and audit purposes.
UnusedPayment	Decimal	True			The portion of the payment amount that has not been applied to existing invoices or transactions.
Amount	Decimal	False			The total amount received from the customer in this payment transaction.
AccountsReceivableName	String	False		1000	The name of the accounts-receivable account where the payment is recorded (for example, 'Accounts Receivable').
AccountsReceivableId	String	False	Accounts.ID	255	The unique QuickBooks ID of the accounts-receivable account used to record the payment.
CustomerName	String	False		1000	The full name of the customer making the payment. Required if CustomerId is not specified during insertion.
CustomerId	String	False	Customers.ID	255	The unique QuickBooks ID of the customer making the payment. Required if CustomerName is not specified during insertion.
DepositToAccountName	String	False		1000	The name of the account where the payment should be deposited, such as 'Checking Account'.
DepositToAccountId	String	False	Accounts.ID	255	The unique QuickBooks ID of the deposit account where the payment is recorded.
PaymentMethodName	String	False		100	The name of the payment method used for this transaction, such as 'Credit Card' or 'Check'.
PaymentMethodId	String	False	PaymentMethods.ID	255	The QuickBooks ID of the payment method used for the transaction.
Memo	String	False		5000	An optional memo to provide additional context about this payment, often used for internal notes or reports.
ExchangeRate	Double	False			The exchange rate applied to convert the payment currency into the home currency for reporting purposes.
TotalAmountInHomeCurrency	Decimal	False			The total payment amount converted to the company's home currency after applying the exchange rate.
AutoApply	String	False		20	Indicates how the payment is applied to transactions, such as automatically applying it to the oldest outstanding invoice. The allowed values are ExistingTransactions, FutureTransactions, Custom. The default value is ExistingTransactions.
CustomFields	String	False			Any custom fields associated with the payment, formatted as XML and returned by QuickBooks.
AppliedToRefId	String	False		255	The reference ID of the transaction (such as an invoice or journal entry) to which the payment is applied.
AppliedToAmount	Decimal	True			The amount of the payment that is applied to the specified transaction.
AppliedToBalanceRemaining	Double	True			The remaining balance for the specified transaction after applying the payment.
AppliedToCreditAppliedAmount	Decimal	False			The portion of a credit applied to the transaction as part of the payment.
AppliedToCreditMemoId	String	False	CreditMemos.ID	255	The unique ID of a credit memo applied to the transaction.
AppliedToDiscountAccountName	String	False		1000	The name of the account where any discounts applied to the transaction are recorded.
AppliedToDiscountAccountId	String	False	Accounts.ID	255	The QuickBooks ID of the account where discounts applied to the transaction are recorded.
AppliedToDiscountAmount	Decimal	False			The amount of the discount applied to the transaction as part of the payment.
AppliedToPaymentAmount	Decimal	False			The portion of the payment amount directly applied to the transaction.
AppliedToReferenceNumber	String	True		21	The reference number of the transaction to which the payment is applied, for example, an invoice number.
AppliedToTxnDate	Date	True			The date of the transaction that the payment is applied to, useful for audit and tracking.
AppliedToTxnType	String	True		100	The type of transaction to which the payment is applied, such as 'Invoice' or 'Credit Memo'.
TimeModified	Datetime	True			The date and time when the payment record was last modified in QuickBooks.
TimeCreated	Datetime	True			The date and time when the payment record was created in QuickBooks.

Pseudo-Columns

Pseudo Column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.