---
title: "Retrieves a transaction match report which includes a details array and a summary"
method: GET
path: "/transaction_match_report"
tags: ["TransactionMatchReport"]
---

# Retrieves a transaction match report which includes a details array and a summary

`GET /transaction_match_report`

## Request

- Base URL: `https://example.myintranetapps.com/api`
- URL: `https://example.myintranetapps.com/api/transaction_match_report`
- Auth: HTTP basic
- TypeScript: <https://skmtc.dev/bossinsights/apis/boss-insights/docs/transaction_match_report/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieves a TransactionMatchReport resource.

## Query parameters

- `start` string, date-time
- `end` string, date-time
- `refresh` string

## Response `200`

TransactionMatchReport resource

- TransactionMatchReport: Provides a transaction match report showing which transactions match in banking data sources and accounting data sources
  - `start` string, date
  - `end` string, date
  - `summary` object
    - `bankMatchedCount` integer
    - `bankTotalCount` integer
    - `bankMatchedAmount` number, float
    - `bankTotalAmount` number, float
    - `accountingMatchedCount` integer
    - `accountingTotalCount` integer
    - `accountingMatchedAmount` number, float
    - `accountingTotalAmount` number, float
    - `overallMatchedCount` integer
    - `overallTotalCount` integer
    - `overallMatchedAmount` number, float
    - `overallTotalAmount` number, float
  - `details` object[]
    - `type` 'BANK' | 'ACCOUNTING'
    - `bank_transaction_id` string
    - `bank_txn_type` 'DEBIT' | 'CREDIT'
    - `bank_total_amount` number, float
    - `bank_currency` string
    - `bank_date` string, date
    - `bank_merchant` string
    - `bank_description` string
    - `bank_category` string
    - `accounting_table` string
    - `accounting_table_id` string
    - `accounting_txn_type` 'DEBIT' | 'CREDIT'
    - `accounting_total_amount` number, float
    - `accounting_currency` string
    - `accounting_date` string, date
    - `accounting_merchant` string
    - `accounting_description` string
    - `accounting_category` string
    - `has_match` boolean

## Other responses

- `404`: Resource not found

---

[API](https://skmtc.dev/bossinsights/apis/boss-insights.md) - [All operations](https://skmtc.dev/bossinsights/apis/boss-insights/llms.txt) - [OpenAPI document](https://skmtc.dev/bossinsights/apis/boss-insights/revisions/d08a107895ad?raw)