proptech-fixed2

Suspend workitem

PUT /v1/workitems/{id}/suspension

Update workitem owners

PUT /v1/workitems/{id}/owners

Get workitems

GET /v1/workitems

Create workitem

POST /v1/workitems

Get workitem progress

GET /v1/workitems/{id}/progress

Progress workitem

POST /v1/workitems/{id}/progress

Move workitem

POST /v1/workitems/{id}/move

Get workitem

GET /v1/workitems/{id}

Get access

GET /v1/workitems/{id}/access

Get stage workitems v2

GET /v2/stages/{id}/workitems

Get stage workitems

GET /v1/stages/{id}/workitems

PUT /v1/workitems/{id}/suspension

This api requires WORKITEMS_MANAGE permission.

Path variables

id

string required

Request body

application/json

Workitem suspend request

Responses

200 200

OK

Body

*/*

Workitem response

PUT /v1/workitems/{id}/owners

This api requires WORKITEMS_MANAGE permission.

Path variables

id

string required

Request body

application/json

Valid list user organization request

Responses

200 200

OK

Body

*/*

Array of Workitem owner response

GET /v1/workitems

This api requires WORKITEMS_VIEW permission.

Request parameters

search

string optional

visible_only

boolean optional

lead_generator_id

string optional

lead_source_id

string optional

lead_source_user_id

string optional

created_date.min

integer int64 optional

created_date.max

integer int64 optional

job_type_id

string optional

project_id

string optional

campaign_id

string optional

owners

array of string optional

view_id

string optional

stage_id

array of string optional

sort_by

string optional

order_by

string optional

page

Pageable required

Responses

200 200

OK

Body

*/*

Page workitem response

POST /v1/workitems

This api requires WORKITEMS_MANAGE permission.

Request body

application/json

Workitem create request

Responses

200 200

OK

Body

*/*

Workitem create response

GET /v1/workitems/{id}/progress

This api requires WORKITEMS_VIEW permission.

Path variables

id

string required

Responses

200 200

OK

Body

*/*

Array of Workitem progress

POST /v1/workitems/{id}/progress

This api requires WORKITEMS_MANAGE,OPPORTUNITIES_MANAGE, JOBS_MANAGE permission.

Path variables

id

string required

Request body

application/json

Workitem progress request

Responses

200 200

OK

Body

*/*

Workitem create response

POST /v1/workitems/{id}/move

This api requires WORKITEM_MOVE permission.

Path variables

id

string required

Request body

application/json

Workitem move request

Responses

200 200

OK

Body

*/*

Workitem create response

GET /v1/workitems/{id}

This api requires WORKITEMS_VIEW permission.

Path variables

id

string required

Responses

200 200

OK

Body

*/*

Workitem response

GET /v1/workitems/{id}/access

This api requires WORKITEMS_VIEW permission.

Path variables

id

string required

Request parameters

search

string optional

Responses

200 200

OK

Body

*/*

Array of Id name avatar url

GET /v2/stages/{id}/workitems

This api requires WORKITEMS_VIEW permission.

Path variables

id

string required

Request parameters

search

string optional

visible_only

boolean optional

lead_generator_id

string optional

lead_source_id

string optional

lead_source_user_id

string optional

created_date.min

integer int64 optional

created_date.max

integer int64 optional

job_type_id

string optional

project_id

string optional

campaign_id

string optional

owners

array of string optional

view_id

string optional

sort_by

string optional

order_by

string optional

page

Pageable required

Responses

200 200

OK

Body

*/*

Page board workitem v2 response

GET /v1/stages/{id}/workitems

This api requires WORKITEMS_VIEW permission.

Path variables

id

string required

Request parameters

search

string optional

visible_only

boolean optional

lead_generator_id

string optional

lead_source_id

string optional

lead_source_user_id

string optional

created_date.min

integer int64 optional

created_date.max

integer int64 optional

job_type_id

string optional

project_id

string optional

campaign_id

string optional

owners

array of string optional

view_id

string optional

sort_by

string optional

order_by

string optional

page

Pageable required

Responses

200 200

OK

Body

*/*

Page workitem response

Get workflow

GET /v1/workflows/{id}

Update workflow

PUT /v1/workflows/{id}

Delete workflow

DELETE /v1/workflows/{id}

Get workflow stages

GET /v1/workflows/{id}/stages

Create stage

POST /v1/workflows/{id}/stages

Update stage

PUT /v1/workflows/{id}/stages

Update lifecycle

PUT /v1/workflows/{id}/lifecycle

Get workflows

GET /v1/workflows

Create workflow

POST /v1/workflows

Clone workflow

POST /v1/workflows/{id}/clone

GET /v1/workflows/{id}

This api requires WORKFLOWS_VIEW permission.

Path variables

id

string required

Responses

200 200

OK

Body

*/*

Workflow

PUT /v1/workflows/{id}

This api requires WORKFLOWS_MANAGE permission.

Path variables

id

string required

Request body

application/json

Workflow clone

Responses

200 200

OK

Body

*/*

Workflow

DELETE /v1/workflows/{id}

This api requires WORKFLOWS_MANAGE permission.

Path variables

id

string required

Responses

200 200

OK

GET /v1/workflows/{id}/stages

This api requires WORKFLOWS_VIEW permission.

Path variables

id

string required

Request parameters

stage_type

array of string optional

search

string optional

Responses

200 200

OK

Body

*/*

Array of Workflow stage

POST /v1/workflows/{id}/stages

This api requires WORKFLOWS_MANAGE permission.

Path variables

id

string required

Request body

application/json

Stage request

Responses

200 200

OK

Body

*/*

Workflow stage

PUT /v1/workflows/{id}/stages

This api requires WORKFLOWS_MANAGE permission.

Path variables

id

string required

Request body

application/json

Workflow stage update

Responses

200 200

OK

Body

*/*

Workflow stage update

PUT /v1/workflows/{id}/lifecycle

This api requires WORKFLOWS_MANAGE permission.

Path variables

id

string required

Request body

application/json

Workflow lifecycle request

Responses

200 200

OK

Body

*/*

Workflow

GET /v1/workflows

This api requires WORKFLOWS_VIEW permission.

Request parameters

project_id

string optional

job_type_id

array of string optional

search

string optional

templates

boolean optional

engagement_type

string optional

Enumeration:

OPPORTUNITY

JOB

LEAD

is_default

boolean optional

lifecycle

string optional

Enumeration:

ACTIVE

INACTIVE

Responses

200 200

OK

Body

*/*

Array of Workflow response

POST /v1/workflows

This api requires WORKFLOWS_MANAGE permission.

Request body

application/json

Workflow clone

Responses

200 200

OK

Body

*/*

Workflow

POST /v1/workflows/{id}/clone

This api requires WORKFLOWS_MANAGE permission.

Path variables

id

string required

Request body

application/json

Workflow clone

Responses

200 200

OK

Body

*/*

Workflow

Update board order

PUT /v1/users/{id}/boards/order

Get boards

GET /v1/users/{id}/boards

PUT /v1/users/{id}/boards/order

This api requires BOARDS_VIEW, BOARDS_MANAGE permission.

Path variables

id

string required

Request body

application/json

Array of Board order request

Responses

200 200

OK

GET /v1/users/{id}/boards

This api requires BOARDS_VIEW, BOARDS_MANAGE permission.

Path variables

id

string required

Request parameters

board_type

string optional

Enumeration:

OPPORTUNITY

JOB

LEAD

Responses

200 200

OK

Body

*/*

Array of Board summary

Get task

GET /v1/tasks/{id}

Update task

PUT /v1/tasks/{id}

Delete task

DELETE /v1/tasks/{id}

Get event tasks

GET /v1/tasks

Create task

POST /v1/tasks

Delete tasks

DELETE /v1/tasks

Progress task

POST /v1/tasks/{id}/progress

Get subtasks

GET /v1/tasks/{id}/tasks

Get evidence

GET /v1/tasks/{id}/evidence

GET /v1/tasks/{id}

This api requires LEAD_TASKS_VIEW,JOB_TASKS_VIEW,OPPORTUNITY_TASKS_VIEW,LEAD_TASKS_VIEW_OWN,JOB_TASKS_VIEW_OWN,OPPORTUNITY_TASKS_VIEW_OWN,TASKS_VIEW_OWN,TASKS_VIEW permission.

Path variables

id

string required

Responses

200 200

OK

Body

*/*

Event task response

PUT /v1/tasks/{id}

This api requires LEAD_TASKS_MANAGE,JOB_TASKS_MANAGE,OPPORTUNITY_TASKS_MANAGE,TASKS_MANAGE_OWN,TASKS_MANAGE permission.

Path variables

id

string required

Request body

application/json

Update task request

Responses

200 200

OK

Body

*/*

Event task response

DELETE /v1/tasks/{id}

This api requires LEAD_TASKS_MANAGE,JOB_TASKS_MANAGE,OPPORTUNITY_TASKS_MANAGE,TASKS_MANAGE_OWN,TASKS_MANAGE permission.

Path variables

id

string required

Responses

200 200

OK

GET /v1/tasks

This api requires LEAD_TASKS_VIEW,JOB_TASKS_VIEW,OPPORTUNITY_TASKS_VIEW,LEAD_TASKS_VIEW_OWN,JOB_TASKS_VIEW_OWN,OPPORTUNITY_TASKS_VIEW_OWN,TASKS_VIEW_OWN,TASKS_VIEW permission.

Request parameters

service_id

string optional

engagement_id

string optional

activity_id

string optional

search

string optional

status

array of string optional

type

array of string optional

assignee_id

array of string optional

team_id

array of string optional

priority

array of string optional

due_date.min

string date-time optional

due_date.max

string date-time optional

sort_by

array of string optional

pageable

Pageable required

Responses

200 200

OK

Body

*/*

Page event task response

POST /v1/tasks

This api requires LEAD_TASKS_MANAGE,JOB_TASKS_MANAGE,OPPORTUNITY_TASKS_MANAGE,TASKS_MANAGE_OWN,TASKS_MANAGE permission.

Request body

application/json

Create task request

Responses

200 200

OK

Body

*/*

Event task response

DELETE /v1/tasks

This api requires LEAD_TASKS_MANAGE,JOB_TASKS_MANAGE,OPPORTUNITY_TASKS_MANAGE,TASKS_MANAGE_OWN,TASKS_MANAGE permission.

Request body

application/json

Array of Delete task request

Responses

200 200

OK

POST /v1/tasks/{id}/progress

This api requires LEAD_TASKS_MANAGE,JOB_TASKS_MANAGE,OPPORTUNITY_TASKS_MANAGE,TASKS_MANAGE_OWN,TASKS_MANAGE permission.

Path variables

id

string required

Request body

application/json

Progress task request

Responses

200 200

OK

Body

*/*

Event task response

GET /v1/tasks/{id}/tasks

This api requires LEAD_TASKS_VIEW,JOB_TASKS_VIEW,OPPORTUNITY_TASKS_VIEW,LEAD_TASKS_VIEW_OWN,JOB_TASKS_VIEW_OWN,OPPORTUNITY_TASKS_VIEW_OWN,TASKS_VIEW_OWN,TASKS_VIEW permission.

Path variables

id

string required

Responses

200 200

OK

Body

*/*

Array of Event task response

GET /v1/tasks/{id}/evidence

This api requires LEAD_TASKS_VIEW,JOB_TASKS_VIEW,OPPORTUNITY_TASKS_VIEW,LEAD_TASKS_VIEW_OWN,JOB_TASKS_VIEW_OWN,OPPORTUNITY_TASKS_VIEW_OWN,TASKS_VIEW_OWN,TASKS_VIEW permission.

Path variables

id

string required

Responses

200 200

OK

Body

*/*

Array of Task evidence

Get financial design

GET /v1/solar_designs/{sid}/financials/{fid}

Update financial design

PUT /v1/solar_designs/{sid}/financials/{fid}

Delete financial design

DELETE /v1/solar_designs/{sid}/financials/{fid}

Get financial designs

GET /v1/solar_designs/{sid}/financials

Create financial design

POST /v1/solar_designs/{sid}/financials

GET /v1/solar_designs/{sid}/financials/{fid}

This api requires LEAD_DESIGNS_VIEW,JOB_DESIGNS_VIEW,OPPORTUNITY_DESIGNS_VIEW permission.

Path variables

sid

string required

fid

string required

Responses

200 200

OK

Body

*/*

Financial design response

PUT /v1/solar_designs/{sid}/financials/{fid}

This api requires LEAD_DESIGNS_MANAGE,JOB_DESIGNS_MANAGE,OPPORTUNITY_DESIGNS_MANAGE permission.

Path variables

sid

string required

fid

string required

Request body

application/json

Financial design request

Responses

200 200

OK

Body

*/*

Financial design response

DELETE /v1/solar_designs/{sid}/financials/{fid}

This api requires LEAD_DESIGNS_MANAGE,JOB_DESIGNS_MANAGE,OPPORTUNITY_DESIGNS_MANAGE permission.

Path variables

sid

string required

fid

string required

Responses

200 200

OK

GET /v1/solar_designs/{sid}/financials

This api requires LEAD_DESIGNS_VIEW,JOB_DESIGNS_VIEW,OPPORTUNITY_DESIGNS_VIEW permission.

Path variables

sid

string required

Responses

200 200

OK

Body

*/*

Array of Financial design summary

POST /v1/solar_designs/{sid}/financials

This api requires LEAD_DESIGNS_MANAGE,JOB_DESIGNS_MANAGE,OPPORTUNITY_DESIGNS_MANAGE permission.

Path variables

sid

string required

Request body

application/json

Financial design request

Responses

200 200

OK

Body

*/*

Financial design response

Update roof

PUT /v1/solar_designs/{propertyId}/roofs/{roofId}

Delete roof

DELETE /v1/solar_designs/{propertyId}/roofs/{roofId}

Get roof panels

GET /v1/solar_designs/{propertyId}/roofs/{roofId}/panels

Add roof panels

POST /v1/solar_designs/{propertyId}/roofs/{roofId}/panels

Update roof panels

PUT /v1/solar_designs/{propertyId}/roofs/{roofId}/panels

Get roof exclusions

GET /v1/solar_designs/{propertyId}/roofs/{roofId}/exclusions

Update roof exclusions

PUT /v1/solar_designs/{propertyId}/roofs/{roofId}/exclusions

Get roofs

GET /v1/solar_designs/{propertyId}/roofs

Import roofs

POST /v1/solar_designs/{propertyId}/roofs

Import roofs_1

POST /v1/solar_designs/{propertyId}/roofs/import

Get roof panels geo json

GET /v1/solar_designs/{propertyId}/roofs/{roofId}/panels/geojson

Get roof elevation tiff

GET /v1/solar_designs/{propertyId}/roofs/{roofId}/elevations

PUT /v1/solar_designs/{propertyId}/roofs/{roofId}

This api requires LEAD_DESIGNS_MANAGE,JOB_DESIGNS_MANAGE,OPPORTUNITY_DESIGNS_MANAGE permission.

Path variables

propertyId

string required

roofId

string required

Request body

application/json

Property roof request

Responses

200 200

OK

Body

*/*

Roof segment response

DELETE /v1/solar_designs/{propertyId}/roofs/{roofId}

This api requires LEAD_DESIGNS_MANAGE,JOB_DESIGNS_MANAGE,OPPORTUNITY_DESIGNS_MANAGE permission.

Path variables

propertyId

string required

roofId

string required

Responses

200 200

OK

GET /v1/solar_designs/{propertyId}/roofs/{roofId}/panels

This api requires LEAD_DESIGNS_VIEW,JOB_DESIGNS_VIEW,OPPORTUNITY_DESIGNS_VIEW permission.

Path variables

propertyId

string required

roofId

string required

Request parameters

source

string optional

Enumeration:

MANUAL

IMPORTED

Responses

200 200

OK

Body

*/*

Array of Panel response

POST /v1/solar_designs/{propertyId}/roofs/{roofId}/panels

This api requires LEAD_DESIGNS_MANAGE,JOB_DESIGNS_MANAGE,OPPORTUNITY_DESIGNS_MANAGE permission.

Path variables

propertyId

string required

roofId

string required

Request parameters

source

string optional

Enumeration:

MANUAL

IMPORTED

Request body

application/json

Array of Panel request

Responses

200 200

OK

Body

*/*

Array of Panel response

PUT /v1/solar_designs/{propertyId}/roofs/{roofId}/panels

This api requires LEAD_DESIGNS_MANAGE,JOB_DESIGNS_MANAGE,OPPORTUNITY_DESIGNS_MANAGE permission.

Path variables

propertyId

string required

roofId

string required

Request parameters

source

string optional

Enumeration:

MANUAL

IMPORTED

Request body

application/json

Array of Panel request

Responses

200 200

OK

Body

*/*

Array of Panel response

GET /v1/solar_designs/{propertyId}/roofs/{roofId}/exclusions

This api requires LEAD_DESIGNS_VIEW,JOB_DESIGNS_VIEW,OPPORTUNITY_DESIGNS_VIEW permission.

Path variables

propertyId

string required

roofId

string required

Responses

200 200

OK

Body

*/*

Array of Roof exclusion response

PUT /v1/solar_designs/{propertyId}/roofs/{roofId}/exclusions

This api requires LEAD_DESIGNS_MANAGE,JOB_DESIGNS_MANAGE,OPPORTUNITY_DESIGNS_MANAGE permission.

Path variables

propertyId

string required

roofId

string required

Request body

application/json

Array of Roof exclusion request

Responses

200 200

OK

Body

*/*

Array of Roof exclusion response

GET /v1/solar_designs/{propertyId}/roofs

This api requires LEAD_DESIGNS_VIEW,JOB_DESIGNS_VIEW,OPPORTUNITY_DESIGNS_VIEW permission.

Path variables

propertyId

string required

Responses

200 200

OK

Body

*/*

Array of Property roof response

POST /v1/solar_designs/{propertyId}/roofs

This api requires LEAD_DESIGNS_MANAGE,JOB_DESIGNS_MANAGE,OPPORTUNITY_DESIGNS_MANAGE permission.

Path variables

propertyId

string required

Request body

application/json

Roof creation request

Responses

200 200

OK

Body

*/*

Property roof response

POST /v1/solar_designs/{propertyId}/roofs/import

This api requires LEAD_DESIGNS_MANAGE,JOB_DESIGNS_MANAGE,OPPORTUNITY_DESIGNS_MANAGE permission.

Path variables

propertyId

string required

Request body

application/json

Roof import request

Responses

200 200

OK

Body

*/*

Property roof response

GET /v1/solar_designs/{propertyId}/roofs/{roofId}/panels/geojson

This api requires LEAD_DESIGNS_VIEW,JOB_DESIGNS_VIEW,OPPORTUNITY_DESIGNS_VIEW permission.

Path variables

propertyId

string required

roofId

string required

Responses

200 200

OK

Body

*/*

Panel geo json response

GET /v1/solar_designs/{propertyId}/roofs/{roofId}/elevations

This api requires LEAD_DESIGNS_VIEW,JOB_DESIGNS_VIEW,OPPORTUNITY_DESIGNS_VIEW permission.

Path variables

propertyId

string required

roofId

string required

Responses

200 200

OK

Body

image/tiff

string byte

Update3d roofs

PUT /v1/solar_designs/{id}/3d/roofs/{roofId}

Delete3d roofs

DELETE /v1/solar_designs/{id}/3d/roofs/{roofId}

Get3d roofs

GET /v1/solar_designs/{id}/3d/roofs

Add3d roofs

POST /v1/solar_designs/{id}/3d/roofs

PUT /v1/solar_designs/{id}/3d/roofs/{roofId}

This api requires LEAD_DESIGNS_MANAGE,JOB_DESIGNS_MANAGE,OPPORTUNITY_DESIGNS_MANAGE permission.

Path variables

id

string required

roofId

string required

Request body

application/json

Roof3d request

Responses

200 200

OK

Body

*/*

Roof3d response

DELETE /v1/solar_designs/{id}/3d/roofs/{roofId}

This api requires LEAD_DESIGNS_MANAGE,JOB_DESIGNS_MANAGE,OPPORTUNITY_DESIGNS_MANAGE permission.

Path variables

id

string required

roofId

string required

Responses

200 200

OK

GET /v1/solar_designs/{id}/3d/roofs

This api requires LEAD_DESIGNS_VIEW,JOB_DESIGNS_VIEW,OPPORTUNITY_DESIGNS_VIEW permission.

Path variables

id

string required

Responses

200 200

OK

Body

*/*

Array of Roof3d response

POST /v1/solar_designs/{id}/3d/roofs

This api requires LEAD_DESIGNS_MANAGE,JOB_DESIGNS_MANAGE,OPPORTUNITY_DESIGNS_MANAGE permission.

Path variables

id

string required

Request body

application/json

Roof3d request

Responses

200 200

OK

Body

*/*

Roof3d response

Get losses

GET /v1/solar_designs/{designId}/roofs/{roofId}/losses

Update losses

PUT /v1/solar_designs/{designId}/roofs/{roofId}/losses

GET /v1/solar_designs/{designId}/roofs/{roofId}/losses

This api requires LEAD_DESIGNS_VIEW,JOB_DESIGNS_VIEW,OPPORTUNITY_DESIGNS_VIEW permission.

Path variables

designId

string required

roofId

string required

Responses

200 200

OK

Body

*/*

Loss request

PUT /v1/solar_designs/{designId}/roofs/{roofId}/losses

This api requires LEAD_DESIGNS_MANAGE,JOB_DESIGNS_MANAGE,OPPORTUNITY_DESIGNS_MANAGE permission.

Path variables

designId

string required

roofId

string required

Request body

application/json

Loss request

Responses

200 200

OK

Body

*/*

Loss request

Get obstacles

GET /v1/solar_designs/{designId}/obstacles

Update obstacle

PUT /v1/solar_designs/{designId}/obstacles

GET /v1/solar_designs/{designId}/obstacles

This api requires LEAD_DESIGNS_VIEW,JOB_DESIGNS_VIEW,OPPORTUNITY_DESIGNS_VIEW permission.

Path variables

designId

string required

Request parameters

roof_id

string optional

max_distance

number double optional

Responses

200 200

OK

Body

*/*

Array of Obstacle response

PUT /v1/solar_designs/{designId}/obstacles

This api requires LEAD_DESIGNS_MANAGE,JOB_DESIGNS_MANAGE,OPPORTUNITY_DESIGNS_MANAGE permission.

Path variables

designId

string required

Request body

application/json

Array of Obstacle request

Responses

200 200

OK

Body

*/*

Array of Obstacle response

Update site inventory

PUT /v1/sites/{id}/inventory/{inventoryId}

Delete site inventory

DELETE /v1/sites/{id}/inventory/{inventoryId}

Get site inventory list

GET /v1/sites/{id}/inventory

Add site inventory

POST /v1/sites/{id}/inventory

Get site inventory

GET /v1/sites/inventory

PUT /v1/sites/{id}/inventory/{inventoryId}

This api requires INVENTORY_MANAGE permission.

Path variables

id

string required

inventoryId

string required

Request body

application/json

Site inventory request

Responses

200 200

OK

Body

*/*

Site inventory response

DELETE /v1/sites/{id}/inventory/{inventoryId}

This api requires INVENTORY_MANAGE permission.

Path variables

id

string required

inventoryId

string required

Responses

200 200

OK

GET /v1/sites/{id}/inventory

This api requires INVENTORY_VIEW permission.

Path variables

id

string required

Responses

200 200

OK

Body

*/*

Array of Site inventory response

POST /v1/sites/{id}/inventory

This api requires INVENTORY_MANAGE permission.

Path variables

id

string required

Request body

application/json

Site inventory request

Responses

200 200

OK

Body

*/*

Site inventory response

GET /v1/sites/inventory

This api requires INVENTORY_VIEW permission.

Responses

200 200

OK

Body

*/*

Object

integer int64

Get energy cost

GET /v1/properties/{pid}/energy_costs/{type}

Update energy cost

PUT /v1/properties/{pid}/energy_costs/{type}

Delete energy cost

DELETE /v1/properties/{pid}/energy_costs/{type}

GET /v1/properties/{pid}/energy_costs/{type}

This api requires PROPERTIES_VIEW,PROPERTIES_VIEW_OWN permission.

Path variables

pid

string required

type

string required

Enumeration:

ELECTRICITY

GAS

Responses

200 200

OK

Body

*/*

Energy cost

PUT /v1/properties/{pid}/energy_costs/{type}

This api requires PROPERTIES_MANAGE permission.

Path variables

pid

string required

type

string required

Enumeration:

ELECTRICITY

GAS

Request body

application/json

Energy cost

Responses

200 200

OK

Body

*/*

Energy cost

DELETE /v1/properties/{pid}/energy_costs/{type}

This api requires PROPERTIES_MANAGE permission.

Path variables

pid

string required

type

string required

Enumeration:

ELECTRICITY

GAS

Responses

200 200

OK

Get property

GET /v1/properties/{id}

Update property

PUT /v1/properties/{id}

Delete property

DELETE /v1/properties/{id}

Update property details

PUT /v1/properties/{id}/details

Get properties

GET /v1/properties

Add property

POST /v1/properties

Get property epcs

GET /v1/properties/{id}/epcs

Get property engagements

GET /v1/properties/{id}/engagements

GET /v1/properties/{id}

This api requires PROPERTIES_VIEW,PROPERTIES_VIEW_OWN permission.

Path variables

id

string required

Responses

200 200

OK

Body

*/*

Property details response

PUT /v1/properties/{id}

This api requires PROPERTIES_MANAGE permission.

Path variables

id

string required

Request body

application/json

Property update request

Responses

200 200

OK

Body

*/*

Property details response

DELETE /v1/properties/{id}

This api requires PROPERTIES_DELETE permission.

Path variables

id

string required

Responses

200 200

OK

PUT /v1/properties/{id}/details

This api requires PROPERTIES_MANAGE permission.

Path variables

id

string required

Request body

application/json

Property details request

Responses

200 200

OK

Body

*/*

Property details response

GET /v1/properties

This api requires PROPERTIES_VIEW,PROPERTIES_VIEW_OWN permission.

Request parameters

search

string optional

property_class

string optional

Enumeration:

COMMERCIAL

RESIDENTIAL

BLOCK

LAND

created_by

string optional

created_on.min

integer int64 optional

created_on.max

integer int64 optional

contact_id

string optional

sort_by

string optional

order_by

string optional

pageable

Pageable required

Responses

200 200

OK

Body

*/*

Page property response

POST /v1/properties

This api requires PROPERTIES_MANAGE permission.

Request body

application/json

Property request

Responses

200 200

OK

Body

*/*

Property details response

GET /v1/properties/{id}/epcs

This api requires PROPERTIES_VIEW,PROPERTIES_VIEW_OWN permission.

Path variables

id

string required

Responses

200 200

OK

Body

*/*

Array of Property epc response

GET /v1/properties/{id}/engagements

This api requires PROPERTY_ENGAGEMENTS_VIEW,PROPERTIES_VIEW_OWN permission.

Path variables

id

string required

Request parameters

search

string optional

engagement_type

string optional

Enumeration:

OPPORTUNITY

JOB

LEAD

pageable

Pageable required

Responses

200 200

OK

Body

*/*

