The identity and technical contract details declared by the specification.
UpdateMemberPermissions
object
Replace the role assignments for an account member.
1 property
1 required
AccountMember
object
An account member and their assigned roles.
7 properties
7 required
AccountMemberList
object
Members of an account and their role assignments.
1 property
1 required
RemoveMemberResult
object
Result of removing a member from an account.
3 properties
3 required
UpdateAccountNameRequest
object
Partial account update payload. Phase 1 supports accountname only.
1 property
1 required
AccountNameUpdateResponse
object
Updated account name fields returned in the API envelope data field.
3 properties
3 required
ApiKeyCreateRequestBody
object
1 property
1 required
ApiKeyCreatePayload
object
5 properties
5 required
ApiKeyDeactivatePayload
object
4 properties
4 required
ApiKeyList
array
API key rows in the API envelope data field.
ApiKeyListRow
object
7 properties
6 required
ApiKeyRotatePayload
object
5 properties
5 required
AuthTokenError
object
Error from auth token exchange or refresh (flat JSON, not the standard API envelope).
1 property
1 required
TokenExchangeRequest
object
Primary PWA clients send application/x-www-form-urlencoded. Mobile clients (X-Client-Type: mobile) may send the same field as JSON.
1 property
1 required
TokenRefreshRequest
object
Optional body for mobile clients. PWA clients omit the body and send the refreshtoken via an HTTP-only cookie.
1 property
AuthTokenResponse
object
JWT issued by auth token exchange or refresh. refreshtoken is included for mobile clients only.
2 properties
1 required
BuildingTypeItem
object
One building type row in the API envelope data array for getBuildingTypes. Runtime: {@see \Buildingtypelib::getbuildingtypes()} — id, name.
2 properties
2 required
BuildingTypesListResponse
array
Building type rows returned in the API envelope data field.
CountriesListResponse
array
Country rows returned in the API envelope data field.
Country
object
One country row in the API envelope data array for getCountries.
2 properties
2 required
StateOption
object
One state or province option in the getStatesByCountry response.
2 properties
2 required
StatesByCountryResponse
object
Map of countryid (string key) to state/province options.
CreateAssetFieldErrors
object
Field-level validation messages in envelope data for POST /ct/assets.
19 properties
postAssetCreate
object
Request body for POST /ct/assets (createAsset).
26 properties
19 required
CompanyEntityAddress
object
Address nested on a company entity returned by getCompanyEntities.
6 properties
CompanyEntityContact
object
Contact nested on a company entity returned by getCompanyEntities.
5 properties
CompanyEntityItem
object
6 properties
CompanyEntityList
array
Company entity rows in the API envelope data field.
CreateAssetSuccess
object
Success payload in the API envelope data field for createAsset (POST /ct/assets).
1 property
1 required
FacilityCompleteError
object
Error payload for POST /facilities/{facilityid}/complete business-rule and validation failures.
3 properties
2 required
FacilityGetError
object
2 required
FacilityGetMissingIdError
object
2 required
MeterReadingEligibilityBadRequestError
object
GET .../readings/eligibility when facility or meter path IDs are invalid (manual contract).
2 required
MeterReadingEligibilityServerError
object
GET .../readings/eligibility when an unexpected error occurs (manual contract).
3 properties
3 required
MeterReadingImageProcessingStatusBadRequestError
object
GET .../image-readings/{processingid} when facility access or path validation fails (manual documents as 400).
3 required
MeterReadingImageProcessingStatusNotFoundError
object
GET .../image-readings/{processingid} when the processing record is missing or not owned by the facility.
3 required
MeterReadingImageProcessingStatusServerError
object
GET .../image-readings/{processingid} internal server error (manual contract).
3 required
ProcessMeterReadingImageBadRequestError
object
POST .../image-readings client errors (missing/invalid image per manual spec).
3 required
ProcessMeterReadingImageMaxAttemptsError
object
POST .../image-readings when the photo OCR retry limit is reached (HTTP 429).
5 properties
5 required
ProcessMeterReadingImageServerError
object
POST .../image-readings server failures after the image is accepted.
3 required
ProductionHistoryBadRequestError
object
GET .../generation/history when generation data cannot be loaded (runtime returns 400).
2 required
MeterReadingErrorResponse
object
Error response payload (inside the data envelope). The error and errors fields are optional and may not be present in all error responses.
4 properties
2 required
TransactionsForbiddenError
object
GET .../transactions when access is denied or the facility is closed/lost (manual 403).
2 required
TransactionsInvalidFacilityIdError
object
GET .../transactions when facilityid is not numeric (manual contract).
2 required
TransactionsNotFoundError
object
2 required
AssignExistingPaymentPreferenceRequest
object
2 properties
1 required
CreateBankPaymentPreferenceRequest
object
9 properties
5 required
CreateCheckPaymentPreferenceRequest
object
6 properties
5 required
ExistingPaymentMethodSelection
object
2 properties
2 required
AbpTermsStatus
object
4 properties
AccountTypeOption
object
2 properties
BankPaymentPreferenceDetails
object
9 properties
CheckPaymentPreferenceDetails
object
6 properties
ExistingPaymentMethodOption
object
3 properties
FacilityPaymentPreferenceResponse
object
10 properties
PaymentPreferenceDetails
object
9 properties
PaymentPreferenceEditOptions
object
6 properties
AddFacilityStateCertificationRequest
object
Request body for POST /facilities/{facilityid}/statecertifications.
1 property
1 required
AutomatedMeterReadingRequest
object
Automated meter reading submission body for submitMeterReading (OCR processingid).
1 property
1 required
BaseMeterReading
object
Internal meter-reading command context (populated server-side; not part of the public JSON body).
CompleteFacilityRequest
object
Request body for POST /facilities/{facilityid}/complete.
2 properties
1 required
CreateFacilityStateApplicationRequest
object
Request body for POST /facilities/{facilityid}/stateapplications.
1 property
1 required
facilityAbpCreateOrUpdate
ABP facility create payload in nested DTO format.
FacilityAbpFields
object
Illinois Adjustable Block Program (ABP) fields. Required when creating an ABP facility (address.state is IL and your account is ABP-enabled). See nested panels…
19 properties
facilityAbpFlatCreateOrUpdate
Illinois ABP facility create payload in legacy flat format. Requires state: IL. Uses postAbpPanelCreate for panels and postAbpInverterCreate for inverters. You…
FacilityCreateAbpFields
object
50 properties
61 required
FacilityCreateDggFields
object
10 properties
27 required
facilityCreateOrUpdateCommonProperties
object
Payload format accepted by POST /facilities and PATCH /facilities/{facilityid}. Legacy flat payload keys are still accepted for backwards compatibility and wil…
27 properties
11 required
facilityCreateOrUpdate
Standard facility create payload in nested format.
FacilityCreateStandardFields
object
25 properties
26 required
facilityDggCreateOrUpdate
California DGG facility create payload in nested format.
FacilityDggFields
object
6 properties
1 required
facilityDggFlatCreateOrUpdate
California DGG facility create payload. Requires dgg: true and state: CA. Uses postDggPanelCreate for panels (not panelFlatCreate).
facilityFlatCreateOrUpdateCommonProperties
object
Shared JSON properties for standard facility create (facilityFlatCreateOrUpdate), California DGG create (facilityDggFlatCreateOrUpdate), and Illinois ABP creat…
36 properties
facilityFlatCreateOrUpdate
Standard facility create payload.
ManualMeterReadingRequest
object
Manual meter reading submission body for submitMeterReading.
2 properties
2 required
ProcessMeterReadingImageRequest
object
Multipart body for POST /facilities/{facilityid}/generation/meters/{meterid}/image-readings.
3 properties
1 required
StateCertificationInput
object
2 properties
2 required
UploadFacilityDocumentsRequest
object
2 properties
1 required
postAbpInverterCreate
object
Inverter array entry for ABP facility creation (facilityAbpFlatCreateOrUpdate.inverters).
5 properties
5 required
postAbpPanelCreate
object
Panel array entry for ABP facility creation (facilityAbpFlatCreateOrUpdate.panels).
9 properties
9 required
facilityAddressInput
object
6 properties
5 required
postDggPanelCreate
object
Panel array entry for DGG facility creation (facilityDggFlatCreateOrUpdate.panels). panellocation is optional (unlike panelFlatCreate).
8 properties
7 required
facilityInstallerInput
object
6 properties
1 required
inverterFlatCreate
object
4 properties
4 required
facilityInverterInput
object
5 properties
4 required
facilityMeterInput
object
14 properties
5 required
facilityOwnerInput
object
6 properties
4 required
panelFlatCreate
object
8 properties
8 required
facilityPanelInput
object
9 properties
7 required
facilityRegistryInput
object
Registry fields accepted on create/update. The registry name is derived from the facility state and cannot be set or updated.
1 property
AbpFacilityDetails
Facility detail for an Illinois Adjustable Block Program (ABP) system. Returned from GET /facilities/{id}?data=all when the facility has an ABP application. Pr…
AbpFacilityDetailsFields
object
Illinois ABP-specific fields included on facility detail responses.
19 properties
DggFacilityDetailsFields
object
5 properties
FacilitiesListForAccountList
object
1 property
FacilityCompleteSuccess
object
Facility application completed successfully.
1 property
1 required
facilityFlatCreateOrUpdateResponse200
object
Facility create/update success payload returned in the API envelope data field.
2 properties
2 required
FacilityDetails
object
Single facility detail object returned in FacilityResponse.
32 properties
FacilityDocumentsUploadResult
object
Upload counts and error messages inside {@see FacilityDocumentsUploadSuccess}.
2 properties
2 required
uploadFacilityDocumentsResponse
object
Document upload result returned in the API envelope data field.
2 properties
2 required
FacilityListDetails
object
Facility summary returned in the account facilities list.
21 properties
FacilityResponse
array
Facility detail rows returned in the API envelope data field (single-facility GET returns one element).
FacilityStateEligibilitiesList
array
State eligibility rows in the API envelope data field.
FacilityTransactionsPaginatedResponse
object
1 property
MeterReadingEligibilityResult
object
Whether the facility/meter can submit manual readings at this time
5 properties
3 required
MeterReadingImageExtractedData
object
OCR extracted data from the meter reading image
6 properties
6 required
MeterReadingImageProcessingStatus
object
OCR processing status and extracted data
5 properties
5 required
MeterReadingLastSubmission
object
4 properties
3 required
MeterReadingSubmissionPeriod
object
2 properties
2 required
MeterReadingSubmissionWindow
object
2 properties
ProcessMeterReadingImageSuccess
object
Image accepted for OCR processing.
4 properties
4 required
ProductionHistoryData
object
Production history payload in the API envelope data field for getProductionHistory.
9 properties
9 required
ProductionHistoryItem
object
Single production history row in ProductionHistoryData.history.
9 properties
2 required
ProductionHistoryPaginatedResponse
object
1 property
StateApplicationCreateData
object
State application create success payload returned in the API envelope data field.
2 properties
2 required
StateCertificationCreateData
object
State certification create success payload returned in the API envelope data field.
2 properties
2 required
StateEligibilityDocument
object
Required document row for a state eligibility entry. Runtime: {@see \Trade\CodeIgniter\models\dto\Documentdto}.
3 properties
3 required
StateEligibilityItem
object
5 properties
3 required
MeterReadingSuccessResponse
object
Success response payload (inside the data envelope)
4 properties
3 required
SubmitReadingVerificationSuccess
object
Verification submission accepted — reading moved to pendingreview.
3 properties
3 required
TransactionItem
object
Single transaction row in TransactionReportData.transactions.
6 properties
5 required
TransactionReportData
object
Transaction report payload in the API envelope data field for getTransactionsHistory.
4 properties
3 required
Address
object
6 properties
Installer
object
6 properties
Inverter
object
5 properties
Meter
object
17 properties
Owner
object
6 properties
Panel
object
9 properties
Registry
object
2 properties
StateCertification
object
3 properties
InstallerDemographics
object
Installer workforce demographics for facility create/update requests and ABP detail responses.
14 properties
UploadErrorPreviewClientError
object
Shared {success, error} shape for upload error preview client failures (400/403).
2 properties
UploadErrorPreviewForbiddenError
object
403 data payload when the caller cannot access the upload.
UploadErrorPreviewInvalidErrorIndexError
object
400 data payload when errorindex query parameter is not a valid integer.
UploadErrorPreviewNotFoundError
object
404 data payload when no error group or fixer matches the request.
3 properties
FixPreviewPayload
object
5 properties
3 required
PreviewChangeRow
object
One proposed change row in a fix preview (FixPreviewPayload.changes[]).
3 properties
3 required
UploadBulkErrorPreviewSuccess
object
2 properties
2 required
UploadSingleRowErrorPreviewSuccess
object
2 properties
2 required
AcceptInvitation
object
Payload to accept an invitation addressed to the caller.
1 property
1 required
CreateInvitation
object
Payload to create a new account invitation.
4 properties
4 required
UpdateInvitationPermissions
object
Replace the roles granted by a pending invitation.
1 property
1 required
AcceptInvitationResult
object
Result of accepting an invitation addressed to the caller.
4 properties
4 required
Invitation
object
A pending account invitation and its assigned roles.
10 properties
9 required
InvitationList
object
A list of pending invitations.
1 property
1 required
InvitationPaginatedList
object
1 property
InvitedBy
object
The user who created the invitation.
3 properties
3 required
RemoveInvitationResult
object
Result of cancelling a pending invitation.
2 properties
2 required
ResendInvitationResult
object
Result of re-sending an invitation email.
3 properties
3 required
ManagedFacilityGroupWorkflowError
object
Error payload in the API envelope data field for workflow transition failures (400 / 404).
3 properties
2 required
ManagedFacilityGroupWorkflowGroupFailure
object
Per-group failure detail in {@see ManagedFacilityGroupWorkflowError} groups.
3 properties
3 required
AddManagedFacilityGroupMemberRequest
object
1 property
1 required
CreateManagedFacilityGroupRequest
object
5 properties
3 required
ManagedFacilityGroupWorkflowRequest
object
2 properties
2 required
ManagedFacilityGroupFacility
object
A facility that belongs to a managed facility group (summary row)
10 properties
ManagedFacilityGroup
object
Managed facility group with nested facility summaries
11 properties
ManagedFacilityGroupAccountAccessItem
object
One account row in the API envelope data array for getManagedFacilityGroupAccountAccess.
2 properties
2 required
ManagedFacilityGroupAccountAccessListResponse
array
Enabled managed facility group access rows returned in the API envelope data field.
ManagedFacilityGroupAddMemberResult
object
Membership created when adding a facility to a group.
1 property
1 required
ManagedFacilityGroupAddMemberSuccess
object
Success payload in the API envelope data field for add-member (HTTP 200).
2 properties
2 required
ManagedFacilityGroupCreateResult
object
Created group and optional initial memberships.
2 properties
1 required
ManagedFacilityGroupMembership
object
Membership row in managedfacilitygroupshasfacilities.
8 properties
ManagedFacilityGroupMutationSuccess
object
Success payload in the API envelope data field for managed facility group mutations.
2 properties
2 required
ManagedFacilityGroupList
object
1 property
ManagedFacilityGroupRecord
object
Managed facility group row returned in mutation success payloads.
12 properties
ManagedFacilityGroupRemoveMemberResult
object
Outcome when a facility membership is removed from a group.
2 properties
2 required
ManagedFacilityGroupRemoveMemberSuccess
object
Success payload in the API envelope data field for remove-member (HTTP 200).
2 properties
2 required
ManagedFacilityGroupUngroupResult
object
Count of memberships soft-deleted when clearing a managed facility group.
1 property
1 required
ManagedFacilityGroupUngroupSuccess
object
Success payload in the API envelope data field for ungroup (HTTP 200).
2 properties
2 required
ManagedFacilityGroupWorkflowList
array
Updated managed facility groups after a workflow transition, returned in the API envelope data field.
ManagedFacilityGroupWregis
object
Derived owner contact fields and interconnected utility from the first member facility of a managed facility group.
12 properties
MarketPricingItem
object
One market pricing row in the API envelope data array for searchMarket.
4 properties
2 required
MarketPricingListResponse
array
Market pricing rows returned in the API envelope data field.
SubmitFeedback
object
Payload to submit mobile app feedback
2 properties
Feedback
object
Confirmation of a successfully submitted feedback entry.
4 properties
2 required
PartnerTermsVersionMismatchError
object
4 required
AcceptPartnerTermsRequest
object
Payload to record acceptance of the current partner Terms & Conditions version.
1 property
1 required
CreatePartnerRequest
object
Payload to create a new partner
4 properties
2 required
PatchPartnerRequest
object
Partial partner update. Send only fields to change.
4 properties
CommissionRateItem
object
2 properties
2 required
CommissionRatesGetOk
object
Partner commission rates returned in the API envelope data field.
1 property
1 required
Partner
object
Partner object
10 properties
PartnerList
object
1 property
PartnerProfile
object
Partner profile object
3 properties
PartnerStatusLog
object
3 properties
3 required
PartnerStatusLogList
object
1 property
PartnerTag
object
Auto-assigned referrer tag for a partner (Partner Admin alignment).
4 properties
PartnerTagsList
array
Partner referrer tag rows returned in the API envelope data field.
PartnerTermsAgreement
object
Partner T&C acceptance record returned in the API envelope data field.
4 properties
4 required
PartnerTermsAgreementOk
object
Partner T&C acceptance record returned in the API envelope data field.
UpdateProfileAddress
object
When any address field is supplied, the full legacy address set is required.
7 properties
UpdateProfileRequest
object
Partial profile update. Profile fields and address are independently optional.
6 properties
ProfileAddress
object
10 properties
ProfileResponse
object
8 properties
2 required
QualifiedReportingEntitiesListResponse
array
QRE rows returned in the API envelope data field.
QualifiedReportingEntityItem
object
One QRE row in the API envelope data array for getQualifiedReportingEntities. Runtime: {@see \Qualifiedreportingentitylib::getqualifiedreportingentities()} — i…
2 properties
2 required
RemoteDataCollectorItem
object
One remote data collector row in the API envelope data array for getRemoteDataCollectors. Runtime: {@see \Referencedataapi::remotedatacollectorsget()} — id, na…
2 properties
2 required
RemoteDataCollectorsListResponse
array
Remote data collector rows returned in the API envelope data field.
ThirdPartyCredentialCreateRequest
object
3 properties
3 required
ThirdPartyCredentialUpdateRequest
object
At least one of displayname, username, or password must be provided.
3 properties
ThirdPartyCredential
object
6 properties
5 required
ThirdPartyCredentialList
array
Third-party API credentials for the caller's primary account.
TransactionStatementDetailItem
object
6 properties
6 required
TransactionStatementFinancialSummary
object
3 properties
3 required
TransactionStatementFinancialSummaryTotalItem
object
4 properties
4 required
TransactionStatementItem
object
7 properties
7 required
TransactionStatementList
object
1 property
UserNotAvailableError
object
2 required
SwitchActiveAccountRequest
object
Payload to switch the authenticated user active account.
1 property
1 required
MeAccount
object
Single account membership for the authenticated user.
6 properties
5 required
MeAccountListResponse
object
Authenticated user account memberships returned in the API envelope data field.
1 property
1 required
UserInfoResponse
object
Authenticated user profile, active account name, and permissions returned in the API envelope data field.
7 properties
6 required
UtilitiesListResponse
array
Utility rows returned in the API envelope data field.
UtilityItem
object
One utility row in the API envelope data array for getUtilitiesByCountyAndState. Runtime: {@see \UtilityLib::getutilitiesbycountyandstate()} — id, name.
2 properties
2 required
ApiFieldError
object
API field error
2 properties
ApiResponseDTO
object
API response data
6 properties
Pagination
object
4 properties
AccessForbiddenError
object
2 required
AuthError
object
2 required
Error
object
Generic error payload when no more specific error schema applies. Implements JsonSerializable so it can be passed directly to APIController::response(). Implem…
2 properties
2 required
MeterReadingOperationError
object
Shared {success, error, message} shape for meter-reading image/status API errors. Endpoint-specific schemas extend this class and set a distinct schema name fo…
3 properties
3 required
ServerError
object
2 required
ValidationError
object
Error payload for validation failures (400, 422) on request bodies and business rules. For query/path validation, see {@see \Trade\CodeIgniter\dtos\shared\resp…
3 properties
QueryValidationErrorResponse
object
Generic 400 payload for query/path validation errors. Intended for read/query failures: - simple bad requests (error only, optional message) - field-level deta…
3 properties
MobileAppConfigResponse
object
Configuration used by the mobile app at startup.
4 properties
4 required
MobileAppEligibilityResult
object
Eligibility details for the authenticated user to use the mobile app.
5 properties
5 required
ApplyFixRequestBody
object
4 properties
2 required
ForbiddenResponse
object
2 properties
ApplyFixFieldErrorResponse
object
2 properties
ValidationErrorsMap
object
Map of row identifier to validation error detail.
ApplyFixValidationErrorResponse
object
4 properties
4 required
SingleFixSuccessResponse
object
2 properties
2 required
BulkFixSuccessResponse
object
3 properties
3 required
UserListItem
object
4 properties
4 required
UsersListResponse
array
User rows returned in the API envelope data field.
PaginatedResponseEnvelope
object
Standard API response envelope for paginated endpoints.
ResponseEnvelope
object
Standard API response envelope. Every response wraps its payload in this structure; the data field contains the operation-specific payload.
5 properties
5 required
The full machine-readable OpenAPI contract behind this narrative.