Get Battery Job GET

Path:/pvds/:id/get_battery_info.json

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

HTTP Method:GET

Request Parameters

Parameter	Type	Is Required?	Note	Example
`id`	String	Yes	id means gwtid	"GWT12234"

Response

Parameter	Type	Example	Note
`code`	Integer	200	Status code: 200: success 400: parameters error 401: authorization failure
`message`	String		An error message will be returned here if the request is incorrect
`response`	JSON
`response["body"]`	JSON		stc_job_detail_data

Stc Job Detail parameter info

Parameter	Type	Note
`gwtid`	String	The gwtid assigned to the pvd
`pvd_num`	String	The government will assign a id to the submitted job
`trade_mode`	String	Has to be one of the following options: Credit Cash
`claimed_quantity`	Integer	System -> Panel RECs Quantity
`price`	Decimal	The sold price for this STC Job.
`gst`	Boolean	1. gst=true: this is a commercial building 2. gst=false: it is a residential building
`submit_date`	Date	The date that GreenDeal submits the job to Clean Energy Regulator.
`paid_date`	Date	The date that the job paid.
`credit_memo`	String	Credit Memo Reference / Payment Remittance Reference
`unqualified_reasons`	Text	The unqualified reason for this STC job.
`failed_reasons`	Text	The reason why the government rejects this pvd.
`received_date`	Datetime	Retailer's Lodged Date.
`reference`	String	Order reference of this Job (e.g: your purchase order number)
`amount`	Decimal	STC amount for the current Job
`install_detail`	JSON	install_detail_data
`owner_detail`	JSON	owner_detail_data
`system_detail`	JSON	system_detail_data
`serial_numbers`	Array	Panel's serial number
`serial_numbers_photo`	Array	The url of photos
`stc_documents`	Array	A document about information of the job
`coc_documents`	Array	Certificate of compliance
`noc_documents`	Array	Notice of completion documents
`other_documents`	Array	Other files can be uploaded
`installer_signed_at`	String
`installer_signed_signature`	String
`designer_signed_at`	String
`designer_signed_signature`	String
`owner_signed_at`	String
`owner_signed_signature`	String
`witness_signed_at`	String
`witness_signed_signature`	String
`retailer_signed_at`	String
`retailer_signed_signature`	String
`retailer_witness_signed_at`	String
`retailer_witness_signed_signature`	String
`installer_witness_signed_at`	String
`installer_witness_signed_signature`	String
`designer_witness_signed_at`	String
`designer_witness_signed_signature`	String

Owner detail parameters

Parameter	Type	Note
`first_name`	String	Owner first name
`last_name`	String	Owner last name
`state`	String	One of followings: "ACT","NSW","NT","QLD","SA","TAS","VIC" and "WA"
`phone`	String	Telephone number
`delivery_type`	String	Delivery type of postal:pobox
`delivery_number`	String	Delivery number of postal:766
`suburb`	String	For example:"ALLOWAY","ABBOTSFORD" and so on
`post_code`	String	The region zip code
`type`	String	Owner type: 1.Individual 2.Corporate body 3.Government body 4.Trustee
`type_name`	String	Name for owner type
`address_type`	String	Address type: 1.Physical 2.Postal
`address`	String	Owner address

Install detail parameter info

Parameter	Type	Note
`property_type`	String	Property type: Residential School Commercial
`latitude`	String	Latitude of Installation Address,between -90 and 90
`longitude`	String	Longitude of Installation Address,between -180 and 180
`special_address`	String	Needs some notes if the installation address is special.(e.g:Fosters Dam Pump Site)
`installation_address`	String	The detailed installation address
`single_or_multi_story`	String	A selection of the installation address is single story or multi story.

System detail parameter info

