USE RESTRICTION: Any foreign or other unauthorized access to our APIs or software will be blocked. If you are Developer accessing our software from outside the USA or Canada please send an to [email protected] specifying the customer for which you were hired for API development. |
Revision date: 28-Feb-2014
API URL & Resources
The URL for all APIs is: https://vault.energyperiscope.com/api/index.php/
API "Resources":
- GetJobList
- GetJob
- GetLeadList
- GetLead
- PostLead
- GetWidgetUsers
For example: If you want to get a list of all Jobs for your account you would use the Resource "GetJobList" and its associated parameters: https://vault.energyperiscope.com/api/index.php/GetJobList/?parameter_variables
Authentication
API Key Sets (ID & Key) are generated from within the software User's Administrator account ("My Account" >> API tab). When calling an API Resource a valid API ID and API Key must be submitted together with other parameter variables, as applicable:
Request Get Variable Parameter Formats:
- "dates and times stamps" (if provided; not blank) must be in the format "YYYY-MM-DD HH:mm:ss" where "HH" is the hour in 00-24 hour format. Example: 1:14 PM and 7 seconds on January 19, 2016 would be in the format 2016-01-19 13:14:07
- Our servers reside in the United States in the Pacific Time Zone. All date and time stamps should be in reference to this time zone. For example, if you are in the Eastern time zone, the time stamps stored on our server will be 3 hours prior to the Eastern Time stamp.
- "UserEmail" (if provided) must be a valid email address assigned to the account.
- "externalid" (if provided) must not contain any of the following characters: ' + ? ; &
Response (XML)
The API will respond in XML format:
If the Request was successful:
If "Successful" but the software had to auto-correct errors, the XML response will include each auto-corrected error returned as a message:
If the Request was not successful, the XML response will be as follows, with each error returned as a message:
If the API Request URI Resource contains a "Get____" the XML document will also include the data response fields (XML-tagged variables) as further defined herein. For example, detailed Job data for the Job requested.
Revision date: 05-Feb-2015: added Storage
GetJobList
Returns a List of Jobs for the entire Company or a specific User of the company account. Data request may also be refined by the dates ranges for when a Job was Created and/or Last Updated. The Job list is ordered by Date Created.
API Request Parameter Variables |
Get Variable Name |
Value |
The following parameter variables may be submitted to the API URL after the Resource "GetJobList". Required variables are red.
|
apiID |
API ID |
apiKey |
Key assigned to the API ID |
You may specify a User Login Email (associated with an Account Login). If specified only Jobs assigned to that User will be pulled. If blank all Jobs from the Company account will be pulled.
|
UserEmail |
email address for a specific account User login (used to find Jobs, if provided) |
You may specify Dates for when a Job was Created and/or last Updated:
- If a start date and end date are specified, then search within that range.
- If only a start date was specified, then search after that date.
- If only the end date is specified, then search before that date.
- If a Created_ dates and Updated_ dates are both specified the results will match both search terms. For example, if Created_From: 2014-01-01, Created_To: 2015-01-01, Updated_From: 2014-01-01, Updated_To: 2105-01-01, then only Jobs that were both created and updated in 2014 will be pulled.
|
Created_From |
YYYY-MM-DD HH:mm:ss |
Created_To |
YYYY-MM-DD hh:mm:ss |
Updated_From |
YYYY-MM-DD HH:mm:ss |
Updated_To |
YYYY-MM-DD hh:mm:ss |
XMl Document: API Response
XML Document: API Response |
XML Name Space |
Value |
status |
Successful or Unsuccessful |
messages and/or errors |
API messages: each with a name space tag <message> |
UserEmail |
email address for a specific account User login (used to find Jobs, if provided) |
Created_From |
Date Jobs created from (used to find Jobs, if provided) |
Created_To |
Date Jobs created to (used to find Jobs, if provided) |
Updated_From |
Date Jobs updated from (used to find Jobs, if provided) |
Updated_To |
Date Jobs updated to (used to find Jobs, if provided) |
total_jobs |
Number of Jobs found |
job |
Data for this Job: Parent name space tag >> Children: |
jobid |
Job ID |
externalid |
Job External ID |
jref |
Job Reference Name |
date_jcreated |
Date Job Created: YYYY-MM-DD HH:mm:ss |
date_jupdated |
Date Job Last Updated: YYYY-MM-DD hh:mm:ss |
assignedto |
Account UserName (email) Job assigned to |
job_role |
Contractor, Subcontractor or Consultant |
sale_status |
Active, Sold, Cold |
sale_probability |
Probability of Sale (0-100%) |
date_jclosed |
Date marked Sold or Cold |
jarchived |
1 if Job Archived, else 0 |
cfirstname |
Customer First name |
clastname |
Customer Last name |
ctitle |
Customer Title |
ccompany |
Customer Company |
caddress1 |
Customer Address |
caddress2 |
Customer Address (2nd line) |
ccity |
Customer City |
cstate |
Customer State |
czip |
Customer Zipcode |
ccountry |
Customer Country |
phone |
Customer Phone |
phone2 |
Customer Phone (alternative) |
phone3 |
Customer Phone (mobile) |
cemail |
Customer Email |
ctype |
Customer Type |
jcompany |
Company (for Job) |
jaddress1 |
Job Address |
jaddress2 |
Job Address (2nd line) |
jcity |
Job City |
jstate |
Job State |
jzip |
Job Zipcode |
jcountry |
Job Country |
dopv |
1 if Solar Electric (PV) quoted, else 0 |
dosdhw |
1 if Solar Water heating quoted, else 0 |
dorad |
1 if Hydronic Floor heating quoted, else 0 |
dopool |
1 if Solar Pool or Spa heating quoted, else 0 |
dowind |
1 if Wind Turbine quoted, else 0 |
doeff_elec |
1 if Electric Efficiency quoted, else 0 |
doeff_fuel |
1 if Fuel Efficiency quoted, else 0 |
dostorage |
1 if Energy Storage quoted, else 0 |
report_ok |
1 if Report (Sales Proposal) complete, else 0 |
report_ok = 1, then Job Quote data is Provided, as follows: |
loan_type |
Cash, Loan, Lease, PPA |
total_quote |
Total Job Quote ($ gross cost) |
pv_kw |
Total kW DC of PV quoted |
pv_quote |
Solar Electric (PV) Quote ($ gross cost) |
sdhw_sqft |
Total Sq-Feet of Water heating collectors quoted |
sdhw_quote |
Total solar Water Heating Quote ($ gross cost) |
rad_floor_quote |
Total solar hydronic floor heating Quote ($ gross cost) |
pool_sqft |
Total Sq-Feet of Pool/Spa heating collectors quoted |
pool_quote |
Total solar Pool/Spa heating Quote ($ gross cost) |
wind_kw |
Total kW DC of Wind Turbines quoted |
turbine_quote |
Total Wind Turbine Quote ($ gross cost) |
storage_nameplate_kwh |
kWh storage quoted |
storage_quote |
Total Storage Quote ($ gross cost) |
eff_grosscost |
Total Efficiency measures Quote ($ gross cost) |
|
Revision date: 18-May-2017: Added "heating_fuel_post" and "heating_units_post" to differentiate energy source for space heating after the project (post-project)
Revision date: 05-Feb-2015 - Added Energy Storage
GetJob
Returns data for a specified Job.
You may pull Job data by its jobid or by the externalid. "externalid" is a unique ID associated with the Job, as assigned by you (for example an ID that comes from your CRM system for this Job/customer record). The externalid must be unique (can not be assigned to more than one (1) Job. If you submit an jobid and an externalid the software will store the externalid to that jobid (associate it to the jobid in our database) for future reference.
API Request Parameter Variables |
Get Variable Name |
Value |
The following parameter variables may be submitted to the API URL after the Resource "GetJob". Required variables are red.
|
apiID |
API ID |
jobid* |
Job ID |
externalid* |
ExternalID |
* - "jobid" or its associated "externalid" is required |
XML Document: API Response |
XML Name Space |
Value |
status |
Successful or Unsuccessful |
messages and/or errors |
API messages: each with a name space tag <message> |
job |
Parent name space tag >> Children |
job >> Children |
jobid |
Job ID |
externalid |
Job External ID |
jref |
Job Reference Name |
date_jcreated |
Date Job Created: YYYY-MM-DD HH:mm:ss |
date_jupdated |
Date Job Last Updated: YYYY-MM-DD hh:mm:ss |
assignedto |
Account UserName (email) Job assigned to |
job_role |
Contractor, Subcontractor or Consultant |
sale_status |
Active, Sold, Cold |
sale_probability |
Probability of Sale (0-100%) |
date_jclosed |
Date marked Sold or Cold |
jarchived |
1 if Job Archived, else 0 |
cfirstname |
Customer First name |
clastname |
Customer Last name |
ctitle |
Customer Title |
ccompany |
Customer Company |
caddress1 |
Customer Address |
caddress2 |
Customer Address (2nd line) |
ccity |
Customer City |
cstate |
Customer State |
czip |
Customer Zipcode |
ccountry |
Customer Country |
phone |
Customer Phone |
phone2 |
Customer Phone (alternative) |
phone3 |
Customer Phone (mobile) |
cemail |
Customer Email |
ctype |
Customer Type |
jcompany |
Company (for Job) |
jaddress1 |
Job Address |
jaddress2 |
Job Address (2nd line) |
jcity |
Job City |
jstate |
Job State |
jzip |
Job Zipcode |
jcountry |
Job Country |
ctype |
Customer Type |
dopv |
1 if Solar Electric (PV) quoted, else 0 |
dosdhw |
1 if Solar Water heating quoted, else 0 |
dorad |
1 if Hydronic Floor heating quoted, else 0 |
dopool |
1 if Solar Pool or Spa heating quoted, else 0 |
dowind |
1 if Wind Turbine quoted, else 0 |
doeff_elec |
1 if Electric Efficiency quoted, else 0 |
doeff_fuel |
1 if Fuel Efficiency quoted, else 0 |
dostorage |
1 if Energy Storage quoted, else 0 |
report_ok |
1 if Report (Sales Proposal) complete, else 0 |
report_ok = 1, then Job Report data is Provided, as follows: |
cover_page |
Parent name space tag >> Children |
cover_page Children |
prepby_firstname |
Report prepared by First Name |
prepby_lastname |
Report prepared by Last Name |
prepby_title |
Report prepared by Title |
prepby_phone |
Report prepared by Phone |
prepby_phone_ext |
Report prepared by phone Extension |
prepby_email |
Report prepared by Email |
custom_title_note |
Report Title |
|
exec_summary |
Parent name space tag >> Children |
exec_summary Children |
per_electric_reduction |
Precent reduction in kWh used |
per_ecost_reduction |
Percent cost reduction in electric bill |
utility_annual_cost_electric_pre |
Current Annual electric bill (before project) |
ppa_annual_cost |
Annual PPA cost (1st year, if PPA quoted) |
utility_annual_cost_electric_post |
Annual electric bill (after project at current rates) |
ave_kwh_rate_pre |
Average cost per kWh (before project) |
ave_kwh_rate_post |
Average cost per kWh (after project) |
fuel_type |
Fuel Type |
fuel_units |
Fuel Units |
per_fuel_reduction |
Percent reduction in fuel used |
per_fcost_reduction |
Percent cost reduction in fuel bill |
utility_annual_cost_fuel_pre |
Current Annual fuel bill (before project) |
utility_annual_cost_fuel_post |
Annual fuel bill (after project at current rates) |
ave_fuel_rate_pre |
Average cost per unit (before project) |
ave_fuel_rate_post |
Average cost per unit (after project) |
ave_annual_raw_usavings |
Average annual utility savings (without tax affects) |
ave_annual_usavings |
Average annual utility savings (with tax affects) |
total_usavings |
Total system life utility savings (with tax affects) |
electric_pbi_year1 |
Electric PBI value in Year 1 |
electric_pbi_years |
Number of years electric PBIs extend |
per_ecost_reduction_with_pbi |
Percent electric cost reduction with PBIs included (1st year) |
fuel_pbi_year1 |
Fuel PBI value in Year 1 |
fuel_pbi_years |
Number of years fuel PBIs extend |
per_fcost_reduction_with_pbi |
Percent fuel cost reduction with PBIs included (1st year) |
gross_cost |
Gross Cost |
incentive_flows_system_crec |
Value of Install (year 0) incentives received by Contractor |
purchase_incentives_to_customer |
Value of Install (year 0) incentives received by Customer |
tax_on_purchase_incentives_to_customer |
Value of Income Tax to be paid on install incentives (year 0) |
net_purchase_cost |
Net Cost (after install incentives and income taxes on incentives) |
future_incentives |
Total Value of Incentives after install (year 1 thru system life) |
npv_future_incentives |
NPV of Value of Incentives after install (year 1 thru system life) |
total_depreciation |
Total Value of tax savings from depreciation (year 1 thru system life) |
npv_depreciation |
NPV of Value of tax savings from depreciation (year 1 thru system life) |
p_index |
Profitability Index |
cash_payback |
Cashflow Payback |
cash_modified_payback |
Modified Cashflow Payback |
irr_nlp |
IRR (levered if financed) |
npv_nlp |
NPV (levered if financed) |
cash_gained_over_life |
Cash gained over system life |
property_appreciation |
Property Appreciation |
|
carbon_reduction |
Parent name space tag >> Children |
carbon_reduction Children |
co2saved_tons |
Tons of CO2 saved |
automiles |
Equivalent auto miles |
trees |
Equivalent trees planted |
landfill_tons |
Equivalent tons of landfill |
homes |
Equivalent electric use displaced by number of homes |
|
finance |
Parent name space tag >> Children |
finance Children |
loan_type |
Finance method quoted |
loan1_principal |
Principal of Loan #1 |
loan1_interest_only |
1 if interest-only loan |
loan1_rate |
interest rate |
loan1_starts |
starts (in month) |
loan1_term |
term (months) |
loan1_fee |
loan fees |
loan1_interest_deduction |
1 if interest is a tax deduction |
loan1_prepay_amt |
Amount to be pre-paid (for re-amortized loan) |
loan1_prepay_mo |
Month loan to be re-amortized (pre-paid) |
loan1_pmt |
Loan monthly payment |
loan1_pmt_remortized |
Loan monthly payment after re-amortization |
loan1_pmt_after_interest_only_mo |
Loan monthly payment after interst-only period ends |
loan2_principal |
Principal of Loan #1 |
loan2_interest_only |
1 if interest-only loan |
loan2_rate |
interest rate |
loan2_starts |
starts (in month) |
loan2_term |
term (months) |
loan2_fee |
loan fees |
loan2_interest_deduction |
1 if interest is a tax deduction |
loan2_prepay_amt |
Amount to be pre-paid (for re-amortized loan) |
loan2_prepay_mo |
Month loan to be re-amortized (pre-paid) |
loan2_pmt |
Loan monthly payment |
loan2_pmt_remortized |
Loan monthly payment after re-amortization |
loan2_pmt_after_interest_only_mo |
Loan monthly payment after interst-only period ends |
lease_fee |
Lease fees |
lease_pmt |
Lease payment (monthly) |
lease_term |
Lease term (months) |
lease_escalator |
Lease annual escalator (%) |
lease_capital |
1 if Capital Lease, 0 = Operating Lease |
lease_capital_amt |
Amount financed by Capital Lease |
lease_buy_price |
Fair market value at end of lease |
ppa_term |
PPA Term (months) |
ppa_covers |
1 if All, 0 if only system portion (electricity covered by PPA) |
ppa_covers_descr |
100% of Electricity used by Building, or Only Electricity Generated by System |
ppa_pv |
1 if PPA covers PV, else 0 |
ppa_wind |
1 if PPA covers Wind, else 0 |
ppa_escalator |
Annual PPA cost escalator (%) |
ppa_escalator_start |
Month PPA escalator starts |
ppa_buy_price |
Fair market value at end of PPA |
|
efficiency_page |
Parent name space tag >> Children |
efficiency_page Children |
eff_prescriptions |
If 1: Energy efficiency prescriptions used |
eff_measures_descr |
Description of efficiency measures quoted |
eff_adders |
Description of efficiency adders quoted |
adder_notes |
Description of efficiency (adder) notes included |
heating_savings |
Space heating energy saved |
heating_fuel |
Type of energy used to heat space (current) |
heating_units |
Units of energy used to heat space (current) |
heating_fuel_post |
Type of energy used to heat space (post-project) |
heating_units_post |
Units of energy used to heat space (post-project) |
cooling_savings |
Space cooling kWh energy saved |
water_heating_savings |
Water heating energy saved |
water_heating_units |
Units of energy used to heat water |
water_heating_change |
Descripion of water heater change (from one fuel to another) |
appliance_savings_electric |
kWh saved from equipment/appliance efficiency measures |
appliance_savings_fuel |
Fuel saved from equipment/appliance efficiency measures |
appliance_savings_fuel_units |
Units of Fuel saved from equipment/appliance efficiency measures |
pool_heating_savings |
Energy saved from pool efficiency measures |
pool_heating_units |
Units of Fuel saved from pool efficiency measures |
pool_heating_ghost_savings |
Energy saved from UNheated pool efficiency measures |
spa_heating_savings |
Energy saved from spa efficiency measures |
spa_heating_units |
Units of Fuel saved from spa efficiency measures |
gross_cost |
Gross cost quoted |
incentives_contractor_receives |
Value of incentives going to Contractor (Year 0) |
parent >> 'incentive' >> children |
description |
incentive description |
amount |
incentive amount |
|
incentives_customer_receives |
Value of incentives going to Customer (Year 0) |
parent >> 'incentive' >> children |
description |
incentive description |
amount |
incentive amount |
|
contract_amount |
Contract Amount |
net_cost |
Net Cost (after install incentives) |
incentive_value_after_install |
Value of incentives to be received after install |
|
pv_page |
Parent name space tag >> Children |
pv_page Children |
array |
PV Array (Parent name space tag) |
array parent >> children |
array_num |
Array Number (1,2,3, or 4) |
num_pv |
Number PV panels |
p_mfg |
Manufacturer (PV panel) |
p_model |
Model (PV panel) |
num_inv |
Number of Inverters |
i_mfg |
Manufacturer (Inverter) |
i_model |
Model (Inverter) |
mount |
mounting air gap |
tilt |
Tilt |
azimuth |
Azimuth |
weighted_ave_shade |
Shade Percent (annual weighted average) |
pvwatts_derating |
PVWatts derating calculated) |
|
adders |
Adders description |
notes |
Notes (Adders) description |
area_covered |
Sq-Ft of PV Panels |
dc_kw |
kW (DC) of Panels |
ac_kw |
kW (AC) of PV system |
cec_kw |
kW (CEC-AC) of PV system |
inv_rated_kw |
kW (rated power) of Inverters in PV system |
annual_kwh |
Annual kWh production quoted |
annual_kwh_adjustment_percent |
% kWh production adjustment from software estimate to kWh quoted |
month_kwh |
monthly kWh production (Parent name space tag) |
month_kwh >> 'month' child |
month_num |
Month (1-12) |
amount |
kWh produced in month |
|
gross_cost |
Gross Cost |
gross_cost_per_wattdc |
$/watt DC quoted (using Gross Cost) |
incentives_contractor_receives |
Parent 'incentives_contractor_receives' >> Children |
incentives_contractor_receives >> 'incentive' (Child) |
description |
description of incentive |
amount |
amount of incentive |
|
incentives_customer_receives |
Parent 'incentives_customer_receives' >> Children |
incentives_customer_receives >> 'incentive' (Child) |
description |
description of incentive |
amount |
amount of incentive |
|
contract_amount |
Contract amount |
net_cost |
Net Cost (after install incentives) |
net_cost_per_wattdc |
Net Cost per watt DC |
net_cost_per_wattac |
Net Cost per watt AC |
incentive_value_after_install |
Total value of incentives to be received in later years (Year 1+) |
|
sdhw_page |
Parent name space tag >> Children |
sdhw_page Children |
array |
Collector Array (Parent name space tag) |
array parent >> children |
array_num |
Array Number (1 or 2) |
num_col |
Number collectors |
c_mfg |
Manufacturer (collector) |
c_model |
Model (collector) |
tilt |
Tilt |
azimuth |
Azimuth |
weighted_ave_shade |
Shade Percent (annual weighted average) |
|
tank |
Tank size in gallons |
waterheater_pre_eff |
Water Heater EF (current) |
waterheater_post_eff |
Water Heater EF (after project) |
sdhw_losses |
Solar water heating system losses (%) |
adders |
Adders description |
notes |
Notes (Adders) description |
annual_kwh |
Annual kWh energy displaced (quoted) |
fuel_units |
Units of fuel energy displaced (If not electric) |
annual_fuel_units |
Annual Units of fuel energy displaced (If not electric) |
month_kwh |
monthly kWh production (Parent name space tag) |
month_kwh >> 'month' child |
month_num |
Month (1-12) |
amount |
kWh displaced in month |
|
water_daily |
Gallon of heated water used per day |
water_temp |
Temperature (F) of heated water |
sdhw_rad |
Was space heating included as part of system (Yes, No) |
month_sef >> 'month' child |
month_num |
Month (1-12) |
amount |
Solar Energy Fraction (SEF) this month |
|
gross_cost |
Gross Cost |
incentives_contractor_receives |
Parent 'incentives_contractor_receives' >> Children |
incentives_contractor_receives >> 'incentive' (Child) |
description |
description of incentive |
amount |
amount of incentive |
|
incentives_customer_receives |
Parent 'incentives_customer_receives' >> Children |
incentives_customer_receives >> 'incentive' (Child) |
description |
description of incentive |
amount |
amount of incentive |
|
contract_amount |
Contract amount |
net_cost |
Net Cost (after install incentives) |
incentive_value_after_install |
Total value of incentives to be received in later years (Year 1+) |
|
pool_page |
Parent name space tag >> Children |
pool_page Children |
array |
Collector Array (Parent name space tag) |
'array' parent name space tag >> children |
array_num |
Array Number (1 or 2) |
num_col |
Number collectors |
c_mfg |
Manufacturer (collector) |
c_model |
Model (collector) |
tilt |
Tilt |
azimuth |
Azimuth |
weighted_ave_shade |
Shade Percent (annual weighted average) |
|
pool_type |
Description of Pool Use (Residential, Condo, Public, etc.) |
area_covered |
Sq-Ft of Total collector area |
pool_temp |
Pool Temperature desired (F) |
pool_area |
Sq-Ft pool |
spa_temp |
Spa Temperature desired (F) |
spa_area |
Sq-Ft Spa |
poolcover_post |
Pool cover use (description) |
spacover_post |
Spa cover use (description) |
pool_temp_estimated |
'pool_temp_estimated' (Parent) >> Child 'month' |
Child 'month' |
temp_f |
Pool Temperature (F) estimated |
|
adders |
Adders description |
notes |
Notes (Adders) description |
annual_kwh |
Annual kWh energy displaced (quoted) |
fuel_units |
Units of fuel energy displaced (If not electric) |
annual_fuel_units |
Annual Units of fuel energy displaced (If not electric) |
month_kwh |
monthly kWh production (Parent name space tag) |
month_kwh >> 'month' child |
month_num |
Month (1-12) |
amount |
kWh displaced in month |
|
month_sef >> 'month' child |
month_num |
Month (1-12) |
amount |
Solar Energy Fraction (SEF) this month |
|
gross_cost |
Gross Cost |
incentives_contractor_receives |
Parent 'incentives_contractor_receives' >> Children |
incentives_contractor_receives >> 'incentive' (Child) |
description |
description of incentive |
amount |
amount of incentive |
|
incentives_customer_receives |
Parent 'incentives_customer_receives' >> Children |
incentives_customer_receives >> 'incentive' (Child) |
description |
description of incentive |
amount |
amount of incentive |
|
contract_amount |
Contract amount |
net_cost |
Net Cost (after install incentives) |
incentive_value_after_install |
Total value of incentives to be received in later years (Year 1+) |
|
wind_page |
Parent name space tag >> Children |
wind_page Children |
num_turbine |
Number of Turbines quoted |
t_mfg |
Turbine Manufacturer |
t_model |
Turbine Model |
t_height |
Height (Ft) of Turbine |
dc_kw |
kW (rated DC) of Turbines |
adders |
Adders description |
notes |
Notes (Adders) description |
annual_kwh |
Annual kWh production quoted |
annual_percent_electric |
Annual percent of utility kWh produced by turbines |
month_kwh |
monthly kWh production (Parent name space tag) |
month_kwh >> 'month' child |
month_num |
Month (1-12) |
amount |
kWh produced in month |
|
gross_cost |
Gross Cost |
incentives_contractor_receives |
Parent 'incentives_contractor_receives' >> Children |
incentives_contractor_receives >> 'incentive' (Child) |
description |
description of incentive |
amount |
amount of incentive |
|
incentives_customer_receives |
Parent 'incentives_customer_receives' >> Children |
incentives_customer_receives >> 'incentive' (Child) |
description |
description of incentive |
amount |
amount of incentive |
|
contract_amount |
Contract amount |
net_cost |
Net Cost (after install incentives) |
incentive_value_after_install |
Total value of incentives to be received in later years (Year 1+) |
|
storage_page |
Parent name space tag >> Children |
storage_page Children |
storage_nameplate_kwh |
Number of kWh quoted |
storage_descr |
Description of Storage System |
storage_application |
Application Description |
storage_type |
Type of Battery |
min_soc |
Minimum State Of Charge (as percent) |
storage_location |
Battery location (Out or Indoor) |
charger_rated_kw |
Battery charger rated power in kW DC |
storage_rated_kw |
Inverter rated power in kW AC |
storage_life |
Storage system life in years |
storage_cyclelife |
Battery cycles to 50% DOD |
storage_warranty |
Battery warranty in Months |
warranty_type |
Battery warranty Type |
demand_weibull |
Variation in Demand |
peak_kw >> 'month' child |
month |
Month (1-12) |
amount |
Peak kW in month |
|
demand_reduced_to >> 'month' child |
month |
Month (1-12) |
amount |
Peak kW in month (after storage) |
|
charge_state_s_wd |
Summer Weekdays: CSV of Hours 0-23: 1= charge, -1 = discharge, 0= idle |
charge_state_s_we |
Summer Weekend days: CSV of Hours 0-23: 1= charge, -1 = discharge, 0= idle |
charge_state_w_wd |
Winter Weekdays: CSV of Hours 0-23: 1= charge, -1 = discharge, 0= idle |
charge_state_w_we |
Winter Weekend days: CSV of Hours 0-23: 1= charge, -1 = discharge, 0= idle |
adders |
Adder descriptions |
notes |
Notes (Adders) description |
gross_cost |
Gross Cost |
incentives_contractor_receives |
Parent 'incentives_contractor_receives' >> Children |
incentives_contractor_receives >> 'incentive' (Child) |
description |
description of incentive |
amount |
amount of incentive |
|
incentives_customer_receives |
Parent 'incentives_customer_receives' >> Children |
incentives_customer_receives >> 'incentive' (Child) |
description |
description of incentive |
amount |
amount of incentive |
|
contract_amount |
Contract amount |
net_cost |
Net Cost (after install incentives) |
incentive_value_after_install |
Total value of incentives to be received in later years (Year 1+) |
|
utility_summary_page |
Parent name space tag >> Children |
utility_summary_page Children |
electric |
'electric' >> Children |
Parent name space tag >> Children |
electric_rate_pre |
current electric rate |
electric_cost_pre |
current $/kWh |
electric_rate_post |
post-project electric rate |
electric_cost_post |
post-project $/kWh |
ppa_cost |
PPA $/kWh |
tiered_pre |
Current Rate Tiered: Yes or No |
tiered_post |
Post Rate Tiered: Yes or No |
tou_pre |
Current Rate TOU: Yes or No |
tou_post |
Post Rate TOU: Yes or No |
demand_pre |
Current Rate Demand Charges: Yes or No |
demand_post |
Post Rate Demand Charges: Yes or No |
demand_reduction |
Reduction in demand charges (%) |
submeters |
Number of submeters (if applies) |
ave_kwh_rate_pre |
Average cost $/kWh current |
ave_kwh_rate_post |
Average cost $/kWh post project |
historical_kwh |
Parent >> Children |
historical_kwh >> 'month' (child) |
month_num |
month (1-12) |
amount |
kWh used in month |
|
historical_kwh >> 'annual' |
annual kWh used |
historical_cost >> 'month' (child) |
month_num |
month (1-12) |
amount |
Electric Cost in month |
|
historical_cost >> 'annual' |
annual electric cost |
current_kwh |
Parent >> Children |
current_kwh >> 'month' (child) |
month_num |
month (1-12) |
amount |
kWh used in month |
|
current_kwh >> 'annual' |
annual kWh used |
current_cost >> 'month' (child) |
month_num |
month (1-12) |
amount |
Electric Cost in month |
|
current_cost >> 'annual' |
annual electric cost |
current_demand_charges >> 'month' (child) |
month_num |
month (1-12) |
amount |
Electric Demand Cost in month |
|
current_demand_charges >> 'annual' |
annual demand cost |
current_total_cost >> 'month' (child) |
month_num |
month (1-12) |
amount |
Total Electric Cost in month |
|
current_total_cost >> 'annual' |
Total annual cost cost |
baseline_kwh |
Parent >> Children |
baseline_kwh >> 'month' (child) |
month_num |
month (1-12) |
amount |
kWh used in month |
|
baseline_kwh >> 'annual' |
annual kWh used |
baseline_cost >> 'month' (child) |
month_num |
month (1-12) |
amount |
Electric Cost in month |
|
baseline_cost >> 'annual' |
annual electric cost |
baseline_demand_charges >> 'month' (child) |
month_num |
month (1-12) |
amount |
Electric Demand Cost in month |
|
baseline_demand_charges >> 'annual' |
annual demand cost |
baseline_total_cost >> 'month' (child) |
month_num |
month (1-12) |
amount |
Total Electric Cost in month |
|
baseline_total_cost >> 'annual' |
Total annual cost cost |
post_kwh |
Parent >> Children |
post_kwh >> 'month' (child) |
month_num |
month (1-12) |
amount |
kWh used in month |
|
post_kwh >> 'annual' |
annual kWh used |
post_ppa >> 'month' (child) |
month_num |
month (1-12) |
amount |
Electric Cost in month |
|
post_ppa >> 'annual' |
annual electric cost |
post_cost >> 'month' (child) |
month_num |
month (1-12) |
amount |
Electric Cost in month |
|
post_cost >> 'annual' |
annual electric cost |
post_demand_charges >> 'month' (child) |
month_num |
month (1-12) |
amount |
Electric Demand Cost in month |
|
post_demand_charges >> 'annual' |
annual demand cost |
post_total_cost >> 'month' (child) |
month_num |
month (1-12) |
amount |
Total Electric Cost in month |
|
post_total_cost >> 'annual' |
Total annual cost cost |
net_meter_credit >> 'month' (child) |
month_num |
month (1-12) |
amount |
Total Net-Meter Credit in month |
|
net_meter_credit >> 'annual' |
Total annual net-meter credit |
tier_cost_pre |
Parent to Children: tier_1, tier_2, tier_3, tier_4, tier_5 |
tier_1, tier_2, tier_3, tier_4, tier_5 |
tier_x >> 'month' (child) |
tier_x >> 'month' (child) |
month_num |
month (1-12) |
amount |
Tier cost in month |
|
tier_x >> 'annual' |
tier total |
tier_cost_post |
Parent to Children: tier_1, tier_2, tier_3, tier_4, tier_5 |
tier_1, tier_2, tier_3, tier_4, tier_5 |
tier_x >> 'month' (child) |
tier_x >> 'month' (child) |
month_num |
month (1-12) |
amount |
Tier cost in month |
|
tier_x >> 'annual' |
tier total |
tou_percent_pre |
Parent to Children: off_peak, part_peak, peak |
off_peak, part_peak, peak |
YOU period >> 'month' (child) |
(TOU period) >> 'month' (child) |
month_num |
month (1-12) |
percent |
Percent of this TOU period in month |
|
If EnergyFarm (FIT) |
sold_kwh |
Parent to Children: |
sold_kwh >> 'month' (child) |
month_num |
month (1-12) |
amount |
kWh sold this month |
|
sold_kwh >> 'annual' |
Total annual kWh sold |
revenue_kwh_sold |
Parent to Children: |
revenue_kwh_sold >> 'month' (child) |
month_num |
month (1-12) |
amount |
$ value of kWh sold this month |
|
revenue_kwh_sold >> 'annual' |
Total annual value $ of kWh sold |
If Virtual Net_Metered |
meter |
'meter' Parent of ... |
meter_number |
meter number (1-4) |
percent_production |
% of production allocated to this meter |
Other children name space tags as above for this meter |
|
fuel |
Parent name space tag >> Children |
'fuel' >> Children> |
fuel_type |
Fuel type |
fuel_units |
Fuel Units |
fuel_rate_pre |
current fuel rate |
fuel_cost_pre |
current $/unit |
fuel_rate_post |
post-project fuel rate |
fuel_cost_post |
post-project $/unit |
tiered_pre |
Current Rate Tiered: Yes or No |
tiered_post |
Post Rate Tiered: Yes or No |
ave_fuel_rate_pre |
Average cost $/unit current |
ave_fuel_rate_post |
Average cost $/unit post project |
historical_units |
Parent >> Children |
historical_units >> 'month' (child) |
month_num |
month (1-12) |
amount |
units used in month |
|
historical_units >> 'annual' |
annual units used |
historical_cost >> 'month' (child) |
month_num |
month (1-12) |
amount |
Fuel Cost in month |
|
historical_cost >> 'annual' |
annual fuel cost |
current_units |
Parent >> Children |
current_units >> 'month' (child) |
month_num |
month (1-12) |
amount |
Units used in month |
|
current_units >> 'annual' |
annual units used |
current_cost >> 'month' (child) |
month_num |
month (1-12) |
amount |
Fuel Cost in month |
|
current_cost >> 'annual' |
annual fuel cost |
baseline_units |
Parent >> Children |
baseline_units >> 'month' (child) |
month_num |
month (1-12) |
amount |
Units used in month |
|
baseline_units >> 'annual' |
annual units used |
baseline_cost >> 'month' (child) |
month_num |
month (1-12) |
amount |
Fuel Cost in month |
|
baseline_cost >> 'annual' |
annual fuel cost |
post_units |
Parent >> Children |
post_units >> 'month' (child) |
month_num |
month (1-12) |
amount |
Units used in month |
|
post_units >> 'annual' |
annual Units used |
post_cost >> 'month' (child) |
month_num |
month (1-12) |
amount |
Fuel Cost in month |
|
post_cost >> 'annual' |
annual fuel cost |
|
|
cash_flow_page |
Parent name space tag >> Children |
cash_flow_page Children |
'gross_cost' parent name space tag |
efficiency |
year >> year_num, amount |
pv |
year >> year_num, amount |
sdhw |
year >> year_num, amount |
pool |
year >> year_num, amount |
wind |
year >> year_num, amount |
total |
year >> year_num, amount |
|
'om_cost' parent name space tag |
efficiency |
year >> year_num, amount |
pv |
year >> year_num, amount |
sdhw |
year >> year_num, amount |
pool |
year >> year_num, amount |
wind |
year >> year_num, amount |
total |
year >> year_num, amount |
|
'utility_savings' parent name space tag |
year |
year >> year_num, amount |
|
'utility_savings_with_tax_effects' parent name space tag |
year |
year >> year_num, amount |
|
'incentives' parent name space tag |
efficiency |
year >> year_num, amount |
pv |
year >> year_num, amount |
sdhw |
year >> year_num, amount |
pool |
year >> year_num, amount |
wind |
year >> year_num, amount |
total |
year >> year_num, amount |
|
'income_tax_incentives' parent name space tag |
federal |
year >> year_num, amount |
state |
year >> year_num, amount |
total |
year >> year_num, amount |
|
'om_tax_deduction_savings' parent name space tag |
year |
year >> year_num, amount |
|
'depreciation_tax_savings' parent name space tag |
federal |
year >> year_num, amount |
state |
year >> year_num, amount |
total |
year >> year_num, amount |
|
'loan_flows' parent name space tag |
principal_payments |
year >> year_num, amount |
interest_tax_savings |
year >> year_num, amount |
|
'lease_flows' parent name space tag |
lease_payments |
year >> year_num, amount |
lease_tax_savings |
year >> year_num, amount |
|
'ppa_payments' parent name space tag |
year |
year >> year_num, amount |
|
'net_cashflow' parent name space tag |
year |
year >> year_num, amount |
|
'cumulative_cashflow' parent name space tag |
year |
year >> year_num, amount |
|
|
assumptions_page |
Parent name space tag >> Children |
assumptions_page Children |
utility_savings_pretax_dollars |
1 if Yes, 0 if NO |
utility_savings_increase_profit |
1 if Yes, 0 if NO |
ev_charging |
0 if No. If > 0 then result x 30 miles driven per day (ave. in month) |
pv_life |
PV life in Years |
inv_life |
Inverter life in Years |
st_life |
Solar Thermal life in Years |
wind_life |
Wind Turbine life in Years |
appliance_life |
Equipment/Appliance life in Years (for efficiency) |
degradation |
Percent annual performance degradation |
cpi_inflation |
CPI inflation rate |
electric_inflation |
Electric inflation rate |
gas_inflation |
Natural Gas inflation rate |
oil_inflation |
Fuel Oil inflation rate |
propane_inflation |
Propane inflation rate |
pv_om |
PV Opertion and Maintenance expense (Percent of Gross Cost) |
st_om |
Solar Thermal Opertion and Maintenance expense (Percent of Gross Cost) |
wind_om |
Wind Turbine Opertion and Maintenance expense (Percent of Gross Cost) |
monthly_excess_sell_rate |
Monthly Net Excess Genertion Sell Rate |
sell_back_rate |
Annual Net Excess Genertion Sell Rate |
discount_rate |
Discount rate |
reinvest_rate |
Re-investment rate |
federal_depr_type |
Federal Depreciation type |
state_depr_type |
State Depreciation type |
federal_sect179_amount |
Federal Section 179 amount |
state_sect179_amount |
State Section 179 amount |
lease_capital_amt |
Capital lease amount |
implied_lease_interest |
Implied interest on Capital lease amount |
weather_station |
Weather Station used |
solar_resources >> month >> month_num, amount |
Solar kWh/M2/Day at location, by month |
water_inlet_temp_f >> month >> month_num, amount |
Water inlet temperature (F) assumed, by month |
wind_height_m |
Height (meters) Wind speed was measured |
wind_speed_mph >> month >> month_num, amount |
Wind speed assumed, by month |
mean_f >> month >> month_num, amount |
Mean ambient temerature (F) assumed, by month |
max_f >> month >> month_num, amount |
Maximum ambient temerature (F) assumed, by month |
min_f >> month >> month_num, amount |
Minimum ambient temerature (F) assumed, by month |
rh >> month >> month_num, amount |
Relative Humidity (%) assumed, by month |
rh_indoor_pool |
Indoor Relative Humidity (%) assumed for indoor pool area |
tempf_indoor_pool |
Indoor temperature (F) assumed for indoor pool area |
|
contract_page |
Parent name space tag >> Children |
contract_page Children |
downpayment |
Down Payment Amount |
milestone1_name |
Milestone Payment 1: name |
milestone1_per |
Milestone Payment 1: percent of contract total |
milestone1_week |
Milestone Payment 1: Wek due (after commencement of work) |
milestones 2-6 (same format) ... |
milestone6_name |
Milestone Payment 6: name |
milestone6_per |
Milestone Payment 6: percent of contract total |
milestone6_week |
Milestone Payment 6: Wek due (after commencement of work) |
|
|
Original Release date: 28-Feb-2014
Revised 06-May-2014 added variables: fed_tax_rate, state_tax_rate, ctype, pwrrel, pwrmgmt
Revised 13-Jun-2014 added variable: lead_status
Revised 28-Dec-2015 added namespace: jobs
GetLeadList
Returns a List of Sales leads for the entire Company or a specific User of the company account. Data request may also be refined by the dates ranges for when a Lead was Created. All Leads will be pulled if no date, or dates, are specified. For example if the Created_From is defined by the Created_To is blank, all Leads from the Created_From date onward will be pulled The Lead list is ordered by Date Created.
API Request Parameter Variables |
Get Variable Name |
Value |
The following parameter variables may be submitted to the API URL after the Resource "GetLeadList". Required variables are red.
|
apiID |
API ID |
apiKey |
Key assigned to the API ID |
You may specify a User Login Email (associated with an Account Login). If specified only Leads assigned to that User will be pulled. If blank all Leads from Company account will be pulled.
|
UserEmail |
email address for a specific account User login (used to find Leads, if provided) |
You may specify Dates for when a Lead was Created and/or last Updated:
- If a start date and end date are specified, then search within that range.
- If only a start date was specified, then search after that date.
- If only the end date is specified, then search before that date.
- If a Created_ dates and Updated_ dates are both specified the results will match both search terms. For example, if Created_From: 2014-01-01, Created_To: 2015-01-01, Updated_From: 2014-01-01, Updated_To: 2105-01-01, then only Leads that were both created and updated in 2014 will be pulled.
|
Created_From |
YYYY-MM-DD HH:mm:ss |
Created_To |
YYYY-MM-DD hh:mm:ss |
Updated_From |
YYYY-MM-DD HH:mm:ss |
Updated_To |
YYYY-MM-DD hh:mm:ss |
API Response Parameter |
Data for each Lead will be enclosed in ... tags. |
Lead Question |
XML Name Space |
Format |
Values |
ID of the Lead |
leadid |
int(11) |
Lead ID |
Lead External ID |
externalid |
varchar(30) |
an External ID for this Lead |
Lead Source |
source |
varchar(30) |
Source for this Lead |
Lead Status |
lead_status |
tinyint(2) |
0: New, 1: Cold, 2: Warm, 3: Hot |
User Email this Lead is assigned to (blank if not assigned) |
assignedto |
varchar(50) |
Source for this Lead |
JobID if Lead was converted to a Job |
jobid |
int(11) |
JobID if Lead was converted to a Job |
External JobID if Lead was converted to a Job |
jobid_externalid |
varchar(30) |
External JobID if Lead was converted to a Job |
If more than 1 Job is associated with the Lead then data is provided as: |
|
jobs (parent) |
jobid (child) |
jobid_externalid (child) |
Date Lead was Entered |
whensubmit |
YYYY-MM-DD HH:mm:ss |
Date Lead was Entered |
Date Lead was Last Updated |
date_updated |
YYYY-MM-DD HH:mm:ss |
Date Lead was Last Updated |
Lead Archived |
archived |
tinyint(1) |
1 if lead was Archived, else 0 |
Latitude of Customer Location |
latitude |
decimal(10,2) |
Latitude of Customer Location |
Longitude of Customer Location |
longitude |
decimal(10,2) |
Longitude of Customer Location |
Lead Contact Information |
First Name |
first_name |
varchar(100) |
first name |
Last Name |
last_name |
varchar(100) |
last name |
Email Address |
email |
varchar(100) |
email address |
Company Name |
company |
varchar(100) |
company |
Mobile (cell) Number |
mobile |
varchar(50) |
mobile phone number |
Telephone Number |
phone |
varchar(50) |
phone number |
Fax Number |
fax |
varchar(50) |
fax number |
Street Address |
street |
varchar(100) |
street address |
City |
city |
varchar(100) |
city |
State |
state |
varchar(2) |
state |
Zip or Post Code |
zip |
varchar(10) |
USA XXXXX, or XXXX-YYYY Canada XXX-YYY or XXX YYY |
Federal Tax Rate |
fed_tax_rate |
decimal(5,2) |
Federal tax rate like xx.xx (%) |
State Tax Rate |
state_tax_rate |
decimal(5,2)) |
State tax rate like xx.xx (%) |
Customer type |
ctype |
tinyint(4) |
1=Residential, 2=Business, 3=Nonprofit, 4=Govt/Muni |
Contact When |
contactwhen |
tinyint(1) |
1=Morning, 2=Afternoon, 3=Evening |
Contact How |
contacthow |
tinyint(1) |
1=Cell phone, 2=Home phone, 3=Email |
Energy Efficiency Improvements Previously Performed on Building |
Enery Audit Performed? |
energyaudit |
tinyint(1) |
1=Yes, 0=No |
Insulation Improved? |
insulation |
tinyint(1) |
1=Yes, 0=No |
Windows Upgraded? |
windows |
tinyint(1) |
1=Yes, 0=No |
Space Heater Efficiency Improved? |
heating |
tinyint(1) |
1=Yes, 0=No |
Air Conditioner (Cooling) Efficiency Improved? |
cooling |
tinyint(1) |
1=Yes, 0=No |
Water Heater Efficiency Improved? |
waterheat |
tinyint(1) |
1=Yes, 0=No |
Lighting Efficiency Improved? |
lighting |
tinyint(1) |
1=Yes, 0=No |
Appliance Efficiency Improved? |
appliances |
tinyint(1) |
1=Yes, 0=No |
Interested In |
Want Solar Electric (PV)? |
pv |
tinyint(1) |
1=Yes, 0=No |
Want Solar Water Heating? |
solarwater |
tinyint(1) |
1=Yes, 0=No |
Want Solar Pool/Spa Heating? |
solarpool |
tinyint(1) |
1=Yes, 0=No |
Want Wind Turbine? |
wind |
tinyint(1) |
1=Yes, 0=No |
Want Geothermal Heatpump? |
geothermal |
tinyint(1) |
1=Yes, 0=No |
Want Solar Space Heating? |
solarspace |
tinyint(1) |
1=Yes, 0=No |
Want Wood/Biomass Heating? |
wood |
tinyint(1) |
1=Yes, 0=No |
Want Energy Efficiency Improvements? |
efficiency |
tinyint(1) |
1=Yes, 0=No |
Want/Need Financing? |
finance |
tinyint(1) |
1=Yes, 0=No |
Want Financial Analysis? |
financialanalysis |
tinyint(1) |
1=Yes, 0=No |
Want Incentive Analysis? |
incentives |
tinyint(1) |
1=Yes, 0=No |
Want Power Reliability (Backup)? |
pwrrel |
tinyint(1) |
1=Yes, 0=No |
Want Power Management (Demand Reduction)? |
pwrmgmt |
tinyint(1) |
1=Yes, 0=No |
Current Energy Use |
Average Monthly Electric Bill |
electricbill |
int(11) |
$ per month |
Average Monthly Natural Gas Bill |
gasbill |
int(11) |
$ per month |
Average Monthly Fuel Oil Bill |
oilbill |
int(11) |
$ per month |
Name of Electric Utility |
electricutility |
varchar(100) |
name of electric utility |
Name of Natural Gas Utility |
gasutility |
varchar(100) |
name of natural gas utility |
Percent Energy Use Customer Wants Displace |
percentsolar |
smallint(3) |
0 - 100 percent |
Building Information |
Type of Building |
buildingtype |
tinyint(1) |
0=Undefined 1=Single Family Home (new construction) 2=Single family home (older) 3=Semi-detached or town house 4=Condo 5=Commercial Building |
Ownership of Building |
ownertype |
tinyint(1) |
0=Undefined 1=Owned 2=Rented/Leased |
Building Size (sq-ft) |
bldgsize |
int(8) |
Sq-Ft |
How Building is Heated |
heattype |
tinyint(1) |
0=Undefined 1=Natural Gas 2=Electric 3=Fuel Oil 4=Propane 5=Wood Burning |
How Water is Heated |
watertype |
tinyint(1) |
0=Undefined 1=Natural Gas 2=Electric 3=Fuel Oil 4=Propane 5=Wood Burning |
Type of Water Heater (currently) |
waterheater |
tinyint(1) |
0=Undefined 1=Standard 2=Tankless 3=On-demand |
Project Information |
State Where Work is to be Performed |
projectstate |
varchar(2) |
State |
Description of Work/Project Requested |
description |
text |
project description |
When do they want work started |
timing |
tinyint(1) |
0=Undefined 1=Immediately 2=3-6 months 3=1 year 4=2 years or more |
Budget for Project |
budget |
int(11) |
budget |
Method of Financing Project |
needfinance |
tinyint(1) |
0=I am not sure about financing 1=Need Financing 2=Have financing 3=Cash (no finance req'd) |
Mounting Location for Collectors |
mount |
tinyint(1) |
0=Roof 1=Ground 2=Roof and Ground 3=Not Sure |
Sun Exposure for Collectors |
exposure |
tinyint(1) |
0=Undefined 1=North 2=South 3=East 4=West 5=Other |
Shading Conditions for Collectors |
shading |
tinyint(1) |
0=Undefined 1=Full Sun 2=Partial 3=Low Sun |
Description of any Obstructions to Collectors |
obstructions |
text |
description of any obstructions |
Area (sq-ft) Available for Collector Installation |
area |
int(11) |
Sq-Ft of installation area available |
Type of Roofing Material |
rooftype |
tinyint(2) |
0=Undefined 1=Asphalt Shingle 2=Ceramic 3=Clay Tile 4=Wood Shingle 5=Metal 6=Engineered Rubber 7=Plastic 8=Other |
Description of Roofing Material (if Other) |
roofother |
varchar(100) |
description of roof type (if other) |
Age of Roofing Material (years) |
roofage |
int(6) |
years - age of roof |
Pitch of Roof |
rooftilt |
tinyint(1) |
0=Undefined 1=Conventional Pitch 2=Low Pitch 3=Flat Roof |
Style of Roof |
roofstyle |
tinyint(1) |
0=Undefined |
|
1=Flat: |
2=Gable: |
3=Shed: |
4=Hip: |
5=Gambrel: |
6=Mansard: |
|
FICO (credit) Score of Customer |
fico_score |
smallint(3) |
FICO score |
Value of Property/Building |
prop_value |
mediumint(8) |
Value ($) of property |
County of Job Location |
county |
varchar(50) |
County of Job Location |
Country of Job Location |
country |
varchar(2) |
Country of Job Location |
Zipcode of Job Location |
jzip |
varchar(10) |
USA XXXXX, or XXXX-YYYY Canada XXX-YYY or XXX YYY |
Original Release date: 28-Feb-2014
Revised 06-May-2014 added variables: fed_tax_rate, state_tax_rate, ctype, pwrrel, pwrmgmt
Revised 13-Jun-2014 added variable: lead_status
Revised 28-Dec-2015 added namespace: jobs
GetLead
Returns data for a specified Lead.
You may pull Lead data by its leadid or by the externalid. "externalid" is a unique ID associated with the Lead, as assigned by you (for example an ID that comes from your CRM system for this customer record). The externalid must be unique (can not be assigned to more than one (1) Lead. If you submit an leadid and an externalid the software will store the externalid to that leadid (associate it to the leadid in our database) for future reference.
API Request Parameter Variables |
Get Variable Name |
Value |
The following parameter variables may be submitted to the API URL after the Resource "GetLead". Required variables are red.
|
apiID |
API ID |
leadid* |
Lead ID |
externalid* |
ExternalID |
* - "leadid" or its associated "externalid" is required |
API Response Parameter |
Lead Question |
XML Name Space |
Format |
Values |
ID of the Lead |
leadid |
int(11) |
Lead ID |
Lead External ID |
externalid |
varchar(30) |
an External ID for this Lead |
Lead Source |
source |
varchar(30) |
Source for this Lead |
Lead Status |
lead_status |
tinyint(2) |
0: New, 1: Cold, 2: Warm, 3: Hot |
User Email this Lead is assigned to (blank if not assigned) |
assignedto |
varchar(50) |
Source for this Lead |
JobID if Lead was converted to a Job |
jobid |
int(11) |
JobID if Lead was converted to a Job |
External JobID if Lead was converted to a Job |
jobid_externalid |
varchar(30) |
External JobID if Lead was converted to a Job |
If more than 1 Job is associated with the Lead then data is provided as: |
|
jobs (parent) |
jobid (child) |
jobid_externalid (child) |
Date Lead was Entered |
whensubmit |
YYYY-MM-DD HH:mm:ss |
Date Lead was Entered |
Date Lead was Last Updated |
date_updated |
YYYY-MM-DD HH:mm:ss |
Date Lead was Last Updated |
Lead Archived |
archived |
tinyint(1) |
1 if lead was Archived, else 0 |
Latitude of Customer Location |
latitude |
decimal(10,2) |
Latitude of Customer Location |
Longitude of Customer Location |
longitude |
decimal(10,2) |
Longitude of Customer Location |
Lead Contact Information |
First Name |
first_name |
varchar(100) |
first name |
Last Name |
last_name |
varchar(100) |
last name |
Email Address |
email |
varchar(100) |
email address |
Company Name |
company |
varchar(100) |
company |
Mobile (cell) Number |
mobile |
varchar(50) |
mobile phone number |
Telephone Number |
phone |
varchar(50) |
phone number |
Fax Number |
fax |
varchar(50) |
fax number |
Street Address |
street |
varchar(100) |
street address |
City |
city |
varchar(100) |
city |
State |
state |
varchar(2) |
state |
Zip or Post Code |
zip |
varchar(10) |
USA XXXXX, or XXXX-YYYY Canada XXX-YYY or XXX YYY |
Federal Tax Rate |
fed_tax_rate |
decimal(5,2) |
Federal tax rate like xx.xx (%) |
State Tax Rate |
state_tax_rate |
decimal(5,2)) |
State tax rate like xx.xx (%) |
Customer type |
ctype |
tinyint(4) |
1=Residential, 2=Business, 3=Nonprofit, 4=Govt/Muni |
Energy Efficiency Improvements Previously Performed on Building |
Enery Audit Performed? |
energyaudit |
tinyint(1) |
1=Yes, 0=No |
Insulation Improved? |
insulation |
tinyint(1) |
1=Yes, 0=No |
Windows Upgraded? |
windows |
tinyint(1) |
1=Yes, 0=No |
Space Heater Efficiency Improved? |
heating |
tinyint(1) |
1=Yes, 0=No |
Air Conditioner (Cooling) Efficiency Improved? |
cooling |
tinyint(1) |
1=Yes, 0=No |
Water Heater Efficiency Improved? |
waterheat |
tinyint(1) |
1=Yes, 0=No |
Lighting Efficiency Improved? |
lighting |
tinyint(1) |
1=Yes, 0=No |
Appliance Efficiency Improved? |
appliances |
tinyint(1) |
1=Yes, 0=No |
Interested In |
Want Solar Electric (PV)? |
pv |
tinyint(1) |
1=Yes, 0=No |
Want Solar Water Heating? |
solarwater |
tinyint(1) |
1=Yes, 0=No |
Want Solar Pool/Spa Heating? |
solarpool |
tinyint(1) |
1=Yes, 0=No |
Want Wind Turbine? |
wind |
tinyint(1) |
1=Yes, 0=No |
Want Geothermal Heatpump? |
geothermal |
tinyint(1) |
1=Yes, 0=No |
Want Solar Space Heating? |
solarspace |
tinyint(1) |
1=Yes, 0=No |
Want Wood/Biomass Heating? |
wood |
tinyint(1) |
1=Yes, 0=No |
Want Energy Efficiency Improvements? |
efficiency |
tinyint(1) |
1=Yes, 0=No |
Want/Need Financing? |
finance |
tinyint(1) |
1=Yes, 0=No |
Want Financial Analysis? |
financialanalysis |
tinyint(1) |
1=Yes, 0=No |
Want Incentive Analysis? |
incentives |
tinyint(1) |
1=Yes, 0=No |
Want Power Reliability (Backup)? |
pwrrel |
tinyint(1) |
1=Yes, 0=No |
Want Power Management (Demand Reduction)? |
pwrmgmt |
tinyint(1) |
1=Yes, 0=No |
Current Energy Use |
Average Monthly Electric Bill |
electricbill |
int(11) |
$ per month |
Average Monthly Natural Gas Bill |
gasbill |
int(11) |
$ per month |
Average Monthly Fuel Oil Bill |
oilbill |
int(11) |
$ per month |
Name of Electric Utility |
electricutility |
varchar(100) |
name of electric utility |
Name of Natural Gas Utility |
gasutility |
varchar(100) |
name of natural gas utility |
Percent Energy Use Customer Wants Displace |
percentsolar |
smallint(3) |
0 - 100 percent |
Building Information |
Type of Building |
buildingtype |
tinyint(1) |
0=Undefined 1=Single Family Home (new construction) 2=Single family home (older) 3=Semi-detached or town house 4=Condo 5=Commercial Building |
Ownership of Building |
ownertype |
tinyint(1) |
0=Undefined 1=Owned 2=Rented/Leased |
Building Size (sq-ft) |
bldgsize |
int(8) |
Sq-Ft |
How Building is Heated |
heattype |
tinyint(1) |
0=Undefined 1=Natural Gas 2=Electric 3=Fuel Oil 4=Propane 5=Wood Burning |
How Water is Heated |
watertype |
tinyint(1) |
0=Undefined 1=Natural Gas 2=Electric 3=Fuel Oil 4=Propane 5=Wood Burning |
Type of Water Heater (currently) |
waterheater |
tinyint(1) |
0=Undefined 1=Standard 2=Tankless 3=On-demand |
Project Information |
State Where Work is to be Performed |
projectstate |
varchar(2) |
State |
Description of Work/Project Requested |
description |
text |
project description |
When do they want work started |
timing |
tinyint(1) |
0=Undefined 1=Immediately 2=3-6 months 3=1 year 4=2 years or more |
Budget for Project |
budget |
int(11) |
budget |
Method of Financing Project |
needfinance |
tinyint(1) |
0=I am not sure about financing 1=Need Financing 2=Have financing 3=Cash (no finance req'd) |
Mounting Location for Collectors |
mount |
tinyint(1) |
0=Roof 1=Ground 2=Roof and Ground 3=Not Sure |
Sun Exposure for Collectors |
exposure |
tinyint(1) |
0=Undefined 1=North 2=South 3=East 4=West 5=Other |
Shading Conditions for Collectors |
shading |
tinyint(1) |
0=Undefined 1=Full Sun 2=Partial 3=Low Sun |
Description of any Obstructions to Collectors |
obstructions |
text |
description of any obstructions |
Area (sq-ft) Available for Collector Installation |
area |
int(11) |
Sq-Ft of installation area available |
Type of Roofing Material |
rooftype |
tinyint(2) |
0=Undefined 1=Asphalt Shingle 2=Ceramic 3=Clay Tile 4=Wood Shingle 5=Metal 6=Engineered Rubber 7=Plastic 8=Other |
Description of Roofing Material (if Other) |
roofother |
varchar(100) |
description of roof type (if other) |
Age of Roofing Material (years) |
roofage |
int(6) |
years - age of roof |
Pitch of Roof |
rooftilt |
tinyint(1) |
0=Undefined 1=Conventional Pitch 2=Low Pitch 3=Flat Roof |
Style of Roof |
roofstyle |
tinyint(1) |
0=Undefined |
|
1=Flat: |
2=Gable: |
3=Shed: |
4=Hip: |
5=Gambrel: |
6=Mansard: |
|
FICO (credit) Score of Customer |
fico_score |
smallint(3) |
FICO score |
Value of Property/Building |
prop_value |
mediumint(8) |
Value ($) of property |
County of Job Location |
county |
varchar(50) |
County of Job Location |
Country of Job Location |
country |
varchar(2) |
Country of Job Location |
Zipcode of Job Location |
jzip |
varchar(10) |
USA XXXXX, or XXXX-YYYY Canada XXX-YYY or XXX YYY |
Original Release date: 28-Feb-2014
Revised 06-May-2014 added variables: source, fed_tax_rate, state_tax_rate, ctype, pwrrel, pwrmgmt
Legacy API: The Lead Source API Interface Document (used prior to 28-Feb-2014)
PostLead
Inserts a new Sales leads into the Company account.
API Request Parameter Variables
The following Parameter variables may be submitted to the API URL after the Resource "PostLead". Required variables are red.
"externalid" is a unique ID associated with the Lead, as assigned by you (for example an ID that comes from your CRM system for this Lead/customer record). The externalid must be unique (can not be assigned to more than one (1) Lead. If you submit an externalid the software will associate the externalid to the leadid in our database for future reference.
Lead Question |
Get Variable Name |
Format |
Values |
API Key Set |
API Validation |
apiID |
int(11) |
API ID |
API Validation |
apiKey |
varchar(200) |
API Key |
External ID for this Lead |
External ID |
externalid |
varchar(30) |
an External ID for this Lead |
Source of this Lead |
Lead Source |
source |
varchar(30) |
Source of this Lead (If blank API name is used). |
Lead Contact Information |
First Name |
first_name |
varchar(100) |
first name |
Last Name |
last_name |
varchar(100) |
last name |
email or mobile or phone is required |
Email Address |
email |
varchar(100) |
email address |
Company Name |
company |
varchar(100) |
company |
Mobile (cell) Number |
mobile |
varchar(50) |
mobile phone number |
Telephone Number |
phone |
varchar(50) |
phone number |
Fax Number |
fax |
varchar(50) |
fax number |
Street Address |
street |
varchar(100) |
street address |
City |
city |
varchar(100) |
city |
State |
state |
varchar(2) |
state |
Zip or Post Code |
zip |
varchar(10) |
USA XXXXX, or XXXX-YYYY Canada XXX-YYY or XXX YYY |
Federal Tax Rate |
fed_tax_rate |
decimal(5,2) |
Federal tax rate like xx.xx (%) |
State Tax Rate |
state_tax_rate |
decimal(5,2)) |
State tax rate like xx.xx (%) |
Customer type |
ctype |
tinyint(4) |
1=Residential, 2=Business, 3=Nonprofit, 4=Govt/Muni |
Energy Efficiency Improvements Previously Performed on Building |
Energy Audit Performed? |
energyaudit |
tinyint(1) |
1=Yes, 0=No |
Insulation Improved? |
insulation |
tinyint(1) |
1=Yes, 0=No |
Windows Upgraded? |
windows |
tinyint(1) |
1=Yes, 0=No |
Space Heater Efficiency Improved? |
heating |
tinyint(1) |
1=Yes, 0=No |
Air Conditioner (Cooling) Efficiency Improved? |
cooling |
tinyint(1) |
1=Yes, 0=No |
Water Heater Efficiency Improved? |
waterheat |
tinyint(1) |
1=Yes, 0=No |
Lighting Efficiency Improved? |
lighting |
tinyint(1) |
1=Yes, 0=No |
Appliance Efficiency Improved? |
appliances |
tinyint(1) |
1=Yes, 0=No |
Interested In |
Want Solar Electric (PV)? |
pv |
tinyint(1) |
1=Yes, 0=No |
Want Solar Water Heating? |
solarwater |
tinyint(1) |
1=Yes, 0=No |
Want Solar Pool/Spa Heating? |
solarpool |
tinyint(1) |
1=Yes, 0=No |
Want Wind Turbine? |
wind |
tinyint(1) |
1=Yes, 0=No |
Want Geothermal Heatpump? |
geothermal |
tinyint(1) |
1=Yes, 0=No |
Want Solar Space Heating? |
solarspace |
tinyint(1) |
1=Yes, 0=No |
Want Wood/Biomass Heating? |
wood |
tinyint(1) |
1=Yes, 0=No |
Want Energy Efficiency Improvements? |
efficiency |
tinyint(1) |
1=Yes, 0=No |
Want/Need Financing? |
finance |
tinyint(1) |
1=Yes, 0=No |
Want Financial Analysis? |
financialanalysis |
tinyint(1) |
1=Yes, 0=No |
Want Incentive Analysis? |
incentives |
tinyint(1) |
1=Yes, 0=No |
Want Power Reliability (Backup)? |
pwrrel |
tinyint(1) |
1=Yes, 0=No |
Want Power Management (Demand Reduction)? |
pwrmgmt |
tinyint(1) |
1=Yes, 0=No |
Current Energy Use |
Average Monthly Electric Bill |
electricbill |
int(11) |
$ per month |
Average Monthly Natural Gas Bill |
gasbill |
int(11) |
$ per month |
Average Monthly Fuel Oil Bill |
oilbill |
int(11) |
$ per month |
Name of Electric Utility |
electricutility |
varchar(100) |
name of electric utility |
Name of Natural Gas Utility |
gasutility |
varchar(100) |
name of natural gas utility |
Percent Energy Use Customer Wants to Displace |
percentsolar |
smallint(3) |
0 - 100 percent |
Building Information |
Type of Building |
buildingtype |
tinyint(1) |
0=Undefined 1=Single Family Home (new construction) 2=Single family home (older) 3=Semi-detached or town house 4=Condo 5=Commercial Building |
Ownership of Building |
ownertype |
tinyint(1) |
0=Undefined 1=Owned 2=Rented/Leased |
Building Size (sq-ft) |
bldgsize |
int(8) |
Sq-Ft |
How Building is Heated |
heattype |
tinyint(1) |
0=Undefined 1=Natural Gas 2=Electric 3=Fuel Oil 4=Propane 5=Wood Burning |
How Water is Heated |
watertype |
tinyint(1) |
0=Undefined 1=Natural Gas 2=Electric 3=Fuel Oil 4=Propane 5=Wood Burning |
Type of Water Heater (currently) |
waterheater |
tinyint(1) |
0=Undefined 1=Standard 2=Tankless 3=On-demand |
Project Information |
State Where Work is to be Performed |
projectstate |
varchar(2) |
State |
Description of Work/Project Requested |
description |
text |
project description |
When do they want work started |
timing |
tinyint(1) |
0=Undefined 1=Immediately 2=3-6 months 3=1 year 4=2 years or more |
Budget for Project |
budget |
int(11) |
budget |
Method of Financing Project |
needfinance |
tinyint(1) |
0=I am not sure about financing 1=Need Financing 2=Have financing 3=Cash (no finance req'd) |
Mounting Location for Collectors |
mount |
tinyint(1) |
0=Roof 1=Ground 2=Roof and Ground 3=Not Sure |
Sun Exposure for Collectors |
exposure |
tinyint(1) |
0=Undefined 1=North 2=South 3=East 4=West 5=Other |
Shading Conditions for Collectors |
shading |
tinyint(1) |
0=Undefined 1=Full Sun 2=Partial 3=Low Sun |
Description of any Obstructions to Collectors |
obstructions |
text |
description of any obstructions |
Area (sq-ft) Available for Collector Installation |
area |
int(11) |
Sq-Ft of installation area available |
Type of Roofing Material |
rooftype |
tinyint(2) |
0=Undefined 1=Asphalt Shingle 2=Ceramic 3=Clay Tile 4=Wood Shingle 5=Metal 6=Engineered Rubber 7=Plastic 8=Other |
Description of Roofing Material (if Other) |
roofother |
varchar(100) |
description of roof type (if other) |
Age of Roofing Material (years) |
roofage |
int(6) |
years - age of roof |
Pitch of Roof |
rooftilt |
tinyint(1) |
0=Undefined 1=Conventional Pitch 2=Low Pitch 3=Flat Roof |
Style of Roof |
roofstyle |
tinyint(1) |
0=Undefined |
|
1=Flat: |
2=Gable: |
3=Shed: |
4=Hip: |
5=Gambrel: |
6=Mansard: |
|
FICO (credit) Score of Customer |
fico_score |
smallint(3) |
FICO score |
Value of Property/Building |
prop_value |
mediumint(8) |
Value ($) of property |
Revision date: 28-Feb-2014
GetWidgetUsers
Returns a List of Sales Lead Widget Users for the entire Company. Note: Widget user data is only stored for the past 90 days.
API Request Parameter Variables |
Get Variable Name |
Value |
The following parameter variables may be submitted to the API URL after the Resource "GetWidgetUsers". Required variables are red.
|
apiID |
API ID |
apiKey |
Key assigned to the API ID |
You may specify Dates for when a Widget User record was Created. Note: Widget user data is only stored for the past 90 days.
- If a start date and end date are specified, then search within that range.
- If only a start date was specified, then search after that date.
- If only the end date is specified, then search before that date.
|
Created_From |
YYYY-MM-DD HH:mm:ss |
Created_To |
YYYY-MM-DD hh:mm:ss |
API Response Parameter Variables |
XML Name Space |
Value |
status |
Successful or Unsuccessful |
messages and/or errors |
API messages: each with a tag <message> |
Created_From |
Date Widget use created from (used to find Widget Users, if provided) |
Created_To |
Date Widget use created to (used to find Widget Users, if provided) |
total_users |
Total number of Widget Users reported |
user |
A Widget User record: data as follows: |
date_created |
YYYY-MM-DD HH:mm:ss |
cfirstname |
First name |
clastname |
Last name |
cphone |
Phone |
cemail |
Email |
czip |
Zipcode |
All rights reserved by SolarReviews.com, 1625 Broadway Suite 830, Denver, CO 80202