Merge · Schema

TransactionLineItem

# The TransactionLineItem Object ### Description The `TransactionLineItem` object is used to represent a transaction's line items. ### Usage Example Fetch from the `GET TransactionLineItem` endpoint and view the transaction's line items.

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.
memo stringnull An internal note used by the business to clarify purpose of the transaction.
unit_price stringnull The line item's unit price.
quantity stringnull The line item's quantity.
item stringnull
account stringnull The line item's account.
tracking_category stringnull The line's associated tracking category.
tracking_categories array The transaction line item's associated tracking categories.
total_line_amount stringnull The line item's total.
tax_rate stringnull The tax rate that applies to this line item.
currency object The line item's currency. The currency code in ISO 4217 format.
exchange_rate stringnull The line item's exchange rate.
company stringnull The company the line belongs to.
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
View JSON Schema on GitHub

JSON Schema

merge-transactionlineitem-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/TransactionLineItem",
  "title": "TransactionLineItem",
  "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."
    },
    "memo": {
      "type": [
        "string",
        "null"
      ],
      "description": "An internal note used by the business to clarify purpose of the transaction."
    },
    "unit_price": {
      "type": [
        "string",
        "null"
      ],
      "format": "decimal",
      "description": "The line item's unit price."
    },
    "quantity": {
      "type": [
        "string",
        "null"
      ],
      "format": "decimal",
      "description": "The line item's quantity."
    },
    "item": {
      "type": [
        "string",
        "null"
      ],
      "format": "uuid"
    },
    "account": {
      "type": [
        "string",
        "null"
      ],
      "format": "uuid",
      "description": "The line item's account."
    },
    "tracking_category": {
      "type": [
        "string",
        "null"
      ],
      "format": "uuid",
      "description": "The line's associated tracking category."
    },
    "tracking_categories": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "uuid"
      },
      "description": "The transaction line item's associated tracking categories."
    },
    "total_line_amount": {
      "type": [
        "string",
        "null"
      ],
      "format": "decimal",
      "description": "The line item's total."
    },
    "tax_rate": {
      "type": [
        "string",
        "null"
      ],
      "format": "uuid",
      "description": "The tax rate that applies to this line item."
    },
    "currency": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/TransactionCurrencyEnum"
        },
        {
          "type": "null"
        }
      ],
      "description": "The line item's currency. The currency code in ISO 4217 format."
    },
    "exchange_rate": {
      "type": [
        "string",
        "null"
      ],
      "format": "decimal",
      "description": "The line item's exchange rate."
    },
    "company": {
      "type": [
        "string",
        "null"
      ],
      "format": "uuid",
      "description": "The company the line belongs to."
    },
    "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/)."
    }
  },
  "description": "# The TransactionLineItem Object\n### Description\nThe `TransactionLineItem` object is used to represent a transaction's line items.\n\n### Usage Example\nFetch from the `GET TransactionLineItem` endpoint and view the transaction's line items."
}