Parameter	Type	Note
`deemed_years`	Integer	The shelf life for the system
`installation_date`	Date	The scheduled time when the installer will start the job
`type_of_connection`	String	So far there are three types: "Connected to an electricity grid with battery storage" -> "1" "Connected to an electricity grid without battery storage" -> "2" "Stand-alone (not connected to an electricity grid)" -> "3"
`connected_type`	String	Type of Connected So far there are two types: "on-grid" "off-grid"
`is_battery`	String	The system has a battery storage? is_battery=true batteries is required
`system_mounting_type`	String	System mounting type: 1.Building or structure 2.Ground mounted or free standing
`rated_output`	Float	Rated output of each solar system
`complete_unit`	String	Whether it is an additional capacity/panels to an existing system
`additional_upgrade_system_details`	String	Some necessary notes needed if it is not the first time to install system
`install_additional_information`	String	Additional Information
`panel_brand`	String	Panel brand
`panel_model`	String	Panel model
`number_panels`	Integer	Quantity of panels
`number_inverters`	String	Quantity of inverters
`watts_per_panel`	Integer	Power per panel
`inverter_manufacture`	String	Manufacturer of inverter
`inverter_series`	String	Inverter series
`inverter_model`	String	Inverter model
`battery_manufacture`	String	Manufacturer of battery
`battery_series`	String	Battery series
`battery_model`	String	Battery model
`existing_battery_capacity_kwh`	String
`existing_battery_usable_capacity_kwh`	String
`battery_installation_type`	String
`battery_installation_location`	String
`battery_inverter_integration_type`	String
`panels`	Array	Panels detail
`inverters`	Array	Inverters detail
`batteries`	Array	Batteries detail

Panels params info

Parameter	Type	Note
`id`	Int
`panel_brand`	String	CSI Solar Co Ltd
`panel_model`	String	CS1H-330MS (IEC1000V)
`brand_id`	Int	Brand id, see get panel brands
`watts_per`	Int
`qty`	Int

Inverters params info

Parameter	Type	Note
`id`	Int
`inverter_brand`	String	GoodWe Technologies Co Ltd
`inverter_series`	String	DNS
`inverter_model`	String	GW3000D-NS (AS4777-2 2020)
`brand_id`	Int	Brand id, see get inverter brands
`qty`	Int

Batteries params info

Parameter	Type	Note
`id`	Int
`battery_brand`	String	Smart Lifestyle Australia Pty Ltd
`battery_series`	String	SLA ESS
`battery_model`	String	SLA-ESS-S1-5kWh
`brand_id`	Int	Brand id, see get battery storages
`qty`	Int
`battery_unit`	String

Installer parameter info

Parameter	Type
`first_name`	String
`last_name`	String
`accreditation`	String
`unit_type`	String
`unit_number`	String
`street_number`	String
`street_name`	String
`street_type`	String
`suburb`	String
`state`	String
`address_type`	String
`delivery_type`	String
`delivery_number`	String
`postcode`	String
`phone`	String

Designer parameter info

Parameter	Type
`first_name`	String
`last_name`	String
`accreditation`	String
`unit_type`	String
`unit_number`	String
`street_number`	String
`street_name`	String
`street_type`	String
`suburb`	String
`state`	String
`address_type`	String
`delivery_type`	String
`delivery_number`	String
`postcode`	String
`phone`	String

Electrician parameter info

Parameter	Type
`first_name`	String
`last_name`	String
`license`	String
`unit_type`	String
`unit_number`	String
`street_number`	String
`street_name`	String
`street_type`	String
`suburb`	String
`state`	String
`address_type`	String
`delivery_type`	String
`delivery_number`	String
`postcode`	String
`phone`	String

Request Example

{
  "client_id": "23565656e63f33016ad7f4f338a6f70be78c136addbbb9c803d09756c6ee93f1",
  "signature": "5faff972b3b67ca249cf4fee9e175a6d",
  "timestamp": "2019-08-01T16:05:01+11:00",
  "id": "GWT413858"
}

Response Example

