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
  }
]
'

[
  {
    "external_id": "<string>",
    "amount": 123,
    "datetime": "2023-11-07T05:31:56Z",
    "description": "<string>",
    "posted": true,
    "type": "business",
    "reviewed": true,
    "id": "<string>",
    "external_account_id": "<string>",
    "metadata_": {},
    "invoice_payments": [
      {
        "invoice_id": "<string>",
        "transaction_id": "<string>",
        "payment_id": "<string>",
        "datetime": "2023-11-07T05:31:56Z",
        "payment_amount": 123,
        "id": "<string>",
        "invoice": {
          "business_id": "<string>",
          "number": "<string>",
          "description": "<string>",
          "total_amount": 123,
          "source": "manual",
          "due_at": "2023-11-07T05:31:56Z",
          "sent_at": "2023-11-07T05:31:56Z",
          "status": "open",
          "id": "<string>",
          "customer_id": "<string>",
          "total_paid": 0,
          "voided_at": "2023-11-07T05:31:56Z",
          "credit_amount": 123,
          "metadata_": {},
          "lines": [
            {
              "description": "<string>",
              "ledger_id": "ldg_WQMDNUHpBThYSNh4AprDBo",
              "unit_price": 123,
              "quantity": 123,
              "id": "<string>",
              "invoice_id": "<string>",
              "discount_amount": 123,
              "discount_rate": 123,
              "tax_amount": 123,
              "tax_rate": 123,
              "is_prepayment": true,
              "metadata_": {}
            }
          ],
          "payments": [
            "<unknown>"
          ]
        }
      }
    ],
    "refund_payments": [
      {
        "amount": 123,
        "id": "<string>",
        "transaction_id": "<string>"
      }
    ],
    "bill_payments": [
      {
        "bill_id": "<string>",
        "transaction_id": "<string>",
        "payment_id": "<string>",
        "datetime": "2023-11-07T05:31:56Z",
        "payment_amount": 123,
        "id": "<string>",
        "bill": {
          "business_id": "<string>",
          "vendor_id": "<string>",
          "number": "<string>",
          "description": "<string>",
          "total_amount": 123,
          "total_paid": 123,
          "due_at": "2023-11-07T05:31:56Z",
          "issued_at": "2023-11-07T05:31:56Z",
          "status": "open",
          "id": "<string>",
          "voided_at": "2023-11-07T05:31:56Z",
          "metadata_": {},
          "lines": [
            {
              "description": "<string>",
              "number": "<string>",
              "ledger_id": "ldg_WQMDNUHpBThYSNh4AprDBo",
              "amount": 123,
              "id": "<string>",
              "bill_id": "<string>",
              "metadata_": {}
            }
          ],
          "payments": [
            "<unknown>"
          ]
        }
      }
    ]
  }
]

PATCH

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
  }
]
'

[
  {
    "external_id": "<string>",
    "amount": 123,
    "datetime": "2023-11-07T05:31:56Z",
    "description": "<string>",
    "posted": true,
    "type": "business",
    "reviewed": true,
    "id": "<string>",
    "external_account_id": "<string>",
    "metadata_": {},
    "invoice_payments": [
      {
        "invoice_id": "<string>",
        "transaction_id": "<string>",
        "payment_id": "<string>",
        "datetime": "2023-11-07T05:31:56Z",
        "payment_amount": 123,
        "id": "<string>",
        "invoice": {
          "business_id": "<string>",
          "number": "<string>",
          "description": "<string>",
          "total_amount": 123,
          "source": "manual",
          "due_at": "2023-11-07T05:31:56Z",
          "sent_at": "2023-11-07T05:31:56Z",
          "status": "open",
          "id": "<string>",
          "customer_id": "<string>",
          "total_paid": 0,
          "voided_at": "2023-11-07T05:31:56Z",
          "credit_amount": 123,
          "metadata_": {},
          "lines": [
            {
              "description": "<string>",
              "ledger_id": "ldg_WQMDNUHpBThYSNh4AprDBo",
              "unit_price": 123,
              "quantity": 123,
              "id": "<string>",
              "invoice_id": "<string>",
              "discount_amount": 123,
              "discount_rate": 123,
              "tax_amount": 123,
              "tax_rate": 123,
              "is_prepayment": true,
              "metadata_": {}
            }
          ],
          "payments": [
            "<unknown>"
          ]
        }
      }
    ],
    "refund_payments": [
      {
        "amount": 123,
        "id": "<string>",
        "transaction_id": "<string>"
      }
    ],
    "bill_payments": [
      {
        "bill_id": "<string>",
        "transaction_id": "<string>",
        "payment_id": "<string>",
        "datetime": "2023-11-07T05:31:56Z",
        "payment_amount": 123,
        "id": "<string>",
        "bill": {
          "business_id": "<string>",
          "vendor_id": "<string>",
          "number": "<string>",
          "description": "<string>",
          "total_amount": 123,
          "total_paid": 123,
          "due_at": "2023-11-07T05:31:56Z",
          "issued_at": "2023-11-07T05:31:56Z",
          "status": "open",
          "id": "<string>",
          "voided_at": "2023-11-07T05:31:56Z",
          "metadata_": {},
          "lines": [
            {
              "description": "<string>",
              "number": "<string>",
              "ledger_id": "ldg_WQMDNUHpBThYSNh4AprDBo",
              "amount": 123,
              "id": "<string>",
              "bill_id": "<string>",
              "metadata_": {}
            }
          ],
          "payments": [
            "<unknown>"
          ]
        }
      }
    ]
  }
]

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

