Skip to main content

ark:AccountCharge

A charge recorded on a billing account, representing an obligation and its fulfilment rather than a ledger event. Unlike an ark:Transaction (a movement of money), an ark:AccountCharge is an amount owed that may remain unpaid for an extended period. Suitable for use with billing accounts rather than ledgers.

anyOf
idurirequired

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

Example: https://graph.onteric.com/.draft-nodes/f85b8b6b37fe3e8b144829d200000000
typestringrequired

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

Constant value: ark:AccountCharge
Example: ark:AccountCharge
relatedTourirequired
Example: https://graph.onteric.com/.draft-nodes/f85b8b6b37fe3e8b144829d200000000
datedate
totalAmount objectrequired
SensitiveGDPR
type
Constant value: ark:CurrencyValue
amountstringrequired

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, such as if it's an interest charge or the service provided.

periodStartdate
periodEnddate

If the charge relates to a specific time period, like for utilities, then adding these dates can improve the accuracy of our estimates.

ark:AccountCharge
{
  "id": "https://graph.onteric.com/.draft-nodes/f85b8b6b37fe3e8b144829d200000000",
  "type": "ark:AccountCharge",
  "relatedTo": "https://graph.onteric.com/.draft-nodes/f85b8b6b37fe3e8b144829d200000000",
  "date": "2024-07-29",
  "totalAmount": {
    "amount": "string",
    "currency": "string",
    "direction": "Credit"
  },
  "name": "string",
  "periodStart": "2024-07-29",
  "periodEnd": "2024-07-29"
}