{
  "message": "success",
  "code": 200,
  "response": {
    "body": {
      "gwtid": "GWT413858",
      "pvd_num": null,
      "trade_mode": "Credit",
      "claimed_quantity": null,
      "price": null,
      "gst": true,
      "status": "Scheduled",
      "payment_status": "Open",
      "submit_date": null,
      "credit_memo": null,
      "unqualified_reasons": null,
      "failed_reasons": null,
      "created_via": "GWT",
      "note": null,
      "received_date": null,
      "reference": "",
      "amount": 0,
      "created_at": "2018-06-07T11:01:55.000+10:00",
      "finished_at": null,
      "finished_location": null,
      "install_detail": {
        "property_type": "Commercial",
        "latitude": null,
        "longitude": null,
        "special_address": "",
        "installation_address": "72 Tuohey Road ARNOLD , VIC , 3551",
        "single_or_multi_story": "Single story",
        "same_as_postal": true
      },
      "owner_detail": {
        "first_name": "",
        "last_name": "",
        "state": "VIC",
        "phone": "0409926001",
        "delivery_type": "",
        "delivery_number": "",
        "suburb": "ARNOLD",
        "post_code": "3551",
        "type": "Corporate body",
        "type_name": "JT & KM & A Tuohey",
        "address_type": "Physical",
        "address": "72 Tuohey Road ARNOLD , VIC , 3551",
        "price_to_the_home_owner": "33.xx",
        "home_owner_abn": "",
        "owner_representative_name": "test",
        "owner_representative_position": "test"
      },
      "system_detail": {
        "deemed_years": 13,
        "installation_date": "2018-06-07",
        "type_of_connection": "Connected to an electricity grid without battery storage",
        "connected_type": "on-grid",
        "is_battery": "true",
        "system_mounting_type": "Building or structure",
        "rated_output": 6.5,
        "complete_unit": "YES",
        "additional_upgrade_system_details": "Please note: this is the first installation at this address",
        "panel_brand": "GCL System Integration Technology Co Ltd",
        "panel_model": "GCL-P6/72325",
        "number_panels": 20,
        "number_inverters": "1",
        "watts_per_panel": 325,
        "inverter_manufacture": "Jiangsu GoodWe Power Supply Technology Co Ltd",
        "inverter_series": "DNS",
        "inverter_model": "GW5000D-NS",
        "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": ""
          }
        ]
      },
      "serial_numbers": [
        "311801102551347",
        "311801102551419",
        "311801102551423",
        "311801102551440"
      ],
      "serial_numbers_photo": [
        "https://s3-ap-southeast-2.amazonaws.com/greendeals3-test/uploads/pvd_serial_number/photo/1144855/ea284d78-8ab2-4f43-ab52-3bd0bcb769f2.png",
        "https://s3-ap-southeast-2.amazonaws.com/greendeals3-test/uploads/pvd_serial_number/photo/1144856/71ef30bf-c609-4be3-a59a-6afdbb18a5f3.png"
      ],
      "installer": {
        "first_name": "Lily",
        "last_name": "Jackson",
        "accreditation": "A0000001",
        "unit_type": "Apt. 155",
        "unit_number": "3499",
        "street_number": "47 Ava Run",
        "street_name": "Bruen Trail",
        "street_type": "Street",
        "suburb": "East Ivystad",
        "state": "TAS",
        "address_type": "physical",
        "delivery_type": "",
        "delivery_number": "",
        "postcode": "3191",
        "phone": "0483404356"
      },
      "designer": {
        "first_name": "Adam",
        "last_name": "Collier",
        "accreditation": "A0000002",
        "unit_type": "Apt. 243",
        "unit_number": "765",
        "street_number": "473 Henry Meadow",
        "street_name": "Bode Boulevard",
        "street_type": "Street",
        "suburb": "Lake Mayaborough",
        "state": "WA",
        "address_type": "physical",
        "delivery_type": "",
        "delivery_number": "",
        "postcode": "3329",
        "phone": "0413340599"
      },
      "electrician": {
        "first_name": "test first name",
        "last_name": "test last name",
        "license": "1234567",
        "unit_type": "Apt. 189",
        "unit_number": "9321",
        "street_number": "90 Young Court",
        "street_name": "Hackett Summit",
        "street_type": "Mews",
        "suburb": "West Jasmineview",
        "state": "QLD",
        "address_type": "physical",
        "delivery_type": "",
        "delivery_number": "",
        "postcode": "2134",
        "phone": "0479439278"
      },
      "stc_documents": [],
      "coc_documents": [],
      "noc_documents": [],
      "other_documents": [],
      "installer_signed_at": null,
      "installer_signed_signature": null,
      "designer_signed_at": null,
      "designer_signed_signature": null,
      "owner_signed_at": null,
      "owner_signed_signature": null,
      "witness_signed_at": null,
      "witness_signed_signature": null,
      "retailer_signed_at": null,
      "retailer_signed_signature": null,
      "retailer_witness_signed_at": null,
      "retailer_witness_signed_signature": null,
      "installer_witness_signed_at": null,
      "installer_witness_signed_signature": null,
      "designer_witness_signed_at": null,
      "designer_witness_signed_signature": null
    }
  }
}