> 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. # /transactions GET https://api.merge.dev/api/accounting/v1/transactions Returns a list of `Transaction` objects. Reference: https://docs.merge.dev/merge-unified/accounting/common-models/transactions/list ## Authentication - `Authorization` header (bearer token, required) — Token-based authentication with required prefix "Bearer" ## Servers - `https://api.merge.dev/api` (Production, default) - `https://api-eu.merge.dev/api` (ProductionEU) - `https://api-ap.merge.dev/api` (ProductionAPSE1) ## Request ### Query parameters - `company_id` (string, optional) — If provided, will only return accounting transactions for this company. - `created_after` (datetime, optional) — If provided, will only return objects created after this datetime. - `created_before` (datetime, optional) — If provided, will only return objects created before this datetime. - `cursor` (string, optional) — The pagination cursor value. - `expand` (list of enum, optional) — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. - Allowed values: `account`, `accounting_period`, `company`, `contact`, `line_items`, `tracking_categories` - `include_deleted_data` (boolean, optional) — 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/). - `include_remote_data` (boolean, optional) — Whether to include the original data Merge fetched from the third-party to produce these models. - `include_shell_data` (boolean, optional) — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). - `modified_after` (datetime, optional) — If provided, only objects synced by Merge after this date time will be returned. - `modified_before` (datetime, optional) — If provided, only objects synced by Merge before this date time will be returned. - `page_size` (integer, optional) — Number of results to return per page. The maximum limit is 100. - `remote_id` (string, optional) — The API provider's ID for the given object. - `transaction_date_after` (datetime, optional) — If provided, will only return objects created after this datetime. - `transaction_date_before` (datetime, optional) — If provided, will only return objects created before this datetime. ### Headers - `X-Account-Token` (string, required) — Token identifying the end user. ## Response ### 200 - `next` (string, optional, nullable) - `previous` (string, optional, nullable) - `results` (list of Transaction, optional) ## Types ### 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. - `id` (string, optional) - `remote_id` (string, optional, nullable) — The third-party API ID of the matching object. - `created_at` (datetime, optional) — The datetime that this object was created by Merge. - `modified_at` (datetime, optional) — The datetime that this object was modified by Merge. - `transaction_type` (string, optional, nullable) — The type of transaction, which can by any transaction object not already included in Merge’s common model. - `number` (string, optional, nullable) — The transaction's number used for identifying purposes. - `transaction_date` (datetime, optional, nullable) — The date upon which the transaction occurred. - `account` (string, optional, nullable) — The transaction's account. - `contact` (string, optional, nullable) — The contact to whom the transaction relates to. - `inclusive_of_tax` (boolean, optional, nullable) — If the transaction is inclusive or exclusive of tax. `True` if inclusive, `False` if exclusive. - `total_amount` (string, optional, nullable) — The total amount being paid after taxes. - `currency` (enum, optional, nullable) — The transaction's currency. The currency code in ISO 4217 format. - Allowed values: `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` - `exchange_rate` (string, optional, nullable) — The transaction's exchange rate. - `company` (string, optional, nullable) — The company the transaction belongs to. - `tracking_categories` (list of string, optional) - `line_items` (list of TransactionLineItem, optional) - `accounting_period` (string, optional, nullable) — The accounting period that the Transaction was generated in. - `transaction_url` (string, optional, nullable) — The 3rd party URL of the transaction. - `remote_was_deleted` (boolean, optional) — 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` (TransactionFieldMappings, optional, nullable) - `remote_data` (list of RemoteData, optional, nullable) ### 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. - `id` (string, optional) - `remote_id` (string, optional, nullable) — The third-party API ID of the matching object. - `created_at` (datetime, optional) — The datetime that this object was created by Merge. - `modified_at` (datetime, optional) — The datetime that this object was modified by Merge. - `memo` (string, optional, nullable) — An internal note used by the business to clarify purpose of the transaction. - `unit_price` (string, optional, nullable) — The line item's unit price. - `quantity` (string, optional, nullable) — The line item's quantity. - `item` (string, optional, nullable) - `account` (string, optional, nullable) — The line item's account. - `tracking_categories` (list of string, optional) — The transaction line item's associated tracking categories. - `total_line_amount` (string, optional, nullable) — The line item's total. - `tax_rate` (string, optional, nullable) — The tax rate that applies to this line item. - `currency` (enum, optional, nullable) — The line item's currency. The currency code in ISO 4217 format. - Allowed values: `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` - `exchange_rate` (string, optional, nullable) — The line item's exchange rate. - `company` (string, optional, nullable) — The company the line belongs to. - `remote_was_deleted` (boolean, optional) — 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/). - `tracking_category` (string, optional, nullable, deprecated) — The line's associated tracking category. ### TransactionFieldMappings - `organization_defined_targets` (map from string to any, optional) - `linked_account_defined_targets` (map from string to any, optional) ### RemoteData # 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 - `path` (string, required) — The third-party API path that is being called. - `data` (any, optional) — The data returned from the third-party for this object in its original, unnormalized format. ## Examples **Response** ```json { "next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", "previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ", "results": [ { "id": "0048ea5b-911e-4dff-9364-92070dea62ff", "remote_id": "239741", "created_at": "2021-09-15T00:00:00Z", "modified_at": "2021-10-16T00:00:00Z", "transaction_type": "estimate", "number": "122", "transaction_date": "2020-03-31T00:00:00Z", "account": "3e442c5d-8f51-4103-b5c9-dcee39c30a08", "contact": "2c22ce34-5c6e-4fc7-a594-7f26bb4cf78b", "inclusive_of_tax": true, "total_amount": "260", "currency": "USD", "exchange_rate": "2.9", "company": "595c8f97-2ac4-45b7-b000-41bdf43240b5", "tracking_categories": [ "b38c59b0-a9d7-4740-b1ee-5436c6751e3d", "9b840d2-686a-465a-8a8e-7b028498f8e4", "a47e11b6-c73b-4a0c-be31-130fc48177fa" ], "line_items": [ { "remote_id": "121222", "memo": "Pickleball paddles", "unit_price": "25.0", "quantity": "10.0", "item": "0958cbc6-6040-430a-848e-aafacbadf4ae", "account": "2b38c085-2620-4269-b5ec-75dd9095ed2c", "tracking_categories": [ "f1214c24-2702-4617-b74b-3ddecfc0d384", "9b840d2-686a-465a-8a8e-7b028498f8e4", "a47e11b6-c73b-4a0c-be31-130fc48177fa" ], "total_line_amount": "260", "tax_rate": "a12e7c20-1922-9df7-s75n-edfeewnn7384", "currency": "USD", "exchange_rate": "2.9", "company": "595c8f97-2ac4-45b7-b000-41bdf43240b5", "remote_was_deleted": false }, { "memo": "Pickleball balls", "unit_price": "1", "quantity": "10", "item": "249c9faa-3045-4a31-953b-8f22d3613301", "account": "3e442c5d-8f51-4103-b5c9-dcee39c30a08", "tracking_categories": [ "f1214c24-2702-4617-b74b-3ddecfc0d384", "9b840d2-686a-465a-8a8e-7b028498f8e4", "a47e11b6-c73b-4a0c-be31-130fc48177fa" ], "total_line_amount": "20", "tax_rate": "a12e7c20-1922-9df7-s75n-edfeewnn7384" } ], "accounting_period": "595c8f97-2ac4-45b7-b000-41bdf43240b5", "transaction_url": "https://qbo.intuit.com/app/transaction/239741", "remote_was_deleted": true, "field_mappings": { "organization_defined_targets": { "custom_key": "custom_value" }, "linked_account_defined_targets": { "custom_key": "custom_value" } }, "remote_data": [ { "path": "/actions", "data": null } ] } ] } ``` **SDK Code** ```python import requests url = "https://api.merge.dev/api/accounting/v1/transactions" querystring = {"include_remote_data":"true"} headers = { "X-Account-Token": "X-Account-Token", "Authorization": "Bearer " } response = requests.get(url, headers=headers, params=querystring) print(response.json()) ``` ```javascript const url = 'https://api.merge.dev/api/accounting/v1/transactions?include_remote_data=true'; const options = { method: 'GET', headers: {'X-Account-Token': 'X-Account-Token', Authorization: 'Bearer '} }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "net/http" "io" ) func main() { url := "https://api.merge.dev/api/accounting/v1/transactions?include_remote_data=true" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("X-Account-Token", "X-Account-Token") req.Header.Add("Authorization", "Bearer ") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://api.merge.dev/api/accounting/v1/transactions?include_remote_data=true") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["X-Account-Token"] = 'X-Account-Token' request["Authorization"] = 'Bearer ' response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://api.merge.dev/api/accounting/v1/transactions?include_remote_data=true") .header("X-Account-Token", "X-Account-Token") .header("Authorization", "Bearer ") .asString(); ``` ```php request('GET', 'https://api.merge.dev/api/accounting/v1/transactions?include_remote_data=true', [ 'headers' => [ 'Authorization' => 'Bearer ', 'X-Account-Token' => 'X-Account-Token', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.merge.dev/api/accounting/v1/transactions?include_remote_data=true"); var request = new RestRequest(Method.GET); request.AddHeader("X-Account-Token", "X-Account-Token"); request.AddHeader("Authorization", "Bearer "); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "X-Account-Token": "X-Account-Token", "Authorization": "Bearer " ] let request = NSMutableURLRequest(url: NSURL(string: "https://api.merge.dev/api/accounting/v1/transactions?include_remote_data=true")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```