{"type":"doc","content":[{"type":"paragraph","content":[{"text":"This API provides access to a range of data from:","type":"text"}]},{"type":"paragraph"},{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"toc","parameters":{"macroParams":{},"macroMetadata":{"macroId":{"value":"024bb6ff-0f34-4c35-aa10-5202564f3797"},"schemaVersion":{"value":"1"},"title":"Table of Contents"}},"localId":"37de8be5-8d24-42e1-b64b-43f73449bd06"}},{"type":"heading","attrs":{"level":1},"content":[{"text":"Systems (quote data related to the system design)","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"System Quotes via Quote Number","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"Endpoint:","type":"text","marks":[{"type":"strong"}]},{"text":" /api/system?quote_number=","type":"text"}]},{"type":"paragraph","content":[{"text":"Example","type":"text","marks":[{"type":"strong"}]},{"text":":","type":"text"},{"text":" ","type":"text","marks":[{"type":"link","attrs":{"href":"http://go.solarplus.co/api/contact/quotes/25487"}}]},{"text":"https://go.solarplus.co/api/system?quote_number=5012","type":"text","marks":[{"type":"link","attrs":{"href":"http://go.solarplus.co/api/system?quote_number=5012"}}]}]},{"type":"paragraph","content":[{"text":"Request Method","type":"text","marks":[{"type":"strong"}]},{"text":": GET","type":"text"}]},{"type":"paragraph","content":[{"text":"Result","type":"text","marks":[{"type":"strong"}]},{"text":":","type":"text"}]},{"type":"table","attrs":{"layout":"default"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[680.0]},"content":[{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"success\": true,\n \"message\": \"Successfully retrieved quotes.\",\n \"data\": {\n \"id\": \"119\",\n \"name\": \"LKSSS-110920-07:37\",\n \"quote_number\": 5012,\n \"pv_kw_size\": 0,\n \"total_panels\": 0,\n \"module\": [],\n \"inverter\": [],\n \"battery_inverter\": [],\n \"battery\": [],\n \"site_assessment\": {\n \"id\": \"1\",\n \"site_id\": \"119\",\n \"system_id\": \"119\",\n \"contact_id\": \"65932\",\n \"bldg_type\": \"0\",\n \"bldg_stories\": \"1\",\n \"bldg_height\": \"2.4\",\n \"roof_material\": \"6\",\n \"roof_extrusion\": \"123\",\n \"roof_condition\": \"good\",\n \"grid_underground\": \"1\",\n \"grid_pillar_no\": \"123\",\n \"array_length\": \"123\",\n \"household_size\": \"2\",\n \"load_type\": \"123\",\n \"load_daily_kWh\": \"123\",\n \"load_night_perc\": \"123\",\n \"daily_kWh\": \"123\",\n \"bldg_ess_habitable\": \"1\",\n \"bldg_exterior_clad\": \"2\",\n \"bldg_eave_height\": \"123.0\",\n \"bldg_ess_shed\": \"1\",\n \"bldg_ess_location_ok\": \"1\",\n \"bldg_ess_habit_behind\": \"1\",\n \"bldg_ess_habit_above\": \"1\",\n \"bldg_ess_notes\": \"sample notes\",\n \"created_user_id\": \"2288\",\n \"created_at\": \"2021-06-22 20:04:39\",\n \"updated_user_id\": \"2288\",\n \"updated_at\": \"2021-06-22 22:27:34\",\n \"cable_inverter_to_battery_length\": null,\n \"bldg_status\": \"0\",\n \"main_supply_switch_rating\": \"123\",\n \"average_bill_cost_per_month\": \"123\",\n \"aim_battery_storage\": \"2\",\n \"timeframe_for_install\": \"2\",\n \"is_energy_monitoring_priority\": \"0\",\n \"finance\": \"1\",\n \"any_rebates_applicable\": \"sample\"\n }\n }\n}","type":"text"}]}]}]}]},{"type":"paragraph"},{"type":"heading","attrs":{"level":2},"content":[{"text":"Create System from Customer ID","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"Endpoint:","type":"text","marks":[{"type":"strong"}]},{"text":" /api/system?contact_id=","type":"text"}]},{"type":"paragraph","content":[{"text":"Example","type":"text","marks":[{"type":"strong"}]},{"text":":","type":"text"},{"text":" ","type":"text","marks":[{"type":"link","attrs":{"href":"http://go.solarplus.co/api/contact/quotes/25487"}}]},{"text":"https://go.solarplus.co/api/system?contact_id=65932","type":"text","marks":[{"type":"link","attrs":{"href":"https://go.solarplus.co/api/system?contact_id=65932"}}]}]},{"type":"paragraph","content":[{"text":"Request Method","type":"text","marks":[{"type":"strong"}]},{"text":": POST","type":"text"}]},{"type":"paragraph","content":[{"text":"JSON Payload","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"structure_id\": 25640, // load tariff based on id\n \"profile_id\": 11981, // consumption profile id\n \"avg_daily_kwh\": 123, // Average daily kwh under consumption profile\n \"package_id\": 2 // system package id,\n \"customer_rep\": \"John Doe\" // Name of the Customer Representative\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Result","type":"text","marks":[{"type":"strong"}]},{"text":":","type":"text"}]},{"type":"table","attrs":{"layout":"default"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[680.0]},"content":[{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"id\": \"70\",\n \"name\": \"JT-310521-21:15\",\n \"site_id\": \"76\"\n}","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Update System","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"Endpoint:","type":"text","marks":[{"type":"strong"}]},{"text":" /api/system/","type":"text"}]},{"type":"paragraph","content":[{"text":"Example","type":"text","marks":[{"type":"strong"}]},{"text":":","type":"text"},{"text":" ","type":"text","marks":[{"type":"link","attrs":{"href":"http://go.solarplus.co/api/contact/quotes/25487"}}]},{"text":"https://go.solarplus.co/api/system/70","type":"text","marks":[{"type":"link","attrs":{"href":"https://go.solarplus.co/api/system/70"}}]}]},{"type":"paragraph","content":[{"text":"Request Method","type":"text","marks":[{"type":"strong"}]},{"text":": PUT","type":"text"}]},{"type":"paragraph","content":[{"text":"JSON Payload","type":"text","marks":[{"type":"strong"}]}]},{"type":"table","attrs":{"layout":"default"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[680.0]},"content":[{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":" {\n \"system\": {\n \"name\": \"LK-110920-07:37\",\n \"status\": \"\",\n \"supplier_id\": null,\n \"is_template\": 0,\n \"f_climate\": 1.000,\n \"f_mismatch\": 1,\n \"f_dirt\": 0.95,\n \"f_grid\": 0.999,\n \"price\": null,\n \"quote_use_price\": 1,\n \"quote_price\": 0.00,\n \"quote_deposit\": 0.00,\n \"quote_status\": 1,\n \"quote_show_discount\": 1,\n \"stc_eligible\": 1,\n \"stc_payment_option\": 1,\n \"quote_signator\": \"\",\n \"quote_signature\": \"\",\n \"quote_sig_hash\": \"\",\n \"quote_sig_ip\": \"\",\n \"quote_sig_created\": \"2020-09-10 20:41:16\",\n \"quote_payment_years\": 11,\n \"quote_intro\": \"

Hi [[customer_name]],

\\r\\n\\r\\n

Thank you for choosing [[business_name]] for your solar power system quote.

\\r\\n\\r\\n

1. Review the proposal PDF attached as this contains details of the system we're recommending and the possible benefits to you.

\\r\\n\\r\\n

2. Visit the link below to review and accept our terms if you are ready to proceed.

\\r\\n\\r\\n

[[quote_acceptance_link]]

\\r\\n\\r\\n

Thanks and don't hesitate to call us to discuss this further.

\\r\\n\\r\\n

Kind regards,

\\r\\n\\r\\n

[[user_full_name]]
\\r\\n[[business_name]]
\\r\\n[[business_email]]
\\r\\n[[primary_phone]]

\\r\\n\\r\\n

\\r\\n\",\n \"stc_value\": 35.00,\n \"business_category_id\": null,\n \"apply_gst\": 0,\n \"bill_of_materials_notes\": \"\",\n \"com_man_show_serials\": 1,\n \"customer_rep_id\": null,\n \"site_assessor_id\": null,\n \"installer_id\": null,\n \"designer_id\": null,\n \"com_data\": null,\n \"connection_diagram\": \"\",\n \"array_restricted_access\": 0,\n \"setting_use_cec\": 1,\n \"setting_use_tax\": 1,\n \"setting_tax_label\": \"GST\",\n \"setting_tax_percent\": 10.00,\n \"setting_quote_number\": 4931,\n \"quote_show_customer\": 0,\n \"quote_order\": \"a:16:{i:0;s:9:\\\"remainder\\\";i:1;s:7:\\\"package\\\";i:2;s:4:\\\"item\\\";i:3;s:8:\\\"inverter\\\";i:4;s:6:\\\"module\\\";i:5;s:8:\\\"mounting\\\";i:6;s:4:\\\"fuse\\\";i:7;s:4:\\\"mppt\\\";i:8;s:10:\\\"isolatorac\\\";i:9;s:10:\\\"isolatordc\\\";i:10;s:5:\\\"meter\\\";i:11;s:7:\\\"monitor\\\";i:12;s:6:\\\"manage\\\";i:13;s:17:\\\"batteryController\\\";i:14;s:7:\\\"battery\\\";i:15;s:9:\\\"optimiser\\\";}\",\n \"quote_remainder\": null,\n \"quote_conditions\": null,\n \"email_performance\": 1,\n \"quote_email_subject\": \"Quote for your solar power installation\",\n \"tariff_escalation_rate\": 5.0,\n \"fit_escalation_rate\": null,\n \"degrad_rate\": 0.5,\n \"degrad_rate_y2\": 2.0,\n \"reinvest1_year\": 10,\n \"lifecycle\": 25,\n \"reinvest1\": null,\n \"reinvest2_year\": 15,\n \"reinvest2\": null,\n \"mainten\": null,\n \"discount_rate\": 3.0,\n \"quote_sent\": 1,\n \"hide_item_pricing\": 1, // boolean 1 = true 0 = false\n \"structure_id\": 70407,\n \"contact_id\": 65917,\n \"yearly_profile_id\": null,\n \"backup_type\": 1,\n \"energy_control_profile_id\": null,\n \"lgc_eligible\": 0,\n \"tax_credit\": 0,\n \"tax_credit_rate\": 0.00,\n \"is_invoice\": null,\n \"quote_valid_date\": \"2020-09-18\",\n \"install_date\": \"0000-00-00 00:00:00\",\n \"quote_approved_at\": null,\n \"quote_features\": null,\n \"quote_price_location\": 0,\n \"show_hidden_component\": 0,\n \"new_tariff_id\": null,\n \"commissioning_notes\": null,\n \"report_simple\": 0,\n \"deprec_yr1_value\": null,\n \"deprec_yr1_perc\": null,\n \"deprec_subsequent_perc\": null,\n \"nominal_tax_rate\": null,\n \"use_design_page\": 1, // boolean 1 = true 0 = false\n \"lgc_regression_rate\": 0.0000\n }\n }","type":"text"}]}]}]}]},{"type":"paragraph","content":[{"text":"Result","type":"text","marks":[{"type":"strong"}]},{"text":":","type":"text"}]},{"type":"table","attrs":{"layout":"default"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[680.0]},"content":[{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"success\": false,\n \"message\": \"Successfully updated system.\"\n}","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Site survey","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Fetching system via quote number includes site assessment data","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"Endpoint:","type":"text","marks":[{"type":"strong"}]},{"text":" /api/system?quote_number=","type":"text"}]},{"type":"paragraph","content":[{"text":"Example","type":"text","marks":[{"type":"strong"}]},{"text":":","type":"text"},{"text":" ","type":"text","marks":[{"type":"link","attrs":{"href":"http://go.solarplus.co/api/contact/quotes/25487"}}]},{"text":"https://go.solarplus.co/api/system?quote_number=5012","type":"text","marks":[{"type":"link","attrs":{"href":"https://go.solarplus.co/api/system?quote_number=5012"}}]}]},{"type":"paragraph","content":[{"text":"Request Method","type":"text","marks":[{"type":"strong"}]},{"text":": GET","type":"text"}]},{"type":"paragraph","content":[{"text":"Result","type":"text","marks":[{"type":"strong"}]},{"text":":","type":"text"}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"success\": true,\n \"message\": \"Successfully retrieved quotes.\",\n \"data\": {\n \"id\": \"119\",\n \"name\": \"LKSSS-110920-07:37\",\n \"quote_number\": 5012,\n \"pv_kw_size\": 0,\n \"total_panels\": 0,\n \"module\": [],\n \"inverter\": [],\n \"battery_inverter\": [],\n \"battery\": [],\n \"site_assessment\": {\n \"id\": \"1\",\n \"site_id\": \"119\",\n \"system_id\": \"119\",\n \"contact_id\": \"65932\",\n \"bldg_type\": \"0\",\n \"bldg_stories\": \"1\",\n \"bldg_height\": \"2.4\",\n \"roof_material\": \"6\",\n \"roof_extrusion\": \"123\",\n \"roof_condition\": \"good\",\n \"grid_underground\": \"1\",\n \"grid_pillar_no\": \"123\",\n \"array_length\": \"123\",\n \"household_size\": \"2\",\n \"load_type\": \"123\",\n \"load_daily_kWh\": \"123\",\n \"load_night_perc\": \"123\",\n \"daily_kWh\": \"123\",\n \"bldg_ess_habitable\": \"1\",\n \"bldg_exterior_clad\": \"2\",\n \"bldg_eave_height\": \"123.0\",\n \"bldg_ess_shed\": \"1\",\n \"bldg_ess_location_ok\": \"1\",\n \"bldg_ess_habit_behind\": \"1\",\n \"bldg_ess_habit_above\": \"1\",\n \"bldg_ess_notes\": \"sample notes\",\n \"created_user_id\": \"2288\",\n \"created_at\": \"2021-06-22 20:04:39\",\n \"updated_user_id\": \"2288\",\n \"updated_at\": \"2021-06-22 22:27:34\",\n \"cable_inverter_to_battery_length\": null,\n \"bldg_status\": \"0\",\n \"main_supply_switch_rating\": \"123\",\n \"average_bill_cost_per_month\": \"123\",\n \"aim_battery_storage\": \"2\",\n \"timeframe_for_install\": \"2\",\n \"is_energy_monitoring_priority\": \"0\",\n \"finance\": \"1\",\n \"any_rebates_applicable\": \"sample\"\n }\n }\n}","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Update Site Survey","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"Endpoint:","type":"text","marks":[{"type":"strong"}]},{"text":" /api/system/","type":"text"}]},{"type":"paragraph","content":[{"text":"Example","type":"text","marks":[{"type":"strong"}]},{"text":":","type":"text"},{"text":" ","type":"text","marks":[{"type":"link","attrs":{"href":"http://go.solarplus.co/api/contact/quotes/25487"}}]},{"text":"http://go.solarplus.co/api/system/70","type":"text","marks":[{"type":"link","attrs":{"href":"http://go.solarplus.co/api/system/70"}}]}]},{"type":"paragraph","content":[{"text":"Request Method","type":"text","marks":[{"type":"strong"}]},{"text":": PUT","type":"text"}]},{"type":"paragraph","content":[{"text":"JSON Payload","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"siteAssessment\" : {\n \"bldg_type\": \"0\",\n \"bldg_stories\": \"1\",\n \"bldg_height\": \"2.4\",\n \"roof_material\": \"6\",\n \"roof_extrusion\": \"123\",\n \"roof_condition\": \"good\",\n \"grid_underground\": \"1\",\n \"grid_pillar_no\": \"123\",\n \"array_length\": \"123\",\n \"household_size\": \"2\",\n \"load_type\": \"123\",\n \"load_daily_kWh\": \"123\",\n \"load_night_perc\": \"123\",\n \"daily_kWh\": \"123\",\n \"bldg_ess_habitable\": \"1\",\n \"bldg_exterior_clad\": \"2\",\n \"bldg_eave_height\": \"123.0\",\n \"bldg_ess_shed\": \"1\",\n \"bldg_ess_location_ok\": \"1\",\n \"bldg_ess_habit_behind\": \"1\",\n \"bldg_ess_habit_above\": \"1\",\n \"bldg_ess_notes\": \"sample notes\",\n \"created_user_id\": \"2288\",\n \"created_at\": \"2021-06-22 20:04:39\",\n \"updated_user_id\": \"2288\",\n \"updated_at\": \"2021-06-22 22:27:34\",\n \"cable_inverter_to_battery_length\": null,\n \"bldg_status\": \"0\",\n \"main_supply_switch_rating\": \"123\",\n \"average_bill_cost_per_month\": \"123\",\n \"aim_battery_storage\": \"2\",\n \"timeframe_for_install\": \"2\",\n \"is_energy_monitoring_priority\": \"0\",\n \"finance\": \"1\",\n \"any_rebates_applicable\": \"sample\"\n }\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Result","type":"text","marks":[{"type":"strong"}]},{"text":":","type":"text"}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"success\": true,\n \"message\": \"Successfully updated site survey.\"\n}","type":"text"}]}],"version":1}

Browser not supported