utilityapi/json-schema/utilityapi-bill-schema.json at main · api-evangelist/utilityapi · 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
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://utilityapi.com/schemas/bill",
  "title": "Bill",
  "description": "A utility bill associated with a meter",
  "type": "object",
  "properties": {
    "uid": {
      "type": "string",
      "description": "Unique identifier for the bill"
    },
    "meter_uid": {
      "type": "string",
      "description": "UID of the meter this bill belongs to"
    },
    "statement_date": {
      "type": "string",
      "format": "date",
      "description": "Date the bill was issued"
    },
    "due_date": {
      "type": "string",
      "format": "date",
      "description": "Payment due date"
    },
    "total_kwh": {
      "type": "number",
      "minimum": 0,
      "description": "Total electricity consumption in kWh"
    },
    "total_amount": {
      "type": "number",
      "minimum": 0,
      "description": "Total bill amount"
    },
    "currency": {
      "type": "string",
      "default": "USD",
      "description": "Currency code for the bill amount"
    },
    "created": {
      "type": "string",
      "format": "date-time",
      "description": "When the bill was added to the system"
    }
  },
  "required": ["uid", "meter_uid", "statement_date", "total_amount"]
}