Skip to content

Customer Payment Replace

Sean Callan edited this page Jun 9, 2020 · 1 revision

Beans_Customer_Payment_Replace

Replace a transaction in the journal with a payment.


Parameters

  • auth_uid (required) INTEGER - The ID for your API key.

  • auth_key (required) STRING - The API key.

  • auth_expiration (required) INTEGER - Unique ID tied to your key; changes if you reset your key.

  • transaction_id (required) INTEGER - The ID of the Beans_Transaction you are replacing.

  • deposit_account_id (required) INTEGER - The ID of the Beans_Account you are depositing into.

  • writeoff_account_id (optional) INTEGER - The ID of the Beans_Account to write off balances to.

  • adjustment_account_id (optional) INTEGER - The ID of the Beans_Account for an adjusting entry.

  • amount (required) - DECIMAL The total payment amount being received.

  • adjustment_amount (optional) - DECIMAL The amount for an adjusting entry.

  • description (optional) STRING -

  • sales (required) ARRAY - An array of objects representing the amount received for each sale.

    • id (required) INTEGER - The ID for the Beans_Customer_Sale being paid.

    • amount (required) - DECIMAL The amount being paid.

    • writeoff_balance (optional) BOOLEAN - Write off the remaining balance of the sale.

  • id (required) INTEGER - The ID for the Beans_Customer_Sale being paid.

  • amount (required) - DECIMAL The amount being paid.

  • writeoff_balance (optional) BOOLEAN - Write off the remaining balance of the sale.


Returns

  • payment OBJECT - The resulting Beans_Customer_Payment.
Clone this wiki locally