Sign in

v1

latestOpenAPI 3.0.02026-07-2482421001.1 KB
Capture

Transactions

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

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

get/v1/transaction

Query parameters

book_uuidstring uuid

The unique identifier of a <glossary:Book>. Mutually exclusive with book_pk.

book_pkstring uuid

The unique primary key of a <glossary:Book>. Mutually exclusive with book_uuid.

uploaded_doc_uuidstring

The unique identifier of a <glossary:Document>. Mutually exclusive with uploaded_doc_pk.

uploaded_doc_pkstring

The unique primary key of a <glossary:Document>. Mutually exclusive with uploaded_doc_uuid.

Response

Success

statusinteger

A numerical code that indicates the status of the request.

messagestring

A textual description that indicates details about this response's status.

Example response

{
  "status": 200,
  "response": {
    "txns": [
      {
        "bank_account_pk": 12942296,
        "bbox": [
          142,
          2804,
          2196,
          2854
        ],
        "txn_date": "09/10/2020",
        "description": "BKOFAMERICA ATM 09/10"
      }
    ],
    "uploaded_docs": {
      "uploaded_doc_pk": {
        "name": "july.pdf(0,1,2,3)",
        "status": "VERIFICATION_COMPLETE",
        "pages": 4,
        "uuid": "30021344a56d4037a6f3d453444edae2",
        "mixed_uploaded_doc_uuid": "428110d2-ed77-44de-88bb-18003cfc10e6"
      }
    },
    "bank_accounts": {
      "bank_account_pk": {
        "bank_name": "CHASE",
        "activity_info": [
          {
            "start": [
              {
                "year": 2022,
                "month": 9,
                "day": 10
              }
            ],
            "end": [
              {
                "year": 2020,
                "month": 9,
                "day": 10
              }
            ]
          }
        ],
        "account_type": "CHECKING",
        "account_holder": "JILL S COFFEE",
        "holder_country": "US",
        "holder_state": "NY",
        "holder_city": "New York",
        "holder_address_1": "74 Prospect Park",
        "holder_address_2": "West Park Slope",
        "account_category": "PERSONAL ACCOUNT",
        "account_source": "STANDARD_STATEMENT",
        "book_uuid": "ffb922fb88f14702a4d36a4d64a18013",
        "periods": [
          {
            "uuid": "c283613c-d20a-4aac-b8b3-5dfd608ba111",
            "bank_account_pk": 12942296,
            "begin_date": "09/10/2020",
            "end_date": "09/10/2022",
            "primary_recon_error_reason": "Tampering detected",
            "secondary_recon_error_reason": "Tampering on pages 1, 3, 4, and 5"
          }
        ]
      }
    },
    "bank_checks": [
      {
        "uuid": "520dc1b8-3475-4da3-8fa0-f2880b9ae2c3",
        "bank_account_pk": 290879,
        "amount": 100,
        "pay_to": "Fake",
        "txn_date": "01/01/2000"
      }
    ]
  },
  "message": "OK"
}