Get STC Jobs
Path: /pvds.json
Example: https://www.greendeal.com.au/rapi/v1/pvds.json
HTTP Method: GET
Request Parameter
| Parameter | Type | Is Required? | Example |
| owner_first_name | String | NO | "CHEN" |
| owner_last_name | String | NO | "SHEN" |
| po_reference | String | NO | "12345" |
| order_reference | String | NO | "ABCDEF" |
| gwtid | String | NO | "GWT123456" |
| pvd_num | String | NO | "PVD1234567" |
| gst | Boolean | NO |
1. gst=true :this is a commercial building 2. gst=false :it is a residential building |
| spv_check | Boolean | NO | True/False |
| trade_mode | String | NO |
Has to be one of the following options: Credit Cash |
| job_type | Integer | NO |
1. job_type=1 :this is PVD job 2. job_type=2 :this is SWH job |
| page | Integer | NO | 2, current page, default value is 1 |
| per_page | Integer | NO | 10, items per page, default value is 20. The acceptable range for the input is between 1 and 100. |
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["meta"] | JSON | count_info_data | |
| response["body"] | JSON Array | stc_jobs_detail_data |
Stc Jobs Count Meta Info
| Parameter | Type | Description |
| total_count | Integer | The total count of stc jobs |
| page | Integer | The current page |
| per_page | Integer | The limit to display per page |
| total_pages | Integer | The total pages number |
Stc Jobs 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 |
| 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 | 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" |
| 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 |
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": "2024-08-02T07:25:33.926Z",
"owner_first_name": "HE",
"owner_last_name": "HE",
"installer_first_name": "fer",
"order_reference": "OSW",
"gwtid": "GWT",
"pvd_num": "PVD25",
"spv_job": true,
"trade_mode": "Credit",
"page": 1
}
Response Example
{
"message": "success",
"code": 200,
"response": {
"meta": {
"total_count": 4,
"page": 1,
"per_page": 2,
"total_pages": 2
},
"body": [
{
"gwtid": "GWT101055",
"pvd_num": "PVD2564494",
"trade_mode": "Credit",
"claimed_quantity": 100,
"price": "38.75",
"gst": false,
"status": "Approved",
"payment_status": "Credited",
"submit_date": null,
"paid_date": "2016-11-22",
"credit_memo": "OCMP1571",
"unqualified_reasons": "",
"failed_reasons": "",
"created_via": "Manual",
"note": "",
"received_date": "2016-11-24T15:49:11.000+11:00",
"reference": "OSW5426",
"amount": "3875.0",
"created_at": "2016-11-24T15:49:11.000+11:00",
"finished_at": null,
"finished_location": null,
"rec_quantity": 100,
"po_reference": "",
"order_reference": "OSW5426",
"install_detail": {
"unit_type": "",
"unit_number": null,
"post_code": "6173",
"street_number": "42",
"street_name": "Camargue",
"suburb": "SECRET HARBOUR",
"state": "WA",
"property_type": "Residential",
"latitude": null,
"longitude": null,
"special_address": "",
"story": "Single story",
"nmi": null,
"job_number": null,
"installation_address": "42 Camargue GRN, SECRET HARBOUR WA 6173",
"single_or_multi_story": "Single story",
"same_as_postal": true,
"street_type": "GREEN"
},
"owner_detail": {
"first_name": "Stephen AND Elizabeth",
"last_name": "Gunther",
"phone": "0451107487",
"delivery_type": "",
"delivery_number": "",
"unit_type": "",
"unit_number": null,
"post_code": "6173",
"street_number": "42",
"street_name": "Camargue",
"suburb": "SECRET HARBOUR",
"state": "WA",
"email": null,
"price_to_the_home_owner": null,
"home_owner_abn": null,
"type": "Individual",
"type_name": "Stephen AND Elizabeth Gunther",
"address_type": "Physical",
"address": "42 Camargue GRN, SECRET HARBOUR WA 6173",
"street_type": "GREEN",
"owner_representative_name": null,
"owner_representative_position": null
},
"system_detail": {
"deemed_years": 15,
"installation_date": "2016-11-21",
"type_of_connection": "Connected to an electricity grid without battery storage",
"connected_type": "on-grid",
"is_battery": false,
"system_mounting_type": "Building or structure",
"rated_output": 4.845,
"complete_unit": "YES",
"additional_upgrade_system_details": "",
"install_additional_information": "",
"panel_brand": "GCL System Integration Technology Co. Ltd.",
"panel_model": "GCL-P6/60255",
"number_panels": 19,
"number_inverters": "1",
"watts_per_panel": 255,
"inverter_manufacture": "JIANGSU GOODWE POWER SUPPLY TECHNOLOGY CO.LTD",
"inverter_series": "DNS",
"inverter_model": "GW5000D-NS",
"battery_manufacture": "",
"battery_series": "",
"battery_model": ""
},
"serial_numbers": [
"121605282361382",
"121605273361804",
"121605281361256",
"121605273361779",
"121605261360545",
"121605261360628",
"121605261360592",
"121605261360594",
"121605261360602",
"121605261360603",
"121605282361327",
"121605282360681",
"121605282361355",
"121605282361354",
"121605282361353",
"121605282361351",
"121605242360747",
"121605261360527",
"121605282361358"
],
"serial_numbers_photo": [],
"installer": {
"first_name": "Jefferson",
"last_name": "Gardiner",
"accreditation": "A3561486",
"unit_type": "UNIT",
"unit_number": "9",
"street_number": "2-6",
"street_name": "TULLOCH",
"street_type": "WAY",
"suburb": "CANNING VALE",
"state": "WA",
"address_type": "Physical",
"delivery_type": null,
"delivery_number": null,
"postcode": "6155",
"phone": "0862585333",
"plumber_licenses": null
},
"designer": {
"first_name": "Jefferson",
"last_name": "Gardiner",
"accreditation": "A3561486",
"unit_type": "UNIT",
"unit_number": "9",
"street_number": "2-6",
"street_name": "TULLOCH",
"street_type": "WAY",
"suburb": "CANNING VALE",
"state": "WA",
"address_type": "Physical",
"delivery_type": null,
"delivery_number": null,
"postcode": "6155",
"phone": "0862585333"
},
"electrician": {
"first_name": "Jefferson",
"last_name": "Gardiner",
"license": "EW129746",
"unit_type": "UNIT",
"unit_number": "9",
"street_number": "2-6",
"street_name": "TULLOCH",
"street_type": "WAY",
"phone": "0862585333",
"postcode": "6155",
"suburb": "CANNING VALE",
"state": "WA",
"address_type": "Physical",
"delivery_type": null,
"delivery_number": null
},
"stc_documents": [],
"coc_documents": [],
"other_documents": [],
"noc_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
},
{
"gwtid": "GWT101055",
"pvd_num": "PVD2564459",
"trade_mode": "Credit",
"claimed_quantity": 100,
"price": "38.75",
"gst": false,
"status": "Closed",
"payment_status": "Credited",
"submit_date": null,
"paid_date": null,
"credit_memo": "OCMP1571",
"unqualified_reasons": "",
"failed_reasons": "",
"created_via": "Manual",
"note": "duplicated submission.",
"received_date": "2016-11-24T15:45:48.000+11:00",
"reference": "OSW5426",
"amount": "3875.0",
"created_at": "2016-11-24T15:45:48.000+11:00",
"finished_at": null,
"finished_location": null,
"rec_quantity": 100,
"po_reference": null,
"order_reference": "OSW5426",
"install_detail": {
"unit_type": "",
"unit_number": null,
"post_code": "6173",
"street_number": "42",
"street_name": "Camargue",
"suburb": "SECRET HARBOUR",
"state": "WA",
"property_type": "Residential",
"latitude": null,
"longitude": null,
"special_address": "",
"story": "Single story",
"nmi": null,
"job_number": null,
"installation_address": "42 Camargue GRN, SECRET HARBOUR WA 6173",
"single_or_multi_story": "Single story",
"same_as_postal": true,
"street_type": "GREEN"
},
"owner_detail": {
"first_name": "Stephen AND Elizabeth",
"last_name": "Gunther",
"phone": "0451107487",
"delivery_type": "",
"delivery_number": "",
"unit_type": "",
"unit_number": null,
"post_code": "6173",
"street_number": "42",
"street_name": "Camargue",
"suburb": "SECRET HARBOUR",
"state": "WA",
"email": null,
"price_to_the_home_owner": null,
"home_owner_abn": null,
"type": "Individual",
"type_name": "Stephen AND Elizabeth Gunther",
"address_type": "Physical",
"address": "42 Camargue GRN, SECRET HARBOUR WA 6173",
"street_type": "GREEN",
"owner_representative_name": null,
"owner_representative_position": null
},
"system_detail": {
"deemed_years": 15,
"installation_date": "2016-11-21",
"type_of_connection": "Connected to an electricity grid without battery storage",
"connected_type": "on-grid",
"is_battery": false,
"system_mounting_type": "Building or structure",
"rated_output": 4.845,
"complete_unit": "YES",
"additional_upgrade_system_details": "",
"install_additional_information": "",
"panel_brand": "GCL System Integration Technology Co. Ltd.",
"panel_model": "GCL-P6/60255",
"number_panels": 19,
"number_inverters": "1",
"watts_per_panel": 255,
"inverter_manufacture": "JIANGSU GOODWE POWER SUPPLY TECHNOLOGY CO.LTD",
"inverter_series": "DNS",
"inverter_model": "GW5000D-NS",
"battery_manufacture": "",
"battery_series": "",
"battery_model": ""
},
"serial_numbers": [
"121605282361382",
"121605273361804",
"121605281361256",
"121605273361779",
"121605261360545",
"121605261360628",
"121605261360592",
"121605261360594",
"121605261360602",
"121605261360603",
"121605282361327",
"121605282360681",
"121605282361355",
"121605282361354",
"121605282361353",
"121605282361351",
"121605242360747",
"121605261360527",
"121605282361358"
],
"serial_numbers_photo": [],
"installer": {
"first_name": "Jefferson",
"last_name": "Gardiner",
"accreditation": "A3561486",
"unit_type": "UNIT",
"unit_number": "9",
"street_number": "2-6",
"street_name": "TULLOCH",
"street_type": "WAY",
"suburb": "CANNING VALE",
"state": "WA",
"address_type": "Physical",
"delivery_type": null,
"delivery_number": null,
"postcode": "6155",
"phone": "0862585333",
"plumber_licenses": null
},
"designer": {
"first_name": "Jefferson",
"last_name": "Gardiner",
"accreditation": "A3561486",
"unit_type": "UNIT",
"unit_number": "9",
"street_number": "2-6",
"street_name": "TULLOCH",
"street_type": "WAY",
"suburb": "CANNING VALE",
"state": "WA",
"address_type": "Physical",
"delivery_type": null,
"delivery_number": null,
"postcode": "6155",
"phone": "0862585333"
},
"electrician": {
"first_name": "Jefferson",
"last_name": "Gardiner",
"license": "EW129746",
"unit_type": "UNIT",
"unit_number": "9",
"street_number": "2-6",
"street_name": "TULLOCH",
"street_type": "WAY",
"phone": "0862585333",
"postcode": "6155",
"suburb": "CANNING VALE",
"state": "WA",
"address_type": "Physical",
"delivery_type": null,
"delivery_number": null
},
"stc_documents": [],
"coc_documents": [],
"other_documents": [],
"noc_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
}
]
}
}
