Proptech

Suspend Workitem

PUT /workitems/{id}/suspension

Update Workitem Owners

PUT /workitems/{id}/owners

getWorkitems

GET /workitems

createWorkitem

POST /workitems

getWorkitemProgress

GET /workitems/{id}/progress

progressWorkitem

POST /workitems/{id}/progress

moveWorkitem

POST /workitems/{id}/move

getWorkitem

GET /workitems/{id}

getAccess

GET /workitems/{id}/access

getStageWorkitemsV2

GET /v2/stages/{id}/workitems

getStageWorkitems

GET /stages/{id}/workitems

PUT /workitems/{id}/suspension

This api requires WORKITEMS_MANAGE permission.

null

Path variables

id

string required

Request body

application/json

id

string required

Request body

application/json

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

application/json

id

id

string required

Request body

application/json

id

string required

Request body

application/json

id

id

string required

Request parameters

search

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

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

*/*

PageWorkitemResponseDto

getWorkflow

GET /workflows/{id}

updateWorkflow

PUT /workflows/{id}

deleteWorkflow

DELETE /workflows/{id}

getWorkflowStages

GET /workflows/{id}/stages

createStage

POST /workflows/{id}/stages

updateStage

PUT /workflows/{id}/stages

updateLifecycle

PUT /workflows/{id}/lifecycle

getWorkflows

GET /workflows

createWorkflow

POST /workflows

cloneWorkflow

POST /workflows/{id}/clone

GET /workflows/{id}

This api requires WORKFLOWS_VIEW permission.

null

Path variables

id

id

string required

Request body

application/json

id

*/*

RestMicroserviceException

200 200

OK

GET /workflows/{id}/stages

This api requires WORKFLOWS_VIEW permission.

null

Path variables

id

string required

Request parameters

stage_type

array of string optional

search

id

string required

Request body

application/json

id

string required

Request body

application/json

id

string required

Request body

application/json

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

application/json

id

string required

Request body

application/json

*/*

WorkflowDto

updateBoardOrder

PUT /users/{id}/boards/order

getBoards

GET /users/{id}/boards

PUT /users/{id}/boards/order

This api requires BOARDS_VIEW, BOARDS_MANAGE permission.

null

Path variables

id

string required

Request body

application/json

*/*

RestMicroserviceException

200 200

OK

GET /users/{id}/boards

This api requires BOARDS_VIEW, BOARDS_MANAGE permission.

null

Path variables

id

string required

Request parameters

board_type

string optional

Enumeration:

OPPORTUNITY

JOB

*/*

Array of BoardSummary

getTask

GET /tasks/{id}

updateTask

PUT /tasks/{id}

deleteTask

DELETE /tasks/{id}

getEventTasks

GET /tasks

createTask

POST /tasks

deleteTasks

DELETE /tasks

progressTask

POST /tasks/{id}/progress

getSubtasks

GET /tasks/{id}/tasks

getEvidence

GET /tasks/{id}/evidence

GET /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.

null

Path variables

id

id

string required

Request body

application/json

id

*/*

RestMicroserviceException

200 200

OK

GET /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.

null

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

application/json

application/json

*/*

RestMicroserviceException

200 200

OK

POST /tasks/{id}/progress

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

null

Path variables

id

string required

Request body

application/json

id

id

fid

sid

string required

fid

string required

Request body

application/json

sid

string required

fid

*/*

RestMicroserviceException

200 200

OK

GET /solar_designs/{sid}/financials

This api requires LEAD_DESIGNS_VIEW,JOB_DESIGNS_VIEW,OPPORTUNITY_DESIGNS_VIEW permission.

null

Path variables

sid

sid

string required

Request body

application/json

*/*

FinancialDesignResponse

updateRoof

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

deleteRoof

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

getRoofPanels

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

addRoofPanels

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

updateRoofPanels

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

getRoofExclusions

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

updateRoofExclusions

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

getRoofs

GET /solar_designs/{propertyId}/roofs

importRoofs

POST /solar_designs/{propertyId}/roofs

importRoofs_1

POST /solar_designs/{propertyId}/roofs/import

getRoofPanelsGeoJson

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

getRoofElevationTiff

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

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

This api requires LEAD_DESIGNS_MANAGE,JOB_DESIGNS_MANAGE,OPPORTUNITY_DESIGNS_MANAGE permission.

null

Path variables

propertyId

string required

roofId

string required

Request body

application/json

propertyId

string required

roofId

*/*

RestMicroserviceException

200 200

OK

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

This api requires LEAD_DESIGNS_VIEW,JOB_DESIGNS_VIEW,OPPORTUNITY_DESIGNS_VIEW permission.

null

Path variables

propertyId

string required

roofId

string required

Request parameters

source

string optional

Enumeration:

MANUAL

propertyId

string required

roofId

string required

Request parameters

source

string optional

Enumeration:

MANUAL

IMPORTED

Request body

application/json

propertyId

string required

roofId

string required

Request parameters

source

string optional

Enumeration:

MANUAL

IMPORTED

Request body

application/json

propertyId

string required

roofId

propertyId

string required

roofId

string required

Request body

application/json

propertyId

propertyId

string required

Request body

application/json

propertyId

string required

Request body

application/json

propertyId

string required

roofId

propertyId

string required

roofId

image/tiff

string byte

update3dRoofs

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

delete3dRoofs

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

get3dRoofs

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

add3dRoofs

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

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

This api requires LEAD_DESIGNS_MANAGE,JOB_DESIGNS_MANAGE,OPPORTUNITY_DESIGNS_MANAGE permission.

null

Path variables

id

string required

roofId

string required

Request body

application/json

id

string required

roofId

*/*

RestMicroserviceException

200 200

OK

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

This api requires LEAD_DESIGNS_VIEW,JOB_DESIGNS_VIEW,OPPORTUNITY_DESIGNS_VIEW permission.

null

Path variables

id

id

string required

Request body

application/json

*/*

Roof3dResponse

getLosses

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

updateLosses

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

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

This api requires LEAD_DESIGNS_VIEW,JOB_DESIGNS_VIEW,OPPORTUNITY_DESIGNS_VIEW permission.

null

Path variables

designId

string required

roofId

designId

string required

roofId

string required

Request body

application/json

*/*

LossRequest

getObstacles

GET /solar_designs/{designId}/obstacles

updateObstacle

PUT /solar_designs/{designId}/obstacles

GET /solar_designs/{designId}/obstacles

This api requires LEAD_DESIGNS_VIEW,JOB_DESIGNS_VIEW,OPPORTUNITY_DESIGNS_VIEW permission.

null

Path variables

designId

string required

Request parameters

roof_id

string optional

max_distance

designId

string required

Request body

application/json

inventoryId

string required

Request body

application/json

id

string required

inventoryId

*/*

RestMicroserviceException

200 200

OK

GET /sites/{id}/inventory

This api requires INVENTORY_VIEW permission.

null

Path variables

id

id

string required

Request body

application/json

deleteEnergyCost

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

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

This api requires PROPERTIES_VIEW,PROPERTIES_VIEW_OWN permission.

null

Path variables

pid

string required

type

string required

Enumeration:

ELECTRICITY

pid

string required

type

string required

Enumeration:

ELECTRICITY

GAS

Request body

application/json

pid

string required

type

string required

Enumeration:

ELECTRICITY

*/*

RestMicroserviceException

200 200

OK

getProperty

GET /properties/{id}

updateProperty

PUT /properties/{id}

deleteProperty

DELETE /properties/{id}

updatePropertyDetails

PUT /properties/{id}/details

getProperties

GET /properties

addProperty

POST /properties

getPropertyEpcs

GET /properties/{id}/epcs

getPropertyEngagements

GET /properties/{id}/engagements

GET /properties/{id}

This api requires PROPERTIES_VIEW,PROPERTIES_VIEW_OWN permission.

null

Path variables

id

id

string required

Request body

application/json

id

*/*

RestMicroserviceException

200 200

OK

PUT /properties/{id}/details

This api requires PROPERTIES_MANAGE permission.

null

Path variables

id

string required

Request body

application/json

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

application/json

id

id

string required

Request parameters

search

string optional

engagement_type

string optional

Enumeration:

OPPORTUNITY

JOB

LEAD

pageable

*/*

PageEngagementFullDto

updatePropertyMeters

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

deletePropertyMeters

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

getPropertyMeters

GET /properties/{id}/meters

addPropertyMeters

POST /properties/{id}/meters

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

This api requires PROPERTIES_MANAGE permission.

null

Path variables

id

string required

meterId

string required

Request body

application/json

id

string required

meterId

*/*

RestMicroserviceException

200 200

OK

GET /properties/{id}/meters

This api requires PROPERTIES_MANAGE permission.

null

Path variables

id

id

string required

Request body

application/json

*/*

PropertyMeterResponse

updateImage

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

deleteImage

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

getPropertyImages

GET /properties/{id}/images

addImage

POST /properties/{id}/images

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

null

Path variables

id

string required

imageId

string required

Request body

application/json

id

string required

imageId

*/*

RestMicroserviceException

200 200

OK

GET /properties/{id}/images

null

Path variables

id

id

string required

Request body

application/json

*/*

PropertyImageResponse

updatePropertyContact

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

getPropertyContacts

GET /properties/{id}/contacts

createPropertyContact

POST /properties/{id}/contacts

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

This api requires PROPERTY_CONTACTS_MANAGE permission.

null

Path variables

id

string required

contactId

string required

Request body

application/json

id

string required

Request parameters

search

id

string required

Request body

application/json

id

string required

Request body

application/json

id

*/*

RestMicroserviceException

200 200

OK

GET /projects

This api requires PROJECTS_VIEW permission.

null

Request parameters

search

string optional

owner_id

application/json

*/*

ProjectResponse

updatePreference

PUT /product_preferences/{id}

deletePreference

DELETE /product_preferences/{id}

getPreferences

GET /product_preferences

createPreference

POST /product_preferences

PUT /product_preferences/{id}

This api requires PRODUCT_PREFERENCES_MANAGE permission.

null

Path variables

id

string required

Request body

application/json

id

*/*

RestMicroserviceException

200 200

OK

GET /product_preferences

This api requires PRODUCT_PREFERENCES_VIEW,PRODUCTS_VIEW permission.

null

Request parameters

job_type_id

array of string optional

preference_type

string optional

Enumeration:

DESIGN

QUOTE

project_id

application/json

*/*

ProductPreferencesResponse

getPartnerDescription

GET /partners/{id}/descriptions

updatePartnerDescription

PUT /partners/{id}/descriptions

GET /partners/{id}/descriptions

null

Path variables

id

id

string required

Request body

application/json

*/*

