STC JOBS

Create STC Job POST

Path:/pvds.json

Example:https://www.greendeal.com.au/rapi/v1/pvds.json

HTTP Method:POST

Request Parameters

Parameter	Type	Is Required?	Note	Example
`created_by`	String	No	The user must exist in the current Retailer's User List.	"xxx@gmail.com"
`trade_mode`	String	Yes	Trade mode, Valid values are: "Credit" or "Cash"	"Credit"
`work_type`	String	Yes	If there is Only "STC-BATTERY" in the work_type, create an "STC-Battery only" Job. If the work_type contains "STC-BATTERY" and "STC-PV", create a combined job	"STC-PV, STC-BATTERY"
`po_reference`	String	Yes	Customer Reference	"A2444"
`order_reference`	String	No	Order Reference	"RSB7908"
`gst`	String	Yes	1.gst=true this is a commercial building 2.gst=false it is a residential building	"false"
`owner_address`	Hash	No	See owner_address params info	{ "first_name": "test", "last_name": "test", "address_type": "physical", "street_number": "116", "street_type":"ACCS", "suburb": "CHURCHLANDS", "street_name": "BIRCHWOOD AVENUE", "phone": "0xxxxxxxxx", "state": "ACT", "post_code": "6068", "owner_type": "Individual", "email": "test@hotmail.com" }
`install_address`	Hash	No	See install_address params info	{ "same_as_postal": "false", "story": "Single story", "post_code": "6068", "street_number": "116", "street_name": "BIRCHWOOD AVENUE WOODLANDS", "street_type": "ACCS", "suburb": "CHURCHLANDS", "state": "ACT", "property_type": "Residential", "nmi": "xxxxxxxxxx", "job_number": "yyyyyyyyy" }
`system`	Hash	No	See system params info	{ "installation_type": "new_system", "connected_type": "on-grid", "is_battery": "true", "install_date": "2019-08-05", "install_on_building": "true", "additional_capacity_details": "6 new panels replaced to old system", "panels": [{ "brand_id": 1001, "watts_per": "12", "qty": 1 }], "inverters": [{ "brand_id": 84, "qty": 1 }] }
`installer`	Hash	No	See installer params info	{ "first_name": "Lily", "last_name": "Jackson", "accreditation": "A0000001", }
`designer`	Hash	No	See designer params info	{ "first_name": "Adam", "last_name": "Collier", "accreditation": "A0000002", }
`electrician`	Hash	No	See electrician params info	{ "first_name": "test first name", "last_name": "test last name", "license": "1234567", }

Owner_address params info

Parameter	Type	Is Required?	Note	Example
`owner_type`	String	Yes	Valid values are: "Individual", "Corporate body", "Government body" or "Trustee"	"Individual"
`first_name`	String	No	first name(required when owner_type is "Individual" )	"Avril Ramona"
`last_name`	String	No	last name(required when owner_type is "Individual" )	"Lavigne"
`owner_type_name`	String	No	the name of "Corporate body", "Government body" or "Trustee" (required when owner_type is each of them)	"INTERNATIONAL FISH SUPPLIERS PTY. LTD"
`owner_representative_name`	String	No	the name of "Corporate body", "Government body" or "Trustee" (required when owner_type is each of them)	"test"
`owner_representative_position`	String	No	the name of "Corporate body", "Government body" or "Trustee" (required when owner_type is each of them)	"test"
`unit_type`	String	No	unit Type of owner address	"ANT"
`unit_number`	String	No	unit number of owner address	"4"
`street_number`	String	No	street number of owner address	"10"
`street_name`	String	No	street name of owner address	"GEORGE ST"
`street_type`	String	No	street Type of owner address	"ACCESS"
`suburb`	String	Yes	suburb of the owner address	"Barangaroo"
`state`	String	Yes	state of the owner address	"QLD"
`post_code`	String	Yes	the region zip code	"4571"
`address_type`	String	Yes	Type of owner address 1.physical 2.p_o_box(postal) Valid values are: "physical" or "p_o_box"	"physical"
`phone`	String	Yes	owner phone	"1300 951 666"
`email`	String	Yes	owner email	"stc@greendeal.com.au"
`is_owner_price_consistent`	Boolean	No	Owner's STC Unit Price will be consistent with the price sold to GD Finance，The default is true. If false is selected, the "price_to_the_home_owner" field is mandatory.	false
`price_to_the_home_owner`	String	Yes	System owner's STC unit pricerequired when owner_type is not "Individual" and property_type is "Commercial" or "School"	3x.xx
`home_owner_abn`	String	Yes	System owner's ABNrequired when owner_type is not "Individual" and property_type is "Commercial" or "School"	12345678911

