Banking

Create a versioned bank rule and queue the feed pipeline

Direction and absolute amount bounds are evaluated before the selected text field. The rule mutation and durable pipeline enqueue commit together.

post/bank-rules

Request

  • Base URL: https://ledgerhq.pro/api/v1
  • URL: https://ledgerhq.pro/api/v1/bank-rules
  • Auth: one of:
    • HTTP bearer and API key in header x-organization-id
    • HTTP bearer and API key in header x-organization-id

Request body

namestring required
priorityinteger
matchField'description' | 'reference' | 'merchant'
matchType'contains' | 'equals' | 'starts_with' | 'ends_with' required
matchValuestring required
accountIdstring uuid nullable
classIdstring uuid nullable

Class stamped on rows this rule codes

allocationTemplateIdstring uuid nullable

Class allocation stamped on rows this rule codes, in place of classId

contactIdstring uuid nullable
taxRateIdstring uuid nullable
direction'any' | 'money_in' | 'money_out'
amountMininteger nullable

Minimum absolute amount in cents

amountMaxinteger nullable

Maximum absolute amount in cents

Response

Created versioned rule

Changes

No recorded changes to this operation across all 5 revisions of this API.