Page engagement full

Update property meters

PUT /v1/properties/{id}/meters/{meterId}

Delete property meters

DELETE /v1/properties/{id}/meters/{meterId}

Get property meters

GET /v1/properties/{id}/meters

Add property meters

POST /v1/properties/{id}/meters

PUT /v1/properties/{id}/meters/{meterId}

This api requires PROPERTIES_MANAGE permission.

Path variables

id

string required

meterId

string required

Request body

application/json

Property meter update request

Responses

200 200

OK

Body

*/*

Property meter response

DELETE /v1/properties/{id}/meters/{meterId}

This api requires PROPERTIES_MANAGE permission.

Path variables

id

string required

meterId

string required

Responses

200 200

OK

GET /v1/properties/{id}/meters

This api requires PROPERTIES_MANAGE permission.

Path variables

id

string required

Responses

200 200

OK

Body

*/*

Array of Property meter response

POST /v1/properties/{id}/meters

This api requires PROPERTIES_MANAGE permission.

Path variables

id

string required

Request body

application/json

Property meter request

Responses

200 200

OK

Body

*/*

Property meter response

Update image

PUT /v1/properties/{id}/images/{imageId}

Delete image

DELETE /v1/properties/{id}/images/{imageId}

Get property images

GET /v1/properties/{id}/images

Add image

POST /v1/properties/{id}/images

PUT /v1/properties/{id}/images/{imageId}

null

Path variables

id

string required

imageId

string required

Request body

application/json

Property image request

Responses

200 200

OK

Body

*/*

Property image response

DELETE /v1/properties/{id}/images/{imageId}

null

Path variables

id

string required

imageId

string required

Responses

200 200

OK

GET /v1/properties/{id}/images

null

Path variables

id

string required

Responses

200 200

OK

Body

*/*

Array of Property image response

POST /v1/properties/{id}/images

null

Path variables

id

string required

Request body

application/json

Property image request

Responses

200 200

OK

Body

*/*

Property image response

Update property contact

PUT /v1/properties/{id}/contacts/{contactId}

Get property contacts

GET /v1/properties/{id}/contacts

Create property contact

POST /v1/properties/{id}/contacts

PUT /v1/properties/{id}/contacts/{contactId}

This api requires PROPERTY_CONTACTS_MANAGE permission.

Path variables

id

string required

contactId

string required

Request body

application/json

Property contact update

Responses

200 200

OK

Body

*/*

Property contact response

GET /v1/properties/{id}/contacts

This api requires PROPERTY_CONTACTS_VIEW,PROPERTIES_VIEW_OWN permission.

Path variables

id

string required

Request parameters

search

string optional

Responses

200 200

OK

Body

*/*

Array of Property contact response

POST /v1/properties/{id}/contacts

This api requires PROPERTY_CONTACTS_MANAGE permission.

Path variables

id

string required

Request body

application/json

Valid list property contact request

Responses

200 200

OK

Body

*/*

Array of Property contact response

Get project

GET /v1/projects/{id}

Update project

PUT /v1/projects/{id}

Delete project

DELETE /v1/projects/{id}

Get projects

GET /v1/projects

Create project

POST /v1/projects

GET /v1/projects/{id}

This api requires PROJECTS_VIEW permission.

Path variables

id

string required

Responses

200 200

OK

Body

*/*

Project response

PUT /v1/projects/{id}

This api requires PROJECTS_MANAGE permission.

Path variables

id

string required

Request body

application/json

Project request

Responses

200 200

OK

Body

*/*

Project response

DELETE /v1/projects/{id}

This api requires PROJECTS_MANAGE permission.

Path variables

id

string required

Responses

200 200

OK

GET /v1/projects

This api requires PROJECTS_VIEW permission.

Request parameters

search

string optional

owner_id

string optional

Responses

200 200

OK

Body

*/*

Array of Project response

POST /v1/projects

This api requires PROJECTS_MANAGE permission.

Request body

application/json

Project request

Responses

200 200

OK

Body

*/*

Project response

Update preference

PUT /v1/product_preferences/{id}

Delete preference

DELETE /v1/product_preferences/{id}

Get preferences

GET /v1/product_preferences

Create preference

POST /v1/product_preferences

PUT /v1/product_preferences/{id}

This api requires PRODUCT_PREFERENCES_MANAGE permission.

Path variables

id

string required

Request body

application/json

Product preferences request

Responses

200 200

OK

Body

*/*

Product preferences response

DELETE /v1/product_preferences/{id}

This api requires PRODUCT_PREFERENCES_MANAGE permission.

Path variables

id

string required

Responses

200 200

OK

GET /v1/product_preferences

This api requires PRODUCT_PREFERENCES_VIEW,PRODUCTS_VIEW permission.

Request parameters

job_type_id

array of string optional

preference_type

string optional

Enumeration:

DESIGN

QUOTE

project_id

string optional

Responses

200 200

OK

Body

*/*

Array of Product preferences response

POST /v1/product_preferences

This api requires PRODUCT_PREFERENCES_MANAGE permission.

Request body

application/json

Product preferences request

Responses

200 200

OK

Body

*/*

Product preferences response

Get partner description

GET /v1/partners/{id}/descriptions

Update partner description

PUT /v1/partners/{id}/descriptions

GET /v1/partners/{id}/descriptions

null

Path variables

id

string required

Responses

200 200

OK

Body

*/*

Partner description response

PUT /v1/partners/{id}/descriptions

null

Path variables

id

string required

Request body

application/json

Partner description request

Responses

200 200

OK

Body

*/*

Partner description response

Get opportunity

GET /v1/opportunities/{id}

Update opportunity

PUT /v1/opportunities/{id}

Delete opportunity

DELETE /v1/opportunities/{id}

Add opportunity job type

POST /v1/opportunities/{id}/job_types/{jobTypeId}

Update opportunity job type

PUT /v1/opportunities/{id}/job_types/{jobTypeId}

Delete opportunity job type

DELETE /v1/opportunities/{id}/job_types/{jobTypeId}

Add opportunity

POST /v1/opportunities

Get opportunity jobs

GET /v1/opportunities/{id}/jobs

GET /v1/opportunities/{id}

This api requires OPPORTUNITIES_VIEW,OPPORTUNITIES_VIEW_OWN permission.

Path variables

id

string required

Responses

200 200

OK

Body

*/*

Opportunity details

PUT /v1/opportunities/{id}

This api requires OPPORTUNITIES_MANAGE permission.

Path variables

id

string required

Request body

application/json

Opportunity update request

Responses

200 200

OK

Body

*/*

Opportunity details

DELETE /v1/opportunities/{id}

This api requires OPPORTUNITIES_DELETE permission.

Path variables

id

string required

Responses

200 200

OK

POST /v1/opportunities/{id}/job_types/{jobTypeId}

This api requires OPPORTUNITIES_MANAGE permission.

Path variables

id

string required

jobTypeId

string required

Responses

200 200

OK

Body

*/*

Opportunity details

PUT /v1/opportunities/{id}/job_types/{jobTypeId}

This api requires OPPORTUNITIES_MANAGE permission.

Path variables

id

string required

jobTypeId

string required

Request body

application/json

Opportunity job type request

Responses

200 200

OK

Body

*/*

Opportunity job type response

DELETE /v1/opportunities/{id}/job_types/{jobTypeId}

This api requires OPPORTUNITIES_MANAGE permission.

Path variables

id

string required

jobTypeId

string required

Responses

200 200

OK

POST /v1/opportunities

This api requires OPPORTUNITIES_MANAGE permission.

Request body

application/json

Opportunity request

Responses

200 200

OK

Body

*/*

Opportunity details

GET /v1/opportunities/{id}/jobs

This api requires OPPORTUNITIES_VIEW,OPPORTUNITIES_VIEW_OWN permission.

Path variables

id

string required

Responses

200 200

OK

Body

*/*

Array of Opportunity job details

Update engagement note

PUT /v1/notes/{id}

Delete engagement note

DELETE /v1/notes/{id}

Get engagement notes

GET /v1/engagements/{engagementId}/notes

Save engagement note

POST /v1/engagements/{engagementId}/notes

PUT /v1/notes/{id}

This api requires LEAD_NOTES_MANAGE,JOB_NOTES_MANAGE,OPPORTUNITY_NOTES_MANAGE, ACTIVITY_NOTES_MANAGE, TASK_NOTES_MANAGE permission.

Path variables

id

string required

Request body

application/json

Engagement note update

Responses

200 200

OK

Body

*/*

Engagement note response

DELETE /v1/notes/{id}

This api requires LEAD_NOTES_MANAGE,JOB_NOTES_MANAGE,OPPORTUNITY_NOTES_MANAGE, ACTIVITY_NOTES_MANAGE, TASK_NOTES_MANAGE permission.

Path variables

id

string required

Responses

200 200

OK

GET /v1/engagements/{engagementId}/notes

This api requires LEAD_NOTES_VIEW,JOB_NOTES_VIEW,OPPORTUNITY_NOTES_VIEW, ACTIVITY_NOTES_VIEW, TASK_NOTES_VIEW permission.

Path variables

engagementId

string required

Request parameters

search

string optional

note_type

string optional

Enumeration:

ENGAGEMENT

TASK

ACTIVITY

created_by

string optional

activity_id

string optional

task_id

string optional

pageable

Pageable required

Responses

200 200

OK

Body

*/*

Page engagement note response

POST /v1/engagements/{engagementId}/notes

This api requires LEAD_NOTES_MANAGE,JOB_NOTES_MANAGE,OPPORTUNITY_NOTES_MANAGE,ACTIVITY_NOTES_MANAGE, TASK_NOTES_MANAGE permission.

Path variables

engagementId

string required

Request body

application/json

Engagement note request

Responses

200 200

OK

Body

*/*

Engagement note response

Update list view

PUT /v1/list_views/{id}

Delete list view

DELETE /v1/list_views/{id}

Get list views

GET /v1/list_views

Add list view

POST /v1/list_views

PUT /v1/list_views/{id}

This api requires LISTVIEW_MANAGE,LISTVIEW_MANAGE_OWN,LISTVIEW_MANAGE_TEAM permission.

Path variables

id

string required

Request body

application/json

List view request

Responses

200 200

OK

Body

*/*

List view response

DELETE /v1/list_views/{id}

This api requires LISTVIEW_MANAGE,LISTVIEW_MANAGE_OWN,LISTVIEW_MANAGE_TEAM permission.

Path variables

id

string required

Responses

200 200

OK

GET /v1/list_views

This api requires LISTVIEW_VIEW,LISTVIEW_VIEW_OWN,LISTVIEW_VIEW_TEAM permission.

Request parameters

entity_type

string optional

Enumeration:

WORKITEMS

LEADS

OPPORTUNITIES

JOBS

PROPERTIES

view_type

string optional

Enumeration:

KANBAN

LIST

board_id

string optional

Responses

200 200

OK

Body

*/*

Array of List view response

POST /v1/list_views

This api requires LISTVIEW_MANAGE,LISTVIEW_MANAGE_OWN,LISTVIEW_MANAGE_TEAM permission.

Request body

application/json

List view request

Responses

200 200

OK

Body

*/*

List view response

Get lifecycles

GET /v1/lifecycle_groups/{id}/lifecycles

Add lifecycles

POST /v1/lifecycle_groups/{id}/lifecycles

Update lifecycles

PUT /v1/lifecycle_groups/{id}/lifecycles

Get lifecycle groups

GET /v1/lifecycle_groups

Add lifecycle group

POST /v1/lifecycle_groups

Get lifecycle group

GET /v1/lifecycle_groups/{id}

Delete lifecycle group

DELETE /v1/lifecycle_groups/{id}

GET /v1/lifecycle_groups/{id}/lifecycles

This api requires LIFECYCLE_GROUPS_VIEW permission.

Path variables

id

string required

Responses

200 200

OK

Body

*/*

Array of Lifecycle response

POST /v1/lifecycle_groups/{id}/lifecycles

This api requires LIFECYCLE_GROUPS_MANAGE permission.

Path variables

id

string required

Request body

application/json

Lifecycle request

Responses

200 200

OK

Body

*/*

Lifecycle response

PUT /v1/lifecycle_groups/{id}/lifecycles

This api requires LIFECYCLE_GROUPS_MANAGE permission.

Path variables

id

string required

Request body

application/json

Array of Update lifecycle request

Responses

200 200

OK

Body

*/*

Array of Lifecycle response

GET /v1/lifecycle_groups

This api requires LIFECYCLE_GROUPS_VIEW permission.

Request parameters

search

string optional

lifecycle_type

string optional

Enumeration:

LEAD

JOB

OPPORTUNITY

owner_id

string optional

Responses

200 200

OK

Body

*/*

Array of Lifecycle group response

POST /v1/lifecycle_groups

This api requires LIFECYCLE_GROUPS_MANAGE permission.

Request body

application/json

Lifecycle group request

Responses

200 200

OK

Body

*/*

Lifecycle group response

GET /v1/lifecycle_groups/{id}

This api requires LIFECYCLE_GROUPS_VIEW permission.

Path variables

id

string required

Request parameters

owner_id

string optional

Responses

200 200

OK

Body

*/*

Lifecycle group response

DELETE /v1/lifecycle_groups/{id}

This api requires LIFECYCLE_GROUPS_MANAGE permission.

Path variables

id

string required

Responses

200 200

OK

Get lead

GET /v1/leads/{id}

Update lead

PUT /v1/leads/{id}

Delete lead

DELETE /v1/leads/{id}

Update lead property

PUT /v1/leads/{id}/properties

Update lead lifecycle

PUT /v1/leads/{id}/lifecycles/{lifecycleId}

Get leads

GET /v1/leads

Add lead

POST /v1/leads

Get children opportunities

GET /v1/leads/{id}/opportunities

GET /v1/leads/{id}

This api requires LEADS_VIEW,LEADS_VIEW_OWN permission.

Path variables

id

string required

Responses

200 200

OK

Body

*/*

Lead response

PUT /v1/leads/{id}

This api requires LEADS_MANAGE permission.

Path variables

id

string required

Request body

application/json

Update lead request

Responses

200 200

OK

Body

*/*

Lead response

DELETE /v1/leads/{id}

This api requires LEADS_DELETE permission.

Path variables

id

string required

Responses

200 200

OK

PUT /v1/leads/{id}/properties

This api requires LEADS_MANAGE permission.

Path variables

id

string required

Request body

application/json

Property

Responses

200 200

OK

Body

*/*

Lead response

PUT /v1/leads/{id}/lifecycles/{lifecycleId}

This api requires LEADS_MANAGE permission.

Path variables

id

string required

lifecycleId

string required

Responses

200 200

OK

Body

*/*

Lead response

GET /v1/leads

This api requires LEADS_VIEW,LEADS_VIEW_OWN permission.

Request parameters

search

string optional

lifecycle_id

string optional

job_type_id

array of string optional

lead_owner_id

string optional

lead_source_id

string optional

lead_source_user_id

string optional

project_id

string optional

campaign_id

string optional

sort_by

string optional

order_by

string optional

pageable

Pageable required

Responses

200 200

OK

Body

*/*

Page lead summary

POST /v1/leads

This api requires LEADS_MANAGE permission.

Request body

application/json

Lead request

Responses

200 200

OK

Body

*/*

Lead response

GET /v1/leads/{id}/opportunities

This api requires LEADS_VIEW,LEADS_VIEW_OWN permission.

Path variables

id

string required

Responses

200 200

OK

Body

*/*

Array of Opportunity details

Get job

GET /v1/jobs/{id}

Update job

PUT /v1/jobs/{id}

Delete job

DELETE /v1/jobs/{id}

Get jobs

GET /v1/jobs

Save job

POST /v1/jobs

GET /v1/jobs/{id}

This api requires JOBS_VIEW,JOBS_VIEW_OWN permission.

Path variables

id

string required

Responses

200 200

OK

Body

*/*

Job details

PUT /v1/jobs/{id}

This api requires JOBS_MANAGE permission.

Path variables

id

string required

Request body

application/json

Job update request

Responses

200 200

OK

Body

*/*

Job response

DELETE /v1/jobs/{id}

This api requires JOBS_DELETE permission.

Path variables

id

string required

Responses

200 200

OK

GET /v1/jobs

This api requires JOBS_VIEW,JOBS_VIEW_OWN permission.

Request parameters

search

string optional

page

Pageable required

Responses

200 200

OK

Body

*/*

Page engagement full

POST /v1/jobs

This api requires JOBS_MANAGE permission.

Request body

application/json

Job request

Responses

200 200

OK

Body

*/*

Job response

Update job type organizations

PUT /v1/job_types/{id}/organizations/{organizationId}

Delete job type organizations

DELETE /v1/job_types/{id}/organizations/{organizationId}

Get job type services

GET /v1/job_types/{id}/services

Add job type services

POST /v1/job_types/{id}/services

Get job types

GET /v1/job_types

Get job type organizations

GET /v1/job_types/{id}/organizations

PUT /v1/job_types/{id}/organizations/{organizationId}

This api requires JOB_TYPES_MANAGE permission.

Path variables

id

string required

organizationId

string required

Request body

application/json

Job type organization request

Responses

200 200

OK

Body

*/*

Job type organization response

DELETE /v1/job_types/{id}/organizations/{organizationId}

This api requires JOB_TYPES_MANAGE permission.

Path variables

id

string required

organizationId

string required

Responses

200 200

OK

GET /v1/job_types/{id}/services

This api requires JOB_TYPES_VIEW permission.

Path variables

id

string required

Request parameters

search

string optional

Responses

200 200

OK

Body

*/*

Array of Job type service response

POST /v1/job_types/{id}/services

This api requires JOB_TYPES_MANAGE permission.

Path variables

id

string required

Request body

application/json

Valid list job type service request

Responses

200 200

OK

Body

*/*

Array of Job type service response

GET /v1/job_types

This api requires JOB_TYPES_VIEW permission.

Request parameters

search

string optional

project_id

string optional

is_default

boolean optional

owner_id

string optional

Responses

200 200

OK

Body

*/*

Array of Job type response

GET /v1/job_types/{id}/organizations

This api requires JOB_TYPES_VIEW permission.

Path variables

id

string required

Request parameters

engagement_id

string optional

Responses

200 200

OK

Body

*/*

Array of Job type organization response

Get evidence config

GET /v1/evidence_configs/{id}

Update evidence config

PUT /v1/evidence_configs/{id}

Delete evidence config

DELETE /v1/evidence_configs/{id}

Get evidence configs

GET /v1/evidence_configs

Add evidence config

POST /v1/evidence_configs

GET /v1/evidence_configs/{id}

This api requires LEAD_EVIDENCE_VIEW,JOB_EVIDENCE_VIEW,OPPORTUNITY_EVIDENCE_VIEW permission.

Path variables

id

string required

Responses

200 200

OK

Body

*/*

Evidence config

PUT /v1/evidence_configs/{id}

This api requires LEAD_EVIDENCE_MANAGE,JOB_EVIDENCE_MANAGE,OPPORTUNITY_EVIDENCE_MANAGE permission.

Path variables

id

string required

Request body

application/json

Evidence config request

Responses

200 200

OK

Body

*/*

Evidence config

DELETE /v1/evidence_configs/{id}

This api requires LEAD_EVIDENCE_MANAGE,JOB_EVIDENCE_MANAGE,OPPORTUNITY_EVIDENCE_MANAGE permission.

Path variables

id

string required

Responses

200 200

OK

GET /v1/evidence_configs

This api requires LEAD_EVIDENCE_VIEW,JOB_EVIDENCE_VIEW,OPPORTUNITY_EVIDENCE_VIEW,EVIDENCE_VIEW permission.

Request parameters

engagement_id

string optional

evidence_type

string optional

Enumeration:

IMAGE

VIDEO

FORM

DOCUMENT

evidence_category_tag

string optional

evidence_category_id

array of string optional

evidence_config_tag

string optional

source

string optional

Enumeration:

UPLOAD

AUTOMATION

ZERVIO_PDF

FORM_FILLER

search

string optional

is_default

boolean optional

Responses

200 200

OK

Body

*/*

Array of Evidence config

POST /v1/evidence_configs

This api requires LEAD_EVIDENCE_MANAGE,JOB_EVIDENCE_MANAGE,OPPORTUNITY_EVIDENCE_MANAGE permission.

Request body

application/json

Evidence config request

Responses

200 200

OK

Body

*/*

Evidence config

Update evidence config filters

PUT /v1/evidence_configs/filters

Get evidence config filters

GET /v1/evidence_configs/{id}/filters

PUT /v1/evidence_configs/filters

This api requires LEAD_EVIDENCE_VIEW,JOB_EVIDENCE_VIEW,OPPORTUNITY_EVIDENCE_VIEW permission.

Request body

application/json

Evidence config filters request

Responses

200 200

OK

Body

*/*

Array of Evidence config filter response

GET /v1/evidence_configs/{id}/filters

This api requires LEAD_EVIDENCE_VIEW,JOB_EVIDENCE_VIEW,OPPORTUNITY_EVIDENCE_VIEW permission.

Path variables

id

string required

Responses

200 200

OK

Body

*/*

Array of Evidence config filter response

Ge evidence_1

GET /v1/evidence/{id}

Add evidence

PUT /v1/evidence/{id}

Delete evidence

DELETE /v1/evidence/{id}

Update evidence organizations

PUT /v1/evidence/organizations

Ge evidence

GET /v1/evidence

Add evidence_1

POST /v1/evidence

Add evidence organizations

POST /v1/evidence/{id}/services

Download

POST /v1/evidence/download

Get evidence organizations

GET /v1/evidence/{id}/organizations

Delete evidence organizations

DELETE /v1/evidence/{id}/organizations/{organizationId}

GET /v1/evidence/{id}

This api requires LEAD_EVIDENCE_VIEW,JOB_EVIDENCE_VIEW,OPPORTUNITY_EVIDENCE_VIEW permission.

Path variables

id

string required

Responses

200 200

OK

Body

*/*

Evidence response

PUT /v1/evidence/{id}

This api requires LEAD_EVIDENCE_MANAGE,JOB_EVIDENCE_MANAGE,OPPORTUNITY_EVIDENCE_MANAGE permission.

Path variables

id

string required

Request body

application/json

Update evidence request

Responses

200 200

OK

Body

*/*

Evidence response

DELETE /v1/evidence/{id}

This api requires LEAD_EVIDENCE_MANAGE,JOB_EVIDENCE_MANAGE,OPPORTUNITY_EVIDENCE_MANAGE permission.

Path variables

id

string required

Responses

200 200

OK

PUT /v1/evidence/organizations

This api requires LEAD_EVIDENCE_MANAGE,JOB_EVIDENCE_MANAGE,OPPORTUNITY_EVIDENCE_MANAGE permission.

Request body

application/json

Array of Update evidence organization request

Responses

200 200

OK

Body

*/*

Array of Update evidence organization response

GET /v1/evidence

This api requires LEAD_EVIDENCE_VIEW,JOB_EVIDENCE_VIEW,OPPORTUNITY_EVIDENCE_VIEW permission.

Request parameters

engagement_id

string optional

activity_id

string optional

task_id

string optional

evidence_category_id

string optional

timeline

string optional

Enumeration:

BEFORE

DURING

AFTER

ONCE

search

string optional

status

string optional

Enumeration:

UPLOADED

GENERATED

FAILED

PROCESSING

ON_DEVICE

DELETED

EXPIRED

solar_design_id

array of string optional

evidence_config_tag

string optional

include_media

boolean optional

job_type_id

string optional

project_id

string optional

Responses

200 200

OK

Body

*/*

Array of Evidence list response

POST /v1/evidence

This api requires LEAD_EVIDENCE_MANAGE,JOB_EVIDENCE_MANAGE,OPPORTUNITY_EVIDENCE_MANAGE permission.

Request body

application/json

Valid list evidence request

Responses

200 200

OK

Body

*/*

Array of Evidence response

POST /v1/evidence/{id}/services

This api requires LEAD_EVIDENCE_MANAGE,JOB_EVIDENCE_MANAGE,OPPORTUNITY_EVIDENCE_MANAGE permission.

Path variables

id

string required

Request body

application/json

Valid list evidence organization request

Responses

200 200

OK

Body

*/*

Array of Id name

POST /v1/evidence/download

This api requires LEAD_EVIDENCE_MANAGE,JOB_EVIDENCE_MANAGE,OPPORTUNITY_EVIDENCE_MANAGE permission.

Request body

application/json

Valid list id

Responses

200 200

OK

GET /v1/evidence/{id}/organizations

This api requires LEAD_EVIDENCE_MANAGE,JOB_EVIDENCE_MANAGE,OPPORTUNITY_EVIDENCE_MANAGE permission.

Path variables

id

string required

Responses

200 200

OK

Body

*/*

Array of Id name

DELETE /v1/evidence/{id}/organizations/{organizationId}

This api requires LEAD_EVIDENCE_MANAGE,JOB_EVIDENCE_MANAGE,OPPORTUNITY_EVIDENCE_MANAGE permission.

Path variables

id

string required

organizationId

string required

Responses

200 200

OK

Get evidence media

GET /v1/evidence/{id}/media/{mediaId}

Update evidence media

PUT /v1/evidence/{id}/media/{mediaId}

Delete evidence media

DELETE /v1/evidence/{id}/media/{mediaId}

Add evidence media

POST /v1/evidence/{id}/media

Sign media

POST /v1/evidence/{id}/media/{mediaId}/sign

Resend

POST /v1/evidence/{id}/media/{mediaId}/resend

GET /v1/evidence/{id}/media/{mediaId}

This api requires LEAD_EVIDENCE_MANAGE,JOB_EVIDENCE_MANAGE,OPPORTUNITY_EVIDENCE_MANAGE permission.

Path variables

id

string required

mediaId

string required

Responses

200 200

OK

Body

*/*

Evidence media response

PUT /v1/evidence/{id}/media/{mediaId}

This api requires LEAD_EVIDENCE_MANAGE,JOB_EVIDENCE_MANAGE,OPPORTUNITY_EVIDENCE_MANAGE permission.

Path variables

id

string required

mediaId

string required

Request body

application/json

Evidence media update request

Responses

200 200

OK

Body

*/*

Evidence media response

DELETE /v1/evidence/{id}/media/{mediaId}

This api requires LEAD_EVIDENCE_MANAGE,JOB_EVIDENCE_MANAGE,OPPORTUNITY_EVIDENCE_MANAGE permission.

Path variables

id

string required

mediaId

string required

Responses

200 200

OK

POST /v1/evidence/{id}/media

This api requires LEAD_EVIDENCE_MANAGE,JOB_EVIDENCE_MANAGE,OPPORTUNITY_EVIDENCE_MANAGE permission.

Path variables

id

string required

Request body

application/json

Evidence media request

Responses

200 200

OK

Body

*/*

Evidence media response

POST /v1/evidence/{id}/media/{mediaId}/sign

This api requires LEAD_EVIDENCE_MANAGE,JOB_EVIDENCE_MANAGE,OPPORTUNITY_EVIDENCE_MANAGE permission.

Path variables

id

string required

