ark:PayPeriodPattern

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:PayPeriodPattern

Example: ark:PayPeriodPattern

relatedTourirequired

The employment that this pay period pattern is related to.

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

payFrequencystring

The frequency at which the employee is paid, taken from the employment or derived from the pay period dates. Omitted when it cannot be determined reliably.

Possible values: [Weekly, Fortnightly, Four-weekly, Monthly, Quarterly, Semi-annual, Annual]

Example: Monthly

startDatedate

The start date of the first pay period in the pattern.

Example: 2026-01-01

endDatedate

The end date of the last pay period in the pattern.

Example: 2026-03-31

grossPay objectrequired

Summary statistics for gross pay across the pay periods in the pattern.

minimum objectrequired

The smallest gross pay observed in any single pay period.

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 gross pay observed in any single pay period.

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})?$

averagePerPeriodAfterDeductions objectrequired

The mean regular gross pay per period after salary-sacrifice (Debit) items, excluding irregular items.

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})?$

averagePerPeriodBeforeDeductions objectrequired

The mean regular gross pay per period before salary-sacrifice (Debit) items, excluding irregular items.

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})?$

averageAnnualisedBeforeDeductions object

The estimated annual gross salary before salary-sacrifice deductions, derived by annualising the regular gross pay using the pay frequency.

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})?$

netPay objectrequired

Summary statistics for net pay across the pay periods in the pattern.

minimum objectrequired

The smallest net pay observed in any single pay period.

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 net pay observed in any single pay period.

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})?$

averagePerPeriod objectrequired

The mean net pay per period.

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})?$

payItemPatternsuri[]

The pay item pattern nodes summarised by this pay period pattern.

Example: ["https://graph.onteric.com/.draft-nodes/payitempattern1","https://graph.onteric.com/.draft-nodes/payitempattern2"]

payPeriodsuri[]

The pay period nodes summarised by this pay period pattern.

Example: ["https://graph.onteric.com/.draft-nodes/payperiod1","https://graph.onteric.com/.draft-nodes/payperiod2"]

ark:PayPeriodPattern

{
  "id": "https://graph.onteric.com/.draft-nodes/a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4",
  "type": "ark:PayPeriodPattern",
  "relatedTo": "https://graph.onteric.com/.draft-nodes/employment-1234567890",
  "payFrequency": "Monthly",
  "startDate": "2026-01-01",
  "endDate": "2026-03-31",
  "grossPay": {
    "minimum": {
      "type": "ark:CurrencyValue",
      "currency": "GBP",
      "amount": "2000.00"
    },
    "maximum": {
      "type": "ark:CurrencyValue",
      "currency": "GBP",
      "amount": "3000.00"
    },
    "averagePerPeriodAfterDeductions": {
      "type": "ark:CurrencyValue",
      "currency": "GBP",
      "amount": "2400.00"
    },
    "averagePerPeriodBeforeDeductions": {
      "type": "ark:CurrencyValue",
      "currency": "GBP",
      "amount": "2500.00"
    },
    "averageAnnualisedBeforeDeductions": {
      "type": "ark:CurrencyValue",
      "currency": "GBP",
      "amount": "30000.00"
    }
  },
  "netPay": {
    "minimum": {
      "type": "ark:CurrencyValue",
      "currency": "GBP",
      "amount": "1600.00"
    },
    "maximum": {
      "type": "ark:CurrencyValue",
      "currency": "GBP",
      "amount": "2200.00"
    },
    "averagePerPeriod": {
      "type": "ark:CurrencyValue",
      "currency": "GBP",
      "amount": "1900.00"
    }
  },
  "payItemPatterns": [
    "https://graph.onteric.com/.draft-nodes/payitempattern1",
    "https://graph.onteric.com/.draft-nodes/payitempattern2"
  ],
  "payPeriods": [
    "https://graph.onteric.com/.draft-nodes/payperiod1",
    "https://graph.onteric.com/.draft-nodes/payperiod2"
  ]
}