Category (Stable Name)
Category (Account Id)
Split
curl -X POST https://sandbox.layerfi.com/v1/businesses/863ed926-e30d-40f4-8e7e-b0d5387ce4fb/bank-transactions/67cee0d8-3b8e-4b4b-a857-78ce3bb1d895/categorize \ -H "Authorization: Bearer <access_token>" \
-H "Content-Type: application/json" \
-d '{
"type" : "Category" ,
"category" : {
"type" : "StableName" ,
"stable_name" : "MEALS"
}
} '
{ "data" : {
"id" : "c63a7a21-d6d7-4d3a-b8f3-e419161a9516" ,
"type" : "Bank_Transaction" ,
"transaction_type" : "Book" ,
"business_id" : "cfee5365-dcc3-425e-b403-cc9568f7121e" ,
"source" : "API" ,
"source_transaction_id" : "11111114" ,
"source_account_id" : "111113" ,
"imported_at" : "2023-06-07T00:48:25.784724Z" ,
"date" : "2023-05-10T14:13:07Z" ,
"direction" : "DEBIT" ,
"amount" : 5670 ,
"counterparty_name" : "Home Depot" ,
"description" : "HOMEDEPOT MI59" ,
"categorization_status" : "CATEGORIZED" ,
"category" : {
"category" : "SUPPLIES" ,
"display_name" : "Supplies"
} ,
"categorization_method" : "LAYER_AUTO" ,
"categorization_flow" : {
"type" : "ASK_FROM_SUGGESTIONS" ,
"categories" : [
{
"category" : "SUPPLIES" ,
"display_name" : "Supplies"
} ,
{
"category" : "EQUIPMENT" ,
"display_name" : "Business equipment"
} ,
{
"category" : "MARKETING" ,
"display_name" : "Marketing expenses"
}
]
}
} ,
"meta" : {
}
} Path Parameters ID of the Business the bank transaction is associated with.
ID of the Bank Transaction to categorize.
Body Either a Category or a Split may be provided.
Splits are used when the transaction’s value should be allocated across multiple categories.
This is most commonly the case when multiple items are purchased and those items should be categorized separately.
Category Category payloads should have a type field and a category field.
This category field can be any Account Identifier .
The available categories can be fetched using the Fetch transaction categories endpoint.
Category payload using a StableName
Set to Category when categorizing the transaction as a single (non-split) category.
Set to StableName when using a stable name for the category.
The stable name from any option, as a string.
Category payload using an AccountId
Set to Category when categorizing the transaction as a single (non-split) category.
Set to AccountId when using an account ID for the category.
The account id, set as a string.
Split Categorizations Splits are specified with an array of categorizations, as above, with an amount tied to each category.
The total amount must exactly equal the amount of the transaction.
Amounts are always specified in positive cents.
Set to Split when categorizing the transaction as a single (non-split) category.
Array of entries consisting of a category and an amount.
This category payload is the same as the category payloads for non-splits. Either Account Ids or Stable Names can be used.
The account id, set as a string - or use stable_name instead of id.
Amount, in cents, to categorize to this portion of the split.
Response Returns the categorized Bank Transaction Object
Category (Stable Name)
Category (Account Id)
Split
curl -X POST https://sandbox.layerfi.com/v1/businesses/863ed926-e30d-40f4-8e7e-b0d5387ce4fb/bank-transactions/67cee0d8-3b8e-4b4b-a857-78ce3bb1d895/categorize \ -H "Authorization: Bearer <access_token>" \
-H "Content-Type: application/json" \
-d '{
"type" : "Category" ,
"category" : {
"type" : "StableName" ,
"stable_name" : "MEALS"
}
} '
{ "data" : {
"id" : "c63a7a21-d6d7-4d3a-b8f3-e419161a9516" ,
"type" : "Bank_Transaction" ,
"transaction_type" : "Book" ,
"business_id" : "cfee5365-dcc3-425e-b403-cc9568f7121e" ,
"source" : "API" ,
"source_transaction_id" : "11111114" ,
"source_account_id" : "111113" ,
"imported_at" : "2023-06-07T00:48:25.784724Z" ,
"date" : "2023-05-10T14:13:07Z" ,
"direction" : "DEBIT" ,
"amount" : 5670 ,
"counterparty_name" : "Home Depot" ,
"description" : "HOMEDEPOT MI59" ,
"categorization_status" : "CATEGORIZED" ,
"category" : {
"category" : "SUPPLIES" ,
"display_name" : "Supplies"
} ,
"categorization_method" : "LAYER_AUTO" ,
"categorization_flow" : {
"type" : "ASK_FROM_SUGGESTIONS" ,
"categories" : [
{
"category" : "SUPPLIES" ,
"display_name" : "Supplies"
} ,
{
"category" : "EQUIPMENT" ,
"display_name" : "Business equipment"
} ,
{
"category" : "MARKETING" ,
"display_name" : "Marketing expenses"
}
]
}
} ,
"meta" : {
}
} 