ReceivePayments

Manages QuickBooks Receive Payment transactions, supporting creation, updates, deletion, and queries for customer payments. 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 ReceivePayments WHERE TimeModified > '1/1/2011' AND TimeModified < '2/1/2011' AND ReferenceNumber LIKE '%12345%'

Insert

To add a ReceivePayment, specify the Customer and Amount. The AppliedToAggregate column may be used to specify an XML aggregate of AppliedTo data. In a Receive Payment, each AppliedTo aggregate represents the transaction to which this part of the payment is being applied. The columns that may be used in these aggregates are defined in the ReceivePaymentsAppliedTo table and it starts with AppliedTo. To use the ApplyToAggregate column, set the AutoApply pseudo column to Custom. For example, the following will insert a new ReceivePayment with two AppliedTo entries:

INSERT INTO ReceivePayments (CustomerName, Amount, AutoApply, AppliedToAggregate) 
VALUES ('Cook, Brian', '300.00', 'Custom', 
'<ReceivePaymentsAppliedTo>
<Row><AppliedToRefId>178C1-1450221347</AppliedToRefId><AppliedToPaymentAmount>200.00</AppliedToPaymentAmount></Row>
<Row><AppliedToRefId>881-933371709</AppliedToRefId><AppliedToPaymentAmount>100.00</AppliedToPaymentAmount></Row>
</ReceivePaymentsAppliedTo>')

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 ReceivePayments (CustomerName, Amount, AutoApply) VALUES ('Cook, Brian', '300.00', 'ExistingTransactions')

To insert subitems, set the ItemName field to the FullName of the item; for example, '<Row><ItemName>Subs:Carpet</ItemName><ItemQuantity>0</ItemQuantity></Row>'

Columns


Name	Type	ReadOnly	References	ColumnSize	Description
ID [KEY]	String	True		255	A unique identifier for the transaction, used to distinguish it in the system.
ReferenceNumber	String	False		21	The reference number assigned to the transaction for identification purposes, such as a check or invoice number.
TxnNumber	Integer	True			An identifying number for the transaction that differs from the Quickbooks generated ID, often used for internal tracking.
Date	Date	False			The date when the payment transaction occurred, essential for recording and reconciliation.
UnusedPayment	Decimal	True			The portion of the payment amount that has not been applied to outstanding invoices or transactions.
Amount	Decimal	False			The total payment amount received from the customer in this transaction.
AccountsReceivableName	String	False		1000	The name of the accounts-receivable account where this payment is recorded, such as 'Accounts Receivable'.
AccountsReceivableId	String	False	Accounts.ID	255	The unique QuickBooks ID of the accounts-receivable account where this payment is recorded.
CustomerName	String	False		1000	The name of the customer making the payment. This is required if CustomerId is not specified during insertion.
CustomerId	String	False	Customers.ID	255	The unique QuickBooks ID of the customer making the payment. This is required if CustomerName is not specified during insertion.
DepositToAccountName	String	False		1000	The name of the account where this payment will be deposited, such as 'Checking Account'.
DepositToAccountId	String	False	Accounts.ID	255	The QuickBooks ID of the account where this payment will be deposited.
PaymentMethodName	String	False		100	The name of the payment method used, such as 'Credit Card', 'Cash', or 'Check'.
PaymentMethodId	String	False	PaymentMethods.ID	255	The QuickBooks ID of the payment method used for this transaction.
Memo	String	False		5000	A memo or note associated with the transaction, typically used for internal documentation or reporting.
ExchangeRate	Double	False			The exchange rate applied to convert the payment amount from a foreign currency to the home currency.
TotalAmountInHomeCurrency	Decimal	False			The payment amount converted to the home currency after applying the exchange rate.
AppliedToAggregate	String	False		5000	An aggregated representation of all the applied-to data for this payment, useful for linking it to specific invoices or transactions.
CustomFields	String	False			Any custom fields associated with the payment, formatted as XML and returned by QuickBooks.
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 initially 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.

Name

Type

Description

AutoApply

String

Specifies whether the payment should be automatically applied to outstanding invoices or handled manually.

使用できる値は次のとおりです。ExistingTransactions, FutureTransactions, Custom