Skip to main content

ark:RegularCharge

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:RegularCharge
Example: ark:RegularCharge
relatedTostring<uri>required
Example: https://graph.datawollet.com/.draft-nodes/f85b8b6b37fe3e8b144829d200000000
paymentFrequency objectrequired

DataWollet currently only supports a monthly amount, but let us know if you have a different interval.

anyOf
Constant value: Monthly
totalAmount objectrequired
SensitiveGDPR
type
Constant value: ark:CurrencyValue
amountstringrequired

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

currencystringrequired
directionstring

Possible values: [Credit, Debit]

namestring
SensitiveGDPR

This is optional but can help to explain the detail of what the payment is for. DataWollet sometimes looks for keywords in the name such as 'electricity' to provide more granular insights.

effectiveFromstring<date>

The date that this rate applies from, useful if the amount increases from time to time.

property name*any
ark:RegularCharge
{
  "id": "https://graph.datawollet.com/.draft-nodes/f85b8b6b37fe3e8b144829d200000000",
  "type": "ark:RegularCharge",
  "relatedTo": "https://graph.datawollet.com/.draft-nodes/f85b8b6b37fe3e8b144829d200000000",
  "totalAmount": {
    "amount": "string",
    "currency": "string",
    "direction": "Credit"
  },
  "name": "string",
  "effectiveFrom": "2024-07-29"
}