ark:AccountCredit

A credit 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:AccountCredit reflects an amount credited against what is owed. Suitable for use with billing accounts rather than ledgers.

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

Example: ark:AccountCredit

relatedTourirequired

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

datedaterequired

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 a direct debit payment or a refund.

reasonstring

Only payments will be included in your outgoings. If you don't select a reason, Onteric will normally assume it's a payment.

Possible values: [Payment, Refund, Adjustment, Discount, Negative, Other]

ark:AccountCredit

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