​
transactionType
enum<string>
required

The type of transaction.

Available options:
ar_refund_credit_card,
bill,
bill_payment_check,
bill_payment_credit_card,
build_assembly,
charge,
check,
credit_card_charge,
credit_card_credit,
credit_memo,
deposit,
estimate,
inventory_adjustment,
invoice,
item_receipt,
journal_entry,
liability_adjustment,
paycheck,
payroll_liability_check,
purchase_order,
receive_payment,
sales_order,
sales_receipt,
sales_tax_payment_check,
transfer,
vendor_credit,
ytd_adjustment
Example:

"invoice"

​
transactionId
string
required

The QuickBooks-assigned unique identifier of this transaction. If transactionLineId is also defined, this is the identifier of the line's parent transaction object.

Example:

"123ABC-1234567890"

​
transactionLineId
string | null
required

The QuickBooks-assigned unique identifier of this transaction line. If null, this result is a transaction object.

Example:

"456DEF-1234567890"

​
createdAt
string
required

The date and time when this transaction was created, in ISO 8601 format (YYYY-MM-DDThh:mm:ss±hh:mm). The time zone is the same as the user's time zone in QuickBooks.

Example:

"2021-10-01T17:34:56.000Z"

​
updatedAt
string
required

The date and time when this transaction was last updated, in ISO 8601 format (YYYY-MM-DDThh:mm:ss±hh:mm). The time zone is the same as the user's time zone in QuickBooks.

Example:

"2021-10-01T20:45:30.000Z"

​
entity
object | null
required

The customer, vendor, employee, or person on QuickBooks's "Other Names" list associated with this transaction.

Example:
{
  "id": "80000001-1234567890",
  "fullName": "Acme Corporation"
}
​
account
object | null
required

The account associated with this transaction.

Example:
{
  "id": "80000001-1234567890",
  "fullName": "Checking"
}
​
transactionDate
string
required

The date of this transaction, in ISO 8601 format (YYYY-MM-DD).

Example:

"2021-10-01T00:00:00.000Z"

​
refNumber
string | null
required

The case-sensitive user-defined reference number for this transaction, which can be used to identify the transaction in QuickBooks. This value is not required to be unique and can be arbitrarily changed by the QuickBooks user.

Example:

"INV-1234"

​
amount
string
required

The monetary amount of this transaction, represented as a decimal string.

Example:

"1000.00"

​
currency
object | null
required

The transaction's currency. For built-in currencies, the name and code are standard international values. For user-defined currencies, all values are editable.

Example:
{
  "id": "80000001-1234567890",
  "fullName": "USD"
}
​
exchangeRate
number | null
required

The market exchange rate between this transaction's currency and the home currency in QuickBooks at the time of this transaction. Represented as a decimal value (e.g., 1.2345 for 1 EUR = 1.2345 USD if USD is the home currency).

Example:

1.2345

​
amountInHomeCurrency
string | null
required

The monetary amount of this transaction converted to the home currency of the QuickBooks company file. Represented as a decimal string.

Example:

"1234.56"

​
memo
string | null
required

A memo or note for this transaction.

Example:

"Customer requested rush delivery"

Health checkRetrieve a transaction