mediaId

string required

Request body

application/json

Sign media request

Responses

200 200

OK

Body

*/*

Evidence media response

POST /v1/evidence/{id}/media/{mediaId}/resend

This api requires LEAD_EVIDENCE_MANAGE,JOB_EVIDENCE_MANAGE,OPPORTUNITY_EVIDENCE_MANAGE permission.

Path variables

id

string required

mediaId

string required

Request body

application/json

Evidence resend request

Responses

200 200

OK

Body

*/*

Evidence media response

Get property epc

PUT /v1/epcs/{id}

This api requires PROPERTIES_VIEW,PROPERTIES_VIEW_OWN permission.

Path variables

id

string required

Responses

200 200

OK

Body

*/*

Property epc details

Get custom data

GET /v1/engagements/{id}/custom_forms/{cid}/custom_data

Update custom data

PUT /v1/engagements/{id}/custom_forms/{cid}/custom_data

GET /v1/engagements/{id}/custom_forms/{cid}/custom_data

This api requires LEAD_CUSTOM_DATA_VIEW,JOB_CUSTOM_DATA_VIEW,OPPORTUNITY_CUSTOM_DATA_VIEW,JOBS_VIEW_OWN permission.

Path variables

id

string required

cid

string required

Request parameters

owner_id

string optional

Responses

200 200

OK

Body

*/*

Array of Custom data response

PUT /v1/engagements/{id}/custom_forms/{cid}/custom_data

This api requires LEAD_CUSTOM_DATA_MANAGE,JOB_CUSTOM_DATA_MANAGE,OPPORTUNITY_CUSTOM_DATA_MANAGE permission.

Path variables

id

string required

cid

string required

Request body

application/json

Array of Custom data request

Responses

200 200

OK

Body

*/*

Array of Custom data response

Get communication

GET /v1/engagements/{id}/communications/{cid}

Update communication

PUT /v1/engagements/{id}/communications/{cid}

Delete communication

DELETE /v1/engagements/{id}/communications/{cid}

Get communications

GET /v1/engagements/{id}/communications

Add communication

POST /v1/engagements/{id}/communications

GET /v1/engagements/{id}/communications/{cid}

This api requires LEAD_COMMUNICATIONS_VIEW,JOB_COMMUNICATIONS_VIEW,OPPORTUNITY_COMMUNICATIONS_VIEW permission.

Path variables

id

string required

cid

string required

Responses

200 200

OK

Body

*/*

Communication response

PUT /v1/engagements/{id}/communications/{cid}

This api requires LEAD_COMMUNICATIONS_MANAGE,JOB_COMMUNICATIONS_MANAGE,OPPORTUNITY_COMMUNICATIONS_MANAGE permission.

Path variables

id

string required

cid

string required

Request body

application/json

Communication request

Responses

200 200

OK

Body

*/*

Communication response

DELETE /v1/engagements/{id}/communications/{cid}

This api requires LEAD_COMMUNICATIONS_MANAGE,JOB_COMMUNICATIONS_MANAGE,OPPORTUNITY_COMMUNICATIONS_MANAGE permission.

Path variables

id

string required

cid

string required

Responses

200 200

OK

GET /v1/engagements/{id}/communications

This api requires LEAD_COMMUNICATIONS_VIEW,JOB_COMMUNICATIONS_VIEW,OPPORTUNITY_COMMUNICATIONS_VIEW permission.

Path variables

id

string required

Responses

200 200

OK

Body

*/*

Array of Communication response

POST /v1/engagements/{id}/communications

This api requires LEAD_COMMUNICATIONS_MANAGE,JOB_COMMUNICATIONS_MANAGE,OPPORTUNITY_COMMUNICATIONS_MANAGE permission.

Path variables

id

string required

Request body

application/json

Communication request

Responses

200 200

OK

Body

*/*

Communication response

Get solar design

GET /v1/engagements/{engagementId}/solar_designs/{designId}

Update solar design

PUT /v1/engagements/{engagementId}/solar_designs/{designId}

Delete solar design

DELETE /v1/engagements/{engagementId}/solar_designs/{designId}

Get solar designs

GET /v1/engagements/{engagementId}/solar_designs

Create solar design

POST /v1/engagements/{engagementId}/solar_designs

Get images

GET /v1/engagements/{engagementId}/solar_designs/{designId}/images

Upload images

POST /v1/engagements/{engagementId}/solar_designs/{designId}/images

Get solar design_1

GET /v1/engagements/{engagementId}/solar_designs/{designId}/hourly

GET /v1/engagements/{engagementId}/solar_designs/{designId}

This api requires LEAD_DESIGNS_VIEW,JOB_DESIGNS_VIEW,OPPORTUNITY_DESIGNS_VIEW permission.

Path variables

engagementId

string required

designId

string required

Responses

200 200

OK

Body

*/*

Solar design response

PUT /v1/engagements/{engagementId}/solar_designs/{designId}

This api requires LEAD_DESIGNS_MANAGE,JOB_DESIGNS_MANAGE,OPPORTUNITY_DESIGNS_MANAGE permission.

Path variables

engagementId

string required

designId

string required

Request body

application/json

Design request

Responses

200 200

OK

Body

*/*

Solar design summary

DELETE /v1/engagements/{engagementId}/solar_designs/{designId}

This api requires LEAD_DESIGNS_MANAGE,JOB_DESIGNS_MANAGE,OPPORTUNITY_DESIGNS_MANAGE permission.

Path variables

engagementId

string required

designId

string required

Responses

200 200

OK

GET /v1/engagements/{engagementId}/solar_designs

This api requires LEAD_DESIGNS_VIEW,JOB_DESIGNS_VIEW,OPPORTUNITY_DESIGNS_VIEW permission.

Path variables

engagementId

string required

Responses

200 200

OK

Body

*/*

Array of Solar design summary

POST /v1/engagements/{engagementId}/solar_designs

This api requires LEAD_DESIGNS_MANAGE,JOB_DESIGNS_MANAGE,OPPORTUNITY_DESIGNS_MANAGE permission.

Path variables

engagementId

string required

Request body

application/json

Design creation request

Responses

200 200

OK

Body

*/*

Solar design summary

GET /v1/engagements/{engagementId}/solar_designs/{designId}/images

This api requires LEAD_DESIGNS_VIEW,JOB_DESIGNS_VIEW,OPPORTUNITY_DESIGNS_VIEW permission.

Path variables

engagementId

string required

designId

string required

Request parameters

lexicon

string optional

roof_id

string optional

segment_3d_id

string optional

Responses

200 200

OK

Body

*/*

Array of Design image response

POST /v1/engagements/{engagementId}/solar_designs/{designId}/images

This api requires LEAD_DESIGNS_MANAGE,JOB_DESIGNS_MANAGE,OPPORTUNITY_DESIGNS_MANAGE permission.

Path variables

engagementId

string required

designId

string required

Request body

application/json

Design image request

Responses

200 200

OK

GET /v1/engagements/{engagementId}/solar_designs/{designId}/hourly

This api requires LEAD_DESIGNS_VIEW,JOB_DESIGNS_VIEW,OPPORTUNITY_DESIGNS_VIEW permission.

Path variables

engagementId

string required

designId

string required

Request parameters

month

integer int32 required

Responses

200 200

OK

Body

*/*

Array of Hourly simulation result

Get solar design_2

GET /v1/engagements/{engagementId}/designs/{designId}

Update solar design_1

PUT /v1/engagements/{engagementId}/designs/{designId}

Delete solar design_1

DELETE /v1/engagements/{engagementId}/designs/{designId}

Get solar designs_1

GET /v1/engagements/{engagementId}/designs

Create designs

POST /v1/engagements/{engagementId}/designs

Create design quote

POST /v1/engagements/{engagementId}/designs/{id}/quotes

Get images_1

GET /v1/engagements/{engagementId}/designs/{designId}/images

Upload images_1

POST /v1/engagements/{engagementId}/designs/{designId}/images

Get solar design_3

GET /v1/engagements/{engagementId}/designs/{designId}/hourly

GET /v1/engagements/{engagementId}/designs/{designId}

This api requires LEAD_DESIGNS_VIEW,JOB_DESIGNS_VIEW,OPPORTUNITY_DESIGNS_VIEW permission.

Path variables

engagementId

string required

designId

string required

Responses

200 200

OK

Body

*/*

Design response

PUT /v1/engagements/{engagementId}/designs/{designId}

This api requires LEAD_DESIGNS_MANAGE,JOB_DESIGNS_MANAGE,OPPORTUNITY_DESIGNS_MANAGE permission.

Path variables

engagementId

string required

designId

string required

Request body

application/json

Design request

Responses

200 200

OK

Body

*/*

Solar design summary

DELETE /v1/engagements/{engagementId}/designs/{designId}

This api requires LEAD_DESIGNS_MANAGE,JOB_DESIGNS_MANAGE,OPPORTUNITY_DESIGNS_MANAGE permission.

Path variables

engagementId

string required

designId

string required

Responses

200 200

OK

GET /v1/engagements/{engagementId}/designs

This api requires LEAD_DESIGNS_VIEW,JOB_DESIGNS_VIEW,OPPORTUNITY_DESIGNS_VIEW permission.

Path variables

engagementId

string required

Request parameters

design_type

string optional

Enumeration:

SOLAR

SOLAR_3D

ASHP

Responses

200 200

OK

Body

*/*

Array of Design summary

POST /v1/engagements/{engagementId}/designs

This api requires LEAD_DESIGNS_MANAGE,JOB_DESIGNS_MANAGE,OPPORTUNITY_DESIGNS_MANAGE permission.

Path variables

engagementId

string required

Request body

application/json

Array of Create design request

Responses

200 200

OK

Body

*/*

Array of Design summary response

POST /v1/engagements/{engagementId}/designs/{id}/quotes

This api requires LEAD_DESIGNS_MANAGE,JOB_DESIGNS_MANAGE,OPPORTUNITY_DESIGNS_MANAGE permission.

Path variables

engagementId

string required

id

string required

Responses

200 200

OK

Body

*/*

Design response

GET /v1/engagements/{engagementId}/designs/{designId}/images

This api requires LEAD_DESIGNS_VIEW,JOB_DESIGNS_VIEW,OPPORTUNITY_DESIGNS_VIEW permission.

Path variables

engagementId

string required

designId

string required

Request parameters

lexicon

string optional

roof_id

string optional

segment_3d_id

string optional

Responses

200 200

OK

Body

*/*

Array of Design image response

POST /v1/engagements/{engagementId}/designs/{designId}/images

This api requires LEAD_DESIGNS_MANAGE,JOB_DESIGNS_MANAGE,OPPORTUNITY_DESIGNS_MANAGE permission.

Path variables

engagementId

string required

designId

string required

Request body

application/json

Design image request

Responses

200 200

OK

GET /v1/engagements/{engagementId}/designs/{designId}/hourly

This api requires LEAD_DESIGNS_VIEW,JOB_DESIGNS_VIEW,OPPORTUNITY_DESIGNS_VIEW permission.

Path variables

engagementId

string required

designId

string required

Request parameters

month

integer int32 required

Responses

200 200

OK

Body

*/*

Array of Hourly simulation result

Get tariff by id

GET /v1/energy_tariffs/{id}

Update tariff

PUT /v1/energy_tariffs/{id}

Get all tariffs

GET /v1/energy_tariffs

Create tariff

POST /v1/energy_tariffs

Get rates

GET /v1/energy_tariffs/{id}/energy_rates

GET /v1/energy_tariffs/{id}

This api requires ENERGY_TARIFFS_VIEW permission.

Path variables

id

string required

Responses

200 200

OK

Body

*/*

Energy tariff response

PUT /v1/energy_tariffs/{id}

This api requires ENERGY_TARIFFS_MANAGE permission.

Path variables

id

string required

Request body

application/json

Energy tariff request

Responses

200 200

OK

Body

*/*

Energy tariff response

GET /v1/energy_tariffs

This api requires ENERGY_TARIFFS_VIEW,PUBLIC_ENERGY_TARIFFS_VIEW permission.

Request parameters

energy_type

string required

Enumeration:

ELECTRICITY

GAS

Responses

200 200

OK

Body

*/*

Array of Id name

POST /v1/energy_tariffs

This api requires ENERGY_TARIFFS_MANAGE permission.

Request body

application/json

Energy tariff request

Responses

200 200

OK

Body

*/*

Energy tariff response

GET /v1/energy_tariffs/{id}/energy_rates

This api requires ENERGY_TARIFFS_VIEW permission.

Path variables

id

string required

Request parameters

account_id

string optional

Responses

200 200

OK

Body

*/*

Array of Energy rate response

Get financial design_1

GET /v1/designs/{sid}/financials/{fid}

Update financial design_1

PUT /v1/designs/{sid}/financials/{fid}

Delete financial design_1

DELETE /v1/designs/{sid}/financials/{fid}

Get financial designs_1

GET /v1/designs/{sid}/financials

Create financial design_1

POST /v1/designs/{sid}/financials

GET /v1/designs/{sid}/financials/{fid}

This api requires LEAD_DESIGNS_VIEW,JOB_DESIGNS_VIEW,OPPORTUNITY_DESIGNS_VIEW permission.

Path variables

sid

string required

fid

string required

Responses

200 200

OK

Body

*/*

Financial design response

PUT /v1/designs/{sid}/financials/{fid}

This api requires LEAD_DESIGNS_MANAGE,JOB_DESIGNS_MANAGE,OPPORTUNITY_DESIGNS_MANAGE permission.

Path variables

sid

string required

fid

string required

Request body

application/json

Financial design request

Responses

200 200

OK

Body

*/*

Financial design response

DELETE /v1/designs/{sid}/financials/{fid}

This api requires LEAD_DESIGNS_MANAGE,JOB_DESIGNS_MANAGE,OPPORTUNITY_DESIGNS_MANAGE permission.

Path variables

sid

string required

fid

string required

Responses

200 200

OK

GET /v1/designs/{sid}/financials

This api requires LEAD_DESIGNS_VIEW,JOB_DESIGNS_VIEW,OPPORTUNITY_DESIGNS_VIEW permission.

Path variables

sid

string required

Responses

200 200

OK

Body

*/*

Array of Financial design summary

POST /v1/designs/{sid}/financials

This api requires LEAD_DESIGNS_MANAGE,JOB_DESIGNS_MANAGE,OPPORTUNITY_DESIGNS_MANAGE permission.

Path variables

sid

string required

Request body

application/json

Financial design request

Responses

200 200

OK

Body

*/*

Financial design response

Update roof_1

PUT /v1/designs/{propertyId}/roofs/{roofId}

Delete roof_1

DELETE /v1/designs/{propertyId}/roofs/{roofId}

Get roof panels_1

GET /v1/designs/{propertyId}/roofs/{roofId}/panels

Add roof panels_1

POST /v1/designs/{propertyId}/roofs/{roofId}/panels

Update roof panels_1

PUT /v1/designs/{propertyId}/roofs/{roofId}/panels

Get roof exclusions_1

GET /v1/designs/{propertyId}/roofs/{roofId}/exclusions

Update roof exclusions_1

PUT /v1/designs/{propertyId}/roofs/{roofId}/exclusions

Get roofs_1

GET /v1/designs/{propertyId}/roofs

Import roofs_2

POST /v1/designs/{propertyId}/roofs

Import roofs_3

POST /v1/designs/{propertyId}/roofs/import

Get roof panels geo json_1

GET /v1/designs/{propertyId}/roofs/{roofId}/panels/geojson

Get roof elevation tiff_1

GET /v1/designs/{propertyId}/roofs/{roofId}/elevations

PUT /v1/designs/{propertyId}/roofs/{roofId}

This api requires LEAD_DESIGNS_MANAGE,JOB_DESIGNS_MANAGE,OPPORTUNITY_DESIGNS_MANAGE permission.

Path variables

propertyId

string required

roofId

string required

Request body

application/json

Property roof request

Responses

200 200

OK

Body

*/*

Roof segment response

DELETE /v1/designs/{propertyId}/roofs/{roofId}

This api requires LEAD_DESIGNS_MANAGE,JOB_DESIGNS_MANAGE,OPPORTUNITY_DESIGNS_MANAGE permission.

Path variables

propertyId

string required

roofId

string required

Responses

200 200

OK

GET /v1/designs/{propertyId}/roofs/{roofId}/panels

This api requires LEAD_DESIGNS_VIEW,JOB_DESIGNS_VIEW,OPPORTUNITY_DESIGNS_VIEW permission.

Path variables

propertyId

string required

roofId

string required

Request parameters

source

string optional

Enumeration:

MANUAL

IMPORTED

Responses

200 200

OK

Body

*/*

Array of Panel response

POST /v1/designs/{propertyId}/roofs/{roofId}/panels

This api requires LEAD_DESIGNS_MANAGE,JOB_DESIGNS_MANAGE,OPPORTUNITY_DESIGNS_MANAGE permission.

Path variables

propertyId

string required

roofId

string required

Request parameters

source

string optional

Enumeration:

MANUAL

IMPORTED

Request body

application/json

Array of Panel request

Responses

200 200

OK

Body

*/*

Array of Panel response

PUT /v1/designs/{propertyId}/roofs/{roofId}/panels

This api requires LEAD_DESIGNS_MANAGE,JOB_DESIGNS_MANAGE,OPPORTUNITY_DESIGNS_MANAGE permission.

Path variables

propertyId

string required

roofId

string required

Request parameters

source

string optional

Enumeration:

MANUAL

IMPORTED

Request body

application/json

Array of Panel request

Responses

200 200

OK

Body

*/*

Array of Panel response

GET /v1/designs/{propertyId}/roofs/{roofId}/exclusions

This api requires LEAD_DESIGNS_VIEW,JOB_DESIGNS_VIEW,OPPORTUNITY_DESIGNS_VIEW permission.

Path variables

propertyId

string required

roofId

string required

Responses

200 200

OK

Body

*/*

Array of Roof exclusion response

PUT /v1/designs/{propertyId}/roofs/{roofId}/exclusions

This api requires LEAD_DESIGNS_MANAGE,JOB_DESIGNS_MANAGE,OPPORTUNITY_DESIGNS_MANAGE permission.

Path variables

propertyId

string required

roofId

string required

Request body

application/json

Array of Roof exclusion request

Responses

200 200

OK

Body

*/*

Array of Roof exclusion response

GET /v1/designs/{propertyId}/roofs

This api requires LEAD_DESIGNS_VIEW,JOB_DESIGNS_VIEW,OPPORTUNITY_DESIGNS_VIEW permission.

Path variables

propertyId

string required

Responses

200 200

OK

Body

*/*

Array of Property roof response

POST /v1/designs/{propertyId}/roofs

This api requires LEAD_DESIGNS_MANAGE,JOB_DESIGNS_MANAGE,OPPORTUNITY_DESIGNS_MANAGE permission.

Path variables

propertyId

string required

Request body

application/json

Roof creation request

Responses

200 200

OK

Body

*/*

Property roof response

POST /v1/designs/{propertyId}/roofs/import

This api requires LEAD_DESIGNS_MANAGE,JOB_DESIGNS_MANAGE,OPPORTUNITY_DESIGNS_MANAGE permission.

Path variables

propertyId

string required

Request body

application/json

Roof import request

Responses

200 200

OK

Body

*/*

Property roof response

GET /v1/designs/{propertyId}/roofs/{roofId}/panels/geojson

This api requires LEAD_DESIGNS_VIEW,JOB_DESIGNS_VIEW,OPPORTUNITY_DESIGNS_VIEW permission.

Path variables

propertyId

string required

roofId

string required

Responses

200 200

OK

Body

*/*

Panel geo json response

GET /v1/designs/{propertyId}/roofs/{roofId}/elevations

This api requires LEAD_DESIGNS_VIEW,JOB_DESIGNS_VIEW,OPPORTUNITY_DESIGNS_VIEW permission.

Path variables

propertyId

string required

roofId

string required

Responses

200 200

OK

Body

image/tiff

string byte

Get diagram

GET /v1/designs/{id}/diagrams

Update diagram

PUT /v1/designs/{id}/diagrams

GET /v1/designs/{id}/diagrams

This api requires LEAD_DESIGNS_VIEW,JOB_DESIGNS_VIEW,OPPORTUNITY_DESIGNS_VIEW permission.

Path variables

id

string required

Responses

200 200

OK

Body

*/*

Diagram

PUT /v1/designs/{id}/diagrams

This api requires LEAD_DESIGNS_MANAGE,JOB_DESIGNS_MANAGE,OPPORTUNITY_DESIGNS_MANAGE permission.

Path variables

id

string required

Request body

application/json

Diagram

Responses

200 200

OK

Body

*/*

Diagram

Update

PUT /v1/designs/{did}/solar_simulations/{sid}

Delete simulation

DELETE /v1/designs/{did}/solar_simulations/{sid}

Get simulations

GET /v1/designs/{did}/solar_simulations

Run simulation

POST /v1/designs/{did}/solar_simulations

PUT /v1/designs/{did}/solar_simulations/{sid}

This api requires LEAD_DESIGNS_MANAGE,JOB_DESIGNS_MANAGE,OPPORTUNITY_DESIGNS_MANAGE permission.

Path variables

did

string required

sid

string required

Request body

application/json

Simulation update request

Responses

200 200

OK

Body

*/*

Simulation summary

DELETE /v1/designs/{did}/solar_simulations/{sid}

This api requires LEAD_DESIGNS_MANAGE,JOB_DESIGNS_MANAGE,OPPORTUNITY_DESIGNS_MANAGE permission.

Path variables

did

string required

sid

string required

Responses

200 200

OK

GET /v1/designs/{did}/solar_simulations

This api requires LEAD_DESIGNS_VIEW,JOB_DESIGNS_VIEW,OPPORTUNITY_DESIGNS_VIEW permission.

Path variables

did

string required

Responses

200 200

OK

Body

*/*

Array of Simulation summary

POST /v1/designs/{did}/solar_simulations

This api requires LEAD_DESIGNS_MANAGE,JOB_DESIGNS_MANAGE,OPPORTUNITY_DESIGNS_MANAGE permission.

Path variables

did

string required

Request body

application/json

Simulation run request

Responses

200 200

OK

Body

*/*

Simulation summary

Update3d roof strings

PUT /v1/designs/{designId}/strings/{stringId}

Delete3d roof strings

DELETE /v1/designs/{designId}/strings/{stringId}

Get3d roof strings

GET /v1/designs/{designId}/strings

Add3d roof strings

POST /v1/designs/{designId}/strings

PUT /v1/designs/{designId}/strings/{stringId}

This api requires LEAD_DESIGNS_MANAGE,JOB_DESIGNS_MANAGE,OPPORTUNITY_DESIGNS_MANAGE permission.

Path variables

designId

string required

stringId

string required

Request body

application/json

Panel string request

Responses

200 200

OK

Body

*/*

Panel string response

DELETE /v1/designs/{designId}/strings/{stringId}

This api requires LEAD_DESIGNS_MANAGE,JOB_DESIGNS_MANAGE,OPPORTUNITY_DESIGNS_MANAGE permission.

Path variables

designId

string required

stringId

string required

Responses

200 200

OK

GET /v1/designs/{designId}/strings

This api requires LEAD_DESIGNS_VIEW,JOB_DESIGNS_VIEW,OPPORTUNITY_DESIGNS_VIEW permission.

Path variables

designId

string required

Responses

200 200

OK

Body

application/json

Array of Panel string response

POST /v1/designs/{designId}/strings

This api requires LEAD_DESIGNS_MANAGE,JOB_DESIGNS_MANAGE,OPPORTUNITY_DESIGNS_MANAGE permission.

Path variables

designId

string required

Request body

application/json

Panel string request

Responses

200 200

OK

Body

application/json

Panel string response

Get losses_1

GET /v1/designs/{designId}/roofs/{roofId}/losses

Update losses_1

PUT /v1/designs/{designId}/roofs/{roofId}/losses

GET /v1/designs/{designId}/roofs/{roofId}/losses

This api requires LEAD_DESIGNS_VIEW,JOB_DESIGNS_VIEW,OPPORTUNITY_DESIGNS_VIEW permission.

Path variables

designId

string required

roofId

string required

Responses

200 200

OK

Body

*/*

Loss request

PUT /v1/designs/{designId}/roofs/{roofId}/losses

This api requires LEAD_DESIGNS_MANAGE,JOB_DESIGNS_MANAGE,OPPORTUNITY_DESIGNS_MANAGE permission.

Path variables

designId

string required

roofId

string required

Request body

application/json

Loss request

Responses

200 200

OK

Body

*/*

Loss request

Update panel

PUT /v1/designs/{designId}/panels/{id}

Delete panel

DELETE /v1/designs/{designId}/panels/{id}

Add panel

POST /v1/designs/{designId}/panels

PUT /v1/designs/{designId}/panels/{id}

null

Path variables

designId

string required

id

string required

Request body

application/json

Design component request

Responses

200 200

OK

Body

*/*

Object

DELETE /v1/designs/{designId}/panels/{id}

null

Path variables

designId

string required

id

string required

Responses

200 200

OK

POST /v1/designs/{designId}/panels

null

Path variables

designId

string required

Request body

application/json

Design component request

Responses

200 200

OK

Body

*/*

Object

Get obstacles_1

GET /v1/designs/{designId}/obstacles

Update obstacle_1

PUT /v1/designs/{designId}/obstacles

GET /v1/designs/{designId}/obstacles

This api requires LEAD_DESIGNS_VIEW,JOB_DESIGNS_VIEW,OPPORTUNITY_DESIGNS_VIEW permission.

Path variables

designId

string required

Request parameters

roof_id

string optional

max_distance

number double optional

Responses

200 200

OK

Body

*/*

Array of Obstacle response

PUT /v1/designs/{designId}/obstacles

This api requires LEAD_DESIGNS_MANAGE,JOB_DESIGNS_MANAGE,OPPORTUNITY_DESIGNS_MANAGE permission.

Path variables

designId

string required

Request body

application/json

Array of Obstacle request

Responses

200 200

OK

Body

*/*

Array of Obstacle response

Update inverter

PUT /v1/designs/{designId}/inverters/{id}

Delete inverter

DELETE /v1/designs/{designId}/inverters/{id}

Add inverter

POST /v1/designs/{designId}/inverters

PUT /v1/designs/{designId}/inverters/{id}

null

Path variables

designId

string required

id

string required

Request body

application/json

Design component request

Responses

200 200

OK

Body

*/*

Object

DELETE /v1/designs/{designId}/inverters/{id}

null

Path variables

designId

string required

id

string required

Responses

200 200

OK

POST /v1/designs/{designId}/inverters

null

Path variables

designId

string required

Request body

application/json

Design component request

Responses

200 200

OK

Body

*/*

Object

Update ev charger

PUT /v1/designs/{designId}/ev_chargers/{id}

Delete ev charger

DELETE /v1/designs/{designId}/ev_chargers/{id}

Add ev charger

POST /v1/designs/{designId}/ev_chargers

PUT /v1/designs/{designId}/ev_chargers/{id}

null

Path variables

designId

string required

id

string required

Request body

application/json

Design component request

Responses

200 200

OK

Body

*/*

Object

