--- title: "Business transactions" method: GET path: "/v1/businesses/{business_id}/transactions" tags: ["Business history"] --- # Business transactions `GET /v1/businesses/{business_id}/transactions` ## Request - Base URL: `https://api.ocrolus.com` - URL: `https://api.ocrolus.com/v1/businesses/{business_id}/transactions` - Auth: OAuth 2 - Client credentials - Token URL: `https://auth.ocrolus.com/oauth/token` This API retrieves the paginated, deduplicated enriched transactions across all of the requesting org's <>s for a given business. Transactions are structurally compatible with the existing book-level enriched transactions API. > 👍 Tips > `start_date` and `end_date` filter transactions based on when they occurred at the bank, while `updated_since` filters based on when transactions were ingested into the system. Use `updated_since` to retrieve newly added data, even if the transaction dates are earlier. ## Path parameters - `business_id` string, uuid, required ## Query parameters - `offset` integer - `limit` integer - `start_date` string, date - `end_date` string, date - `updated_since` string, date-time ## Response `200` Success - object - `id` string, uuid: Unique identifier of the business entity for which transaction details are retrieved. - `total` integer: The total number of deduplicated transactions for this business retrieved based on the specified query parameteres. - `filtered_total` integer: The total number of transactions retrieved based on the provided `start_date`, `end_date`, and `updated_since` filters. - `offset` integer: The starting index for paginated transactions result. - `limit` integer: The maximum number of transactions returned per page starting from the specified `offset` value. - `transactions` object[] - `txn_pk` integer: Unique identifier of the transaction. - `txn_date` number: Date of the transaction in ISO 8601-compliant YYYY-MM-DD format. - `description` string: A brief description of the transaction. - `bank_account_pk` integer: The primary key of the bank account associated with the transaction. - `uploaded_doc_uuid` string: The UUID of the uploaded <> containing transaction details. - `uploaded_doc_name` string: The name of the uploaded <> containing transaction details. - `amount` number, float: Transaction amount. Positive values represent credits, and negative values represent debits. This amount includes dollars and cents; to avoid floating-point precision errors, consider parsing this field with a decimal data type, as opposed to a native `float` or `double`. - `counterparty` string: Standardized identifier of the transaction counterparty. - `comment` string: User provided notes or remarks about the transaction. - `is_noteworthy` boolean: Indicates whether the transaction is considered noteworthy based on internal business rules and risk factors. A value of `true` highlights transactions that may require additional attention or review. - `page_idx` number: The page number in the source document where this transaction was recorded. - `book_uuid` string, uuid: UUID of the book entity from which transaction details are retrieved. - `deposits` boolean: Creadited amount greater than zero. - `withdrawals` boolean: Debited amount less than zero. - `revenue` boolean: Deposits that have been included in revenue. - `nsf` boolean: Non-sufficient funds transactions and fees. - `expense` boolean: Withdrawals that have been included as expense. - `overdraft` boolean: Fees associated with overdraft events - `atm` boolean: Transaction at physical ATM locations. - `bank` boolean, nullable: Transaction associated with a traditional bank/depository institution. - `bank_branch` boolean, nullable: Transaction with a physical bank branch. - `bank_cash_advance` boolean, nullable: Cash advance transaction with a traditional bank. - `bank_loan` boolean, nullable: Loan transaction with a traditional bank. - `benefits` boolean, nullable: Transaction associated with government benefits. - `card_rewards` boolean, nullable: Transaction associated with credit card rewards. - `checks` boolean: Transaction associated with check payments, including check payments that have cleared, as well as check payments that have not cleared but are present in the bank statement data. - `credit_builder` boolean: Transaction associated with credit builder products offered by fintech companies to help businesses build credit history. - `credit_card` boolean: Transaction associated with credit cards, including purchases, payments, fees, and interest charges. - `crypto` boolean: Transaction associated with cryptocurrency and related companies. - `debit_card` boolean: Debit card transaction. - `debt_consolidator` boolean: Transaction associated with debt refinancing and consolidation companies that offer services to help businesses manage and consolidate existing debts. - `equipment_lease` boolean: Transaction associated with equipment leasing companies. - `factoring` boolean: Transaction associated with factoring companies. - `federal_tax` boolean: Transaction associated with federal tax payments or refunds. - `fintech_loan` boolean: Loan transaction with a fintech company that does not fit into `bank_loan` category. - `fintech_loan_source` string: The source of a loan transaction with a fintech company. - `fintech_mca` string: Merchant cash advance transaction with a fintech company. - `fintech_mca_source` boolean: The source of a merchant cash advance transaction with a fintech company. - `fintech` boolean: Transaction associated with a fintech company. - `gambling` boolean: Transaction associated with gambling like casino and lottery. - `insurance` boolean: Transaction associated with insurance premiums or payouts. - `internal_transfer` boolean: Transfer between accounts with the same owner. - `investment` boolean: Transaction associated with investment and brokerage companies. - `large_deposits` boolean: Large amount of deposite in the account. - `merchant_service_transfer` boolean: Transfer to/from a merchant service company. - `merchant_service` boolean: Transaction associated with payment processing companies. - `nsf_paid_or_negative_balance` boolean: Indicates a paid transaction despite insufficient funds (NSF) or an account with a negative balance. - `nsf_returned_or_not_paid` boolean: Indicates a transaction that was returned or declined due to non-sufficient funds (NSF) and was not successfully paid. - `other_loan` boolean: Loan transaction that does not fit into `fintech_loan` or `bank_loan`. - `other_transfer` boolean: Transfer that does not fit into other categories. - `outside_source_deposits` boolean: Deposits that are not `internal_transfer` or `other_transfer`. - `paypal` boolean: Transaction with PayPal, including PayPal payments, fees, and refunds. - `payroll_tax` boolean: Transaction associated with payroll tax payments or refunds. - `payroll` boolean: Transaction associated with payroll activities and companies. - `probable_recurring_txns` boolean: Transaction that is likely to be recurring based on internal business rules and transaction patterns. - `remote` boolean: Transaction initiated without the physical presence of a card, such as online or phone transactions. - `returned_item` boolean: Transaction associated with returned items, including returns of purchases and returned checks. - `revenue_deduction_other` boolean: Transaction that had been removed from revenue but does not fit into other categories. - `revenue_deduction` boolean: Transaction that has been removed from revenue, including refunds, returns, and other revenue adjustments. - `reversed` boolean: Transaction that has been reversed, meaning the original transaction was negated by a subsequent transaction, such as a refund or reversal entry. - `sba` boolean: Transaction associated with the Small Business Administration. - `state_tax` boolean: Transaction associated with state tax payments or refunds. - `tolls` boolean: Transaction associated with transportation tolls (bridges, highways, etc.). - `truck_stop` boolean: Transaction associated with truck stops, including fuel purchases, rest fees, and other services at truck stop locations. - `txn_five_zeros` boolean: Amount is multiple of $1000.00. - `txn_four_zeros` boolean: Amount is multiple of $100.00. - `venmo_zelle_cashapp` boolean: Transaction with popular peer-to-peer payment platforms like Venmo, Zelle, and Cash App. - `wire_transfer` boolean: Transaction associated with wire transfers, including both domestic and international wires. - `custom_tag` boolean: Custom tag that can be applied to transactions based on user-defined criteria or business rules. ## Other responses - `400`: Invalid Auth/Business ID format - `403`: Business not associated with requesting organization - `404`: Business Identity Not Found - `500`: Internal server error --- [API](https://skmtc.dev/ocrolus/apis/business-history.md) - [All operations](https://skmtc.dev/ocrolus/apis/business-history/llms.txt) - [OpenAPI document](https://skmtc.dev/ocrolus/apis/business-history/revisions/8f419cb52efa?raw)