PartnerDescriptionResponse

getOpportunity

GET /opportunities/{id}

updateOpportunity

PUT /opportunities/{id}

deleteOpportunity

DELETE /opportunities/{id}

addOpportunityJobType

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

updateOpportunityJobType

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

deleteOpportunityJobType

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

addOpportunity

POST /opportunities

getOpportunityJobs

GET /opportunities/{id}/jobs

GET /opportunities/{id}

This api requires OPPORTUNITIES_VIEW,OPPORTUNITIES_VIEW_OWN permission.

null

Path variables

id

id

string required

Request body

application/json

id

*/*

RestMicroserviceException

200 200

OK

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

This api requires OPPORTUNITIES_MANAGE permission.

null

Path variables

id

string required

jobTypeId

id

string required

jobTypeId

string required

Request body

application/json

id

string required

jobTypeId

*/*

RestMicroserviceException

200 200

OK

POST /opportunities

This api requires OPPORTUNITIES_MANAGE permission.

null

Request body

application/json

id

*/*

Array of OpportunityJobDetails

updateEngagementNote

PUT /notes/{id}

deleteEngagementNote

DELETE /notes/{id}

getEngagementNotes

GET /engagements/{engagementId}/notes

saveEngagementNote

POST /engagements/{engagementId}/notes

PUT /notes/{id}

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

null

Path variables

id

string required

Request body

application/json

id

*/*

RestMicroserviceException

200 200

OK

GET /engagements/{engagementId}/notes

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

null

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

engagementId

string required

Request body

application/json

*/*

EngagementNoteResponse

updateListView

PUT /list_views/{id}

deleteListView

DELETE /list_views/{id}

getListViews

GET /list_views

addListView

POST /list_views

PUT /list_views/{id}

This api requires LISTVIEW_MANAGE,LISTVIEW_MANAGE_OWN,LISTVIEW_MANAGE_TEAM permission.

null

Path variables

id

string required

Request body

application/json

id

*/*

RestMicroserviceException

200 200

OK

GET /list_views

This api requires LISTVIEW_VIEW,LISTVIEW_VIEW_OWN,LISTVIEW_VIEW_TEAM permission.

null

Request parameters

entity_type

string optional

Enumeration:

WORKITEMS

LEADS

OPPORTUNITIES

JOBS

PROPERTIES

view_type

string optional

Enumeration:

KANBAN

LIST

board_id

application/json

*/*

ListViewResponse

getLifecycles

GET /lifecycle_groups/{id}/lifecycles

addLifecycles

POST /lifecycle_groups/{id}/lifecycles

updateLifecycles

PUT /lifecycle_groups/{id}/lifecycles

getLifecycleGroups

GET /lifecycle_groups

addLifecycleGroup

POST /lifecycle_groups

getLifecycleGroup

GET /lifecycle_groups/{id}

deleteLifecycleGroup

DELETE /lifecycle_groups/{id}

GET /lifecycle_groups/{id}/lifecycles

This api requires LIFECYCLE_GROUPS_VIEW permission.

null

Path variables

id

id

string required

Request body

application/json

id

string required

Request body

application/json

search

string optional

lifecycle_type

string optional

Enumeration:

LEAD

JOB

OPPORTUNITY

owner_id

application/json

id

string required

Request parameters

owner_id

id

*/*

RestMicroserviceException

200 200

OK

getLead

GET /leads/{id}

updateLead

PUT /leads/{id}

deleteLead

DELETE /leads/{id}

updateLeadProperty

PUT /leads/{id}/properties

updateLeadLifecycle

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

getLeads

GET /leads

addLead

POST /leads

getChildrenOpportunities

GET /leads/{id}/opportunities

GET /leads/{id}

This api requires LEADS_VIEW,LEADS_VIEW_OWN permission.

null

Path variables

id

id

string required

Request body

application/json

id

*/*

RestMicroserviceException

200 200

OK

PUT /leads/{id}/properties

This api requires LEADS_MANAGE permission.

null

Path variables

id

string required

Request body

application/json

id

string required

lifecycleId

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

application/json

id

id

string required

Request body

application/json

id

*/*

RestMicroserviceException

200 200

OK

GET /jobs

This api requires JOBS_VIEW,JOBS_VIEW_OWN permission.

null

Request parameters

search

string optional

page

application/json

*/*

JobResponse

updateJobTypeOrganizations

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

deleteJobTypeOrganizations

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

getJobTypeServices

GET /job_types/{id}/services

addJobTypeServices

POST /job_types/{id}/services

getJobTypes

GET /job_types

getJobTypeOrganizations

GET /job_types/{id}/organizations

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

This api requires JOB_TYPES_MANAGE permission.

null

Path variables

id

string required

organizationId

string required

Request body

application/json

id

string required

organizationId

*/*

RestMicroserviceException

200 200

OK

GET /job_types/{id}/services

This api requires JOB_TYPES_VIEW permission.

null

Path variables

id

string required

Request parameters

search

id

string required

Request body

application/json

search

string optional

project_id

string optional

is_default

boolean optional

owner_id

id

string required

Request parameters

engagement_id

id

string required

Request body

application/json

id

*/*

RestMicroserviceException

200 200

OK

GET /evidence_configs

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

null

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

application/json

*/*

EvidenceConfigDto

updateEvidenceConfigFilters

PUT /evidence_configs/filters

getEvidenceConfigFilters

GET /evidence_configs/{id}/filters

PUT /evidence_configs/filters

This api requires LEAD_EVIDENCE_VIEW,JOB_EVIDENCE_VIEW,OPPORTUNITY_EVIDENCE_VIEW permission.

null

Request body

application/json

id

*/*

Array of EvidenceConfigFilterResponse

geEvidence_1

GET /evidence/{id}

addEvidence

PUT /evidence/{id}

deleteEvidence

DELETE /evidence/{id}

updateEvidenceOrganizations

PUT /evidence/organizations

geEvidence

GET /evidence

addEvidence_1

POST /evidence

addEvidenceOrganizations

POST /evidence/{id}/services

download

POST /evidence/download

getEvidenceOrganizations

GET /evidence/{id}/organizations

deleteEvidenceOrganizations

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

GET /evidence/{id}

This api requires LEAD_EVIDENCE_VIEW,JOB_EVIDENCE_VIEW,OPPORTUNITY_EVIDENCE_VIEW permission.

null

Path variables

id

id

string required

Request body

application/json

id

*/*

RestMicroserviceException

200 200

OK

PUT /evidence/organizations

This api requires LEAD_EVIDENCE_MANAGE,JOB_EVIDENCE_MANAGE,OPPORTUNITY_EVIDENCE_MANAGE permission.

null

Request body

application/json

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

application/json

id

string required

Request body

application/json

application/json

*/*

RestMicroserviceException

200 200

OK

GET /evidence/{id}/organizations

This api requires LEAD_EVIDENCE_MANAGE,JOB_EVIDENCE_MANAGE,OPPORTUNITY_EVIDENCE_MANAGE permission.

null

Path variables

id

id

string required

organizationId

*/*

RestMicroserviceException

200 200

OK

getEvidenceMedia

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

updateEvidenceMedia

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

deleteEvidenceMedia

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

addEvidenceMedia

POST /evidence/{id}/media

signMedia

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

resend

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

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

This api requires LEAD_EVIDENCE_MANAGE,JOB_EVIDENCE_MANAGE,OPPORTUNITY_EVIDENCE_MANAGE permission.

null

Path variables

id

string required

mediaId

id

string required

mediaId

string required

Request body

application/json

id

string required

mediaId

*/*

RestMicroserviceException

200 200

OK

POST /evidence/{id}/media

This api requires LEAD_EVIDENCE_MANAGE,JOB_EVIDENCE_MANAGE,OPPORTUNITY_EVIDENCE_MANAGE permission.

null

Path variables

id

string required

Request body

application/json

id

string required

mediaId

string required

Request body

application/json

id

string required

mediaId

string required

Request body

application/json

*/*

EvidenceMediaResponse

getPropertyEpc

PUT /epcs/{id}

This api requires PROPERTIES_VIEW,PROPERTIES_VIEW_OWN permission.

null

Path variables

id

*/*

PropertyEpcDetails

getCustomData

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

updateCustomData

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

GET /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.

null

Path variables

id

string required

cid

string required

Request parameters

owner_id

id

string required

cid

string required

Request body

application/json

cid

id

string required

cid

string required

Request body

application/json

id

string required

cid

*/*

RestMicroserviceException

200 200

OK

GET /engagements/{id}/communications

This api requires LEAD_COMMUNICATIONS_VIEW,JOB_COMMUNICATIONS_VIEW,OPPORTUNITY_COMMUNICATIONS_VIEW permission.

null

Path variables

id

id

string required

Request body

application/json

*/*

CommunicationResponse

getSolarDesign

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

updateSolarDesign

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

deleteSolarDesign

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

getSolarDesigns

GET /engagements/{engagementId}/solar_designs

createSolarDesign

POST /engagements/{engagementId}/solar_designs

getImages

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

uploadImages

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

getSolarDesign_1

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

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

This api requires LEAD_DESIGNS_VIEW,JOB_DESIGNS_VIEW,OPPORTUNITY_DESIGNS_VIEW permission.

null

Path variables

engagementId

string required

designId

engagementId

string required

designId

string required

Request body

application/json

engagementId

string required

designId

*/*

RestMicroserviceException

200 200

OK

GET /engagements/{engagementId}/solar_designs

This api requires LEAD_DESIGNS_VIEW,JOB_DESIGNS_VIEW,OPPORTUNITY_DESIGNS_VIEW permission.

null

Path variables

engagementId

engagementId

string required

Request body

application/json

DesignCreationRequest

Responses

400 400

Bad Request

Body

*/*

RestMicroserviceException

404 404

Not Found

Body

engagementId

string required

designId

string required

Request body

application/json

*/*

RestMicroserviceException

200 200

OK

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

This api requires LEAD_DESIGNS_VIEW,JOB_DESIGNS_VIEW,OPPORTUNITY_DESIGNS_VIEW permission.

null

Path variables

engagementId

string required

designId

string required

Request parameters

month

