---
title: "Transactions"
method: GET
path: "/v1/transaction"
tags: ["Capture"]
---

# Transactions

`GET /v1/transaction`

Retrieve transactions from all Documents uploaded to a <<glossary:Book>>.

---
> 🚧 
> The Transactions endpoint provides raw transactions output. If you are looking for enriched transactions complete with a list of categories, transaction tagging, and improved revenue, expense, and transfer logic, please visit the [Enriched transactions page](https://docs.ocrolus.com/ocrolus-api/reference/enriched-transactions)

> 📘
> If `uploaded_doc_pk` or `uploaded_doc_uuid` are not provided in the request, transactions from all Documents in the Book will be provided.

## Query parameters

- `book_uuid` string, uuid
- `book_pk` string, uuid
- `uploaded_doc_uuid` string
- `uploaded_doc_pk` string

## Response `200`

Success

- object
  - `status` integer — A numerical code that indicates the status of the request.
  - `response` object — An object received from the server that potentially contains data.
    - `txns` object[] — Transaction(s) and their atributes details.
      - `page_idx` integer — The specific page number within a Document from which transaction details are retrieved.
      - `bank_account_pk` integer — A unique integer identifier of the bank account using which the transaction was done.
      - `amount` string — The amount recorded in the transaction.
      - `bbox` unknown[] — The bounding box (bbox) coordinates are the pixel units that enclose the text data on a page. They're given in left, top, bottom, and right order, with (0, 0) as the top-left corner of the page.
        - unknown
      - `txn_date` string — Date at which the transaction was done.
      - `page_doc_pk` string — Unique ID of the specific page within a Document from which transaction details are retrieved.
      - `pk` string — A unique identifier of the transaction.
      - `uploaded_doc_pk` string — A unique integer of the Document from which the transaction details are retrieved.
      - `description` string — Phrasal description of the transaction.
      - `txn_pk_duplicate_of` string — When a transaction is a duplicate of another, it displays the primary key of the original transaction.
      - `comment` string — Comments regarding the transaction provided by the customer using the web application.
      - `explanation` string — Explanation regarding the transaction configured by the customer using the web application.
      - `has_probable_transfers` boolean — Indicates if the Document has probable transfers.
      - `tags` unknown[] — Tags given to this transaction.
        - unknown
      - `period_pk` string — Unique ID of the period from which transactions are retrieved.
    - `uploaded_docs` object — Documents from the Book where transaction(s) are retrieved from.
      - `uploaded_doc_pk` object — An object containing information on a Document.
        - `name` string — Name of the Document from which transaction details are retrieved.
        - `status` string — Verification status of the Document from which transaction details are retrieved.
        - `pages` integer — Number of pages in the <<glossary:Document>>.
        - `pk` string — A unique integer of the Document from which the transaction details are retrieved.
        - `uuid` string — A unique identification code (uuid) of the Document from which the transaction details are retrieved.
        - `rejection_reason` string — An optional attribute that briefly explains why a Document was rejected.
        - `uploaded_doc_type` string — The type of the uploaded document.
        - `sub_doc_type` string — The sub type of the uploaded document.
        - `sub_doc_type_details` string — Additional details that pertain to the sub type of the Document.
        - `mixed_uploaded_doc_pk` string — A unique integer of the Mixed Document from which the transaction details are retrieved. A Mixed Document is a Document that contains information in various formats, such as text and images, and can be a single-page or multi-page <<glossary:Document>>.
        - `mixed_uploaded_doc_uuid` string — A unique identification code (uuid) of the Mixed Document from which the transaction details are retrieved.
    - `bank_accounts` object — Details of the bank accounts from which the transaction(s) is retrieved.
      - `bank_account_pk` object — An object containing information on a bank account.
        - `pk` string — A unique integer identifier of the bank account using which the transaction was done.
        - `book_pk` string — A unique integer identifier of the Book to which the Document is uploaded. Transactions are retrieved using this <<glossary:Book>> .
        - `name` integer — Name of the bank account holder.
        - `bank_name` string — Name of the bank.
        - `activity_info` object[] — It displays the start and end period in which transactions have occurred for a given bank account.
          - `start` object[] — It displays the start duration in which transactions have occurred.
            - `year` integer — It displays the start year in which transactions have occurred.
            - `month` integer — It displays the start month in which transactions have occurred.
            - `day` integer — It displays the start day in which transactions have occurred.
          - `end` object[] — It displays the end duration in which transactions have occurred.
            - `year` integer — It displays the end year in which transactions have occurred.
            - `month` integer — It displays the end month in which transactions have occurred.
            - `day` integer — It displays the end day in which transactions have occurred.
          - `missing` unknown[] — Missing transaction details.
            - unknown
        - `account_type` string — Type of the account from which transactions are retrieved.
        - `account_holder` string — Name of the account holder from which transactions are retrieved.
        - `account_number` string — Account number from which transactions are retrieved.
        - `holder_zip` string — Zip code of the account holder's address.
        - `holder_country` string — Country of the account holder.
        - `holder_state` string — State of the account holder.
        - `holder_city` string — City of the account holder.
        - `holder_address_1` string — The first line address of the account holder.
        - `holder_address_2` string — The second line address of the account holder.
        - `account_category` string — Category of the account.
        - `member_id` string — The credit union member ID of the account holder, as available in the bank statement.
        - `account_source` 'STANDARD_STATEMENT' | 'TRANSACTION_SUMMARY' | 'CREDIT_UNION' | 'VOA_PLAID' | 'VOA_BLEND' | 'VOA_FINICITY' | 'VOA_ACCOUNTCHEK' | 'VOA_OTHERS' | 'OTHERS' — The source from which the bank account data was obtained. The default value is null.
        - `id` string — Unique id of the bank.
        - `book_uuid` string — A unique identification code (uuid) of the Book from which the transaction details are retrieved.
        - `periods` object[] — An array of bank account statement periods.
          - `pk` string — Unique ID of the period from where transactions are retrieved.
          - `uuid` string — Universally unique identification code of the period from where transactions are retrieved.
          - `bank_account_pk` integer — A unique integer identifier of the bank account using which the transaction was done.
          - `begin_date` string — Start of date of the transaction.
          - `end_date` string — End of date of the transaction.
          - `begin_balance` string — Starting balance of the transaction retrieved.
          - `end_balance` string — Ending balance of the transaction retrieved.
          - `primary_recon_error_reason` string — Manual verifier flag for suspicious activity after inspection. If the period is not reconciled, the verifiers will add the predefined values like Potential Fraud, Incomplete Information, and Unreconciled Period.
          - `secondary_recon_error_reason` string — Manual verifier flag for suspicious activity after inspection. If the period is not reconciled, the verifiers will add the predefined values like Incomplete Transaction Data, Invalid Date(s), Photoshopped Data, Missing Period Data, Missing Page(s), Invalid Amount(s) Or Balance(s), and Reconciliation Error Reason Is Not Identified.
          - `absolute_recon_error` string — Represents the total monetary impact of the reconciliation error. This value reflects the amount associated with the issue identified, based on the inspection outcomes from `primary_recon_error_reason` and `secondary_recon_error_reason`.
          - `uploaded_doc_pk` string — A unique integer of the Document from which the transaction details are retrieved.
        - `account_holders` string[] — Name(s) of the account holder(s).
    - `bank_checks` object[] — List of images within the bank statement that have been processed by the system for check detection.
      - `uuid` string — Unique identifier for the check entry.
      - `bank_account_pk` integer — Primary key of the associated bank account.
      - `amount` number — Amount associated with the check.
      - `pay_to` string — Name of the check recipient.
      - `txn_date` string — Date the check was issued or processed (MM/DD/YYYY).
      - `check_number` string — Check number.
      - `memo_number` string — Reference number.
    - `tags` string — Tags given to the transaction.
  - `message` string — A textual description that indicates details about this response's status.

## Other responses

- `400` — Client Errors

---

[API](https://skmtc.net/ocrolus/apis/user-management.md) · [All operations](https://skmtc.net/ocrolus/apis/user-management/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ocrolus/user-management/revisions/3571ef602d13/schema)