Body

application/json

transaction_id

string<txn_string>

required

The ID of the Transaction to update

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

Response

Successful Response

external_id

string | null

required

Maximum string length: 255

amount

number

required

datetime

string<date-time>

required

description

string

required

Maximum string length: 512

posted

boolean

required

type

enum<string>

required

The type of the Transaction

Available options:

business,

personal

reviewed

boolean

required

string<txn_string>

required

The ID of the Transaction

external_account_id

string<eac_string>

required

The ID of the External Account associated with the Transaction

metadata_

Metadata · object

invoice_payments

InvoicePaymentPublic · object[] | null

The invoice payments associated with the Transaction

Show child attributes

invoice_payments.invoice_id

string<inv_string>

required

The ID of the invoice that the payment is associated with

invoice_payments.transaction_id

string<txn_string>

required

The ID of the transaction that the payment is associated with

invoice_payments.payment_id

string

required

The external identifier of the payment

Maximum string length: 255

invoice_payments.datetime

string<date-time>

required

The date and time the payment was made

invoice_payments.payment_amount

number

required

The amount of the payment

invoice_payments.id

string<inp_string>

required

The ID of the invoice payment

invoice_payments.invoice

InvoicePublic · object

The invoice that the payment is associated with

Show child attributes

invoice_payments.invoice.business_id

string<biz_string>

required

The ID of the Business that the invoice is associated with

invoice_payments.invoice.number

string

required

The number of the invoice. Must be unique across all invoices for a business.

Maximum string length: 255

invoice_payments.invoice.description

string

required

The description of the invoice

Maximum string length: 512

invoice_payments.invoice.total_amount

number

required

The amount of the invoice

invoice_payments.invoice.source

enum<string>

required

The source of the invoice

Available options:

manual,

stripe

invoice_payments.invoice.due_at

string<date-time>

required

The due date of the invoice

invoice_payments.invoice.sent_at

string<date-time>

required

The date the invoice was sent

invoice_payments.invoice.status

enum<string>

required

The status of the invoice

Available options:

open,

paid,

uncollectible,

voided,

refunded,

partially_refunded

invoice_payments.invoice.id

string<inv_string>

required

The ID of the invoice

invoice_payments.invoice.customer_id

string<cus_string>

required

The ID of the Customer that the invoice is associated with

invoice_payments.invoice.total_paid

number

default:0

The amount of the invoice that has been paid

invoice_payments.invoice.voided_at

string<date-time> | null

The date the invoice was voided

invoice_payments.invoice.credit_amount

number | null

The amount to issue as a credit in the invoice

invoice_payments.invoice.metadata_

Metadata · object

invoice_payments.invoice.lines

InvoiceLinePublic · object[] | null

The lines of the invoice

Show child attributes

invoice_payments.invoice.lines.description

string

required

The description of the line item

Maximum string length: 512

invoice_payments.invoice.lines.ledger_id

string<ldg_string> | null

