GreenDeal-Open Api Document

Request Parameter

For every web service call, following parameters must be present in the request.

Parameter	Type	Is Required?	Description
client_id	String	Yes	assign client_id to app
timestamp	String	Yes	1.Format is yyyy-MM-ddTHH:mm:ss:z,for example:2016-01-01T12:00:00+11:00. 2.The maximum time error that the API server allowed is 10 minutes.
signature	String	Yes	Please see Signature Algorithm section for working out the value of the signature.

Signature Algorithm

For every request, we will need to have a 'signature' parameter in it for the authentication. Server will reject the request if the signature value failed in the validation.

Append client id, timestamp, client_secret in the string, with the appendix of"GD:" eg. signature_string = "GD:"+ client_id+timestamp+client_secret
Encrypt the signature_string that we have in the above step. eg. md5(signature_string).
MD5 uses a 128-bit length digest algorithm, which is expressed in hexadecimal.
A hexadecimal character can represent 4 bits, so the signed character length is fixed to 32 hexadecimal characters.

Get STC Job

Path: /pvds/:id.json

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

id means gwtid

HTTP Method：GET

Request Parameter

Parameter	Type	Is Required?	Example
id	String	Yes	"GWT12234"

Response

Parameter	Type	Example	Description
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	Description
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 -> 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
invoice_documents	Array	electronic invoices provided by retailers
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

Owner detail parameters

Parameter	Type	Description
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	Description
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	Description
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"
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
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

Installer parameter info

Parameter	Type	Description
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	Description
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	Description
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 \u0026 KM \u0026 A Tuohey ",
        "address_type": "Physical",
        "address": "72 Tuohey Road ARNOLD , VIC , 3551"
      },
      "system_detail": {
        "deemed_years": 13,
        "installation_date": "2018-06-07",
        "type_of_connection": "Connected to an electricity grid without battery storage",
        "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"
      },
      "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": "Leah",
        "last_name": "Little",
        "license": "6745260859",
        "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": [],
      "invoice_documents": [],
      "other_documents": []
    }
  }
}

Create stc jobs

Path: /pvds.json

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

HTTP Method：POST

Request Parameter

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: "Creadit" or "Cash"	"Credit"
po_reference	String	Yes	Customer Reference	"A2444"
order_reference	String	Yes	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": "1", "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": "Leah", "last_name": "Little", "license": "6745260859", }`

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"
unit_type	String	No	unit Type of owner address	"ANT"
unit_number	String	No	unit number of owner address	"4"
street_number	String	Yes	street number of owner address	"10"
street_name	String	Yes	street name of owner address	"GEORGE ST"
street_type	String	Yes	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	"07 3387 1810"
email	String	Yes	owner email	"stc@greendeal.com.au"
price_to_the_home_owner	String	Yes	System owner's STC unit price required when owner_type is not "Individual" and property_type is "Commercial"	3x.xx
home_owner_abn	String	Yes	System owner's ABN required when owner_type is not "Individual" and property_type is "Commercial"	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	Yes	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	Int	Yes	Type of Connection 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"	"1"
battery_storage_manufacturer	String	No	battery storage manufacturer	"Sungrow-Samsung"
battery_storage_model	String	No	battery storage model	"SG-WMB-SBP4K8"
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	additional information	This is a commercial building,signer is general maneger of this company.Company ABN isXXXXXXXX
inverters	Array	No	See inverters info
panels	Array	No	See panels 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	Example
brand_id	Int	Yes	See get inverter brands
qty	Int	Yes

Installer params info

Parameter	Type	Is Required?	Note	Example
first_name	String	Yes
last_name	String	Yes
accreditation	String	Yes

Designer params info

Parameter	Type	Is Required?	Note	Example
first_name	String	Yes
last_name	String	Yes
accreditation	String	Yes

Eelectrician params info

Parameter	Type	Is Required?	Note	Example
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"
  },
  "system": {
    "installation_type": "new_system",
    "connected": "1",
    "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
    }]
  }
}

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": {
        "property_type": "Commercial",
        "latitude": null,
        "longitude": null,
        "special_address": null,
        "installation_address": " BEECHMONT , 4211",
        "single_or_multi_story": "Single story",
        "same_as_postal": false
      },
      "owner_detail": {
        "first_name": null,
        "last_name": null,
        "state": null,
        "phone": null,
        "delivery_type": "",
        "delivery_number": "",
        "suburb": null,
        "post_code": null,
        "type": null,
        "type_name": "",
        "address_type": "Physical",
        "address": " "
      },
      "system_detail": {
        "deemed_years": 15,
        "installation_date": "2019-08-05",
        "type_of_connection": "1",
        "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"
      },
      "serial_numbers": [

      ],
      "serial_numbers_photo": [

      ],
      "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": "Leah",
        "last_name": "Little",
        "license": "6745260859",
        "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": [

      ],
      "invoice_documents": [

      ],
      "other_documents": [

      ]
    }
  }
}

