ark:PayItemPattern

Generated

idurirequired

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

Example: https://graph.onteric.com/.draft-nodes/a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4

typestringrequired

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

Constant value: ark:PayItemPattern

Example: ark:PayItemPattern

relatedTourirequired

The employment that this pay item pattern is related to.

Example: https://graph.onteric.com/.draft-nodes/employment-1234567890

descriptionstringrequired

SensitiveGDPR

A representative description shared by the pay items in this pattern (e.g., Basic Salary, Overtime, Bonus).

Example: Basic Salary

startDatedate

The start date of the first pay period in which this pay item appears.

Example: 2026-01-01

endDatedate

The end date of the last pay period in which this pay item appears.

Example: 2026-03-31

occurrencestringrequired

Whether the pay item appears in every pay period (REGULAR) or only some of them (IRREGULAR).

Possible values: [REGULAR, IRREGULAR]

Example: REGULAR

directionstring

Whether the pay item adds to (Credit) or subtracts from (Debit, e.g. salary sacrifice) gross pay.

Possible values: [Credit, Debit]

Example: Credit

amount objectrequired

Summary statistics for the pay item amount across the pay periods it appears in.

minimum objectrequired

The smallest amount observed for this pay item.

typerequired

Constant value: ark:CurrencyValue

currencystring

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

amountstringrequired

FinancialSensitiveGDPR

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

maximum objectrequired

The largest amount observed for this pay item.

typerequired

Constant value: ark:CurrencyValue

currencystring

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

amountstringrequired

FinancialSensitiveGDPR

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

average objectrequired

The mean amount observed for this pay item.

typerequired

Constant value: ark:CurrencyValue

currencystring

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

amountstringrequired

FinancialSensitiveGDPR

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

payItemsuri[]required

The pay item nodes summarised by this pattern.

Example: ["https://graph.onteric.com/.draft-nodes/payitem1","https://graph.onteric.com/.draft-nodes/payitem2"]

ark:PayItemPattern

{
  "id": "https://graph.onteric.com/.draft-nodes/a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4",
  "type": "ark:PayItemPattern",
  "relatedTo": "https://graph.onteric.com/.draft-nodes/employment-1234567890",
  "description": "Basic Salary",
  "startDate": "2026-01-01",
  "endDate": "2026-03-31",
  "occurrence": "REGULAR",
  "direction": "Credit",
  "amount": {
    "minimum": {
      "type": "ark:CurrencyValue",
      "currency": "GBP",
      "amount": "1800.00"
    },
    "maximum": {
      "type": "ark:CurrencyValue",
      "currency": "GBP",
      "amount": "2000.00"
    },
    "average": {
      "type": "ark:CurrencyValue",
      "currency": "GBP",
      "amount": "1900.00"
    }
  },
  "payItems": [
    "https://graph.onteric.com/.draft-nodes/payitem1",
    "https://graph.onteric.com/.draft-nodes/payitem2"
  ]
}