Update Transactions for a Business
Update one or more Transactions. Each item may change the type, reviewed
or status flags, merge tags, or set line_items to recategorize the
Transaction (a single line item) or split it across categories (several).
Scopes: transaction:update
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Headers
Path Parameters
The id of the business
"biz_GA6EG2qFxA97NZHtxeLPUy"
Body
The ID of the Transaction to update
"txn_WQMDNUHpBThYSNh4AprDBo"
The updated type of the Transaction
business, personal "business"
Whether the Transaction has been reviewed
Inline tag input to merge into the transaction's tags. Each key is a tag field name that must already exist. A list of {value, amount} objects replaces all current values for that field; a bare string is still accepted as a backwards-compatible alias for a single-value list. A null (or empty list) removes all of the transaction's values for that field. Fields not mentioned are left untouched. Per-field amounts follow the default rules (single value -> transaction amount; N values without amounts -> transaction.amount / N; mixed is rejected) and the per-field sum must not exceed transaction.amount.
Replace the Transaction's line items with this set of categorized allocations. Provide a single line item to change the category, or several to split the Transaction across categories. Each amount is signed in the same direction as the Transaction amount and they must sum to it (a $100 transaction split evenly is two 50.00 line items).
1Response
Successful Response
255"1234567890"
520.56
The description of the Transaction
512"Payment from Acme Corp"
The type of the Transaction
business, personal "business"
"personal"
The ID of the Transaction
"txn_WQMDNUHpBThYSNh4AprDBo"
The ID of the External Account associated with the Transaction
"eac_WQMDNUHpBThYSNh4AprDBo"
The categories associated with the Transaction, derived from the journal entry with both basis. Each entry carries the ledger name and the amount allocated to it; a single-category journal entry is still returned as a one-element list. Null when no journal entry with both basis exists.
The status of the Transaction. Null when it has no status.
bookkeeper_pending, business_pending, confirmed "confirmed"
The categorized line items of the Transaction. Each item carries the ledger it is categorized to and the amount allocated to it. Pass the ids of the line items to the split endpoint to re-split the Transaction. Null when the Transaction has no categorization.
The invoice payments associated with the Transaction
null
The refund payments associated with the Transaction
null
The bill payments associated with the Transaction
null
Tag field name to the list of values attached to the transaction. Each value carries its allocated amount and, when pinned, its ledger; a single-value field is still returned as a one-element list.