*/*

Array of HourlySimulationResult

getSolarDesign_2

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

updateSolarDesign_1

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

deleteSolarDesign_1

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

getSolarDesigns_1

GET /engagements/{engagementId}/designs

createDesigns

POST /engagements/{engagementId}/designs

createDesignQuote

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

getImages_1

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

uploadImages_1

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

getSolarDesign_3

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

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

This api requires LEAD_DESIGNS_VIEW,JOB_DESIGNS_VIEW,OPPORTUNITY_DESIGNS_VIEW permission.

null

Path variables

engagementId

string required

designId

engagementId

string required

designId

string required

Request body

application/json

engagementId

string required

designId

*/*

RestMicroserviceException

200 200

OK

GET /engagements/{engagementId}/designs

This api requires LEAD_DESIGNS_VIEW,JOB_DESIGNS_VIEW,OPPORTUNITY_DESIGNS_VIEW permission.

null

Path variables

engagementId

string required

Request parameters

design_type

string optional

Enumeration:

SOLAR

SOLAR_3D

engagementId

string required

Request body

application/json

engagementId

string required

id

string required

Responses

400 400

Bad Request

Body

*/*

RestMicroserviceException

404 404

Not Found

Body

engagementId

string required

designId

string required

Request body

application/json

*/*

RestMicroserviceException

200 200

OK

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

This api requires LEAD_DESIGNS_VIEW,JOB_DESIGNS_VIEW,OPPORTUNITY_DESIGNS_VIEW permission.

null

Path variables

engagementId

string required

designId

string required

Request parameters

month

id

string required

Request body

application/json

energy_type

string required

Enumeration:

ELECTRICITY

application/json

id

string required

Request parameters

account_id

fid

sid

string required

fid

string required

Request body

application/json

sid

string required

fid

*/*

RestMicroserviceException

200 200

OK

GET /designs/{sid}/financials

This api requires LEAD_DESIGNS_VIEW,JOB_DESIGNS_VIEW,OPPORTUNITY_DESIGNS_VIEW permission.

null

Path variables

sid

sid

string required

Request body

application/json

*/*

FinancialDesignResponse

updateRoof_1

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

deleteRoof_1

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

getRoofPanels_1

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

addRoofPanels_1

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

updateRoofPanels_1

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

getRoofExclusions_1

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

updateRoofExclusions_1

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

getRoofs_1

GET /designs/{propertyId}/roofs

importRoofs_2

POST /designs/{propertyId}/roofs

importRoofs_3

POST /designs/{propertyId}/roofs/import

getRoofPanelsGeoJson_1

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

getRoofElevationTiff_1

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

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

This api requires LEAD_DESIGNS_MANAGE,JOB_DESIGNS_MANAGE,OPPORTUNITY_DESIGNS_MANAGE permission.

null

Path variables

propertyId

string required

roofId

string required

Request body

application/json

propertyId

string required

roofId

*/*

RestMicroserviceException

200 200

OK

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

This api requires LEAD_DESIGNS_VIEW,JOB_DESIGNS_VIEW,OPPORTUNITY_DESIGNS_VIEW permission.

null

Path variables

propertyId

string required

roofId

string required

Request parameters

source

string optional

Enumeration:

MANUAL

propertyId

string required

roofId

string required

Request parameters

source

string optional

Enumeration:

MANUAL

IMPORTED

Request body

application/json

propertyId

string required

roofId

string required

Request parameters

source

string optional

Enumeration:

MANUAL

IMPORTED

Request body

application/json

propertyId

string required

roofId

propertyId

string required

roofId

string required

Request body

application/json

propertyId

propertyId

string required

Request body

application/json

propertyId

string required

Request body

application/json

propertyId

string required

roofId

propertyId

string required

roofId

image/tiff

string byte

getDiagram

GET /designs/{id}/diagrams

updateDiagram

PUT /designs/{id}/diagrams

GET /designs/{id}/diagrams

This api requires LEAD_DESIGNS_VIEW,JOB_DESIGNS_VIEW,OPPORTUNITY_DESIGNS_VIEW permission.

null

Path variables

id

id

string required

Request body

application/json

*/*

DiagramDto

update

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

deleteSimulation

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

getSimulations

GET /designs/{did}/solar_simulations

runSimulation

POST /designs/{did}/solar_simulations

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

This api requires LEAD_DESIGNS_MANAGE,JOB_DESIGNS_MANAGE,OPPORTUNITY_DESIGNS_MANAGE permission.

null

Path variables

did

string required

sid

string required

Request body

application/json

did

string required

sid

*/*

RestMicroserviceException

200 200

OK

GET /designs/{did}/solar_simulations

This api requires LEAD_DESIGNS_VIEW,JOB_DESIGNS_VIEW,OPPORTUNITY_DESIGNS_VIEW permission.

null

Path variables

did

did

string required

Request body

application/json

*/*

SimulationSummary

update3dRoofStrings

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

delete3dRoofStrings

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

get3dRoofStrings

GET /designs/{designId}/strings

add3dRoofStrings

POST /designs/{designId}/strings

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

This api requires LEAD_DESIGNS_MANAGE,JOB_DESIGNS_MANAGE,OPPORTUNITY_DESIGNS_MANAGE permission.

null

Path variables

designId

string required

stringId

string required

Request body

application/json

designId

string required

stringId

*/*

RestMicroserviceException

200 200

OK

GET /designs/{designId}/strings

This api requires LEAD_DESIGNS_VIEW,JOB_DESIGNS_VIEW,OPPORTUNITY_DESIGNS_VIEW permission.

null

Path variables

designId

designId

string required

Request body

application/json

application/json

PanelStringResponseDto

getLosses_1

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

updateLosses_1

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

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

This api requires LEAD_DESIGNS_VIEW,JOB_DESIGNS_VIEW,OPPORTUNITY_DESIGNS_VIEW permission.

null

Path variables

designId

string required

roofId

designId

string required

roofId

string required

Request body

application/json

*/*

LossRequest

updatePanel

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

deletePanel

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

addPanel

POST /designs/{designId}/panels

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

null

Path variables

designId

string required

id

string required

Request body

application/json

designId

string required

id

*/*

RestMicroserviceException

200 200

OK

POST /designs/{designId}/panels

null

Path variables

designId

string required

Request body

application/json

*/*

Object

getObstacles_1

GET /designs/{designId}/obstacles

updateObstacle_1

PUT /designs/{designId}/obstacles

GET /designs/{designId}/obstacles

This api requires LEAD_DESIGNS_VIEW,JOB_DESIGNS_VIEW,OPPORTUNITY_DESIGNS_VIEW permission.

null

Path variables

designId

string required

Request parameters

roof_id

string optional

max_distance

designId

string required

Request body

application/json

*/*

Array of ObstacleResponse

updateInverter

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

deleteInverter

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

addInverter

POST /designs/{designId}/inverters

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

null

Path variables

designId

string required

id

string required

Request body

application/json

designId

string required

id

*/*

RestMicroserviceException

200 200

OK

POST /designs/{designId}/inverters

null

Path variables

designId

string required

Request body

application/json

*/*

Object

updateEvCharger

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

deleteEvCharger

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

addEvCharger

POST /designs/{designId}/ev_chargers

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

null

Path variables

designId

string required

id

string required

Request body

application/json

designId

string required

id

*/*

RestMicroserviceException

200 200

OK

POST /designs/{designId}/ev_chargers

null

Path variables

designId

string required

Request body

application/json

*/*

Object

updateBattery

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

deleteBattery

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

addBattery

POST /designs/{designId}/batteries

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

null

Path variables

designId

string required

id

string required

Request body

application/json

designId

string required

id

*/*

RestMicroserviceException

200 200

OK

POST /designs/{designId}/batteries

null

Path variables

designId

string required

Request body

application/json

*/*

Object

getBoard

GET /boards/{id}

updateBoard

PUT /boards/{id}

deleteBoard

DELETE /boards/{id}

getBoardStages

GET /boards/{id}/stages

updateBoardStages

PUT /boards/{id}/stages

getBoardAccess

GET /boards/{id}/access

updateBoardAccess

PUT /boards/{id}/access

getBoards_1

GET /boards

createBoard

POST /boards

addBoardOrganizations

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

deleteBoardOrganizations

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

getBoardWorkitems

GET /boards/{id}/workitems

getBoardOrganizations

GET /boards/{id}/organizations

GET /boards/{id}

This api requires BOARDS_VIEW permission.

null

Path variables

id

id

string required

Request body

application/json

id

*/*

RestMicroserviceException

200 200

OK

GET /boards/{id}/stages

This api requires BOARDS_VIEW permission.

null

Path variables

id

string required

Request parameters

stage_type

string optional

Enumeration:

CREATOR

SPLIT

RENDEZVOUS

NORMAL

TRANSITION

ARCHIVE

id

string required

Request body

application/json

id

id

string required

Request body

application/json

application/json

id

string required

organizationId

id

string required

organizationId

*/*

RestMicroserviceException

200 200

OK

GET /boards/{id}/workitems

This api requires BOARDS_VIEW permission.

null

Path variables

id

string required

Request parameters

search

string optional

stage_id

id

*/*

Array of IdNameDto

getActivityType

GET /activity_types/{id}

updateActivityType

PUT /activity_types/{id}

deleteActivityType

DELETE /activity_types/{id}

addActivityTypeOrganizations

POST /organizations/{id}/activity_types

getActivityTypes

GET /activity_types

addActivityType

POST /activity_types

getActivityTypeServices

GET /activity_types/{id}/services

GET /activity_types/{id}

This api requires JOB_TYPES_VIEW permission.

null

Path variables

id

id

string required

Request body

application/json

id

*/*

RestMicroserviceException

200 200

OK

POST /organizations/{id}/activity_types

This api requires JOB_TYPES_MANAGE permission.

null

Path variables

id

string required

Request body

application/json

project_id

string optional

job_type_id

array of string optional

engagement_type

string optional

Enumeration:

OPPORTUNITY

JOB

LEAD

is_default

application/json

id

*/*

Array of ActivityTypeServiceResponse

getEvent

GET /activities/{id}

updateActivity

PUT /activities/{id}

updateActivityTasks

PUT /activities/{id}/tasks

updateActivityStatus

PUT /activities/{id}/status

updateActivityCreator

PUT /activities/{id}/creator

getActivities_1

GET /activities

addActivity

POST /activities

getUserEvents

GET /users/{id}/activities

getActivities

GET /engagements/{id}/activities

getActivityOffline

GET /activities/{id}/offline

GET /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.

null

Path variables

id

id

string required

Request body

application/json

id

string required

Request body

application/json

id

string required

Request body

application/json

id

string required

Request body

application/json

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

application/json

id

string required

Request parameters

event_date.start

integer int64 optional

event_date.end

integer int64 optional

