Bank transactions are transactions that have occurred within a bank account owned by a business.
Attributes
Unique identifier for the bank transaction.
Unique ID of the bank transaction in your system for linking purposes. Idempotency key.
Resource type. Value will be “Bank_Transaction”.
ID for the Business this transaction belongs to.
The source that the bank transaction was imported from.
Values can be: UNIT, PLAID, API
Unique ID of the bank transaction in its source system. Idempotency key.
ID of the source account in the source system.
Date the transaction occurred.
The direction of the transaction relative to the source account.
Values can be: CREDIT, DEBIT
The amount of the transaction in cents.
The name of the merchant or counterparty associated with the transaction.
Description of the transaction.
The type of bank account transaction.
Example values: PURCHASE, BOOK, ATM, WIRE, etc.
The status of the transaction’s categorization in Layer’s systems.
Values can be: PENDING, READY_FOR_INPUT, CATEGORIZED, LAYER_REVIEW
The category assigned to the transaction. Only populated for transactions that have a finalized category.
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.
A human-readable string describing the category. This can be presented to the end user in your UI.
suggested_matches
array containing SuggestedMatch objects
The suggested matches for the transaction.
The type of suggested match. Options include Transfer_Match, Invoice_Match, Payout_Match, and Journal_Entry_Match.
The details of the suggested match.
The type of the details object based off the matchable target. Options include TRANSFER, INVOICE_PAYMENT, PAYOUT, and MANUAL_JOURNAL_ENTRY.
The unique identifier of the matchable target (e.g., invoice payment ID).
The amount involved in the match, in cents.
The date of the target of the suggested match in ISO8601 format.
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"
},
"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"
}
}
],
}
