Skip to main content

ark:TransactionPattern

idstring<uri>required

URI format identifier used to refer to this node within the graph.

Example: https://graph.datawollet.com/.draft-nodes/a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4
typestringrequired

A type identifier used to indicate the data model that the node conforms to.

Constant value: ark:TransactionPattern
Example: ark:TransactionPattern
relatedTostring<uri>required

Account the pattern is related to.

Example: https://graph.datawollet.com/.draft-nodes/0118735d359276fd42741493c449e568
period objectrequired

The recurrence period for this pattern.

intervalstringrequired

The interval type for the pattern.

Possible values: [MONTH, WEEK, QUARTER, SEMI_ANNUAL, ANNUAL]

Example: MONTH
frequencyintegerrequired

How often the pattern repeats within the interval (e.g., 1 = every interval, 2 = every other interval).

Possible values: >= 1

Example: 1
specifier objectrequired

Additional details about when in the interval the pattern occurs.

dayOfMonthinteger

Day of the month the pattern occurs (1-31). Uses 31 for end-of-month patterns.

Possible values: >= 1 and <= 31

Example: 15
dayOfWeekinteger

Day of the week the pattern occurs (0 = Sunday, 1 = Monday, ..., 6 = Saturday).

Possible values: >= 0 and <= 6

Example: 1
weekOfMonthinteger

Week of the month for week-of-month patterns (1-4 for first/second/third/fourth, -1 for last).

Possible values: >= -1 and <= 4

Example: 1
flexibilitystring

How the pattern adjusts for non-working days.

Possible values: [EXACT, WORKING_DAY_BEFORE, WORKING_DAY_AFTER, NEAREST_WORKING_DAY]

Example: WORKING_DAY_BEFORE
commonality objectrequired

Common attributes shared by all transactions in this pattern.

referencestring
FinancialSensitiveGDPRPSR2017

Shared reference across all transactions in the pattern.

Example: SALARY
counterpartystring
FinancialSensitiveGDPRPSR2017

Shared counterparty name across all transactions in the pattern.

Example: Netflix
merchantstring<uri>
FinancialSensitiveGDPRPSR2017

Shared merchant ID across all transactions in the pattern.

Example: https://graph.datawollet.com/organisation/netflix
descriptionstring
FinancialSensitiveGDPRPSR2017

Shared description across all transactions in the pattern.

Example: DIRECT DEBIT PAYMENT - NETFLIX
categorystring
FinancialSensitiveGDPRPSR2017

Shared primary category across all transactions in the pattern.

Example: entertainment
methodCategorystring

Shared payment method category across all transactions in the pattern.

Possible values: [PAYMENT, PAYMENT:ONLINE, PAYMENT:DIRECT_DEBIT, PAYMENT:STANDING_ORDER, PAYMENT:CARD, PAYMENT:CARD:CONTACTLESS, TRANSFER, TRANSFER:OUT, TRANSFER:FASTER, TRANSFER:SAVINGS:OUT, TRANSFER:SAVINGS:IN, TRANSFER:P2P, TRANSFER:CHAPS, CREDIT, UNKNOWN]

Example: PAYMENT:DIRECT_DEBIT
amountstring
FinancialSensitiveGDPRPSR2017

Average amount across all transactions in the pattern, formatted as a decimal string.

Possible values: Value must match regular expression ^[0-9]+(\.[0-9]{2})?$

Example: 15.99
currencystring

Shared currency code across all transactions in the pattern.

Example: GBP
directionstring

Shared direction (Credit or Debit) across all transactions in the pattern.

Possible values: [Credit, Debit]

Example: Debit
transactionsstring<uri>[]required

List of transaction IDs that belong to this pattern.

Possible values: >= 2

Example: ["https://graph.datawollet.com/.draft-nodes/tx1","https://graph.datawollet.com/.draft-nodes/tx2","https://graph.datawollet.com/.draft-nodes/tx3"]
startDatestring<date>required

Date of the first transaction in the pattern.

Example: 2024-01-15
endDatestring<date>required

Date of the last transaction in the pattern.

Example: 2024-03-15
nextExpectedstring<date>[]required

Predicted dates for the next occurrences of this pattern.

Example: ["2024-04-15","2024-05-15","2024-06-14"]
ark:TransactionPattern
{
  "id": "https://graph.datawollet.com/.draft-nodes/a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4",
  "type": "ark:TransactionPattern",
  "relatedTo": "https://graph.datawollet.com/.draft-nodes/0118735d359276fd42741493c449e568",
  "period": {
    "interval": "MONTH",
    "frequency": 1,
    "specifier": {
      "dayOfMonth": 15,
      "dayOfWeek": 1,
      "weekOfMonth": 1,
      "flexibility": "WORKING_DAY_BEFORE"
    }
  },
  "commonality": {
    "reference": "SALARY",
    "counterparty": "Netflix",
    "merchant": "https://graph.datawollet.com/organisation/netflix",
    "description": "DIRECT DEBIT PAYMENT - NETFLIX",
    "category": "entertainment",
    "methodCategory": "PAYMENT:DIRECT_DEBIT",
    "amount": "15.99",
    "currency": "GBP",
    "direction": "Debit"
  },
  "transactions": [
    "https://graph.datawollet.com/.draft-nodes/tx1",
    "https://graph.datawollet.com/.draft-nodes/tx2",
    "https://graph.datawollet.com/.draft-nodes/tx3"
  ],
  "startDate": "2024-01-15",
  "endDate": "2024-03-15",
  "nextExpected": [
    "2024-04-15",
    "2024-05-15",
    "2024-06-14"
  ]
}