Delete STC Job

Path: /pvds/:id.json

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

id means gwtid

HTTP Method：DELETE

Request Parameter

Parameter	Type	Is Required?	Example
id	String	Yes	"GWT383595"

Response

      
{
  "message": "STC job was successfully delete"
}

Request Example

      
{
  "client_id": "23565656e63f33016ad7f4f338a6f70be78c136addbbb9c803d09756c6ee93f1",
  "signature": "2dc1b977b376a2fd26bf05c1f15da59b",
  "timestamp": "2019-08-02T10:31:50+11:00",
  "id": "GWT383595"
}

Response Example

      
{
  "message": "STC job was successfully delete"
}

Update Job Status

Path: /pvds/update_status.json

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

HTTP Method：POST

Request Parameter

Parameter	Type	Is Required?	Note	Example
id	String	Yes		"GWT383595"
status	String	Yes	Status, Valid values are: "Installing" or "Installed"	"Installing"

Response

Request Example

      
{
  "client_id": "23565656e63f33016ad7f4f338a6f70be78c136addbbb9c803d09756c6ee93f1",
  "signature": "2dc1b977b376a2fd26bf05c1f15da59b",
  "timestamp": "2019-08-02T10:31:50+11:00",
  "id": "GWT383595",
  "status": "Installed"
}

Response Example

See Get Stc Job Response

Upload Job Attachment

Path: /pvds/upload_attachment.json

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

HTTP Method：POST

Request Parameter

Parameter	Type	Is Required?	Note	Example
id	String	Yes		"GWT383595"
attachment_type	String	Yes	Attachment Type, Valid values are: "other_document" , "stc_document" , "coc_document" or "invoice_document" other_document: Other Documents stc_document: STC Form coc_document: COC (ESC) Document invoice_document: STC Invoice Document	"invoice_document"
file_name	String	Yes		"invoice document.pdf"
file	String	Yes	Base64 encoded file Example: original string: abcde encode string: YWJjZGU=

Request Example

      
{
  "client_id": "23565656e63f33016ad7f4f338a6f70be78c136addbbb9c803d09756c6ee93f1",
  "signature": "2dc1b977b376a2fd26bf05c1f15da59b",
  "timestamp": "2019-08-02T10:31:50+11:00",
  "id": "GWT383595",
  "attachment_type": "other_document",
  "file_name": "invoice document.pdf",
  "file": "/9j/4AAQSkZJRgABAQAAkACQAAD/4QB0RXhpZgAATU0AKgAAAAgABAEaAAUAAAABAAA.....pGiiivsjkCiiigAooooAKKKKAP/2Q=="
}

Response Example

See Get Stc Job Response

Upload Serial Number

Path: /pvds/upload_serial_number.json

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

HTTP Method：POST

Request Parameter

Parameter	Type	Is Required?	Note	Example
id	String	Yes		"GWT383595"
serial_number	String	Yes		"9010KDTL2xxxx"
photo_name	String	Yes		"serial_number_photo.png"
photo	String	Yes	Base64 encoded image file Example: original string: abcde encode string: YWJjZGU=

Request Example

      
{
  "client_id": "23565656e63f33016ad7f4f338a6f70be78c136addbbb9c803d09756c6ee93f1",
  "signature": "2dc1b977b376a2fd26bf05c1f15da59b",
  "timestamp": "2019-08-02T10:31:50+11:00",
  "id": "GWT383595",
  "serial_number": "test_serial_code",
  "photo_name": "serial_number_photo.png",
  "photo": "/9j/4AAQSkZJRgABAQAAkACQAAD/4QB0RXhpZgAATU0AKgAAAAgABAEaAAUAAAABAAA.....pGiiivsjkCiiigAooooAKKKKAP/2Q=="
}

Response Example

      
{
  "id":xx,
  "code":"test_serial_code",
  "photo":"https://s3-ap-southeast-2.amazonaws.com/xxx/xxx/xxx/photo/xx/serial_number_photo.png"
}

Upload Inverter Number

Path: /pvds/upload_inverter_number.json

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

