-
Notifications
You must be signed in to change notification settings - Fork 2
/
PropertyTax_Payment_schema.json
212 lines (212 loc) · 5.22 KB
/
PropertyTax_Payment_schema.json
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
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "#/",
"type": "object",
"additionalProperties": false,
"required": [
"Payment", "Service", "Payable"
],
"properties": {
"Payment": {
"$ref": "#/definitions/Payment"
},
"Service": {
"$ref": "#/definitions/TaxService"
},
"Payable": {
"$ref": "#/definitions/TaxPayable"
}
},
"definitions": {
"TaxService": {
"type": "object",
"additionalProperties": false,
"properties": {
"Type": {
"type": "string",
"example": "TAX",
"enum": [
"TAX"
]
},
"ROLL_NUMBER": {
"type": "string",
"example": "191406329000500000000",
"pattern": "^[0-9-]*$"
},
"TENANT_NUMBER": {
"type": "string",
"example": "453534",
"pattern": "^[0-9]*$"
},
"ROLL_TYPE": {
"type": "string",
"example": "Residential",
"pattern": "^[A-Za-z]*$"
},
"Detail": {
"type": "object",
"PropertyLocation": {
"type": "string",
"example": "55 John Street, Toronto",
"pattern": "^[0-9a-zA-Z., -]*$"
},
"AssessedOwner": {
"type": "string",
"example": "55 John Street, Toronto",
"pattern": "^[0-9a-zA-Z., -]*$"
},
"TotalAmountDue": {
"type": "number",
"example": 6234.33
}
}
}
},
"TaxPayable": {
"type": "object",
"additionalProperties": false,
"properties": {
"LineItemID": {
"type": "string",
"example": "5425432",
"pattern": "^[A-Za-z0-9]*$"
},
"AmountDue": {
"type": "number",
"format": "double",
"example": 15.12,
"description": "Amount due for this payable, such as ticket amount or bill amount"
},
"DueDate": {
"type": "string",
"format": "date",
"example": "2019-11-01",
"pattern": "^[0-90-]*$"
},
"PaidAmount": {
"type": "number",
"format": "double",
"example": 15.12,
"description": "Amount paid for this line-item"
},
"LineItemFee": {
"type": "number",
"format": "double",
"example": 0
},
"Type": {
"type": "string",
"example": "PropertyTaxBill",
"pattern": "^[a-zA-Z]*$"
},
"BILL_NUMBER": {
"type": "string",
"example": "sdf345",
"pattern": "^[a-zA-Z0-9]*$"
},
"Principle": {
"type": "number",
"example": 100.23
},
"Interest": {
"type": "number",
"example": 10.01
},
"Fee": {
"type": "number",
"example": 0.2
}
}
},
"Payment": {
"required": [
"BatchID", "CardNum", "CardType", "ConfirmationNumber", "LineItemsIDs", "PaymentID", "PaymentType", "TellerID", "TotalAmount", "TransactionTimestamp"
],
"type": "object",
"additionalProperties": false,
"properties": {
"TellerID": {
"type": "string",
"example": "PayIT",
"description": "this can be hardcoded to PAYIT",
"pattern": "^[A-Za-z]*$"
},
"PaymentType": {
"type": "string",
"example": "CreditCard",
"pattern": "^[A-Za-z]*$"
},
"PaymentID": {
"type": "integer",
"minimum": 1000000000,
"maximum": 9999999999,
"example": 1234567890,
"description": "this is for tracing each payment to a billed item such as Tax, Utility, and parking ticket. When there is a payment paying Tax and Utility and several parking tickets, then the transaction number would be the same for all of them. This allows the transaction to be cancelled at the same time for everything"
},
"ConfirmationNumber": {
"type": "string",
"example": "j93J22j",
"description": "The bank confirmation number that customers will see on their credit-card bill and reciept.",
"pattern": "^[A-Za-z0-9]*$"
},
"TransactionTimestamp": {
"type": "string",
"description": "this is to understand when the transaction happened",
"pattern": "^[0-9T :.-]*$"
},
"BatchID": {
"type": "string",
"example": "2019-11-01",
"description": "this is used to group transactions by day, closing periods, etc. We can have one batch per day containing everything",
"pattern": "^[0-9-]*$"
},
"ProcessingFee": {
"type": "number",
"format": "double",
"example": 0.01
},
"ConvenienceFee": {
"type": "number",
"format": "double",
"example": 0.01
},
"TotalAmount": {
"type": "number",
"format": "double",
"example": 1345.12,
"description": "this is the payment amount"
},
"CardType": {
"type": "string",
"example": "visa",
"description": "Debit Card/Visa/MC/Amex",
"pattern": "^[A-Za-z]*$"
},
"CardNum": {
"type": "string",
"example": "4242********4242",
"pattern": "^[0-9*]*$"
},
"LineItemsIDs": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[0-9A-Za-z]*$"
}
},
"CancelledAmount": {
"type": "number",
"format": "double"
},
"CancelledLineItemsIDs": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[0-9A-Za-z]*$"
}
}
}
}
}
}