API Documentation

Beans_Customer_Payment_Replace

Replace a transaction in the journal with a payment.


Parameters

auth_uid INTEGER The ID for your API key.
auth_key STRING The API key.
auth_expiration INTEGER Unique ID tied to your key; changes if you reset your key.
transaction_id INTEGER The ID of the Beans_Transaction you are replacing.
deposit_account_id INTEGER The ID of the Beans_Account you are depositing into.
writeoff_account_id INTEGER The ID of the Beans_Account to write off balances to.
adjustment_account_id INTEGER The ID of the Beans_Account for an adjusting entry.
amount DECIMAL The total payment amount being received.
adjustment_amount DECIMAL The amount for an adjusting entry.
description STRING
sales ARRAY An array of objects representing the amount received for each sale.
id INTEGER The ID for the Beans_Customer_Sale being paid.
amount DECIMAL The amount being paid.
writeoff_balance BOOLEAN Write off the remaining balance of the sale.

Returns

payment OBJECT The resulting Beans_Customer_Payment.