HTTP Method：POST

Request Parameter

Parameter	Type	Is Required?	Note	Example
id	String	Yes		"GWT383595"
inverter_number	String	Yes		"9010KDTL204W0168009262xxxx"
check_code	String	No
photo_name	String	Yes		"interver_photo.png"
photo	String	Yes	Base64 encoded image file Example: original string: abcde encode string: YWJjZGU=

Request Example

      
{
  "client_id": "23565656e63f33016ad7f4f338a6f70be78c136addbbb9c803d09756c6ee93f1",
  "signature": "2dc1b977b376a2fd26bf05c1f15da59b",
  "timestamp": "2019-08-02T10:31:50+11:00",
  "id": "GWT383595",
  "inverter_number": "test_inverter_code",
  "check_code": "",
  "photo_name": "interver_photo.png",
  "photo": "/9j/4AAQSkZJRgABAQAAkACQAAD/4QB0RXhpZgAATU0AKgAAAAgABAEaAAUAAAABAAA.....pGiiivsjkCiiigAooooAKKKKAP/2Q=="
}

Response Example

      
{
  "id":xx,
  "code":"test_inverter_code",
  "photo":"https://s3-ap-southeast-2.amazonaws.com/xxx/xxx/xxx/photo/xx/flower.png"
}

Get Owner Signature Url

Path: /pvds/owner_signature_url.json

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

HTTP GET

Request Parameter

Parameter	Type	Is Required?	Example
id	String	Yes	"GWT383595"

Response

      
{
  "signature_url":"http://www.greendeal.com.au/web_sign/xxx/installer_read/xxx",
  "expires_in":"2020-12-30T16:17:35.429+08:00"
}

Request Example

      
{
  "client_id": "23565656e63f33016ad7f4f338a6f70be78c136addbbb9c803d09756c6ee93f1",
  "signature": "2dc1b977b376a2fd26bf05c1f15da59b",
  "timestamp": "2019-08-02T10:31:50+11:00",
  "id": "GWT383595"
}

Response Example

      
{
  "signature_url":"http://www.greendeal.com.au/web_sign/xxx/installer_read/xxx",
  "expires_in":"2020-12-30T16:17:35.429+08:00"
}

Get Installer Signature Url

Path: /pvds/installer_signature_url.json

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

HTTP GET

Request Parameter

Parameter	Type	Is Required?	Example
id	String	Yes	"GWT383595"

Response

      
{
  "signature_url":"http://www.greendeal.com.au/web_sign/xxx/installer_read/xxx",
  "expires_in":"2020-12-30T16:17:35.429+08:00"
}

Request Example

      
{
  "client_id": "23565656e63f33016ad7f4f338a6f70be78c136addbbb9c803d09756c6ee93f1",
  "signature": "2dc1b977b376a2fd26bf05c1f15da59b",
  "timestamp": "2019-08-02T10:31:50+11:00",
  "id": "GWT383595"
}

Response Example

      
{
  "signature_url":"http://www.greendeal.com.au/web_sign/xxx/installer_read/xxx",
  "expires_in":"2020-12-30T16:17:35.429+08:00"
}

Get Checklist

Path: /pvds/get_checklist.json

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

HTTP Method：GET

Request Parameter

Parameter	Type	Is Required?	Note	Example
id	String	Yes		"GWT383595"

Response

Parameter	Type	Example	Description
checklist_id	Integer	3	checklist id
title	String		checklist title
type	String	boolean	Has to be one of the following options: boolean text image
images	JSON		checklist_image_parameter_info
answer	String	test
answered_at	String	Jan 12 2021 20:07:49
full_name	String	xx xx	installer name
is_required	String	true	the checklist is required

Checklist Image parameter info

Parameter	Type	Example	Description
id	Integer
image	String	https://xxx.com.au/xxx.png	checklist image url
record_at	String

Request Example

      
{
  "client_id": "23565656e63f33016ad7f4f338a6f70be78c136addbbb9c803d09756c6ee93f1",
  "signature": "2dc1b977b376a2fd26bf05c1f15da59b",
  "timestamp": "2019-08-02T10:31:50+11:00",
  "id": "GWT383595"
}