DELETE /v1/designs/{designId}/ev_chargers/{id}

null

Path variables

designId

string required

id

string required

Responses

200 200

OK

POST /v1/designs/{designId}/ev_chargers

null

Path variables

designId

string required

Request body

application/json

Design component request

Responses

200 200

OK

Body

*/*

Object

Update battery

PUT /v1/designs/{designId}/batteries/{id}

Delete battery

DELETE /v1/designs/{designId}/batteries/{id}

Add battery

POST /v1/designs/{designId}/batteries

PUT /v1/designs/{designId}/batteries/{id}

null

Path variables

designId

string required

id

string required

Request body

application/json

Design component request

Responses

200 200

OK

Body

*/*

Object

DELETE /v1/designs/{designId}/batteries/{id}

null

Path variables

designId

string required

id

string required

Responses

200 200

OK

POST /v1/designs/{designId}/batteries

null

Path variables

designId

string required

Request body

application/json

Design component request

Responses

200 200

OK

Body

*/*

Object

Get board

GET /v1/boards/{id}

Update board

PUT /v1/boards/{id}

Delete board

DELETE /v1/boards/{id}

Get board stages

GET /v1/boards/{id}/stages

Update board stages

PUT /v1/boards/{id}/stages

Get board access

GET /v1/boards/{id}/access

Update board access

PUT /v1/boards/{id}/access

Get boards_1

GET /v1/boards

Create board

POST /v1/boards

Add board organizations

POST /v1/boards/{id}/organizations/{organizationId}

Delete board organizations

DELETE /v1/boards/{id}/organizations/{organizationId}

Get board workitems

GET /v1/boards/{id}/workitems

Get board organizations

GET /v1/boards/{id}/organizations

GET /v1/boards/{id}

This api requires BOARDS_VIEW permission.

Path variables

id

string required

Responses

200 200

OK

Body

*/*

Board response

PUT /v1/boards/{id}

This api requires BOARDS_MANAGE permission.

Path variables

id

string required

Request body

application/json

Board request

Responses

200 200

OK

Body

*/*

Board response

DELETE /v1/boards/{id}

This api requires BOARDS_MANAGE permission.

Path variables

id

string required

Responses

200 200

OK

GET /v1/boards/{id}/stages

This api requires BOARDS_VIEW permission.

Path variables

id

string required

Request parameters

stage_type

string optional

Enumeration:

CREATOR

SPLIT

RENDEZVOUS

NORMAL

TRANSITION

ARCHIVE

AGGREGATOR

Responses

200 200

OK

Body

*/*

Array of Board stage response

PUT /v1/boards/{id}/stages

This api requires BOARDS_MANAGE permission.

Path variables

id

string required

Request body

application/json

Array of Board stage request

Responses

200 200

OK

Body

*/*

Array of Board stage response

GET /v1/boards/{id}/access

This api requires BOARDS_VIEW permission.

Path variables

id

string required

Responses

200 200

OK

Body

*/*

Array of Board access response

PUT /v1/boards/{id}/access

This api requires BOARDS_VIEW permission.

Path variables

id

string required

Request body

application/json

Array of Board access request

Responses

200 200

OK

Body

*/*

Array of Board access response

GET /v1/boards

This api requires BOARDS_VIEW, BOARDS_MANAGE permission.

Request parameters

board_type

string optional

Enumeration:

OPPORTUNITY

JOB

LEAD

Responses

200 200

OK

Body

*/*

Array of Board summary

POST /v1/boards

This api requires BOARDS_MANAGE permission.

Request body

application/json

Board request

Responses

200 200

OK

Body

*/*

Board response

POST /v1/boards/{id}/organizations/{organizationId}

This api requires BOARDS_MANAGE permission.

Path variables

id

string required

organizationId

string required

Responses

200 200

OK

Body

*/*

Id name

DELETE /v1/boards/{id}/organizations/{organizationId}

This api requires BOARDS_MANAGE permission.

Path variables

id

string required

organizationId

string required

Responses

200 200

OK

GET /v1/boards/{id}/workitems

This api requires BOARDS_VIEW permission.

Path variables

id

string required

Request parameters

search

string optional

stage_id

array of string optional

Responses

200 200

OK

Body

*/*

Array of Board workitem

GET /v1/boards/{id}/organizations

This api requires BOARDS_VIEW permission.

Path variables

id

string required

Responses

200 200

OK

Body

*/*

Array of Id name

Get activity type

GET /v1/activity_types/{id}

Update activity type

PUT /v1/activity_types/{id}

Delete activity type

DELETE /v1/activity_types/{id}

Add activity type organizations

POST /v1/organizations/{id}/activity_types

Get activity types

GET /v1/activity_types

Add activity type

POST /v1/activity_types

Get activity type services

GET /v1/activity_types/{id}/services

GET /v1/activity_types/{id}

This api requires JOB_TYPES_VIEW permission.

Path variables

id

string required

Responses

200 200

OK

Body

*/*

Activity type response

PUT /v1/activity_types/{id}

This api requires JOB_TYPES_MANAGE permission.

Path variables

id

string required

Request body

application/json

Activity type request

Responses

200 200

OK

Body

*/*

Activity type response

DELETE /v1/activity_types/{id}

This api requires JOB_TYPES_MANAGE permission.

Path variables

id

string required

Responses

200 200

OK

POST /v1/organizations/{id}/activity_types

This api requires JOB_TYPES_MANAGE permission.

Path variables

id

string required

Request body

application/json

Array of Id

Responses

200 200

OK

Body

*/*

Array of Activity type response

GET /v1/activity_types

This api requires JOB_TYPES_VIEW permission.

Request parameters

project_id

string optional

job_type_id

array of string optional

engagement_type

string optional

Enumeration:

OPPORTUNITY

JOB

LEAD

is_default

boolean optional

Responses

200 200

OK

Body

*/*

Array of Activity type response

POST /v1/activity_types

This api requires JOB_TYPES_MANAGE permission.

Request body

application/json

Activity type request

Responses

200 200

OK

Body

*/*

Activity type response

GET /v1/activity_types/{id}/services

This api requires JOB_TYPES_VIEW permission.

Path variables

id

string required

Responses

200 200

OK

Body

*/*

Array of Activity type service response

Get event

GET /v1/activities/{id}

Update activity

PUT /v1/activities/{id}

Update activity tasks

PUT /v1/activities/{id}/tasks

Update activity status

PUT /v1/activities/{id}/status

Update activity creator

PUT /v1/activities/{id}/creator

Get activities_1

GET /v1/activities

Add activity

POST /v1/activities

Get user events

GET /v1/users/{id}/activities

Get activities

GET /v1/engagements/{id}/activities

Get activity offline

GET /v1/activities/{id}/offline

GET /v1/activities/{id}

This api requires LEAD_ACTIVITIES_VIEW,JOB_ACTIVITIES_VIEW,OPPORTUNITY_ACTIVITIES_VIEW,ACTIVITIES_VIEW,LEAD_ACTIVITIES_VIEW_OWN,JOB_ACTIVITIES_VIEW_OWN,OPPORTUNITY_ACTIVITIES_VIEW_OWN,ACTIVITIES_VIEW_OWN permission.

Path variables

id

string required

Responses

200 200

OK

Body

*/*

Activity response

PUT /v1/activities/{id}

This api requires LEAD_ACTIVITIES_MANAGE,JOB_ACTIVITIES_MANAGE,OPPORTUNITY_ACTIVITIES_MANAGE,ACTIVITIES_MANAGE permission.

Path variables

id

string required

Request body

application/json

Activity update request

Responses

200 200

OK

Body

*/*

Activity list response

PUT /v1/activities/{id}/tasks

This api requires LEAD_ACTIVITIES_MANAGE,JOB_ACTIVITIES_MANAGE,OPPORTUNITY_ACTIVITIES_MANAGE,ACTIVITIES_MANAGE permission.

Path variables

id

string required

Request body

application/json

Array of Create task request

Responses

200 200

OK

Body

*/*

Array of Event task response

PUT /v1/activities/{id}/status

This api requires LEAD_ACTIVITIES_MANAGE,JOB_ACTIVITIES_MANAGE,OPPORTUNITY_ACTIVITIES_MANAGE,ACTIVITIES_MANAGE permission.

Path variables

id

string required

Request body

application/json

Activity update status request

Responses

200 200

OK

Body

*/*

Activity list response

PUT /v1/activities/{id}/creator

This api requires LEAD_ACTIVITIES_MANAGE,JOB_ACTIVITIES_MANAGE,OPPORTUNITY_ACTIVITIES_MANAGE,ACTIVITIES_MANAGE permission.

Path variables

id

string required

Request body

application/json

Activity creator update request

Responses

200 200

OK

Body

*/*

Activity list response

GET /v1/activities

This api requires LEAD_ACTIVITIES_VIEW,JOB_ACTIVITIES_VIEW,OPPORTUNITY_ACTIVITIES_VIEW,ACTIVITIES_VIEW,LEAD_ACTIVITIES_VIEW_OWN,JOB_ACTIVITIES_VIEW_OWN,OPPORTUNITY_ACTIVITIES_VIEW_OWN,ACTIVITIES_VIEW_OWN permission.

Request parameters

activity_date.start

integer int64 optional

activity_date.end

integer int64 optional

search

string optional

user_id

string optional

organization_id

string optional

serviceId

string optional

status

array of string optional

pageable

Pageable required

Responses

200 200

OK

Body

*/*

Page activity list response

POST /v1/activities

This api requires LEAD_ACTIVITIES_MANAGE,JOB_ACTIVITIES_MANAGE,OPPORTUNITY_ACTIVITIES_MANAGE,ACTIVITIES_MANAGE permission.

Request body

application/json

Array of Activity request

Responses

200 200

OK

Body

*/*

Array of Activity list response

GET /v1/users/{id}/activities

This api requires LEAD_ACTIVITIES_VIEW,JOB_ACTIVITIES_VIEW,OPPORTUNITY_ACTIVITIES_VIEW,ACTIVITIES_VIEW,ACTIVITIES_VIEW_OWN permission.

Path variables

id

string required

Request parameters

event_date.start

integer int64 optional

event_date.end

integer int64 optional

status

array of string optional

pageable

Pageable required

Responses

200 200

OK

Body

*/*

Page activity response

GET /v1/engagements/{id}/activities

This api requires LEAD_ACTIVITIES_VIEW,JOB_ACTIVITIES_VIEW,OPPORTUNITY_ACTIVITIES_VIEW,ACTIVITIES_VIEW,LEAD_ACTIVITIES_VIEW_OWN,JOB_ACTIVITIES_VIEW_OWN,OPPORTUNITY_ACTIVITIES_VIEW_OWN permission.

Path variables

id

string required

Request parameters

event_date.start

integer int64 optional

event_date.end

integer int64 optional

search

string optional

sort_by

string optional

order_by

string optional

page

Pageable required

Responses

200 200

OK

Body

*/*

Page activity list response

GET /v1/activities/{id}/offline

This api requires LEAD_ACTIVITIES_VIEW,JOB_ACTIVITIES_VIEW,OPPORTUNITY_ACTIVITIES_VIEW,ACTIVITIES_VIEW,LEAD_ACTIVITIES_VIEW_OWN,JOB_ACTIVITIES_VIEW_OWN,OPPORTUNITY_ACTIVITIES_VIEW_OWN,ACTIVITIES_VIEW_OWN permission.

Path variables

id

string required

Responses

200 200

OK

Body

*/*

Activity response offline

Update event tasks

PUT /v1/activities/{id}/tasks/{taskId}

null

Path variables

id

string required

taskId

string required

Request body

application/json

Update event task request

Responses

200 200

OK

Body

*/*

Event task response

Update activity resource

PUT /v1/activities/{id}/resources/{resourceId}

Delete activity resource

DELETE /v1/activities/{id}/resources/{resourceId}

Get activity resource

GET /v1/activities/{id}/resources

Add activity resource

POST /v1/activities/{id}/resources

PUT /v1/activities/{id}/resources/{resourceId}

This api requires LEAD_ACTIVITIES_MANAGE,JOB_ACTIVITIES_MANAGE,OPPORTUNITY_ACTIVITIES_MANAGE,ACTIVITIES_MANAGE permission.

Path variables

id

string required

resourceId

string required

Request body

application/json

Update activity resource request

Responses

200 200

OK

Body

*/*

Activity resource response

DELETE /v1/activities/{id}/resources/{resourceId}

This api requires LEAD_ACTIVITIES_MANAGE,JOB_ACTIVITIES_MANAGE,OPPORTUNITY_ACTIVITIES_MANAGE,ACTIVITIES_MANAGE permission.

Path variables

id

string required

resourceId

string required

Responses

200 200

OK

GET /v1/activities/{id}/resources

This api requires LEAD_ACTIVITIES_VIEW,JOB_ACTIVITIES_VIEW,OPPORTUNITY_ACTIVITIES_VIEW,ACTIVITIES_VIEW permission.

Path variables

id

string required

Responses

200 200

OK

Body

*/*

Array of Activity resource response

POST /v1/activities/{id}/resources

This api requires LEAD_ACTIVITIES_MANAGE,JOB_ACTIVITIES_MANAGE,OPPORTUNITY_ACTIVITIES_MANAGE,ACTIVITIES_MANAGE permission.

Path variables

id

string required

Request body

application/json

Activity resource request

Responses

200 200

OK

Body

*/*

Activity resource response

Get losses_2

GET /v1/3d/segments/{segment}/losses

Update losses_2

PUT /v1/3d/segments/{segment}/losses

GET /v1/3d/segments/{segment}/losses

This api requires LEAD_DESIGNS_VIEW,JOB_DESIGNS_VIEW,OPPORTUNITY_DESIGNS_VIEW permission.

Path variables

segment

string required

Responses

200 200

OK

Body

*/*

Loss request

PUT /v1/3d/segments/{segment}/losses

This api requires LEAD_DESIGNS_MANAGE,JOB_DESIGNS_MANAGE,OPPORTUNITY_DESIGNS_MANAGE permission.

Path variables

segment

string required

Request body

application/json

Loss request

Responses

200 200

OK

Body

*/*

Loss request

Get3d groups

GET /v1/3d/segments/{id}/groups

Add3d groups

PUT /v1/3d/segments/{id}/groups

GET /v1/3d/segments/{id}/groups

This api requires LEAD_DESIGNS_VIEW,JOB_DESIGNS_VIEW,OPPORTUNITY_DESIGNS_VIEW permission.

Path variables

id

string required

Responses

200 200

OK

Body

*/*

Array of Segment3d group response

PUT /v1/3d/segments/{id}/groups

This api requires LEAD_DESIGNS_MANAGE,JOB_DESIGNS_MANAGE,OPPORTUNITY_DESIGNS_MANAGE permission.

Path variables

id

string required

Request body

application/json

Array of Segment3d group request

Responses

200 200

OK

Body

*/*

Array of Segment3d group response

Update3d roof segment

PUT /v1/3d/roofs/{id}/segments/{segmentId}

Delete3d roof segment

DELETE /v1/3d/roofs/{id}/segments/{segmentId}

Get3d roof segments

GET /v1/3d/roofs/{id}/segments

Add3d roof segment

POST /v1/3d/roofs/{id}/segments

Get roof elevation tiff_2

GET /v1/3d/roofs/{id}/segments/{segmentId}/elevations

PUT /v1/3d/roofs/{id}/segments/{segmentId}

This api requires LEAD_DESIGNS_MANAGE,JOB_DESIGNS_MANAGE,OPPORTUNITY_DESIGNS_MANAGE permission.

Path variables

id

string required

segmentId

string required

Request body

application/json

Roof3d segment request

Responses

200 200

OK

Body

*/*

Roof3d segment response

DELETE /v1/3d/roofs/{id}/segments/{segmentId}

This api requires LEAD_DESIGNS_MANAGE,JOB_DESIGNS_MANAGE,OPPORTUNITY_DESIGNS_MANAGE permission.

Path variables

id

string required

segmentId

string required

Responses

200 200

OK

GET /v1/3d/roofs/{id}/segments

This api requires LEAD_DESIGNS_VIEW,JOB_DESIGNS_VIEW,OPPORTUNITY_DESIGNS_VIEW permission.

Path variables

id

string required

Responses

200 200

OK

Body

*/*

Array of Roof3d segment response

POST /v1/3d/roofs/{id}/segments

This api requires LEAD_DESIGNS_MANAGE,JOB_DESIGNS_MANAGE,OPPORTUNITY_DESIGNS_MANAGE permission.

Path variables

id

string required

Request body

application/json

Array of Roof3d segment request

Responses

200 200

OK

Body

*/*

Array of Roof3d segment response

GET /v1/3d/roofs/{id}/segments/{segmentId}/elevations

This api requires LEAD_DESIGNS_VIEW,JOB_DESIGNS_VIEW,OPPORTUNITY_DESIGNS_VIEW permission.

Path variables

id

string required

segmentId

string required

Responses

200 200

OK

Body

image/tiff

string byte

Get weather data

GET /v1/weather_data

Save weather data

POST /v1/weather_data

Get available years

GET /v1/weather_data/available_years

GET /v1/weather_data

This api requires WEATHER_DATA_VIEW permission.

Request parameters

radius

number double optional

lat

number optional

lon

number optional

year

string optional

Responses

200 200

OK

Body

*/*

Array of Weather file response

POST /v1/weather_data

This api requires WEATHER_DATA_MANAGE permission.

Request body

application/json

Weather file request

Responses

200 200

OK

Body

*/*

Weather file response

GET /v1/weather_data/available_years

This api requires WEATHER_DATA_MANAGE permission.

Request parameters

integration_id

string required

lat

number required

lon

number required

Responses

200 200

OK

Body

*/*

Available years response

Add task configs

POST /v1/task_config_groups/{id}/task_configs

Get groups

GET /v1/task_config_groups

POST /v1/task_config_groups/{id}/task_configs

This api requires TASKS_CONFIG_MANAGE permission.

Path variables

id

string required

Request body

application/json

Valid list task config request

Responses

200 200

OK

Body

*/*

Array of Task config response

GET /v1/task_config_groups

This api requires TASKS_CONFIG_VIEW permission.

Request parameters

job_type_id

string optional

service_id

string optional

stage_id

string optional

contract_id

string optional

Responses

200 200

OK

Body

*/*

Array of Task config group response

Get routes

GET /v1/stages/{id}/decisions

Add routes

POST /v1/stages/{id}/decisions

Get stage

GET /v1/stages/{id}

Get stage routes

GET /v1/stages/{id}/routes

GET /v1/stages/{id}/decisions

This api requires WORKFLOWS_VIEW permission.

Path variables

id

string required

Request parameters

board_id

string optional

Responses

200 200

OK

Body

*/*

Stage decisions response

POST /v1/stages/{id}/decisions

This api requires WORKFLOWS_VIEW permission.

Path variables

id

string required

Request body

application/json

Route request

Responses

200 200

OK

Body

*/*

Route response

GET /v1/stages/{id}

This api requires WORKFLOWS_VIEW permission.

Path variables

id

string required

Responses

200 200

OK

Body

*/*

Workflow stage

GET /v1/stages/{id}/routes

This api requires WORKFLOWS_VIEW permission.

Path variables

id

string required

Responses

200 200

OK

Body

*/*

Stage route response

Add solar simulation

POST /v1/solar_simulations

This api requires LEAD_DESIGNS_MANAGE,JOB_DESIGNS_MANAGE,OPPORTUNITY_DESIGNS_MANAGE permission.

Request body

application/json

Solar simulation request

Responses

200 200

OK

Migrate financial designs

POST /v1/solar_designs/financial/migrate

This api requires LEAD_DESIGNS_MANAGE,JOB_DESIGNS_MANAGE,OPPORTUNITY_DESIGNS_MANAGE permission.

Responses

200 200

OK

Reingest

POST /v1/sites/{siteId}/reingest

Get energy readings v2

GET /v2/energy_readings

Get site power

GET /v1/sites/{siteId}/power

Get energy summary

GET /v1/sites/{id}/energy_summary

Get power status

GET /v1/power_status

Get power readings

GET /v1/power_readings/{type}

Get energy summary last3h

GET /v1/energy_summary

Get energy summary top10

GET /v1/energy_summary/top10

Get energy summary last3h_1

GET /v1/energy_summary/last3h

Get energy summary generation

GET /v1/energy_summary/generation

Get energy readings_2

GET /v1/energy_readings

Get energy reading

GET /v1/energy_readings/{type}

POST /v1/sites/{siteId}/reingest

This api requires ENERGY_READING_MANAGE permission.

Path variables

siteId

string required

Request body

application/json

Reingest request

Responses

200 200

OK

GET /v2/energy_readings

This api requires ENERGY_READING_VIEW permission.

Request parameters

site_id

string optional

meter_id

string optional

unit

string optional

Enumeration:

HALF_HOUR

HOUR

DAY

WEEK

MONTH

YEAR

TOTAL

start_date

string date-time optional

end_date

string date-time optional

reading_type

array of string optional

split_inverters

boolean optional

Responses

200 200

OK

Body

*/*

Energy readings response

GET /v1/sites/{siteId}/power

This api requires ENERGY_READING_VIEW,SELF_CONTACT_MANAGE,SCREEN_SITE_VIEW permission.

Path variables

siteId

string required

Request parameters

start_date

integer int64 required

end_date

integer int64 required

reading_type

array of string optional

Responses

200 200

OK

Body

*/*

Array of Site power response

GET /v1/sites/{id}/energy_summary

This api requires ENERGY_READING_VIEW permission.

Path variables

id

string required

Request parameters

interval

string optional

Enumeration:

HALF_HOUR

HOUR

DAY

WEEK

MONTH

YEAR

TOTAL

Responses

200 200

OK

Body

*/*

Self energy summary response

GET /v1/power_status

This api requires ENERGY_READING_VIEW,SELF_CONTACT_MANAGE,SCREEN_SITE_VIEW permission.

Request parameters

site_id

string optional

meter_id

string optional

Responses

200 200

OK

Body

*/*

Power status response

GET /v1/power_readings/{type}

This api requires ENERGY_READING_VIEW,SELF_CONTACT_MANAGE,SCREEN_SITE_VIEW permission.

Path variables

type

string required

Enumeration:

GENERATION

CHP_GENERATION

EXPORT

GENERATION_CONSUMPTION

SELF_CONSUMPTION

GRID_CONSUMPTION

TOTAL_CONSUMPTION

BATTERY_CHARGE

PV_YIELD

BATTERY_CHARGE_GRID

BATTERY_CHARGE_SOLAR

BATTERY_DISCHARGE

BATTERY_DISCHARGE_SOLAR

BATTERY_DISCHARGE_GRID

EV_CHARGE

EV_POWER

BATTERY_SOC

PV_POWER

GRID_POWER

LOAD_POWER

BATTERY_POWER

AUTOCONSUMPTION_POWER

CHP_POWER

FUEL1_USAGE

FUEL2_USAGE

EXP_GENERATION

EXP_GENERATION_ADJUSTED

PERFORMANCE_RATIO

PERFORMANCE_RATIO_ADJUSTED

SOLAR_AVAILABILITY

PV_OPERATION_TIME

PV_AVAILABLE_TIME

EXP_GENERATION_SIMULATED

PR_SIMULATION

Request parameters

site_id

string optional

meter_id

string optional

start_date

integer int64 required

end_date

integer int64 required

split_inverters

boolean optional

Responses

200 200

OK

Body

*/*

Array of Power reading response

GET /v1/energy_summary

This api requires ENERGY_READING_VIEW permission.

Request parameters

start_date

integer int64 required

end_date

integer int64 required

Responses

200 200

OK

Body

*/*

Array of Energy summary last3h response

GET /v1/energy_summary/top10

This api requires ENERGY_READING_VIEW permission.

Responses

200 200

OK

Body

*/*

Array of Energy summary top10 response

GET /v1/energy_summary/last3h

This api requires ENERGY_READING_VIEW permission.

Responses

200 200

OK

Body

*/*

Array of Energy summary last3h response

GET /v1/energy_summary/generation

This api requires ENERGY_READING_VIEW,SCREEN_SITE_VIEW permission.

Request parameters

site_id

string optional

Responses

200 200

OK

Body

*/*

Energy summary generation response

GET /v1/energy_readings

This api requires ENERGY_READING_VIEW permission.

Request parameters

site_id

string optional

meter_id

string optional

unit

string optional

Enumeration:

HALF_HOUR

HOUR

DAY

WEEK

MONTH

YEAR

TOTAL

start_date

string date-time optional

end_date

string date-time optional

reading_type

array of string optional

split_inverters

boolean optional

Responses

200 200

OK

Body

*/*

Array

Object

GET /v1/energy_readings/{type}

This api requires ENERGY_READING_VIEW permission.

Path variables

type

string required

Enumeration:

GENERATION

CHP_GENERATION

EXPORT

GENERATION_CONSUMPTION

SELF_CONSUMPTION

GRID_CONSUMPTION

TOTAL_CONSUMPTION

BATTERY_CHARGE

PV_YIELD

BATTERY_CHARGE_GRID

BATTERY_CHARGE_SOLAR

BATTERY_DISCHARGE

BATTERY_DISCHARGE_SOLAR

BATTERY_DISCHARGE_GRID

EV_CHARGE

EV_POWER

BATTERY_SOC

PV_POWER

GRID_POWER

LOAD_POWER

BATTERY_POWER

AUTOCONSUMPTION_POWER

CHP_POWER

FUEL1_USAGE

FUEL2_USAGE

EXP_GENERATION

EXP_GENERATION_ADJUSTED

PERFORMANCE_RATIO

PERFORMANCE_RATIO_ADJUSTED

SOLAR_AVAILABILITY

PV_OPERATION_TIME

PV_AVAILABLE_TIME

EXP_GENERATION_SIMULATED

PR_SIMULATION

Request parameters

site_id

string optional

unit

string optional

Enumeration:

HALF_HOUR

HOUR

DAY

WEEK

MONTH

YEAR

TOTAL

start_date

string date-time optional

end_date

string date-time optional

Responses

200 200

OK

Body

*/*

Array of Energy reading response

Get screens

GET /v1/self-service/screens

Add screen

POST /v1/self-service/screens

Get screen

GET /v1/self-service/screens/{id}

Delete screen

DELETE /v1/self-service/screens/{id}

GET /v1/self-service/screens

This api requires SELF_CONTACT_MANAGE permission.

Responses

200 200

OK

Body

*/*

Array of Screen response

POST /v1/self-service/screens

This api requires SELF_CONTACT_MANAGE permission.

Request body

application/json

Screen request

Responses

200 200

OK

Body

*/*

Screen response

GET /v1/self-service/screens/{id}

This api requires SELF_CONTACT_MANAGE permission.

Path variables

id

string required

Responses

200 200

OK

Body

*/*

Screen response

DELETE /v1/self-service/screens/{id}

This api requires SELF_CONTACT_MANAGE permission.

Path variables

id

string required

Responses

200 200

OK

Progress

POST /v1/self-service/engagements/{id}/progress

Get decisions

GET /v1/self-service/engagements/{id}/decisions

POST /v1/self-service/engagements/{id}/progress