required

The ID of the ledger that the line item is associated with

Example:

"ldg_WQMDNUHpBThYSNh4AprDBo"

invoice_payments.invoice.lines.unit_price

number

required

The unit price of the line item

invoice_payments.invoice.lines.quantity

integer

required

The quantity of the line item

invoice_payments.invoice.lines.id

string<inl_string>

required

The ID of the invoice line

invoice_payments.invoice.lines.invoice_id

string<inv_string>

required

The ID of the invoice that the line item is associated with

invoice_payments.invoice.lines.discount_amount

number | null

The discount amount of the line item

invoice_payments.invoice.lines.discount_rate

number | null

The discount rate of the line item

invoice_payments.invoice.lines.tax_amount

number | null

The tax amount of the line item

invoice_payments.invoice.lines.tax_rate

number | null

The tax rate of the line item

invoice_payments.invoice.lines.is_prepayment

boolean

Whether the line item is a prepayment

invoice_payments.invoice.lines.metadata_

Metadata · object

invoice_payments.invoice.payments

any[] | null

The payments of the invoice

refund_payments

RefundPaymentPublic · object[] | null

The refund payments associated with the Transaction

Show child attributes

refund_payments.amount

number

required

The amount of the refund that has been paid

refund_payments.id

string<rfp_string>

required

The ID of the payment

refund_payments.transaction_id

string<txn_string>

required

The ID of the transaction that the refund payment is associated with

bill_payments

BillPaymentPublic · object[] | null

The bill payments associated with the Transaction

Show child attributes

bill_payments.bill_id

string<bil_string>

required

The ID of the bill that the payment is associated with

bill_payments.transaction_id

string<txn_string>

required

The ID of the transaction that the payment is associated with

bill_payments.payment_id

string

required

The external identifier of the payment

Maximum string length: 255

bill_payments.datetime

string<date-time>

required

The date and time the payment was made

bill_payments.payment_amount

number

required

The amount of the payment

bill_payments.id

string<blp_string>

required

The ID of the bill payment

bill_payments.bill

BillPublic · object

The bill that the payment is associated with

Show child attributes

bill_payments.bill.business_id

string<biz_string>

required

The ID of the Business that the bill is associated with

bill_payments.bill.vendor_id

string<ven_string>

required

The ID of the Vendor that the bill is associated with

bill_payments.bill.number

string

required

The id or number of the bill

Maximum string length: 255

bill_payments.bill.description

string

required

The description of the bill

Maximum string length: 512

bill_payments.bill.total_amount

number

required

The amount of the bill

bill_payments.bill.total_paid

number

required

The amount of the bill that has been paid

bill_payments.bill.due_at

string<date-time>

required

The due date of the bill

bill_payments.bill.issued_at

string<date-time>

required

The date the bill was sent

bill_payments.bill.status

enum<string>

required

The status of the bill

Available options:

open,

paid,

voided

bill_payments.bill.id

string<bil_string>

required

The ID of the bill

bill_payments.bill.voided_at

string<date-time> | null

The date the bill was voided

bill_payments.bill.metadata_

Metadata · object

bill_payments.bill.lines

BillLinePublic · object[] | null

The lines of the bill

Show child attributes

bill_payments.bill.lines.description

string

required

The description of the line item

Maximum string length: 512

bill_payments.bill.lines.number

string

required

The id or number of the bill line item

Maximum string length: 255

bill_payments.bill.lines.ledger_id

string<ldg_string> | null

required

The ID of the ledger that the line item is associated with

Example:

"ldg_WQMDNUHpBThYSNh4AprDBo"

bill_payments.bill.lines.amount

number

required

The amount of the line item

bill_payments.bill.lines.id

string<bln_string>

required

The ID of the bill line

bill_payments.bill.lines.bill_id

string<bil_string>

required

The ID of the bill that the line item is associated with

bill_payments.bill.lines.metadata_

Metadata · object

bill_payments.bill.payments

any[] | null

The payments associated with the bill

Delete Multiple Transactions Get a single Transaction

⌘I

API Overview

Authentication

Business

Journal Entry

Ledger

Reports

Transaction

Invoice

Bill

Request

Document

Webhooks

Update Transactions for a Business

Authorizations

Path Parameters

Body

Response