Install_address params info

Parameter	Type	Is Required?	Note	Example
`same_as_postal`	String	No	The installation address is the same as the owner's address； 1.Value="true",The following owner_address parameter information is required,and address_type must be "physical": address_type=physical,street_number,street_name,street_type,suburb,state,post_code 2.Value="false"	"true"
`property_type`	String	Yes	Valid values are: "Residential", "School" or "Commercial"	"School"
`story`	String	Yes	Valid values are: "Single story" or "Multi story"	"Single story"
`nmi`	String	Yes	serial number of electric meter	"1111111111"
`job_number`	String	No	Job Number for DERR	"1111111111"
`unit_type`	String	No	unit type	"ANT"
`unit_number`	String	No	unit number	"25"
`street_number`	String	No	street number	"33"
`street_name`	String	Yes	street name	"JERVIS"
`street_type`	String	Yes	street type	"ACCESS"
`suburb`	String	Yes	suburb	"BEECHMONT"
`state`	String	Yes	state	"QLD"
`post_code`	String	Yes	post code	"4211"
`latitude`	String	No	between -90 and 90	"50"
`longitude`	String	No	between -180 and 180	"80"
`special_address`	String	No	special address	"Street type should be : Avenue south"

System params info

Parameter	Type	Is Required?	Note	Example
`installation_type`	String	Yes	Type of Installation so far there are four types: "New System" -> "new_system" "Replacement system" -> "replacement_system" "Extension system" -> "extension_system" "Additional system" -> "additional_system" New System (the first system installed at the address) Replacement system (all previous system components removed/decommissioned) Extension system (components added to existing system) Additional system (new separate system at the same address). When you select either replacement, extension or additional system to indicate the Installation type, there will be a field (Additional/Upgrade System Information) where you will be able to add any additional relevant information. This filed is not mandatory for replacement systems and mandatory for extension or additional systems. Additional information is required to explain the location of the new system/components in relation to the old system. Please provide a simple description such as 'The new system is located north of the existing system'.	"new_system"
`connected_type`	String	Yes	Type of Connected so far there are two types: "on-grid" "off-grid"	"on-grid"
`is_battery`	String	Yes	The system has a battery storage? is_battery=true batteries is required is_battery=false the batteries will not be saved. If the "work_type" field contains "STC-BATTERY", then "is_battery" must be set to true.	"true"
`install_date`	Date	Yes	installation date	"2018-10-10"
`install_on_building`	Boolean	Yes	System mounting type 1.value=true install on building or structure 2.value=false Ground mounted or free standing	"true"
`deemed_years`	Int	No	default 13	"12"
`additional_capacity_details`	String	Yes	required when type is "extension_system" or "additional_system"	Existing 3kw system located on north roof. 6 new panels replaced/upgraded to old system. Located on south-west, facing south.
`install_additional_information`	String	No
`battery_inverter_integration_type`	String	required when work_type include "STC-BATTERY"	["install_ac_coupled_battery_system", "install_battery_with_new_hybrid_inverter", "install_battery_with_existing_hybrid_inverter"]
`battery_installation_type`	String	required when work_type include "STC-BATTERY"	["new_system", "replacement_system", "extension_system", "additional_system"]
`battery_installation_location`	String	required when work_type include "STC-BATTERY"	["indoor", "outdoor"]
`existing_battery_capacity_kwh`	Decimal	required when work_type include "STC-BATTERY"
`existing_battery_usable_capacity_kwh`	Decimal	required when work_type include "STC-BATTERY"
`inverters`	Array	No	See inverters info
`panels`	Array	No	See panels info
`batteries`	Array	No	required when is_battery is "true" See batteries info

Panels params info

