flow/schemas/programmable-object.json at develop · flow-mn/flow · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
  {
    "$schema": "http://json-schema.org/draft-07/schema#",
    "type": "object",
    "description": "Flow's programmable transaction object definition. All of the fields are optional. This only represents the data object, refer to Flow's GitHub repo for how this is used.",
    "properties": {
      "title": {
        "type": [
          "string",
          "null"
        ],
        "description": "Title of the transaction"
      },
      "amount": {
        "type": [
          "number",
          "null"
        ],
        "description": "Amount of the transaction"
      },
      "fromAccountUuid": {
        "type": [
          "string",
          "null"
        ],
        "description": "UUID of the account from which the amount is debited. This has more priority than fromAccount. If not provided, or this doesn't exist, this field is ignored for the user to fill out."
      },
      "fromAccount": {
        "type": [
          "string",
          "null"
        ],
        "description": "Name of the account from which the amount is debited. If fromAccountUuid is provided, or this doesn't match any existing account (case-sensitive), this field is ignored."
      },
      "toAccountUuid": {
        "type": [
          "string",
          "null"
        ],
        "description": "Only for transfers. UUID of the account to which the amount is credited. This has more priority than toAccount. If not provided, or this doesn't exist, this field is ignored for the user to fill out."
      },
      "toAccount": {
        "type": [
          "string",
          "null"
        ],
        "description": "Only for transfers. Name of the account to which the amount is credited. If toAccountUuid is provided, or this doesn't match any existing account (case-sensitive), this field is ignored."
      },
      "type": {
        "type": [
          "string",
          "null"
        ],
        "enum": [
          "expense",
          "income",
          "transfer",
          null
        ]
      },
      "transactionDate": {
        "type": [
          "string",
          "null"
        ],
        "format": "date-time",
        "description": "Date of the transaction in ISO 8601 format. If not provided, the current date is used."
      },
      "categoryUuid": {
        "type": [
          "string",
          "null"
        ],
        "description": "UUID of the category associated with the transaction. If not provided, or this doesn't exist, this field is ignored for the user to fill out."
      },
      "category": {
        "type": [
          "string",
          "null"
        ],
        "description": "Name of the category associated with the transaction. If categoryUuid is provided, or this doesn't match any existing category (case-sensitive), this field is ignored."
      },
      "notes": {
        "type": [
          "string",
          "null"
        ],
        "description": "Additional notes for the transaction, supports markdown."
      },
      "transferConversionRate": {
        "type": [
          "number",
          "null"
        ],
        "description": "Only for transfers. Conversion rate applied during the transfer between two different currencies."
      },
      "isPending": {
        "type": [
          "boolean",
          "null"
        ],
        "description": "Indicates whether the transaction is pending. If the transactionDate is in the future, this is set to true automatically."
      },
      "tags": {
        "type": [
          "array",
          "null"
        ],
        "items": {
          "type": "string"
        },
        "description": "List of tags associated with the transaction."
      },
      "tagsUuids": {
        "type": [
          "array",
          "null"
        ],
        "items": {
          "type": "string"
        },
        "description": "List of uuid of tags associated with the transaction."
      },
      "lat": {
        "type": [
          "number",
          "null"
        ],
        "description": "Latitude coordinate of the transaction location."
      },
      "lng": {
        "type": [
          "number",
          "null"
        ],
        "description": "Longitude coordinate of the transaction location."
      }
    }
  }