Creates a payment record in QuickBooks Online. The Payment entity records payment from customers against single or multiple invoices and credit memos. Use this action when recording customer payments, whether full payment of an invoice or partial payment across multiple invoices.
linesRequiredarrayList of payment line items specifying which invoices or credit memos the payment is applied to. Each line item must contain Amount and LinkedTxn fields. Example: [{'Amount': 50.0, 'LinkedTxn': [{'TxnId': '11', 'TxnType': 'Invoice'}]}]
txn_datestringDate of the payment transaction in YYYY-MM-DD format (e.g., '2024-01-15'). If not specified, the current date is used.
total_amtRequirednumberTotal amount of the payment. This should equal the sum of all Line item amounts. Must be a positive number (e.g., 50.0, 100.0).
customer_idRequiredstringID of the customer making the payment. This is the unique identifier for the customer in QuickBooks (e.g., '3', '58'). Use QUICKBOOKS_CREATE_CUSTOMER or QUICKBOOKS_READ_CUSTOMER to get valid customer IDs.
minorversionintegerQuickBooks API minor version number to use for this request (e.g., 65, 70, 75). Allows access to version-specific features. If not specified, uses the default API version.
private_notestringPrivate note about the payment. Not visible to the customer. Maximum 4000 characters.
customer_namestringName of the customer. Optional field that helps with readability but not required by the API.
exchange_ratenumberExchange rate for the transaction when using multi-currency. Applicable only if multi-currency is enabled. Optional field.
payment_ref_numstringReference number for the payment, such as a check number or transaction ID. Optional field.
process_paymentbooleanIndicates whether the payment should be processed through QuickBooks Payments. Set to true to process the payment, false otherwise. Optional field.
ar_account_ref_idstringID of the accounts receivable account. Optional field. Use QuickBooks query API to get valid AR account IDs.
currency_ref_valuestringCurrency code for multi-currency environments (e.g., 'USD', 'CAD', 'EUR'). Required if the company file uses multi-currency. Optional otherwise.
dataRequiredData from the action execution
errorstringError if any occurred during the execution of the action
successfulRequiredbooleanWhether or not the action execution was successful or not
OAuth connection. Risk level 2 of 5.
Free Action
No published Skills explicitly reference this Action yet.