Parameter	Type	Is Required?	Note	Example
`brand_id`	Int	Yes	brand id, see get panel brands
`watts_per`	String	Yes	See get panel brands	"12"
`qty`	Int	Yes

Inverters params info

Parameter	Type	Is Required?	Note
`brand_id`	Int	Yes	See get inverter brands
`qty`	Int	Yes

Batteries params info

Parameter	Type	Is Required?	Note	Example
`brand_id`	Int	Yes	See get battery storages
`qty`	Int	Yes
`vpp_capable`	Boolean	Yes	VPP stands for Virtual Power Plant. If you're not sure whether this battery model is VPP-capable, you can contact the supplier or manufacturer for confirmation	true/false

Installer params info

Parameter	Type	Is Required?
`first_name`	String	Yes
`last_name`	String	Yes
`accreditation`	String	Yes

Designer params info

Parameter	Type	Is Required?
`first_name`	String	Yes
`last_name`	String	Yes
`accreditation`	String	Yes

Electrician params info

Parameter	Type	Is Required?
`first_name`	String	Yes
`last_name`	String	Yes
`license`	String	Yes

Request Example

{
  "client_id": "23565656e63f33016ad7f4f338a6f70be78c136addbbb9c803d09756c6ee93f1",
  "signature": "49f6bab0335586a39fa061eb1cfc966b",
  "timestamp": "2019-08-02T09:45:23+11:00",
  "trade_mode": "Cash",
  "po_reference": "test",
  "gst": "false",
  "install_address": {
    "same_as_postal": "false",
    "story": "Single story",
    "post_code": "6068",
    "street_number": "116",
    "street_name": "BIRCHWOOD AVENUE WOODLANDS",
    "street_type": "ACCS",
    "suburb": "CHURCHLANDS",
    "state": "ACT",
    "property_type": "Residential",
    "nmi": "xxxxxxxxxx",
    "job_number": "yyyyyyyyy"
  },
  "owner_address": {
    "first_name": "test",
    "last_name": "test",
    "address_type": "physical",
    "street_number": "116",
    "street_type": "ACCS",
    "suburb": "CHURCHLANDS",
    "street_name": "BIRCHWOOD AVENUE",
    "phone": "0xxxxxxxxx",
    "state": "ACT",
    "post_code": "6068",
    "owner_type": "Individual",
    "email": "test@hotmail.com",
    "price_to_the_home_owner": "33.xx",
    "home_owner_abn": "test abn",
    "owner_representative_name": "test",
    "owner_representative_position": "test"
  },
  "system": {
    "installation_type": "new_system",
    "connected_type": "on-grid",
    "is_battery": "true",
    "install_date": "2019-08-05",
    "install_on_building": "true",
    "additional_capacity_details": "6 new panels replaced to old system",
    "panels": [
      {
        "brand_id": 1001,
        "watts_per": "12",
        "qty": 1
      }
    ],
    "inverters": [
      {
        "brand_id": 84,
        "qty": 1
      }
    ],
    "batteries": [
      {
        "brand_id": 3433,
        "qty": 1
      }
    ]
  }
}

Response Example

