Skip to main content

ark:PaymentPattern

idurirequired

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

Example: https://graph.onteric.com/.draft-nodes/f85b8b6b37fe3e8b144829d200000000
typestringrequired

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

Constant value: ark:PaymentPattern
Example: ark:PaymentPattern
relatedTourirequired

The account, bill, mortgage or other obligation these payments are for.

Example: https://graph.onteric.com/.draft-nodes/0118735d359276fd42741493c449e568
effectiveAtdaterequired

The date this payment pattern was determined.

Example: 2026-01-01
commonality object

Attributes shared by every payment in this pattern.

regularAmount object
SensitiveGDPR

The amount of each payment, where every payment in the pattern is the same.

type
Constant value: ark:CurrencyValue
amountstringrequired

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

currencystringrequired

Possible values: Value must match regular expression ^[A-Z]{3}$

directionstring

Possible values: [Credit, Debit]

period object

The recurrence period for the payments.

intervalstringrequired

The interval type for the pattern.

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

Example: MONTH
frequencyintegerrequired

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

Possible values: >= 1

Example: 1
specifier object

Additional detail about when in the interval the payment occurs, where known.

dayOfMonthinteger

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

Possible values: >= 1 and <= 31

Example: 15
dayOfWeekinteger

Day of the week the payment 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 payment adjusts for non-working days.

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

Example: WORKING_DAY_BEFORE
numberOfPaymentsinteger

The total number of payments in this pattern. Omit for an open-ended (perpetual) pattern.

Possible values: >= 1

Example: 5
startAfteruri

A preceding ark:PaymentPattern that this pattern continues from, once that pattern's payments are complete. Use instead of startDate for a continuation segment.

Example: https://graph.onteric.com/.draft-nodes/0118735d359276fd42741493c449e567
startDatedate

The date of the first payment in this pattern. Use for a standalone or first pattern; omit when startAfter is set.

Example: 2026-02-01
descriptionstring
SensitiveGDPR

An optional label for the payments, such as a keyword that helps explain what they are for (e.g. 'Electricity').

Example: Electricity
ark:PaymentPattern
{
  "id": "https://graph.onteric.com/.draft-nodes/f85b8b6b37fe3e8b144829d200000000",
  "type": "ark:PaymentPattern",
  "relatedTo": "https://graph.onteric.com/.draft-nodes/0118735d359276fd42741493c449e568",
  "effectiveAt": "2026-01-01",
  "commonality": {
    "regularAmount": {
      "amount": "string",
      "currency": "string",
      "direction": "Credit"
    }
  },
  "period": {
    "interval": "MONTH",
    "frequency": 1,
    "specifier": {
      "dayOfMonth": 15,
      "dayOfWeek": 1,
      "weekOfMonth": 1,
      "flexibility": "WORKING_DAY_BEFORE"
    }
  },
  "numberOfPayments": 5,
  "startAfter": "https://graph.onteric.com/.draft-nodes/0118735d359276fd42741493c449e567",
  "startDate": "2026-02-01",
  "description": "Electricity"
}