Skip to main content

ark:ExpenditurePattern

GeneratedCustomisable
idurirequired

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

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

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

Constant value: ark:ExpenditurePattern
Example: ark:ExpenditurePattern
reasonstringrequired

Identifier used to group patterns together.

Possible values: [BORROWING, ESSENTIAL, QUALITY_OF_LIFE]

Example: ESSENTIAL
relatedTourirequired

The budget that this expenditure pattern relates to.

Example: https://graph.onteric.com/nodes/f85b8b6b37fe3e8b144829d200000000
descriptionstringrequired

A human-readable description of the pattern.

Example: Mortgages
groupstringrequired

The group of the expenditure pattern.

Example: mortgage
totalstringrequired
FinancialSensitiveGDPRPSR2017

Total monthly amount for this expenditure category, formatted as a decimal string.

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

Example: 1250.00
items object[]required

The individual expenditure components: either transaction patterns (URIs) or averaged transactions from a category that didn't match a pattern.

  • Array [
    • anyOf
    idurirequired

    URI of the TransactionPattern node that defines the recurring pattern.

    Example: https://graph.onteric.com/.draft-nodes/pattern123
    amountstringrequired
    FinancialSensitiveGDPRPSR2017

    The monthly amount for this pattern, formatted as a decimal string.

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

    Example: 150.00
    accountsuri[]

    Bank accounts associated with this item.

    personsuri[]

    Persons associated with this item.

  • ]
    • ark:ExpenditurePattern
    {
      "id": "https://graph.onteric.com/.draft-nodes/a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4",
      "type": "ark:ExpenditurePattern",
      "reason": "ESSENTIAL",
      "relatedTo": "https://graph.onteric.com/nodes/f85b8b6b37fe3e8b144829d200000000",
      "description": "Mortgages",
      "group": "mortgage",
      "total": "1250.00",
      "items": [
        {
          "id": "https://graph.onteric.com/.draft-nodes/pattern123",
          "amount": "150.00",
          "accounts": [
            "string"
          ],
          "persons": [
            "string"
          ]
        },
        {
          "amount": "45.99",
          "transactions": [
            "https://graph.onteric.com/.draft-nodes/tx1",
            "https://graph.onteric.com/.draft-nodes/tx2"
          ],
          "accounts": [
            "string"
          ],
          "persons": [
            "string"
          ]
        }
      ]
    }