This api requires SELF_SERVICE_ENABLEMENT_PROGRESS permission.

Path variables

id

string required

Request body

application/json

Workitem progress request

Responses

200 200

OK

GET /v1/self-service/engagements/{id}/decisions

This api requires SELF_SERVICE_ENABLEMENT_PROGRESS permission.

Path variables

id

string required

Responses

200 200

OK

Body

*/*

Array of Self service route

Get screens_1

GET /v1/screens

Add screen_1

POST /v1/screens

Authenticate

POST /v1/screens/authenticate

Get screen_1

GET /v1/screens/{id}

Delete screen_1

DELETE /v1/screens/{id}

GET /v1/screens

This api requires SCREENS_VIEW permission.

Responses

200 200

OK

Body

*/*

Array of Screen response

POST /v1/screens

This api requires SCREENS_MANAGE permission.

Request body

application/json

Screen request

Responses

200 200

OK

Body

*/*

Screen response

POST /v1/screens/authenticate

null

Request headers

Host

string required

Origin

string optional

Request body

application/json

Screen authenticate request

Responses

200 200

OK

Body

*/*

Screen token

GET /v1/screens/{id}

This api requires SCREENS_VIEW,SCREEN_SITE_VIEW permission.

Path variables

id

string required

Responses

200 200

OK

Body

*/*

Screen response

DELETE /v1/screens/{id}

This api requires SCREENS_MANAGE permission.

Path variables

id

string required

Responses

200 200

OK

Add property organization

POST /v1/properties/{id}/organizations

Delete property organization

DELETE /v1/properties/{id}/organizations/{orgId}

POST /v1/properties/{id}/organizations

This api requires PROPERTIES_MANAGE permission.

Path variables

id

string required

Request body

application/json

Property organization request

Responses

200 200

OK

DELETE /v1/properties/{id}/organizations/{orgId}

This api requires PROPERTIES_MANAGE permission.

Path variables

id

string required

orgId

string required

Responses

200 200

OK

Get energy consumption

GET /v1/properties/{id}/energy_consumption/{type}

Create energy consumption

POST /v1/properties/{id}/energy_consumption/{type}

GET /v1/properties/{id}/energy_consumption/{type}

This api requires PROPERTIES_VIEW,PROPERTIES_VIEW_OWN permission.

Path variables

id

string required

type

string required

Enumeration:

ELECTRICITY

GAS

Request parameters

unit

string required

Enumeration:

YEAR

QUARTER

MONTH

meter_id

array of string optional

Responses

200 200

OK

Body

*/*

Array of Energy consumption

POST /v1/properties/{id}/energy_consumption/{type}

This api requires PROPERTIES_MANAGE permission.

Path variables

id

string required

type

string required

Enumeration:

ELECTRICITY

GAS

Request body

application/json

Array of Energy consumption

Responses

200 200

OK

Add project organizations

POST /v1/projects/{id}/organizations/{organizationId}

Delete project organizations

DELETE /v1/projects/{id}/organizations/{organizationId}

Get project organizations

GET /v1/projects/{id}/organizations

POST /v1/projects/{id}/organizations/{organizationId}

This api requires PROJECTS_MANAGE permission.

Path variables

id

string required

organizationId

string required

Responses

200 200

OK

DELETE /v1/projects/{id}/organizations/{organizationId}

This api requires PROJECTS_MANAGE permission.

Path variables

id

string required

organizationId

string required

Responses

200 200

OK

GET /v1/projects/{id}/organizations

This api requires PROJECTS_VIEW permission.

Path variables

id

string required

Responses

200 200

OK

Body

*/*

Array of Id name

Add organization job types

POST /v1/organizations/{id}/job_types

This api requires JOB_TYPES_MANAGE permission.

Path variables

id

string required

Request body

application/json

Valid list organization job type request

Responses

200 200

OK

Body

*/*

Array of Id name description

Create solar quote

POST /v1/jobs/{id}/solar_quote

Get solar options

GET /v1/solar_designs/{id}/solar_options

Get default solar options

GET /v1/properties/{id}/solar_options

Get design options

GET /v1/designs/{id}/solar_options

POST /v1/jobs/{id}/solar_quote

This api requires LEAD_DESIGNS_MANAGE,JOB_DESIGNS_MANAGE,OPPORTUNITY_DESIGNS_MANAGE permission.

Path variables

id

string required

Request body

application/json

Quote request

Responses

200 200

OK

GET /v1/solar_designs/{id}/solar_options

This api requires LEAD_DESIGNS_VIEW,JOB_DESIGNS_VIEW,OPPORTUNITY_DESIGNS_VIEW,PUBLIC_SOLAR_OPTIONS_VIEW permission.

Path variables

id

string required

Request parameters

quote_category

string optional

annual_cost

number optional

annual_usage_kwh

number optional

panel_count

integer int32 optional

panel_product_id

string optional

force_components

boolean optional

Responses

200 200

OK

Body

*/*

Solar options response

GET /v1/properties/{id}/solar_options

This api requires PROPERTIES_VIEW,PUBLIC_SOLAR_OPTIONS_VIEW permission.

Path variables

id

string required

Request parameters

quote_category

string optional

annual_cost

number optional

annual_usage_kwh

number optional

panel_count

integer int32 optional

panel_product_id

string optional

force_components

boolean optional

Responses

200 200

OK

Body

*/*

Solar options response

GET /v1/designs/{id}/solar_options

This api requires LEAD_DESIGNS_VIEW,JOB_DESIGNS_VIEW,OPPORTUNITY_DESIGNS_VIEW,PUBLIC_SOLAR_OPTIONS_VIEW permission.

Path variables

id

string required

Request parameters

quote_category

string optional

annual_cost

number optional

annual_usage_kwh

number optional

panel_count

integer int32 optional

panel_product_id

string optional

force_components

boolean optional

Responses

200 200

OK

Body

*/*

Solar options response

Recalculate solar design

POST /v1/interservice/solar_design/recalculate

Recalculate solar design_1

POST /v1/interservice/solar_design/recalculate/{id}

Recalculate solar design from

POST /v1/interservice/solar_design/recalculate/from/{id}

POST /v1/interservice/solar_design/recalculate

null

Responses

200 200

OK

POST /v1/interservice/solar_design/recalculate/{id}

null

Path variables

id

string required

Responses

200 200

OK

POST /v1/interservice/solar_design/recalculate/from/{id}

null

Path variables

id

string required

Responses

200 200

OK

Backfill weather

POST /v1/internal/sites/{id}/backfill_weather

Get weather history

GET /v1/sites/{id}/weather_history

POST /v1/internal/sites/{id}/backfill_weather

null

Path variables

id

integer int64 required

Responses

200 200

OK

GET /v1/sites/{id}/weather_history

This api requires SITES_VIEW permission.

Path variables

id

string required

Request parameters

source

string optional

Enumeration:

PYRANOMETER

OPENMETEO

start_date

integer int64 required

end_date

integer int64 required

aggregation

string optional

Enumeration:

SINGLE

HOUR

DAY

WEEK

MONTH

YEAR

TOTAL

Responses

200 200

OK

Body

*/*

Site past weather response

Generate

POST /v1/internal/exp/gen

null

Request parameters

start

integer int64 required

Responses

200 200

OK

Get evidence categories

GET /v1/evidence_category

Add evidence categories

POST /v1/evidence_category

GET /v1/evidence_category

This api requires EVIDENCE_CATEGORY_VIEW,EVIDENCE_VIEW permission.

Request parameters

engagement_id

string optional

is_default

boolean optional

job_type_id

array of string optional

parent_id

string optional

include_children

boolean optional

Responses

200 200

OK

Body

*/*

Array of Evidence category response

POST /v1/evidence_category

This api requires EVIDENCE_CATEGORY_MANAGE permission.

Request body

application/json

Evidence category request

Responses

200 200

OK

Body

*/*

Evidence category response

Get engagement quote

GET /v1/engagements/{id}/quotes

Create engagement quote

POST /v1/engagements/{id}/quotes

GET /v1/engagements/{id}/quotes

This api requires LEAD_QUOTES_VIEW,JOB_QUOTES_VIEW,OPPORTUNITY_QUOTES_VIEW permission.

Path variables

id

string required

Responses

200 200

OK

Body

*/*

Array of Quote summary response

POST /v1/engagements/{id}/quotes

This api requires LEAD_QUOTES_MANAGE,JOB_QUOTES_MANAGE,OPPORTUNITY_QUOTES_MANAGE permission.

Path variables

id

string required

Request body

application/json

Quote request with design

Responses

200 200

OK

Body

*/*

Quote response

Get engagement partners

GET /v1/engagements/{id}/partners

Create engagement partner

POST /v1/engagements/{id}/partners

Delete engagement partner

DELETE /v1/engagements/{id}/partners/{partnerId}

GET /v1/engagements/{id}/partners

This api requires JOB_PARTNERS_VIEW,LEAD_PARTNERS_VIEW,OPPORTUNITY_PARTNERS_VIEW,JOBS_VIEW_OWN permission.

Path variables

id

string required

Responses

200 200

OK

Body

*/*

Array of Engagement partner response

POST /v1/engagements/{id}/partners

This api requires JOB_PARTNERS_MANAGE,LEAD_PARTNERS_MANAGE,OPPORTUNITY_PARTNERS_MANAGE permission.

Path variables

id

string required

Request body

application/json

Engagement organization request

Responses

200 200

OK

Body

*/*

Engagement partner response

DELETE /v1/engagements/{id}/partners/{partnerId}

This api requires JOB_PARTNERS_MANAGE,LEAD_PARTNERS_MANAGE,OPPORTUNITY_PARTNERS_MANAGE permission.

Path variables

id

string required

partnerId

string required

Responses

200 200

OK

Get custom forms

GET /v1/engagements/{id}/custom_forms

Save custom form

POST /v1/engagements/{id}/custom_forms

Attach custom form

POST /v1/engagements/{id}/custom_forms/{cid}

Detach custom form

DELETE /v1/engagements/{id}/custom_forms/{cid}

GET /v1/engagements/{id}/custom_forms

This api requires LEAD_CUSTOM_FORMS_VIEW,JOB_CUSTOM_FORMS_VIEW,OPPORTUNITY_CUSTOM_FORMS_VIEW,JOBS_VIEW_OWN permission.

Path variables

id

string required

Request parameters

job_type_id

array of string optional

campaign_id

string optional

project_id

string optional

is_job

boolean optional

owner_id

string optional

Responses

200 200

OK

Body

*/*

Array of Engagement custom form response

POST /v1/engagements/{id}/custom_forms

This api requires LEAD_CUSTOM_FORMS_MANAGE,JOB_CUSTOM_FORMS_MANAGE,OPPORTUNITY_CUSTOM_FORMS_MANAGE permission.

Path variables

id

string required

Request body

application/json

Array of Id

Responses

200 200

OK

Body

*/*

Array of Engagement custom form response

POST /v1/engagements/{id}/custom_forms/{cid}

This api requires LEAD_CUSTOM_FORMS_MANAGE,JOB_CUSTOM_FORMS_MANAGE,OPPORTUNITY_CUSTOM_FORMS_MANAGE permission.

Path variables

id

string required

cid

string required

Responses

200 200

OK

DELETE /v1/engagements/{id}/custom_forms/{cid}

This api requires LEAD_CUSTOM_FORMS_MANAGE,JOB_CUSTOM_FORMS_MANAGE,OPPORTUNITY_CUSTOM_FORMS_MANAGE permission.

Path variables

id

string required

cid

string required

Responses

200 200

OK

Get costs

GET /v1/engagements/{id}/costs

Create cost

POST /v1/engagements/{id}/costs

GET /v1/engagements/{id}/costs

This api requires JOB_COSTS_VIEW permission.

Path variables

id

string required

Responses

200 200

OK

Body

*/*

Array of Cost

POST /v1/engagements/{id}/costs

This api requires JOB_COSTS_MANAGE permission.

Path variables

id

string required

Request body

application/json

Cost request

Responses

200 200

OK

Body

*/*

Cost

Add engagement evidence

POST /v1/engagements/{engagementId}/evidence

Send evidence

POST /v1/engagements/{engagementId}/evidence/{id}/send

Delete engagement evidence

DELETE /v1/engagements/{engagementId}/evidence/{id}

POST /v1/engagements/{engagementId}/evidence

This api requires LEAD_EVIDENCE_MANAGE,JOB_EVIDENCE_MANAGE,OPPORTUNITY_EVIDENCE_MANAGE permission.

Path variables

engagementId

string required

Request body

application/json

Array of Id

Responses

200 200

OK

POST /v1/engagements/{engagementId}/evidence/{id}/send

This api requires LEAD_EVIDENCE_MANAGE,JOB_EVIDENCE_MANAGE,OPPORTUNITY_EVIDENCE_MANAGE permission.

Path variables

engagementId

string required

id

string required

Request body

application/json

Send evidence request

Responses

200 200

OK

DELETE /v1/engagements/{engagementId}/evidence/{id}

This api requires LEAD_EVIDENCE_MANAGE,JOB_EVIDENCE_MANAGE,OPPORTUNITY_EVIDENCE_MANAGE permission.

Path variables

engagementId

string required

id

string required

Responses

200 200

OK

Create evidence

POST /v1/engagements/{engagementId}/evidence/generate

This api requires LEAD_DESIGNS_MANAGE,JOB_DESIGNS_MANAGE,OPPORTUNITY_DESIGNS_MANAGE permission.

Path variables

engagementId

string required

Request body

application/json

Solar evidence request

Responses

200 200

OK

Body

*/*

Evidence response

Generate bill

POST /v1/energy_bills

This api requires ENERGY_BILLS_MANAGE permission.

Request body

application/json

Bill generation request

Responses

200 200

OK

Body

*/*

Bill response

Add design meter

POST /v1/designs/{id}/meters/{meterId}

Delete design meter

DELETE /v1/designs/{id}/meters/{meterId}

Get design meters

GET /v1/designs/{id}/meters

POST /v1/designs/{id}/meters/{meterId}

This api requires LEAD_DESIGNS_MANAGE,JOB_DESIGNS_MANAGE,OPPORTUNITY_DESIGNS_MANAGE permission.

Path variables

id

string required

meterId

string required

Responses

200 200

OK

Body

*/*

Property meter response

DELETE /v1/designs/{id}/meters/{meterId}

This api requires LEAD_DESIGNS_MANAGE,JOB_DESIGNS_MANAGE,OPPORTUNITY_DESIGNS_MANAGE permission.

Path variables

id

string required

meterId

string required

Responses

200 200

OK

GET /v1/designs/{id}/meters

This api requires LEAD_DESIGNS_MANAGE,JOB_DESIGNS_MANAGE,OPPORTUNITY_DESIGNS_MANAGE permission.

Path variables

id

string required

Responses

200 200

OK

Body

*/*

Array of Property meter response

Create load

POST /v1/designs/{id}/loads

This api requires LEAD_DESIGNS_MANAGE,JOB_DESIGNS_MANAGE,OPPORTUNITY_DESIGNS_MANAGE permission.

Path variables

id

string required

Request body

application/json

Array of Roof load request

Responses

200 200

OK

Reconfigure

POST /v1/connector/integration/{integration}/reconfigure

Execute

POST /v1/connector/integration/{integration}/execute/{action}

Enable

POST /v1/connector/integration/{integration}/enable

Disable

POST /v1/connector/integration/{integration}/disable

Get action config

POST /v1/connector/config/action/{action}

Get list values

POST /v1/connector/config/action/{action}/list/{param}

Get connector configs

GET /v1/connector/config/connector

Get action types

GET /v1/connector/config/actions

POST /v1/connector/integration/{integration}/reconfigure

null

Path variables

integration

string required

Request body

application/json

Connector request

Responses

200 200

OK

POST /v1/connector/integration/{integration}/execute/{action}

null

Path variables

action

string required

Enumeration:

SOLAR_QUOTE_CREATE

WORKITEM_PROGRESS

CREATE_TASK

COMPLETE_TASK

GENERATE_EVIDENCE

SIGN_EVIDENCE

Request body

application/json

Connector request

Responses

200 200

OK

Body

*/*

Object

POST /v1/connector/integration/{integration}/enable

null

Path variables

integration

string required

Request body

application/json

Connector request

Responses

200 200

OK

POST /v1/connector/integration/{integration}/disable

null

Path variables

integration

string required

Request body

application/json

Connector request

Responses

200 200

OK

POST /v1/connector/config/action/{action}

null

Path variables

action

string required

Request body

application/json

Connector request

Responses

200 200

OK

Body

*/*

Array of Param config

POST /v1/connector/config/action/{action}/list/{param}

null

Path variables

action

string required

param

string required

Request parameters

search

string optional

Request body

application/json

Connector request

Responses

200 200

OK

Body

*/*

Array

Object

GET /v1/connector/config/connector

null

Responses

200 200

OK

Body

*/*

Array of Param config

GET /v1/connector/config/actions

null

Responses

200 200

OK

Body

*/*

Array

string

Enumeration:

SOLAR_QUOTE_CREATE

WORKITEM_PROGRESS

CREATE_TASK

COMPLETE_TASK

GENERATE_EVIDENCE

SIGN_EVIDENCE

Get campaigns

GET /v1/campaigns

Add campaigns

POST /v1/campaigns

Delete campaigns

DELETE /v1/campaigns/{id}

GET /v1/campaigns

This api requires CAMPAIGNS_VIEW permission.

Request parameters

owner_id

string optional

Responses

200 200

OK

Body

*/*

Array of Campaign response

POST /v1/campaigns

This api requires CAMPAIGNS_MANAGE permission.

Request body

application/json

Campaign request

Responses

200 200

OK

Body

*/*

Campaign response

DELETE /v1/campaigns/{id}

This api requires CAMPAIGNS_MANAGE permission.

Path variables

id

string required

Responses

200 200

OK

Add campaign organizations

POST /v1/campaigns/{id}/organizations/{organizationId}

Delete campaign organizations

DELETE /v1/campaigns/{id}/organizations/{organizationId}

Get campaign organizations

GET /v1/campaigns/{id}/organizations

POST /v1/campaigns/{id}/organizations/{organizationId}

This api requires CAMPAIGNS_MANAGE permission.

Path variables

id

string required

organizationId

string required

Responses

200 200

OK

DELETE /v1/campaigns/{id}/organizations/{organizationId}

This api requires CAMPAIGNS_MANAGE permission.

Path variables

id

string required

organizationId

string required

Responses

200 200

OK

GET /v1/campaigns/{id}/organizations

This api requires CAMPAIGNS_VIEW permission.

Path variables

id

string required

Responses

200 200

OK

Body

*/*

Array of Id name

Create evidence pack

POST /v1/activities/{id}/evidence_packs

This api requires LEAD_ACTIVITIES_MANAGE,JOB_ACTIVITIES_MANAGE,OPPORTUNITY_ACTIVITIES_MANAGE,ACTIVITIES_MANAGE permission.

Path variables

id

string required

Request body

application/json

Activity pack request

Responses

200 200

OK

Body

*/*

Evidence response

Get sites

GET /v2/sites

Get sub sites

GET /v2/sites/{id}/sites

GET /v2/sites

This api requires SITES_VIEW permission.

Request parameters

search

string optional

status

array of string optional

size.min

number optional

size.max

number optional

page

Pageable required

Responses

200 200

OK

Body

*/*

Page site response v2

GET /v2/sites/{id}/sites

This api requires SITES_VIEW permission.

Path variables

id

string required

Request parameters

search

string optional

page

Pageable required

Responses

200 200

OK

Body

*/*

Page site response v2

Get task configs

GET /v1/task_configs

Get task config

GET /v1/task_configs/{id}

GET /v1/task_configs

This api requires TASKS_CONFIG_VIEW permission.

Request parameters

task_config_group_id

string optional

parent_id

string optional

Responses

200 200

OK

Body

*/*

Array of Task config response

GET /v1/task_configs/{id}

This api requires TASKS_CONFIG_VIEW permission.

Request parameters

id

string required

Responses

200 200

OK

Body

*/*

Task config response

Get sites_1

GET /v1/sites

Get sites_2

GET /v1/sites/{id}

Get sub sites_1

GET /v1/sites/{id}/sites

Get sites summary

GET /v1/sites/summary

Get sites accounts

GET /v1/sites/accounts

GET /v1/sites

This api requires SITES_VIEW permission.

Request parameters

search

string optional

page

Pageable required

Responses

200 200

OK

Body

*/*

Page site response

GET /v1/sites/{id}

This api requires SITES_VIEW permission.

Path variables

id

string required

Responses

200 200

OK

Body

*/*

Site response

GET /v1/sites/{id}/sites

This api requires SITES_VIEW permission.

Path variables

id

string required

Request parameters

search

string optional

page

Pageable required

Responses

200 200

OK

Body

*/*

Page site response

GET /v1/sites/summary

This api requires SITES_VIEW permission.

Responses

200 200

OK

Body

*/*

Site summary response

GET /v1/sites/accounts

This api requires SITES_VIEW permission.

Responses

200 200

OK

Body

*/*

Array of Account summary

Get meters

GET /v1/sites/{sid}/meters/{id}

Get meters_1

GET /v1/sites/{id}/meters

GET /v1/sites/{sid}/meters/{id}

This api requires SITES_VIEW,SELF_CONTACT_MANAGE permission.

Path variables

id

string required

Request parameters

control

array of string required

Responses

200 200

OK

Body

*/*

Meter controls response

GET /v1/sites/{id}/meters

This api requires SITES_VIEW,SELF_CONTACT_MANAGE permission.

Path variables

id

string required

Responses

200 200

OK

Body

*/*

Array of Meter response

Get site weather

GET /v1/sites/{id}/weather_forecast

This api requires SITES_VIEW permission.

Path variables

id

string required

Responses

200 200

OK

Body

*/*

Site weather response

Get site simulation data

GET /v1/sites/simulation_data

This api requires SITES_VIEW permission.

Request parameters

start_date

string date-time optional

end_date

string date-time optional

unit

string required

Enumeration:

HOUR

DAY

WEEK

MONTH

YEAR

site_id

string optional

Responses

200 200

OK

Body

*/*

Site simulation response

Get site details

GET /v1/self-service/sites/details

This api requires SCREEN_SITE_VIEW permission.

Responses

200 200

OK

Body

*/*

Site details

Get energy summary_1

GET /v1/self-service/energy_summary

Get energy readings

GET /v1/self-service/energy_readings

Get energy readings_1

GET /v1/self-service/energy_readings/{type}

GET /v1/self-service/energy_summary

This api requires SELF_CONTACT_MANAGE, SCREEN_SITE_VIEW permission.

Request parameters

site_id

string optional

interval

string optional

Enumeration:

HALF_HOUR

HOUR

DAY

WEEK

MONTH

YEAR

TOTAL

Responses

200 200

OK

Body

*/*

Self energy summary response

GET /v1/self-service/energy_readings

This api requires SELF_CONTACT_MANAGE, SCREEN_SITE_VIEW permission.

Request parameters

site_id

string optional

meter_id

string optional

unit

string optional

Enumeration:

HALF_HOUR

HOUR

DAY

WEEK

MONTH

YEAR

TOTAL

start_date

string date-time optional

end_date

string date-time optional

reading_type

array of string optional

split_inverters

boolean optional

Responses

200 200

OK

Body

*/*

Array

Object

GET /v1/self-service/energy_readings/{type}

This api requires SELF_CONTACT_MANAGE, SCREEN_SITE_VIEW permission.

Path variables

type

string required

Enumeration:

GENERATION

CHP_GENERATION

EXPORT

GENERATION_CONSUMPTION

SELF_CONSUMPTION

GRID_CONSUMPTION

TOTAL_CONSUMPTION

BATTERY_CHARGE

PV_YIELD

BATTERY_CHARGE_GRID

BATTERY_CHARGE_SOLAR

BATTERY_DISCHARGE

BATTERY_DISCHARGE_SOLAR

BATTERY_DISCHARGE_GRID

EV_CHARGE

EV_POWER

BATTERY_SOC

PV_POWER

GRID_POWER

LOAD_POWER

BATTERY_POWER

AUTOCONSUMPTION_POWER

CHP_POWER

FUEL1_USAGE

FUEL2_USAGE

EXP_GENERATION

EXP_GENERATION_ADJUSTED

PERFORMANCE_RATIO

PERFORMANCE_RATIO_ADJUSTED

SOLAR_AVAILABILITY

PV_OPERATION_TIME

PV_AVAILABLE_TIME

EXP_GENERATION_SIMULATED

PR_SIMULATION

Request parameters

site_id

string optional

unit

string optional

Enumeration:

HALF_HOUR

HOUR

DAY

WEEK

MONTH

YEAR

TOTAL

start_date

string date-time optional

end_date

string date-time optional

Responses

200 200

OK

Body

*/*

Array of Energy reading response

Get route

GET /v1/routes/{id}

null

Path variables

id

string required

Responses

200 200

OK

Body

*/*

Routes response

Get contacts

GET /v1/proptech/contacts

This api requires CONTACTS_VIEW permission.

Request parameters

search

string optional

lifecycle_id

string optional

sort_by

string optional

engagement_type

array of string optional

order_by

string optional

pageable

Pageable required

Responses

200 200

OK

Body

*/*

Page proptech contact response

Get cancel reasons

GET /v1/proptech/cancel_reasons

null

Responses

200 200

OK

Body

*/*

Array of Cancel reasons

Get solar performance

GET /v1/properties/{id}/solar_performance

This api requires PROPERTIES_VIEW,PUBLIC_SOLAR_OPTIONS_VIEW permission.

Path variables

id

string required

Responses

200 200

OK

Body

*/*

Solar performance response

Get lexicon values

GET /v1/lexicons/{lexicon}/values

null

Path variables

lexicon

string required

Request parameters

search

string optional

depend_lexicon

string optional

workitem.workflow.id

string optional

workitems.workflow.id

string optional

Responses

200 200

OK

Body

*/*

Array of Id name

Get topics

GET /v1/interservice/ably/authentication

This api requires NOTIFICATIONS_VIEW permission.

Responses

200 200

OK

Body

*/*

Array of string

Get quote engagement

GET /v1/internal/quotes/{id}/engagements

null

Path variables

id

string required

Responses

200 200

OK

Body

*/*

Quote engagement job

Get engagements

GET /v1/engagements

Get engagement supply taxation schemes

GET /v1/engagements/{id}/supply_taxation_scheme

Get access_1

GET /v1/engagements/{id}/partner_suggestions

Get access_2

GET /v1/engagements/{id}/access

Delete engagement organization

DELETE /v1/engagements/engagements/{engagementId}/organizations/{organizationId}

GET /v1/engagements

This api requires ENGAGEMENTS_VIEW,OPPORTUNITIES_VIEW_OWN,JOBS_VIEW_OWN permission.

Request parameters

search

string optional

engagement_type

string optional

Enumeration:

OPPORTUNITY

JOB

LEAD

pageable

Pageable required

Responses

200 200

OK

Body

*/*

Page engagement details response

GET /v1/engagements/{id}/supply_taxation_scheme

This api requires ENGAGEMENTS_VIEW permission.

Path variables

id

string required

Responses

200 200

