> This page is for Unified. > For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.merge.dev/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.merge.dev/_mcp/server. 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** ### The Transaction Object ```json { "id": "string", "remote_id": "string", "created_at": "2023-01-01T00:00:00Z", "modified_at": "2023-01-01T00:00:00Z", "transaction_type": "string", "number": "string", "transaction_date": "2023-01-01T00:00:00Z", "account": "string", "contact": "string", "inclusive_of_tax": true, "total_amount": "string", "currency": "XUA", "exchange_rate": "string", "company": "string", "tracking_categories": [ "string" ], "line_items": [ { "id": "string", "remote_id": "string", "created_at": "2023-01-01T00:00:00Z", "modified_at": "2023-01-01T00:00:00Z", "memo": "string", "unit_price": "string", "quantity": "string", "item": "string", "account": "string", "tracking_category": "string", "tracking_categories": [ "string" ], "total_line_amount": "string", "tax_rate": "string", "currency": "XUA", "exchange_rate": "string", "company": "string", "remote_was_deleted": true } ], "accounting_period": "string", "transaction_url": "string", "remote_was_deleted": true, "field_mappings": { "organization_defined_targets": { "string": {} }, "linked_account_defined_targets": { "string": {} } }, "remote_data": [ { "path": "string", "data": {} } ] } ``` ### Schema (`Transaction`) ```yaml components: schemas: TransactionCurrencyEnum: type: string enum: - XUA - AFN - AFA - ALL - ALK - DZD - ADP - AOA - AOK - AON - AOR - ARA - ARS - ARM - ARP - ARL - AMD - AWG - AUD - ATS - AZN - AZM - BSD - BHD - BDT - BBD - BYN - BYB - BYR - BEF - BEC - BEL - BZD - BMD - BTN - BOB - BOL - BOV - BOP - BAM - BAD - BAN - BWP - BRC - BRZ - BRE - BRR - BRN - BRB - BRL - GBP - BND - BGL - BGN - BGO - BGM - BUK - BIF - XPF - KHR - CAD - CVE - KYD - XAF - CLE - CLP - CLF - CNX - CNY - CNH - COP - COU - KMF - CDF - CRC - HRD - HRK - CUC - CUP - CYP - CZK - CSK - DKK - DJF - DOP - NLG - XCD - DDM - ECS - ECV - EGP - GQE - ERN - EEK - ETB - EUR - XBA - XEU - XBB - XBC - XBD - FKP - FJD - FIM - FRF - XFO - XFU - GMD - GEK - GEL - DEM - GHS - GHC - GIP - XAU - GRD - GTQ - GWP - GNF - GNS - GYD - HTG - HNL - HKD - HUF - IMP - ISK - ISJ - INR - IDR - IRR - IQD - IEP - ILS - ILP - ILR - ITL - JMD - JPY - JOD - KZT - KES - KWD - KGS - LAK - LVL - LVR - LBP - LSL - LRD - LYD - LTL - LTT - LUL - LUC - LUF - MOP - MKD - MKN - MGA - MGF - MWK - MYR - MVR - MVP - MLF - MTL - MTP - MRU - MRO - MUR - MXV - MXN - MXP - MDC - MDL - MCF - MNT - MAD - MAF - MZE - MZN - MZM - MMK - NAD - NPR - ANG - TWD - NZD - NIO - NIC - NGN - KPW - NOK - OMR - PKR - XPD - PAB - PGK - PYG - PEI - PEN - PES - PHP - XPT - PLN - PLZ - PTE - GWE - QAR - XRE - RHD - RON - ROL - RUB - RUR - RWF - SVC - WST - SAR - RSD - CSD - SCR - SLL - XAG - SGD - SKK - SIT - SBD - SOS - ZAR - ZAL - KRH - KRW - KRO - SSP - SUR - ESP - ESA - ESB - XDR - LKR - SHP - XSU - SDD - SDG - SDP - SRD - SRG - SZL - SEK - CHF - SYP - STN - STD - TVD - TJR - TJS - TZS - XTS - THB - XXX - TPE - TOP - TTD - TND - TRY - TRL - TMT - TMM - USD - USN - USS - UGX - UGS - UAH - UAK - AED - UYW - UYU - UYP - UYI - UZS - VUV - VES - VEB - VEF - VND - VNN - CHE - CHW - XOF - YDD - YER - YUN - YUD - YUM - YUR - ZWN - ZRN - ZRZ - ZMW - ZMK - ZWD - ZWR - ZWL description: The currency code in ISO 4217 format. title: TransactionCurrencyEnum 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 pattern: ^-?\d{0,32}(?:\.\d{0,16})?$ description: The line item's unit price. quantity: type: - string - 'null' format: decimal pattern: ^-?\d{0,24}(?:\.\d{0,8})?$ 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. deprecated: true 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 pattern: ^-?\d{0,32}(?:\.\d{0,16})?$ 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 pattern: ^-?\d{0,32}(?:\.\d{0,16})?$ 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 ### 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. title: TransactionLineItem TransactionFieldMappings: type: object properties: organization_defined_targets: type: object additionalProperties: description: Any type linked_account_defined_targets: type: object additionalProperties: description: Any type title: TransactionFieldMappings RemoteData: type: object properties: path: type: string description: The third-party API path that is being called. data: description: >- The data returned from the third-party for this object in its original, unnormalized format. required: - path description: >- # The RemoteData Object ### Description The `RemoteData` object is used to represent the full data pulled from the third-party API for an object. ### Usage Example TODO title: RemoteData 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’s 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 pattern: ^-?\d{0,32}(?:\.\d{0,16})?$ 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 pattern: ^-?\d{0,32}(?:\.\d{0,16})?$ 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' accounting_period: type: - string - 'null' format: uuid description: The accounting period that the Transaction was generated in. transaction_url: type: - string - 'null' format: uri maxLength: 2000 description: The 3rd party URL of the transaction. 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/). field_mappings: oneOf: - $ref: '#/components/schemas/TransactionFieldMappings' - type: 'null' remote_data: type: - array - 'null' items: $ref: '#/components/schemas/RemoteData' title: Transaction ```