{
    "$schema": "http://json-schema.org/schema#",
    "$schemaVersion": "0.0.1",
    "modelTags": "IUDX",
    "derivedFrom": "",
    "license": "https://smart-data-models.github.io/dataModel.PublicAccountability/RevenueCollection/LICENSE.md",
    "$id": "https://smart-data-models.github.io/dataModel.PublicAccountability/RevenueCollection/schema.json",
    "title": " - PublicAccountability / RevenueCollection",
    "description": "A Data Model for city revenue collection operations.",
    "type": "object",
    "allOf": [
        {
            "$ref": "https://smart-data-models.github.io/data-models/common-schema.json#/definitions/GSMA-Commons"
        },
        {
            "$ref": "https://smart-data-models.github.io/data-models/common-schema.json#/definitions/Location-Commons"
        },
        {
            "properties": {
                "type": {
                    "type": "string",
                    "enum": [
                        "RevenueCollection"
                    ],
                    "description": "Property. NGSI Entity type. It has to be RevenueCollection"
                },
                "year": {
                    "type": "string",
                    "description": "Property. Year corresponding to this observation and is described in YYYY format, for eg. '2020'"
                },
                "month": {
                    "type": "string",
                    "description": "Property. Month corresponding to this observation and is described in MM format, for eg. '05' for the month of May"
                },
                "dateObserved": {
                    "type": "string",
                    "format": "date-time",
                    "description": "Property. The date and time of this observation in ISO8601 UTC format"
                },
                "totalCount": {
                    "type": "number",
                    "description": "Property. Count of the revenue collection service corresponding to this observation"
                },
                "registrationCertificateRecoveryAmount": {
                    "type": "number",
                    "description": "Property. Amount collected towards Registration Certificate on monthly basis from the establishment per employee"
                },
                "revenueCollectionType": {
                    "type": "string",
                    "description": "Property. Type of source from which the city administration collects the revenue, could be property tax, vehicle registration, party hall booking, community hall booking, auditorium booking etc"
                },
                "enrollmentCertificateRecoveryAmount": {
                    "type": "number",
                    "description": "Property. Amount collected towards Enrollment Certificate from the establishment on annual basis"
                },
                "vehicleTypeCode": {
                    "type": "string",
                    "description": "Property. The code for vehicleType corresponding to this observation. For eg.- '1' - MOPED/SCOOTER, '2' - MOTOR CYCLE, '4' - PRIVATE MOTOR CAR/JEEP CAR, '21' - TEMPO, '26' - BUS, etc"
                },
                "vehicleType": {
                    "type": "string",
                    "description": "Property. Type of vehicle from the point of view of its structural characteristics. This is different than the vehicle category . The following values defined by _VehicleTypeEnum_ and _VehicleTypeEnum2_, [DATEX 2 version 2.3](http://d2docs.ndwcloud.nu/_static/umlmodel/v2.3/index.htm)",
                    "enum": [
                        "agriculturalVehicle",
                        "anyVehicle",
                        "articulatedVehicle",
                        "autorickshaw",
                        "bicycle",
                        "binTrolley",
                        "BRT mini bus\u00b7",
                        "BRT bus",
                        "bus",
                        "car",
                        "caravan",
                        "carOrLightVehicle",
                        "carWithCaravan",
                        "carWithTrailer",
                        "cleaningTrolley",
                        "compactor",
                        "constructionOrMaintenanceVehicle",
                        "dumper",
                        "e-moped",
                        "e-scooter",
                        "e-motorcycle",
                        "fourWheelDrive",
                        "highSidedVehicle",
                        "hopper",
                        "lorry",
                        "minibus",
                        "moped",
                        "motorcycle",
                        "motorcycleWithSideCar",
                        "motorscooter",
                        "sweepingMachine",
                        "tanker",
                        "tempo",
                        "threeWheeledVehicle",
                        "tipper",
                        "trailer",
                        "tram",
                        "trolley",
                        "twoWheeledVehicle",
                        "van",
                        "vehicleWithoutCatalyticConverter",
                        "vehicleWithCaravan",
                        "vehicleWithTrailer",
                        "withEvenNumberedRegistrationPlates",
                        "withOddNumberedRegistrationPlates",
                        "other"
                    ]
                },
                "amountCollected": {
                    "type": "number",
                    "description": "Property. Amount collected towards the service corresponding to this observation"
                },
                "municipalityInfo": {
                    "type": "object",
                    "description": "Property. Municipality information corresponding to this observation",
                    "properties": {
                        "district": {
                            "type": "string"
                        },
                        "ulbName": {
                            "type": "string"
                        },
                        "cityId": {
                            "type": "string"
                        },
                        "addressRegion": {
                            "type": "string"
                        },
                        "addressLocality": {
                            "type": "string"
                        },
                        "zoneId": {
                            "type": "string"
                        },
                        "wardNum": {
                            "type": "number"
                        }
                    }
                }
            },
            "required": [
                "id",
                "type"
            ]
        }
    ]
}