OK

Body

*/*

Supply taxation schemes response

GET /v1/engagements/{id}/partner_suggestions

This api requires PROPERTY_ENGAGEMENTS_VIEW permission.

Path variables

id

string required

Request parameters

job_type_id

array of string optional

Responses

200 200

OK

Body

*/*

Array of Partner suggestion

GET /v1/engagements/{id}/access

This api requires PROPERTY_ENGAGEMENTS_VIEW permission.

Path variables

id

string required

Request parameters

team_id

string optional

search

string optional

Responses

200 200

OK

Body

*/*

Array of Id name avatar url

DELETE /v1/engagements/engagements/{engagementId}/organizations/{organizationId}

This api requires LEAD_ORGANIZATION_MANAGE,JOB_ORGANIZATION_MANAGE,OPPORTUNITY_ORGANIZATION_MANAGE permission.

Path variables

engagementId

string required

organizationId

string required

Responses

200 200

OK

Get consumption patterns

GET /v1/energy_consumption_patterns

null

Request parameters

class_type

string optional

Enumeration:

COMMERCIAL

RESIDENTIAL

BLOCK

LAND

commercial_type

string optional

Enumeration:

OFFICES

RETAIL

INDUSTRIAL

LEISURE

HEALTHCARE

EDUCATIONAL

NURSERY

CAR_PARK

SHOPPING_CENTRE

MIXED

BUSINESS_PARK

LIBRARY

RESIDENTIAL

Responses

200 200

OK

Body

*/*

Array of Id name

Get custom forms_1

GET /v1/custom_forms

This api requires JOBS_VIEW,LEADS_VIEW,OPPORTUNITIES_VIEW permission.

Request parameters

job_type_id

array of string optional

campaign_id

string optional

project_id

string optional

is_job

boolean optional

is_opportunity

boolean optional

is_lead

boolean optional

engagement_id

string optional

owner_id

string optional

Responses

200 200

OK

Body

*/*

Array of Custom fields form response

Get available groups

GET /v1/available_columns/{entity}

null

Path variables

entity

string required

Request parameters

search

string optional

Responses

200 200

OK

Body

*/*

Available column response

Get availabilities

GET /v1/availability

null

Request parameters

service_id

array of string optional

user_id

array of string optional

organization_id

array of string optional

region_id

string optional

resource_type

string optional

Enumeration:

ORGANIZATION

USER

TEAM

activity_date.start

integer int64 required

activity_date.end

integer int64 required

Responses

200 200

OK

Body

*/*

Array of Availability response

Get account site

GET /v1/accounts/{id}/sites

This api requires SITES_VIEW,SELF_CONTACT_MANAGE permission.

Path variables

id

string required

Responses

200 200

OK

Body

*/*

Site response

Get account tariffs

GET /v1/accounts/{id}/energy_tariffs

This api requires ENERGY_TARIFFS_VIEW,SELF_CONTACT_MANAGE permission.

Path variables

id

string required

Responses

200 200

OK

Body

*/*

Array of Account energy tariff response

Get energy revenue

GET /v1/accounts/{accountId}/energy_revenue

This api requires ACCOUNTS_VIEW,SELF_CONTACT_MANAGE permission.

Path variables

accountId

string required

Request parameters

start_date

string date-time required

unit

string required

Enumeration:

HALF_HOUR

HOUR

DAY

WEEK

MONTH

YEAR

TOTAL

site_id

string optional

end_date

string date-time required

Responses

200 200

OK

Body

*/*

Account revenue response

Object

field

string

message

string

Object

is4xxClientError

boolean

is5xxServerError

boolean

is1xxInformational

boolean

is2xxSuccessful

boolean

is3xxRedirection

boolean

error

boolean

Object

response

string

error_code

Http status code

error_description

string

field_errors

Array of Field error message

Object

suspend_until

string date-time required

Object

id

string

country_code

string

postcode

string

city

string

line1

string

line2

string

line3

string

is_billing

boolean

is_residential

boolean

is_postal

boolean

location

Location

formatted_address

string

state

string

is_primary

boolean

Object

id

string

name

string

emails

Array of Contact email response

phones

Array of Contact phone response

addresses

Array of Contact address response

Object

id

string

value

string

is_primary

boolean

email_type

string

Enumeration:

WORK

PERSONAL

Object

id

string

contact_type

string

Enumeration:

LANDLINE

MOBILE

value

string

is_primary

boolean

phone_type

string

Enumeration:

WORK

PERSONAL

country_code

string

Object

emitter_total_output

number

pump_capacity

number

Object

panels

integer int32

batteries

integer int32

inverters

integer int32

system_size

number double

annual_production

number double

annual_export

number double

battery_capacity

number double

autoconsumption

number double

consumption

number double

estimator

string

Enumeration:

MCS

PVWATTS

SAM

IMPORTED

Object

id

string

engagement_type

string

Enumeration:

OPPORTUNITY

JOB

LEAD

name

string

contact

Contact

property

Property summary

project

Id name code

engagement_value

Engagement value

expected_completion

string date-time

deadline

string date-time

job

Engagement job response

opportunity

Engagement opportunity response

workitems

Array of Workitem engagement response

Object

name

string

job_type

Job type response

job_number

string

po_number

string

job_description

string

contract_agreed_amount

number

completion_date

string date-time

Object

id

string

name

string

job_types

Array of Job type response

opportunity_number

string

opportunity_description

string

probability

integer int32

closed_date

string date-time

budget

number

decision_maker

Id

Object

amount

number

currency

string

contracted_amount

number

Object

lexicon

string

value

string

name

string

icon

string

data_type

string

Enumeration:

TEXT

DATETIME

IMAGE

Object

id

string required

Object

id

string

name

string

avatar_url

string

Object

id

string

name

string

code

string

Object

id

string

name

string

Object

id

string

name

string

description

string

quote_category

string

category

string

Enumeration:

SERVICE

IMPROVEMENT

default_size_unit

string

Enumeration:

KW

SQM

owner

Id name

Object

hour

integer int32

minute

integer int32

second

integer int32

nano

integer int32

Object

lat

number required

lon

number required

Object

id

string

name

string

formatted_address

string

location

Location

Object

start

Local time

end

Local time

suspended_date

string date-time

Object

id

string

name

string

design_type

string

Enumeration:

SOLAR

SOLAR_3D

ASHP

solar

Design data

ashp

Design ashp response

design_image_url

string

Object

id

string

workflow

Workitem stage

stage

Workitem stage

visibility

Visible request

owners

Array of Workitem owner response

Object

id

string

user

Id name avatar url

organization

Id name

transferred_date

string date-time

Object

id

string

engagement

Engagement

workflow

Workitem stage

stage

Workitem stage

visibility

Visible request

design

Workitem design summary

owners

Array of Workitem owner response

tasks

Workitem tasks number response

extra_data

Array of Extra data

Object

id

string

name

string

arrived

string date-time

Object

all

integer int64

completed

integer int64

Object

user

Id

organization

Id

Array of User organization request

Object

name

string required

description

string required

allow_job

boolean

allow_opportunity

boolean

Object

id

string

name

string

stage_type

string

Enumeration:

CREATOR

SPLIT

RENDEZVOUS

NORMAL

TRANSITION

ARCHIVE

AGGREGATOR

handle

string

Object

id

string

name

string

description

string

color

string

priority

integer int32

probability

integer int32

status

string

Enumeration:

OPEN

WON

LOST

CONVERTED

COMPLETE

is_collaborative

boolean

Object

id

string

name

string

description

string

from_stage

Array of Id name stage type

to_stage

Id name stage type

is_default

boolean

ignore_tasks

boolean

is_active

boolean

autoroute_after_days

integer int32

Object

id

string

name

string

description

string

allow_job

boolean

allow_opportunity

boolean

stages

Array of Workflow stage

Object

id

string

name

string

description

string

stage_type

string

Enumeration:

CREATOR

SPLIT

RENDEZVOUS

NORMAL

TRANSITION

ARCHIVE

AGGREGATOR

estimated_duration

integer int32

priority

integer int32

x

integer int32

y

integer int32

lifecycle

Lifecycle response

routes

Array of Stage route

split

Id name

is_collaborative

boolean

Object

id

string required

handle

string

is_active

boolean

Object

from_stage

Id required

to_stage

Id required

Object

id

string required

name

string required

is_default

boolean required

to_stage

Id handle

autoroute_after_days

integer int32

ignore_tasks

boolean

task_complete_autoroute

boolean

from_stage

Array of Id handle required

Object

id

string required

name

string

description

string

stage_type

string

Enumeration:

CREATOR

SPLIT

RENDEZVOUS

NORMAL

TRANSITION

ARCHIVE

AGGREGATOR

estimated_duration

integer int32

priority

integer int32

x

integer int32

y

integer int32

lifecycle

Id

selfservice_allowed

boolean

split

Id

is_collaborative

boolean

Object

stages

Array of Workflow stage request required

routes

Array of Workflow route request required

transitions

Array of Transition request

Object

lifecycle

string required

Enumeration:

ACTIVE

INACTIVE

Object

board

Id required

priority

integer int32 required

Object

duration

integer int32 required

units

string required

Enumeration:

MINUTES

HOURS

DAYS

WEEKS

MONTHS

Object

id

string

evidence_config

Id required

timeline

string required

Enumeration:

BEFORE

DURING

AFTER

ONCE

is_required

boolean required

Object

service

Id

assignee

Id

name

string required

description

string

due_date

string date-time

activity

Id

engagement

Id

priority

string required

Enumeration:

VERY_LOW

LOW

MEDIUM

HIGH

VERY_HIGH

ANY

parent

Id

team

Id

task_type

string required

Enumeration:

SCHEDULE

EMAIL

CALL

BASIC

FILES

estimated

Estimated

evidence

Array of Update task evidence request

Object

lead_number

string

description

string

job_types

Array of Job type response

lifecycle

Id name

lead_owner

Id name avatar url

owner

Id

Object

id

string

name

string

description

string

estimated

Estimated

progress

Progress

subtask_count

integer int32

evidence_count

Evidence count

due_date

string date-time

service

Id name

assignee

Id name

team

Id name

priority

string

Enumeration:

VERY_LOW

LOW

MEDIUM

HIGH

VERY_HIGH

ANY

task_type

string

Enumeration:

SCHEDULE

EMAIL

CALL

BASIC

FILES

created_on

string date-time

engagement

Task engagement summary

Object

before

integer int32

during

integer int32

after

integer int32

once

integer int32

Object

start_date

string date-time

completed_date

string date-time

status

string

Enumeration:

BLOCKED

TODO

STARTED

COMPLETE

NOT_APPLICABLE

Object

id

string

stage

Id name

days_in_process

integer int64

days_in_stage

integer int64

Object

id

string

name

string

job_number

string

property

Property summary

engagement_type

string

Enumeration:

OPPORTUNITY

JOB

LEAD

job

Engagement job response

opportunity

Engagement opportunity response

lead

Engagement lead response

workitems

Array of Property engagement workitem response

Object

standing_charge

number required

rates

Array of Energy rate

Object

start_time

Local time required

end_time

Local time required

start_day

integer int32 required

end_day

integer int32 required

charge_type

string required

Enumeration:

AUTOCONSUMPTION

EXPORT

GRID

price_per_kwh

number required

platform_fee_included_in_rate

boolean

installer_fee_included_in_rate

boolean

secure_revenue

boolean

platform_fee

number

installer_fee

number

inflation_rate

number

Object

hardware_cost_per_kw

number required

service_cost_per_kw

number required

finance_amount

number

finance_type

string required

Enumeration:

PPA

LEASE

payback_period

number double

apr

number double

energy_cost

Energy cost required

finance_period_months

integer int32

contract_length_months

integer int32 required

is_override

boolean required

amortization_rate

number

commission_pct

number

commission_per_kw

number

amortization_threshold_pct

number

amortization_type

string

Enumeration:

FIXED

VARIABLE

balloon_amount

number

sales_total

number

sales_total_kwp

number

opex

Array of Ppa opex request

Object

cost

number

cost_basis

string required

Enumeration:

FIXED_MONTHLY

FIXED_ANNUAL

SYSTEM_SIZE

GENERATION

CONSUMPTION

INSTALL_COST

term_years

integer int32 required

cost_type

string required

Enumeration:

INSURANCE

O_M

CONSULTANCY_FEE

Object

id

string

service_cost_per_kw

number

finance_type

string

Enumeration:

PPA

LEASE

payback_period

number

apr

number double

energy_cost

Energy cost

system_cost

number

export_revenue

number

ppa_revenue

number

finance_period_months

integer int32

contract_length_months

integer int32

total_install_cost

number

total_funding_required

number

dscr

number

annual_opex

number

hardware_cost

number

service_cost

number

excluded_cost

number

annual_net_revenue

number

annual_gross_revenue

number

total_annual_cost

number

is_override

boolean

amortization_rate

number

amortization_threshold_pct

number

amortization_type

string

Enumeration:

FIXED

VARIABLE

hardware_cost_per_kw

number

commission_pct

number

commission_per_kw

number

finance_amount

number

interest_payments

number

balloon_amount

number

sales_total

number

sales_total_kwp

number

opex

Array of Ppa opex response

Object

id

string

cost

number

avg_annual_cost

number

worst_annual_cost

number

dscr_annual_cost

number

total_cost

number

cost_basis

string

Enumeration:

FIXED_MONTHLY

FIXED_ANNUAL

SYSTEM_SIZE

GENERATION

CONSUMPTION

INSTALL_COST

term_years

integer int32

cost_type

string

Enumeration:

INSURANCE

O_M

CONSULTANCY_FEE

Object

left

number

right

number

top

number

bottom

number

Object

boundary

Array of Location required

area

number double

azimuth

number double

grid_alignment

number double

pitch

number double

panel_grid

Array of Location

center

Location

rack_type

string

Enumeration:

FLUSH

TILTED

DUAL_TILT

rack_orientation

string

Enumeration:

LANDSCAPE

PORTRAIT

roof_type

string

Enumeration:

ASPHALT_SHINGLE_COMPOSITION

CONCRETE_TILE

CLAY_TILE

SLATE_TILE

FLAT_ROOF

METAL_STANDING_SEAM

METAL_SHINGLE

METAL_STONE_COATED

KLIPLOCK

MEMBRANE_ROOFING

TAR_AND_GRAVEL_BITUMEN

THATCHED

WOOD_SHAKE_SHINGLE

GREEN_ROOF

OTHER

alignment_line

Array of Location

border

Border

Object

boundary

Array of Location required

area

number double

pitch

number double

azimuth

number double

grid_alignment

number double

panels_count

integer int32

yearly_energy

number double

Object

id

string

segment

integer int32

plane_height

number double

center

Location

sunshine_hours

integer int32

sunshine_quantiles

Array

integer int32

manual

Roof common data

imported

Roof common data

panel_grid

Array of Location

rack_orientation

string

Enumeration:

LANDSCAPE

PORTRAIT

border

Border

rack_type

string

Enumeration:

FLUSH

TILTED

DUAL_TILT

roof_type

string

Enumeration:

ASPHALT_SHINGLE_COMPOSITION

CONCRETE_TILE

CLAY_TILE

SLATE_TILE

FLAT_ROOF

METAL_STANDING_SEAM

METAL_SHINGLE

METAL_STONE_COATED

KLIPLOCK

MEMBRANE_ROOFING

TAR_AND_GRAVEL_BITUMEN

THATCHED

WOOD_SHAKE_SHINGLE

GREEN_ROOF

OTHER

alignment_line

Array of Location

Object

id

string

center

Location required

capacity

number double required

orientation

string required

Enumeration:

LANDSCAPE

PORTRAIT

width

number double required

height

number double required

row

integer int32

column

integer int32

boundary

Array of Location

Object

id

string

center

Location

orientation

string

Enumeration:

LANDSCAPE

PORTRAIT

capacity

number double

width

number double

height

number double

yearly_energy

number double

roof

Id

row

integer int32

column

integer int32

boundary

Array of Location

Object

boundary

Array of Location required

Object

id

string

boundary

Array of Location

Object

x

number double

y

number double

z

number double

Object

roof_type

string required

Enumeration:

SINGLE_HIP

FLAT

DUAL

SINGLE_SLOPE

DOUBLE_HIP

gutters

Array of Point3d required

ridges

Array of Point3d required

boundaries

Array of Point3d required

Object

id

string

roof_type

string

Enumeration:

SINGLE_HIP

FLAT

DUAL

SINGLE_SLOPE

DOUBLE_HIP

gutters

Array of Point3d

ridges

Array of Point3d

boundaries

Array of Point3d

Object

category

string required

Enumeration:

SOILING

SHADING

SNOW

MISMATCH

WIRING

CONNECTIONS

DEGRADATION

NAMEPLATE

AGE

AVAILABILITY

loss_pct

number double

Object

category

string

Enumeration:

SERVICE

IMPROVEMENT

owner

Id name

default_size_unit

string

Enumeration:

KW

SQM

system_size

number

value

number

Object

id

string

formatted_address

string required

city

string

line1

string

line2

string

line3

string

postcode

string

state

string

name

string

location

Location

country_code

string

details

Property details request

property_class

Property class request

contacts

Array of Contact request

Object

id

string

integration

Integration

Object

system_size

number

value

number

Object

note

string required

Object

id

string

name

string

description

string

status

string

Enumeration:

PENDING

INPROGRESS

COMPLETE

CANCELLED

POSTPONED

ON_HOLD

COMPLETE_ISSUES

Object

date

string date-time

user

Id name

organization

Id name

Object

id

string

created

Audit

modified

Audit

note

string

task

Task summary

activity

Activity summary

Object

id

string

name

string

description

string

status

string

Enumeration:

BLOCKED

TODO

STARTED

COMPLETE

NOT_APPLICABLE

Object

name

string required

icon_url

string

is_frozen

boolean

fields

Array of List view fields

Object

name

string required

lexicon

string required

icon_url

string

data_type

string

Enumeration:

TEXT

DATETIME

IMAGE

Object

name

string required

team

Id

user

Id

view_type

string required

Enumeration:

KANBAN

LIST

entity_type

string required

Enumeration:

WORKITEMS

LEADS

OPPORTUNITIES

JOBS

PROPERTIES

columns

Array of List view column

is_default

boolean required

board

Id

Object

id

string

name

string

team

Id name

user

Id name

view_type

string

Enumeration:

KANBAN

LIST

entity_type

string

Enumeration:

WORKITEMS

LEADS

OPPORTUNITIES

JOBS

PROPERTIES

columns

Array of List view column

is_default

boolean

owner

Id

Object

id

string

name

string required

description

string

color

string

priority

integer int32

is_default

boolean

probability

integer int32

status

string

Enumeration:

OPEN

WON

LOST

CONVERTED

COMPLETE

is_collaborative

boolean

Object

user

Id

organization

Id

Object

job_types

Array of Id

description

string

engagement

Engagement update request

lead_owner

Lead owner request

Object

id

string

name

string

lifecycle_date

string date-time

Object

name

string

description

string

lead_number

string

lifecycle

Array of Id name lifecycle date

job_types

Array of Opportunity job type response

engagement

Engagement response

lead_owner

Id name avatar url

owner

Id

Object

engagement

Engagement update request

job_number

string

po_number

string

job_description

string

contract_agreed_amount

number

completion_date

string date-time

job_type

Id

Object

job_type

Job type response

engagement

Engagement response

job_number

string

po_number

string

job_description

string

workitems

Array of Workitem engagement response

Object

postcodes

Array of string required

Unique items: YES

Object

id

string

name

string

phone

string

email

string

Object

id

string

organization

Job type organization

postcodes

Array of string

Unique items: YES

Object

name

string required

form

Id

evidence_type

string required

Enumeration:

IMAGE

VIDEO

FORM

DOCUMENT

tag

string

integration

Id

template

Id

append_product_specs

boolean

source

string required

Enumeration:

UPLOAD

AUTOMATION

ZERVIO_PDF

FORM_FILLER

evidence_category

Id required

share_to_job

boolean

allow_versioning

boolean

is_default

boolean

top_level_entity

string

Enumeration:

PROJECT

JOB_TYPE

pdf_form

Id

sign_concurrently

boolean

Object

id

string

name

string

description

string

tag

string

Object

id

string

name

string

form

Form interservice response

evidence_type

string

Enumeration:

IMAGE

VIDEO

FORM

DOCUMENT

tag

string

integration

Id

template

Id

append_product_specs

boolean

source

string

Enumeration:

UPLOAD

AUTOMATION

ZERVIO_PDF

FORM_FILLER

evidence_category

Evidence category

share_to_job

boolean

pdf_form

Id

top_level_entity

string

Enumeration:

PROJECT

JOB_TYPE

sign_concurrently

boolean

Object

id

string

name

string

signatures

Array of Form signature response

Object

id

string

name

string

label

string

Object

id

string required

entity_type

string required

Enumeration:

PROJECT

JOB_TYPE

or_group

Or group request

Object

evidence_configs

Array of Id required

filters

Array of Evidence config filter request required

Object

entity_type

string required

Enumeration:

PROJECT

JOB_TYPE

entities

Array of Id required

Object

id

string

or_group

Array of Or group response

name

string

entity_type

string

Enumeration:

PROJECT

JOB_TYPE

Object

id

string

name

string

entity_type

string

Enumeration:

PROJECT

JOB_TYPE

Object

name

string

activity

Id

task

Id

media_count

integer int32

solar_design

Id

evidence_config

Id

evidence_category

Id

comments

string

Object

start_date

string date-time

duration

integer int32

Object

id

string

name

string

status

string

Enumeration:

PENDING

INPROGRESS

COMPLETE

CANCELLED

POSTPONED

ON_HOLD

COMPLETE_ISSUES

activity_date

Evidence activity date response

Object

created_on

string date-time

created_by

Id name avatar url

uploaded_on

string date-time

Object

id

string

status

string

Enumeration:

UPLOADED

GENERATED

FAILED

PROCESSING

ON_DEVICE

DELETED

EXPIRED

is_current

boolean

created_on

string date-time

version

integer int32

media

Creatives

Object

created

string date-time

sent

string date-time

received

string date-time

opened

string date-time

signed

string date-time

Object

id

string

contact

Id

name

string

email

string

action

string

Enumeration:

SEND

REQUIRES_VIEW

REQUIRES_SIGNATURE

recipient_type

string

dates

Evidence recipient dates response

Object

id

string

evidence_date

Evidence date

name

string

engagement

Array of Id name

activity

Evidence activity response

task

Id name

task_evidence

Task evidence

media

Creatives

local_url

string

form_session

Internal form session response

media_count

integer int32

evidence_category

Id name

evidence_config

Evidence config

solar_design

Id name

status

string

Enumeration:

UPLOADED

GENERATED

FAILED

PROCESSING

ON_DEVICE

DELETED

EXPIRED

error_message

string

owner

Id name logo url

visibility

Array of Id name logo url

evidence_media

Array of Evidence media summary

signatures

Evidence signatures

evidence_recipient

Array of Evidence recipient response

signing_integration

Id

comments

string

Object

signed

integer int64

required

integer int64

sent

integer int64

Object

id

string

name

string

logo_url

string

Object

id

string

name

string

tag

string

Object

id

string

name

string

component_media

Array of Submission media response

Object

id

string

session_start

string date-time

session_end

string date-time

form

Id name

user

Id name

components

Array of Internal form session component

Object

id

string

media

Creatives

local_url

string

uploaded_date

string date-time

Object

id

string

name

string

evidence_category

Id name tag

timeline

string

Enumeration:

BEFORE

DURING

AFTER

ONCE

is_required

boolean

evidence_type

string

Enumeration:

IMAGE

VIDEO

FORM

DOCUMENT

tag

string

form

Id name

evidence_config

Id name

Object

uploaded_on

string date-time

media

Id

local_url

string

form_session

Id

is_current

boolean

Object

id

string

uploaded_date

string date-time

media

Creatives

local_url

string

form_session

Internal form session response

status

string

Enumeration:

UPLOADED

GENERATED

FAILED

PROCESSING

ON_DEVICE

DELETED

EXPIRED

error_message

string

is_current

boolean

version

integer int32

evidence_recipient

Array of Evidence recipient response

Object

evidence

Id

organizations

Array of Id

Object

evidence

Id

visibility

Array of Id name logo url

Object

id

string

saving_type

string

Enumeration:

LIGHTNING

HEATING

HOT_WATER

current_amount

number

saving_amount

number

Object

id

string

building_ref_no

string

lodgement_date

string date-time

current_rating

string

potential_rating

string

current_energy_efficiency

integer int32

potential_energy_efficiency

integer int32

uploaded_date

string date-time

completed_date

string date-time

user

Id name

organization

Id name

ei_rating

number

ei_rating_after

number

emissions

number

emissions_after

number

property_improvements

Array of Property improvement

epc_savings

Array of Epc savings

Object

id

string

name

string

sequence

integer int32

category

integer int32

green_deal_category

integer int32

improvement_type

string

improvement_number

integer int32

currency_code

string

typical_savings

number

indicative_cost

string

indicative_cost_lower

number

indicative_cost_upper

number

energy_performance_rating

integer int32

environmental_impact_rating

integer int32

Object

submitted_data

string

lexicon

string required

panel_widget_component

Id required

Object

submitted_data

string

lexicon

string

panel_widget_component

Id

Object

media

Id required

Object

communication_value

string required

user

Id

contact

Id

participant_role

string required

Enumeration:

TO

CC

BCC

FROM

PARTICIPANT

Object

direction

string

Enumeration:

INBOUND

OUTBOUND

communication_type

string required

Enumeration:

SMS

MEETING

PHONE

EMAIL

contact_time

string date-time required

subject

string

body

string

notes

string

duration

integer int32

outcome

string

Enumeration:

BUSY

NO_ANSWER

WRONG_NUMBER

LEFT_VOICEMAIL

SCHEDULED_CALLBACK

APPOINTMENT_SET

REQUESTED_CALLBACK

CONNECTED

communication_participants

Array of Communication participant request

communication_attachments

Array of Communication attachment request

Object

media

Creatives

Object

id

string

title

string

forename

string

surname

string

contact_type

string

Enumeration:

COMPANY

PERSON

EMPLOYEE

company_name

string

Object

communication_value

string

user

Id name avatar url

contact

Communication contact

participant_role

string

Enumeration:

TO

CC

BCC

FROM

PARTICIPANT

Object

id

string

direction

string

Enumeration:

INBOUND

OUTBOUND

communication_type

string

Enumeration:

SMS

MEETING

PHONE

EMAIL

contact_time

string date-time

subject

string

body

string

notes

string

duration

integer int32

outcome

string

Enumeration:

BUSY

NO_ANSWER

WRONG_NUMBER

LEFT_VOICEMAIL

SCHEDULED_CALLBACK

APPOINTMENT_SET

REQUESTED_CALLBACK

CONNECTED

communication_participants

Array of Communication participant response

communication_attachments

Array of Communication attachment response

Object

name

string required

quote

Id required

estimator

string required

Enumeration:

MCS

PVWATTS

SAM

IMPORTED

Object

id

string

name

string

quote

Id name

design_data

Design data

design_type

string

Enumeration:

