Skip to main content
PATCH
/
v0
/
business
/
{business_id}
/
transactions
Update Transactions for a Business
curl --request PATCH \
  --url https://api.sandbox.getasset.com/v0/business/{business_id}/transactions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "transaction_id": "<string>",
    "type": "business",
    "reviewed": true,
    "tags": {
      "Location": "NYC"
    }
  }
]
'
[
  {
    "external_id": "1234567890",
    "amount": 123,
    "datetime": "2023-11-07T05:31:56Z",
    "description": "<string>",
    "posted": true,
    "reviewed": true,
    "id": "<string>",
    "external_account_id": "<string>",
    "metadata_": {},
    "invoice_payments": null,
    "refund_payments": null,
    "bill_payments": null,
    "tags": {
      "Job": [
        {
          "amount": "3000.00",
          "value": "Maple Street Remodel"
        },
        {
          "amount": "1500.00",
          "value": "Downtown Office Rewire"
        }
      ]
    }
  }
]

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
business_id
string<biz_string>
required

The id of the business

Example:

"biz_GA6EG2qFxA97NZHtxeLPUy"

Body

application/json
​
transaction_id
string<txn_string>
required

The ID of the Transaction to update

Example:

"txn_WQMDNUHpBThYSNh4AprDBo"

​
type
enum<string> | null

The updated type of the Transaction

Available options:
business,
personal
Example:

"business"

​
reviewed
boolean | null

Whether the Transaction has been reviewed

​
tags
Tags · object

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.

Example:
{ "Location": "NYC" }

Response

Successful Response

​
external_id
string | null
required
Maximum string length: 255
Example:

"1234567890"

​
amount
number
required
Example:

520.56

​
datetime
string<date-time>
required
​
description
string
required

The description of the Transaction

Maximum string length: 512
Example:

"Payment from Acme Corp"

​
posted
boolean
required
​
type
enum<string>
required

The type of the Transaction

Available options:
business,
personal
Examples:

"business"

"personal"

​
reviewed
boolean
required
​
id
string<txn_string>
required

The ID of the Transaction

Example:

"txn_WQMDNUHpBThYSNh4AprDBo"

​
external_account_id
string<eac_string>
required

The ID of the External Account associated with the Transaction

Example:

"eac_WQMDNUHpBThYSNh4AprDBo"

​
metadata_
Metadata · object
​
invoice_payments
InvoicePaymentPublic · object[] | null

The invoice payments associated with the Transaction

Example:

null

​
refund_payments
RefundPaymentPublic · object[] | null

The refund payments associated with the Transaction

Example:

null

​
bill_payments
BillPaymentPublic · object[] | null

The bill payments associated with the Transaction

Example:

null

​
tags
Tags · object

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.

Example:
{
  "Job": [
    {
      "amount": "3000.00",
      "value": "Maple Street Remodel"
    },
    {
      "amount": "1500.00",
      "value": "Downtown Office Rewire"
    }
  ]
}