status

array of string optional

pageable

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

id

*/*

ActivityResponseOffline

updateEventTasks

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

null

Path variables

id

string required

taskId

string required

Request body

application/json

*/*

EventTaskResponse

updateActivityResource

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

deleteActivityResource

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

getActivityResource

GET /activities/{id}/resources

addActivityResource

POST /activities/{id}/resources

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

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

null

Path variables

id

string required

resourceId

string required

Request body

application/json

id

string required

resourceId

*/*

RestMicroserviceException

200 200

OK

GET /activities/{id}/resources

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

null

Path variables

id

id

string required

Request body

application/json

*/*

ActivityResourceResponse

getLosses_2

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

updateLosses_2

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

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

This api requires LEAD_DESIGNS_VIEW,JOB_DESIGNS_VIEW,OPPORTUNITY_DESIGNS_VIEW permission.

null

Path variables

segment

segment

string required

Request body

application/json

*/*

LossRequest

get3dGroups

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

add3dGroups

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

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

This api requires LEAD_DESIGNS_VIEW,JOB_DESIGNS_VIEW,OPPORTUNITY_DESIGNS_VIEW permission.

null

Path variables

id

id

string required

Request body

application/json

segmentId

string required

Request body

application/json

id

string required

segmentId

*/*

RestMicroserviceException

200 200

OK

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

This api requires LEAD_DESIGNS_VIEW,JOB_DESIGNS_VIEW,OPPORTUNITY_DESIGNS_VIEW permission.

null

Path variables

id

id

string required

Request body

application/json

id

string required

segmentId

*/*

RestMicroserviceException

200 200

OK

Body

image/tiff

string byte

getWeatherData

GET /weather_data

saveWeatherData

POST /weather_data

getAvailableYears

GET /weather_data/available_years

GET /weather_data

This api requires WEATHER_DATA_VIEW permission.

null

Request parameters

radius

number double optional

lat

number optional

lon

number optional

year

application/json

GET /task_config_groups

POST /task_config_groups/{id}/task_configs

This api requires TASKS_CONFIG_MANAGE permission.

null

Path variables

id

string required

Request body

application/json

job_type_id

string optional

service_id

string optional

stage_id

string optional

contract_id

*/*

Array of TaskConfigGroupResponse

getRoutes

GET /stages/{id}/decisions

addRoutes

POST /stages/{id}/decisions

getStage

GET /stages/{id}

getStageRoutes

GET /stages/{id}/routes

GET /stages/{id}/decisions

This api requires WORKFLOWS_VIEW permission.

null

Path variables

id

string required

Request parameters

board_id

id

string required

Request body

application/json

id

id

*/*

StageRouteResponse

addSolarSimulation

POST /solar_simulations

This api requires LEAD_DESIGNS_MANAGE,JOB_DESIGNS_MANAGE,OPPORTUNITY_DESIGNS_MANAGE permission.

null

Request body

application/json

*/*

RestMicroserviceException

200 200

OK

migrateFinancialDesigns

POST /solar_designs/financial/migrate

*/*

RestMicroserviceException

200 200

OK

reingest

POST /sites/{siteId}/reingest

getEnergyReadingsV2

GET /v2/energy_readings

getSitePower

GET /sites/{siteId}/power

getEnergySummary

GET /sites/{id}/energy_summary

getPowerStatus

GET /power_status

getPowerReadings

GET /power_readings/{type}

getEnergySummaryLast3h

GET /energy_summary

getEnergySummaryTop10

GET /energy_summary/top10

getEnergySummaryLast3h_1

GET /energy_summary/last3h

getEnergySummaryGeneration

GET /energy_summary/generation

getEnergyReadings_2

GET /energy_readings

getEnergyReading

GET /energy_readings/{type}

POST /sites/{siteId}/reingest

This api requires ENERGY_READING_MANAGE permission.

null

Path variables

siteId

string required

Request body

application/json

*/*

RestMicroserviceException

200 200

OK

GET /v2/energy_readings

This api requires ENERGY_READING_VIEW permission.

null

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

siteId

string required

Request parameters

start_date

integer int64 required

end_date

integer int64 required

reading_type

id

string required

Request parameters

interval

string optional

Enumeration:

HALF_HOUR

HOUR

DAY

WEEK

MONTH

YEAR

site_id

string optional

meter_id

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

start_date

integer int64 required

end_date

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

*/*

Array

Object

GET /energy_readings/{type}

This api requires ENERGY_READING_VIEW permission.

null

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

*/*

Array of EnergyReadingResponse

getScreens

GET /self-service/screens

addScreen

POST /self-service/screens

getScreen

GET /self-service/screens/{id}

deleteScreen

DELETE /self-service/screens/{id}

GET /self-service/screens

application/json

id

id

*/*

RestMicroserviceException

200 200

OK

progress

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

getDecisions

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

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

This api requires SELF_SERVICE_ENABLEMENT_PROGRESS permission.

null

Path variables

id

string required

Request body

application/json

*/*

RestMicroserviceException

200 200

OK

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

This api requires SELF_SERVICE_ENABLEMENT_PROGRESS permission.

null

Path variables

id

application/json

Host

string required

Origin

string optional

Request body

application/json

id

id

*/*

RestMicroserviceException

200 200

OK

addPropertyOrganization

POST /properties/{id}/organizations

deletePropertyOrganization

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

POST /properties/{id}/organizations

This api requires PROPERTIES_MANAGE permission.

null

Path variables

id

string required

Request body

application/json

*/*

RestMicroserviceException

200 200

OK

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

This api requires PROPERTIES_MANAGE permission.

null

Path variables

id

string required

orgId

*/*

RestMicroserviceException

200 200

OK

getEnergyConsumption

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

createEnergyConsumption

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

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

This api requires PROPERTIES_VIEW,PROPERTIES_VIEW_OWN permission.

null

Path variables

id

string required

type

string required

Enumeration:

ELECTRICITY

GAS

Request parameters

unit

string required

Enumeration:

YEAR

QUARTER

MONTH

meter_id

id

string required

type

string required

Enumeration:

ELECTRICITY

GAS

Request body

application/json

*/*

RestMicroserviceException

200 200

OK

addProjectOrganizations

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

deleteProjectOrganizations

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

getProjectOrganizations

GET /projects/{id}/organizations

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

This api requires PROJECTS_MANAGE permission.

null

Path variables

id

string required

organizationId

*/*

RestMicroserviceException

200 200

OK

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

This api requires PROJECTS_MANAGE permission.

null

Path variables

id

string required

organizationId

*/*

RestMicroserviceException

200 200

OK

GET /projects/{id}/organizations

This api requires PROJECTS_VIEW permission.

null

Path variables

id

*/*

Array of IdNameDto

addOrganizationJobTypes

POST /organizations/{id}/job_types

This api requires JOB_TYPES_MANAGE permission.

null

Path variables

id

string required

Request body

application/json

*/*

Array of IdNameDescriptionDto

createSolarQuote

POST /jobs/{id}/solar_quote

getSolarOptions

GET /solar_designs/{id}/solar_options

getDefaultSolarOptions

GET /properties/{id}/solar_options

getDesignOptions

GET /designs/{id}/solar_options

POST /jobs/{id}/solar_quote

This api requires LEAD_DESIGNS_MANAGE,JOB_DESIGNS_MANAGE,OPPORTUNITY_DESIGNS_MANAGE permission.

null

Path variables

id

string required

Request body

application/json

*/*

RestMicroserviceException

200 200

OK

GET /solar_designs/{id}/solar_options

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

null

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

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

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

*/*

SolarOptionsResponse

recalculateSolarDesign

POST /interservice/solar_design/recalculate

recalculateSolarDesign_1

POST /interservice/solar_design/recalculate/{id}

recalculateSolarDesignFrom

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

POST /interservice/solar_design/recalculate

*/*

RestMicroserviceException

200 200

OK

POST /interservice/solar_design/recalculate/{id}

null

Path variables

id

*/*

RestMicroserviceException

200 200

OK

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

null

Path variables

id

*/*

RestMicroserviceException

200 200

OK

backfillWeather

POST /internal/sites/{id}/backfill_weather

getWeatherHistory

GET /sites/{id}/weather_history

POST /internal/sites/{id}/backfill_weather

null

Path variables

id

*/*

RestMicroserviceException

200 200

OK

GET /sites/{id}/weather_history

This api requires SITES_VIEW permission.

null

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

*/*

SitePastWeatherResponse

generate

POST /internal/exp/gen

null

Request parameters

start

*/*

RestMicroserviceException

200 200

OK

getEvidenceCategories

GET /evidence_category

addEvidenceCategories

POST /evidence_category

GET /evidence_category

This api requires EVIDENCE_CATEGORY_VIEW,EVIDENCE_VIEW permission.

null

Request parameters

engagement_id

string optional

is_default

boolean optional

job_type_id

array of string optional

parent_id

string optional

include_children

application/json

*/*

EvidenceCategoryResponse

getEngagementQuote

GET /engagements/{id}/quotes

createEngagementQuote

POST /engagements/{id}/quotes

GET /engagements/{id}/quotes

This api requires LEAD_QUOTES_VIEW,JOB_QUOTES_VIEW,OPPORTUNITY_QUOTES_VIEW permission.

null

Path variables

id

id

string required

Request body

application/json

*/*

QuoteResponse

getEngagementPartners

GET /engagements/{id}/partners

createEngagementPartner

POST /engagements/{id}/partners

deleteEngagementPartner

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

GET /engagements/{id}/partners

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

null

Path variables

id

id

string required

Request body

application/json

id

string required

partnerId

*/*

RestMicroserviceException

200 200

OK

getCustomForms

GET /engagements/{id}/custom_forms

saveCustomForm

POST /engagements/{id}/custom_forms

attachCustomForm

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

detachCustomForm

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

GET /engagements/{id}/custom_forms

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

null

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

id

string required

Request body

application/json

id

string required

cid

*/*

RestMicroserviceException

200 200

OK

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

This api requires LEAD_CUSTOM_FORMS_MANAGE,JOB_CUSTOM_FORMS_MANAGE,OPPORTUNITY_CUSTOM_FORMS_MANAGE permission.

null

Path variables

id

string required

cid

*/*

RestMicroserviceException

200 200

OK

getCosts

GET /engagements/{id}/costs

createCost

POST /engagements/{id}/costs

GET /engagements/{id}/costs

This api requires JOB_COSTS_VIEW permission.

null

Path variables

id

id

string required

Request body

application/json

*/*

CostDto

addEngagementEvidence