SOLAR

SOLAR_3D

ASHP

Object

start_time

Local time required

end_time

Local time required

start_day

integer int32 required

end_day

integer int32 required

charge_type

string required

Enumeration:

GENERATION

CHP_GENERATION

EXPORT

GENERATION_CONSUMPTION

SELF_CONSUMPTION

GRID_CONSUMPTION

TOTAL_CONSUMPTION

BATTERY_CHARGE

PV_YIELD

BATTERY_CHARGE_GRID

BATTERY_CHARGE_SOLAR

BATTERY_DISCHARGE

BATTERY_DISCHARGE_SOLAR

BATTERY_DISCHARGE_GRID

EV_CHARGE

EV_POWER

BATTERY_SOC

PV_POWER

GRID_POWER

LOAD_POWER

BATTERY_POWER

AUTOCONSUMPTION_POWER

CHP_POWER

FUEL1_USAGE

FUEL2_USAGE

EXP_GENERATION

EXP_GENERATION_ADJUSTED

PERFORMANCE_RATIO

PERFORMANCE_RATIO_ADJUSTED

SOLAR_AVAILABILITY

PV_OPERATION_TIME

PV_AVAILABLE_TIME

EXP_GENERATION_SIMULATED

PR_SIMULATION

price_per_kwh

number required

rate_type

string

Enumeration:

CHARGE

REVENUE

name

string required

Object

name

string required

is_default

boolean

energy_type

string required

Enumeration:

ELECTRICITY

GAS

standing_charge

number

default_for_class

string

Enumeration:

COMMERCIAL

RESIDENTIAL

BLOCK

LAND

default_for_commercial_type

string

Enumeration:

OFFICES

RETAIL

INDUSTRIAL

LEISURE

HEALTHCARE

EDUCATIONAL

NURSERY

CAR_PARK

SHOPPING_CENTRE

MIXED

BUSINESS_PARK

LIBRARY

RESIDENTIAL

rates

Array of Energy rate request required

Object

id

string

start_time

Local time

end_time

Local time

start_day

integer int32

end_day

integer int32

charge_type

string

Enumeration:

GENERATION

CHP_GENERATION

EXPORT

GENERATION_CONSUMPTION

SELF_CONSUMPTION

GRID_CONSUMPTION

TOTAL_CONSUMPTION

BATTERY_CHARGE

PV_YIELD

BATTERY_CHARGE_GRID

BATTERY_CHARGE_SOLAR

BATTERY_DISCHARGE

BATTERY_DISCHARGE_SOLAR

BATTERY_DISCHARGE_GRID

EV_CHARGE

EV_POWER

BATTERY_SOC

PV_POWER

GRID_POWER

LOAD_POWER

BATTERY_POWER

AUTOCONSUMPTION_POWER

CHP_POWER

FUEL1_USAGE

FUEL2_USAGE

EXP_GENERATION

EXP_GENERATION_ADJUSTED

PERFORMANCE_RATIO

PERFORMANCE_RATIO_ADJUSTED

SOLAR_AVAILABILITY

PV_OPERATION_TIME

PV_AVAILABLE_TIME

EXP_GENERATION_SIMULATED

PR_SIMULATION

price_per_kwh

number

taxation

Taxation scheme response

commission_partner

Id name icon

rate_type

string

Enumeration:

CHARGE

REVENUE

name

string

Object

id

string

name

string

is_default

boolean

energy_type

string

Enumeration:

ELECTRICITY

GAS

default_for_class

string

Enumeration:

COMMERCIAL

RESIDENTIAL

BLOCK

LAND

default_for_commercial_type

string

Enumeration:

OFFICES

RETAIL

INDUSTRIAL

LEISURE

HEALTHCARE

EDUCATIONAL

NURSERY

CAR_PARK

SHOPPING_CENTRE

MIXED

BUSINESS_PARK

LIBRARY

RESIDENTIAL

rates

Array of Energy rate response

term_type

string

Enumeration:

FIXED

VARIABLE

INDEXED

term_months

integer int32

is_grid

boolean

Object

id

string required

external_reference

string

Object

id

string

name

string

icon

Creatives

Object

id

string

name

string

rate

number

integration

Id external reference

Object

id

string required

handle

string required

Object

id

string required

x

number double

y

number double

w

number double

h

number double

component

string required

Enumeration:

PV_STRING

INVERTER

INVERTER_BATTERY_DC

INVERTER_BATTERY_AC

DISTRIBUTION

AC_CONNECTOR

data

Object

source

Connection spec required

target

Connection spec required

Object

components

Array of Diagram component required

connections

Array of Diagram connection required

Object

name

string required

is_selected

boolean required

Object

id

string

name

string

estimator

string

Enumeration:

MCS

PVWATTS

SAM

IMPORTED

weather_source

string

Enumeration:

NONE

SATELLITE

GROUND_STATION

PROVIDED

UNKNOWN

annual_generation

number double

is_selected

boolean

weather_data

Id name

system_size

number double

Object

x

number double

y

number double

z

number double

Object

id

string

Object

id

string

Object

row

integer int32

column

integer int32

group

Group request

Object

mppt_number

integer int32

inverter

Inverter request

entry_point

Entry point

string_points

Array of String point request

Object

cable_length

number double

start

Panel string point request

end

Panel string point request

panel_count

integer int32

Object

x

number double

y

number double

z

number double

Object

id

string

Object

id

string

Object

id

string

cable_length

number double

start

Point response

end

Point response

panel_count

integer int32

Object

mppt_number

integer int32

cable_length

number double

inverter

Inverter response

entry_point

Entry point response

string_points

Array of Panel string point response

id

string

Object

row

integer int32

column

integer int32

group

Group response

Object

product

Id required

count

integer int32

Object

name

string required

description

string

icon

Id

board_type

string required

Enumeration:

OPPORTUNITY

JOB

LEAD

priority

integer int32

Object

id

string

active

string

inactive

string

Object

id

string

avatar_url

string

name

string

Object

id

string

name

string

description

string

owner

Board owner

icon

Board icon

board_type

string

Enumeration:

OPPORTUNITY

JOB

LEAD

created_on

string date-time

modified_on

string date-time

people_with_access

integer int32

Object

priority

integer int32 required

stage

Id required

Object

id

string

name

string

description

string

stage_type

string

Enumeration:

CREATOR

SPLIT

RENDEZVOUS

NORMAL

TRANSITION

ARCHIVE

AGGREGATOR

estimated_duration

integer int32

is_collaborative

boolean

workflow

Stage workflow

Object

id

string

priority

integer int32

stage

Board stage

Object

id

string

name

string

owner

Id

Object

user

Id

team

Id

Object

id

string

user

Board user

team

Team

Object

id

string

name

string

forename

string

surname

string

avatar_url

string

email

string

phone

string

country_code

string

role

Id name

Object

id

string

name

string

description

string

users

Array of Board user

Object

name

string required

description

string

tag

string

allow_job

boolean

allow_opportunity

boolean

allow_lead

boolean

is_default

boolean

Object

id

string

name

string

description

string

tag

string

allow_lead

boolean

allow_job

boolean

allow_opportunity

boolean

projects

Array of Id name

job_types

Array of Id name

Object

name

string required

description

string

event_location

string required

Enumeration:

PROPERTY

OFFICE

VIRTUAL

creator_note

string

expected_date

Expected date required

activity_type

Id

Object

start_date

string date-time required

duration

integer int32 required

Object

id

string

name

string

media

Creatives

evidence_category

Id name

evidence_config

Evidence config

Object

id

string

name

string

description

string

event_location

string

Enumeration:

PROPERTY

OFFICE

VIRTUAL

virtual

Virtual

status

string

Enumeration:

PENDING

INPROGRESS

COMPLETE

CANCELLED

POSTPONED

ON_HOLD

COMPLETE_ISSUES

expected_date

Expected date

actual_date

Expected date

cancellation

Cancellation

task_count

integer int32

resource_count

integer int32

creator_note

string

resources

Array of Activity resource response

engagement

Engagement

parent

Id name description

activity_type

Id name tag

creator_activity_files

Array of Creator activity file response

Object

id

string

user

Id name

organization

Id name

service

Id name

status

string

Enumeration:

PENDING

INPROGRESS

COMPLETE

CANCELLED

POSTPONED

ON_HOLD

COMPLETE_ISSUES

cancellation

Id name description

expected_date

Expected date

actual_date

Expected date

slot

integer int32

team

Id name

status_note

string

Object

reason_id

string

note

string

Object

evidence

Activity evidence response

Object

id

string

name

string

description

string

Object

link

string

passcode

string

Object

service

Id

engagement

Id required

assignee

Id

parent

Id

team

Id

activity

Id

name

string required

description

string

due_date

string date-time

start_date

string date-time

completed_date

string date-time

status

string required

Enumeration:

BLOCKED

TODO

STARTED

COMPLETE

NOT_APPLICABLE

priority

string required

Enumeration:

VERY_LOW

LOW

MEDIUM

HIGH

VERY_HIGH

ANY

task_type

string required

Enumeration:

SCHEDULE

EMAIL

CALL

BASIC

FILES

estimated

Estimated

evidence

Array of Task evidence request required

Object

evidence_config

Id required

timeline

string required

Enumeration:

BEFORE

DURING

AFTER

ONCE

is_required

boolean required

Object

start_date

string date-time

completed_date

string date-time

status

string

Enumeration:

BLOCKED

TODO

STARTED

COMPLETE

NOT_APPLICABLE

assignee

Id

priority

string

Enumeration:

VERY_LOW

LOW

MEDIUM

HIGH

VERY_HIGH

ANY

Object

status

string required

Enumeration:

PENDING

INPROGRESS

COMPLETE

CANCELLED

POSTPONED

ON_HOLD

COMPLETE_ISSUES

actual_date

Expected date

cancellation

Cancellation request

Object

reason

Id

note

string

Object

status

string required

Enumeration:

PENDING

INPROGRESS

COMPLETE

CANCELLED

POSTPONED

ON_HOLD

COMPLETE_ISSUES

cancellation

Id

service

Id required

expected_date

Expected date required

actual_date

Expected date

slot

integer int32

status_note

string

Object

creator_note

string

creator_activity_files

Array of Creator activity file request

Object

evidence

Id required

Object

row

integer int32

column

integer int32

removed

string required

Enumeration:

AUTO

MANUAL

Object

count

integer int32 required

gap

number required

width

number required

orientation

string required

Enumeration:

LANDSCAPE

PORTRAIT

panel_list

Array of Removed panel required

product

Id required

Object

count

integer int32 required

gap

number required

rack_type

string required

Enumeration:

FLUSH

TILTED

DUAL_TILT

width

number required

tilt_angle

number required

Object

id

string

racks

Segment3d group racks request required

panels

Segment3d group panels request required

origin

Point3d required

Object

count

integer int32

gap

number

width

number

orientation

string

Enumeration:

LANDSCAPE

PORTRAIT

panel_list

Array of Removed panel

product

Segment3d group product response

Object

id

string

name

string

specification

Segment3d group product specification response

Object

width

number

height

number

depth

number

Object

count

integer int32

gap

number

rack_type

string

Enumeration:

FLUSH

TILTED

DUAL_TILT

width

number

tilt_angle

number

Object

id

string

racks

Segment3d group racks response

panels

Segment3d group panels response

origin

Point3d

Object

lat

number required

lon

number required

segment_number

integer int32

roof_type

string

Enumeration:

ASPHALT_SHINGLE_COMPOSITION

CONCRETE_TILE

CLAY_TILE

SLATE_TILE

FLAT_ROOF

METAL_STANDING_SEAM

METAL_SHINGLE

METAL_STONE_COATED

KLIPLOCK

MEMBRANE_ROOFING

TAR_AND_GRAVEL_BITUMEN

THATCHED

WOOD_SHAKE_SHINGLE

GREEN_ROOF

OTHER

pitch

number double required

azimuth

number double required

changed_azimuth

number double

boundary_gap

integer int32

Object

id

string

lat

number

lon

number

segment_number

integer int32

roof_type

string

Enumeration:

ASPHALT_SHINGLE_COMPOSITION

CONCRETE_TILE

CLAY_TILE

SLATE_TILE

FLAT_ROOF

METAL_STANDING_SEAM

METAL_SHINGLE

METAL_STONE_COATED

KLIPLOCK

MEMBRANE_ROOFING

TAR_AND_GRAVEL_BITUMEN

THATCHED

WOOD_SHAKE_SHINGLE

GREEN_ROOF

OTHER

pitch

number double

azimuth

number double

changed_azimuth

number double

boundary_gap

integer int32

Object

workflow

Id required

stage

Id

decision

Id

engagement

Id required

owners

Array of User organization request

Object

id

string

workflow

Workitem workflow response

Object

id

string

name

string

stage

Id name

Object

decision

Id

stage

Id

visible

Visible request

owners

Array of User organization request

Object

workflow

Id required

stage

Id required

owners

Array of User organization request

Object

name

string required

description

string

stage_type

string required

Enumeration:

CREATOR

SPLIT

RENDEZVOUS

NORMAL

TRANSITION

ARCHIVE

AGGREGATOR

estimated_duration

integer int32

priority

integer int32 required

x

integer int32

y

integer int32

is_collaborative

boolean

Object

integration

Id required

location

Location required

year

string required

Object

id

string

location

Location

year

string

source_name

string

Object

start_date

string date-time

completed_date

string date-time

status

string required

Enumeration:

BLOCKED

TODO

STARTED

COMPLETE

NOT_APPLICABLE

assignee

Id

priority

string

Enumeration:

VERY_LOW

LOW

MEDIUM

HIGH

VERY_HIGH

ANY

Object

progress

Progress task required

Object

name

string required

description

string

estimated

Estimated

parent

Id

repeat_lexicon

string

due_date_offset

integer int32

due_date_period

string

Enumeration:

HOUR

DAY

WEEK

MONTH

priority

integer int32

rank

string

Enumeration:

VERY_LOW

LOW

MEDIUM

HIGH

VERY_HIGH

ANY

Array of Task config request

Object

id

string

name

string

description

string

estimated

Estimated

subtask_count

integer int32

evidence_count

Evidence count

service

Id

task_config_group

Id name

Object

name

string required

description

string

is_default

boolean

autoroute_after_days

integer int32

stage

Id required

task_complete_autoroute

boolean

Object

id

string

name

string

description

string

is_default

boolean

autoroute_after_days

integer int32

stage

Stage response

ignore_tasks

boolean

Object

id

string

name

string

stage_type

string

Enumeration:

CREATOR

SPLIT

RENDEZVOUS

NORMAL

TRANSITION

ARCHIVE

AGGREGATOR

is_collaborative

boolean

workflow

Stage workflow

Object

year

integer int32

month

integer int32

day

integer int32

hour

integer int32

poa_irradiance

number double

generation

number double

consumption

number double

grid_import

number double

grid_export

number double

self_consumption

number double

battery_discharge

number double

battery_charge

number double

ghi_irradiance

number double

Object

name

string required

site

Id

solar_design

Id

data

Array of Solar simulation data request

system_size

number double

Object

boundary

Array of Location required

area

number double

azimuth

number double

grid_alignment

number double

pitch

number double

parent

Id

center

Location required

sunshine_hours

number double

panel_grid

Array of Location

rack_type

string

Enumeration:

FLUSH

TILTED

DUAL_TILT

rack_orientation

string

Enumeration:

LANDSCAPE

PORTRAIT

roof_type

string

Enumeration:

ASPHALT_SHINGLE_COMPOSITION

CONCRETE_TILE

CLAY_TILE

SLATE_TILE

FLAT_ROOF

METAL_STANDING_SEAM

METAL_SHINGLE

METAL_STONE_COATED

KLIPLOCK

MEMBRANE_ROOFING

TAR_AND_GRAVEL_BITUMEN

THATCHED

WOOD_SHAKE_SHINGLE

GREEN_ROOF

OTHER

alignment_line

Array of Location

border

Border

Object

whole_roof

Roof segment response

segments

Array of Roof segment response

Object

id

string

center

Location required

Object

start_time

integer int64 required

end_time

integer int64 required

Object

pairing_code

string required

name

string required

rotation

integer int32

site

Id required

Object

id

string

name

string

pairing_code

string

paired_on

string date-time

rotation

integer int32

site

Id name

Object

pairing_code

string required

Object

screen

Screen response

token

string

Object

id

string

title

string

forename

string

surname

string

property_contact_type

string

Enumeration:

THIRD_PARTY

POWER_OF_ATTORNEY

TENANT

OWNER

LANDLORD

CARER

SHARED_OWNER

MANAGING_AGENT

LETTING_AGENT

LETTING_COMPANY

MANAGEMENT_COMPANY

ACCOUNTANT

SUSTAINABILITY_MANAGER

FUNDER

FINANCE_DIRECTOR

SUSTAINABILITY_DIRECTOR

OPERATIONS_DIRECTOR

INTRODUCER

MAIN_APPLICANT

BENEFIT_RECIPIENT

contact_type

string

Enumeration:

COMPANY

PERSON

EMPLOYEE

date_of_birth

string date-time

profession

string

timezone

string

pronouns

string

emails

Array of Contact email request

phones

Array of Contact phone request

addresses

Array of Contact address request

contact_period

Array of Contact call time request

shared_percentage

integer int32

company_name

string

parent

Id

job_title

string

isPrimary

boolean

management_start_date

string date-time

company_registration_number

string

primary

boolean

Object

formatted_address

string required

city

string required

line1

string required

line2

string

line3

string

postcode

string

state

string

name

string

location

Location

country_code

string required

details

Property details request

contacts

Array of Property contact request

property_class

Property class request

parent

Id

Object

organization

Id required

organization_type

string required

Enumeration:

OWNER

LETTING_AGENT

MANAGING_AGENT

user

Id

Object

name

string required

mpan

string

energy_consumption_pattern

Id

energy_type

string

Enumeration:

ELECTRICITY

GAS

is_uploaded_consumption

boolean

Object

month

integer int32

Min: 1

Max: 12

quarter

integer int32

Min: 1

Max: 4

day

integer int32

Min: 1

Max: 31

hour

integer int32

Min: 0

Max: 23

half_hour

integer int32

Min: 0

Max: 48

consumption_kwh

number required

meter

Id required

Array of Property contact request

Object

job_type

Id required

Array of Organization job type request

Object

user

Id

organization

Id

Object

id

string

note

string required

activity

Id

task

Id

Object

parent

Id

name

string

project

Id

campaign

Id

engagement_dates

Engagement dates request

currency

string

quote

Quote

primary_contact

Contact request

property

Property

workflow

Engagement workflow request

agent

Agent request

note

Engagement note request

external_reference

string

integration

Id

lead_generator

Engagement organization request

lead_source

Engagement organization request

partners

Array of Engagement organization request

Object

id

string

stage

Engagement workflow stage request

Object

id

string

route

Id

Object

job_types

Array of Id

opportunity_description

string

probability

integer int32

contracted_agreed_date

string date-time

budget

number

decision_maker_id

string

opportunity_value

number

engagement

Engagement request required

import_roof

boolean

opportunity_number

string

lead

Id

Object

lifecycle_type

string required

Enumeration:

LEAD

JOB

OPPORTUNITY

Object

id

string

lifecycle_type

string

Enumeration:

LEAD

JOB

OPPORTUNITY

created

Created

lifecycles

Array of Lifecycle response

Object

name

string required

description

string

color

string

priority

integer int32

is_default

boolean

probability

integer int32

status

string

Enumeration:

OPEN

WON

LOST

CONVERTED

COMPLETE

is_collaborative

boolean

Object

job_types

Array of Id

lead_number

string

description

string

engagement

Engagement request

lead_owner

Lead owner request

lifecycle

Id

create_custom_forms

boolean

import_roof

boolean

Object

job_type

Id required

job_number

string

po_number

string

job_description

string

contract_agreed_amount

number

completion_date

string date-time

import_roof

boolean

engagement

Engagement request required

Object

quote_category

string required

Object

service

Id required

isMandatory

boolean

estimated_duration

integer int32

qty

integer int32

mandatory

boolean

Array of Job type service request

Object

id

string

name

string

description

string

is_virtual

boolean

Object

service

Job type service

is_mandatory

boolean

estimated_duration

integer int32

qty

integer int32

Object

name

string required

description

string

tag

string

is_default

boolean

priority

integer int32

parent

Id

allow_job

boolean

allow_opportunity

boolean

allow_lead

boolean

Object

id

string

name

string

description

string

tag

string

is_default

boolean

created_on

string date-time

modified_on

string date-time

allow_job

boolean

allow_opportunity

boolean

allow_lead

boolean

evidence_configs

Array of Evidence config

children_count

integer int32

children

Array of Evidence category response

Object

id

string

created_date

string date-time

name

string

engagement

Id required

activity

Id

task

Id

task_evidence

Id

evidence_config

Id

solar_design

Id

media

Id

evidence_category

Id

form_session

Id

device_media_id

string

media_count

integer int32

comments

string

Array of Evidence request

Object

organization

Id required

Array of Evidence organization request

Object

uploaded_on

string date-time

media

Id

local_url

string

form_session

Id

Object

contact

Id

name

string required

email

string required

action

string required

Enumeration:

SEND

REQUIRES_VIEW

REQUIRES_SIGNATURE

signature_component_id

string

Object

sign_concurrently

boolean

evidence_recipient

Array of Evidence recipient request required

Object

evidence_recipient

Array of Resend request required

Object

id

string required

email

string

name

string

Array of Id

Object

amount

number required

months

integer int32 required

apr

number required

initial_payment

number required

lender

Id

Object

organization

Id required

user

Id

Object

unit

string

Enumeration:

HOUR

DAY

WEEK

MONTH

YEAR

count

integer int32

Object

sku

string

product

Id

name

string required

description

string

external_reference

string

line_no

integer int32 required

product_type

string required

Enumeration:

PHYSICAL

SERVICE

LABOUR

EXPENSE

qty

number required

unit

string required

Enumeration:

COUNT

SQMTR

SQFT

HOURS

DAY

KWH

unit_price

number

taxation_scheme

Id

discount_rate

number

discount_amount

number

total_net

number

total_tax

number

total_amount

number

supplier

Id name

line_item_type

string

Enumeration:

TIME

OTHER

CATALOG

image

Id

cost_net

number

cost_amount

number

cost_unit_price

number

cost_tax

number

cost_discount_rate

number

cost_discount_amount

number

cost_taxation_scheme

Id

ppa_excluded

boolean

finance_excluded

boolean

billing

Quote product billing request

term

Quote product billing request

sold_as

string

Enumeration:

ONE_OFF

RECURRING

Object

id

string

code

string

description

string

status

string required

Enumeration:

ESTIMATE

DRAFT

SENT

ACCEPTED

REJECTED

INVOICED

PART_INVOICED

quote_type

string required

Enumeration:

COST

SALE

expiry_date

string date-time

accepted_date

string date-time

external_reference

string

salesperson

Id name

integration

Id

products

Array of Quote product request

payment_terms_template

Id

recipients

Array of Recipient request

term

string

quote_category

string

quote_template

Id

organizations

Array of Quote organization request

finance

Finance request

solar_design

Id

Object

organization

Id

user

Id

contact

Id

requires_acceptance

boolean

Object

amount

number

months

integer int32

apr

number

monthly_repayment

number

initial_payment

number

lender

Id name

total_repayments

number

approved

string date-time

Object

id

string

code

string

description

string

Object

id

string

name

string

description

string

percentage

number

due_count

integer int32

is_required

boolean

priority

integer int32

invoice

Id code description

Object

id

string

name

string

description

string

payment_terms

Array of Payment term response

Object

id

string

alignment

string

Enumeration:

LEFT

RIGHT

CENTRE

media

Creatives

Object

organization

Id name

user

Id name

Object

id

string

sku

string

product

Id

name

string

description

string

external_reference

string

line_no

integer int32

product_type

string

Enumeration:

PHYSICAL

SERVICE

LABOUR

EXPENSE

qty

number

unit

string

Enumeration:

COUNT

SQMTR

SQFT

HOURS

DAY

KWH

unit_price

number

taxation_scheme

Taxation scheme response

discount_rate

number

discount_amount

number

total_net

number

total_tax

number

total_amount

number

supplier

Id name

line_item_type

string

Enumeration:

TIME

OTHER

CATALOG

image

Creatives

families

Array of Family response

cost_net

number

cost_amount

number

cost_unit_price

number

cost_tax

number

cost_discount_rate

number

cost_discount_amount

number

cost_taxation_scheme

Taxation scheme response

ppa_excluded

boolean

finance_excluded

boolean

billing

Quote product billing request

term

Quote product billing request

sold_as

string

Enumeration:

ONE_OFF

RECURRING

Object

id

string

code

string

description

string

status

string

Enumeration:

ESTIMATE

DRAFT

SENT

ACCEPTED

REJECTED

INVOICED

PART_INVOICED

expiry_date

string date-time

accepted_date

string date-time

external_reference

string

total_amount

number

total_tax

number

total_net

number

total_discount

number

salesperson

Id name

integration

Id name

created_on

string date-time

recipients

Array of Recipient response

customer_note

string

products

Array of Quote product response

payment_terms_template

Payment term template response

invoice

Id code description

term

string

issued_date

string date-time

quote_template

Quote template details

organizations

Array of Quote organization response

finance

Finance response

Object

id

string

created_on

string date-time

created_by

Id name

name

string

description

string

terms

string

contact_information

string

is_default

boolean

image

Quote image response

Object

id

string

name

string

contact_type

string

Enumeration:

COMPANY

PERSON

EMPLOYEE

company_name

string

emails

Array of Contact email response

phones

Array of Contact phone response

Object

requires_acceptance

boolean

customer_note

string

status

string

Enumeration:

ESTIMATE

DRAFT

SENT

ACCEPTED

REJECTED

INVOICED

PART_INVOICED

created_on

string date-time

contact

Recipient contact

organization

Id name

user

Id name

updated_on

string date-time

Object

id

string

name

string

email

string

phone

string

image

Creatives

formatted_address

string

Object

id

string

organization

Engagement partner organization

user

Engagement user

team

Id name

created_on

string date-time

type

string

Enumeration:

PARTNER

LEAD_SOURCE

LEAD_GENERATOR

job_types

Array of Id name

Object

id

string

name

string

email

string

phone

string

Object

id

string

form_version

Id

form

Id

engagements

Array of Id name

Object

sku

string

name

string required

description

string

quantity

integer int32 required

cost_type

string required

Enumeration:

MATERIALS

LABOUR

EXPENSE

QUOTE

cost_unit_price

number required

cost_tax_rate

number required

cost_total_amount

number required

sale_unit_price

number

sale_tax_rate

number

sale_total_amount

number

quote

Id

product

Id

quote_product

Id

Object

id

string

sku

string

name

string

description

string

quantity

integer int32

cost_type

string

Enumeration:

MATERIALS

LABOUR

EXPENSE

QUOTE

cost_unit_price

number

cost_tax_rate

number

cost_total_amount

number

sale_unit_price

number

sale_tax_rate

number

sale_total_amount

number

quote

Quote cost

product

Product short

quote_product

Quote product

Object

id

string

sku

string

