Merge · Schema

Transaction

# The Transaction Object ### Description 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__ ### Usage Example Fetch from the `GET Transaction` endpoint and view a company's transactions.

IntegrationsPlatformUnified APIAgent HandlerLLM Gateway

Properties

Name	Type	Description
id	string
remote_id	stringnull	The third-party API ID of the matching object.
created_at	string	The datetime that this object was created by Merge.
modified_at	string	The datetime that this object was modified by Merge.
transaction_type	stringnull	The type of transaction, which can by any transaction object not already included in Merge’s common model.
number	stringnull	The transaction's number used for identifying purposes.
transaction_date	stringnull	The date upon which the transaction occurred.
account	stringnull	The transaction's account.
contact	stringnull	The contact to whom the transaction relates to.
inclusive_of_tax	booleannull	If the transaction is inclusive or exclusive of tax. `True` if inclusive, `False` if exclusive.
total_amount	stringnull	The total amount being paid after taxes.
currency	object	The transaction's currency. The currency code in ISO 4217 format.
exchange_rate	stringnull	The transaction's exchange rate.
company	stringnull	The company the transaction belongs to.
tracking_categories	array
line_items	array
remote_was_deleted	boolean	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 cove
accounting_period	stringnull	The accounting period that the Transaction was generated in.
field_mappings	object
remote_data	arraynull

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Transaction",
  "title": "Transaction",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid"
    },
    "remote_id": {
      "type": [
        "string",
        "null"
      ],
      "description": "The third-party API ID of the matching object."
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "The datetime that this object was created by Merge."
    },
    "modified_at": {
      "type": "string",
      "format": "date-time",
      "description": "The datetime that this object was modified by Merge."
    },
    "transaction_type": {
      "type": [
        "string",
        "null"
      ],
      "description": "The type of transaction, which can by any transaction object not already included in Merge\u2019s common model."
    },
    "number": {
      "type": [
        "string",
        "null"
      ],
      "description": "The transaction's number used for identifying purposes."
    },
    "transaction_date": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time",
      "description": "The date upon which the transaction occurred."
    },
    "account": {
      "type": [
        "string",
        "null"
      ],
      "format": "uuid",
      "description": "The transaction's account."
    },
    "contact": {
      "type": [
        "string",
        "null"
      ],
      "format": "uuid",
      "description": "The contact to whom the transaction relates to."
    },
    "inclusive_of_tax": {
      "type": [
        "boolean",
        "null"
      ],
      "description": "If the transaction is inclusive or exclusive of tax. `True` if inclusive, `False` if exclusive."
    },
    "total_amount": {
      "type": [
        "string",
        "null"
      ],
      "format": "decimal",
      "description": "The total amount being paid after taxes."
    },
    "currency": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/TransactionCurrencyEnum"
        },
        {
          "type": "null"
        }
      ],
      "description": "The transaction's currency. The currency code in ISO 4217 format."
    },
    "exchange_rate": {
      "type": [
        "string",
        "null"
      ],
      "format": "decimal",
      "description": "The transaction's exchange rate."
    },
    "company": {
      "type": [
        "string",
        "null"
      ],
      "format": "uuid",
      "description": "The company the transaction belongs to."
    },
    "tracking_categories": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "uuid"
      }
    },
    "line_items": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/TransactionLineItem"
      }
    },
    "remote_was_deleted": {
      "type": "boolean",
      "description": "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](https://docs.merge.dev/integrations/hris/supported-features/)."
    },
    "accounting_period": {
      "type": [
        "string",
        "null"
      ],
      "format": "uuid",
      "description": "The accounting period that the Transaction was generated in."
    },
    "field_mappings": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/TransactionFieldMappings"
        },
        {
          "type": "null"
        }
      ]
    },
    "remote_data": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "$ref": "#/components/schemas/RemoteData"
      }
    }
  },
  "description": "# The Transaction Object\n### Description\nThe `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:\n* __Credit Notes__\n* __Expenses__\n* __Invoices__\n* __Journal Entries__\n* __Payments__\n* __Purchase Orders__\n* __Vendor Credits__\n\n### Usage Example\nFetch from the `GET Transaction` endpoint and view a company's transactions."
}