ark:RegularCharge
Deprecated
idurirequired
URI format identifier used to refer to this node within the graph.
Example:
https://graph.onteric.com/.draft-nodes/f85b8b6b37fe3e8b144829d200000000typestringrequired
A type identifier used to indicate the data model that the node conforms to.
Constant value:
ark:RegularChargeExample:
ark:RegularChargerelatedTourirequired
Example:
https://graph.onteric.com/.draft-nodes/f85b8b6b37fe3e8b144829d200000000paymentFrequencystringrequired
Onteric currently only supports a monthly amount, but let us know if you have a different interval.
Possible values: [Monthly]
totalAmount objectrequiredSensitiveGDPR
type
Constant value:
ark:CurrencyValueamountstringrequired
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]
namestring
SensitiveGDPR
This is optional but can help to explain the detail of what the payment is for. Onteric sometimes looks for keywords in the name such as 'electricity' to provide more granular insights.
effectiveFromdate
The date that this rate applies from, useful if the amount increases from time to time.
ark:RegularCharge
{
"id": "https://graph.onteric.com/.draft-nodes/f85b8b6b37fe3e8b144829d200000000",
"type": "ark:RegularCharge",
"relatedTo": "https://graph.onteric.com/.draft-nodes/f85b8b6b37fe3e8b144829d200000000",
"paymentFrequency": "Monthly",
"totalAmount": {
"amount": "string",
"currency": "string",
"direction": "Credit"
},
"name": "string",
"effectiveFrom": "2024-07-29"
}