Loans

Required Authorization Claims: lss_can_do_everything,lss_can_search_organization,lss_can_search_own,ogn_can_read_all_loans,

post/posfinancing/rest/v2/loans-search

Query parameters

cursorstring
limitinteger

Request body

wellKnownFilter'None' | 'DocumentsNotSent' | 'DocumentsNotSigned' | 'ProjectInfoNotComplete' | 'ContractNotUploaded' | 'LoanDetailsNotVerified' | 'NotInstalled' | 'NotFunded' | 'ProjectCertificateNotSigned' | 'NoPto' | 'CreditExpiringWithin30Days' | 'WorkOrderNotInitiallySigned' | 'ConditionalClaimsReleaseNotSigned' | 'FinalClaimsReleaseNotSigned' | 'ConsumerAgreementNotSent' | 'ConsumerAgreementNotSigned' | 'ConsumerAgreementNotViewed' | 'InRescissionPeriod' | 'WorkOrderNotSignedAfterChangeOrder' | 'DomesticContentNotQualifiedNoPto' | 'AoMNotSigned' | 'CpcRejected' | 'CreditExpiredWithinExtensionWindow'
tile'None' | 'CreditAtRisk' | 'LoanDocActions' | 'NtpActions' | 'InstallActions'
titlestring nullable
numberOfApplicantsinteger nullable
loanIdstring[] nullable
languagestring[] nullable
isAutoPayboolean nullable
tenantIdstring guid
loanAmountnumber double nullable
categorystring[] nullable
referenceIdstring nullable
subCategoriesstring[] nullable
statusstring[] nullable
tagsstring[] nullable
terminteger[] nullable
creditDecisionTypestring nullable
hierarchiesstring[] nullable
fieldsstring[] nullable
agentstring nullable
legacyDealerstring nullable
includeExpiredLoansboolean nullable

Changes

Changed in 1 of the 7 revisions of this API.4

    • added the new ApprovalDate enum value to the request property allOf[subschema #2]/sort/oneOf[LSS_SortField3]/field

      request-property-enum-value-added

    • added the new LastCompletedMilestoneUpdatedAt enum value to the request property allOf[subschema #2]/sort/oneOf[LSS_SortField3]/field

      request-property-enum-value-added

    • added the new LoanAmount enum value to the request property allOf[subschema #2]/sort/oneOf[LSS_SortField3]/field

      request-property-enum-value-added

    • added the optional property payload/items/lastCompletedMilestoneUpdatedAt to the response with the 200 status

      response-optional-property-added