{
  "message": "success",
  "code": 200,
  "response": {
    "body": {
      "gwtid": "GWT417778",
      "pvd_num": null,
      "trade_mode": "Cash",
      "claimed_quantity": null,
      "price": null,
      "gst": false,
      "status": "New",
      "payment_status": "Open",
      "submit_date": null,
      "credit_memo": null,
      "unqualified_reasons": null,
      "failed_reasons": null,
      "created_via": "GWT",
      "note": null,
      "received_date": null,
      "reference": null,
      "amount": 0,
      "created_at": "2019-08-02T19:46:04.612+10:00",
      "finished_at": null,
      "finished_location": null,
      "install_detail": {
        "unit_type": null,
        "unit_number": null,
        "post_code": "",
        "street_number": "",
        "street_name": "",
        "suburb": "",
        "state": "ACT",
        "property_type": "",
        "latitude": null,
        "longitude": null,
        "special_address": null,
        "story": "",
        "nmi": "",
        "job_number": null,
        "installation_address": "",
        "single_or_multi_story": "",
        "same_as_postal": false,
        "street_type": ""
      },
      "owner_detail": {
        "first_name": null,
        "last_name": null,
        "phone": "",
        "delivery_type": "",
        "delivery_number": "",
        "unit_type": null,
        "unit_number": null,
        "post_code": "",
        "street_number": "",
        "street_name": " AVENUE",
        "suburb": "",
        "state": "ACT",
        "email": "",
        "price_to_the_home_owner": "33.xx",
        "home_owner_abn": "",
        "owner_representative_name": "test",
        "owner_representative_position": "test",
        "type": "",
        "type_name": "test",
        "address_type": "",
        "address": "",
        "street_type": ""
      },
      "system_detail": {
        "deemed_years": 15,
        "installation_date": "2019-08-05",
        "connected_type": "on-grid",
        "is_battery": "true",
        "system_mounting_type": "Building or structure",
        "rated_output": 0.012,
        "installation_type": "new_system",
        "additional_upgrade_system_details": "6 new panels replaced to old system",
        "panel_brand": "Flextronics Industrial Ltd",
        "panel_model": "FLV-MB-320S72AB",
        "number_panels": 1,
        "number_inverters": "1",
        "watts_per_panel": 12,
        "inverter_manufacture": "Afore New Energy Technology Shanghai Co Ltd",
        "inverter_series": "Hybrid inverter",
        "inverter_model": "HNS3000HS",
        "battery_manufacture": "Alpha ESS Co Ltd",
        "battery_series": "SMILE",
        "battery_model": "SMILE-BAT-8.2 PH VI",
        "panels": [
          {
            "id": 192171,
            "panel_brand": "CSI Solar Co Ltd",
            "panel_model": "CS1H-330MS (IEC1000V)",
            "brand_id": 8664,
            "watts_per": 340,
            "qty": 1
          }
        ],
        "inverters": [
          {
            "id": 194232,
            "inverter_brand": "GoodWe Technologies Co Ltd",
            "inverter_series": "DNS",
            "inverter_model": "GW3000D-NS (AS4777-2 2020)",
            "brand_id": 3279,
            "qty": 1
          }
        ],
        "batteries": [
          {
            "id": 155,
            "battery_brand": "Smart Lifestyle Australia Pty Ltd",
            "battery_series": "SLA ESS",
            "battery_model": "SLA-ESS-S1-5kWh",
            "brand_id": 34268,
            "qty": 1,
            "battery_unit": ""
          }
        ],
        "type_of_connection": "Hybrid inverter"
      },
      "serial_numbers": [],
      "serial_numbers_photo": [],
      "installer": {
        "first_name": "Lily",
        "last_name": "Jackson",
        "accreditation": "A0000001",
        "unit_type": null,
        "unit_number": null,
        "street_number": "116",
        "street_name": "BIRCHWOOD AVENUE",
        "street_type": "ACCS",
        "suburb": "CHURCHLANDS",
        "state": "ACT",
        "address_type": "physical",
        "delivery_type": "",
        "delivery_number": "",
        "postcode": "6068",
        "phone": "0xxxxxxxxx"
      },
      "designer": {
        "first_name": "Adam",
        "last_name": "Collier",
        "accreditation": "A0000002",
        "unit_type": null,
        "unit_number": null,
        "street_number": "116",
        "street_name": "BIRCHWOOD AVENUE",
        "street_type": "ACCS",
        "suburb": "CHURCHLANDS",
        "state": "ACT",
        "address_type": "physical",
        "delivery_type": "",
        "delivery_number": "",
        "postcode": "6068",
        "phone": "0xxxxxxxxx"
      },
      "electrician": {
        "first_name": "test first name",
        "last_name": "test last name",
        "license": "1234567",
        "unit_type": null,
        "unit_number": null,
        "street_number": "116",
        "street_name": "BIRCHWOOD AVENUE",
        "street_type": "ACCS",
        "suburb": "CHURCHLANDS",
        "state": "ACT",
        "address_type": "physical",
        "delivery_type": "",
        "delivery_number": "",
        "postcode": "6068",
        "phone": "0xxxxxxxxx"
      },
      "stc_documents": [],
      "coc_documents": [],
      "noc_documents": [],
      "other_documents": []
    }
  }
}