Response Example

      
[
  {
    "checklist_id":3,
    "title":"Array frame is certified to AS1170.2 for installation location",
    "type":"boolean",
    "images":[
    ],
    "answer":"true",
    "answered_at":"Jan 12 2021 20:07:49",
    "full_name":"xx xx",
    "is_required":"false"
  },
  {
    "checklist_id":15,
    "title":"Picture of Roof before installation",
    "type":"image",
    "images":[
      {
        "id":"332072",
        "image":"https://xxx.com/greendeals3test/xxx.png",
        "record_at":"2020-11-10T19:52:15.418+11:00"
      }
    ],
    "answer":"",
    "answered_at":"Jan 12 2021 20:15:49",
    "full_name":"xx xx",
    "is_required":"true"
  },
  {
    "checklist_id":406,
    "title":"test",
    "type":"text",
    "images":[
    ],
    "answer":"test text",
    "answered_at":"Jan 12 2021 20:09:42",
    "full_name":"xx xx",
    "is_required":"true"
  }
]

Upload Checklist

Path: /pvds/upload_checklist.json

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

HTTP Method：POST

Request Parameter

For each job, it's mandatory to call get_checklist API before upload any checklist upload

Parameter	Type	Is Required?	Note	Example
id	String	Yes		"GWT383595"
checklist_id	Integer	Yes		3
answer	String	No	Answer(required when type is "boolean" or "text")	"true" or "false" or "answer content"
photo_name	String	No	Photo Name(required when type is "image" )	"xx.png"
photo	String	No	Photo file (required when type is "image" ) Base64 encoded image file Example: original string: abcde encode string: YWJjZGU=

Request Example

      
{
  "client_id": "23565656e63f33016ad7f4f338a6f70be78c136addbbb9c803d09756c6ee93f1",
  "signature": "2dc1b977b376a2fd26bf05c1f15da59b",
  "timestamp": "2019-08-02T10:31:50+11:00",
  "id": "GWT383595",
  "checklist_id": 15,
  "content": "",
  "photo_name": "xx.png",
  "photo": "/9j/4AAQSkZJRgABAQAAkACQAAD/4QB0RXhpZgAATU0AKgAAAAgABAEaAAUAAAABAAA.....pGiiivsjkCiiigAooooAKKKKAP/2Q=="
}

Response Example

See Get Checklist Response

Get panel brands

Path: /dictionaries/panel_brands.json

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

HTTP Method：GET

Request Parameter

Parameter	Type	Is Required?	Description	Example
brand_id	Int	No	When brand_id not provided, default returns records for all brand	2648

Response

Parameter	Type	Description
id	Int
name	String	panel brand(eg:Canadian Solar Inc)
model_number	String	model number of panel (eg:CS6K-255P-SD)

Request One Example

      
{
  "client_id": "23565656e63f33016ad7f4f338a6f70be78c136addbbb9c803d09756c6ee93f1",
  "signature": "2dc1b977b376a2fd26bf05c1f15da59b",
  "timestamp": "2019-08-02T10:31:50+11:00",
  "brand_id": 4480
}

Response One Example

      
{
  "message": "success",
  "code": 200,
  "response": {
    "body": {
      "id": "YL360CG2536F-2 1/2",
      "text": "Yingli Energy China Co Ltd",
      "brand_id": 4480
    }
  }
}

Request All Example

      
{
  "client_id": "23565656e63f33016ad7f4f338a6f70be78c136addbbb9c803d09756c6ee93f1",
  "signature": "2dc1b977b376a2fd26bf05c1f15da59b",
  "timestamp": "2019-08-02T10:31:50+11:00"
}

Response All Example

      
{
  "message": "success",
  "code": 200,
  "response": {
    "body": [
      ...
      {
        "id": "YL360CG2536F-2 1/2",
        "text": "Yingli Energy China Co Ltd",
        "brand_id": 4480
      },
      ...
    ]
  }
}

Get inverter brands

Path: /dictionaries/inverter_brands.json

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

HTTP Method：GET

Request Parameter

Parameter	Type	Is Required?	Description	Example
brand_id	Int	No	When brand_id not provided, default returns records for all brand	253
series	String	No		Symo

Response

Parameter	Type	Description
id	Int
name	String	inverter manufacturer(e.g:SMA Australia Pty Ltd)
model_number	String	model number of inverter(eg:STP12000TL-20)
series	String	inverter series(eg:4G)
ac_power	Int	inverter ac_power(eg:2850)

Request One Example

      
{
  "client_id": "23565656e63f33016ad7f4f338a6f70be78c136addbbb9c803d09756c6ee93f1",
  "signature": "2dc1b977b376a2fd26bf05c1f15da59b",
  "timestamp": "2019-08-02T10:31:50+11:00",
  "brand_id": 191
}

