Product/Rate Schema

This will provide an example specification for pulling rates from an external API.

Glossary

Product

• name - Product name being sold
• channel - Channel the product will be sold. DTD, TM, or RETAIL. Can also be pipe delimited for multiple.
• market - Market the product will be sold. Residential or Commercial. Can also be pipe delimited for multiple.
• home_type - Home Type the product will be sold. Single, Multi-Family, or Apartment. Can also be pipe delimited for multiple.
• rate_type_id - 1 for fixed, 2 for variable, 3 for tiered
• green_percentage - integer from 0 to 100 to show green percentage
• term - integer with term value
• term_type_id - 1 for day, 2 for week, 3 for month, 4 for year
• service_fee - service fee value (only numbers and decimal should be entered)
• daily_fee - daily fee value (only numbers and decimal should be entered)
• monthly_fee - monthly fee value (only numbers and decimal should be entered)
• intro_daily_fee - intro daily fee value (only numbers and decimal should be entered)
• intro_service_fee - intro service fee value (only numbers and decimal should be entered)
• intro_term - integer with term value
• intro_term_type_id - 1 for day, 2 for week, 3 for month, 4 for year

Rate

• utility - Utility label name in the Focus platform
• rate_currency_id - 1 for cents, 2 for dollars
• rate_uom_id - 1 for therm, 2 for kwh, 3 for unknown, 4 for ccf, 5 for mwhs, 6 for gj, 7 for mcf
• cancellation_fee - cancellation fee value (only numbers and decimal should be entered)
• cancellation_fee_currency - 1 for cents, 2 for dollars
• admin_fee - admin fee value (only numbers and decimal should be entered)
• external_rate_id - External name needed by the client system
• program_code - product/program code
• rate_amount - rate amount (only numbers and decimal should be entered)
• rate_monthly_fee - rate monthly fee value (only numbers and decimal should be entered)
• intro_rate_amount - intro rate amount (only numbers and decimal should be entered)
• intro_cancellation_fee - intro cancellation fee value (only numbers and decimal should be entered)
• intro_cancellation_fee_currency - 1 for cents, 2 for dollars

Schema example

[
    {
        "name": "Green Two-Phase Fixed - IL - Tiered - 14 month(s)",
        "channel": "DTD|TM",
        "market": "Residential",
        "home_type": "Single|Multi-Family|Apartment",
        "rate_type_id": 3,
        "green_percentage": 100,
        "term": 14,
        "term_type_id": 3,
        "service_fee": null,
        "daily_fee": null,
        "monthly_fee": null,
        "intro_daily_fee": null,
        "intro_service_fee": null,
        "intro_term": 1,
        "intro_term_type_id": 3,
        "rates": [
            {
                "utility": "AMEREN",
                "rate_currency_id": 1,
                "rate_uom_id": 2,
                "cancellation_fee": null,
                "cancellation_fee_currency": null,
                "admin_fee": null,
                "external_rate_id": "",
                "program_code": "IL001E",
                "rate_amount": 8.9,
                "rate_monthly_fee": null,
                "intro_rate_amount": 4.9,
                "intro_cancellation_fee": null,
                "intro_cancellation_fee_currency": null,
            },
            {
                "utility": "COMED",
                "rate_currency_id": 1,
                "rate_uom_id": 2,
                "cancellation_fee": null,
                "cancellation_fee_currency": null,
                "admin_fee": null,
                "external_rate_id": "",
                "program_code": "IL002E",
                "rate_amount": 8.9,
                "rate_monthly_fee": null,
                "intro_rate_amount": 4.9,
                "intro_cancellation_fee": null,
                "intro_cancellation_fee_currency": null,
            }
        ]
    },
    {
        "name": "PA Power Smart 3 T",
        "channel": "DTD|TM",
        "market": "Residential",
        "home_type": "Single|Multi-Family",
        "rate_type_id": 1,
        "green_percentage": null,
        "term": 3,
        "term_type_id": 3,
        "service_fee": null,
        "daily_fee": null,
        "monthly_fee": null,
        "intro_daily_fee": null,
        "intro_service_fee": null,
        "intro_term": 1,
        "intro_term_type_id": 3,
        "rates": [
            {
                "utility": "CPA",
                "rate_currency_id": 1,
                "rate_uom_id": 2,
                "cancellation_fee": null,
                "cancellation_fee_currency": null,
                "admin_fee": null,
                "external_rate_id": "",
                "program_code": "PA3T",
                "rate_amount": 8.9,
                "rate_monthly_fee": null,
                "intro_rate_amount": 4.9,
                "intro_cancellation_fee": null,
                "intro_cancellation_fee_currency": null
            }
        ]
    }
]