Excel Add-In for QuickBooks

Build 21.0.7930

ReceivePaymentsAppliedTo

Create, update, and query QuickBooks Receive Payment AppliedTo aggregates. In a Receive Payment, each AppliedTo aggregate represents the transaction to which this part of the payment is being applied. QBXMLVersion must be set to 6.0 or higher to update a ReceivePayment.

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

The unique identifier in the format ReceivePaymentId|AppliedToRefId.

ReceivePaymentId String False

ReceivePayments.ID

255

The Id of the bill-payment transaction.

ReferenceNumber String False 21

The transaction reference number. This may be set to refnumber*, *refnumber, and *refnumber* in the WHERE clause of a SELECT statement to search by StartsWith, EndsWith, and Contains. Refnum1:refnum2, refnum1:, and :refnum1 may also be used to denote a range.

TxnNumber Integer True

The transaction number. An identifying number for the transaction, different from the QuickBooks-generated Id.

Date Date False

The date of the transaction.

UnusedPayment Decimal True

This property will contain the amount of the payment that was not applied to existing invoices.

Amount Decimal False

The amount of the payment received from the Customer.

AccountsReceivableName String False

Accounts.FullName

1000

A reference to the name of the accounts-receivable account where the money received from this transaction will be deposited.

AccountsReceivableId String False

Accounts.ID

255

A reference to the Id of the accounts-receivable account where the money received from this transaction will be deposited.

CustomerName String False

Customers.FullName

1000

The name of the customer who has purchased goods or services from the company. This is required to have a value when inserting if CustomerId is not defined.

CustomerId String False

Customers.ID

255

The Id of the customer who has purchased goods or services from the company. This is required to have a value when inserting if CustomerName is not defined.

DepositToAccountName String False

Accounts.FullName

1000

The account name that the payment should be deposited to.

DepositToAccountId String False

Accounts.ID

255

The account Id that the payment should be deposited to.

PaymentMethodName String False

PaymentMethods.Name

100

Name of a payment method that already exists in QuickBooks.

PaymentMethodId String False

PaymentMethods.ID

255

Id of a payment method that already exists in QuickBooks.

Memo String False 5000

A memo to appear on internal reports.

ExchangeRate Double False

The exachange rate of the payment currency to the home currency.

TotalAmountInHomeCurrency Decimal False

The total amount in home currency.

AutoApply String False 20

How the payment should be applied.

The allowed values are ExistingTransactions, FutureTransactions, Custom.

The default value is ExistingTransactions.

CustomFields String False

Custom fields returned from QuickBooks and formatted into XML.

AppliedToRefId String False 255

The applied-to reference identifier. This is the Id of an existing transaction that a payment can be applied to such as a JournalEntry, or an Invoice.

AppliedToAmount Decimal True

The amount to be applied.

AppliedToBalanceRemaining Double True

The balance remaining to be applied.

AppliedToCreditAppliedAmount Decimal False

The credit applied amount to be applied.

AppliedToCreditMemoId String False

CreditMemos.ID

255

The credit memo Id to be applied.

AppliedToDiscountAccountName String False

Accounts.FullName

1000

The discount account name to be applied.

AppliedToDiscountAccountId String False

Accounts.ID

255

The discount account Id to be applied.

AppliedToDiscountAmount Decimal False

The discount amount to be applied.

AppliedToPaymentAmount Decimal False

The payment amount to be applied.

AppliedToReferenceNumber String True 21

The ref number to be applied.

AppliedToTxnDate Date True

The transaction date to be applied.

AppliedToTxnType String True 100

The transaction type that was applied.

TimeModified Datetime True

When the receive payment was last modified.

TimeCreated Datetime True

When the receive payment was created.

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
StartTxnDate String

Earliest transaction date to search for.

EndTxnDate String

Latest transaction date to search for.

StartModifiedDate String

Earliest modified date to search for.

EndModifiedDate String

Latest modified date to search for.

Copyright (c) 2021 CData Software, Inc. - All rights reserved.
Build 21.0.7930