--- title: "Query transactions" method: POST path: "/v6/banks/transactions/query" tags: ["Bank Transactions"] --- # Query transactions `POST /v6/banks/transactions/query` Query transactions for the authenticated user ## Headers - `Tight-Version` '6' ## Request body - BankTransactionsGetParam - `cursor` string, nullable — Cursor from the previous paginated response - `limit` integer — Page size, i.e. number of items to return per page - `sort` BankTransactionsSort — Sort order for the items in the response. - `orderBy` 'DATE' | 'AMOUNT' | 'DESCRIPTION' | 'STATUS' | 'REVIEW_STATUS' — Sort column - `direction` 'ASC' | 'DESC' — Sort direction. Defaults to DESC - `start` string — The starting value of the first record in the response. - `filter` BankTransactionsFilterParam — Filter for items in the response. - `search` string — Search filter - `date` DateFilter — Date filter - `equal` string, date — Value - returns all records with specified field equal to this value. - `notEqual` string, date — Value - returns all records with specified field not equal to this value. - `greaterThan` string, date — Value - returns all records with specified field greater than to this value. - `greaterThanEqual` string, date — Value - returns all records with specified field greater than or equal to this value. - `lessThan` string, date — Value - returns all records with specified field less than to this value. - `lessThanEqual` string, date — Value - returns all records with specified field less than or equal to this value. - `amount` AmountFilter — Match count filter - `equal` integer — Value - returns all records with specified field equal to this value. - `notEqual` integer — Value - returns all records with specified field not equal to this value. - `greaterThan` integer — Value - returns all records with specified field greater than to this value. - `greaterThanEqual` integer — Value - returns all records with specified field greater than or equal to this value. - `lessThan` integer — Value - returns all records with specified field less than to this value. - `lessThanEqual` integer — Value - returns all records with specified field less than or equal to this value. - `description` StringFilter — Name filter - `equal` string — Value - returns all records with specified field equal to this value. - `notEqual` string — Value - returns all records with specified field not equal to this value. - `greaterThan` string — Value - returns all records with specified field greater than to this value. - `greaterThanEqual` string — Value - returns all records with specified field greater than or equal to this value. - `lessThan` string — Value - returns all records with specified field less than to this value. - `lessThanEqual` string — Value - returns all records with specified field less than or equal to this value. - `contain` string — Value - returns all records with specified field containing this value. - `notes` StringFilter — Name filter - `equal` string — Value - returns all records with specified field equal to this value. - `notEqual` string — Value - returns all records with specified field not equal to this value. - `greaterThan` string — Value - returns all records with specified field greater than to this value. - `greaterThanEqual` string — Value - returns all records with specified field greater than or equal to this value. - `lessThan` string — Value - returns all records with specified field less than to this value. - `lessThanEqual` string — Value - returns all records with specified field less than or equal to this value. - `contain` string — Value - returns all records with specified field containing this value. - `status` EnumStatusListFilter — Status filter - `in` string[] - `notIn` string[] - `equal` 'ACTIVE' | 'INACTIVE' | 'REMOVED' - `notEqual` 'ACTIVE' | 'INACTIVE' | 'REMOVED' - `greaterThan` 'ACTIVE' | 'INACTIVE' | 'REMOVED' - `greaterThanEqual` 'ACTIVE' | 'INACTIVE' | 'REMOVED' - `lessThan` 'ACTIVE' | 'INACTIVE' | 'REMOVED' - `lessThanEqual` 'ACTIVE' | 'INACTIVE' | 'REMOVED' - `reviewStatus` ReviewStatusListFilter — Review status filter - `in` string[] — List of values to include. - `notIn` string[] — List of values to exclude. - `equal` 'RECONCILIATION_DISCREPANCY' | 'USER_REVIEW_REQUIRED' | 'ACCOUNTANT_REVIEW_REQUIRED' | 'PARTNER_REVIEW_REQUIRED' | 'AWAITING_MATCH' | 'STAGED' | 'RECONCILED' - `notEqual` 'RECONCILIATION_DISCREPANCY' | 'USER_REVIEW_REQUIRED' | 'ACCOUNTANT_REVIEW_REQUIRED' | 'PARTNER_REVIEW_REQUIRED' | 'AWAITING_MATCH' | 'STAGED' | 'RECONCILED' - `greaterThan` 'RECONCILIATION_DISCREPANCY' | 'USER_REVIEW_REQUIRED' | 'ACCOUNTANT_REVIEW_REQUIRED' | 'PARTNER_REVIEW_REQUIRED' | 'AWAITING_MATCH' | 'STAGED' | 'RECONCILED' - `greaterThanEqual` 'RECONCILIATION_DISCREPANCY' | 'USER_REVIEW_REQUIRED' | 'ACCOUNTANT_REVIEW_REQUIRED' | 'PARTNER_REVIEW_REQUIRED' | 'AWAITING_MATCH' | 'STAGED' | 'RECONCILED' - `lessThan` 'RECONCILIATION_DISCREPANCY' | 'USER_REVIEW_REQUIRED' | 'ACCOUNTANT_REVIEW_REQUIRED' | 'PARTNER_REVIEW_REQUIRED' | 'AWAITING_MATCH' | 'STAGED' | 'RECONCILED' - `lessThanEqual` 'RECONCILIATION_DISCREPANCY' | 'USER_REVIEW_REQUIRED' | 'ACCOUNTANT_REVIEW_REQUIRED' | 'PARTNER_REVIEW_REQUIRED' | 'AWAITING_MATCH' | 'STAGED' | 'RECONCILED' - `type` BankTransactionTypeFilter — Type filter - `in` string[] — List of values to include. - `notIn` string[] — List of values to exclude. - `bankAccount` BankAccountExpandFilter — Bank filter - `expand` boolean — Expand - whether to display additional nested data - `id` BankAccountIds — Id filter - returns all entities with the following bank accounts. - `in` string[] — List of values to include. - `notIn` string[] — List of values to exclude. - `vendor` VendorExpandFilter — Vendor filter - `expand` boolean — Expand - whether to display additional nested data - `id` VendorIds — Id filter - returns all entities with the following vendors. - `in` string[] — List of values to include. - `dimensionValues` DimensionValueExpandFilter — Dimension value filter - `expand` boolean — Expand - whether to display additional nested data - `id` DimensionValueIds — Id filter - returns all entities with the following dimension values. - `in` string[] — List of values to include. - `customer` CustomerExpandFilter — Customer filter - `expand` boolean — Expand - whether to display additional nested data - `id` CustomerIds — Id filter - returns all entities with the following customers. - `in` string[] — List of values to include. - `category` CategoryExpandFilter — Category filter - `expand` boolean — Expand - whether to display additional nested data - `id` CategoryIds — Id filter - returns all entities with the following categories. - `in` string[] — List of values to include. - `glAccount` GlAccountExpandFilter — GL account filter - `expand` boolean — Expand - whether to display additional nested data - `id` GlAccountIds — Id filter - returns all entities with the following General Ledger accounts. - `in` string[] — List of values to include. - `reconciliationMatch` MatchingBankTransactionFilter — Filter by linked bank transaction. Use {"id": {"equal": null}} to return payments not linked to any bank transaction. - `expand` boolean — Expand - whether to display additional nested data - `id` MatchingBankTransactionIds — Id filter - returns all entities with the following matching bank transactions. - `equal` string, nullable — Value - returns all records with specified field equal to this value. - `conversation` ConversationFilter — Conversation filter - `expand` boolean — Expand - whether to display additional nested data - `invoice` InvoiceFilter — Invoice filter - `expand` boolean — Expand - whether to display additional nested data - `lineItems` InvoiceLineItemFilter - `expand` boolean — Expand - whether to display additional nested data - `bill` BillFilter — Bill filter - `expand` boolean — Expand - whether to display additional nested data - `lineItems` BillLineItemFilter - `expand` boolean — Expand - whether to display additional nested data - `payroll` PayrollFilter — Payroll filter - `expand` boolean — Expand - whether to display additional nested data - `lineItems` PayrollLineItemFilter - `expand` boolean — Expand - whether to display additional nested data - `company` CompanyIdFilter — Company filter - `in` string[] — Company IDs to include - `lastUpdatedDateTime` string, date-time — Date filter ## Response `200` Success - PaginatedResponseBankTransactionGetDto - `result` 'SUCCESS' | 'FAILURE' — The result of the action performed. - `data` BankTransactionGetDto[] — The data generated by the action performed. - `id` string, required — Id of the bank transaction, required when updating an existing bank transaction - `type` 'EXPENSE' | 'REVENUE' | 'TRANSFER_IN' | 'TRANSFER_OUT', required — Type of the bank transaction - `date` string, date, required — Date of the bank transaction - `amount` integer, required — Total amount of the bank transaction (in cents) - `currencyInfo` CurrencyInfo, required — Currency conversion info for the bank transaction - `originalCurrency` 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VED' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL' — Original currency in which the transaction was ingested - `originalAmount` integer — Amount in the original currency which the transaction was ingested - `exchangeDate` string, date — Date on which the transaction amount was converted, if ingested in a different currency - `displayName` string, required — Transaction display name, useful for displaying this transaction to a user - `description` string, required — Transaction description, similar to what will show on the user's bank statement - `notes` string, nullable, required — Notes for the bank transactions - `status` 'ACTIVE' | 'INACTIVE' | 'REMOVED', required — Status of the bank transaction - `reviewStatus` 'RECONCILIATION_DISCREPANCY' | 'USER_REVIEW_REQUIRED' | 'ACCOUNTANT_REVIEW_REQUIRED' | 'PARTNER_REVIEW_REQUIRED' | 'AWAITING_MATCH' | 'STAGED' | 'RECONCILED', required — Review status of the bank transaction - `apiName` 'PLAID' | 'UNIT' | 'STRIPE' | 'SHOPIFY' | 'SQUARE' | 'RUTTER' | 'UBER' | 'MOOV' | 'QUALPAY' | 'MANUAL_ENTRY' | 'CSV_IMPORT' | 'PARTNER_IMPLEMENTATION' | 'QBO' | 'XERO' | 'BENCH' | 'WAVE', required — Name of the API from which this transaction originated - `iconUrl` string, required — Icon URL for the bank transaction - `apiSourceId` string, nullable, required — Id of the bank transaction on associated API - `bankAccount` BankAccountExpanded, required — Bank account of the matching bank transaction - `id` string, required — Id of the bank account - `name` string — Name of the bank account - `displayName` string — Display Name of the bank account - `dimensionValues` DimensionValueExpanded[], required - `id` string, required — Id of the dimension value - `dimension` DimensionExpanded — Dimension for this dimension value - `id` string, required — Id of the dimension - `name` string — Name of the dimension - `requiredness` 'REQUIRED' | 'NOT_REQUIRED' — Requiredness of the dimension - `name` string — Name of the dimension value - `child` ChildDimensionValue — Child dimension value, if applicable - `id` string, required — Id of the dimension value - `dimension` DimensionExpanded — Dimension for this dimension value - `id` string, required — Id of the dimension - `name` string — Name of the dimension - `requiredness` 'REQUIRED' | 'NOT_REQUIRED' — Requiredness of the dimension - `name` string — Name of the dimension value - `child` ChildDimensionValue — recursive - `customer` CustomerExpanded, nullable, required — Customer associated with this time entry - `id` string, required — Id of the customer - `name` string — Name of the customer - `email` string — Email of the customer - `vendor` VendorExpanded, nullable, required — Vendor associated with this child payment - `id` string, required — Id of the vendor - `name` string — Name of the vendor - `category` CategoryExpanded, nullable, required — Category associated with this child payment - `id` string, required — Id of the category - `name` string — Name of the category - `iconUrl` string — Icon URL of the category - `suggestedCategories` CategoryExpanded[], required - `id` string, required — Id of the category - `name` string — Name of the category - `iconUrl` string — Icon URL of the category - `glAccount` GlAccountExpanded, required — GL account details - `id` string, required — Id of the GL account - `name` string — Name of the GL account - `accountNo` string — Number of the GL account - `type` 'ASSET' | 'LIABILITY' | 'EQUITY' | 'INCOME' | 'COGS' | 'EXPENSE' | 'OTHER_INCOME' | 'OTHER_EXPENSE' | 'SUSPENSE' — Type the GL account - `iconUrl` string — Icon URL of the GL account - `displayName` string — Display name of the GL account - `reconciliationMatch` MatchingBankTransactionExpanded, nullable, required — The bank transaction matched to this payroll line item - `id` string — Id of the matching bank transaction - `apiSourceId` string, nullable — Id from the source of matching bank transaction - `amount` integer — Amount of the matching bank transaction (in cents) - `date` string, date — Date of the matching bank transaction - `description` string — Description of the matching bank transaction - `apiName` 'BOX' | 'CLOVER' | 'STRIPE' | 'PLAID' | 'KNOX' | 'UBER' | 'FRESHBOOKS' | 'HARVEST' | 'KW' | 'FRESHBOOKS2' | 'CAPITAL_ONE' | 'SQUARE' | 'DOTLOOP' | 'REALOGY' | 'UPWORK' | 'SHOPIFY' | 'DEDUCTR' | 'ENTERPRISE' | 'MOXIWORKS' | 'APPDIRECT' | 'LONEWOLF' | 'LONEWOLF_TRANSACTIONDESK' | 'SAMPLE_BANK' | 'TAXBOT' | 'GUSTO' | 'XERO' | 'UNIT' | 'MOOV' | 'QBO' | 'QUALPAY' | 'BENCH' | 'PARTNER_IMPLEMENTATION' | 'CHECK' | 'RUTTER' | 'WAVE' | 'MANUAL_ENTRY' | 'CSV_IMPORT' | 'ADYEN' | 'PAYABLI' — Name of the API of the matching bank transaction - `apiInstitutionId` string, nullable — Id of the institution that the matching bank transaction originated from - `bankAccount` BankAccountExpanded — Bank account of the matching bank transaction - `id` string, required — Id of the bank account - `name` string — Name of the bank account - `displayName` string — Display Name of the bank account - `conversation` ConversationExpanded, nullable, required — The conversation associated with this entity - `id` string, required — Id of the conversation - `readStatus` 'READ' | 'UNREAD' — Read status of the conversation for the authenticated user - `company` CompanyExpanded, required — Company associated with this conversation - `id` string, required — Id of the company - `name` string — Name of the company - `attachments` BankTransactionAttachmentExpanded[], required - `id` string, required — Id of the attachment - `url` string — URL at which the attachment is located - `fileName` string — File name of attachment - `fileSize` string — File size of attachment - `createdDateTime` string, date-time — Date that attachment was uploaded - `iconUrl` string — Icon URL based on file extension - `tax` TaxData, required — Tax data associated with this transaction - `paymentInfo` TaxPaymentFields, nullable — Payment information; only applicable for tax payment transactions - `region` 'FEDERAL' | 'STATE' | 'SALES' — Tax region of bank transaction - `year` integer — Year for which tax payment was made - `quarter` 'Q1' | 'Q2' | 'Q3' | 'Q4' — Quarter for which tax payment was made - `children` BankTransactionChildGetDto[], required - `id` string, required — Id of the child, required when updating an existing child - `type` 'EXPENSE' | 'REVENUE' | 'TRANSFER_IN' | 'TRANSFER_OUT', required — Type of the bank transaction - `date` string, date, required — Date of the bank transaction - `amount` integer, required — Total amount of the bank transaction (in cents) - `displayName` string, required — Transaction display name, useful for displaying this transaction to a user - `description` string, required — Transaction description, similar to what will show on the user's bank statement - `notes` string, nullable, required — Notes for the bank transaction - `reviewStatus` 'RECONCILIATION_DISCREPANCY' | 'USER_REVIEW_REQUIRED' | 'ACCOUNTANT_REVIEW_REQUIRED' | 'PARTNER_REVIEW_REQUIRED' | 'AWAITING_MATCH' | 'STAGED' | 'RECONCILED', required — Review status of the bank transaction - `apiName` 'PLAID' | 'UNIT' | 'STRIPE' | 'SHOPIFY' | 'SQUARE' | 'RUTTER' | 'UBER' | 'MOOV' | 'QUALPAY' | 'MANUAL_ENTRY' | 'CSV_IMPORT' | 'PARTNER_IMPLEMENTATION' | 'QBO' | 'XERO' | 'BENCH' | 'WAVE', required — Name of the API from which this transaction originated - `iconUrl` string, required — Icon URL for the bank transaction - `apiSourceId` string, nullable, required — Id of the bank transaction on associated API - `bankAccount` BankAccountExpanded, required — Bank account of the matching bank transaction - `id` string, required — Id of the bank account - `name` string — Name of the bank account - `displayName` string — Display Name of the bank account - `dimensionValues` DimensionValueExpanded[], required - `id` string, required — Id of the dimension value - `dimension` DimensionExpanded — Dimension for this dimension value - `id` string, required — Id of the dimension - `name` string — Name of the dimension - `requiredness` 'REQUIRED' | 'NOT_REQUIRED' — Requiredness of the dimension - `name` string — Name of the dimension value - `child` ChildDimensionValue — Child dimension value, if applicable - `id` string, required — Id of the dimension value - `dimension` DimensionExpanded — Dimension for this dimension value - `id` string, required — Id of the dimension - `name` string — Name of the dimension - `requiredness` 'REQUIRED' | 'NOT_REQUIRED' — Requiredness of the dimension - `name` string — Name of the dimension value - `child` ChildDimensionValue — recursive - `customer` CustomerExpanded, nullable, required — Customer associated with this time entry - `id` string, required — Id of the customer - `name` string — Name of the customer - `email` string — Email of the customer - `vendor` VendorExpanded, nullable, required — Vendor associated with this child payment - `id` string, required — Id of the vendor - `name` string — Name of the vendor - `category` CategoryExpanded, nullable, required — Category associated with this child payment - `id` string, required — Id of the category - `name` string — Name of the category - `iconUrl` string — Icon URL of the category - `glAccount` GlAccountExpanded, required — GL account details - `id` string, required — Id of the GL account - `name` string — Name of the GL account - `accountNo` string — Number of the GL account - `type` 'ASSET' | 'LIABILITY' | 'EQUITY' | 'INCOME' | 'COGS' | 'EXPENSE' | 'OTHER_INCOME' | 'OTHER_EXPENSE' | 'SUSPENSE' — Type the GL account - `iconUrl` string — Icon URL of the GL account - `displayName` string — Display name of the GL account - `invoice` InvoiceExpanded, nullable, required — Invoice associated with this time entry - `id` string, required — Id of the invoice - `name` string — Name of the invoice - `date` string, date — Date of the invoice - `lineItems` InvoiceLineItem[] - `id` string — Id of the invoice line item - `amount` integer — Total amount of the invoice line item (in cents) - `bill` BillExpanded, nullable, required — Bill associated with this child payment - `id` string, required — Id of the bill - `name` string — Name of the bill - `lineItems` BillLineItem[] - `id` string — Id of the bill line item - `amount` integer — Total amount of the bill line item (in cents) - `payroll` PayrollExpanded, nullable, required — Payroll associated with this bank transaction - `id` string, required — Id of the payroll - `date` string, date — Date when payroll was processed - `checkDate` string, date — Payroll check date - `description` string — Description if any - `lineItems` PayrollLineItem[] - `id` string — Id of the payroll line item - `amount` integer — Total amount of the payroll line item (in cents) - `paymentId` string, nullable, required — ID of the payment linked to this child - `apiItemId` string, nullable — Id of the bank transaction item on associated API - `lastUpdatedDateTime` string, date-time, required — Timestamp of when the bank transaction was last updated - `customData` JsonNode, nullable — Custom JSON in which you can store any data with max length of 2000 characters - `empty` boolean - `array` boolean - `null` boolean - `object` boolean - `float` boolean - `string` boolean - `number` boolean - `missingNode` boolean - `valueNode` boolean - `nodeType` 'ARRAY' | 'BINARY' | 'BOOLEAN' | 'MISSING' | 'NULL' | 'NUMBER' | 'OBJECT' | 'POJO' | 'STRING' - `pojo` boolean - `integralNumber` boolean - `floatingPointNumber` boolean - `short` boolean - `int` boolean - `long` boolean - `double` boolean - `bigDecimal` boolean - `bigInteger` boolean - `textual` boolean - `boolean` boolean - `binary` boolean - `container` boolean - `embeddedValue` boolean - `cursor` ResponseCursor — Cursor to be used in your subsequent paginated request. Only populated if there are more pages available. - `after` string — After cursor - Fetches entities after this cursor. Useful for paging forwards. - `before` string — Before cursor - Fetches entities before this cursor. Useful for paging backwards. ## Other responses - `400` — Bad request - `401` — Not authenticated - `403` — Not authorized - `404` — Endpoint not found - `500` — Internal server error --- [API](https://skmtc.net/tight/apis/tight-api.md) · [All operations](https://skmtc.net/tight/apis/tight-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/tight/tight-api/revisions/e9f0790a89af/schema)