Overview
Model Name: Transaction
Detailed information about a specific credit or debit within a bank account.
Properties
page_idx
page_idx- Type
- Integer
- Required
- true
- Min. Value
- 0
The page number of the original document from which this transaction was captured.
bank_account_pk
bank_account_pk- Type
-
Integer (
uint64) - Required
- true
The primary key of the bank account from which this transaction was captured.
amount
amount- Type
- String
- Pattern
/^[+-]?\\d+(\\.\\d{1,2})?$/- Required
- true
The amount of the credit or debit that this transaction represents. Will be in USD, and can be positive or negative.
bbox
bbox- Type
- List of numbers
- Required
- true
- Min. Item Count
- 4
- Max. Item Count
- 4
The coordinates of the bounding box (i.e. rectangle) on the page from which this transaction was captured.
Unit of measurement is in pixels, and the origin ([0, 0]) is in the top-left corner.
The bounding box is encoded as [x, y, x+w, y+h], where:
xis the horizontal position of the box, relative to the left of the page.yis the vertical position of the bounding box, relative to the top of the page.wis the width of the bounding box.his the height of the bounding box.
txn_date
txn_date- Type
- String
- Pattern
/^\\d{2}\/\\d{2}\/\\d{4}$/- Required
- true
The date on which this transaction occurred. Given in MM/DD/YYYY format.
page_doc_pk
page_doc_pk- Type
-
Integer (
uint64) - Required
- true
The unique identifier of the page from which this transaction was captured.
pk
pk- Type
-
Integer (
uint64) - Required
- true
The unique identifier of this particular transaction.
uploaded_doc_pk
uploaded_doc_pk- Type
-
Integer (
uint64) - Required
- true
The unique identifier of the document from which this transaction was captured.
description
description- Type
- String
- Required
- true
Details about the transaction that were captured from the original bank statement.