Skip to content

Vendor Payment Replace

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

Beans_Vendor_Payment_Replace

Replace a transaction in the journal with a payment by adding purchases to it.


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.

  • payment_account_id (required) INTEGER - The ID of the Beans_Account you are making this payment from.

  • writeoff_account_id (optional) INTEGER - The ID of the Beans_Account to write off balances on. This is required only if you have writeoff_balance as tru for any pruchases.

  • 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.

  • number (optional) STRING - A reference number.

  • description (optional) STRING -

  • check_number (optional) STRING - A transaction or check number.

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

    • purchase_id (required) INTEGER - The ID for the Beans_Vendor_Purchase being paid.

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

    • invoice_number (required) STRING - The invoice number being paid.

    • date_billed (required) STRING - The bill date in YYYY-MM-DD format.

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

  • purchase_id (required) INTEGER - The ID for the Beans_Vendor_Purchase being paid.

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

  • invoice_number (required) STRING - The invoice number being paid.

  • date_billed (required) STRING - The bill date in YYYY-MM-DD format.

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


Returns

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