POST /engagements/{engagementId}/evidence

sendEvidence

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

deleteEngagementEvidence

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

POST /engagements/{engagementId}/evidence

This api requires LEAD_EVIDENCE_MANAGE,JOB_EVIDENCE_MANAGE,OPPORTUNITY_EVIDENCE_MANAGE permission.

null

Path variables

engagementId

string required

Request body

application/json

*/*

RestMicroserviceException

200 200

OK

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

This api requires LEAD_EVIDENCE_MANAGE,JOB_EVIDENCE_MANAGE,OPPORTUNITY_EVIDENCE_MANAGE permission.

null

Path variables

engagementId

string required

id

string required

Request body

application/json

*/*

RestMicroserviceException

200 200

OK

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

This api requires LEAD_EVIDENCE_MANAGE,JOB_EVIDENCE_MANAGE,OPPORTUNITY_EVIDENCE_MANAGE permission.

null

Path variables

engagementId

string required

id

*/*

RestMicroserviceException

200 200

OK

createEvidence

POST /engagements/{engagementId}/evidence/generate

This api requires LEAD_DESIGNS_MANAGE,JOB_DESIGNS_MANAGE,OPPORTUNITY_DESIGNS_MANAGE permission.

null

Path variables

engagementId

string required

Request body

application/json

*/*

EvidenceResponse

generateBill

POST /energy_bills

This api requires ENERGY_BILLS_MANAGE permission.

null

Request body

application/json

*/*

BillResponse

addDesignMeter

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

deleteDesignMeter

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

getDesignMeters

GET /designs/{id}/meters

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

This api requires LEAD_DESIGNS_MANAGE,JOB_DESIGNS_MANAGE,OPPORTUNITY_DESIGNS_MANAGE permission.

null

Path variables

id

string required

meterId

id

string required

meterId

*/*

RestMicroserviceException

200 200

OK

GET /designs/{id}/meters

This api requires LEAD_DESIGNS_MANAGE,JOB_DESIGNS_MANAGE,OPPORTUNITY_DESIGNS_MANAGE permission.

null

Path variables

id

*/*

Array of PropertyMeterResponse

createLoad

POST /designs/{id}/loads

This api requires LEAD_DESIGNS_MANAGE,JOB_DESIGNS_MANAGE,OPPORTUNITY_DESIGNS_MANAGE permission.

null

Path variables

id

string required

Request body

application/json

*/*

RestMicroserviceException

200 200

OK

reconfigure

POST /connector/integration/{integration}/reconfigure

execute

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

enable

POST /connector/integration/{integration}/enable

disable

POST /connector/integration/{integration}/disable

getActionConfig

POST /connector/config/action/{action}

getListValues

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

getConnectorConfigs

GET /connector/config/connector

getActionTypes

GET /connector/config/actions

POST /connector/integration/{integration}/reconfigure

null

Path variables

integration

string required

Request body

application/json

*/*

RestMicroserviceException

200 200

OK

POST /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

integration

string required

Request body

application/json

*/*

RestMicroserviceException

200 200

OK

POST /connector/integration/{integration}/disable

null

Path variables

integration

string required

Request body

application/json

*/*

RestMicroserviceException

200 200

OK

POST /connector/config/action/{action}

null

Path variables

action

string required

Request body

application/json

action

string required

param

string required

Request parameters

search

string optional

Request body

application/json

*/*

Array

Object

GET /connector/config/connector

COMPLETE_TASK

GENERATE_EVIDENCE

SIGN_EVIDENCE

getCampaigns

GET /campaigns

addCampaigns

POST /campaigns

deleteCampaigns

DELETE /campaigns/{id}

GET /campaigns

This api requires CAMPAIGNS_VIEW permission.

null

Request parameters

owner_id

application/json

id

*/*

RestMicroserviceException

200 200

OK

addCampaignOrganizations

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

deleteCampaignOrganizations

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

getCampaignOrganizations

GET /campaigns/{id}/organizations

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

This api requires CAMPAIGNS_MANAGE permission.

null

Path variables

id

string required

organizationId

*/*

RestMicroserviceException

200 200

OK

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

This api requires CAMPAIGNS_MANAGE permission.

null

Path variables

id

string required

organizationId

*/*

RestMicroserviceException

200 200

OK

GET /campaigns/{id}/organizations

This api requires CAMPAIGNS_VIEW permission.

null

Path variables

id

*/*

Array of IdNameDto

createEvidencePack

POST /activities/{id}/evidence_packs

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

null

Path variables

id

string required

Request body

application/json

*/*

EvidenceResponse

getSites

GET /v2/sites

getSubSites

GET /v2/sites/{id}/sites

GET /v2/sites

This api requires SITES_VIEW permission.

null

Request parameters

search

string optional

status

array of string optional

size.min

number optional

size.max

number optional

page

id

string required

Request parameters

search

string optional

page

*/*

PageSiteResponseV2

getTaskConfigs

GET /task_configs

getTaskConfig

GET /task_configs/{id}

GET /task_configs

This api requires TASKS_CONFIG_VIEW permission.

null

Request parameters

task_config_group_id

string optional

parent_id

id

page

id

id

string required

Request parameters

search

string optional

page

*/*

Array of AccountSummary

getMeters

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

getMeters_1

GET /sites/{id}/meters

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

This api requires SITES_VIEW,SELF_CONTACT_MANAGE permission.

null

Path variables

id

string required

Request parameters

control

id

*/*

Array of MeterResponse

getSiteWeather

GET /sites/{id}/weather_forecast

This api requires SITES_VIEW permission.

null

Path variables

id

*/*

SiteWeatherResponse

getSiteSimulationData

GET /sites/simulation_data

This api requires SITES_VIEW permission.

null

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

*/*

SiteSimulationResponse

getSiteDetails

GET /self-service/sites/details

*/*

SiteDetails

getEnergySummary_1

GET /self-service/energy_summary

getEnergyReadings

GET /self-service/energy_readings

getEnergyReadings_1

GET /self-service/energy_readings/{type}

GET /self-service/energy_summary

This api requires SELF_CONTACT_MANAGE, SCREEN_SITE_VIEW permission.

null

Request parameters

site_id

string optional

interval

string optional

Enumeration:

HALF_HOUR

HOUR

DAY

WEEK

MONTH

YEAR

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

*/*

Array

Object

GET /self-service/energy_readings/{type}

This api requires SELF_CONTACT_MANAGE, SCREEN_SITE_VIEW permission.

null

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

*/*

Array of EnergyReadingResponse

getRoute

GET /routes/{id}

null

Path variables

id

*/*

RoutesResponse

getContacts

GET /proptech/contacts

This api requires CONTACTS_VIEW permission.

null

Request parameters

search

string optional

lifecycle_id

string optional

sort_by

string optional

engagement_type

array of string optional

order_by

string optional

pageable

*/*

PageProptechContactResponse

getCancelReasons

GET /proptech/cancel_reasons

*/*

Array of CancelReasonsDto

getSolarPerformance

GET /properties/{id}/solar_performance

This api requires PROPERTIES_VIEW,PUBLIC_SOLAR_OPTIONS_VIEW permission.

null

Path variables

id

*/*

SolarPerformanceResponse

getLexiconValues

GET /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

*/*

Array of IdNameDto

getTopics

GET /interservice/ably/authentication

*/*

Array of string

getQuoteEngagement

GET /internal/quotes/{id}/engagements

null

Path variables

id

engagement_type

string optional

Enumeration:

OPPORTUNITY

JOB

LEAD

pageable

id

id

string required

Request parameters

job_type_id

id

string required

Request parameters

team_id

string optional

search

engagementId

string required

organizationId

*/*

RestMicroserviceException

200 200

OK

getConsumptionPatterns

GET /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

*/*

Array of IdNameDto

getCustomForms_1

GET /custom_forms

This api requires JOBS_VIEW,LEADS_VIEW,OPPORTUNITIES_VIEW permission.

null

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

*/*

Array of CustomFieldsFormResponse

getAvailableGroups

GET /available_columns/{entity}

null

Path variables

entity

string required

Request parameters

search

*/*

AvailableColumnResponse

getAvailabilities

GET /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

*/*

Array of AvailabilityResponse

getAccountSite

GET /accounts/{id}/sites

This api requires SITES_VIEW,SELF_CONTACT_MANAGE permission.

null

Path variables

id

*/*

SiteResponse

getAccountTariffs

GET /accounts/{id}/energy_tariffs

This api requires ENERGY_TARIFFS_VIEW,SELF_CONTACT_MANAGE permission.

null

Path variables

id

*/*

Array of AccountEnergyTariffResponse

getEnergyRevenue

GET /accounts/{accountId}/energy_revenue

This api requires ACCOUNTS_VIEW,SELF_CONTACT_MANAGE permission.

null

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

