Bank Transaction object

Bank transactions are transactions that have occurred within a bank account owned by a business.

Attributes

string

Unique identifier for the bank transaction.

string

Unique ID of the bank transaction in your system for linking purposes. Idempotency key.

string

Resource type. Value will be “Bank_Transaction”.

string

ID for the Business this transaction belongs to.

enum

The source that the bank transaction was imported from. Values can be: UNIT, PLAID, API

string

Unique ID of the bank transaction in its source system. Idempotency key.

string

ID of the source account in the source system.

ISO8601 timestamp

Date the transaction occurred.

enum

The direction of the transaction relative to the source account. Values can be: CREDIT, DEBIT

integer

The amount of the transaction in cents.

string

The name of the merchant or counterparty associated with the transaction.

string

Description of the transaction.

string

The type of bank account transaction. Example values: PURCHASE, BOOK, ATM, WIRE, etc.

enum

The status of the transaction’s categorization in Layer’s systems. Values can be: PENDING, READY_FOR_INPUT, CATEGORIZED, LAYER_REVIEW

Category object

The category assigned to the transaction. Only populated for transactions that have a finalized category.

Show properties

enum

String enum for the category assigned to the transaction. The set of category enums will vary based on chart of account configured for the business.

string

A human-readable string describing the category. This can be presented to the end user in your UI.

string (nullable)

Tax code applied to the transaction’s categorization. Currently only supported for businesses incorporated in Canada (country is CA). See tax_options below for the codes valid for this transaction’s date, and Categorize a Transaction for how to set it.

Tax Options object (nullable)

Tax codes available for categorizing this transaction, scoped to the business’s country and the transaction’s date. Currently only populated for businesses incorporated in Canada (country is CA); null otherwise.

Show properties

array

Available Canada Revenue Agency tax codes for this transaction’s date.

Show properties

string

The value to send in tax_code when categorizing.

string

Human-readable, locale-aware name for the tax code.

enum

Values can be: TAXABLE, EXEMPT, ZERO_RATED, OUT_OF_SCOPE.

string (nullable)

The Canadian province this tax code applies to, if province-specific (e.g. BRITISH_COLUMBIA, ONTARIO, QUEBEC).

string

Sum of all component rates for this tax code, as a percentage.

string (nullable)

Date this tax code became effective, if bounded.

string (nullable)

Last date this tax code is effective, if bounded.

array

Tax components (e.g. GST, PST) that make up this tax code.

Show properties

string

Identifier for this tax component.

enum

Values can be: GST, HST, PST, QST.

string (nullable)

The Canadian province this component applies to, if any.

string

Rate for this component, as a percentage.

boolean

Whether this tax component is recoverable (e.g. as an input tax credit).

Create_Categorization_Rule_For_Counterparty object (nullable)

Optional rule suggestion returned after categorization when Layer recommends creating a reusable categorization rule. If no suggestion is available, this field is null.See Categorization Rule Suggestions for more details.

Show properties

enum

Suggestion type. Value will be Create_Categorization_Rule_For_Counterparty.

string (uuid)

Unique identifier for this suggestion. Use this ID for tracking suggestion state and rejecting a suggestion.

ISO8601 timestamp

Timestamp when the suggestion was created.

enum

Suggestion status. Values can be: PENDING, ACCEPTED, REJECTED.

object

Counterparty associated with the suggestion.

string

UI-ready prompt text to display when asking a user whether to create the suggested rule.

CreateCategorizationRuleParams object

Prebuilt payload that can be sent to Create Categorization Rule (this is how suggestions are accepted).

Show common properties

boolean

Whether to apply the rule to existing uncategorized transactions.

string (uuid)

Suggestion ID used to create this rule.

string (uuid)

Counterparty filter for the rule.

Account Identifier object

Rule category identifier.

enum

Direction filter. Values can be: DEBIT, CREDIT.

array

Preview list of transactions affected by the suggested rule.

array containing SuggestedMatch objects

The suggested matches for the transaction. See Match Bank Transaction for more details.

Show properties

string

The unique identifier for the suggested match. Can be used to match a bank transaction.

string

The type of suggested match. Options include Transfer_Match, Invoice_Match, Payout_Match, and Journal_Entry_Match.

object

The details of the suggested match.

Show properties

string

The type of the details object based off the matchable target. Options include TRANSFER, INVOICE_PAYMENT, PAYOUT, and MANUAL_JOURNAL_ENTRY.

string

The unique identifier of the matchable target (e.g., invoice payment ID).

integer

The amount involved in the match, in cents.

ISO8601 timestamp

The date of the target of the suggested match in ISO8601 format.

string

A description of the suggested match.

{
  "id":"67cee0d8-3b8e-4b4b-a857-78ce3bb1d895",
  "type":"Bank_Transaction",
  "transaction_type":"Purchase",
  "business_id":"cfee5365-dcc3-425e-b403-cc9568f7121e",
  "source":"API",
  "source_transaction_id":"11111113",
  "source_account_id":"111113",
  "imported_at":"2023-06-07T00:42:08.664543Z",
  "date":"2023-05-15T14:13:07Z",
  "direction":"Debit",
  "amount":8026,
  "counterparty_name":"SUNOCO",
  "description":null,
  "categorization_status":"CATEGORIZED",
  "category":{
    "category":"FUEL",
    "display_name":"Fuel"
  },
  "update_categorization_rules_suggestion": {
    "type": "Create_Categorization_Rule_For_Counterparty",
    "id": "b3488b6a-c7b4-4d2a-a8c7-7d15f9942ed4",
    "created_at": "2025-02-14T17:22:01Z",
    "status": "PENDING",
    "counterparty": {
      "id": "f1664961-43d8-42f1-9a6d-c6c32a9f0adf",
      "name": "SUNOCO"
    },
    "suggestion_prompt": "Would you like to create a rule for outbound SUNOCO transactions?",
    "new_rule": {
      "apply_retroactively": true,
      "created_by_suggestion_id": "b3488b6a-c7b4-4d2a-a8c7-7d15f9942ed4",
      "counterparty_filter": "f1664961-43d8-42f1-9a6d-c6c32a9f0adf",
      "category": {
        "type": "StableName",
        "stable_name": "FUEL"
      },
      "bank_direction_filter": "MONEY_OUT"
    },
    "transactions_that_will_be_affected": []
  },
  "suggested_matches": [
      {
          "id": "cf33f1b6-ac18-480e-ab58-82aab4ab86f4",
          "matchType": "INVOICE_PAYMENT",
          "details": {
              "type": "Invoice_Match",
              "id": "0cfb7d11-874a-4c15-a9f9-875c21d95c86",
              "amount": 8026,
              "date": "2023-05-16T10:12:09Z",
              "description": "Invoice payment from FakeCustomer"
          }
      }
  ],
}

Businesses

Financial Activity

Accounting Reports

Platform Configuration

Activity Metrics

Integrations

Bank Transaction object

Attributes

​Attributes

Attributes