Skip to main content
Sets the Received From payer on lines of an existing bank deposit in QuickBooks Online. This is how a deposit gets tagged with the client who paid it. Display name “QuickBooks Update Deposit Received From”. Off by default. Get deposit_id and line_id values from QuickBooks Find Deposits, and the payer id from QuickBooks Lookup (quickbooks_lookup_entity), or from QuickBooks Create Customer when the client does not exist yet.

​
Authentication and enablement

Enable the tool on the agent and connect a QuickBooks Online integration (OAuth) with write access. The access token and company (realm_id) are injected from the connection. With several companies connected, the per-company toggles on the tool decide which ones it may write to.

​
Inputs

  • deposit_id: required. QuickBooks Deposit id.
  • received_from_id: required. QuickBooks id of the payer.
  • received_from_type: the payer’s record type, one of Customer (default), Vendor or Employee.
  • line_ids: the deposit lines to tag. Omit to tag every editable line on the deposit.
  • overwrite_existing: replace a Received From already set to a different payer. Default false, which skips those lines. Confirm with the user before turning it on.

​
Output

updated_lines[], unchanged_lines[] (already set to this payer) and skipped_lines[], each with line_id, amount, previous_received_from and, for skips, a reason. Also written (whether QuickBooks was updated), received_from, the deposit as it now stands in deposit, and completed_at.

​
Limits and side effects

  • Only Line[].DepositLineDetail.Entity changes. QuickBooks does not accept partial updates on deposits, so the tool reads the deposit and sends the complete record back with amounts, accounts, dates, memos and every other field exactly as read.
  • The update carries the SyncToken from that read. If someone edits the deposit in between, QuickBooks rejects the update and nothing changes.
  • Lines linked to a payment or sales receipt are never changed; their payer comes from that transaction.
  • When no line needs a change, nothing is written.
  • Each call is one metered Intuit read plus at most one write.

​
Expected errors

  • line … was not found on deposit …: a requested line_id is not on the deposit. Nothing was written; run Find Deposits again for current ids.
  • line … cannot take a Received From: linked to a payment, which sets its payer: a requested line is linked. Nothing was written.
  • failed to read deposit …: for example QuickBooks fault 610, object not found.
  • failed to update deposit … (nothing was changed): QuickBooks rejected the write, for example fault 5010 when the deposit changed after it was read. Run the call again.
  • deposit_id must be a numeric QuickBooks id, received_from_id must be…, received_from_type must be one of Customer, Vendor, Employee: validation, before any call.