external_reference

string

name

string

description

string

supplier

Id name

Object

id

string

code

string

description

string

status

string

Enumeration:

ESTIMATE

DRAFT

SENT

ACCEPTED

REJECTED

INVOICED

PART_INVOICED

Object

id

string

sku

string

product

Id

name

string

description

string

external_reference

string

line_no

integer int32

product_type

string

Enumeration:

PHYSICAL

SERVICE

LABOUR

EXPENSE

qty

number

supplier

Id name

Object

name

string required

quote

Id required

existing_solar_design

Id

Object

lexicon

string required

media

Id required

roof

Id

segment3d

Id

Object

to

Array of string required

cc

Array of string

bcc

Array of string

subject

string required

message

string required

to_as_string

string

cc_as_string

string

bcc_as_string

string

Object

evidence_config

Id required

design

Id

evidence_category

Id

Object

id

string

name

string

quote

Id

design_type

string

Enumeration:

SOLAR

SOLAR_3D

ASHP

integration

Id

user

Id

estimator

string

Enumeration:

MCS

PVWATTS

SAM

IMPORTED

Object

id

string

name

string

quote

Id name

design_type

string

Enumeration:

SOLAR

SOLAR_3D

ASHP

integration

Id

Object

id

string

count

integer int32

product

Id name

capacity

number

Object

id

string

product

Id name

size

integer int32

mppts

integer int32

power_out

number

Object

id

string

total_capacity

number

count

integer int32

product

Id name

Object

panels

Array of Design data panel

batteries

Array of Design data battery

inverters

Array of Design data inverter

ev_chargers

Array of Id product count response

system_losses

number

battery_capacity

number

inverters_capacity

number

Object

id

string

name

string

quote

Id

design_data

Design data response

engagement

Array of Id name

estimations

Estimator response

image

Creatives

Object

estimator

string

Enumeration:

MCS

PVWATTS

SAM

IMPORTED

annual_production

number double

annual_export

number double

autoconsumption

number double

Object

id

string

product

Id name

count

integer int32

Object

integration

Id

start_date

string date required

end_date

string date required

account

Id required

Object

id

string

formatted_address

string

line1

string

line2

string

line3

string

city

string

state

string

postcode

string

country_code

string

coordinates

Location

Object

email

string

address

Account address event

autocollection

boolean

collection_date

string date

Object

id

string

name

string

billing

Account billing event

service

Account service event

account_number

string

contact

Id

Object

start_date

string date

end_date

string date

address

Account address event

Object

timestamp

string date-time

balance

number

Object

timestamp

string date-time

amount

number

payment_type

string

Enumeration:

BANK_REDIRECT

DIRECT_DEBIT

CARD

WALLET

OTHER

DIRECT_TRANSFER

Object

current

Balance

payments

Array of Balance payment summary

total_paid

number

Object

name

string

account_number

string

sort_code

string

account_holder

string

Object

id

string

start

string date

end

string date

invoice

Invoice event

balance_snapshot

Balance snapshot

account_event

Account event

payment_methods

Array of Payment method response

Object

expiration_month

integer int64

expiration_year

integer int64

funding

string

Enumeration:

CREDIT

PREPAID

UNKNOWN

DEBIT

Object

id

string

code

string

description

string

status

string

Enumeration:

DRAFT

SENT

AUTHORIZED

PAID

UNPAID

VOIDED

DELETED

PARTIALLY_PAID

due_date

string date-time

external_reference

string

total_amount

number

total_tax

number

total_net

number

line_items

Array of Line item

payment_terms_template

Payment term template response

created_on

string date-time

issued_date

string date-time

paid_date

string date-time

quote

Id code description

Object

sku

string

product

Id

name

string required

description

string

external_reference

string

line_no

integer int32 required

product_type

string required

Enumeration:

PHYSICAL

SERVICE

LABOUR

EXPENSE

qty

number required

unit

string required

Enumeration:

COUNT

SQMTR

SQFT

HOURS

DAY

KWH

unit_price

number required

unit_tax_rate

number

discount_rate

number

total_net

number required

total_tax

number required

total_amount

number

finance_account

Id

supplier

Id name

taxation_scheme

Id

image

Id

Object

id

string

integration

Id

type

string

Enumeration:

BANK_REDIRECT

DIRECT_DEBIT

CARD

WALLET

OTHER

DIRECT_TRANSFER

brand

string

last_4_digits

string

card

Card

bank

Bank

external_reference

string

is_default

boolean

Object

roof

Id required

panel_weight

number double

num_rows

integer int32

num_columns

integer int32

ballast_weight

number double

mounting_weight

number double

Object

estimator

string

Enumeration:

MCS

PVWATTS

SAM

IMPORTED

weather_source

string

Enumeration:

NONE

SATELLITE

GROUND_STATION

PROVIDED

UNKNOWN

weather_data

Id

name

string

Object

event

Integration automation event

action_parameters

Object

string

action_parameter_list

Array of Execute action param

integration_parameters

Object

string

preceding_parameters

Object

string

tenant_id

string

Object

name

string

value

string

mapping

string

display_value

string

Object

event_id

string

created_on

string date-time

created_by

string

event_type

string

payload

Object

cancel_id

string

cancel_pending

boolean

tenant_id

string

saas_provider_id

string

entities

Object

string

pii_lexicons

Array of string

is_apikey

boolean

organizations

Array of string

anonymize_after_seconds

integer int64

entity_owner

string

Object

param_name

string

param_value

string

Object

id

string

name

string

param_type

string

Enumeration:

LIST

TEXT

PASSWORD

NUMBER

DATE

ATTACHMENTS

HTML

GROUP

TEXTAREA

conditional

Param conditional

optional

boolean

required_params

Array of string

default

Id name

choices

Array of Id name

condition_lexicon

string

is_field_mapping

boolean

isRepeatable

boolean

params

Array of Param config

repeatable

boolean

Object

name

string required

campaign_type

string required

Enumeration:

REFERRAL

MARKETING

RADIO

description

string

utm_source

string

utm_medium

string

utm_campaign

string

Object

id

string

name

string

description

string

campaign_type

string

Enumeration:

REFERRAL

MARKETING

RADIO

created_on

string date-time

created_by

Id name avatar url

modified_on

string date-time

modified_by

Id name avatar url

utm_source

string

utm_medium

string

utm_campaign

string

Object

name

string required

description

string

engagement

Id required

event_location

string required

Enumeration:

PROPERTY

OFFICE

VIRTUAL

creator_note

string

resources

Array of Activity resource request

parent

Id

expected_date

Expected date required

activity_type

Id

creator_activity_files

Array of Creator activity file request

Object

organization

Id required

team

Id

user

Id

slot

integer int32

service

Id required

expected_date

Expected date required

Object

category

Id

Object

page

integer int32

size

integer int32

Min: 1

sort

Array of string

Object

total_pages

integer int32

total_elements

integer int64

pageable

Pageable object

number_of_elements

integer int32

first

boolean

last

boolean

sort

Sort object

number

integer int32

content

Array of Workitem response

size

integer int32

empty

boolean

Object

page_number

integer int32

paged

boolean

page_size

integer int32

unpaged

boolean

sort

Sort object

offset

integer int64

Object

sorted

boolean

unsorted

boolean

empty

boolean

Object

id

string

name

string

color

string

Object

arrived_at

string date-time

stage

Stage response

lifecycle

Id name color

Object

id

string

name

string

description

string

created_on

string date-time

modified_on

string date-time

lifecycle

string

Enumeration:

ACTIVE

INACTIVE

allow_job

boolean

allow_opportunity

boolean

decisions

Array of Id name description

Object

years

Array of Id name

Object

name

string

icon_url

string

is_frozen

boolean

fields

Array of Board workitem field

Object

name

string

lexicon

string

icon_url

string

value

string

data_type

string

Enumeration:

TEXT

DATETIME

IMAGE

Object

columns

Array of Board workitem column

Object

total_pages

integer int32

total_elements

integer int64

pageable

Pageable object

number_of_elements

integer int32

first

boolean

last

boolean

sort

Sort object

number

integer int32

content

Array of Board workitem v2 response

size

integer int32

empty

boolean

Object

total_pages

integer int32

total_elements

integer int64

pageable

Pageable object

number_of_elements

integer int32

first

boolean

last

boolean

sort

Sort object

number

integer int32

content

Array of Site response v2

size

integer int32

empty

boolean

Object

id

string

contact

Id name

Object

id

string

property

Property summary

primary_account

Primary account

subsites_count

integer int32

system_size

number

peak_kwp

number

status

string

Enumeration:

OPERATIONAL

OFFLINE

UNDERPERFORMING

INSTALLING

inventory

Array

string

Enumeration:

BATTERY

SOLAR_PANEL

INVERTER

METER

EV_CHARGER

CHP_ENGINE

GATEWAY

PYRANOMETER

generation

Object

number double

image

Creatives

Object

readings

Array

Object

totals

Object

number double

Object

id

string

name

string

description

string

owner

Board owner

icon

Board icon

board_type

string

Enumeration:

OPPORTUNITY

JOB

LEAD

created_on

string date-time

modified_on

string date-time

people_with_access

integer int32

priority

integer int32

Object

id

string

engagement

Engagement

name

string

description

string

start_time

string date-time

expected_duration

integer int32

actual_start_time

string date-time

actual_duration

integer int32

event_location

string

Enumeration:

PROPERTY

OFFICE

VIRTUAL

expected_date

Expected date

actual_date

Expected date

status

string

Enumeration:

PENDING

INPROGRESS

COMPLETE

CANCELLED

POSTPONED

ON_HOLD

COMPLETE_ISSUES

cancellation

Cancellation

task_count

integer int32

resource_count

integer int32

virtual

Virtual

creator_note

string

resources

Array of Activity resource response

activity_type

Id name tag

creator_activity_files

Array of Creator activity file response

Object

total_pages

integer int32

total_elements

integer int64

pageable

Pageable object

number_of_elements

integer int32

first

boolean

last

boolean

sort

Sort object

number

integer int32

content

Array of Activity response

size

integer int32

empty

boolean

Object

total_pages

integer int32

total_elements

integer int64

pageable

Pageable object

number_of_elements

integer int32

first

boolean

last

boolean

sort

Sort object

number

integer int32

content

Array of Event task response

size

integer int32

empty

boolean

Object

id

string

name

string

job_type

Id name

service

Id name

contract

Id

workflow

Id name

stage

Id name

activity_type

Id name tag

project

Id name

Object

routes

Array of Stage route

Object

decisions

Array of Route response

transitions

Array of Transition response

Object

id

string

name

string

description

string

stage_type

string

Enumeration:

CREATOR

SPLIT

RENDEZVOUS

NORMAL

TRANSITION

ARCHIVE

AGGREGATOR

estimated_duration

integer int32

Object

id

string

contract_length_months

integer int32

ppa_energy_cost

number

payback_period

number double

system_cost

number

total_net_revenue

number

total_gross_revenue

number

total_install_cost

number

energy_cost

Energy cost

Object

type

string

geometry

Panel geo json geometry

Object

type

string

coordinates

Array of Location

Object

type

string

features

Array of Panel geo json feature

Object

id

string

row

integer int32

column

integer int32

orientation

string

center

Location

annual_production_kwh

number

width

number double

height

number double

Object

price

number

taxation_scheme

Taxation scheme summary

tax_model

string

Enumeration:

INCLUSIVE

EXCLUSIVE

Object

id

string

location_code

string

currency

string

effective_date

string date-time

during_binding

boolean

external_reference

string

merchant

Id name

price_group

Price group merchant response

sales

Price sales response

cost

Price cost response

Object

id

string

name

string

merchant

Id name

Object

display_price

string

price

number

currency

string

tax_model

string

Enumeration:

INCLUSIVE

EXCLUSIVE

Object

price

number

currency

string

taxation_scheme

Taxation scheme summary

display_price

string

tax_model

string

Enumeration:

INCLUSIVE

EXCLUSIVE

override

Price override response

Object

id

string

name

string

variant

Product variant

ratecard

Ratecard self

term

Term without prices

prices

Array of Price

Unique items: YES

payment_model

string

Enumeration:

PREPAY

ADD_TO_BILL

price_model

string

Enumeration:

FLAT

TIERED

RATED

VARIABLE

price_type

string

Enumeration:

ONE_OFF

RECURRING

isPrimary

boolean

primary

boolean

Object

id

string

name

string

prices

Array of Price

Unique items: YES

payment_model

string

Enumeration:

PREPAY

ADD_TO_BILL

price_model

string

Enumeration:

FLAT

TIERED

RATED

VARIABLE

price_type

string

Enumeration:

ONE_OFF

RECURRING

isPrimary

boolean

primary

boolean

Object

id

string

sku

string

barcode

string

attributes

Array of Variant value

Unique items: YES

pricing

Product price variant

Object

annual_usage_kwh

number

annual_cost

number

class_type

string

Enumeration:

COMMERCIAL

RESIDENTIAL

BLOCK

LAND

Object

id

string

name

string

description

string

Object

id

string

name

string

rate_type

string

Enumeration:

VOICE

DATA

SMS

FUEL

GAS

ELECTRIC

effective_date

string date-time

use_provider

boolean

rating

Array of Rating self

Unique items: YES

Object

id

string

name

string

sales_org_id

string

purchaser_id

string

rate_unit

string

Enumeration:

SECOND

MINUTE

HOUR

DAY

WEEK

MONTH

YEAR

MB

GB

KWH

MESSAGES

time_period

Time period self

location_code

string

price

number

currency

string

tax_model

string

Enumeration:

INCLUSIVE

EXCLUSIVE

min_charge

number

charge_after

integer int32

round_to

integer int32

effective_date

string date-time

rating_values

Array of Rating value self

Unique items: YES

Object

id

string

rate_map

Rate map self

rate_value

string

Object

id

string

azimuth_degrees

number double

pitch_degrees

number double

area

number double

center

Location

panels

Array of Panel

boundary

Array of Location

panel_grid

Array of Location

alignment_line

Array of Location

grid_alignment

number double

Object

segment_id

string

panels

integer int32

Object

id

string

name

string

map_type

string

Enumeration:

MODIFIER

ADD_ON

REMOVE

is_mandatory

boolean

max_items

integer int32

min_items

integer int32

tag

string

components

Array of Solar option component

Object

panels

integer int32

system_size

number

peak_power

number double

segments

Array of Segment config

Object

annual_production_kwh

number double

export_revenue

number double

annual_savings

number double

annual_savings_with_export

number double

autoconsumption_pct

number double

autoconsumption_kwh

number double

annual_production_offset_pct

number

independence_pct

number

Object

bundle

Solar option product

products

Array of Solar option product

config

Solar config

estimate

Solar estimate

Object

id

string

name

string

sku

string

pricing

Solar product pricing

quantity

number

min_quantity

number

max_quantity

number

description

string

sell_type

string

Enumeration:

UP_SELL

CROSS_SELL

BASE

is_inclusive

boolean

reason

string

image

Creatives

Object

id

string

name

string

sku

string

pricing

Array of Product price

Unique items: YES

quantity

number

component_maps

Array of Solar component map

description

string

sell_type

string

Enumeration:

UP_SELL

CROSS_SELL

BASE

image

Creatives

Object

options

Array of Solar option

whole_roof

Whole roof

roof_segments

Array of Roof segment

property

Property solar data

Object

unit_price

number

currency

string

total_amount

number

total_tax

number

total_net

number

Object

id

string

name

string

location_code

string

tax_type

string

Enumeration:

VAT

SALES_TAX

GST

CUSTOM

rate

number

Object

id

string

billing

integer int32

billing_unit

string

Enumeration:

HOUR

DAY

WEEK

MONTH

YEAR

binding

integer int32

binding_unit

string

Enumeration:

DAY

WEEK

MONTH

YEAR

name

string

price_model

string

Enumeration:

FLAT

TIERED

RATED

VARIABLE

auto_renew

boolean

Object

id

string

name

string

day_start

integer int32

start_time

string date-time

day_end

integer int32

end_time

string date-time

Object

id

string

name

string

Object

id

string

variant_map

Variant map

variant_value

string

Object

roof_area

number

max_sunshine_hours

number

center

Location

Object

id

string

account_number

string

contact

Contact short summary

Object

id

string

forename

string

surname

string

company_name

string

contact_type

string

Enumeration:

COMPANY

PERSON

EMPLOYEE

Object

total_pages

integer int32

total_elements

integer int64

pageable

Pageable object

number_of_elements

integer int32

first

boolean

last

boolean

sort

Sort object

number

integer int32

content

Array of Site response

size

integer int32

empty

boolean

Object

id

string

name

string

image

Creatives

date

string date-time

Object

id

string

primary_account

Account summary

property

Property summary

status

string

Enumeration:

OPERATIONAL

OFFLINE

UNDERPERFORMING

INSTALLING

system_size

integer int32

subsites_count

integer int32

system_stats

Site system stats

installers

Array of Site organization response

image

Creatives

Object

total_generated

number double

total_exported

number double

total_consumed

number double

total_charged

number double

total_discharged

number double

Object

reading_type

string

Enumeration:

BATTERY_SOC

CONSUMPTION_GRID

CONSUMPTION_GENERATION

CONSUMPTION_BATTERY

GENERATION_GRID

GENERATION_BATTERY

GENERATION_LOAD

GENERATION_PV

POA_IRRADIANCE

GHI_IRRADIANCE

PERFORMANCE_RATIO

PERFORMANCE_RATIO_ADJUSTED

reading_value

number double

Object

timestamp

string date-time

readings

Array of Site power reading response

Object

control

string

value

number double

error

string

Object

values

Array of Control value

Object

ghi

number double

dhi

number double

dni

number double

poa

number double

Object

quantity

number double

probability

number double

Object

weather

Array of Site weather

source

string

Enumeration:

PYRANOMETER

OPENMETEO

average

Site weather

Object

uv_index

integer int32

cloud_cover

integer int32

weather_type

string

icon_uri

string

rain

Rain

temperature

number double

air_temperature

number double

device_temperature

number double

humidity

number double

timestamp

string date-time

pressure

number double

source

string

Enumeration:

PYRANOMETER

OPENMETEO

irradiance

Irradiance

Object

uv_index

integer int32

cloud_cover

integer int32

temperature

Temperature

weather_type

string

timestamp

string date-time

icon_uri

string

rain

Rain

sunrise

string date-time

sunset

string date-time

irradiance

Irradiance

Object

uv_index

integer int32

cloud_cover

integer int32

temperature

number double

weather_type

string

timestamp

string date-time

icon_uri

string

rain

Rain

irradiance

Irradiance

Object

hours

Array of Site weather hour

days

Array of Site weather day

address

Weather address

Object

min

number double

max

number double

Object

city

string

country

string

Object

id

string

identity_number

string

meter_type

string

Enumeration:

INVERTER

METER

EV_CHARGER

CHP_ENGINE

PYRANOMETER

Object

flights_offset

number double

co2_offset_tons

number double

trees_planted

number double

car_journeys_offset

number double

flight_miles_offset

number double

car_miles_offset

number double

Object

total_consumption_kwh

number double

import_kwh

number double

export_kwh

number double

self_consumption_pct

number double

eco_benefits

Self eco benefit response

Object

installed_capacity

number

status

Object

integer int64

count

integer int32

Object

readings

Array

Object

id

string

name

string

system_size

number

installers

Array of Site organization response

Object

id

string

name

string

description

string

is_default

boolean

Object

valueKwhRaw

number

reading_start

string

value_kwh

number double

Object

routes

Stage route

Object

id

string

name

string

engagement_type

string

Enumeration:

OPPORTUNITY

JOB

LEAD

property

Engagement property summary

lifecycle

Id name

job_types

Array of Opportunity job type response

workitems

Array of Property engagement workitem response

Object

id

string

name

string

description

string

is_default

boolean

Object

id

string

country_code

string

number

string

is_primary

boolean

phone_type

string

Enumeration:

WORK

PERSONAL

contact_type

string

Enumeration:

LANDLINE

MOBILE

Object

id

string

name

string

contact_type

string

Enumeration:

COMPANY

PERSON

EMPLOYEE

lifecycle

Contact lifecycle response

company_registration_number

string

phones

Array of Contact phone

emails

Array of Contact email response

Object

id

string

formatted_address

string

location

Location

Object

id

string

name

string

formatted_address

string

location

Location

Object

total_pages

integer int32

total_elements

integer int64

pageable

Pageable object

number_of_elements

integer int32

first

boolean

last

boolean

sort

Sort object

number

integer int32

content

Array of Proptech contact response

size

integer int32

empty

boolean

Object

contact

Contact response

properties

Array of Id name address

engagements

Array of Contact engagement summary

Object

id

string

name

string

description

string

Object

total_pages

integer int32

total_elements

integer int64

pageable

Pageable object

number_of_elements

integer int32

first

boolean

last

boolean

sort

Sort object

number

integer int32

content

Array of Property response

size

integer int32

empty

boolean

Object

id

string

name

string

engagement_type

string

Enumeration:

OPPORTUNITY

JOB

LEAD

job

Engagement job response

opportunity

Engagement opportunity response

lead

Engagement lead response

project

Id name

workitems

Array of Property engagement workitem response

Object

id

string

name

string

formatted_address

string

location

Location

contacts

Array of Property contact response

details

Property details

property_class

Property class

engagements

Array of Property engagement response

created_on

string date-time

created_by

Id name avatar url

Object

old_cost

number

new_cost

number

Object

year

Solar estimate

savings25_years

Array of Old new cost

Object

id

string

building_ref_no

string

lodgement_date

string date-time

current_rating

string

potential_rating

string

current_energy_efficiency

integer int32

potential_energy_efficiency

integer int32

uploaded_date

string date-time

completed_date

string date-time

user

Id name

organization

Id name

ei_rating

number

ei_rating_after

number

emissions

number

emissions_after

number

Object

id

string

name

string

project

Id name code

engagement_type

string

Enumeration:

OPPORTUNITY

JOB

LEAD

contact

Contact

property

Property summary

engagement_dates

Engagement dates response

workitems

Array of Workitem engagement response

created_by

Created by

expected_completion

string date-time

job

Engagement job response

opportunity

Engagement opportunity response

lead

Engagement lead response

Object

total_pages

integer int32

total_elements

integer int64

pageable

Pageable object

number_of_elements

integer int32

first

boolean

last

boolean

sort

Sort object

number

integer int32

content

Array of Engagement full

size

integer int32

empty

boolean

Object

battery_soc

number double

battery_power

number double

pv_power

number double

solar_consumption

number double

ev_power

number double

chp_power

number double

system_size

number

grid_power

number double

load_power

number double

last_reading_time

string date-time

Object

reading_start

string date-time

reading_end

string date-time

reading_value

number double

meter

Id

Object

id

string

name

string

quote_category

string

Object

name

string

job_type

Job type summary

job_number

string

po_number

string

job_description

string

contract_agreed_amount

number

completion_date

string date-time

engagement

Engagement response

workitems

Array of Property engagement workitem response

Object

id

string

name

string

formatted_address

string

property_class

Property class

Object

id

string

lead_number

string

contact

Id name

name

string

lifecycle

Id name

lead_owner

Id name avatar url

property

Lead property summary

job_types

Array of Id name

owner

Id

Object

total_pages

integer int32

total_elements

integer int64

pageable

Pageable object

number_of_elements

integer int32

first

boolean

last

boolean

sort

Sort object

number

integer int32

content

Array of Lead summary

size

integer int32

empty

boolean

Object

name

string

job_type

Job type summary

job_number

string

po_number

string

job_description

string

contract_agreed_amount

number

completion_date

string date-time

engagement

Engagement response

Object

id

string

formatted_address

string

Object

engagement

Quote self engagement

job

Quote self job

Object

id

string

property

Id address

Object

id

string

job_number

string

po_number

string

Object

id

string

evidence_date

Evidence date

name

string

engagement

Array of Id name

activity

Evidence activity response

task

Id name

task_evidence

Task evidence

media

Creatives

local_url

string

form_session

Internal form session response

media_count

integer int32

evidence_category

Id name

evidence_config

Evidence config

solar_design

Id name

status

string

Enumeration:

UPLOADED

GENERATED

FAILED

PROCESSING

ON_DEVICE

DELETED

EXPIRED

error_message

string

owner

Id name logo url

visibility

Array of Id name logo url

evidence_media

Array of Evidence media summary

signatures

Evidence signatures

comments

string

Object

id

string

name

string

engagement_type

string

Enumeration:

OPPORTUNITY

JOB

LEAD

project

Id name

campaign

Id name

engagement_dates

Engagement dates response

currency

string

property

Property

created_by

Created by

job

Engagement job response

opportunity

Engagement opportunity response

lead

Engagement lead response

Object

total_pages

integer int32

total_elements

integer int64

pageable

Pageable object

number_of_elements

integer int32

first

boolean

last

boolean

sort

Sort object

number

integer int32

content

Array of Engagement details response

size

integer int32

empty

boolean

Object

id

string

name

string

rate

number

Object

id

string

code

string

description

string

status

string

Enumeration:

ESTIMATE

DRAFT

SENT

ACCEPTED

REJECTED

INVOICED

PART_INVOICED

quote_type

string

Enumeration:

COST

SALE

total_amount

number

total_discount

number

lines

integer int32

created_on

string date-time

expiration_date

string date-time

total_net

number

total_tax

number

salesperson

Id name

term

string

Object

id

string

name

string

email

string

phone

string

formatted_address

string

job_types

Array of Id name

Object

total_pages

integer int32

total_elements

integer int64

pageable

Pageable object

number_of_elements

integer int32

first

boolean

last

boolean

sort

Sort object

number

integer int32

content

Array of Activity list response

size

integer int32

empty

boolean

Object

id

string

name

string

account_type

string

Enumeration:

SALES

COG

integration

Id name external reference

Object

id

string

name

string required

description

string

is_default

boolean required

Object

id

string

name

string

on_name

string

on_description

string

off_name

string

off_description

string

isOn

boolean

on

boolean

Object

id

string

external_reference

string

name

string

Object

id

string

name

string

description

string

usage

string

Enumeration:

SINGLE

BUNDLE

EXPENSE

COMPONENT

SERIES

Object

id

string

name

string

description

string

long_description

string

language

string

priority

integer int32

Object

id

string

name

string

integration

Products integration

created_on

string date-time

description

string

business_type

string

Enumeration:

TV

ENTERTAINMENT

FIXED_LINE

MOBILE

BROADBAND

DATA

ENERGY

FOOD_DRINK

SAAS

DIGITAL

REWARDS

NFT

ECO

product_type

string

Enumeration:

PHYSICAL

SERVICE

EXPENSE

EVENT

USAGE

DIGITAL

sold_as

string

Enumeration:

SINGLE

BUNDLE

EXPENSE

COMPONENT

SERVICE

sku

string

families

Array of Family response

Unique items: YES

specifications

Array of Specification

brands

Array of Brand

Unique items: YES

term

Term

pricing

Array of Product price

Unique items: YES

features

Array of Product feature

Unique items: YES

filters

Array of Filter self

Unique items: YES

components

integer int32

variants

integer int32

priority

integer int32

is_paused

boolean

image

Creatives