Response One Example

      
{
  "message": "success",
  "code": 200,
  "response": {
    "body": {
      "id": "H3_211",
      "text": "Delta Electronics Inc",
      "name": "H3_211",
      "brand_id": 191
    }
  }
}

Request All Example

      
{
  "client_id": "23565656e63f33016ad7f4f338a6f70be78c136addbbb9c803d09756c6ee93f1",
  "signature": "2dc1b977b376a2fd26bf05c1f15da59b",
  "timestamp": "2019-08-02T10:31:50+11:00"
}

Response All Example

      
{
  "message": "success",
  "code": 200,
  "response": {
    "body": [
      ...
      {
        "id": "H3_211",
        "text": "Delta Electronics Inc",
        "name": "H3_211",
        "brand_id": 191
      },
      ...
    ]
  }
}

Get STC Price

Path: /dictionaries/get_stc_price.json

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

HTTP Method：GET

Request Parameter

Parameter

Type

Is Required?

Description

Example

Response

Parameter	Type	Description
live_stc_price	Float	Live STC Price or Cash Trade Live STC Price
battery_stc_price	Float	Battery System Price or Cash Trade Battery System Price
commercial_stc_price	Float	Commercial System Price or Cash Trade Commercial System Price
credit_live_stc_price	Float	Credit Trade Live STC Price
credit_commercial_stc_price	Float	Credit Trade Commercial System Price
credit_battery_stc_price	Float	Credit Trade Battery System Price
registered_stc_price	Float	Registered STC Price

Request Example

      
{
  "client_id": "23565656e63f33016ad7f4f338a6f70be78c136addbbb9c803d09756c6ee93f1",
  "signature": "2dc1b977b376a2fd26bf05c1f15da59b",
  "timestamp": "2019-08-02T10:31:50+11:00"
}

Response Example

      
{
  "live_stc_price":3x.xx,
  "battery_stc_price":3x.xx,
  "commercial_stc_price":3x.xx,
  "credit_live_stc_price":3x.xx,
  "credit_commercial_stc_price":3x.xx,
  "credit_battery_stc_price":3x.xx,
  "registered_stc_price":3x.xx
}

Get Installers

Path: /installers

Example: https://www.greendeal.com.au/rapi/v1/installers

HTTP Method：GET

Request Parameter

Parameter

Type

Is Required?

Example

Response

Parameter	Type	Description
first_name	String	installer first name
last_name	String	installer last name
state	String
accreditation_number	String	Accreditation Number
electrician_license	String	Electrician License
status	String	CEC installer status

Request One Example

      
{
  "client_id": "23565656e63f33016ad7f4f338a6f70be78c136addbbb9c803d09756c6ee93f1",
  "signature": "2dc1b977b376a2fd26bf05c1f15da59b",
  "timestamp": "2019-08-02T10:31:50+11:00",
}

Response One Example

      
{
  "message": "success",
  "code": 200,
  "response": {
    "body": [{
      "first_name":"test",
      "last_name":"test",
      "state":"WA",
      "accreditation_number":"test",
      "electrician_license":"test",
      "status":"Current"
    }]
  }
}

Server Information

Rate limits

Request Parameter

Signature

Signature Algorithm

Signature Example:

Restful Services

Get STC Job

Path: /pvds/:id.json

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

HTTP Method：GET

Request Parameter

Response

Stc Job Detail parameter info

Owner detail parameters

Install detail parameter info

System detail parameter info

Installer parameter info

Designer parameter info

Electrician parameter info

Request Example

Response Example

Create stc jobs

Path: /pvds.json

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

HTTP Method：POST

Request Parameter

owner_address params info

install_address params info

System params info

Panels params info

Inverters params info

Installer params info

Designer params info

Eelectrician params info

Request Example

Response Example

Delete STC Job

Path: /pvds/:id.json

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

HTTP Method：DELETE

Request Parameter

Response

Request Example

Response Example

Update Job Status

Path: /pvds/update_status.json

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

HTTP Method：POST

Request Parameter

Response

Request Example

Response Example

Upload Job Attachment

Path: /pvds/upload_attachment.json

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

HTTP Method：POST

Request Parameter

Request Example

Response Example

Upload Serial Number

Path: /pvds/upload_serial_number.json

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

HTTP Method：POST

Request Parameter

Request Example

Response Example

Upload Inverter Number

Path: /pvds/upload_inverter_number.json

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

HTTP Method：POST

Request Parameter

Request Example

Response Example

Get Owner Signature Url

Path: /pvds/owner_signature_url.json

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

HTTP GET

Request Parameter

Response