ark:PayPeriod

idstring<uri>required

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

Example: https://graph.datawollet.com/.draft-nodes/f85b8b6b37fe3e8b144829d200000000

typestringrequired

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

Constant value: ark:PayPeriod

Example: ark:PayPeriod

relatedTostring<uri>

The employment or contract that this pay period is related to.

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

startDatestring<date>

The start date of the pay period.

Example: 2026-01-01

endDatestring<date>

The end date of the pay period.

Example: 2026-01-31

paymentDatestring<date>

The date the payment was made.

Example: 2026-01-25

grossPay object

typerequired

Constant value: ark:CurrencyValue

currencystring

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

amountstringrequired

FinancialGDPR

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

directionstring

Will show as 'Debit' if the amount is negative, such as with refunds.

Possible values: [Debit]

taxablePay object

typerequired

Constant value: ark:CurrencyValue

currencystring

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

amountstringrequired

FinancialGDPR

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

directionstring

Will show as 'Debit' if the amount is negative, such as with refunds.

Possible values: [Debit]

pensionablePay object

typerequired

Constant value: ark:CurrencyValue

currencystring

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

amountstringrequired

FinancialGDPR

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

directionstring

Will show as 'Debit' if the amount is negative, such as with refunds.

Possible values: [Debit]

nonTaxablePay object

typerequired

Constant value: ark:CurrencyValue

currencystring

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

amountstringrequired

FinancialGDPR

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

directionstring

Will show as 'Debit' if the amount is negative, such as with refunds.

Possible values: [Debit]

totalDeductions object

typerequired

Constant value: ark:CurrencyValue

currencystring

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

amountstringrequired

FinancialGDPR

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

directionstring

Will show as 'Debit' if the amount is negative, such as with refunds.

Possible values: [Debit]

transactionsstring<uri>[]

List of transaction IDs that correspond to the salary or other income made during the period.

netPay object

typerequired

Constant value: ark:CurrencyValue

currencystring

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

amountstringrequired

FinancialGDPR

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

directionstring

Will show as 'Debit' if the amount is negative, such as with refunds.

Possible values: [Debit]

ark:PayPeriod

{
  "id": "https://graph.datawollet.com/.draft-nodes/f85b8b6b37fe3e8b144829d200000000",
  "type": "ark:PayPeriod",
  "relatedTo": "https://graph.datawollet.com/.draft-nodes/employment-contract-1234567890",
  "startDate": "2026-01-01",
  "endDate": "2026-01-31",
  "paymentDate": "2026-01-25",
  "grossPay": {
    "type": "ark:CurrencyValue",
    "currency": "GBP",
    "amount": "2500.58"
  },
  "taxablePay": {
    "type": "ark:CurrencyValue",
    "currency": "GBP",
    "amount": "1200.00"
  },
  "pensionablePay": {
    "type": "ark:CurrencyValue",
    "currency": "GBP",
    "amount": "800.00"
  },
  "nonTaxablePay": {
    "type": "ark:CurrencyValue",
    "currency": "GBP",
    "amount": "1300.58"
  },
  "totalDeductions": {
    "type": "ark:CurrencyValue",
    "currency": "GBP",
    "amount": "500.00"
  },
  "transactions": [
    "string"
  ],
  "netPay": {
    "type": "ark:CurrencyValue",
    "currency": "GBP",
    "amount": "2000.58"
  }
}