Skip to main content

ark:IncomePattern

idstring<uri>required

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

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

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

Constant value: ark:IncomePattern
Example: ark:IncomePattern
reasonstringrequired

Identifier used to group patterns together.

Possible values: [INCOME, BORROWING, ESSENTIAL, QUALITY_OF_LIFE]

Example: INCOME
descriptionstringrequired

A human-readable description of the pattern.

Example: Net Pay
relatedTostring<uri>required

The budget that this income pattern relates to.

Example: https://graph.datawollet.com/nodes/f85b8b6b37fe3e8b144829d200000000
groupstring

The category of the income pattern.

Example: income
totalstringrequired
FinancialSensitiveGDPRPSR2017

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

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

Example: 2500.00
items object[]required

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

  • Array [
    • anyOf
    idstring<uri>required

    URI of the TransactionPattern node that defines the recurring pattern.

    Example: https://graph.datawollet.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
  • ]
    • ark:IncomePattern
    {
      "id": "https://graph.datawollet.com/.draft-nodes/a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4",
      "type": "ark:IncomePattern",
      "reason": "INCOME",
      "description": "Net Pay",
      "relatedTo": "https://graph.datawollet.com/nodes/f85b8b6b37fe3e8b144829d200000000",
      "group": "income",
      "total": "2500.00",
      "items": [
        {
          "id": "https://graph.datawollet.com/.draft-nodes/pattern123",
          "amount": "150.00"
        },
        {
          "amount": "150.00",
          "transactions": [
            "https://graph.datawollet.com/.draft-nodes/tx1",
            "https://graph.datawollet.com/.draft-nodes/tx2"
          ]
        }
      ]
    }