{"openapi":"3.0.0","info":{"title":"Developer API","description":"The Developer API is designed for partners to originate\nand manage loans through their lifecycle.","version":"3.0"},"servers":[{"url":"https://devint01-api.goodleap.com"}],"components":{"securitySchemes":{"jwt":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"LSS_ResponseViewModelOfIReadOnlyCollectionOfSearchableFinanceAccountAndMeta":{"type":"object","additionalProperties":false,"properties":{"payload":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/LSS_SearchableFinanceAccount"}},"meta":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/LSS_Meta"}]}}},"LSS_SearchableFinanceAccount":{"type":"object","additionalProperties":false,"properties":{"title":{"type":"string","nullable":true},"financeAccountId":{"type":"string","nullable":true},"financeAccountGuid":{"type":"string","nullable":true},"financeType":{"type":"string","nullable":true},"referenceId":{"type":"string","nullable":true},"tenantId":{"type":"string","format":"guid","nullable":true},"monthlyPayment":{"type":"number","format":"decimal","nullable":true},"product":{"type":"string","nullable":true},"projectType":{"type":"string","nullable":true},"status":{"type":"string","nullable":true},"term":{"type":"integer","format":"int32","nullable":true},"propertyLocation":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/LSS_Address"}]},"dateCreated":{"type":"string","format":"date-time","nullable":true},"dateUpdated":{"type":"string","format":"date-time","nullable":true},"dateIndexed":{"type":"string","format":"date-time","nullable":true},"expirationDate":{"type":"string","format":"date-time","nullable":true},"applicants":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/LSS_Applicant"}},"salesPerson":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/LSS_Person"}},"organizationId":{"type":"string","nullable":true},"systemDesignId":{"type":"string","nullable":true},"savingsScheduleId":{"type":"string","nullable":true},"utilityInformationId":{"type":"string","nullable":true},"calculatedSystemPricing":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/LSS_Pricing"}]},"activeAgreementPricing":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/LSS_Pricing"}]},"offerId":{"type":"string","nullable":true},"projectId":{"type":"string","nullable":true},"parties":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/LSS_Party"}},"milestones":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/LSS_MilestoneObject"}},"fundedMilestones":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/LSS_MilestoneObject"}},"orders":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/LSS_Order"}},"cases":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/LSS_CaseSummary"}]},"noOrdersCreated":{"type":"boolean","nullable":true},"tags":{"type":"array","nullable":true,"items":{"type":"string"}},"rate":{"type":"number","format":"float","nullable":true},"decomposedHierarchies":{"type":"array","nullable":true,"items":{"type":"string"}},"creditDecisionType":{"type":"string","nullable":true},"enrollments":{"type":"array","nullable":true,"items":{"type":"string"}},"agent":{"type":"string","nullable":true},"waitingOn":{"type":"array","nullable":true,"items":{"type":"string"}},"lastCompletedMilestone":{"type":"string","nullable":true},"linkedFinanceAccount":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/LSS_LinkedFinanceAccount"}]},"category":{"type":"string","nullable":true},"creditExtension":{"type":"string","nullable":true}}},"LSS_Address":{"type":"object","additionalProperties":false,"properties":{"completeAddress":{"type":"string","nullable":true},"locality":{"type":"string","nullable":true},"adminArea":{"type":"string","nullable":true},"postalCode":{"type":"string","nullable":true},"country":{"type":"string","nullable":true}}},"LSS_Applicant":{"type":"object","additionalProperties":false,"properties":{"firstName":{"type":"string","nullable":true},"lastName":{"type":"string","nullable":true},"dateOfBirth":{"type":"string","format":"date-time","nullable":true},"socialSecurity":{"type":"string","nullable":true},"emailAddress":{"type":"string","nullable":true},"phoneNumber1":{"type":"string","nullable":true},"phoneNumber1Type":{"type":"string","nullable":true},"completeAddress":{"type":"string","nullable":true},"locality":{"type":"string","nullable":true},"adminArea":{"type":"string","nullable":true},"postalCode":{"type":"string","nullable":true},"country":{"type":"string","nullable":true},"language":{"type":"string","nullable":true},"isPrimary":{"type":"boolean","nullable":true},"isDropped":{"type":"boolean","nullable":true},"annualIncome":{"type":"number","format":"float","nullable":true},"annualIncomeType":{"type":"string","nullable":true}}},"LSS_Person":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","nullable":true},"emailAddress":{"type":"string","nullable":true},"phone":{"type":"string","nullable":true}}},"LSS_Pricing":{"type":"object","additionalProperties":false,"properties":{"pricePerUnitType":{"type":"string","nullable":true},"pricePerUnitValue":{"type":"number","format":"float","nullable":true},"purchasePriceType":{"type":"string","nullable":true},"purchasePriceValue":{"type":"number","format":"float","nullable":true},"estimatedFirstYearMonthlyPaymentType":{"type":"string","nullable":true},"estimatedFirstYearMonthlyPaymentValue":{"type":"number","format":"float","nullable":true},"powerPurchaseRateType":{"type":"string","nullable":true},"powerPurchaseRateValue":{"type":"number","format":"float","nullable":true}}},"LSS_Party":{"type":"object","additionalProperties":false,"properties":{"type":{"type":"string","nullable":true},"entityId":{"type":"string","format":"guid","nullable":true},"name":{"type":"string","nullable":true},"hKey":{"type":"string","nullable":true},"isPrimary":{"type":"boolean","nullable":true},"isDisabled":{"type":"boolean"},"workspaceId":{"type":"string","format":"guid","nullable":true}}},"LSS_MilestoneObject":{"type":"object","additionalProperties":false,"properties":{"date":{"type":"string","format":"date-time","nullable":true},"milestone":{"type":"string","nullable":true}}},"LSS_Order":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","format":"guid"},"amount":{"type":"number","format":"decimal","nullable":true},"payee":{"type":"string","nullable":true},"payeeType":{"type":"string","nullable":true},"status":{"type":"string","nullable":true}}},"LSS_CaseSummary":{"type":"object","additionalProperties":false,"properties":{"frozenCases":{"type":"integer","format":"int32"},"rejectedCases":{"type":"integer","format":"int32"},"openCases":{"type":"integer","format":"int32"},"closedCases":{"type":"integer","format":"int32"},"openGLCases":{"type":"integer","format":"int32"},"totalCases":{"type":"integer","format":"int32"},"openBorrowerCases":{"type":"integer","format":"int32"},"dateCreated":{"type":"string","format":"date-time"},"dateUpdated":{"type":"string","format":"date-time"}}},"LSS_LinkedFinanceAccount":{"type":"object","additionalProperties":false,"properties":{"financeAccountId":{"type":"string","nullable":true},"linkType":{"type":"string","nullable":true}}},"LSS_Meta":{"type":"object","additionalProperties":false,"properties":{"cursor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/LSS_Cursor"}]},"pageNumber":{"type":"integer","format":"int32","nullable":true},"itemsPerPage":{"type":"integer","format":"int32","nullable":true},"total":{"type":"integer","format":"int64","nullable":true}}},"LSS_Cursor":{"type":"object","additionalProperties":false,"properties":{"next":{"type":"string","nullable":true},"size":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"}}},"LSS_ProblemDetails":{"type":"object","properties":{"type":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"status":{"type":"integer","format":"int32","nullable":true},"detail":{"type":"string","nullable":true},"instance":{"type":"string","nullable":true},"extensions":{"type":"object"}}},"LSS_FinanceAccountSearchParameters":{"allOf":[{"$ref":"#/components/schemas/LSS_SearchUserExtension"},{"type":"object","additionalProperties":false,"properties":{"agent":{"type":"string","nullable":true},"applicant":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/LSS_ApplicantParameters"}]},"cases":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/LSS_CasesSearchParameters"}]},"dateCreated":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/LSS_DateRange"}]},"dateUpdated":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/LSS_DateRange"}]},"creditDecisionType":{"type":"string","nullable":true},"expirationDate":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/LSS_DateRange"}]},"enrollments":{"type":"array","nullable":true,"items":{"type":"string"}},"financeAccountId":{"type":"array","nullable":true,"items":{"type":"string"}},"financeAccountGuid":{"type":"array","nullable":true,"items":{"type":"string"}},"includeExpiredFinanceAccounts":{"type":"boolean","nullable":true},"milestone":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/LSS_MilestoneParameters"}]},"fundingMilestone":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/LSS_FundingMilestoneType"}]},"monthlyPayment":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/LSS_NumericRange"}]},"offerId":{"type":"string","nullable":true},"order":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/LSS_Order2"}]},"organizationId":{"type":"string","nullable":true},"excludeOrganizationIds":{"type":"array","nullable":true,"items":{"type":"string"}},"parties":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/LSS_PartyParameters"}},"product":{"type":"string","nullable":true},"projectId":{"type":"string","nullable":true},"projectType":{"type":"string","nullable":true},"propertyLocation":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/LSS_AddressParameters"}]},"rate":{"type":"array","nullable":true,"items":{"type":"number","format":"double"}},"referenceId":{"type":"string","nullable":true},"salesPerson":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/LSS_PersonParameters"}]},"stage":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/LSS_StageFilter"}]},"status":{"type":"array","nullable":true,"items":{"type":"string"}},"tags":{"type":"array","nullable":true,"items":{"type":"string"}},"term":{"type":"array","nullable":true,"items":{"type":"integer","format":"int32"}},"title":{"type":"string","nullable":true},"financeType":{"type":"string","nullable":true},"category":{"type":"array","nullable":true,"items":{"type":"string"}},"wellKnownFilter":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/LSS_WellKnownFilters"}]},"sort":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/LSS_SortField"}]},"fields":{"type":"array","nullable":true,"items":{"type":"string"}}}}]},"LSS_ApplicantParameters":{"type":"object","additionalProperties":false,"properties":{"adminArea":{"type":"array","nullable":true,"items":{"type":"string"}},"annualIncome":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/LSS_NumericRange"}]},"annualIncomeType":{"type":"string","nullable":true},"completeAddress":{"type":"string","nullable":true},"country":{"type":"string","nullable":true},"dateOfBirth":{"type":"string","format":"date-time","nullable":true},"emailAddress":{"type":"string","nullable":true},"firstName":{"type":"string","nullable":true},"isPrimary":{"type":"boolean","nullable":true},"lastName":{"type":"string","nullable":true},"language":{"type":"string","nullable":true},"locality":{"type":"string","nullable":true},"phoneNumber1":{"type":"string","nullable":true},"postalCode":{"type":"string","nullable":true},"socialSecurity":{"type":"string","nullable":true}}},"LSS_NumericRange":{"type":"object","additionalProperties":false,"properties":{"lowRange":{"type":"number","format":"double","nullable":true},"highRange":{"type":"number","format":"double","nullable":true}}},"LSS_CasesSearchParameters":{"type":"object","additionalProperties":false,"properties":{"hasFrozenCases":{"type":"boolean","nullable":true},"hasOpenCases":{"type":"boolean","nullable":true},"hasRejectedCases":{"type":"boolean","nullable":true},"hasClosedCases":{"type":"boolean","nullable":true},"hasOpenBorrowerCases":{"type":"boolean","nullable":true},"hasOpenGoodLeapCases":{"type":"boolean","nullable":true}}},"LSS_DateRange":{"type":"object","additionalProperties":false,"properties":{"startDate":{"type":"string","format":"date-time","nullable":true},"endDate":{"type":"string","format":"date-time","nullable":true}}},"LSS_MilestoneParameters":{"type":"object","additionalProperties":false,"properties":{"date":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/LSS_DateRange"}]},"Milestone":{"type":"string","nullable":true}}},"LSS_FundingMilestoneType":{"type":"string","description":"","x-enumNames":["InstallationFunded","PTOFunded"],"enum":["InstallationFunded","PTOFunded"]},"LSS_Order2":{"type":"object","additionalProperties":false,"properties":{"payeeType":{"type":"array","nullable":true,"items":{"type":"string"}},"status":{"type":"array","nullable":true,"items":{"type":"string"}}}},"LSS_PartyParameters":{"type":"object","additionalProperties":false,"properties":{"type":{"type":"string","nullable":true},"entityId":{"type":"string","format":"guid","nullable":true},"name":{"type":"string","nullable":true},"hKey":{"type":"string","nullable":true},"isPrimary":{"type":"boolean","nullable":true},"workspaceId":{"type":"string","format":"guid","nullable":true}}},"LSS_AddressParameters":{"type":"object","additionalProperties":false,"properties":{"adminArea":{"type":"array","nullable":true,"items":{"type":"string"}},"completeAddress":{"type":"string","nullable":true},"country":{"type":"string","nullable":true},"locality":{"type":"string","nullable":true},"postalCode":{"type":"string","nullable":true}}},"LSS_PersonParameters":{"type":"object","additionalProperties":false,"properties":{"type":{"type":"string","nullable":true},"userId":{"type":"string","format":"guid","nullable":true},"name":{"type":"string","nullable":true},"emailAddress":{"type":"string","nullable":true}}},"LSS_StageFilter":{"type":"object","additionalProperties":false,"properties":{"complete":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/LSS_StageType"}]},"notComplete":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/LSS_StageType"}]}}},"LSS_StageType":{"type":"string","description":"","x-enumNames":["None","Approved","AgreementCompleted","AgreementSent","AgreementSigned","ConditionalReleaseSigned","ContractUploaded","ContractSigned","FinalReleaseSigned","Funded","InstallComplete","InRescission","LoanDetailsVerified","LoanDocumentsSent","LoanDocumentsSigned","NtpComplete","ProjectCertificateSent","ProjectCertificateSigned","PtoComplete","ProjectInfoComplete","WorkOrderRequested","WorkOrderSigned","IcPaymentRequestSent","NtpPaymentRequestSent","DocsNotarized","ApprovedWithStips"],"enum":["None","Approved","AgreementCompleted","AgreementSent","AgreementSigned","ConditionalReleaseSigned","ContractUploaded","ContractSigned","FinalReleaseSigned","Funded","InstallComplete","InRescission","LoanDetailsVerified","LoanDocumentsSent","LoanDocumentsSigned","NtpComplete","ProjectCertificateSent","ProjectCertificateSigned","PtoComplete","ProjectInfoComplete","WorkOrderRequested","WorkOrderSigned","IcPaymentRequestSent","NtpPaymentRequestSent","DocsNotarized","ApprovedWithStips"]},"LSS_WellKnownFilters":{"type":"string","description":"","x-enumNames":["None","DocumentsNotSent","DocumentsNotSigned","ProjectInfoNotComplete","ContractNotUploaded","LoanDetailsNotVerified","NotInstalled","NotFunded","ProjectCertificateNotSigned","NoPto","CreditExpiringWithin30Days","WorkOrderNotInitiallySigned","ConditionalClaimsReleaseNotSigned","FinalClaimsReleaseNotSigned","ConsumerAgreementNotSent","ConsumerAgreementNotSigned","ConsumerAgreementNotViewed","InRescissionPeriod","WorkOrderNotSignedAfterChangeOrder","DomesticContentNotQualifiedNoPto","AoMNotSigned","CpcRejected","CreditExpiredWithinExtensionWindow"],"enum":["None","DocumentsNotSent","DocumentsNotSigned","ProjectInfoNotComplete","ContractNotUploaded","LoanDetailsNotVerified","NotInstalled","NotFunded","ProjectCertificateNotSigned","NoPto","CreditExpiringWithin30Days","WorkOrderNotInitiallySigned","ConditionalClaimsReleaseNotSigned","FinalClaimsReleaseNotSigned","ConsumerAgreementNotSent","ConsumerAgreementNotSigned","ConsumerAgreementNotViewed","InRescissionPeriod","WorkOrderNotSignedAfterChangeOrder","DomesticContentNotQualifiedNoPto","AoMNotSigned","CpcRejected","CreditExpiredWithinExtensionWindow"]},"LSS_SortField":{"type":"object","additionalProperties":false,"properties":{"field":{"$ref":"#/components/schemas/LSS_SortByField"},"order":{"$ref":"#/components/schemas/LSS_ResultsSortOrder"}}},"LSS_SortByField":{"type":"string","description":"","x-enumNames":["None","DateCreated","DateUpdated","SearchScore","ExpirationDate"],"enum":["None","DateCreated","DateUpdated","SearchScore","ExpirationDate"]},"LSS_ResultsSortOrder":{"type":"string","description":"","x-enumNames":["Ascending","Descending"],"enum":["Ascending","Descending"]},"LSS_SearchUserExtension":{"type":"object","additionalProperties":false},"LSS_ResponseViewModelOfListOfOrganizationSearchResponse":{"type":"object","additionalProperties":false,"properties":{"payload":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/LSS_OrganizationSearchResponse"}}}},"LSS_OrganizationSearchResponse":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string"},"organizationId":{"type":"string","format":"guid"},"entityId":{"type":"string","format":"guid"}}},"LSS_FinanceAccountType":{"type":"string","description":"","x-enumNames":["Loan","Tpo","Heloc","Combined"],"enum":["Loan","Tpo","Heloc","Combined"]},"LSS_ResponseViewModelOfListOfEmailSearchResponse":{"type":"object","additionalProperties":false,"properties":{"payload":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/LSS_EmailSearchResponse"}}}},"LSS_EmailSearchResponse":{"type":"object","additionalProperties":false,"properties":{"emailAddress":{"type":"string"}}},"LSS_ResponseViewModelOfListOfAgentSearchResponse":{"type":"object","additionalProperties":false,"properties":{"payload":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/LSS_AgentSearchResponse"}}}},"LSS_AgentSearchResponse":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string"},"emailAddress":{"type":"string"}}},"LSS_RemoveAssetsResponse":{"type":"object","additionalProperties":false,"properties":{"tenantId":{"type":"string","format":"guid"},"documentsRemoved":{"type":"integer","format":"int32"}}},"LSS_ErrorResponseViewModel":{"type":"object","additionalProperties":false,"properties":{"description":{"type":"string","nullable":true},"status":{"type":"integer","format":"int32"},"reason":{"type":"string","nullable":true},"errors":{"type":"array","items":{"$ref":"#/components/schemas/LSS_Error"}}}},"LSS_Error":{"type":"object","additionalProperties":false,"properties":{"field":{"type":"string","nullable":true},"message":{"type":"string","nullable":true},"reason":{"type":"string","nullable":true},"type":{"type":"string","nullable":true},"stackTrace":{"type":"string","nullable":true}}},"LSS_RemoveAssetsCommand":{"type":"object","additionalProperties":false,"properties":{"ids":{"type":"array","items":{"type":"string"}}}},"LSS_ResponseViewModelOfListOfInteger":{"type":"object","additionalProperties":false,"properties":{"payload":{"type":"array","nullable":true,"items":{"type":"integer","format":"int32"}}}},"LSS_ResponseViewModelOfListOfDouble":{"type":"object","additionalProperties":false,"properties":{"payload":{"type":"array","nullable":true,"items":{"type":"number","format":"double"}}}},"LSS_UpdateFinanceAccountStatusResponse":{"type":"object","additionalProperties":false,"properties":{"wasDocumentUpdated":{"type":"boolean"},"errors":{"type":"array","items":{"type":"string"}}}},"LSS_FinanceAccountUpdateStatusModel":{"type":"object","additionalProperties":false,"required":["financeAccountId","status"],"properties":{"financeAccountId":{"type":"string"},"status":{"type":"string"}}},"LSS_DeleteFinanceAccountOrderResponse":{"type":"object","additionalProperties":false,"properties":{"wasOrderDeleted":{"type":"boolean"},"errors":{"type":"array","items":{"type":"string"}}}},"LSS_FinanceAccountDeleteOrderModel":{"type":"object","additionalProperties":false,"required":["financeAccountId","orderId"],"properties":{"financeAccountId":{"type":"string"},"orderId":{"type":"string","format":"guid"}}},"LSS_ResponseViewModelOfIReadOnlyCollectionOfSearchableHelocAndMeta":{"type":"object","additionalProperties":false,"properties":{"payload":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/LSS_SearchableHeloc"}},"meta":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/LSS_Meta"}]}}},"LSS_SearchableHeloc":{"allOf":[{"$ref":"#/components/schemas/LSS_SearchableAsset"},{"type":"object","additionalProperties":false,"properties":{"projectTypes":{"type":"array","nullable":true,"items":{"type":"string"}}}}]},"LSS_SearchableAsset":{"type":"object","additionalProperties":false,"properties":{"title":{"type":"string","nullable":true},"financeAccountId":{"type":"string","nullable":true},"financeAccountGuid":{"type":"string","nullable":true},"financeType":{"type":"string","nullable":true},"referenceId":{"type":"string","nullable":true},"tenantId":{"type":"string","format":"guid","nullable":true},"monthlyPayment":{"type":"number","format":"decimal","nullable":true},"product":{"type":"string","nullable":true},"projectType":{"type":"string","nullable":true},"status":{"type":"string","nullable":true},"statusDisplayValue":{"type":"string","nullable":true},"term":{"type":"integer","format":"int32","nullable":true},"propertyLocation":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/LSS_Address2"}]},"dateCreated":{"type":"string","format":"date-time","nullable":true},"dateUpdated":{"type":"string","format":"date-time","nullable":true},"dateIndexed":{"type":"string","format":"date-time","nullable":true},"expirationDate":{"type":"string","format":"date-time","nullable":true},"applicants":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/LSS_Applicant2"}},"salesPerson":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/LSS_Person2"}},"organizationId":{"type":"string","nullable":true},"systemDesignId":{"type":"string","nullable":true},"savingsScheduleId":{"type":"string","nullable":true},"utilityInformationId":{"type":"string","nullable":true},"calculatedSystemPricing":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/LSS_Pricing2"}]},"activeAgreementPricing":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/LSS_Pricing2"}]},"offerId":{"type":"string","nullable":true},"projectId":{"type":"string","nullable":true},"parties":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/LSS_Party2"}},"milestones":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/LSS_MilestoneObject"}},"fundedMilestones":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/LSS_MilestoneObject"}},"orders":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/LSS_Order"}},"cases":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/LSS_CaseSummary2"}]},"noOrdersCreated":{"type":"boolean","nullable":true},"tags":{"type":"array","nullable":true,"items":{"type":"string"}},"rate":{"type":"number","format":"float","nullable":true},"decomposedHierarchies":{"type":"array","nullable":true,"items":{"type":"string"}},"creditDecisionType":{"type":"string","nullable":true},"enrollments":{"type":"array","nullable":true,"items":{"type":"string"}},"agent":{"type":"string","nullable":true},"waitingOn":{"type":"array","nullable":true,"items":{"type":"string"}},"lastCompletedMilestone":{"type":"string","nullable":true},"numberOfApplicants":{"type":"integer","format":"int32","nullable":true},"loanId":{"type":"string","nullable":true},"loanGuid":{"type":"string","nullable":true},"language":{"type":"string","nullable":true},"isAutoPay":{"type":"boolean","nullable":true},"loanVersion":{"type":"string","nullable":true},"loanAmount":{"type":"number","format":"double","nullable":true},"category":{"type":"string","nullable":true},"categoryName":{"type":"string","nullable":true},"subCategories":{"type":"array","nullable":true,"items":{"type":"string"}},"stage":{"type":"string","nullable":true},"interestRate":{"type":"number","format":"double","nullable":true},"creditExpirationDate":{"type":"string","format":"date-time","nullable":true},"people":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/LSS_Person2"}},"legacyDealer":{"type":"string","nullable":true},"hasPurchaseOrder":{"type":"boolean","nullable":true},"purchaseOrderStatus":{"type":"string","nullable":true},"includeNotCreatedOrders":{"type":"boolean","nullable":true},"linkedFinanceAccount":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/LSS_LinkedFinanceAccount"}]},"creditExtension":{"type":"string","nullable":true},"projects":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/LSS_Project"}}}},"LSS_Address2":{"type":"object","additionalProperties":false,"properties":{"completeAddress":{"type":"string","nullable":true},"locality":{"type":"string","nullable":true},"adminArea":{"type":"string","nullable":true},"postalCode":{"type":"string","nullable":true},"country":{"type":"string","nullable":true},"adminArea1":{"type":"string","nullable":true},"adminArea2":{"type":"string","nullable":true}}},"LSS_Applicant2":{"type":"object","additionalProperties":false,"properties":{"firstName":{"type":"string","nullable":true},"lastName":{"type":"string","nullable":true},"socialSecurity":{"type":"string","nullable":true},"emailAddress":{"type":"string","nullable":true},"phoneNumber1":{"type":"string","nullable":true},"phoneNumber1Type":{"type":"string","nullable":true},"completeAddress":{"type":"string","nullable":true},"dateOfBirth":{"type":"string","format":"date-time","nullable":true},"locality":{"type":"string","nullable":true},"adminArea":{"type":"string","nullable":true},"postalCode":{"type":"string","nullable":true},"country":{"type":"string","nullable":true},"language":{"type":"string","nullable":true},"isPrimary":{"type":"boolean","nullable":true},"isDropped":{"type":"boolean","nullable":true},"annualIncome":{"type":"number","format":"float","nullable":true},"annualIncomeType":{"type":"string","nullable":true},"phoneNumber":{"type":"string","nullable":true},"adminArea1":{"type":"string","nullable":true},"adminArea2":{"type":"string","nullable":true}}},"LSS_Person2":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","nullable":true},"emailAddress":{"type":"string","nullable":true},"phone":{"type":"string","nullable":true},"type":{"type":"string","nullable":true},"userId":{"type":"string","format":"guid","nullable":true}}},"LSS_Pricing2":{"type":"object","additionalProperties":false,"properties":{"pricePerUnitType":{"type":"string","nullable":true},"pricePerUnitValue":{"type":"number","format":"float","nullable":true},"purchasePriceType":{"type":"string","nullable":true},"purchasePriceValue":{"type":"number","format":"float","nullable":true},"estimatedFirstYearMonthlyPaymentType":{"type":"string","nullable":true},"estimatedFirstYearMonthlyPaymentValue":{"type":"number","format":"float","nullable":true},"powerPurchaseRateType":{"type":"string","nullable":true},"powerPurchaseRateValue":{"type":"number","format":"float","nullable":true}}},"LSS_Party2":{"type":"object","additionalProperties":false,"properties":{"type":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"hKey":{"type":"string","nullable":true},"isPrimary":{"type":"boolean","nullable":true},"isDisabled":{"type":"boolean"},"workspaceId":{"type":"string","format":"guid","nullable":true},"organizationId":{"type":"string","format":"guid","nullable":true},"entityId":{"type":"string","format":"guid","nullable":true}}},"LSS_CaseSummary2":{"type":"object","additionalProperties":false,"properties":{"frozenCases":{"type":"integer","format":"int32","nullable":true},"rejectedCases":{"type":"integer","format":"int32","nullable":true},"openCases":{"type":"integer","format":"int32","nullable":true},"closedCases":{"type":"integer","format":"int32","nullable":true},"openGLCases":{"type":"integer","format":"int32","nullable":true},"totalCases":{"type":"integer","format":"int32","nullable":true},"openBorrowerCases":{"type":"integer","format":"int32","nullable":true},"dateCreated":{"type":"string","format":"date-time","nullable":true},"dateUpdated":{"type":"string","format":"date-time","nullable":true}}},"LSS_Project":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","nullable":true},"type":{"type":"string","nullable":true}}},"LSS_HelocSearchParameters":{"allOf":[{"$ref":"#/components/schemas/LSS_SearchUserExtension"},{"type":"object","additionalProperties":false,"properties":{"wellKnownFilter":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/LSS_WellKnownFilters"}]},"financeAccountId":{"type":"array","nullable":true,"items":{"type":"string"}},"sort":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/LSS_SortField2"}]},"fields":{"type":"array","nullable":true,"items":{"type":"string"}},"status":{"type":"array","nullable":true,"items":{"type":"string"}},"dateCreated":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/LSS_DateRange"}]},"dateUpdated":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/LSS_DateRange"}]},"propertyLocation":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/LSS_AddressParameters2"}]},"applicant":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/LSS_ApplicantParameters2"}]},"includeExpiredFinanceAccounts":{"type":"boolean","nullable":true},"parties":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/LSS_PartyParameters2"}},"referenceId":{"type":"string","nullable":true},"term":{"type":"array","nullable":true,"items":{"type":"integer","format":"int32"}},"projectTypes":{"type":"array","nullable":true,"items":{"type":"string"}},"salesPerson":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/LSS_PersonParameters"}]},"milestone":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/LSS_MilestoneParameters"}]},"stage":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/LSS_StageFilter"}]}}}]},"LSS_SortField2":{"type":"object","additionalProperties":false,"properties":{"field":{"$ref":"#/components/schemas/LSS_SortByField2"},"order":{"$ref":"#/components/schemas/LSS_ResultsSortOrder"}}},"LSS_SortByField2":{"type":"string","description":"","x-enumNames":["None","DateCreated","DateUpdated","SearchScore","ExpirationDate"],"enum":["None","DateCreated","DateUpdated","SearchScore","ExpirationDate"]},"LSS_AddressParameters2":{"type":"object","additionalProperties":false,"properties":{"adminArea":{"type":"array","nullable":true,"items":{"type":"string"}},"completeAddress":{"type":"string","nullable":true},"country":{"type":"string","nullable":true},"locality":{"type":"string","nullable":true},"postalCode":{"type":"string","nullable":true}}},"LSS_ApplicantParameters2":{"type":"object","additionalProperties":false,"properties":{"adminArea":{"type":"array","nullable":true,"items":{"type":"string"}},"annualIncome":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/LSS_NumericRange"}]},"annualIncomeType":{"type":"string","nullable":true},"completeAddress":{"type":"string","nullable":true},"country":{"type":"string","nullable":true},"dateOfBirth":{"type":"string","format":"date-time","nullable":true},"emailAddress":{"type":"string","nullable":true},"firstName":{"type":"string","nullable":true},"isPrimary":{"type":"boolean","nullable":true},"lastName":{"type":"string","nullable":true},"language":{"type":"string","nullable":true},"locality":{"type":"string","nullable":true},"phoneNumber1":{"type":"string","nullable":true},"postalCode":{"type":"string","nullable":true},"socialSecurity":{"type":"string","nullable":true}}},"LSS_PartyParameters2":{"type":"object","additionalProperties":false,"properties":{"type":{"type":"string","nullable":true},"entityId":{"type":"string","format":"guid","nullable":true},"name":{"type":"string","nullable":true},"hKey":{"type":"string","nullable":true},"isPrimary":{"type":"boolean","nullable":true},"workspaceId":{"type":"string","format":"guid","nullable":true}}},"LSS_ResponseViewModelOfIReadOnlyCollectionOfSearchableLoanAndMeta":{"type":"object","additionalProperties":false,"properties":{"payload":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/LSS_SearchableLoan"}},"meta":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/LSS_Meta"}]}}},"LSS_SearchableLoan":{"type":"object","additionalProperties":false,"properties":{"agent":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"numberOfApplicants":{"type":"integer","format":"int32","nullable":true},"loanId":{"type":"string","nullable":true},"loanGuid":{"type":"string","nullable":true},"language":{"type":"string","nullable":true},"referenceId":{"type":"string","nullable":true},"isAutoPay":{"type":"boolean","nullable":true},"tenantId":{"type":"string","format":"guid","nullable":true},"loanVersion":{"type":"string","nullable":true},"loanAmount":{"type":"number","format":"double","nullable":true},"category":{"type":"string","nullable":true},"categoryName":{"type":"string","nullable":true},"subCategories":{"type":"array","nullable":true,"items":{"type":"string"}},"status":{"type":"string","nullable":true},"statusDisplayValue":{"type":"string","nullable":true},"stage":{"type":"string","nullable":true},"interestRate":{"type":"number","format":"double","nullable":true},"term":{"type":"integer","format":"int32","nullable":true},"propertyLocation":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/LSS_Address3"}]},"dateCreated":{"type":"string","format":"date-time","nullable":true},"dateUpdated":{"type":"string","format":"date-time","nullable":true},"creditExpirationDate":{"type":"string","format":"date-time","nullable":true},"approvalDate":{"type":"string","format":"date-time","nullable":true},"creditDecisionType":{"type":"string","nullable":true},"applicants":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/LSS_Applicant3"}},"people":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/LSS_Person3"}},"tags":{"type":"array","nullable":true,"items":{"type":"string"}},"cases":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/LSS_CaseSummary3"}]},"parties":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/LSS_Party3"}},"milestones":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/LSS_MilestoneObject"}},"legacyDealer":{"type":"string","nullable":true},"hasPurchaseOrder":{"type":"boolean","nullable":true},"purchaseOrderStatus":{"type":"string","nullable":true},"lastCompletedMilestone":{"type":"string","nullable":true},"waitingOn":{"type":"array","nullable":true,"items":{"type":"string"}},"lastCompletedMilestoneUpdatedAt":{"type":"string","format":"date-time","nullable":true},"orders":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/LSS_Order"}},"includeNotCreatedOrders":{"type":"boolean","nullable":true}}},"LSS_Address3":{"type":"object","additionalProperties":false,"properties":{"completeAddress":{"type":"string","nullable":true},"locality":{"type":"string","nullable":true},"adminArea1":{"type":"string","nullable":true},"adminArea2":{"type":"string","nullable":true},"postalCode":{"type":"string","nullable":true},"country":{"type":"string","nullable":true}}},"LSS_Applicant3":{"type":"object","additionalProperties":false,"properties":{"firstName":{"type":"string","nullable":true},"lastName":{"type":"string","nullable":true},"dateOfBirth":{"type":"string","format":"date-time","nullable":true},"socialSecurity":{"type":"string","nullable":true},"emailAddress":{"type":"string","nullable":true},"phoneNumber":{"type":"string","nullable":true},"completeAddress":{"type":"string","nullable":true},"locality":{"type":"string","nullable":true},"adminArea1":{"type":"string","nullable":true},"adminArea2":{"type":"string","nullable":true},"postalCode":{"type":"string","nullable":true},"country":{"type":"string","nullable":true},"isPrimary":{"type":"boolean","nullable":true}}},"LSS_Person3":{"type":"object","additionalProperties":false,"properties":{"type":{"type":"string","nullable":true},"userId":{"type":"string","format":"guid","nullable":true},"name":{"type":"string","nullable":true},"emailAddress":{"type":"string","nullable":true},"phone":{"type":"string","nullable":true}}},"LSS_CaseSummary3":{"type":"object","additionalProperties":false,"properties":{"frozenCases":{"type":"integer","format":"int32","nullable":true},"rejectedCases":{"type":"integer","format":"int32","nullable":true},"openCases":{"type":"integer","format":"int32","nullable":true},"closedCases":{"type":"integer","format":"int32","nullable":true},"openGLCases":{"type":"integer","format":"int32","nullable":true},"totalCases":{"type":"integer","format":"int32","nullable":true},"openBorrowerCases":{"type":"integer","format":"int32","nullable":true},"dateCreated":{"type":"string","format":"date-time","nullable":true},"dateUpdated":{"type":"string","format":"date-time","nullable":true}}},"LSS_Party3":{"type":"object","additionalProperties":false,"properties":{"type":{"type":"string","nullable":true},"organizationId":{"type":"string","format":"guid","nullable":true},"entityId":{"type":"string","format":"guid","nullable":true},"name":{"type":"string","nullable":true},"hKey":{"type":"string","nullable":true},"isPrimary":{"type":"boolean","nullable":true},"workspaceId":{"type":"string","format":"guid","nullable":true},"isDisabled":{"type":"boolean"}}},"LSS_ResponseViewModelOfDocumentSearchResponseOfGroupByCount":{"type":"object","additionalProperties":false,"properties":{"payload":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/LSS_DocumentSearchResponseOfGroupByCount"}]}}},"LSS_DocumentSearchResponseOfGroupByCount":{"type":"object","additionalProperties":false,"properties":{"hits":{"type":"integer","format":"int64"},"duration":{"type":"integer","format":"int64"},"pageNumber":{"type":"integer","format":"int32","nullable":true},"itemsPerPage":{"type":"integer","format":"int32"},"next":{"type":"string","nullable":true},"documents":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/LSS_GroupByCount"}},"rawQuery":{"nullable":true}}},"LSS_GroupByCount":{"type":"object","additionalProperties":false,"properties":{"key":{"type":"string","nullable":true},"count":{"type":"integer","format":"int64"}}},"LSS_LookupTypes":{"type":"string","description":"","x-enumNames":["Categories","Languages","Milestones","PartyTypes","Statuses"],"enum":["Categories","Languages","Milestones","PartyTypes","Statuses"]},"LSS_LoanSearchParameters":{"allOf":[{"$ref":"#/components/schemas/LSS_SearchUserExtension"},{"type":"object","additionalProperties":false,"properties":{"wellKnownFilter":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/LSS_WellKnownFilters"}]},"tile":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/LSS_PipelineActionTile"}]},"title":{"type":"string","nullable":true},"numberOfApplicants":{"type":"integer","nullable":true},"loanId":{"type":"array","nullable":true,"items":{"type":"string"}},"language":{"type":"array","nullable":true,"items":{"type":"string"}},"rateAndTerms":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/LSS_RateTermParameters"}},"isAutoPay":{"type":"boolean","nullable":true},"tenantId":{"type":"string","format":"guid"},"loanVersion":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/LSS_NumericRange"}]},"loanAmount":{"type":"number","format":"double","nullable":true},"loanAmountRange":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/LSS_NumericRange"}]},"category":{"type":"array","nullable":true,"items":{"type":"string"}},"referenceId":{"type":"string","nullable":true},"subCategories":{"type":"array","nullable":true,"items":{"type":"string"}},"status":{"type":"array","nullable":true,"items":{"type":"string"}},"tags":{"type":"array","nullable":true,"items":{"type":"string"}},"stage":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/LSS_StageFilter"}]},"interestRate":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/LSS_NumericRange"}]},"term":{"type":"array","nullable":true,"items":{"type":"integer","format":"int32"}},"propertyLocation":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/LSS_AddressParameters3"}]},"dateCreated":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/LSS_DateRange"}]},"dateUpdated":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/LSS_DateRange"}]},"creditDecisionType":{"type":"string","nullable":true},"creditExpirationDate":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/LSS_DateRange"}]},"applicant":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/LSS_ApplicantParameters3"}]},"person":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/LSS_PersonParameters"}]},"parties":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/LSS_PartyParameters3"}},"hierarchies":{"type":"array","nullable":true,"items":{"type":"string"}},"milestone":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/LSS_MilestoneParameters"}]},"sort":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/LSS_SortField3"}]},"fields":{"type":"array","nullable":true,"items":{"type":"string"}},"agent":{"type":"string","nullable":true},"legacyDealer":{"type":"string","nullable":true},"cases":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/LSS_CasesSearchParameters2"}]},"orders":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/LSS_Orders"}]},"includeExpiredLoans":{"type":"boolean","nullable":true}}}]},"LSS_PipelineActionTile":{"type":"string","description":"","x-enumNames":["None","CreditAtRisk","LoanDocActions","NtpActions","InstallActions"],"enum":["None","CreditAtRisk","LoanDocActions","NtpActions","InstallActions"]},"LSS_RateTermParameters":{"type":"object","additionalProperties":false,"properties":{"rate":{"type":"number","format":"double"},"term":{"type":"integer","format":"int32"}}},"LSS_AddressParameters3":{"type":"object","additionalProperties":false,"properties":{"completeAddress":{"type":"string","nullable":true},"locality":{"type":"string","nullable":true},"adminArea1":{"type":"array","nullable":true,"items":{"type":"string"}},"adminArea2":{"type":"string","nullable":true},"postalCode":{"type":"string","nullable":true},"country":{"type":"string","nullable":true}}},"LSS_ApplicantParameters3":{"type":"object","additionalProperties":false,"properties":{"firstName":{"type":"string","nullable":true},"lastName":{"type":"string","nullable":true},"dateOfBirth":{"type":"string","format":"date-time","nullable":true},"socialSecurity":{"type":"string","nullable":true},"emailAddress":{"type":"string","nullable":true},"phoneNumber":{"type":"string","nullable":true},"completeAddress":{"type":"string","nullable":true},"locality":{"type":"string","nullable":true},"adminArea1":{"type":"array","nullable":true,"items":{"type":"string"}},"adminArea2":{"type":"string","nullable":true},"postalCode":{"type":"string","nullable":true},"country":{"type":"string","nullable":true},"isPrimary":{"type":"boolean","nullable":true}}},"LSS_PartyParameters3":{"type":"object","additionalProperties":false,"properties":{"type":{"type":"string","nullable":true},"organizationId":{"type":"string","format":"guid","nullable":true},"entityId":{"type":"string","format":"guid","nullable":true},"name":{"type":"string","nullable":true},"hKey":{"type":"string","nullable":true},"isPrimary":{"type":"boolean","nullable":true},"workspaceId":{"type":"string","format":"guid","nullable":true}}},"LSS_SortField3":{"type":"object","additionalProperties":false,"properties":{"field":{"$ref":"#/components/schemas/LSS_SortByField3"},"order":{"$ref":"#/components/schemas/LSS_ResultsSortOrder"}}},"LSS_SortByField3":{"type":"string","description":"","x-enumNames":["None","DateCreated","DateUpdated","SearchScore","CreditExpirationDate","ApprovalDate","LoanAmount","LastCompletedMilestoneUpdatedAt"],"enum":["None","DateCreated","DateUpdated","SearchScore","CreditExpirationDate","ApprovalDate","LoanAmount","LastCompletedMilestoneUpdatedAt"]},"LSS_CasesSearchParameters2":{"type":"object","additionalProperties":false,"properties":{"hasFrozenCases":{"type":"boolean","nullable":true},"hasOpenCases":{"type":"boolean","nullable":true},"hasRejectedCases":{"type":"boolean","nullable":true},"hasClosedCases":{"type":"boolean","nullable":true},"hasOpenBorrowerCases":{"type":"boolean","nullable":true},"hasOpenGoodLeapCases":{"type":"boolean","nullable":true}}},"LSS_Orders":{"type":"object","additionalProperties":false,"properties":{"payeeType":{"type":"array","nullable":true,"items":{"type":"string"}},"status":{"type":"array","nullable":true,"items":{"type":"string"}}}},"LSS_ResponseViewModelOfRemoveAssetsResponse":{"type":"object","additionalProperties":false,"properties":{"payload":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/LSS_RemoveAssetsResponse"}]}}},"LSS_ResponseViewModelOfListOfLegacyDealerSearchResponse":{"type":"object","additionalProperties":false,"properties":{"payload":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/LSS_LegacyDealerSearchResponse"}}}},"LSS_LegacyDealerSearchResponse":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string"}}},"LSS_ResponseViewModelOfListOfSubCategorySearchResponse":{"type":"object","additionalProperties":false,"properties":{"payload":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/LSS_SubCategorySearchResponse"}}}},"LSS_SubCategorySearchResponse":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string"}}},"SUBMISSION_ApiResponse":{"type":"object","properties":{"payload":{"description":"The response data.","type":"object"}},"required":["payload"]},"SUBMISSION_Cursor":{"type":"object","properties":{"prev":{"type":"string","nullable":true,"description":"A point of reference to the previous page of data. Set to `null` when there is no more data to get back to."},"next":{"type":"string","nullable":true,"description":"A point of reference to the next page of data. Set to `null` when there is no more data to fetch."},"size":{"type":"number","description":"Number of items to return in the page."},"total":{"type":"number","description":"The total number of items."}},"required":["prev","next","size","total"]},"SUBMISSION_ApiResponseMeta":{"type":"object","properties":{"cursor":{"description":"The cursor metadata.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_Cursor"}]}},"required":["cursor"]},"SUBMISSION_ApiResponseWithPagination":{"type":"object","properties":{"payload":{"description":"The response data.","type":"object"},"meta":{"description":"The response metadata.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_ApiResponseMeta"}]}},"required":["payload","meta"]},"SUBMISSION_ApiErrorDetail":{"type":"object","properties":{"field":{"type":"string","description":"The field with faulty data."},"message":{"type":"string","description":"The message containing details about the underlying error."},"reason":{"type":"string","description":"The error code."},"type":{"type":"string","description":"The error type.","default":""}},"required":["field","message","reason"]},"SUBMISSION_ApiError":{"type":"object","properties":{"description":{"type":"string","description":"A short description of what led to the unexpected condition."},"reason":{"type":"string","description":"An additional error code that can be used to consult reference documentation."},"errors":{"description":"An optional collection of details about the errors that occurred.","type":"array","items":{"$ref":"#/components/schemas/SUBMISSION_ApiErrorDetail"}}},"required":["description"]},"SUBMISSION_FindDupeKeyOutput":{"type":"object","properties":{"financeAccountId":{"type":"string","nullable":true,"description":"The finance account ID of the first matching document."},"dupeKeys":{"nullable":true,"description":"The list of corresponding dupe keys that were returned from the finance account.","type":"array","items":{"type":"string"}}},"required":["financeAccountId","dupeKeys"]},"SUBMISSION_Address":{"type":"object","properties":{"line1":{"type":"string","description":"The street address."},"line2":{"type":"string","description":"Additional details such as apartment or unit number, suite, floor, building, etc."},"city":{"type":"string","description":"The city."},"state":{"type":"string","description":"The state.","pattern":"/^[A-Z]{2}$/"},"zip":{"type":"string","description":"The ZIP code.","pattern":"/^\\d{5}(?:-\\d{4})?$/"},"country":{"type":"string","description":"The country in ISO 3166-1 alpha-2 format. Defaults to US."}},"required":["line1","city","state","zip"]},"SUBMISSION_Coordinates":{"type":"object","properties":{"latitude":{"type":"number","description":"The latitude of the subject property.","minimum":-90,"maximum":90},"longitude":{"type":"number","description":"The longitude of the subject property.","minimum":-180,"maximum":180}},"required":["latitude","longitude"]},"SUBMISSION_CurrencyMeasurement":{"type":"object","properties":{"label":{"type":"string","description":"The display name of the currency."},"type":{"type":"string","description":"The type of currency.","enum":["USD"]},"value":{"type":"number","minimum":0}},"required":["type","value"]},"SUBMISSION_SubjectProperty":{"type":"object","properties":{"address":{"description":"The address of the property.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_Address"}]},"coordinates":{"description":"The coordinates of the property.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_Coordinates"}]},"isMobileOrManufacturedHome":{"type":"boolean","description":"Whether the property is a mobile or manufactured home."},"propertyType":{"type":"string","description":"The type of property.","enum":["Detached Single Family","Condo","Multi Family Dwelling","Low Density Multi Family Dwelling","Mobile","Other","Manufactured","Townhouse"]},"mortgageTotalBalances":{"description":"The total balances of the mortgage.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_CurrencyMeasurement"}]},"mortgageTotalPayments":{"description":"The total payments of the mortgage.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_CurrencyMeasurement"}]},"fips":{"type":"string","description":"The FIPS code of the property."},"situsCensusTract":{"type":"string","description":"The Situs Census Tract of the property."},"lienPosition":{"type":"number","description":"The position of the lien on the property."},"legalDescription":{"type":"string","nullable":true,"description":"The full legal description of the property, used on lien/closing documents."}},"required":["address"]},"SUBMISSION_TpoApplicationDto":{"type":"object","properties":{"accountId":{"type":"string","description":"The unique identifier of the account associated to this application."},"financeAccountId":{"type":"string","description":"The human-readable finance account ID."},"financeType":{"description":"The finance type of the application.","enum":["loan","lease","ppa","ppav","e-heloc"],"type":"string"},"organizationId":{"type":"string","description":"The unique identifier of the organization that the application is associated with."},"salesRepId":{"type":"string","description":"The unique identifier of the sales rep that submitted the application."},"enrollments":{"description":"A collection of enrollments the applicant signed up for.","type":"array","items":{"type":"string","enum":["AUTOPAY","PAPERLESS_COMMUNICATIONS"]}},"disclosureId":{"type":"string","description":"The signed token of the disclosures the applicant agreed to."},"subjectProperty":{"description":"The property where the project is being done.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_SubjectProperty"}]},"tags":{"description":"Optional user-defined tags added to the application.","type":"array","items":{"type":"string"}},"status":{"description":"The status of the application.","enum":["APPROVED","APPROVED_WITH_STIPS","DECLINED","PENDING","CANCELED"],"type":"string"},"type":{"description":"The decision that was made on the application by the underwriting engine.","enum":["SINGLE","COMBINED","PRIMARY","SECONDARY"],"type":"string"},"reason":{"type":"string","description":"The reason the application was declined or approved with stips."},"expiresAt":{"format":"date-time","type":"string","description":"The application expiration date, which is 120 days from the creation date."},"referenceNumber":{"type":"string","description":"A custom reference number external parties use to link the application back to their systems."},"version":{"type":"number","description":"The version of the application."},"tenantId":{"type":"string","description":"The unique identifier of the tenant."},"createdAt":{"format":"date-time","type":"string","description":"The date and time the entity was created."},"createdBy":{"type":"string","description":"The unique identifier of the user who created the entity."},"updatedAt":{"format":"date-time","type":"string","description":"The date and time the entity was last updated."},"updatedBy":{"type":"string","description":"The unique identifier of the user who last updated the entity."},"removedAt":{"format":"date-time","type":"string","description":"The date and time the entity was marked as removed."},"removedBy":{"type":"string","description":"The unique identifier of the user who removed the entity."},"id":{"type":"string","description":"The unique identifier of the entity."}},"required":["accountId","financeAccountId","financeType","organizationId","salesRepId","enrollments","subjectProperty","tags","status","type","reason","expiresAt","version","tenantId","createdAt","createdBy","id"]},"SUBMISSION_PersonalIdentity":{"type":"object","properties":{"type":{"type":"string","description":"The document type.","enum":["SSN"]},"displayName":{"type":"string","description":"The display name of the document type."},"value":{"type":"string","description":"The unique identification number."},"issuingCountry":{"type":"string","description":"The country that issues the personal identity document."}},"required":["type","value","issuingCountry"]},"SUBMISSION_Phone":{"type":"object","properties":{"countryCode":{"type":"string","description":"The country code in E.164 format."},"isoCountryCode":{"type":"string","description":"The country in ISO 3166-1 alpha-2 format. Defaults to US."},"phoneNumber":{"type":"string","description":"The phone number."},"type":{"type":"string","description":"The phone number type.","enum":["HOME","MOBILE"]}},"required":["countryCode","phoneNumber","type"]},"SUBMISSION_MaritalPartnerContactDto":{"type":"object","properties":{"email":{"type":"string","description":"The marital partner's email address."},"primaryPhoneNumber":{"description":"The marital partner's primary phone number.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_Phone"}]},"secondaryPhoneNumber":{"description":"The marital partner's secondary phone number.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_Phone"}]}},"required":["email","primaryPhoneNumber"]},"SUBMISSION_MaritalPartnerDto":{"type":"object","properties":{"firstName":{"type":"string","description":"The marital partner's first name."},"lastName":{"type":"string","description":"The marital partner's last name."},"contact":{"description":"The marital partner's contact information.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_MaritalPartnerContactDto"}]}},"required":["firstName","lastName","contact"]},"SUBMISSION_ApplicantDto":{"type":"object","properties":{"firstName":{"type":"string","description":"The applicant's first name."},"lastName":{"type":"string","description":"The applicant's last name."},"dateOfBirth":{"format":"date-time","type":"string","description":"The applicant's date of birth."},"email":{"type":"string","description":"The applicant's email address."},"personalIdentity":{"description":"The applicant's personal identity information.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_PersonalIdentity"}]},"homeOccupancy":{"description":"Occupancy status of the applicant's property.","enum":["PRIMARY","SECONDARY","INVESTMENT","OTHER"],"type":"string"},"homeOccupancyDisplayValue":{"description":"The display value of the occupancy status of the applicant's property.","enum":["Primary residence","Second or vacation home","Investment property","Doesn't occupy or own"],"type":"string"},"homeOwnership":{"description":"Ownership status of the applicant's property.","enum":["NOT_OWNED","OWNED_WITH_MORTGAGE","OWNED_FREE_AND_CLEAR"],"type":"string"},"annualIncome":{"description":"Total annual income, as reported by the applicant.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_CurrencyMeasurement"}]},"verifiedAnnualIncome":{"description":"The applicant's verified annual income from the income verification workflow.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_CurrencyMeasurement"}]},"primaryPhoneNumber":{"description":"The applicant's primary phone number.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_Phone"}]},"secondaryPhoneNumber":{"nullable":true,"description":"The applicant's secondary phone number.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_Phone"}]},"spokenLanguage":{"description":"The applicant's spoken language.","enum":["ENGLISH","SPANISH"],"type":"string"},"spokenLanguageDisplayValue":{"description":"The display value of the applicant's spoken language.","enum":["English","Spanish"],"type":"string"},"employmentStatus":{"description":"The applicant's employment status.","enum":["EMPLOYED","RETIRED","NOT_EMPLOYED","OTHER"],"type":"string"},"citizenshipStatus":{"description":"The applicant's citizenship status.","enum":["US_CITIZEN","LAWFUL_PERMANENT_RESIDENT_ALIEN","OTHER"],"type":"string"},"address":{"description":"The applicant's mailing address.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_Address"}]},"electronicConsent":{"type":"boolean","description":"The applicant's consent to have their information stored and processed."},"isPrimary":{"type":"boolean","description":"Indicates whether the applicant is the primary applicant."},"dropped":{"type":"boolean","description":"Indicates whether the applicant has been dropped from the application."},"isOnTitle":{"type":"boolean","description":"Indicates whether underwriting verified the applicant is on the property\ntitle. `undefined` when underwriting made no determination."},"maritalStatus":{"description":"The applicant's marital status.","enum":["SINGLE","MARRIED","DIVORCED","SEPARATED","WIDOWED"],"type":"string"},"maritalPartner":{"description":"The applicant's marital partner. Populated when `maritalStatus` is one\nthat requires a partner (e.g. `MARRIED`, `SEPARATED`).","allOf":[{"$ref":"#/components/schemas/SUBMISSION_MaritalPartnerDto"}]},"tenantId":{"type":"string","description":"The unique identifier of the tenant."},"createdAt":{"format":"date-time","type":"string","description":"The date and time the entity was created."},"createdBy":{"type":"string","description":"The unique identifier of the user who created the entity."},"updatedAt":{"format":"date-time","type":"string","description":"The date and time the entity was last updated."},"updatedBy":{"type":"string","description":"The unique identifier of the user who last updated the entity."},"removedAt":{"format":"date-time","type":"string","description":"The date and time the entity was marked as removed."},"removedBy":{"type":"string","description":"The unique identifier of the user who removed the entity."},"id":{"type":"string","description":"The unique identifier of the entity."}},"required":["firstName","lastName","dateOfBirth","email","personalIdentity","homeOccupancy","homeOwnership","annualIncome","primaryPhoneNumber","spokenLanguage","employmentStatus","citizenshipStatus","address","electronicConsent","isPrimary","dropped","tenantId","createdAt","createdBy","id"]},"SUBMISSION_LinkedFinanceAccountDto":{"type":"object","properties":{"linkType":{"type":"string","description":"The type of the linked finance account.","enum":["NEW_ACCOUNT","ASSUMED_ACCOUNT","ROOT_ACCOUNT","LOAN"]},"financeAccountId":{"type":"string","description":"The unique identifier of the linked finance account."},"location":{"type":"string","description":"The location of the linked finance account.","enum":["INTEGRATION_API"]}},"required":["linkType","financeAccountId"]},"SUBMISSION_FinanceAccountDto":{"type":"object","properties":{"financeAccountId":{"type":"string","description":"The human-readable finance account ID."},"offerId":{"type":"string","description":"The unique identifier of the offer which can then be used to fetch rate, term and other product-related data."},"categoryCode":{"description":"The code of the category for this project.","enum":["Solar_TPO","HVAC_LEASE","BATTERY_LEASE","HELOC"],"type":"string"},"categoryId":{"type":"string","description":"The unique identifier of the category for this project."},"applications":{"description":"The applications that the finance account is associated with.","type":"array","items":{"$ref":"#/components/schemas/SUBMISSION_TpoApplicationDto"}},"applicants":{"description":"The applicants associated with the application.","type":"array","items":{"$ref":"#/components/schemas/SUBMISSION_ApplicantDto"}},"linkedFinanceAccounts":{"description":"The linked finance accounts associated with the finance account.","type":"array","items":{"$ref":"#/components/schemas/SUBMISSION_LinkedFinanceAccountDto"}},"tenantId":{"type":"string","description":"The unique identifier of the tenant."},"createdAt":{"format":"date-time","type":"string","description":"The date and time the entity was created."},"createdBy":{"type":"string","description":"The unique identifier of the user who created the entity."},"updatedAt":{"format":"date-time","type":"string","description":"The date and time the entity was last updated."},"updatedBy":{"type":"string","description":"The unique identifier of the user who last updated the entity."},"removedAt":{"format":"date-time","type":"string","description":"The date and time the entity was marked as removed."},"removedBy":{"type":"string","description":"The unique identifier of the user who removed the entity."},"id":{"type":"string","description":"The unique identifier of the entity."}},"required":["financeAccountId","offerId","categoryCode","categoryId","applications","applicants","tenantId","createdAt","createdBy","id"]},"SUBMISSION_UpdateFinanceAccountDispositionInput":{"type":"object","properties":{"requesterName":{"type":"string","description":"The name of the person requesting the disposition change.","minLength":1,"maxLength":255},"reason":{"type":"string","description":"The reason for a cancelation.","minLength":1,"maxLength":500}}},"SUBMISSION_ProjectTypeDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the project type."},"code":{"type":"string","description":"The code of the project type.","enum":["Solar","Battery_nonbackup","Battery_backup"]},"name":{"type":"string","description":"The name of the project type."}},"required":["id","code","name"]},"SUBMISSION_StateDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the state."},"code":{"type":"string","description":"The code of the state."},"name":{"type":"string","description":"The name of the state."}},"required":["id","code","name"]},"SUBMISSION_KwhRateLimitDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the kwh rate limit."},"minRateKwh":{"type":"number","description":"The minimum rate in kWh."},"maxRateKwh":{"type":"number","description":"The maximum rate in kWh."}},"required":["id","minRateKwh","maxRateKwh"]},"SUBMISSION_UtilityCompanyDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the utility company."},"code":{"type":"string","description":"The code of the utility company."},"name":{"type":"string","description":"The name of the utility company."},"lseId":{"type":"string","description":"The Load Serving Entity ID of the utility company."},"stateGuid":{"type":"string","description":"The ID of the state the utility company is in."},"stateCode":{"type":"string","description":"The code of the state the utility company is in."}},"required":["id","code","name","stateGuid","stateCode"]},"SUBMISSION_FormulaVariableDto":{"type":"object","properties":{"baseSlope":{"type":"number","description":"The base slope of the formula."},"slopeDelta":{"type":"number","description":"The slope delta of the formula."},"baseIntercept":{"type":"number","description":"The base intercept of the formula."},"interceptDelta":{"type":"number","description":"The intercept delta of the formula."},"targetDate":{"format":"date-time","type":"string","description":"The target date of the formula."},"effectiveAt":{"format":"date-time","type":"string","description":"The effective date of the formula."},"nonDomesticContentAdj":{"type":"number","description":"The non-domestic-content pricing adjustment of the formula.\nDefaults to 0 when no non-domestic content adjustment is applied to the offer."}},"required":["baseSlope","slopeDelta","baseIntercept","interceptDelta","nonDomesticContentAdj"]},"SUBMISSION_CategoryDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the category."},"code":{"type":"string","description":"The code of the category.","enum":["Solar_TPO","HVAC_LEASE","BATTERY_LEASE","HELOC"]},"name":{"type":"string","description":"The name of the category."}},"required":["id","code","name"]},"SUBMISSION_TpoProductDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the TPO product."},"name":{"type":"string","description":"The name of the TPO product."},"code":{"type":"object","description":"The code of the TPO product."},"description":{"type":"string","description":"The description of the TPO product."}},"required":["id","name","code","description"]},"SUBMISSION_TermDto":{"type":"object","properties":{"termYears":{"type":"number","description":"The term expressed in years."},"termMonths":{"type":"number","description":"The term expressed in months."}},"required":["termYears","termMonths"]},"SUBMISSION_SolarTpoOfferDto":{"type":"object","properties":{"projectType":{"description":"The type of project associated with the offer.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_ProjectTypeDto"}]},"state":{"description":"The state where the offer is valid.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_StateDto"}]},"kwhRateLimit":{"description":"The rate limit of the offer.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_KwhRateLimitDto"}]},"utilityCompany":{"description":"The utility company associated with the offer.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_UtilityCompanyDto"}]},"targetedFormulaVariables":{"description":"A set of formula variables associated with the offer, targeted for a specific date.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_FormulaVariableDto"}]},"formulaVariables":{"description":"The formula variables associated with the offer.","type":"array","items":{"$ref":"#/components/schemas/SUBMISSION_FormulaVariableDto"}},"offerId":{"type":"string","description":"The unique identifier of the offer."},"offerOptionId":{"type":"number","description":"The legacy identifier of the offer."},"offerName":{"type":"string","description":"The name of the offer."},"category":{"description":"The category of the offer.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_CategoryDto"}]},"tpoProduct":{"description":"The product associated with the offer.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_TpoProductDto"}]},"term":{"description":"The term of the offer.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_TermDto"}]},"escalatorRatePercent":{"type":"number","description":"The escalator rate of the offer."}},"required":["projectType","state","kwhRateLimit","utilityCompany","targetedFormulaVariables","formulaVariables","offerId","offerOptionId","offerName","category","tpoProduct","term","escalatorRatePercent"]},"SUBMISSION_ManufacturerDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the manufacturer."},"externalCode":{"type":"string","description":"The code of the manufacturer used in Project-Info Service as `projectType.component.key`."},"code":{"type":"string","description":"The code of the manufacturer."},"name":{"type":"string","description":"The name of the manufacturer."}},"required":["id","externalCode","code","name"]},"SUBMISSION_EquipmentLeaseOfferDto":{"type":"object","properties":{"manufacturer":{"description":"The manufacturer of the equipment.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_ManufacturerDto"}]},"targetedFormulaVariables":{"description":"A set of formula variables associated with the offer, targeted for a specific date.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_FormulaVariableDto"}]},"formulaVariables":{"description":"The formula variables associated with the offer.","type":"array","items":{"$ref":"#/components/schemas/SUBMISSION_FormulaVariableDto"}},"offerId":{"type":"string","description":"The unique identifier of the offer."},"offerOptionId":{"type":"number","description":"The legacy identifier of the offer."},"offerName":{"type":"string","description":"The name of the offer."},"category":{"description":"The category of the offer.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_CategoryDto"}]},"tpoProduct":{"description":"The product associated with the offer.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_TpoProductDto"}]},"term":{"description":"The term of the offer.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_TermDto"}]},"escalatorRatePercent":{"type":"number","description":"The escalator rate of the offer."}},"required":["manufacturer","targetedFormulaVariables","formulaVariables","offerId","offerOptionId","offerName","category","tpoProduct","term","escalatorRatePercent"]},"SUBMISSION_BaseTpoOfferDto":{"type":"object","properties":{"offerId":{"type":"string","description":"The unique identifier of the offer."},"offerOptionId":{"type":"number","description":"The legacy identifier of the offer."},"offerName":{"type":"string","description":"The name of the offer."},"category":{"description":"The category of the offer.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_CategoryDto"}]},"tpoProduct":{"description":"The product associated with the offer.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_TpoProductDto"}]},"term":{"description":"The term of the offer.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_TermDto"}]},"escalatorRatePercent":{"type":"number","description":"The escalator rate of the offer."}},"required":["offerId","offerOptionId","offerName","category","tpoProduct","term","escalatorRatePercent"]},"SUBMISSION_OrgOfferDto":{"type":"object","properties":{"id":{"type":"number","description":"The legacy identifier of the offer."},"offerId":{"type":"string","description":"The unique identifier of the offer."},"product":{"type":"object","description":"The product details of the offer."},"category":{"description":"The category of the offer.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_CategoryDto"}]},"term":{"type":"object","description":"The term of the offer."},"rate":{"type":"object","description":"The rate of the offer."},"revolvingRate":{"type":"object","description":"The revolving rate of the offer."}},"required":["id","offerId","product","category","term","rate","revolvingRate"]},"SUBMISSION_UpdateFinanceAccountOfferOutput":{"type":"object","properties":{"newOfferId":{"type":"string"}},"required":["newOfferId"]},"SUBMISSION_UpdateFinanceAccountOfferInput":{"type":"object","properties":{"offerId":{"type":"string","description":"The offer ID to update on the finance account."}},"required":["offerId"]},"SUBMISSION_RerunUnderwritingResponse":{"type":"object","properties":{"status":{"type":"string","description":"The status of the application.","enum":["APPROVED","APPROVED_WITH_STIPS","DECLINED","PENDING","CANCELED"]}},"required":["status"]},"SUBMISSION_UpdateApplicantInput":{"type":"object","properties":{"type":{"type":"string","description":"The type of applicant.","enum":["APPLICANT","COAPPLICANT"]},"isOnTitle":{"type":"boolean","description":"Whether the applicant is on the property title."},"firstName":{"type":"string","description":"The applicant's first name."},"lastName":{"type":"string","description":"The applicant's last name."},"dateOfBirth":{"format":"date-time","type":"string","description":"The applicant's date of birth."},"personalIdentity":{"description":"The applicant's personal identity information.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_PersonalIdentityInputDto"}]},"homeOccupancy":{"type":"string","description":"Occupancy status of the applicant's property.","enum":["PRIMARY","SECONDARY","INVESTMENT","OTHER"]},"homeOwnership":{"type":"string","description":"Ownership status of the applicant's property.","enum":["NOT_OWNED","OWNED_WITH_MORTGAGE","OWNED_FREE_AND_CLEAR"]},"annualIncome":{"description":"Total annual income.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_CurrencyMeasurementInputDto"}]},"email":{"type":"string","description":"The applicant's email address."},"primaryPhoneNumber":{"description":"The applicant's primary phone number.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_PhoneInputDto"}]},"secondaryPhoneNumber":{"nullable":true,"description":"The applicant's secondary phone number.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_PhoneInputDto"}]},"spokenLanguage":{"type":"string","description":"The applicant's spoken language.","enum":["ENGLISH","SPANISH"]},"employmentStatus":{"type":"string","description":"The applicant's employment status.","enum":["EMPLOYED","RETIRED","NOT_EMPLOYED","OTHER"]},"citizenshipStatus":{"type":"string","description":"The applicant's citizenship status.","enum":["US_CITIZEN","LAWFUL_PERMANENT_RESIDENT_ALIEN","OTHER"]},"address":{"description":"The applicant's mailing address.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_Address"}]},"maritalStatus":{"type":"string","description":"The applicant's marital status.","enum":["SINGLE","MARRIED","DIVORCED","SEPARATED","WIDOWED"]},"maritalPartner":{"description":"The applicant's marital partner information.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_MaritalPartnerInputDto"}]}},"required":["type"]},"SUBMISSION_LenderDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the lender."},"name":{"type":"string","description":"The name of the lender."}},"required":["id","name"]},"SUBMISSION_CreateEvaluationOutputDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the evaluation."},"lender":{"description":"The lender that processed the evaluation.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_LenderDto"}]},"lenderApplicationId":{"type":"string","description":"The application ID of the lender."},"lenderApplicationUrl":{"type":"string","description":"The lender's application URL."},"status":{"type":"string","description":"The status of the evaluation.","enum":["APPROVED","DECLINED","PENDING"]}},"required":["id","lender","lenderApplicationId","lenderApplicationUrl","status"]},"SUBMISSION_AdditionalInputDto":{"type":"object","properties":{"key":{"type":"string","description":"The key identifier for the additional data."},"value":{"type":"string","description":"The value associated with the key."}},"required":["key","value"]},"SUBMISSION_CreateEvaluationInput":{"type":"object","properties":{"lenderId":{"type":"string","description":"The unique identifier of the lender."},"disclosureToken":{"type":"string","description":"The disclosure token string."},"additionalInputs":{"description":"Additional input data provided with the evaluation.","type":"array","items":{"$ref":"#/components/schemas/SUBMISSION_AdditionalInputDto"}}},"required":["lenderId","disclosureToken","additionalInputs"]},"SUBMISSION_GetEvaluationOutputDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the evaluation."},"lender":{"description":"The lender that processed the evaluation.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_LenderDto"}]},"lenderApplicationId":{"type":"string","description":"The application ID of the lender."},"lenderApplicationUrl":{"type":"string","description":"The lender's application URL."},"status":{"description":"The status of the evaluation.","enum":["APPROVED","DECLINED","PENDING"],"type":"string"},"createdAt":{"format":"date-time","type":"string","description":"The date and time the evaluation was created."}},"required":["id","lender","status","createdAt"]},"SUBMISSION_MetadataOutputDto":{"type":"object","properties":{"clientName":{"type":"string","description":"The originating client application the token was issued from. Used by\ndownstream consumers (e.g. GL Home) to make decisions based on the\norigination platform of the finance account."},"workflowType":{"type":"string","description":"Whether the application was submitted through a B2B (e.g. POS) or B2C\n(e.g. Home Owner App) channel. Absent on records created before this\nfield was introduced.","enum":["POS","D2C"]}}},"SUBMISSION_LegalEntityDto":{"type":"object","properties":{"name":{"type":"string","description":"The name of the legal entity."},"address":{"description":"The address of the legal entity.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_Address"}]}},"required":["name","address"]},"SUBMISSION_MortgageOfficerOutputDto":{"type":"object","properties":{"fullName":{"type":"string","description":"The full name of the mortgage officer."},"licenseNumber":{"type":"string","description":"The license number of the mortgage officer."},"legalEntity":{"description":"The legal entity details of the mortgage officer.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_LegalEntityDto"}]},"id":{"type":"string","description":"The unique identifier of the entity."}},"required":["fullName","licenseNumber","legalEntity","id"]},"SUBMISSION_UpdateFinanceAccountMortgageOfficerInput":{"type":"object","properties":{"mortgageOfficerId":{"type":"string","description":"The unique identifier of the mortgage officer."}},"required":["mortgageOfficerId"]},"SUBMISSION_PersonaMaritalPartnerDto":{"type":"object","properties":{"firstName":{"type":"string","description":"The marital partner's first name."},"lastName":{"type":"string","description":"The marital partner's last name."},"email":{"type":"string","description":"The marital partner's email address."},"primaryPhoneNumber":{"description":"The marital partner's primary phone number.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_Phone"}]},"secondaryPhoneNumber":{"description":"The marital partner's secondary phone number.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_Phone"}]}},"required":["firstName","lastName","email","primaryPhoneNumber"]},"SUBMISSION_PersonaDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the persona."},"type":{"type":"string","description":"The persona type.","enum":["PROPERTY_OWNER"]},"firstName":{"type":"string","description":"The persona's first name."},"lastName":{"type":"string","description":"The persona's last name."},"email":{"type":"string","description":"The persona's email address."},"primaryPhoneNumber":{"description":"The persona's primary phone number.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_Phone"}]},"secondaryPhoneNumber":{"description":"The persona's secondary phone number.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_Phone"}]},"maritalStatus":{"description":"The persona's marital status.","enum":["SINGLE","MARRIED","DIVORCED","SEPARATED","WIDOWED"],"type":"string"},"maritalPartner":{"description":"The persona's marital partner information.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_PersonaMaritalPartnerDto"}]},"createdAt":{"format":"date-time","type":"string","description":"The timestamp of when the persona was created."}},"required":["id","type","firstName","lastName","createdAt"]},"SUBMISSION_CreatePersonaInput":{"type":"object","properties":{"type":{"type":"string","description":"The persona type.","enum":["PROPERTY_OWNER"]},"firstName":{"type":"string","description":"The persona's first name."},"lastName":{"type":"string","description":"The persona's last name."},"email":{"type":"string","description":"The persona's email address."},"primaryPhoneNumber":{"description":"The persona's primary phone number.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_Phone"}]},"secondaryPhoneNumber":{"description":"The persona's secondary phone number.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_Phone"}]},"maritalStatus":{"type":"string","description":"The persona's marital status.","enum":["SINGLE","MARRIED","DIVORCED","SEPARATED","WIDOWED"]},"maritalPartner":{"description":"The persona's marital partner information.\nRequired when `maritalStatus` is `MARRIED` or `SEPARATED`.\nNot allowed when `maritalStatus` is `SINGLE`, `DIVORCED`, or `WIDOWED`.\nMust not be provided when `maritalStatus` is absent.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_PersonaMaritalPartnerDto"}]}},"required":["type","firstName","lastName","email","primaryPhoneNumber","maritalStatus"]},"SUBMISSION_UpdatePersonaInput":{"type":"object","properties":{"firstName":{"type":"string","description":"The persona's first name. Optional on update; omit to leave it unchanged.\nCannot be cleared — an explicit null is rejected."},"lastName":{"type":"string","description":"The persona's last name. Optional on update; omit to leave it unchanged.\nCannot be cleared — an explicit null is rejected."},"email":{"type":"string","description":"The persona's email address. Optional on update; omit to leave it\nunchanged. Cannot be cleared — an explicit null is rejected."},"primaryPhoneNumber":{"description":"The persona's primary phone number. Optional on update; omit to leave it\nunchanged. Cannot be cleared — an explicit null is rejected.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_Phone"}]},"secondaryPhoneNumber":{"nullable":true,"description":"The persona's secondary phone number.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_Phone"}]},"maritalStatus":{"type":"string","description":"The persona's marital status. Optional on update; omit to leave it\nunchanged. Cannot be cleared — an explicit null is rejected.","enum":["SINGLE","MARRIED","DIVORCED","SEPARATED","WIDOWED"]},"maritalPartner":{"nullable":true,"description":"The persona's marital partner information.\nCross-field validation with maritalStatus is performed in the service\nafter merging with existing persona state.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_PersonaMaritalPartnerDto"}]}}},"SUBMISSION_AddSolarTpoPricingInput":{"type":"object","properties":{"systemSize":{"type":"number","description":"Size of the solar system in kilowatts (kW).\nRequired for Solar TPO pricing."},"estimatedAnnualProduction":{"type":"number","description":"Estimated annual energy production in kilowatt-hours (kWh).\nRequired for Solar TPO pricing."},"kWhRate":{"type":"number","description":"Rate per kilowatt-hour in dollars.\nRequired for Solar TPO pricing."},"offerId":{"type":"string","description":"The unique identifier of the finance offer."},"projectId":{"type":"string","description":"The project identifier associated with this pricing calculation."},"projectDescriptionId":{"type":"string","description":"The project description identifier containing detailed system design specifications."}},"required":["systemSize","estimatedAnnualProduction","kWhRate","offerId","projectId","projectDescriptionId"]},"SUBMISSION_HvacLeasePricingSystemDesign":{"type":"object","properties":{"acManufacturer":{"type":"string","description":"AC manufacturer identifier. Standardized code, not display name (HVAC Lease)."},"acModel":{"type":"string","description":"AC model identifier. Standardized code, not display name (HVAC Lease).\nOptional - when absent, Catalog may return estimated pricing instead of complete calculation."}},"required":["acManufacturer"]},"SUBMISSION_HvacLeasePricingProject":{"type":"object","properties":{"cost":{"description":"The total cost of the equipment being leased.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_CurrencyMeasurement"}]},"systemDesign":{"description":"Information about the HVAC system to be installed on the property.\nThe values provided are stored in Project Info Service and used to calculate pricing.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_HvacLeasePricingSystemDesign"}]}},"required":["cost","systemDesign"]},"SUBMISSION_AddHvacLeasePricingInput":{"type":"object","properties":{"project":{"description":"Project details including cost and system design for HVAC Lease pricing.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_HvacLeasePricingProject"}]},"offerId":{"type":"string","description":"The unique identifier of the finance offer."},"projectId":{"type":"string","description":"The project identifier associated with this pricing calculation."},"projectDescriptionId":{"type":"string","description":"The project description identifier containing detailed system design specifications."}},"required":["project","offerId","projectId","projectDescriptionId"]},"SUBMISSION_BatteryLeasePricingSystemDesign":{"type":"object","properties":{"batteryManufacturer":{"type":"string","description":"Battery manufacturer code (e.g., \"ENPHASE\", \"TESLA\").\nMust match the manufacturer from the selected TPO offer."},"batteryModel":{"type":"string","description":"Battery model code (e.g., \"IQBATTERY_5P-1P-NA-DOM_542528\", \"Powerwall2\").\nRequired for precise pricing calculations via Catalog Service."}},"required":["batteryManufacturer","batteryModel"]},"SUBMISSION_BatteryLeasePricingProject":{"type":"object","properties":{"cost":{"description":"Total installation cost of battery equipment (equipment, installation, additional costs).\nSent to Catalog Service for lease pricing calculations.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_CurrencyMeasurement"}]},"systemDesign":{"description":"Battery system information with manufacturer and model codes.\nStored in Project Info Service and used by Catalog Service for pricing.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_BatteryLeasePricingSystemDesign"}]}},"required":["cost","systemDesign"]},"SUBMISSION_AddBatteryLeasePricingInput":{"type":"object","properties":{"project":{"description":"Project details including cost and battery system design.\nUsed by Catalog Service to calculate lease pricing.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_BatteryLeasePricingProject"}]},"offerId":{"type":"string","description":"The unique identifier of the finance offer."},"projectId":{"type":"string","description":"The project identifier associated with this pricing calculation."},"projectDescriptionId":{"type":"string","description":"The project description identifier containing detailed system design specifications."}},"required":["project","offerId","projectId","projectDescriptionId"]},"SUBMISSION_EstimatedMonthlyPaymentRangeDto":{"type":"object","properties":{"minimum":{"type":"number","description":"Minimum estimated monthly payment across equipment configurations.","example":187.5},"maximum":{"type":"number","description":"Maximum estimated monthly payment across equipment configurations.","example":312.8}},"required":["minimum","maximum"]},"SUBMISSION_ProductionAndPaymentsScheduleSummaryDto":{"type":"object","properties":{"totalEstimatedProductionForGuarantee":{"type":"number","description":"Total estimated production for guarantee calculations in kWh (Solar TPO only).","example":235559.5},"totalGuaranteedProduction":{"type":"number","description":"Total guaranteed production promised to customer in kWh (Solar TPO only).\nTypically, 85% of estimated; customer compensated if actual falls below.","example":200226},"totalEstimatedProductionForPayment":{"type":"number","description":"Total estimated production for payment calculations in kWh (Solar TPO only).\nUsed to calculate expected payments (production × kWh rate).","example":250000},"totalPayments":{"type":"number","description":"Total of all payments over the contract term.","example":54617.15}},"required":["totalPayments"]},"SUBMISSION_ProductionAndPaymentsScheduleItemDto":{"type":"object","properties":{"period":{"type":"number","description":"Period number in the schedule (1 = first year, 2 = second year, etc.).","example":1},"periodType":{"type":"string","description":"Type of period.","example":"Year"},"date":{"format":"date-time","type":"string","description":"Start date of this period for payment due dates and production guarantees.","example":"2024-01-15T00:00:00.000Z"},"estimatedProductionForGuarantee":{"type":"number","description":"Estimated production for guarantee calculations in kWh (Solar TPO only).","example":14500},"guaranteedProduction":{"type":"number","description":"Guaranteed minimum production in kWh (Solar TPO only).","example":13000},"estimatedProductionForPayment":{"type":"number","description":"Estimated production for payment calculations in kWh (Solar TPO only).","example":15000},"kWhRate":{"type":"number","description":"Rate per kilowatt-hour in $/kWh for this period (Solar TPO only).","example":0.12},"prepayment":{"type":"number","description":"Amount to prepay entire remaining balance.\nAbsent when prepayment is excluded via the `paymentOptions` parameter (e.g., HVAC Lease).","example":25000},"annualPayment":{"type":"number","description":"Total payment for this period on annual basis.","example":1800},"monthlyPayment":{"type":"number","description":"Average monthly payment during this period.","example":150},"buyout":{"type":"number","description":"Early termination buyout price to own or remove equipment.\nAbsent when buyout is suppressed via `buyoutSuppression` or excluded via the `paymentOptions` parameter.","example":22000}},"required":["period","periodType","date","annualPayment","monthlyPayment"]},"SUBMISSION_ProductionAndPaymentsScheduleDto":{"type":"object","properties":{"summary":{"description":"Aggregate totals for the entire contract term.\nContains total payments and production metrics (Solar only).","allOf":[{"$ref":"#/components/schemas/SUBMISSION_ProductionAndPaymentsScheduleSummaryDto"}]},"schedule":{"description":"Array of schedule items, one per period (typically one per year).\nOrdered chronologically; typically 25 items for 25-year Solar contract or 15 items for 15-year Equipment Lease.","type":"array","items":{"$ref":"#/components/schemas/SUBMISSION_ProductionAndPaymentsScheduleItemDto"}},"monthlySchedule":{"description":"Monthly breakdown of payments (Equipment Lease only).\nTypically, 12 items per year × term years. Provides month-by-month payment amounts.","type":"array","items":{"$ref":"#/components/schemas/SUBMISSION_ProductionAndPaymentsScheduleItemDto"}}},"required":["summary","schedule"]},"SUBMISSION_PricingInputMetaDto":{"type":"object","properties":{"offerId":{"type":"string","description":"TPO offer ID from Catalog Service defining product type, pricing formulas, and terms.","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"},"projectId":{"type":"string","description":"Project ID linking to system design and installation details in Project Info Service.","example":"b2c3d4e5-f6a7-8901-bcde-f12345678901"},"projectDescriptionId":{"type":"string","description":"Project description version ID tracking which design iteration was used for pricing.","example":"c3d4e5f6-a7b8-9012-cdef-123456789012"},"domesticContent":{"type":"boolean","nullable":true,"description":"Whether project meets 40%+ domestic US-manufactured content for ITC tax credit (Solar TPO only).","example":true},"nonDomesticContentAdjustment":{"type":"number","description":"Dollar per watt penalty when domestic content not achieved (Solar TPO only).","example":0.15},"systemSize":{"type":"number","description":"Solar system size in kilowatts (Solar TPO only).\nUsed by Catalog Service to calculate dollarPerWatt and purchasePrice.","example":10.5},"firstYearEstimatedProduction":{"type":"number","description":"Estimated first-year electricity production in kWh (Solar TPO only).\nFrom solar design tool; used by Calculator for production schedule.","example":15000},"kWhRate":{"type":"number","description":"Rate per kilowatt-hour in $/kWh, customer pays this per kWh produced (Solar TPO only).","example":0.12},"escalatorRatePercent":{"type":"number","description":"Annual payment escalation rate as percentage (e.g., 0.99 = 0.99% yearly increase).","example":0.99},"term":{"description":"Contract duration in years and months from Catalog offer.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_TermDto"}]},"acManufacturer":{"type":"string","description":"HVAC equipment manufacturer name (HVAC Lease only).\nMay affect pricing adjustments in Catalog Service.","example":"Carrier"},"acModel":{"type":"string","description":"HVAC equipment model code sent to Catalog Service for pricing calculation (HVAC Lease only).\nPresence affects calculation precision - may result in complete vs. estimated pricing.","example":"ABC123"},"batteryManufacturer":{"type":"string","description":"Battery equipment manufacturer code (Battery Lease only).\nMay affect pricing adjustments in Catalog Service.","example":"Tesla"},"batteryModel":{"type":"string","description":"Battery equipment model code sent to Catalog Service for pricing calculation (Battery Lease only).","example":"Powerwall2"},"targetDate":{"type":"string","description":"ISO 8601 timestamp determining which offer version and pricing rules to use from Catalog.\nDefaults to application.createdAt if not explicitly provided."},"organizationId":{"type":"string","description":"Organization ID used by Catalog Service for org-specific pricing rules.\nDefaults to application.organizationId if not explicitly provided."},"discountRate":{"type":"number","description":"Discount rate used for NPV calculations in payment schedules.\nRetrieved from system configuration based on product category.","example":"0.05 (meaning 5%)"},"monthlyPaymentBuyoutReduction":{"type":"number","description":"Monthly payment reduction applied to buyout calculations (Equipment Lease: HVAC Lease and Battery Lease).\nRetrieved from system configuration based on product category.","example":"29 (meaning a $29/month fee)"},"buyoutSuppressionMonths":{"type":"number","description":"Number of initial months where buyout is suppressed (Equipment Lease: HVAC Lease and Battery Lease).\nRetrieved from system configuration based on product category.","example":"60 (meaning buyout is suppressed for the first 5 years)"},"paymentOptions":{"type":"array","description":"Payment types included in the Calculator lease schedule response (Equipment Lease: HVAC Lease and Battery Lease).\nRetrieved from system configuration based on product category.","example":"[\"Buyout\"] (HVAC Lease — buyout only, no prepayment)","items":{"type":"string","enum":["Buyout","Prepayment"]}}},"required":["offerId","projectId","projectDescriptionId","escalatorRatePercent","term"]},"SUBMISSION_PriceAdjustmentDto":{"type":"object","properties":{"description":{"type":"string","description":"Human-readable description of the adjustment.","example":"Extended Service Agreement, Organization Tier Discount"},"source":{"type":"string","description":"Source of the adjustment.","example":"Manufacturer | Tier | Model"},"direction":{"type":"string","description":"Direction of the adjustment (Up = adds cost, Down = discount).","example":"Up | Down"},"type":{"type":"string","description":"Specific type of adjustment.\nCatalog service uses various types (EquipmentRebate, TierDiscount, CloudServiceFee, etc.).","example":"EquipmentRebate | TierDiscount | ExtendedWarranty"},"amountValue":{"type":"number","description":"Dollar amount of the adjustment (always positive)."}},"required":["description","source","direction","type","amountValue"]},"SUBMISSION_PricingStepDto":{"type":"object","properties":{"input":{"type":"number","description":"Starting dollar amount."},"adjustments":{"description":"Adjustments applied during this step.","type":"array","items":{"$ref":"#/components/schemas/SUBMISSION_PriceAdjustmentDto"}},"output":{"type":"number","description":"Final dollar amount after adjustments."}},"required":["input","adjustments","output"]},"SUBMISSION_PricingDto":{"type":"object","properties":{"financeAccountId":{"type":"string","description":"The human-readable finance account ID this pricing is associated with."},"current":{"type":"boolean","description":"Indicates whether this pricing is the current one for the finance account.\nOnly one pricing per finance account can be current at any time.","example":true},"activeAgreement":{"type":"boolean","description":"Indicates whether this pricing corresponds to an active signed customer agreement.\nDistinguishes preliminary pricing from agreement-backed pricing.","example":false},"discountRate":{"type":"number","description":"Discount rate for present value calculations (decimal format, e.g., 0.05 = 5%).","example":0.05},"kWhRate":{"type":"number","description":"Rate per kilowatt-hour in $/kWh (Solar TPO only).\nCustomer pays this rate for each kWh of electricity produced by the solar system.","example":0.12},"dollarPerWatt":{"type":"number","description":"System cost in dollars per watt (Solar TPO only).\nThis field will only be present in the response if the context requesting the pricing\nhas the `sub_view_purchase_and_dollar_per_watt_price` permission.","example":2.85},"purchasePrice":{"type":"number","description":"Total financed amount for the solar system (Solar TPO only).\nFor example, a 10kW system at $2.85/watt would have a purchase price of $28,500.\nThis field will only be present in the response if the context requesting the pricing\nhas the `sub_view_purchase_and_dollar_per_watt_price` permission.","example":28500},"estimatedFirstYearMonthlyPayment":{"type":"number","description":"Estimated monthly payment in the first year before escalation.\nAlways present for Solar TPO.\nFor Equipment Lease (HVAC and Battery): present only for complete pricing (SINGLE calculation type).","example":150.25},"estimatedFirstYearMonthlyPaymentRange":{"description":"Range of estimated monthly payments for the first year (Equipment Lease partial pricing only).\nPresent when Catalog returns MINIMUM/MAXIMUM calculation types.\nRepresents the payment range across different equipment configurations.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_EstimatedMonthlyPaymentRangeDto"}]},"productionAndPaymentsSchedule":{"description":"The production and payments schedule associated with this pricing.\nAlways present for Solar TPO (with production metrics).\nFor Equipment Lease (HVAC and Battery): present only for complete pricing (requires Calculator service call).\nNot present for partial Equipment Lease pricing (no payment schedule generation).","allOf":[{"$ref":"#/components/schemas/SUBMISSION_ProductionAndPaymentsScheduleDto"}]},"inputMeta":{"description":"The input values used to generate this pricing.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_PricingInputMetaDto"}]},"projectCost":{"type":"number","description":"Total project cost in dollars before adjustments (Equipment Lease only).\nStarting amount for lease calculation.","example":15000},"projectCostAppliedFor":{"type":"number","description":"The original project cost that was applied for (not applicable to Solar_TPO).\nPreserved when pricing is recalculated due to max loan amount adjustment.","example":15000},"projectCostMaximumApprovedFor":{"type":"number","description":"The maximum project cost underwriting approved (not applicable to Solar_TPO).\nOnly present when underwriting approves a lower amount than originally applied for.","example":12750},"subtotal":{"type":"number","description":"Subtotal after step up adjustments in dollars (Equipment Lease only).\nProject cost plus any upward adjustments (warranties, service plans, etc.).","example":16500},"netCost":{"type":"number","description":"Net cost after all adjustments in dollars (Equipment Lease only).\nResult of stepUp and stepDown calculations. Used to calculate monthly payment.","example":15750},"purchaseCost":{"type":"number","description":"End-of-lease purchase/buyout cost in dollars (Equipment Lease only).\nAmount customer pays to own the equipment at lease end.","example":1500},"calculationTypes":{"description":"Type(s) of pricing calculation result (Equipment Lease only).\nComplete pricing: [\"SINGLE\"] - specific model pricing.\nPartial pricing: [\"MINIMUM\", \"MAXIMUM\"] - range across models.","example":["SINGLE"],"type":"array","items":{"type":"string","enum":["SINGLE","MINIMUM","MAXIMUM"]}},"stepUp":{"description":"Step showing upward price adjustments (Equipment Lease only).\nIncludes warranties, extended service agreements, and other add-ons that increase cost.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_PricingStepDto"}]},"stepDown":{"description":"Step showing downward price adjustments (Equipment Lease only).\nIncludes discounts, rebates, and tier benefits that decrease cost.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_PricingStepDto"}]},"tenantId":{"type":"string","description":"The unique identifier of the tenant."},"createdAt":{"format":"date-time","type":"string","description":"The date and time the entity was created."},"createdBy":{"type":"string","description":"The unique identifier of the user who created the entity."},"updatedAt":{"format":"date-time","type":"string","description":"The date and time the entity was last updated."},"updatedBy":{"type":"string","description":"The unique identifier of the user who last updated the entity."},"removedAt":{"format":"date-time","type":"string","description":"The date and time the entity was marked as removed."},"removedBy":{"type":"string","description":"The unique identifier of the user who removed the entity."},"id":{"type":"string","description":"The unique identifier of the entity."}},"required":["financeAccountId","current","activeAgreement","discountRate","inputMeta","tenantId","createdAt","createdBy","id"]},"SUBMISSION_CreditLineDto":{"type":"object","properties":{"verified":{"type":"number","description":"The verified credit line after underwriting.\nPopulated after the income/CFA case resolves."},"adjusted":{"type":"number","description":"Borrower-requested reduction below the UW ceiling. Sticky — never auto-cleared by offer or\nunderwriting changes; only updated when the borrower explicitly submits a CREDIT_LINE change."},"max":{"type":"number","description":"The maximum credit line sourced from the offer's `maxAmount`. Updated on offer changes."},"effective":{"type":"number","description":"The effective credit line — the smallest of max, verified (if set), and adjusted (if set).\nThe single value downstream consumers should read."}},"required":["max","effective"]},"SUBMISSION_RateDto":{"type":"object","properties":{"minimum":{"type":"number","description":"The minimum rate."},"maximum":{"type":"number","description":"The maximum rate."}},"required":["minimum","maximum"]},"SUBMISSION_RateRangeDto":{"type":"object","properties":{"withAutopay":{"type":"number","description":"The rate when enrolled in autopay."},"withoutAutopay":{"type":"number","description":"The rate when not enrolled in autopay."}},"required":["withAutopay","withoutAutopay"]},"SUBMISSION_MarginsDto":{"type":"object","properties":{"installment":{"type":"number","description":"The margin rate applied to the installment portion of the loan."},"revolving":{"type":"number","description":"The margin rate applied to the revolving portion of the loan."}},"required":["installment","revolving"]},"SUBMISSION_DealerFeeDto":{"type":"object","properties":{"percent":{"type":"number","description":"The dealer fee expressed as a percentage of project cost (e.g. 5 for 5%)."}},"required":["percent"]},"SUBMISSION_HelocPricingInputMetaDto":{"type":"object","properties":{"offerId":{"type":"string","description":"The offer ID of the HELOC."},"term":{"description":"The term of the HELOC.\nOnly returned to internal and homeowner users; hidden from external contractors.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_TermDto"}]},"rate":{"description":"The rate of the HELOC.\nOnly returned to internal and homeowner users; hidden from external contractors.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_RateDto"}]},"autopayRate":{"description":"The autopay rate of the HELOC.\nOnly returned to internal and homeowner users; hidden from external contractors.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_RateDto"}]},"installmentRate":{"description":"The installment rate of the HELOC, with and without autopay.\nOnly returned to internal and homeowner users; hidden from external contractors.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_RateRangeDto"}]},"revolvingRate":{"description":"The revolving rate of the HELOC, with and without autopay.\nOnly returned to internal and homeowner users; hidden from external contractors.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_RateRangeDto"}]},"targetDate":{"format":"date-time","type":"string","description":"The target date of the HELOC."},"margins":{"description":"The per-product margin rates of the HELOC offer, when supplied by underwriting.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_MarginsDto"}]},"dealerFee":{"description":"The dealer fee for the HELOC offer, when supplied by underwriting.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_DealerFeeDto"}]}},"required":["offerId","targetDate"]},"SUBMISSION_HelocPricingDto":{"type":"object","properties":{"financeAccountId":{"type":"string","description":"The human-readable finance account ID this pricing is associated with."},"current":{"type":"boolean","description":"Indicates whether this pricing is the current one for the finance account.\nOnly one pricing can be current=true;"},"creditLine":{"description":"The credit line of the HELOC.\nOnly returned to internal and homeowner users; hidden from external contractors.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_CreditLineDto"}]},"estimatedMonthlyPayment":{"type":"number","nullable":true,"description":"The estimated monthly payment of the HELOC. Null for D2C (homeowner-initiated) HELOC finance accounts, which have no associated project cost.\nOnly returned to internal and homeowner users; hidden from external contractors."},"inputMeta":{"description":"The input meta of the HELOC.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_HelocPricingInputMetaDto"}]},"projectCost":{"type":"number","nullable":true,"description":"The project cost of the HELOC. Null for D2C (homeowner-initiated) HELOC finance accounts, which have no associated project cost."},"projectCostMaximumApprovedFor":{"type":"number","description":"The project cost maximum approved for the HELOC."},"projectCostAppliedFor":{"type":"number","description":"The project cost applied for the HELOC."},"reserveLimit":{"type":"number","nullable":true,"description":"The reserve limit of the HELOC. Null for D2C (homeowner-initiated) HELOC finance accounts, which have no associated project cost."},"projectReserveLimit":{"type":"number","nullable":true,"description":"The total project reserve envelope (projectCost + reserveLimit) at the time this pricing was created. Null for D2C (homeowner-initiated) HELOC finance accounts, which have no associated project cost."},"autopayEnrolled":{"type":"boolean","description":"Whether the borrower is enrolled in autopay for this pricing record.\nOnly returned to internal and homeowner users; hidden from external contractors."},"tenantId":{"type":"string","description":"The unique identifier of the tenant."},"createdAt":{"format":"date-time","type":"string","description":"The date and time the entity was created."},"createdBy":{"type":"string","description":"The unique identifier of the user who created the entity."},"updatedAt":{"format":"date-time","type":"string","description":"The date and time the entity was last updated."},"updatedBy":{"type":"string","description":"The unique identifier of the user who last updated the entity."},"removedAt":{"format":"date-time","type":"string","description":"The date and time the entity was marked as removed."},"removedBy":{"type":"string","description":"The unique identifier of the user who removed the entity."},"id":{"type":"string","description":"The unique identifier of the entity."}},"required":["financeAccountId","current","inputMeta","projectCost","reserveLimit","projectReserveLimit","tenantId","createdAt","createdBy","id"]},"SUBMISSION_UpdateReferenceNumberInput":{"type":"object","properties":{"referenceNumber":{"type":"string","description":"A custom reference number external parties use to link the application back to their systems.\nIf the organization requires a reference number, this field is required and should not consist of whitespaces."}}},"SUBMISSION_UpdateSubjectPropertyInput":{"type":"object","properties":{"address":{"description":"The address of the property where the project is being done","allOf":[{"$ref":"#/components/schemas/SUBMISSION_Address"}]},"coordinates":{"description":"The coordinates of the property where the project is being done","allOf":[{"$ref":"#/components/schemas/SUBMISSION_Coordinates"}]}},"required":["address"]},"SUBMISSION_UpdateSalesRepInput":{"type":"object","properties":{"salesRepId":{"type":"string","description":"The unique identifier of the new sales rep."},"workspaceId":{"type":"string","description":"The context identifier of the new sales rep."}},"required":["salesRepId","workspaceId"]},"SUBMISSION_UndoCancellationResult":{"type":"object","properties":{"financeAccountId":{"type":"string","description":"The finance account ID."},"success":{"type":"boolean","description":"Indicates whether the operation was successful."},"status":{"type":"string","description":"The updated status of the finance account (if successful).","enum":["APPROVED","APPROVED_WITH_STIPS","DECLINED","PENDING","CANCELED"]},"error":{"type":"string","description":"Error message if the operation failed."}},"required":["financeAccountId","success"]},"SUBMISSION_UndoCancellationOutput":{"type":"object","properties":{"message":{"type":"string","description":"Overall success message."},"results":{"description":"The results for each finance account.","type":"array","items":{"$ref":"#/components/schemas/SUBMISSION_UndoCancellationResult"}}},"required":["message","results"]},"SUBMISSION_UndoCancellationInput":{"type":"object","properties":{"financeAccountIds":{"description":"The list of finance account IDs to undo cancellation for.","type":"array","items":{"type":"string"}}},"required":["financeAccountIds"]},"SUBMISSION_SystemDesign":{"type":"object","properties":{}},"SUBMISSION_TpoApplicant":{"type":"object","properties":{"firstName":{"type":"string","description":"The applicant's first name."},"lastName":{"type":"string","description":"The applicant's last name."},"dateOfBirth":{"format":"date-time","type":"string","description":"The applicant's date of birth."},"personalIdentity":{"description":"The applicant's personal identity information.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_PersonalIdentity"}]},"homeOccupancy":{"type":"string","description":"Occupancy status of the applicant's property.","enum":["PRIMARY","SECONDARY","INVESTMENT","OTHER"]},"homeOwnership":{"type":"string","description":"Ownership status of the applicant's property.","enum":["NOT_OWNED","OWNED_WITH_MORTGAGE","OWNED_FREE_AND_CLEAR"]},"annualIncome":{"description":"Total annual income.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_CurrencyMeasurement"}]},"email":{"type":"string","description":"The applicant's email address."},"primaryPhoneNumber":{"description":"The applicant's primary phone number.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_Phone"}]},"secondaryPhoneNumber":{"nullable":true,"description":"The applicant's secondary phone number.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_Phone"}]},"spokenLanguage":{"type":"string","description":"The applicant's spoken language.","enum":["ENGLISH","SPANISH"]},"employmentStatus":{"type":"string","description":"The applicant's employment status.","enum":["EMPLOYED","RETIRED","NOT_EMPLOYED","OTHER"]},"citizenshipStatus":{"type":"string","description":"The applicant's citizenship status.","enum":["US_CITIZEN","LAWFUL_PERMANENT_RESIDENT_ALIEN","OTHER"]},"address":{"description":"The applicant's mailing address.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_Address"}]},"ssn":{"type":"string","description":"The applicant's social security number. Present for backwards compatibility. Use the `personalIdentity` property instead."},"electronicConsent":{"type":"boolean","description":"The applicant's consent to have their information stored and processed."}},"required":["firstName","lastName","dateOfBirth","personalIdentity","homeOccupancy","homeOwnership","annualIncome","email","primaryPhoneNumber","spokenLanguage","employmentStatus","citizenshipStatus","address","electronicConsent"]},"SUBMISSION_SystemPricingInfo":{"type":"object","properties":{"type":{"type":"string","description":"The pricing unit.","enum":["DOLLAR_PER_kWh","DOLLAR_PER_WATT"]},"value":{"type":"number","description":"The value of the pricing unit."}},"required":["type","value"]},"SUBMISSION_PricingMeasurement":{"type":"object","properties":{"unit":{"type":"string","description":"The unit of a pricing measurement.","enum":["DOLLAR_PER_kWh","DOLLAR_PER_WATT"]},"value":{"type":"number","description":"The value of a pricing measurement.","minimum":0},"label":{"type":"string","description":"The display name of the unit."}},"required":["unit","value"]},"SUBMISSION_CalculatedSystemPricingOutput":{"type":"object","properties":{"estimatedFirstYearMonthlyPayment":{"description":"An estimate of the first year monthly payment.\nAlways present for Solar TPO.\nFor HVAC Lease: present only for complete pricing (SINGLE), not partial (MINIMUM/MAXIMUM).","allOf":[{"$ref":"#/components/schemas/SUBMISSION_CurrencyMeasurement"}]},"projectCost":{"description":"Total project cost in dollars (not applicable to Solar_TPO).\nPresent in both complete and partial pricing.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_CurrencyMeasurement"}]},"projectCostAppliedFor":{"description":"The project cost that was originally applied for (not applicable to Solar_TPO).","allOf":[{"$ref":"#/components/schemas/SUBMISSION_CurrencyMeasurement"}]},"projectCostMaximumApprovedFor":{"description":"The maximum project cost underwriting approved the application for (not applicable to Solar_TPO).","allOf":[{"$ref":"#/components/schemas/SUBMISSION_CurrencyMeasurement"}]},"pricePerUnit":{"description":"The price per unit of the system (Solar only).","allOf":[{"$ref":"#/components/schemas/SUBMISSION_PricingMeasurement"}]},"purchasePrice":{"description":"The purchase price of the system (Solar only).","allOf":[{"$ref":"#/components/schemas/SUBMISSION_CurrencyMeasurement"}]},"powerPurchaseRate":{"description":"The power purchase rate (Solar only).","allOf":[{"$ref":"#/components/schemas/SUBMISSION_PricingMeasurement"}]}}},"SUBMISSION_TpoApplicationChange":{"type":"object","properties":{"code":{"type":"string","description":"The code of the change.","enum":["PROJECT_COST"]},"description":{"type":"string","description":"The description of the change."}},"required":["code","description"]},"SUBMISSION_CaseAttachment":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the attachment in UUID v4 format."},"extension":{"type":"string","description":"The extension of the attachment."},"type":{"type":"string","description":"The type of the attachment."},"name":{"type":"string","description":"The name of the attachment."},"label":{"type":"string","description":"A label for the attachment."},"groupId":{"type":"string","description":"Group identifier used to combine multiple uploads."},"status":{"type":"string","description":"The status of the attachment."}},"required":["id","extension","type","name","label","groupId","status"]},"SUBMISSION_DocumentToClear":{"type":"object","properties":{"type":{"type":"string","description":"The document type."},"name":{"type":"string","description":"The document name."},"description":{"type":"string","description":"A description of the document to clear."}},"required":["name","description"]},"SUBMISSION_ApplicationPendingCaseOutput":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the case in UUID v4 format."},"name":{"type":"string","description":"The name of the case."},"description":{"type":"string","description":"A description of the case."},"reasonCodes":{"description":"The key of the case.","type":"array","items":{"type":"string"}},"status":{"type":"string","description":"The status of the current step."},"type":{"type":"string","description":"The type of the case."},"attachments":{"description":"An array of attachments associated with the case.","type":"array","items":{"$ref":"#/components/schemas/SUBMISSION_CaseAttachment"}},"domain":{"type":"string","description":"The actor that has to act on the case."},"deferred":{"type":"boolean","description":"Whether this case blocks NTP."},"createdAt":{"format":"date-time","type":"string","description":"The date and time when the case was created."},"updatedAt":{"format":"date-time","type":"string","description":"The date and time when the case was last updated."},"updatedBy":{"type":"string","description":"The identity that last updated the case."},"appliesTo":{"type":"string","description":"The subject of the case."},"documentsToClear":{"description":"The documents to clear.","type":"array","items":{"$ref":"#/components/schemas/SUBMISSION_DocumentToClear"}}},"required":["id","name","description","reasonCodes","status","type","attachments","domain","deferred","createdAt","updatedAt","updatedBy","appliesTo","documentsToClear"]},"SUBMISSION_ReapplyAction":{"type":"object","properties":{"description":{"type":"string","description":"The description of the action."},"type":{"type":"string","description":"The type of action."}},"required":["description","type"]},"SUBMISSION_Reapply":{"type":"object","properties":{"encouraged":{"type":"boolean","description":"If true, reapplying is encouraged because there are actions the applicant can take to potentially change the decision when they reapply.\nIf false, reapplying is not encouraged for the applicant."},"actions":{"nullable":true,"description":"If `encouraged` is `true`, this will be an array of actions the applicant should take before reapplying.\nIf `encouraged` is `false`, this will be `null` because there are no actions to take.","type":"array","items":{"$ref":"#/components/schemas/SUBMISSION_ReapplyAction"}}},"required":["encouraged","actions"]},"SUBMISSION_DecisionExplanationReason":{"type":"object","properties":{"reasonCode":{"type":"string","description":"The non-user-friendly code for the reason."},"title":{"type":"string","description":"The title of the reason explanation."},"description":{"type":"string","description":"The description of the reason explanation."}},"required":["reasonCode","title","description"]},"SUBMISSION_DecisionExplanation":{"type":"object","properties":{"reapply":{"description":"Information about reapplying based on the decision.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_Reapply"}]},"reasons":{"description":"The list of reasons for the decision.","type":"array","items":{"$ref":"#/components/schemas/SUBMISSION_DecisionExplanationReason"}}}},"SUBMISSION_CreateTpoApplicationOutput":{"type":"object","properties":{"systemDesign":{"description":"Information about the system to be installed on the property where the project is being done.","oneOf":[{"$ref":"#/components/schemas/SUBMISSION_SolarTpoSystemDesign"},{"$ref":"#/components/schemas/SUBMISSION_HvacLeaseSystemDesign"},{"$ref":"#/components/schemas/SUBMISSION_BatteryLeaseSystemDesign"}],"allOf":[{"$ref":"#/components/schemas/SUBMISSION_SystemDesign"}]},"applicants":{"description":"The applicants.","type":"array","items":{"$ref":"#/components/schemas/SUBMISSION_TpoApplicant"}},"projectId":{"type":"string","description":"The unique identifier of the project in UUID v4 format."},"referenceNumber":{"type":"string","description":"A custom reference number external parties use to link the application back to their systems."},"systemPricingInfo":{"description":"Information about the pricing of the system to be installed on the property where the project is being done.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_SystemPricingInfo"}]},"calculatedSystemPricing":{"description":"The calculated system pricing.\nOptional for HVAC Lease when AC model is not provided during application creation.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_CalculatedSystemPricingOutput"}]},"changes":{"description":"Any changes to the application that were made as a result of the underwriting process.\nThe differences between what was applied for and what was approved for.","type":"array","items":{"$ref":"#/components/schemas/SUBMISSION_TpoApplicationChange"}},"id":{"type":"string","description":"The unique identifier of the application in UUID v4 format."},"accountId":{"type":"string","description":"The unique identifier of the newly created finance account in UUID v4 format."},"financeAccountId":{"type":"string","description":"The unique identifier of the newly created finance account in ##-##-###### format."},"createdAt":{"format":"date-time","type":"string","description":"The date and time when the application was created."},"expiresAt":{"format":"date-time","type":"string","description":"The date and time when the application will expire."},"financeType":{"description":"The type of finance project.","enum":["loan","lease","ppa","ppav","e-heloc"],"type":"string"},"offerId":{"type":"string","description":"The unique identifier of the offer which can then be used to fetch rate, term and other product-related data."},"categoryCode":{"description":"The code of the category for this project.","enum":["Solar_TPO","HVAC_LEASE","BATTERY_LEASE","HELOC"],"type":"string"},"categoryId":{"type":"string","description":"The unique identifier of the offer category."},"tags":{"description":"Optional user-defined tags to be added to the application.","type":"array","items":{"type":"string"}},"status":{"description":"The status of the application.","enum":["APPROVED","APPROVED_WITH_STIPS","DECLINED","PENDING","CANCELED"],"type":"string"},"reason":{"type":"string","description":"The reason the application was declined or approved with stips."},"type":{"description":"The decision type.","enum":["SINGLE","COMBINED","PRIMARY","SECONDARY"],"type":"string"},"cases":{"description":"An array of cases created for this application.","type":"array","items":{"$ref":"#/components/schemas/SUBMISSION_ApplicationPendingCaseOutput"}},"decisionExplanation":{"description":"The explanation of the underwriting decision reason.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_DecisionExplanation"}]},"borrowerActionableUrl":{"type":"string","description":"A URL the borrower can visit to take action on cases related to this application."}},"required":["systemDesign","applicants","projectId","changes","id","accountId","financeAccountId","createdAt","expiresAt","financeType","offerId","categoryCode","categoryId","status","type"]},"SUBMISSION_FirstYearProductionEstimate":{"type":"object","properties":{"value":{"type":"number","description":"The value of the first year production estimate.","minimum":2400,"maximum":50000},"unit":{"type":"string","description":"The unit of a production measurement or estimate.","enum":["kWh"]},"label":{"type":"string","description":"The display name of the unit."}},"required":["value","unit"]},"SUBMISSION_SystemSizeMeasurement":{"type":"object","properties":{"value":{"type":"number","description":"The value of the system size measurement.","minimum":3,"maximum":25},"unit":{"type":"string","description":"The unit of a size measurement.","enum":["kW"]},"label":{"type":"string","description":"The display name of the unit."}},"required":["value","unit"]},"SUBMISSION_SolarTpoSystemDesign":{"type":"object","properties":{"designTool":{"type":"string","description":"The design tool used to design the system.","enum":["Aerialytic","Artemis","Aurora","Lightfusion","Onedraw","Other","Solargraf","Solo","Subcontractorhub","Sunobi","Vision","Scanifly"]},"firstYearProduction":{"description":"The estimated first year production of the system.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_FirstYearProductionEstimate"}]},"systemSize":{"description":"The estimated size of the system.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_SystemSizeMeasurement"}]},"batteryCost":{"description":"The cost of a Battery","allOf":[{"$ref":"#/components/schemas/SUBMISSION_CurrencyMeasurement"}]}},"required":["designTool","firstYearProduction","systemSize"]},"SUBMISSION_ProductionMeasurement":{"type":"object","properties":{"unit":{"type":"string","description":"The unit of a production measurement or estimate.","enum":["kWh"]},"value":{"type":"number","description":"The value of a production measurement or estimate.","minimum":0,"maximum":50000},"label":{"type":"string","description":"The display name of the unit."}},"required":["unit","value"]},"SUBMISSION_UtilityOnly":{"type":"object","properties":{"utilityUsage":{"$ref":"#/components/schemas/SUBMISSION_ProductionMeasurement"},"utilityPayment":{"$ref":"#/components/schemas/SUBMISSION_CurrencyMeasurement"}},"required":["utilityUsage","utilityPayment"]},"SUBMISSION_SolarWithoutRate":{"type":"object","properties":{"utilityUsage":{"$ref":"#/components/schemas/SUBMISSION_ProductionMeasurement"},"solarUsage":{"$ref":"#/components/schemas/SUBMISSION_ProductionMeasurement"},"solarPayment":{"$ref":"#/components/schemas/SUBMISSION_CurrencyMeasurement"},"utilityPayment":{"$ref":"#/components/schemas/SUBMISSION_CurrencyMeasurement"}},"required":["utilityUsage","solarUsage","solarPayment","utilityPayment"]},"SUBMISSION_FirstYearSchedule":{"type":"object","properties":{"month":{"type":"number","description":"The month in which the savings schedule is estimated.","minimum":1,"maximum":12},"utilityOnly":{"description":"The usage and payment for the utility only schedule","allOf":[{"$ref":"#/components/schemas/SUBMISSION_UtilityOnly"}]},"utilityWithSolar":{"description":"The usage and payment for the utility with solar schedule","allOf":[{"$ref":"#/components/schemas/SUBMISSION_SolarWithoutRate"}]},"savings":{"description":"The savings for the month","allOf":[{"$ref":"#/components/schemas/SUBMISSION_CurrencyMeasurement"}]}},"required":["month","utilityOnly","utilityWithSolar","savings"]},"SUBMISSION_SolarRate":{"type":"object","properties":{"currency":{"type":"string","enum":["USD"]},"price":{"type":"number"},"unit":{"type":"string","enum":["kWh"]}},"required":["currency","price","unit"]},"SUBMISSION_UtilityWithSolar":{"type":"object","properties":{"solarUsage":{"$ref":"#/components/schemas/SUBMISSION_ProductionMeasurement"},"solarPayment":{"$ref":"#/components/schemas/SUBMISSION_CurrencyMeasurement"},"utilityUsage":{"$ref":"#/components/schemas/SUBMISSION_ProductionMeasurement"},"utilityPayment":{"$ref":"#/components/schemas/SUBMISSION_CurrencyMeasurement"},"solarRate":{"$ref":"#/components/schemas/SUBMISSION_SolarRate"}},"required":["solarUsage","solarPayment","utilityUsage","utilityPayment","solarRate"]},"SUBMISSION_FullTermSchedule":{"type":"object","properties":{"year":{"type":"number","description":"The year in which the savings schedule is estimated.","minimum":1},"utilityOnly":{"description":"The usage and payment for the utility only schedule","allOf":[{"$ref":"#/components/schemas/SUBMISSION_UtilityOnly"}]},"utilityWithSolar":{"description":"The usage and payment for the utility with solar schedule","allOf":[{"$ref":"#/components/schemas/SUBMISSION_UtilityWithSolar"}]},"savings":{"description":"The savings for the year","allOf":[{"$ref":"#/components/schemas/SUBMISSION_CurrencyMeasurement"}]}},"required":["year","utilityOnly","utilityWithSolar","savings"]},"SUBMISSION_ProjectSavingsSchedule":{"type":"object","properties":{"calculatorNames":{"type":"array","description":"The list of names of the calculators used to create the savings schedule","items":{"type":"string","enum":["SOLO","ENERFLO","SUBCONTRACTOR_HUB","SOLARGRAF","ARCADIA_SWITCH","VISION","ARTEMIS","ENERGY_PAL","PURE_ENERGY","SUNTRIA","PATTER_AI","PIPE","LIGHT_FUSION","AURORA"]}},"firstYearSchedule":{"description":"The month to month first year schedule","type":"array","items":{"$ref":"#/components/schemas/SUBMISSION_FirstYearSchedule"}},"fullTermSchedule":{"description":"The full term schedule","type":"array","items":{"$ref":"#/components/schemas/SUBMISSION_FullTermSchedule"}}},"required":["firstYearSchedule","fullTermSchedule"]},"SUBMISSION_SolarTpoProject":{"type":"object","properties":{"systemDesign":{"description":"Information about the system to be installed on the property where the project is being done.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_SolarTpoSystemDesign"}]},"systemPricingInfo":{"description":"Information about the pricing of the system to be installed on the property where the project is being done.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_SystemPricingInfo"}]},"savingsSchedule":{"description":"The savings schedule of the project.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_ProjectSavingsSchedule"}]}},"required":["systemDesign","systemPricingInfo","savingsSchedule"]},"SUBMISSION_HvacLeaseUnit":{"type":"object","properties":{"manufacturerCode":{"type":"string","description":"The standardized manufacturer code."},"modelCode":{"type":"string","description":"The standardized model code."},"count":{"type":"number","description":"The quantity of units of this type.","minimum":1}},"required":["manufacturerCode"]},"SUBMISSION_HvacLeaseComponent":{"type":"object","properties":{"type":{"type":"string","description":"The type of HVAC component.","enum":["AIR_CONDITIONER","HEAT_PUMP"]},"units":{"description":"The units for this component. Only exactly one unit per component is supported.","type":"array","items":{"$ref":"#/components/schemas/SUBMISSION_HvacLeaseUnit"}}},"required":["type","units"]},"SUBMISSION_HvacLeaseSystemDesign":{"type":"object","properties":{"components":{"description":"The components of the HVAC system.","type":"array","items":{"$ref":"#/components/schemas/SUBMISSION_HvacLeaseComponent"}}},"required":["components"]},"SUBMISSION_HvacLeaseProject":{"type":"object","properties":{"cost":{"description":"The total cost of the equipment being leased.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_CurrencyMeasurement"}]},"systemDesign":{"description":"Information about the HVAC system to be installed on the property.\nThe values provided are stored in Project Info Service and used to calculate pricing.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_HvacLeaseSystemDesign"}]}},"required":["cost","systemDesign"]},"SUBMISSION_BatteryLeaseUnit":{"type":"object","properties":{"manufacturerCode":{"type":"string","description":"The standardized manufacturer code."},"modelCode":{"type":"string","description":"The standardized model code."},"count":{"type":"number","description":"The quantity of battery units of this type.","minimum":1}},"required":["manufacturerCode","modelCode","count"]},"SUBMISSION_BatteryLeaseComponent":{"type":"object","properties":{"type":{"type":"string","description":"The type of battery component.","enum":["BATTERY"]},"units":{"description":"The battery units for this component.","type":"array","items":{"$ref":"#/components/schemas/SUBMISSION_BatteryLeaseUnit"}}},"required":["type","units"]},"SUBMISSION_BatteryLeaseSystemDesign":{"type":"object","properties":{"components":{"description":"The battery components of the system.","type":"array","items":{"$ref":"#/components/schemas/SUBMISSION_BatteryLeaseComponent"}}},"required":["components"]},"SUBMISSION_BatteryLeaseProject":{"type":"object","properties":{"cost":{"description":"The total cost of the battery equipment being leased.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_CurrencyMeasurement"}]},"systemDesign":{"description":"Information about the battery system to be installed on the property.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_BatteryLeaseSystemDesign"}]}},"required":["cost","systemDesign"]},"SUBMISSION_TpoProject":{"type":"object","properties":{}},"SUBMISSION_SubjectPropertyCreateInputDto":{"type":"object","properties":{"address":{"description":"The address of the property.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_Address"}]},"coordinates":{"description":"The coordinates of the property.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_Coordinates"}]},"isMobileOrManufacturedHome":{"type":"boolean","description":"Whether the property is a mobile or manufactured home."},"propertyType":{"type":"string","description":"The type of property.","enum":["Detached Single Family","Condo","Multi Family Dwelling","Low Density Multi Family Dwelling","Mobile","Other","Manufactured","Townhouse"]},"mortgageTotalBalances":{"description":"The total balances of the mortgage.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_CurrencyMeasurement"}]},"mortgageTotalPayments":{"description":"The total payments of the mortgage.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_CurrencyMeasurement"}]},"fips":{"type":"string","description":"The FIPS code of the property."},"situsCensusTract":{"type":"string","description":"The Situs Census Tract of the property."},"lienPosition":{"type":"number","description":"The position of the lien on the property."}},"required":["address"]},"SUBMISSION_PartyDto":{"type":"object","properties":{"entityId":{"type":"string","description":"The unique identifier of the entity associated with the party."},"hKey":{"type":"string","description":"The hierarchical key of the party. Required for all party types except:\n- {@link PartyType.SalesPerson|SalesPerson}"},"isDisabled":{"type":"boolean","description":"Indicates whether the party is disabled."},"isPrimary":{"type":"boolean","description":"Indicates whether the party is the primary party."},"name":{"type":"string","description":"The name of the party."},"type":{"type":"string","description":"The type of the party.","enum":["Corporate","Distributor","Integrator","Investor","Manufacturer","ReferralSource","Sales","SalesPerson","Service","Homeowner","Lender","CoApplicant"]},"workspaceId":{"type":"string","description":"The unique identifier of the workspace the party is operating under. Required for the {@link PartyType.SalesPerson|SalesPerson} party type."}},"required":["entityId","isDisabled","isPrimary","name","type"]},"SUBMISSION_CreateTpoApplicationInput":{"type":"object","properties":{"project":{"description":"Details about the project being applied for.\nCan be `SolarTpoProject`, `HvacLeaseProject`, or `BatteryLeaseProject`.\nThe `offer.category.code` (resolved from `input.offerId`) will determine the type of project that can be submitted.","oneOf":[{"$ref":"#/components/schemas/SUBMISSION_SolarTpoProject"},{"$ref":"#/components/schemas/SUBMISSION_HvacLeaseProject"},{"$ref":"#/components/schemas/SUBMISSION_BatteryLeaseProject"}],"allOf":[{"$ref":"#/components/schemas/SUBMISSION_TpoProject"}]},"applicant":{"description":"The primary applicant.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_TpoApplicant"}]},"coApplicant":{"description":"The secondary applicant.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_TpoApplicant"}]},"subjectProperty":{"description":"The property where the project is being done.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_SubjectPropertyCreateInputDto"}]},"offerId":{"type":"string","description":"The unique identifier of the offer which can then be used to fetch rate, term and other product-related data.\nThe `offer.category.code` is used as a discriminator for the `input.project` field."},"systemDesign":{"deprecated":true,"allOf":[{"$ref":"#/components/schemas/SUBMISSION_SolarTpoSystemDesign"}]},"systemPricingInfo":{"deprecated":true,"allOf":[{"$ref":"#/components/schemas/SUBMISSION_SystemPricingInfo"}]},"savingsSchedule":{"deprecated":true,"allOf":[{"$ref":"#/components/schemas/SUBMISSION_ProjectSavingsSchedule"}]},"disclosureToken":{"type":"string","description":"The signed token of the disclosures the applicant agreed to."},"agent":{"type":"string"},"applicantSignature":{"type":"string","description":"The signature of the applicant."},"referenceNumber":{"type":"string","description":"A custom reference number external parties use to link the application back to their systems."},"enrollments":{"type":"array","description":"A list of enrollments. Defaults to `[AUTOPAY]` when set to `null`.","items":{"type":"string","enum":["AUTOPAY","PAPERLESS_COMMUNICATIONS"]}},"tags":{"description":"Optional user-defined tags to be added to the application.","type":"array","items":{"type":"string"}},"parties":{"description":"A list of custom parties.","type":"array","items":{"$ref":"#/components/schemas/SUBMISSION_PartyDto"}}},"required":["project","applicant","subjectProperty","offerId","applicantSignature"]},"SUBMISSION_DisclosureSectionDto":{"type":"object","properties":{"text":{"type":"string","description":"The text to render in the section."},"componentName":{"type":"string","description":"The component name this disclosure applies to. Only available for disclosures of type `PROPOSAL`."},"boldText":{"type":"boolean","description":"Whether the text should be bold."},"sort":{"type":"number","description":"The sort order of the section."},"checkbox":{"type":"boolean","description":"Whether the section is a checkbox."},"signatureBox":{"type":"boolean","description":"Whether the section is a signature box."}},"required":["text","boldText","sort","checkbox","signatureBox"]},"SUBMISSION_DisclosureDto":{"type":"object","properties":{"application":{"type":"string","description":"The application that the disclosure is for."},"categoryCode":{"type":"string","description":"The category code this disclosure applies to."},"lenderId":{"type":"string","description":"The lender ID this disclosure applies to."},"current":{"type":"boolean","description":"Whether the disclosure is the current version."},"name":{"type":"string","description":"A name for the disclosure."},"type":{"description":"The type of the disclosure.","enum":["ELECTRONIC_CONSENT","FINANCIAL","PROPOSAL"],"type":"string"},"sections":{"description":"The sections of the disclosure.","type":"array","items":{"$ref":"#/components/schemas/SUBMISSION_DisclosureSectionDto"}},"version":{"type":"number","description":"The version of the disclosure."},"locale":{"description":"The locale of the disclosure.","enum":["en-US","es-US"],"type":"string"},"token":{"type":"string","description":"The token of the disclosure."},"tokenExpiresAt":{"format":"date-time","type":"string","description":"The expiration date of the token."},"createdAt":{"format":"date-time","type":"string","description":"The date and time the entity was created."},"createdBy":{"type":"string","description":"The unique identifier of the user who created the entity."},"updatedAt":{"format":"date-time","type":"string","description":"The date and time the entity was last updated."},"updatedBy":{"type":"string","description":"The unique identifier of the user who last updated the entity."},"removedAt":{"format":"date-time","type":"string","description":"The date and time the entity was marked as removed."},"removedBy":{"type":"string","description":"The unique identifier of the user who removed the entity."},"id":{"type":"string","description":"The unique identifier of the entity."}},"required":["application","categoryCode","lenderId","current","name","type","sections","version","locale","createdAt","createdBy","id"]},"SUBMISSION_CreateDisclosureInput":{"type":"object","properties":{"application":{"type":"string","description":"The application that the disclosure is for."},"categoryCode":{"type":"string","description":"The category code this disclosure applies to."},"lenderId":{"type":"string","description":"The lender ID this disclosure applies to. Defaults to the first party lender ID when not provided."},"name":{"type":"string","description":"A name for the disclosure."},"type":{"type":"string","description":"The type of the disclosure.","enum":["ELECTRONIC_CONSENT","FINANCIAL","PROPOSAL"]},"sections":{"description":"The sections of the disclosure.","type":"array","items":{"$ref":"#/components/schemas/SUBMISSION_DisclosureSectionDto"}},"version":{"type":"number","description":"An optional version number to override the default value of 1.\nIf a disclosure is being updated and no version is provided, the version will be incremented by 1."}},"required":["application","categoryCode","name","type","sections"]},"SUBMISSION_UpdateDisclosureInput":{"type":"object","properties":{"application":{"type":"string","description":"The application that the disclosure is for."},"categoryCode":{"type":"string","description":"The category code this disclosure applies to."},"lenderId":{"type":"string","description":"The lender ID this disclosure applies to. Defaults to the first party lender ID when not provided."},"name":{"type":"string","description":"A name for the disclosure."},"type":{"description":"The type of the disclosure.","enum":["ELECTRONIC_CONSENT","FINANCIAL","PROPOSAL"],"type":"string"},"sections":{"description":"The sections of the disclosure.","type":"array","items":{"$ref":"#/components/schemas/SUBMISSION_DisclosureSectionDto"}},"version":{"type":"number","description":"An optional version number to override the default value of 1.\nIf a disclosure is being updated and no version is provided, the version will be incremented by 1."},"id":{"type":"string","description":"The identifier of the disclosure to update."}},"required":["application","categoryCode","name","type","sections","id"]},"SUBMISSION_CalculateSavingsOutput":{"type":"object","properties":{"savings":{"type":"number","description":"The savings amount in USD."},"lookbackYearsEvaluated":{"type":"number","description":"The number of previous years that were evaluated."},"savingsRuleResult":{"type":"string","description":"The result of validating the calculated savings amount.","enum":["pass","fail"]}},"required":["savings","lookbackYearsEvaluated","savingsRuleResult"]},"SUBMISSION_CalculateSavingsInput":{"type":"object","properties":{"firstYearEstimatedProduction":{"type":"number","description":"The first year estimated production."},"systemSize":{"type":"number","description":"The system size.","minimum":0},"kWhRate":{"type":"number","description":"The kWh rate."},"offerId":{"type":"string","description":"The offer ID."},"batteryCost":{"type":"number","description":"The battery cost."},"financeAccountId":{"type":"string","description":"An optional finance account ID. When provided, the account creation date will be used to fetch offer information for a targeted date"},"savingsSchedule":{"description":"The savings schedule.","type":"array","items":{"$ref":"#/components/schemas/SUBMISSION_FullTermSchedule"}}},"required":["firstYearEstimatedProduction","systemSize","kWhRate","offerId","savingsSchedule"]},"SUBMISSION_CalculateKwhRateOutput":{"type":"object","properties":{"calculatedRate":{"description":"The calculated kWh rate.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_PricingMeasurement"}]},"maxAllowedRate":{"description":"The maximum allowed kWh rate.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_PricingMeasurement"}]},"minAllowedRate":{"description":"The minimum allowed kWh rate.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_PricingMeasurement"}]},"lookbackYearsEvaluated":{"type":"number","description":"The lookback years evaluated."},"batteryCostAdded":{"type":"boolean","description":"Whether the battery cost was added."}},"required":["calculatedRate","maxAllowedRate","minAllowedRate","lookbackYearsEvaluated","batteryCostAdded"]},"SUBMISSION_CalculateKwhRateInput":{"type":"object","properties":{"firstYearEstimatedProduction":{"type":"number","description":"The first year estimated production."},"systemSize":{"type":"number","description":"The system size.","minimum":0},"offerId":{"type":"string","description":"The offer ID."},"batteryCost":{"type":"number","description":"The battery cost."},"financeAccountId":{"type":"string","description":"An optional finance account ID. When provided, the account creation date will be used to fetch offer information for a targeted date"},"savingsSchedule":{"description":"The savings schedule.","type":"array","items":{"$ref":"#/components/schemas/SUBMISSION_FullTermSchedule"}}},"required":["firstYearEstimatedProduction","systemSize","offerId","savingsSchedule"]},"SUBMISSION_TimeMeasurement":{"type":"object","properties":{"unit":{"type":"string","description":"The unit of a time measurement.","enum":["SECOND","MINUTE","HOUR","DAY","WEEK","YEAR"]},"value":{"type":"number","description":"The value of a time measurement.","minimum":0},"label":{"type":"string","description":"The display name of the unit."}},"required":["unit","value"]},"SUBMISSION_OverrideDto":{"type":"object","properties":{"action":{"type":"string","description":"The system functionality to override.","enum":["DUPE_KEY_CHECKS"]},"affectedOrganizations":{"description":"The human-readable organization IDs for which the override will be applied, known as client ID on legacy APIs.","type":"array","items":{"type":"string"}},"affectedUsers":{"description":"The email addresses of the users for which the override will be applied.","type":"array","items":{"type":"string"}},"expiresIn":{"description":"The expiration time for the override.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_TimeMeasurement"}]},"expirationDate":{"format":"date-time","type":"string","description":"The calculated expiration date for the override."},"tenantId":{"type":"string","description":"The unique identifier of the tenant."},"createdAt":{"format":"date-time","type":"string","description":"The date and time the entity was created."},"createdBy":{"type":"string","description":"The unique identifier of the user who created the entity."},"updatedAt":{"format":"date-time","type":"string","description":"The date and time the entity was last updated."},"updatedBy":{"type":"string","description":"The unique identifier of the user who last updated the entity."},"removedAt":{"format":"date-time","type":"string","description":"The date and time the entity was marked as removed."},"removedBy":{"type":"string","description":"The unique identifier of the user who removed the entity."},"id":{"type":"string","description":"The unique identifier of the entity."}},"required":["action","expiresIn","expirationDate","tenantId","createdAt","createdBy","id"]},"SUBMISSION_CreateOverrideInput":{"type":"object","properties":{"action":{"type":"string","description":"The system functionality to override.","enum":["DUPE_KEY_CHECKS"]},"affectedOrganizations":{"description":"The human-readable organization IDs for which the override will be applied, known as client ID on legacy APIs.","type":"array","items":{"type":"string"}},"affectedUsers":{"description":"The email addresses of the users for which the override will be applied.","type":"array","items":{"type":"string"}},"expiresIn":{"description":"The expiration time for the override.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_TimeMeasurement"}]}},"required":["action","expiresIn"]},"SUBMISSION_SolarTpoSharedAppProjectOutputDto":{"type":"object","properties":{"categoryCode":{"description":"The category code discriminator for this project type.","enum":["Solar_TPO","HVAC_LEASE","BATTERY_LEASE","HELOC"],"type":"string"},"estimatedFirstYearMonthlyPayment":{"type":"number","description":"Represents the estimated first year monthly payment for the shared app."},"systemPricingInfo":{"description":"Represents the system pricing information for shared applications.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_SystemPricingInfo"}]},"systemDesign":{"description":"Information about the system to be installed on the property where the project is being done.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_SolarTpoSystemDesign"}]}},"required":["categoryCode","estimatedFirstYearMonthlyPayment","systemPricingInfo","systemDesign"]},"SUBMISSION_HvacLeaseSharedAppProjectOutputDto":{"type":"object","properties":{"categoryCode":{"description":"The category code discriminator for this project type.","enum":["Solar_TPO","HVAC_LEASE","BATTERY_LEASE","HELOC"],"type":"string"},"estimatedFirstYearMonthlyPayment":{"type":"number","description":"Represents the estimated first year monthly payment for the shared app."},"cost":{"description":"The total cost of the equipment being leased.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_CurrencyMeasurement"}]},"systemDesign":{"description":"Information about the HVAC system to be installed on the property.\nOptional field for HVAC Lease projects.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_HvacLeaseSystemDesign"}]}},"required":["categoryCode","estimatedFirstYearMonthlyPayment","cost"]},"SUBMISSION_BatteryLeaseSharedAppProjectOutputDto":{"type":"object","properties":{"categoryCode":{"description":"The category code discriminator for this project type.","enum":["Solar_TPO","HVAC_LEASE","BATTERY_LEASE","HELOC"],"type":"string"},"estimatedFirstYearMonthlyPayment":{"type":"number","description":"Represents the estimated first year monthly payment for the shared app."},"cost":{"description":"The total cost of the battery equipment being leased.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_CurrencyMeasurement"}]},"systemDesign":{"description":"Information about the battery system to be installed on the property.\nRequired field for Battery Lease projects.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_BatteryLeaseSystemDesign"}]}},"required":["categoryCode","estimatedFirstYearMonthlyPayment","cost","systemDesign"]},"SUBMISSION_SharedAppOrganizationDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the organization."},"name":{"type":"string","description":"The name of the organization."},"type":{"type":"string","description":"The type of the organization.","enum":["Corporate","Distributor","Integrator","Investor","Manufacturer","ReferralSource","Sales","SalesPerson","Service","Homeowner","Lender","CoApplicant"]}},"required":["id","name","type"]},"SUBMISSION_SharedAppSalesRepDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the sales representative."},"workspaceId":{"type":"string","description":"The workspace ID associated with the sales representative."},"email":{"type":"string","description":"The email address of the sales representative."},"phone":{"type":"string","description":"The phone number of the sales representative."},"name":{"type":"string","description":"The name of the sales representative."},"organizationId":{"type":"string","description":"The unique identifier of the organization the sales representative belongs to."}},"required":["id","workspaceId","email","name","organizationId"]},"SUBMISSION_SharedLinkedFinanceAccountDto":{"type":"object","properties":{"linkType":{"type":"string","description":"The type of the link.","enum":["USER_SUBMITTED","ASSUMPTION","ROOT_ACCOUNT","LOAN"]},"financeAccountId":{"type":"string","description":"The finance account ID."},"location":{"type":"string","description":"The location of the linked finance account.","enum":["INTEGRATION_API"]}},"required":["linkType","financeAccountId"]},"SUBMISSION_SharedAppApplicantDto":{"type":"object","properties":{"email":{"type":"string","description":"The applicant's email address."},"firstName":{"type":"string","description":"The applicant's first name."},"lastName":{"type":"string","description":"The applicant's last name."},"sendEmail":{"type":"boolean","description":"If true, the applicant will be sent an email inviting them to visit a `link` and complete the shared application form. Defaults to `true`."},"isPrimary":{"type":"boolean","description":"If true, the applicant is treated as the primary applicant.\nIf false, the applicant is treated as a co-applicant.\nThere is always exactly one primary applicant in an array of applicants."}},"required":["email","firstName","lastName","sendEmail","isPrimary"]},"SUBMISSION_SharedAppHistoryDto":{"type":"object","properties":{"sentAt":{"format":"date-time","type":"string","description":"The date and time when the shared app was sent."},"expiresAt":{"format":"date-time","type":"string","description":"The date and time when the shared app will expire."},"sentTo":{"type":"string","description":"The recipient to whom the data was sent."},"link":{"type":"string","description":"The link sent to the recipient."}},"required":["sentAt","expiresAt","sentTo","link"]},"SUBMISSION_SharedAppSubjectPropertyDto":{"type":"object","properties":{"coordinates":{"description":"The coordinates of the property.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_Coordinates"}]},"address":{"description":"The address of the property.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_Address"}]},"isMobileOrManufacturedHome":{"type":"boolean","description":"Whether the property is a mobile or manufactured home."},"propertyType":{"type":"string","description":"The type of property.","enum":["Detached Single Family","Condo","Multi Family Dwelling","Low Density Multi Family Dwelling","Mobile","Other","Manufactured","Townhouse"]},"mortgageTotalBalances":{"description":"The total balances of the mortgage.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_CurrencyMeasurement"}]},"mortgageTotalPayments":{"description":"The total payments of the mortgage.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_CurrencyMeasurement"}]}}},"SUBMISSION_SharedApplicationOutputDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the shared application."},"link":{"type":"string","description":"The URL that the applicant can visit to complete their application."},"type":{"description":"The type of the shared application.","enum":["TPO","TPO_ASSUMPTION","PREQUALIFICATION"],"type":"string"},"categoryCode":{"description":"The category code associated with the shared application.","enum":["Solar_TPO","HVAC_LEASE","BATTERY_LEASE","HELOC"],"type":"string"},"categoryId":{"type":"string","description":"The category ID associated with the shared application."},"expiresAt":{"format":"date-time","type":"string","description":"The date the shared application expires."},"sentAt":{"format":"date-time","type":"string","description":"The date the shared application was sent."},"offerId":{"type":"string","description":"The offer ID associated with the shared application."},"channel":{"type":"string","description":"A named set of offers (channel)."},"state":{"type":"string","description":"Two-character US state code."},"organizationId":{"type":"string","description":"The organization ID associated with the shared application."},"creditCheckOptOut":{"type":"boolean","description":"The credit check opt-out status."},"organizations":{"description":"The organizations associated with the shared application.","type":"array","items":{"$ref":"#/components/schemas/SUBMISSION_SharedAppOrganizationDto"}},"salesRep":{"description":"The sales rep associated with the shared application.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_SharedAppSalesRepDto"}]},"linkedFinanceAccounts":{"description":"Optional. The linked finance accounts.","type":"array","items":{"$ref":"#/components/schemas/SUBMISSION_SharedLinkedFinanceAccountDto"}},"status":{"description":"The status of the shared application.","enum":["PENDING","SUBMITTED"],"type":"string"},"applicants":{"description":"The applicants for the shared application.","type":"array","items":{"$ref":"#/components/schemas/SUBMISSION_SharedAppApplicantDto"}},"sentHistory":{"description":"Represents the history of sent items.\nEach entry in the history includes the date and time the item was sent,\nas well as the recipient's identifier.","type":"array","items":{"$ref":"#/components/schemas/SUBMISSION_SharedAppHistoryDto"}},"subjectProperty":{"description":"The subject property information associated with the shared application.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_SharedAppSubjectPropertyDto"}]}},"required":["id","link","type","categoryCode","categoryId","expiresAt","offerId","organizationId","organizations","salesRep","status","sentHistory"]},"SUBMISSION_SolarTpoSharedAppProjectInput":{"type":"object","properties":{"systemDesign":{"description":"Information about the system to be installed on the property where the project is being done.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_SolarTpoSystemDesign"}]},"systemPricingInfo":{"description":"Information about the pricing of the system to be installed on the property where the project is being done.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_SystemPricingInfo"}]},"savingsSchedule":{"description":"The savings schedule of the project.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_ProjectSavingsSchedule"}]}},"required":["systemDesign","systemPricingInfo","savingsSchedule"]},"SUBMISSION_HvacLeaseSharedAppProjectInput":{"type":"object","properties":{"cost":{"description":"The total cost of the equipment being leased.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_CurrencyMeasurement"}]},"systemDesign":{"description":"Information about the HVAC system to be installed on the property.\nThe values provided are stored in Project Info Service and used to calculate pricing.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_HvacLeaseSystemDesign"}]}},"required":["cost"]},"SUBMISSION_BatteryLeaseSharedAppProjectInput":{"type":"object","properties":{"cost":{"description":"The total cost of the battery equipment being leased.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_CurrencyMeasurement"}]},"systemDesign":{"description":"Information about the battery system to be installed on the property.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_BatteryLeaseSystemDesign"}]}},"required":["cost","systemDesign"]},"SUBMISSION_SharedAppProjectInput":{"type":"object","properties":{}},"SUBMISSION_SharedAppApplicantInputDto":{"type":"object","properties":{"email":{"type":"string","description":"The applicant's email address.","maxLength":500},"firstName":{"type":"string","description":"The applicant's first name.","maxLength":500},"lastName":{"type":"string","description":"The applicant's last name.","maxLength":500},"sendEmail":{"type":"boolean","description":"If true, the applicant will be sent an email inviting them to visit a `link` and complete the shared application form. Defaults to `true`.","default":true}},"required":["email","firstName","lastName"]},"SUBMISSION_SubjectPropertyOptional":{"type":"object","properties":{"address":{"description":"The address of the property.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_Address"}]},"coordinates":{"description":"The coordinates of the property.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_Coordinates"}]},"isMobileOrManufacturedHome":{"type":"boolean","description":"Whether the property is a mobile or manufactured home."},"propertyType":{"type":"string","description":"The type of property.","enum":["Detached Single Family","Condo","Multi Family Dwelling","Low Density Multi Family Dwelling","Mobile","Other","Manufactured","Townhouse"]},"mortgageTotalBalances":{"description":"The total balances of the mortgage.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_CurrencyMeasurement"}]},"mortgageTotalPayments":{"description":"The total payments of the mortgage.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_CurrencyMeasurement"}]},"fips":{"type":"string","description":"The FIPS code of the property."},"situsCensusTract":{"type":"string","description":"The Situs Census Tract of the property."},"lienPosition":{"type":"number","description":"The position of the lien on the property."}}},"SUBMISSION_CreateSharedApplicationInput":{"type":"object","properties":{"project":{"description":"Details about the project being applied for.\nCan be a {@link SolarTpoSharedAppProjectInput}, {@link HvacLeaseSharedAppProjectInput}, or {@link BatteryLeaseSharedAppProjectInput}.\nThe `offer.category.code` (resolved from `input.offerId`) will determine the type of project that can be submitted.","oneOf":[{"$ref":"#/components/schemas/SUBMISSION_SolarTpoSharedAppProjectInput"},{"$ref":"#/components/schemas/SUBMISSION_HvacLeaseSharedAppProjectInput"},{"$ref":"#/components/schemas/SUBMISSION_BatteryLeaseSharedAppProjectInput"}],"allOf":[{"$ref":"#/components/schemas/SUBMISSION_SharedAppProjectInput"}]},"applicant":{"description":"The primary applicant. Optional to support \"Start Now\" functionality where\nshared applications can be created without immediately sending to an applicant.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_SharedAppApplicantInputDto"}]},"offerId":{"type":"string","description":"The unique identifier of the offer which can then be used to fetch rate, term and other product-related data."},"savingsSchedule":{"deprecated":true,"allOf":[{"$ref":"#/components/schemas/SUBMISSION_ProjectSavingsSchedule"}]},"systemDesign":{"deprecated":true,"allOf":[{"$ref":"#/components/schemas/SUBMISSION_SolarTpoSystemDesign"}]},"systemPricingInfo":{"deprecated":true,"allOf":[{"$ref":"#/components/schemas/SUBMISSION_SystemPricingInfo"}]},"tags":{"description":"Optional user-defined tags to be added to the application.","type":"array","items":{"type":"string"}},"channel":{"type":"string","description":"A named set of offers (channel).","maxLength":500},"state":{"type":"string","description":"Two-character US state code.","maxLength":2,"pattern":"/^[A-Z]{2}$/"},"parties":{"description":"A list of custom parties.","type":"array","items":{"$ref":"#/components/schemas/SUBMISSION_PartyDto"}},"subjectProperty":{"description":"The property where the project is being done.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_SubjectPropertyOptional"}]},"referenceNumber":{"type":"string","description":"A custom reference number external parties use to link the application back to their systems.\nRequired for some organizations.","maxLength":500},"enrollments":{"type":"array","description":"A list of enrollments. Defaults to `[AUTOPAY]` when set to `null`.","items":{"type":"string","enum":["AUTOPAY","PAPERLESS_COMMUNICATIONS"]}}},"required":["project","offerId"]},"SUBMISSION_CreateAssumptionApplicationInput":{"type":"object","properties":{"applicant":{"description":"The primary applicant.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_SharedAppApplicantInputDto"}]},"financeAccountId":{"type":"string","description":"The unique identifier of the finance account."},"creditOptOutWaiverPaid":{"type":"boolean","description":"Whether the buyer paid the credit check waiver fee."}},"required":["applicant","financeAccountId","creditOptOutWaiverPaid"]},"SUBMISSION_SharedAppProjectDto":{"type":"object","properties":{"categoryCode":{"description":"The category code discriminator for this project type.","enum":["Solar_TPO","HVAC_LEASE","BATTERY_LEASE","HELOC"],"type":"string"},"estimatedFirstYearMonthlyPayment":{"type":"number","description":"Represents the estimated first year monthly payment for the shared app."}},"required":["categoryCode","estimatedFirstYearMonthlyPayment"]},"SUBMISSION_SharedApplicationWithProjectInfoDto":{"type":"object","properties":{"projectInfo":{"oneOf":[{"$ref":"#/components/schemas/SUBMISSION_SolarTpoSharedAppProjectOutputDto"},{"$ref":"#/components/schemas/SUBMISSION_HvacLeaseSharedAppProjectOutputDto"},{"$ref":"#/components/schemas/SUBMISSION_BatteryLeaseSharedAppProjectOutputDto"}],"allOf":[{"$ref":"#/components/schemas/SUBMISSION_SharedAppProjectDto"}]},"id":{"type":"string","description":"The unique identifier for the shared application."},"link":{"type":"string","description":"The URL that the applicant can visit to complete their application."},"type":{"description":"The type of the shared application.","enum":["TPO","TPO_ASSUMPTION","PREQUALIFICATION"],"type":"string"},"categoryCode":{"description":"The category code associated with the shared application.","enum":["Solar_TPO","HVAC_LEASE","BATTERY_LEASE","HELOC"],"type":"string"},"categoryId":{"type":"string","description":"The category ID associated with the shared application."},"expiresAt":{"format":"date-time","type":"string","description":"The date the shared application expires."},"sentAt":{"format":"date-time","type":"string","description":"The date the shared application was sent."},"offerId":{"type":"string","description":"The offer ID associated with the shared application."},"channel":{"type":"string","description":"A named set of offers (channel)."},"state":{"type":"string","description":"Two-character US state code."},"organizationId":{"type":"string","description":"The organization ID associated with the shared application."},"creditCheckOptOut":{"type":"boolean","description":"The credit check opt-out status."},"organizations":{"description":"The organizations associated with the shared application.","type":"array","items":{"$ref":"#/components/schemas/SUBMISSION_SharedAppOrganizationDto"}},"salesRep":{"description":"The sales rep associated with the shared application.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_SharedAppSalesRepDto"}]},"linkedFinanceAccounts":{"description":"Optional. The linked finance accounts.","type":"array","items":{"$ref":"#/components/schemas/SUBMISSION_SharedLinkedFinanceAccountDto"}},"status":{"description":"The status of the shared application.","enum":["PENDING","SUBMITTED"],"type":"string"},"applicants":{"description":"The applicants for the shared application.","type":"array","items":{"$ref":"#/components/schemas/SUBMISSION_SharedAppApplicantDto"}},"sentHistory":{"description":"Represents the history of sent items.\nEach entry in the history includes the date and time the item was sent,\nas well as the recipient's identifier.","type":"array","items":{"$ref":"#/components/schemas/SUBMISSION_SharedAppHistoryDto"}},"subjectProperty":{"description":"The subject property information associated with the shared application.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_SharedAppSubjectPropertyDto"}]}},"required":["id","link","type","categoryCode","categoryId","expiresAt","offerId","organizationId","organizations","salesRep","status","sentHistory"]},"SUBMISSION_Salesforce":{"type":"object","properties":{"accountId":{"type":"string","description":"The unique identifier of the organization in Salesforce."}},"required":["accountId"]},"SUBMISSION_LegacyAddress":{"type":"object","properties":{"street":{"type":"string","description":"The street address."},"street2":{"type":"string","description":"Additional details such as apartment or unit number, suite, floor, building, etc."}},"required":["street"]},"SUBMISSION_VitalInfo":{"type":"object","properties":{"name":{"type":"string","description":"The name of the organization."},"website":{"type":"string","description":"The website of the organization."},"address":{"description":"The address of the organization.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_LegacyAddress"}]},"phone":{"type":"string","description":"The phone number of the organization."},"email":{"type":"string","description":"The email address of the organization."}},"required":["name","website","address","phone","email"]},"SUBMISSION_OrganizationDto":{"type":"object","properties":{"salesforce":{"description":"The identity of the organization in Salesforce.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_Salesforce"}]},"id":{"type":"string","description":"The human-readable ID of the organization, known as the client ID."},"installationCategories":{"description":"A list of categories supported by the organization.","type":"array","items":{"type":"string"}},"vitalInfo":{"description":"The general information of the organization.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_VitalInfo"}]},"type":{"type":"string","description":"The type of the organization.","enum":["Service"]}},"required":["salesforce","id","installationCategories","vitalInfo","type"]},"SUBMISSION_TermRemainingDto":{"type":"object","properties":{"months":{"type":"number","description":"The remaining term expressed in months."},"years":{"type":"number","description":"The remaining term expressed in years."}},"required":["months","years"]},"SUBMISSION_FirstYearPricingDto":{"type":"object","properties":{"kWhRate":{"type":"number","description":"The current KWhRate for the assumed finance account."},"monthlyPayment":{"type":"number","description":"The current calculated monthly payment for the assumed finance account."},"outstandingTerm":{"description":"The outstanding term of the finance account in remaining years and months.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_TermRemainingDto"}]}},"required":["kWhRate","monthlyPayment","outstandingTerm"]},"SUBMISSION_SharedApplicationDecoratedDto":{"type":"object","properties":{"offer":{"description":"The TPO offer associated with the shared application.\nCan be either a Solar TPO offer or an Equipment Lease offer.","oneOf":[{"$ref":"#/components/schemas/SUBMISSION_SolarTpoOfferDto"},{"$ref":"#/components/schemas/SUBMISSION_EquipmentLeaseOfferDto"}]},"sharedApplication":{"description":"The shared application.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_SharedApplicationWithProjectInfoDto"}]},"organization":{"description":"The organization that the application belongs to.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_OrganizationDto"}]},"firstYearPricing":{"description":"The first year pricing of the assumption shared application. Populated by the current pricing of the assumed finance account. This field is only available for shared applications created as part of the Assumptions flow.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_FirstYearPricingDto"}]},"salesRepVerificationStatus":{"type":"string","description":"The verification status of the sales representative who created the shared application.","enum":["UNVERIFIED","PENDING","VERIFIED","FAILED"]}},"required":["offer","sharedApplication","organization"]},"SUBMISSION_UpdateSharedAppApplicantInput":{"type":"object","properties":{"email":{"type":"string","description":"The applicant's email address.","maxLength":500},"sendEmail":{"type":"boolean","description":"If true, the applicant will be sent an email inviting them to visit a `link` and complete the shared application form. Defaults to `true`.","default":true}},"required":["email"]},"SUBMISSION_FicoReason":{"type":"object","properties":{"code":{"type":"string"},"description":{"type":"string"},"importance":{"type":"number"}},"required":["code","importance"]},"SUBMISSION_FIREngineAttributesDto":{"type":"object","properties":{"chosenFICOScore":{"type":"number"},"isSub650":{"type":"boolean"},"primaryStatedIncome":{"type":"number"},"primaryStatedDTI":{"type":"number"},"primaryModeledIncome":{"type":"number"},"primaryModeledDTI":{"type":"number"},"primaryEquifaxFICOScore":{"type":"number"},"primaryEquifaxReasonCodes":{"type":"array","items":{"type":"string"}},"primaryEquifaxFICOReasons":{"type":"array","items":{"$ref":"#/components/schemas/SUBMISSION_FicoReason"}},"primaryTransUnionFICOScore":{"type":"number"},"primaryTransUnionReasonCodes":{"type":"array","items":{"type":"string"}},"primaryTransUnionFICOReasons":{"type":"array","items":{"$ref":"#/components/schemas/SUBMISSION_FicoReason"}},"primaryExperianFICOScore":{"type":"number"},"primaryExperianReasonCodes":{"type":"array","items":{"type":"string"}},"primaryExperianFICOReasons":{"type":"array","items":{"$ref":"#/components/schemas/SUBMISSION_FicoReason"}},"primaryChosenFICOScore":{"type":"number"},"primaryChosenBureau":{"type":"string"},"primaryScheduledMonthlyPayments":{"type":"number"},"primaryOwnerOccupancyFlag":{"type":"boolean"},"primaryWorst_Rating_within_12_months_Mortgage_Trades":{"type":"number"},"primaryNumber_Open_Mortgage_Trades":{"type":"number"},"primaryTotal_Balance_Open_Mortgage_Trades_with_Update_within_6_months":{"type":"number"},"primaryNumber_Trades":{"type":"number"},"primaryNumber_90_Days_Past_Due_Occurrences_within_24_months":{"type":"number"},"primaryWorst_Rating_within_24_months_Mortgage_Trades":{"type":"number"},"primaryNumber_Trades_Worst_Rating_90_Days_Past_Due_within_12_months":{"type":"number"},"primaryAge_Oldest_Trade":{"type":"number"},"primaryForeclosure_Flag":{"type":"number"},"primaryAnyForeclosure":{"type":"boolean"},"primaryAnyHomeEquity":{"type":"boolean"},"primaryFullSsn":{"type":"string"},"primaryHasChapter7Bankruptcy":{"type":"boolean"},"primaryNinetyDay_Revolving_Lates_within_12_months":{"type":"number"},"primaryNinetyDay_Installment_Lates_within_12_months":{"type":"number"},"primaryTotalMortgagePayment":{"type":"number"},"primaryTotalMonthlyPaymentsOnCredit":{"type":"number"},"primaryPdaCreditNameMatch":{"type":"boolean"},"primaryLossMitigation48Months":{"type":"number"},"primaryIncomeDifference":{"type":"number"},"primaryForeclosure_within_48_months_Flag":{"type":"number"},"primaryBankruptcyEver":{"type":"number"},"primaryBankruptcy_Public_Record_within_48_months_Flag":{"type":"number"},"primaryLossMitigation":{"type":"boolean"},"primaryMonthsSinceBk":{"type":"number"},"primaryLossMitigationEver":{"type":"number"},"primaryTotalLienBalance":{"type":"number"},"primaryNumber_30_Days_Past_Due_Occurrences_within_12_months_Mortgage_Trades":{"type":"number"},"primaryVerifiedIncome":{"type":"string"},"primaryModeledSecondaryStatedDTI":{"type":"number"},"primaryStatedSecondaryModeledDTI":{"type":"number"},"secondaryStatedIncome":{"type":"number"},"secondaryStatedDTI":{"type":"number"},"secondaryModeledIncome":{"type":"number"},"secondaryModeledDTI":{"type":"number"},"secondaryEquifaxFICOScore":{"type":"number"},"secondaryEquifaxReasonCodes":{"type":"array","items":{"type":"string"}},"secondaryEquifaxFICOReasons":{"type":"array","items":{"$ref":"#/components/schemas/SUBMISSION_FicoReason"}},"secondaryTransUnionFICOScore":{"type":"number"},"secondaryTransUnionReasonCodes":{"type":"array","items":{"type":"string"}},"secondaryTransUnionFICOReasons":{"type":"array","items":{"$ref":"#/components/schemas/SUBMISSION_FicoReason"}},"secondaryExperianFICOScore":{"type":"number"},"secondaryExperianReasonCodes":{"type":"array","items":{"type":"string"}},"secondaryExperianFICOReasons":{"type":"array","items":{"$ref":"#/components/schemas/SUBMISSION_FicoReason"}},"secondaryChosenFICOScore":{"type":"number"},"secondaryChosenBureau":{"type":"string"},"secondaryScheduledMonthlyPayments":{"type":"number"},"secondaryOwnerOccupancyFlag":{"type":"boolean"},"secondaryWorst_Rating_within_12_months_Mortgage_Trades":{"type":"number"},"secondaryNumber_Open_Mortgage_Trades":{"type":"number"},"secondaryTotal_Balance_Open_Mortgage_Trades_with_Update_within_6_months":{"type":"number"},"secondaryNumber_Trades":{"type":"number"},"secondaryNumber_90_Days_Past_Due_Occurrences_within_24_months":{"type":"number"},"secondaryWorst_Rating_within_24_months_Mortgage_Trades":{"type":"number"},"secondaryNumber_Trades_Worst_Rating_90_Days_Past_Due_within_12_months":{"type":"number"},"secondaryAge_Oldest_Trade":{"type":"number"},"secondaryForeclosure_Flag":{"type":"number"},"secondaryAnyForeclosure":{"type":"boolean"},"secondaryAnyHomeEquity":{"type":"boolean"},"secondaryFullSsn":{"type":"string"},"secondaryHasChapter7Bankruptcy":{"type":"boolean"},"secondaryNinetyDay_Revolving_Lates_within_12_months":{"type":"number"},"secondaryNinetyDay_Installment_Lates_within_12_months":{"type":"number"},"secondaryTotalMortgagePayment":{"type":"number"},"secondaryTotalMonthlyPaymentsOnCredit":{"type":"number"},"secondaryPdaCreditNameMatch":{"type":"boolean"},"secondaryLossMitigation48Months":{"type":"number"},"secondaryIncomeDifference":{"type":"number"},"secondaryForeclosure_within_48_months_Flag":{"type":"number"},"secondaryBankruptcyEver":{"type":"number"},"secondaryBankruptcy_Public_Record_within_48_months_Flag":{"type":"number"},"secondaryMonthsSinceBk":{"type":"number"},"secondaryLossMitigationEver":{"type":"number"},"secondaryNumber_30_Days_Past_Due_Occurrences_within_12_months_Mortgage_Trades":{"type":"number"},"secondaryVerifiedIncome":{"type":"string"},"secondaryLossMitigation":{"type":"boolean"},"secondaryTotalLienBalance":{"type":"number"},"anyForeclosure":{"type":"boolean"},"anyHomeEquity":{"type":"boolean"},"hasChapter7Bankruptcy":{"type":"boolean"},"lossMitigation":{"type":"boolean"},"pdaCreditNameMatch":{"type":"boolean"},"avm":{"type":"number"},"highAvm":{"type":"number"},"lowAvm":{"type":"number"},"modeledCLTV":{"type":"number"},"combinedStatedDTI":{"type":"number"},"combinedModeledIncome":{"type":"number"},"combinedModeledDTI":{"type":"number"},"combinedStatedIncome":{"type":"number"},"combinedScheduledMonthlyPayments":{"type":"number"},"combinedNumber_Open_Mortgage_Trades":{"type":"number"},"combinedTotalLienBalance":{"type":"number"},"duplicateAccountBalance":{"type":"number"},"imputedDebt":{"type":"number"},"propertyType":{"type":"string"},"underwritingPolicy":{"type":"string"},"parcelNumber":{"type":"string"},"chosenFICOpercentile":{"type":"number"},"chosenFICOlowScore":{"type":"number"},"chosenFICOhighScore":{"type":"number"},"statedDTI":{"type":"number"},"modeledDTI":{"type":"number"},"scheduledMonthlyPayments":{"type":"number"},"statedIncome":{"type":"string"},"ownerOccupancyFlag":{"type":"boolean"},"number_Open_Mortgage_Trades":{"type":"number"},"totalMonthlyPaymentsOnCredit":{"type":"number"},"totalMortgagePayment":{"type":"number"},"avmHigh":{"type":"number"},"avmLow":{"type":"number"},"totalLienBalance":{"type":"number"}}},"SUBMISSION_FIREngineAvailableDataSourceDto":{"type":"object","properties":{"WorkerGuid":{"type":"string"},"DataSourceGuid":{"type":"string"},"DataSourceUniqueId":{"type":"string"},"SourceType":{"type":"string"},"SourceName":{"type":"string"},"TemplateName":{"type":"string"},"Name":{"type":"string"},"BaseUrl":{"type":"string"},"AlfaXBaseUrl":{"type":"string"},"Url":{"type":"string"},"RequestUrl":{"type":"string"},"DataSourceResponseLogGuid":{"type":"string"},"DateStart":{"format":"date-time","type":"string"},"Duration":{"type":"number"},"ApplicantIndex":{"type":"number"},"ErrorMessages":{"type":"string"},"IsNoScore":{"type":"boolean"},"IsUnavailable":{"type":"boolean"},"IsLockedFrozen":{"type":"boolean"},"IsErrorCategory":{"type":"boolean"},"IsNoCreditCategory":{"type":"boolean"},"IsNoHit":{"type":"boolean"},"IsError":{"type":"boolean"},"PullType":{"type":"string"},"IsDown":{"type":"boolean"},"DecisionDate":{"format":"date-time","type":"string"},"EvaluationSessionGuid":{"type":"string"}}},"SUBMISSION_FIREngineReasonsForApplicantRemovalDto":{"type":"object","properties":{"applicant0":{"type":"string"},"applicant1":{"type":"string"}}},"SUBMISSION_CreditDecisionDto":{"type":"object","properties":{"evaluationId":{"type":"string"},"type":{"type":"string","enum":["Single","Combined","Primary","Secondary"]},"code":{"type":"string"},"attributes":{"$ref":"#/components/schemas/SUBMISSION_FIREngineAttributesDto"},"bestDecision":{"type":"boolean"},"chosenBureau":{"type":"string"},"equifaxScored":{"type":"boolean"},"experianScored":{"type":"boolean"},"transUnionScored":{"type":"boolean"},"exclusionPass":{"type":"boolean"},"highScore":{"type":"boolean"},"availableDataSources":{"type":"array","items":{"$ref":"#/components/schemas/SUBMISSION_FIREngineAvailableDataSourceDto"}},"reasonsForApplicantRemoval":{"$ref":"#/components/schemas/SUBMISSION_FIREngineReasonsForApplicantRemovalDto"},"continueStop":{"type":"string"}},"required":["evaluationId","type","code","attributes","bestDecision","chosenBureau","equifaxScored","experianScored","transUnionScored","exclusionPass","highScore","availableDataSources"]},"SUBMISSION_MortgageOfficerDto":{"type":"object","properties":{"name":{"type":"string","description":"The name of the mortgage officer."},"licenseNumber":{"type":"string","description":"The license number of the mortgage officer."}},"required":["name","licenseNumber"]},"SUBMISSION_GetMortgageOfficerOutputDto":{"type":"object","properties":{"state":{"type":"string","description":"The state this officer is licensed in."},"legalEntityName":{"type":"string","description":"The name of the legal entity."},"legalEntityLocation":{"description":"The location of the legal entity.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_Address"}]},"officer":{"description":"The mortgage officer.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_MortgageOfficerDto"}]}},"required":["state","legalEntityName","legalEntityLocation","officer"]},"SUBMISSION_HandleDocumentsSignedPayload":{"type":"object","properties":{"financeAccountId":{"type":"string","description":"The human-readable identifier of the finance account whose documents\nwere signed. For the POS HI/HELOC flow this is the HELOC's finance\naccount ID."},"financeType":{"type":"string","description":"The type of finance account.","enum":["loan","lease","ppa","ppav","e-heloc"]},"bundleType":{"type":"string","nullable":true,"description":"The bundle type of the signed document set, e.g. `closing-agreement` when the documents are signed for a HELOC account.\nSet to `null` when the documents are signed for a non-HELOC account."},"reason":{"type":"string","description":"The reason for the documents signed event."}},"required":["financeAccountId","financeType","bundleType","reason"]},"SUBMISSION_SizeMeasurement":{"type":"object","properties":{"unit":{"type":"string","description":"The unit of a size measurement.","enum":["kW"]},"value":{"type":"number","description":"The value of a size measurement.","minimum":0},"label":{"type":"string","description":"The display name of the unit."}},"required":["unit","value"]},"SUBMISSION_DomesticContentEvaluation":{"type":"object","properties":{"solar":{"type":"string","description":"The `solar` represents the solar-system evaluation for the domestic-content.\nThis status indicates the eligibility of the solar system for the Domestic Content tax credit.","enum":["ACHIEVED","ACHIEVABLE","NOT_ACHIEVED","NOT_ACHIEVABLE"]},"fullDescriptionEvaluation":{"type":"boolean","description":"Indicates if the input payload was complete (inverters + panel + mounting).\nThis flag is used to determine if the evaluation was based on a complete set of inputs."},"domesticContentEvaluationChanged":{"type":"boolean","description":"Indicates if the current `solar` domestic-content evaluation is different from the new `solar` domestic-content evaluation.\nThis flag is used to determine if there has been a change in the evaluation status."},"domesticContentBasedPricing":{"type":"boolean","description":"Indicates if the domestic-content-based pricing is applicable.\nThis flag is used to determine if pricing is influenced by domestic-content evaluation."}}},"SUBMISSION_ProcessProjectDescriptionUpdatedInput":{"type":"object","properties":{"financeAccountId":{"type":"string","description":"The human-readable identifier of the finance account."},"systemSize":{"description":"The estimated size of the system.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_SizeMeasurement"}]},"firstYearEstimatedProduction":{"description":"The estimated annual production of the system.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_ProductionMeasurement"}]},"projectId":{"type":"string","description":"The unique identifier of the project."},"descriptionId":{"type":"string","description":"The unique identifier of the project description."},"firstFullDescription":{"type":"boolean","description":"Indicates whether this is the first full description created for this project."},"domesticContentEvaluation":{"description":"Indicates the domestic-content evaluation details.\nThis includes the evaluation of the `solar` system and `battery` for Domestic Content tax credit eligibility.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_DomesticContentEvaluation"}]}},"required":["financeAccountId","systemSize","firstYearEstimatedProduction","projectId","descriptionId","firstFullDescription"]},"SUBMISSION_UserDelta":{"type":"object","properties":{"userId":{"type":"string","description":"The ID of the user that was affected by the event."}},"required":["userId"]},"SUBMISSION_HandleDirectoryUserDeltaPayload":{"type":"object","properties":{"serviceKey":{"type":"string","description":"The service key."},"dateTime":{"format":"date-time","type":"string","description":"The date and time of the event."},"eventName":{"type":"string","description":"The name of the event."},"objectType":{"type":"string","description":"The object type."},"object":{"description":"The object that contains the user delta.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_UserDelta"}]},"tenantId":{"type":"string","description":"The tenant ID.","enum":["93d011dc-f34f-47ab-883a-c419d3c02567","ffaed9db-7d87-48fa-b0e2-60899f12ba91","a330ae3f-fd72-455b-9581-d1b292a3fba5","042d7acb-9113-4959-8a3f-8a56da4ee7fe"]}},"required":["serviceKey","dateTime","eventName","objectType","object","tenantId"]},"SUBMISSION_UserInvalidated":{"type":"object","properties":{"userId":{"type":"string","description":"The ID of the user that was affected by the event."}},"required":["userId"]},"SUBMISSION_HandleDirectoryUserInvalidatedPayload":{"type":"object","properties":{"serviceKey":{"type":"string","description":"The service key."},"dateTime":{"format":"date-time","type":"string","description":"The date and time of the event."},"eventName":{"type":"string","description":"The name of the event."},"objectType":{"type":"string","description":"The object type."},"object":{"description":"The object that contains the user invalidated.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_UserInvalidated"}]},"tenantId":{"type":"string","description":"The tenant ID.","enum":["93d011dc-f34f-47ab-883a-c419d3c02567","ffaed9db-7d87-48fa-b0e2-60899f12ba91","a330ae3f-fd72-455b-9581-d1b292a3fba5","042d7acb-9113-4959-8a3f-8a56da4ee7fe"]}},"required":["serviceKey","dateTime","eventName","objectType","object","tenantId"]},"SUBMISSION_HandlePartiesUpdatedPayloadItem":{"type":"object","properties":{"loanId":{"type":"string","description":"The human-readable unique identifier of the finance account, referred to as `loanId` on the Parties service."},"guid":{"type":"string","description":"*\nThe unique identifier of the finance account."},"parties":{"description":"The parties associated with the finance account.","type":"array","items":{"$ref":"#/components/schemas/SUBMISSION_PartyDto"}}},"required":["loanId","guid","parties"]},"SUBMISSION_HandlePartiesUpdatedPayloadAttributes":{"type":"object","properties":{"isLoan":{"type":"boolean","description":"Indicates whether the event is for a loan."}},"required":["isLoan"]},"SUBMISSION_HandlePartiesUpdatedPayload":{"type":"object","properties":{"item":{"description":"The item that contains the updated parties.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_HandlePartiesUpdatedPayloadItem"}]},"attributes":{"description":"The attributes of the payload.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_HandlePartiesUpdatedPayloadAttributes"}]}},"required":["item","attributes"]},"SUBMISSION_HandlePodcoEvaluationCompletedPayload":{"type":"object","properties":{"financeAccountId":{"type":"string","description":"The human-readable identifier of the finance account."},"activeAgreement":{"type":"object","description":"The metadata indicating which pricing should now be considered active."}},"required":["financeAccountId","activeAgreement"]},"SUBMISSION_HandleProjectDescriptionUpdatedPayload":{"type":"object","properties":{"financeAccountId":{"type":"string","description":"The human-readable identifier of the finance account."},"systemSize":{"description":"The estimated size of the system.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_SizeMeasurement"}]},"firstYearEstimatedProduction":{"description":"The estimated annual production of the system.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_ProductionMeasurement"}]},"projectId":{"type":"string","description":"The unique identifier of the project."},"descriptionId":{"type":"string","description":"The unique identifier of the project description."},"firstFullDescription":{"type":"boolean","description":"Indicates whether this is the first full description created for this project."},"domesticContentEvaluation":{"description":"Indicates the domestic-content evaluation details.\nThis includes the evaluation of the `solar` system and `battery` for Domestic Content tax credit eligibility.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_DomesticContentEvaluation"}]}},"required":["financeAccountId","systemSize","firstYearEstimatedProduction","projectId","descriptionId","firstFullDescription"]},"SUBMISSION_UnderwritingEvaluationsApplicant":{"type":"object","properties":{"createdBy":{"type":"string","description":"The unique identifier of the user (or system) that created the record."},"tenantId":{"type":"string","description":"Represents the tenantId for the current evaluation."},"firstName":{"type":"string","description":"The first name of the applicant."},"lastName":{"type":"string","description":"The last name of the applicant."},"dateOfBirth":{"type":"string","description":"The date of birth of the applicant."},"email":{"type":"string","description":"The email address of the applicant."},"personalIdentity":{"description":"The unique personal identifier of the applicant.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_PersonalIdentity"}]},"address":{"description":"The address of the property.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_Address"}]},"homeOccupancy":{"type":"string","description":"The home occupancy of the property.","enum":["PRIMARY","SECONDARY","INVESTMENT","OTHER"]},"homeOwnership":{"type":"string","description":"The home ownership status of the property.","enum":["NOT_OWNED","OWNED_WITH_MORTGAGE","OWNED_FREE_AND_CLEAR"]},"annualIncome":{"description":"The annual income of the applicant.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_CurrencyMeasurement"}]},"primaryPhoneNumber":{"description":"The primary phone number of the applicant.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_Phone"}]},"spokenLanguage":{"type":"string","description":"The spoken language of the applicant.","enum":["ENGLISH","SPANISH"]},"citizenshipStatus":{"type":"string","description":"The citizenship of the applicant.","enum":["US_CITIZEN","LAWFUL_PERMANENT_RESIDENT_ALIEN","OTHER"]},"employmentStatus":{"type":"string","description":"The employment status of the applicant.","enum":["EMPLOYED","RETIRED","NOT_EMPLOYED","OTHER"]},"electronicConsent":{"type":"boolean","description":"Indicates whether the applicant has provided electronic consent."},"isPrimary":{"type":"boolean","description":"Indicates whether the applicant is the primary applicant."},"dropped":{"type":"boolean","description":"Indicates whether the applicant has been dropped from the evaluation."},"isOnTitle":{"type":"boolean","description":"Indicates whether underwriting verified the applicant is on the property\ntitle. `undefined` when underwriting did not make a determination (e.g.\nnon-HELOC evaluations)."}},"required":["createdBy","tenantId"]},"SUBMISSION_HandleUnderwritingEvaluationEventPayload":{"type":"object","properties":{"financeAccountId":{"type":"string","description":"The human-readable identifier of the finance account."},"evaluationSessionId":{"type":"string","description":"The unique identifier of the evaluation session."},"creditDecisionType":{"type":"string","description":"The type of credit decision.","enum":["Single","Combined","Primary","Secondary"]},"creditDecisionReason":{"type":"string","description":"The reason for the credit decision."},"expirationDate":{"type":"string","description":"The expiration date of the application."},"applicants":{"description":"The applicants associated with the finance account.","type":"array","items":{"$ref":"#/components/schemas/SUBMISSION_UnderwritingEvaluationsApplicant"}}},"required":["financeAccountId","evaluationSessionId","creditDecisionType","creditDecisionReason","expirationDate","applicants"]},"SUBMISSION_Lender":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the lender."},"name":{"type":"string","description":"The name of the lender."},"organizationId":{"type":"string","description":"The organization ID of the lender."}},"required":["id","name","organizationId"]},"SUBMISSION_LenderUnderwritingReason":{"type":"object","properties":{"code":{"type":"string","description":"The code for the reason."},"description":{"type":"string","description":"The description of the reason."}},"required":["code","description"]},"SUBMISSION_HandleUnderwritingExternalEvaluationEventPayload":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the external evaluation session."},"externalId":{"type":"string","description":"The unique identifier of the external application as returned by the lender."},"financeAccountId":{"type":"string","description":"The human-readable identifier of the finance account."},"lender":{"description":"The lender that processed the external evaluation.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_Lender"}]},"status":{"type":"string","description":"The status of the external evaluation as represented by FIREngine.","enum":["Approved","ApprovedWithStips","Declined","Pending"]},"reasons":{"description":"The reason for the external evaluation as represented by the lender.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_LenderUnderwritingReason"}]},"preApprovedLeaseAmount":{"type":"number","description":"The pre-approved lease amount."}},"required":["id","externalId","financeAccountId","lender","status","reasons","preApprovedLeaseAmount"]},"SUBMISSION_BorrowerContactInfoChangedPayload":{"type":"object","properties":{"financeAccountId":{"type":"string","description":"The finance account identifier."},"isPrimary":{"type":"boolean","description":"Whether this borrower is the primary borrower on the account."},"email":{"type":"string","description":"The borrower's current email address, present when included on the wire payload."},"phoneNumber":{"type":"string","description":"The borrower's current phone number, present when included on the wire payload."},"mailingAddrStreet":{"type":"string","description":"The borrower's current mailing address street line, present when included on the wire payload."},"mailingAddrCity":{"type":"string","description":"The borrower's current mailing address city, present when included on the wire payload."},"mailingAddrState":{"type":"string","description":"The borrower's current mailing address state, present when included on the wire payload."},"mailingAddrZip":{"type":"string","description":"The borrower's current mailing address ZIP code, present when included on the wire payload."},"changedFieldNames":{"description":"The names of the fields that changed in this update.","type":"array","items":{"type":"string"}}},"required":["financeAccountId","isPrimary","changedFieldNames"]},"SUBMISSION_HandleFundReportingEventPayload":{"type":"object","properties":{"partyOrganizationId":{"type":"string","description":"The ID of the organization of the party."},"loanGuid":{"type":"string","description":"The ID of the loan."},"partyRole":{"type":"string","description":"The role of the party."},"financeAccountId":{"type":"string","description":"The ID of the finance account."},"projectType":{"type":"string","description":"The type of the project.","enum":["TPO","Loan"]},"milestoneName":{"type":"string","description":"The name of the milestone."},"dateTimeFunded":{"type":"string","description":"The date and time the funding occurred."},"fundingAmount":{"type":"number","description":"The amount funded."},"dealerFeeAmount":{"type":"number","description":"The dealer fee amount."},"dealerFeePercentage":{"type":"number","description":"The dealer fee percentage."},"amountDueToPartner":{"type":"number","description":"The amount due to the partner."},"loanAmount":{"type":"number","description":"The loan amount."},"isPartyFullyFunded":{"type":"boolean","description":"Whether the party is fully funded."},"currencyUnit":{"type":"string","description":"The currency unit."},"distributionLedgerEntryGuid":{"type":"string","description":"The ID of the distribution ledger entry."}},"required":["partyOrganizationId","loanGuid","partyRole","financeAccountId","projectType","milestoneName","dateTimeFunded","fundingAmount","dealerFeeAmount","dealerFeePercentage","amountDueToPartner","loanAmount","isPartyFullyFunded","currencyUnit","distributionLedgerEntryGuid"]},"SUBMISSION_Health":{"type":"object","properties":{"status":{"type":"string","description":"The overall status of the Submission service."},"details":{"description":"A collection of health checks performed on the dependent systems and resources.","type":"array","items":{"type":"object"}}},"required":["status","details"]},"SUBMISSION_DeepHealth":{"type":"object","properties":{"status":{"type":"string","description":"The overall status of the Submission service."},"details":{"description":"A collection of health checks performed on the dependent systems and resources.","type":"array","items":{"type":"object"}}},"required":["status","details"]},"SUBMISSION_CreateApplicationTpoFromSharedInput":{"type":"object","properties":{"type":{"type":"string","description":"The type of application submission.","enum":["TPO_FROM_SHARED_APPLICATION","TPO_FROM_ASSUMPTION"]},"subjectProperty":{"description":"The property where the project is being done.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_SubjectPropertyOptional"}]},"applicant":{"description":"The primary applicant.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_TpoApplicant"}]},"coApplicant":{"description":"The secondary applicant.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_TpoApplicant"}]},"disclosureToken":{"type":"string","description":"The signed token of the disclosures the applicant agreed to."},"agent":{"type":"string"},"applicantSignature":{"type":"string","description":"The signature of the applicant."},"referenceNumber":{"type":"string","description":"A custom reference number external parties use to link the application back to their systems."},"enrollments":{"type":"array","description":"A list of enrollments. Defaults to `[AUTOPAY]` when set to `null`.","items":{"type":"string","enum":["AUTOPAY","PAPERLESS_COMMUNICATIONS"]}},"tags":{"description":"Optional user-defined tags to be added to the application.","type":"array","items":{"type":"string"}},"parties":{"description":"A list of custom parties.","type":"array","items":{"$ref":"#/components/schemas/SUBMISSION_PartyDto"}}},"required":["type","applicant","applicantSignature"]},"SUBMISSION_CreateHmdaResponseItemInput":{"type":"object","properties":{"questionId":{"type":"string","description":"Foreign key to the HMDA question."},"value":{"type":"string","description":"The exact value submitted by the user."},"collectionMethod":{"type":"string","description":"Required by HMDA when applicable for GMI.","enum":["SELF","VISUAL_OBSERVATION_OR_SURNAME","ORIGINATOR_INPUT","AUTOFILLED"]}},"required":["questionId","value","collectionMethod"]},"SUBMISSION_CreateHmdaApplicantResponsesInput":{"type":"object","properties":{"applicantRole":{"type":"string","description":"Who answered the questions (e.g., APPLICANT, COAPPLICANT).","enum":["APPLICANT","COAPPLICANT"]},"responses":{"description":"The array of HMDA response items for this applicant.","type":"array","items":{"$ref":"#/components/schemas/SUBMISSION_CreateHmdaResponseItemInput"}}},"required":["applicantRole","responses"]},"SUBMISSION_CreateHmdaResponsesInput":{"type":"object","properties":{"payload":{"description":"The array of applicant responses.","type":"array","items":{"$ref":"#/components/schemas/SUBMISSION_CreateHmdaApplicantResponsesInput"}},"token":{"type":"string","description":"The signed JWT token."}},"required":["payload","token"]},"SUBMISSION_LocalizationEntryDto":{"type":"object","properties":{"language":{"type":"string","description":"The language code (e.g., \"en\", \"es\")."},"locale":{"type":"string","description":"The locale code (e.g., \"en-US\", \"es-US\")."},"text":{"type":"string","description":"The localized text content."}},"required":["language","locale","text"]},"SUBMISSION_LocalizedTextDto":{"type":"object","properties":{"default":{"type":"string","description":"The default text value."},"localizations":{"description":"Array of localization entries.","type":"array","items":{"$ref":"#/components/schemas/SUBMISSION_LocalizationEntryDto"}}},"required":["default","localizations"]},"SUBMISSION_HmdaApplicabilityDto":{"type":"object","properties":{"applicantRoles":{"type":"array","description":"List of applicant roles this question applies to.","items":{"type":"string","enum":["APPLICANT","COAPPLICANT"]}}},"required":["applicantRoles"]},"SUBMISSION_HmdaResponseSchemaDto":{"type":"object","properties":{"type":{"type":"string","description":"The response type (e.g., \"SINGLE_SELECT\", \"MULTI_SELECT\", \"NUMERIC\", \"TEXT\", \"DATE\").","enum":["SINGLE_SELECT","MULTI_SELECT","NUMERIC","TEXT","DATE"]},"allowedValues":{"description":"Valid values for select-type questions.","type":"array","items":{"type":"string"}},"maxSelections":{"type":"number","description":"For multi-select questions, the maximum number of selections allowed."}},"required":["type"]},"SUBMISSION_HmdaOptionDto":{"type":"object","properties":{"key":{"type":"string","description":"Internal key for the option."},"label":{"description":"Localized label for the option.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_LocalizedTextDto"}]},"value":{"type":"string","description":"The value sent by the client."}},"required":["key","label","value"]},"SUBMISSION_HmdaVisibilityConditionDto":{"type":"object","properties":{"field":{"type":"string","description":"The field to check."},"operator":{"type":"string","description":"The operator to use.","enum":["ALWAYS","EQUALS","CONTAINS"]},"value":{"type":"string","description":"The value to compare to."}},"required":["operator"]},"SUBMISSION_HmdaVisibilityDto":{"type":"object","properties":{"conditions":{"description":"The conditions that determine the visibility of the HMDA question.","type":"array","items":{"$ref":"#/components/schemas/SUBMISSION_HmdaVisibilityConditionDto"}},"logic":{"type":"string","description":"The logical operator to use.","enum":["ALL","ANY"]}},"required":["conditions","logic"]},"SUBMISSION_HomeMortgageDisclosureDto":{"type":"object","properties":{"code":{"type":"string","description":"Stable logical identifier for the question (e.g., \"HMDA_ETHNICITY_PRIMARY\")."},"section":{"type":"string","description":"HMDA section (e.g., \"ETHNICITY\", \"RACE\", \"SEX\")."},"title":{"description":"Localizable title.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_LocalizedTextDto"}]},"description":{"description":"Localizable description/help text.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_LocalizedTextDto"}]},"applicability":{"description":"Defines visibility by product, channel, jurisdiction, applicant role.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_HmdaApplicabilityDto"}]},"responseSchema":{"description":"Validation rules and structure of the answer.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_HmdaResponseSchemaDto"}]},"options":{"description":"Only for select-type. Contains option metadata.","type":"array","items":{"$ref":"#/components/schemas/SUBMISSION_HmdaOptionDto"}},"visibility":{"description":"Visibility conditions.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_HmdaVisibilityDto"}]},"lifecycleStatus":{"type":"string","description":"Lifecycle status of the question.","enum":["DRAFT","ACTIVE","DEPRECATED","RETIRED"]},"id":{"type":"string","description":"The unique identifier of the entity."}},"required":["code","section","title","applicability","responseSchema","visibility","lifecycleStatus","id"]},"SUBMISSION_FindHomeMortgageDisclosuresOutputDto":{"type":"object","properties":{"items":{"description":"The list of home mortgage disclosures that match the query parameters.","type":"array","items":{"$ref":"#/components/schemas/SUBMISSION_HomeMortgageDisclosureDto"}},"token":{"type":"string","description":"The token to send back when persisting the responses associated with the Home Mortgage Disclosure questions."},"tokenExpiresAt":{"format":"date-time","type":"string","description":"The expiration date of the token."}},"required":["items","token","tokenExpiresAt"]},"SUBMISSION_CreateApplicationTpoFromAssumptionInput":{"type":"object","properties":{"type":{"type":"string","description":"The type of application submission.","enum":["TPO_FROM_SHARED_APPLICATION","TPO_FROM_ASSUMPTION"]},"applicant":{"description":"The primary applicant.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_TpoApplicant"}]},"coApplicant":{"description":"The secondary applicant.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_TpoApplicant"}]},"disclosureToken":{"type":"string","description":"The signed token of the disclosures the applicant agreed to."},"agent":{"type":"string"},"applicantSignature":{"type":"string","description":"The signature of the applicant."},"referenceNumber":{"type":"string","description":"A custom reference number external parties use to link the application back to their systems."},"enrollments":{"type":"array","description":"A list of enrollments. Defaults to `[AUTOPAY]` when set to `null`.","items":{"type":"string","enum":["AUTOPAY","PAPERLESS_COMMUNICATIONS"]}},"tags":{"description":"Optional user-defined tags to be added to the application.","type":"array","items":{"type":"string"}},"parties":{"description":"A list of custom parties.","type":"array","items":{"$ref":"#/components/schemas/SUBMISSION_PartyDto"}}},"required":["type","applicant","applicantSignature"]},"SUBMISSION_AddressValidationOutput":{"type":"object","properties":{"streetAddress":{"type":"string","description":"The street address."},"city":{"type":"string","description":"The city."},"state":{"type":"string","description":"The state,"},"zip":{"type":"string","description":"The ZIP code."}},"required":["streetAddress","city","state","zip"]},"SUBMISSION_ValidationResult":{"type":"object","properties":{"isPassed":{"type":"boolean","description":"Whether the validation passed."},"description":{"type":"string","description":"The description of the validation result."}},"required":["isPassed","description"]},"SUBMISSION_AdditionalValidationResult":{"type":"object","properties":{"code":{"type":"string","description":"The code of the additional validation.","enum":["REMOTE_ONLINE_NOTARIZATION"]},"result":{"description":"The result of the additional validation.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_ValidationResult"}]}},"required":["code","result"]},"SUBMISSION_AddressValidationResponse":{"type":"object","properties":{"providedAddress":{"description":"The address provided by the user.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_AddressValidationOutput"}]},"suggestedAddress":{"description":"The suggested address.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_AddressValidationOutput"}]},"additionalValidationResults":{"description":"The results of additional validations.","type":"array","items":{"$ref":"#/components/schemas/SUBMISSION_AdditionalValidationResult"}}},"required":["providedAddress","suggestedAddress","additionalValidationResults"]},"SUBMISSION_AddressValidationInput":{"type":"object","properties":{"streetAddress":{"type":"string","description":"The street address to search for."},"city":{"type":"string","description":"The city to search for."},"state":{"type":"string","description":"The state to search for.","minLength":2,"maxLength":2},"zipCode":{"type":"string","description":"The ZIP code to search for.","minLength":5,"maxLength":10},"additionalValidations":{"type":"string","description":"Additional validations to perform on the address.","enum":["REMOTE_ONLINE_NOTARIZATION"]}},"required":["streetAddress","city","state","zipCode"]},"SUBMISSION_GetCacheEntryOutput":{"type":"object","properties":{"value":{"type":"object","nullable":true,"description":"The value associated with the key."}},"required":["value"]},"SUBMISSION_DeleteCacheOutput":{"type":"object","properties":{"key":{"type":"string","description":"The key of the cache entry that was deleted. If the cache was wiped, this value is `all`."},"success":{"type":"boolean","description":"Whether the operation was successful."}},"required":["key","success"]},"SUBMISSION_CreateClaimOutput":{"type":"object","properties":{"name":{"type":"string","description":"The name of the claim."},"key":{"type":"string","description":"The key of the claim."},"description":{"type":"string","description":"A description of what the claim enables."},"claimId":{"type":"string","description":"The ID of the claim."}},"required":["name","key","description","claimId"]},"SUBMISSION_CreateClaimInput":{"type":"object","properties":{"name":{"type":"string","description":"The name of the claim."},"key":{"type":"string","description":"The key of the claim."},"description":{"type":"string","description":"A description of what the claim enables."}},"required":["name","key","description"]},"SUBMISSION_FinanceType":{"type":"string","description":"Type of the application","enum":["loan","lease","ppa","ppav","e-heloc"]},"SUBMISSION_SessionTokenDto":{"type":"object","properties":{"financeAccountId":{"type":"string","description":"Finance account ID associated with the session token","example":"24-34-000102"},"applicationType":{"example":"loan","$ref":"#/components/schemas/SUBMISSION_FinanceType"},"deepLink":{"type":"string","description":"Deep link URL for the given session token","example":"https://goodleap.callpilot.io/public/launcher?token=token&session=session&surveyType=id&code=code"}},"required":["financeAccountId","applicationType","deepLink"]},"SUBMISSION_PrequalificationOfferRateDto":{"type":"object","properties":{"minimum":{"type":"number","description":"The minimum rate."},"maximum":{"type":"number","description":"The maximum rate."}},"required":["minimum","maximum"]},"SUBMISSION_PrequalificationOfferMarginsDto":{"type":"object","properties":{"installment":{"type":"number","description":"The margin rate applied to the installment portion of the loan,\nexpressed as a decimal representing a percent (e.g. `0.025` = 2.5%)."},"revolving":{"type":"number","description":"The margin rate applied to the revolving portion of the loan,\nexpressed as a decimal representing a percent (e.g. `0.025` = 2.5%)."}},"required":["installment","revolving"]},"SUBMISSION_PrequalificationOfferDealerFeeDto":{"type":"object","properties":{"percent":{"type":"number","description":"The dealer fee expressed as a percentage of project cost (e.g. 5 for 5%)."}},"required":["percent"]},"SUBMISSION_PrequalificationOfferDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the offer."},"estimatedMonthlyPaymentWithAutopay":{"type":"number","nullable":true,"description":"The estimated monthly payment calculated using the autopay interest rate. Null for D2C (homeowner-initiated) HELOC prequalifications, which have no project cost to compute payments against."},"estimatedMonthlyPaymentWithoutAutopay":{"type":"number","nullable":true,"description":"The estimated monthly payment calculated without the autopay discount. Null for D2C (homeowner-initiated) HELOC prequalifications, which have no project cost to compute payments against."},"ratesWithAutopay":{"description":"The rate information for the offer with autopay.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_PrequalificationOfferRateDto"}]},"ratesWithoutAutopay":{"description":"The rate information for the offer without autopay.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_PrequalificationOfferRateDto"}]},"term":{"type":"number","description":"The term information for the offer."},"maxAmount":{"type":"number","description":"The maximum amount for the offer."},"featured":{"type":"boolean","description":"Indicates whether this offer is featured."},"margins":{"description":"The per-product margin rates of the offer, when supplied by underwriting.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_PrequalificationOfferMarginsDto"}]},"dealerFee":{"description":"The dealer fee for the offer, when supplied by underwriting.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_PrequalificationOfferDealerFeeDto"}]}},"required":["id","estimatedMonthlyPaymentWithAutopay","estimatedMonthlyPaymentWithoutAutopay","ratesWithAutopay","ratesWithoutAutopay","term","maxAmount","featured"]},"SUBMISSION_CreatePrequalificationOutput":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the prequalification."},"createdAt":{"format":"date-time","type":"string","description":"The date and time when the prequalification was created."},"expiresAt":{"format":"date-time","type":"string","description":"The date and time when the prequalification will expire."},"financeType":{"type":"string","description":"The type of finance project.","enum":["loan","lease","ppa","ppav","e-heloc"]},"categoryCode":{"type":"string","description":"The code of the category for this project.","enum":["Solar_TPO","HVAC_LEASE","BATTERY_LEASE","HELOC"]},"categoryId":{"type":"string","description":"The unique identifier of the offer category."},"availableOffers":{"description":"Available offers for the prequalification.","type":"array","items":{"$ref":"#/components/schemas/SUBMISSION_PrequalificationOfferDto"}}},"required":["id","createdAt","expiresAt","financeType","categoryCode","categoryId","availableOffers"]},"SUBMISSION_PrimaryPrequalificationApplicantInput":{"type":"object","properties":{"isCoApplicantSpouse":{"type":"boolean","description":"Indicates if the co-applicant is the applicant's spouse.\nWhen true, `coApplicant` is required."},"maritalStatus":{"type":"string","description":"The applicant's marital status.","enum":["SINGLE","MARRIED","DIVORCED","SEPARATED","WIDOWED"]},"maritalPartner":{"description":"The applicant's marital partner information.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_MaritalPartnerDto"}]},"firstName":{"type":"string","description":"The applicant's first name."},"lastName":{"type":"string","description":"The applicant's last name."},"dateOfBirth":{"format":"date-time","type":"string","description":"The applicant's date of birth."},"personalIdentity":{"description":"The applicant's personal identity information.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_PersonalIdentity"}]},"homeOccupancy":{"type":"string","description":"Occupancy status of the applicant's property.","enum":["PRIMARY","SECONDARY","INVESTMENT","OTHER"]},"homeOwnership":{"type":"string","description":"Ownership status of the applicant's property.","enum":["NOT_OWNED","OWNED_WITH_MORTGAGE","OWNED_FREE_AND_CLEAR"]},"annualIncome":{"description":"Total annual income.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_CurrencyMeasurement"}]},"email":{"type":"string","description":"The applicant's email address."},"primaryPhoneNumber":{"description":"The applicant's primary phone number.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_Phone"}]},"secondaryPhoneNumber":{"nullable":true,"description":"The applicant's secondary phone number.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_Phone"}]},"spokenLanguage":{"type":"string","description":"The applicant's spoken language.","enum":["ENGLISH","SPANISH"]},"employmentStatus":{"type":"string","description":"The applicant's employment status.","enum":["EMPLOYED","RETIRED","NOT_EMPLOYED","OTHER"]},"citizenshipStatus":{"type":"string","description":"The applicant's citizenship status.","enum":["US_CITIZEN","LAWFUL_PERMANENT_RESIDENT_ALIEN","OTHER"]},"address":{"description":"The applicant's mailing address.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_Address"}]},"ssn":{"type":"string","description":"The applicant's social security number. Present for backwards compatibility. Use the `personalIdentity` property instead."}},"required":["firstName","lastName","dateOfBirth","personalIdentity","homeOccupancy","homeOwnership","annualIncome","email","primaryPhoneNumber","spokenLanguage","employmentStatus","citizenshipStatus","address"]},"SUBMISSION_BasePrequalificationApplicantInput":{"type":"object","properties":{"maritalStatus":{"type":"string","description":"The applicant's marital status.","enum":["SINGLE","MARRIED","DIVORCED","SEPARATED","WIDOWED"]},"maritalPartner":{"description":"The applicant's marital partner information.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_MaritalPartnerDto"}]},"firstName":{"type":"string","description":"The applicant's first name."},"lastName":{"type":"string","description":"The applicant's last name."},"dateOfBirth":{"format":"date-time","type":"string","description":"The applicant's date of birth."},"personalIdentity":{"description":"The applicant's personal identity information.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_PersonalIdentity"}]},"homeOccupancy":{"type":"string","description":"Occupancy status of the applicant's property.","enum":["PRIMARY","SECONDARY","INVESTMENT","OTHER"]},"homeOwnership":{"type":"string","description":"Ownership status of the applicant's property.","enum":["NOT_OWNED","OWNED_WITH_MORTGAGE","OWNED_FREE_AND_CLEAR"]},"annualIncome":{"description":"Total annual income.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_CurrencyMeasurement"}]},"email":{"type":"string","description":"The applicant's email address."},"primaryPhoneNumber":{"description":"The applicant's primary phone number.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_Phone"}]},"secondaryPhoneNumber":{"nullable":true,"description":"The applicant's secondary phone number.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_Phone"}]},"spokenLanguage":{"type":"string","description":"The applicant's spoken language.","enum":["ENGLISH","SPANISH"]},"employmentStatus":{"type":"string","description":"The applicant's employment status.","enum":["EMPLOYED","RETIRED","NOT_EMPLOYED","OTHER"]},"citizenshipStatus":{"type":"string","description":"The applicant's citizenship status.","enum":["US_CITIZEN","LAWFUL_PERMANENT_RESIDENT_ALIEN","OTHER"]},"address":{"description":"The applicant's mailing address.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_Address"}]},"ssn":{"type":"string","description":"The applicant's social security number. Present for backwards compatibility. Use the `personalIdentity` property instead."}},"required":["firstName","lastName","dateOfBirth","personalIdentity","homeOccupancy","homeOwnership","annualIncome","email","primaryPhoneNumber","spokenLanguage","employmentStatus","citizenshipStatus","address"]},"SUBMISSION_PrequalificationLinkedFinanceAccount":{"type":"object","properties":{"linkType":{"type":"string","description":"The type of the linked finance account.","enum":["USER_SUBMITTED","ASSUMPTION","ROOT_ACCOUNT","LOAN"]},"financeAccountId":{"type":"string","description":"The unique identifier of the linked finance account."},"location":{"type":"string","description":"The location of the linked finance account.","enum":["INTEGRATION_API"]}},"required":["linkType","financeAccountId","location"]},"SUBMISSION_CreatePrequalificationInput":{"type":"object","properties":{"projectCost":{"type":"number","description":"The cost of the project."},"subjectProperty":{"description":"The property where the project is being done.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_SubjectPropertyCreateInputDto"}]},"applicant":{"description":"The primary applicant.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_PrimaryPrequalificationApplicantInput"}]},"coApplicant":{"description":"The secondary applicant.\nRequired when `applicant.isCoApplicantSpouse` is true.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_BasePrequalificationApplicantInput"}]},"disclosureToken":{"type":"string","description":"The signed token of the disclosures the applicant agreed to."},"referenceNumber":{"type":"string","description":"A custom reference number external parties use to link the application back to their systems.","maxLength":500},"enrollments":{"type":"array","description":"A list of enrollments. Defaults to `[PaperlessCommunications]` when set to `null`.","items":{"type":"string","enum":["AUTOPAY","PAPERLESS_COMMUNICATIONS"]}},"tags":{"description":"Optional user-defined tags to be added to the prequalification.","type":"array","items":{"type":"string"}},"parties":{"description":"A list of custom parties.","type":"array","items":{"$ref":"#/components/schemas/SUBMISSION_PartyDto"}},"linkedFinanceAccounts":{"description":"A list of linked finance accounts.","type":"array","items":{"$ref":"#/components/schemas/SUBMISSION_PrequalificationLinkedFinanceAccount"}},"offers":{"description":"The list of offers for the prequalification.","type":"array","items":{"$ref":"#/components/schemas/SUBMISSION_PrequalificationOfferDto"}}},"required":["projectCost","subjectProperty","applicant","offers"]},"SUBMISSION_CreatePrequalificationSubmissionOutput":{"type":"object","properties":{"financeAccountId":{"type":"string","description":"The unique identifier of the newly created finance account in ##-##-###### format."},"createdAt":{"format":"date-time","type":"string","description":"The date and time when the application was created."},"expiresAt":{"format":"date-time","type":"string","description":"The date and time when the application will expire."},"financeType":{"type":"string","description":"The type of finance project.","enum":["loan","lease","ppa","ppav","e-heloc"]},"offerId":{"type":"string","description":"The unique identifier of the offer which can then be used to fetch rate, term and other product-related data."},"categoryCode":{"type":"string","description":"The code of the category for this project.","enum":["Solar_TPO","HVAC_LEASE","BATTERY_LEASE","HELOC"]},"categoryId":{"type":"string","description":"The unique identifier of the offer category."},"tags":{"description":"Optional user-defined tags to be added to the application.","type":"array","items":{"type":"string"}},"status":{"type":"string","description":"The status of the application.","enum":["APPROVED","APPROVED_WITH_STIPS","DECLINED","PENDING","CANCELED"]},"reason":{"type":"string","description":"The reason the application was declined or approved with stips."},"type":{"type":"string","description":"The decision type.","enum":["SINGLE","COMBINED","PRIMARY","SECONDARY"]},"cases":{"description":"An array of cases created for this application.","type":"array","items":{"$ref":"#/components/schemas/SUBMISSION_ApplicationPendingCaseOutput"}},"decisionExplanation":{"description":"The explanation of the underwriting decision reason.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_DecisionExplanation"}]},"borrowerActionableUrl":{"type":"string","description":"A URL the borrower can visit to take action on cases related to this application."}},"required":["financeAccountId","createdAt","expiresAt","financeType","offerId","categoryCode","categoryId","status","type"]},"SUBMISSION_CreatePrequalificationSubmissionInput":{"type":"object","properties":{"applicantSignature":{"type":"string","description":"The signature of the applicant."},"coApplicantSignature":{"type":"string","description":"The signature of the co-applicant."},"disclosureToken":{"type":"string","description":"The signed token of the disclosures the applicant agreed to."}},"required":["applicantSignature","disclosureToken"]},"SUBMISSION_PrequalificationApplicantOutput":{"type":"object","properties":{"firstName":{"type":"string","description":"The first name of the applicant."},"lastName":{"type":"string","description":"The last name of the applicant."},"email":{"type":"string","description":"The email of the applicant."},"maritalStatus":{"type":"string","description":"The marital status of the applicant.","enum":["SINGLE","MARRIED","DIVORCED","SEPARATED","WIDOWED"]},"maritalPartner":{"description":"The marital partner of the applicant.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_MaritalPartnerDto"}]}},"required":["firstName","lastName","email"]},"SUBMISSION_PrequalificationOutput":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the prequalification."},"projectCost":{"type":"number","nullable":true,"description":"The cost of the project. Null for D2C (homeowner-initiated) HELOC finance accounts, which have no associated project cost."},"selectedOfferId":{"type":"string","description":"The unique identifier of the selected offer."},"subjectProperty":{"description":"The property where the project is being done.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_SharedAppSubjectPropertyDto"}]},"applicant":{"description":"The primary applicant.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_PrequalificationApplicantOutput"}]},"coApplicant":{"description":"The secondary applicant.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_PrequalificationApplicantOutput"}]},"financeType":{"type":"string","description":"The type of finance project.","enum":["loan","lease","ppa","ppav","e-heloc"]},"categoryCode":{"type":"string","description":"The category code associated with the prequalification.","enum":["Solar_TPO","HVAC_LEASE","BATTERY_LEASE","HELOC"]},"categoryId":{"type":"string","description":"The category ID associated with the prequalification."},"availableOffers":{"description":"The offers for the prequalification.","type":"array","items":{"$ref":"#/components/schemas/SUBMISSION_PrequalificationOfferDto"}},"linkedFinanceAccounts":{"description":"The linked finance accounts for the prequalification.","type":"array","items":{"$ref":"#/components/schemas/SUBMISSION_SharedLinkedFinanceAccountDto"}},"createdAt":{"format":"date-time","type":"string","description":"The date and time when the prequalification was created."},"expiresAt":{"format":"date-time","type":"string","description":"The date and time when the prequalification will expire."}},"required":["id","projectCost","selectedOfferId","applicant","financeType","categoryCode","categoryId","availableOffers","linkedFinanceAccounts","createdAt","expiresAt"]},"SUBMISSION_UpdatePrequalificationApplicantInput":{"type":"object","properties":{"maritalStatus":{"type":"string","description":"The applicant's marital status.","enum":["SINGLE","MARRIED","DIVORCED","SEPARATED","WIDOWED"]},"maritalPartner":{"description":"The applicant's marital partner information.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_MaritalPartnerDto"}]},"isCoApplicantSpouse":{"type":"boolean","description":"Indicates if the co-applicant is the applicant's spouse.\nWhen true, `coApplicant` is required."}}},"SUBMISSION_UpdatePrequalificationCoApplicantInput":{"type":"object","properties":{"email":{"type":"string","description":"The applicant's email address."},"maritalStatus":{"type":"string","description":"The applicant's marital status.","enum":["SINGLE","MARRIED","DIVORCED","SEPARATED","WIDOWED"]},"maritalPartner":{"description":"The applicant's marital partner information.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_MaritalPartnerDto"}]}}},"SUBMISSION_UpdatePrequalificationInput":{"type":"object","properties":{"selectedOfferId":{"type":"string","description":"The unique identifier of the selected offer."},"applicant":{"description":"The primary applicant update data.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_UpdatePrequalificationApplicantInput"}]},"coApplicant":{"description":"The secondary applicant update data.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_UpdatePrequalificationCoApplicantInput"}]}}},"SUBMISSION_ChangeOrderPricingDto":{"type":"object","properties":{"offerId":{"type":"string","description":"The offer the finance account now points at."},"creditLine":{"description":"The recalculated credit line; `effective` already folds in the sticky borrower reduction.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_CreditLineDto"}]},"projectReserveLimit":{"type":"number","nullable":true,"description":"The total project reserve limit (project cost + reserve buffer). Null for D2C (homeowner-initiated) HELOC finance accounts, which have no associated project cost."},"estimatedMonthlyPayment":{"type":"number","nullable":true,"description":"The estimated monthly payment for the new pricing. Null for D2C (homeowner-initiated) HELOC finance accounts, which have no associated project cost."},"autopayEnrolled":{"type":"boolean","description":"Whether the borrower is enrolled in autopay for the new pricing."}},"required":["offerId","creditLine","projectReserveLimit","estimatedMonthlyPayment","autopayEnrolled"]},"SUBMISSION_CreateChangeOrderOutput":{"type":"object","properties":{"financeAccountId":{"type":"string","description":"The human-readable ID of the finance account that was updated."},"pricing":{"description":"The recalculated pricing snapshot produced by the change order.\nOptional for backward compatibility; populated for HELOC change orders.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_ChangeOrderPricingDto"}]}},"required":["financeAccountId"]},"SUBMISSION_OfferChangeItem":{"type":"object","properties":{"type":{"enum":["OFFER"],"type":"string"},"value":{"type":"string","description":"The UUID of the offer to switch to. Must be one of the offers available on the finance account's prequalification."}},"required":["type","value"]},"SUBMISSION_CurrencyMeasurementInputDto":{"type":"object","properties":{"type":{"type":"string","description":"The currency type.","enum":["USD"]},"value":{"type":"number","description":"The currency value.","minimum":0}},"required":["type","value"]},"SUBMISSION_AdjustedCreditLineChangeItem":{"type":"object","properties":{"type":{"enum":["CREDIT_LINE"],"type":"string"},"value":{"description":"The new adjusted line of credit. Must be less than or equal to the approved (verified/max)\nline of credit, and greater than or equal to the account's project reserve limit — or, for\naccounts with no project (D2C), the HELOC category's configured minimum loan amount.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_CurrencyMeasurementInputDto"}]}},"required":["type","value"]},"SUBMISSION_AmountChangeItem":{"type":"object","properties":{"type":{"enum":["AMOUNT"],"type":"string"},"value":{"description":"The new project cost. Must be at or above the global minimum. Must not exceed the current project reserve envelope (projectReserveLimit).","allOf":[{"$ref":"#/components/schemas/SUBMISSION_CurrencyMeasurementInputDto"}]}},"required":["type","value"]},"SUBMISSION_EnrollmentActionItem":{"type":"object","properties":{"type":{"description":"Whether to add or remove this enrollment.","enum":["ADD","REMOVE"],"type":"string"},"value":{"type":"string","description":"The enrollment program being toggled.","enum":["AUTOPAY"]}},"required":["type","value"]},"SUBMISSION_EnrollmentChangeItem":{"type":"object","properties":{"type":{"enum":["ENROLLMENT"],"type":"string"},"value":{"description":"The enrollment actions to apply. Each enrollment program may appear at most\nonce - sending both ADD and REMOVE for the same program is rejected.","type":"array","items":{"$ref":"#/components/schemas/SUBMISSION_EnrollmentActionItem"}}},"required":["type","value"]},"SUBMISSION_CreateChangeOrderInput":{"type":"object","properties":{"changes":{"description":"The list of changes to apply to the finance account. Each item is one change type (offer, credit line, project cost, or enrollment); types may be combined but must not be duplicated.","type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/SUBMISSION_OfferChangeItem"},{"$ref":"#/components/schemas/SUBMISSION_AdjustedCreditLineChangeItem"},{"$ref":"#/components/schemas/SUBMISSION_AmountChangeItem"},{"$ref":"#/components/schemas/SUBMISSION_EnrollmentChangeItem"}]}}},"required":["changes"]},"SUBMISSION_CreateApplicationOutput":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the application."},"lifecycleStatus":{"type":"string","description":"The lifecycle status of the application.","enum":["INITIATED","PREQUALIFIED","SUBMITTED","EXPIRED","CANCELED","NOT_PREQUALIFIED"]},"referenceNumber":{"type":"string","description":"A custom reference number."}},"required":["id","lifecycleStatus"]},"SUBMISSION_PersonalIdentityInputDto":{"type":"object","properties":{"type":{"type":"string","description":"The document type.","enum":["SSN"]},"value":{"type":"string","description":"The unique identification number."}},"required":["type","value"]},"SUBMISSION_PhoneInputDto":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"The phone number."},"type":{"type":"string","description":"The phone number type.","enum":["HOME","MOBILE"]}},"required":["phoneNumber","type"]},"SUBMISSION_MaritalPartnerContactInputDto":{"type":"object","properties":{"email":{"type":"string","description":"The marital partner's email address."},"primaryPhoneNumber":{"description":"The marital partner's primary phone number.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_PhoneInputDto"}]},"secondaryPhoneNumber":{"nullable":true,"description":"The marital partner's secondary phone number.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_PhoneInputDto"}]}},"required":["email","primaryPhoneNumber"]},"SUBMISSION_MaritalPartnerInputDto":{"type":"object","properties":{"firstName":{"type":"string","description":"The marital partner's first name."},"lastName":{"type":"string","description":"The marital partner's last name."},"contact":{"description":"The marital partner's contact information.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_MaritalPartnerContactInputDto"}]}},"required":["firstName","lastName","contact"]},"SUBMISSION_PrimaryApplicantInput":{"type":"object","properties":{"firstName":{"type":"string","description":"The applicant's first name."},"lastName":{"type":"string","description":"The applicant's last name."},"dateOfBirth":{"format":"date-time","type":"string","description":"The applicant's date of birth."},"personalIdentity":{"description":"The applicant's personal identity information.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_PersonalIdentityInputDto"}]},"homeOccupancy":{"type":"string","description":"Occupancy status of the applicant's property.","enum":["PRIMARY","SECONDARY","INVESTMENT","OTHER"]},"homeOwnership":{"type":"string","description":"Ownership status of the applicant's property.","enum":["NOT_OWNED","OWNED_WITH_MORTGAGE","OWNED_FREE_AND_CLEAR"]},"annualIncome":{"description":"Total annual income.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_CurrencyMeasurementInputDto"}]},"email":{"type":"string","description":"The applicant's email address."},"primaryPhoneNumber":{"description":"The applicant's primary phone number.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_PhoneInputDto"}]},"secondaryPhoneNumber":{"nullable":true,"description":"The applicant's secondary phone number.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_PhoneInputDto"}]},"spokenLanguage":{"type":"string","description":"The applicant's spoken language.","enum":["ENGLISH","SPANISH"]},"employmentStatus":{"type":"string","description":"The applicant's employment status.","enum":["EMPLOYED","RETIRED","NOT_EMPLOYED","OTHER"]},"citizenshipStatus":{"type":"string","description":"The applicant's citizenship status.","enum":["US_CITIZEN","LAWFUL_PERMANENT_RESIDENT_ALIEN","OTHER"]},"address":{"description":"The applicant's mailing address.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_Address"}]},"maritalStatus":{"type":"string","description":"The applicant's marital status.","enum":["SINGLE","MARRIED","DIVORCED","SEPARATED","WIDOWED"]},"maritalPartner":{"description":"The applicant's marital partner information.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_MaritalPartnerInputDto"}]}},"required":["firstName","lastName","dateOfBirth","personalIdentity","homeOccupancy","homeOwnership","annualIncome","email","primaryPhoneNumber","spokenLanguage","employmentStatus","citizenshipStatus","address"]},"SUBMISSION_ApplicantInput":{"type":"object","properties":{"firstName":{"type":"string","description":"The applicant's first name."},"lastName":{"type":"string","description":"The applicant's last name."},"dateOfBirth":{"format":"date-time","type":"string","description":"The applicant's date of birth."},"personalIdentity":{"description":"The applicant's personal identity information.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_PersonalIdentityInputDto"}]},"homeOccupancy":{"type":"string","description":"Occupancy status of the applicant's property.","enum":["PRIMARY","SECONDARY","INVESTMENT","OTHER"]},"homeOwnership":{"type":"string","description":"Ownership status of the applicant's property.","enum":["NOT_OWNED","OWNED_WITH_MORTGAGE","OWNED_FREE_AND_CLEAR"]},"annualIncome":{"description":"Total annual income.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_CurrencyMeasurementInputDto"}]},"email":{"type":"string","description":"The applicant's email address."},"primaryPhoneNumber":{"description":"The applicant's primary phone number.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_PhoneInputDto"}]},"secondaryPhoneNumber":{"nullable":true,"description":"The applicant's secondary phone number.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_PhoneInputDto"}]},"spokenLanguage":{"type":"string","description":"The applicant's spoken language.","enum":["ENGLISH","SPANISH"]},"employmentStatus":{"type":"string","description":"The applicant's employment status.","enum":["EMPLOYED","RETIRED","NOT_EMPLOYED","OTHER"]},"citizenshipStatus":{"type":"string","description":"The applicant's citizenship status.","enum":["US_CITIZEN","LAWFUL_PERMANENT_RESIDENT_ALIEN","OTHER"]},"address":{"description":"The applicant's mailing address.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_Address"}]},"maritalStatus":{"type":"string","description":"The applicant's marital status.","enum":["SINGLE","MARRIED","DIVORCED","SEPARATED","WIDOWED"]},"maritalPartner":{"description":"The applicant's marital partner information.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_MaritalPartnerInputDto"}]}},"required":["firstName","lastName","dateOfBirth","personalIdentity","homeOccupancy","homeOwnership","annualIncome","email","primaryPhoneNumber","spokenLanguage","employmentStatus","citizenshipStatus","address"]},"SUBMISSION_SubjectPropertyInputDto":{"type":"object","properties":{"mortgageTotalBalances":{"description":"The total balances of the mortgage.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_CurrencyMeasurementInputDto"}]},"mortgageTotalPayments":{"description":"The total payments of the mortgage.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_CurrencyMeasurementInputDto"}]},"address":{"description":"The address of the property.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_Address"}]},"coordinates":{"description":"The coordinates of the property.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_Coordinates"}]},"isMobileOrManufacturedHome":{"type":"boolean","description":"Whether the property is a mobile or manufactured home."},"lienPosition":{"type":"number","description":"The position of the lien on the property."}},"required":["address"]},"SUBMISSION_PartyInputDto":{"type":"object","properties":{"entityId":{"type":"string","description":"The unique identifier of the entity associated with the party."},"name":{"type":"string","description":"The name of the party."},"hKey":{"type":"string","description":"The hierarchical key of the party. Required for all party types except `SalesPerson`, `Homeowner`, and `CoApplicant`.","example":"`0-3-47B`"},"type":{"type":"string","description":"The type of the party.","enum":["Corporate","Distributor","Integrator","Investor","Manufacturer","ReferralSource","Sales","SalesPerson","Service","Homeowner","Lender","CoApplicant"]},"workspaceId":{"type":"string","description":"The unique identifier of the workspace the party is operating under. Required for the `SalesPerson`, `Homeowner`, and `CoApplicant` party types."}},"required":["entityId","name","type"]},"SUBMISSION_CreateApplicationInput":{"type":"object","properties":{"applicant":{"description":"The primary applicant.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_PrimaryApplicantInput"}]},"coApplicant":{"description":"The secondary applicant.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_ApplicantInput"}]},"subjectProperty":{"description":"The property where the project is being done.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_SubjectPropertyInputDto"}]},"referenceNumber":{"type":"string","description":"A custom reference number external parties use to link the application back to their systems.","maxLength":500},"enrollments":{"type":"array","description":"A list of enrollments.","items":{"type":"string","enum":["AUTOPAY","PAPERLESS_COMMUNICATIONS"]}},"tags":{"description":"Optional user-defined tags to be added to the application.","type":"array","items":{"type":"string"}},"parties":{"description":"A list of custom parties.","type":"array","items":{"$ref":"#/components/schemas/SUBMISSION_PartyInputDto"}},"linkedFinanceAccounts":{"description":"A list of finance accounts linked to the application.","type":"array","items":{"$ref":"#/components/schemas/SUBMISSION_LinkedFinanceAccountDto"}}},"required":["applicant","subjectProperty"]},"SUBMISSION_ApplicationSalesRepDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the sales representative."},"workspaceId":{"type":"string","description":"The workspace ID associated with the sales representative."},"email":{"type":"string","description":"The email address of the sales representative."},"name":{"type":"string","description":"The name of the sales representative."},"organizationId":{"type":"string","description":"The unique identifier of the organization the sales representative belongs to."}},"required":["id","workspaceId","name","organizationId"]},"SUBMISSION_ApplicationsListApplicantDetailDto":{"type":"object","properties":{"firstName":{"type":"string","description":"The first name of the applicant."},"lastName":{"type":"string","description":"The last name of the applicant."},"email":{"type":"string","description":"The email of the applicant."}},"required":["firstName","lastName","email"]},"SUBMISSION_ApplicationsListApplicantDto":{"type":"object","properties":{"type":{"type":"string","description":"The type of applicant.","enum":["APPLICANT","COAPPLICANT"]},"detail":{"description":"The detail of the applicant.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_ApplicationsListApplicantDetailDto"}]}},"required":["type","detail"]},"SUBMISSION_PrequalificationCategoryDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the category."},"code":{"type":"string","description":"The code of the category.","enum":["Solar_TPO","HVAC_LEASE","BATTERY_LEASE","HELOC"]},"name":{"type":"string","description":"The name of the category."}},"required":["id","code","name"]},"SUBMISSION_ApplicationsListPrequalificationDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the prequalification."},"category":{"description":"The category of the prequalification.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_PrequalificationCategoryDto"}]},"expiresAt":{"format":"date-time","type":"string","description":"The date the prequalification expires."},"createdAt":{"format":"date-time","type":"string","description":"The date the prequalification was created."},"status":{"type":"string","description":"The outcome of the prequalification decision.","enum":["APPROVED","APPROVED_WITH_STIPS","DECLINED","PENDING","CANCELED"]}},"required":["id","category","expiresAt","createdAt","status"]},"SUBMISSION_FindApplicationsOutput":{"type":"object","properties":{"organizationId":{"type":"string","description":"The unique identifier of the organization that the application is associated with."},"organizations":{"description":"The organizations associated with the application. Consumers resolve the sales rep's organization\nname by matching `salesRep.organizationId` against this array.","type":"array","items":{"$ref":"#/components/schemas/SUBMISSION_SharedAppOrganizationDto"}},"salesRep":{"description":"The sales representative that submitted the application.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_ApplicationSalesRepDto"}]},"applicants":{"description":"The applicants associated with the application.","type":"array","items":{"$ref":"#/components/schemas/SUBMISSION_ApplicationsListApplicantDto"}},"enrollments":{"type":"array","description":"The enrollments the applicant signed up for.","items":{"type":"string","enum":["AUTOPAY","PAPERLESS_COMMUNICATIONS"]}},"prequalifications":{"description":"Summary of the prequalifications linked to the application.","type":"array","items":{"$ref":"#/components/schemas/SUBMISSION_ApplicationsListPrequalificationDto"}},"lifecycleStatus":{"type":"string","description":"The lifecycle status of the application.","enum":["INITIATED","PREQUALIFIED","SUBMITTED","EXPIRED","CANCELED","NOT_PREQUALIFIED"]},"workflowType":{"type":"string","description":"The submission channel the application was created through — `D2C` for\nhomeowner-initiated flows, `POS` for contractor-initiated flows.","enum":["POS","D2C"]},"referenceNumber":{"type":"string","description":"The reference number of the application."},"createdAt":{"format":"date-time","type":"string","description":"The date the application was created."},"id":{"type":"string","description":"The unique identifier of the entity."}},"required":["organizationId","applicants","enrollments","prequalifications","lifecycleStatus","workflowType","createdAt","id"]},"SUBMISSION_PhoneDto":{"type":"object","properties":{"countryCode":{"type":"string","description":"The country code in E.164 format."},"isoCountryCode":{"type":"string","description":"The country in ISO 3166-1 alpha-2 format."},"phoneNumber":{"type":"string","description":"The phone number."},"type":{"type":"string","description":"The phone number type.","enum":["HOME","MOBILE"]}},"required":["countryCode","isoCountryCode","phoneNumber","type"]},"SUBMISSION_ApplicantMaritalPartnerContactDto":{"type":"object","properties":{"email":{"type":"string","description":"The marital partner's email address."},"primaryPhoneNumber":{"description":"The marital partner's primary phone number.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_PhoneDto"}]},"secondaryPhoneNumber":{"nullable":true,"description":"The marital partner's secondary phone number.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_PhoneDto"}]}},"required":["email","primaryPhoneNumber","secondaryPhoneNumber"]},"SUBMISSION_ApplicantMaritalPartnerDto":{"type":"object","properties":{"firstName":{"type":"string","description":"The marital partner's first name."},"lastName":{"type":"string","description":"The marital partner's last name."},"contact":{"description":"The marital partner's contact information.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_ApplicantMaritalPartnerContactDto"}]}},"required":["firstName","lastName","contact"]},"SUBMISSION_ApplicantDtoV2":{"type":"object","properties":{"firstName":{"type":"string","description":"The applicant's first name."},"lastName":{"type":"string","description":"The applicant's last name."},"dateOfBirth":{"format":"date-time","type":"string","description":"The applicant's date of birth."},"email":{"type":"string","description":"The applicant's email address."},"personalIdentity":{"description":"The applicant's personal identity information.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_PersonalIdentity"}]},"homeOccupancy":{"type":"string","description":"Occupancy status of the applicant's property.","enum":["PRIMARY","SECONDARY","INVESTMENT","OTHER"]},"homeOccupancyDisplayValue":{"type":"string","description":"The display value of the occupancy status of the applicant's property.","enum":["Primary residence","Second or vacation home","Investment property","Doesn't occupy or own"]},"homeOwnership":{"type":"string","description":"Ownership status of the applicant's property.","enum":["NOT_OWNED","OWNED_WITH_MORTGAGE","OWNED_FREE_AND_CLEAR"]},"annualIncome":{"description":"Total annual income, as reported by the applicant.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_CurrencyMeasurement"}]},"verifiedAnnualIncome":{"description":"The applicant's verified annual income from the income verification workflow.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_CurrencyMeasurement"}]},"primaryPhoneNumber":{"description":"The applicant's primary phone number.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_PhoneDto"}]},"secondaryPhoneNumber":{"nullable":true,"description":"The applicant's secondary phone number.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_PhoneDto"}]},"spokenLanguage":{"type":"string","description":"The applicant's spoken language.","enum":["ENGLISH","SPANISH"]},"spokenLanguageDisplayValue":{"type":"string","description":"The display value of the applicant's spoken language.","enum":["English","Spanish"]},"employmentStatus":{"type":"string","description":"The applicant's employment status.","enum":["EMPLOYED","RETIRED","NOT_EMPLOYED","OTHER"]},"citizenshipStatus":{"type":"string","description":"The applicant's citizenship status.","enum":["US_CITIZEN","LAWFUL_PERMANENT_RESIDENT_ALIEN","OTHER"]},"address":{"description":"The applicant's mailing address.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_Address"}]},"electronicConsent":{"type":"boolean","description":"The applicant's consent to have their information stored and processed."},"isPrimary":{"type":"boolean","description":"Indicates whether the applicant is the primary applicant."},"dropped":{"type":"boolean","description":"Indicates whether the applicant has been dropped from the application."},"maritalStatus":{"type":"string","nullable":true,"description":"The applicant's marital status.","enum":["SINGLE","MARRIED","DIVORCED","SEPARATED","WIDOWED"]},"maritalPartner":{"nullable":true,"description":"The applicant's marital partner. Populated when `maritalStatus` is one\nthat requires a partner (e.g. `MARRIED`, `SEPARATED`).","allOf":[{"$ref":"#/components/schemas/SUBMISSION_ApplicantMaritalPartnerDto"}]},"id":{"type":"string","description":"The unique identifier of the entity."}},"required":["firstName","lastName","dateOfBirth","email","personalIdentity","homeOccupancy","homeOwnership","annualIncome","primaryPhoneNumber","secondaryPhoneNumber","spokenLanguage","employmentStatus","citizenshipStatus","address","electronicConsent","isPrimary","dropped","maritalStatus","maritalPartner","id"]},"SUBMISSION_ApplicantFragmentDto":{"type":"object","properties":{"firstName":{"type":"string","description":"The first name of the applicant."},"lastName":{"type":"string","description":"The last name of the applicant."},"email":{"type":"string","description":"The email of the applicant."},"primaryPhoneNumber":{"description":"The primary phone number of the applicant.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_Phone"}]}},"required":["firstName","lastName","email","primaryPhoneNumber"]},"SUBMISSION_ApplicantAssociationDto":{"type":"object","properties":{"type":{"type":"string","description":"The type of applicant.","enum":["APPLICANT","COAPPLICANT"]},"applicant":{"description":"The applicant associated with the application.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_ApplicantDtoV2"}]},"fragment":{"description":"The fragment of the applicant if it has not been fully created yet.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_ApplicantFragmentDto"}]}},"required":["type"]},"SUBMISSION_FindApplicationOutput":{"type":"object","properties":{"organizationId":{"type":"string","description":"The unique identifier of the organization that the application is associated with."},"salesRep":{"description":"The sales representative that submitted the application.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_ApplicationSalesRepDto"}]},"enrollments":{"type":"array","description":"A collection of enrollments the applicant signed up for.","items":{"type":"string","enum":["AUTOPAY","PAPERLESS_COMMUNICATIONS"]}},"subjectProperty":{"description":"The property where the project is being done.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_SubjectProperty"}]},"tags":{"description":"Optional user-defined tags added to the application.","type":"array","items":{"type":"string"}},"referenceNumber":{"type":"string","description":"A custom reference number external parties use to link the application back to their systems."},"applicants":{"description":"The applicants associated with the application.","type":"array","items":{"$ref":"#/components/schemas/SUBMISSION_ApplicantAssociationDto"}},"lifecycleStatus":{"type":"string","description":"The lifecycle status of the application.","enum":["INITIATED","PREQUALIFIED","SUBMITTED","EXPIRED","CANCELED","NOT_PREQUALIFIED"]},"createdAt":{"format":"date-time","type":"string","description":"The date the application was created."},"prequalifications":{"description":"Summary of the prequalifications linked to the application.","type":"array","items":{"$ref":"#/components/schemas/SUBMISSION_ApplicationsListPrequalificationDto"}},"linkedFinanceAccounts":{"description":"Finance accounts linked to this application. For HELOC applications this\nholds the source loan that the application was created from, which\ndownstream consumers use to resolve loan-level data (balances, payment\nschedule, etc.) without having to walk back through the originating flow.\nUndefined until the application has been linked to one or more finance\naccounts.","type":"array","items":{"$ref":"#/components/schemas/SUBMISSION_LinkedFinanceAccountDto"}},"id":{"type":"string","description":"The unique identifier of the entity."}},"required":["organizationId","enrollments","subjectProperty","tags","applicants","createdAt","prequalifications","id"]},"SUBMISSION_CompletedReadinessStepDto":{"type":"object","properties":{"code":{"type":"string","description":"The code identifying the satisfied readiness step.","enum":["CO_APPLICANT_COMPLETED","DISCLOSURE_AGREEMENTS_RECORDED","ELECTRONIC_CONSENT_DISCLOSURE_RECORDED","FINANCIAL_DISCLOSURE_RECORDED","HOME_MORTGAGE_DISCLOSURES_RECORDED","OFFER_SELECTED","PREQUALIFICATION_LINKED","PREQUALIFICATION_NOT_EXPIRED","PREQUALIFICATION_APPROVED"]},"scope":{"type":"string","description":"The entity scope this step's invariant belongs to.","enum":["APPLICATION","PREQUALIFICATION"]}},"required":["code","scope"]},"SUBMISSION_PendingReadinessStepDto":{"type":"object","properties":{"code":{"type":"string","description":"The code identifying the unsatisfied readiness step.","enum":["CO_APPLICANT_COMPLETED","DISCLOSURE_AGREEMENTS_RECORDED","ELECTRONIC_CONSENT_DISCLOSURE_RECORDED","FINANCIAL_DISCLOSURE_RECORDED","HOME_MORTGAGE_DISCLOSURES_RECORDED","OFFER_SELECTED","PREQUALIFICATION_LINKED","PREQUALIFICATION_NOT_EXPIRED","PREQUALIFICATION_APPROVED"]},"scope":{"type":"string","description":"The entity scope this step's invariant belongs to.","enum":["APPLICATION","PREQUALIFICATION"]},"audience":{"type":"string","nullable":true,"description":"The audience this step's invariant corresponds to. `null` for\napplication-wide invariants with no per-applicant dimension.","enum":["APPLICANT","COAPPLICANT"]},"description":{"type":"string","description":"A human-readable explanation of why the step is unsatisfied."}},"required":["code","scope","audience","description"]},"SUBMISSION_GetApplicationReadinessOutput":{"type":"object","properties":{"applicationId":{"type":"string","description":"The unique identifier of the application this readiness output\ndescribes."},"prequalificationId":{"type":"string","nullable":true,"description":"The id of the prequalification the readiness output is scoped to,\nechoed back from the request's `?prequalificationId=` query\nparameter. Set to null when the caller did not scope to a\nprequalification, in which case the output covers only\napplication-scoped invariants."},"status":{"type":"string","description":"The lifecycle status of the application at the time the readiness\nwas computed.","enum":["INITIATED","PREQUALIFIED","SUBMITTED","EXPIRED","CANCELED","NOT_PREQUALIFIED"]},"prequalificationStatus":{"type":"string","nullable":true,"description":"The decision status of the scoped prequalification, echoed when the\ncaller supplied `?prequalificationId=`. Null when the readiness check\nis application-scoped only.","enum":["APPROVED","APPROVED_WITH_STIPS","DECLINED","PENDING","CANCELED"]},"readyForSubmission":{"type":"boolean","description":"Whether the application is currently in shape to be submitted.\n\n`true` only when every applicable readiness step is satisfied and\nthe lifecycle status admits submission. `false` for all terminal\nlifecycle states (`SUBMITTED`, `EXPIRED`)."},"completedSteps":{"description":"The readiness steps that the application currently satisfies.\nAlways empty for terminal lifecycle states.","type":"array","items":{"$ref":"#/components/schemas/SUBMISSION_CompletedReadinessStepDto"}},"pendingSteps":{"description":"The readiness steps that the application does not currently\nsatisfy. Always empty for terminal lifecycle states.","type":"array","items":{"$ref":"#/components/schemas/SUBMISSION_PendingReadinessStepDto"}}},"required":["applicationId","prequalificationId","status","prequalificationStatus","readyForSubmission","completedSteps","pendingSteps"]},"SUBMISSION_ShareApplicationInput":{"type":"object","properties":{"audience":{"type":"string","description":"The applicant role the share is intended for. The corresponding applicant\nmust already exist on the application; otherwise the entire request is\nrejected and no shares are created.","enum":["APPLICANT","COAPPLICANT"]},"deliveryChannel":{"type":"string","description":"The channel through which the share's access link will be delivered to the\naudience.","enum":["EMAIL","SMS"]}},"required":["audience","deliveryChannel"]},"SUBMISSION_ShareApplicationOutput":{"type":"object","properties":{"shareId":{"type":"string","description":"The server-generated unique identifier of the share."},"audience":{"type":"string","description":"The applicant role this share targets.","enum":["APPLICANT","COAPPLICANT"]},"communicationStatus":{"type":"string","description":"The communication status of the share, indicating where the share is in\nits delivery lifecycle.","enum":["SENT"]},"deliveryChannel":{"type":"string","description":"The channel through which the share's access link was delivered.","enum":["EMAIL","SMS"]},"deliveryAddress":{"type":"string","description":"The address the share's access link was delivered to. Format depends on\n`deliveryChannel`: an RFC 5321 email address for `EMAIL`, an E.164 phone\nnumber for `SMS`."},"expiresAt":{"format":"date-time","type":"string","description":"The date and time at which the share's access link expires and stops\ngranting access to the application."}},"required":["shareId","audience","communicationStatus","deliveryChannel","deliveryAddress","expiresAt"]},"SUBMISSION_SignedDisclosureInput":{"type":"object","properties":{"applicantRole":{"type":"string","description":"The applicant role agreeing to the disclosure. The corresponding\napplicant must already exist on the application; otherwise the entire\nrequest is rejected and no signed disclosures are recorded.","enum":["APPLICANT","COAPPLICANT"]},"disclosureToken":{"type":"string","description":"The encoded disclosure JWT carrying the disclosure identifier the\napplicant agreed to. Validated against `DisclosureType.Financial`."},"signature":{"type":"string","description":"The applicant signature image, encoded as a base64 PNG data URI.\nPersisted to S3 at a deterministic key — re-submitting a signed\ndisclosure with the same `(applicantRole, disclosureId)` overwrites\nthe prior signature image at the same S3 location."}},"required":["applicantRole","disclosureToken","signature"]},"SUBMISSION_SignedDisclosureOutput":{"type":"object","properties":{"applicantRole":{"type":"string","description":"The applicant role that agreed to the disclosure.","enum":["APPLICANT","COAPPLICANT"]},"disclosureId":{"type":"string","description":"The resolved unique identifier of the disclosure the applicant agreed to."},"agreementDate":{"format":"date-time","type":"string","description":"The date and time the agreement was recorded by this PUT."}},"required":["applicantRole","disclosureId","agreementDate"]},"SUBMISSION_CreateCoApplicantOutput":{"type":"object","properties":{"shares":{"description":"The shares created alongside the coapplicant, returned in the same order as\nthe requested `shareDeliveryChannels` — the share at index N corresponds to\nthe channel at index N. Absent when no `shareDeliveryChannels` were\nrequested or an empty array was provided.","type":"array","items":{"$ref":"#/components/schemas/SUBMISSION_ShareApplicationOutput"}}}},"SUBMISSION_CreateCoApplicantInput":{"type":"object","properties":{"firstName":{"type":"string","description":"The coapplicant's first name."},"lastName":{"type":"string","description":"The coapplicant's last name."},"email":{"type":"string","description":"The coapplicant's email address."},"primaryPhoneNumber":{"description":"The coapplicant's phone number.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_PhoneInputDto"}]},"shareDeliveryChannels":{"type":"array","description":"Delivery channels for the application share(s) created alongside the new\ncoapplicant. Exactly one share is created per channel — for example,\n`[Email, SMS]` creates two shares targeting the coapplicant, delivered via\nemail and SMS respectively. Channels must be unique. When omitted or empty,\nthe coapplicant is created without any shares.","items":{"type":"string","enum":["EMAIL","SMS"]}}},"required":["firstName","lastName","email","primaryPhoneNumber"]},"SUBMISSION_MarginsInputDto":{"type":"object","properties":{"installment":{"type":"number","description":"The margin rate applied to the installment portion of the loan."},"revolving":{"type":"number","description":"The margin rate applied to the revolving portion of the loan."}},"required":["installment","revolving"]},"SUBMISSION_DealerFeeInputDto":{"type":"object","properties":{"percent":{"type":"number","description":"The dealer fee expressed as a percentage of project cost (e.g. 5 for 5%)."}},"required":["percent"]},"SUBMISSION_PrequalificationOfferInputDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the offer."},"estimatedMonthlyPaymentWithAutopay":{"type":"number","description":"The estimated monthly payment calculated using the autopay interest rate.","minimum":1},"estimatedMonthlyPaymentWithoutAutopay":{"type":"number","description":"The estimated monthly payment calculated without the autopay discount.","minimum":1},"ratesWithAutopay":{"description":"The rate information for the offer with autopay.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_PrequalificationOfferRateDto"}]},"ratesWithoutAutopay":{"description":"The rate information for the offer without autopay.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_PrequalificationOfferRateDto"}]},"term":{"type":"number","description":"The term information for the offer."},"maxAmount":{"type":"number","description":"The maximum amount for the offer."},"featured":{"type":"boolean","description":"Indicates whether this offer is featured."},"margins":{"description":"The per-product margin rates of the offer, when supplied by underwriting.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_MarginsInputDto"}]},"dealerFee":{"description":"The dealer fee for the offer, when supplied by underwriting.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_DealerFeeInputDto"}]}},"required":["id","estimatedMonthlyPaymentWithAutopay","estimatedMonthlyPaymentWithoutAutopay","ratesWithAutopay","ratesWithoutAutopay","term","maxAmount","featured"]},"SUBMISSION_PrequalificationInput":{"type":"object","properties":{"projectCost":{"type":"number","description":"The cost of the project.","minimum":1},"category":{"description":"The category of the project.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_CategoryDto"}]},"offers":{"description":"The list of pre-qualified offers.","type":"array","items":{"$ref":"#/components/schemas/SUBMISSION_PrequalificationOfferInputDto"}},"status":{"type":"string","description":"The outcome of the prequalification decision asserted by the caller.\nDefaults to `APPROVED` when omitted.","enum":["APPROVED","APPROVED_WITH_STIPS","DECLINED","PENDING","CANCELED"]}},"required":["projectCost","category","offers"]},"SUBMISSION_PrequalifyExplicitApplicationInput":{"type":"object","properties":{"prequalifications":{"description":"Prequalified financing options for the application.","type":"array","items":{"$ref":"#/components/schemas/SUBMISSION_PrequalificationInput"}}},"required":["prequalifications"]},"SUBMISSION_PrequalifyImplicitApplicationInput":{"type":"object","properties":{}},"SUBMISSION_NumberRangeDto":{"type":"object","properties":{"minimum":{"type":"number","description":"The inclusive lower bound of the range."},"maximum":{"type":"number","description":"The inclusive upper bound of the range."}},"required":["minimum","maximum"]},"SUBMISSION_PrequalificationOfferOutputDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the offer."},"estimatedMonthlyPaymentWithAutopay":{"type":"number","nullable":true,"description":"The estimated monthly payment calculated using the autopay interest rate. Null for D2C (homeowner-initiated) HELOC prequalifications, which have no project cost to compute payments against."},"estimatedMonthlyPaymentWithoutAutopay":{"type":"number","nullable":true,"description":"The estimated monthly payment calculated without the autopay discount. Null for D2C (homeowner-initiated) HELOC prequalifications, which have no project cost to compute payments against."},"ratesWithAutopay":{"description":"The rate information for the offer with autopay.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_PrequalificationOfferRateDto"}]},"ratesWithoutAutopay":{"description":"The rate information for the offer without autopay.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_PrequalificationOfferRateDto"}]},"term":{"type":"number","description":"The term of the offer in years."},"maxAmount":{"type":"number","description":"The maximum amount for the offer."},"featured":{"type":"boolean","description":"Indicates whether this offer is featured."},"margins":{"description":"The per-product margin rates of the offer, when supplied by underwriting.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_MarginsDto"}]},"dealerFee":{"description":"The dealer fee for the offer, when supplied by underwriting.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_DealerFeeDto"}]},"projectCostLimits":{"description":"The project cost limits for the offer.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_NumberRangeDto"}]}},"required":["id","estimatedMonthlyPaymentWithAutopay","estimatedMonthlyPaymentWithoutAutopay","ratesWithAutopay","ratesWithoutAutopay","term","maxAmount","featured","projectCostLimits"]},"SUBMISSION_PrequalifyApplicationOutput":{"type":"object","properties":{"projectCost":{"type":"number","nullable":true,"description":"The project cost applied to the prequalification. Null for D2C (homeowner-initiated) HELOC finance accounts, which have no associated project cost."},"status":{"type":"string","description":"The outcome of the prequalification decision. For the implicit path this is\nmapped from the FIREngine response; for the explicit path it is supplied by\nthe caller on each prequalification input and defaults to\n`APPROVED` when omitted.","enum":["APPROVED","APPROVED_WITH_STIPS","DECLINED","PENDING","CANCELED"]},"maxLoanAmount":{"type":"string","description":"The maximum loan amount returned by the underwriting engine, as a string.\nOnly populated on the implicit path."},"reason":{"type":"string","description":"The reason provided by the underwriting engine for the decision. Only\npopulated on the implicit path."},"availableOffers":{"description":"The offers available under this prequalification.","type":"array","items":{"$ref":"#/components/schemas/SUBMISSION_PrequalificationOfferOutputDto"}},"limitedUseToken":{"type":"string","description":"A redeem token whose scope is narrowed to this prequalification and its\nowning application. The token is not itself a JWT and cannot be used as a\nBearer credential — clients must exchange it with the Directory service\nfor a session JWT, which is then used in the `Authorization` header on\nsubsequent requests that advance this prequalification (e.g. PATCH to\nupdate the selected offer, POST to submit the application)."},"projectReserveLimit":{"type":"number","nullable":true,"description":"The total project reserve limit for this prequalification. Null when there is no project cost (D2C/homeowner-initiated HELOC prequalifications) or no featured offer among the available offers."},"mortgageOfficer":{"description":"The mortgage officer assigned to this prequalification, if any.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_MortgageOfficerOutputDto"}]},"expiresAt":{"format":"date-time","type":"string","description":"The date the prequalification expires."},"id":{"type":"string","description":"The unique identifier of the entity."}},"required":["projectCost","status","availableOffers","limitedUseToken","projectReserveLimit","expiresAt","id"]},"SUBMISSION_UpdatePrequalificationInputV2":{"type":"object","properties":{"selectedOfferId":{"type":"string","description":"The unique identifier of the selected offer."},"autopayEnrolled":{"type":"boolean","description":"Indicates whether the applicant opted into autopay."},"requestedCreditLine":{"type":"number","description":"The credit line the borrower requested at the prequalification stage.\nBecomes the pricing record's `creditLine.adjusted` at submission.\nBounds (category minimum and the selected offer's maximum) are enforced by the service.","minimum":1},"projectCost":{"type":"number","description":"The cost of the project.","minimum":1},"status":{"type":"string","description":"The outcome of the prequalification decision asserted by the caller.\nDefaults to `APPROVED` when omitted.","enum":["APPROVED","APPROVED_WITH_STIPS","DECLINED","PENDING","CANCELED"]}}},"SUBMISSION_PrequalificationTokenOutput":{"type":"object","properties":{"limitedUseToken":{"type":"string","description":"A redeem token whose scope is narrowed to a prequalification and its\nowning application. The token is not itself a JWT and cannot be used as a\nBearer credential — clients must exchange it with the Directory service\nfor a session JWT."}},"required":["limitedUseToken"]},"SUBMISSION_ApplicationApplicantOutput":{"type":"object","properties":{"role":{"type":"string","description":"The applicant's role on the application.","enum":["APPLICANT","COAPPLICANT"]},"firstName":{"type":"string","description":"The applicant's first name."},"lastName":{"type":"string","description":"The applicant's last name."},"email":{"type":"string","description":"The applicant's email address."},"dropped":{"type":"boolean","description":"Whether the applicant was dropped from the application — either because\nunderwriting excluded them so the other applicant could proceed, or\nbecause the application as a whole was Declined."}},"required":["role","firstName","lastName","email","dropped"]},"SUBMISSION_SubmitApplicationOutput":{"type":"object","properties":{"financeAccountId":{"type":"string","description":"The human-readable identifier of the finance account.","example":"12-34-567890"},"financeType":{"type":"string","description":"The finance type.","enum":["loan","lease","ppa","ppav","e-heloc"]},"offerId":{"type":"string","description":"The unique identifier of the offer."},"categoryCode":{"type":"string","description":"The code of the offer category.","enum":["Solar_TPO","HVAC_LEASE","BATTERY_LEASE","HELOC"]},"categoryId":{"type":"string","description":"The unique identifier of the offer category."},"createdAt":{"format":"date-time","type":"string","description":"The date and time when the finance account was created."},"expiresAt":{"format":"date-time","type":"string","description":"The date and time when credit expires."},"tags":{"description":"Optional user-defined tags added to the application.","type":"array","items":{"type":"string"}},"status":{"type":"string","description":"The status of the application.","enum":["APPROVED","APPROVED_WITH_STIPS","DECLINED","PENDING","CANCELED"]},"reason":{"type":"string","description":"The reason the application was declined or approved with stips."},"type":{"type":"string","description":"The decision type.","enum":["SINGLE","COMBINED","PRIMARY","SECONDARY"]},"applicants":{"description":"The applicants on the application, projected to the fields needed by the\ndecision screen.","type":"array","items":{"$ref":"#/components/schemas/SUBMISSION_ApplicationApplicantOutput"}},"cases":{"description":"Borrower-facing cases (e.g. document upload stips) that must be resolved\nbefore the account can progress.","type":"array","items":{"$ref":"#/components/schemas/SUBMISSION_ApplicationPendingCaseOutput"}},"borrowerActionableUrl":{"type":"string","description":"A URL the borrower can visit to take action on outstanding cases."},"decisionExplanation":{"description":"User-friendly explanation of the underwriting decision, including the list\nof reasons. Populated for non-Approved outcomes.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_DecisionExplanation"}]},"creditLine":{"description":"The credit line approved for the HELOC at submission time.\nPopulated for HELOC submissions only.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_CreditLineDto"}]},"availableOffers":{"description":"The offers available under the prequalification.\nPopulated for HELOC submissions only.","type":"array","items":{"$ref":"#/components/schemas/SUBMISSION_PrequalificationOfferOutputDto"}},"projectReserveLimit":{"type":"number","nullable":true,"description":"The total project reserve limit (project cost + reserve buffer). Populated for HELOC\nsubmissions only. Null for D2C (homeowner-initiated) HELOC finance accounts, which have no\nassociated project cost."},"estimatedMonthlyPayment":{"type":"number","nullable":true,"description":"The estimated monthly payment based on the selected offer and autopay enrollment. Populated for\nHELOC submissions only. Null for D2C (homeowner-initiated) HELOC finance accounts, which have\nno associated project cost."},"autopayEnrolled":{"type":"boolean","description":"Whether the borrower enrolled in autopay at submission time.\nPopulated for HELOC submissions only."}},"required":["financeAccountId","financeType","offerId","categoryCode","categoryId","createdAt","expiresAt","tags","status","reason","type","applicants"]},"SUBMISSION_SubmitApplicationInput":{"type":"object","properties":{"prequalificationId":{"type":"string","description":"The ID of the prequalification to use for decisioning. This holds the offer and category information."}},"required":["prequalificationId"]},"SUBMISSION_UpdateSubjectPropertyFieldsOutput":{"type":"object","properties":{"legalDescription":{"type":"string","nullable":true,"description":"The full legal description of the property, or `null` if not set."}},"required":["legalDescription"]},"SUBMISSION_UpdateSubjectPropertyFieldsInput":{"type":"object","properties":{"legalDescription":{"type":"string","nullable":true,"description":"The full legal description of the property. `null` clears the value;\nwhen provided, it is trimmed and must not be empty or whitespace-only.","maxLength":50000}}},"SUBMISSION_PrequalificationOutputV2":{"type":"object","properties":{"projectCost":{"type":"number","nullable":true,"description":"The project cost applied to the prequalification. Null for D2C (homeowner-initiated) HELOC finance accounts, which have no associated project cost."},"requestedCreditLine":{"type":"number","nullable":true,"description":"The credit line the borrower requested at the prequalification stage.\nBecomes the pricing record's `creditLine.adjusted` at submission. Null when\nnone was requested."},"selectedOfferId":{"type":"string","description":"The unique identifier of the selected offer."},"category":{"description":"The category associated with the prequalification.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_PrequalificationCategoryDto"}]},"availableOffers":{"description":"The offers available under this prequalification.","type":"array","items":{"$ref":"#/components/schemas/SUBMISSION_PrequalificationOfferOutputDto"}},"autopayEnrolled":{"type":"boolean","description":"Indicates whether the applicant opted into autopay."},"projectReserveLimit":{"type":"number","nullable":true,"description":"The total project reserve limit for this prequalification. Null when there is no project cost (D2C/homeowner-initiated HELOC prequalifications) or no featured offer among the available offers."},"createdAt":{"format":"date-time","type":"string","description":"The date and time when the prequalification was created."},"expiresAt":{"format":"date-time","type":"string","description":"The date the prequalification expires."},"status":{"type":"string","description":"The outcome of the prequalification decision.","enum":["APPROVED","APPROVED_WITH_STIPS","DECLINED","PENDING","CANCELED"]},"mortgageOfficer":{"description":"The mortgage officer assigned to this prequalification, if any.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_MortgageOfficerOutputDto"}]},"id":{"type":"string","description":"The unique identifier of the entity."}},"required":["projectCost","requestedCreditLine","category","availableOffers","autopayEnrolled","projectReserveLimit","createdAt","expiresAt","status","id"]},"SUBMISSION_OfferDisclaimersDto":{"type":"object","properties":{"offerId":{"type":"object","description":"The unique identifier of the offer these disclaimers describe.","format":"uuid"},"estimatedPaymentConversion":{"description":"Estimated-payment disclaimer paragraphs. Empty when the prequalification\nhas no project cost.","type":"array","items":{"type":"string"}},"variableRate":{"description":"Variable-rate disclaimer paragraphs.","type":"array","items":{"type":"string"}}},"required":["offerId","estimatedPaymentConversion","variableRate"]},"SUBMISSION_PrequalificationDisclaimersOutputDto":{"type":"object","properties":{"offers":{"description":"Disclaimers for each available offer.","type":"array","items":{"$ref":"#/components/schemas/SUBMISSION_OfferDisclaimersDto"}}},"required":["offers"]},"SUBMISSION_PrequalificationOfferEstimateOutputDto":{"type":"object","properties":{"estimatedMonthlyPaymentWithAutopay":{"type":"number","nullable":true,"description":"The estimated monthly payment calculated using the autopay interest rate."},"estimatedMonthlyPaymentWithoutAutopay":{"type":"number","nullable":true,"description":"The estimated monthly payment calculated without the autopay discount."},"id":{"type":"string","description":"The unique identifier of the offer."},"ratesWithAutopay":{"description":"The rate information for the offer with autopay.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_PrequalificationOfferRateDto"}]},"ratesWithoutAutopay":{"description":"The rate information for the offer without autopay.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_PrequalificationOfferRateDto"}]},"term":{"type":"number","description":"The term of the offer in years."},"maxAmount":{"type":"number","description":"The maximum amount for the offer."},"featured":{"type":"boolean","description":"Indicates whether this offer is featured."},"margins":{"description":"The per-product margin rates of the offer, when supplied by underwriting.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_MarginsDto"}]},"dealerFee":{"description":"The dealer fee for the offer, when supplied by underwriting.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_DealerFeeDto"}]},"projectCostLimits":{"description":"The project cost limits for the offer.","allOf":[{"$ref":"#/components/schemas/SUBMISSION_NumberRangeDto"}]}},"required":["estimatedMonthlyPaymentWithAutopay","estimatedMonthlyPaymentWithoutAutopay","id","ratesWithAutopay","ratesWithoutAutopay","term","maxAmount","featured","projectCostLimits"]},"SUBMISSION_PrequalificationPricingEstimatesOutput":{"type":"object","properties":{"projectReserveLimit":{"type":"number","description":"The estimated project reserve limit for the prequalification."},"offers":{"description":"The estimated offers for the prequalification.","type":"array","items":{"$ref":"#/components/schemas/SUBMISSION_PrequalificationOfferEstimateOutputDto"}}},"required":["projectReserveLimit","offers"]},"LSS_v2_ResponseViewModelOfIReadOnlyCollectionOfSearchableAssetAndMeta":{"type":"object","additionalProperties":false,"properties":{"payload":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/LSS_v2_SearchableAsset"}},"meta":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/LSS_v2_Meta"}]}}},"LSS_v2_SearchableAsset":{"type":"object","additionalProperties":false,"properties":{"title":{"type":"string","nullable":true},"financeAccountId":{"type":"string","nullable":true},"financeAccountGuid":{"type":"string","nullable":true},"financeType":{"type":"string","nullable":true},"referenceId":{"type":"string","nullable":true},"tenantId":{"type":"string","format":"guid","nullable":true},"monthlyPayment":{"type":"number","format":"decimal","nullable":true},"product":{"type":"string","nullable":true},"projectType":{"type":"string","nullable":true},"status":{"type":"string","nullable":true},"statusDisplayValue":{"type":"string","nullable":true},"term":{"type":"integer","format":"int32","nullable":true},"propertyLocation":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/LSS_v2_Address"}]},"dateCreated":{"type":"string","format":"date-time","nullable":true},"dateUpdated":{"type":"string","format":"date-time","nullable":true},"dateIndexed":{"type":"string","format":"date-time","nullable":true},"expirationDate":{"type":"string","format":"date-time","nullable":true},"applicants":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/LSS_v2_Applicant"}},"salesPerson":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/LSS_v2_Person"}},"organizationId":{"type":"string","nullable":true},"systemDesignId":{"type":"string","nullable":true},"savingsScheduleId":{"type":"string","nullable":true},"utilityInformationId":{"type":"string","nullable":true},"calculatedSystemPricing":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/LSS_v2_Pricing"}]},"activeAgreementPricing":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/LSS_v2_Pricing"}]},"offerId":{"type":"string","nullable":true},"projectId":{"type":"string","nullable":true},"parties":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/LSS_v2_Party"}},"milestones":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/LSS_v2_MilestoneObject"}},"fundedMilestones":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/LSS_v2_MilestoneObject"}},"orders":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/LSS_v2_Order"}},"cases":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/LSS_v2_CaseSummary"}]},"noOrdersCreated":{"type":"boolean","nullable":true},"tags":{"type":"array","nullable":true,"items":{"type":"string"}},"rate":{"type":"number","format":"float","nullable":true},"decomposedHierarchies":{"type":"array","nullable":true,"items":{"type":"string"}},"creditDecisionType":{"type":"string","nullable":true},"enrollments":{"type":"array","nullable":true,"items":{"type":"string"}},"agent":{"type":"string","nullable":true},"waitingOn":{"type":"array","nullable":true,"items":{"type":"string"}},"lastCompletedMilestone":{"type":"string","nullable":true},"numberOfApplicants":{"type":"integer","format":"int32","nullable":true},"loanId":{"type":"string","nullable":true},"loanGuid":{"type":"string","nullable":true},"language":{"type":"string","nullable":true},"isAutoPay":{"type":"boolean","nullable":true},"loanVersion":{"type":"string","nullable":true},"loanAmount":{"type":"number","format":"double","nullable":true},"category":{"type":"string","nullable":true},"categoryName":{"type":"string","nullable":true},"subCategories":{"type":"array","nullable":true,"items":{"type":"string"}},"stage":{"type":"string","nullable":true},"interestRate":{"type":"number","format":"double","nullable":true},"creditExpirationDate":{"type":"string","format":"date-time","nullable":true},"people":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/LSS_v2_Person"}},"legacyDealer":{"type":"string","nullable":true},"hasPurchaseOrder":{"type":"boolean","nullable":true},"purchaseOrderStatus":{"type":"string","nullable":true},"includeNotCreatedOrders":{"type":"boolean","nullable":true},"linkedFinanceAccount":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/LSS_v2_LinkedFinanceAccount"}]},"creditExtension":{"type":"string","nullable":true},"projects":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/LSS_v2_Project"}}}},"LSS_v2_Address":{"type":"object","additionalProperties":false,"properties":{"completeAddress":{"type":"string","nullable":true},"locality":{"type":"string","nullable":true},"adminArea":{"type":"string","nullable":true},"postalCode":{"type":"string","nullable":true},"country":{"type":"string","nullable":true},"adminArea1":{"type":"string","nullable":true},"adminArea2":{"type":"string","nullable":true}}},"LSS_v2_Applicant":{"type":"object","additionalProperties":false,"properties":{"firstName":{"type":"string","nullable":true},"lastName":{"type":"string","nullable":true},"socialSecurity":{"type":"string","nullable":true},"emailAddress":{"type":"string","nullable":true},"phoneNumber1":{"type":"string","nullable":true},"phoneNumber1Type":{"type":"string","nullable":true},"completeAddress":{"type":"string","nullable":true},"dateOfBirth":{"type":"string","format":"date-time","nullable":true},"locality":{"type":"string","nullable":true},"adminArea":{"type":"string","nullable":true},"postalCode":{"type":"string","nullable":true},"country":{"type":"string","nullable":true},"language":{"type":"string","nullable":true},"isPrimary":{"type":"boolean","nullable":true},"isDropped":{"type":"boolean","nullable":true},"annualIncome":{"type":"number","format":"float","nullable":true},"annualIncomeType":{"type":"string","nullable":true},"phoneNumber":{"type":"string","nullable":true},"adminArea1":{"type":"string","nullable":true},"adminArea2":{"type":"string","nullable":true}}},"LSS_v2_Person":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","nullable":true},"emailAddress":{"type":"string","nullable":true},"phone":{"type":"string","nullable":true},"type":{"type":"string","nullable":true},"userId":{"type":"string","format":"guid","nullable":true}}},"LSS_v2_Pricing":{"type":"object","additionalProperties":false,"properties":{"pricePerUnitType":{"type":"string","nullable":true},"pricePerUnitValue":{"type":"number","format":"float","nullable":true},"purchasePriceType":{"type":"string","nullable":true},"purchasePriceValue":{"type":"number","format":"float","nullable":true},"estimatedFirstYearMonthlyPaymentType":{"type":"string","nullable":true},"estimatedFirstYearMonthlyPaymentValue":{"type":"number","format":"float","nullable":true},"powerPurchaseRateType":{"type":"string","nullable":true},"powerPurchaseRateValue":{"type":"number","format":"float","nullable":true}}},"LSS_v2_Party":{"type":"object","additionalProperties":false,"properties":{"type":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"hKey":{"type":"string","nullable":true},"isPrimary":{"type":"boolean","nullable":true},"isDisabled":{"type":"boolean"},"workspaceId":{"type":"string","format":"guid","nullable":true},"organizationId":{"type":"string","format":"guid","nullable":true},"entityId":{"type":"string","format":"guid","nullable":true}}},"LSS_v2_MilestoneObject":{"type":"object","additionalProperties":false,"properties":{"date":{"type":"string","format":"date-time","nullable":true},"milestone":{"type":"string","nullable":true}}},"LSS_v2_Order":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","format":"guid"},"amount":{"type":"number","format":"decimal","nullable":true},"payee":{"type":"string","nullable":true},"payeeType":{"type":"string","nullable":true},"status":{"type":"string","nullable":true}}},"LSS_v2_CaseSummary":{"type":"object","additionalProperties":false,"properties":{"frozenCases":{"type":"integer","format":"int32","nullable":true},"rejectedCases":{"type":"integer","format":"int32","nullable":true},"openCases":{"type":"integer","format":"int32","nullable":true},"closedCases":{"type":"integer","format":"int32","nullable":true},"openGLCases":{"type":"integer","format":"int32","nullable":true},"totalCases":{"type":"integer","format":"int32","nullable":true},"openBorrowerCases":{"type":"integer","format":"int32","nullable":true},"dateCreated":{"type":"string","format":"date-time","nullable":true},"dateUpdated":{"type":"string","format":"date-time","nullable":true}}},"LSS_v2_LinkedFinanceAccount":{"type":"object","additionalProperties":false,"properties":{"financeAccountId":{"type":"string","nullable":true},"linkType":{"type":"string","nullable":true}}},"LSS_v2_Project":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","nullable":true},"type":{"type":"string","nullable":true}}},"LSS_v2_Meta":{"type":"object","additionalProperties":false,"properties":{"cursor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/LSS_v2_Cursor"}]},"pageNumber":{"type":"integer","format":"int32","nullable":true},"itemsPerPage":{"type":"integer","format":"int32","nullable":true},"total":{"type":"integer","format":"int64","nullable":true}}},"LSS_v2_Cursor":{"type":"object","additionalProperties":false,"properties":{"next":{"type":"string","nullable":true},"size":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"}}},"LSS_v2_ResponseViewModelOfIReadOnlyListOfNamedFilterCount":{"type":"object","additionalProperties":false,"properties":{"payload":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/LSS_v2_NamedFilterCount"}}}},"LSS_v2_NamedFilterCount":{"type":"object","additionalProperties":false,"required":["name"],"properties":{"name":{"type":"string"},"count":{"type":"integer","format":"int64"}}},"LSS_v2_LoanCountsQuery":{"type":"object","additionalProperties":false,"required":["filters"],"properties":{"filters":{"type":"array","items":{"$ref":"#/components/schemas/LSS_v2_NamedFilter"}}}},"LSS_v2_NamedFilter":{"type":"object","additionalProperties":false,"required":["name","parameters"],"properties":{"name":{"type":"string"},"parameters":{"$ref":"#/components/schemas/LSS_v2_LoanSearchParameters"}}},"LSS_v2_LoanSearchParameters":{"allOf":[{"$ref":"#/components/schemas/LSS_v2_SearchUserExtension"},{"type":"object","additionalProperties":false,"properties":{"wellKnownFilter":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/LSS_v2_WellKnownFilters"}]},"tile":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/LSS_v2_PipelineActionTile"}]},"title":{"type":"string","nullable":true},"numberOfApplicants":{"type":"integer","nullable":true},"loanId":{"type":"array","nullable":true,"items":{"type":"string"}},"language":{"type":"array","nullable":true,"items":{"type":"string"}},"rateAndTerms":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/LSS_v2_RateTermParameters"}},"isAutoPay":{"type":"boolean","nullable":true},"tenantId":{"type":"string","format":"guid"},"loanVersion":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/LSS_v2_NumericRange"}]},"loanAmount":{"type":"number","format":"double","nullable":true},"loanAmountRange":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/LSS_v2_NumericRange"}]},"category":{"type":"array","nullable":true,"items":{"type":"string"}},"referenceId":{"type":"string","nullable":true},"subCategories":{"type":"array","nullable":true,"items":{"type":"string"}},"status":{"type":"array","nullable":true,"items":{"type":"string"}},"tags":{"type":"array","nullable":true,"items":{"type":"string"}},"stage":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/LSS_v2_StageFilter"}]},"interestRate":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/LSS_v2_NumericRange"}]},"term":{"type":"array","nullable":true,"items":{"type":"integer","format":"int32"}},"propertyLocation":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/LSS_v2_AddressParameters"}]},"dateCreated":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/LSS_v2_DateRange"}]},"dateUpdated":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/LSS_v2_DateRange"}]},"creditDecisionType":{"type":"string","nullable":true},"creditExpirationDate":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/LSS_v2_DateRange"}]},"applicant":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/LSS_v2_ApplicantParameters"}]},"person":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/LSS_v2_PersonParameters"}]},"parties":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/LSS_v2_PartyParameters"}},"hierarchies":{"type":"array","nullable":true,"items":{"type":"string"}},"milestone":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/LSS_v2_MilestoneParameters"}]},"sort":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/LSS_v2_SortField"}]},"fields":{"type":"array","nullable":true,"items":{"type":"string"}},"agent":{"type":"string","nullable":true},"legacyDealer":{"type":"string","nullable":true},"cases":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/LSS_v2_CasesSearchParameters"}]},"orders":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/LSS_v2_Orders"}]},"includeExpiredLoans":{"type":"boolean","nullable":true}}}]},"LSS_v2_WellKnownFilters":{"type":"string","description":"","x-enumNames":["None","DocumentsNotSent","DocumentsNotSigned","ProjectInfoNotComplete","ContractNotUploaded","LoanDetailsNotVerified","NotInstalled","NotFunded","ProjectCertificateNotSigned","NoPto","CreditExpiringWithin30Days","WorkOrderNotInitiallySigned","ConditionalClaimsReleaseNotSigned","FinalClaimsReleaseNotSigned","ConsumerAgreementNotSent","ConsumerAgreementNotSigned","ConsumerAgreementNotViewed","InRescissionPeriod","WorkOrderNotSignedAfterChangeOrder","DomesticContentNotQualifiedNoPto","AoMNotSigned","CpcRejected","CreditExpiredWithinExtensionWindow"],"enum":["None","DocumentsNotSent","DocumentsNotSigned","ProjectInfoNotComplete","ContractNotUploaded","LoanDetailsNotVerified","NotInstalled","NotFunded","ProjectCertificateNotSigned","NoPto","CreditExpiringWithin30Days","WorkOrderNotInitiallySigned","ConditionalClaimsReleaseNotSigned","FinalClaimsReleaseNotSigned","ConsumerAgreementNotSent","ConsumerAgreementNotSigned","ConsumerAgreementNotViewed","InRescissionPeriod","WorkOrderNotSignedAfterChangeOrder","DomesticContentNotQualifiedNoPto","AoMNotSigned","CpcRejected","CreditExpiredWithinExtensionWindow"]},"LSS_v2_PipelineActionTile":{"type":"string","description":"","x-enumNames":["None","CreditAtRisk","LoanDocActions","NtpActions","InstallActions"],"enum":["None","CreditAtRisk","LoanDocActions","NtpActions","InstallActions"]},"LSS_v2_RateTermParameters":{"type":"object","additionalProperties":false,"properties":{"rate":{"type":"number","format":"double"},"term":{"type":"integer","format":"int32"}}},"LSS_v2_NumericRange":{"type":"object","additionalProperties":false,"properties":{"lowRange":{"type":"number","format":"double","nullable":true},"highRange":{"type":"number","format":"double","nullable":true}}},"LSS_v2_StageFilter":{"type":"object","additionalProperties":false,"properties":{"complete":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/LSS_v2_StageType"}]},"notComplete":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/LSS_v2_StageType"}]}}},"LSS_v2_StageType":{"type":"string","description":"","x-enumNames":["None","Approved","AgreementCompleted","AgreementSent","AgreementSigned","ConditionalReleaseSigned","ContractUploaded","ContractSigned","FinalReleaseSigned","Funded","InstallComplete","InRescission","LoanDetailsVerified","LoanDocumentsSent","LoanDocumentsSigned","NtpComplete","ProjectCertificateSent","ProjectCertificateSigned","PtoComplete","ProjectInfoComplete","WorkOrderRequested","WorkOrderSigned","IcPaymentRequestSent","NtpPaymentRequestSent","DocsNotarized","ApprovedWithStips"],"enum":["None","Approved","AgreementCompleted","AgreementSent","AgreementSigned","ConditionalReleaseSigned","ContractUploaded","ContractSigned","FinalReleaseSigned","Funded","InstallComplete","InRescission","LoanDetailsVerified","LoanDocumentsSent","LoanDocumentsSigned","NtpComplete","ProjectCertificateSent","ProjectCertificateSigned","PtoComplete","ProjectInfoComplete","WorkOrderRequested","WorkOrderSigned","IcPaymentRequestSent","NtpPaymentRequestSent","DocsNotarized","ApprovedWithStips"]},"LSS_v2_AddressParameters":{"type":"object","additionalProperties":false,"properties":{"completeAddress":{"type":"string","nullable":true},"locality":{"type":"string","nullable":true},"adminArea1":{"type":"array","nullable":true,"items":{"type":"string"}},"adminArea2":{"type":"string","nullable":true},"postalCode":{"type":"string","nullable":true},"country":{"type":"string","nullable":true}}},"LSS_v2_DateRange":{"type":"object","additionalProperties":false,"properties":{"startDate":{"type":"string","format":"date-time","nullable":true},"endDate":{"type":"string","format":"date-time","nullable":true}}},"LSS_v2_ApplicantParameters":{"type":"object","additionalProperties":false,"properties":{"firstName":{"type":"string","nullable":true},"lastName":{"type":"string","nullable":true},"dateOfBirth":{"type":"string","format":"date-time","nullable":true},"socialSecurity":{"type":"string","nullable":true},"emailAddress":{"type":"string","nullable":true},"phoneNumber":{"type":"string","nullable":true},"completeAddress":{"type":"string","nullable":true},"locality":{"type":"string","nullable":true},"adminArea1":{"type":"array","nullable":true,"items":{"type":"string"}},"adminArea2":{"type":"string","nullable":true},"postalCode":{"type":"string","nullable":true},"country":{"type":"string","nullable":true},"isPrimary":{"type":"boolean","nullable":true}}},"LSS_v2_PersonParameters":{"type":"object","additionalProperties":false,"properties":{"type":{"type":"string","nullable":true},"userId":{"type":"string","format":"guid","nullable":true},"name":{"type":"string","nullable":true},"emailAddress":{"type":"string","nullable":true}}},"LSS_v2_PartyParameters":{"type":"object","additionalProperties":false,"properties":{"type":{"type":"string","nullable":true},"organizationId":{"type":"string","format":"guid","nullable":true},"entityId":{"type":"string","format":"guid","nullable":true},"name":{"type":"string","nullable":true},"hKey":{"type":"string","nullable":true},"isPrimary":{"type":"boolean","nullable":true},"workspaceId":{"type":"string","format":"guid","nullable":true}}},"LSS_v2_MilestoneParameters":{"type":"object","additionalProperties":false,"properties":{"date":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/LSS_v2_DateRange"}]},"Milestone":{"type":"string","nullable":true}}},"LSS_v2_SortField":{"type":"object","additionalProperties":false,"properties":{"field":{"$ref":"#/components/schemas/LSS_v2_SortByField"},"order":{"$ref":"#/components/schemas/LSS_v2_ResultsSortOrder"}}},"LSS_v2_SortByField":{"type":"string","description":"","x-enumNames":["None","DateCreated","DateUpdated","SearchScore","CreditExpirationDate","ApprovalDate","LoanAmount","LastCompletedMilestoneUpdatedAt"],"enum":["None","DateCreated","DateUpdated","SearchScore","CreditExpirationDate","ApprovalDate","LoanAmount","LastCompletedMilestoneUpdatedAt"]},"LSS_v2_ResultsSortOrder":{"type":"string","description":"","x-enumNames":["Ascending","Descending"],"enum":["Ascending","Descending"]},"LSS_v2_CasesSearchParameters":{"type":"object","additionalProperties":false,"properties":{"hasFrozenCases":{"type":"boolean","nullable":true},"hasOpenCases":{"type":"boolean","nullable":true},"hasRejectedCases":{"type":"boolean","nullable":true},"hasClosedCases":{"type":"boolean","nullable":true},"hasOpenBorrowerCases":{"type":"boolean","nullable":true},"hasOpenGoodLeapCases":{"type":"boolean","nullable":true}}},"LSS_v2_Orders":{"type":"object","additionalProperties":false,"properties":{"payeeType":{"type":"array","nullable":true,"items":{"type":"string"}},"status":{"type":"array","nullable":true,"items":{"type":"string"}}}},"LSS_v2_SearchUserExtension":{"type":"object","additionalProperties":false},"undefined_ApiResponse":{"type":"object","properties":{"payload":{"description":"The response data.","type":"object"}},"required":["payload"]},"undefined_Cursor":{"type":"object","properties":{"prev":{"type":"string","nullable":true,"description":"A point of reference to the previous page of data. Set to `null` when there is no more data to get back to."},"next":{"type":"string","nullable":true,"description":"A point of reference to the next page of data. Set to `null` when there is no more data to fetch."},"size":{"type":"number","description":"Number of items to return in the page."},"total":{"type":"number","description":"The total number of items."}},"required":["prev","next","size","total"]},"undefined_ApiResponseMeta":{"type":"object","properties":{"cursor":{"description":"The cursor metadata.","allOf":[{"$ref":"#/components/schemas/undefined_Cursor"}]}},"required":["cursor"]},"undefined_ApiResponseWithPagination":{"type":"object","properties":{"payload":{"description":"The response data.","type":"object"},"meta":{"description":"The response metadata.","allOf":[{"$ref":"#/components/schemas/undefined_ApiResponseMeta"}]}},"required":["payload","meta"]},"undefined_ApiErrorDetail":{"type":"object","properties":{"field":{"type":"string","description":"The field with faulty data."},"message":{"type":"string","description":"The message containing details about the underlying error."},"reason":{"type":"string","description":"The error code."},"type":{"type":"string","description":"The error type.","default":""}},"required":["field","message","reason"]},"undefined_ApiError":{"type":"object","properties":{"description":{"type":"string","description":"A short description of what led to the unexpected condition."},"reason":{"type":"string","description":"An additional error code that can be used to consult reference documentation."},"errors":{"description":"An optional collection of details about the errors that occurred.","type":"array","items":{"$ref":"#/components/schemas/undefined_ApiErrorDetail"}}},"required":["description"]},"undefined_Health":{"type":"object","properties":{"status":{"type":"string","description":"The overall status of the Submission service."},"details":{"description":"A collection of health checks performed on the dependent systems and resources.","type":"array","items":{"type":"object"}}},"required":["status","details"]},"undefined_CreateApplicationOutput":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the application."},"lifecycleStatus":{"description":"The lifecycle status of the application.","enum":["INITIATED","PREQUALIFIED","SUBMITTED","EXPIRED","CANCELED","NOT_PREQUALIFIED"],"type":"string"},"referenceNumber":{"type":"string","description":"A custom reference number."}},"required":["id","lifecycleStatus"]},"undefined_PersonalIdentityInputDto":{"type":"object","properties":{"type":{"type":"string","description":"The document type.","enum":["SSN"]},"value":{"type":"string","description":"The unique identification number."}},"required":["type","value"]},"undefined_CurrencyMeasurementInputDto":{"type":"object","properties":{"type":{"type":"string","description":"The currency type.","enum":["USD"]},"value":{"type":"number","description":"The currency value.","minimum":0}},"required":["type","value"]},"undefined_PhoneInputDto":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"The phone number."},"type":{"description":"The phone number type.","enum":["HOME","MOBILE"],"type":"string"}},"required":["phoneNumber","type"]},"undefined_Address":{"type":"object","properties":{"line1":{"type":"string","description":"The street address."},"line2":{"type":"string","description":"Additional details such as apartment or unit number, suite, floor, building, etc."},"city":{"type":"string","description":"The city."},"state":{"type":"string","description":"The state.","pattern":"/^[A-Z]{2}$/"},"zip":{"type":"string","description":"The ZIP code.","pattern":"/^\\d{5}(?:-\\d{4})?$/"},"country":{"type":"string","description":"The country in ISO 3166-1 alpha-2 format. Defaults to US."}},"required":["line1","city","state","zip"]},"undefined_MaritalPartnerContactInputDto":{"type":"object","properties":{"email":{"type":"string","description":"The marital partner's email address."},"primaryPhoneNumber":{"description":"The marital partner's primary phone number.","allOf":[{"$ref":"#/components/schemas/undefined_PhoneInputDto"}]},"secondaryPhoneNumber":{"nullable":true,"description":"The marital partner's secondary phone number.","allOf":[{"$ref":"#/components/schemas/undefined_PhoneInputDto"}]}},"required":["email","primaryPhoneNumber"]},"undefined_MaritalPartnerInputDto":{"type":"object","properties":{"firstName":{"type":"string","description":"The marital partner's first name."},"lastName":{"type":"string","description":"The marital partner's last name."},"contact":{"description":"The marital partner's contact information.","allOf":[{"$ref":"#/components/schemas/undefined_MaritalPartnerContactInputDto"}]}},"required":["firstName","lastName","contact"]},"undefined_PrimaryApplicantInput":{"type":"object","properties":{"firstName":{"type":"string","description":"The applicant's first name."},"lastName":{"type":"string","description":"The applicant's last name."},"dateOfBirth":{"format":"date-time","type":"string","description":"The applicant's date of birth."},"personalIdentity":{"description":"The applicant's personal identity information.","allOf":[{"$ref":"#/components/schemas/undefined_PersonalIdentityInputDto"}]},"homeOccupancy":{"description":"Occupancy status of the applicant's property.","enum":["PRIMARY","SECONDARY","INVESTMENT","OTHER"],"type":"string"},"homeOwnership":{"description":"Ownership status of the applicant's property.","enum":["NOT_OWNED","OWNED_WITH_MORTGAGE","OWNED_FREE_AND_CLEAR"],"type":"string"},"annualIncome":{"description":"Total annual income.","allOf":[{"$ref":"#/components/schemas/undefined_CurrencyMeasurementInputDto"}]},"email":{"type":"string","description":"The applicant's email address."},"primaryPhoneNumber":{"description":"The applicant's primary phone number.","allOf":[{"$ref":"#/components/schemas/undefined_PhoneInputDto"}]},"secondaryPhoneNumber":{"nullable":true,"description":"The applicant's secondary phone number.","allOf":[{"$ref":"#/components/schemas/undefined_PhoneInputDto"}]},"spokenLanguage":{"description":"The applicant's spoken language.","enum":["ENGLISH","SPANISH"],"type":"string"},"employmentStatus":{"description":"The applicant's employment status.","enum":["EMPLOYED","RETIRED","NOT_EMPLOYED","OTHER"],"type":"string"},"citizenshipStatus":{"description":"The applicant's citizenship status.","enum":["US_CITIZEN","LAWFUL_PERMANENT_RESIDENT_ALIEN","OTHER"],"type":"string"},"address":{"description":"The applicant's mailing address.","allOf":[{"$ref":"#/components/schemas/undefined_Address"}]},"maritalStatus":{"description":"The applicant's marital status.","enum":["SINGLE","MARRIED","DIVORCED","SEPARATED","WIDOWED"],"type":"string"},"maritalPartner":{"description":"The applicant's marital partner information.","allOf":[{"$ref":"#/components/schemas/undefined_MaritalPartnerInputDto"}]}},"required":["firstName","lastName","dateOfBirth","personalIdentity","homeOccupancy","homeOwnership","annualIncome","email","primaryPhoneNumber","spokenLanguage","employmentStatus","citizenshipStatus","address"]},"undefined_ApplicantInput":{"type":"object","properties":{"firstName":{"type":"string","description":"The applicant's first name."},"lastName":{"type":"string","description":"The applicant's last name."},"dateOfBirth":{"format":"date-time","type":"string","description":"The applicant's date of birth."},"personalIdentity":{"description":"The applicant's personal identity information.","allOf":[{"$ref":"#/components/schemas/undefined_PersonalIdentityInputDto"}]},"homeOccupancy":{"description":"Occupancy status of the applicant's property.","enum":["PRIMARY","SECONDARY","INVESTMENT","OTHER"],"type":"string"},"homeOwnership":{"description":"Ownership status of the applicant's property.","enum":["NOT_OWNED","OWNED_WITH_MORTGAGE","OWNED_FREE_AND_CLEAR"],"type":"string"},"annualIncome":{"description":"Total annual income.","allOf":[{"$ref":"#/components/schemas/undefined_CurrencyMeasurementInputDto"}]},"email":{"type":"string","description":"The applicant's email address."},"primaryPhoneNumber":{"description":"The applicant's primary phone number.","allOf":[{"$ref":"#/components/schemas/undefined_PhoneInputDto"}]},"secondaryPhoneNumber":{"nullable":true,"description":"The applicant's secondary phone number.","allOf":[{"$ref":"#/components/schemas/undefined_PhoneInputDto"}]},"spokenLanguage":{"description":"The applicant's spoken language.","enum":["ENGLISH","SPANISH"],"type":"string"},"employmentStatus":{"description":"The applicant's employment status.","enum":["EMPLOYED","RETIRED","NOT_EMPLOYED","OTHER"],"type":"string"},"citizenshipStatus":{"description":"The applicant's citizenship status.","enum":["US_CITIZEN","LAWFUL_PERMANENT_RESIDENT_ALIEN","OTHER"],"type":"string"},"address":{"description":"The applicant's mailing address.","allOf":[{"$ref":"#/components/schemas/undefined_Address"}]},"maritalStatus":{"description":"The applicant's marital status.","enum":["SINGLE","MARRIED","DIVORCED","SEPARATED","WIDOWED"],"type":"string"},"maritalPartner":{"description":"The applicant's marital partner information.","allOf":[{"$ref":"#/components/schemas/undefined_MaritalPartnerInputDto"}]}},"required":["firstName","lastName","dateOfBirth","personalIdentity","homeOccupancy","homeOwnership","annualIncome","email","primaryPhoneNumber","spokenLanguage","employmentStatus","citizenshipStatus","address"]},"undefined_Coordinates":{"type":"object","properties":{"latitude":{"type":"number","description":"The latitude of the subject property.","minimum":-90,"maximum":90},"longitude":{"type":"number","description":"The longitude of the subject property.","minimum":-180,"maximum":180}},"required":["latitude","longitude"]},"undefined_SubjectPropertyInputDto":{"type":"object","properties":{"mortgageTotalBalances":{"description":"The total balances of the mortgage.","allOf":[{"$ref":"#/components/schemas/undefined_CurrencyMeasurementInputDto"}]},"mortgageTotalPayments":{"description":"The total payments of the mortgage.","allOf":[{"$ref":"#/components/schemas/undefined_CurrencyMeasurementInputDto"}]},"address":{"description":"The address of the property.","allOf":[{"$ref":"#/components/schemas/undefined_Address"}]},"coordinates":{"description":"The coordinates of the property.","allOf":[{"$ref":"#/components/schemas/undefined_Coordinates"}]},"isMobileOrManufacturedHome":{"type":"boolean","description":"Whether the property is a mobile or manufactured home."},"lienPosition":{"type":"number","description":"The position of the lien on the property."}},"required":["address"]},"undefined_PartyInputDto":{"type":"object","properties":{"entityId":{"type":"string","description":"The unique identifier of the entity associated with the party."},"name":{"type":"string","description":"The name of the party."},"hKey":{"type":"string","description":"The hierarchical key of the party. Required for all party types except `SalesPerson`, `Homeowner`, and `CoApplicant`.","example":"`0-3-47B`"},"type":{"description":"The type of the party.","enum":["Corporate","Distributor","Integrator","Investor","Manufacturer","ReferralSource","Sales","SalesPerson","Service","Homeowner","Lender","CoApplicant"],"type":"string"},"workspaceId":{"type":"string","description":"The unique identifier of the workspace the party is operating under. Required for the `SalesPerson`, `Homeowner`, and `CoApplicant` party types."}},"required":["entityId","name","type"]},"undefined_LinkedFinanceAccountDto":{"type":"object","properties":{"linkType":{"description":"The type of the linked finance account.","enum":["NEW_ACCOUNT","ASSUMED_ACCOUNT","ROOT_ACCOUNT","LOAN"],"type":"string"},"financeAccountId":{"type":"string","description":"The unique identifier of the linked finance account."},"location":{"type":"string","description":"The location of the linked finance account.","enum":["INTEGRATION_API"]}},"required":["linkType","financeAccountId"]},"undefined_CreateApplicationInput":{"type":"object","properties":{"applicant":{"description":"The primary applicant.","allOf":[{"$ref":"#/components/schemas/undefined_PrimaryApplicantInput"}]},"coApplicant":{"description":"The secondary applicant.","allOf":[{"$ref":"#/components/schemas/undefined_ApplicantInput"}]},"subjectProperty":{"description":"The property where the project is being done.","allOf":[{"$ref":"#/components/schemas/undefined_SubjectPropertyInputDto"}]},"referenceNumber":{"type":"string","description":"A custom reference number external parties use to link the application back to their systems.","maxLength":500},"enrollments":{"description":"A list of enrollments.","type":"array","items":{"type":"string","enum":["AUTOPAY","PAPERLESS_COMMUNICATIONS"]}},"tags":{"description":"Optional user-defined tags to be added to the application.","type":"array","items":{"type":"string"}},"parties":{"description":"A list of custom parties.","type":"array","items":{"$ref":"#/components/schemas/undefined_PartyInputDto"}},"linkedFinanceAccounts":{"description":"A list of finance accounts linked to the application.","type":"array","items":{"$ref":"#/components/schemas/undefined_LinkedFinanceAccountDto"}}},"required":["applicant","subjectProperty"]},"undefined_SharedAppOrganizationDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the organization."},"name":{"type":"string","description":"The name of the organization."},"type":{"description":"The type of the organization.","enum":["Corporate","Distributor","Integrator","Investor","Manufacturer","ReferralSource","Sales","SalesPerson","Service","Homeowner","Lender","CoApplicant"],"type":"string"}},"required":["id","name","type"]},"undefined_ApplicationSalesRepDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the sales representative."},"workspaceId":{"type":"string","description":"The workspace ID associated with the sales representative."},"email":{"type":"string","description":"The email address of the sales representative."},"name":{"type":"string","description":"The name of the sales representative."},"organizationId":{"type":"string","description":"The unique identifier of the organization the sales representative belongs to."}},"required":["id","workspaceId","name","organizationId"]},"undefined_ApplicationsListApplicantDetailDto":{"type":"object","properties":{"firstName":{"type":"string","description":"The first name of the applicant."},"lastName":{"type":"string","description":"The last name of the applicant."},"email":{"type":"string","description":"The email of the applicant."}},"required":["firstName","lastName","email"]},"undefined_ApplicationsListApplicantDto":{"type":"object","properties":{"type":{"description":"The type of applicant.","enum":["APPLICANT","COAPPLICANT"],"type":"string"},"detail":{"description":"The detail of the applicant.","allOf":[{"$ref":"#/components/schemas/undefined_ApplicationsListApplicantDetailDto"}]}},"required":["type","detail"]},"undefined_PrequalificationCategoryDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the category."},"code":{"description":"The code of the category.","enum":["Solar_TPO","HVAC_LEASE","BATTERY_LEASE","HELOC"],"type":"string"},"name":{"type":"string","description":"The name of the category."}},"required":["id","code","name"]},"undefined_ApplicationsListPrequalificationDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the prequalification."},"category":{"description":"The category of the prequalification.","allOf":[{"$ref":"#/components/schemas/undefined_PrequalificationCategoryDto"}]},"expiresAt":{"format":"date-time","type":"string","description":"The date the prequalification expires."},"createdAt":{"format":"date-time","type":"string","description":"The date the prequalification was created."},"status":{"description":"The outcome of the prequalification decision.","enum":["APPROVED","APPROVED_WITH_STIPS","DECLINED","PENDING","CANCELED"],"type":"string"}},"required":["id","category","expiresAt","createdAt","status"]},"undefined_FindApplicationsOutput":{"type":"object","properties":{"organizationId":{"type":"string","description":"The unique identifier of the organization that the application is associated with."},"organizations":{"description":"The organizations associated with the application. Consumers resolve the sales rep's organization\nname by matching `salesRep.organizationId` against this array.","type":"array","items":{"$ref":"#/components/schemas/undefined_SharedAppOrganizationDto"}},"salesRep":{"description":"The sales representative that submitted the application.","allOf":[{"$ref":"#/components/schemas/undefined_ApplicationSalesRepDto"}]},"applicants":{"description":"The applicants associated with the application.","type":"array","items":{"$ref":"#/components/schemas/undefined_ApplicationsListApplicantDto"}},"enrollments":{"description":"The enrollments the applicant signed up for.","type":"array","items":{"type":"string","enum":["AUTOPAY","PAPERLESS_COMMUNICATIONS"]}},"prequalifications":{"description":"Summary of the prequalifications linked to the application.","type":"array","items":{"$ref":"#/components/schemas/undefined_ApplicationsListPrequalificationDto"}},"lifecycleStatus":{"description":"The lifecycle status of the application.","enum":["INITIATED","PREQUALIFIED","SUBMITTED","EXPIRED","CANCELED","NOT_PREQUALIFIED"],"type":"string"},"workflowType":{"description":"The submission channel the application was created through — `D2C` for\nhomeowner-initiated flows, `POS` for contractor-initiated flows.","enum":["POS","D2C"],"type":"string"},"referenceNumber":{"type":"string","description":"The reference number of the application."},"createdAt":{"format":"date-time","type":"string","description":"The date the application was created."},"id":{"type":"string","description":"The unique identifier of the entity."}},"required":["organizationId","applicants","enrollments","prequalifications","lifecycleStatus","workflowType","createdAt","id"]},"undefined_CurrencyMeasurement":{"type":"object","properties":{"label":{"type":"string","description":"The display name of the currency."},"type":{"type":"string","description":"The type of currency.","enum":["USD"]},"value":{"type":"number","minimum":0}},"required":["type","value"]},"undefined_SubjectProperty":{"type":"object","properties":{"address":{"description":"The address of the property.","allOf":[{"$ref":"#/components/schemas/undefined_Address"}]},"coordinates":{"description":"The coordinates of the property.","allOf":[{"$ref":"#/components/schemas/undefined_Coordinates"}]},"isMobileOrManufacturedHome":{"type":"boolean","description":"Whether the property is a mobile or manufactured home."},"propertyType":{"description":"The type of property.","enum":["Detached Single Family","Condo","Multi Family Dwelling","Low Density Multi Family Dwelling","Mobile","Other","Manufactured","Townhouse"],"type":"string"},"mortgageTotalBalances":{"description":"The total balances of the mortgage.","allOf":[{"$ref":"#/components/schemas/undefined_CurrencyMeasurement"}]},"mortgageTotalPayments":{"description":"The total payments of the mortgage.","allOf":[{"$ref":"#/components/schemas/undefined_CurrencyMeasurement"}]},"fips":{"type":"string","description":"The FIPS code of the property."},"situsCensusTract":{"type":"string","description":"The Situs Census Tract of the property."},"lienPosition":{"type":"number","description":"The position of the lien on the property."},"legalDescription":{"type":"string","nullable":true,"description":"The full legal description of the property, used on lien/closing documents."}},"required":["address"]},"undefined_PersonalIdentity":{"type":"object","properties":{"type":{"type":"string","description":"The document type.","enum":["SSN"]},"displayName":{"type":"string","description":"The display name of the document type."},"value":{"type":"string","description":"The unique identification number."},"issuingCountry":{"type":"string","description":"The country that issues the personal identity document."}},"required":["type","value","issuingCountry"]},"undefined_PhoneDto":{"type":"object","properties":{"countryCode":{"type":"string","description":"The country code in E.164 format."},"isoCountryCode":{"type":"string","description":"The country in ISO 3166-1 alpha-2 format."},"phoneNumber":{"type":"string","description":"The phone number."},"type":{"description":"The phone number type.","enum":["HOME","MOBILE"],"type":"string"}},"required":["countryCode","isoCountryCode","phoneNumber","type"]},"undefined_ApplicantMaritalPartnerContactDto":{"type":"object","properties":{"email":{"type":"string","description":"The marital partner's email address."},"primaryPhoneNumber":{"description":"The marital partner's primary phone number.","allOf":[{"$ref":"#/components/schemas/undefined_PhoneDto"}]},"secondaryPhoneNumber":{"nullable":true,"description":"The marital partner's secondary phone number.","allOf":[{"$ref":"#/components/schemas/undefined_PhoneDto"}]}},"required":["email","primaryPhoneNumber","secondaryPhoneNumber"]},"undefined_ApplicantMaritalPartnerDto":{"type":"object","properties":{"firstName":{"type":"string","description":"The marital partner's first name."},"lastName":{"type":"string","description":"The marital partner's last name."},"contact":{"description":"The marital partner's contact information.","allOf":[{"$ref":"#/components/schemas/undefined_ApplicantMaritalPartnerContactDto"}]}},"required":["firstName","lastName","contact"]},"undefined_ApplicantDtoV2":{"type":"object","properties":{"firstName":{"type":"string","description":"The applicant's first name."},"lastName":{"type":"string","description":"The applicant's last name."},"dateOfBirth":{"format":"date-time","type":"string","description":"The applicant's date of birth."},"email":{"type":"string","description":"The applicant's email address."},"personalIdentity":{"description":"The applicant's personal identity information.","allOf":[{"$ref":"#/components/schemas/undefined_PersonalIdentity"}]},"homeOccupancy":{"description":"Occupancy status of the applicant's property.","enum":["PRIMARY","SECONDARY","INVESTMENT","OTHER"],"type":"string"},"homeOccupancyDisplayValue":{"description":"The display value of the occupancy status of the applicant's property.","enum":["Primary residence","Second or vacation home","Investment property","Doesn't occupy or own"],"type":"string"},"homeOwnership":{"description":"Ownership status of the applicant's property.","enum":["NOT_OWNED","OWNED_WITH_MORTGAGE","OWNED_FREE_AND_CLEAR"],"type":"string"},"annualIncome":{"description":"Total annual income, as reported by the applicant.","allOf":[{"$ref":"#/components/schemas/undefined_CurrencyMeasurement"}]},"verifiedAnnualIncome":{"description":"The applicant's verified annual income from the income verification workflow.","allOf":[{"$ref":"#/components/schemas/undefined_CurrencyMeasurement"}]},"primaryPhoneNumber":{"description":"The applicant's primary phone number.","allOf":[{"$ref":"#/components/schemas/undefined_PhoneDto"}]},"secondaryPhoneNumber":{"nullable":true,"description":"The applicant's secondary phone number.","allOf":[{"$ref":"#/components/schemas/undefined_PhoneDto"}]},"spokenLanguage":{"description":"The applicant's spoken language.","enum":["ENGLISH","SPANISH"],"type":"string"},"spokenLanguageDisplayValue":{"description":"The display value of the applicant's spoken language.","enum":["English","Spanish"],"type":"string"},"employmentStatus":{"description":"The applicant's employment status.","enum":["EMPLOYED","RETIRED","NOT_EMPLOYED","OTHER"],"type":"string"},"citizenshipStatus":{"description":"The applicant's citizenship status.","enum":["US_CITIZEN","LAWFUL_PERMANENT_RESIDENT_ALIEN","OTHER"],"type":"string"},"address":{"description":"The applicant's mailing address.","allOf":[{"$ref":"#/components/schemas/undefined_Address"}]},"electronicConsent":{"type":"boolean","description":"The applicant's consent to have their information stored and processed."},"isPrimary":{"type":"boolean","description":"Indicates whether the applicant is the primary applicant."},"dropped":{"type":"boolean","description":"Indicates whether the applicant has been dropped from the application."},"maritalStatus":{"nullable":true,"description":"The applicant's marital status.","enum":["SINGLE","MARRIED","DIVORCED","SEPARATED","WIDOWED"],"type":"string"},"maritalPartner":{"nullable":true,"description":"The applicant's marital partner. Populated when `maritalStatus` is one\nthat requires a partner (e.g. `MARRIED`, `SEPARATED`).","allOf":[{"$ref":"#/components/schemas/undefined_ApplicantMaritalPartnerDto"}]},"id":{"type":"string","description":"The unique identifier of the entity."}},"required":["firstName","lastName","dateOfBirth","email","personalIdentity","homeOccupancy","homeOwnership","annualIncome","primaryPhoneNumber","secondaryPhoneNumber","spokenLanguage","employmentStatus","citizenshipStatus","address","electronicConsent","isPrimary","dropped","maritalStatus","maritalPartner","id"]},"undefined_Phone":{"type":"object","properties":{"countryCode":{"type":"string","description":"The country code in E.164 format."},"isoCountryCode":{"type":"string","description":"The country in ISO 3166-1 alpha-2 format. Defaults to US."},"phoneNumber":{"type":"string","description":"The phone number."},"type":{"description":"The phone number type.","enum":["HOME","MOBILE"],"type":"string"}},"required":["countryCode","phoneNumber","type"]},"undefined_ApplicantFragmentDto":{"type":"object","properties":{"firstName":{"type":"string","description":"The first name of the applicant."},"lastName":{"type":"string","description":"The last name of the applicant."},"email":{"type":"string","description":"The email of the applicant."},"primaryPhoneNumber":{"description":"The primary phone number of the applicant.","allOf":[{"$ref":"#/components/schemas/undefined_Phone"}]}},"required":["firstName","lastName","email","primaryPhoneNumber"]},"undefined_ApplicantAssociationDto":{"type":"object","properties":{"type":{"description":"The type of applicant.","enum":["APPLICANT","COAPPLICANT"],"type":"string"},"applicant":{"description":"The applicant associated with the application.","allOf":[{"$ref":"#/components/schemas/undefined_ApplicantDtoV2"}]},"fragment":{"description":"The fragment of the applicant if it has not been fully created yet.","allOf":[{"$ref":"#/components/schemas/undefined_ApplicantFragmentDto"}]}},"required":["type"]},"undefined_FindApplicationOutput":{"type":"object","properties":{"organizationId":{"type":"string","description":"The unique identifier of the organization that the application is associated with."},"salesRep":{"description":"The sales representative that submitted the application.","allOf":[{"$ref":"#/components/schemas/undefined_ApplicationSalesRepDto"}]},"enrollments":{"description":"A collection of enrollments the applicant signed up for.","type":"array","items":{"type":"string","enum":["AUTOPAY","PAPERLESS_COMMUNICATIONS"]}},"subjectProperty":{"description":"The property where the project is being done.","allOf":[{"$ref":"#/components/schemas/undefined_SubjectProperty"}]},"tags":{"description":"Optional user-defined tags added to the application.","type":"array","items":{"type":"string"}},"referenceNumber":{"type":"string","description":"A custom reference number external parties use to link the application back to their systems."},"applicants":{"description":"The applicants associated with the application.","type":"array","items":{"$ref":"#/components/schemas/undefined_ApplicantAssociationDto"}},"lifecycleStatus":{"description":"The lifecycle status of the application.","enum":["INITIATED","PREQUALIFIED","SUBMITTED","EXPIRED","CANCELED","NOT_PREQUALIFIED"],"type":"string"},"createdAt":{"format":"date-time","type":"string","description":"The date the application was created."},"prequalifications":{"description":"Summary of the prequalifications linked to the application.","type":"array","items":{"$ref":"#/components/schemas/undefined_ApplicationsListPrequalificationDto"}},"linkedFinanceAccounts":{"description":"Finance accounts linked to this application. For HELOC applications this\nholds the source loan that the application was created from, which\ndownstream consumers use to resolve loan-level data (balances, payment\nschedule, etc.) without having to walk back through the originating flow.\nUndefined until the application has been linked to one or more finance\naccounts.","type":"array","items":{"$ref":"#/components/schemas/undefined_LinkedFinanceAccountDto"}},"id":{"type":"string","description":"The unique identifier of the entity."}},"required":["organizationId","enrollments","subjectProperty","tags","applicants","createdAt","prequalifications","id"]},"undefined_CompletedReadinessStepDto":{"type":"object","properties":{"code":{"description":"The code identifying the satisfied readiness step.","enum":["CO_APPLICANT_COMPLETED","DISCLOSURE_AGREEMENTS_RECORDED","ELECTRONIC_CONSENT_DISCLOSURE_RECORDED","FINANCIAL_DISCLOSURE_RECORDED","HOME_MORTGAGE_DISCLOSURES_RECORDED","OFFER_SELECTED","PREQUALIFICATION_LINKED","PREQUALIFICATION_NOT_EXPIRED","PREQUALIFICATION_APPROVED"],"type":"string"},"scope":{"description":"The entity scope this step's invariant belongs to.","enum":["APPLICATION","PREQUALIFICATION"],"type":"string"}},"required":["code","scope"]},"undefined_PendingReadinessStepDto":{"type":"object","properties":{"code":{"description":"The code identifying the unsatisfied readiness step.","enum":["CO_APPLICANT_COMPLETED","DISCLOSURE_AGREEMENTS_RECORDED","ELECTRONIC_CONSENT_DISCLOSURE_RECORDED","FINANCIAL_DISCLOSURE_RECORDED","HOME_MORTGAGE_DISCLOSURES_RECORDED","OFFER_SELECTED","PREQUALIFICATION_LINKED","PREQUALIFICATION_NOT_EXPIRED","PREQUALIFICATION_APPROVED"],"type":"string"},"scope":{"description":"The entity scope this step's invariant belongs to.","enum":["APPLICATION","PREQUALIFICATION"],"type":"string"},"audience":{"nullable":true,"description":"The audience this step's invariant corresponds to. `null` for\napplication-wide invariants with no per-applicant dimension.","enum":["APPLICANT","COAPPLICANT"],"type":"string"},"description":{"type":"string","description":"A human-readable explanation of why the step is unsatisfied."}},"required":["code","scope","audience","description"]},"undefined_GetApplicationReadinessOutput":{"type":"object","properties":{"applicationId":{"type":"string","description":"The unique identifier of the application this readiness output\ndescribes."},"prequalificationId":{"type":"string","nullable":true,"description":"The id of the prequalification the readiness output is scoped to,\nechoed back from the request's `?prequalificationId=` query\nparameter. Set to null when the caller did not scope to a\nprequalification, in which case the output covers only\napplication-scoped invariants."},"status":{"description":"The lifecycle status of the application at the time the readiness\nwas computed.","enum":["INITIATED","PREQUALIFIED","SUBMITTED","EXPIRED","CANCELED","NOT_PREQUALIFIED"],"type":"string"},"prequalificationStatus":{"nullable":true,"description":"The decision status of the scoped prequalification, echoed when the\ncaller supplied `?prequalificationId=`. Null when the readiness check\nis application-scoped only.","enum":["APPROVED","APPROVED_WITH_STIPS","DECLINED","PENDING","CANCELED"],"type":"string"},"readyForSubmission":{"type":"boolean","description":"Whether the application is currently in shape to be submitted.\n\n`true` only when every applicable readiness step is satisfied and\nthe lifecycle status admits submission. `false` for all terminal\nlifecycle states (`SUBMITTED`, `EXPIRED`)."},"completedSteps":{"description":"The readiness steps that the application currently satisfies.\nAlways empty for terminal lifecycle states.","type":"array","items":{"$ref":"#/components/schemas/undefined_CompletedReadinessStepDto"}},"pendingSteps":{"description":"The readiness steps that the application does not currently\nsatisfy. Always empty for terminal lifecycle states.","type":"array","items":{"$ref":"#/components/schemas/undefined_PendingReadinessStepDto"}}},"required":["applicationId","prequalificationId","status","prequalificationStatus","readyForSubmission","completedSteps","pendingSteps"]},"undefined_ShareApplicationInput":{"type":"object","properties":{"audience":{"description":"The applicant role the share is intended for. The corresponding applicant\nmust already exist on the application; otherwise the entire request is\nrejected and no shares are created.","enum":["APPLICANT","COAPPLICANT"],"type":"string"},"deliveryChannel":{"description":"The channel through which the share's access link will be delivered to the\naudience.","enum":["EMAIL","SMS"],"type":"string"}},"required":["audience","deliveryChannel"]},"undefined_ShareApplicationOutput":{"type":"object","properties":{"shareId":{"type":"string","description":"The server-generated unique identifier of the share."},"audience":{"description":"The applicant role this share targets.","enum":["APPLICANT","COAPPLICANT"],"type":"string"},"communicationStatus":{"type":"string","description":"The communication status of the share, indicating where the share is in\nits delivery lifecycle.","enum":["SENT"]},"deliveryChannel":{"description":"The channel through which the share's access link was delivered.","enum":["EMAIL","SMS"],"type":"string"},"deliveryAddress":{"type":"string","description":"The address the share's access link was delivered to. Format depends on\n`deliveryChannel`: an RFC 5321 email address for `EMAIL`, an E.164 phone\nnumber for `SMS`."},"expiresAt":{"format":"date-time","type":"string","description":"The date and time at which the share's access link expires and stops\ngranting access to the application."}},"required":["shareId","audience","communicationStatus","deliveryChannel","deliveryAddress","expiresAt"]},"undefined_SignedDisclosureInput":{"type":"object","properties":{"applicantRole":{"description":"The applicant role agreeing to the disclosure. The corresponding\napplicant must already exist on the application; otherwise the entire\nrequest is rejected and no signed disclosures are recorded.","enum":["APPLICANT","COAPPLICANT"],"type":"string"},"disclosureToken":{"type":"string","description":"The encoded disclosure JWT carrying the disclosure identifier the\napplicant agreed to. Validated against `DisclosureType.Financial`."},"signature":{"type":"string","description":"The applicant signature image, encoded as a base64 PNG data URI.\nPersisted to S3 at a deterministic key — re-submitting a signed\ndisclosure with the same `(applicantRole, disclosureId)` overwrites\nthe prior signature image at the same S3 location."}},"required":["applicantRole","disclosureToken","signature"]},"undefined_SignedDisclosureOutput":{"type":"object","properties":{"applicantRole":{"description":"The applicant role that agreed to the disclosure.","enum":["APPLICANT","COAPPLICANT"],"type":"string"},"disclosureId":{"type":"string","description":"The resolved unique identifier of the disclosure the applicant agreed to."},"agreementDate":{"format":"date-time","type":"string","description":"The date and time the agreement was recorded by this PUT."}},"required":["applicantRole","disclosureId","agreementDate"]},"undefined_CreateCoApplicantOutput":{"type":"object","properties":{"shares":{"description":"The shares created alongside the coapplicant, returned in the same order as\nthe requested `shareDeliveryChannels` — the share at index N corresponds to\nthe channel at index N. Absent when no `shareDeliveryChannels` were\nrequested or an empty array was provided.","type":"array","items":{"$ref":"#/components/schemas/undefined_ShareApplicationOutput"}}}},"undefined_CreateCoApplicantInput":{"type":"object","properties":{"firstName":{"type":"string","description":"The coapplicant's first name."},"lastName":{"type":"string","description":"The coapplicant's last name."},"email":{"type":"string","description":"The coapplicant's email address."},"primaryPhoneNumber":{"description":"The coapplicant's phone number.","allOf":[{"$ref":"#/components/schemas/undefined_PhoneInputDto"}]},"shareDeliveryChannels":{"description":"Delivery channels for the application share(s) created alongside the new\ncoapplicant. Exactly one share is created per channel — for example,\n`[Email, SMS]` creates two shares targeting the coapplicant, delivered via\nemail and SMS respectively. Channels must be unique. When omitted or empty,\nthe coapplicant is created without any shares.","type":"array","items":{"type":"string","enum":["EMAIL","SMS"]}}},"required":["firstName","lastName","email","primaryPhoneNumber"]},"undefined_UpdateApplicantInput":{"type":"object","properties":{"type":{"description":"The type of applicant.","enum":["APPLICANT","COAPPLICANT"],"type":"string"},"isOnTitle":{"type":"boolean","description":"Whether the applicant is on the property title."},"firstName":{"type":"string","description":"The applicant's first name."},"lastName":{"type":"string","description":"The applicant's last name."},"dateOfBirth":{"format":"date-time","type":"string","description":"The applicant's date of birth."},"personalIdentity":{"description":"The applicant's personal identity information.","allOf":[{"$ref":"#/components/schemas/undefined_PersonalIdentityInputDto"}]},"homeOccupancy":{"description":"Occupancy status of the applicant's property.","enum":["PRIMARY","SECONDARY","INVESTMENT","OTHER"],"type":"string"},"homeOwnership":{"description":"Ownership status of the applicant's property.","enum":["NOT_OWNED","OWNED_WITH_MORTGAGE","OWNED_FREE_AND_CLEAR"],"type":"string"},"annualIncome":{"description":"Total annual income.","allOf":[{"$ref":"#/components/schemas/undefined_CurrencyMeasurementInputDto"}]},"email":{"type":"string","description":"The applicant's email address."},"primaryPhoneNumber":{"description":"The applicant's primary phone number.","allOf":[{"$ref":"#/components/schemas/undefined_PhoneInputDto"}]},"secondaryPhoneNumber":{"nullable":true,"description":"The applicant's secondary phone number.","allOf":[{"$ref":"#/components/schemas/undefined_PhoneInputDto"}]},"spokenLanguage":{"description":"The applicant's spoken language.","enum":["ENGLISH","SPANISH"],"type":"string"},"employmentStatus":{"description":"The applicant's employment status.","enum":["EMPLOYED","RETIRED","NOT_EMPLOYED","OTHER"],"type":"string"},"citizenshipStatus":{"description":"The applicant's citizenship status.","enum":["US_CITIZEN","LAWFUL_PERMANENT_RESIDENT_ALIEN","OTHER"],"type":"string"},"address":{"description":"The applicant's mailing address.","allOf":[{"$ref":"#/components/schemas/undefined_Address"}]},"maritalStatus":{"description":"The applicant's marital status.","enum":["SINGLE","MARRIED","DIVORCED","SEPARATED","WIDOWED"],"type":"string"},"maritalPartner":{"description":"The applicant's marital partner information.","allOf":[{"$ref":"#/components/schemas/undefined_MaritalPartnerInputDto"}]}},"required":["type"]},"undefined_CreateHmdaResponseItemInput":{"type":"object","properties":{"questionId":{"type":"string","description":"Foreign key to the HMDA question."},"value":{"type":"string","description":"The exact value submitted by the user."},"collectionMethod":{"type":"string","description":"Required by HMDA when applicable for GMI.","enum":["SELF","VISUAL_OBSERVATION_OR_SURNAME","ORIGINATOR_INPUT","AUTOFILLED"]}},"required":["questionId","value","collectionMethod"]},"undefined_CreateHmdaApplicantResponsesInput":{"type":"object","properties":{"applicantRole":{"type":"string","description":"Who answered the questions (e.g., APPLICANT, COAPPLICANT).","enum":["APPLICANT","COAPPLICANT"]},"responses":{"description":"The array of HMDA response items for this applicant.","type":"array","items":{"$ref":"#/components/schemas/undefined_CreateHmdaResponseItemInput"}}},"required":["applicantRole","responses"]},"undefined_CreateHmdaResponsesInput":{"type":"object","properties":{"payload":{"description":"The array of applicant responses.","type":"array","items":{"$ref":"#/components/schemas/undefined_CreateHmdaApplicantResponsesInput"}},"token":{"type":"string","description":"The signed JWT token."}},"required":["payload","token"]},"undefined_CategoryDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the category."},"code":{"description":"The code of the category.","enum":["Solar_TPO","HVAC_LEASE","BATTERY_LEASE","HELOC"],"type":"string"},"name":{"type":"string","description":"The name of the category."}},"required":["id","code","name"]},"undefined_PrequalificationOfferRateDto":{"type":"object","properties":{"minimum":{"type":"number","description":"The minimum rate."},"maximum":{"type":"number","description":"The maximum rate."}},"required":["minimum","maximum"]},"undefined_MarginsInputDto":{"type":"object","properties":{"installment":{"type":"number","description":"The margin rate applied to the installment portion of the loan."},"revolving":{"type":"number","description":"The margin rate applied to the revolving portion of the loan."}},"required":["installment","revolving"]},"undefined_DealerFeeInputDto":{"type":"object","properties":{"percent":{"type":"number","description":"The dealer fee expressed as a percentage of project cost (e.g. 5 for 5%)."}},"required":["percent"]},"undefined_PrequalificationOfferInputDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the offer."},"estimatedMonthlyPaymentWithAutopay":{"type":"number","description":"The estimated monthly payment calculated using the autopay interest rate.","minimum":1},"estimatedMonthlyPaymentWithoutAutopay":{"type":"number","description":"The estimated monthly payment calculated without the autopay discount.","minimum":1},"ratesWithAutopay":{"description":"The rate information for the offer with autopay.","allOf":[{"$ref":"#/components/schemas/undefined_PrequalificationOfferRateDto"}]},"ratesWithoutAutopay":{"description":"The rate information for the offer without autopay.","allOf":[{"$ref":"#/components/schemas/undefined_PrequalificationOfferRateDto"}]},"term":{"type":"number","description":"The term information for the offer."},"maxAmount":{"type":"number","description":"The maximum amount for the offer."},"featured":{"type":"boolean","description":"Indicates whether this offer is featured."},"margins":{"description":"The per-product margin rates of the offer, when supplied by underwriting.","allOf":[{"$ref":"#/components/schemas/undefined_MarginsInputDto"}]},"dealerFee":{"description":"The dealer fee for the offer, when supplied by underwriting.","allOf":[{"$ref":"#/components/schemas/undefined_DealerFeeInputDto"}]}},"required":["id","estimatedMonthlyPaymentWithAutopay","estimatedMonthlyPaymentWithoutAutopay","ratesWithAutopay","ratesWithoutAutopay","term","maxAmount","featured"]},"undefined_PrequalificationInput":{"type":"object","properties":{"projectCost":{"type":"number","description":"The cost of the project.","minimum":1},"category":{"description":"The category of the project.","allOf":[{"$ref":"#/components/schemas/undefined_CategoryDto"}]},"offers":{"description":"The list of pre-qualified offers.","type":"array","items":{"$ref":"#/components/schemas/undefined_PrequalificationOfferInputDto"}},"status":{"description":"The outcome of the prequalification decision asserted by the caller.\nDefaults to `APPROVED` when omitted.","enum":["APPROVED","APPROVED_WITH_STIPS","DECLINED","PENDING","CANCELED"],"type":"string"}},"required":["projectCost","category","offers"]},"undefined_PrequalifyExplicitApplicationInput":{"type":"object","properties":{"prequalifications":{"description":"Prequalified financing options for the application.","type":"array","items":{"$ref":"#/components/schemas/undefined_PrequalificationInput"}}},"required":["prequalifications"]},"undefined_PrequalifyImplicitApplicationInput":{"type":"object","properties":{}},"undefined_MarginsDto":{"type":"object","properties":{"installment":{"type":"number","description":"The margin rate applied to the installment portion of the loan."},"revolving":{"type":"number","description":"The margin rate applied to the revolving portion of the loan."}},"required":["installment","revolving"]},"undefined_DealerFeeDto":{"type":"object","properties":{"percent":{"type":"number","description":"The dealer fee expressed as a percentage of project cost (e.g. 5 for 5%)."}},"required":["percent"]},"undefined_NumberRangeDto":{"type":"object","properties":{"minimum":{"type":"number","description":"The inclusive lower bound of the range."},"maximum":{"type":"number","description":"The inclusive upper bound of the range."}},"required":["minimum","maximum"]},"undefined_PrequalificationOfferOutputDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the offer."},"estimatedMonthlyPaymentWithAutopay":{"type":"number","nullable":true,"description":"The estimated monthly payment calculated using the autopay interest rate. Null for D2C (homeowner-initiated) HELOC prequalifications, which have no project cost to compute payments against."},"estimatedMonthlyPaymentWithoutAutopay":{"type":"number","nullable":true,"description":"The estimated monthly payment calculated without the autopay discount. Null for D2C (homeowner-initiated) HELOC prequalifications, which have no project cost to compute payments against."},"ratesWithAutopay":{"description":"The rate information for the offer with autopay.","allOf":[{"$ref":"#/components/schemas/undefined_PrequalificationOfferRateDto"}]},"ratesWithoutAutopay":{"description":"The rate information for the offer without autopay.","allOf":[{"$ref":"#/components/schemas/undefined_PrequalificationOfferRateDto"}]},"term":{"type":"number","description":"The term of the offer in years."},"maxAmount":{"type":"number","description":"The maximum amount for the offer."},"featured":{"type":"boolean","description":"Indicates whether this offer is featured."},"margins":{"description":"The per-product margin rates of the offer, when supplied by underwriting.","allOf":[{"$ref":"#/components/schemas/undefined_MarginsDto"}]},"dealerFee":{"description":"The dealer fee for the offer, when supplied by underwriting.","allOf":[{"$ref":"#/components/schemas/undefined_DealerFeeDto"}]},"projectCostLimits":{"description":"The project cost limits for the offer.","allOf":[{"$ref":"#/components/schemas/undefined_NumberRangeDto"}]}},"required":["id","estimatedMonthlyPaymentWithAutopay","estimatedMonthlyPaymentWithoutAutopay","ratesWithAutopay","ratesWithoutAutopay","term","maxAmount","featured","projectCostLimits"]},"undefined_LegalEntityDto":{"type":"object","properties":{"name":{"type":"string","description":"The name of the legal entity."},"address":{"description":"The address of the legal entity.","allOf":[{"$ref":"#/components/schemas/undefined_Address"}]}},"required":["name","address"]},"undefined_MortgageOfficerOutputDto":{"type":"object","properties":{"fullName":{"type":"string","description":"The full name of the mortgage officer."},"licenseNumber":{"type":"string","description":"The license number of the mortgage officer."},"legalEntity":{"description":"The legal entity details of the mortgage officer.","allOf":[{"$ref":"#/components/schemas/undefined_LegalEntityDto"}]},"id":{"type":"string","description":"The unique identifier of the entity."}},"required":["fullName","licenseNumber","legalEntity","id"]},"undefined_PrequalifyApplicationOutput":{"type":"object","properties":{"projectCost":{"type":"number","nullable":true,"description":"The project cost applied to the prequalification. Null for D2C (homeowner-initiated) HELOC finance accounts, which have no associated project cost."},"status":{"description":"The outcome of the prequalification decision. For the implicit path this is\nmapped from the FIREngine response; for the explicit path it is supplied by\nthe caller on each prequalification input and defaults to\n`APPROVED` when omitted.","enum":["APPROVED","APPROVED_WITH_STIPS","DECLINED","PENDING","CANCELED"],"type":"string"},"maxLoanAmount":{"type":"string","description":"The maximum loan amount returned by the underwriting engine, as a string.\nOnly populated on the implicit path."},"reason":{"type":"string","description":"The reason provided by the underwriting engine for the decision. Only\npopulated on the implicit path."},"availableOffers":{"description":"The offers available under this prequalification.","type":"array","items":{"$ref":"#/components/schemas/undefined_PrequalificationOfferOutputDto"}},"limitedUseToken":{"type":"string","description":"A redeem token whose scope is narrowed to this prequalification and its\nowning application. The token is not itself a JWT and cannot be used as a\nBearer credential — clients must exchange it with the Directory service\nfor a session JWT, which is then used in the `Authorization` header on\nsubsequent requests that advance this prequalification (e.g. PATCH to\nupdate the selected offer, POST to submit the application)."},"projectReserveLimit":{"type":"number","nullable":true,"description":"The total project reserve limit for this prequalification. Null when there is no project cost (D2C/homeowner-initiated HELOC prequalifications) or no featured offer among the available offers."},"mortgageOfficer":{"description":"The mortgage officer assigned to this prequalification, if any.","allOf":[{"$ref":"#/components/schemas/undefined_MortgageOfficerOutputDto"}]},"expiresAt":{"format":"date-time","type":"string","description":"The date the prequalification expires."},"id":{"type":"string","description":"The unique identifier of the entity."}},"required":["projectCost","status","availableOffers","limitedUseToken","projectReserveLimit","expiresAt","id"]},"undefined_UpdatePrequalificationInputV2":{"type":"object","properties":{"selectedOfferId":{"type":"string","description":"The unique identifier of the selected offer."},"autopayEnrolled":{"type":"boolean","description":"Indicates whether the applicant opted into autopay."},"requestedCreditLine":{"type":"number","description":"The credit line the borrower requested at the prequalification stage.\nBecomes the pricing record's `creditLine.adjusted` at submission.\nBounds (category minimum and the selected offer's maximum) are enforced by the service.","minimum":1},"projectCost":{"type":"number","description":"The cost of the project.","minimum":1},"status":{"description":"The outcome of the prequalification decision asserted by the caller.\nDefaults to `APPROVED` when omitted.","enum":["APPROVED","APPROVED_WITH_STIPS","DECLINED","PENDING","CANCELED"],"type":"string"}}},"undefined_PrequalificationTokenOutput":{"type":"object","properties":{"limitedUseToken":{"type":"string","description":"A redeem token whose scope is narrowed to a prequalification and its\nowning application. The token is not itself a JWT and cannot be used as a\nBearer credential — clients must exchange it with the Directory service\nfor a session JWT."}},"required":["limitedUseToken"]},"undefined_ApplicationApplicantOutput":{"type":"object","properties":{"role":{"description":"The applicant's role on the application.","enum":["APPLICANT","COAPPLICANT"],"type":"string"},"firstName":{"type":"string","description":"The applicant's first name."},"lastName":{"type":"string","description":"The applicant's last name."},"email":{"type":"string","description":"The applicant's email address."},"dropped":{"type":"boolean","description":"Whether the applicant was dropped from the application — either because\nunderwriting excluded them so the other applicant could proceed, or\nbecause the application as a whole was Declined."}},"required":["role","firstName","lastName","email","dropped"]},"undefined_CaseAttachment":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the attachment in UUID v4 format."},"extension":{"type":"string","description":"The extension of the attachment."},"type":{"type":"string","description":"The type of the attachment."},"name":{"type":"string","description":"The name of the attachment."},"label":{"type":"string","description":"A label for the attachment."},"groupId":{"type":"string","description":"Group identifier used to combine multiple uploads."},"status":{"type":"string","description":"The status of the attachment."}},"required":["id","extension","type","name","label","groupId","status"]},"undefined_DocumentToClear":{"type":"object","properties":{"type":{"type":"string","description":"The document type."},"name":{"type":"string","description":"The document name."},"description":{"type":"string","description":"A description of the document to clear."}},"required":["name","description"]},"undefined_ApplicationPendingCaseOutput":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the case in UUID v4 format."},"name":{"type":"string","description":"The name of the case."},"description":{"type":"string","description":"A description of the case."},"reasonCodes":{"description":"The key of the case.","type":"array","items":{"type":"string"}},"status":{"type":"string","description":"The status of the current step."},"type":{"type":"string","description":"The type of the case."},"attachments":{"description":"An array of attachments associated with the case.","type":"array","items":{"$ref":"#/components/schemas/undefined_CaseAttachment"}},"domain":{"type":"string","description":"The actor that has to act on the case."},"deferred":{"type":"boolean","description":"Whether this case blocks NTP."},"createdAt":{"format":"date-time","type":"string","description":"The date and time when the case was created."},"updatedAt":{"format":"date-time","type":"string","description":"The date and time when the case was last updated."},"updatedBy":{"type":"string","description":"The identity that last updated the case."},"appliesTo":{"type":"string","description":"The subject of the case."},"documentsToClear":{"description":"The documents to clear.","type":"array","items":{"$ref":"#/components/schemas/undefined_DocumentToClear"}}},"required":["id","name","description","reasonCodes","status","type","attachments","domain","deferred","createdAt","updatedAt","updatedBy","appliesTo","documentsToClear"]},"undefined_ReapplyAction":{"type":"object","properties":{"description":{"type":"string","description":"The description of the action."},"type":{"type":"string","description":"The type of action."}},"required":["description","type"]},"undefined_Reapply":{"type":"object","properties":{"encouraged":{"type":"boolean","description":"If true, reapplying is encouraged because there are actions the applicant can take to potentially change the decision when they reapply.\nIf false, reapplying is not encouraged for the applicant."},"actions":{"nullable":true,"description":"If `encouraged` is `true`, this will be an array of actions the applicant should take before reapplying.\nIf `encouraged` is `false`, this will be `null` because there are no actions to take.","type":"array","items":{"$ref":"#/components/schemas/undefined_ReapplyAction"}}},"required":["encouraged","actions"]},"undefined_DecisionExplanationReason":{"type":"object","properties":{"reasonCode":{"type":"string","description":"The non-user-friendly code for the reason."},"title":{"type":"string","description":"The title of the reason explanation."},"description":{"type":"string","description":"The description of the reason explanation."}},"required":["reasonCode","title","description"]},"undefined_DecisionExplanation":{"type":"object","properties":{"reapply":{"description":"Information about reapplying based on the decision.","allOf":[{"$ref":"#/components/schemas/undefined_Reapply"}]},"reasons":{"description":"The list of reasons for the decision.","type":"array","items":{"$ref":"#/components/schemas/undefined_DecisionExplanationReason"}}}},"undefined_CreditLineDto":{"type":"object","properties":{"verified":{"type":"number","description":"The verified credit line after underwriting.\nPopulated after the income/CFA case resolves."},"adjusted":{"type":"number","description":"Borrower-requested reduction below the UW ceiling. Sticky — never auto-cleared by offer or\nunderwriting changes; only updated when the borrower explicitly submits a CREDIT_LINE change."},"max":{"type":"number","description":"The maximum credit line sourced from the offer's `maxAmount`. Updated on offer changes."},"effective":{"type":"number","description":"The effective credit line — the smallest of max, verified (if set), and adjusted (if set).\nThe single value downstream consumers should read."}},"required":["max","effective"]},"undefined_SubmitApplicationOutput":{"type":"object","properties":{"financeAccountId":{"type":"string","description":"The human-readable identifier of the finance account.","example":"12-34-567890"},"financeType":{"description":"The finance type.","enum":["loan","lease","ppa","ppav","e-heloc"],"type":"string"},"offerId":{"type":"string","description":"The unique identifier of the offer."},"categoryCode":{"description":"The code of the offer category.","enum":["Solar_TPO","HVAC_LEASE","BATTERY_LEASE","HELOC"],"type":"string"},"categoryId":{"type":"string","description":"The unique identifier of the offer category."},"createdAt":{"format":"date-time","type":"string","description":"The date and time when the finance account was created."},"expiresAt":{"format":"date-time","type":"string","description":"The date and time when credit expires."},"tags":{"description":"Optional user-defined tags added to the application.","type":"array","items":{"type":"string"}},"status":{"description":"The status of the application.","enum":["APPROVED","APPROVED_WITH_STIPS","DECLINED","PENDING","CANCELED"],"type":"string"},"reason":{"type":"string","description":"The reason the application was declined or approved with stips."},"type":{"description":"The decision type.","enum":["SINGLE","COMBINED","PRIMARY","SECONDARY"],"type":"string"},"applicants":{"description":"The applicants on the application, projected to the fields needed by the\ndecision screen.","type":"array","items":{"$ref":"#/components/schemas/undefined_ApplicationApplicantOutput"}},"cases":{"description":"Borrower-facing cases (e.g. document upload stips) that must be resolved\nbefore the account can progress.","type":"array","items":{"$ref":"#/components/schemas/undefined_ApplicationPendingCaseOutput"}},"borrowerActionableUrl":{"type":"string","description":"A URL the borrower can visit to take action on outstanding cases."},"decisionExplanation":{"description":"User-friendly explanation of the underwriting decision, including the list\nof reasons. Populated for non-Approved outcomes.","allOf":[{"$ref":"#/components/schemas/undefined_DecisionExplanation"}]},"creditLine":{"description":"The credit line approved for the HELOC at submission time.\nPopulated for HELOC submissions only.","allOf":[{"$ref":"#/components/schemas/undefined_CreditLineDto"}]},"availableOffers":{"description":"The offers available under the prequalification.\nPopulated for HELOC submissions only.","type":"array","items":{"$ref":"#/components/schemas/undefined_PrequalificationOfferOutputDto"}},"projectReserveLimit":{"type":"number","nullable":true,"description":"The total project reserve limit (project cost + reserve buffer). Populated for HELOC\nsubmissions only. Null for D2C (homeowner-initiated) HELOC finance accounts, which have no\nassociated project cost."},"estimatedMonthlyPayment":{"type":"number","nullable":true,"description":"The estimated monthly payment based on the selected offer and autopay enrollment. Populated for\nHELOC submissions only. Null for D2C (homeowner-initiated) HELOC finance accounts, which have\nno associated project cost."},"autopayEnrolled":{"type":"boolean","description":"Whether the borrower enrolled in autopay at submission time.\nPopulated for HELOC submissions only."}},"required":["financeAccountId","financeType","offerId","categoryCode","categoryId","createdAt","expiresAt","tags","status","reason","type","applicants"]},"undefined_SubmitApplicationInput":{"type":"object","properties":{"prequalificationId":{"type":"string","description":"The ID of the prequalification to use for decisioning. This holds the offer and category information."}},"required":["prequalificationId"]},"undefined_UpdateSubjectPropertyFieldsOutput":{"type":"object","properties":{"legalDescription":{"type":"string","nullable":true,"description":"The full legal description of the property, or `null` if not set."}},"required":["legalDescription"]},"undefined_UpdateSubjectPropertyFieldsInput":{"type":"object","properties":{"legalDescription":{"type":"string","nullable":true,"description":"The full legal description of the property. `null` clears the value;\nwhen provided, it is trimmed and must not be empty or whitespace-only.","maxLength":50000}}},"undefined_PrequalificationOutputV2":{"type":"object","properties":{"projectCost":{"type":"number","nullable":true,"description":"The project cost applied to the prequalification. Null for D2C (homeowner-initiated) HELOC finance accounts, which have no associated project cost."},"requestedCreditLine":{"type":"number","nullable":true,"description":"The credit line the borrower requested at the prequalification stage.\nBecomes the pricing record's `creditLine.adjusted` at submission. Null when\nnone was requested."},"selectedOfferId":{"type":"string","description":"The unique identifier of the selected offer."},"category":{"description":"The category associated with the prequalification.","allOf":[{"$ref":"#/components/schemas/undefined_PrequalificationCategoryDto"}]},"availableOffers":{"description":"The offers available under this prequalification.","type":"array","items":{"$ref":"#/components/schemas/undefined_PrequalificationOfferOutputDto"}},"autopayEnrolled":{"type":"boolean","description":"Indicates whether the applicant opted into autopay."},"projectReserveLimit":{"type":"number","nullable":true,"description":"The total project reserve limit for this prequalification. Null when there is no project cost (D2C/homeowner-initiated HELOC prequalifications) or no featured offer among the available offers."},"createdAt":{"format":"date-time","type":"string","description":"The date and time when the prequalification was created."},"expiresAt":{"format":"date-time","type":"string","description":"The date the prequalification expires."},"status":{"description":"The outcome of the prequalification decision.","enum":["APPROVED","APPROVED_WITH_STIPS","DECLINED","PENDING","CANCELED"],"type":"string"},"mortgageOfficer":{"description":"The mortgage officer assigned to this prequalification, if any.","allOf":[{"$ref":"#/components/schemas/undefined_MortgageOfficerOutputDto"}]},"id":{"type":"string","description":"The unique identifier of the entity."}},"required":["projectCost","requestedCreditLine","category","availableOffers","autopayEnrolled","projectReserveLimit","createdAt","expiresAt","status","id"]},"undefined_OfferDisclaimersDto":{"type":"object","properties":{"offerId":{"type":"object","description":"The unique identifier of the offer these disclaimers describe.","format":"uuid"},"estimatedPaymentConversion":{"description":"Estimated-payment disclaimer paragraphs. Empty when the prequalification\nhas no project cost.","type":"array","items":{"type":"string"}},"variableRate":{"description":"Variable-rate disclaimer paragraphs.","type":"array","items":{"type":"string"}}},"required":["offerId","estimatedPaymentConversion","variableRate"]},"undefined_PrequalificationDisclaimersOutputDto":{"type":"object","properties":{"offers":{"description":"Disclaimers for each available offer.","type":"array","items":{"$ref":"#/components/schemas/undefined_OfferDisclaimersDto"}}},"required":["offers"]},"undefined_PrequalificationOfferEstimateOutputDto":{"type":"object","properties":{"estimatedMonthlyPaymentWithAutopay":{"type":"number","nullable":true,"description":"The estimated monthly payment calculated using the autopay interest rate."},"estimatedMonthlyPaymentWithoutAutopay":{"type":"number","nullable":true,"description":"The estimated monthly payment calculated without the autopay discount."},"id":{"type":"string","description":"The unique identifier of the offer."},"ratesWithAutopay":{"description":"The rate information for the offer with autopay.","allOf":[{"$ref":"#/components/schemas/undefined_PrequalificationOfferRateDto"}]},"ratesWithoutAutopay":{"description":"The rate information for the offer without autopay.","allOf":[{"$ref":"#/components/schemas/undefined_PrequalificationOfferRateDto"}]},"term":{"type":"number","description":"The term of the offer in years."},"maxAmount":{"type":"number","description":"The maximum amount for the offer."},"featured":{"type":"boolean","description":"Indicates whether this offer is featured."},"margins":{"description":"The per-product margin rates of the offer, when supplied by underwriting.","allOf":[{"$ref":"#/components/schemas/undefined_MarginsDto"}]},"dealerFee":{"description":"The dealer fee for the offer, when supplied by underwriting.","allOf":[{"$ref":"#/components/schemas/undefined_DealerFeeDto"}]},"projectCostLimits":{"description":"The project cost limits for the offer.","allOf":[{"$ref":"#/components/schemas/undefined_NumberRangeDto"}]}},"required":["estimatedMonthlyPaymentWithAutopay","estimatedMonthlyPaymentWithoutAutopay","id","ratesWithAutopay","ratesWithoutAutopay","term","maxAmount","featured","projectCostLimits"]},"undefined_PrequalificationPricingEstimatesOutput":{"type":"object","properties":{"projectReserveLimit":{"type":"number","description":"The estimated project reserve limit for the prequalification."},"offers":{"description":"The estimated offers for the prequalification.","type":"array","items":{"$ref":"#/components/schemas/undefined_PrequalificationOfferEstimateOutputDto"}}},"required":["projectReserveLimit","offers"]},"TIMELINE_HealthCheckResponse":{"type":"object","properties":{"status":{"type":"string"}},"required":["status"]},"TIMELINE_status":{"type":"string","enum":["PENDING","IN_PROGRESS","COMPLETE","DISABLED"]},"TIMELINE_icon":{"type":"string","enum":["EMPTY","IN_PROGRESS","COMPLETE","WARNING"]},"TIMELINE_visualState":{"type":"string","enum":["EXPANDED","COLLAPSED"]},"TIMELINE_Model1":{"type":"string","enum":["COMPLETE","WARNING","IN_PROGRESS","LOADING","EMPTY"]},"TIMELINE_action":{"type":"string","enum":["RERUN_UNDERWRITING","SEND_LOAN_DOCS","RESEND_DOCS","REGENERATE_DOCS","REGENERATE_HELOC_DOCS","RESOLVE_CASES","CHANGE_ORDER","EXTERNAL_CHANGE_ORDER","VERIFY_PROJECT_INFO","UPDATE_SOURCE","UPLOAD_HIC","VERIFY_LOAN_DETAILS","CONTRACT_REVIEW","VIEW_CR_FAILURE_REASONS","INSTALL_COMPLETE","RESEND_CPC","REGENERATE_CPC","PERMISSION_TO_OPERATE","CREATE_REFUND_INVOICE","CREATE_NETFUND","SIGN_DOCS","SIGN_CPC","SIGN_CONDITIONAL_RELEASE_CLAIMS","SIGN_FINAL_RELEASE_CLAIMS","CERTIFY_PROJECT","UPLOAD_STIPS","REQUEST_FUNDS","RESEND_REQUEST","GENERATE_DISCLOSURE_DOCUMENT","EDIT_BORROWER","EDIT_COBORROWER","CREATE_PAYOUT_ADJUSTMENT","EDIT_PAYEE","UPDATE_REFERENCE_NUMBER","UPDATE_PROPERTY","APPROVE","DECLINE","CANCEL","EXTERNAL_CANCEL","REVIEW_AGAIN","VIEW_EMAILS","CONVERT_LOAN","CONVERT_RATE","REVIEW_INSTALL_COMPLETE","ADD_PAYEE","REVIEW_ORDERS","RESOLVE_IN_UW_LOAN_DETAILS","RESOLVE_IN_UW_CONTRACT_REVIEW","HOW_TO_RESOLVE","DOM_CON_OVERRIDE","SIGN_WORK_ORDER","UPDATE_PROJECT_DESCRIPTION","UPDATE_UTILITY_INFO","EDIT_CUSTOMER","EDIT_CUSTOMER_2","SEND_PAYMENT_REQUEST_NTP","RESEND_PAYMENT_CONFIRMATION_NTP","RESEND_PAYMENT_CONFIRMATION_IC","REGENERATE_PAYMENT_CONFIRMATION_NTP","REGENERATE_PAYMENT_CONFIRMATION_IC","REGENERATE_PAYMENT_INSTRUMENT_NTP","REGENERATE_PAYMENT_INSTRUMENT_IC","SEND_PAYMENT_REQUEST_IC","RESEND_AGREEEMENT_AMENDMENT","REGENERATE_AGREEEMENT_AMENDMENT","EDIT_SALES_REP_INFO","START_TRANSFER","REVIEW_DOCUMENTS","AGENT_OF_MORTGAGEE_SIGN_DOCUMENT","CANCEL_PROJECT"]},"TIMELINE_Model2":{"type":"object","properties":{"text":{"type":"string"},"link":{"type":"string"},"icon":{"$ref":"#/components/schemas/TIMELINE_Model1"},"action":{"$ref":"#/components/schemas/TIMELINE_action"},"timestamp":{"type":"string"},"key":{"type":"string"}},"required":["text"]},"TIMELINE_items":{"type":"array","items":{"$ref":"#/components/schemas/TIMELINE_Model2"}},"TIMELINE_type":{"type":"string","enum":["RERUN_UNDERWRITING","SEND_LOAN_DOCS","RESEND_DOCS","REGENERATE_DOCS","REGENERATE_HELOC_DOCS","RESOLVE_CASES","CHANGE_ORDER","EXTERNAL_CHANGE_ORDER","VERIFY_PROJECT_INFO","UPDATE_SOURCE","UPLOAD_HIC","VERIFY_LOAN_DETAILS","CONTRACT_REVIEW","VIEW_CR_FAILURE_REASONS","INSTALL_COMPLETE","RESEND_CPC","REGENERATE_CPC","PERMISSION_TO_OPERATE","CREATE_REFUND_INVOICE","CREATE_NETFUND","SIGN_DOCS","SIGN_CPC","SIGN_CONDITIONAL_RELEASE_CLAIMS","SIGN_FINAL_RELEASE_CLAIMS","CERTIFY_PROJECT","UPLOAD_STIPS","REQUEST_FUNDS","RESEND_REQUEST","GENERATE_DISCLOSURE_DOCUMENT","EDIT_BORROWER","EDIT_COBORROWER","CREATE_PAYOUT_ADJUSTMENT","EDIT_PAYEE","UPDATE_REFERENCE_NUMBER","UPDATE_PROPERTY","APPROVE","DECLINE","CANCEL","EXTERNAL_CANCEL","REVIEW_AGAIN","VIEW_EMAILS","CONVERT_LOAN","CONVERT_RATE","REVIEW_INSTALL_COMPLETE","ADD_PAYEE","REVIEW_ORDERS","RESOLVE_IN_UW_LOAN_DETAILS","RESOLVE_IN_UW_CONTRACT_REVIEW","HOW_TO_RESOLVE","DOM_CON_OVERRIDE","SIGN_WORK_ORDER","UPDATE_PROJECT_DESCRIPTION","UPDATE_UTILITY_INFO","EDIT_CUSTOMER","EDIT_CUSTOMER_2","SEND_PAYMENT_REQUEST_NTP","RESEND_PAYMENT_CONFIRMATION_NTP","RESEND_PAYMENT_CONFIRMATION_IC","REGENERATE_PAYMENT_CONFIRMATION_NTP","REGENERATE_PAYMENT_CONFIRMATION_IC","REGENERATE_PAYMENT_INSTRUMENT_NTP","REGENERATE_PAYMENT_INSTRUMENT_IC","SEND_PAYMENT_REQUEST_IC","RESEND_AGREEEMENT_AMENDMENT","REGENERATE_AGREEEMENT_AMENDMENT","EDIT_SALES_REP_INFO","START_TRANSFER","REVIEW_DOCUMENTS","AGENT_OF_MORTGAGEE_SIGN_DOCUMENT","CANCEL_PROJECT"]},"TIMELINE_state":{"type":"string","enum":["FILLED","EMPTY"]},"TIMELINE_availableTo":{"type":"array","items":{"type":"string"}},"TIMELINE_Model3":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/TIMELINE_type"},"title":{"type":"string"},"state":{"$ref":"#/components/schemas/TIMELINE_state"},"link":{"type":"string"},"availableTo":{"$ref":"#/components/schemas/TIMELINE_availableTo"},"requiresAllPreviousSteps":{"type":"boolean"}},"required":["type","title","state"]},"TIMELINE_actions":{"type":"array","items":{"$ref":"#/components/schemas/TIMELINE_Model3"}},"TIMELINE_AccountSection":{"type":"object","properties":{"cardIndex":{"type":"number"},"title":{"type":"string"},"key":{"type":"string"},"status":{"$ref":"#/components/schemas/TIMELINE_status"},"icon":{"$ref":"#/components/schemas/TIMELINE_icon"},"visualState":{"$ref":"#/components/schemas/TIMELINE_visualState"},"items":{"$ref":"#/components/schemas/TIMELINE_items"},"actions":{"$ref":"#/components/schemas/TIMELINE_actions"},"dateComplete":{"type":"string"},"nextRefresh":{"type":"number"}},"required":["title","key","status","icon","visualState"]},"TIMELINE_sections":{"type":"array","items":{"$ref":"#/components/schemas/TIMELINE_AccountSection"}},"TIMELINE_waitingOn":{"type":"array","items":{"type":"string"}},"TIMELINE_AvailableAction":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/TIMELINE_type"},"title":{"type":"string"},"sort":{"type":"number"},"priority":{"type":"boolean"},"link":{"type":"string"}},"required":["type","title"]},"TIMELINE_availableActions":{"type":"array","items":{"$ref":"#/components/schemas/TIMELINE_AvailableAction"}},"TIMELINE_Model4":{"type":"object","properties":{"reason":{"type":"string"},"message":{"type":"string"}}},"TIMELINE_reasons":{"type":"array","items":{"$ref":"#/components/schemas/TIMELINE_Model4"}},"TIMELINE_UnavailableAction":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/TIMELINE_type"},"reasons":{"$ref":"#/components/schemas/TIMELINE_reasons"}}},"TIMELINE_unavailableActions":{"type":"array","items":{"$ref":"#/components/schemas/TIMELINE_UnavailableAction"}},"TIMELINE_AccountHistoryItem":{"type":"object","properties":{"eventName":{"type":"string"},"timestamp":{"type":"string"},"userDisplayName":{"type":"string"},"orgDisplayName":{"type":"string"},"triggeredBy":{"type":"string"}},"required":["eventName","timestamp"]},"TIMELINE_history":{"type":"array","items":{"$ref":"#/components/schemas/TIMELINE_AccountHistoryItem"}},"TIMELINE_AccountTimelineDataPayload":{"type":"object","properties":{"sections":{"$ref":"#/components/schemas/TIMELINE_sections"},"lastCompletedMilestone":{"type":"string"},"waitingOn":{"$ref":"#/components/schemas/TIMELINE_waitingOn"},"availableActions":{"$ref":"#/components/schemas/TIMELINE_availableActions"},"unavailableActions":{"$ref":"#/components/schemas/TIMELINE_unavailableActions"},"history":{"$ref":"#/components/schemas/TIMELINE_history"}}},"TIMELINE_AccountTimelineDataResponse":{"type":"object","properties":{"payload":{"$ref":"#/components/schemas/TIMELINE_AccountTimelineDataPayload"}}},"TIMELINE_AvailableActions":{"type":"array","items":{"$ref":"#/components/schemas/TIMELINE_AvailableAction"}},"TIMELINE_UnavailableActions":{"type":"array","items":{"$ref":"#/components/schemas/TIMELINE_UnavailableAction"}},"TIMELINE_AccountActionsPayload":{"type":"object","properties":{"availableActions":{"$ref":"#/components/schemas/TIMELINE_AvailableActions"},"unavailableActions":{"$ref":"#/components/schemas/TIMELINE_UnavailableActions"}}},"TIMELINE_AccountActionsResponse":{"type":"object","properties":{"payload":{"$ref":"#/components/schemas/TIMELINE_AccountActionsPayload"}}},"TIMELINE_AccountTimelineSection":{"type":"array","items":{"$ref":"#/components/schemas/TIMELINE_AccountSection"}},"TIMELINE_AccountTimelinePayload":{"type":"object","properties":{"sections":{"$ref":"#/components/schemas/TIMELINE_AccountTimelineSection"},"lastCompletedMilestone":{"type":"string"},"waitingOn":{"$ref":"#/components/schemas/TIMELINE_waitingOn"}}},"TIMELINE_AccountTimelineResponse":{"type":"object","properties":{"payload":{"$ref":"#/components/schemas/TIMELINE_AccountTimelinePayload"}}},"TIMELINE_Model5":{"type":"string","enum":["UPLOAD_STIPS","CANCEL","EXTERNAL_CANCEL","CHANGE_ORDER","EXTERNAL_CHANGE_ORDER","VERIFY_PROJECT_INFO","INSTALL_COMPLETE","PERMISSION_TO_OPERATE","RESOLVE_CASES","SEND_LOAN_DOCS","UPDATE_SOURCE","UPLOAD_HIC","VERIFY_LOAN_DETAILS","RESEND_DOCS","RESEND_CPC","REGENERATE_CPC"]},"TIMELINE_Model6":{"type":"string","enum":["BORROWER","LOAN_PARTIES","GOODLEAP"]},"TIMELINE_owners":{"type":"array","items":{"$ref":"#/components/schemas/TIMELINE_Model6"}},"TIMELINE_Model7":{"type":"string","enum":["UPLOAD","REDIRECT","API"]},"TIMELINE_method":{"type":"string","enum":["GET","POST","PUT","REDIRECT"]},"TIMELINE_actionUrl":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/TIMELINE_Model7"},"method":{"$ref":"#/components/schemas/TIMELINE_method"},"path":{"type":"string"}},"required":["type","method"]},"TIMELINE_Model8":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/TIMELINE_Model5"},"name":{"type":"string"},"owners":{"$ref":"#/components/schemas/TIMELINE_owners"},"actionUrl":{"$ref":"#/components/schemas/TIMELINE_actionUrl"},"link":{"type":"string"}},"required":["type","name"]},"TIMELINE_Model9":{"type":"array","items":{"$ref":"#/components/schemas/TIMELINE_Model8"}},"TIMELINE_data":{"type":"object","properties":{"actions":{"$ref":"#/components/schemas/TIMELINE_Model9"}}},"TIMELINE_Model10":{"type":"object","properties":{"message":{"type":"string"}}},"TIMELINE_errors":{"type":"array","items":{"$ref":"#/components/schemas/TIMELINE_Model10"}},"TIMELINE_LoanActionsResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/TIMELINE_data"},"errors":{"$ref":"#/components/schemas/TIMELINE_errors"}}},"TIMELINE_Model11":{"type":"object","properties":{"description":{"type":"string","example":"Invalid credentials"},"status":{"type":"number","example":401,"enum":[null]}},"required":["description","status"]},"TIMELINE_Model12":{"type":"object","properties":{"description":{"type":"string","example":"Entity is not found"},"reason":{"type":"string","example":"LOAN_NOT_FOUND"},"status":{"type":"number","example":404,"enum":[null]}},"required":["description","status"]},"TIMELINE_Model13":{"type":"array","items":{"type":"string"}},"TIMELINE_milestone":{"type":"string","enum":["APPROVAL","NTP","FUNDING"]},"TIMELINE_children":{"type":"array","items":{"type":"string"}},"TIMELINE_Model14":{"type":"object","properties":{"title":{"type":"string"},"key":{"type":"string"},"status":{"$ref":"#/components/schemas/TIMELINE_status"},"items":{"$ref":"#/components/schemas/TIMELINE_Model13"},"dateComplete":{"type":"string"},"milestone":{"$ref":"#/components/schemas/TIMELINE_milestone"},"children":{"$ref":"#/components/schemas/TIMELINE_children"}},"required":["title","key","status","milestone"]},"TIMELINE_Model15":{"type":"array","items":{"$ref":"#/components/schemas/TIMELINE_Model14"}},"TIMELINE_timeline":{"type":"object","properties":{"sections":{"$ref":"#/components/schemas/TIMELINE_Model15"}}},"TIMELINE_Model16":{"type":"object","properties":{"timeline":{"$ref":"#/components/schemas/TIMELINE_timeline"}}},"TIMELINE_Model17":{"type":"object","properties":{"message":{"type":"string"}}},"TIMELINE_Model18":{"type":"array","items":{"$ref":"#/components/schemas/TIMELINE_Model17"}},"TIMELINE_TimelineResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/TIMELINE_Model16"},"errors":{"$ref":"#/components/schemas/TIMELINE_Model18"}}},"TIMELINE_triggeredBy":{"type":"string","enum":["GOODLEAP","PARTNER","BORROWER","COBORROWER","SYSTEM","USER","USER_OR_SYSTEM"]},"TIMELINE_Model19":{"type":"object","properties":{"eventName":{"type":"string","example":"Application submitted"},"timestamp":{"type":"string","example":"2023-03-22T17:11:15.0097"},"triggeredBy":{"$ref":"#/components/schemas/TIMELINE_triggeredBy"},"userName":{"type":"string","example":"John Doe"},"organizationName":{"type":"string","example":"Solar Test Partner"}},"required":["eventName","timestamp"]},"TIMELINE_payload":{"type":"array","items":{"$ref":"#/components/schemas/TIMELINE_Model19"}},"TIMELINE_Model20":{"type":"object","properties":{"payload":{"$ref":"#/components/schemas/TIMELINE_payload"}}},"TIMELINE_lastCompletedMilestone":{"type":"string","enum":["SUBMITTED","APPROVED","DOCS_COMPLETED","PROJECT_INFO_ENTERED","VLD_COMPLETE","CONTRACT_REVIEW_COMPLETE","NTP_COMPLETE","INSTALLATION_COMPLETE","CPC_COMPLETE","FUNDED","PTO_COMPLETE"]},"TIMELINE_Model21":{"type":"string","enum":["GOODLEAP","PARTNER","BORROWER"]},"TIMELINE_Model22":{"type":"array","items":{"$ref":"#/components/schemas/TIMELINE_Model21"}},"TIMELINE_Model23":{"type":"object","enum":[{"value":{}}],"properties":{"lastCompletedMilestone":{"$ref":"#/components/schemas/TIMELINE_lastCompletedMilestone"},"waitingOn":{"$ref":"#/components/schemas/TIMELINE_Model22"},"lastUpdated":{"type":"string"}},"required":["lastCompletedMilestone","waitingOn","lastUpdated"]},"TIMELINE_Model24":{"type":"object","properties":{"message":{"type":"string"}}},"TIMELINE_Model25":{"type":"array","items":{"$ref":"#/components/schemas/TIMELINE_Model24"}},"TIMELINE_LoanStageResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/TIMELINE_Model23"},"errors":{"$ref":"#/components/schemas/TIMELINE_Model25"}}},"TIMELINE_Model26":{"type":"string","enum":["PENDING","IN_PROGRESS","COMPLETE","WARNING"]},"TIMELINE_Model27":{"type":"array","items":{"type":"string"}},"TIMELINE_Model28":{"type":"object","properties":{"title":{"type":"string"},"key":{"type":"string"},"status":{"$ref":"#/components/schemas/TIMELINE_Model26"},"items":{"$ref":"#/components/schemas/TIMELINE_Model27"},"dateComplete":{"type":"string"}},"required":["title","key","status"]},"TIMELINE_Model29":{"type":"object","properties":{"message":{"type":"string"}}},"TIMELINE_Model30":{"type":"array","items":{"$ref":"#/components/schemas/TIMELINE_Model29"}},"TIMELINE_LoanMilestoneResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/TIMELINE_Model28"},"errors":{"$ref":"#/components/schemas/TIMELINE_Model30"}}},"TIMELINE_Model31":{"type":"string","enum":["COMPLETE","WARNING","IN_PROGRESS","LOADING","EMPTY"]},"TIMELINE_Model32":{"type":"object","properties":{"text":{"type":"string"},"link":{"type":"string"},"icon":{"$ref":"#/components/schemas/TIMELINE_Model31"},"action":{"$ref":"#/components/schemas/TIMELINE_action"},"timestamp":{"type":"string"},"key":{"type":"string"}},"required":["text"]},"TIMELINE_Model33":{"type":"array","items":{"$ref":"#/components/schemas/TIMELINE_Model32"}},"TIMELINE_Model34":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/TIMELINE_type"},"title":{"type":"string"},"state":{"$ref":"#/components/schemas/TIMELINE_state"},"link":{"type":"string"},"availableTo":{"$ref":"#/components/schemas/TIMELINE_availableTo"},"requiresAllPreviousSteps":{"type":"boolean"}},"required":["type","title","state"]},"TIMELINE_Model35":{"type":"array","items":{"$ref":"#/components/schemas/TIMELINE_Model34"}},"TIMELINE_Model36":{"type":"object","properties":{"cardIndex":{"type":"number"},"title":{"type":"string"},"key":{"type":"string"},"status":{"$ref":"#/components/schemas/TIMELINE_status"},"icon":{"$ref":"#/components/schemas/TIMELINE_icon"},"visualState":{"$ref":"#/components/schemas/TIMELINE_visualState"},"items":{"$ref":"#/components/schemas/TIMELINE_Model33"},"actions":{"$ref":"#/components/schemas/TIMELINE_Model35"},"dateComplete":{"type":"string"},"nextRefresh":{"type":"number"},"milestone":{"$ref":"#/components/schemas/TIMELINE_milestone"},"children":{"$ref":"#/components/schemas/TIMELINE_children"}},"required":["title","key","status"]},"TIMELINE_Model37":{"type":"array","items":{"$ref":"#/components/schemas/TIMELINE_Model36"}},"TIMELINE_TimelineV2Payload":{"type":"object","properties":{"sections":{"$ref":"#/components/schemas/TIMELINE_Model37"}}},"TIMELINE_TimelineV2Response":{"type":"object","properties":{"payload":{"$ref":"#/components/schemas/TIMELINE_TimelineV2Payload"}}},"TIMELINE_Model38":{"type":"object","properties":{"reason":{"type":"string"},"message":{"type":"string"}}},"TIMELINE_Model39":{"type":"array","items":{"$ref":"#/components/schemas/TIMELINE_Model38"}},"TIMELINE_Model40":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/TIMELINE_type"},"reasons":{"$ref":"#/components/schemas/TIMELINE_Model39"}}},"TIMELINE_Model41":{"type":"array","items":{"$ref":"#/components/schemas/TIMELINE_Model40"}},"TIMELINE_V2LoanActionsPayload":{"type":"object","properties":{"availableActions":{"$ref":"#/components/schemas/TIMELINE_AvailableActions"},"unavailableActions":{"$ref":"#/components/schemas/TIMELINE_Model41"}}},"TIMELINE_V2LoanActionsResponse":{"type":"object","properties":{"payload":{"$ref":"#/components/schemas/TIMELINE_V2LoanActionsPayload"}}},"TIMELINE_loanIds":{"type":"array","minItems":1,"items":{"type":"string","pattern":"^\\d{2}-\\d{2}-\\d{6}$"}},"TIMELINE_Model42":{"type":"object","properties":{"loanIds":{"$ref":"#/components/schemas/TIMELINE_loanIds"}},"required":["loanIds"]},"TIMELINE_Model43":{"type":"string","enum":["GOODLEAP","PARTNER","BORROWER"]},"TIMELINE_Model44":{"type":"array","items":{"$ref":"#/components/schemas/TIMELINE_Model43"}},"TIMELINE_Model45":{"type":"object","properties":{"lastCompletedMilestone":{"$ref":"#/components/schemas/TIMELINE_lastCompletedMilestone"},"waitingOn":{"$ref":"#/components/schemas/TIMELINE_Model44"},"lastUpdated":{"type":"string"},"loanId":{"type":"string"}},"required":["lastCompletedMilestone","waitingOn","lastUpdated","loanId"]},"TIMELINE_Model46":{"type":"array","items":{"$ref":"#/components/schemas/TIMELINE_Model45"}},"TIMELINE_Model47":{"type":"object","properties":{"message":{"type":"string"}}},"TIMELINE_Model48":{"type":"array","default":null,"items":{"$ref":"#/components/schemas/TIMELINE_Model47"}},"TIMELINE_Model49":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/TIMELINE_Model46"},"errors":{"$ref":"#/components/schemas/TIMELINE_Model48"}},"required":["data"]},"SchemaObject1":{"title":"ApiResponseOfFindHomeMortgageDisclosuresOutputDto","allOf":[{"$ref":"#/components/schemas/SUBMISSION_ApiResponse"},{"properties":{"payload":{"$ref":"#/components/schemas/SUBMISSION_FindHomeMortgageDisclosuresOutputDto"}}}]},"SchemaObject2":{"allOf":[{"$ref":"#/components/schemas/SUBMISSION_ApiError"}]},"SchemaObject3":{"title":"ApiResponseOfGetMortgageOfficerOutputDto","allOf":[{"$ref":"#/components/schemas/SUBMISSION_ApiResponse"},{"properties":{"payload":{"$ref":"#/components/schemas/SUBMISSION_GetMortgageOfficerOutputDto"}}}]},"SchemaObject4":{"title":"ApiResponseOfPrequalificationOutputV2","allOf":[{"$ref":"#/components/schemas/undefined_ApiResponse"},{"properties":{"payload":{"$ref":"#/components/schemas/undefined_PrequalificationOutputV2"}}}]},"SchemaObject5":{"allOf":[{"$ref":"#/components/schemas/undefined_ApiError"}]},"SchemaObject6":{"title":"ApiResponseOfMortgageOfficerOutputDto","allOf":[{"$ref":"#/components/schemas/SUBMISSION_ApiResponse"},{"properties":{"payload":{"$ref":"#/components/schemas/SUBMISSION_MortgageOfficerOutputDto"}}}]},"SchemaObject7":{"title":"ApiResponseOfPrequalificationDisclaimersOutputDto","allOf":[{"$ref":"#/components/schemas/undefined_ApiResponse"},{"properties":{"payload":{"$ref":"#/components/schemas/undefined_PrequalificationDisclaimersOutputDto"}}}]},"SchemaObject8":{"title":"ApiResponseOfPrequalificationPricingEstimatesOutput","allOf":[{"$ref":"#/components/schemas/undefined_ApiResponse"},{"properties":{"payload":{"$ref":"#/components/schemas/undefined_PrequalificationPricingEstimatesOutput"}}}]},"SchemaObject9":{"title":"ApiResponseOfShareApplicationOutput","allOf":[{"$ref":"#/components/schemas/undefined_ApiResponseWithPagination"},{"properties":{"payload":{"type":"array","items":{"$ref":"#/components/schemas/undefined_ShareApplicationOutput"}}}}]},"SchemaObject10":{"title":"ApiResponseOfSubmitApplicationOutput","allOf":[{"$ref":"#/components/schemas/undefined_ApiResponse"},{"properties":{"payload":{"$ref":"#/components/schemas/undefined_SubmitApplicationOutput"}}}]},"SchemaObject11":{"type":"object","properties":{"id":{"type":"string","format":"uuid"}},"additionalProperties":false,"title":"SavingsScheduleResponseSchema"},"SchemaObject12":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string","example":"Entity cannot exceed 100000. Must be less than that."},"code":{"type":"string","enum":["INVALID_DISCLOSURE_TYPE_HELOC_ONLY","INVALID_DISCLOSURE_TYPE_TPO_ONLY","INVALID_SIGNING_STRATEGY","VALIDATION","APPLICANT_ROLE_MUST_BE_UNIQUE","APPLICANT_ADDRESS_MUST_BE_SUBJECT_PROPERTY","APPLICANT_BELOW_MINIMUM_AGE","APPLICANT_HAS_ACTIVE_LEASE","APPLICANT_HAS_ACTIVE_LOAN","APPLICANT_HOME_OCCUPANCY","APPLICATION_MAXIMUM_LOAN_AMOUNT","APPLICATION_MINIMUM_LOAN_AMOUNT","APPLICATION_STATE_SUBJECT_PROPERTY_STATE_MISMATCH","AT_LEAST_ONE_APPLICANT_OWNS_THE_HOME","BAD_INPUT","INVALID_DATE_FORMAT","BATTERY_PROJECT_INVALID_COMPONENT_TYPE","BATTERY_PROJECT_ONE_BATTERY_ALLOWED","CANCELLATION_NOT_ALLOWED_ON_STATUS","CHANGE_ORDER_AFTER_INSTALL_COMPLETE","CHANGE_ORDER_BEFORE_APPROVED","CHANGE_ORDER_AFTER_READY_TO_FUND","CHANGE_ORDER_EMPTY","CASE_NOT_FOUND","NO_ACTIONABLE_CASE","CASE_ACTION_NOT_VALID","COAPPLICANT_CANNOT_BE_APPLICANT","CONFIG_ISSUE","CONTRACT_REVIEW_MISSING_ITEMS","CPC_ALREADY_COMPLETE","DOCS_REQUEST_NOT_ALLOWED_ON_STATUS","DUPLICATE_CHANGE_ORDER_TYPE","EMPLOYMENT_DURATION_REQUIRED","EXTRAPAYDOWN_PERCENTAGE_EXCEEDED","EXTRAPAYDOWN_AMOUNT_EXCEEDED","FILTER_COMBINATION_NOT_ALLOWED","FUNDS_NOT_AVAILABLE_OR_RELEASED","FIELD_REQUIRED_FOR_FINANCE_TYPE","HIC_BELOW_THRESHOLD","HOME_VALIDATION","INVALID_ACCESS_TOKEN","INVALID_ACCOUNT_NUMBER","INVALID_ADDRESS","INVALID_APPLICATION_STATE","INVALID_APPLICATION_TOKEN","INVALID_CALCULATOR_INPUT","INVALID_CONTRACT_REVIEW","INVALID_CHANGE_ORDER_ACTION","INVALID_CHANGE_ORDER","INVALID_CHANGE_ORDER_SUB650","INVALID_CHANNEL","INVALID_CITIZENSHIP_STATUS","INVALID_CPC_CATEGORY","Invalid disclosures input","Disclosure token is invalid","INVALID_PAYEE","INVALID_DOB_FORMAT","INVALID_DOB_VALUE","INVALID_DOCUMENT","INVALID_EMAIL","INVALID_EMPLOYMENT_DURATION","INVALID_ENROLLMENT","INVALID_FIELD_FOR_CASE","INVALID_FILE_EXTENSION","INVALID_GROUP","INVALID_INPUT_PROMOTION_ID","INVALID_INSTALL_CATEGORY","INVALID_INSTALL_CATEGORY_ID","INVALID_LOAN_OFFER","INVALID_LOAN_ID","INVALID_MILESTONE","INVALID_MIME_TYPE","INVALID_OFFER","INVALID_ORDER_AMOUNT","INVALID_ORDER_STATE","INVALID_ORG_ID","INVALID_ORG_CONNECTION","INVALID_ORGANIZATION_TYPE","INVALID_PARTY_FORMAT","INVALID_PARTY_INPUT","INVALID_PERCENTAGE","INVALID_PHONE","INVALID_POSTAL_CODE","INVALID_PRIMARY_PROJECT_TYPE","INVALID_REDIRECT","INVALID_REFRESH_TOKEN","INVALID_ROUTING_NUMBER","INVALID_SSN","INVALID_STATE","INVALID_SUBMITTING_USER_EMAIL","INVALID_TIMESTAMP","INVALID_USER","INVALID_PROMOTION_ID","LOAN_AMOUNT_MISMATCH","LOAN_ID_DIFFERENT_FROM_CASE","LOAN_FILTER_REQUIRED","LOAN_OFFER_MISMATCH","LOAN_OFFER_MISSING_PROGRAM_FEE","LOAN_OFFER_NOT_ALLOWED_IN_STATE","LOAN_OFFER_NOT_VALID_FOR_INSTALL_CATEGORY","LOAN_OPTION_CHANNEL_MISSING","LOAN_SHARE_REQUIRES_VALID_SALES_REP","LOAN_TYPE_REQUIRES_MANUFACTURED_HOME_TYPE","LOAN_TYPE_REQUIRES_VALID_SALES_REP","LOAN_ALREADY_OPERATIONAL","MANUFACTURER_NOT_APPROVED","MAXIMUM_LENGTH_EXCEEDED","MAXIMUM_LOAN_AMOUNT","MAXIMUM_LOAN_TAGS_EXCEEDED","MILESTONE_AFTER_CREDIT_EXPIRED","MILESTONE_BEFORE_CONTRACT_UPLOAD","MILESTONE_BEFORE_DOCS_COMPLETED","MILESTONE_BEFORE_INSTALLATION_COMPLETE","MILESTONE_BEFORE_LOAN_APPROVED","MILESTONE_BEFORE_NTP","MILESTONE_BEFORE_SYSTEM_INFO","MILESTONE_COMPLETED","MILESTONE_INSTALL_COMPLETE_COMPLETED","MILESTONE_PTO_COMPLETE_COMPLETED","MILESTONE_PTO_COMPLETE_CASES","MILESTONE_INSTALL_COMPLETE_CASES","MINIMUM_LOAN_AMOUNT","MISSING_OFFER_ID","MISSING_ORG_ID","MISSING_ADDRESS_REQUIRED_FIELDS","MORTGAGE_INFO_REQUIRED","MORTGAGE_TOTAL_BALANCES_REQUIRED","MORTGAGE_TOTAL_PAYMENTS_REQUIRED","OFFER_CALCULATION_LIMIT","ONLY_SOLAR_OR_BATTERY","ORGANIZATION_CONNECTION_CONFIGURATION","ORG_NOT_CONFIGURED_FOR_LOAN_APPS","ORG_PRODUCT_ID_REQUIRED","ORG_REQUIRES_LOAN_AMOUNT","ORG_REQUIRES_PROJECT_COST","ORG_REQUIRES_REF_NUMBER","PAGE_BEFORE_AND_PAGE_AFTER_BOTH_PROVIDED","PAGE_SIZE_CHANGED_MID_PAGINATION","PAYDOWN_NOT_PERMITTED","PAYDOWN_PERCENTAGE_NOT_PERMITTED","PAYDOWN_AMOUNT_NOT_PERMITTED","PO_BOX_NOT_ALLOWED","UNAUTHORIZED_TO_CREATE_APPLICATION","PROJECT_INVALID_PROVIDED_DATA","PROJECT_SCHEMA_VALIDATION_FAILED","PROJECT_UNKNOWN_TYPE","PROJECT_UPDATE_AFTER_REVIEW_COMPLETED","PROJECT_UPDATE_BATTERY_REQUIRED_PROPERTIES","PROJECT_UPDATE_MAXIMUM_BATTERY_QUANTITY","PROJECT_UPDATE_SOLAR_REQUIRED_COMPONENTS","PROJECT_UPDATE_SOLAR_UNIQUE_COMPONENTS","PROJECT_UPDATE_WITHOUT_SIGNED_DOCS","PROMOTIONS_NOT_SUPPORTED","QUERY_PARAM_NOT_AVAILABLE","QUERY_PARAM_NOT_SUPPORTED","RECIPIENT_NOT_IN_SEQUENCE","REQUEST_BODY_FIELD_NOT_AVAILABLE","REQUEST_BODY_FIELD_NOT_SUPPORTED","SYSTEM_DESIGN_TYPE_NOT_DETECTED","SYSTEM_DESIGN_REQUIRED","INVALID_CHANGE_ORDER_PAYLOAD","UNCHANGED_LOAN_OPTION","UNCHANGED_LOAN_ENROLLMENTS","UNSUPPORTED_ACCESS","USER_ALREADY_EXISTS","USER_VERIFICATION_REQUIRED","VERIFY_INVALID_AMOUNT","VERIFY_INVALID_DOCUMENT","VERIFY_ALREADY_COMPLETED","VERIFY_BEFORE_CONTRACT_UPLOAD","VERIFY_BEFORE_SYSTEM_INFO","VLD_NOT_REQUIRED","V2_LOAN_NOT_ENABLED","SIGNING_URL_NOT_READY","ROLE_DOES_NOT_EXIST_FOR_DOCUMENT","DOCUMENT_ROLE_NOT_CONFIGURED_FOR_EMBEDDED_SIGNING","SIGNING_STRATEGY_ALREADY_USED","SIGNING_STRATEGY_UNAVAILABLE","INVALID_DOCUMENT_STATE","ROLE_OUT_OF_SEQUENCE","UNAUTHENTICATED","API_NOT_AVAILABLE","FORBIDDEN","PERMISSIONS","DISCLOSURES_NOT_FOUND","DOCUMENT_NOT_FOUND","INSTALL_CATEGORY_NOT_FOUND","ITC_FAILED","LOAN_NOT_FOUND","LOAN_OFFER_NOT_FOUND","LOAN_STATUS_NOT_FOUND","ORG_NOT_FOUND","PAYMENT_INFO_NOT_FOUND","SALESFORCE_NOT_FOUND","STIPULATION_NOT_FOUND","USER_NOT_FOUND","V2_LOAN","RESOURCE_NOT_FOUND","USER_ROLE_NOT_FOUND","DOCUMENTS_NOT_FOUND","TERMS_NOT_FOUND","NOT_FOUND","SYSTEM_DESIGN_NOT_FOUND","UTILITY_INFO_NOT_FOUND","SAVINGS_SCHEDULE_NOT_FOUND","ORDER_NOT_FOUND","CHANGE_ORDER_NOT_ALLOWED_ON_STATUS","CPC_NOT_ALLOWED_ON_STATUS","CONFLICT","DOCUMENTS_REQUIRE_ADDITIONAL_INFORMATION","MILESTONE_NOT_ALLOWED_ON_STATUS","MILESTONE_PTO_NOT_ALLOWED_ON_STATUS","UPLOAD_NOT_ALLOWED_ON_STATUS","OPERATIONALIZE_LOAN_NOT_ALLOWED_ON_STATUS","ORDER_MODIFICATION_NOT_ALLOWED_ON_STATUS","ACTION_REQUIRES_APPROVED_STATUS","PROJECT_UPDATE_NOT_ALLOWED_ON_STATUS","VERIFY_AFTER_INSTALL_COMPLETE","VERIFY_AFTER_READY_TO_FUND","VERIFY_INVALID_MAX_AMOUNT","VERIFY_LOAN_NOT_APPROVED","FUNDING_NOT_ALLOWED_ON_STATUS","REFRESH_TOKEN_ALREADY_REDEEMED","FILE_ALREADY_UPLOADED","ORDER_REQUIRES_UPLOADED_PROJECT","SUBMIT_ORDER_IN_PROGRESS","CREDIT_EXPIRED","ACCOUNT_NOT_PROCESSABLE","UNPROCESSABLE_ENTITY","CASE_NOT_PROCESSED","INVALID_ORDER_ACTION","LOAN_NOT_OPERATIONAL","TOO_MANY_REQUESTS","INTERNAL_SERVER_ERROR","UPDATE_CASE_INVALID_JSON","NOT_IMPLEMENTED"],"example":"BAD_INPUT"},"type":{"type":"string","enum":["VALIDATION"]}},"required":["description"],"additionalProperties":false,"title":"BadRequestSchema"},"description":"A list of detailed errors.","title":"ListBadRequestSchema"},"SchemaObject13":{"type":"object","properties":{"statusCode":{"type":"number","format":"float","example":401},"error":{"type":"string","example":"Unauthorized"},"message":{"type":"string","example":"Unauthorized"}},"required":["statusCode","error","message"],"additionalProperties":false,"title":"ExternalUnauthorizedResponseSchema"},"SchemaObject14":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string","example":"This api is not available for this organization."},"type":{"type":"string","enum":["FORBIDDEN"]},"code":{"type":"string"}},"required":["description","code"],"additionalProperties":false,"title":"ForbiddenResponseSchema"},"description":"A list of detailed errors.","title":"ListForbiddenResponseSchema"},"SchemaObject15":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string"},"type":{"type":"string","enum":["NOT_FOUND"]},"code":{"type":"string"}},"required":["description","code"],"additionalProperties":false,"title":"NotFoundResponseSchema"},"description":"A list of detailed errors.","title":"ListNotFoundResponseSchema"},"SchemaObject16":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string","example":"Uh oh, looks like something went wrong. We will check it out."},"type":{"type":"string","enum":["SERVER"]},"code":{"type":"string","enum":["INTERNAL_SERVER_ERROR"]}},"required":["description"],"additionalProperties":false,"title":"ServerErrorResponseSchema"},"description":"A list of detailed errors.","title":"ListServerErrorResponseSchema"},"SchemaObject17":{"title":"ApiResponseOfSignedDisclosureOutput","allOf":[{"$ref":"#/components/schemas/undefined_ApiResponseWithPagination"},{"properties":{"payload":{"type":"array","items":{"$ref":"#/components/schemas/undefined_SignedDisclosureOutput"}}}}]}}},"paths":{"/posfinancing/rest/v2/finance-accounts":{"get":{"parameters":[{"name":"searchFor","in":"query","schema":{"type":"string"},"x-position":1},{"name":"fieldsToInclude","in":"query","schema":{"type":"string","default":""},"x-position":2},{"name":"cursor","in":"query","schema":{"type":"string","default":""},"x-position":3},{"name":"limit","in":"query","schema":{"type":"integer","format":"int32","default":20},"x-position":4},{"name":"pageNumber","in":"query","schema":{"type":"integer","format":"int32","nullable":true},"x-position":5}],"responses":{"200":{"description":"","content":{"application/json;version=1":{"schema":{"$ref":"#/components/schemas/LSS_ResponseViewModelOfIReadOnlyCollectionOfSearchableFinanceAccountAndMeta"}}}},"400":{"description":"","content":{"application/json;version=1":{"schema":{"$ref":"#/components/schemas/LSS_ProblemDetails"}}}}},"description":" Required Authorization Claims: lss_can_do_everything_tpo,lss_can_search_organization_tpo,lss_can_search_own_tpo, ","tags":["FinanceAccounts"],"security":[{"jwt":[]}]},"post":{"parameters":[{"name":"cursor","in":"query","schema":{"type":"string","default":""},"x-position":2},{"name":"limit","in":"query","schema":{"type":"integer","format":"int32","default":20},"x-position":3},{"name":"pageNumber","in":"query","schema":{"type":"integer","format":"int32","nullable":true},"x-position":4}],"requestBody":{"x-name":"parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LSS_FinanceAccountSearchParameters"}}},"required":true,"x-position":1},"responses":{"200":{"description":"","content":{"application/json;version=1":{"schema":{"$ref":"#/components/schemas/LSS_ResponseViewModelOfIReadOnlyCollectionOfSearchableFinanceAccountAndMeta"}}}},"400":{"description":"","content":{"application/json;version=1":{"schema":{"$ref":"#/components/schemas/LSS_ProblemDetails"}}}}},"description":" Required Authorization Claims: lss_can_do_everything_tpo,lss_can_search_organization_tpo,lss_can_search_own_tpo, ","tags":["FinanceAccounts"],"security":[{"jwt":[]}]}},"/posfinancing/rest/v2/home-mortgage-disclosures":{"get":{"parameters":[{"name":"lifecycleStatus","required":false,"in":"query","description":"The lifecycle status to filter by. Defaults to `ACTIVE`.","schema":{"enum":["DRAFT","ACTIVE","DEPRECATED","RETIRED"],"type":"string"}}],"responses":{"200":{"description":"The request has been processed successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchemaObject1"}}}},"400":{"description":"The request cannot be processed due to malformed data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchemaObject2"}}}},"401":{"description":"Unauthorized access to the requested resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchemaObject2"}}}},"404":{"description":"The resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchemaObject2"}}}}},"description":"Fetch Mortgage Officer Configuration","summary":"Fetches the mortgage officer configuration for a state from application submission configuration. When categoryCode is omitted, the officer assigned to the state is returned.","tags":["Home Card"],"security":[{"jwt":[]}]}},"/posfinancing/rest/v2/loans-search":{"get":{"parameters":[{"name":"searchFor","in":"query","schema":{"type":"string"},"x-position":1},{"name":"fieldsToInclude","in":"query","schema":{"type":"string","default":""},"x-position":2},{"name":"cursor","in":"query","schema":{"type":"string","default":""},"x-position":3},{"name":"limit","in":"query","schema":{"type":"integer","format":"int32","default":20},"x-position":4}],"responses":{"200":{"description":"","content":{"application/json;version=1":{"schema":{"$ref":"#/components/schemas/LSS_ResponseViewModelOfIReadOnlyCollectionOfSearchableLoanAndMeta"}}}}},"description":" Required Authorization Claims: lss_can_do_everything,lss_can_search_organization,lss_can_search_own,ogn_can_read_all_loans, ","tags":["Loans"],"security":[{"jwt":[]}]},"post":{"parameters":[{"name":"cursor","in":"query","schema":{"type":"string","default":""},"x-position":2},{"name":"limit","in":"query","schema":{"type":"integer","format":"int32","default":20},"x-position":3}],"requestBody":{"x-name":"parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LSS_LoanSearchParameters"}}},"required":true,"x-position":1},"responses":{"200":{"description":"","content":{"application/json;version=1":{"schema":{"$ref":"#/components/schemas/LSS_ResponseViewModelOfIReadOnlyCollectionOfSearchableLoanAndMeta"}}}}},"description":" Required Authorization Claims: lss_can_do_everything,lss_can_search_organization,lss_can_search_own,ogn_can_read_all_loans, ","tags":["Loans"],"security":[{"jwt":[]}]}},"/posfinancing/rest/v2/mortgage-officers":{"get":{"parameters":[{"name":"state","required":true,"in":"query","description":"The state code used to resolve mortgage officer configuration. Must be a valid ISO 3166-1 alpha-2 code.","example":"CA","schema":{"maxLength":2,"pattern":"/^[A-Z]{2}$/","type":"string"}},{"name":"categoryCode","required":false,"in":"query","description":"Optional product category; when an override exists for this state and category, that officer is returned.","example":"HELOC","schema":{"enum":["Solar_TPO","HVAC_LEASE","BATTERY_LEASE","HELOC"],"type":"string"}}],"responses":{"200":{"description":"The request has been processed successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchemaObject3"}}}},"400":{"description":"The request cannot be processed due to malformed data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchemaObject2"}}}},"401":{"description":"Unauthorized access to the requested resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchemaObject2"}}}},"404":{"description":"The resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchemaObject2"}}}}},"description":"Fetch Mortgage Officer Configuration","summary":"Fetches the mortgage officer configuration for a state from application submission configuration. When categoryCode is omitted, the officer assigned to the state is returned.","tags":["Home Card"],"security":[{"jwt":[]}]}},"/posfinancing/rest/v2/finance-accounts/agents":{"get":{"parameters":[{"name":"searchedTerm","in":"query","schema":{"type":"string"},"x-position":1},{"name":"financeAccountType","in":"query","schema":{"default":"Tpo","oneOf":[{"$ref":"#/components/schemas/LSS_FinanceAccountType"}]},"x-position":2},{"name":"itemsPerResponse","in":"query","schema":{"type":"integer","format":"int32","default":50},"x-position":3},{"name":"includeRawQuery","in":"query","schema":{"type":"boolean","default":false},"x-position":4}],"responses":{"200":{"description":"","content":{"application/json;version=1":{"schema":{"$ref":"#/components/schemas/LSS_ResponseViewModelOfListOfAgentSearchResponse"}}}}},"description":" Required Authorization Claims: lss_can_do_everything_tpo,lss_can_search_organization_tpo,lss_can_search_own_tpo, ","tags":["FinanceAccounts"],"security":[{"jwt":[]}]}},"/posfinancing/rest/v2/finance-accounts/emails":{"get":{"parameters":[{"name":"searchedTerm","in":"query","schema":{"type":"string"},"x-position":1},{"name":"financeAccountType","in":"query","schema":{"default":"Tpo","oneOf":[{"$ref":"#/components/schemas/LSS_FinanceAccountType"}]},"x-position":2},{"name":"itemsPerResponse","in":"query","schema":{"type":"integer","format":"int32","default":50},"x-position":3},{"name":"includeRawQuery","in":"query","schema":{"type":"boolean","default":false},"x-position":4}],"responses":{"200":{"description":"","content":{"application/json;version=1":{"schema":{"$ref":"#/components/schemas/LSS_ResponseViewModelOfListOfEmailSearchResponse"}}}}},"description":" Required Authorization Claims: lss_can_do_everything_tpo,lss_can_search_organization_tpo,lss_can_search_own_tpo, ","tags":["FinanceAccounts"],"security":[{"jwt":[]}]}},"/posfinancing/rest/v2/finance-accounts/heloc":{"get":{"parameters":[{"name":"searchFor","in":"query","schema":{"type":"string"},"x-position":1},{"name":"fieldsToInclude","in":"query","schema":{"type":"string","default":""},"x-position":2},{"name":"cursor","in":"query","schema":{"type":"string","default":""},"x-position":3},{"name":"limit","in":"query","schema":{"type":"integer","format":"int32","default":20},"x-position":4}],"responses":{"200":{"description":"","content":{"application/json;version=1":{"schema":{"$ref":"#/components/schemas/LSS_ResponseViewModelOfIReadOnlyCollectionOfSearchableHelocAndMeta"}}}}},"description":" Required Authorization Claims: lss_can_do_everything,lss_can_search_organization,lss_can_search_own,ogn_can_read_all_loans, ","tags":["Heloc"],"security":[{"jwt":[]}]},"post":{"parameters":[{"name":"cursor","in":"query","schema":{"type":"string","default":""},"x-position":2},{"name":"limit","in":"query","schema":{"type":"integer","format":"int32","default":20},"x-position":3}],"requestBody":{"x-name":"parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LSS_HelocSearchParameters"}}},"required":true,"x-position":1},"responses":{"200":{"description":"","content":{"application/json;version=1":{"schema":{"$ref":"#/components/schemas/LSS_ResponseViewModelOfIReadOnlyCollectionOfSearchableHelocAndMeta"}}}}},"description":" Required Authorization Claims: lss_can_do_everything,lss_can_search_organization,lss_can_search_own,ogn_can_read_all_loans, ","tags":["Heloc"],"security":[{"jwt":[]}]}},"/posfinancing/rest/v2/finance-accounts/organizations":{"get":{"parameters":[{"name":"searchedTerm","in":"query","schema":{"type":"string"},"x-position":1},{"name":"financeAccountType","in":"query","schema":{"default":"Tpo","oneOf":[{"$ref":"#/components/schemas/LSS_FinanceAccountType"}]},"x-position":2},{"name":"itemsPerResponse","in":"query","schema":{"type":"integer","format":"int32","default":50},"x-position":3},{"name":"includeRawQuery","in":"query","schema":{"type":"boolean","default":false},"x-position":4}],"responses":{"200":{"description":"","content":{"application/json;version=1":{"schema":{"$ref":"#/components/schemas/LSS_ResponseViewModelOfListOfOrganizationSearchResponse"}}}}},"description":" Required Authorization Claims: lss_can_do_everything_tpo,lss_can_search_organization_tpo,lss_can_search_own_tpo, ","tags":["FinanceAccounts"],"security":[{"jwt":[]}]}},"/posfinancing/rest/v2/finance-accounts/rates":{"get":{"parameters":[{"name":"financeAccountType","in":"query","schema":{"default":"Tpo","oneOf":[{"$ref":"#/components/schemas/LSS_FinanceAccountType"}]},"x-position":1},{"name":"itemsPerResponse","in":"query","schema":{"type":"integer","format":"int32","default":50},"x-position":2},{"name":"includeRawQuery","in":"query","schema":{"type":"boolean","default":false},"x-position":3}],"responses":{"200":{"description":"","content":{"application/json;version=1":{"schema":{"$ref":"#/components/schemas/LSS_ResponseViewModelOfListOfDouble"}}}}},"description":" Required Authorization Claims: lss_can_do_everything_tpo,lss_can_search_organization_tpo,lss_can_search_own_tpo, ","tags":["FinanceAccounts"],"security":[{"jwt":[]}]}},"/posfinancing/rest/v2/finance-accounts/search":{"get":{"parameters":[{"name":"searchFor","in":"query","schema":{"type":"string"},"x-position":1},{"name":"fieldsToInclude","in":"query","schema":{"type":"string","default":""},"x-position":2},{"name":"cursor","in":"query","schema":{"type":"string","default":""},"x-position":3},{"name":"limit","in":"query","schema":{"type":"integer","format":"int32","default":20},"x-position":4}],"responses":{"200":{"description":"","content":{"application/json;version=2":{"schema":{"$ref":"#/components/schemas/LSS_v2_ResponseViewModelOfIReadOnlyCollectionOfSearchableAssetAndMeta"}}}}},"description":" Required Authorization Claims: lss_can_do_everything,lss_can_do_everything_tpo,lss_can_search_organization,lss_can_search_organization_tpo,lss_can_search_own,lss_can_search_own_tpo,ogn_can_read_all_loans, ","tags":["FinanceAccounts"],"security":[{"jwt":[]}]}},"/posfinancing/rest/v2/finance-accounts/terms":{"get":{"parameters":[{"name":"financeAccountType","in":"query","schema":{"default":"Tpo","oneOf":[{"$ref":"#/components/schemas/LSS_FinanceAccountType"}]},"x-position":1},{"name":"itemsPerResponse","in":"query","schema":{"type":"integer","format":"int32","default":50},"x-position":2},{"name":"includeRawQuery","in":"query","schema":{"type":"boolean","default":false},"x-position":3}],"responses":{"200":{"description":"","content":{"application/json;version=1":{"schema":{"$ref":"#/components/schemas/LSS_ResponseViewModelOfListOfInteger"}}}}},"description":" Required Authorization Claims: lss_can_do_everything_tpo,lss_can_search_organization_tpo,lss_can_search_own_tpo, ","tags":["FinanceAccounts"],"security":[{"jwt":[]}]}},"/posfinancing/rest/v2/prequalifications/{prequalificationId}":{"get":{"parameters":[{"name":"prequalificationId","required":true,"in":"path","description":"The unique identifier of the prequalification to retrieve.","schema":{"format":"uuid"}}],"responses":{"200":{"description":"The request has been processed successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchemaObject4"}}}},"400":{"description":"The request cannot be processed due to malformed data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchemaObject5"}}}},"404":{"description":"The resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchemaObject5"}}}}},"description":"Prequalification By ID","summary":"Fetches a prequalification by its unique identifier.","tags":["Application"],"security":[{"jwt":[]}]}},"/posfinancing/internal/v1/loans/{referenceId}/timeline":{"get":{"parameters":[{"name":"referenceId","in":"path","required":true,"schema":{"type":"string","pattern":"^\\d{2}-\\d{2}-\\d{6}$"}}],"responses":{"200":{"description":"Successful","content":{"*/*":{"schema":{"$ref":"#/components/schemas/TIMELINE_TimelineV2Response"}}}}},"summary":"Get timeline by reference id","tags":["Timeline"],"security":[{"jwt":[]}]}},"/posfinancing/rest/v2/finance-accounts/{financeAccountId}/mortgage-officer":{"get":{"parameters":[{"name":"financeAccountId","required":true,"in":"path","description":"The finance account ID to resolve the mortgage officer for.","schema":{"pattern":"^[0-9]{2}-[0-9]{2}-[0-9]{6}$","format":"##-##-######","type":"string"}}],"responses":{"200":{"description":"The request has been processed successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchemaObject6"}}}},"400":{"description":"The request cannot be processed due to malformed data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchemaObject2"}}}},"401":{"description":"Unauthorized access to the requested resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchemaObject2"}}}},"403":{"description":"Access to the requested resource is forbidden.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchemaObject2"}}}},"404":{"description":"The resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchemaObject2"}}}}},"description":"Finance Account Mortgage Officer","summary":"Fetches the mortgage officer configuration for the finance account, using the subject property state from the linked application and the account category when resolving category overrides.","tags":["Home Card"],"security":[{"jwt":[]}]}},"/posfinancing/rest/v2/prequalifications/{prequalificationId}/disclaimers":{"get":{"parameters":[{"name":"projectCost","required":false,"in":"query","description":"The project cost to compose the estimated-payment disclaimer for. Defaults\nto the prequalification's project cost when omitted.","schema":{"minimum":1,"type":"number"}},{"name":"prequalificationId","required":true,"in":"path","description":"The unique identifier of the prequalification whose disclaimers to retrieve.","schema":{"format":"uuid"}}],"responses":{"200":{"description":"The request has been processed successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchemaObject7"}}}},"400":{"description":"The request cannot be processed due to malformed data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchemaObject5"}}}},"404":{"description":"The resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchemaObject5"}}}}},"description":"Prequalification Disclaimers","summary":"Fetches offer-derived disclaimers for a prequalification.","tags":["Application"],"security":[{"jwt":[]}]}},"/posfinancing/rest/v2/prequalifications/{prequalificationId}/estimates":{"get":{"parameters":[{"name":"projectCost","required":true,"in":"query","description":"The project cost to compute monthly payments for.","schema":{"minimum":1,"type":"number"}},{"name":"prequalificationId","required":true,"in":"path","description":"The unique identifier of the prequalification to compute estimates for.","schema":{"format":"uuid"}}],"responses":{"200":{"description":"The request has been processed successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchemaObject8"}}}},"400":{"description":"The request cannot be processed due to malformed data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchemaObject5"}}}},"404":{"description":"The resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchemaObject5"}}}}},"description":"Prequalification Estimates","summary":"Computes monthly payment estimates for every available offer on the specified prequalification at the given project cost.","tags":["Application"],"security":[{"jwt":[]}]}},"/posfinancing/rest/v2/applications/{applicationId}/shares":{"post":{"parameters":[{"name":"applicationId","required":true,"in":"path","description":"The ID of the application to share.","schema":{"format":"uuid"}}],"requestBody":{"required":true,"description":"The list of audiences to share the application with. Each entry produces one share.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/undefined_ShareApplicationInput"}}}}},"responses":{"201":{"description":"Resource created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchemaObject9"}}}},"400":{"description":"The request cannot be processed due to malformed data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchemaObject5"}}}},"401":{"description":"Unauthorized access to the requested resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchemaObject5"}}}},"403":{"description":"Access to the requested resource is forbidden.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchemaObject5"}}}},"404":{"description":"The resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchemaObject5"}}}},"409":{"description":"The request cannot be processed due to a conflict with the current state of the resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchemaObject5"}}}},"422":{"description":"The server understood the request but it was unable to process the contained instructions.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchemaObject5"}}}}},"description":"Share Homecard Application","summary":"Share an application with one or more audiences","tags":["Application"],"security":[{"jwt":[]}]}},"/posfinancing/rest/v2/applications/{applicationId}/finance-accounts":{"post":{"parameters":[{"name":"applicationId","required":true,"in":"path","description":"The ID of the application to submit for decisioning.","schema":{"format":"uuid","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/undefined_SubmitApplicationInput"}}}},"responses":{"201":{"description":"Resource created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchemaObject10"}}}},"400":{"description":"The request cannot be processed due to malformed data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchemaObject5"}}}},"401":{"description":"Unauthorized access to the requested resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchemaObject5"}}}},"403":{"description":"Access to the requested resource is forbidden.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchemaObject5"}}}},"404":{"description":"The resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchemaObject5"}}}},"409":{"description":"The request cannot be processed due to a conflict with the current state of the resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchemaObject5"}}}},"422":{"description":"The server understood the request but it was unable to process the contained instructions.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchemaObject5"}}}}},"description":"Submit Application","summary":"Submit a completed application for decisioning","tags":["Application"],"security":[{"jwt":[]}]}},"/posfinancing/rest/v2/loans/{id}/savings-schedule":{"post":{"parameters":[{"in":"path","name":"id","description":"The application's unique identifier.","schema":{"type":"string","pattern":"^[0-9]{2}-[0-9]{2}-[0-9]{6}$"},"required":true}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"calculatorNames":{"type":"array","items":{"type":"string","enum":["SOLO","ENERFLO","SUBCONTRACTOR_HUB","SOLARGRAF","ARCADIA_SWITCH","VISION","ARTEMIS","ENERGY_PAL","PURE_ENERGY","SUNTRIA","PATTER_AI","PIPE","LIGHT_FUSION","AURORA"]},"minItems":1,"uniqueItems":true,"description":"If solar + storage system: the name(s) of the calculator(s) used to to estimate customer utility bill savings for systems with solar + storage. \n OR if solar system only: the name(s) of the calculator(s) used to estimate customer utility bill savings for systems with solar."},"firstYearSchedule":{"type":"array","items":{"type":"object","properties":{"month":{"type":"number","format":"float","minimum":1,"maximum":12,"description":"The numeric representation of the month."},"utilityWithoutSolar":{"type":"object","properties":{"consumption":{"type":"object","properties":{"unit":{"type":"string","enum":["kWh"],"description":"Electrical output type of a system. Defaults to kWh","default":"kWh"},"value":{"type":"number","format":"double","minimum":1,"description":"Two point precision positive number"}},"required":["value"],"additionalProperties":false,"nullable":true,"description":"The estimated usage from the utility company without solar in kWh."},"payment":{"type":"object","properties":{"type":{"type":"string","enum":["USD","CAD"],"description":"The currency type. Enumerated."},"value":{"type":"number","format":"double","minimum":0,"description":"Value of the Currency(). Two point precision decimal.","example":100.11}},"required":["type","value"],"additionalProperties":false,"description":"The estimated payment to the utility company."}},"required":["consumption","payment"],"additionalProperties":false,"description":"Pre-installation utility power consumption and cost information","title":"UtilityWithoutSolar"},"utilityWithSolar":{"type":"object","properties":{"solarConsumption":{"type":"object","properties":{"unit":{"type":"string","enum":["kWh"],"description":"Electrical output type of a system. Defaults to kWh","default":"kWh"},"value":{"type":"number","format":"double","minimum":1,"description":"Two point precision positive number"}},"required":["value"],"additionalProperties":false,"nullable":true,"description":"The estimated property usage of the solar system in kWh."},"utilityPayment":{"type":"object","properties":{"type":{"type":"string","enum":["USD","CAD"],"description":"The currency type. Enumerated."},"value":{"type":"number","format":"double","description":"Value of the Currency(). Two point precision decimal.","example":100.11}},"required":["type","value"],"additionalProperties":false,"description":"The estimated payment to the utility company."},"solarPayment":{"type":"object","properties":{"type":{"type":"string","enum":["USD","CAD"],"description":"The currency type. Enumerated."},"value":{"type":"number","format":"double","minimum":0,"description":"Value of the Currency(). Two point precision decimal.","example":100.11}},"required":["type","value"],"additionalProperties":false,"description":"The estimated payment for the solar energy produced."},"utilityConsumption":{"type":"object","properties":{"unit":{"type":"string","enum":["kWh"],"description":"Electrical output type of a system. Defaults to kWh","default":"kWh"},"value":{"type":"number","format":"double"}},"additionalProperties":false,"nullable":true,"description":"The estimated usage from the utility company."}},"required":["solarConsumption","utilityPayment","solarPayment","utilityConsumption"],"additionalProperties":false,"description":"Post-installation utility and solar monthly power consumption and cost information","title":"MonthlyUtilityWithSolar"},"savings":{"type":"object","properties":{"type":{"type":"string","enum":["USD","CAD"],"description":"The currency type. Enumerated."},"value":{"type":"number","format":"double","description":"Value of the Currency(). Two point precision decimal.","example":100.11}},"required":["type","value"],"additionalProperties":false,"description":"Savings calculated from the cost difference between utilities with and without solar production."}},"required":["month","utilityWithoutSolar","utilityWithSolar","savings"],"additionalProperties":false,"title":"FirstYearMonthlySchedule"},"minItems":12,"maxItems":12,"uniqueItems":true,"description":"The 12-month breakdown of the solar production and cost savings schedule of the proposed solar project."},"fullTermSchedule":{"type":"array","items":{"type":"object","properties":{"year":{"type":"number","format":"float","minimum":1,"maximum":25,"description":"The numeric representation of the year(s) from installation."},"utilityWithoutSolar":{"type":"object","properties":{"consumption":{"type":"object","properties":{"unit":{"type":"string","enum":["kWh"],"description":"Electrical output type of a system. Defaults to kWh","default":"kWh"},"value":{"type":"number","format":"double","minimum":1,"description":"Two point precision positive number"}},"required":["value"],"additionalProperties":false,"nullable":true,"description":"The estimated usage from the utility company without solar in kWh."},"payment":{"type":"object","properties":{"type":{"type":"string","enum":["USD","CAD"],"description":"The currency type. Enumerated."},"value":{"type":"number","format":"double","minimum":0,"description":"Value of the Currency(). Two point precision decimal.","example":100.11}},"required":["type","value"],"additionalProperties":false,"description":"The estimated payment to the utility company."}},"required":["consumption","payment"],"additionalProperties":false,"description":"Pre-installation utility power consumption and cost information","title":"UtilityWithoutSolar"},"utilityWithSolar":{"type":"object","properties":{"solarConsumption":{"type":"object","properties":{"unit":{"type":"string","enum":["kWh"],"description":"Electrical output type of a system. Defaults to kWh","default":"kWh"},"value":{"type":"number","format":"double","minimum":1,"description":"Two point precision positive number"}},"required":["value"],"additionalProperties":false,"nullable":true,"description":"The estimated property usage of the solar system in kWh."},"utilityPayment":{"type":"object","properties":{"type":{"type":"string","enum":["USD","CAD"],"description":"The currency type. Enumerated."},"value":{"type":"number","format":"double","description":"Value of the Currency(). Two point precision decimal.","example":100.11}},"required":["type","value"],"additionalProperties":false,"description":"The estimated payment to the utility company."},"solarPayment":{"type":"object","properties":{"type":{"type":"string","enum":["USD","CAD"],"description":"The currency type. Enumerated."},"value":{"type":"number","format":"double","minimum":0,"description":"Value of the Currency(). Two point precision decimal.","example":100.11}},"required":["type","value"],"additionalProperties":false,"description":"The estimated payment for the solar energy produced."},"utilityConsumption":{"type":"object","properties":{"unit":{"type":"string","enum":["kWh"],"description":"Electrical output type of a system. Defaults to kWh","default":"kWh"},"value":{"type":"number","format":"double"}},"additionalProperties":false,"nullable":true,"description":"The estimated usage from the utility company."},"solarRate":{"type":"object","properties":{"unit":{"type":"string","enum":["DOLLAR_PER_kWh"]},"price":{"type":"number","format":"double","minimum":0}},"required":["unit"],"additionalProperties":false,"description":"The price per kWh produced by the solar system."}},"required":["solarConsumption","utilityPayment","solarPayment","utilityConsumption","solarRate"],"additionalProperties":false,"description":"Post-installation utility and solar annual power consumption, cost, and rate information","title":"YearlyUtilityWithSolar"},"savings":{"type":"object","properties":{"type":{"type":"string","enum":["USD","CAD"],"description":"The currency type. Enumerated."},"value":{"type":"number","format":"double","description":"Value of the Currency(). Two point precision decimal.","example":100.11}},"required":["type","value"],"additionalProperties":false,"description":"Savings calculated from the cost difference between utilities with and without solar production."}},"required":["year","utilityWithoutSolar","utilityWithSolar","savings"],"additionalProperties":false,"title":"FullTermSchedule"},"uniqueItems":true,"description":"The full-term annual breakdown of the solar production and cost savings schedule of the proposed solar project."}},"required":["firstYearSchedule","fullTermSchedule"],"additionalProperties":false,"nullable":true,"description":"The estimated production and savings schedule of the proposed solar project. \n NOTE: Only applicable to lease / power purchase agreement submissions.","title":"SavingsScheduleSchema"}}}},"responses":{"201":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchemaObject11"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchemaObject12"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchemaObject13"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchemaObject14"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchemaObject15"}}}},"500":{"description":"Server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchemaObject16"}}}}},"summary":"Create a Production and Savings Schedule","description":"Creates a production and savings schedule associated with a given lease / power purchase agreement application.","tags":["Savings Schedule"],"x-codeSamples":[{"lang":"JavaScript","label":"NodeJs","source":"const fetch = require('node-fetch');\nconst url = 'https://api.goodleap.com/rest/v2/loans/{id}/savings-schedule';\nconst options = {\n  method: 'POST',\n  headers: {\n    'authorization': 'Basic ' + Buffer.from(YOUR_API_KEY_ID + ':' + YOUR_API_KEY_SECRET).toString('base64'),\n    'content-type': 'application/json',\n    'cache-control': 'no-cache',\n  },\n  body: JSON.stringify({ field1: 'xyz', field2: 'abc' }),\n};\n\ntry {\n  const response = await fetch(url, options);\n\n  if (response.ok) { \n    const data = await response.json();\n    console.log(data);\n  } \n} catch (err) {\n  console.error('An error has occurred', err);\n}"},{"lang":"PHP","source":"setUrl('https://api.goodleap.com/rest/v2/loans/{id}/savings-schedule');\n\n$request->setMethod(HTTP_METH_POST);\n\n$request->setHeaders(array(\n  'authorization' => 'Basic ' . base64_encode(YOUR_API_KEY_ID . ':' . YOUR_API_KEY_SECRET),\n  'content-type' => 'application/json'\n  'cache-control' => 'no-cache',\n));\n$request->setBody('{\"field1\":\"xyz\",\"field2\":\"abc\"}');\n\ntry {\n  $response = $request->send();\n  echo $response->getBody();\n} catch (HttpException $ex) {\n  echo $ex;\n}"},{"lang":"Java","source":"HttpResponse response = Unirest.post(\"https://api.goodleap.com/rest/v2/loans/{id}/savings-schedule\")\n            .header(\"authorization\", \"Basic \" + Base64.getEncoder().encodeToString((YOUR_API_KEY_ID + \":\" + YOUR_API_KEY_SECRET).getBytes()))\n            .header(\"content-type\", \"application/json\")\n            .header(\"cache-control\", \"no-cache\")\n.body(\"{\"field1\":\"xyz\",\"field2\":\"abc\"}\")\n            .asString();"},{"lang":"C#","source":"var client = new RestClient(\"https://api.goodleap.com/rest/v2/loans/{id}/savings-schedule\");\nvar request = new RestRequest(Method.POST);\n\nrequest.AddHeader(\"cache-control\", \"no-cache\");\nrequest.AddHeader(\"authorization\", \"Basic \" + (YOUR_API_KEY_ID + \":\" + YOUR_API_KEY_SECRET).EncodeBase64());\nrequest.AddHeader(\"content-type\", \"application/json\");\nrequest.AddParameter(\"application/json\", \"{\"field1\":\"xyz\",\"field2\":\"abc\"}\", ParameterType.RequestBody);\n\nIRestResponse response = client.Execute(request);"}],"security":[{"jwt":[]}]}},"/posfinancing/rest/v2/applications/{applicationId}/home-mortgage-disclosures":{"put":{"parameters":[{"name":"applicationId","required":true,"in":"path","description":"The application ID to create home mortgage disclosure responses for.","schema":{"format":"uuid","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/undefined_CreateHmdaResponsesInput"}}}},"responses":{"204":{"description":"The request has been processed successfully."},"400":{"description":"The request cannot be processed due to malformed data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchemaObject5"}}}},"401":{"description":"Unauthorized access to the requested resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchemaObject5"}}}},"403":{"description":"Access to the requested resource is forbidden.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchemaObject5"}}}},"404":{"description":"The resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchemaObject5"}}}}},"description":"Submit Home Mortgage Disclosure Responses","summary":"Creates home mortgage disclosure responses for an application.","tags":["Home Card"],"security":[{"jwt":[]}]},"patch":{"parameters":[{"name":"applicationId","required":true,"in":"path","description":"The application ID to create home mortgage disclosure responses for.","schema":{"format":"uuid","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SUBMISSION_CreateHmdaResponsesInput"}}}},"responses":{"204":{"description":"The request has been processed successfully."},"400":{"description":"The request cannot be processed due to malformed data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchemaObject2"}}}},"401":{"description":"Unauthorized access to the requested resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchemaObject2"}}}},"403":{"description":"Access to the requested resource is forbidden.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchemaObject2"}}}},"404":{"description":"The resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchemaObject2"}}}}},"description":"`DEPRECATED`: Please use our `PUT` resource \n\n Submit Home Mortgage Disclosure Responses","summary":"Creates home mortgage disclosure responses for an application.","tags":["Home Card"],"security":[{"jwt":[]}]}},"/posfinancing/rest/v2/applications/{applicationId}/signed-disclosures":{"put":{"parameters":[{"name":"applicationId","required":true,"in":"path","description":"The ID of the application to put signed disclosures onto.","schema":{"format":"uuid"}}],"requestBody":{"required":true,"description":"The signed disclosures to put. Each entry establishes the canonical state for its (applicantRole, disclosureId) identity.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/undefined_SignedDisclosureInput"}}}}},"responses":{"200":{"description":"The request has been processed successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchemaObject17"}}}},"400":{"description":"The request cannot be processed due to malformed data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchemaObject5"}}}},"401":{"description":"Unauthorized access to the requested resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchemaObject5"}}}},"403":{"description":"Access to the requested resource is forbidden.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchemaObject5"}}}},"404":{"description":"The resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchemaObject5"}}}},"422":{"description":"The server understood the request but it was unable to process the contained instructions.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchemaObject5"}}}}},"description":"Update Signed Disclosures","summary":"Puts one or more signed disclosures onto the application. Each entry pairs an applicant role with a signed disclosure token and the applicant signature image","tags":["Application"],"security":[{"jwt":[]}]}},"/posfinancing/rest/v2/applications/{applicationId}/applicants":{"patch":{"parameters":[{"name":"applicationId","required":true,"in":"path","description":"The ID of the application to update the applicants for.","schema":{"format":"uuid"}}],"requestBody":{"required":true,"description":"List of applicant updates to apply to the application.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/undefined_UpdateApplicantInput"}}}}},"responses":{"204":{"description":"The request has been processed successfully."},"400":{"description":"The request cannot be processed due to malformed data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchemaObject5"}}}},"401":{"description":"Unauthorized access to the requested resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchemaObject5"}}}},"403":{"description":"Access to the requested resource is forbidden.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchemaObject5"}}}},"404":{"description":"The resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchemaObject5"}}}}},"description":"Update Application Applicant","summary":"Update Applicant on Application","tags":["Application"],"security":[{"jwt":[]}]}},"/posfinancing/rest/v2/applications/{applicationId}/prequalifications/{prequalificationId}":{"patch":{"parameters":[{"name":"prequalificationId","required":true,"in":"path","description":"The ID of the prequalification to update.","schema":{"format":"uuid"}},{"name":"applicationId","required":true,"in":"path","description":"The ID of the application to update the prequalification for.","schema":{"format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/undefined_UpdatePrequalificationInputV2"}}}},"responses":{"204":{"description":"The request has been processed successfully."},"400":{"description":"The request cannot be processed due to malformed data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchemaObject5"}}}},"401":{"description":"Unauthorized access to the requested resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchemaObject5"}}}},"403":{"description":"Access to the requested resource is forbidden.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchemaObject5"}}}},"404":{"description":"The resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchemaObject5"}}}}},"description":"Update Application Prequalification","summary":"Update a prequalification on a given application","tags":["Application"],"security":[{"jwt":[]}]}}}}