Common ModelsTransactions

The Transaction object

The Transaction common model includes records of all types of transactions that do not appear in other common models. The type of transaction can be identified through the type field. More specifically, it will contain all types of transactions outside of:

  • Credit Notes
  • Expenses
  • Invoices
  • Journal Entries
  • Payments
  • Purchase Orders
  • Vendor Credits
idstringOptionalRead-onlyformat: "uuid"
remote_idstring or nullOptional

The third-party API ID of the matching object.

created_atdatetimeOptionalRead-only
The datetime that this object was created by Merge.
modified_atdatetimeOptionalRead-only
The datetime that this object was modified by Merge.
transaction_typestring or nullOptional

The type of transaction, which can by any transaction object not already included in Merge’s common model.

numberstring or nullOptional
The transaction's number used for identifying purposes.
transaction_datedatetime or nullOptional
The date upon which the transaction occurred.
accountstring or nullOptionalformat: "uuid"
The transaction's account.
contactstring or nullOptionalformat: "uuid"
The contact to whom the transaction relates to.
inclusive_of_taxboolean or nullOptional

If the transaction is inclusive or exclusive of tax. True if inclusive, False if exclusive.

total_amountstring or nullOptionalformat: "decimal"
The total amount being paid after taxes.
currencyenum or nullOptional
The transaction's currency. The currency code in ISO 4217 format.
exchange_ratestring or nullOptionalformat: "decimal"
The transaction's exchange rate.
companystring or nullOptionalformat: "uuid"
The company the transaction belongs to.
tracking_categorieslist of stringsOptional
line_itemslist of objectsOptionalRead-only
remote_was_deletedbooleanOptionalRead-only

Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. Learn more.

accounting_periodstring or nullOptionalformat: "uuid"
The accounting period that the Transaction was generated in.
field_mappingsobject or nullOptionalRead-only
remote_datalist of objects or nullOptionalRead-only