*/*

AccountRevenueResponse

Object

field

string

message

string

Object

is4xxClientError

boolean

is5xxServerError

boolean

is1xxInformational

boolean

is2xxSuccessful

boolean

is3xxRedirection

boolean

error

boolean

Object

response

string

error_code

HttpStatusCode

error_description

string

field_errors

Array of FieldErrorMessage

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

LocationDto

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 ContactAddressResponse

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

PropertySummary

project

IdNameCodeDto

engagement_value

Engagement Value

expected_completion

string date-time

deadline

string date-time

job

Engagement Job Response

opportunity

Engagement Opportunity Response

workitems

Array of WorkitemEngagementResponseDto

Object

name

string

job_type

JobTypeResponse

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 JobTypeResponse

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

IdNameDto

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

LocationDto

Object

start

LocalTime

end

LocalTime

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

WorkitemStageDto

stage

WorkitemStageDto

visibility

VisibleRequest

owners

Array of WorkitemOwnerResponse

Object

id

string

user

Id Name Avatar Url

organization

IdNameDto

transferred_date

string date-time

Object

id

string

engagement

Engagement

workflow

WorkitemStageDto

stage

WorkitemStageDto

visibility

VisibleRequest

design

WorkitemDesignSummary

owners

Array of WorkitemOwnerResponse

tasks

WorkitemTasksNumberResponse

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 UserOrganizationRequest

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 IdNameStageTypeDto

to_stage

IdNameStageTypeDto

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 WorkflowStageDto

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

LifecycleResponse

routes

Array of StageRouteDto

split

IdNameDto

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

IdHandle

autoroute_after_days

integer int32

ignore_tasks

boolean

task_complete_autoroute

boolean

from_stage

Array of IdHandle 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 WorkflowStageRequest required

routes

Array of WorkflowRouteRequest required

transitions

Array of TransitionRequest

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

EstimatedDto

evidence

Array of UpdateTaskEvidenceRequest

Object

lead_number

string

description

string

job_types

Array of JobTypeResponse

lifecycle

IdNameDto

lead_owner

Id Name Avatar Url

owner

Id

Object

id

string

name

string

description

string

estimated

EstimatedDto

progress

ProgressDto

subtask_count

integer int32

evidence_count

EvidenceCount

due_date

string date-time

service

IdNameDto

assignee

IdNameDto

team

IdNameDto

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

TaskEngagementSummary

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

IdNameDto

days_in_process

integer int64

days_in_stage

integer int64

Object

id

string

name

string

job_number

string

property

PropertySummary

engagement_type

string

Enumeration:

OPPORTUNITY

JOB

LEAD

job

Engagement Job Response

opportunity

Engagement Opportunity Response

lead

EngagementLeadResponse

workitems

Array of PropertyEngagementWorkitemResponse

Object

standing_charge

number required

rates

Array of EnergyRateDto

Object

start_time

LocalTime required

end_time

LocalTime 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

EnergyCostDto 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 PpaOpexRequest

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

EnergyCostDto

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 PpaOpexResponse

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 LocationDto required

area

number double

azimuth

number double

grid_alignment

number double

pitch

number double

panel_grid

Array of LocationDto

center

LocationDto

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 LocationDto

border

BorderDto

Object

boundary

Array of LocationDto 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

LocationDto

sunshine_hours

integer int32

sunshine_quantiles

Array

integer int32

manual

RoofCommonData

imported

RoofCommonData

panel_grid

Array of LocationDto

rack_orientation

string

Enumeration:

LANDSCAPE

PORTRAIT

border

BorderDto

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 LocationDto

Object

id

string

center

LocationDto 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 LocationDto

Object

id

string

center

LocationDto

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 LocationDto

Object

boundary

Array of LocationDto required

Object

id

string

boundary

Array of LocationDto

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

IdNameDto

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

LocationDto

country_code

string

details

PropertyDetailsRequest

property_class

PropertyClassRequest

contacts

Array of ContactRequest

Object

id

string

integration

IntegrationDto

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

IdNameDto

organization

IdNameDto

Object

id

string

created

AuditDto

modified

AuditDto

note

string

task

TaskSummary

activity

ActivitySummary

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 ListViewFieldsDto

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 ListViewColumnDto

is_default

boolean required

board

Id

Object

id

string

name

string

team

IdNameDto

user

IdNameDto

view_type

string

Enumeration:

KANBAN

LIST

entity_type

string

Enumeration:

WORKITEMS

LEADS

OPPORTUNITIES

JOBS

PROPERTIES

columns

Array of ListViewColumnDto

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

EngagementUpdateRequest

lead_owner

LeadOwnerRequest

Object

id

string

name

string

lifecycle_date

string date-time

Object

name

string

description

string

lead_number

string

lifecycle

Array of IdNameLifecycleDate

job_types

Array of OpportunityJobTypeResponse

engagement

EngagementResponse

lead_owner

Id Name Avatar Url

owner

Id

Object

engagement

EngagementUpdateRequest

job_number

string

po_number

string

job_description

string

contract_agreed_amount

number

completion_date

string date-time

job_type

Id

Object

job_type

JobTypeResponse

engagement

EngagementResponse

job_number

string

po_number

string

job_description

string

workitems

Array of WorkitemEngagementResponseDto

Object

postcodes

Array of string required

Unique items: YES

Object

id

string

name

string

phone

string

email

string

Object

id

string

organization

JobTypeOrganizationDto

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

FormInterserviceResponse

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

EvidenceCategoryDto

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 FormSignatureResponse

Object

id

string

name

string

label

string

Object

id

string required

entity_type

string required

Enumeration:

PROJECT

JOB_TYPE

or_group

OrGroupRequest

Object

evidence_configs

Array of Id required

filters

Array of EvidenceConfigFilterRequest required

Object

entity_type

string required

Enumeration:

PROJECT

JOB_TYPE

entities

Array of Id required

Object

id

string

or_group

Array of OrGroupResponse

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

EvidenceActivityDateResponse

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

CreativesDto

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

EvidenceRecipientDatesResponse

Object

id

string

evidence_date

EvidenceDateDto

name

string

engagement

Array of IdNameDto

activity

EvidenceActivityResponse

task

IdNameDto

task_evidence

TaskEvidenceDto

media

CreativesDto

local_url

string

form_session

InternalFormSessionResponse

media_count

integer int32

evidence_category

IdNameDto

evidence_config

EvidenceConfigDto

solar_design

IdNameDto

status

string

Enumeration:

UPLOADED

GENERATED

FAILED

PROCESSING

ON_DEVICE

DELETED

EXPIRED

error_message

string

owner

IdNameLogoUrl

visibility

Array of IdNameLogoUrl

evidence_media

Array of EvidenceMediaSummary

signatures

EvidenceSignatures

evidence_recipient

Array of EvidenceRecipientResponse

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 SubmissionMediaResponse

Object

id

string

session_start

string date-time

session_end

string date-time

form

IdNameDto

user

IdNameDto

components

Array of InternalFormSessionComponent

Object

id

string

media

CreativesDto

local_url

string

uploaded_date

string date-time

Object

id

string

name

string

evidence_category

IdNameTagDto

timeline

string

Enumeration:

BEFORE

DURING

AFTER

ONCE

is_required

boolean

evidence_type

string

Enumeration:

IMAGE

VIDEO

FORM

DOCUMENT

tag

string

form

IdNameDto

evidence_config

IdNameDto

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

CreativesDto

local_url

string

form_session

InternalFormSessionResponse

status

string

Enumeration:

UPLOADED

GENERATED

FAILED

PROCESSING

ON_DEVICE

DELETED

EXPIRED

error_message

string

is_current

boolean

version

integer int32

evidence_recipient

Array of EvidenceRecipientResponse

Object

evidence

Id

organizations

Array of Id

Object

evidence

Id

visibility

Array of IdNameLogoUrl

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

IdNameDto

organization

IdNameDto

ei_rating

number

ei_rating_after

number

emissions

number

emissions_after

number

property_improvements

Array of PropertyImprovementDto

epc_savings

Array of EpcSavingsDto

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 CommunicationParticipantRequest

communication_attachments

Array of CommunicationAttachmentRequest

Object

media

CreativesDto

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

CommunicationContactDto

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 CommunicationParticipantResponse

communication_attachments

Array of CommunicationAttachmentResponse

Object

name

string required

quote

Id required

estimator

string required

Enumeration:

MCS

PVWATTS

SAM

IMPORTED

Object

id

string

name

string

quote

IdNameDto

design_data

Design Data

design_type

string

Enumeration:

SOLAR

SOLAR_3D

ASHP

Object

start_time

LocalTime required

end_time

LocalTime 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 EnergyRateRequest required

Object

id

string

start_time

LocalTime

end_time

LocalTime

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

TaxationSchemeResponse

commission_partner

IdNameIcon

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 EnergyRateResponse

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

CreativesDto

Object

id

string

name

string

rate

number

integration

IdExternalReference

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

ConnectionSpec required

target

ConnectionSpec required

Object

components

Array of DiagramComponentDto required

connections

Array of DiagramConnectionDto 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

IdNameDto

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

GroupRequestDto

Object

mppt_number

integer int32

inverter

InverterRequestDto

entry_point

EntryPointDto

string_points

Array of StringPointRequestDto

Object

cable_length

number double

start

PanelStringPointRequestDto

end

PanelStringPointRequestDto

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

PointResponseDto

end

PointResponseDto

panel_count

integer int32

Object

mppt_number

integer int32

cable_length

number double

inverter

InverterResponseDto

entry_point

EntryPointResponseDto

string_points

Array of PanelStringPointResponseDto

id

string

Object

row

integer int32

column

integer int32

group

GroupResponseDto

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

BoardOwnerDto

icon

BoardIconDto

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

StageWorkflow

Object

id

string

priority

integer int32

stage

BoardStageDto

Object

id

string

name

string

owner

Id

Object

user

Id

team

Id

Object

id

string

user

BoardUserDto

team

TeamDto

Object

id

string

name

string

forename

string

surname

string

avatar_url

string

email

string

phone

string

country_code

string

role

IdNameDto

Object

id

string

name

string

description

string

users

Array of BoardUserDto

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 IdNameDto

job_types

Array of IdNameDto

Object

name

string required

description

string

event_location

string required

Enumeration:

PROPERTY

OFFICE

VIRTUAL

creator_note

string

expected_date

ExpectedDateDto required

activity_type

Id

Object

start_date

string date-time required

duration

integer int32 required

Object

id

string

name

string

media

CreativesDto

evidence_category

IdNameDto

evidence_config

EvidenceConfigDto

Object

id

string

name

string

description

string

event_location

string

Enumeration:

PROPERTY

OFFICE

VIRTUAL

virtual

VirtualDto

status

string

Enumeration:

PENDING

INPROGRESS

COMPLETE

CANCELLED

POSTPONED

ON_HOLD

COMPLETE_ISSUES

expected_date

ExpectedDateDto

actual_date

ExpectedDateDto

cancellation

CancellationDto

task_count

integer int32

resource_count

integer int32

creator_note

string

resources

Array of ActivityResourceResponse

engagement

Engagement

parent

IdNameDescriptionDto

activity_type

IdNameTagDto

creator_activity_files

Array of CreatorActivityFileResponse

Object

id

string

user

IdNameDto

organization

IdNameDto

service

IdNameDto

status

string

Enumeration:

PENDING

INPROGRESS

COMPLETE

CANCELLED

POSTPONED

ON_HOLD

COMPLETE_ISSUES

cancellation

IdNameDescriptionDto

expected_date

ExpectedDateDto

actual_date

ExpectedDateDto

slot

integer int32

team

IdNameDto

status_note

string

Object

reason_id

string

note

string

Object

evidence

ActivityEvidenceResponse

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

EstimatedDto

evidence

Array of TaskEvidenceRequest 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

ExpectedDateDto

cancellation

CancellationRequestDto

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

ExpectedDateDto required

actual_date

ExpectedDateDto

slot

integer int32

status_note

string

Object

creator_note

string

creator_activity_files

Array of CreatorActivityFileRequest

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 RemovedPanel 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

Segment3dGroupRacksRequest required

panels

Segment3dGroupPanelsRequest required

origin

Point3d required

Object

count

integer int32

gap

number

width

number

orientation

string

Enumeration:

LANDSCAPE

PORTRAIT

panel_list

Array of RemovedPanel

product

Segment3dGroupProductResponse

Object

id

string

name

string

specification

Segment3dGroupProductSpecificationResponse

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

Segment3dGroupRacksResponse

panels

Segment3dGroupPanelsResponse

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 UserOrganizationRequest

Object

id

string

workflow

WorkitemWorkflowResponse

Object

id

string

name

string

stage

IdNameDto

Object

decision

Id

stage

Id

visible

VisibleRequest

owners

Array of UserOrganizationRequest

Object

workflow

Id required

stage

Id required

owners

Array of UserOrganizationRequest

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

LocationDto required

year

string required

Object

id

string

location

LocationDto

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

ProgressTaskDto required

Object

name

string required

description

string

estimated

EstimatedDto

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 TaskConfigRequest

Object

id

string

name

string

description

string

estimated

EstimatedDto

subtask_count

integer int32

evidence_count

EvidenceCount

service

Id

task_config_group

IdNameDto

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

StageResponseDto

ignore_tasks

boolean

Object

id

string

name

string

stage_type

string

Enumeration:

CREATOR

SPLIT

RENDEZVOUS

NORMAL

TRANSITION

ARCHIVE

AGGREGATOR

is_collaborative

boolean

workflow

StageWorkflow

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 SolarSimulationDataRequest

system_size

number double

Object

boundary

Array of LocationDto required

area

number double

azimuth

number double

grid_alignment

number double

pitch

number double

parent

Id

center

LocationDto required

sunshine_hours

number double

panel_grid

Array of LocationDto

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 LocationDto

border

BorderDto

Object

whole_roof

RoofSegmentResponse

segments

Array of RoofSegmentResponse

Object

id

string

center

LocationDto 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

IdNameDto

Object

pairing_code

string required

Object

screen

ScreenResponse

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 ContactEmailRequest

phones

Array of ContactPhoneRequest

addresses

Array of ContactAddressRequest

contact_period

Array of ContactCallTimeRequest

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

LocationDto

country_code

string required

details

PropertyDetailsRequest

contacts

Array of PropertyContactRequest

property_class

PropertyClassRequest

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 PropertyContactRequest

Object

job_type

Id required

Array of OrganizationJobTypeRequest

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

EngagementDatesRequest

currency

string

quote

QuoteDto

primary_contact

ContactRequest

property

PropertyDto

workflow

EngagementWorkflowRequest

agent

AgentRequest

note

EngagementNoteRequest

external_reference

string

integration

Id

lead_generator

EngagementOrganizationRequest

lead_source

EngagementOrganizationRequest

partners

Array of EngagementOrganizationRequest

Object

id

string

stage

EngagementWorkflowStageRequest

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

EngagementRequest 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

CreatedDto

lifecycles

Array of LifecycleResponse

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

EngagementRequest

lead_owner

LeadOwnerRequest

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

EngagementRequest required

Object

quote_category

string required

Object

service

Id required

isMandatory

boolean

estimated_duration

integer int32

qty

integer int32

mandatory

boolean

Array of JobTypeServiceRequest

Object

id

string

name

string

description

string

is_virtual

boolean

Object

service

JobTypeServiceDto

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 EvidenceConfigDto

children_count

integer int32

children

Array of EvidenceCategoryResponse

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 EvidenceRequest

Object

organization

Id required

Array of EvidenceOrganizationRequest

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 EvidenceRecipientRequest required

Object

evidence_recipient

Array of ResendRequest 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

IdNameDto

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

QuoteProductBillingRequest

term

QuoteProductBillingRequest

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

IdNameDto

integration

Id

products

Array of QuoteProductRequest

payment_terms_template

Id

recipients

Array of RecipientRequest

term

string

quote_category

string

quote_template

Id

organizations

Array of QuoteOrganizationRequest

finance

FinanceRequest

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

IdNameDto

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

IdCodeDescription

Object

id

string

name

string

description

string

payment_terms

Array of PaymentTermResponse

Object

id

string

alignment

string

Enumeration:

LEFT

RIGHT

CENTRE

media

CreativesDto

Object

organization

IdNameDto

user

IdNameDto

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

TaxationSchemeResponse

discount_rate

number

discount_amount

number

total_net

number

total_tax

number

total_amount

number

supplier

IdNameDto

line_item_type

string

Enumeration:

TIME

OTHER

CATALOG

image

CreativesDto

families

Array of FamilyResponse

cost_net

number

cost_amount

number

cost_unit_price

number

cost_tax

number

cost_discount_rate

number

cost_discount_amount

number

cost_taxation_scheme

TaxationSchemeResponse

ppa_excluded

boolean

finance_excluded

boolean

billing

QuoteProductBillingRequest

term

QuoteProductBillingRequest

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

IdNameDto

integration

IdNameDto

created_on

string date-time

recipients

Array of RecipientResponse

customer_note

string

products

Array of QuoteProductResponse

payment_terms_template

PaymentTermTemplateResponse

invoice

IdCodeDescription

term

string

issued_date

string date-time

quote_template

QuoteTemplateDetails

organizations

Array of QuoteOrganizationResponse

finance

FinanceResponse

Object

id

string

created_on

string date-time

created_by

IdNameDto

name

string

description

string

terms

string

contact_information

string

is_default

boolean

image

QuoteImageResponse

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

RecipientContactDto

organization

IdNameDto

user

IdNameDto

updated_on

string date-time

Object

id

string

name

string

email

string

phone

string

image

CreativesDto

formatted_address

string

Object

id

string

organization

EngagementPartnerOrganization

user

EngagementUser

team

IdNameDto

created_on

string date-time

type

string

Enumeration:

PARTNER

LEAD_SOURCE

LEAD_GENERATOR

job_types

Array of IdNameDto

Object

id

string

name

string

email

string

phone

string

Object

id

string

form_version

Id

form

Id

engagements

Array of IdNameDto

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

QuoteCostDto

product

ProductShortDto

quote_product

QuoteProductDto

Object

id

string

sku

string

external_reference

string

name

string

description

string

supplier

IdNameDto

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

IdNameDto

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

IdNameDto

design_type

string

Enumeration:

SOLAR

SOLAR_3D

ASHP

integration

Id

Object

id

string

count

integer int32

product

IdNameDto

capacity

number

Object

id

string

product

IdNameDto

size

integer int32

mppts

integer int32

power_out

number

Object

id

string

total_capacity

number

count

integer int32

product

IdNameDto

Object

panels

Array of DesignDataPanel

batteries

Array of DesignDataBattery

inverters

Array of DesignDataInverter

ev_chargers

Array of IdProductCountResponse

system_losses

number

battery_capacity

number

inverters_capacity

number

Object

id

string

name

string

quote

Id

design_data

DesignDataResponse

engagement

Array of IdNameDto

estimations

EstimatorResponse

image

CreativesDto

Object

estimator

string

Enumeration:

MCS

PVWATTS

SAM

IMPORTED

annual_production

number double

annual_export

number double

autoconsumption

number double

Object

id

string

product

IdNameDto

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

LocationDto

Object

email

string

address

AccountAddressEvent

autocollection

boolean

collection_date

string date

Object

id

string

name

string

billing

AccountBillingEvent

service

AccountServiceEvent

account_number

string

contact

Id

Object

start_date

string date

end_date

string date

address

AccountAddressEvent

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 BalancePaymentSummary

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

InvoiceEvent

balance_snapshot

BalanceSnapshot

account_event

AccountEvent

payment_methods

Array of PaymentMethodResponse

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 LineItem

payment_terms_template

PaymentTermTemplateResponse

created_on

string date-time

issued_date

string date-time

paid_date

string date-time

quote

IdCodeDescription

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

IdNameDto

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

CardDto

bank

BankDto

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

IntegrationAutomationEvent

action_parameters

Object

string

action_parameter_list

Array of ExecuteActionParam

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

ParamConditional

optional

boolean

required_params

Array of string

default

IdNameDto

choices

Array of IdNameDto

condition_lexicon

string

is_field_mapping

boolean

isRepeatable

boolean

params

Array of ParamConfig

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 ActivityResourceRequest

parent

Id

expected_date

ExpectedDateDto required

activity_type

Id

creator_activity_files

Array of CreatorActivityFileRequest

Object

organization

Id required

team

Id

user

Id

slot

integer int32

service

Id required

expected_date

ExpectedDateDto 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

PageableObject

number_of_elements

integer int32

first

boolean

last

boolean

sort

SortObject

number

integer int32

content

Array of WorkitemResponseDto

size

integer int32

empty

boolean

Object

page_number

integer int32

paged

boolean

page_size

integer int32

unpaged

boolean

sort

SortObject

offset

integer int64

Object

sorted

boolean

unsorted

boolean

empty

boolean

Object

id

string

name

string

color

string

Object

arrived_at

string date-time

stage

StageResponseDto

lifecycle

IdNameColor

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 IdNameDescriptionDto

Object

years

Array of IdNameDto

Object

name

string

icon_url

string

is_frozen

boolean

fields

Array of BoardWorkitemField

Object

name

string

lexicon

string

icon_url

string

value

string

data_type

string

Enumeration:

TEXT

DATETIME

IMAGE

Object

columns

Array of BoardWorkitemColumn

Object

total_pages

integer int32

total_elements

integer int64

pageable

PageableObject

number_of_elements

integer int32

first

boolean

last

boolean

sort

SortObject

number

integer int32

content

Array of BoardWorkitemV2Response

size

integer int32

empty

boolean

Object

total_pages

integer int32

total_elements

integer int64

pageable

PageableObject

number_of_elements

integer int32

first

boolean

last

boolean

sort

SortObject

number

integer int32

content

Array of SiteResponseV2

size

integer int32

empty

boolean

Object

id

string

contact

IdNameDto

Object

id

string

property

PropertySummary

primary_account

PrimaryAccountDto

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

CreativesDto

Object

readings

Array

Object

totals

Object

number double

Object

id

string

name

string

description

string

owner

BoardOwnerDto

icon

BoardIconDto

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

ExpectedDateDto

actual_date

ExpectedDateDto

status

string

Enumeration:

PENDING

INPROGRESS

COMPLETE

CANCELLED

POSTPONED

ON_HOLD

COMPLETE_ISSUES

cancellation

CancellationDto

task_count

integer int32

resource_count

integer int32

virtual

VirtualDto

creator_note

string

resources

Array of ActivityResourceResponse

activity_type

IdNameTagDto

creator_activity_files

Array of CreatorActivityFileResponse

Object

total_pages

integer int32

total_elements

integer int64

pageable

PageableObject

number_of_elements

integer int32

first

boolean

last

boolean

sort

SortObject

number

integer int32

content

Array of ActivityResponse

size

integer int32

empty

boolean

Object

total_pages

integer int32

total_elements

integer int64

pageable

PageableObject

number_of_elements

integer int32

first

boolean

last

boolean

sort

SortObject

number

integer int32

content

Array of EventTaskResponse

size

integer int32

empty

boolean

Object

id

string

name

string

job_type

IdNameDto

service

IdNameDto

contract

Id

workflow

IdNameDto

stage

IdNameDto

activity_type

IdNameTagDto

project

IdNameDto

Object

routes

Array of StageRouteDto

Object

decisions

Array of RouteResponseDto

transitions

Array of TransitionResponse

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

EnergyCostDto

Object

type

string

geometry

PanelGeoJsonGeometry

Object

type

string

coordinates

Array of LocationDto

Object

type

string

features

Array of PanelGeoJsonFeature

Object

id

string

row

integer int32

column

integer int32

orientation

string

center

LocationDto

annual_production_kwh

number

width

number double

height

number double

Object

price

number

taxation_scheme

TaxationSchemeSummary

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

IdNameDto

price_group

PriceGroupMerchantResponse

sales

PriceSalesResponse

cost

PriceCostResponse

Object

id

string

name

string

merchant

IdNameDto

Object

display_price

string

price

number

currency

string

tax_model

string

Enumeration:

INCLUSIVE

EXCLUSIVE

Object

price

number

currency

string

taxation_scheme

TaxationSchemeSummary

display_price

string

tax_model

string

Enumeration:

INCLUSIVE

EXCLUSIVE

override

PriceOverrideResponse

Object

id

string

name

string

variant

ProductVariantDto

ratecard

RatecardSelfDto

term

TermWithoutPricesDto

prices

Array of PriceDto

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 PriceDto

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 VariantValueDto

Unique items: YES

pricing

ProductPriceVariantDto

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 RatingSelfDto

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

TimePeriodSelfDto

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 RatingValueSelfDto

Unique items: YES

Object

id

string

rate_map

RateMapSelfDto

rate_value

string

Object

id

string

azimuth_degrees

number double

pitch_degrees

number double

area

number double

center

LocationDto

panels

Array of Panel

boundary

Array of LocationDto

panel_grid

Array of LocationDto

alignment_line

Array of LocationDto

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 SolarOptionComponent

Object

panels

integer int32

system_size

number

peak_power

number double

segments

Array of SegmentConfig

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

SolarOptionProduct

products

Array of SolarOptionProduct

config

SolarConfig

estimate

SolarEstimate

Object

id

string

name

string

sku

string

pricing

SolarProductPricing

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

CreativesDto

Object

id

string

name

string

sku

string

pricing

Array of ProductPriceDto

Unique items: YES

quantity

number

component_maps

Array of SolarComponentMap

description

string

sell_type

string

Enumeration:

UP_SELL

CROSS_SELL

BASE

image

CreativesDto

Object

options

Array of SolarOption

whole_roof

WholeRoof

roof_segments

Array of RoofSegment

property

PropertySolarData

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

VariantMapDto

variant_value

string

Object

roof_area

number

max_sunshine_hours

number

center

LocationDto

Object

id

string

account_number

string

contact

ContactShortSummary

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

PageableObject

number_of_elements

integer int32

first

boolean

last

boolean

sort

SortObject

number

integer int32

content

Array of SiteResponse

size

integer int32

empty

boolean

Object

id

string

name

string

image

CreativesDto

date

string date-time

Object

id

string

primary_account

AccountSummary

property

PropertySummary

status

string

Enumeration:

OPERATIONAL

OFFLINE

UNDERPERFORMING

INSTALLING

system_size

integer int32

subsites_count

integer int32

system_stats

SiteSystemStats

installers

Array of SiteOrganizationResponse

image

CreativesDto

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 SitePowerReadingResponse

Object

control

string

value

number double

error

string

Object

values

Array of ControlValue

Object

ghi

number double

dhi

number double

dni

number double

poa

number double

Object

quantity

number double

probability

number double

Object

weather

Array of SiteWeatherDto

source

string

Enumeration:

PYRANOMETER

OPENMETEO

average

SiteWeatherDto

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 SiteWeatherHour

days

Array of SiteWeatherDay

address

WeatherAddress

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

SelfEcoBenefitResponse

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 SiteOrganizationResponse

Object

id

string

name

string

description

string

is_default

boolean

Object

valueKwhRaw

number

reading_start

string

value_kwh

number double

Object

routes

StageRouteDto

Object

id

string

name

string

engagement_type

string

Enumeration:

OPPORTUNITY

JOB

LEAD

property

EngagementPropertySummary

lifecycle

IdNameDto

job_types

Array of OpportunityJobTypeResponse

workitems

Array of PropertyEngagementWorkitemResponse

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

ContactLifecycleResponse

company_registration_number

string

phones

Array of ContactPhoneDto

emails

Array of Contact Email Response

Object

id

string

formatted_address

string

location

LocationDto

Object

id

string

name

string

formatted_address

string

location

LocationDto

Object

total_pages

integer int32

total_elements

integer int64

pageable

PageableObject

number_of_elements

integer int32

first

boolean

last

boolean

sort

SortObject

number

integer int32

content

Array of ProptechContactResponse

size

integer int32

empty

boolean

Object

contact

ContactResponse

properties

Array of IdNameAddressDto

engagements

Array of ContactEngagementSummary

Object

id

string

name

string

description

string

Object

total_pages

integer int32

total_elements

integer int64

pageable

PageableObject

number_of_elements

integer int32

first

boolean

last

boolean

sort

SortObject

number

integer int32

content

Array of PropertyResponse

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

EngagementLeadResponse

project

IdNameDto

workitems

Array of PropertyEngagementWorkitemResponse

Object

id

string

name

string

formatted_address

string

location

LocationDto

contacts

Array of PropertyContactResponse

details

PropertyDetailsDto

property_class

PropertyClassDto

engagements

Array of PropertyEngagementResponse

created_on

string date-time

created_by

Id Name Avatar Url

Object

old_cost

number

new_cost

number

Object

year

SolarEstimate

savings25_years

Array of OldNewCost

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

IdNameDto

organization

IdNameDto

ei_rating

number

ei_rating_after

number

emissions

number

emissions_after

number

Object

id

string

name

string

project

IdNameCodeDto

engagement_type

string

Enumeration:

OPPORTUNITY

JOB

LEAD

contact

Contact

property

PropertySummary

engagement_dates

EngagementDatesResponse

workitems

Array of WorkitemEngagementResponseDto

created_by

CreatedByDto

expected_completion

string date-time

job

Engagement Job Response

opportunity

Engagement Opportunity Response

lead

EngagementLeadResponse

Object

total_pages

integer int32

total_elements

integer int64

pageable

PageableObject

number_of_elements

integer int32

first

boolean

last

boolean

sort

SortObject

number

integer int32

content

Array of EngagementFullDto

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

JobTypeSummary

job_number

string

po_number

string

job_description

string

contract_agreed_amount

number

completion_date

string date-time

engagement

EngagementResponse

workitems

Array of PropertyEngagementWorkitemResponse

Object

id

string

name

string

formatted_address

string

property_class

PropertyClassDto

Object

id

string

lead_number

string

contact

IdNameDto

name

string

lifecycle

IdNameDto

lead_owner

Id Name Avatar Url

property

LeadPropertySummary

job_types

Array of IdNameDto

owner

Id

Object

total_pages

integer int32

total_elements

integer int64

pageable

PageableObject

number_of_elements

integer int32

first

boolean

last

boolean

sort

SortObject

number

integer int32

content

Array of LeadSummary

size

integer int32

empty

boolean

Object

name

string

job_type

JobTypeSummary

job_number

string

po_number

string

job_description

string

contract_agreed_amount

number

completion_date

string date-time

engagement

EngagementResponse

Object

id

string

formatted_address

string

Object

engagement

QuoteSelfEngagement

job

QuoteSelfJob

Object

id

string

property

IdAddressDto

Object

id

string

job_number

string

po_number

string

Object

id

string

evidence_date

EvidenceDateDto

name

string

engagement

Array of IdNameDto

activity

EvidenceActivityResponse

task

IdNameDto

task_evidence

TaskEvidenceDto

media

CreativesDto

local_url

string

form_session

InternalFormSessionResponse

media_count

integer int32

evidence_category

IdNameDto

evidence_config

EvidenceConfigDto

solar_design

IdNameDto

status

string

Enumeration:

UPLOADED

GENERATED

FAILED

PROCESSING

ON_DEVICE

DELETED

EXPIRED

error_message

string

owner

IdNameLogoUrl

visibility

Array of IdNameLogoUrl

evidence_media

Array of EvidenceMediaSummary

signatures

EvidenceSignatures

comments

string

Object

id

string

name

string

engagement_type

string

Enumeration:

OPPORTUNITY

JOB

LEAD

project

IdNameDto

campaign

IdNameDto

engagement_dates

EngagementDatesResponse

currency

string

property

PropertyDto

created_by

CreatedByDto

job

Engagement Job Response

opportunity

Engagement Opportunity Response

lead

EngagementLeadResponse

Object

total_pages

integer int32

total_elements

integer int64

pageable

PageableObject

number_of_elements

integer int32

first

boolean

last

boolean

sort

SortObject

number

integer int32

content

Array of EngagementDetailsResponse

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

IdNameDto

term

string

Object

id

string

name

string

email

string

phone

string

formatted_address

string

job_types

Array of IdNameDto

Object

total_pages

integer int32

total_elements

integer int64

pageable

PageableObject

number_of_elements

integer int32

first

boolean

last

boolean

sort

SortObject

number

integer int32

content

Array of ActivityListResponse

size

integer int32

empty

boolean

Object

id

string

name

string

account_type

string

Enumeration:

SALES

COG

integration

IdNameExternalReference

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

ProductsIntegrationDto

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 FamilyResponse

Unique items: YES

specifications

Array of SpecificationDto

brands

Array of BrandDto

Unique items: YES

term

TermDto

pricing

Array of ProductPriceDto

Unique items: YES

features

Array of ProductFeatureDto

Unique items: YES

filters

Array of FilterSelfDto

Unique items: YES

components

integer int32

variants

integer int32

priority

integer int32

is_paused

boolean

image

CreativesDto