{ "swagger": "2.0", "info": { "title": "Sageworks API", "description": "API to access Sageworks related data", "version": "v1" }, "host": "api.sageworks.com", "schemes": [ "https" ], "paths": { "/v1/customers": { "get": { "tags": [ "Customers" ], "summary": "Gets all customers", "operationId": "GetPaged", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "page", "description": "The page number of results to retrieve (first page = 1, default = 1)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "perPage", "description": "The number of records to return on each page (minimum = 1, maximum = 1000, default = 200)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "uniqueIdentifier", "description": "Unique identifier to filter by", "type": "string" }, { "in": "query", "name": "ids", "description": "List of ids to filter by", "type": "array", "items": { "format": "int64", "type": "integer" }, "collectionFormat": "multi" }, { "in": "query", "name": "name", "description": "Customer name to filter by", "type": "string" }, { "in": "query", "name": "taxId", "description": "Tax ID to filter by", "type": "string" }, { "in": "query", "name": "email", "description": "Email to filter by", "type": "string" }, { "in": "query", "name": "city", "description": "City to filter by", "type": "string" }, { "in": "query", "name": "state", "description": "2 character state code to filter by", "type": "string" }, { "in": "query", "name": "includeUserDefinedFields", "description": "Include User Defined fields in the response", "type": "boolean", "default": false, "x-nullable": true } ], "responses": { "200": { "description": "Gets all current, existing, and active customers in the account", "schema": { "$ref": "#/definitions/CollectionResponse[Customer]" }, "examples": { "application/json": {"items":[{"id":7456123,"name":"Example, LLC","dba":"Example Doing Business As","firstName":null,"middleInitial":null,"lastName":null,"nameSuffix":null,"userDefinedFields":{"User Defined Field 1":"Value 1","User Defined Field 2":"Value 2"},"creditScore":98,"secondaryCreditScore":null,"businessType":"llc","dnbScore":"567","namePrefix":null,"jobTitle":null,"addresses":[{"line1":"123 Main St","line2":"Suite 2078","city":"Example City","state":"NY","postalCode":"00101","country":"US","addressType":"primary"}],"phoneNumbers":[{"type":"primary","number":"(999)999-9999"}],"type":"business","emailAddress":"test-company@sageworks.com","industryCode":"99999","isDeleted":false,"uniqueIdentifier":"785654","taxId":"111111111","branch":null,"department":null,"website":null,"description":null,"restricted":false,"checkingBalance":15000.0,"savingsBalance":100000.0,"cDsBalance":50000.0,"averageChecking":14500.0,"averageSavings":125000.0,"averageCDs":60000.0,"citizenshipStatus":null,"maritalStatus":null,"isActiveMiltaryDuty":null,"isDependentOfActiveMiltaryDuty":null,"civDescription":null,"employer":null,"numberOfYearsEmployed":0.0,"ofacDesignation":null,"dateOfBirth":null,"idDescription":null,"idNumber":null,"idIssueDate":null,"idExpirationDate":null,"idIssuingAuthority":null,"idState":null,"comments":null,"msa":16980,"stateCode":12,"countyCode":"123","tractCode":"3453","longitude":-87.656376,"latitude":41.94763,"medianHouseholdIncome":107250.0,"metropolitanDivision":"Chicago-Naperville-Evanston, IL","metropolitanDivisionCode":"1234242","loanOfficer":null,"loanOfficerId":438331,"loanAdministrator":null,"equifaxCreditScore":null,"equifaxCreditScoreDate":null,"experianCreditScore":null,"experianCreditScoreDate":null,"transunionCreditScore":null,"transunionCreditScoreDate":null,"ficoSbssCreditScore":450,"ficoSbssCreditScoreDate":"2019-06-09","bankruptcies":null,"dateOfLastBankruptcy":null,"historical30DayDelinquencies":null,"historical60DayDelinquencies":null,"historical90DayDelinquencies":null,"historicalOtherDelinquencies":null,"currentMortgagePastDue":null,"currentInstallmentPastDue":null,"currentAutoPastDue":null,"currentEducationPastDue":null,"currentOpenPastDue":null,"currentRevolvingPastDue":null,"currentOtherPastDue":null,"currentTotalPastDue":null,"entryMethod":"operatingCompany","professionalLLC":true,"yearFounded":1999,"businessRegistered":"NY","farmRegistered":null,"stateOfFormation":"NY","franchiseName":"Franchise #1","franchiseLegalName":"#1 Franchise","franchiseStartDate":1999,"sbaCode":"123","cityHQ":"Chicago","stateHQ":"IL","franchiseDataImportDate":"2019-09-06","franchiseDataFinancialPeriod":2019,"historicalSuccessRate":130,"systemSupportAndExpenseCommitment":75,"resaleActivityLevel":25,"mngmtExperienceStability":35,"averageUnitRevenueGrowth":60,"prospectScreening":30,"unitEconomics":70,"franchiseAgreementAssessment":15,"franchiseeRelationship":30,"projectedUnitSuccess":200,"recurringRevenueSelfSufficiency":50,"totalFundScore":750,"finStatementStrength":25,"franchisedUnits":100,"minInitial":258625,"maxInitial":1609500,"avgInitial":602350,"companyOwnedUnits":53,"projectedOpenings":12,"compoundAnnualUnitGrowthRate":91.0,"compoundedUnitSuccessRate":0.96,"experianDBT":5,"equifaxDBT":null,"dbdbt":null,"dbPaydex":null,"ansoniaCreditRating":"3071K-8","ansoniaRiskScore":95,"creditLogicScore":58,"dbViabilityRating":"","lastReportRun":"2019-06-07","bankruptciesCount":0,"collectionsCount":0,"judgmentsCount":0,"chargeOffsCount":0,"liensCount":0,"nsfChecksCount":0,"dataDepthScore":0,"underFormation":null,"dateBusinessEstablished":null,"loanBoardingIdentifier":null,"crmIdentifier":null,"isMailingAddressDifferent":false,"licenseNumber":null},{"id":4213102,"name":"Smith, John","dba":null,"firstName":"John","middleInitial":null,"lastName":"Smith","nameSuffix":null,"userDefinedFields":{"User Defined Field 1":"Value 1","User Defined Field 2":"Value 2"},"creditScore":650,"secondaryCreditScore":null,"businessType":null,"dnbScore":null,"namePrefix":null,"jobTitle":null,"addresses":[{"line1":"456 Circle St","line2":"Apt 4B","city":"New York","state":"NY","postalCode":"00101","country":"US","addressType":"primary"}],"phoneNumbers":[{"type":"mobile","number":"(999)999-9999"}],"type":"person","emailAddress":"test-person@sageworks.com","industryCode":null,"isDeleted":false,"uniqueIdentifier":"746313","taxId":null,"branch":null,"department":null,"website":null,"description":null,"restricted":false,"checkingBalance":15000.0,"savingsBalance":100000.0,"cDsBalance":50000.0,"averageChecking":14500.0,"averageSavings":125000.0,"averageCDs":60000.0,"citizenshipStatus":"usCitizen","maritalStatus":"legallySeparated","isActiveMiltaryDuty":true,"isDependentOfActiveMiltaryDuty":false,"civDescription":"","employer":null,"numberOfYearsEmployed":0.0,"ofacDesignation":null,"dateOfBirth":null,"idDescription":"Passport","idNumber":"111111","idIssueDate":"2014-01-02","idExpirationDate":"2024-01-02","idIssuingAuthority":"","idState":"FL","comments":null,"msa":null,"stateCode":null,"countyCode":null,"tractCode":null,"longitude":null,"latitude":null,"medianHouseholdIncome":null,"metropolitanDivision":null,"metropolitanDivisionCode":null,"loanOfficer":"Test Loan Officer","loanOfficerId":438323,"loanAdministrator":"Test Loan Admin","equifaxCreditScore":670,"equifaxCreditScoreDate":"2018-04-05","experianCreditScore":700,"experianCreditScoreDate":"2019-05-06","transunionCreditScore":750,"transunionCreditScoreDate":"2019-06-07","ficoSbssCreditScore":720,"ficoSbssCreditScoreDate":"2019-06-08","bankruptcies":"0","dateOfLastBankruptcy":"","historical30DayDelinquencies":"2","historical60DayDelinquencies":"1","historical90DayDelinquencies":"0","historicalOtherDelinquencies":"0","currentMortgagePastDue":"0","currentInstallmentPastDue":"0","currentAutoPastDue":"90","currentEducationPastDue":"0","currentOpenPastDue":"0","currentRevolvingPastDue":"100","currentOtherPastDue":"0","currentTotalPastDue":"0","entryMethod":"operatingCompany","professionalLLC":null,"yearFounded":0,"businessRegistered":null,"farmRegistered":null,"stateOfFormation":null,"franchiseName":null,"franchiseLegalName":null,"franchiseStartDate":null,"sbaCode":null,"cityHQ":null,"stateHQ":null,"franchiseDataImportDate":null,"franchiseDataFinancialPeriod":null,"historicalSuccessRate":null,"systemSupportAndExpenseCommitment":null,"resaleActivityLevel":null,"mngmtExperienceStability":null,"averageUnitRevenueGrowth":null,"prospectScreening":null,"unitEconomics":null,"franchiseAgreementAssessment":null,"franchiseeRelationship":null,"projectedUnitSuccess":null,"recurringRevenueSelfSufficiency":null,"totalFundScore":null,"finStatementStrength":null,"franchisedUnits":null,"minInitial":null,"maxInitial":null,"avgInitial":null,"companyOwnedUnits":null,"projectedOpenings":null,"compoundAnnualUnitGrowthRate":null,"compoundedUnitSuccessRate":null,"experianDBT":null,"equifaxDBT":null,"dbdbt":null,"dbPaydex":null,"ansoniaCreditRating":null,"ansoniaRiskScore":null,"creditLogicScore":null,"dbViabilityRating":null,"lastReportRun":null,"bankruptciesCount":null,"collectionsCount":null,"judgmentsCount":null,"chargeOffsCount":null,"liensCount":null,"nsfChecksCount":null,"dataDepthScore":null,"underFormation":null,"dateBusinessEstablished":null,"loanBoardingIdentifier":null,"crmIdentifier":null,"isMailingAddressDifferent":false,"licenseNumber":null},{"id":45123997,"name":"Example Farm","dba":null,"firstName":null,"middleInitial":null,"lastName":null,"nameSuffix":null,"userDefinedFields":{"User Defined Field 1":"Value 1","User Defined Field 2":"Value 2"},"creditScore":98,"secondaryCreditScore":null,"businessType":"soleProp","dnbScore":"567","namePrefix":null,"jobTitle":null,"addresses":[{"line1":"964 Meadow Ave","line2":"","city":"Seattle","state":"WA","postalCode":"90541","country":"US","addressType":"primary"}],"phoneNumbers":[{"type":"primary","number":"(999)999-9999"}],"type":"farm","emailAddress":"test@sageworks.com","industryCode":"99999","isDeleted":false,"uniqueIdentifier":null,"taxId":null,"branch":null,"department":null,"website":null,"description":null,"restricted":false,"checkingBalance":15000.0,"savingsBalance":100000.0,"cDsBalance":50000.0,"averageChecking":14500.0,"averageSavings":125000.0,"averageCDs":60000.0,"citizenshipStatus":null,"maritalStatus":null,"isActiveMiltaryDuty":null,"isDependentOfActiveMiltaryDuty":null,"civDescription":null,"employer":null,"numberOfYearsEmployed":0.0,"ofacDesignation":null,"dateOfBirth":null,"idDescription":null,"idNumber":null,"idIssueDate":null,"idExpirationDate":null,"idIssuingAuthority":null,"idState":null,"comments":null,"msa":16980,"stateCode":12,"countyCode":"123","tractCode":"33433","longitude":-87.656376,"latitude":41.94763,"medianHouseholdIncome":107250.0,"metropolitanDivision":"Chicago-Naperville-Evanston, IL","metropolitanDivisionCode":"1234242","loanOfficer":null,"loanOfficerId":438332,"loanAdministrator":null,"equifaxCreditScore":null,"equifaxCreditScoreDate":null,"experianCreditScore":null,"experianCreditScoreDate":null,"transunionCreditScore":null,"transunionCreditScoreDate":null,"ficoSbssCreditScore":450,"ficoSbssCreditScoreDate":"2019-06-09","bankruptcies":null,"dateOfLastBankruptcy":null,"historical30DayDelinquencies":null,"historical60DayDelinquencies":null,"historical90DayDelinquencies":null,"historicalOtherDelinquencies":null,"currentMortgagePastDue":null,"currentInstallmentPastDue":null,"currentAutoPastDue":null,"currentEducationPastDue":null,"currentOpenPastDue":null,"currentRevolvingPastDue":null,"currentOtherPastDue":null,"currentTotalPastDue":null,"entryMethod":"operatingCompany","professionalLLC":false,"yearFounded":0,"businessRegistered":null,"farmRegistered":"MI","stateOfFormation":null,"franchiseName":"Franchise #1","franchiseLegalName":"#1 Franchise","franchiseStartDate":1999,"sbaCode":"123","cityHQ":"Chicago","stateHQ":"IL","franchiseDataImportDate":"2019-09-06","franchiseDataFinancialPeriod":2019,"historicalSuccessRate":130,"systemSupportAndExpenseCommitment":75,"resaleActivityLevel":25,"mngmtExperienceStability":35,"averageUnitRevenueGrowth":60,"prospectScreening":30,"unitEconomics":70,"franchiseAgreementAssessment":15,"franchiseeRelationship":30,"projectedUnitSuccess":200,"recurringRevenueSelfSufficiency":50,"totalFundScore":750,"finStatementStrength":25,"franchisedUnits":100,"minInitial":258625,"maxInitial":1609500,"avgInitial":602350,"companyOwnedUnits":53,"projectedOpenings":12,"compoundAnnualUnitGrowthRate":91.0,"compoundedUnitSuccessRate":0.96,"experianDBT":5,"equifaxDBT":null,"dbdbt":null,"dbPaydex":null,"ansoniaCreditRating":"3071K-8","ansoniaRiskScore":95,"creditLogicScore":58,"dbViabilityRating":"","lastReportRun":"2019-06-07","bankruptciesCount":0,"collectionsCount":0,"judgmentsCount":0,"chargeOffsCount":0,"liensCount":0,"nsfChecksCount":0,"dataDepthScore":0,"underFormation":null,"dateBusinessEstablished":null,"loanBoardingIdentifier":null,"crmIdentifier":null,"isMailingAddressDifferent":false,"licenseNumber":null}]} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "ReadCustomers" ] } ] }, "post": { "tags": [ "Customers" ], "summary": "Creates a new customer", "operationId": "Create", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "The customer to create", "schema": { "$ref": "#/definitions/Customer" } } ], "responses": { "201": { "description": "The customer has been created successfully. The customer\r\n that was created is returned and has the Sageworks id that was assigned.", "schema": { "$ref": "#/definitions/Customer" }, "examples": { "application/json": {"id":4513215,"name":"Example, LLC","dba":"Example Doing Business As","firstName":null,"middleInitial":null,"lastName":null,"nameSuffix":null,"userDefinedFields":{"User Defined Field 1":"Value 1","User Defined Field 2":"Value 2"},"creditScore":98,"secondaryCreditScore":99,"businessType":"llc","dnbScore":"567","namePrefix":null,"jobTitle":null,"addresses":[{"line1":"123 Main St","line2":"Apt 4B","city":"Example City","state":"NY","postalCode":"00101","country":"US","addressType":"primary"}],"phoneNumbers":[{"type":"primary","number":"(999)999-9999"}],"type":"business","emailAddress":"test@sageworks.com","industryCode":"99999","isDeleted":false,"uniqueIdentifier":"785654","taxId":"111111111","branch":null,"department":null,"website":null,"description":null,"restricted":false,"checkingBalance":15000.0,"savingsBalance":100000.0,"cDsBalance":50000.0,"averageChecking":14500.0,"averageSavings":125000.0,"averageCDs":60000.0,"citizenshipStatus":null,"maritalStatus":null,"isActiveMiltaryDuty":null,"isDependentOfActiveMiltaryDuty":null,"civDescription":null,"employer":null,"numberOfYearsEmployed":0.0,"ofacDesignation":null,"dateOfBirth":null,"idDescription":null,"idNumber":null,"idIssueDate":null,"idExpirationDate":null,"idIssuingAuthority":null,"idState":null,"comments":null,"msa":16980,"stateCode":12,"countyCode":"123","tractCode":"3453","longitude":-87.656376,"latitude":41.94763,"medianHouseholdIncome":107250.0,"metropolitanDivision":"Chicago-Naperville-Evanston, IL","metropolitanDivisionCode":"1234242","loanOfficer":null,"loanOfficerId":438331,"loanAdministrator":null,"equifaxCreditScore":null,"equifaxCreditScoreDate":null,"experianCreditScore":null,"experianCreditScoreDate":null,"transunionCreditScore":null,"transunionCreditScoreDate":null,"ficoSbssCreditScore":450,"ficoSbssCreditScoreDate":"2019-06-09","bankruptcies":null,"dateOfLastBankruptcy":null,"historical30DayDelinquencies":null,"historical60DayDelinquencies":null,"historical90DayDelinquencies":null,"historicalOtherDelinquencies":null,"currentMortgagePastDue":null,"currentInstallmentPastDue":null,"currentAutoPastDue":null,"currentEducationPastDue":null,"currentOpenPastDue":null,"currentRevolvingPastDue":null,"currentOtherPastDue":null,"currentTotalPastDue":null,"entryMethod":"operatingCompany","professionalLLC":true,"yearFounded":1999,"businessRegistered":"NY","farmRegistered":null,"stateOfFormation":"NY","franchiseName":"Franchise #1","franchiseLegalName":"#1 Franchise","franchiseStartDate":1999,"sbaCode":"123","cityHQ":"Chicago","stateHQ":"IL","franchiseDataImportDate":"2019-09-06","franchiseDataFinancialPeriod":2019,"historicalSuccessRate":130,"systemSupportAndExpenseCommitment":75,"resaleActivityLevel":25,"mngmtExperienceStability":35,"averageUnitRevenueGrowth":60,"prospectScreening":30,"unitEconomics":70,"franchiseAgreementAssessment":15,"franchiseeRelationship":30,"projectedUnitSuccess":200,"recurringRevenueSelfSufficiency":50,"totalFundScore":750,"finStatementStrength":25,"franchisedUnits":100,"minInitial":258625,"maxInitial":1609500,"avgInitial":602350,"companyOwnedUnits":53,"projectedOpenings":12,"compoundAnnualUnitGrowthRate":91.0,"compoundedUnitSuccessRate":0.96,"experianDBT":5,"equifaxDBT":null,"dbdbt":null,"dbPaydex":null,"ansoniaCreditRating":"3071K-8","ansoniaRiskScore":95,"creditLogicScore":58,"dbViabilityRating":"","lastReportRun":"2019-10-06","bankruptciesCount":0,"collectionsCount":0,"judgmentsCount":0,"chargeOffsCount":0,"liensCount":0,"nsfChecksCount":0,"dataDepthScore":0,"underFormation":null,"dateBusinessEstablished":null,"loanBoardingIdentifier":"12345","crmIdentifier":"66754","isMailingAddressDifferent":false,"licenseNumber":null} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "CreateCustomers" ] } ] } }, "/v1/customers/basic-information": { "get": { "tags": [ "Customers" ], "summary": "Gets all customer basic information", "operationId": "GetPagedBasicInformation", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "page", "description": "The page number of results to retrieve (first page = 1, default = 1)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "perPage", "description": "The number of records to return on each page (minimum = 1, maximum = 1000, default = 200)", "type": "integer", "format": "int32", "x-nullable": true } ], "responses": { "200": { "description": "Gets basic information for all current, existing, and active customers in the account", "schema": { "$ref": "#/definitions/CollectionResponse[CustomerBasicInformation]" }, "examples": { "application/json": [{"id":556098165,"name":"Sageworks API Business","type":"business","uniqueIdentifier":"fdas-gdes-5543","isDeleted":false},{"id":465112351,"name":"Sageworks Farm","type":"farm","uniqueIdentifier":"asdf-rewq-1231","isDeleted":false}] } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "ReadCustomers" ] } ] } }, "/v1/customers/search": { "get": { "tags": [ "Customers" ], "summary": "Search customers based on specific criteria", "operationId": "GetPagedCustomerSearch", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "page", "description": "The page number of results to retrieve (first page = 1, default = 1)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "perPage", "description": "The number of records to return on each page (minimum = 1, maximum = 1000, default = 200)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "onlyCustomersWithFinancialRecords", "description": "Set to true to ensure the records return are linked to financial records", "type": "boolean", "default": false } ], "responses": { "200": { "description": "Gets basic information for all current, existing, and active customers that meet search criteria", "schema": { "$ref": "#/definitions/CollectionResponse[CustomerBasicInformation]" }, "examples": { "application/json": [{"id":556098165,"name":"Sageworks API Business","type":"business","uniqueIdentifier":"fdas-gdes-5543","isDeleted":false},{"id":465112351,"name":"Sageworks Farm","type":"farm","uniqueIdentifier":"asdf-rewq-1231","isDeleted":false}] } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "ReadCustomers" ] } ] } }, "/v1/customers/bulk": { "post": { "tags": [ "Customers" ], "summary": "Creates a collection of customers", "operationId": "CreateMany", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "The collection of customers to create", "schema": { "$ref": "#/definitions/BulkCreateRequest[Customer]" } } ], "responses": { "200": { "description": "All customers were processed. Please check the errors property of the response object\r\n to determine if there were errors creating any individual customer", "schema": { "$ref": "#/definitions/BulkCreateResponse[Customer]" }, "examples": { "application/json": {"itemsCreated":[{"id":7456123,"name":"Example, LLC","dba":"Example Doing Business As","firstName":null,"middleInitial":null,"lastName":null,"nameSuffix":null,"userDefinedFields":null,"creditScore":98,"secondaryCreditScore":null,"businessType":"llc","dnbScore":"567","namePrefix":null,"jobTitle":null,"addresses":[{"line1":"123 Main St","line2":"Suite 2078","city":"Example City","state":"NY","postalCode":"00101","country":"US","addressType":"primary"}],"phoneNumbers":[{"type":"primary","number":"(999)999-9999"}],"type":"business","emailAddress":"test-company@sageworks.com","industryCode":"99999","isDeleted":false,"uniqueIdentifier":"785654","taxId":null,"branch":null,"department":null,"website":null,"description":null,"restricted":false,"checkingBalance":15000.0,"savingsBalance":100000.0,"cDsBalance":50000.0,"averageChecking":14500.0,"averageSavings":125000.0,"averageCDs":60000.0,"citizenshipStatus":null,"maritalStatus":null,"isActiveMiltaryDuty":null,"isDependentOfActiveMiltaryDuty":null,"civDescription":null,"employer":null,"numberOfYearsEmployed":0.0,"ofacDesignation":null,"dateOfBirth":null,"idDescription":null,"idNumber":null,"idIssueDate":null,"idExpirationDate":null,"idIssuingAuthority":null,"idState":null,"comments":null,"msa":null,"stateCode":null,"countyCode":null,"tractCode":null,"longitude":null,"latitude":null,"medianHouseholdIncome":null,"metropolitanDivision":null,"metropolitanDivisionCode":null,"loanOfficer":null,"loanOfficerId":null,"loanAdministrator":null,"equifaxCreditScore":null,"equifaxCreditScoreDate":null,"experianCreditScore":null,"experianCreditScoreDate":null,"transunionCreditScore":null,"transunionCreditScoreDate":null,"ficoSbssCreditScore":null,"ficoSbssCreditScoreDate":null,"bankruptcies":null,"dateOfLastBankruptcy":null,"historical30DayDelinquencies":null,"historical60DayDelinquencies":null,"historical90DayDelinquencies":null,"historicalOtherDelinquencies":null,"currentMortgagePastDue":null,"currentInstallmentPastDue":null,"currentAutoPastDue":null,"currentEducationPastDue":null,"currentOpenPastDue":null,"currentRevolvingPastDue":null,"currentOtherPastDue":null,"currentTotalPastDue":null,"entryMethod":"operatingCompany","professionalLLC":null,"yearFounded":0,"businessRegistered":null,"farmRegistered":null,"stateOfFormation":null,"franchiseName":null,"franchiseLegalName":null,"franchiseStartDate":null,"sbaCode":null,"cityHQ":null,"stateHQ":null,"franchiseDataImportDate":null,"franchiseDataFinancialPeriod":null,"historicalSuccessRate":null,"systemSupportAndExpenseCommitment":null,"resaleActivityLevel":null,"mngmtExperienceStability":null,"averageUnitRevenueGrowth":null,"prospectScreening":null,"unitEconomics":null,"franchiseAgreementAssessment":null,"franchiseeRelationship":null,"projectedUnitSuccess":null,"recurringRevenueSelfSufficiency":null,"totalFundScore":null,"finStatementStrength":null,"franchisedUnits":null,"minInitial":null,"maxInitial":null,"avgInitial":null,"companyOwnedUnits":null,"projectedOpenings":null,"compoundAnnualUnitGrowthRate":null,"compoundedUnitSuccessRate":null,"experianDBT":null,"equifaxDBT":null,"dbdbt":null,"dbPaydex":null,"ansoniaCreditRating":null,"ansoniaRiskScore":null,"creditLogicScore":null,"dbViabilityRating":null,"lastReportRun":null,"bankruptciesCount":null,"collectionsCount":null,"judgmentsCount":null,"chargeOffsCount":null,"liensCount":null,"nsfChecksCount":null,"dataDepthScore":null,"underFormation":null,"dateBusinessEstablished":null,"loanBoardingIdentifier":"12345","crmIdentifier":"66754","isMailingAddressDifferent":false,"licenseNumber":null},{"id":4213102,"name":"Smith, John","dba":null,"firstName":"John","middleInitial":null,"lastName":"Smith","nameSuffix":null,"userDefinedFields":null,"creditScore":650,"secondaryCreditScore":null,"businessType":null,"dnbScore":null,"namePrefix":null,"jobTitle":null,"addresses":[{"line1":"456 Circle St","line2":"Apt 4B","city":"New York","state":"NY","postalCode":"00101","country":"US","addressType":"primary"}],"phoneNumbers":[{"type":"mobile","number":"(999)999-9999"}],"type":"person","emailAddress":"test-person@sageworks.com","industryCode":null,"isDeleted":false,"uniqueIdentifier":"746313","taxId":null,"branch":null,"department":null,"website":null,"description":null,"restricted":false,"checkingBalance":15000.0,"savingsBalance":100000.0,"cDsBalance":50000.0,"averageChecking":14500.0,"averageSavings":125000.0,"averageCDs":60000.0,"citizenshipStatus":null,"maritalStatus":null,"isActiveMiltaryDuty":null,"isDependentOfActiveMiltaryDuty":null,"civDescription":null,"employer":null,"numberOfYearsEmployed":0.0,"ofacDesignation":null,"dateOfBirth":null,"idDescription":null,"idNumber":null,"idIssueDate":null,"idExpirationDate":null,"idIssuingAuthority":null,"idState":null,"comments":null,"msa":null,"stateCode":null,"countyCode":null,"tractCode":null,"longitude":null,"latitude":null,"medianHouseholdIncome":null,"metropolitanDivision":null,"metropolitanDivisionCode":null,"loanOfficer":null,"loanOfficerId":null,"loanAdministrator":null,"equifaxCreditScore":null,"equifaxCreditScoreDate":null,"experianCreditScore":null,"experianCreditScoreDate":null,"transunionCreditScore":null,"transunionCreditScoreDate":null,"ficoSbssCreditScore":null,"ficoSbssCreditScoreDate":null,"bankruptcies":null,"dateOfLastBankruptcy":null,"historical30DayDelinquencies":null,"historical60DayDelinquencies":null,"historical90DayDelinquencies":null,"historicalOtherDelinquencies":null,"currentMortgagePastDue":null,"currentInstallmentPastDue":null,"currentAutoPastDue":null,"currentEducationPastDue":null,"currentOpenPastDue":null,"currentRevolvingPastDue":null,"currentOtherPastDue":null,"currentTotalPastDue":null,"entryMethod":"operatingCompany","professionalLLC":null,"yearFounded":0,"businessRegistered":null,"farmRegistered":null,"stateOfFormation":null,"franchiseName":null,"franchiseLegalName":null,"franchiseStartDate":null,"sbaCode":null,"cityHQ":null,"stateHQ":null,"franchiseDataImportDate":null,"franchiseDataFinancialPeriod":null,"historicalSuccessRate":null,"systemSupportAndExpenseCommitment":null,"resaleActivityLevel":null,"mngmtExperienceStability":null,"averageUnitRevenueGrowth":null,"prospectScreening":null,"unitEconomics":null,"franchiseAgreementAssessment":null,"franchiseeRelationship":null,"projectedUnitSuccess":null,"recurringRevenueSelfSufficiency":null,"totalFundScore":null,"finStatementStrength":null,"franchisedUnits":null,"minInitial":null,"maxInitial":null,"avgInitial":null,"companyOwnedUnits":null,"projectedOpenings":null,"compoundAnnualUnitGrowthRate":null,"compoundedUnitSuccessRate":null,"experianDBT":null,"equifaxDBT":null,"dbdbt":null,"dbPaydex":null,"ansoniaCreditRating":null,"ansoniaRiskScore":null,"creditLogicScore":null,"dbViabilityRating":null,"lastReportRun":null,"bankruptciesCount":null,"collectionsCount":null,"judgmentsCount":null,"chargeOffsCount":null,"liensCount":null,"nsfChecksCount":null,"dataDepthScore":null,"underFormation":null,"dateBusinessEstablished":null,"loanBoardingIdentifier":null,"crmIdentifier":null,"isMailingAddressDifferent":false,"licenseNumber":null},null,{"id":45123997,"name":"Example Farm","dba":null,"firstName":null,"middleInitial":null,"lastName":null,"nameSuffix":null,"userDefinedFields":null,"creditScore":98,"secondaryCreditScore":null,"businessType":"soleProp","dnbScore":"567","namePrefix":null,"jobTitle":null,"addresses":[{"line1":"964 Meadow Ave","line2":"","city":"Seattle","state":"WA","postalCode":"90541","country":"US","addressType":"primary"}],"phoneNumbers":[{"type":"primary","number":"(999)999-9999"}],"type":"farm","emailAddress":"test@sageworks.com","industryCode":"99999","isDeleted":false,"uniqueIdentifier":null,"taxId":null,"branch":null,"department":null,"website":null,"description":null,"restricted":false,"checkingBalance":15000.0,"savingsBalance":100000.0,"cDsBalance":50000.0,"averageChecking":14500.0,"averageSavings":125000.0,"averageCDs":60000.0,"citizenshipStatus":null,"maritalStatus":null,"isActiveMiltaryDuty":null,"isDependentOfActiveMiltaryDuty":null,"civDescription":null,"employer":null,"numberOfYearsEmployed":0.0,"ofacDesignation":null,"dateOfBirth":null,"idDescription":null,"idNumber":null,"idIssueDate":null,"idExpirationDate":null,"idIssuingAuthority":null,"idState":null,"comments":null,"msa":null,"stateCode":null,"countyCode":null,"tractCode":null,"longitude":null,"latitude":null,"medianHouseholdIncome":null,"metropolitanDivision":null,"metropolitanDivisionCode":null,"loanOfficer":null,"loanOfficerId":null,"loanAdministrator":null,"equifaxCreditScore":null,"equifaxCreditScoreDate":null,"experianCreditScore":null,"experianCreditScoreDate":null,"transunionCreditScore":null,"transunionCreditScoreDate":null,"ficoSbssCreditScore":null,"ficoSbssCreditScoreDate":null,"bankruptcies":null,"dateOfLastBankruptcy":null,"historical30DayDelinquencies":null,"historical60DayDelinquencies":null,"historical90DayDelinquencies":null,"historicalOtherDelinquencies":null,"currentMortgagePastDue":null,"currentInstallmentPastDue":null,"currentAutoPastDue":null,"currentEducationPastDue":null,"currentOpenPastDue":null,"currentRevolvingPastDue":null,"currentOtherPastDue":null,"currentTotalPastDue":null,"entryMethod":"operatingCompany","professionalLLC":null,"yearFounded":0,"businessRegistered":null,"farmRegistered":null,"stateOfFormation":null,"franchiseName":null,"franchiseLegalName":null,"franchiseStartDate":null,"sbaCode":null,"cityHQ":null,"stateHQ":null,"franchiseDataImportDate":null,"franchiseDataFinancialPeriod":null,"historicalSuccessRate":null,"systemSupportAndExpenseCommitment":null,"resaleActivityLevel":null,"mngmtExperienceStability":null,"averageUnitRevenueGrowth":null,"prospectScreening":null,"unitEconomics":null,"franchiseAgreementAssessment":null,"franchiseeRelationship":null,"projectedUnitSuccess":null,"recurringRevenueSelfSufficiency":null,"totalFundScore":null,"finStatementStrength":null,"franchisedUnits":null,"minInitial":null,"maxInitial":null,"avgInitial":null,"companyOwnedUnits":null,"projectedOpenings":null,"compoundAnnualUnitGrowthRate":null,"compoundedUnitSuccessRate":null,"experianDBT":null,"equifaxDBT":null,"dbdbt":null,"dbPaydex":null,"ansoniaCreditRating":null,"ansoniaRiskScore":null,"creditLogicScore":null,"dbViabilityRating":null,"lastReportRun":null,"bankruptciesCount":null,"collectionsCount":null,"judgmentsCount":null,"chargeOffsCount":null,"liensCount":null,"nsfChecksCount":null,"dataDepthScore":null,"underFormation":null,"dateBusinessEstablished":null,"loanBoardingIdentifier":null,"crmIdentifier":null,"isMailingAddressDifferent":false,"licenseNumber":null}],"errors":{"2":{"errorType":"invalidRequest","message":"Input model for request is invalid","modelErrors":[{"propertyName":"name","message":"name is required"}]}}} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "CreateCustomers" ] } ] }, "patch": { "tags": [ "Customers" ], "summary": "Updates a collection of customers", "operationId": "UpdateMany", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "The collection of customers to update", "schema": { "$ref": "#/definitions/BulkUpdateRequest[Customer]" } } ], "responses": { "200": { "description": "All customers were processed. Please check the errors property of the response object\r\n to determine if there were errors updating any individual customer", "schema": { "$ref": "#/definitions/BulkUpdateRequest[Customer]" }, "examples": { "application/json": {"itemsUpdated":[{"id":7456123,"name":"Example, LLC","dba":"Example Doing Business As","firstName":null,"middleInitial":null,"lastName":null,"nameSuffix":null,"userDefinedFields":null,"creditScore":98,"secondaryCreditScore":null,"businessType":"llc","dnbScore":"567","namePrefix":null,"jobTitle":null,"addresses":[{"line1":"123 Main St","line2":"Suite 2078","city":"Example City","state":"NY","postalCode":"00101","country":"US","addressType":"primary"}],"phoneNumbers":[{"type":"primary","number":"(999)999-9999"}],"type":"business","emailAddress":"test-company@sageworks.com","industryCode":"99999","isDeleted":false,"uniqueIdentifier":"785654","taxId":null,"branch":null,"department":null,"website":null,"description":null,"restricted":false,"checkingBalance":15000.0,"savingsBalance":100000.0,"cDsBalance":50000.0,"averageChecking":14500.0,"averageSavings":125000.0,"averageCDs":60000.0,"citizenshipStatus":null,"maritalStatus":null,"isActiveMiltaryDuty":null,"isDependentOfActiveMiltaryDuty":null,"civDescription":null,"employer":null,"numberOfYearsEmployed":0.0,"ofacDesignation":null,"dateOfBirth":null,"idDescription":null,"idNumber":null,"idIssueDate":null,"idExpirationDate":null,"idIssuingAuthority":null,"idState":null,"comments":null,"msa":null,"stateCode":null,"countyCode":null,"tractCode":null,"longitude":null,"latitude":null,"medianHouseholdIncome":null,"metropolitanDivision":null,"metropolitanDivisionCode":null,"loanOfficer":null,"loanOfficerId":null,"loanAdministrator":null,"equifaxCreditScore":null,"equifaxCreditScoreDate":null,"experianCreditScore":null,"experianCreditScoreDate":null,"transunionCreditScore":null,"transunionCreditScoreDate":null,"ficoSbssCreditScore":null,"ficoSbssCreditScoreDate":null,"bankruptcies":null,"dateOfLastBankruptcy":null,"historical30DayDelinquencies":null,"historical60DayDelinquencies":null,"historical90DayDelinquencies":null,"historicalOtherDelinquencies":null,"currentMortgagePastDue":null,"currentInstallmentPastDue":null,"currentAutoPastDue":null,"currentEducationPastDue":null,"currentOpenPastDue":null,"currentRevolvingPastDue":null,"currentOtherPastDue":null,"currentTotalPastDue":null,"entryMethod":"operatingCompany","professionalLLC":null,"yearFounded":0,"businessRegistered":null,"farmRegistered":null,"stateOfFormation":null,"franchiseName":null,"franchiseLegalName":null,"franchiseStartDate":null,"sbaCode":null,"cityHQ":null,"stateHQ":null,"franchiseDataImportDate":null,"franchiseDataFinancialPeriod":null,"historicalSuccessRate":null,"systemSupportAndExpenseCommitment":null,"resaleActivityLevel":null,"mngmtExperienceStability":null,"averageUnitRevenueGrowth":null,"prospectScreening":null,"unitEconomics":null,"franchiseAgreementAssessment":null,"franchiseeRelationship":null,"projectedUnitSuccess":null,"recurringRevenueSelfSufficiency":null,"totalFundScore":null,"finStatementStrength":null,"franchisedUnits":null,"minInitial":null,"maxInitial":null,"avgInitial":null,"companyOwnedUnits":null,"projectedOpenings":null,"compoundAnnualUnitGrowthRate":null,"compoundedUnitSuccessRate":null,"experianDBT":null,"equifaxDBT":null,"dbdbt":null,"dbPaydex":null,"ansoniaCreditRating":null,"ansoniaRiskScore":null,"creditLogicScore":null,"dbViabilityRating":null,"lastReportRun":null,"bankruptciesCount":null,"collectionsCount":null,"judgmentsCount":null,"chargeOffsCount":null,"liensCount":null,"nsfChecksCount":null,"dataDepthScore":null,"underFormation":null,"dateBusinessEstablished":null,"loanBoardingIdentifier":"675665","crmIdentifier":"66754","isMailingAddressDifferent":false,"licenseNumber":null},{"id":4213102,"name":"Smith, John","dba":null,"firstName":"John","middleInitial":null,"lastName":"Smith","nameSuffix":null,"userDefinedFields":null,"creditScore":650,"secondaryCreditScore":null,"businessType":null,"dnbScore":null,"namePrefix":null,"jobTitle":null,"addresses":[{"line1":"456 Circle St","line2":"Apt 4B","city":"New York","state":"NY","postalCode":"00101","country":"US","addressType":"primary"}],"phoneNumbers":[{"type":"mobile","number":"(999)999-9999"}],"type":"person","emailAddress":"test-person@sageworks.com","industryCode":null,"isDeleted":false,"uniqueIdentifier":"746313","taxId":null,"branch":null,"department":null,"website":null,"description":null,"restricted":false,"checkingBalance":15000.0,"savingsBalance":100000.0,"cDsBalance":50000.0,"averageChecking":14500.0,"averageSavings":125000.0,"averageCDs":60000.0,"citizenshipStatus":null,"maritalStatus":null,"isActiveMiltaryDuty":null,"isDependentOfActiveMiltaryDuty":null,"civDescription":null,"employer":null,"numberOfYearsEmployed":0.0,"ofacDesignation":null,"dateOfBirth":null,"idDescription":null,"idNumber":null,"idIssueDate":null,"idExpirationDate":null,"idIssuingAuthority":null,"idState":null,"comments":null,"msa":null,"stateCode":null,"countyCode":null,"tractCode":null,"longitude":null,"latitude":null,"medianHouseholdIncome":null,"metropolitanDivision":null,"metropolitanDivisionCode":null,"loanOfficer":null,"loanOfficerId":null,"loanAdministrator":null,"equifaxCreditScore":null,"equifaxCreditScoreDate":null,"experianCreditScore":null,"experianCreditScoreDate":null,"transunionCreditScore":null,"transunionCreditScoreDate":null,"ficoSbssCreditScore":null,"ficoSbssCreditScoreDate":null,"bankruptcies":null,"dateOfLastBankruptcy":null,"historical30DayDelinquencies":null,"historical60DayDelinquencies":null,"historical90DayDelinquencies":null,"historicalOtherDelinquencies":null,"currentMortgagePastDue":null,"currentInstallmentPastDue":null,"currentAutoPastDue":null,"currentEducationPastDue":null,"currentOpenPastDue":null,"currentRevolvingPastDue":null,"currentOtherPastDue":null,"currentTotalPastDue":null,"entryMethod":"operatingCompany","professionalLLC":null,"yearFounded":0,"businessRegistered":null,"farmRegistered":null,"stateOfFormation":null,"franchiseName":null,"franchiseLegalName":null,"franchiseStartDate":null,"sbaCode":null,"cityHQ":null,"stateHQ":null,"franchiseDataImportDate":null,"franchiseDataFinancialPeriod":null,"historicalSuccessRate":null,"systemSupportAndExpenseCommitment":null,"resaleActivityLevel":null,"mngmtExperienceStability":null,"averageUnitRevenueGrowth":null,"prospectScreening":null,"unitEconomics":null,"franchiseAgreementAssessment":null,"franchiseeRelationship":null,"projectedUnitSuccess":null,"recurringRevenueSelfSufficiency":null,"totalFundScore":null,"finStatementStrength":null,"franchisedUnits":null,"minInitial":null,"maxInitial":null,"avgInitial":null,"companyOwnedUnits":null,"projectedOpenings":null,"compoundAnnualUnitGrowthRate":null,"compoundedUnitSuccessRate":null,"experianDBT":null,"equifaxDBT":null,"dbdbt":null,"dbPaydex":null,"ansoniaCreditRating":null,"ansoniaRiskScore":null,"creditLogicScore":null,"dbViabilityRating":null,"lastReportRun":null,"bankruptciesCount":null,"collectionsCount":null,"judgmentsCount":null,"chargeOffsCount":null,"liensCount":null,"nsfChecksCount":null,"dataDepthScore":null,"underFormation":null,"dateBusinessEstablished":null,"loanBoardingIdentifier":"44444","crmIdentifier":"45464","isMailingAddressDifferent":false,"licenseNumber":null},null,{"id":45123997,"name":"Example Farm","dba":null,"firstName":null,"middleInitial":null,"lastName":null,"nameSuffix":null,"userDefinedFields":null,"creditScore":98,"secondaryCreditScore":null,"businessType":"soleProp","dnbScore":"567","namePrefix":null,"jobTitle":null,"addresses":[{"line1":"964 Meadow Ave","line2":"","city":"Seattle","state":"WA","postalCode":"90541","country":"US","addressType":"primary"}],"phoneNumbers":[{"type":"primary","number":"(999)999-9999"}],"type":"farm","emailAddress":"test@sageworks.com","industryCode":"99999","isDeleted":false,"uniqueIdentifier":null,"taxId":null,"branch":null,"department":null,"website":null,"description":null,"restricted":false,"checkingBalance":15000.0,"savingsBalance":100000.0,"cDsBalance":50000.0,"averageChecking":14500.0,"averageSavings":125000.0,"averageCDs":60000.0,"citizenshipStatus":null,"maritalStatus":null,"isActiveMiltaryDuty":null,"isDependentOfActiveMiltaryDuty":null,"civDescription":null,"employer":null,"numberOfYearsEmployed":0.0,"ofacDesignation":null,"dateOfBirth":null,"idDescription":null,"idNumber":null,"idIssueDate":null,"idExpirationDate":null,"idIssuingAuthority":null,"idState":null,"comments":null,"msa":null,"stateCode":null,"countyCode":null,"tractCode":null,"longitude":null,"latitude":null,"medianHouseholdIncome":null,"metropolitanDivision":null,"metropolitanDivisionCode":null,"loanOfficer":null,"loanOfficerId":null,"loanAdministrator":null,"equifaxCreditScore":null,"equifaxCreditScoreDate":null,"experianCreditScore":null,"experianCreditScoreDate":null,"transunionCreditScore":null,"transunionCreditScoreDate":null,"ficoSbssCreditScore":null,"ficoSbssCreditScoreDate":null,"bankruptcies":null,"dateOfLastBankruptcy":null,"historical30DayDelinquencies":null,"historical60DayDelinquencies":null,"historical90DayDelinquencies":null,"historicalOtherDelinquencies":null,"currentMortgagePastDue":null,"currentInstallmentPastDue":null,"currentAutoPastDue":null,"currentEducationPastDue":null,"currentOpenPastDue":null,"currentRevolvingPastDue":null,"currentOtherPastDue":null,"currentTotalPastDue":null,"entryMethod":"operatingCompany","professionalLLC":null,"yearFounded":0,"businessRegistered":null,"farmRegistered":null,"stateOfFormation":null,"franchiseName":null,"franchiseLegalName":null,"franchiseStartDate":null,"sbaCode":null,"cityHQ":null,"stateHQ":null,"franchiseDataImportDate":null,"franchiseDataFinancialPeriod":null,"historicalSuccessRate":null,"systemSupportAndExpenseCommitment":null,"resaleActivityLevel":null,"mngmtExperienceStability":null,"averageUnitRevenueGrowth":null,"prospectScreening":null,"unitEconomics":null,"franchiseAgreementAssessment":null,"franchiseeRelationship":null,"projectedUnitSuccess":null,"recurringRevenueSelfSufficiency":null,"totalFundScore":null,"finStatementStrength":null,"franchisedUnits":null,"minInitial":null,"maxInitial":null,"avgInitial":null,"companyOwnedUnits":null,"projectedOpenings":null,"compoundAnnualUnitGrowthRate":null,"compoundedUnitSuccessRate":null,"experianDBT":null,"equifaxDBT":null,"dbdbt":null,"dbPaydex":null,"ansoniaCreditRating":null,"ansoniaRiskScore":null,"creditLogicScore":null,"dbViabilityRating":null,"lastReportRun":null,"bankruptciesCount":null,"collectionsCount":null,"judgmentsCount":null,"chargeOffsCount":null,"liensCount":null,"nsfChecksCount":null,"dataDepthScore":null,"underFormation":null,"dateBusinessEstablished":null,"loanBoardingIdentifier":null,"crmIdentifier":null,"isMailingAddressDifferent":false,"licenseNumber":null}],"errors":{"2":{"errorType":"invalidRequest","message":"Input model for request is invalid","modelErrors":[{"propertyName":"name","message":"name is required"}]}}} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "UpdateCustomers" ] } ] } }, "/v1/customers/{id}": { "patch": { "tags": [ "Customers" ], "summary": "Updates a customer", "operationId": "Update", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "id of the existing customer to update", "required": true, "type": "integer", "format": "int32" }, { "in": "body", "name": "body", "description": "The customer values to update", "schema": { "$ref": "#/definitions/Customer" } } ], "responses": { "200": { "description": "Returns the modified customer", "schema": { "$ref": "#/definitions/Customer" }, "examples": { "application/json": {"id":4513215,"name":"Example, LLC","dba":"Example Doing Business As","firstName":null,"middleInitial":null,"lastName":null,"nameSuffix":null,"userDefinedFields":{"User Defined Field 1":"Value 1","User Defined Field 2":"Value 2"},"creditScore":98,"secondaryCreditScore":99,"businessType":"llc","dnbScore":"567","namePrefix":null,"jobTitle":null,"addresses":[{"line1":"123 Main St","line2":"Apt 4B","city":"Example City","state":"NY","postalCode":"00101","country":"US","addressType":"primary"}],"phoneNumbers":[{"type":"primary","number":"(999)999-9999"}],"type":"business","emailAddress":"test@sageworks.com","industryCode":"99999","isDeleted":false,"uniqueIdentifier":"785654","taxId":"111111111","branch":null,"department":null,"website":null,"description":null,"restricted":false,"checkingBalance":15000.0,"savingsBalance":100000.0,"cDsBalance":50000.0,"averageChecking":14500.0,"averageSavings":125000.0,"averageCDs":60000.0,"citizenshipStatus":null,"maritalStatus":null,"isActiveMiltaryDuty":null,"isDependentOfActiveMiltaryDuty":null,"civDescription":null,"employer":null,"numberOfYearsEmployed":0.0,"ofacDesignation":null,"dateOfBirth":null,"idDescription":null,"idNumber":null,"idIssueDate":null,"idExpirationDate":null,"idIssuingAuthority":null,"idState":null,"comments":null,"msa":16980,"stateCode":12,"countyCode":"123","tractCode":"3453","longitude":-87.656376,"latitude":41.94763,"medianHouseholdIncome":107250.0,"metropolitanDivision":"Chicago-Naperville-Evanston, IL","metropolitanDivisionCode":"1234242","loanOfficer":null,"loanOfficerId":438331,"loanAdministrator":null,"equifaxCreditScore":null,"equifaxCreditScoreDate":null,"experianCreditScore":null,"experianCreditScoreDate":null,"transunionCreditScore":null,"transunionCreditScoreDate":null,"ficoSbssCreditScore":450,"ficoSbssCreditScoreDate":"2019-06-09","bankruptcies":null,"dateOfLastBankruptcy":null,"historical30DayDelinquencies":null,"historical60DayDelinquencies":null,"historical90DayDelinquencies":null,"historicalOtherDelinquencies":null,"currentMortgagePastDue":null,"currentInstallmentPastDue":null,"currentAutoPastDue":null,"currentEducationPastDue":null,"currentOpenPastDue":null,"currentRevolvingPastDue":null,"currentOtherPastDue":null,"currentTotalPastDue":null,"entryMethod":"operatingCompany","professionalLLC":true,"yearFounded":1999,"businessRegistered":"NY","farmRegistered":null,"stateOfFormation":"NY","franchiseName":"Franchise #1","franchiseLegalName":"#1 Franchise","franchiseStartDate":1999,"sbaCode":"123","cityHQ":"Chicago","stateHQ":"IL","franchiseDataImportDate":"2019-09-06","franchiseDataFinancialPeriod":2019,"historicalSuccessRate":130,"systemSupportAndExpenseCommitment":75,"resaleActivityLevel":25,"mngmtExperienceStability":35,"averageUnitRevenueGrowth":60,"prospectScreening":30,"unitEconomics":70,"franchiseAgreementAssessment":15,"franchiseeRelationship":30,"projectedUnitSuccess":200,"recurringRevenueSelfSufficiency":50,"totalFundScore":750,"finStatementStrength":25,"franchisedUnits":100,"minInitial":258625,"maxInitial":1609500,"avgInitial":602350,"companyOwnedUnits":53,"projectedOpenings":12,"compoundAnnualUnitGrowthRate":91.0,"compoundedUnitSuccessRate":0.96,"experianDBT":5,"equifaxDBT":null,"dbdbt":null,"dbPaydex":null,"ansoniaCreditRating":"3071K-8","ansoniaRiskScore":95,"creditLogicScore":58,"dbViabilityRating":"","lastReportRun":"2019-10-06","bankruptciesCount":0,"collectionsCount":0,"judgmentsCount":0,"chargeOffsCount":0,"liensCount":0,"nsfChecksCount":0,"dataDepthScore":0,"underFormation":null,"dateBusinessEstablished":null,"loanBoardingIdentifier":"12345","crmIdentifier":"66754","isMailingAddressDifferent":false,"licenseNumber":null} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "UpdateCustomers" ] } ] }, "delete": { "tags": [ "Customers" ], "summary": "Deletes a customer by id", "operationId": "Delete", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "id of the existing customer to delete", "required": true, "type": "integer", "format": "int32" } ], "responses": { "204": { "description": "The customer has been deleted successfully." }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "DeleteCustomers" ] } ] }, "get": { "tags": [ "Customers" ], "summary": "Gets a customer by id", "operationId": "GetById", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "id of the customer to get", "required": true, "type": "integer", "format": "int32" }, { "in": "query", "name": "includeUserDefinedFields", "description": "Include User Defined fields in the response", "type": "boolean", "default": false, "x-nullable": true } ], "responses": { "200": { "description": "Gets the customer with the specified id", "schema": { "$ref": "#/definitions/Customer" }, "examples": { "application/json": {"id":4513215,"name":"Example, LLC","dba":"Example Doing Business As","firstName":null,"middleInitial":null,"lastName":null,"nameSuffix":null,"userDefinedFields":{"User Defined Field 1":"Value 1","User Defined Field 2":"Value 2"},"creditScore":98,"secondaryCreditScore":99,"businessType":"llc","dnbScore":"567","namePrefix":null,"jobTitle":null,"addresses":[{"line1":"123 Main St","line2":"Apt 4B","city":"Example City","state":"NY","postalCode":"00101","country":"US","addressType":"primary"}],"phoneNumbers":[{"type":"primary","number":"(999)999-9999"}],"type":"business","emailAddress":"test@sageworks.com","industryCode":"99999","isDeleted":false,"uniqueIdentifier":"785654","taxId":"111111111","branch":null,"department":null,"website":null,"description":null,"restricted":false,"checkingBalance":15000.0,"savingsBalance":100000.0,"cDsBalance":50000.0,"averageChecking":14500.0,"averageSavings":125000.0,"averageCDs":60000.0,"citizenshipStatus":null,"maritalStatus":null,"isActiveMiltaryDuty":null,"isDependentOfActiveMiltaryDuty":null,"civDescription":null,"employer":null,"numberOfYearsEmployed":0.0,"ofacDesignation":null,"dateOfBirth":null,"idDescription":null,"idNumber":null,"idIssueDate":null,"idExpirationDate":null,"idIssuingAuthority":null,"idState":null,"comments":null,"msa":16980,"stateCode":12,"countyCode":"123","tractCode":"3453","longitude":-87.656376,"latitude":41.94763,"medianHouseholdIncome":107250.0,"metropolitanDivision":"Chicago-Naperville-Evanston, IL","metropolitanDivisionCode":"1234242","loanOfficer":null,"loanOfficerId":438331,"loanAdministrator":null,"equifaxCreditScore":null,"equifaxCreditScoreDate":null,"experianCreditScore":null,"experianCreditScoreDate":null,"transunionCreditScore":null,"transunionCreditScoreDate":null,"ficoSbssCreditScore":450,"ficoSbssCreditScoreDate":"2019-06-09","bankruptcies":null,"dateOfLastBankruptcy":null,"historical30DayDelinquencies":null,"historical60DayDelinquencies":null,"historical90DayDelinquencies":null,"historicalOtherDelinquencies":null,"currentMortgagePastDue":null,"currentInstallmentPastDue":null,"currentAutoPastDue":null,"currentEducationPastDue":null,"currentOpenPastDue":null,"currentRevolvingPastDue":null,"currentOtherPastDue":null,"currentTotalPastDue":null,"entryMethod":"operatingCompany","professionalLLC":true,"yearFounded":1999,"businessRegistered":"NY","farmRegistered":null,"stateOfFormation":"NY","franchiseName":"Franchise #1","franchiseLegalName":"#1 Franchise","franchiseStartDate":1999,"sbaCode":"123","cityHQ":"Chicago","stateHQ":"IL","franchiseDataImportDate":"2019-09-06","franchiseDataFinancialPeriod":2019,"historicalSuccessRate":130,"systemSupportAndExpenseCommitment":75,"resaleActivityLevel":25,"mngmtExperienceStability":35,"averageUnitRevenueGrowth":60,"prospectScreening":30,"unitEconomics":70,"franchiseAgreementAssessment":15,"franchiseeRelationship":30,"projectedUnitSuccess":200,"recurringRevenueSelfSufficiency":50,"totalFundScore":750,"finStatementStrength":25,"franchisedUnits":100,"minInitial":258625,"maxInitial":1609500,"avgInitial":602350,"companyOwnedUnits":53,"projectedOpenings":12,"compoundAnnualUnitGrowthRate":91.0,"compoundedUnitSuccessRate":0.96,"experianDBT":5,"equifaxDBT":null,"dbdbt":null,"dbPaydex":null,"ansoniaCreditRating":"3071K-8","ansoniaRiskScore":95,"creditLogicScore":58,"dbViabilityRating":"","lastReportRun":"2019-10-06","bankruptciesCount":0,"collectionsCount":0,"judgmentsCount":0,"chargeOffsCount":0,"liensCount":0,"nsfChecksCount":0,"dataDepthScore":0,"underFormation":null,"dateBusinessEstablished":null,"loanBoardingIdentifier":"12345","crmIdentifier":"66754","isMailingAddressDifferent":false,"licenseNumber":null} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "ReadCustomers" ] } ] } }, "/v1/customers/crm-identifier/{crmIdentifier}": { "get": { "tags": [ "Customers" ], "summary": "Gets a customer by crm identifier", "operationId": "GetByCrmIdentifier", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "crmIdentifier", "description": "crm identifier of the customer to get", "required": true, "type": "string" } ], "responses": { "200": { "description": "Gets the customer with the specified crm identifier", "schema": { "$ref": "#/definitions/Customer" }, "examples": { "application/json": {"id":4513215,"name":"Example, LLC","dba":"Example Doing Business As","firstName":null,"middleInitial":null,"lastName":null,"nameSuffix":null,"userDefinedFields":{"User Defined Field 1":"Value 1","User Defined Field 2":"Value 2"},"creditScore":98,"secondaryCreditScore":99,"businessType":"llc","dnbScore":"567","namePrefix":null,"jobTitle":null,"addresses":[{"line1":"123 Main St","line2":"Apt 4B","city":"Example City","state":"NY","postalCode":"00101","country":"US","addressType":"primary"}],"phoneNumbers":[{"type":"primary","number":"(999)999-9999"}],"type":"business","emailAddress":"test@sageworks.com","industryCode":"99999","isDeleted":false,"uniqueIdentifier":"785654","taxId":"111111111","branch":null,"department":null,"website":null,"description":null,"restricted":false,"checkingBalance":15000.0,"savingsBalance":100000.0,"cDsBalance":50000.0,"averageChecking":14500.0,"averageSavings":125000.0,"averageCDs":60000.0,"citizenshipStatus":null,"maritalStatus":null,"isActiveMiltaryDuty":null,"isDependentOfActiveMiltaryDuty":null,"civDescription":null,"employer":null,"numberOfYearsEmployed":0.0,"ofacDesignation":null,"dateOfBirth":null,"idDescription":null,"idNumber":null,"idIssueDate":null,"idExpirationDate":null,"idIssuingAuthority":null,"idState":null,"comments":null,"msa":16980,"stateCode":12,"countyCode":"123","tractCode":"3453","longitude":-87.656376,"latitude":41.94763,"medianHouseholdIncome":107250.0,"metropolitanDivision":"Chicago-Naperville-Evanston, IL","metropolitanDivisionCode":"1234242","loanOfficer":null,"loanOfficerId":438331,"loanAdministrator":null,"equifaxCreditScore":null,"equifaxCreditScoreDate":null,"experianCreditScore":null,"experianCreditScoreDate":null,"transunionCreditScore":null,"transunionCreditScoreDate":null,"ficoSbssCreditScore":450,"ficoSbssCreditScoreDate":"2019-06-09","bankruptcies":null,"dateOfLastBankruptcy":null,"historical30DayDelinquencies":null,"historical60DayDelinquencies":null,"historical90DayDelinquencies":null,"historicalOtherDelinquencies":null,"currentMortgagePastDue":null,"currentInstallmentPastDue":null,"currentAutoPastDue":null,"currentEducationPastDue":null,"currentOpenPastDue":null,"currentRevolvingPastDue":null,"currentOtherPastDue":null,"currentTotalPastDue":null,"entryMethod":"operatingCompany","professionalLLC":true,"yearFounded":1999,"businessRegistered":"NY","farmRegistered":null,"stateOfFormation":"NY","franchiseName":"Franchise #1","franchiseLegalName":"#1 Franchise","franchiseStartDate":1999,"sbaCode":"123","cityHQ":"Chicago","stateHQ":"IL","franchiseDataImportDate":"2019-09-06","franchiseDataFinancialPeriod":2019,"historicalSuccessRate":130,"systemSupportAndExpenseCommitment":75,"resaleActivityLevel":25,"mngmtExperienceStability":35,"averageUnitRevenueGrowth":60,"prospectScreening":30,"unitEconomics":70,"franchiseAgreementAssessment":15,"franchiseeRelationship":30,"projectedUnitSuccess":200,"recurringRevenueSelfSufficiency":50,"totalFundScore":750,"finStatementStrength":25,"franchisedUnits":100,"minInitial":258625,"maxInitial":1609500,"avgInitial":602350,"companyOwnedUnits":53,"projectedOpenings":12,"compoundAnnualUnitGrowthRate":91.0,"compoundedUnitSuccessRate":0.96,"experianDBT":5,"equifaxDBT":null,"dbdbt":null,"dbPaydex":null,"ansoniaCreditRating":"3071K-8","ansoniaRiskScore":95,"creditLogicScore":58,"dbViabilityRating":"","lastReportRun":"2019-10-06","bankruptciesCount":0,"collectionsCount":0,"judgmentsCount":0,"chargeOffsCount":0,"liensCount":0,"nsfChecksCount":0,"dataDepthScore":0,"underFormation":null,"dateBusinessEstablished":null,"loanBoardingIdentifier":"12345","crmIdentifier":"66754","isMailingAddressDifferent":false,"licenseNumber":null} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "ReadCustomers" ] } ] } }, "/v1/customers/properties": { "get": { "tags": [ "Customers" ], "summary": "Gets all user defined fields", "operationId": "GetPagedProperties", "parameters": [ { "in": "query", "name": "customerType", "type": "string", "format": "string", "enum": [ "business", "person", "farm", "nonProfit" ] }, { "in": "query", "name": "page", "description": "The page number of results to retrieve (first page = 1, default = 1)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "perPage", "description": "The number of records to return on each page (minimum = 1, maximum = 1000, default = 200)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "name", "description": "The name of the data field", "type": "string" }, { "in": "query", "name": "dataFieldTypes", "description": "List of allowed DataFieldTypes", "type": "array", "items": { "format": "string", "description": "The type of value that the data field stores", "enum": [ "currency", "numeric", "percent", "unknown", "text", "boolean", "date", "phoneNumber", "industryCode", "socialSecurityNumber", "textArea", "dataObject" ], "type": "string" }, "collectionFormat": "multi" }, { "in": "query", "name": "isUserDefined", "description": "Specifies whether the data field is user defined", "type": "boolean" }, { "in": "query", "name": "templateDataFieldID", "description": "The ID of the template that this data field was created from", "type": "integer", "format": "int32" }, { "in": "query", "name": "aliases", "description": "List of allowed Aliases", "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" } ], "responses": { "200": { "description": "Gets all of the user defined fields in the account" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "OnlinePortalAnalystApiAcess", null ] } ] } }, "/v1/customers/properties/{id}": { "get": { "tags": [ "Customers" ], "summary": "Gets a user defined field by id", "operationId": "GetPropertyById", "parameters": [ { "in": "path", "name": "id", "description": "id of the user defined field to get", "required": true, "type": "integer", "format": "int32" } ], "responses": { "404": { "description": "Not Found" }, "200": { "description": "Gets the user defined field with the specified id" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "OnlinePortalAnalystApiAcess", null ] } ] } }, "/v1/customers/properties/add": { "post": { "tags": [ "Customers" ], "summary": "Creates a new user defined field", "operationId": "CreateUserDefinedField", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "", "schema": { "$ref": "#/definitions/UserDefinedDataFieldPostRequest" } } ], "responses": { "201": { "description": "Created", "schema": { "$ref": "#/definitions/UserDefinedDataFieldPostRequest" }, "examples": { "application/json": {"id":12345,"name":"Test","dataFieldInputFormat":"text","dataFieldFormatString":"textLength200","options":null} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "OnlinePortalAnalystApiAcess", null ] } ] } }, "/v1/customers/properties/update": { "patch": { "tags": [ "Customers" ], "summary": "Updates a user defined field", "operationId": "UpdateUserDefinedField", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "", "schema": { "$ref": "#/definitions/UserDefinedDataFieldPatchRequest" } } ], "responses": { "201": { "description": "Created", "schema": { "$ref": "#/definitions/UserDefinedDataFieldPatchRequest" }, "examples": { "application/json": {"id":12345,"name":"Test","dataFieldInputFormat":"text","dataFieldFormatString":"textLength200","options":null} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "OnlinePortalAnalystApiAcess", null ] } ] } }, "/v1/portfolio-loans": { "get": { "tags": [ "Portfolio Loans" ], "summary": "Gets all portfolio loans", "operationId": "GetPaged", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "page", "description": "The page number of results to retrieve (first page = 1, default = 1)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "perPage", "description": "The number of records to return on each page (minimum = 1, maximum = 1000, default = 200)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "customerId", "description": "CustomerId value to filter by", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "loanNumber", "description": "Loan Number to filter by", "type": "string" }, { "in": "query", "name": "loanAmountStart", "description": "The start of the loan amount to be used when doing a loan amount range query. This amount is inclusive.", "type": "number", "format": "double", "x-nullable": true }, { "in": "query", "name": "loanAmountEnd", "description": "The end of the loan amount to be used when doing a loan amount range query. This amount is inclusive.", "type": "number", "format": "double", "x-nullable": true }, { "in": "query", "name": "paymentType", "description": "Payment Type for the loan", "type": "string", "enum": [ "fixedPayment", "fixedPrincipal", "lineOfCredit", "revolvingLineOfCredit", "interestOnly", "fixedPaymentBalloon", "fixedPrincipalBalloon", "singlePaymentBalloon", "principalOnly", "other", "noPayment" ], "x-nullable": true }, { "in": "query", "name": "loanTermStart", "description": "The start of the loan term to be used when doing a loan term range query (# of periods determined by payment frequency).", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "loanTermEnd", "description": "The end of the loan term to be used when doing a loan term range query (# of periods determined by payment frequency).", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "indexRateDescription", "description": "Index Rate Description for the proposed loan", "type": "string" }, { "in": "query", "name": "excludeLoansForDeletedCustomers", "description": "Set to true to ensure the proposed loans returned are not linked to deleted primary borrowers", "type": "boolean", "default": false }, { "in": "query", "name": "includeUserDefinedFields", "description": "Include User Defined fields in the response", "type": "boolean", "default": false, "x-nullable": true } ], "responses": { "200": { "description": "Gets all current, existing, and active portfolio loans in the account", "schema": { "$ref": "#/definitions/CollectionResponse[PortfolioLoan]" }, "examples": { "application/json": [{"id":1299967899,"loanNumber":"100041235","name":"Loan Name","customerId":1201567899,"currentBalance":573000.32,"unamortizedPremium":1312.0,"bookBalance":573000.32,"riskRating":4,"paymentAmount":5523.0,"paymentFrequency":"monthly","paymentType":"fixedPayment","loanOfficerId":123456789,"interestRate":0.097,"floorRate":0.03,"ceilingRate":0.25,"indexRateDescription":"FHLBChicago","spread":0.02,"indexRate":0.02,"callCode":"1a","collateralCode":"Office Building","loanTypeCode":"Real Estate - Owner Occupied","productCode":"Real Estate","purposeCode":"110","industryCode":"110210","nonAccrual":false,"nonAccrualDate":null,"troubledDebtRestructure":false,"troubledDebtRestructureDate":null,"defaultStartDate":"2017-04-18","adjustableInterestRate":true,"timesPastDue3060":1,"timesPastDue6090":0,"timesPastDue90Plus":1,"daysCurrentlyPastDue":16,"chargedOffAmount":418.92,"amountPastDue":615.91,"prepaymentPenalty":false,"remainingTermInMonths":60,"dayCountConvention":"c_30_360","amortizedOver":null,"currentAvailableCredit":0.0,"maturityDate":"2030-12-15","netDeferredFeesOrCosts":1200.0,"totalFees":500.0,"expectedUtilizationRate":0.25,"upfrontFee":100.0,"annualFee":100.0,"unusedCommitmentFee":100.0,"originationExpenses":300.0,"overheadExpenses":200.0,"servicingExpenses":200.0,"accruedInterest":274.23,"originalLoanAmount":1250000.0,"originationDate":"2007-01-31","originalTermInMonths":60,"renewalDate":"2017-12-15","repricingDate":null,"governmentGuaranteed":false,"governmentGuaranteedPercent":null,"governmentGuaranteedBalance":null,"watchList":false,"points":0.0,"refinance":false,"latestPaymentDate":"2026-06-16","loanToValueRatio":0.754,"isDeleted":false,"isGuidanceLineOfCredit":null,"bankCodeBranch":null,"accountType":null,"parentLoansId":null,"withheldAmount":null,"institutionAvailableCredit":null,"institutionWithheld":null,"userDefinedString1":"Commercial","userDefinedString2":"Fixed Rate","userDefinedString3":"","userDefinedString4":"","userDefinedString5":"","userDefinedString6":"","userDefinedString7":"Another User Defined Value","userDefinedString8":"","userDefinedString9":"","userDefinedString10":"","userDefinedString11":"","userDefinedString12":"","userDefinedString13":"","userDefinedString14":"","userDefinedString15":"","userDefinedString16":"","userDefinedString17":"","userDefinedString18":"","userDefinedString19":"","userDefinedString20":"","userDefinedNumber1":13.77,"userDefinedNumber2":1044.0,"userDefinedNumber3":0.0045,"userDefinedNumber4":7.0,"userDefinedNumber5":7.0,"userDefinedNumber6":7.0,"userDefinedNumber7":7.0,"userDefinedNumber8":7.0,"userDefinedNumber9":7.0,"userDefinedNumber10":7.0,"userDefinedNumber11":7.0,"userDefinedNumber12":7.0,"userDefinedNumber13":7.0,"userDefinedNumber14":7.0,"userDefinedNumber15":7.0,"userDefinedNumber16":7.0,"userDefinedNumber17":7.0,"userDefinedNumber18":7.0,"userDefinedNumber19":7.0,"userDefinedNumber20":7.0,"userDefinedDate1":"2026-07-16","userDefinedDate2":"2026-07-15","userDefinedDate3":null,"userDefinedDate4":null,"userDefinedDate5":null,"userDefinedDate6":null,"userDefinedDate7":null,"userDefinedDate8":null,"userDefinedDate9":null,"userDefinedDate10":null,"userDefinedFields":null,"riskRatingId":null,"comments":null,"lossGivenDefaultRiskRating":null,"probabilityOfDefaultRiskRating":null},{"id":1299964568,"loanNumber":"708041235","name":"Loan Name","customerId":1201577899,"currentBalance":1570023.47,"unamortizedPremium":2110.0,"bookBalance":1570023.47,"riskRating":4,"paymentAmount":15649.0,"paymentFrequency":"annual","paymentType":"singlePaymentBalloon","loanOfficerId":123456789,"interestRate":0.119,"floorRate":0.03,"ceilingRate":0.25,"indexRateDescription":"FHLBBoston","spread":0.02,"indexRate":0.02,"callCode":"1e1","collateralCode":"Office Building","loanTypeCode":"Real Estate - Owner Occupied","productCode":"Real Estate","purposeCode":"220","industryCode":"100200","nonAccrual":false,"nonAccrualDate":null,"troubledDebtRestructure":true,"troubledDebtRestructureDate":null,"defaultStartDate":"2017-04-18","adjustableInterestRate":true,"timesPastDue3060":1,"timesPastDue6090":0,"timesPastDue90Plus":1,"daysCurrentlyPastDue":8,"chargedOffAmount":418.92,"amountPastDue":615.91,"prepaymentPenalty":false,"remainingTermInMonths":19,"dayCountConvention":"c_30_365","amortizedOver":null,"currentAvailableCredit":100000.0,"maturityDate":"2038-02-01","netDeferredFeesOrCosts":1200.0,"totalFees":500.0,"expectedUtilizationRate":0.25,"upfrontFee":100.0,"annualFee":100.0,"unusedCommitmentFee":100.0,"originationExpenses":200.0,"overheadExpenses":200.0,"servicingExpenses":200.0,"accruedInterest":274.23,"originalLoanAmount":1950000.0,"originationDate":"2002-05-31","originalTermInMonths":60,"renewalDate":"2015-07-12","repricingDate":null,"governmentGuaranteed":false,"governmentGuaranteedPercent":null,"governmentGuaranteedBalance":null,"watchList":false,"points":0.0,"refinance":false,"latestPaymentDate":"2026-02-16","loanToValueRatio":0.754,"isDeleted":false,"isGuidanceLineOfCredit":null,"bankCodeBranch":null,"accountType":null,"parentLoansId":null,"withheldAmount":null,"institutionAvailableCredit":null,"institutionWithheld":null,"userDefinedString1":"Commercial","userDefinedString2":"Fixed Rate","userDefinedString3":"","userDefinedString4":"","userDefinedString5":"","userDefinedString6":"","userDefinedString7":"Another User Defined Value","userDefinedString8":"","userDefinedString9":"","userDefinedString10":"","userDefinedString11":"","userDefinedString12":"","userDefinedString13":"","userDefinedString14":"","userDefinedString15":"","userDefinedString16":"","userDefinedString17":"","userDefinedString18":"","userDefinedString19":"","userDefinedString20":"","userDefinedNumber1":13.77,"userDefinedNumber2":1044.0,"userDefinedNumber3":0.0045,"userDefinedNumber4":7.0,"userDefinedNumber5":7.0,"userDefinedNumber6":7.0,"userDefinedNumber7":7.0,"userDefinedNumber8":7.0,"userDefinedNumber9":7.0,"userDefinedNumber10":7.0,"userDefinedNumber11":7.0,"userDefinedNumber12":7.0,"userDefinedNumber13":7.0,"userDefinedNumber14":7.0,"userDefinedNumber15":7.0,"userDefinedNumber16":7.0,"userDefinedNumber17":7.0,"userDefinedNumber18":7.0,"userDefinedNumber19":7.0,"userDefinedNumber20":7.0,"userDefinedDate1":"2026-07-16","userDefinedDate2":"2026-07-15","userDefinedDate3":null,"userDefinedDate4":null,"userDefinedDate5":null,"userDefinedDate6":null,"userDefinedDate7":null,"userDefinedDate8":null,"userDefinedDate9":null,"userDefinedDate10":null,"userDefinedFields":null,"riskRatingId":null,"comments":null,"lossGivenDefaultRiskRating":null,"probabilityOfDefaultRiskRating":null}] } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "ReadPortfolioLoans" ] } ] }, "post": { "tags": [ "Portfolio Loans" ], "summary": "Creates a portfolio loan", "operationId": "Create", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "The portfolio loan to create", "schema": { "$ref": "#/definitions/PortfolioLoan" } } ], "responses": { "201": { "description": "The portfolio loan has been created successfully. The portfolio loan\r\n that was created is returned and has the Sageworks id that was assigned.", "schema": { "$ref": "#/definitions/PortfolioLoan" }, "examples": { "application/json": {"id":1299967899,"loanNumber":"100041235","name":"Loan Name","customerId":1201567899,"currentBalance":573000.32,"unamortizedPremium":1312.0,"bookBalance":573000.32,"riskRating":4,"paymentAmount":5523.0,"paymentFrequency":"monthly","paymentType":"fixedPayment","loanOfficerId":123456789,"interestRate":0.097,"floorRate":0.03,"ceilingRate":0.25,"indexRateDescription":"FHLBDallas","spread":0.02,"indexRate":0.02,"callCode":"1a","collateralCode":"Office Building","loanTypeCode":"Real Estate - Owner Occupied","productCode":"Real Estate","purposeCode":"110","industryCode":"110210","nonAccrual":false,"nonAccrualDate":null,"troubledDebtRestructure":false,"troubledDebtRestructureDate":null,"defaultStartDate":"2017-04-18","adjustableInterestRate":true,"timesPastDue3060":1,"timesPastDue6090":0,"timesPastDue90Plus":1,"daysCurrentlyPastDue":8,"chargedOffAmount":418.92,"amountPastDue":615.91,"prepaymentPenalty":false,"remainingTermInMonths":60,"dayCountConvention":"c_30_360","amortizedOver":null,"currentAvailableCredit":0.0,"maturityDate":"2030-12-15","netDeferredFeesOrCosts":1200.0,"totalFees":500.0,"expectedUtilizationRate":0.25,"upfrontFee":100.0,"annualFee":100.0,"unusedCommitmentFee":100.0,"originationExpenses":200.0,"overheadExpenses":200.0,"servicingExpenses":200.0,"accruedInterest":274.23,"originalLoanAmount":1250000.0,"originationDate":"2007-01-31","originalTermInMonths":60,"renewalDate":"2017-12-15","repricingDate":null,"governmentGuaranteed":false,"governmentGuaranteedPercent":null,"governmentGuaranteedBalance":null,"watchList":false,"points":0.0,"refinance":false,"latestPaymentDate":"2026-06-16","loanToValueRatio":0.754,"isDeleted":false,"isGuidanceLineOfCredit":true,"bankCodeBranch":null,"accountType":null,"parentLoansId":null,"withheldAmount":0.0,"institutionAvailableCredit":0.0,"institutionWithheld":0.0,"userDefinedString1":"Commercial","userDefinedString2":"Fixed Rate","userDefinedString3":"","userDefinedString4":"","userDefinedString5":"","userDefinedString6":"","userDefinedString7":"Another User Defined Value","userDefinedString8":"","userDefinedString9":"","userDefinedString10":"","userDefinedString11":"","userDefinedString12":"","userDefinedString13":"","userDefinedString14":"","userDefinedString15":"","userDefinedString16":"","userDefinedString17":"","userDefinedString18":"","userDefinedString19":"","userDefinedString20":"","userDefinedNumber1":13.77,"userDefinedNumber2":1044.0,"userDefinedNumber3":0.0045,"userDefinedNumber4":7.0,"userDefinedNumber5":7.0,"userDefinedNumber6":7.0,"userDefinedNumber7":7.0,"userDefinedNumber8":7.0,"userDefinedNumber9":7.0,"userDefinedNumber10":7.0,"userDefinedNumber11":7.0,"userDefinedNumber12":7.0,"userDefinedNumber13":7.0,"userDefinedNumber14":7.0,"userDefinedNumber15":7.0,"userDefinedNumber16":7.0,"userDefinedNumber17":7.0,"userDefinedNumber18":7.0,"userDefinedNumber19":7.0,"userDefinedNumber20":7.0,"userDefinedDate1":"2026-07-16","userDefinedDate2":"2026-07-15","userDefinedDate3":null,"userDefinedDate4":null,"userDefinedDate5":null,"userDefinedDate6":null,"userDefinedDate7":null,"userDefinedDate8":null,"userDefinedDate9":null,"userDefinedDate10":null,"userDefinedFields":null,"riskRatingId":null,"comments":"Comments","lossGivenDefaultRiskRating":"PASS","probabilityOfDefaultRiskRating":1.0} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "CreatePortfolioLoans" ] } ] } }, "/v1/portfolio-loans/basic-information": { "get": { "tags": [ "Portfolio Loans" ], "summary": "Gets all portfolio loans basic information", "operationId": "GetPagedBasicInformation", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "page", "description": "The page number of results to retrieve (first page = 1, default = 1)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "perPage", "description": "The number of records to return on each page (minimum = 1, maximum = 1000, default = 200)", "type": "integer", "format": "int32", "x-nullable": true } ], "responses": { "200": { "description": "Gets basic information for all current, existing, and active portfolio loans in the account", "schema": { "$ref": "#/definitions/CollectionResponse[PortfolioLoanBasicInformation]" }, "examples": { "application/json": [{"id":1299967899,"customerId":1201567899,"loanNumber":"100041235","currentBalance":573000.32},{"id":1299964568,"customerId":1201567899,"loanNumber":"708041235","currentBalance":1570023.47}] } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "ReadPortfolioLoans" ] } ] } }, "/v1/portfolio-loans/summary-information": { "get": { "tags": [ "Portfolio Loans" ], "summary": "Gets all portfolio loans summary information.", "operationId": "GetPagedSummaryInformation", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "page", "description": "The page number of results to retrieve (first page = 1, default = 1)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "perPage", "description": "The number of records to return on each page (minimum = 1, maximum = 1000, default = 200)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "customerId", "description": "CustomerId value to filter by", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "loanNumber", "description": "Loan Number to filter by", "type": "string" } ], "responses": { "200": { "description": "Gets summary information for all current, existing, and active portfolio loans in the account", "schema": { "$ref": "#/definitions/PagedCollectionResponse[PortfolioLoanSummaryInformation]" }, "examples": { "application/json": [{"id":1299967899,"customerId":1201567899,"loanNumber":"100041235","currentBalance":573000.32,"borrowerName":"Person Borrower","currentAvailableCredit":12087094.0,"paymentType":"lineOfCredit","riskRating":5,"watchList":true,"bankCustomerProfitEntitiesID":444555666},{"id":1299964568,"customerId":1201567899,"loanNumber":"708041235","currentBalance":1570023.47,"borrowerName":"Company Borrower","currentAvailableCredit":19975016.0,"paymentType":"fixedPayment","riskRating":1,"watchList":false,"bankCustomerProfitEntitiesID":444555666}] } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "ReadPortfolioLoans" ] } ] } }, "/v1/portfolio-loans/past-due-loans": { "get": { "tags": [ "Portfolio Loans" ], "summary": "Gets all past due portfolio loans basic information", "operationId": "GetPastDueLoans", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "page", "description": "The page number of results to retrieve (first page = 1, default = 1)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "perPage", "description": "The number of records to return on each page (minimum = 1, maximum = 1000, default = 200)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "requireUserIsLoanOfficer", "description": "True if we should filter only to loans where the current user is loan officer", "type": "boolean" } ], "responses": { "200": { "description": "Gets basic information for all existing portfolio loans that are past due", "schema": { "$ref": "#/definitions/PagedCollectionResponse[LosLiteLoanSummaryInformation]" }, "examples": { "application/json": [{"id":1299967899,"loanNumber":"100041235","customerId":1201567899,"borrowerName":"Person Borrower","productCode":"Product 1","loanOfficer":"Loan Officer 1","daysCurrentlyPastDue":5,"paymentAmount":500.00,"paymentFrequency":"monthly","currentBalance":573000.32,"originalBalance":1000000.0,"maturityDate":"01/01/2023"},{"id":1299964568,"loanNumber":"708041235","customerId":1201567899,"borrowerName":"Company Borrower","productCode":"Product 1","loanOfficer":"Loan Officer 1","daysCurrentlyPastDue":5,"paymentAmount":500.00,"paymentFrequency":"monthly","currentBalance":573000.32,"originalBalance":1000000.0,"maturityDate":"01/01/2023"}] } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "ReadPortfolioLoans" ] } ] } }, "/v1/portfolio-loans/maturing-loans": { "get": { "tags": [ "Portfolio Loans" ], "summary": "Gets all maturing portfolio loans basic information", "operationId": "GetMaturingLoans", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "page", "description": "The page number of results to retrieve (first page = 1, default = 1)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "perPage", "description": "The number of records to return on each page (minimum = 1, maximum = 1000, default = 200)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "maturingWithinDays", "description": "How many days to check for maturing loans", "type": "integer", "format": "int32" }, { "in": "query", "name": "requireUserIsLoanOfficer", "description": "True if we should filter only to loans where the current user is loan officer", "type": "boolean" } ], "responses": { "200": { "description": "Gets basic information for all existing portfolio loans that are maturing within 30 days", "schema": { "$ref": "#/definitions/PagedCollectionResponse[LosLiteLoanSummaryInformation]" }, "examples": { "application/json": [{"id":1299967899,"loanNumber":"100041235","customerId":1201567899,"borrowerName":"Person Borrower","productCode":"Product 1","loanOfficer":"Loan Officer 1","daysCurrentlyPastDue":5,"paymentAmount":500.00,"paymentFrequency":"monthly","currentBalance":573000.32,"originalBalance":1000000.0,"maturityDate":"01/01/2023"},{"id":1299964568,"loanNumber":"708041235","customerId":1201567899,"borrowerName":"Company Borrower","productCode":"Product 1","loanOfficer":"Loan Officer 1","daysCurrentlyPastDue":5,"paymentAmount":500.00,"paymentFrequency":"monthly","currentBalance":573000.32,"originalBalance":1000000.0,"maturityDate":"01/01/2023"}] } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "ReadPortfolioLoans" ] } ] } }, "/v1/portfolio-loans/{id}": { "get": { "tags": [ "Portfolio Loans" ], "summary": "Gets a portfolio loan by id", "operationId": "GetById", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "id of the portfolio loan to get", "required": true, "type": "integer", "format": "int32" }, { "in": "query", "name": "includeUserDefinedFields", "description": "Include User Defined fields in the response", "type": "boolean", "default": false, "x-nullable": true } ], "responses": { "200": { "description": "Gets the portfolio loan with the specified id", "schema": { "$ref": "#/definitions/PortfolioLoan" }, "examples": { "application/json": {"id":1299967899,"loanNumber":"100041235","name":"Loan Name","customerId":1201567899,"currentBalance":573000.32,"unamortizedPremium":1312.0,"bookBalance":573000.32,"riskRating":4,"paymentAmount":5523.0,"paymentFrequency":"monthly","paymentType":"fixedPayment","loanOfficerId":123456789,"interestRate":0.097,"floorRate":0.03,"ceilingRate":0.25,"indexRateDescription":"FHLBDallas","spread":0.02,"indexRate":0.02,"callCode":"1a","collateralCode":"Office Building","loanTypeCode":"Real Estate - Owner Occupied","productCode":"Real Estate","purposeCode":"110","industryCode":"110210","nonAccrual":false,"nonAccrualDate":null,"troubledDebtRestructure":false,"troubledDebtRestructureDate":null,"defaultStartDate":"2017-04-18","adjustableInterestRate":true,"timesPastDue3060":1,"timesPastDue6090":0,"timesPastDue90Plus":1,"daysCurrentlyPastDue":6,"chargedOffAmount":418.92,"amountPastDue":615.91,"prepaymentPenalty":false,"remainingTermInMonths":60,"dayCountConvention":"c_30_360","amortizedOver":null,"currentAvailableCredit":0.0,"maturityDate":"2030-12-15","netDeferredFeesOrCosts":1200.0,"totalFees":500.0,"expectedUtilizationRate":0.25,"upfrontFee":100.0,"annualFee":100.0,"unusedCommitmentFee":100.0,"originationExpenses":200.0,"overheadExpenses":200.0,"servicingExpenses":200.0,"accruedInterest":274.23,"originalLoanAmount":1250000.0,"originationDate":"2007-01-31","originalTermInMonths":60,"renewalDate":"2017-12-15","repricingDate":null,"governmentGuaranteed":false,"governmentGuaranteedPercent":null,"governmentGuaranteedBalance":null,"watchList":false,"points":0.0,"refinance":false,"latestPaymentDate":"2026-06-16","loanToValueRatio":0.754,"isDeleted":false,"isGuidanceLineOfCredit":true,"bankCodeBranch":null,"accountType":null,"parentLoansId":null,"withheldAmount":0.0,"institutionAvailableCredit":0.0,"institutionWithheld":0.0,"userDefinedString1":"Commercial","userDefinedString2":"Fixed Rate","userDefinedString3":"","userDefinedString4":"","userDefinedString5":"","userDefinedString6":"","userDefinedString7":"Another User Defined Value","userDefinedString8":"","userDefinedString9":"","userDefinedString10":"","userDefinedString11":"","userDefinedString12":"","userDefinedString13":"","userDefinedString14":"","userDefinedString15":"","userDefinedString16":"","userDefinedString17":"","userDefinedString18":"","userDefinedString19":"","userDefinedString20":"","userDefinedNumber1":13.77,"userDefinedNumber2":1044.0,"userDefinedNumber3":0.0045,"userDefinedNumber4":7.0,"userDefinedNumber5":7.0,"userDefinedNumber6":7.0,"userDefinedNumber7":7.0,"userDefinedNumber8":7.0,"userDefinedNumber9":7.0,"userDefinedNumber10":7.0,"userDefinedNumber11":7.0,"userDefinedNumber12":7.0,"userDefinedNumber13":7.0,"userDefinedNumber14":7.0,"userDefinedNumber15":7.0,"userDefinedNumber16":7.0,"userDefinedNumber17":7.0,"userDefinedNumber18":7.0,"userDefinedNumber19":7.0,"userDefinedNumber20":7.0,"userDefinedDate1":"2026-07-16","userDefinedDate2":"2026-07-15","userDefinedDate3":null,"userDefinedDate4":null,"userDefinedDate5":null,"userDefinedDate6":null,"userDefinedDate7":null,"userDefinedDate8":null,"userDefinedDate9":null,"userDefinedDate10":null,"userDefinedFields":null,"riskRatingId":null,"comments":"Comments","lossGivenDefaultRiskRating":"PASS","probabilityOfDefaultRiskRating":1.0} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "ReadPortfolioLoans" ] } ] }, "patch": { "tags": [ "Portfolio Loans" ], "summary": "Updates a loan", "operationId": "Update", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "id of the existing loan to update", "required": true, "type": "integer", "format": "int32" }, { "in": "body", "name": "body", "description": "The loan values to update", "schema": { "$ref": "#/definitions/PortfolioLoan" } } ], "responses": { "200": { "description": "Returns the modified loan", "schema": { "$ref": "#/definitions/PortfolioLoan" }, "examples": { "application/json": {"id":1299967899,"loanNumber":"100041235","name":"Loan Name","customerId":1201567899,"currentBalance":573000.32,"unamortizedPremium":1312.0,"bookBalance":573000.32,"riskRating":4,"paymentAmount":5523.0,"paymentFrequency":"monthly","paymentType":"fixedPayment","loanOfficerId":123456789,"interestRate":0.097,"floorRate":0.03,"ceilingRate":0.25,"indexRateDescription":"FHLBDallas","spread":0.02,"indexRate":0.02,"callCode":"1a","collateralCode":"Office Building","loanTypeCode":"Real Estate - Owner Occupied","productCode":"Real Estate","purposeCode":"110","industryCode":"110210","nonAccrual":false,"nonAccrualDate":null,"troubledDebtRestructure":false,"troubledDebtRestructureDate":null,"defaultStartDate":"2017-04-18","adjustableInterestRate":true,"timesPastDue3060":1,"timesPastDue6090":0,"timesPastDue90Plus":1,"daysCurrentlyPastDue":9,"chargedOffAmount":418.92,"amountPastDue":615.91,"prepaymentPenalty":false,"remainingTermInMonths":60,"dayCountConvention":"c_30_360","amortizedOver":null,"currentAvailableCredit":0.0,"maturityDate":"2030-12-15","netDeferredFeesOrCosts":1200.0,"totalFees":500.0,"expectedUtilizationRate":0.25,"upfrontFee":100.0,"annualFee":100.0,"unusedCommitmentFee":100.0,"originationExpenses":200.0,"overheadExpenses":200.0,"servicingExpenses":200.0,"accruedInterest":274.23,"originalLoanAmount":1250000.0,"originationDate":"2007-01-31","originalTermInMonths":60,"renewalDate":"2017-12-15","repricingDate":null,"governmentGuaranteed":false,"governmentGuaranteedPercent":null,"governmentGuaranteedBalance":null,"watchList":false,"points":0.0,"refinance":false,"latestPaymentDate":"2026-06-16","loanToValueRatio":0.754,"isDeleted":false,"isGuidanceLineOfCredit":true,"bankCodeBranch":null,"accountType":null,"parentLoansId":null,"withheldAmount":0.0,"institutionAvailableCredit":0.0,"institutionWithheld":0.0,"userDefinedString1":"Commercial","userDefinedString2":"Fixed Rate","userDefinedString3":"","userDefinedString4":"","userDefinedString5":"","userDefinedString6":"","userDefinedString7":"Another User Defined Value","userDefinedString8":"","userDefinedString9":"","userDefinedString10":"","userDefinedString11":"","userDefinedString12":"","userDefinedString13":"","userDefinedString14":"","userDefinedString15":"","userDefinedString16":"","userDefinedString17":"","userDefinedString18":"","userDefinedString19":"","userDefinedString20":"","userDefinedNumber1":13.77,"userDefinedNumber2":1044.0,"userDefinedNumber3":0.0045,"userDefinedNumber4":7.0,"userDefinedNumber5":7.0,"userDefinedNumber6":7.0,"userDefinedNumber7":7.0,"userDefinedNumber8":7.0,"userDefinedNumber9":7.0,"userDefinedNumber10":7.0,"userDefinedNumber11":7.0,"userDefinedNumber12":7.0,"userDefinedNumber13":7.0,"userDefinedNumber14":7.0,"userDefinedNumber15":7.0,"userDefinedNumber16":7.0,"userDefinedNumber17":7.0,"userDefinedNumber18":7.0,"userDefinedNumber19":7.0,"userDefinedNumber20":7.0,"userDefinedDate1":"2026-07-16","userDefinedDate2":"2026-07-15","userDefinedDate3":null,"userDefinedDate4":null,"userDefinedDate5":null,"userDefinedDate6":null,"userDefinedDate7":null,"userDefinedDate8":null,"userDefinedDate9":null,"userDefinedDate10":null,"userDefinedFields":null,"riskRatingId":null,"comments":"Comments","lossGivenDefaultRiskRating":"PASS","probabilityOfDefaultRiskRating":1.0} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "UpdatePortfolioLoans" ] } ] }, "delete": { "tags": [ "Portfolio Loans" ], "summary": "Deletes a portfolio loan by id", "operationId": "Delete", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "id of the existing portfolio loan to delete", "required": true, "type": "integer", "format": "int32" } ], "responses": { "204": { "description": "The portfolio loan has been deleted successfully." }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "DeletePortfolioLoans" ] } ] } }, "/v1/portfolio-loans/bulk": { "patch": { "tags": [ "Portfolio Loans" ], "summary": "Updates a collection of portfolio loans", "operationId": "UpdateMany", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "The collection of portfolio loans to update", "schema": { "$ref": "#/definitions/BulkUpdateRequest[PortfolioLoan]" } } ], "responses": { "200": { "description": "All portfolio loans were processed. Please check the errors property of the response object\r\n to determine if there were errors updating any individual portfolio loan", "schema": { "$ref": "#/definitions/BulkUpdateRequest[PortfolioLoan]" }, "examples": { "application/json": {"itemsUpdated":[{"id":1299967899,"loanNumber":"100041235","name":"Loan Name","customerId":1201567899,"currentBalance":573000.32,"unamortizedPremium":1312.0,"bookBalance":573000.32,"riskRating":4,"paymentAmount":5523.0,"paymentFrequency":"monthly","paymentType":"fixedPayment","loanOfficerId":123456789,"interestRate":0.097,"floorRate":0.03,"ceilingRate":0.25,"indexRateDescription":"FHLBChicago","spread":0.02,"indexRate":0.02,"callCode":"1a","collateralCode":"Office Building","loanTypeCode":"Real Estate - Owner Occupied","productCode":"Real Estate","purposeCode":"110","industryCode":"110210","nonAccrual":false,"nonAccrualDate":null,"troubledDebtRestructure":false,"troubledDebtRestructureDate":null,"defaultStartDate":"2017-04-18","adjustableInterestRate":true,"timesPastDue3060":1,"timesPastDue6090":0,"timesPastDue90Plus":1,"daysCurrentlyPastDue":13,"chargedOffAmount":418.92,"amountPastDue":615.91,"prepaymentPenalty":false,"remainingTermInMonths":60,"dayCountConvention":"c_30_360","amortizedOver":null,"currentAvailableCredit":0.0,"maturityDate":"2030-12-15","netDeferredFeesOrCosts":1200.0,"totalFees":500.0,"expectedUtilizationRate":0.25,"upfrontFee":100.0,"annualFee":100.0,"unusedCommitmentFee":100.0,"originationExpenses":300.0,"overheadExpenses":200.0,"servicingExpenses":200.0,"accruedInterest":274.23,"originalLoanAmount":1250000.0,"originationDate":"2007-01-31","originalTermInMonths":60,"renewalDate":"2017-12-15","repricingDate":null,"governmentGuaranteed":false,"governmentGuaranteedPercent":null,"governmentGuaranteedBalance":null,"watchList":false,"points":0.0,"refinance":false,"latestPaymentDate":"2026-06-16","loanToValueRatio":0.754,"isDeleted":false,"isGuidanceLineOfCredit":true,"bankCodeBranch":null,"accountType":null,"parentLoansId":null,"withheldAmount":0.0,"institutionAvailableCredit":0.0,"institutionWithheld":0.0,"userDefinedString1":"Commercial","userDefinedString2":"Fixed Rate","userDefinedString3":"","userDefinedString4":"","userDefinedString5":"","userDefinedString6":"","userDefinedString7":"Another User Defined Value","userDefinedString8":"","userDefinedString9":"","userDefinedString10":"","userDefinedString11":"","userDefinedString12":"","userDefinedString13":"","userDefinedString14":"","userDefinedString15":"","userDefinedString16":"","userDefinedString17":"","userDefinedString18":"","userDefinedString19":"","userDefinedString20":"","userDefinedNumber1":13.77,"userDefinedNumber2":1044.0,"userDefinedNumber3":0.0045,"userDefinedNumber4":7.0,"userDefinedNumber5":7.0,"userDefinedNumber6":7.0,"userDefinedNumber7":7.0,"userDefinedNumber8":7.0,"userDefinedNumber9":7.0,"userDefinedNumber10":7.0,"userDefinedNumber11":7.0,"userDefinedNumber12":7.0,"userDefinedNumber13":7.0,"userDefinedNumber14":7.0,"userDefinedNumber15":7.0,"userDefinedNumber16":7.0,"userDefinedNumber17":7.0,"userDefinedNumber18":7.0,"userDefinedNumber19":7.0,"userDefinedNumber20":7.0,"userDefinedDate1":"2026-07-16","userDefinedDate2":"2026-07-15","userDefinedDate3":null,"userDefinedDate4":null,"userDefinedDate5":null,"userDefinedDate6":null,"userDefinedDate7":null,"userDefinedDate8":null,"userDefinedDate9":null,"userDefinedDate10":null,"userDefinedFields":null,"riskRatingId":null,"comments":"Comments","lossGivenDefaultRiskRating":"PASS","probabilityOfDefaultRiskRating":1.0},{"id":127764568,"loanNumber":"707041235","name":"Loan Name","customerId":1201577899,"currentBalance":1570023.47,"unamortizedPremium":2110.0,"bookBalance":1570023.47,"riskRating":4,"paymentAmount":15649.0,"paymentFrequency":"annual","paymentType":"singlePaymentBalloon","loanOfficerId":123456789,"interestRate":0.119,"floorRate":0.03,"ceilingRate":0.25,"indexRateDescription":"FHLBBoston","spread":0.02,"indexRate":0.02,"callCode":"1e1","collateralCode":"Office Building","loanTypeCode":"Real Estate - Owner Occupied","productCode":"Real Estate","purposeCode":"220","industryCode":"100200","nonAccrual":false,"nonAccrualDate":null,"troubledDebtRestructure":true,"troubledDebtRestructureDate":null,"defaultStartDate":"2017-04-18","adjustableInterestRate":true,"timesPastDue3060":1,"timesPastDue6090":0,"timesPastDue90Plus":1,"daysCurrentlyPastDue":16,"chargedOffAmount":418.92,"amountPastDue":615.91,"prepaymentPenalty":false,"remainingTermInMonths":19,"dayCountConvention":"c_30_365","amortizedOver":null,"currentAvailableCredit":100000.0,"maturityDate":"2038-02-01","netDeferredFeesOrCosts":1200.0,"totalFees":500.0,"expectedUtilizationRate":0.25,"upfrontFee":100.0,"annualFee":100.0,"unusedCommitmentFee":100.0,"originationExpenses":200.0,"overheadExpenses":200.0,"servicingExpenses":200.0,"accruedInterest":274.23,"originalLoanAmount":1950000.0,"originationDate":"2002-05-31","originalTermInMonths":60,"renewalDate":"2015-07-12","repricingDate":null,"governmentGuaranteed":false,"governmentGuaranteedPercent":null,"governmentGuaranteedBalance":null,"watchList":false,"points":0.0,"refinance":false,"latestPaymentDate":"2026-02-16","loanToValueRatio":0.754,"isDeleted":false,"isGuidanceLineOfCredit":false,"bankCodeBranch":null,"accountType":null,"parentLoansId":null,"withheldAmount":5000.0,"institutionAvailableCredit":0.0,"institutionWithheld":0.0,"userDefinedString1":"Commercial","userDefinedString2":"Fixed Rate","userDefinedString3":"","userDefinedString4":"","userDefinedString5":"","userDefinedString6":"","userDefinedString7":"Another User Defined Value","userDefinedString8":"","userDefinedString9":"","userDefinedString10":"","userDefinedString11":"","userDefinedString12":"","userDefinedString13":"","userDefinedString14":"","userDefinedString15":"","userDefinedString16":"","userDefinedString17":"","userDefinedString18":"","userDefinedString19":"","userDefinedString20":"","userDefinedNumber1":13.77,"userDefinedNumber2":1044.0,"userDefinedNumber3":0.0045,"userDefinedNumber4":7.0,"userDefinedNumber5":7.0,"userDefinedNumber6":7.0,"userDefinedNumber7":7.0,"userDefinedNumber8":7.0,"userDefinedNumber9":7.0,"userDefinedNumber10":7.0,"userDefinedNumber11":7.0,"userDefinedNumber12":7.0,"userDefinedNumber13":7.0,"userDefinedNumber14":7.0,"userDefinedNumber15":7.0,"userDefinedNumber16":7.0,"userDefinedNumber17":7.0,"userDefinedNumber18":7.0,"userDefinedNumber19":7.0,"userDefinedNumber20":7.0,"userDefinedDate1":"2026-07-16","userDefinedDate2":"2026-07-15","userDefinedDate3":null,"userDefinedDate4":null,"userDefinedDate5":null,"userDefinedDate6":null,"userDefinedDate7":null,"userDefinedDate8":null,"userDefinedDate9":null,"userDefinedDate10":null,"userDefinedFields":null,"riskRatingId":null,"comments":"Comments","lossGivenDefaultRiskRating":"PASS","probabilityOfDefaultRiskRating":1.0},null,{"id":1299967899,"loanNumber":"100041235","name":"Loan Name","customerId":1201567899,"currentBalance":573000.32,"unamortizedPremium":1312.0,"bookBalance":573000.32,"riskRating":4,"paymentAmount":5523.0,"paymentFrequency":"monthly","paymentType":"fixedPayment","loanOfficerId":123456789,"interestRate":0.097,"floorRate":0.03,"ceilingRate":0.25,"indexRateDescription":"FHLBChicago","spread":0.02,"indexRate":0.02,"callCode":"1a","collateralCode":"Office Building","loanTypeCode":"Real Estate - Owner Occupied","productCode":"Real Estate","purposeCode":"110","industryCode":"110210","nonAccrual":false,"nonAccrualDate":null,"troubledDebtRestructure":false,"troubledDebtRestructureDate":null,"defaultStartDate":"2017-04-18","adjustableInterestRate":true,"timesPastDue3060":1,"timesPastDue6090":0,"timesPastDue90Plus":1,"daysCurrentlyPastDue":0,"chargedOffAmount":418.92,"amountPastDue":615.91,"prepaymentPenalty":false,"remainingTermInMonths":60,"dayCountConvention":"c_30_360","amortizedOver":null,"currentAvailableCredit":0.0,"maturityDate":"2030-12-15","netDeferredFeesOrCosts":1200.0,"totalFees":500.0,"expectedUtilizationRate":0.25,"upfrontFee":100.0,"annualFee":100.0,"unusedCommitmentFee":100.0,"originationExpenses":300.0,"overheadExpenses":200.0,"servicingExpenses":200.0,"accruedInterest":274.23,"originalLoanAmount":1250000.0,"originationDate":"2007-01-31","originalTermInMonths":60,"renewalDate":"2017-12-15","repricingDate":null,"governmentGuaranteed":false,"governmentGuaranteedPercent":null,"governmentGuaranteedBalance":null,"watchList":false,"points":0.0,"refinance":false,"latestPaymentDate":"2026-06-16","loanToValueRatio":0.754,"isDeleted":false,"isGuidanceLineOfCredit":null,"bankCodeBranch":null,"accountType":null,"parentLoansId":null,"withheldAmount":null,"institutionAvailableCredit":null,"institutionWithheld":null,"userDefinedString1":"Commercial","userDefinedString2":"Fixed Rate","userDefinedString3":"","userDefinedString4":"","userDefinedString5":"","userDefinedString6":"","userDefinedString7":"Another User Defined Value","userDefinedString8":"","userDefinedString9":"","userDefinedString10":"","userDefinedString11":"","userDefinedString12":"","userDefinedString13":"","userDefinedString14":"","userDefinedString15":"","userDefinedString16":"","userDefinedString17":"","userDefinedString18":"","userDefinedString19":"","userDefinedString20":"","userDefinedNumber1":13.77,"userDefinedNumber2":1044.0,"userDefinedNumber3":0.0045,"userDefinedNumber4":7.0,"userDefinedNumber5":7.0,"userDefinedNumber6":7.0,"userDefinedNumber7":7.0,"userDefinedNumber8":7.0,"userDefinedNumber9":7.0,"userDefinedNumber10":7.0,"userDefinedNumber11":7.0,"userDefinedNumber12":7.0,"userDefinedNumber13":7.0,"userDefinedNumber14":7.0,"userDefinedNumber15":7.0,"userDefinedNumber16":7.0,"userDefinedNumber17":7.0,"userDefinedNumber18":7.0,"userDefinedNumber19":7.0,"userDefinedNumber20":7.0,"userDefinedDate1":"2026-07-16","userDefinedDate2":"2026-07-15","userDefinedDate3":null,"userDefinedDate4":null,"userDefinedDate5":null,"userDefinedDate6":null,"userDefinedDate7":null,"userDefinedDate8":null,"userDefinedDate9":null,"userDefinedDate10":null,"userDefinedFields":null,"riskRatingId":null,"comments":null,"lossGivenDefaultRiskRating":"PASS","probabilityOfDefaultRiskRating":1.0}],"errors":{"2":{"errorType":"invalidRequest","message":"Input model for request is invalid","modelErrors":[{"propertyName":"loanNumber","message":"A loan with loanNumber '1234' already exists"}]}}} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "UpdatePortfolioLoans" ] } ] }, "post": { "tags": [ "Portfolio Loans" ], "summary": "Creates a collection of portfolio loans", "operationId": "CreateMany", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "The collection of portfolio loans to create", "schema": { "$ref": "#/definitions/BulkCreateRequest[PortfolioLoan]" } } ], "responses": { "200": { "description": "All portfolio loans were processed. Please check the errors property of the response object\r\n to determine if there were errors creating any individual portfolio loan", "schema": { "$ref": "#/definitions/BulkCreateResponse[PortfolioLoan]" }, "examples": { "application/json": {"itemsCreated":[{"id":1299967899,"loanNumber":"100041235","name":"Loan Name","customerId":1201567899,"currentBalance":573000.32,"unamortizedPremium":1312.0,"bookBalance":573000.32,"riskRating":4,"paymentAmount":5523.0,"paymentFrequency":"monthly","paymentType":"fixedPayment","loanOfficerId":123456789,"interestRate":0.097,"floorRate":0.03,"ceilingRate":0.25,"indexRateDescription":"FHLBChicago","spread":0.02,"indexRate":0.02,"callCode":"1a","collateralCode":"Office Building","loanTypeCode":"Real Estate - Owner Occupied","productCode":"Real Estate","purposeCode":"110","industryCode":"110210","nonAccrual":false,"nonAccrualDate":null,"troubledDebtRestructure":false,"troubledDebtRestructureDate":null,"defaultStartDate":"2017-04-18","adjustableInterestRate":true,"timesPastDue3060":1,"timesPastDue6090":0,"timesPastDue90Plus":1,"daysCurrentlyPastDue":14,"chargedOffAmount":418.92,"amountPastDue":615.91,"prepaymentPenalty":false,"remainingTermInMonths":60,"dayCountConvention":"c_30_360","amortizedOver":null,"currentAvailableCredit":0.0,"maturityDate":"2030-12-15","netDeferredFeesOrCosts":1200.0,"totalFees":500.0,"expectedUtilizationRate":0.25,"upfrontFee":100.0,"annualFee":100.0,"unusedCommitmentFee":100.0,"originationExpenses":300.0,"overheadExpenses":200.0,"servicingExpenses":200.0,"accruedInterest":274.23,"originalLoanAmount":1250000.0,"originationDate":"2007-01-31","originalTermInMonths":60,"renewalDate":"2017-12-15","repricingDate":null,"governmentGuaranteed":false,"governmentGuaranteedPercent":null,"governmentGuaranteedBalance":null,"watchList":false,"points":0.0,"refinance":false,"latestPaymentDate":"2026-06-16","loanToValueRatio":0.754,"isDeleted":false,"isGuidanceLineOfCredit":null,"bankCodeBranch":null,"accountType":null,"parentLoansId":null,"withheldAmount":null,"institutionAvailableCredit":null,"institutionWithheld":null,"userDefinedString1":"Commercial","userDefinedString2":"Fixed Rate","userDefinedString3":"","userDefinedString4":"","userDefinedString5":"","userDefinedString6":"","userDefinedString7":"Another User Defined Value","userDefinedString8":"","userDefinedString9":"","userDefinedString10":"","userDefinedString11":"","userDefinedString12":"","userDefinedString13":"","userDefinedString14":"","userDefinedString15":"","userDefinedString16":"","userDefinedString17":"","userDefinedString18":"","userDefinedString19":"","userDefinedString20":"","userDefinedNumber1":13.77,"userDefinedNumber2":1044.0,"userDefinedNumber3":0.0045,"userDefinedNumber4":7.0,"userDefinedNumber5":7.0,"userDefinedNumber6":7.0,"userDefinedNumber7":7.0,"userDefinedNumber8":7.0,"userDefinedNumber9":7.0,"userDefinedNumber10":7.0,"userDefinedNumber11":7.0,"userDefinedNumber12":7.0,"userDefinedNumber13":7.0,"userDefinedNumber14":7.0,"userDefinedNumber15":7.0,"userDefinedNumber16":7.0,"userDefinedNumber17":7.0,"userDefinedNumber18":7.0,"userDefinedNumber19":7.0,"userDefinedNumber20":7.0,"userDefinedDate1":"2026-07-16","userDefinedDate2":"2026-07-15","userDefinedDate3":null,"userDefinedDate4":null,"userDefinedDate5":null,"userDefinedDate6":null,"userDefinedDate7":null,"userDefinedDate8":null,"userDefinedDate9":null,"userDefinedDate10":null,"userDefinedFields":null,"riskRatingId":null,"comments":null,"lossGivenDefaultRiskRating":"PASS","probabilityOfDefaultRiskRating":0.5},{"id":127764568,"loanNumber":"707041235","name":"Loan Name","customerId":1201577899,"currentBalance":1570023.47,"unamortizedPremium":2110.0,"bookBalance":1570023.47,"riskRating":4,"paymentAmount":15649.0,"paymentFrequency":"annual","paymentType":"singlePaymentBalloon","loanOfficerId":123456789,"interestRate":0.119,"floorRate":0.03,"ceilingRate":0.25,"indexRateDescription":"FHLBBoston","spread":0.02,"indexRate":0.02,"callCode":"1e1","collateralCode":"Office Building","loanTypeCode":"Real Estate - Owner Occupied","productCode":"Real Estate","purposeCode":"220","industryCode":"100200","nonAccrual":false,"nonAccrualDate":null,"troubledDebtRestructure":true,"troubledDebtRestructureDate":null,"defaultStartDate":"2017-04-18","adjustableInterestRate":true,"timesPastDue3060":1,"timesPastDue6090":0,"timesPastDue90Plus":1,"daysCurrentlyPastDue":18,"chargedOffAmount":418.92,"amountPastDue":615.91,"prepaymentPenalty":false,"remainingTermInMonths":19,"dayCountConvention":"c_30_365","amortizedOver":null,"currentAvailableCredit":100000.0,"maturityDate":"2038-02-01","netDeferredFeesOrCosts":1200.0,"totalFees":500.0,"expectedUtilizationRate":0.25,"upfrontFee":100.0,"annualFee":100.0,"unusedCommitmentFee":100.0,"originationExpenses":200.0,"overheadExpenses":200.0,"servicingExpenses":200.0,"accruedInterest":274.23,"originalLoanAmount":1950000.0,"originationDate":"2002-05-31","originalTermInMonths":60,"renewalDate":"2015-07-12","repricingDate":null,"governmentGuaranteed":false,"governmentGuaranteedPercent":null,"governmentGuaranteedBalance":null,"watchList":false,"points":0.0,"refinance":false,"latestPaymentDate":"2026-02-16","loanToValueRatio":0.754,"isDeleted":false,"isGuidanceLineOfCredit":null,"bankCodeBranch":null,"accountType":null,"parentLoansId":null,"withheldAmount":null,"institutionAvailableCredit":null,"institutionWithheld":null,"userDefinedString1":"Commercial","userDefinedString2":"Fixed Rate","userDefinedString3":"","userDefinedString4":"","userDefinedString5":"","userDefinedString6":"","userDefinedString7":"Another User Defined Value","userDefinedString8":"","userDefinedString9":"","userDefinedString10":"","userDefinedString11":"","userDefinedString12":"","userDefinedString13":"","userDefinedString14":"","userDefinedString15":"","userDefinedString16":"","userDefinedString17":"","userDefinedString18":"","userDefinedString19":"","userDefinedString20":"","userDefinedNumber1":13.77,"userDefinedNumber2":1044.0,"userDefinedNumber3":0.0045,"userDefinedNumber4":7.0,"userDefinedNumber5":7.0,"userDefinedNumber6":7.0,"userDefinedNumber7":7.0,"userDefinedNumber8":7.0,"userDefinedNumber9":7.0,"userDefinedNumber10":7.0,"userDefinedNumber11":7.0,"userDefinedNumber12":7.0,"userDefinedNumber13":7.0,"userDefinedNumber14":7.0,"userDefinedNumber15":7.0,"userDefinedNumber16":7.0,"userDefinedNumber17":7.0,"userDefinedNumber18":7.0,"userDefinedNumber19":7.0,"userDefinedNumber20":7.0,"userDefinedDate1":"2026-07-16","userDefinedDate2":"2026-07-15","userDefinedDate3":null,"userDefinedDate4":null,"userDefinedDate5":null,"userDefinedDate6":null,"userDefinedDate7":null,"userDefinedDate8":null,"userDefinedDate9":null,"userDefinedDate10":null,"userDefinedFields":null,"riskRatingId":null,"comments":null,"lossGivenDefaultRiskRating":"PASS","probabilityOfDefaultRiskRating":1.0},null,{"id":1299967899,"loanNumber":"100041235","name":"Loan Name","customerId":1201567899,"currentBalance":573000.32,"unamortizedPremium":1312.0,"bookBalance":573000.32,"riskRating":4,"paymentAmount":5523.0,"paymentFrequency":"monthly","paymentType":"fixedPayment","loanOfficerId":123456789,"interestRate":0.097,"floorRate":0.03,"ceilingRate":0.25,"indexRateDescription":"FHLBChicago","spread":0.02,"indexRate":0.02,"callCode":"1a","collateralCode":"Office Building","loanTypeCode":"Real Estate - Owner Occupied","productCode":"Real Estate","purposeCode":"110","industryCode":"110210","nonAccrual":false,"nonAccrualDate":null,"troubledDebtRestructure":false,"troubledDebtRestructureDate":null,"defaultStartDate":"2017-04-18","adjustableInterestRate":true,"timesPastDue3060":1,"timesPastDue6090":0,"timesPastDue90Plus":1,"daysCurrentlyPastDue":10,"chargedOffAmount":418.92,"amountPastDue":615.91,"prepaymentPenalty":false,"remainingTermInMonths":60,"dayCountConvention":"c_30_360","amortizedOver":null,"currentAvailableCredit":0.0,"maturityDate":"2030-12-15","netDeferredFeesOrCosts":1200.0,"totalFees":500.0,"expectedUtilizationRate":0.25,"upfrontFee":100.0,"annualFee":100.0,"unusedCommitmentFee":100.0,"originationExpenses":300.0,"overheadExpenses":200.0,"servicingExpenses":200.0,"accruedInterest":274.23,"originalLoanAmount":1250000.0,"originationDate":"2007-01-31","originalTermInMonths":60,"renewalDate":"2017-12-15","repricingDate":null,"governmentGuaranteed":false,"governmentGuaranteedPercent":null,"governmentGuaranteedBalance":null,"watchList":false,"points":0.0,"refinance":false,"latestPaymentDate":"2026-06-16","loanToValueRatio":0.754,"isDeleted":false,"isGuidanceLineOfCredit":null,"bankCodeBranch":null,"accountType":null,"parentLoansId":null,"withheldAmount":null,"institutionAvailableCredit":null,"institutionWithheld":null,"userDefinedString1":"Commercial","userDefinedString2":"Fixed Rate","userDefinedString3":"","userDefinedString4":"","userDefinedString5":"","userDefinedString6":"","userDefinedString7":"Another User Defined Value","userDefinedString8":"","userDefinedString9":"","userDefinedString10":"","userDefinedString11":"","userDefinedString12":"","userDefinedString13":"","userDefinedString14":"","userDefinedString15":"","userDefinedString16":"","userDefinedString17":"","userDefinedString18":"","userDefinedString19":"","userDefinedString20":"","userDefinedNumber1":13.77,"userDefinedNumber2":1044.0,"userDefinedNumber3":0.0045,"userDefinedNumber4":7.0,"userDefinedNumber5":7.0,"userDefinedNumber6":7.0,"userDefinedNumber7":7.0,"userDefinedNumber8":7.0,"userDefinedNumber9":7.0,"userDefinedNumber10":7.0,"userDefinedNumber11":7.0,"userDefinedNumber12":7.0,"userDefinedNumber13":7.0,"userDefinedNumber14":7.0,"userDefinedNumber15":7.0,"userDefinedNumber16":7.0,"userDefinedNumber17":7.0,"userDefinedNumber18":7.0,"userDefinedNumber19":7.0,"userDefinedNumber20":7.0,"userDefinedDate1":"2026-07-16","userDefinedDate2":"2026-07-15","userDefinedDate3":null,"userDefinedDate4":null,"userDefinedDate5":null,"userDefinedDate6":null,"userDefinedDate7":null,"userDefinedDate8":null,"userDefinedDate9":null,"userDefinedDate10":null,"userDefinedFields":null,"riskRatingId":null,"comments":null,"lossGivenDefaultRiskRating":"PASS","probabilityOfDefaultRiskRating":1.0}],"errors":{"2":{"errorType":"invalidRequest","message":"Input model for request is invalid","modelErrors":[{"propertyName":"loanNumber","message":"A loan with loanNumber '1234' already exists"}]}}} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "CreatePortfolioLoans" ] } ] } }, "/v1/portfolio-loans/takedown/{id}": { "post": { "tags": [ "Portfolio Loans" ], "summary": "Creates a portfolio loan takedown", "operationId": "CreatePortfolioLoanTakedown", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "id of the existing loan from which a takedown should be created", "required": true, "type": "integer", "format": "int32" }, { "in": "body", "name": "body", "description": "The portfolio loan to create", "schema": { "$ref": "#/definitions/PortfolioLoanTakedownRequest" } } ], "responses": { "201": { "description": "The portfolio loan takedown has been created successfully. The id of the proposed loan\r\n that was created is returned.", "schema": { "$ref": "#/definitions/PortfolioLoanTakedownResponse" }, "examples": { "application/json": {"proposedLoanId":12456112} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "ApiAccess" ] } ] } }, "/v1/portfolio-loans/takedown": { "get": { "tags": [ "Portfolio Loans" ], "summary": "Gets all takedown loans (across all portfolio loans) with pagination", "operationId": "GetPortfolioLoanTakedown", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "page", "description": "The page number of results to retrieve (first page = 1, default = 1)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "perPage", "description": "The number of records to return on each page (minimum = 1, maximum = 1000, default = 200)", "type": "integer", "format": "int32", "x-nullable": true } ], "responses": { "200": { "description": "Returns a collection of takedown loans in the system", "schema": { "$ref": "#/definitions/CollectionResponse[PortfolioLoanTakedownDetailResponse]" }, "examples": { "application/json": {"proposedLoanId":12456112,"loanName":"Example Loan Name","loanPaymentType":"Monthly","loanAmount":150000.00} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "ReadPortfolioLoans" ] } ] } }, "/v1/portfolio-loans/create-refinance-scenario/{portfolioLoanId}": { "post": { "tags": [ "Portfolio Loans" ], "summary": "Creates a Proposed Loan and Refinance Scenario", "operationId": "CreateRefinanceScenario", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "portfolioLoanId", "description": "id of the existing portfolio loan", "required": true, "type": "integer", "format": "int32" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/RefinanceScenarioRequest" } } ], "responses": { "201": { "description": "The proposed loan and refinance scenario have been created successfully.", "schema": { "$ref": "#/definitions/RefinanceScenarioResponse" }, "examples": { "application/json": {"proposedLoanId":1299967899} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "ApiAccess" ] } ] } }, "/v1/portfolio-loans/refinance-scenario-financial-statement-options/by-customer-id/{customerId}": { "get": { "tags": [ "Portfolio Loans" ], "summary": "Gets all financial statements", "operationId": "GetByCustomerId", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "customerId", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "Gets all current, existing, and active financial statements in the account", "schema": { "$ref": "#/definitions/CollectionResponse[RefinanceScenarioFinancialStatementOption]" }, "examples": { "application/json": {"items":[{"id":0,"periodEndDate":"2019-12-31","sourceOfData":"compilation","periodDuration":6},{"id":46512,"periodEndDate":"2020-01-31","sourceOfData":"other","periodDuration":1}]} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] } }, "/v1/proposed-loans/associate": { "post": { "tags": [ "Proposed Loans" ], "summary": "Associates a proposed loan with a portfolio loan", "operationId": "Associate", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "The loan association request", "schema": { "$ref": "#/definitions/ProposedLoanAssociationRequest" } } ], "responses": { "200": { "description": "The loan association was successful" }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] } }, "/v1/proposed-loans/associate/collateral-options/{proposedLoanId}": { "get": { "tags": [ "Proposed Loans" ], "summary": "Gets all collateral options for loan association given a proposed loan id", "operationId": "GetAssociateCollateralOptions", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "proposedLoanId", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "Gets all collateral options for loan association given a proposed loan id", "schema": { "$ref": "#/definitions/LoanAssociationCollateralOptions" }, "examples": { "application/json": {"proposedCollateralOptions":[{"id":412312,"description":"Proposed Collateral 01"},{"id":412321,"description":"Proposed Collateral 02"}],"existingCollateralOptions":[{"id":564133,"description":"Existing Collateral 01"},{"id":564111,"description":"Existing Collateral 02"},{"id":564115,"description":"Existing Collateral 03"}]} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] } }, "/v1/proposed-loans/associate/is-associated/{proposedLoanId}": { "get": { "tags": [ "Proposed Loans" ], "summary": "Determines if loan is associated", "operationId": "IsProposedLoanAssociated", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "proposedLoanId", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "True if loan is associated, false otherwise", "schema": { "type": "boolean" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] } }, "/v1/proposed-loans": { "get": { "tags": [ "Proposed Loans" ], "summary": "Gets all proposed loans", "operationId": "GetPaged", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "page", "description": "The page number of results to retrieve (first page = 1, default = 1)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "perPage", "description": "The number of records to return on each page (minimum = 1, maximum = 1000, default = 200)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "customerId", "description": "CustomerId value to filter by", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "loanName", "description": "Loan Name to filter by", "type": "string" }, { "in": "query", "name": "loanStatus", "description": "Loan Status to filter by", "type": "string" }, { "in": "query", "name": "proposedLoanStageId", "description": "Loan stage to filter by", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "loanAmountStart", "description": "The start of the loan amount to be used when doing a loan amount range query. This amount is inclusive.", "type": "number", "format": "double", "x-nullable": true }, { "in": "query", "name": "loanAmountEnd", "description": "The end of the loan amount to be used when doing a loan amount range query. This amount is inclusive.", "type": "number", "format": "double", "x-nullable": true }, { "in": "query", "name": "paymentType", "description": "Payment Type for the proposed loan", "type": "string", "enum": [ "fixedPayment", "fixedPrincipal", "lineOfCredit", "revolvingLineOfCredit", "interestOnly", "fixedPaymentBalloon", "fixedPrincipalBalloon", "singlePaymentBalloon", "principalOnly", "other", "noPayment" ], "x-nullable": true }, { "in": "query", "name": "loanTermStart", "description": "The start of the loan term to be used when doing a loan term range query (# of periods determined by payment frequency).", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "loanTermEnd", "description": "The end of the loan term to be used when doing a loan term range query (# of periods determined by payment frequency).", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "indexRateDescription", "description": "Index Rate Description for the proposed loan", "type": "string", "enum": [ "fhlbBoston", "fhlbChicago", "fhlbDallas", "fhlbDesMoines", "libor", "prime", "swap", "treasury", "sofr", "cmeTermSOFR" ], "x-nullable": true }, { "in": "query", "name": "ids", "description": "List of ids to filter by", "type": "array", "items": { "format": "int64", "type": "integer" }, "collectionFormat": "multi" }, { "in": "query", "name": "excludeLoansForDeletedCustomers", "description": "Set to true to ensure the proposed loans returned are not linked to deleted primary borrowers", "type": "boolean", "default": false }, { "in": "query", "name": "includeUserDefinedFields", "description": "Include User Defined fields in the response", "type": "boolean", "default": false, "x-nullable": true } ], "responses": { "200": { "description": "Gets all of the proposed loans in the account", "schema": { "$ref": "#/definitions/CollectionResponse[ProposedLoan]" }, "examples": { "application/json": {"items":[{"id":84851632,"loanId":1235141,"loanName":"70045698","customerId":123456987,"loanAmount":798550.0,"riskRating":3,"paymentAmount":27000.0,"paymentFrequency":"quarterly","paymentType":"fixedPayment","loanOfficerId":12345778,"interestRate":0.079,"callCode":"1e1","collateralCode":"Boats","loanTypeCode":"Marine Establishments","productCode":"Marine Establishments - East","purposeCode":"Business expansion","industryCode":"110210","classCode":"B - Corporation","adjustableInterestRate":true,"loanTerm":60,"dayCountConvention":"c_Actual_365","amortizedOver":null,"isDeleted":false,"status":"approved","createdDate":null,"statusLastUpdatedDate":null,"probabilityOfClosing":0.74,"projectedClosingDate":null,"totalFees":500.0,"otherFees":500.0,"expectedUtilizationRate":0.25,"originationExpenses":200.0,"overheadExpenses":200.0,"upfrontFee":100.0,"annualFee":100.0,"unusedCommitmentFee":100.0,"servicingExpenses":200.0,"floorRate":0.03,"indexRateDescription":"lIBOR","indexRate":0.02,"spread":0.02,"ceilingRate":0.25,"proposedLoanStageId":null,"proposedProductsId":null,"evaluatedCreditScore":null,"bankCodeBranch":"123Abc","denialOrWithdrawalReason":null,"denialOrWithdrawalReasons":null,"loanTypeForDenialOrWithdrawal":null,"statusReason":null,"firstPaymentDate":null,"firstInterestPaymentDate":null,"isSubjectToRegO":null,"isTakedownLoan":null,"isGuidanceLineOfCredit":null,"noteDate":"2026-07-12","maturityDate":null,"repricingDate":null,"disbursementDate":"2026-07-20","discountPointsDollarAmount":null,"includeNegativeAmortization":null,"brokerCompensationPercent":null,"lenderCredits":null,"introductionRatePeriodInMonths":null,"pointsAndFees":null,"isPreapprovalRequested":null,"isReverseMortgage":null,"rateLockDate":null,"cdChangeOfCircumstanceDate":null,"rescissionDate":null,"leChangeOfCircumstanceDate":null,"includeOtherNonAmortizingFeatures":null,"ecoaAdverseAction1":null,"ecoaAdverseAction2":null,"ecoaAdverseAction3":null,"hmdaLoanType":null,"hmdaLoanPurposeType":null,"hmdaPurchaserType":null,"hmdaFinalActionTakenType":null,"craLoanType":null,"craLoanPurposeType":null,"hmdaAmortizationType":null,"hmdaHoepaStatusType":null,"craRevenueCodeType":null,"interestOnlyTerm":60,"interestOnlyPaymentFrequency":null,"participationType":"lead","accountType":null,"parentIsProposed":null,"parentLoansId":null,"lossGivenDefaultRiskRating":"2","probabilityOfDefaultRiskRating":6.7,"withheldAmount":null,"institutionAvailableCredit":null,"institutionWithheld":null,"participatedAmount":null,"userDefinedString1":"Commercial","userDefinedString2":"Fixed Rate","userDefinedString3":"","userDefinedString4":"","userDefinedString5":"","userDefinedString6":"","userDefinedString7":"Another User Defined Value","userDefinedString8":"","userDefinedString9":"","userDefinedString10":"","userDefinedString11":"","userDefinedString12":"","userDefinedString13":"","userDefinedString14":"","userDefinedString15":"","userDefinedString16":"","userDefinedString17":"","userDefinedString18":"","userDefinedString19":"","userDefinedString20":"","userDefinedNumber1":13.77,"userDefinedNumber2":1044.0,"userDefinedNumber3":0.0045,"userDefinedNumber4":7.0,"userDefinedNumber5":7.0,"userDefinedNumber6":7.0,"userDefinedNumber7":7.0,"userDefinedNumber8":7.0,"userDefinedNumber9":7.0,"userDefinedNumber10":7.0,"userDefinedNumber11":7.0,"userDefinedNumber12":7.0,"userDefinedNumber13":7.0,"userDefinedNumber14":7.0,"userDefinedNumber15":7.0,"userDefinedNumber16":7.0,"userDefinedNumber17":7.0,"userDefinedNumber18":7.0,"userDefinedNumber19":7.0,"userDefinedNumber20":7.0,"userDefinedDate1":"2026-07-16","userDefinedDate2":"2026-07-15","userDefinedDate3":null,"userDefinedDate4":null,"userDefinedDate5":null,"userDefinedDate6":null,"userDefinedDate7":null,"userDefinedDate8":null,"userDefinedDate9":null,"userDefinedDate10":null,"userDefinedFields":null,"comments":"Comments","purpose":"Purpose","loanBoardingIdentifier":"12345","creditRating":null,"glCostCenter":null,"prepaymentPenaltyCode":null,"originationFee":null,"crmIdentifier":null,"riskRatingId":null,"tridApplicationDate":null,"intentToProceedDate":null,"consummationDate":null,"leIssueDate":null,"leRequiredDate":null,"cdRequiredDate":null,"cdIssueDate":null,"cdReissueDate":null,"leReissueDate":null,"closingCostExpirationDate":null,"rateLockExpirationDate":null,"fundingDate":null,"earliestTridCloseDate":null,"mortgageRateLockDate":null,"balloonPayment":null,"hasSecondaryRate":false,"secondaryCeilingRate":null,"secondaryIndexRate":null,"secondaryFloorRate":null,"secondaryInterestRate":null,"secondaryAdjustableInterestRate":null,"secondaryIndexRateDescription":null,"secondaryTypeOfPaymentAdjustment":"higherInstallmentAmount","secondaryRepriceFrequencyInterval":null,"secondaryRepriceFrequencyUnits":null,"secondarySpread":null,"termBeforeSecondaryRate":1,"requestType":null,"repriceFrequencyInterval":60,"repriceFrequencyUnits":"quarterly","statusChangedByUsersID":null},{"id":456123,"loanId":1235141,"loanName":"Start Up Loan","customerId":784565412,"loanAmount":100000.0,"riskRating":2,"paymentAmount":94562.24,"paymentFrequency":"quarterly","paymentType":"revolvingLineOfCredit","loanOfficerId":7845621,"interestRate":0.099,"callCode":"1a1","collateralCode":"Vehicles","loanTypeCode":"User Car Lots","productCode":"Used Car Lots - OO","purposeCode":"Business expansion","industryCode":"110210","classCode":"B - Corporation","adjustableInterestRate":false,"loanTerm":20,"dayCountConvention":"c_30_365","amortizedOver":null,"isDeleted":false,"status":"approved","createdDate":null,"statusLastUpdatedDate":null,"probabilityOfClosing":0.88,"projectedClosingDate":null,"totalFees":500.0,"otherFees":500.0,"expectedUtilizationRate":0.25,"originationExpenses":200.0,"overheadExpenses":200.0,"upfrontFee":100.0,"annualFee":100.0,"unusedCommitmentFee":100.0,"servicingExpenses":200.0,"floorRate":0.03,"indexRateDescription":"treasury","indexRate":0.02,"spread":0.02,"ceilingRate":0.25,"proposedLoanStageId":null,"proposedProductsId":null,"evaluatedCreditScore":null,"bankCodeBranch":"456Def","denialOrWithdrawalReason":null,"denialOrWithdrawalReasons":null,"loanTypeForDenialOrWithdrawal":null,"statusReason":null,"firstPaymentDate":null,"firstInterestPaymentDate":null,"isSubjectToRegO":null,"isTakedownLoan":null,"isGuidanceLineOfCredit":null,"noteDate":"2026-07-12","maturityDate":null,"repricingDate":null,"disbursementDate":"2026-07-20","discountPointsDollarAmount":null,"includeNegativeAmortization":null,"brokerCompensationPercent":null,"lenderCredits":null,"introductionRatePeriodInMonths":null,"pointsAndFees":null,"isPreapprovalRequested":null,"isReverseMortgage":null,"rateLockDate":null,"cdChangeOfCircumstanceDate":null,"rescissionDate":null,"leChangeOfCircumstanceDate":null,"includeOtherNonAmortizingFeatures":null,"ecoaAdverseAction1":null,"ecoaAdverseAction2":null,"ecoaAdverseAction3":null,"hmdaLoanType":null,"hmdaLoanPurposeType":null,"hmdaPurchaserType":null,"hmdaFinalActionTakenType":null,"craLoanType":null,"craLoanPurposeType":null,"hmdaAmortizationType":null,"hmdaHoepaStatusType":null,"craRevenueCodeType":null,"interestOnlyTerm":null,"interestOnlyPaymentFrequency":null,"participationType":"na","accountType":null,"parentIsProposed":null,"parentLoansId":null,"lossGivenDefaultRiskRating":null,"probabilityOfDefaultRiskRating":null,"withheldAmount":null,"institutionAvailableCredit":null,"institutionWithheld":null,"participatedAmount":null,"userDefinedString1":"Commercial","userDefinedString2":"Fixed Rate","userDefinedString3":"","userDefinedString4":"","userDefinedString5":"","userDefinedString6":"","userDefinedString7":"Another User Defined Value","userDefinedString8":"","userDefinedString9":"","userDefinedString10":"","userDefinedString11":"","userDefinedString12":"","userDefinedString13":"","userDefinedString14":"","userDefinedString15":"","userDefinedString16":"","userDefinedString17":"","userDefinedString18":"","userDefinedString19":"","userDefinedString20":"","userDefinedNumber1":13.77,"userDefinedNumber2":1044.0,"userDefinedNumber3":0.0045,"userDefinedNumber4":7.0,"userDefinedNumber5":7.0,"userDefinedNumber6":7.0,"userDefinedNumber7":7.0,"userDefinedNumber8":7.0,"userDefinedNumber9":7.0,"userDefinedNumber10":7.0,"userDefinedNumber11":7.0,"userDefinedNumber12":7.0,"userDefinedNumber13":7.0,"userDefinedNumber14":7.0,"userDefinedNumber15":7.0,"userDefinedNumber16":7.0,"userDefinedNumber17":7.0,"userDefinedNumber18":7.0,"userDefinedNumber19":7.0,"userDefinedNumber20":7.0,"userDefinedDate1":"2026-07-16","userDefinedDate2":"2026-07-15","userDefinedDate3":null,"userDefinedDate4":null,"userDefinedDate5":null,"userDefinedDate6":null,"userDefinedDate7":null,"userDefinedDate8":null,"userDefinedDate9":null,"userDefinedDate10":null,"userDefinedFields":null,"comments":"Comments","purpose":"Purpose","loanBoardingIdentifier":"11111","creditRating":null,"glCostCenter":null,"prepaymentPenaltyCode":null,"originationFee":null,"crmIdentifier":null,"riskRatingId":null,"tridApplicationDate":null,"intentToProceedDate":null,"consummationDate":null,"leIssueDate":null,"leRequiredDate":null,"cdRequiredDate":null,"cdIssueDate":null,"cdReissueDate":null,"leReissueDate":null,"closingCostExpirationDate":null,"rateLockExpirationDate":null,"fundingDate":null,"earliestTridCloseDate":null,"mortgageRateLockDate":null,"balloonPayment":null,"hasSecondaryRate":false,"secondaryCeilingRate":null,"secondaryIndexRate":null,"secondaryFloorRate":null,"secondaryInterestRate":null,"secondaryAdjustableInterestRate":null,"secondaryIndexRateDescription":null,"secondaryTypeOfPaymentAdjustment":"higherInstallmentAmount","secondaryRepriceFrequencyInterval":null,"secondaryRepriceFrequencyUnits":null,"secondarySpread":null,"termBeforeSecondaryRate":null,"requestType":null,"repriceFrequencyInterval":null,"repriceFrequencyUnits":null,"statusChangedByUsersID":null}]} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "ReadProposedLoans" ] } ] }, "post": { "tags": [ "Proposed Loans" ], "summary": "Creates a proposed loan", "operationId": "Create", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "The proposed loan to create", "schema": { "$ref": "#/definitions/ProposedLoan" } } ], "responses": { "201": { "description": "The proposed loan has been created succesfully. The proposed loan\r\n that was created is returned and has the Sageworks id that was assigned.", "schema": { "$ref": "#/definitions/ProposedLoan" }, "examples": { "application/json": {"id":84851632,"loanId":1235141,"loanName":"70045698","customerId":123456987,"loanAmount":798550.0,"riskRating":3,"paymentAmount":27000.0,"paymentFrequency":"quarterly","paymentType":"fixedPayment","loanOfficerId":12345778,"interestRate":0.079,"callCode":"1e1","collateralCode":"Boats","loanTypeCode":"Marine Establishments","productCode":"Marine Establishments - East","purposeCode":"Business expansion","industryCode":"110210","classCode":"B - Corporation","adjustableInterestRate":true,"loanTerm":60,"dayCountConvention":"c_Actual_365","amortizedOver":null,"isDeleted":false,"status":"approved","createdDate":null,"statusLastUpdatedDate":null,"probabilityOfClosing":0.74,"projectedClosingDate":null,"totalFees":500.0,"otherFees":500.0,"expectedUtilizationRate":0.25,"originationExpenses":200.0,"overheadExpenses":200.0,"upfrontFee":100.0,"annualFee":100.0,"unusedCommitmentFee":100.0,"servicingExpenses":200.0,"floorRate":0.03,"indexRateDescription":"lIBOR","indexRate":0.02,"spread":0.02,"ceilingRate":0.25,"proposedLoanStageId":null,"proposedProductsId":null,"evaluatedCreditScore":null,"bankCodeBranch":"123Abc","denialOrWithdrawalReason":null,"denialOrWithdrawalReasons":null,"loanTypeForDenialOrWithdrawal":null,"statusReason":null,"firstPaymentDate":null,"firstInterestPaymentDate":null,"isSubjectToRegO":null,"isTakedownLoan":null,"isGuidanceLineOfCredit":null,"noteDate":"2026-07-12","maturityDate":"2031-07-16","repricingDate":"2027-07-16","disbursementDate":"2026-07-20","discountPointsDollarAmount":null,"includeNegativeAmortization":null,"brokerCompensationPercent":null,"lenderCredits":null,"introductionRatePeriodInMonths":null,"pointsAndFees":null,"isPreapprovalRequested":null,"isReverseMortgage":null,"rateLockDate":null,"cdChangeOfCircumstanceDate":null,"rescissionDate":null,"leChangeOfCircumstanceDate":null,"includeOtherNonAmortizingFeatures":null,"ecoaAdverseAction1":null,"ecoaAdverseAction2":null,"ecoaAdverseAction3":null,"hmdaLoanType":null,"hmdaLoanPurposeType":null,"hmdaPurchaserType":null,"hmdaFinalActionTakenType":null,"craLoanType":null,"craLoanPurposeType":null,"hmdaAmortizationType":null,"hmdaHoepaStatusType":null,"craRevenueCodeType":null,"interestOnlyTerm":null,"interestOnlyPaymentFrequency":null,"participationType":"na","accountType":"loan","parentIsProposed":true,"parentLoansId":56789,"lossGivenDefaultRiskRating":"2","probabilityOfDefaultRiskRating":6.7,"withheldAmount":null,"institutionAvailableCredit":null,"institutionWithheld":null,"participatedAmount":null,"userDefinedString1":"Commercial","userDefinedString2":"Fixed Rate","userDefinedString3":"","userDefinedString4":"","userDefinedString5":"","userDefinedString6":"","userDefinedString7":"Another User Defined Value","userDefinedString8":"","userDefinedString9":"","userDefinedString10":"","userDefinedString11":"","userDefinedString12":"","userDefinedString13":"","userDefinedString14":"","userDefinedString15":"","userDefinedString16":"","userDefinedString17":"","userDefinedString18":"","userDefinedString19":"","userDefinedString20":"","userDefinedNumber1":13.77,"userDefinedNumber2":1044.0,"userDefinedNumber3":0.0045,"userDefinedNumber4":7.0,"userDefinedNumber5":7.0,"userDefinedNumber6":7.0,"userDefinedNumber7":7.0,"userDefinedNumber8":7.0,"userDefinedNumber9":7.0,"userDefinedNumber10":7.0,"userDefinedNumber11":7.0,"userDefinedNumber12":7.0,"userDefinedNumber13":7.0,"userDefinedNumber14":7.0,"userDefinedNumber15":7.0,"userDefinedNumber16":7.0,"userDefinedNumber17":7.0,"userDefinedNumber18":7.0,"userDefinedNumber19":7.0,"userDefinedNumber20":7.0,"userDefinedDate1":"2026-07-16","userDefinedDate2":"2026-07-15","userDefinedDate3":null,"userDefinedDate4":null,"userDefinedDate5":null,"userDefinedDate6":null,"userDefinedDate7":null,"userDefinedDate8":null,"userDefinedDate9":null,"userDefinedDate10":null,"userDefinedFields":null,"comments":null,"purpose":null,"loanBoardingIdentifier":"11111","creditRating":null,"glCostCenter":null,"prepaymentPenaltyCode":null,"originationFee":null,"crmIdentifier":null,"riskRatingId":null,"tridApplicationDate":null,"intentToProceedDate":null,"consummationDate":null,"leIssueDate":null,"leRequiredDate":null,"cdRequiredDate":null,"cdIssueDate":null,"cdReissueDate":null,"leReissueDate":null,"closingCostExpirationDate":null,"rateLockExpirationDate":null,"fundingDate":null,"earliestTridCloseDate":null,"mortgageRateLockDate":null,"balloonPayment":null,"hasSecondaryRate":false,"secondaryCeilingRate":null,"secondaryIndexRate":null,"secondaryFloorRate":null,"secondaryInterestRate":null,"secondaryAdjustableInterestRate":null,"secondaryIndexRateDescription":null,"secondaryTypeOfPaymentAdjustment":"higherInstallmentAmount","secondaryRepriceFrequencyInterval":null,"secondaryRepriceFrequencyUnits":null,"secondarySpread":null,"termBeforeSecondaryRate":null,"requestType":null,"repriceFrequencyInterval":null,"repriceFrequencyUnits":null,"statusChangedByUsersID":null} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "CreateProposedLoans" ] } ] } }, "/v1/proposed-loans/basic-information": { "get": { "tags": [ "Proposed Loans" ], "summary": "Gets all proposed loans basic information", "operationId": "GetPagedBasicInformation", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "page", "description": "The page number of results to retrieve (first page = 1, default = 1)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "perPage", "description": "The number of records to return on each page (minimum = 1, maximum = 1000, default = 200)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "customerId", "description": "CustomerId value to filter by", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "loanName", "description": "Loan Name to filter by", "type": "string" }, { "in": "query", "name": "loanStatus", "description": "Loan Status to filter by", "type": "string" }, { "in": "query", "name": "proposedLoanStageId", "description": "Loan stage to filter by", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "loanAmountStart", "description": "The start of the loan amount to be used when doing a loan amount range query. This amount is inclusive.", "type": "number", "format": "double", "x-nullable": true }, { "in": "query", "name": "loanAmountEnd", "description": "The end of the loan amount to be used when doing a loan amount range query. This amount is inclusive.", "type": "number", "format": "double", "x-nullable": true }, { "in": "query", "name": "paymentType", "description": "Payment Type for the proposed loan", "type": "string", "enum": [ "fixedPayment", "fixedPrincipal", "lineOfCredit", "revolvingLineOfCredit", "interestOnly", "fixedPaymentBalloon", "fixedPrincipalBalloon", "singlePaymentBalloon", "principalOnly", "other", "noPayment" ], "x-nullable": true }, { "in": "query", "name": "loanTermStart", "description": "The start of the loan term to be used when doing a loan term range query (# of periods determined by payment frequency).", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "loanTermEnd", "description": "The end of the loan term to be used when doing a loan term range query (# of periods determined by payment frequency).", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "indexRateDescription", "description": "Index Rate Description for the proposed loan", "type": "string", "enum": [ "fhlbBoston", "fhlbChicago", "fhlbDallas", "fhlbDesMoines", "libor", "prime", "swap", "treasury", "sofr", "cmeTermSOFR" ], "x-nullable": true }, { "in": "query", "name": "ids", "description": "List of ids to filter by", "type": "array", "items": { "format": "int64", "type": "integer" }, "collectionFormat": "multi" } ], "responses": { "200": { "description": "Gets basic information for all current, existing, and active proposed loans in the account", "schema": { "$ref": "#/definitions/CollectionResponse[ProposedLoanBasicInformation]" }, "examples": { "application/json": [{"id":1299967899,"customerId":1201567899,"loanName":"100041235","loanAmount":573000.32},{"id":1299964568,"customerId":1201567899,"loanName":"708041235","loanAmount":1570023.47}] } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "ReadProposedLoans" ] } ] } }, "/v1/proposed-loans/{id}/loan-exposure": { "get": { "tags": [ "Proposed Loans" ], "summary": "Gets all proposed loan exposure information.", "operationId": "GetLoanExposure", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "Gets loan exposure for all current, existing, and active proposed loans in the account", "schema": { "$ref": "#/definitions/ProposedLoanExposure" }, "examples": { "application/json": {"customerId":12345,"currentOutstandingBalance":1221041.0,"currentAvailableCredit":0.0,"totalCommitment":1221041.0,"totalRelatedCommitment":1221041.0} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "ReadProposedLoans" ] } ] } }, "/v1/proposed-loans/summary-information": { "get": { "tags": [ "Proposed Loans" ], "summary": "Gets all portfolio loans summary information.", "operationId": "GetPagedSummaryInformation", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "page", "description": "The page number of results to retrieve (first page = 1, default = 1)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "perPage", "description": "The number of records to return on each page (minimum = 1, maximum = 1000, default = 200)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "customerId", "description": "CustomerId value to filter by", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "loanNumber", "description": "Loan Number to filter by", "type": "string" }, { "in": "query", "name": "isDecisioned", "description": "Filter on whether or not the loan has a status", "type": "boolean", "x-nullable": true } ], "responses": { "200": { "description": "Gets summary information for all current, existing, and active portfolio loans in the account", "schema": { "$ref": "#/definitions/PagedCollectionResponse[ProposedLoanSummaryInformation]" }, "examples": { "application/json": [{"bankCustomerProfitEntitiesID":444555666,"id":1299967899,"customerId":1201567899,"borrowerName":"Person Borrower","paymentType":"lineOfCredit","riskRating":5,"loanName":"100041235","loanAmount":573000.32,"loanStage":"Loan Stage 1","importedDate":null,"status":null,"loanApplicationId":null},{"bankCustomerProfitEntitiesID":444555666,"id":1299964568,"customerId":1201567899,"borrowerName":"Company Borrower","paymentType":"fixedPayment","riskRating":1,"loanName":"708041235","loanAmount":1570023.47,"loanStage":"Loan Stage 2","importedDate":null,"status":null,"loanApplicationId":null}] } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "ReadProposedLoans" ] } ] } }, "/v1/proposed-loans/bulk": { "patch": { "tags": [ "Proposed Loans" ], "summary": "Updates a collection of proposed loans", "operationId": "UpdateMany", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "The collection of proposed loans to update", "schema": { "$ref": "#/definitions/BulkUpdateRequest[ProposedLoan]" } } ], "responses": { "200": { "description": "All proposed loans were processed. Please check the errors property of the response object\r\n to determine if there were errors updating any individual proposed loan", "schema": { "$ref": "#/definitions/BulkUpdateRequest[ProposedLoan]" }, "examples": { "application/json": {"itemsUpdated":[{"id":84851632,"loanId":1235141,"loanName":"70045698","customerId":123456987,"loanAmount":798550.0,"riskRating":3,"paymentAmount":27000.0,"paymentFrequency":"quarterly","paymentType":"fixedPayment","loanOfficerId":12345778,"interestRate":0.079,"callCode":"1e1","collateralCode":"Boats","loanTypeCode":"Marine Establishments","productCode":"Marine Establishments - East","purposeCode":"Business expansion","industryCode":"110210","classCode":"B - Corporation","adjustableInterestRate":true,"loanTerm":60,"dayCountConvention":"c_Actual_365","amortizedOver":null,"isDeleted":false,"status":"approved","createdDate":null,"statusLastUpdatedDate":null,"probabilityOfClosing":0.74,"projectedClosingDate":null,"totalFees":500.0,"otherFees":500.0,"expectedUtilizationRate":0.25,"originationExpenses":200.0,"overheadExpenses":200.0,"upfrontFee":100.0,"annualFee":100.0,"unusedCommitmentFee":100.0,"servicingExpenses":200.0,"floorRate":0.03,"indexRateDescription":"lIBOR","indexRate":0.02,"spread":0.02,"ceilingRate":0.25,"proposedLoanStageId":null,"proposedProductsId":null,"evaluatedCreditScore":null,"bankCodeBranch":null,"denialOrWithdrawalReason":null,"denialOrWithdrawalReasons":null,"loanTypeForDenialOrWithdrawal":null,"statusReason":null,"firstPaymentDate":null,"firstInterestPaymentDate":null,"isSubjectToRegO":null,"isTakedownLoan":null,"isGuidanceLineOfCredit":null,"noteDate":null,"maturityDate":null,"repricingDate":null,"disbursementDate":null,"discountPointsDollarAmount":null,"includeNegativeAmortization":null,"brokerCompensationPercent":null,"lenderCredits":null,"introductionRatePeriodInMonths":null,"pointsAndFees":null,"isPreapprovalRequested":null,"isReverseMortgage":null,"rateLockDate":null,"cdChangeOfCircumstanceDate":null,"rescissionDate":null,"leChangeOfCircumstanceDate":null,"includeOtherNonAmortizingFeatures":null,"ecoaAdverseAction1":null,"ecoaAdverseAction2":null,"ecoaAdverseAction3":null,"hmdaLoanType":null,"hmdaLoanPurposeType":null,"hmdaPurchaserType":null,"hmdaFinalActionTakenType":null,"craLoanType":null,"craLoanPurposeType":null,"hmdaAmortizationType":null,"hmdaHoepaStatusType":null,"craRevenueCodeType":null,"interestOnlyTerm":60,"interestOnlyPaymentFrequency":null,"participationType":"na","accountType":"loan","parentIsProposed":true,"parentLoansId":56789,"lossGivenDefaultRiskRating":null,"probabilityOfDefaultRiskRating":null,"withheldAmount":500000.0,"institutionAvailableCredit":40000.0,"institutionWithheld":25000.0,"participatedAmount":100000.0,"userDefinedString1":"Commercial","userDefinedString2":"Fixed Rate","userDefinedString3":"","userDefinedString4":"","userDefinedString5":"","userDefinedString6":"","userDefinedString7":"Another User Defined Value","userDefinedString8":"","userDefinedString9":"","userDefinedString10":"","userDefinedString11":"","userDefinedString12":"","userDefinedString13":"","userDefinedString14":"","userDefinedString15":"","userDefinedString16":"","userDefinedString17":"","userDefinedString18":"","userDefinedString19":"","userDefinedString20":"","userDefinedNumber1":13.77,"userDefinedNumber2":1044.0,"userDefinedNumber3":0.0045,"userDefinedNumber4":7.0,"userDefinedNumber5":7.0,"userDefinedNumber6":7.0,"userDefinedNumber7":7.0,"userDefinedNumber8":7.0,"userDefinedNumber9":7.0,"userDefinedNumber10":7.0,"userDefinedNumber11":7.0,"userDefinedNumber12":7.0,"userDefinedNumber13":7.0,"userDefinedNumber14":7.0,"userDefinedNumber15":7.0,"userDefinedNumber16":7.0,"userDefinedNumber17":7.0,"userDefinedNumber18":7.0,"userDefinedNumber19":7.0,"userDefinedNumber20":7.0,"userDefinedDate1":"2026-07-16","userDefinedDate2":"2026-07-15","userDefinedDate3":null,"userDefinedDate4":null,"userDefinedDate5":null,"userDefinedDate6":null,"userDefinedDate7":null,"userDefinedDate8":null,"userDefinedDate9":null,"userDefinedDate10":null,"userDefinedFields":null,"comments":null,"purpose":null,"loanBoardingIdentifier":"11111","creditRating":null,"glCostCenter":null,"prepaymentPenaltyCode":null,"originationFee":null,"crmIdentifier":null,"riskRatingId":null,"tridApplicationDate":null,"intentToProceedDate":null,"consummationDate":null,"leIssueDate":null,"leRequiredDate":null,"cdRequiredDate":null,"cdIssueDate":null,"cdReissueDate":null,"leReissueDate":null,"closingCostExpirationDate":null,"rateLockExpirationDate":null,"fundingDate":null,"earliestTridCloseDate":null,"mortgageRateLockDate":null,"balloonPayment":null,"hasSecondaryRate":false,"secondaryCeilingRate":null,"secondaryIndexRate":null,"secondaryFloorRate":null,"secondaryInterestRate":null,"secondaryAdjustableInterestRate":null,"secondaryIndexRateDescription":null,"secondaryTypeOfPaymentAdjustment":"higherInstallmentAmount","secondaryRepriceFrequencyInterval":null,"secondaryRepriceFrequencyUnits":null,"secondarySpread":null,"termBeforeSecondaryRate":1,"requestType":null,"repriceFrequencyInterval":60,"repriceFrequencyUnits":"quarterly","statusChangedByUsersID":null},{"id":456123,"loanId":1235141,"loanName":"Start Up Loan","customerId":784565412,"loanAmount":100000.0,"riskRating":2,"paymentAmount":94562.24,"paymentFrequency":"quarterly","paymentType":"revolvingLineOfCredit","loanOfficerId":7845621,"interestRate":0.099,"callCode":"1a1","collateralCode":"Vehicles","loanTypeCode":"User Car Lots","productCode":"Used Car Lots - OO","purposeCode":"Business expansion","industryCode":"110210","classCode":"B - Corporation","adjustableInterestRate":false,"loanTerm":20,"dayCountConvention":"c_30_365","amortizedOver":null,"isDeleted":false,"status":"approved","createdDate":null,"statusLastUpdatedDate":null,"probabilityOfClosing":0.88,"projectedClosingDate":null,"totalFees":500.0,"otherFees":500.0,"expectedUtilizationRate":0.25,"originationExpenses":200.0,"overheadExpenses":200.0,"upfrontFee":100.0,"annualFee":100.0,"unusedCommitmentFee":100.0,"servicingExpenses":200.0,"floorRate":0.03,"indexRateDescription":"treasury","indexRate":0.02,"spread":0.02,"ceilingRate":0.25,"proposedLoanStageId":null,"proposedProductsId":null,"evaluatedCreditScore":null,"bankCodeBranch":null,"denialOrWithdrawalReason":null,"denialOrWithdrawalReasons":null,"loanTypeForDenialOrWithdrawal":null,"statusReason":null,"firstPaymentDate":null,"firstInterestPaymentDate":null,"isSubjectToRegO":null,"isTakedownLoan":null,"isGuidanceLineOfCredit":null,"noteDate":null,"maturityDate":null,"repricingDate":null,"disbursementDate":null,"discountPointsDollarAmount":null,"includeNegativeAmortization":null,"brokerCompensationPercent":null,"lenderCredits":null,"introductionRatePeriodInMonths":null,"pointsAndFees":null,"isPreapprovalRequested":null,"isReverseMortgage":null,"rateLockDate":null,"cdChangeOfCircumstanceDate":null,"rescissionDate":null,"leChangeOfCircumstanceDate":null,"includeOtherNonAmortizingFeatures":null,"ecoaAdverseAction1":null,"ecoaAdverseAction2":null,"ecoaAdverseAction3":null,"hmdaLoanType":null,"hmdaLoanPurposeType":null,"hmdaPurchaserType":null,"hmdaFinalActionTakenType":null,"craLoanType":null,"craLoanPurposeType":null,"hmdaAmortizationType":null,"hmdaHoepaStatusType":null,"craRevenueCodeType":null,"interestOnlyTerm":null,"interestOnlyPaymentFrequency":null,"participationType":"na","accountType":"facility","parentIsProposed":null,"parentLoansId":null,"lossGivenDefaultRiskRating":null,"probabilityOfDefaultRiskRating":null,"withheldAmount":50000.0,"institutionAvailableCredit":2000.0,"institutionWithheld":5000.0,"participatedAmount":10000.0,"userDefinedString1":"Commercial","userDefinedString2":"Fixed Rate","userDefinedString3":"","userDefinedString4":"","userDefinedString5":"","userDefinedString6":"","userDefinedString7":"Another User Defined Value","userDefinedString8":"","userDefinedString9":"","userDefinedString10":"","userDefinedString11":"","userDefinedString12":"","userDefinedString13":"","userDefinedString14":"","userDefinedString15":"","userDefinedString16":"","userDefinedString17":"","userDefinedString18":"","userDefinedString19":"","userDefinedString20":"","userDefinedNumber1":13.77,"userDefinedNumber2":1044.0,"userDefinedNumber3":0.0045,"userDefinedNumber4":7.0,"userDefinedNumber5":7.0,"userDefinedNumber6":7.0,"userDefinedNumber7":7.0,"userDefinedNumber8":7.0,"userDefinedNumber9":7.0,"userDefinedNumber10":7.0,"userDefinedNumber11":7.0,"userDefinedNumber12":7.0,"userDefinedNumber13":7.0,"userDefinedNumber14":7.0,"userDefinedNumber15":7.0,"userDefinedNumber16":7.0,"userDefinedNumber17":7.0,"userDefinedNumber18":7.0,"userDefinedNumber19":7.0,"userDefinedNumber20":7.0,"userDefinedDate1":"2026-07-16","userDefinedDate2":"2026-07-15","userDefinedDate3":null,"userDefinedDate4":null,"userDefinedDate5":null,"userDefinedDate6":null,"userDefinedDate7":null,"userDefinedDate8":null,"userDefinedDate9":null,"userDefinedDate10":null,"userDefinedFields":null,"comments":null,"purpose":null,"loanBoardingIdentifier":"22222","creditRating":null,"glCostCenter":null,"prepaymentPenaltyCode":null,"originationFee":null,"crmIdentifier":null,"riskRatingId":null,"tridApplicationDate":null,"intentToProceedDate":null,"consummationDate":null,"leIssueDate":null,"leRequiredDate":null,"cdRequiredDate":null,"cdIssueDate":null,"cdReissueDate":null,"leReissueDate":null,"closingCostExpirationDate":null,"rateLockExpirationDate":null,"fundingDate":null,"earliestTridCloseDate":null,"mortgageRateLockDate":null,"balloonPayment":null,"hasSecondaryRate":false,"secondaryCeilingRate":null,"secondaryIndexRate":null,"secondaryFloorRate":null,"secondaryInterestRate":null,"secondaryAdjustableInterestRate":null,"secondaryIndexRateDescription":null,"secondaryTypeOfPaymentAdjustment":"higherInstallmentAmount","secondaryRepriceFrequencyInterval":null,"secondaryRepriceFrequencyUnits":null,"secondarySpread":null,"termBeforeSecondaryRate":null,"requestType":null,"repriceFrequencyInterval":null,"repriceFrequencyUnits":null,"statusChangedByUsersID":null},null,{"id":9876543,"loanId":346676,"loanName":"Start Up Loan2","customerId":784565412,"loanAmount":100000.0,"riskRating":2,"paymentAmount":94562.24,"paymentFrequency":"quarterly","paymentType":"revolvingLineOfCredit","loanOfficerId":7845621,"interestRate":0.099,"callCode":"1a1","collateralCode":"Vehicles","loanTypeCode":"User Car Lots","productCode":"Used Car Lots - OO","purposeCode":"Business expansion","industryCode":"110210","classCode":"B - Corporation","adjustableInterestRate":false,"loanTerm":20,"dayCountConvention":"c_30_365","amortizedOver":null,"isDeleted":false,"status":"approved","createdDate":null,"statusLastUpdatedDate":null,"probabilityOfClosing":0.88,"projectedClosingDate":null,"totalFees":500.0,"otherFees":500.0,"expectedUtilizationRate":0.25,"originationExpenses":200.0,"overheadExpenses":200.0,"upfrontFee":100.0,"annualFee":100.0,"unusedCommitmentFee":100.0,"servicingExpenses":200.0,"floorRate":0.03,"indexRateDescription":"treasury","indexRate":0.02,"spread":0.02,"ceilingRate":0.25,"proposedLoanStageId":null,"proposedProductsId":null,"evaluatedCreditScore":null,"bankCodeBranch":null,"denialOrWithdrawalReason":null,"denialOrWithdrawalReasons":null,"loanTypeForDenialOrWithdrawal":null,"statusReason":null,"firstPaymentDate":null,"firstInterestPaymentDate":null,"isSubjectToRegO":null,"isTakedownLoan":null,"isGuidanceLineOfCredit":null,"noteDate":"2026-07-12","maturityDate":null,"repricingDate":null,"disbursementDate":"2026-07-20","discountPointsDollarAmount":null,"includeNegativeAmortization":null,"brokerCompensationPercent":null,"lenderCredits":null,"introductionRatePeriodInMonths":null,"pointsAndFees":null,"isPreapprovalRequested":null,"isReverseMortgage":null,"rateLockDate":null,"cdChangeOfCircumstanceDate":null,"rescissionDate":null,"leChangeOfCircumstanceDate":null,"includeOtherNonAmortizingFeatures":null,"ecoaAdverseAction1":null,"ecoaAdverseAction2":null,"ecoaAdverseAction3":null,"hmdaLoanType":null,"hmdaLoanPurposeType":null,"hmdaPurchaserType":null,"hmdaFinalActionTakenType":null,"craLoanType":null,"craLoanPurposeType":null,"hmdaAmortizationType":null,"hmdaHoepaStatusType":null,"craRevenueCodeType":null,"interestOnlyTerm":null,"interestOnlyPaymentFrequency":null,"participationType":"na","accountType":null,"parentIsProposed":null,"parentLoansId":null,"lossGivenDefaultRiskRating":null,"probabilityOfDefaultRiskRating":null,"withheldAmount":null,"institutionAvailableCredit":null,"institutionWithheld":null,"participatedAmount":null,"userDefinedString1":"Commercial","userDefinedString2":"Fixed Rate","userDefinedString3":"","userDefinedString4":"","userDefinedString5":"","userDefinedString6":"","userDefinedString7":"Another User Defined Value","userDefinedString8":"","userDefinedString9":"","userDefinedString10":"","userDefinedString11":"","userDefinedString12":"","userDefinedString13":"","userDefinedString14":"","userDefinedString15":"","userDefinedString16":"","userDefinedString17":"","userDefinedString18":"","userDefinedString19":"","userDefinedString20":"","userDefinedNumber1":13.77,"userDefinedNumber2":1044.0,"userDefinedNumber3":0.0045,"userDefinedNumber4":7.0,"userDefinedNumber5":7.0,"userDefinedNumber6":7.0,"userDefinedNumber7":7.0,"userDefinedNumber8":7.0,"userDefinedNumber9":7.0,"userDefinedNumber10":7.0,"userDefinedNumber11":7.0,"userDefinedNumber12":7.0,"userDefinedNumber13":7.0,"userDefinedNumber14":7.0,"userDefinedNumber15":7.0,"userDefinedNumber16":7.0,"userDefinedNumber17":7.0,"userDefinedNumber18":7.0,"userDefinedNumber19":7.0,"userDefinedNumber20":7.0,"userDefinedDate1":"2026-07-16","userDefinedDate2":"2026-07-15","userDefinedDate3":null,"userDefinedDate4":null,"userDefinedDate5":null,"userDefinedDate6":null,"userDefinedDate7":null,"userDefinedDate8":null,"userDefinedDate9":null,"userDefinedDate10":null,"userDefinedFields":null,"comments":null,"purpose":null,"loanBoardingIdentifier":"33333","creditRating":null,"glCostCenter":null,"prepaymentPenaltyCode":null,"originationFee":null,"crmIdentifier":null,"riskRatingId":null,"tridApplicationDate":null,"intentToProceedDate":null,"consummationDate":null,"leIssueDate":null,"leRequiredDate":null,"cdRequiredDate":null,"cdIssueDate":null,"cdReissueDate":null,"leReissueDate":null,"closingCostExpirationDate":null,"rateLockExpirationDate":null,"fundingDate":null,"earliestTridCloseDate":null,"mortgageRateLockDate":null,"balloonPayment":null,"hasSecondaryRate":false,"secondaryCeilingRate":null,"secondaryIndexRate":null,"secondaryFloorRate":null,"secondaryInterestRate":null,"secondaryAdjustableInterestRate":null,"secondaryIndexRateDescription":null,"secondaryTypeOfPaymentAdjustment":"higherInstallmentAmount","secondaryRepriceFrequencyInterval":null,"secondaryRepriceFrequencyUnits":null,"secondarySpread":null,"termBeforeSecondaryRate":null,"requestType":null,"repriceFrequencyInterval":null,"repriceFrequencyUnits":null,"statusChangedByUsersID":null}],"errors":{"2":{"errorType":"invalidRequest","message":"Input model for request is invalid","modelErrors":[{"propertyName":"loanName","message":"loanName is required"}]}}} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "UpdateProposedLoans" ] } ] }, "post": { "tags": [ "Proposed Loans" ], "summary": "Creates a collection of proposed loans", "operationId": "CreateMany", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "The collection of proposed loans to create", "schema": { "$ref": "#/definitions/BulkCreateRequest[ProposedLoan]" } } ], "responses": { "200": { "description": "All proposed loans were processed. Please check the errors property of the response object\r\n to determine if there were errors creating any individual proposed loan", "schema": { "$ref": "#/definitions/BulkCreateResponse[ProposedLoan]" }, "examples": { "application/json": {"itemsCreated":[{"id":84851632,"loanId":1235141,"loanName":"70045698","customerId":123456987,"loanAmount":798550.0,"riskRating":3,"paymentAmount":27000.0,"paymentFrequency":"quarterly","paymentType":"fixedPayment","loanOfficerId":12345778,"interestRate":0.079,"callCode":"1e1","collateralCode":"Boats","loanTypeCode":"Marine Establishments","productCode":"Marine Establishments - East","purposeCode":"Business expansion","industryCode":"110210","classCode":"B - Corporation","adjustableInterestRate":true,"loanTerm":60,"dayCountConvention":"c_Actual_365","amortizedOver":null,"isDeleted":false,"status":"approved","createdDate":null,"statusLastUpdatedDate":null,"probabilityOfClosing":0.74,"projectedClosingDate":null,"totalFees":500.0,"otherFees":500.0,"expectedUtilizationRate":0.25,"originationExpenses":200.0,"overheadExpenses":200.0,"upfrontFee":100.0,"annualFee":100.0,"unusedCommitmentFee":100.0,"servicingExpenses":200.0,"floorRate":0.03,"indexRateDescription":"lIBOR","indexRate":0.02,"spread":0.02,"ceilingRate":0.25,"proposedLoanStageId":null,"proposedProductsId":null,"evaluatedCreditScore":null,"bankCodeBranch":"123Abc","denialOrWithdrawalReason":null,"denialOrWithdrawalReasons":null,"loanTypeForDenialOrWithdrawal":null,"statusReason":null,"firstPaymentDate":null,"firstInterestPaymentDate":null,"isSubjectToRegO":null,"isTakedownLoan":null,"isGuidanceLineOfCredit":null,"noteDate":"2026-07-15","maturityDate":null,"repricingDate":null,"disbursementDate":"2026-07-17","discountPointsDollarAmount":null,"includeNegativeAmortization":null,"brokerCompensationPercent":null,"lenderCredits":null,"introductionRatePeriodInMonths":null,"pointsAndFees":null,"isPreapprovalRequested":null,"isReverseMortgage":null,"rateLockDate":null,"cdChangeOfCircumstanceDate":null,"rescissionDate":null,"leChangeOfCircumstanceDate":null,"includeOtherNonAmortizingFeatures":null,"ecoaAdverseAction1":null,"ecoaAdverseAction2":null,"ecoaAdverseAction3":null,"hmdaLoanType":null,"hmdaLoanPurposeType":null,"hmdaPurchaserType":null,"hmdaFinalActionTakenType":null,"craLoanType":null,"craLoanPurposeType":null,"hmdaAmortizationType":null,"hmdaHoepaStatusType":null,"craRevenueCodeType":null,"interestOnlyTerm":60,"interestOnlyPaymentFrequency":null,"participationType":"lead","accountType":null,"parentIsProposed":null,"parentLoansId":null,"lossGivenDefaultRiskRating":null,"probabilityOfDefaultRiskRating":null,"withheldAmount":100000.0,"institutionAvailableCredit":0.0,"institutionWithheld":50000.0,"participatedAmount":60000.0,"userDefinedString1":"Commercial","userDefinedString2":"Fixed Rate","userDefinedString3":"","userDefinedString4":"","userDefinedString5":"","userDefinedString6":"","userDefinedString7":"Another User Defined Value","userDefinedString8":"","userDefinedString9":"","userDefinedString10":"","userDefinedString11":"","userDefinedString12":"","userDefinedString13":"","userDefinedString14":"","userDefinedString15":"","userDefinedString16":"","userDefinedString17":"","userDefinedString18":"","userDefinedString19":"","userDefinedString20":"","userDefinedNumber1":13.77,"userDefinedNumber2":1044.0,"userDefinedNumber3":0.0045,"userDefinedNumber4":7.0,"userDefinedNumber5":7.0,"userDefinedNumber6":7.0,"userDefinedNumber7":7.0,"userDefinedNumber8":7.0,"userDefinedNumber9":7.0,"userDefinedNumber10":7.0,"userDefinedNumber11":7.0,"userDefinedNumber12":7.0,"userDefinedNumber13":7.0,"userDefinedNumber14":7.0,"userDefinedNumber15":7.0,"userDefinedNumber16":7.0,"userDefinedNumber17":7.0,"userDefinedNumber18":7.0,"userDefinedNumber19":7.0,"userDefinedNumber20":7.0,"userDefinedDate1":"2026-07-16","userDefinedDate2":"2026-07-15","userDefinedDate3":null,"userDefinedDate4":null,"userDefinedDate5":null,"userDefinedDate6":null,"userDefinedDate7":null,"userDefinedDate8":null,"userDefinedDate9":null,"userDefinedDate10":null,"userDefinedFields":null,"comments":null,"purpose":null,"loanBoardingIdentifier":"11111","creditRating":null,"glCostCenter":null,"prepaymentPenaltyCode":null,"originationFee":null,"crmIdentifier":null,"riskRatingId":null,"tridApplicationDate":null,"intentToProceedDate":null,"consummationDate":null,"leIssueDate":null,"leRequiredDate":null,"cdRequiredDate":null,"cdIssueDate":null,"cdReissueDate":null,"leReissueDate":null,"closingCostExpirationDate":null,"rateLockExpirationDate":null,"fundingDate":null,"earliestTridCloseDate":null,"mortgageRateLockDate":null,"balloonPayment":null,"hasSecondaryRate":false,"secondaryCeilingRate":null,"secondaryIndexRate":null,"secondaryFloorRate":null,"secondaryInterestRate":null,"secondaryAdjustableInterestRate":null,"secondaryIndexRateDescription":null,"secondaryTypeOfPaymentAdjustment":"higherInstallmentAmount","secondaryRepriceFrequencyInterval":null,"secondaryRepriceFrequencyUnits":null,"secondarySpread":null,"termBeforeSecondaryRate":1,"requestType":null,"repriceFrequencyInterval":60,"repriceFrequencyUnits":"quarterly","statusChangedByUsersID":null},{"id":456123,"loanId":1235141,"loanName":"Start Up Loan","customerId":784565412,"loanAmount":100000.0,"riskRating":2,"paymentAmount":94562.24,"paymentFrequency":"quarterly","paymentType":"revolvingLineOfCredit","loanOfficerId":7845621,"interestRate":0.099,"callCode":"1a1","collateralCode":"Vehicles","loanTypeCode":"User Car Lots","productCode":"Used Car Lots - OO","purposeCode":"Business expansion","industryCode":"110210","classCode":"B - Corporation","adjustableInterestRate":false,"loanTerm":20,"dayCountConvention":"c_30_365","amortizedOver":null,"isDeleted":false,"status":"approved","createdDate":null,"statusLastUpdatedDate":null,"probabilityOfClosing":0.88,"projectedClosingDate":null,"totalFees":500.0,"otherFees":500.0,"expectedUtilizationRate":0.25,"originationExpenses":200.0,"overheadExpenses":200.0,"upfrontFee":100.0,"annualFee":100.0,"unusedCommitmentFee":100.0,"servicingExpenses":200.0,"floorRate":0.03,"indexRateDescription":"treasury","indexRate":0.02,"spread":0.02,"ceilingRate":0.25,"proposedLoanStageId":null,"proposedProductsId":null,"evaluatedCreditScore":null,"bankCodeBranch":null,"denialOrWithdrawalReason":null,"denialOrWithdrawalReasons":null,"loanTypeForDenialOrWithdrawal":null,"statusReason":null,"firstPaymentDate":null,"firstInterestPaymentDate":null,"isSubjectToRegO":null,"isTakedownLoan":null,"isGuidanceLineOfCredit":null,"noteDate":"2026-07-14","maturityDate":null,"repricingDate":null,"disbursementDate":"2026-07-18","discountPointsDollarAmount":null,"includeNegativeAmortization":null,"brokerCompensationPercent":null,"lenderCredits":null,"introductionRatePeriodInMonths":null,"pointsAndFees":null,"isPreapprovalRequested":null,"isReverseMortgage":null,"rateLockDate":null,"cdChangeOfCircumstanceDate":null,"rescissionDate":null,"leChangeOfCircumstanceDate":null,"includeOtherNonAmortizingFeatures":null,"ecoaAdverseAction1":null,"ecoaAdverseAction2":null,"ecoaAdverseAction3":null,"hmdaLoanType":null,"hmdaLoanPurposeType":null,"hmdaPurchaserType":null,"hmdaFinalActionTakenType":null,"craLoanType":null,"craLoanPurposeType":null,"hmdaAmortizationType":null,"hmdaHoepaStatusType":null,"craRevenueCodeType":null,"interestOnlyTerm":65,"interestOnlyPaymentFrequency":null,"participationType":"participant","accountType":null,"parentIsProposed":null,"parentLoansId":null,"lossGivenDefaultRiskRating":null,"probabilityOfDefaultRiskRating":null,"withheldAmount":0.0,"institutionAvailableCredit":0.0,"institutionWithheld":0.0,"participatedAmount":0.0,"userDefinedString1":"Commercial","userDefinedString2":"Fixed Rate","userDefinedString3":"","userDefinedString4":"","userDefinedString5":"","userDefinedString6":"","userDefinedString7":"Another User Defined Value","userDefinedString8":"","userDefinedString9":"","userDefinedString10":"","userDefinedString11":"","userDefinedString12":"","userDefinedString13":"","userDefinedString14":"","userDefinedString15":"","userDefinedString16":"","userDefinedString17":"","userDefinedString18":"","userDefinedString19":"","userDefinedString20":"","userDefinedNumber1":13.77,"userDefinedNumber2":1044.0,"userDefinedNumber3":0.0045,"userDefinedNumber4":7.0,"userDefinedNumber5":7.0,"userDefinedNumber6":7.0,"userDefinedNumber7":7.0,"userDefinedNumber8":7.0,"userDefinedNumber9":7.0,"userDefinedNumber10":7.0,"userDefinedNumber11":7.0,"userDefinedNumber12":7.0,"userDefinedNumber13":7.0,"userDefinedNumber14":7.0,"userDefinedNumber15":7.0,"userDefinedNumber16":7.0,"userDefinedNumber17":7.0,"userDefinedNumber18":7.0,"userDefinedNumber19":7.0,"userDefinedNumber20":7.0,"userDefinedDate1":"2026-07-16","userDefinedDate2":"2026-07-15","userDefinedDate3":null,"userDefinedDate4":null,"userDefinedDate5":null,"userDefinedDate6":null,"userDefinedDate7":null,"userDefinedDate8":null,"userDefinedDate9":null,"userDefinedDate10":null,"userDefinedFields":null,"comments":null,"purpose":null,"loanBoardingIdentifier":"22222","creditRating":null,"glCostCenter":null,"prepaymentPenaltyCode":null,"originationFee":null,"crmIdentifier":null,"riskRatingId":null,"tridApplicationDate":null,"intentToProceedDate":null,"consummationDate":null,"leIssueDate":null,"leRequiredDate":null,"cdRequiredDate":null,"cdIssueDate":null,"cdReissueDate":null,"leReissueDate":null,"closingCostExpirationDate":null,"rateLockExpirationDate":null,"fundingDate":null,"earliestTridCloseDate":null,"mortgageRateLockDate":null,"balloonPayment":null,"hasSecondaryRate":false,"secondaryCeilingRate":null,"secondaryIndexRate":null,"secondaryFloorRate":null,"secondaryInterestRate":null,"secondaryAdjustableInterestRate":null,"secondaryIndexRateDescription":null,"secondaryTypeOfPaymentAdjustment":"higherInstallmentAmount","secondaryRepriceFrequencyInterval":null,"secondaryRepriceFrequencyUnits":null,"secondarySpread":null,"termBeforeSecondaryRate":1,"requestType":null,"repriceFrequencyInterval":60,"repriceFrequencyUnits":"quarterly","statusChangedByUsersID":null},null,{"id":9876543,"loanId":346676,"loanName":"Start Up Loan2","customerId":784565412,"loanAmount":100000.0,"riskRating":2,"paymentAmount":94562.24,"paymentFrequency":"quarterly","paymentType":"revolvingLineOfCredit","loanOfficerId":7845621,"interestRate":0.099,"callCode":"1a1","collateralCode":"Vehicles","loanTypeCode":"User Car Lots","productCode":"Used Car Lots - OO","purposeCode":"Business expansion","industryCode":"110210","classCode":"B - Corporation","adjustableInterestRate":false,"loanTerm":20,"dayCountConvention":"c_30_365","amortizedOver":null,"isDeleted":false,"status":"approved","createdDate":null,"statusLastUpdatedDate":null,"probabilityOfClosing":0.88,"projectedClosingDate":null,"totalFees":500.0,"otherFees":500.0,"expectedUtilizationRate":0.25,"originationExpenses":200.0,"overheadExpenses":200.0,"upfrontFee":100.0,"annualFee":100.0,"unusedCommitmentFee":100.0,"servicingExpenses":200.0,"floorRate":0.03,"indexRateDescription":"treasury","indexRate":0.02,"spread":0.02,"ceilingRate":0.25,"proposedLoanStageId":null,"proposedProductsId":null,"evaluatedCreditScore":null,"bankCodeBranch":null,"denialOrWithdrawalReason":null,"denialOrWithdrawalReasons":null,"loanTypeForDenialOrWithdrawal":null,"statusReason":null,"firstPaymentDate":null,"firstInterestPaymentDate":null,"isSubjectToRegO":null,"isTakedownLoan":null,"isGuidanceLineOfCredit":null,"noteDate":"2026-07-12","maturityDate":null,"repricingDate":null,"disbursementDate":"2026-07-20","discountPointsDollarAmount":null,"includeNegativeAmortization":null,"brokerCompensationPercent":null,"lenderCredits":null,"introductionRatePeriodInMonths":null,"pointsAndFees":null,"isPreapprovalRequested":null,"isReverseMortgage":null,"rateLockDate":null,"cdChangeOfCircumstanceDate":null,"rescissionDate":null,"leChangeOfCircumstanceDate":null,"includeOtherNonAmortizingFeatures":null,"ecoaAdverseAction1":null,"ecoaAdverseAction2":null,"ecoaAdverseAction3":null,"hmdaLoanType":null,"hmdaLoanPurposeType":null,"hmdaPurchaserType":null,"hmdaFinalActionTakenType":null,"craLoanType":null,"craLoanPurposeType":null,"hmdaAmortizationType":null,"hmdaHoepaStatusType":null,"craRevenueCodeType":null,"interestOnlyTerm":null,"interestOnlyPaymentFrequency":null,"participationType":"na","accountType":null,"parentIsProposed":null,"parentLoansId":null,"lossGivenDefaultRiskRating":null,"probabilityOfDefaultRiskRating":null,"withheldAmount":null,"institutionAvailableCredit":null,"institutionWithheld":null,"participatedAmount":null,"userDefinedString1":"Commercial","userDefinedString2":"Fixed Rate","userDefinedString3":"","userDefinedString4":"","userDefinedString5":"","userDefinedString6":"","userDefinedString7":"Another User Defined Value","userDefinedString8":"","userDefinedString9":"","userDefinedString10":"","userDefinedString11":"","userDefinedString12":"","userDefinedString13":"","userDefinedString14":"","userDefinedString15":"","userDefinedString16":"","userDefinedString17":"","userDefinedString18":"","userDefinedString19":"","userDefinedString20":"","userDefinedNumber1":13.77,"userDefinedNumber2":1044.0,"userDefinedNumber3":0.0045,"userDefinedNumber4":7.0,"userDefinedNumber5":7.0,"userDefinedNumber6":7.0,"userDefinedNumber7":7.0,"userDefinedNumber8":7.0,"userDefinedNumber9":7.0,"userDefinedNumber10":7.0,"userDefinedNumber11":7.0,"userDefinedNumber12":7.0,"userDefinedNumber13":7.0,"userDefinedNumber14":7.0,"userDefinedNumber15":7.0,"userDefinedNumber16":7.0,"userDefinedNumber17":7.0,"userDefinedNumber18":7.0,"userDefinedNumber19":7.0,"userDefinedNumber20":7.0,"userDefinedDate1":"2026-07-16","userDefinedDate2":"2026-07-15","userDefinedDate3":null,"userDefinedDate4":null,"userDefinedDate5":null,"userDefinedDate6":null,"userDefinedDate7":null,"userDefinedDate8":null,"userDefinedDate9":null,"userDefinedDate10":null,"userDefinedFields":null,"comments":null,"purpose":null,"loanBoardingIdentifier":"33333","creditRating":null,"glCostCenter":null,"prepaymentPenaltyCode":null,"originationFee":null,"crmIdentifier":null,"riskRatingId":null,"tridApplicationDate":null,"intentToProceedDate":null,"consummationDate":null,"leIssueDate":null,"leRequiredDate":null,"cdRequiredDate":null,"cdIssueDate":null,"cdReissueDate":null,"leReissueDate":null,"closingCostExpirationDate":null,"rateLockExpirationDate":null,"fundingDate":null,"earliestTridCloseDate":null,"mortgageRateLockDate":null,"balloonPayment":null,"hasSecondaryRate":false,"secondaryCeilingRate":null,"secondaryIndexRate":null,"secondaryFloorRate":null,"secondaryInterestRate":null,"secondaryAdjustableInterestRate":null,"secondaryIndexRateDescription":null,"secondaryTypeOfPaymentAdjustment":"higherInstallmentAmount","secondaryRepriceFrequencyInterval":null,"secondaryRepriceFrequencyUnits":null,"secondarySpread":null,"termBeforeSecondaryRate":null,"requestType":null,"repriceFrequencyInterval":null,"repriceFrequencyUnits":null,"statusChangedByUsersID":null}],"errors":{"2":{"errorType":"invalidRequest","message":"Input model for request is invalid","modelErrors":[{"propertyName":"loanName","message":"loanName is required"}]}}} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "CreateProposedLoans" ] } ] } }, "/v1/proposed-loans/{id}": { "get": { "tags": [ "Proposed Loans" ], "summary": "Gets a proposed loan by id", "operationId": "GetById", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "id of the proposed loan to get", "required": true, "type": "integer", "format": "int32" }, { "in": "query", "name": "includeUserDefinedFields", "description": "Include User Defined fields in the response", "type": "boolean", "default": false, "x-nullable": true } ], "responses": { "200": { "description": "Gets the proposed loan with the specified id", "schema": { "$ref": "#/definitions/ProposedLoan" }, "examples": { "application/json": {"paymentType":"fixedPayment","customerId":123456987,"riskRating":3,"adjustableInterestRate":true,"callCode":"1e1","collateralCode":"Boats","dayCountConvention":"c_Actual_365","interestRate":0.079,"isDeleted":false,"loanAmount":798550,"loanName":"70045698","loanOfficerId":12345778,"loanTerm":60,"loanTypeCode":"Marine Establishments","paymentAmount":27000,"paymentFrequency":"quarterly","productCode":"Marine Establishments - East","purposeCode":"Business expansion","industryCode":"110210","status":"approved","totalFees":500,"otherFees":500,"expectedUtilizationRate":0.25,"upfrontFee":100,"annualFee":100,"unusedCommitmentFee":100,"originationExpenses":200,"overheadExpenses":200,"servicingExpenses":200,"floorRate":0.03,"spread":0.02,"indexRate":0.02,"indexRateDescription":"libor","ceilingRate":0.25,"bankCodeBranch":"123Abc","interestOnlyTerm":60,"lossGivenDefaultRiskRating":"2","probabilityOfDefaultRiskRating":6.7,"purpose":"Purpose","comments":"Comments","userDefinedString1":"Commercial","userDefinedString2":"Fixed Rate","userDefinedString3":"","userDefinedString4":"","userDefinedString5":"","userDefinedString6":"","userDefinedString7":"Another User Defined Value","userDefinedString8":"","userDefinedString9":"","userDefinedString10":"","userDefinedString11":"","userDefinedString12":"","userDefinedString13":"","userDefinedString14":"","userDefinedString15":"","userDefinedString16":"","userDefinedString17":"","userDefinedString18":"","userDefinedString19":"","userDefinedString20":"","userDefinedNumber1":13.77,"userDefinedNumber2":1044,"userDefinedNumber3":0.0045,"userDefinedNumber4":7,"userDefinedNumber5":7,"userDefinedNumber6":7,"userDefinedNumber7":7,"userDefinedNumber8":7,"userDefinedNumber9":7,"userDefinedNumber10":7,"userDefinedNumber11":7,"userDefinedNumber12":7,"userDefinedNumber13":7,"userDefinedNumber14":7,"userDefinedNumber15":7,"userDefinedNumber16":7,"userDefinedNumber17":7,"userDefinedNumber18":7,"userDefinedNumber19":7,"userDefinedNumber20":7,"userDefinedDate1":"2026-07-16","userDefinedDate2":"2026-07-15","userDefinedDate3":"2026-07-16","userDefinedDate4":"2026-07-16","userDefinedDate5":"2026-07-16","userDefinedDate6":"2026-07-16","userDefinedDate7":"2026-07-16","userDefinedDate8":"2026-07-16","userDefinedDate9":"2026-07-16","userDefinedDate10":"2026-07-16","parentLoansId":56789,"parentIsProposed":true,"accountType":"loan","withheldAmount":350000} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "ReadProposedLoans" ] } ] }, "patch": { "tags": [ "Proposed Loans" ], "summary": "Updates a proposed loan", "operationId": "Update", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "id of the existing proposed loan to update", "required": true, "type": "integer", "format": "int32" }, { "in": "body", "name": "body", "description": "The proposed loan values to update", "schema": { "$ref": "#/definitions/ProposedLoan" } } ], "responses": { "200": { "description": "Returns the modified proposed loan", "schema": { "$ref": "#/definitions/ProposedLoan" }, "examples": { "application/json": {"id":84851632,"loanId":1235141,"loanName":"70045698","customerId":123456987,"loanAmount":798550.0,"riskRating":3,"paymentAmount":27000.0,"paymentFrequency":"quarterly","paymentType":"fixedPayment","loanOfficerId":12345778,"interestRate":0.079,"callCode":"1e1","collateralCode":"Boats","loanTypeCode":"Marine Establishments","productCode":"Marine Establishments - East","purposeCode":"Business expansion","industryCode":"110210","classCode":"B - Corporation","adjustableInterestRate":true,"loanTerm":60,"dayCountConvention":"c_Actual_365","amortizedOver":null,"isDeleted":false,"status":"approved","createdDate":null,"statusLastUpdatedDate":null,"probabilityOfClosing":0.74,"projectedClosingDate":null,"totalFees":500.0,"otherFees":500.0,"expectedUtilizationRate":0.25,"originationExpenses":200.0,"overheadExpenses":200.0,"upfrontFee":100.0,"annualFee":100.0,"unusedCommitmentFee":100.0,"servicingExpenses":200.0,"floorRate":0.03,"indexRateDescription":"lIBOR","indexRate":0.02,"spread":0.02,"ceilingRate":0.25,"proposedLoanStageId":null,"proposedProductsId":null,"evaluatedCreditScore":null,"bankCodeBranch":"123Abc","denialOrWithdrawalReason":null,"denialOrWithdrawalReasons":null,"loanTypeForDenialOrWithdrawal":null,"statusReason":null,"firstPaymentDate":null,"firstInterestPaymentDate":null,"isSubjectToRegO":null,"isTakedownLoan":null,"isGuidanceLineOfCredit":null,"noteDate":"2026-07-12","maturityDate":"2031-07-16","repricingDate":"2027-07-16","disbursementDate":"2026-07-20","discountPointsDollarAmount":null,"includeNegativeAmortization":null,"brokerCompensationPercent":null,"lenderCredits":null,"introductionRatePeriodInMonths":null,"pointsAndFees":null,"isPreapprovalRequested":null,"isReverseMortgage":null,"rateLockDate":null,"cdChangeOfCircumstanceDate":null,"rescissionDate":null,"leChangeOfCircumstanceDate":null,"includeOtherNonAmortizingFeatures":null,"ecoaAdverseAction1":null,"ecoaAdverseAction2":null,"ecoaAdverseAction3":null,"hmdaLoanType":null,"hmdaLoanPurposeType":null,"hmdaPurchaserType":null,"hmdaFinalActionTakenType":null,"craLoanType":null,"craLoanPurposeType":null,"hmdaAmortizationType":null,"hmdaHoepaStatusType":null,"craRevenueCodeType":null,"interestOnlyTerm":null,"interestOnlyPaymentFrequency":null,"participationType":"na","accountType":"loan","parentIsProposed":true,"parentLoansId":56789,"lossGivenDefaultRiskRating":"2","probabilityOfDefaultRiskRating":6.7,"withheldAmount":null,"institutionAvailableCredit":null,"institutionWithheld":null,"participatedAmount":null,"userDefinedString1":"Commercial","userDefinedString2":"Fixed Rate","userDefinedString3":"","userDefinedString4":"","userDefinedString5":"","userDefinedString6":"","userDefinedString7":"Another User Defined Value","userDefinedString8":"","userDefinedString9":"","userDefinedString10":"","userDefinedString11":"","userDefinedString12":"","userDefinedString13":"","userDefinedString14":"","userDefinedString15":"","userDefinedString16":"","userDefinedString17":"","userDefinedString18":"","userDefinedString19":"","userDefinedString20":"","userDefinedNumber1":13.77,"userDefinedNumber2":1044.0,"userDefinedNumber3":0.0045,"userDefinedNumber4":7.0,"userDefinedNumber5":7.0,"userDefinedNumber6":7.0,"userDefinedNumber7":7.0,"userDefinedNumber8":7.0,"userDefinedNumber9":7.0,"userDefinedNumber10":7.0,"userDefinedNumber11":7.0,"userDefinedNumber12":7.0,"userDefinedNumber13":7.0,"userDefinedNumber14":7.0,"userDefinedNumber15":7.0,"userDefinedNumber16":7.0,"userDefinedNumber17":7.0,"userDefinedNumber18":7.0,"userDefinedNumber19":7.0,"userDefinedNumber20":7.0,"userDefinedDate1":"2026-07-16","userDefinedDate2":"2026-07-15","userDefinedDate3":null,"userDefinedDate4":null,"userDefinedDate5":null,"userDefinedDate6":null,"userDefinedDate7":null,"userDefinedDate8":null,"userDefinedDate9":null,"userDefinedDate10":null,"userDefinedFields":null,"comments":null,"purpose":null,"loanBoardingIdentifier":"11111","creditRating":null,"glCostCenter":null,"prepaymentPenaltyCode":null,"originationFee":null,"crmIdentifier":null,"riskRatingId":null,"tridApplicationDate":null,"intentToProceedDate":null,"consummationDate":null,"leIssueDate":null,"leRequiredDate":null,"cdRequiredDate":null,"cdIssueDate":null,"cdReissueDate":null,"leReissueDate":null,"closingCostExpirationDate":null,"rateLockExpirationDate":null,"fundingDate":null,"earliestTridCloseDate":null,"mortgageRateLockDate":null,"balloonPayment":null,"hasSecondaryRate":false,"secondaryCeilingRate":null,"secondaryIndexRate":null,"secondaryFloorRate":null,"secondaryInterestRate":null,"secondaryAdjustableInterestRate":null,"secondaryIndexRateDescription":null,"secondaryTypeOfPaymentAdjustment":"higherInstallmentAmount","secondaryRepriceFrequencyInterval":null,"secondaryRepriceFrequencyUnits":null,"secondarySpread":null,"termBeforeSecondaryRate":null,"requestType":null,"repriceFrequencyInterval":null,"repriceFrequencyUnits":null,"statusChangedByUsersID":null} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "UpdateProposedLoans" ] } ] }, "delete": { "tags": [ "Proposed Loans" ], "summary": "Deletes a proposed loan by id", "operationId": "Delete", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "id of the existing proposed loan to delete", "required": true, "type": "integer", "format": "int32" } ], "responses": { "204": { "description": "The proposed loan has been deleted successfully." }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "DeleteProposedLoans" ] } ] } }, "/v1/proposed-loans/crm-identifier/{crmIdentifier}": { "get": { "tags": [ "Proposed Loans" ], "summary": "Gets a proposed loan by crm identifier", "operationId": "GetByCrmIdentifier", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "crmIdentifier", "required": true, "type": "string" } ], "responses": { "200": { "description": "Gets the proposed loan with the specified crm identifier", "schema": { "$ref": "#/definitions/ProposedLoan" }, "examples": { "application/json": {"paymentType":"fixedPayment","customerId":123456987,"riskRating":3,"adjustableInterestRate":true,"callCode":"1e1","collateralCode":"Boats","dayCountConvention":"c_Actual_365","interestRate":0.079,"isDeleted":false,"loanAmount":798550,"loanName":"70045698","loanOfficerId":12345778,"loanTerm":60,"loanTypeCode":"Marine Establishments","paymentAmount":27000,"paymentFrequency":"quarterly","productCode":"Marine Establishments - East","purposeCode":"Business expansion","industryCode":"110210","status":"approved","totalFees":500,"otherFees":500,"expectedUtilizationRate":0.25,"upfrontFee":100,"annualFee":100,"unusedCommitmentFee":100,"originationExpenses":200,"overheadExpenses":200,"servicingExpenses":200,"floorRate":0.03,"spread":0.02,"indexRate":0.02,"indexRateDescription":"libor","ceilingRate":0.25,"bankCodeBranch":"123Abc","interestOnlyTerm":60,"lossGivenDefaultRiskRating":"2","probabilityOfDefaultRiskRating":6.7,"purpose":"Purpose","comments":"Comments","userDefinedString1":"Commercial","userDefinedString2":"Fixed Rate","userDefinedString3":"","userDefinedString4":"","userDefinedString5":"","userDefinedString6":"","userDefinedString7":"Another User Defined Value","userDefinedString8":"","userDefinedString9":"","userDefinedString10":"","userDefinedString11":"","userDefinedString12":"","userDefinedString13":"","userDefinedString14":"","userDefinedString15":"","userDefinedString16":"","userDefinedString17":"","userDefinedString18":"","userDefinedString19":"","userDefinedString20":"","userDefinedNumber1":13.77,"userDefinedNumber2":1044,"userDefinedNumber3":0.0045,"userDefinedNumber4":7,"userDefinedNumber5":7,"userDefinedNumber6":7,"userDefinedNumber7":7,"userDefinedNumber8":7,"userDefinedNumber9":7,"userDefinedNumber10":7,"userDefinedNumber11":7,"userDefinedNumber12":7,"userDefinedNumber13":7,"userDefinedNumber14":7,"userDefinedNumber15":7,"userDefinedNumber16":7,"userDefinedNumber17":7,"userDefinedNumber18":7,"userDefinedNumber19":7,"userDefinedNumber20":7,"userDefinedDate1":"2026-07-16","userDefinedDate2":"2026-07-15","userDefinedDate3":"2026-07-16","userDefinedDate4":"2026-07-16","userDefinedDate5":"2026-07-16","userDefinedDate6":"2026-07-16","userDefinedDate7":"2026-07-16","userDefinedDate8":"2026-07-16","userDefinedDate9":"2026-07-16","userDefinedDate10":"2026-07-16","parentLoansId":56789,"parentIsProposed":true,"accountType":"loan","withheldAmount":350000} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "ReadProposedLoans" ] } ] } }, "/v1/proposed-loans/update-status": { "patch": { "tags": [ "Proposed Loans" ], "summary": "Updates a proposed loan's status", "operationId": "UpdateStatus", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "userId", "description": "The user id on which status updates should be made on behalf of", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "body", "name": "body", "description": "The status updates to perform", "schema": { "$ref": "#/definitions/ProposedLoanStatusUpdates" } } ], "responses": { "200": { "description": "Returns 200 if the status update was successful" }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "UpdateProposedLoanStatus" ] } ] } }, "/v1/proposed-loans/generate-loan-number/{proposedBankLoanId}": { "post": { "tags": [ "Proposed Loans" ], "operationId": "GenerateNewLoanBoardingIdentifier", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "proposedBankLoanId", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/GenerateLoanBoardingIdentifierResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] } }, "/v1/collaterals": { "get": { "tags": [ "Collaterals" ], "summary": "Gets all collaterals", "operationId": "GetPaged", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "page", "description": "The page number of results to retrieve (first page = 1, default = 1)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "perPage", "description": "The number of records to return on each page (minimum = 1, maximum = 1000, default = 200)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "customerId", "description": "ID of the customer that pledged the collateral", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "isReadyForAppraisal", "description": "Whether this collateral is ready for appraisal", "type": "boolean", "x-nullable": true }, { "in": "query", "name": "dateAppraisalRequestedStartDate", "description": "The start of the date range to be used when doing a date range query.Use the format yyyy-MM-dd. This date is inclusive.", "type": "string", "format": "date-time", "x-nullable": true }, { "in": "query", "name": "dateAppraisalRequestedEndDate", "description": "The end of the date range to be used when doing a date range query. Use the format yyyy-MM-dd. This date is inclusive.", "type": "string", "format": "date-time", "x-nullable": true }, { "in": "query", "name": "collateralIdentifier", "description": "Identifier for the collateral", "type": "string" }, { "in": "query", "name": "collateralMetadataType", "description": "The type of collateral to filter by. Ex: proposed, existing, archive, etc.", "type": "string", "enum": [ "existing", "proposed", "savedCopy", "archive" ], "x-nullable": true }, { "in": "query", "name": "includeUserDefinedFields", "description": "Include User Defined fields in the response", "type": "boolean", "default": false, "x-nullable": true }, { "in": "query", "name": "excludeCollateralForDeletedCustomers", "description": "Set to true to ensure the collateral returned are not linked to deleted customer", "type": "boolean", "default": false } ], "responses": { "200": { "description": "Gets all current, existing, and active collateral in the account", "schema": { "$ref": "#/definitions/CollectionResponse[Collateral]" }, "examples": { "application/json": {"items":[{"id":45613213,"description":"45687 Walker Ave","currentValue":1250000.0,"mostRecentAppraisalValue":1250000.0,"mostRecentAppraisalDate":"2026-04-16","collateralCode":"330","collateralType":"RealEstate","mileage":null,"equipmentYear":null,"equipmentManufacturer":null,"customerId":48561333,"originalValue":990000.0,"discountRate":0.2,"isDeleted":false,"propertyAddress":"123 Main Street","propertyCity":"New York","propertyState":"NY","propertyZip":"11111","propertyCounty":"New York","propertyTaxID":"123456789","make":"Ford","vin":"1XHDN34343DKSDGDHEEA45","model":"Fusion","year":"2020","bodyStyle":"sedan","serialNumber":"3409594548354543","manufacturer":"","aircraftNumber":"12345","vesselName":"Test Vessel","vesselNumber":"12345","possessoryType":"savings","accountLOCNumber":"5555555","issuedBy":"lender","issuer":"Lender 1234","shares":1,"cusip":"123456789","heldBy":"other","beneficiary":"Beneficiary XYZ","letterOfCreditDate":"2013-01-24","govtContractNumber":"34798445854","govtContractDate":"2018-05-06","titledType":"unknown","floodDeterminationDate":"2017-05-02","specialFloodHazardArea":0,"capitalizationRate":1234.0,"isLOMC":true,"collateralBreakout":null,"cbraAndOPADesignationDate":"2016-09-07","dwelling":"principal","vesselLength":32,"floodZone":"a","floodZoneCode":"","floodProgramType":false,"isLandImprovements":false,"lomcCaseNumber":"123467","lomcDate":"2017-04-05","nfipMapNumber":"12345","nfipMapPanelDate":"2015-09-10","nfipCommunityName":"Community Name","nfipCommunityNumber":"3465656754","nfipPropertyDescription":"Test Property","constructionMethod":"siteBuilt","manufacturedHomeType":"notApplicable","manufacturedHomeLandPropertyInterest":"notApplicable","totalUnits":1,"multiFamilyAffordableUnits":"","occupancyType":"principalResidence","isForAgriculturalPurpose":false,"isOwnerOccupied":true,"isSecondHome":false,"isProtectedArea":false,"stateCode":12,"countyCode":"123","tractCode":"3453","latitude":41.947630,"longitude":-87.656376,"metropolitanStatisticalArea":16980,"medianHouseholdIncome":107250.0,"metropolitanDivision":"Chicago-Naperville-Evanston, IL","metropolitanDivisionCode":"1234242","userDefinedFields":{"User Defined Text":"test 123","User Defined Numeric":"54","User Defined Currency":"5454.0000","User Defined Percent":"4.54","User Defined Date":"3/12/2020 12:00:00 AM","User Defined Dropdown":"Yes","User Defined Yes No":"Yes"},"dateAppraisalRequested":null,"isReadyForAppraisal":null,"collateralMetadataType":"existing","collateralIdentifier":null,"legalDescription":null,"source":null,"comments":null,"coOwnerCustomerIds":null,"proposedAdjustmentComments":null,"includeInProposedScenario":null,"proposedCurrentValue":0.0,"proposedValueAdjustment":0.0},{"id":55613213,"description":"2015 Honda Odyssey","currentValue":32000.0,"mostRecentAppraisalValue":32000.0,"mostRecentAppraisalDate":"2025-12-16","collateralCode":"113","collateralType":"Vehicle","mileage":null,"equipmentYear":null,"equipmentManufacturer":null,"customerId":78561333,"originalValue":45000.0,"discountRate":0.3,"isDeleted":false,"propertyAddress":null,"propertyCity":null,"propertyState":null,"propertyZip":null,"propertyCounty":null,"propertyTaxID":null,"make":null,"vin":null,"model":null,"year":null,"bodyStyle":null,"serialNumber":null,"manufacturer":null,"aircraftNumber":null,"vesselName":null,"vesselNumber":null,"possessoryType":null,"accountLOCNumber":null,"issuedBy":null,"issuer":null,"shares":null,"cusip":null,"heldBy":null,"beneficiary":null,"letterOfCreditDate":null,"govtContractNumber":null,"govtContractDate":null,"titledType":"unknown","floodDeterminationDate":null,"specialFloodHazardArea":null,"capitalizationRate":0.0,"isLOMC":null,"collateralBreakout":null,"cbraAndOPADesignationDate":null,"dwelling":null,"vesselLength":null,"floodZone":null,"floodZoneCode":null,"floodProgramType":null,"isLandImprovements":null,"lomcCaseNumber":null,"lomcDate":null,"nfipMapNumber":null,"nfipMapPanelDate":null,"nfipCommunityName":null,"nfipCommunityNumber":null,"nfipPropertyDescription":null,"constructionMethod":null,"manufacturedHomeType":null,"manufacturedHomeLandPropertyInterest":null,"totalUnits":null,"multiFamilyAffordableUnits":null,"occupancyType":null,"isForAgriculturalPurpose":null,"isOwnerOccupied":null,"isSecondHome":null,"isProtectedArea":null,"stateCode":null,"countyCode":null,"tractCode":null,"latitude":null,"longitude":null,"metropolitanStatisticalArea":null,"medianHouseholdIncome":null,"metropolitanDivision":null,"metropolitanDivisionCode":null,"userDefinedFields":null,"dateAppraisalRequested":null,"isReadyForAppraisal":null,"collateralMetadataType":"existing","collateralIdentifier":"12345","legalDescription":null,"source":"Test","comments":"Comment ABC","coOwnerCustomerIds":null,"proposedAdjustmentComments":null,"includeInProposedScenario":null,"proposedCurrentValue":0.0,"proposedValueAdjustment":0.0}]} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "ReadCollaterals" ] } ] }, "post": { "tags": [ "Collaterals" ], "summary": "Creates a collateral", "operationId": "Create", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "The collateral to create", "schema": { "$ref": "#/definitions/Collateral" } } ], "responses": { "201": { "description": "The collateral has been created successfully. The collateral that was created\r\n is returned and has the Sageworks id that was assigned.", "schema": { "$ref": "#/definitions/Collateral" }, "examples": { "application/json": {"id":45613213,"description":"45687 Walker Ave","currentValue":1250000.0,"mostRecentAppraisalValue":1250000.0,"mostRecentAppraisalDate":"2026-04-16","collateralCode":"330","collateralType":"OtherRealEstate","mileage":null,"equipmentYear":null,"equipmentManufacturer":null,"customerId":48561333,"originalValue":990000.0,"discountRate":0.2,"isDeleted":false,"propertyAddress":"123 Main Street","propertyCity":"New York","propertyState":"NY","propertyZip":"11111","propertyCounty":"New York","propertyTaxID":"123456789","make":"Ford","vin":"1XHDN34343DKSDGDHEEA45","model":"Fusion","year":"2020","bodyStyle":"sedan","serialNumber":"3409594548354543","manufacturer":"","aircraftNumber":"12345","vesselName":"Test Vessel","vesselNumber":"12345","possessoryType":"savings","accountLOCNumber":"5555555","issuedBy":"lender","issuer":"Lender 1234","shares":1,"cusip":"123456789","heldBy":"other","beneficiary":"Beneficiary XYZ","letterOfCreditDate":"2016-09-06","govtContractNumber":"34798445854","govtContractDate":"2018-05-06","titledType":"unknown","floodDeterminationDate":"2017-09-02","specialFloodHazardArea":0,"capitalizationRate":1234.0,"isLOMC":true,"collateralBreakout":null,"cbraAndOPADesignationDate":"2015-10-06","dwelling":"principal","vesselLength":32,"floodZone":"a","floodZoneCode":"","floodProgramType":false,"isLandImprovements":false,"lomcCaseNumber":"123467","lomcDate":"2016-09-06","nfipMapNumber":"12345","nfipMapPanelDate":"2013-09-06","nfipCommunityName":"Community Name","nfipCommunityNumber":"3465656754","nfipPropertyDescription":"Test Property","constructionMethod":"siteBuilt","manufacturedHomeType":"notApplicable","manufacturedHomeLandPropertyInterest":"notApplicable","totalUnits":1,"multiFamilyAffordableUnits":"","occupancyType":"principalResidence","isForAgriculturalPurpose":false,"isOwnerOccupied":true,"isSecondHome":false,"isProtectedArea":false,"stateCode":12,"countyCode":"123","tractCode":"3453","latitude":41.947630,"longitude":-87.656376,"metropolitanStatisticalArea":16980,"medianHouseholdIncome":107250.0,"metropolitanDivision":"Chicago-Naperville-Evanston, IL","metropolitanDivisionCode":"1234242","userDefinedFields":{"User Defined Text":"test 123","User Defined Numeric":"54","User Defined Currency":"5454.0000","User Defined Percent":"4.54","User Defined Date":"3/12/2020 12:00:00 AM","User Defined Dropdown":"Yes","User Defined Yes No":"Yes"},"dateAppraisalRequested":"2021-01-07","isReadyForAppraisal":true,"collateralMetadataType":"existing","collateralIdentifier":null,"legalDescription":null,"source":"Test Source","comments":"Test Comments","coOwnerCustomerIds":null,"proposedAdjustmentComments":null,"includeInProposedScenario":null,"proposedCurrentValue":0.0,"proposedValueAdjustment":0.0} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "CreateCollaterals" ] } ] } }, "/v1/collaterals/basic-information": { "get": { "tags": [ "Collaterals" ], "summary": "Gets all collateral basic information", "operationId": "GetPagedBasicInformation", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "page", "description": "The page number of results to retrieve (first page = 1, default = 1)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "perPage", "description": "The number of records to return on each page (minimum = 1, maximum = 1000, default = 200)", "type": "integer", "format": "int32", "x-nullable": true } ], "responses": { "200": { "description": "Gets basic information for all current, existing, and active collateral in the account", "schema": { "$ref": "#/definitions/CollectionResponse[CollateralBasicInformation]" }, "examples": { "application/json": {"items":[{"id":45613213,"description":"45687 Walker Ave","customerId":48561333,"collateralCode":"330","collateralType":"RealEstate","isDeleted":false,"collateralIdentifier":"123456"},{"id":55613213,"description":"2015 Honda Odyssey","customerId":78561333,"collateralCode":"113","collateralType":"Vehicle","isDeleted":false,"collateralIdentifier":"789012"}]} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "ReadCollaterals" ] } ] } }, "/v1/collaterals/{id}": { "get": { "tags": [ "Collaterals" ], "summary": "Gets a collateral by id", "operationId": "GetById", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "id of the collateral to get", "required": true, "type": "integer", "format": "int32" }, { "in": "query", "name": "includeUserDefinedFields", "description": "Include User Defined fields in the response", "type": "boolean", "default": false, "x-nullable": true } ], "responses": { "200": { "description": "Gets the collateral with the specified id", "schema": { "$ref": "#/definitions/Collateral" }, "examples": { "application/json": {"id":45613213,"description":"45687 Walker Ave","currentValue":1250000.0,"mostRecentAppraisalValue":1250000.0,"mostRecentAppraisalDate":"2026-04-16","collateralCode":"330","collateralType":"OtherRealEstate","mileage":null,"equipmentYear":null,"equipmentManufacturer":null,"customerId":48561333,"originalValue":990000.0,"discountRate":0.2,"isDeleted":false,"propertyAddress":"123 Main Street","propertyCity":"New York","propertyState":"NY","propertyZip":"11111","propertyCounty":"New York","propertyTaxID":"123456789","make":"Ford","vin":"1XHDN34343DKSDGDHEEA45","model":"Fusion","year":"2020","bodyStyle":"sedan","serialNumber":"3409594548354543","manufacturer":"","aircraftNumber":"12345","vesselName":"Test Vessel","vesselNumber":"12345","possessoryType":"savings","accountLOCNumber":"5555555","issuedBy":"lender","issuer":"Lender 1234","shares":1,"cusip":"123456789","heldBy":"other","beneficiary":"Beneficiary XYZ","letterOfCreditDate":"2016-09-06","govtContractNumber":"34798445854","govtContractDate":"2018-05-06","titledType":"unknown","floodDeterminationDate":"2017-09-02","specialFloodHazardArea":0,"capitalizationRate":1234.0,"isLOMC":true,"collateralBreakout":null,"cbraAndOPADesignationDate":"2015-10-06","dwelling":"principal","vesselLength":32,"floodZone":"a","floodZoneCode":"","floodProgramType":false,"isLandImprovements":false,"lomcCaseNumber":"123467","lomcDate":"2016-09-06","nfipMapNumber":"12345","nfipMapPanelDate":"2013-09-06","nfipCommunityName":"Community Name","nfipCommunityNumber":"3465656754","nfipPropertyDescription":"Test Property","constructionMethod":"siteBuilt","manufacturedHomeType":"notApplicable","manufacturedHomeLandPropertyInterest":"notApplicable","totalUnits":1,"multiFamilyAffordableUnits":"","occupancyType":"principalResidence","isForAgriculturalPurpose":false,"isOwnerOccupied":true,"isSecondHome":false,"isProtectedArea":false,"stateCode":12,"countyCode":"123","tractCode":"3453","latitude":41.947630,"longitude":-87.656376,"metropolitanStatisticalArea":16980,"medianHouseholdIncome":107250.0,"metropolitanDivision":"Chicago-Naperville-Evanston, IL","metropolitanDivisionCode":"1234242","userDefinedFields":{"User Defined Text":"test 123","User Defined Numeric":"54","User Defined Currency":"5454.0000","User Defined Percent":"4.54","User Defined Date":"3/12/2020 12:00:00 AM","User Defined Dropdown":"Yes","User Defined Yes No":"Yes"},"dateAppraisalRequested":"2021-01-07","isReadyForAppraisal":true,"collateralMetadataType":"existing","collateralIdentifier":null,"legalDescription":null,"source":"Test Source","comments":"Test Comments","coOwnerCustomerIds":null,"proposedAdjustmentComments":null,"includeInProposedScenario":null,"proposedCurrentValue":0.0,"proposedValueAdjustment":0.0} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "ReadCollaterals" ] } ] }, "delete": { "tags": [ "Collaterals" ], "summary": "Deletes a collateral by id", "operationId": "Delete", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "id of the existing collateral to delete", "required": true, "type": "integer", "format": "int32" } ], "responses": { "204": { "description": "The collateral has been deleted successfully." }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "DeleteCollaterals" ] } ] }, "patch": { "tags": [ "Collaterals" ], "summary": "Updates a collateral", "operationId": "Update", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "id of the existing collateral to update", "required": true, "type": "integer", "format": "int32" }, { "in": "body", "name": "body", "description": "The collateral values to update", "schema": { "$ref": "#/definitions/Collateral" } } ], "responses": { "200": { "description": "Returns the modified collateral", "schema": { "$ref": "#/definitions/Collateral" }, "examples": { "application/json": {"id":45613213,"description":"45687 Walker Ave","currentValue":1250000.0,"mostRecentAppraisalValue":1250000.0,"mostRecentAppraisalDate":"2026-04-16","collateralCode":"330","collateralType":"OtherRealEstate","mileage":null,"equipmentYear":null,"equipmentManufacturer":null,"customerId":48561333,"originalValue":990000.0,"discountRate":0.2,"isDeleted":false,"propertyAddress":"123 Main Street","propertyCity":"New York","propertyState":"NY","propertyZip":"11111","propertyCounty":"New York","propertyTaxID":"123456789","make":"Ford","vin":"1XHDN34343DKSDGDHEEA45","model":"Fusion","year":"2020","bodyStyle":"sedan","serialNumber":"3409594548354543","manufacturer":"","aircraftNumber":"12345","vesselName":"Test Vessel","vesselNumber":"12345","possessoryType":"savings","accountLOCNumber":"5555555","issuedBy":"lender","issuer":"Lender 1234","shares":1,"cusip":"123456789","heldBy":"other","beneficiary":"Beneficiary XYZ","letterOfCreditDate":"2016-09-06","govtContractNumber":"34798445854","govtContractDate":"2018-05-06","titledType":"unknown","floodDeterminationDate":"2017-09-02","specialFloodHazardArea":0,"capitalizationRate":1234.0,"isLOMC":true,"collateralBreakout":null,"cbraAndOPADesignationDate":"2015-10-06","dwelling":"principal","vesselLength":32,"floodZone":"a","floodZoneCode":"","floodProgramType":false,"isLandImprovements":false,"lomcCaseNumber":"123467","lomcDate":"2016-09-06","nfipMapNumber":"12345","nfipMapPanelDate":"2013-09-06","nfipCommunityName":"Community Name","nfipCommunityNumber":"3465656754","nfipPropertyDescription":"Test Property","constructionMethod":"siteBuilt","manufacturedHomeType":"notApplicable","manufacturedHomeLandPropertyInterest":"notApplicable","totalUnits":1,"multiFamilyAffordableUnits":"","occupancyType":"principalResidence","isForAgriculturalPurpose":false,"isOwnerOccupied":true,"isSecondHome":false,"isProtectedArea":false,"stateCode":12,"countyCode":"123","tractCode":"3453","latitude":41.947630,"longitude":-87.656376,"metropolitanStatisticalArea":16980,"medianHouseholdIncome":107250.0,"metropolitanDivision":"Chicago-Naperville-Evanston, IL","metropolitanDivisionCode":"1234242","userDefinedFields":{"User Defined Text":"test 123","User Defined Numeric":"54","User Defined Currency":"5454.0000","User Defined Percent":"4.54","User Defined Date":"3/12/2020 12:00:00 AM","User Defined Dropdown":"Yes","User Defined Yes No":"Yes"},"dateAppraisalRequested":"2021-01-07","isReadyForAppraisal":true,"collateralMetadataType":"existing","collateralIdentifier":null,"legalDescription":null,"source":"Test Source","comments":"Test Comments","coOwnerCustomerIds":null,"proposedAdjustmentComments":null,"includeInProposedScenario":null,"proposedCurrentValue":0.0,"proposedValueAdjustment":0.0} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "UpdateCollaterals" ] } ] } }, "/v1/collaterals/bulk": { "patch": { "tags": [ "Collaterals" ], "summary": "Updates a collection of collaterals", "operationId": "UpdateMany", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "The collection of collaterals to update", "schema": { "$ref": "#/definitions/BulkUpdateRequest[Collateral]" } } ], "responses": { "200": { "description": "All collaterals were processed. Please check the errors property of the response object\r\n to determine if there were errors updating any individual collateral", "schema": { "$ref": "#/definitions/BulkUpdateRequest[Collateral]" }, "examples": { "application/json": {"itemsUpdated":[{"id":45613213,"description":"45687 Walker Ave","currentValue":1250000.0,"mostRecentAppraisalValue":1250000.0,"mostRecentAppraisalDate":"2026-04-16","collateralCode":"330","collateralType":"RealEstate","mileage":null,"equipmentYear":null,"equipmentManufacturer":null,"customerId":48561333,"originalValue":990000.0,"discountRate":0.2,"isDeleted":false,"propertyAddress":null,"propertyCity":null,"propertyState":null,"propertyZip":null,"propertyCounty":null,"propertyTaxID":null,"make":null,"vin":null,"model":null,"year":null,"bodyStyle":null,"serialNumber":null,"manufacturer":null,"aircraftNumber":null,"vesselName":null,"vesselNumber":null,"possessoryType":null,"accountLOCNumber":null,"issuedBy":null,"issuer":null,"shares":null,"cusip":null,"heldBy":null,"beneficiary":null,"letterOfCreditDate":null,"govtContractNumber":null,"govtContractDate":null,"titledType":"unknown","floodDeterminationDate":null,"specialFloodHazardArea":null,"capitalizationRate":0.0,"isLOMC":null,"collateralBreakout":null,"cbraAndOPADesignationDate":null,"dwelling":null,"vesselLength":null,"floodZone":null,"floodZoneCode":null,"floodProgramType":null,"isLandImprovements":null,"lomcCaseNumber":null,"lomcDate":null,"nfipMapNumber":null,"nfipMapPanelDate":null,"nfipCommunityName":null,"nfipCommunityNumber":null,"nfipPropertyDescription":null,"constructionMethod":null,"manufacturedHomeType":null,"manufacturedHomeLandPropertyInterest":null,"totalUnits":null,"multiFamilyAffordableUnits":null,"occupancyType":null,"isForAgriculturalPurpose":null,"isOwnerOccupied":null,"isSecondHome":null,"isProtectedArea":null,"stateCode":null,"countyCode":null,"tractCode":null,"latitude":null,"longitude":null,"metropolitanStatisticalArea":null,"medianHouseholdIncome":null,"metropolitanDivision":null,"metropolitanDivisionCode":null,"userDefinedFields":null,"dateAppraisalRequested":null,"isReadyForAppraisal":null,"collateralMetadataType":"existing","collateralIdentifier":null,"legalDescription":null,"source":null,"comments":"ABC","coOwnerCustomerIds":null,"proposedAdjustmentComments":null,"includeInProposedScenario":null,"proposedCurrentValue":0.0,"proposedValueAdjustment":0.0},{"id":55613213,"description":"2015 Honda Odyssey","currentValue":32000.0,"mostRecentAppraisalValue":32000.0,"mostRecentAppraisalDate":"2025-12-16","collateralCode":"113","collateralType":"Vehicle","mileage":null,"equipmentYear":null,"equipmentManufacturer":null,"customerId":78561333,"originalValue":45000.0,"discountRate":0.3,"isDeleted":false,"propertyAddress":null,"propertyCity":null,"propertyState":null,"propertyZip":null,"propertyCounty":null,"propertyTaxID":null,"make":null,"vin":null,"model":null,"year":null,"bodyStyle":null,"serialNumber":null,"manufacturer":null,"aircraftNumber":null,"vesselName":null,"vesselNumber":null,"possessoryType":null,"accountLOCNumber":null,"issuedBy":null,"issuer":null,"shares":null,"cusip":null,"heldBy":null,"beneficiary":null,"letterOfCreditDate":null,"govtContractNumber":null,"govtContractDate":null,"titledType":"unknown","floodDeterminationDate":null,"specialFloodHazardArea":null,"capitalizationRate":0.0,"isLOMC":null,"collateralBreakout":null,"cbraAndOPADesignationDate":null,"dwelling":null,"vesselLength":null,"floodZone":null,"floodZoneCode":null,"floodProgramType":null,"isLandImprovements":null,"lomcCaseNumber":null,"lomcDate":null,"nfipMapNumber":null,"nfipMapPanelDate":null,"nfipCommunityName":null,"nfipCommunityNumber":null,"nfipPropertyDescription":null,"constructionMethod":null,"manufacturedHomeType":null,"manufacturedHomeLandPropertyInterest":null,"totalUnits":null,"multiFamilyAffordableUnits":null,"occupancyType":null,"isForAgriculturalPurpose":null,"isOwnerOccupied":null,"isSecondHome":null,"isProtectedArea":null,"stateCode":null,"countyCode":null,"tractCode":null,"latitude":null,"longitude":null,"metropolitanStatisticalArea":null,"medianHouseholdIncome":null,"metropolitanDivision":null,"metropolitanDivisionCode":null,"userDefinedFields":null,"dateAppraisalRequested":null,"isReadyForAppraisal":null,"collateralMetadataType":"existing","collateralIdentifier":null,"legalDescription":null,"source":"Test Source","comments":null,"coOwnerCustomerIds":null,"proposedAdjustmentComments":null,"includeInProposedScenario":null,"proposedCurrentValue":0.0,"proposedValueAdjustment":0.0},null,{"id":51233213,"description":"1998 Tesla Model 3","currentValue":1.0,"mostRecentAppraisalValue":32000.0,"mostRecentAppraisalDate":"2025-12-16","collateralCode":"113","collateralType":"Vehicle","mileage":null,"equipmentYear":null,"equipmentManufacturer":null,"customerId":78561333,"originalValue":45000.0,"discountRate":0.3,"isDeleted":false,"propertyAddress":null,"propertyCity":null,"propertyState":null,"propertyZip":null,"propertyCounty":null,"propertyTaxID":null,"make":null,"vin":null,"model":null,"year":null,"bodyStyle":null,"serialNumber":null,"manufacturer":null,"aircraftNumber":null,"vesselName":null,"vesselNumber":null,"possessoryType":null,"accountLOCNumber":null,"issuedBy":null,"issuer":null,"shares":null,"cusip":null,"heldBy":null,"beneficiary":null,"letterOfCreditDate":null,"govtContractNumber":null,"govtContractDate":null,"titledType":"unknown","floodDeterminationDate":null,"specialFloodHazardArea":null,"capitalizationRate":0.0,"isLOMC":null,"collateralBreakout":null,"cbraAndOPADesignationDate":null,"dwelling":null,"vesselLength":null,"floodZone":null,"floodZoneCode":null,"floodProgramType":null,"isLandImprovements":null,"lomcCaseNumber":null,"lomcDate":null,"nfipMapNumber":null,"nfipMapPanelDate":null,"nfipCommunityName":null,"nfipCommunityNumber":null,"nfipPropertyDescription":null,"constructionMethod":null,"manufacturedHomeType":null,"manufacturedHomeLandPropertyInterest":null,"totalUnits":null,"multiFamilyAffordableUnits":null,"occupancyType":null,"isForAgriculturalPurpose":null,"isOwnerOccupied":null,"isSecondHome":null,"isProtectedArea":null,"stateCode":null,"countyCode":null,"tractCode":null,"latitude":null,"longitude":null,"metropolitanStatisticalArea":null,"medianHouseholdIncome":null,"metropolitanDivision":null,"metropolitanDivisionCode":null,"userDefinedFields":null,"dateAppraisalRequested":null,"isReadyForAppraisal":null,"collateralMetadataType":"existing","collateralIdentifier":null,"legalDescription":null,"source":null,"comments":"Test Comments","coOwnerCustomerIds":null,"proposedAdjustmentComments":null,"includeInProposedScenario":null,"proposedCurrentValue":0.0,"proposedValueAdjustment":0.0}],"errors":{"2":{"errorType":"invalidRequest","message":"Input model for request is invalid","modelErrors":[{"propertyName":"collateralType","message":"collateralType is required"}]}}} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "UpdateCollaterals" ] } ] }, "post": { "tags": [ "Collaterals" ], "summary": "Creates a collection of collaterals", "operationId": "CreateMany", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "The collection of collaterals to create", "schema": { "$ref": "#/definitions/BulkCreateRequest[Collateral]" } } ], "responses": { "200": { "description": "All collaterals were processed. Please check the errors property of the response object\r\n to determine if there were errors creating any individual collateral", "schema": { "$ref": "#/definitions/BulkCreateResponse[Collateral]" }, "examples": { "application/json": {"itemsCreated":[{"id":45613213,"description":"45687 Walker Ave","currentValue":1250000.0,"mostRecentAppraisalValue":1250000.0,"mostRecentAppraisalDate":"2026-04-16","collateralCode":"330","collateralType":"RealEstate","mileage":null,"equipmentYear":null,"equipmentManufacturer":null,"customerId":48561333,"originalValue":990000.0,"discountRate":0.2,"isDeleted":false,"propertyAddress":null,"propertyCity":null,"propertyState":null,"propertyZip":null,"propertyCounty":null,"propertyTaxID":null,"make":null,"vin":null,"model":null,"year":null,"bodyStyle":null,"serialNumber":null,"manufacturer":null,"aircraftNumber":null,"vesselName":null,"vesselNumber":null,"possessoryType":null,"accountLOCNumber":null,"issuedBy":null,"issuer":null,"shares":null,"cusip":null,"heldBy":null,"beneficiary":null,"letterOfCreditDate":null,"govtContractNumber":null,"govtContractDate":null,"titledType":"unknown","floodDeterminationDate":null,"specialFloodHazardArea":null,"capitalizationRate":0.0,"isLOMC":null,"collateralBreakout":null,"cbraAndOPADesignationDate":null,"dwelling":null,"vesselLength":null,"floodZone":null,"floodZoneCode":null,"floodProgramType":null,"isLandImprovements":null,"lomcCaseNumber":null,"lomcDate":null,"nfipMapNumber":null,"nfipMapPanelDate":null,"nfipCommunityName":null,"nfipCommunityNumber":null,"nfipPropertyDescription":null,"constructionMethod":null,"manufacturedHomeType":null,"manufacturedHomeLandPropertyInterest":null,"totalUnits":null,"multiFamilyAffordableUnits":null,"occupancyType":null,"isForAgriculturalPurpose":null,"isOwnerOccupied":null,"isSecondHome":null,"isProtectedArea":null,"stateCode":null,"countyCode":null,"tractCode":null,"latitude":null,"longitude":null,"metropolitanStatisticalArea":null,"medianHouseholdIncome":null,"metropolitanDivision":null,"metropolitanDivisionCode":null,"userDefinedFields":null,"dateAppraisalRequested":null,"isReadyForAppraisal":null,"collateralMetadataType":"existing","collateralIdentifier":null,"legalDescription":null,"source":"Test Source","comments":null,"coOwnerCustomerIds":null,"proposedAdjustmentComments":null,"includeInProposedScenario":null,"proposedCurrentValue":0.0,"proposedValueAdjustment":0.0},{"id":55613213,"description":"2015 Honda Odyssey","currentValue":32000.0,"mostRecentAppraisalValue":32000.0,"mostRecentAppraisalDate":"2025-12-16","collateralCode":"113","collateralType":"Vehicle","mileage":null,"equipmentYear":null,"equipmentManufacturer":null,"customerId":78561333,"originalValue":45000.0,"discountRate":0.3,"isDeleted":false,"propertyAddress":null,"propertyCity":null,"propertyState":null,"propertyZip":null,"propertyCounty":null,"propertyTaxID":null,"make":null,"vin":null,"model":null,"year":null,"bodyStyle":null,"serialNumber":null,"manufacturer":null,"aircraftNumber":null,"vesselName":null,"vesselNumber":null,"possessoryType":null,"accountLOCNumber":null,"issuedBy":null,"issuer":null,"shares":null,"cusip":null,"heldBy":null,"beneficiary":null,"letterOfCreditDate":null,"govtContractNumber":null,"govtContractDate":null,"titledType":"unknown","floodDeterminationDate":null,"specialFloodHazardArea":null,"capitalizationRate":0.0,"isLOMC":null,"collateralBreakout":null,"cbraAndOPADesignationDate":null,"dwelling":null,"vesselLength":null,"floodZone":null,"floodZoneCode":null,"floodProgramType":null,"isLandImprovements":null,"lomcCaseNumber":null,"lomcDate":null,"nfipMapNumber":null,"nfipMapPanelDate":null,"nfipCommunityName":null,"nfipCommunityNumber":null,"nfipPropertyDescription":null,"constructionMethod":null,"manufacturedHomeType":null,"manufacturedHomeLandPropertyInterest":null,"totalUnits":null,"multiFamilyAffordableUnits":null,"occupancyType":null,"isForAgriculturalPurpose":null,"isOwnerOccupied":null,"isSecondHome":null,"isProtectedArea":null,"stateCode":null,"countyCode":null,"tractCode":null,"latitude":null,"longitude":null,"metropolitanStatisticalArea":null,"medianHouseholdIncome":null,"metropolitanDivision":null,"metropolitanDivisionCode":null,"userDefinedFields":null,"dateAppraisalRequested":null,"isReadyForAppraisal":null,"collateralMetadataType":"existing","collateralIdentifier":null,"legalDescription":null,"source":null,"comments":"Test Comments","coOwnerCustomerIds":null,"proposedAdjustmentComments":null,"includeInProposedScenario":null,"proposedCurrentValue":0.0,"proposedValueAdjustment":0.0},null,{"id":51233213,"description":"1998 Tesla Model 3","currentValue":1.0,"mostRecentAppraisalValue":32000.0,"mostRecentAppraisalDate":"2025-12-16","collateralCode":"113","collateralType":"Vehicle","mileage":null,"equipmentYear":null,"equipmentManufacturer":null,"customerId":78561333,"originalValue":45000.0,"discountRate":0.3,"isDeleted":false,"propertyAddress":null,"propertyCity":null,"propertyState":null,"propertyZip":null,"propertyCounty":null,"propertyTaxID":null,"make":null,"vin":null,"model":null,"year":null,"bodyStyle":null,"serialNumber":null,"manufacturer":null,"aircraftNumber":null,"vesselName":null,"vesselNumber":null,"possessoryType":null,"accountLOCNumber":null,"issuedBy":null,"issuer":null,"shares":null,"cusip":null,"heldBy":null,"beneficiary":null,"letterOfCreditDate":null,"govtContractNumber":null,"govtContractDate":null,"titledType":"unknown","floodDeterminationDate":null,"specialFloodHazardArea":null,"capitalizationRate":0.0,"isLOMC":null,"collateralBreakout":null,"cbraAndOPADesignationDate":null,"dwelling":null,"vesselLength":null,"floodZone":null,"floodZoneCode":null,"floodProgramType":null,"isLandImprovements":null,"lomcCaseNumber":null,"lomcDate":null,"nfipMapNumber":null,"nfipMapPanelDate":null,"nfipCommunityName":null,"nfipCommunityNumber":null,"nfipPropertyDescription":null,"constructionMethod":null,"manufacturedHomeType":null,"manufacturedHomeLandPropertyInterest":null,"totalUnits":null,"multiFamilyAffordableUnits":null,"occupancyType":null,"isForAgriculturalPurpose":null,"isOwnerOccupied":null,"isSecondHome":null,"isProtectedArea":null,"stateCode":null,"countyCode":null,"tractCode":null,"latitude":null,"longitude":null,"metropolitanStatisticalArea":null,"medianHouseholdIncome":null,"metropolitanDivision":null,"metropolitanDivisionCode":null,"userDefinedFields":null,"dateAppraisalRequested":null,"isReadyForAppraisal":null,"collateralMetadataType":"existing","collateralIdentifier":null,"legalDescription":null,"source":null,"comments":"ABC","coOwnerCustomerIds":null,"proposedAdjustmentComments":null,"includeInProposedScenario":null,"proposedCurrentValue":0.0,"proposedValueAdjustment":0.0}],"errors":{"2":{"errorType":"invalidRequest","message":"Input model for request is invalid","modelErrors":[{"propertyName":"collateralType","message":"collateralType is required"}]}}} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "CreateCollaterals" ] } ] } }, "/v1/portfolio-loans/{id}/collaterals": { "get": { "tags": [ "Collaterals" ], "summary": "Gets all collaterals for given portfolio-loan id", "operationId": "Get", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "id of the portfolio loan to filter by", "required": true, "type": "integer", "format": "int32" }, { "in": "query", "name": "page", "description": "The page number of results to retrieve (first page = 1, default = 1)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "perPage", "description": "The number of records to return on each page (minimum = 1, maximum = 1000, default = 200)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "customerId", "description": "ID of the customer that pledged the collateral", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "isReadyForAppraisal", "description": "Whether this collateral is ready for appraisal", "type": "boolean", "x-nullable": true }, { "in": "query", "name": "dateAppraisalRequestedStartDate", "description": "The start of the date range to be used when doing a date range query.Use the format yyyy-MM-dd. This date is inclusive.", "type": "string", "format": "date-time", "x-nullable": true }, { "in": "query", "name": "dateAppraisalRequestedEndDate", "description": "The end of the date range to be used when doing a date range query. Use the format yyyy-MM-dd. This date is inclusive.", "type": "string", "format": "date-time", "x-nullable": true }, { "in": "query", "name": "collateralIdentifier", "description": "Identifier for the collateral", "type": "string" }, { "in": "query", "name": "collateralMetadataType", "description": "The type of collateral to filter by. Ex: proposed, existing, archive, etc.", "type": "string", "enum": [ "existing", "proposed", "savedCopy", "archive" ], "x-nullable": true }, { "in": "query", "name": "includeUserDefinedFields", "description": "Include User Defined fields in the response", "type": "boolean", "default": false, "x-nullable": true } ], "responses": { "200": { "description": "Gets all collaterals associated with the given portfolio loan id", "schema": { "$ref": "#/definitions/CollectionResponse[Collateral]" }, "examples": { "application/json": {"items":[{"id":45613213,"description":"45687 Walker Ave","currentValue":1250000.0,"mostRecentAppraisalValue":1250000.0,"mostRecentAppraisalDate":"2026-04-16","collateralCode":"330","collateralType":"RealEstate","mileage":null,"equipmentYear":null,"equipmentManufacturer":null,"customerId":48561333,"originalValue":990000.0,"discountRate":0.2,"isDeleted":false,"propertyAddress":"123 Main Street","propertyCity":"New York","propertyState":"NY","propertyZip":"11111","propertyCounty":"New York","propertyTaxID":"123456789","make":"Ford","vin":"1XHDN34343DKSDGDHEEA45","model":"Fusion","year":"2020","bodyStyle":"sedan","serialNumber":"3409594548354543","manufacturer":"","aircraftNumber":"12345","vesselName":"Test Vessel","vesselNumber":"12345","possessoryType":"savings","accountLOCNumber":"5555555","issuedBy":"lender","issuer":"Lender 1234","shares":1,"cusip":"123456789","heldBy":"other","beneficiary":"Beneficiary XYZ","letterOfCreditDate":"2013-01-24","govtContractNumber":"34798445854","govtContractDate":"2018-05-06","titledType":"unknown","floodDeterminationDate":"2017-05-02","specialFloodHazardArea":0,"capitalizationRate":1234.0,"isLOMC":true,"collateralBreakout":null,"cbraAndOPADesignationDate":"2016-09-07","dwelling":"principal","vesselLength":32,"floodZone":"a","floodZoneCode":"","floodProgramType":false,"isLandImprovements":false,"lomcCaseNumber":"123467","lomcDate":"2017-04-05","nfipMapNumber":"12345","nfipMapPanelDate":"2015-09-10","nfipCommunityName":"Community Name","nfipCommunityNumber":"3465656754","nfipPropertyDescription":"Test Property","constructionMethod":"siteBuilt","manufacturedHomeType":"notApplicable","manufacturedHomeLandPropertyInterest":"notApplicable","totalUnits":1,"multiFamilyAffordableUnits":"","occupancyType":"principalResidence","isForAgriculturalPurpose":false,"isOwnerOccupied":true,"isSecondHome":false,"isProtectedArea":false,"stateCode":12,"countyCode":"123","tractCode":"3453","latitude":41.947630,"longitude":-87.656376,"metropolitanStatisticalArea":16980,"medianHouseholdIncome":107250.0,"metropolitanDivision":"Chicago-Naperville-Evanston, IL","metropolitanDivisionCode":"1234242","userDefinedFields":{"User Defined Text":"test 123","User Defined Numeric":"54","User Defined Currency":"5454.0000","User Defined Percent":"4.54","User Defined Date":"3/12/2020 12:00:00 AM","User Defined Dropdown":"Yes","User Defined Yes No":"Yes"},"dateAppraisalRequested":null,"isReadyForAppraisal":null,"collateralMetadataType":"existing","collateralIdentifier":null,"legalDescription":null,"source":null,"comments":null,"coOwnerCustomerIds":null,"proposedAdjustmentComments":null,"includeInProposedScenario":null,"proposedCurrentValue":0.0,"proposedValueAdjustment":0.0},{"id":55613213,"description":"2015 Honda Odyssey","currentValue":32000.0,"mostRecentAppraisalValue":32000.0,"mostRecentAppraisalDate":"2025-12-16","collateralCode":"113","collateralType":"Vehicle","mileage":null,"equipmentYear":null,"equipmentManufacturer":null,"customerId":78561333,"originalValue":45000.0,"discountRate":0.3,"isDeleted":false,"propertyAddress":null,"propertyCity":null,"propertyState":null,"propertyZip":null,"propertyCounty":null,"propertyTaxID":null,"make":null,"vin":null,"model":null,"year":null,"bodyStyle":null,"serialNumber":null,"manufacturer":null,"aircraftNumber":null,"vesselName":null,"vesselNumber":null,"possessoryType":null,"accountLOCNumber":null,"issuedBy":null,"issuer":null,"shares":null,"cusip":null,"heldBy":null,"beneficiary":null,"letterOfCreditDate":null,"govtContractNumber":null,"govtContractDate":null,"titledType":"unknown","floodDeterminationDate":null,"specialFloodHazardArea":null,"capitalizationRate":0.0,"isLOMC":null,"collateralBreakout":null,"cbraAndOPADesignationDate":null,"dwelling":null,"vesselLength":null,"floodZone":null,"floodZoneCode":null,"floodProgramType":null,"isLandImprovements":null,"lomcCaseNumber":null,"lomcDate":null,"nfipMapNumber":null,"nfipMapPanelDate":null,"nfipCommunityName":null,"nfipCommunityNumber":null,"nfipPropertyDescription":null,"constructionMethod":null,"manufacturedHomeType":null,"manufacturedHomeLandPropertyInterest":null,"totalUnits":null,"multiFamilyAffordableUnits":null,"occupancyType":null,"isForAgriculturalPurpose":null,"isOwnerOccupied":null,"isSecondHome":null,"isProtectedArea":null,"stateCode":null,"countyCode":null,"tractCode":null,"latitude":null,"longitude":null,"metropolitanStatisticalArea":null,"medianHouseholdIncome":null,"metropolitanDivision":null,"metropolitanDivisionCode":null,"userDefinedFields":null,"dateAppraisalRequested":null,"isReadyForAppraisal":null,"collateralMetadataType":"existing","collateralIdentifier":"12345","legalDescription":null,"source":"Test","comments":"Comment ABC","coOwnerCustomerIds":null,"proposedAdjustmentComments":null,"includeInProposedScenario":null,"proposedCurrentValue":0.0,"proposedValueAdjustment":0.0}]} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "ReadCollaterals" ] } ] } }, "/v1/collaterals/properties/add": { "post": { "tags": [ "Collaterals" ], "summary": "Creates a new collateral property", "operationId": "CreateUserDefinedField", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "", "schema": { "$ref": "#/definitions/UserDefinedDataFieldPostRequest" } } ], "responses": { "201": { "description": "Created", "schema": { "$ref": "#/definitions/UserDefinedDataFieldPostRequest" }, "examples": { "application/json": {"id":12345,"name":"Test","dataFieldInputFormat":"text","dataFieldFormatString":"textLength200","options":null} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "UpdateCollateralPropertiesUdf" ] } ] } }, "/v1/collaterals/properties/update": { "patch": { "tags": [ "Collaterals" ], "summary": "Updates a collateral property", "operationId": "UpdateUserDefinedField", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "", "schema": { "$ref": "#/definitions/UserDefinedDataFieldPatchRequest" } } ], "responses": { "201": { "description": "Created", "schema": { "$ref": "#/definitions/UserDefinedDataFieldPatchRequest" }, "examples": { "application/json": {"id":12345,"name":"Test","dataFieldInputFormat":"text","dataFieldFormatString":"textLength200","options":null} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "UpdateCollateralPropertiesUdf" ] } ] } }, "/v1/liens": { "get": { "tags": [ "Liens" ], "summary": "Gets all liens", "operationId": "GetPaged", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "page", "description": "The page number of results to retrieve (first page = 1, default = 1)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "perPage", "description": "The number of records to return on each page (minimum = 1, maximum = 1000, default = 200)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "loanId", "description": "The Loan id to filter by", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "collateralId", "description": "The Collateral id to filter by", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "excludeLiensForDeletedCustomers", "description": "Set to true to ensure the liens returned are not linked to deleted customers", "type": "boolean", "default": false } ], "responses": { "200": { "description": "Gets all current, existing, and active liens against collateral in the account", "schema": { "$ref": "#/definitions/CollectionResponse[Lien]" }, "examples": { "application/json": {"items":[{"id":789745312,"collateralId":123456,"loanId":99999,"lienPosition":1,"lienHolder":"My Bank","lienAmount":20261.12,"isDeleted":false},{"id":787945632,"collateralId":123456,"loanId":null,"lienPosition":2,"lienHolder":"Another Bank","lienAmount":13000.76,"isDeleted":false},{"id":754621465,"collateralId":123456,"loanId":789563,"lienPosition":3,"lienHolder":"My Bank","lienAmount":32030.24,"isDeleted":false}]} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "ReadLiens" ] } ] }, "post": { "tags": [ "Liens" ], "summary": "Creates a lien", "operationId": "Create", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "The lien to create", "schema": { "$ref": "#/definitions/Lien" } } ], "responses": { "201": { "description": "The lien has been created successfully. The lien that was created\r\n is returned and has the Sageworks id that was assigned.", "schema": { "$ref": "#/definitions/Lien" }, "examples": { "application/json": {"id":789745312,"collateralId":123456,"loanId":99999,"lienPosition":1,"lienHolder":"My Bank","lienAmount":20261.12,"isDeleted":false} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "ApiAccess" ] } ] } }, "/v1/liens/{id}": { "get": { "tags": [ "Liens" ], "summary": "Gets a lien by id", "operationId": "GetById", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "id of the lien to get", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "Gets the lien with the specified id", "schema": { "$ref": "#/definitions/Lien" }, "examples": { "application/json": {"id":789745312,"collateralId":123456,"loanId":99999,"lienPosition":1,"lienHolder":"My Bank","lienAmount":20261.12,"isDeleted":false} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "ReadLiens" ] } ] }, "patch": { "tags": [ "Liens" ], "summary": "Updates a lien", "operationId": "Update", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "id of the existing lien to update", "required": true, "type": "integer", "format": "int32" }, { "in": "body", "name": "body", "description": "The lien values to update", "schema": { "$ref": "#/definitions/Lien" } } ], "responses": { "200": { "description": "Returns the modified lien", "schema": { "$ref": "#/definitions/Lien" }, "examples": { "application/json": {"id":789745312,"collateralId":123456,"loanId":99999,"lienPosition":1,"lienHolder":"My Bank","lienAmount":20261.12,"isDeleted":false} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "ApiAccess" ] } ] }, "delete": { "tags": [ "Liens" ], "summary": "Deletes a lien by id", "operationId": "Delete", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "id of the existing lien to delete", "required": true, "type": "integer", "format": "int32" } ], "responses": { "204": { "description": "The lien has been deleted successfully." }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "ApiAccess" ] } ] } }, "/v1/liens/bulk": { "patch": { "tags": [ "Liens" ], "summary": "Updates a collection of liens", "operationId": "UpdateMany", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "The collection of liens to update", "schema": { "$ref": "#/definitions/BulkUpdateRequest[Lien]" } } ], "responses": { "200": { "description": "All liens were processed. Please check the errors property of the response object\r\n to determine if there were errors updating any individual lien", "schema": { "$ref": "#/definitions/BulkUpdateRequest[Lien]" }, "examples": { "application/json": {"itemsUpdated":[{"id":789745312,"collateralId":123456,"loanId":99999,"lienPosition":1,"lienHolder":"My Bank","lienAmount":20261.12,"isDeleted":false},{"id":787945632,"collateralId":123456,"loanId":null,"lienPosition":2,"lienHolder":"Another Bank","lienAmount":13000.76,"isDeleted":false},null,{"id":754621465,"collateralId":123456,"loanId":789563,"lienPosition":3,"lienHolder":"My Bank","lienAmount":32030.24,"isDeleted":false}],"errors":{"2":{"errorType":"invalidRequest","message":"Input model for request is invalid","modelErrors":[{"propertyName":"collateralId","message":"collateral with id '1234' does not exist"}]}}} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "ApiAccess" ] } ] }, "post": { "tags": [ "Liens" ], "summary": "Creates a collection of liens", "operationId": "CreateMany", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "The collection of liens to create", "schema": { "$ref": "#/definitions/BulkCreateRequest[Lien]" } } ], "responses": { "200": { "description": "All liens were processed. Please check the errors property of the response object\r\n to determine if there were errors creating any individual lien", "schema": { "$ref": "#/definitions/BulkCreateResponse[Lien]" }, "examples": { "application/json": {"itemsCreated":[{"id":789745312,"collateralId":123456,"loanId":99999,"lienPosition":1,"lienHolder":"My Bank","lienAmount":20261.12,"isDeleted":false},{"id":787945632,"collateralId":123456,"loanId":null,"lienPosition":2,"lienHolder":"Another Bank","lienAmount":13000.76,"isDeleted":false},null,{"id":754621465,"collateralId":123456,"loanId":789563,"lienPosition":3,"lienHolder":"My Bank","lienAmount":32030.24,"isDeleted":false}],"errors":{"2":{"errorType":"invalidRequest","message":"Input model for request is invalid","modelErrors":[{"propertyName":"collateralId","message":"collateral with id '1234' does not exist"}]}}} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "ApiAccess" ] } ] } }, "/v1/documents": { "get": { "tags": [ "Documents" ], "summary": "Gets all documents", "operationId": "GetPaged", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "page", "description": "The page number of results to retrieve (first page = 1, default = 1)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "perPage", "description": "The number of records to return on each page (minimum = 1, maximum = 1000, default = 200)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "dateUploadedStartDate", "description": "The start of the date range to be used when doing a date range query. Use the format yyyy-MM-dd. This date is inclusive.", "type": "string", "format": "date-time", "x-nullable": true }, { "in": "query", "name": "dateUploadedEndDate", "description": "The end of the date range to be used when doing a date range query. Use the format yyyy-MM-dd. This date is inclusive.", "type": "string", "format": "date-time", "x-nullable": true }, { "in": "query", "name": "ids", "description": "List of document ids to filter by", "type": "array", "items": { "format": "int64", "type": "integer" }, "collectionFormat": "multi" }, { "in": "query", "name": "customerId", "description": "Customer id to filter by", "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "Gets all current, existing, and active deposit accounts in the account", "schema": { "$ref": "#/definitions/CollectionResponse[Document]" }, "examples": { "application/json": {"items":[{"id":123546,"customerId":null,"documentFolderId":123,"uniqueIdentifier":"Company ABC Tax Return for 2017","name":"Company ABC 2017 Tax Return","customerFacingName":null,"fileName":"CompanyABC2017TaxReturn.pdf","sizeInBytes":12345,"isImage":false,"isDeleted":false,"documentDated":"2017-12-31","description":"Tax Return for Company ABC for 2017","dateUploaded":"2025-07-16","exportDate":"2025-07-16","exportTime":null},{"id":789654,"customerId":null,"documentFolderId":123,"uniqueIdentifier":"Company ABC Tax Return for 2016","name":"Company ABC 2016 Tax Return","customerFacingName":null,"fileName":"CompanyABC2016TaxReturn.pdf","sizeInBytes":17746,"isImage":false,"isDeleted":false,"documentDated":"2016-12-31","description":"Tax Return for Company ABC for 2016","dateUploaded":"2024-07-16","exportDate":"2025-07-16","exportTime":null}]} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "ReadDocuments" ] } ] }, "post": { "tags": [ "Documents" ], "summary": "Uploads a document to the library", "operationId": "Create", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/DocumentPostRequest" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/Document" }, "examples": { "application/json": {"id":123546,"customerId":null,"documentFolderId":123,"uniqueIdentifier":"Company ABC Tax Return for 2017","name":"Company ABC 2017 Tax Return","customerFacingName":null,"fileName":"CompanyABC2017TaxReturn.pdf","sizeInBytes":12345,"isImage":false,"isDeleted":false,"documentDated":"2017-12-31","description":"Tax Return for Company ABC for 2017","dateUploaded":"2025-07-16","exportDate":null,"exportTime":null} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "201": { "description": "The metadata of the succesfully created document" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "CreateDocuments" ] } ] } }, "/v1/documents/by-object-association": { "get": { "tags": [ "Documents" ], "summary": "Gets all documents by object association", "operationId": "GetPagedByObjectAssociation", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "page", "description": "The page number of results to retrieve (first page = 1, default = 1)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "perPage", "description": "The number of records to return on each page (minimum = 1, maximum = 1000, default = 200)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "objectType", "description": "Object type to filter by", "type": "string", "enum": [ "hmdaLoanRecords", "loanApplication", "loanOriginationDocumentData", "nonProfitInputData", "other", "personalInputData", "profitEntities", "profitInputData", "proposedBankLoans", "workflows" ], "x-nullable": true }, { "in": "query", "name": "objectId", "description": "Object id to filter by", "type": "integer", "format": "int64", "x-nullable": true } ], "responses": { "200": { "description": "Gets all current, existing, and active documents in the account by object association", "schema": { "$ref": "#/definitions/CollectionResponse[Document]" }, "examples": { "application/json": {"items":[{"id":123546,"customerId":null,"documentFolderId":123,"uniqueIdentifier":"Company ABC Tax Return for 2017","name":"Company ABC 2017 Tax Return","customerFacingName":null,"fileName":"CompanyABC2017TaxReturn.pdf","sizeInBytes":12345,"isImage":false,"isDeleted":false,"documentDated":"2017-12-31","description":"Tax Return for Company ABC for 2017","dateUploaded":"2025-07-16","exportDate":"2025-07-16","exportTime":null},{"id":789654,"customerId":null,"documentFolderId":123,"uniqueIdentifier":"Company ABC Tax Return for 2016","name":"Company ABC 2016 Tax Return","customerFacingName":null,"fileName":"CompanyABC2016TaxReturn.pdf","sizeInBytes":17746,"isImage":false,"isDeleted":false,"documentDated":"2016-12-31","description":"Tax Return for Company ABC for 2016","dateUploaded":"2024-07-16","exportDate":"2025-07-16","exportTime":null}]} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "ReadDocuments" ] } ] } }, "/v1/documents/{id}": { "get": { "tags": [ "Documents" ], "summary": "Gets a document (without document content) by id", "operationId": "GetById", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "id of the existing document to get", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "Gets the document with the specified id", "schema": { "$ref": "#/definitions/Document" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "ReadDocuments" ] } ] }, "patch": { "tags": [ "Documents" ], "summary": "Updates an existing document", "operationId": "Update", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "id of the existing document to update", "required": true, "type": "integer", "format": "int32" }, { "in": "body", "name": "body", "description": "The document values to update", "schema": { "$ref": "#/definitions/Document" } } ], "responses": { "200": { "description": "Returns the modified document", "schema": { "$ref": "#/definitions/Document" }, "examples": { "application/json": {"id":123546,"customerId":null,"documentFolderId":123,"uniqueIdentifier":"Company ABC Tax Return for 2017","name":"Company ABC 2017 Tax Return","customerFacingName":null,"fileName":"CompanyABC2017TaxReturn.pdf","sizeInBytes":12345,"isImage":false,"isDeleted":false,"documentDated":"2017-12-31","description":"Tax Return for Company ABC for 2017","dateUploaded":"2025-07-16","exportDate":null,"exportTime":null} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "UpdateDocuments" ] } ] }, "delete": { "tags": [ "Documents" ], "summary": "Deletes a document by id", "operationId": "Delete", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "id of the existing document to delete", "required": true, "type": "integer", "format": "int32" }, { "in": "query", "name": "permanentlyDelete", "description": "Whether or not to permanently delete the document. Default is 'false'", "type": "boolean", "default": false, "x-nullable": true } ], "responses": { "204": { "description": "The document has been deleted successfully." }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "DeleteDocuments" ] } ] } }, "/v1/documents/{id}/content": { "get": { "tags": [ "Documents" ], "summary": "Gets document content by id", "operationId": "GetContentById", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "id of the existing document to get content for", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "Gets the content of the document with the specified id", "schema": { "$ref": "#/definitions/DocumentContent" }, "examples": { "application/json": {"content":"dGVzdCBmaWxlDQp0ZXN0IGZpbGUNCnRlc3QgZmlsZQ0KdGVzdCBmaWxlDQp0ZXN0IGZpbGUNCnRlc3QgZmlsZQ0KdGVzdCBmaWxl"} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "ReadDocumentContent" ] } ] } }, "/v1/documents/bulk": { "delete": { "tags": [ "Documents" ], "operationId": "DeleteBulkDocuments", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "ids", "type": "array", "items": { "format": "int64", "type": "integer" }, "collectionFormat": "multi" } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "DeleteDocuments" ] } ] } }, "/v1/document-folders/{id}": { "get": { "tags": [ "Document Folders" ], "summary": "Gets a document folder by id", "operationId": "GetById", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "id of the existing document folder to get", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "Gets the document folder with the specified id", "schema": { "$ref": "#/definitions/DocumentFolder" }, "examples": { "application/json": {"id":38472,"type":"customer","name":"My Financial Document Folder","parentDocumentFolderId":123,"isDeleted":false} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "ReadDocumentFolders" ] } ] }, "patch": { "tags": [ "Document Folders" ], "summary": "Updates a folder", "operationId": "Update", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "id of the existing folder to update", "required": true, "type": "integer", "format": "int32" }, { "in": "body", "name": "body", "description": "folder object to use for update", "schema": { "$ref": "#/definitions/DocumentFolder" } } ], "responses": { "200": { "description": "The updated folder", "schema": { "$ref": "#/definitions/DocumentFolder" }, "examples": { "application/json": {"id":123546,"customerId":null,"documentFolderId":123,"uniqueIdentifier":"Company ABC Tax Return for 2017","name":"Company ABC 2017 Tax Return","customerFacingName":null,"fileName":"CompanyABC2017TaxReturn.pdf","sizeInBytes":12345,"isImage":false,"isDeleted":false,"documentDated":"2017-12-31","description":"Tax Return for Company ABC for 2017","dateUploaded":"2025-07-16","exportDate":null,"exportTime":null} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "UpdateDocumentFolders" ] } ] } }, "/v1/document-folders": { "get": { "tags": [ "Document Folders" ], "summary": "Gets all document folders", "operationId": "GetPaged", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "page", "description": "The page number of results to retrieve (first page = 1, default = 1)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "perPage", "description": "The number of records to return on each page (minimum = 1, maximum = 1000, default = 200)", "type": "integer", "format": "int32", "x-nullable": true } ], "responses": { "200": { "description": "Gets all current, existing, and active document folders in the account", "schema": { "$ref": "#/definitions/CollectionResponse[DocumentFolder]" }, "examples": { "application/json": {"items":[{"id":38472,"type":"customer","name":"Tax Returns","parentDocumentFolderId":123,"isDeleted":false},{"id":46512,"type":"customer","name":"Flood Insurance Documents","parentDocumentFolderId":125,"isDeleted":false},{"id":79143,"type":"general","name":"Loan Application Forms","parentDocumentFolderId":null,"isDeleted":false}]} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "ReadDocumentFolders" ] } ] }, "post": { "tags": [ "Document Folders" ], "summary": "Creates a document folder", "operationId": "Create", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "The document folder to create", "schema": { "$ref": "#/definitions/DocumentFolder" } } ], "responses": { "201": { "description": "The document folder has been created successfully. The document folder that was created\r\n is returned and has the Sageworks id that was assigned.", "schema": { "$ref": "#/definitions/DocumentFolder" }, "examples": { "application/json": {"id":38472,"type":"customer","name":"My Financial Document Folder","parentDocumentFolderId":123,"isDeleted":false} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "CreateDocumentFolders" ] } ] } }, "/v1/document-associations": { "get": { "tags": [ "Document Associations" ], "summary": "Gets all document associations", "operationId": "GetPaged", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "page", "description": "The page number of results to retrieve (first page = 1, default = 1)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "perPage", "description": "The number of records to return on each page (minimum = 1, maximum = 1000, default = 200)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "documentId", "description": "The ID of the document to retrieve associations for.\r\nNote: Use DocumentId to filter by a single document id. Use DocumentIds to filter by multiple document ids.", "type": "integer", "format": "int64", "x-nullable": true }, { "in": "query", "name": "documentIds", "description": "List of document ids to retrieve associations for.\r\nNote: Use DocumentId to filter by a single document id. Use DocumentIds to filter by multiple document ids.", "type": "array", "items": { "format": "int64", "type": "integer" }, "collectionFormat": "multi" }, { "in": "query", "name": "objectType", "description": "The type of object to retrieve associations for (ex: Customer, Collateral, PortfolioLoan, ProposedLoan, Workflow)", "type": "string" }, { "in": "query", "name": "objectId", "description": "The id of the object to retrieve associations for.\r\nNote: Use ObjectId to filter by a single object id. Use ObjectIds to filter by multiple object ids", "type": "integer", "format": "int64", "x-nullable": true }, { "in": "query", "name": "objectIds", "description": "List of object ids to retrieve associations for.\r\nNote: Use ObjectId to filter by a single object id. Use ObjectIds to filter by multiple object ids", "type": "array", "items": { "format": "int64", "type": "integer" }, "collectionFormat": "multi" } ], "responses": { "200": { "description": "Gets all current, existing, and active document associations", "schema": { "$ref": "#/definitions/CollectionResponse[DocumentAssociation]" }, "examples": { "application/json": {"items":[{"id":123,"documentId":456,"objectType":"PortfolioLoan","objectId":789},{"id":124,"documentId":456,"objectType":"ProposedLoan","objectId":97423},{"id":125,"documentId":9965,"objectType":"Collateral","objectId":12345},{"id":126,"documentId":3222,"objectType":"Workflow","objectId":4325}]} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "ReadDocumentAssociations" ] } ] }, "post": { "tags": [ "Document Associations" ], "summary": "Creates an association between a document and another object in Sageworks", "description": "PortfolioLoan, ProposedLoan, Collateral, and Workflow are the currently supported object types for document associations", "operationId": "Create", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "The document association to create", "schema": { "$ref": "#/definitions/DocumentAssociation" } } ], "responses": { "201": { "description": "The document association has been created successfully. The document association that was created\r\n is returned and has the Sageworks id that was assigned.", "schema": { "$ref": "#/definitions/DocumentAssociation" }, "examples": { "application/json": {"id":123,"documentId":456,"objectType":"PortfolioLoan","objectId":789} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "CreateDocumentAssociations" ] } ] } }, "/v1/document-associations/{id}": { "get": { "tags": [ "Document Associations" ], "summary": "Gets a document association by id", "operationId": "GetById", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "id of the existing document association to get", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "Gets the document asssociation with the specified id", "schema": { "$ref": "#/definitions/DocumentAssociation" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "ReadDocumentAssociations" ] } ] }, "patch": { "tags": [ "Document Associations" ], "summary": "Updates a document association", "operationId": "Update", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "id of the existing document association to update", "required": true, "type": "integer", "format": "int32" }, { "in": "body", "name": "body", "description": "The document association values to update", "schema": { "$ref": "#/definitions/DocumentAssociation" } } ], "responses": { "200": { "description": "Returns the modified document association", "schema": { "$ref": "#/definitions/DocumentAssociation" }, "examples": { "application/json": {"id":123,"documentId":456,"objectType":"PortfolioLoan","objectId":789} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "ReadDocumentAssociations" ] } ] }, "delete": { "tags": [ "Document Associations" ], "summary": "Deletes a document association by id", "operationId": "Delete", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "id of the existing document association to delete", "required": true, "type": "integer", "format": "int32" } ], "responses": { "204": { "description": "The document association has been deleted successfully." }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "DeleteDocumentAssociations" ] } ] } }, "/v1/sba-export-data": { "get": { "tags": [ "SBA Export Data" ], "summary": "Gets all sba export data", "operationId": "GetPaged", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "page", "description": "The page number of results to retrieve (first page = 1, default = 1)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "perPage", "description": "The number of records to return on each page (minimum = 1, maximum = 1000, default = 200)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "proposedBankLoansId", "description": "ProposedBankLoansId value to filter by", "type": "integer", "format": "int32", "x-nullable": true } ], "responses": { "200": { "description": "Gets all of the sba export data in the account", "schema": { "$ref": "#/definitions/CollectionResponse[SBAExportData]" }, "examples": { "application/json": {"eTranReadyStatus":"exported","eTranLoanNumber":"343535445","eTranStatus":"Funded","eTranApprovalDate":null,"eTranApplicationNumber":1232422,"id":123,"proposedLoanId":234325} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] } }, "/v1/sba-export-data/{id}": { "get": { "tags": [ "SBA Export Data" ], "summary": "Gets sba export data by id", "operationId": "GetById", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "id of the sba export data to get", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "Gets the sba export data with the specified id", "schema": { "$ref": "#/definitions/SBAExportData" }, "examples": { "application/json": {"eTranReadyStatus":"exported","eTranLoanNumber":"343535445","eTranStatus":"Funded","eTranApprovalDate":null,"eTranApplicationNumber":1232422,"id":123,"proposedLoanId":234325} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] } }, "/v1/states": { "get": { "tags": [ "States" ], "summary": "Gets all states", "operationId": "GetPaged", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "page", "description": "The page number of results to retrieve (first page = 1, default = 1)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "perPage", "description": "The number of records to return on each page (minimum = 1, maximum = 1000, default = 200)", "type": "integer", "format": "int32", "x-nullable": true } ], "responses": { "200": { "description": "Gets all states", "schema": { "$ref": "#/definitions/CollectionResponse[State]" }, "examples": { "application/json": {"items":[{"id":37,"country":"US","stateCode":"OK","region":"South","stateName":"Oklahoma"},{"id":67,"country":"CA","stateCode":"SK","region":"Canada","stateName":"Saskatchewan"}]} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] } }, "/v1/states/{id}": { "get": { "tags": [ "States" ], "summary": "Gets a State by id", "operationId": "GetById", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "id of the existing State to get", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "Gets the State with the specified id", "schema": { "$ref": "#/definitions/State" }, "examples": { "application/json": {"id":32,"country":"US","stateCode":"NM","region":"West","stateName":"New Mexico"} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] } }, "/v1/usersadditionaldata/regions/get": { "get": { "tags": [ "Users" ], "operationId": "GetRegions", "produces": [ "application/json" ], "responses": { "200": { "description": "Success", "schema": { "type": "array", "items": { "$ref": "#/definitions/UserRegion" } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "UsersApiAccess", null ] } ] } }, "/v1/usersadditionaldata/regions/add": { "post": { "tags": [ "Users" ], "operationId": "CreateRegion", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "parameters": [ { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/UserRegion" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "UsersApiAccess", null ] } ] } }, "/v1/usersadditionaldata/regions/update/{id}": { "put": { "tags": [ "Users" ], "operationId": "UpdateRegion", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "parameters": [ { "in": "path", "name": "id", "required": true, "type": "integer", "format": "int32" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/UserRegion" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "UsersApiAccess", null ] } ] } }, "/v1/usersadditionaldata/regions/save": { "post": { "tags": [ "Users" ], "summary": "Accepts a collection of SageWorksLib.Entities.Users.UserRegion objects and upserts each one (adds new or updates existing).", "operationId": "SaveRegions", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "parameters": [ { "in": "body", "name": "body", "schema": { "type": "array", "items": { "$ref": "#/definitions/UserRegion" } } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "UsersApiAccess", null ] } ] } }, "/v1/usersadditionaldata/regions/delete": { "delete": { "tags": [ "Users" ], "summary": "Deletes a collection of regions by id.", "operationId": "DeleteRegions", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "parameters": [ { "in": "body", "name": "body", "schema": { "type": "array", "items": { "format": "int32", "type": "integer" } } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "UsersApiAccess", null ] } ] } }, "/v1/usersadditionaldata/markets/get": { "get": { "tags": [ "Users" ], "operationId": "GetMarkets", "produces": [ "application/json" ], "responses": { "200": { "description": "Success", "schema": { "type": "array", "items": { "$ref": "#/definitions/UserMarket" } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "UsersApiAccess", null ] } ] } }, "/v1/usersadditionaldata/markets/add": { "post": { "tags": [ "Users" ], "operationId": "CreateMarket", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "parameters": [ { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/UserMarket" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "UsersApiAccess", null ] } ] } }, "/v1/usersadditionaldata/markets/update/{id}": { "put": { "tags": [ "Users" ], "operationId": "UpdateMarket", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "parameters": [ { "in": "path", "name": "id", "required": true, "type": "integer", "format": "int32" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/UserMarket" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "UsersApiAccess", null ] } ] } }, "/v1/usersadditionaldata/markets/save": { "post": { "tags": [ "Users" ], "operationId": "SaveMarkets", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "parameters": [ { "in": "body", "name": "body", "schema": { "type": "array", "items": { "$ref": "#/definitions/UserMarket" } } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "UsersApiAccess", null ] } ] } }, "/v1/usersadditionaldata/markets/delete": { "delete": { "tags": [ "Users" ], "operationId": "DeleteMarkets", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "parameters": [ { "in": "body", "name": "body", "schema": { "type": "array", "items": { "format": "int32", "type": "integer" } } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "UsersApiAccess", null ] } ] } }, "/v1/usersadditionaldata/teams/get": { "get": { "tags": [ "Users" ], "operationId": "GetTeams", "produces": [ "application/json" ], "responses": { "200": { "description": "Success", "schema": { "type": "array", "items": { "$ref": "#/definitions/UserTeam" } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "UsersApiAccess", null ] } ] } }, "/v1/usersadditionaldata/teams/add": { "post": { "tags": [ "Users" ], "operationId": "CreateTeam", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "parameters": [ { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/UserTeam" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "UsersApiAccess", null ] } ] } }, "/v1/usersadditionaldata/teams/update/{id}": { "put": { "tags": [ "Users" ], "operationId": "UpdateTeam", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "parameters": [ { "in": "path", "name": "id", "required": true, "type": "integer", "format": "int32" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/UserTeam" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "UsersApiAccess", null ] } ] } }, "/v1/usersadditionaldata/teams/save": { "post": { "tags": [ "Users" ], "operationId": "SaveTeams", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "parameters": [ { "in": "body", "name": "body", "schema": { "type": "array", "items": { "$ref": "#/definitions/UserTeam" } } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "UsersApiAccess", null ] } ] } }, "/v1/usersadditionaldata/teams/delete": { "delete": { "tags": [ "Users" ], "operationId": "DeleteTeams", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "parameters": [ { "in": "body", "name": "body", "schema": { "type": "array", "items": { "format": "int32", "type": "integer" } } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "UsersApiAccess", null ] } ] } }, "/v1/usersadditionaldata/departments/get": { "get": { "tags": [ "Users" ], "operationId": "GetDepartments", "produces": [ "application/json" ], "responses": { "200": { "description": "Success", "schema": { "type": "array", "items": { "$ref": "#/definitions/UserDepartment" } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "UsersApiAccess", null ] } ] } }, "/v1/usersadditionaldata/departments/add": { "post": { "tags": [ "Users" ], "operationId": "CreateDepartment", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "parameters": [ { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/UserDepartment" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "UsersApiAccess", null ] } ] } }, "/v1/usersadditionaldata/departments/update/{id}": { "put": { "tags": [ "Users" ], "operationId": "UpdateDepartment", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "parameters": [ { "in": "path", "name": "id", "required": true, "type": "integer", "format": "int32" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/UserDepartment" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "UsersApiAccess", null ] } ] } }, "/v1/usersadditionaldata/departments/save": { "post": { "tags": [ "Users" ], "operationId": "SaveDepartments", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "parameters": [ { "in": "body", "name": "body", "schema": { "type": "array", "items": { "$ref": "#/definitions/UserDepartment" } } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "UsersApiAccess", null ] } ] } }, "/v1/usersadditionaldata/departments/delete": { "delete": { "tags": [ "Users" ], "operationId": "DeleteDepartments", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "parameters": [ { "in": "body", "name": "body", "schema": { "type": "array", "items": { "format": "int32", "type": "integer" } } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "UsersApiAccess", null ] } ] } }, "/v1/users": { "get": { "tags": [ "Users" ], "summary": "Gets all users", "operationId": "GetPaged", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "page", "description": "The page number of results to retrieve (first page = 1, default = 1)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "perPage", "description": "The number of records to return on each page (minimum = 1, maximum = 1000, default = 200)", "type": "integer", "format": "int32", "x-nullable": true } ], "responses": { "200": { "description": "Gets all users", "schema": { "$ref": "#/definitions/CollectionResponse[User]" }, "examples": { "application/json": {"id":12345,"firstName":"John","lastName":"Doe","accountCreatedDate":"2020-10-11","lastLoginDate":"2022-10-25","email":"johndoe@example.com","officerCode":"XYZ","isDeleted":false,"isNonUser":false} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "UsersApiAccess", null ] } ] } }, "/v1/users/{id}": { "get": { "tags": [ "Users" ], "summary": "Gets a User by id", "operationId": "GetById", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "id of the existing User to get", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "Gets the User with the specified id", "schema": { "$ref": "#/definitions/User" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "UsersApiAccess", null ] } ] } }, "/v1/workflows/start": { "post": { "tags": [ "Workflow" ], "summary": "Starts a workflow", "operationId": "StartWorkflow", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "A request representing the information needed to start the workflow. You can start a workflow with proposedLoanIds, portfolioLoanIds, or both.", "schema": { "$ref": "#/definitions/StartWorkflowRequest" } } ], "responses": { "200": { "description": "The workflow has been created successfully. The id of the workflow is returned.", "schema": { "$ref": "#/definitions/StartWorkflowResponse" }, "examples": { "application/json": {"workflowId":12345} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "WorkflowAccess", null ] } ] } }, "/v1/workflows": { "get": { "tags": [ "Workflow" ], "summary": "Gets all workflows", "operationId": "GetPaged", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "page", "description": "The page number of results to retrieve (first page = 1, default = 1)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "perPage", "description": "The number of records to return on each page (minimum = 1, maximum = 1000, default = 200)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "customerId", "description": "ID of the customer associated with the workflow", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "ids", "description": "List of Ids to filter by", "type": "array", "items": { "format": "int64", "type": "integer" }, "collectionFormat": "multi" }, { "in": "query", "name": "status", "description": "Workflow Status to filter by", "type": "string", "format": "string", "enum": [ "open", "closed" ] } ], "responses": { "200": { "description": "Gets all current, existing, and active workflows in the account", "schema": { "$ref": "#/definitions/CollectionResponse[Workflow]" }, "examples": { "application/json": {"items":[{"id":336772,"name":"Loan and Deposit Workflow","customerId":122345,"workflowTemplateId":1141,"status":"open","lastModifiedDate":"2022-10-25","isDeleted":false},{"id":336776,"name":"Proposed Loan Workflow","customerId":122345,"workflowTemplateId":1142,"status":"closed","lastModifiedDate":"2023-10-25","isDeleted":false}]} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "WorkflowAccess", null ] } ] } }, "/v1/workflows/{id}": { "get": { "tags": [ "Workflow" ], "summary": "Gets a workflow by id", "operationId": "GetById", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "id of the workflow to get", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "Gets the workflow with the specified id", "schema": { "$ref": "#/definitions/Workflow" }, "examples": { "application/json": {"id":336772,"name":"Proposed Loan and Deposit Workflow","customerId":122345,"workflowTemplateId":1141,"status":"open","lastModifiedDate":"2023-01-01","isDeleted":false} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "WorkflowAccess", null ] } ] } }, "/v1/workflows/{id}/insert-phase/{templatePhaseId}": { "post": { "tags": [ "Workflow" ], "summary": "Inserts a phase in a workflow", "operationId": "InsertWorkflowPhase", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "Id of the workflow to modify", "required": true, "type": "integer", "format": "int32" }, { "in": "path", "name": "templatePhaseId", "description": "Id of the template phase to insert into the workflow", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "The workflow phase which has been inserted successfully.", "schema": { "$ref": "#/definitions/WorkflowPhase" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "WorkflowAccess", null ] } ] } }, "/v1/workflows/{id}/close": { "post": { "tags": [ "Workflow" ], "summary": "Closes a workflow", "operationId": "CloseWorkflow", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "Id of the workflow to close", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "The workflow has been closed successfully." }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "WorkflowAccess", null ] } ] } }, "/v1/workflows/{id}/user-role-assignments": { "get": { "tags": [ "Workflow" ], "summary": "Gets all user role assignments in a workflow", "operationId": "GetRolesByWorkflowId", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "id of the workflow to get user role assignments for", "required": true, "type": "integer", "format": "int32" }, { "in": "query", "name": "roleId", "description": "RoleId to filter by", "type": "integer", "format": "int64", "x-nullable": true } ], "responses": { "200": { "description": "Gets the workflow user role assignments with the specified id", "schema": { "$ref": "#/definitions/WorkflowRoleAssignmentsResponse" }, "examples": { "application/json": {"userRoleAssignments":[{"roleId":1234,"usersId":5678},{"roleId":1234,"usersId":7888},{"roleId":7782,"usersId":null},{"roleId":34354,"usersId":22467}]} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "WorkflowAccess", null ] } ] } }, "/v1/workflow-phases": { "get": { "tags": [ "Workflow Phase" ], "summary": "Gets all workflow phases", "operationId": "GetPaged", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "page", "description": "The page number of results to retrieve (first page = 1, default = 1)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "perPage", "description": "The number of records to return on each page (minimum = 1, maximum = 1000, default = 200)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "workflowIds", "description": "List of Workflow IDs to filter by", "type": "array", "items": { "format": "int64", "type": "integer" }, "collectionFormat": "multi" } ], "responses": { "200": { "description": "Gets all current, existing, and active workflow phases in the account", "schema": { "$ref": "#/definitions/CollectionResponse[WorkflowPhase]" }, "examples": { "application/json": {"id":336772,"workflowId":240545,"name":"Approval","isDeleted":false} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "WorkflowAccess", null ] } ] } }, "/v1/workflow-phases/{id}": { "get": { "tags": [ "Workflow Phase" ], "summary": "Gets a workflow phase by id", "operationId": "GetById", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "id of the workflow phase to get", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "Gets the workflow phase with the specified id", "schema": { "$ref": "#/definitions/WorkflowPhase" }, "examples": { "application/json": {"id":336772,"workflowId":240545,"name":"Approval","isDeleted":false} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "WorkflowAccess", null ] } ] } }, "/v1/workflow-reason-option": { "get": { "tags": [ "Workflow Reason Option" ], "summary": "Gets all workflows reason options", "operationId": "GetPaged", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "page", "description": "The page number of results to retrieve (first page = 1, default = 1)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "perPage", "description": "The number of records to return on each page (minimum = 1, maximum = 1000, default = 200)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "workflowReasonOptionIds", "description": "List of workflow reason options ids to filter by", "type": "array", "items": { "format": "int32", "type": "integer" }, "collectionFormat": "multi" } ], "responses": { "200": { "description": "Gets all current, existing, and active workflow reason options in the account", "schema": { "$ref": "#/definitions/CollectionResponse[WorkflowReasonOption]" }, "examples": { "application/json": {"id":10,"reason":"New Loan","isDeleted":false} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "WorkflowAccess", null ] } ] } }, "/v1/workflow-reason-option/{id}": { "get": { "tags": [ "Workflow Reason Option" ], "summary": "Gets a workflow reason option by id", "operationId": "GetById", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "id of the workflow to get", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "Gets the workflow reason option with the specified id", "schema": { "$ref": "#/definitions/WorkflowReasonOption" }, "examples": { "application/json": {"id":10,"reason":"New Loan","isDeleted":false} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "WorkflowAccess", null ] } ] } }, "/v1/workflow-reason-option-mapping": { "get": { "tags": [ "Workflow Reason Option Mapping" ], "summary": "Gets all workflows", "operationId": "GetPaged", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "page", "description": "The page number of results to retrieve (first page = 1, default = 1)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "perPage", "description": "The number of records to return on each page (minimum = 1, maximum = 1000, default = 200)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "workflowsIds", "description": "List of Workflow IDs to filter by", "type": "array", "items": { "format": "int32", "type": "integer" }, "collectionFormat": "multi" } ], "responses": { "200": { "description": "Gets all current, existing, and active workflows in the account", "schema": { "$ref": "#/definitions/CollectionResponse[WorkflowReasonOptionMapping]" }, "examples": { "application/json": {"id":336772,"workflowsId":240545,"workflowReasonOptionsId":9201} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "WorkflowAccess", null ] } ] } }, "/v1/workflow-reason-option-mapping/{id}": { "get": { "tags": [ "Workflow Reason Option Mapping" ], "summary": "Gets a workflow by id", "operationId": "GetById", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "id of the workflow to get", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "Gets the workflow with the specified id", "schema": { "$ref": "#/definitions/WorkflowReasonOptionMapping" }, "examples": { "application/json": {"id":336772,"workflowsId":240545,"workflowReasonOptionsId":9201} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "WorkflowAccess", null ] } ] } }, "/v1/workflow-loan-mappings": { "get": { "tags": [ "Workflow Loan Mapping" ], "summary": "Gets all workflow loan mappings", "operationId": "GetPaged", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "page", "description": "The page number of results to retrieve (first page = 1, default = 1)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "perPage", "description": "The number of records to return on each page (minimum = 1, maximum = 1000, default = 200)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "workflowIds", "description": "List of workflow ids to filter by", "type": "array", "items": { "format": "int64", "type": "integer" }, "collectionFormat": "multi" }, { "in": "query", "name": "loanIds", "description": "List of loan ids to filter by", "type": "array", "items": { "format": "int64", "type": "integer" }, "collectionFormat": "multi" }, { "in": "query", "name": "loanType", "description": "Loan type to filter by", "type": "string", "format": "string", "enum": [ "portfolio", "proposed" ] } ], "responses": { "200": { "description": "Gets all current, existing, and active workflow loan mappings in the account", "schema": { "$ref": "#/definitions/CollectionResponse[WorkflowLoanMapping]" }, "examples": { "application/json": {"items":[{"id":336782,"workflowId":12345,"loanId":35241,"loanType":"proposed"},{"id":336783,"workflowId":12345,"loanId":35255,"loanType":"proposed"},{"id":447862,"workflowId":22344,"loanId":66534,"loanType":"portfolio"}]} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "WorkflowAccess", null ] } ] } }, "/v1/workflow-loan-mappings/{id}": { "get": { "tags": [ "Workflow Loan Mapping" ], "summary": "Gets a workflow loan mapping by id", "operationId": "GetById", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "id of the workflow loan mapping to get", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "Gets the workflow loan mapping with the specified id", "schema": { "$ref": "#/definitions/WorkflowLoanMapping" }, "examples": { "application/json": {"id":336782,"workflowId":12345,"loanId":35241,"loanType":"proposed"} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "WorkflowAccess", null ] } ] } }, "/v1/workflow-next-steps": { "get": { "tags": [ "Workflow Next Steps" ], "summary": "Gets next steps for all workflows", "operationId": "GetPaged", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "page", "description": "The page number of results to retrieve (first page = 1, default = 1)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "perPage", "description": "The number of records to return on each page (minimum = 1, maximum = 1000, default = 200)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "workflowIds", "description": "List of workflow ids to filter by", "type": "array", "items": { "format": "int64", "type": "integer" }, "collectionFormat": "multi" } ], "responses": { "200": { "description": "Gets next steps for all current, existing, and active workflows in the account", "schema": { "$ref": "#/definitions/CollectionResponse[WorkflowStep]" }, "examples": { "application/json": {"items":[{"id":1234,"workflowId":5546,"workflowPhaseId":53478,"name":"Review/Upload Documents","status":"completed","stepType":null,"dueDate":"2020-10-10","notes":null,"isDeleted":false,"statusChangedDate":"2020-10-10"},{"id":1235,"workflowId":5564,"workflowPhaseId":53478,"name":"Approve Loan","status":"outstanding","stepType":null,"dueDate":"2020-10-11","notes":null,"isDeleted":false,"statusChangedDate":null}]} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "WorkflowAccess", null ] } ] } }, "/v1/workflow-next-steps/{id}": { "get": { "tags": [ "Workflow Next Steps" ], "summary": "Gets the next Workflow Step for a Workflow", "operationId": "GetByWorkflowId", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "id of the existing Workflow to get the next step for", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "Gets the next WorkflowStep with the specified WorkflowId", "schema": { "$ref": "#/definitions/WorkflowStep" }, "examples": { "application/json": {"id":1235,"workflowId":5564,"workflowPhaseId":53478,"name":"Approve Loan","status":"outstanding","stepType":null,"dueDate":"2020-10-11","notes":null,"isDeleted":false,"statusChangedDate":null} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "WorkflowAccess", null ] } ] } }, "/v1/workflow-role-settings": { "get": { "tags": [ "Workflow Role Settings" ], "summary": "Gets all WorkflowRoleSettings", "operationId": "GetPaged", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "page", "description": "The page number of results to retrieve (first page = 1, default = 1)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "perPage", "description": "The number of records to return on each page (minimum = 1, maximum = 1000, default = 200)", "type": "integer", "format": "int32", "x-nullable": true } ], "responses": { "200": { "description": "Gets all current, existing, and active WorkflowRoleSettings in the account", "schema": { "$ref": "#/definitions/CollectionResponse[WorkflowStepOwnerRole]" }, "examples": { "application/json": {"items":[{"id":343,"roleName":"Credit Officer"},{"id":344,"roleName":"Loan Officer"},{"id":345,"roleName":"Analyst"}]} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "WorkflowAccess", null ] } ] } }, "/v1/workflow-role-settings/{id}": { "get": { "tags": [ "Workflow Role Settings" ], "summary": "Gets a WorkflowRoleSetting by id", "operationId": "GetById", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "id of the existing WorkflowRoleSetting to get", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "Gets the WorkflowRoleSetting with the specified id", "schema": { "$ref": "#/definitions/WorkflowStepOwnerRole" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "WorkflowAccess", null ] } ] } }, "/v1/workflow-role-user-settings": { "get": { "tags": [ "Workflow Role User Settings" ], "summary": "Gets all WorkflowRoleUserSettings", "operationId": "GetPaged", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "page", "description": "The page number of results to retrieve (first page = 1, default = 1)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "perPage", "description": "The number of records to return on each page (minimum = 1, maximum = 1000, default = 200)", "type": "integer", "format": "int32", "x-nullable": true } ], "responses": { "200": { "description": "Gets all current, existing, and active WorkflowRoleUserSettings in the account", "schema": { "$ref": "#/definitions/CollectionResponse[WorkflowRoleUserSetting]" }, "examples": { "application/json": {"items":[{"id":343,"workflowRoleId":12345,"userId":6438,"isDefault":true},{"id":344,"workflowRoleId":44332,"userId":67654,"isDefault":false},{"id":345,"workflowRoleId":2268,"userId":679,"isDefault":false}]} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "WorkflowAccess", null ] } ] } }, "/v1/workflow-role-user-settings/{id}": { "get": { "tags": [ "Workflow Role User Settings" ], "summary": "Gets a WorkflowRoleUserSetting by id", "operationId": "GetById", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "id of the existing WorkflowRoleUserSetting to get", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "Gets the WorkflowRoleUserSetting with the specified id", "schema": { "$ref": "#/definitions/WorkflowRoleUserSetting" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "WorkflowAccess", null ] } ] } }, "/v1/workflow-steps": { "get": { "tags": [ "Workflow Steps" ], "summary": "Gets all WorkflowSteps", "operationId": "GetPaged", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "page", "description": "The page number of results to retrieve (first page = 1, default = 1)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "perPage", "description": "The number of records to return on each page (minimum = 1, maximum = 1000, default = 200)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "workflowIds", "description": "List of workflow ids to filter by", "type": "array", "items": { "format": "int64", "type": "integer" }, "collectionFormat": "multi" }, { "in": "query", "name": "workflowStepName", "description": "Workflow Step Name to filter by", "type": "string" }, { "in": "query", "name": "workflowStepStatus", "description": "Workflow Step Status to filter by", "type": "string", "enum": [ "pending", "outstanding", "completed", "waived", "approved", "notApproved", "notRequired", "notApplicable", "running" ], "x-nullable": true }, { "in": "query", "name": "workflowPhaseId", "description": "Workflow Phase Id to filter by", "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "Gets all current, existing, and active WorkflowSteps in the account", "schema": { "$ref": "#/definitions/CollectionResponse[WorkflowStep]" }, "examples": { "application/json": {"items":[{"id":1234,"workflowId":5546,"workflowPhaseId":53478,"name":"Review/Upload Documents","status":"completed","stepType":null,"dueDate":"2020-10-10","notes":null,"isDeleted":false,"statusChangedDate":"2020-10-10"},{"id":1235,"workflowId":5564,"workflowPhaseId":53478,"name":"Approve Loan","status":"outstanding","stepType":null,"dueDate":"2020-10-11","notes":null,"isDeleted":false,"statusChangedDate":null}]} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "WorkflowAccess", null ] } ] } }, "/v1/workflow-steps/{id}": { "get": { "tags": [ "Workflow Steps" ], "summary": "Gets a WorkflowStep by id", "operationId": "GetById", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "id of the existing WorkflowStep to get", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "Gets the WorkflowStep with the specified id", "schema": { "$ref": "#/definitions/WorkflowStep" }, "examples": { "application/json": {"id":1235,"workflowId":5564,"workflowPhaseId":53478,"name":"Approve Loan","status":"outstanding","stepType":null,"dueDate":"2020-10-11","notes":null,"isDeleted":false,"statusChangedDate":null} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "WorkflowAccess", null ] } ] } }, "/v1/workflow-steps/{id}/update-status": { "post": { "tags": [ "Workflow Steps" ], "summary": "Updates the status of a workflow step", "operationId": "UpdateStepStatus", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "required": true, "type": "integer", "format": "int32" }, { "in": "query", "name": "userId", "description": "The user id on which status updates should be made on behalf of", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "body", "name": "body", "description": "A request representing the information needed to update the workflow step.", "schema": { "$ref": "#/definitions/WorkflowStepStatusUpdateRequest" } } ], "responses": { "200": { "description": "The WorkflowStep has been updated successfully. The WorkflowStep that was updated\r\n is returned.", "schema": { "$ref": "#/definitions/WorkflowStepResponseExample" }, "examples": { "application/json": {"id":1235,"workflowId":5564,"workflowPhaseId":53478,"name":"Approve Loan","status":"outstanding","stepType":null,"dueDate":"2020-10-11","notes":null,"isDeleted":false,"statusChangedDate":null} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "WorkflowAccess", null ] } ] } }, "/v1/workflow-step-list-items": { "get": { "tags": [ "Workflow Step List Items" ], "summary": "Gets all WorkflowStepListItems", "operationId": "GetPaged", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "page", "description": "The page number of results to retrieve (first page = 1, default = 1)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "perPage", "description": "The number of records to return on each page (minimum = 1, maximum = 1000, default = 200)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "workflowStepIds", "description": "List of workflow step ids to filter by", "type": "array", "items": { "format": "int64", "type": "integer" }, "collectionFormat": "multi" } ], "responses": { "200": { "description": "Gets all current, existing, and active WorkflowStepListItems in the account", "schema": { "$ref": "#/definitions/CollectionResponse[WorkflowStepListItem]" }, "examples": { "application/json": {"items":[{"id":1234,"workflowStepId":5546,"name":"Tax Return","status":"completed","notes":"Completed on 10-31-2022","isDeleted":false,"completionDate":"2022-10-31"},{"id":1235,"workflowStepId":5564,"name":"Flood Insurance","status":"outstanding","notes":"Verify flood zone","isDeleted":false,"completionDate":null}]} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "WorkflowAccess", null ] } ] } }, "/v1/workflow-step-list-items/{id}/update-status": { "post": { "tags": [ "Workflow Step List Items" ], "summary": "Updates the status of a workflow step list item", "operationId": "UpdateStepStatus", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "required": true, "type": "integer", "format": "int32" }, { "in": "body", "name": "body", "description": "A request representing the information needed to update the workflow step list item.", "schema": { "$ref": "#/definitions/WorkflowStepListItemStatusUpdateRequest" } } ], "responses": { "200": { "description": "The WorkflowStepListItem has been updated successfully. The WorkflowStepListItem that was updated\r\n is returned.", "schema": { "$ref": "#/definitions/WorkflowStepListItem" }, "examples": { "application/json": {"id":1234,"workflowStepId":5546,"name":"Tax Return","status":"completed","notes":"Completed on 10-31-2022","isDeleted":false,"completionDate":null} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "WorkflowAccess", null ] } ] } }, "/v1/workflow-step-owner-mappings": { "get": { "tags": [ "Workflow Step Owner Mappings" ], "summary": "Gets all workflow step owner mappings", "operationId": "GetPaged", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "page", "description": "The page number of results to retrieve (first page = 1, default = 1)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "perPage", "description": "The number of records to return on each page (minimum = 1, maximum = 1000, default = 200)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "workflowStepIds", "description": "List of workflow step ids to filter by", "type": "array", "items": { "format": "int64", "type": "integer" }, "collectionFormat": "multi" }, { "in": "query", "name": "ownerUserIds", "description": "List of owner ids to filter by", "type": "array", "items": { "format": "int64", "type": "integer" }, "collectionFormat": "multi" } ], "responses": { "200": { "description": "Gets all current, existing, and active workflow step owner mappings in the account", "schema": { "$ref": "#/definitions/CollectionResponse[WorkflowStepOwnerMapping]" }, "examples": { "application/json": {"items":[{"id":336782,"workflowStepId":12345,"ownerUserId":35241},{"id":336783,"workflowStepId":14445,"ownerUserId":35255},{"id":447862,"workflowStepId":22344,"ownerUserId":66534}]} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "WorkflowAccess", null ] } ] } }, "/v1/workflow-step-owner-mappings/{id}": { "get": { "tags": [ "Workflow Step Owner Mappings" ], "summary": "Gets a workflow loan mapping by id", "operationId": "GetById", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "id of the workflow step owner mapping to get", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "Gets the workflow step owner mapping with the specified id", "schema": { "$ref": "#/definitions/WorkflowStepOwnerMapping" }, "examples": { "application/json": {"id":336782,"workflowStepId":12345,"ownerUserId":35241} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "WorkflowAccess", null ] } ] } }, "/v1/workflow-templates": { "get": { "tags": [ "Workflow Templates" ], "summary": "Gets all workflow templates", "operationId": "GetWorkflowTemplates", "produces": [ "application/json" ], "responses": { "200": { "description": "Gets all workflow templates in the account", "schema": { "$ref": "#/definitions/CollectionResponse[WorkflowTemplate]" }, "examples": { "application/json": {"items":[{"id":11111,"name":"Workflow Template #1","isPublished":false},{"id":22222,"name":"Workflow Template #2","isPublished":false}]} } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "WorkflowAccess", null ] } ] } }, "/v1/workflow-template-phases": { "get": { "tags": [ "Workflow Template Phases" ], "summary": "Gets all WorkflowTemplatePhases", "operationId": "GetPaged", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "page", "description": "The page number of results to retrieve (first page = 1, default = 1)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "perPage", "description": "The number of records to return on each page (minimum = 1, maximum = 1000, default = 200)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "workflowTemplateIds", "description": "List of workflow template ids to filter by", "type": "array", "items": { "format": "int32", "type": "integer", "x-nullable": true }, "collectionFormat": "multi" } ], "responses": { "200": { "description": "Gets all current, existing, and active WorkflowTemplatePhases in the account", "schema": { "$ref": "#/definitions/CollectionResponse[WorkflowTemplatePhase]" }, "examples": { "application/json": {"items":[{"id":1234,"name":"Review/Upload Documents","type":"standard","position":6,"isOptional":false,"workflowTemplateId":12345,"isDeleted":false},{"id":1235,"name":"Approve Loan","type":"finalApproval","position":7,"isOptional":false,"workflowTemplateId":6789,"isDeleted":false}]} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "WorkflowAccess", null ] } ] } }, "/v1/workflow-template-phases/{id}": { "get": { "tags": [ "Workflow Template Phases" ], "summary": "Gets a WorkflowTemplatePhase by id", "operationId": "GetById", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "id of the existing WorkflowTemplatePhase to get", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "Gets the WorkflowTemplatePhase with the specified id", "schema": { "$ref": "#/definitions/WorkflowTemplatePhase" }, "examples": { "application/json": {"id":336772,"name":"Closing","type":"finalApproval","position":10,"isOptional":false,"workflowTemplateId":12345,"isDeleted":false} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "WorkflowAccess", null ] } ] } }, "/v1/user-role-mappings": { "get": { "tags": [ "Users" ], "summary": "Gets all UserRoleMapping", "operationId": "GetPaged", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "page", "description": "The page number of results to retrieve (first page = 1, default = 1)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "perPage", "description": "The number of records to return on each page (minimum = 1, maximum = 1000, default = 200)", "type": "integer", "format": "int32", "x-nullable": true } ], "responses": { "200": { "description": "Gets all UserRoleMappings", "schema": { "$ref": "#/definitions/CollectionResponse[UserRoleMapping]" }, "examples": { "application/json": {"id":12345,"userId":567,"userRoleId":788} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] } }, "/v1/user-role-mappings/{id}": { "get": { "tags": [ "Users" ], "summary": "Gets a UserRoleMapping by id", "operationId": "GetById", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "id of the existing UserRoleMapping to get", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "Gets the UserRoleMapping with the specified id", "schema": { "$ref": "#/definitions/UserRoleMapping" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] } }, "/v1/user-roles": { "get": { "tags": [ "Users" ], "summary": "Gets all user roles", "operationId": "GetPaged", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "page", "description": "The page number of results to retrieve (first page = 1, default = 1)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "perPage", "description": "The number of records to return on each page (minimum = 1, maximum = 1000, default = 200)", "type": "integer", "format": "int32", "x-nullable": true } ], "responses": { "200": { "description": "Gets all roles", "schema": { "$ref": "#/definitions/CollectionResponse[UserRole]" }, "examples": { "application/json": {"id":12345,"name":"Admin","isDeleted":false} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] } }, "/v1/user-roles/{id}": { "get": { "tags": [ "Users" ], "summary": "Gets a Role by id", "operationId": "GetById", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "id of the existing Role to get", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "Gets the Role with the specified id", "schema": { "$ref": "#/definitions/UserRole" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] } }, "/v1/tickler-loan-mappings": { "get": { "tags": [ "Tickler Loan Mappings" ], "summary": "Gets all tickler loan mappings", "operationId": "GetPaged", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "page", "description": "The page number of results to retrieve (first page = 1, default = 1)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "perPage", "description": "The number of records to return on each page (minimum = 1, maximum = 1000, default = 200)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "portfolioLoanId", "description": "Portfolio Loan Id to filter by", "type": "integer", "format": "int32" }, { "in": "query", "name": "ticklerId", "description": "Tickler Id to filter by", "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "Gets all tickler loan mappings in the account", "schema": { "$ref": "#/definitions/CollectionResponse[TicklerLoanMapping]" }, "examples": { "application/json": {"items":[{"id":23165421,"ticklerId":6554513,"portfolioLoanId":6645134,"isProposed":false},{"id":23165422,"ticklerId":6554513,"portfolioLoanId":6645155,"isProposed":false}]} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] } }, "/v1/tickler-loan-mappings/{id}": { "get": { "tags": [ "Tickler Loan Mappings" ], "summary": "Gets a tickler loan mapping by id", "operationId": "GetById", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "id of the tickler loan mapping to get", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "Gets the tickler loan mapping with the specified id", "schema": { "$ref": "#/definitions/TicklerLoanMapping" }, "examples": { "application/json": {"id":23165421,"ticklerId":6554513,"portfolioLoanId":6645134,"isProposed":false} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] } }, "/v1/tickler-requests": { "get": { "tags": [ "Tickler Requests" ], "summary": "Gets all tickler requests", "operationId": "GetPaged", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "page", "description": "The page number of results to retrieve (first page = 1, default = 1)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "perPage", "description": "The number of records to return on each page (minimum = 1, maximum = 1000, default = 200)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "ticklerId", "description": "Filter by tickler ID", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "status", "description": "Filter by request status", "type": "string", "enum": [ "received", "waived", "extended", "closed" ], "x-nullable": true } ], "responses": { "200": { "description": "Returns a paginated list of tickler requests", "schema": { "$ref": "#/definitions/CollectionResponse[TicklerRequest]" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] } }, "/v1/tickler-requests/{id}": { "get": { "tags": [ "Tickler Requests" ], "summary": "Gets a tickler request by identifier", "operationId": "GetById", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "Unique identifier of the tickler request", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "Returns the tickler request with the specified identifier", "schema": { "$ref": "#/definitions/TicklerRequest" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] }, "patch": { "tags": [ "Tickler Requests" ], "summary": "Updates a tickler request (partial update)", "description": "Updates specific fields of a tickler request. Only specified fields will be updated.\r\n \r\n**Updateable Fields:**\r\n- `status` - Request status (received, waived, extended, closed, or null to clear)\r\n- `documentIdentifier` - Document identifier\r\n- `documentLocation` - Document location\r\n- `comments` - Comments\r\n- `closeTickler` - Set to true to close the parent tickler\r\n \r\n**Status Changes:**\r\n- Date fields (receivedDate, extendedDate, disabledDate) can only be updated when changing status\r\n- Dates default to today if not provided\r\n- Setting status to `extended` will extend the request's due date\r\n- One-time ticklers automatically close when all requests are received or waived", "operationId": "Update", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "Unique identifier of the tickler request", "required": true, "type": "integer", "format": "int32" }, { "in": "body", "name": "body", "description": "Tickler request model with fields to update", "schema": { "$ref": "#/definitions/TicklerRequest" } } ], "responses": { "200": { "description": "Returns the updated tickler request", "schema": { "$ref": "#/definitions/TicklerRequest" } }, "400": { "description": "Invalid request or business rule violation", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Tickler request not found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] } }, "/v1/ticklers": { "get": { "tags": [ "Ticklers" ], "summary": "Gets all ticklers", "operationId": "GetPaged", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "page", "description": "The page number of results to retrieve (first page = 1, default = 1)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "perPage", "description": "The number of records to return on each page (minimum = 1, maximum = 1000, default = 200)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "customerId", "description": "Customer Id to filter by", "type": "integer", "format": "int32" }, { "in": "query", "name": "ids", "description": "List of Ids to filter by", "type": "array", "items": { "format": "int64", "type": "integer" }, "collectionFormat": "multi" } ], "responses": { "200": { "description": "Gets all current, existing, and active ticklers in the account", "schema": { "$ref": "#/definitions/CollectionResponse[Tickler]" }, "examples": { "application/json": {"items":[{"id":123141,"customerId":4552432,"loanOfficerId":4324,"comments":"General Tickler Comments","documentAppliesToCustomerId":5543255,"documentRecipientToCustomerId":12312,"documentIdentifier":"A234B","documentLocation":"Location","ticklerName":"Accounts Payable Aging","frequency":"one-time","nextDueDate":"2021-02-20","nextPdEndDate":"2021-03-20","bankLoanCollateralId":98765},{"id":193716,"customerId":4735262,"loanOfficerId":4324,"comments":"General Tickler Comments","documentAppliesToCustomerId":9937255,"documentRecipientToCustomerId":null,"documentIdentifier":"A234B","documentLocation":"Location","ticklerName":"Business Tax Return","frequency":"annual","nextDueDate":"2021-04-15","nextPdEndDate":"2021-04-15","bankLoanCollateralId":98765}]} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] } }, "/v1/ticklers/{id}": { "get": { "tags": [ "Ticklers" ], "summary": "Gets a tickler by id", "operationId": "GetById", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "id of the tickler to get", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "Gets the tickler with the specified id", "schema": { "$ref": "#/definitions/Tickler" }, "examples": { "application/json": {"id":123141,"customerId":4552432,"loanOfficerId":4324,"comments":"General Tickler Comments","documentAppliesToCustomerId":5543255,"documentRecipientToCustomerId":12312,"documentIdentifier":"A234B","documentLocation":"Location","ticklerName":"Accounts Payable Aging","frequency":"one-time","nextDueDate":"2021-02-20","nextPdEndDate":"2021-03-20","bankLoanCollateralId":98765} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] } }, "/v1/ticklers/detailed": { "get": { "tags": [ "Ticklers" ], "operationId": "GetDetailedTicklers", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "page", "description": "The page number of results to retrieve (first page = 1, default = 1)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "perPage", "description": "The number of records to return on each page (minimum = 1, maximum = 1000, default = 200)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "isPastDue", "type": "boolean" }, { "in": "query", "name": "dueDateHorizonDays", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "loanOfficerId", "type": "integer", "format": "int64", "x-nullable": true } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/DetailedTicklerResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] } }, "/v2/ticklers": { "get": { "tags": [ "Ticklers V2" ], "summary": "Gets all ticklers", "operationId": "GetPaged", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "page", "description": "The page number of results to retrieve (first page = 1, default = 1)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "perPage", "description": "The number of records to return on each page (minimum = 1, maximum = 1000, default = 200)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "ids", "description": "Filter by specific tickler ids", "type": "array", "items": { "format": "int64", "type": "integer" }, "collectionFormat": "multi" }, { "in": "query", "name": "ticklerAppliesToCustomerId", "description": "Filter by the id of the customer the tickler applies to", "type": "integer", "format": "int64", "x-nullable": true }, { "in": "query", "name": "personResponsibleId", "description": "Filter by the id of the user responsible for the tickler", "type": "integer", "format": "int64", "x-nullable": true }, { "in": "query", "name": "isPastDue", "description": "When true, returns only ticklers that are past due", "type": "boolean", "x-nullable": true }, { "in": "query", "name": "dueDateHorizonDays", "description": "Filter to ticklers due within the specified number of days", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "closed", "description": "Filter by closed status. When true, includes closed ticklers. When false or not specified, excludes closed ticklers.", "type": "boolean", "x-nullable": true }, { "in": "query", "name": "classification", "description": "Filter by classification (e.g., \"financialdocument\", \"otherdocument\")", "type": "string" } ], "responses": { "200": { "description": "Returns a paginated list of ticklers", "schema": { "$ref": "#/definitions/CollectionResponse[TicklerV2]" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] }, "post": { "tags": [ "Ticklers V2" ], "summary": "Creates a new tickler with v2 field naming", "operationId": "Create", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "The tickler to create", "schema": { "$ref": "#/definitions/TicklerV2" } } ], "responses": { "201": { "description": "The tickler has been created successfully", "schema": { "$ref": "#/definitions/TicklerV2" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] } }, "/v2/ticklers/{id}": { "get": { "tags": [ "Ticklers V2" ], "summary": "Gets a tickler by identifier", "operationId": "GetById", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "Unique identifier of the tickler", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "Returns the tickler with the specified identifier", "schema": { "$ref": "#/definitions/TicklerV2" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] }, "patch": { "tags": [ "Ticklers V2" ], "summary": "Updates an existing tickler", "operationId": "Update", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "Unique identifier of the tickler", "required": true, "type": "integer", "format": "int32" }, { "in": "body", "name": "body", "description": "The tickler properties to update", "schema": { "$ref": "#/definitions/TicklerV2" } } ], "responses": { "200": { "description": "Returns the updated tickler", "schema": { "$ref": "#/definitions/TicklerV2" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] } }, "/v1/tax-return-reader": { "post": { "tags": [ "Electronic Tax Return Reader" ], "summary": "Extracts all data from a tax return PDF file", "operationId": "ExtractData", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "Request object containing the base64 encoded (RFC 2045) PDF file and password to open the file (if applicable)", "schema": { "$ref": "#/definitions/TaxReturnReaderParsePdfRequest" } } ], "responses": { "200": { "description": "The tax return has been processed successfully, and the list of tax return\r\n line items that were parsed from the PDF tax return is returned", "schema": { "$ref": "#/definitions/TaxReturnReaderResponse" }, "examples": { "application/json": {"taxFormItems":[{"year":"2010","form":"1065","schedule":"","page":2,"line":"Name","itemValue":"Example Customer","rawText":null,"ddkey":null},{"year":"2010","form":"1065","schedule":"","page":2,"line":"1a","itemValue":"4","rawText":null,"ddkey":null},{"year":"2010","form":"1065","schedule":"","page":2,"line":"1b","itemValue":"2","rawText":null,"ddkey":null},{"year":"2010","form":"1065","schedule":"","page":2,"line":"2","itemValue":"-59","rawText":null,"ddkey":null}]} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] } }, "/v1/proposed-sba-loan-details": { "get": { "tags": [ "Proposed SBA Loan Details" ], "summary": "Gets all proposed loan sba details", "operationId": "GetPaged", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "page", "description": "The page number of results to retrieve (first page = 1, default = 1)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "perPage", "description": "The number of records to return on each page (minimum = 1, maximum = 1000, default = 200)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "ids", "description": "List of proposed loan ids to filter by", "type": "array", "items": { "format": "int64", "type": "integer" }, "collectionFormat": "multi" }, { "in": "query", "name": "processingMethodType", "description": "SBA Application Processing Method Type to filter by", "type": "string", "enum": [ "general", "sbaExpress", "plpLenderUnderwrite", "communityAdvantage", "other", "paycheckProtectionProgram", "sevenAWithWcp", "sevenAWithEwcp", "communityAdvantageInternationalTrade", "contractLoanLineOfCredit", "exportExpress", "internationalTradeLoans", "marC7aGeneral", "preferredLendersWithEWCP", "plpmarc", "preferredLendersWithWCP", "buildersLineOfCredit", "seasonalLineOfCredit", "standardAssetBaseWorkingCapitalLineOfCredit" ], "x-nullable": true }, { "in": "query", "name": "isSecondDraw", "description": "Filter by whether a loan is a Second Draw (only applies to PPP Processing Method)", "type": "boolean", "x-nullable": true } ], "responses": { "200": { "description": "Gets all proposed loan sba details", "schema": { "$ref": "#/definitions/CollectionResponse[ProposedSBALoanDetails]" }, "examples": { "application/json": {"items":[{"id":336772,"applicantBusinessCustomerId":12341,"isSecondDrawLoan":true,"applicationProcessingMethodType":"paycheckProtectionProgram","firstDrawSbaLoanNumber":"334335","firstDrawLoanAmount":60053.1,"sbaGuaranteePercentage":2.0},{"id":336776,"applicantBusinessCustomerId":44322,"isSecondDrawLoan":null,"applicationProcessingMethodType":"sbaExpress","firstDrawSbaLoanNumber":null,"firstDrawLoanAmount":null,"sbaGuaranteePercentage":5.0},{"id":336789,"applicantBusinessCustomerId":22314,"isSecondDrawLoan":false,"applicationProcessingMethodType":"paycheckProtectionProgram","firstDrawSbaLoanNumber":null,"firstDrawLoanAmount":null,"sbaGuaranteePercentage":3.0}]} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] } }, "/v1/proposed-sba-loan-details/{id}": { "get": { "tags": [ "Proposed SBA Loan Details" ], "summary": "Gets the proposed loan sba details by id", "operationId": "GetById", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "id of the proposed loan to get", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "Gets the the proposed loan sba details with the specified proposed loan id", "schema": { "$ref": "#/definitions/ProposedSBALoanDetails" }, "examples": { "application/json": {"id":336772,"applicantBusinessCustomerId":12341,"isSecondDrawLoan":true,"applicationProcessingMethodType":"paycheckProtectionProgram","firstDrawSbaLoanNumber":"334335","firstDrawLoanAmount":60053.1,"sbaGuaranteePercentage":5.0} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] } }, "/v1/sba-forms": { "get": { "tags": [ "Sba Forms" ], "summary": "Gets all SBA forms", "operationId": "GetPaged", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "page", "description": "The page number of results to retrieve (first page = 1, default = 1)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "perPage", "description": "The number of records to return on each page (minimum = 1, maximum = 1000, default = 200)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "status", "description": "SBA Form Status to filter by", "type": "string", "format": "string", "enum": [ "new", "sent", "inProgress", "underReview", "approved", "declined", "waived" ] }, { "in": "query", "name": "type", "description": "SBA Form Type to filter by", "type": "string", "format": "string", "enum": [ "form1920", "form1919ApplicantBusinessInformation", "form1919PersonPrincipalInformation", "form2484", "form2483ApplicantBusinessInformation", "form147", "form3508", "form1919BusinessPrincipalInformation", "form1919BusinessInformationJan2024Revision", "personDemographicsInformation" ] } ], "responses": { "200": { "description": "Gets all current, existing, and active SBA forms in the account", "schema": { "$ref": "#/definitions/CollectionResponse[SbaForm]" }, "examples": { "application/json": {"items":[{"formType":"form2483ApplicantBusinessInformation","status":"approved","id":336772,"customerId":12311,"proposedLoanId":44231,"statusReason":"Approved by SBA","statusChangedById":443552,"statusChangedDate":"2021-01-25"},{"formType":"form1919BusinessPrincipalInformation","status":"underReview","id":3367723,"customerId":12311,"proposedLoanId":44231,"statusReason":"Being reviewed","statusChangedById":665891,"statusChangedDate":"2021-01-23"}]} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] } }, "/v1/sba-forms/{id}": { "get": { "tags": [ "Sba Forms" ], "summary": "Gets a SBA form by id", "operationId": "GetById", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "id of the SBA form to get", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "Gets the SBA form with the specified id", "schema": { "$ref": "#/definitions/SbaForm" }, "examples": { "application/json": {"formType":"form2483ApplicantBusinessInformation","status":"approved","id":336772,"customerId":12311,"proposedLoanId":44231,"statusReason":"Approved by SBA","statusChangedById":443552,"statusChangedDate":"2021-01-25"} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] } }, "/v1/risk-rating-approvals/approve/{calculationId}": { "post": { "tags": [ "Risk Rating Approvals" ], "operationId": "ApproveRiskRating", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "calculationId", "required": true, "type": "integer", "format": "int32" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/RiskRatingDecisionInputModel" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/RiskRatingCalculationApproval" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] } }, "/v1/risk-rating-approvals/decline/{calculationId}": { "post": { "tags": [ "Risk Rating Approvals" ], "operationId": "DeclineRiskRating", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "calculationId", "required": true, "type": "integer", "format": "int32" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/RiskRatingDecisionInputModel" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/RiskRatingCalculationApproval" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] } }, "/v1/risk-rating-approvals/withdraw/{calculationId}": { "post": { "tags": [ "Risk Rating Approvals" ], "operationId": "WithdrawRiskRating", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "calculationId", "required": true, "type": "integer", "format": "int32" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/RiskRatingDecisionInputModel" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/RiskRatingCalculationApproval" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] } }, "/v1/risk-rating-approvals/defer/{calculationId}": { "post": { "tags": [ "Risk Rating Approvals" ], "operationId": "DeferRiskRating", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "calculationId", "required": true, "type": "integer", "format": "int32" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/RiskRatingDecisionInputModel" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/RiskRatingCalculationApproval" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] } }, "/v1/risk-rating-approvals/needs-revision/{calculationId}": { "post": { "tags": [ "Risk Rating Approvals" ], "operationId": "RiskRatingNeedsRevision", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "calculationId", "required": true, "type": "integer", "format": "int32" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/RiskRatingDecisionInputModel" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/RiskRatingCalculationApproval" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] } }, "/v1/risk-rating-calculations": { "get": { "tags": [ "Risk Rating Calculations" ], "summary": "Gets a paged list of Risk Rating Calculations based on provided filters.", "operationId": "GetPaged", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "page", "description": "The page number of results to retrieve (first page = 1, default = 1)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "perPage", "description": "The number of records to return on each page (minimum = 1, maximum = 1000, default = 200)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "entityId", "description": "Id of the Entity to filter by", "type": "integer", "format": "int64", "x-nullable": true }, { "in": "query", "name": "proposedLoanId", "description": "Id of the Proposed Loan to filter by", "type": "integer", "format": "int64", "x-nullable": true }, { "in": "query", "name": "portfolioLoanId", "description": "Id of Portfolio Loan to filter by", "type": "integer", "format": "int64", "x-nullable": true }, { "in": "query", "name": "lastModifiedDateFrom", "description": "Start date of the LastModifiedDate range to filter by. This date is INCLUSIVE.", "type": "string", "format": "date-time", "x-nullable": true }, { "in": "query", "name": "lastModifiedDateTo", "description": "End date of the LastModifiedDate range to filter by. This date is INCLUSIVE.", "type": "string", "format": "date-time", "x-nullable": true }, { "in": "query", "name": "isBorrowerRating", "description": "Filter for calculations that are at the borrower level rather and not associated with a loan", "type": "boolean", "x-nullable": true } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/CollectionResponse[RiskRatingCalculation]" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] } }, "/v1/risk-rating-calculations/{id}": { "get": { "tags": [ "Risk Rating Calculations" ], "summary": "Gets a Risk Rating Calculation by id", "operationId": "GetById", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "id of the Risk Rating calculation to get", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "Gets the Risk Rating calculation with the specified id", "schema": { "$ref": "#/definitions/RiskRatingCalculationWithSectionsAndFactors" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] } }, "/v1/revenue-products": { "post": { "tags": [ "Revenue Products" ], "summary": "Creates a RevenueProduct", "operationId": "Create", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "The RevenueProduct to create", "schema": { "$ref": "#/definitions/RevenueProduct" } } ], "responses": { "201": { "description": "The RevenueProduct has been created successfully. The RevenueProduct that was created\r\n is returned and has the Sageworks id that was assigned.", "schema": { "$ref": "#/definitions/RevenueProduct" }, "examples": { "application/json": {"id":1235456,"identifier":"748694","revenueProductTypeId":0,"customerId":12345,"annualRevenue":0.0,"oneTimeRevenue":0.0,"averageBalance":0.0,"originationDate":"2016-03-14","amortizedMonths":1,"timesFeeChargedAnnually":2,"feeAmount":0.0,"comments":"","isProposed":false,"isDeleted":false} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] }, "get": { "tags": [ "Revenue Products" ], "summary": "Gets all revenue products.", "description": "These endpoints are used to interact with both existing and proposed revenue products.\r\nIf you would like to only retrieve existing or proposed revenue products, use the isProposed filter\r\n \r\nisProposed=true will only return proposed revenue products\r\nisProposed=false will only return existing revenue products\r\n \r\nIf you do not pass in any isProposed filter, both existing and proposed revenue products will be returned", "operationId": "GetPaged", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "page", "description": "The page number of results to retrieve (first page = 1, default = 1)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "perPage", "description": "The number of records to return on each page (minimum = 1, maximum = 1000, default = 200)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "customerId", "description": "CustomerId value to filter by", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "isProposed", "description": "IsProposed value to filter by", "type": "boolean", "x-nullable": true }, { "in": "query", "name": "excludeRevenueProductsForDeletedCustomers", "description": "Set to true to ensure the revenue products returned are not linked to deleted primary borrowers", "type": "boolean", "default": false } ], "responses": { "200": { "description": "Gets all current, existing, and active RevenueProducts in the account", "schema": { "$ref": "#/definitions/CollectionResponse[RevenueProduct]" }, "examples": { "application/json": {"items":[{"id":0,"uniqueIdentifier":"78456","customerId":12345,"revenueProductTypeId":0,"annualRevenue":0.0,"oneTimeRevenue":0.0,"averageBalance":0.0,"originationDate":"2017-04-22","amortizedMonths":1,"timesFeeChargedAnnually":2,"feeAmount":0.0,"comments":"string","isProposed":false,"isDeleted":false},{"id":0,"uniqueIdentifier":"12364756","customerId":12345,"revenueProductTypeId":2,"annualRevenue":0.0,"oneTimeRevenue":0.0,"averageBalance":0.0,"originationDate":"2016-01-31","amortizedMonths":1,"timesFeeChargedAnnually":2,"feeAmount":0.0,"comments":"string","isProposed":false,"isDeleted":false}]} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] } }, "/v1/revenue-products/bulk": { "patch": { "tags": [ "Revenue Products" ], "summary": "Updates a collection of revenue products", "operationId": "UpdateMany", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "The collection of revenue products to update", "schema": { "$ref": "#/definitions/BulkUpdateRequest[RevenueProduct]" } } ], "responses": { "200": { "description": "All revenue products were processed. Please check the errors property of the response object\r\n to determine if there were errors updating any individual revenue product", "schema": { "$ref": "#/definitions/BulkUpdateRequest[RevenueProduct]" }, "examples": { "application/json": {"itemsUpdated":[{"id":0,"uniqueIdentifier":"78456","customerId":12345,"revenueProductTypeId":0,"annualRevenue":0.0,"oneTimeRevenue":0.0,"averageBalance":0.0,"originationDate":"2017-04-22","amortizedMonths":1,"timesFeeChargedAnnually":2,"feeAmount":0.0,"comments":"string","isProposed":false,"isDeleted":false},{"id":0,"uniqueIdentifier":"12364756","customerId":12345,"revenueProductTypeId":2,"annualRevenue":0.0,"oneTimeRevenue":0.0,"averageBalance":0.0,"originationDate":"2016-01-31","amortizedMonths":1,"timesFeeChargedAnnually":2,"feeAmount":0.0,"comments":"string","isProposed":false,"isDeleted":false},null,{"id":0,"uniqueIdentifier":"6546456","customerId":12345,"revenueProductTypeId":2,"annualRevenue":0.0,"oneTimeRevenue":0.0,"averageBalance":0.0,"originationDate":"2016-01-31","amortizedMonths":1,"timesFeeChargedAnnually":2,"feeAmount":0.0,"comments":"string","isProposed":false,"isDeleted":false}],"errors":{"2":{"errorType":"invalidRequest","message":"Input model for request is invalid","modelErrors":[{"propertyName":"uniqueIdentifier","message":"A revenue product with uniqueIdentifier '1234' already exists"}]}}} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] }, "post": { "tags": [ "Revenue Products" ], "summary": "Creates a collection of revenue products", "operationId": "CreateMany", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "The collection of revenue products to create", "schema": { "$ref": "#/definitions/BulkCreateRequest[RevenueProduct]" } } ], "responses": { "200": { "description": "All revenue products were processed. Please check the errors property of the response object\r\n to determine if there were errors creating any individual revenue product", "schema": { "$ref": "#/definitions/BulkCreateResponse[RevenueProduct]" }, "examples": { "application/json": {"itemsCreated":[{"id":0,"uniqueIdentifier":"78456","customerId":12345,"revenueProductTypeId":0,"annualRevenue":0.0,"oneTimeRevenue":0.0,"averageBalance":0.0,"originationDate":"2017-04-22","amortizedMonths":1,"timesFeeChargedAnnually":2,"feeAmount":0.0,"comments":"string","isProposed":false,"isDeleted":false},{"id":0,"uniqueIdentifier":"12364756","customerId":12345,"revenueProductTypeId":2,"annualRevenue":0.0,"oneTimeRevenue":0.0,"averageBalance":0.0,"originationDate":"2016-01-31","amortizedMonths":1,"timesFeeChargedAnnually":2,"feeAmount":0.0,"comments":"string","isProposed":false,"isDeleted":false},null,{"id":0,"uniqueIdentifier":"6546456","customerId":12345,"revenueProductTypeId":2,"annualRevenue":0.0,"oneTimeRevenue":0.0,"averageBalance":0.0,"originationDate":"2016-01-31","amortizedMonths":1,"timesFeeChargedAnnually":2,"feeAmount":0.0,"comments":"string","isProposed":false,"isDeleted":false}],"errors":{"2":{"errorType":"invalidRequest","message":"Input model for request is invalid","modelErrors":[{"propertyName":"uniqueIdentifier","message":"A revenue product with uniqueIdentifier '1234' already exists"}]}}} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] } }, "/v1/revenue-products/{id}": { "get": { "tags": [ "Revenue Products" ], "summary": "Gets a RevenueProduct by id", "operationId": "GetById", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "id of the existing revenueProduct to get", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "Gets the revenueProduct with the specified id", "schema": { "$ref": "#/definitions/RevenueProduct" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] }, "patch": { "tags": [ "Revenue Products" ], "summary": "Updates a RevenueProduct", "operationId": "Update", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "id of the existing RevenueProduct to update", "required": true, "type": "integer", "format": "int32" }, { "in": "body", "name": "body", "description": "The RevenueProduct values to update", "schema": { "$ref": "#/definitions/RevenueProduct" } } ], "responses": { "200": { "description": "Returns the modified RevenueProduct", "schema": { "$ref": "#/definitions/RevenueProduct" }, "examples": { "application/json": {"id":1235456,"identifier":"748694","revenueProductTypeId":0,"customerId":12345,"annualRevenue":0.0,"oneTimeRevenue":0.0,"averageBalance":0.0,"originationDate":"2016-03-14","amortizedMonths":1,"timesFeeChargedAnnually":2,"feeAmount":0.0,"comments":"","isProposed":false,"isDeleted":false} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] }, "delete": { "tags": [ "Revenue Products" ], "summary": "Deletes a RevenueProduct by id", "operationId": "Delete", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "id of the existing RevenueProduct to delete", "required": true, "type": "integer", "format": "int32" } ], "responses": { "204": { "description": "The RevenueProduct has been deleted successfully." }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] } }, "/v1/proposed-deposit-stages": { "get": { "tags": [ "Proposed Deposit Stages" ], "summary": "Gets all proposed deposit stages", "operationId": "GetPaged", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "page", "description": "The page number of results to retrieve (first page = 1, default = 1)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "perPage", "description": "The number of records to return on each page (minimum = 1, maximum = 1000, default = 200)", "type": "integer", "format": "int32", "x-nullable": true } ], "responses": { "200": { "description": "Gets all current, existing, and active proposed deposit stages in the account", "schema": { "$ref": "#/definitions/CollectionResponse[ProposedDepositStage]" }, "examples": { "application/json": {"items":[{"id":71466,"isDeleted":false,"name":"Application Started","displayOrder":1},{"id":71467,"isDeleted":false,"name":"Application Completed","displayOrder":2},{"id":71469,"isDeleted":false,"name":"Pending Board Approval","displayOrder":4},{"id":71471,"isDeleted":false,"name":"Closed","displayOrder":6}]} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] } }, "/v1/proposed-deposit-stages/{id}": { "get": { "tags": [ "Proposed Deposit Stages" ], "summary": "Gets a proposed deposit stage by id", "operationId": "GetById", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "id of the proposed deposit stage to get", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "Gets the proposed deposit stage with the specified id", "schema": { "$ref": "#/definitions/ProposedDepositStage" }, "examples": { "application/json": {"id":71466,"isDeleted":false,"name":"Application Started","displayOrder":1} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] } }, "/v1/proposed-loan-stages": { "get": { "tags": [ "Proposed Loan Stages" ], "summary": "Gets all proposed loan stages", "operationId": "GetPaged", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "page", "description": "The page number of results to retrieve (first page = 1, default = 1)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "perPage", "description": "The number of records to return on each page (minimum = 1, maximum = 1000, default = 200)", "type": "integer", "format": "int32", "x-nullable": true } ], "responses": { "200": { "description": "Gets all current, existing, and active proposed loan stages in the account", "schema": { "$ref": "#/definitions/CollectionResponse[ProposedLoanStage]" }, "examples": { "application/json": {"items":[{"id":71456,"isDeleted":false,"name":"Application Started","displayOrder":1},{"id":71457,"isDeleted":false,"name":"Application Completed","displayOrder":2},{"id":71459,"isDeleted":false,"name":"Pending Board Approval","displayOrder":4},{"id":71461,"isDeleted":false,"name":"Closed","displayOrder":6}]} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] } }, "/v1/proposed-loan-stages/{id}": { "get": { "tags": [ "Proposed Loan Stages" ], "summary": "Gets a proposed loan stage by id", "operationId": "GetById", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "id of the proposed loan stage to get", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "Gets the proposed loan stage with the specified id", "schema": { "$ref": "#/definitions/ProposedLoanStage" }, "examples": { "application/json": {"id":71456,"isDeleted":false,"name":"Application Started","displayOrder":1} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] } }, "/v1/proposed-product-available-financial-import-sources/{proposedProductsId}": { "get": { "tags": [ "Proposed Products Available Financial Import Sources" ], "summary": "Retrieves collection of saved available financial import sources.", "operationId": "GetAllByProposedProductsID", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "proposedProductsId", "description": "", "required": true, "type": "integer", "format": "int32" } ], "responses": { "201": { "description": "Retrieves collection of saved available financial import sources for given proposed products identifier", "schema": { "type": "array", "items": { "$ref": "#/definitions/ProposedProductAvailableFinancialImportSource" } } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] }, "patch": { "tags": [ "Proposed Products Available Financial Import Sources" ], "summary": "Updates a collection of ProposedProductAvailableFinancialImportSources", "operationId": "SaveOrUpdate", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "proposedProductsId", "description": "The identifier of the ProposedProduct to which the given financialImportSources are to be associated", "required": true, "type": "integer", "format": "int32" }, { "in": "body", "name": "body", "description": "The collection of ProposedProductAvailableFinancialImportSources to update", "schema": { "type": "array", "items": { "$ref": "#/definitions/ProposedProductAvailableFinancialImportSource" } } } ], "responses": { "200": { "description": "All ProposedProductAvailableFinancialImportSources were processed. Please check the errors property of the response object\r\n to determine if there were errors updating any individual ProposedProductAvailableFinancialImportSource", "schema": { "type": "array", "items": { "$ref": "#/definitions/ProposedProductAvailableFinancialImportSource" } } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] } }, "/v1/proposed-product-available-financial-import-sources/defaults": { "get": { "tags": [ "Proposed Products Available Financial Import Sources" ], "summary": "Gets default selections for available financial sources options to be used if a user has not made differing selections", "operationId": "GetDefaultAvailableFinancialSourcesOptions", "produces": [ "application/json" ], "responses": { "200": { "description": "Success", "schema": { "type": "array", "items": { "format": "string", "enum": [ "none", "annualized", "audit", "companyPrepared", "compilation", "financialStatement", "foreignCurrencyStatement", "merged", "other", "projection", "quickFinancials", "review", "sample", "taxReturn", "trailingTwelveMonths", "average", "projection2", "projection3", "projection4", "projection5", "payStub", "wTwo", "organizationPrepared", "selfReported", "consolidation", "probabilityOfDefault" ], "type": "string" } } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] } }, "/v1/proposed-products/{id}": { "get": { "tags": [ "Proposed Products" ], "summary": "Get the proposed product by the given id", "operationId": "GetById", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "The id of the proposed product", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/ProposedProduct" }, "examples": { "application/json": {"id":12,"name":"7 Year Auto (Used)","customerFacingName":"Used Auto Loan (84 month term)","paymentType":"lineOfCredit","rateSheetsId":13,"calculateEvaluatedCreditScore":false,"isTridLoan":false,"iconName":null,"description":null,"evaluatedCreditScoreCreditBureaus":null,"creditBureauSelectionStrategy":null,"loanRoleSelectionStrategy":null,"applicationTypes":["business"],"evaluatedCreditScoreLoanRoleTypes":null,"applicationTemplates":[{"id":1,"name":"Car Loan Application","active":true,"type":"person","proposedProducts":null,"applicationTemplateAdditionalSettings":null},{"id":2,"name":"Truck Loan Application","active":true,"type":"person","proposedProducts":null,"applicationTemplateAdditionalSettings":null}]} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "OnlinePortalAnalystApiAcess", null ] } ] }, "patch": { "tags": [ "Proposed Products" ], "summary": "Updates a proposed product", "operationId": "Update", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "id of the existing proposed product to update", "required": true, "type": "integer", "format": "int32" }, { "in": "body", "name": "body", "description": "The proposed product values to update", "schema": { "$ref": "#/definitions/ProposedProduct" } } ], "responses": { "200": { "description": "Returns the modified proposed product", "schema": { "$ref": "#/definitions/ProposedProduct" }, "examples": { "application/json": {"id":12,"name":"7 Year Auto (Used)","customerFacingName":"Used Auto Loan (84 month term)","paymentType":"lineOfCredit","rateSheetsId":13,"calculateEvaluatedCreditScore":false,"isTridLoan":false,"iconName":null,"description":null,"evaluatedCreditScoreCreditBureaus":null,"creditBureauSelectionStrategy":null,"loanRoleSelectionStrategy":null,"applicationTypes":["business"],"evaluatedCreditScoreLoanRoleTypes":null,"applicationTemplates":[{"id":1,"name":"Car Loan Application","active":true,"type":"person","proposedProducts":null,"applicationTemplateAdditionalSettings":null},{"id":2,"name":"Truck Loan Application","active":true,"type":"person","proposedProducts":null,"applicationTemplateAdditionalSettings":null}]} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "OnlinePortalAnalystApiAcess", null ] } ] }, "delete": { "tags": [ "Proposed Products" ], "summary": "Deletes a proposed product by id", "operationId": "Delete", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "id of the proposed product to delete", "required": true, "type": "integer", "format": "int32" } ], "responses": { "204": { "description": "The proposed product has been deleted successfully." }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "OnlinePortalAnalystApiAcess", null ] } ] } }, "/v1/proposed-products": { "get": { "tags": [ "Proposed Products" ], "summary": "Gets all proposed products", "operationId": "GetPaged", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "page", "description": "The page number of results to retrieve (first page = 1, default = 1)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "perPage", "description": "The number of records to return on each page (minimum = 1, maximum = 1000, default = 200)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "applicationType", "description": "Filter returned products on the specified application types", "type": "string", "format": "string", "enum": [ "preApp", "business", "person", "sba", "nonprofit", "farm" ] } ], "responses": { "200": { "description": "Gets all proposed products in the account", "schema": { "$ref": "#/definitions/CollectionResponse[ProposedProduct]" }, "examples": { "application/json": {"items":[{"id":12,"name":"7 Year Auto (Used)","customerFacingName":"Used Auto Loan (84 month term)","paymentType":"lineOfCredit","rateSheetsId":13,"calculateEvaluatedCreditScore":false,"isTridLoan":false,"iconName":null,"description":null,"evaluatedCreditScoreCreditBureaus":null,"creditBureauSelectionStrategy":null,"loanRoleSelectionStrategy":null,"applicationTypes":["business"],"evaluatedCreditScoreLoanRoleTypes":null,"applicationTemplates":null},{"id":28,"name":"7 Year Auto (New)","customerFacingName":"New Auto Loan (84 month term)","paymentType":"fixedPrincipal","rateSheetsId":null,"calculateEvaluatedCreditScore":false,"isTridLoan":false,"iconName":null,"description":null,"evaluatedCreditScoreCreditBureaus":null,"creditBureauSelectionStrategy":null,"loanRoleSelectionStrategy":null,"applicationTypes":["person"],"evaluatedCreditScoreLoanRoleTypes":null,"applicationTemplates":null}]} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "OnlinePortalAnalystApiAcess", null ] } ] }, "post": { "tags": [ "Proposed Products" ], "summary": "Creates a new proposed product", "operationId": "Create", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "The proposed product to create", "schema": { "$ref": "#/definitions/ProposedProduct" } } ], "responses": { "201": { "description": "The proposed product has been created successfully.\r\n The proposed product that was created is returned and has the Sageworks\r\n id that was assigned.", "schema": { "$ref": "#/definitions/ProposedProduct" }, "examples": { "application/json": {"id":12,"name":"7 Year Auto (Used)","customerFacingName":"Used Auto Loan (84 month term)","paymentType":"lineOfCredit","rateSheetsId":13,"calculateEvaluatedCreditScore":false,"isTridLoan":false,"iconName":null,"description":null,"evaluatedCreditScoreCreditBureaus":null,"creditBureauSelectionStrategy":null,"loanRoleSelectionStrategy":null,"applicationTypes":["business"],"evaluatedCreditScoreLoanRoleTypes":null,"applicationTemplates":[{"id":1,"name":"Car Loan Application","active":true,"type":"person","proposedProducts":null,"applicationTemplateAdditionalSettings":null},{"id":2,"name":"Truck Loan Application","active":true,"type":"person","proposedProducts":null,"applicationTemplateAdditionalSettings":null}]} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "OnlinePortalAnalystApiAcess", null ] } ] } }, "/v1/proposed-products/bulk": { "post": { "tags": [ "Proposed Products" ], "summary": "Creates a collection of proposed products", "operationId": "CreateMany", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "The collection of proposed products to create", "schema": { "$ref": "#/definitions/BulkCreateRequest[ProposedProduct]" } } ], "responses": { "200": { "description": "All proposed products were processed. Please check the errors property of the response object\r\n to determine if there were errors creating any individual proposed products", "schema": { "$ref": "#/definitions/BulkCreateResponse[ProposedProduct]" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "OnlinePortalAnalystApiAcess", null ] } ] }, "patch": { "tags": [ "Proposed Products" ], "summary": "Updates a collection of proposed products", "operationId": "UpdateMany", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "The collection of proposed products to update", "schema": { "$ref": "#/definitions/BulkUpdateRequest[ProposedProduct]" } } ], "responses": { "200": { "description": "All proposed products were processed. Please check the errors property of the response object\r\n to determine if there were errors updating any individual proposed products", "schema": { "$ref": "#/definitions/BulkUpdateResponse[ProposedProduct]" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "OnlinePortalAnalystApiAcess", null ] } ] } }, "/v1/policy-exceptions": { "get": { "tags": [ "Policy Exceptions" ], "summary": "Gets all policy exceptions", "operationId": "GetPaged", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "page", "description": "The page number of results to retrieve (first page = 1, default = 1)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "perPage", "description": "The number of records to return on each page (minimum = 1, maximum = 1000, default = 200)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "customerId", "description": "CustomerId value to filter by", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "loanId", "description": "loanId value to filter by", "type": "integer", "format": "int64", "x-nullable": true }, { "in": "query", "name": "isProposed", "description": "isProposed value to filter by", "type": "boolean", "x-nullable": true } ], "responses": { "200": { "description": "Gets all current, existing, and active policy exceptions", "schema": { "$ref": "#/definitions/CollectionResponse[PolicyException]" }, "examples": { "application/json": {"id":12345,"customerId":67890,"loanId":55555,"isProposed":true,"workflowId":9999,"comments":"This is a comment","isDeleted":false,"createdDate":"2025-07-16","policyExceptionStatusId":444,"policyExceptionTypeId":2222} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] }, "post": { "tags": [ "Policy Exceptions" ], "summary": "Creates a policy exception in Sageworks", "operationId": "Create", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "The policy exception to create", "schema": { "$ref": "#/definitions/PolicyException" } } ], "responses": { "201": { "description": "The policy exception has been created successfully. The policy exception that was created\r\n is returned and has the Sageworks id that was assigned.", "schema": { "$ref": "#/definitions/PolicyException" }, "examples": { "application/json": {"id":12345,"customerId":67890,"loanId":55555,"isProposed":true,"workflowId":9999,"comments":"This is a comment","isDeleted":false,"createdDate":"2025-07-16","policyExceptionStatusId":444,"policyExceptionTypeId":2222} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] } }, "/v1/policy-exceptions/count": { "get": { "tags": [ "Policy Exceptions" ], "operationId": "GetCount", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "customerId", "description": "CustomerId value to filter by", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "loanId", "description": "loanId value to filter by", "type": "integer", "format": "int64", "x-nullable": true }, { "in": "query", "name": "isProposed", "description": "isProposed value to filter by", "type": "boolean", "x-nullable": true } ], "responses": { "200": { "description": "Success", "schema": { "format": "int32", "type": "integer" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] } }, "/v1/policy-exceptions/{id}": { "get": { "tags": [ "Policy Exceptions" ], "summary": "Gets a policy exception by id", "operationId": "GetById", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "id of the existing policy exception to get", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "Gets the policy exception with the specified id", "schema": { "$ref": "#/definitions/PolicyException" }, "examples": { "application/json": {"id":12345,"customerId":67890,"loanId":55555,"isProposed":true,"workflowId":9999,"comments":"This is a comment","isDeleted":false,"createdDate":"2025-07-16","policyExceptionStatusId":444,"policyExceptionTypeId":2222} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] }, "patch": { "tags": [ "Policy Exceptions" ], "summary": "Updates a policy exception", "operationId": "Update", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "id of the existing policy exception to update", "required": true, "type": "integer", "format": "int32" }, { "in": "body", "name": "body", "description": "The policy exception values to update", "schema": { "$ref": "#/definitions/PolicyException" } } ], "responses": { "200": { "description": "Returns the modified policy exception", "schema": { "$ref": "#/definitions/PolicyException" }, "examples": { "application/json": {"id":12345,"customerId":67890,"loanId":55555,"isProposed":true,"workflowId":9999,"comments":"This is a comment","isDeleted":false,"createdDate":"2025-07-16","policyExceptionStatusId":444,"policyExceptionTypeId":2222} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] }, "delete": { "tags": [ "Policy Exceptions" ], "summary": "Deletes a policy exception by id", "operationId": "Delete", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "id of the existing policy exception to delete", "required": true, "type": "integer", "format": "int32" } ], "responses": { "204": { "description": "The policy exception has been deleted successfully." }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] } }, "/v1/policy-exceptions/bulk": { "patch": { "tags": [ "Policy Exceptions" ], "summary": "Updates a collection of policy exceptions", "operationId": "UpdateMany", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "The collection of policy exceptions to update", "schema": { "$ref": "#/definitions/BulkUpdateRequest[PolicyException]" } } ], "responses": { "200": { "description": "All policy exceptions were processed. Please check the errors property of the response object\r\n to determine if there were errors updating any individual policy exceptions", "schema": { "$ref": "#/definitions/BulkUpdateRequest[PolicyException]" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] }, "post": { "tags": [ "Policy Exceptions" ], "summary": "Creates a collection of policy exceptions", "operationId": "CreateMany", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "The collection of Policy Exceptions to create", "schema": { "$ref": "#/definitions/BulkCreateRequest[PolicyException]" } } ], "responses": { "200": { "description": "All Policy Exceptions were processed. Please check the errors property of the response object\r\n to determine if there were errors creating any individual Policy Exceptions", "schema": { "$ref": "#/definitions/BulkCreateResponse[PolicyException]" }, "examples": { "application/json": {"id":0,"customerId":67890,"loanId":55555,"isProposed":true,"workflowId":9999,"comments":"This is a comment","isDeleted":false,"createdDate":"0001-01-01","policyExceptionStatusId":null,"policyExceptionTypeId":2222} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] } }, "/v1/policy-exception-statuses": { "get": { "tags": [ "Policy Exception Statuses" ], "summary": "Gets all policy exception statuses", "operationId": "GetPaged", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "page", "description": "The page number of results to retrieve (first page = 1, default = 1)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "perPage", "description": "The number of records to return on each page (minimum = 1, maximum = 1000, default = 200)", "type": "integer", "format": "int32", "x-nullable": true } ], "responses": { "200": { "description": "Gets all current, existing, and active policy exception statuses in the account", "schema": { "$ref": "#/definitions/CollectionResponse[PolicyExceptionStatus]" }, "examples": { "application/json": {"items":[{"id":71466,"description":"Active","isDeleted":false},{"id":71467,"description":"Inactive","isDeleted":false},{"id":71469,"description":"Waived","isDeleted":false}]} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] } }, "/v1/policy-exception-statuses/{id}": { "get": { "tags": [ "Policy Exception Statuses" ], "summary": "Gets a policy exception status by id", "operationId": "GetById", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "id of the existing policy exception status to get", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "Gets the policy exception status with the specified id", "schema": { "$ref": "#/definitions/PolicyExceptionStatus" }, "examples": { "application/json": {"id":71466,"description":"Active","isDeleted":false} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] } }, "/v1/policy-exception-types": { "get": { "tags": [ "Policy Exception Types" ], "summary": "Gets all policy exception types", "operationId": "GetPaged", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "page", "description": "The page number of results to retrieve (first page = 1, default = 1)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "perPage", "description": "The number of records to return on each page (minimum = 1, maximum = 1000, default = 200)", "type": "integer", "format": "int32", "x-nullable": true } ], "responses": { "200": { "description": "Gets all current, existing, and active policy exception types in the account", "schema": { "$ref": "#/definitions/CollectionResponse[PolicyExceptionType]" }, "examples": { "application/json": {"items":[{"id":71466,"description":"Other","isDeleted":false},{"id":71467,"description":"LTV","isDeleted":false},{"id":71469,"description":"Prohibited","isDeleted":false}]} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] } }, "/v1/policy-exception-types/{id}": { "get": { "tags": [ "Policy Exception Types" ], "summary": "Gets a policy exception type by id", "operationId": "GetById", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "id of the existing policy exception type to get", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "Gets the policy exception type with the specified id", "schema": { "$ref": "#/definitions/PolicyExceptionType" }, "examples": { "application/json": {"id":71466,"description":"Other","isDeleted":false} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] } }, "/v1/opportunities": { "post": { "tags": [ "Opportunities" ], "summary": "Creates a opportunity", "operationId": "Create", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "The opportunity to create", "schema": { "$ref": "#/definitions/Opportunity" } } ], "responses": { "201": { "description": "The opportunity has been created successfully. The opportunity that was created\r\n is returned and has the Sageworks id that was assigned.", "schema": { "$ref": "#/definitions/Opportunity" }, "examples": { "application/json": {"id":0,"objectType":"customer","objectId":123,"name":"Large Deposit to Account","amount":34346.77,"type":"CRE","assignedToUsersID":35454,"stage":"Proposed","probabilityOfClose":0.67,"comments":"An account received a deposit in the amount of $12,000.00 which is 60 % greater than the average deposits for the past 180 day.The account has been open 2 years.","isDeleted":false} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] }, "get": { "tags": [ "Opportunities" ], "summary": "Gets all opportunities", "operationId": "GetPaged", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "page", "description": "The page number of results to retrieve (first page = 1, default = 1)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "perPage", "description": "The number of records to return on each page (minimum = 1, maximum = 1000, default = 200)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "lastModifiedStartDate", "description": "The start of the date range to be used when doing a date range query.Use the format yyyy-MM-dd. This date is inclusive.", "type": "string", "format": "date-time", "x-nullable": true }, { "in": "query", "name": "lastModifiedEndDate", "description": "The end of the date range to be used when doing a date range query. Use the format yyyy-MM-dd. This date is inclusive.", "type": "string", "format": "date-time", "x-nullable": true }, { "in": "query", "name": "includeUserDefinedFields", "description": "Include User Defined fields in the response", "type": "boolean", "default": false, "x-nullable": true } ], "responses": { "200": { "description": "Gets all current, existing, and active opportunities in the account", "schema": { "$ref": "#/definitions/CollectionResponse[Opportunity]" }, "examples": { "application/json": {"items":[{"id":0,"objectType":"customer","objectId":123,"name":"Large Deposit to Account","type":"CRE","stage":null,"comments":"An account received a deposit in the amount of $12,000.00 which is 60% greater than the average deposits for the past 180 day.The account has been open 2 years.","isDeleted":false,"probabilityOfClose":null,"amount":null,"assignedToUsersId":null,"referredBy":null,"estimatedCloseDate":null,"lastModifiedDate":null,"createdDate":null,"userDefinedFields":null},{"id":0,"objectType":"customer","objectId":123,"name":"string","type":"Cross-Sale","stage":null,"comments":"string","isDeleted":false,"probabilityOfClose":null,"amount":null,"assignedToUsersId":null,"referredBy":null,"estimatedCloseDate":null,"lastModifiedDate":null,"createdDate":null,"userDefinedFields":null}]} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] } }, "/v1/opportunities/stage-options": { "get": { "tags": [ "Opportunities" ], "summary": "Gets all opportunity stage options", "operationId": "GetStageOptions", "produces": [ "application/json" ], "responses": { "200": { "description": "Gets the all the opportunity stage field options", "schema": { "$ref": "#/definitions/CollectionResponse[DataFieldOption]" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] } }, "/v1/opportunities/type-options": { "get": { "tags": [ "Opportunities" ], "summary": "Gets all opportunity type options", "operationId": "GetTypeOptions", "produces": [ "application/json" ], "responses": { "200": { "description": "Gets the all the opportunity type field options", "schema": { "$ref": "#/definitions/CollectionResponse[DataFieldOption]" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] } }, "/v1/opportunities/bulk": { "patch": { "tags": [ "Opportunities" ], "summary": "Updates a collection of opportunities", "operationId": "UpdateMany", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "The collection of opportunities to update", "schema": { "$ref": "#/definitions/BulkUpdateRequest[Opportunity]" } } ], "responses": { "200": { "description": "All opportunities were processed. Please check the errors property of the response object\r\n to determine if there were errors updating any individual opportunity", "schema": { "$ref": "#/definitions/BulkUpdateRequest[Opportunity]" }, "examples": { "application/json": {"itemsUpdated":[{"id":456321,"objectType":"customer","objectId":123,"name":"Large Deposit to Account","type":"CRE","stage":null,"comments":"An account received a deposit in the amount of $12,000.00 which is 60 % greater than the average deposits for the past 180 day.The account has been open 2 years.","isDeleted":false,"probabilityOfClose":null,"amount":null,"assignedToUsersId":null,"referredBy":null,"estimatedCloseDate":null,"lastModifiedDate":null,"createdDate":null,"userDefinedFields":null},{"id":78954,"objectType":"customer","objectId":456,"name":"Medium Deposit to Account","type":"CRE","stage":null,"comments":"An account received a deposit in the amount of $10,000.00 which is 30 % greater than the average deposits for the past 180 day.The account has been open 2 years.","isDeleted":false,"probabilityOfClose":null,"amount":null,"assignedToUsersId":null,"referredBy":null,"estimatedCloseDate":null,"lastModifiedDate":null,"createdDate":null,"userDefinedFields":null},null,{"id":746312,"objectType":"customer","objectId":986,"name":"Medium Deposit to Account","type":"Commercial","stage":null,"comments":"An account received a deposit in the amount of $10,000.00 which is 30 % greater than the average deposits for the past 180 day.The account has been open 2 years.","isDeleted":false,"probabilityOfClose":null,"amount":null,"assignedToUsersId":null,"referredBy":null,"estimatedCloseDate":null,"lastModifiedDate":null,"createdDate":null,"userDefinedFields":null}],"errors":{"2":{"errorType":"invalidRequest","message":"Input model for request is invalid","modelErrors":[{"propertyName":"objectId","message":"A customer with id '120' does not exist"}]}}} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] }, "post": { "tags": [ "Opportunities" ], "summary": "Creates a collection of opportunities", "operationId": "CreateMany", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "The collection of opportunities to create", "schema": { "$ref": "#/definitions/BulkCreateRequest[Opportunity]" } } ], "responses": { "200": { "description": "All opportunities were processed. Please check the errors property of the response object\r\n to determine if there were errors creating any individual opportunity", "schema": { "$ref": "#/definitions/BulkCreateResponse[Opportunity]" }, "examples": { "application/json": {"itemsCreated":[{"id":456321,"objectType":"customer","objectId":123,"name":"Large Deposit to Account","type":"CRE","stage":null,"comments":"An account received a deposit in the amount of $12,000.00 which is 60 % greater than the average deposits for the past 180 day.The account has been open 2 years.","isDeleted":false,"probabilityOfClose":null,"amount":null,"assignedToUsersId":null,"referredBy":null,"estimatedCloseDate":null,"lastModifiedDate":null,"createdDate":null,"userDefinedFields":null},{"id":78954,"objectType":"customer","objectId":456,"name":"Medium Deposit to Account","type":"CRE","stage":null,"comments":"An account received a deposit in the amount of $10,000.00 which is 30 % greater than the average deposits for the past 180 day.The account has been open 2 years.","isDeleted":false,"probabilityOfClose":null,"amount":null,"assignedToUsersId":null,"referredBy":null,"estimatedCloseDate":null,"lastModifiedDate":null,"createdDate":null,"userDefinedFields":null},null,{"id":746312,"objectType":"customer","objectId":986,"name":"Medium Deposit to Account","type":"Commercial","stage":null,"comments":"An account received a deposit in the amount of $10,000.00 which is 30 % greater than the average deposits for the past 180 day.The account has been open 2 years.","isDeleted":false,"probabilityOfClose":null,"amount":null,"assignedToUsersId":null,"referredBy":null,"estimatedCloseDate":null,"lastModifiedDate":null,"createdDate":null,"userDefinedFields":null}],"errors":{"2":{"errorType":"invalidRequest","message":"Input model for request is invalid","modelErrors":[{"propertyName":"objectId","message":"A customer with id '120' does not exist"}]}}} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] } }, "/v1/opportunities/{id}": { "get": { "tags": [ "Opportunities" ], "summary": "Gets a opportunity by id", "operationId": "GetById", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "id of the existing opportunity to get", "required": true, "type": "integer", "format": "int32" }, { "in": "query", "name": "includeUserDefinedFields", "description": "Include User Defined fields in the response", "type": "boolean", "default": false, "x-nullable": true } ], "responses": { "200": { "description": "Gets the opportunity with the specified id", "schema": { "$ref": "#/definitions/Opportunity" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] }, "patch": { "tags": [ "Opportunities" ], "summary": "Updates a opportunity", "operationId": "Update", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "id of the existing opportunity to update", "required": true, "type": "integer", "format": "int32" }, { "in": "body", "name": "body", "description": "The opportunity values to update", "schema": { "$ref": "#/definitions/Opportunity" } } ], "responses": { "200": { "description": "Returns the modified opportunity", "schema": { "$ref": "#/definitions/Opportunity" }, "examples": { "application/json": {"id":0,"objectType":"customer","objectId":123,"name":"Large Deposit to Account","amount":34346.77,"type":"CRE","assignedToUsersID":35454,"stage":"Proposed","probabilityOfClose":0.67,"comments":"An account received a deposit in the amount of $12,000.00 which is 60 % greater than the average deposits for the past 180 day.The account has been open 2 years.","isDeleted":false} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] } }, "/v1/customer-widgets": { "get": { "tags": [ "Customer Widgets" ], "summary": "Gets all Customer Widgets", "operationId": "GetPaged", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "page", "description": "The page number of results to retrieve (first page = 1, default = 1)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "perPage", "description": "The number of records to return on each page (minimum = 1, maximum = 1000, default = 200)", "type": "integer", "format": "int32", "x-nullable": true } ], "responses": { "200": { "description": "Gets all Customer Widgets in the account", "schema": { "$ref": "#/definitions/CollectionResponse[CustomerWidget]" }, "examples": { "application/json": {"items":[{"id":1231321,"name":"Widget ABC","customerType":0,"requiredFields":[{"fieldName":"Driver's License Number"},{"fieldName":"Social Security Number"}],"nonRequiredFields":[{"fieldName":"Apartment Number"}],"returnInformation":[{"fieldName":"Address 1"}],"statusUserDefinedFieldName":"Widget ABC Status"},{"id":54534,"name":"Widget XYZ","customerType":0,"requiredFields":[{"fieldName":"Address"},{"fieldName":"City"},{"fieldName":"State"}],"nonRequiredFields":null,"returnInformation":null,"statusUserDefinedFieldName":"Widget XYZ Status"}]} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "CustomerWidgetApiAccess", null ] } ] }, "post": { "tags": [ "Customer Widgets" ], "summary": "Creates a Customer Widget", "operationId": "Create", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "The Customer Widget to create", "schema": { "$ref": "#/definitions/CustomerWidget" } } ], "responses": { "201": { "description": "The Customer Widget has been created successfully. The Customer Widget that was created\r\n is returned and has the Sageworks id that was assigned.", "schema": { "$ref": "#/definitions/CustomerWidget" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "CustomerWidgetApiAccess", null ] } ] } }, "/v1/customer-widgets/{id}": { "get": { "tags": [ "Customer Widgets" ], "summary": "Gets a Customer Widget by id", "operationId": "GetById", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "id of the existing Customer Widget to get", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "Gets the Customer Widget with the specified id", "schema": { "$ref": "#/definitions/CustomerWidget" }, "examples": { "application/json": {"id":1231321,"name":"Widget ABC","customerType":0,"requiredFields":[{"fieldName":"Tax ID"}],"nonRequiredFields":[{"fieldName":"Car Make"},{"fieldName":"Car Model"}],"returnInformation":[{"fieldName":"Address 1"}],"statusUserDefinedFieldName":"Widget ABC Status"} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "CustomerWidgetApiAccess", null ] } ] }, "patch": { "tags": [ "Customer Widgets" ], "summary": "Updates a Customer Widget", "operationId": "Update", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "id of the existing Customer Widget to update", "required": true, "type": "integer", "format": "int32" }, { "in": "body", "name": "body", "description": "The Customer Widget values to update", "schema": { "$ref": "#/definitions/CustomerWidget" } } ], "responses": { "200": { "description": "Returns the modified Customer Widget", "schema": { "$ref": "#/definitions/CustomerWidget" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "CustomerWidgetApiAccess", null ] } ] }, "delete": { "tags": [ "Customer Widgets" ], "summary": "Deletes a Customer Widget by id", "operationId": "Delete", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "id of the existing Customer Widget to delete", "required": true, "type": "integer", "format": "int32" } ], "responses": { "204": { "description": "The Customer Widget has been deleted successfully." }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "CustomerWidgetApiAccess", null ] } ] } }, "/v1/customer-widgets/values/{id}/{customerId}": { "get": { "tags": [ "Customer Widgets" ], "summary": "Gets a Customer Widget's data fields by id and customer id", "operationId": "GetValues", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "id of the existing Widget to get", "required": true, "type": "integer", "format": "int32" }, { "in": "path", "name": "customerId", "description": "id of the existing Customer to get", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "Gets the Customer widget field values with the specified id and customer id", "schema": { "$ref": "#/definitions/CustomerWidgetFieldValues" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "CustomerWidgetApiAccess", null ] } ] }, "post": { "tags": [ "Customer Widgets" ], "summary": "Updates a Customer Widget's data fields by id and customer id", "operationId": "UpdateValues", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "id of the existing Widget", "required": true, "type": "integer", "format": "int32" }, { "in": "path", "name": "customerId", "description": "id of the existing Customer", "required": true, "type": "integer", "format": "int32" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/CustomerWidgetFieldValues" } } ], "responses": { "200": { "description": "The field values have been updated successfully", "schema": { "$ref": "#/definitions/CustomerWidgetFieldValues" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "CustomerWidgetApiAccess", null ] } ] } }, "/v1/customer-widgets/{id}/events": { "get": { "tags": [ "Customer Widgets" ], "summary": "Gets all events by widget id", "operationId": "GetEvents", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "id of the existing Customer Widget to get events for", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/CollectionResponse[Event]" }, "examples": { "application/json": {"items":[{"id":125464545,"eventTime":"2021-08-01T09:21:03-04:00","eventType":"loanBoardedEvent","eventContent":{"ProposedLoanId":"654321"},"isComplete":false},{"id":125464546,"eventTime":"2021-08-03T10:01:33-04:00","eventType":"loanBoardedEvent","eventContent":{"ProposedLoanId":"654321"},"isComplete":false}]} } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "CustomerWidgetApiAccess", null ] } ] } }, "/v1/customer-widgets/available-fields": { "get": { "tags": [ "Customer Widgets" ], "operationId": "GetAvailableFields", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "customerType", "description": "CustomerType value to filter by", "type": "string", "format": "string", "enum": [ "business", "person", "farm", "nonProfit" ] } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/CustomerWidgetAvailableFields" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "CustomerWidgetApiAccess", null ] } ] } }, "/v1/customer-widgets/available-field-definitions": { "get": { "tags": [ "Customer Widgets" ], "summary": "Get available fields with full metadata for customer widgets", "description": "This endpoint returns complete field definitions as BaseFieldMetadata objects,\r\nincluding input format, data type, dropdown options, and other metadata in a single\r\nAPI call. This eliminates the need for separate API calls to fetch field metadata.\r\n \r\nThe endpoint leverages the established BaseFieldMetadata pattern used throughout\r\nthe codebase for consistent field metadata representation.", "operationId": "GetAvailableFieldDefinitions", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "customerType", "description": "CustomerType value to filter by", "type": "string", "format": "string", "enum": [ "business", "person", "farm", "nonProfit" ] } ], "responses": { "200": { "description": "Returns available fields as BaseFieldMetadata objects with full metadata including input format, data type, and options", "schema": { "$ref": "#/definitions/CustomerWidgetAvailableFieldDefinitions" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "CustomerWidgetApiAccess", null ] } ] } }, "/v1/customer-widgets/status/{widgetId}/{customerId}": { "get": { "tags": [ "Customer Widgets" ], "operationId": "GetCustomerWidgetStatus", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "widgetId", "required": true, "type": "integer", "format": "int32" }, { "in": "path", "name": "customerId", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/CustomerWidgetStatus" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "CustomerWidgetApiAccess", null ] } ] }, "patch": { "tags": [ "Customer Widgets" ], "operationId": "UpdateCustomerWidgetStatus", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "widgetId", "required": true, "type": "integer", "format": "int32" }, { "in": "path", "name": "customerId", "required": true, "type": "integer", "format": "int32" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/CustomerWidgetStatus" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/CustomerWidgetStatus" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "CustomerWidgetApiAccess", null ] } ] } }, "/v1/customer-widgets/order": { "post": { "tags": [ "Customer Widgets" ], "summary": "Orders a Customer Widget for a specific customer", "operationId": "OrderWidgetAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "The order request containing widget id and customer id", "schema": { "$ref": "#/definitions/CustomerWidgetOrderRequest" } } ], "responses": { "200": { "description": "The widget has been ordered successfully" }, "400": { "description": "Invalid request or widget/customer not found", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "CustomerWidgetApiAccess", null ] } ] } }, "/v1/trustage-document-preparation/adobe/send-signature-package/{proposedLoanId}": { "post": { "tags": [ "Trustage Document Preparation" ], "summary": "Send Trustage documents to adobe for esignature", "operationId": "SendDocumentsForESignature", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "proposedLoanId", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/CsiSendForESignatureResponse" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] } }, "/v1/trustage-loan-documents/{proposedLoanId}": { "post": { "tags": [ "Trustage Loan Documents" ], "operationId": "GetDocumentIdsByProposedLoanId", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "proposedLoanId", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/TrustageDocumentsResponse" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] } }, "/v1/prelim-beneficial-owners": { "post": { "tags": [ "Prelim" ], "operationId": "CreatePrelimBeneficialOwner", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/PrelimBeneficialOwnerCustomer" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/BeneficialOwner" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] } }, "/v1/prelim-deposit-app-pipeline/person": { "post": { "tags": [ "Prelim" ], "summary": "Creates Prelim Deposit App Pipeline data record for person", "operationId": "Create", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "The record to create", "schema": { "$ref": "#/definitions/PrelimDepositAppPipelineDataPerson" } } ], "responses": { "201": { "description": "The record has been created successfully. The record that was created\r\n is returned and has the Sageworks id that was assigned.", "schema": { "$ref": "#/definitions/PrelimDepositAppPipelineDataPerson" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] } }, "/v1/prelim-deposit-app-pipeline/{id}": { "patch": { "tags": [ "Prelim" ], "operationId": "Update", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "required": true, "type": "integer", "format": "int32" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/PrelimDepositAppPipelineDataUpdateRequest" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/PrelimDepositAppPipelineDataUpdateRequest" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] } }, "/v1/prelim-deposit-app-pipeline/business": { "post": { "tags": [ "Prelim" ], "summary": "Creates Prelim Deposit App Pipeline data record for business", "operationId": "Create", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "The record to create", "schema": { "$ref": "#/definitions/PrelimDepositAppPipelineDataBusiness" } } ], "responses": { "201": { "description": "The record has been created successfully. The record that was created\r\n is returned and has the Sageworks id that was assigned.", "schema": { "$ref": "#/definitions/PrelimDepositAppPipelineDataBusiness" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] } }, "/v1/plaid/asset-reports/{customerId}": { "get": { "tags": [ "Plaid" ], "operationId": "GetAssetReportJson", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "customerId", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/PlaidJsonAssetReportResponse" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] } }, "/v1/laser-pro-document-preparation/send-to-laser-pro/{proposedLoanId}": { "post": { "tags": [ "LaserPro Document Preparation" ], "summary": "Submit a document preparation request to LaserPro for a proposed loan", "operationId": "SendToLaserPro", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "proposedLoanId", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "Returns the LaserPro request's transaction number", "schema": { "$ref": "#/definitions/SendToLaserProResponse" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] } }, "/v1/laser-pro-document-preparation/adobe/send-signature-package/{proposedLoanId}": { "post": { "tags": [ "LaserPro Document Preparation" ], "summary": "Sends a Laserpro signature package for Adobe esignature", "operationId": "SendLaserproDocumentsToAdobe", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "proposedLoanId", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/EsignAutoSendSignatureResponse" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] } }, "/v1/indirect-auto/route-one-dealer-info": { "get": { "tags": [ "Indirect Auto" ], "operationId": "RouteOneDealerInfo", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "proposedLoanId", "type": "integer", "format": "int64" } ], "responses": { "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "200": { "description": "Success", "schema": { "$ref": "#/definitions/IndirectAutoDealerInformationResponse" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] } }, "/v1/indirect-auto/dealertrack-dealer-info": { "get": { "tags": [ "Indirect Auto" ], "operationId": "DealertrackDealerInfo", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "proposedLoanId", "type": "integer", "format": "int64" } ], "responses": { "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "200": { "description": "Success", "schema": { "$ref": "#/definitions/IndirectAutoDealerInformationResponse" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] } }, "/v1/indirect-auto/pipeline-loans": { "get": { "tags": [ "Indirect Auto" ], "summary": "Retrieves indirect auto loans for the current customer with pagination", "operationId": "GetPipelineLoans", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "page", "description": "Page number (1-based, default = 1)", "type": "integer", "format": "int32", "default": 1 }, { "in": "query", "name": "perPage", "description": "Number of records per page (default = 200, max = 1000)", "type": "integer", "format": "int32", "default": 200 } ], "responses": { "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "200": { "description": "Success", "schema": { "type": "array", "items": { "$ref": "#/definitions/IndirectAutoLoanResponse" } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] } }, "/v1/indirect-auto/pipeline-loans/count": { "get": { "tags": [ "Indirect Auto" ], "summary": "Gets the total count of indirect auto loans for the current customer", "operationId": "GetPipelineLoansCount", "produces": [ "application/json" ], "responses": { "200": { "description": "Success", "schema": { "format": "int32", "type": "integer" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] } }, "/v1/generic-widgets/{widgetId}/{entityId}/status": { "get": { "tags": [ "Generic Widgets" ], "summary": "Gets the status of a Generic Widget for an entity", "operationId": "GetWidgetStatus", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "widgetId", "description": "id of the existing Generic Widget", "required": true, "type": "integer", "format": "int64" }, { "in": "path", "name": "entityId", "description": "id of the entity (ProfitEntity) associated with the widget", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "Returns the status of the generic widget", "schema": { "$ref": "#/definitions/GenericWidgetStatus" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Widget or entity not found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "GenericWidgetApiAccess", null ] } ] }, "patch": { "tags": [ "Generic Widgets" ], "summary": "Updates the status of a Generic Widget for an entity", "operationId": "UpdateWidgetStatus", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "widgetId", "description": "id of the existing Generic Widget", "required": true, "type": "integer", "format": "int64" }, { "in": "path", "name": "entityId", "description": "id of the entity (ProfitEntity) associated with the widget", "required": true, "type": "integer", "format": "int64" }, { "in": "body", "name": "body", "description": "The status to update", "schema": { "$ref": "#/definitions/GenericWidgetStatus" } } ], "responses": { "200": { "description": "Returns the updated status", "schema": { "$ref": "#/definitions/GenericWidgetStatus" } }, "400": { "description": "Invalid request or widget does not have a status field configured", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Widget or entity not found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "GenericWidgetApiAccess", null ] } ] } }, "/v1/collateral-widgets": { "get": { "tags": [ "Collateral Widgets" ], "summary": "Gets all Collateral Widgets", "operationId": "GetPaged", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "page", "description": "The page number of results to retrieve (first page = 1, default = 1)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "perPage", "description": "The number of records to return on each page (minimum = 1, maximum = 1000, default = 200)", "type": "integer", "format": "int32", "x-nullable": true } ], "responses": { "200": { "description": "Gets all Collateral Widgets in the account", "schema": { "$ref": "#/definitions/CollectionResponse[CollateralWidget]" }, "examples": { "application/json": {"items":[{"id":1231321,"name":"Widget ABC","requiredFields":[{"fieldName":"Aircraft Registration Number","fieldType":null,"options":null,"isReadOnly":false,"isDisabled":false,"isCalculated":false},{"fieldName":"Aircraft Serial Number","fieldType":null,"options":null,"isReadOnly":false,"isDisabled":false,"isCalculated":false}],"nonRequiredFields":[{"fieldName":"Aircraft Make","fieldType":null,"options":null,"isReadOnly":false,"isDisabled":false,"isCalculated":false},{"fieldName":"Aircraft Model","fieldType":null,"options":null,"isReadOnly":false,"isDisabled":false,"isCalculated":false}],"statusUserDefinedFieldName":"Widget ABC Status"},{"id":54534,"name":"Widget XYZ","requiredFields":[{"fieldName":"Construction Method","fieldType":null,"options":null,"isReadOnly":false,"isDisabled":false,"isCalculated":false}],"nonRequiredFields":null,"statusUserDefinedFieldName":"Widget XYZ Status"}]} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "CollateralWidgetApiAccess", null ] } ] }, "post": { "tags": [ "Collateral Widgets" ], "summary": "Creates a Collateral Widget", "operationId": "Create", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "The Collateral Widget to create", "schema": { "$ref": "#/definitions/CollateralWidget" } } ], "responses": { "201": { "description": "The Collateral Widget has been created successfully. The Collateral Widget that was created\r\n is returned and has the Sageworks id that was assigned.", "schema": { "$ref": "#/definitions/CollateralWidget" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "CollateralWidgetApiAccess", null ] } ] } }, "/v1/collateral-widgets/{id}": { "get": { "tags": [ "Collateral Widgets" ], "summary": "Gets a Collateral Widget by id", "operationId": "GetById", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "id of the existing Collateral Widget to get", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "Gets the Collateral Widget with the specified id", "schema": { "$ref": "#/definitions/CollateralWidget" }, "examples": { "application/json": {"id":1231321,"name":"Widget ABC","requiredFields":[{"fieldName":"Aircraft Registration Number","fieldType":null,"options":null,"isReadOnly":false,"isDisabled":false,"isCalculated":false}],"nonRequiredFields":[{"fieldName":"Aircraft Make","fieldType":null,"options":null,"isReadOnly":false,"isDisabled":false,"isCalculated":false},{"fieldName":"Aircraft Model","fieldType":null,"options":null,"isReadOnly":false,"isDisabled":false,"isCalculated":false}],"statusUserDefinedFieldName":"Widget ABC Status"} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "CollateralWidgetApiAccess", null ] } ] }, "patch": { "tags": [ "Collateral Widgets" ], "summary": "Updates a Collateral Widget", "operationId": "Update", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "id of the existing Collateral Widget to update", "required": true, "type": "integer", "format": "int32" }, { "in": "body", "name": "body", "description": "The Collateral Widget values to update", "schema": { "$ref": "#/definitions/CollateralWidget" } } ], "responses": { "200": { "description": "Returns the modified Collateral Widget", "schema": { "$ref": "#/definitions/CollateralWidget" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "CollateralWidgetApiAccess", null ] } ] }, "delete": { "tags": [ "Collateral Widgets" ], "summary": "Deletes a Collateral Widget by id", "operationId": "Delete", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "id of the existing Collateral Widget to delete", "required": true, "type": "integer", "format": "int32" } ], "responses": { "204": { "description": "The Collateral Widget has been deleted successfully." }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "CollateralWidgetApiAccess", null ] } ] } }, "/v1/collateral-widgets/values/{id}/{collateralId}": { "get": { "tags": [ "Collateral Widgets" ], "summary": "Gets a Collateral Widget's data fields by id and collateral id", "operationId": "GetValues", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "id of the existing Collateral Widget to get", "required": true, "type": "integer", "format": "int32" }, { "in": "path", "name": "collateralId", "description": "id of the existing Collateral to get", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "Gets the Collateral widget field values with the specified id and collateral id", "schema": { "$ref": "#/definitions/WidgetFieldValues" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "CollateralWidgetApiAccess", null ] } ] } }, "/v1/collateral-widgets/values/{widgetId}/{collateralId}": { "patch": { "tags": [ "Collateral Widgets" ], "summary": "Saves a Collateral Widget's data fields for a collateral", "operationId": "SaveValues", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "widgetId", "description": "id of the existing Collateral Widget", "required": true, "type": "integer", "format": "int32" }, { "in": "path", "name": "collateralId", "description": "id of the existing Collateral", "required": true, "type": "integer", "format": "int32" }, { "in": "body", "name": "body", "description": "The widget field values to save", "schema": { "$ref": "#/definitions/WidgetFieldValues" } } ], "responses": { "200": { "description": "Returns the updated widget field values after save", "schema": { "$ref": "#/definitions/WidgetFieldValues" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "CollateralWidgetApiAccess", null ] } ] } }, "/v1/collateral-widgets/bulk": { "post": { "tags": [ "Collateral Widgets" ], "summary": "Creates a collection of Collateral Widgets", "operationId": "CreateMany", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "The collection of Collateral Widgets to create", "schema": { "$ref": "#/definitions/BulkCreateRequest[CollateralWidget]" } } ], "responses": { "200": { "description": "All Collateral Widgets were processed. Please check the errors property of the response object\r\n to determine if there were errors creating any individual Collateral Widget", "schema": { "$ref": "#/definitions/BulkCreateResponse[CollateralWidget]" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "CollateralWidgetApiAccess", null ] } ] }, "patch": { "tags": [ "Collateral Widgets" ], "summary": "Updates a collection of Collateral Widgets", "operationId": "UpdateMany", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "The collection of Collateral Widgets to update", "schema": { "$ref": "#/definitions/BulkUpdateRequest[CollateralWidget]" } } ], "responses": { "200": { "description": "All Collateral Widgets were processed. Please check the errors property of the response object\r\n to determine if there were errors updating any individual Collateral Widget", "schema": { "$ref": "#/definitions/BulkUpdateRequest[CollateralWidget]" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "CollateralWidgetApiAccess", null ] } ] } }, "/v1/collateral-widgets/available-fields": { "get": { "tags": [ "Collateral Widgets" ], "operationId": "GetCollateralFields", "produces": [ "application/json" ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/CollateralWidgetAvailableFields" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "CollateralWidgetApiAccess", null ] } ] } }, "/v1/collateral-widgets/status/{widgetId}/{collateralId}": { "get": { "tags": [ "Collateral Widgets" ], "operationId": "GetCollateralStatus", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "widgetId", "required": true, "type": "integer", "format": "int32" }, { "in": "path", "name": "collateralId", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/CollateralWidgetStatus" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "CollateralWidgetApiAccess", null ] } ] }, "patch": { "tags": [ "Collateral Widgets" ], "operationId": "UpdateCollateralStatus", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "widgetId", "required": true, "type": "integer", "format": "int32" }, { "in": "path", "name": "collateralId", "required": true, "type": "integer", "format": "int32" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/CollateralWidgetStatus" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/CollateralWidgetStatus" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "CollateralWidgetApiAccess", null ] } ] } }, "/v1/collateral-widgets/events/{widgetId}": { "get": { "tags": [ "Collateral Widgets" ], "operationId": "GetCollateralWidgetEvents", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "widgetId", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/CollectionResponse[Event]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "CollateralWidgetApiAccess", null ] } ] } }, "/v1/collateral-widgets/order": { "post": { "tags": [ "Collateral Widgets" ], "summary": "Creates a collateral widget order", "operationId": "OrderWidget", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "The collateral widget order details", "schema": { "$ref": "#/definitions/CollateralWidgetOrderRequest" } } ], "responses": { "200": { "description": "The order has been created successfully" }, "400": { "description": "Invalid request or Sageworks Event System is not enabled", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "CollateralWidgetApiAccess", null ] } ] } }, "/v1/adobe/adobe-agreement-proposed-loan-mappings/{proposedLoanId}": { "get": { "tags": [ "Adobe Esign" ], "summary": "Gets Adobe Agreement Ids by proposedLoanId", "operationId": "GetAdobeAgreementIdByProposedBankLoansId", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "proposedLoanId", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "Returns Adobe Agreement Ids by proposedLoanId", "schema": { "$ref": "#/definitions/CollectionResponse[AdobeAgreementProposedLoanMapping]" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] } }, "/v1/adobe/get-status": { "post": { "tags": [ "Adobe Esign" ], "summary": "Gets a document's status by its AgreementID", "operationId": "GetStatusByAgreementId", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "id of the agreement to get", "schema": { "$ref": "#/definitions/AdobeAgreement" } } ], "responses": { "200": { "description": "Gets the status of the agreement", "schema": { "$ref": "#/definitions/AdobeEsignAgreementStatus" }, "examples": { "application/json": {"agreementStatus":{"requestedDate":"2020-03-19","lastSignatureEmailRequestSent":"2020-03-20","recipientStatuses":[{"name":"Test Person","email":"TestPerson@gmail.com","isSigned":true,"dateSigned":"2020-03-20"},{"name":"Test Person 2","email":"TestPerson2@gmail.com","isSigned":false,"dateSigned":null}]}} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] } }, "/v1/notifications/loan-boarding": { "post": { "tags": [ "Notification" ], "summary": "Send a notification to the select users/roles with the required type and a redirection to loan boarding page", "operationId": "SendLoanBoardingNotification", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "parameters": [ { "in": "body", "name": "body", "description": "The request for the notification", "schema": { "$ref": "#/definitions/LoanBoardingNotificationRequest" } } ], "responses": { "200": { "description": "The notification was sent successfully" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] } }, "/v1/notifications": { "post": { "tags": [ "Notification" ], "summary": "Send a notification to the select users/roles", "operationId": "SendNotification", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "parameters": [ { "in": "body", "name": "body", "description": "The request for the notification", "schema": { "$ref": "#/definitions/NotificationRequest" } } ], "responses": { "200": { "description": "The notification was sent successfully" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] } }, "/v1/loan-roles/{id}/role-type/{roleType}": { "delete": { "tags": [ "Loan Roles" ], "summary": "Deletes a loan role by id and role type", "operationId": "Delete", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "id of the existing loan role to delete", "required": true, "type": "integer", "format": "int32" }, { "in": "path", "name": "roleType", "description": "Role Type of the existing loan role to delete", "required": true, "type": "string" } ], "responses": { "204": { "description": "The loan role has been deleted successfully." }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "ApiAccess" ] } ] } }, "/v1/loan-roles": { "post": { "tags": [ "Loan Roles" ], "summary": "Creates a loan role", "operationId": "Create", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "The loan role to create", "schema": { "$ref": "#/definitions/LoanRole" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/LoanRole" }, "examples": { "application/json": {"id":125464545,"customerId":12356548,"portfolioLoanId":null,"proposedLoanId":123459,"percentResponsible":0.9234,"roleType":"Guarantor","isDeleted":false} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "201": { "description": "The loan role has been created successfully. The role that was created\r\n is returned and has the Sageworks id that was assigned." }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "ApiAccess" ] } ] } }, "/v1/loan-roles/{id}": { "patch": { "tags": [ "Loan Roles" ], "summary": "Updates a loan role", "operationId": "Update", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "id of the existing loan role to update", "required": true, "type": "integer", "format": "int32" }, { "in": "body", "name": "body", "description": "The loan role values to update", "schema": { "$ref": "#/definitions/LoanRole" } } ], "responses": { "200": { "description": "Returns the modified deposit", "schema": { "$ref": "#/definitions/LoanRole" }, "examples": { "application/json": {"id":125464545,"customerId":12356548,"portfolioLoanId":null,"proposedLoanId":123459,"percentResponsible":0.9234,"roleType":"Guarantor","isDeleted":false} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "ApiAccess" ] } ] } }, "/v1/loan-roles/{proposedLoanId}": { "get": { "tags": [ "Loan Roles" ], "summary": "[DEPRECATED -- USE /by-proposed-loan-id/{proposedLoanId}]\r\nGets a Loan Role by Proposed Loan ID", "operationId": "GetByProposedLoanIdDeprecated", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "proposedLoanId", "description": "id of the proposed loan", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "Gets the Loan Role associated with the specified Proposed Loan Id", "schema": { "$ref": "#/definitions/CollectionResponse[LoanRole]" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "ApiAccess" ] } ] } }, "/v1/loan-roles/by-proposed-loan-id/{proposedLoanId}": { "get": { "tags": [ "Loan Roles" ], "summary": "Gets a Loan Role by Proposed Loan ID", "operationId": "GetByProposedLoanId", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "proposedLoanId", "description": "id of the proposed loan", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "Gets the Loan Role associated with the specified Proposed Loan Id", "schema": { "$ref": "#/definitions/CollectionResponse[LoanRole]" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "ReadLoanRoles" ] } ] } }, "/v1/loan-roles/by-portfolio-loan-Id/{portfolioLoanId}": { "get": { "tags": [ "Loan Roles" ], "summary": "Gets a Loan Role by Portfolio Loan ID", "operationId": "GetByPortfolioLoanId", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "portfolioLoanId", "description": "id of the portfolio loan", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "Gets the Loan Role associated with the specified Portfolio Loan Id", "schema": { "$ref": "#/definitions/CollectionResponse[LoanRole]" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "ReadLoanRoles" ] } ] } }, "/v1/loan-roles/related-loan-roles/by-proposed-loan-id/{proposedLoanId}": { "get": { "tags": [ "Loan Roles" ], "summary": "Gets all Related Loan Role by Proposed Loan ID", "operationId": "GetRelatedRolesByProposedLoanId", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "proposedLoanId", "description": "id of the proposed loan", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "Gets all the related loan roles associated with the specified Proposed Loan Id", "schema": { "$ref": "#/definitions/CollectionResponse[RelatedLoanRole]" }, "examples": { "application/json": {"items":[{"id":125464545,"customerId":12356548,"portfolioLoanId":null,"proposedLoanId":123459,"parentLoanRoleId":12345,"parentLoanRoleType":"other","roleType":"Authorized Signer","isDeleted":false}]} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "ReadLoanRoles" ] } ] } }, "/v1/loan-roles/related-loan-roles/by-portfolio-loan-Id/{portfolioLoanId}": { "get": { "tags": [ "Loan Roles" ], "summary": "Gets all related roles by Portfolio Loan ID", "operationId": "GetRelatedRolesByPortfolioLoanId", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "portfolioLoanId", "description": "id of the portfolio loan", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "Gets all the related loan roles associated with the specified Portfolio Loan Id", "schema": { "$ref": "#/definitions/CollectionResponse[RelatedLoanRole]" }, "examples": { "application/json": {"items":[{"id":125464545,"customerId":12356548,"portfolioLoanId":25698,"proposedLoanId":null,"parentLoanRoleId":12345,"parentLoanRoleType":"other","roleType":"Authorized Signer","isDeleted":false}]} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "ReadLoanRoles" ] } ] } }, "/v1/loan-originations": { "get": { "tags": [ "Loan Origination" ], "summary": "Gets all loan originations", "operationId": "GetPaged", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "page", "description": "The page number of results to retrieve (first page = 1, default = 1)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "perPage", "description": "The number of records to return on each page (minimum = 1, maximum = 1000, default = 200)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "proposedLoanId", "description": "Proposed Loan Id to filter by", "type": "integer", "format": "int32" }, { "in": "query", "name": "coreSystemLoanNumber", "description": "Core System Loan Number to filter by", "type": "string" } ], "responses": { "200": { "description": "Gets all current, existing, and active loan originations in the account", "schema": { "$ref": "#/definitions/CollectionResponse[LoanOrigination]" }, "examples": { "application/json": {"items":[{"id":1231321,"proposedLoanId":2355466,"coreSystemLoanNumber":"ABCD123456","companyStatesId":10,"csLoanType":"commercial","loanStatusType":"application","loanTermType":"closedEndTermLoan","loanPaymentType":"principalAndInterestPayment","loanOriginationDocumentsStarted":false},{"id":1231322,"proposedLoanId":2355467,"coreSystemLoanNumber":"DEFG789454","companyStatesId":21,"csLoanType":"consumer","loanStatusType":"none","loanTermType":"openEndLineOfCredit","loanPaymentType":"replacementPayment","loanOriginationDocumentsStarted":false}]} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "LoanBoarding", null ] } ] } }, "/v1/loan-originations/{id}": { "get": { "tags": [ "Loan Origination" ], "summary": "Gets a loan origination by id", "operationId": "GetById", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "id of the loan origination to get", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "Gets the loan origination with the specified id", "schema": { "$ref": "#/definitions/LoanOrigination" }, "examples": { "application/json": {"id":1231321,"proposedLoanId":2355466,"coreSystemLoanNumber":"ABCD123456","companyStatesId":10,"csLoanType":"commercial","loanStatusType":"application","loanTermType":"closedEndTermLoan","loanPaymentType":"principalAndInterestPayment","loanOriginationDocumentsStarted":false} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "LoanBoarding", null ] } ] }, "patch": { "tags": [ "Loan Origination" ], "summary": "Updates a loan origination", "operationId": "Update", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "id of the loan origination to update", "required": true, "type": "integer", "format": "int32" }, { "in": "body", "name": "body", "description": "The loan origination values to update", "schema": { "$ref": "#/definitions/LoanOrigination" } } ], "responses": { "200": { "description": "Returns the modified proposed deposit", "schema": { "$ref": "#/definitions/LoanOrigination" }, "examples": { "application/json": {"id":1231321,"proposedLoanId":2355466,"coreSystemLoanNumber":"ABCD123456","companyStatesId":10,"csLoanType":"commercial","loanStatusType":"application","loanTermType":"closedEndTermLoan","loanPaymentType":"principalAndInterestPayment","loanOriginationDocumentsStarted":false} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "LoanBoarding", null ] } ] } }, "/v1/loan-originations/loan-origination-xml/{proposedLoanId}": { "get": { "tags": [ "Loan Origination" ], "summary": "Gets loan origination xml by proposed loan id", "operationId": "GetLoanOriginationByProposedLoan", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "proposedLoanId", "description": "id of the proposed loan to get loan origination xml for", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "Gets the loan origination with the specified proposed loan id", "schema": { "$ref": "#/definitions/ProposedLoanXml" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "LoanBoarding", null ] } ] } }, "/v1/loan-originations/loan-origination-xml-with-cs-data/{proposedLoanId}": { "get": { "tags": [ "Loan Origination" ], "summary": "Gets loan origination xml with CS data by proposed loan id", "operationId": "GetLoanOriginationWithCsDataByProposedLoan", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "proposedLoanId", "description": "id of the proposed loan to get loan origination xml for", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "Gets the loan origination with the specified proposed loan id", "schema": { "$ref": "#/definitions/ProposedLoanXml" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "LoanBoarding", null ] } ] } }, "/v1/proposed-loan-file/{proposedLoanId}": { "get": { "tags": [ "Proposed Loan File" ], "summary": "Gets a proposed loan file by proposedLoanId", "operationId": "GetProposedLoanFileById", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "proposedLoanId", "description": "id of the proposed loan", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "Gets the proposed loan file with the specified proposed loan id", "schema": { "$ref": "#/definitions/ProposedLoanFile" }, "examples": { "application/json": {"proposedLoan":{"id":84851632,"loanId":1235141,"loanName":"70045698","customerId":123456987,"loanAmount":798550.0,"riskRating":3,"paymentAmount":27000.0,"paymentFrequency":"quarterly","paymentType":"fixedPayment","loanOfficerId":12345778,"interestRate":0.079,"callCode":"1e1","collateralCode":"Boats","loanTypeCode":"Marine Establishments","productCode":"Marine Establishments - East","purposeCode":"Business expansion","industryCode":"110210","classCode":"B - Corporation","adjustableInterestRate":true,"loanTerm":60,"dayCountConvention":"c_Actual_365","amortizedOver":null,"isDeleted":false,"status":"approved","createdDate":null,"statusLastUpdatedDate":null,"probabilityOfClosing":0.74,"projectedClosingDate":null,"totalFees":500.0,"otherFees":500.0,"expectedUtilizationRate":0.25,"originationExpenses":200.0,"overheadExpenses":200.0,"upfrontFee":100.0,"annualFee":100.0,"unusedCommitmentFee":100.0,"servicingExpenses":200.0,"floorRate":0.03,"indexRateDescription":"lIBOR","indexRate":0.02,"spread":0.02,"ceilingRate":0.25,"proposedLoanStageId":null,"proposedProductsId":null,"evaluatedCreditScore":null,"bankCodeBranch":"123Abc","denialOrWithdrawalReason":null,"denialOrWithdrawalReasons":null,"loanTypeForDenialOrWithdrawal":null,"statusReason":null,"firstPaymentDate":null,"firstInterestPaymentDate":null,"isSubjectToRegO":null,"isTakedownLoan":null,"isGuidanceLineOfCredit":null,"noteDate":"2026-07-12","maturityDate":null,"repricingDate":null,"disbursementDate":"2026-07-20","discountPointsDollarAmount":null,"includeNegativeAmortization":null,"brokerCompensationPercent":null,"lenderCredits":null,"introductionRatePeriodInMonths":null,"pointsAndFees":null,"isPreapprovalRequested":null,"isReverseMortgage":null,"rateLockDate":null,"cdChangeOfCircumstanceDate":null,"rescissionDate":null,"leChangeOfCircumstanceDate":null,"includeOtherNonAmortizingFeatures":null,"ecoaAdverseAction1":null,"ecoaAdverseAction2":null,"ecoaAdverseAction3":null,"hmdaLoanType":null,"hmdaLoanPurposeType":null,"hmdaPurchaserType":null,"hmdaFinalActionTakenType":null,"craLoanType":null,"craLoanPurposeType":null,"hmdaAmortizationType":null,"hmdaHoepaStatusType":null,"craRevenueCodeType":null,"interestOnlyTerm":null,"interestOnlyPaymentFrequency":null,"participationType":"na","accountType":"loan","parentIsProposed":true,"parentLoansId":56789,"lossGivenDefaultRiskRating":"2","probabilityOfDefaultRiskRating":6.7,"withheldAmount":null,"institutionAvailableCredit":null,"institutionWithheld":null,"participatedAmount":null,"userDefinedString1":"Commercial","userDefinedString2":"Fixed Rate","userDefinedString3":"","userDefinedString4":"","userDefinedString5":"","userDefinedString6":"","userDefinedString7":"Another User Defined Value","userDefinedString8":"","userDefinedString9":"","userDefinedString10":"","userDefinedString11":"","userDefinedString12":"","userDefinedString13":"","userDefinedString14":"","userDefinedString15":"","userDefinedString16":"","userDefinedString17":"","userDefinedString18":"","userDefinedString19":"","userDefinedString20":"","userDefinedNumber1":13.77,"userDefinedNumber2":1044.0,"userDefinedNumber3":0.0045,"userDefinedNumber4":7.0,"userDefinedNumber5":7.0,"userDefinedNumber6":7.0,"userDefinedNumber7":7.0,"userDefinedNumber8":7.0,"userDefinedNumber9":7.0,"userDefinedNumber10":7.0,"userDefinedNumber11":7.0,"userDefinedNumber12":7.0,"userDefinedNumber13":7.0,"userDefinedNumber14":7.0,"userDefinedNumber15":7.0,"userDefinedNumber16":7.0,"userDefinedNumber17":7.0,"userDefinedNumber18":7.0,"userDefinedNumber19":7.0,"userDefinedNumber20":7.0,"userDefinedDate1":"2026-07-16","userDefinedDate2":"2026-07-15","userDefinedDate3":null,"userDefinedDate4":null,"userDefinedDate5":null,"userDefinedDate6":null,"userDefinedDate7":null,"userDefinedDate8":null,"userDefinedDate9":null,"userDefinedDate10":null,"userDefinedFields":null,"comments":"Comments","purpose":"Purpose","loanBoardingIdentifier":null,"creditRating":null,"glCostCenter":null,"prepaymentPenaltyCode":null,"originationFee":null,"crmIdentifier":null,"riskRatingId":null,"tridApplicationDate":null,"intentToProceedDate":null,"consummationDate":null,"leIssueDate":null,"leRequiredDate":null,"cdRequiredDate":null,"cdIssueDate":null,"cdReissueDate":null,"leReissueDate":null,"closingCostExpirationDate":null,"rateLockExpirationDate":null,"fundingDate":null,"earliestTridCloseDate":null,"mortgageRateLockDate":null,"balloonPayment":null,"hasSecondaryRate":false,"secondaryCeilingRate":null,"secondaryIndexRate":null,"secondaryFloorRate":null,"secondaryInterestRate":null,"secondaryAdjustableInterestRate":null,"secondaryIndexRateDescription":null,"secondaryTypeOfPaymentAdjustment":"higherInstallmentAmount","secondaryRepriceFrequencyInterval":null,"secondaryRepriceFrequencyUnits":null,"secondarySpread":null,"termBeforeSecondaryRate":null,"requestType":null,"repriceFrequencyInterval":null,"repriceFrequencyUnits":null,"statusChangedByUsersID":null},"customers":[{"customer":{"id":7456123,"name":"Example, LLC","dba":"Example Doing Business As","firstName":null,"middleInitial":null,"lastName":null,"nameSuffix":null,"userDefinedFields":{"User Defined Field 1":"Value 1","User Defined Field 2":"Value 2"},"creditScore":98,"secondaryCreditScore":null,"businessType":"llc","dnbScore":"567","namePrefix":null,"jobTitle":null,"addresses":[{"line1":"123 Main St","line2":"Suite 2078","city":"Example City","state":"NY","postalCode":"00101","country":"US","addressType":"primary"}],"phoneNumbers":[{"type":"primary","number":"(999)999-9999"}],"type":"business","emailAddress":"test-company@sageworks.com","industryCode":"99999","isDeleted":false,"uniqueIdentifier":"785654","taxId":"111111111","branch":null,"department":null,"website":null,"description":null,"restricted":false,"checkingBalance":15000.0,"savingsBalance":100000.0,"cDsBalance":50000.0,"averageChecking":14500.0,"averageSavings":125000.0,"averageCDs":60000.0,"citizenshipStatus":null,"maritalStatus":null,"isActiveMiltaryDuty":null,"isDependentOfActiveMiltaryDuty":null,"civDescription":null,"employer":null,"numberOfYearsEmployed":0.0,"ofacDesignation":null,"dateOfBirth":null,"idDescription":null,"idNumber":null,"idIssueDate":null,"idExpirationDate":null,"idIssuingAuthority":null,"idState":null,"comments":null,"msa":16980,"stateCode":12,"countyCode":"123","tractCode":"3453","longitude":-87.656376,"latitude":41.94763,"medianHouseholdIncome":107250.0,"metropolitanDivision":"Chicago-Naperville-Evanston, IL","metropolitanDivisionCode":"1234242","loanOfficer":null,"loanOfficerId":438331,"loanAdministrator":null,"equifaxCreditScore":null,"equifaxCreditScoreDate":null,"experianCreditScore":null,"experianCreditScoreDate":null,"transunionCreditScore":null,"transunionCreditScoreDate":null,"ficoSbssCreditScore":450,"ficoSbssCreditScoreDate":"2019-06-09","bankruptcies":null,"dateOfLastBankruptcy":null,"historical30DayDelinquencies":null,"historical60DayDelinquencies":null,"historical90DayDelinquencies":null,"historicalOtherDelinquencies":null,"currentMortgagePastDue":null,"currentInstallmentPastDue":null,"currentAutoPastDue":null,"currentEducationPastDue":null,"currentOpenPastDue":null,"currentRevolvingPastDue":null,"currentOtherPastDue":null,"currentTotalPastDue":null,"entryMethod":"operatingCompany","professionalLLC":true,"yearFounded":1999,"businessRegistered":"NY","farmRegistered":null,"stateOfFormation":"NY","franchiseName":"Franchise #1","franchiseLegalName":"#1 Franchise","franchiseStartDate":1999,"sbaCode":"123","cityHQ":"Chicago","stateHQ":"IL","franchiseDataImportDate":"2019-09-06","franchiseDataFinancialPeriod":2019,"historicalSuccessRate":130,"systemSupportAndExpenseCommitment":75,"resaleActivityLevel":25,"mngmtExperienceStability":35,"averageUnitRevenueGrowth":60,"prospectScreening":30,"unitEconomics":70,"franchiseAgreementAssessment":15,"franchiseeRelationship":30,"projectedUnitSuccess":200,"recurringRevenueSelfSufficiency":50,"totalFundScore":750,"finStatementStrength":25,"franchisedUnits":100,"minInitial":258625,"maxInitial":1609500,"avgInitial":602350,"companyOwnedUnits":53,"projectedOpenings":12,"compoundAnnualUnitGrowthRate":91.0,"compoundedUnitSuccessRate":0.96,"experianDBT":5,"equifaxDBT":null,"dbdbt":null,"dbPaydex":null,"ansoniaCreditRating":"3071K-8","ansoniaRiskScore":95,"creditLogicScore":58,"dbViabilityRating":"","lastReportRun":"2019-06-07","bankruptciesCount":0,"collectionsCount":0,"judgmentsCount":0,"chargeOffsCount":0,"liensCount":0,"nsfChecksCount":0,"dataDepthScore":0,"underFormation":null,"dateBusinessEstablished":null,"loanBoardingIdentifier":null,"crmIdentifier":null,"isMailingAddressDifferent":false,"licenseNumber":null},"loanRole":{"id":125464545,"customerId":7456123,"portfolioLoanId":null,"proposedLoanId":84851632,"percentResponsible":0.9234,"roleType":"Guarantor","isDeleted":false},"roles":null},{"customer":{"id":4213102,"name":"Smith, John","dba":null,"firstName":"John","middleInitial":null,"lastName":"Smith","nameSuffix":null,"userDefinedFields":{"User Defined Field 1":"Value 1","User Defined Field 2":"Value 2"},"creditScore":650,"secondaryCreditScore":null,"businessType":null,"dnbScore":null,"namePrefix":null,"jobTitle":null,"addresses":[{"line1":"456 Circle St","line2":"Apt 4B","city":"New York","state":"NY","postalCode":"00101","country":"US","addressType":"primary"}],"phoneNumbers":[{"type":"mobile","number":"(999)999-9999"}],"type":"person","emailAddress":"test-person@sageworks.com","industryCode":null,"isDeleted":false,"uniqueIdentifier":"746313","taxId":null,"branch":null,"department":null,"website":null,"description":null,"restricted":false,"checkingBalance":15000.0,"savingsBalance":100000.0,"cDsBalance":50000.0,"averageChecking":14500.0,"averageSavings":125000.0,"averageCDs":60000.0,"citizenshipStatus":"usCitizen","maritalStatus":"legallySeparated","isActiveMiltaryDuty":true,"isDependentOfActiveMiltaryDuty":false,"civDescription":"","employer":null,"numberOfYearsEmployed":0.0,"ofacDesignation":null,"dateOfBirth":null,"idDescription":"Passport","idNumber":"111111","idIssueDate":"2014-01-02","idExpirationDate":"2024-01-02","idIssuingAuthority":"","idState":null,"comments":null,"msa":null,"stateCode":null,"countyCode":null,"tractCode":null,"longitude":null,"latitude":null,"medianHouseholdIncome":null,"metropolitanDivision":null,"metropolitanDivisionCode":null,"loanOfficer":"Test Loan Officer","loanOfficerId":438323,"loanAdministrator":"Test Loan Admin","equifaxCreditScore":670,"equifaxCreditScoreDate":"2018-04-05","experianCreditScore":700,"experianCreditScoreDate":"2019-05-06","transunionCreditScore":750,"transunionCreditScoreDate":"2019-06-07","ficoSbssCreditScore":720,"ficoSbssCreditScoreDate":"2019-06-08","bankruptcies":"0","dateOfLastBankruptcy":"","historical30DayDelinquencies":"2","historical60DayDelinquencies":"1","historical90DayDelinquencies":"0","historicalOtherDelinquencies":"0","currentMortgagePastDue":"0","currentInstallmentPastDue":"0","currentAutoPastDue":"90","currentEducationPastDue":"0","currentOpenPastDue":"0","currentRevolvingPastDue":"100","currentOtherPastDue":"0","currentTotalPastDue":"0","entryMethod":"operatingCompany","professionalLLC":null,"yearFounded":0,"businessRegistered":null,"farmRegistered":null,"stateOfFormation":null,"franchiseName":null,"franchiseLegalName":null,"franchiseStartDate":null,"sbaCode":null,"cityHQ":null,"stateHQ":null,"franchiseDataImportDate":null,"franchiseDataFinancialPeriod":null,"historicalSuccessRate":null,"systemSupportAndExpenseCommitment":null,"resaleActivityLevel":null,"mngmtExperienceStability":null,"averageUnitRevenueGrowth":null,"prospectScreening":null,"unitEconomics":null,"franchiseAgreementAssessment":null,"franchiseeRelationship":null,"projectedUnitSuccess":null,"recurringRevenueSelfSufficiency":null,"totalFundScore":null,"finStatementStrength":null,"franchisedUnits":null,"minInitial":null,"maxInitial":null,"avgInitial":null,"companyOwnedUnits":null,"projectedOpenings":null,"compoundAnnualUnitGrowthRate":null,"compoundedUnitSuccessRate":null,"experianDBT":null,"equifaxDBT":null,"dbdbt":null,"dbPaydex":null,"ansoniaCreditRating":null,"ansoniaRiskScore":null,"creditLogicScore":null,"dbViabilityRating":null,"lastReportRun":null,"bankruptciesCount":null,"collectionsCount":null,"judgmentsCount":null,"chargeOffsCount":null,"liensCount":null,"nsfChecksCount":null,"dataDepthScore":null,"underFormation":null,"dateBusinessEstablished":null,"loanBoardingIdentifier":null,"crmIdentifier":null,"isMailingAddressDifferent":false,"licenseNumber":null},"loanRole":{"id":43423243,"customerId":4213102,"portfolioLoanId":null,"proposedLoanId":84851632,"percentResponsible":0.007,"roleType":"Guarantor","isDeleted":false},"roles":null}],"collaterals":[{"id":45613213,"description":"45687 Walker Ave","currentValue":1250000.0,"mostRecentAppraisalValue":1250000.0,"mostRecentAppraisalDate":"2026-04-16","collateralCode":"330","collateralType":"OtherRealEstate","mileage":null,"equipmentYear":null,"equipmentManufacturer":null,"customerId":48561333,"originalValue":990000.0,"discountRate":0.2,"isDeleted":false,"propertyAddress":"123 Main Street","propertyCity":"New York","propertyState":"NY","propertyZip":"11111","propertyCounty":"New York","propertyTaxID":"123456789","make":"Ford","vin":"1XHDN34343DKSDGDHEEA45","model":"Fusion","year":"2020","bodyStyle":"sedan","serialNumber":"3409594548354543","manufacturer":"","aircraftNumber":"12345","vesselName":"Test Vessel","vesselNumber":"12345","possessoryType":"savings","accountLOCNumber":"5555555","issuedBy":"lender","issuer":"Lender 1234","shares":1,"cusip":"123456789","heldBy":"other","beneficiary":"Beneficiary XYZ","letterOfCreditDate":"2016-09-06","govtContractNumber":"34798445854","govtContractDate":"2018-05-06","titledType":"unknown","floodDeterminationDate":"2017-09-02","specialFloodHazardArea":0,"capitalizationRate":1234.0,"isLOMC":true,"collateralBreakout":null,"cbraAndOPADesignationDate":"2015-10-06","dwelling":"principal","vesselLength":32,"floodZone":"a","floodZoneCode":"","floodProgramType":false,"isLandImprovements":false,"lomcCaseNumber":"123467","lomcDate":"2016-09-06","nfipMapNumber":"12345","nfipMapPanelDate":"2013-09-06","nfipCommunityName":"Community Name","nfipCommunityNumber":"3465656754","nfipPropertyDescription":"Test Property","constructionMethod":"siteBuilt","manufacturedHomeType":"notApplicable","manufacturedHomeLandPropertyInterest":"notApplicable","totalUnits":1,"multiFamilyAffordableUnits":"","occupancyType":"principalResidence","isForAgriculturalPurpose":false,"isOwnerOccupied":true,"isSecondHome":false,"isProtectedArea":false,"stateCode":12,"countyCode":"123","tractCode":"3453","latitude":41.947630,"longitude":-87.656376,"metropolitanStatisticalArea":16980,"medianHouseholdIncome":107250.0,"metropolitanDivision":"Chicago-Naperville-Evanston, IL","metropolitanDivisionCode":"1234242","userDefinedFields":{"User Defined Text":"test 123","User Defined Numeric":"54","User Defined Currency":"5454.0000","User Defined Percent":"4.54","User Defined Date":"3/12/2020 12:00:00 AM","User Defined Dropdown":"Yes","User Defined Yes No":"Yes"},"dateAppraisalRequested":"2021-01-07","isReadyForAppraisal":true,"collateralMetadataType":"existing","collateralIdentifier":null,"legalDescription":null,"source":null,"comments":null,"coOwnerCustomerIds":null,"proposedAdjustmentComments":null,"includeInProposedScenario":null,"proposedCurrentValue":0.0,"proposedValueAdjustment":0.0}]} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "LoanBoarding", null ] } ] } }, "/v1/loan-boarding/jxchange/board-loan-to-core/{proposedBankLoanId}": { "post": { "tags": [ "Loan Origination" ], "summary": "Board the loan to the core using jXchange", "operationId": "JXchangeBoardLoanToCore", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "proposedBankLoanId", "description": "Id of the proposed loan to board", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/JXchangeBoardLoanToCoreResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/JXchangeBoardLoanToCoreErrorResponse" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "LoanBoarding", null ] } ] } }, "/v1/loan-boarding/connections/board-loan-to-core/{proposedBankLoanId}": { "post": { "tags": [ "Loan Origination" ], "summary": "Board the loan to the core using Sageworks Connections", "operationId": "BoardLoanToCoreSageworksConnectionsAsync", "parameters": [ { "in": "path", "name": "proposedBankLoanId", "description": "Id of the proposed loan to board", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "LoanBoarding", null ] } ] } }, "/v1/proposed-liens": { "get": { "tags": [ "Proposed Liens" ], "summary": "Gets all proposed liens", "operationId": "GetPaged", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "page", "description": "The page number of results to retrieve (first page = 1, default = 1)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "perPage", "description": "The number of records to return on each page (minimum = 1, maximum = 1000, default = 200)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "collateralId", "description": "CollateralId to filter by", "type": "integer", "format": "int64" }, { "in": "query", "name": "proposedLoanId", "description": "ProposedLoanId to filter by", "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "Gets all proposed liens in the account", "schema": { "$ref": "#/definitions/CollectionResponse[ProposedLien]" }, "examples": { "application/json": {"items":[{"id":1231321,"collateralId":2355466,"loanReferenceLoanId":354545,"loanReferenceType":"portfolio","lienPosition":1,"lienHolder":"John Smith","lienAmount":12143.0,"isDeleted":false},{"id":54534,"collateralId":564563,"loanReferenceLoanId":7582,"loanReferenceType":"proposed","lienPosition":2,"lienHolder":"Jane Doe","lienAmount":8543.0,"isDeleted":false}]} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "ReadLiens" ] } ] }, "post": { "tags": [ "Proposed Liens" ], "summary": "Creates a Proposed Lien", "operationId": "Create", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "The Proposed Lien to create", "schema": { "$ref": "#/definitions/ProposedLien" } } ], "responses": { "201": { "description": "The Proposed Lien has been created successfully. The Proposed Lien that was created\r\n is returned and has the Sageworks id that was assigned.", "schema": { "$ref": "#/definitions/ProposedLien" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "ApiAccess" ] } ] } }, "/v1/proposed-liens/{id}": { "get": { "tags": [ "Proposed Liens" ], "summary": "Gets a Proposed Lien by id", "operationId": "GetById", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "id of the existing Proposed Lien to get", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "Gets the Proposed Lien with the specified id", "schema": { "$ref": "#/definitions/ProposedLien" }, "examples": { "application/json": {"id":1231321,"collateralId":2355466,"loanReferenceLoanId":354545,"loanReferenceType":"portfolio","lienPosition":1,"lienHolder":"John Smith","lienAmount":12143.0,"isDeleted":false} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "ReadLiens" ] } ] }, "patch": { "tags": [ "Proposed Liens" ], "summary": "Updates a Proposed Lien", "operationId": "Update", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "id of the existing Proposed Lien to update", "required": true, "type": "integer", "format": "int32" }, { "in": "body", "name": "body", "description": "The Proposed Lien values to update", "schema": { "$ref": "#/definitions/ProposedLien" } } ], "responses": { "200": { "description": "Returns the modified Proposed Lien", "schema": { "$ref": "#/definitions/ProposedLien" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "ApiAccess" ] } ] }, "delete": { "tags": [ "Proposed Liens" ], "summary": "Deletes a Proposed Lien by id", "operationId": "Delete", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "id of the existing Proposed Lien to delete", "required": true, "type": "integer", "format": "int32" } ], "responses": { "204": { "description": "The Proposed Lien has been deleted successfully." }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "ApiAccess" ] } ] } }, "/v1/proposed-liens/bulk": { "post": { "tags": [ "Proposed Liens" ], "summary": "Creates a collection of Proposed Liens", "operationId": "CreateMany", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "The collection of Proposed Liens to create", "schema": { "$ref": "#/definitions/BulkCreateRequest[ProposedLien]" } } ], "responses": { "200": { "description": "All Proposed Liens were processed. Please check the errors property of the response object\r\n to determine if there were errors creating any individual Proposed Lien", "schema": { "$ref": "#/definitions/BulkCreateResponse[ProposedLien]" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "ApiAccess" ] } ] }, "patch": { "tags": [ "Proposed Liens" ], "summary": "Updates a collection of Proposed Liens", "operationId": "UpdateMany", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "The collection of Proposed Liens to update", "schema": { "$ref": "#/definitions/BulkUpdateRequest[ProposedLien]" } } ], "responses": { "200": { "description": "All Proposed Liens were processed. Please check the errors property of the response object\r\n to determine if there were errors updating any individual Proposed Lien", "schema": { "$ref": "#/definitions/BulkUpdateRequest[ProposedLien]" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "ApiAccess" ] } ] } }, "/internal-deprecated/v1/sba-financials/entities/{profitEntitiesId}/options": { "get": { "tags": [ "SbaFinancials" ], "summary": "Get available financial options for a profit entity", "operationId": "GetFinancialOptions", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "profitEntitiesId", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "Success", "schema": { "type": "array", "items": { "$ref": "#/definitions/SelectOption" } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] } }, "/internal-deprecated/v1/sba-financials/business/{inputDataId}": { "get": { "tags": [ "SbaFinancials" ], "summary": "Get business financial data by input data ID", "operationId": "GetBusinessFinancialData", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "inputDataId", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/SbaBusinessFinancialData" } }, "404": { "description": "Not Found" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] } }, "/internal-deprecated/v1/sba-financials/proposed-loans/{proposedLoanId}/business/{profitEntitiesId}": { "get": { "tags": [ "SbaFinancials", "Consumer:Sba", "external" ], "summary": "Get business financial data for a proposed loan and profit entity", "operationId": "GetProposedLoanBusinessFinancials", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "proposedLoanId", "required": true, "type": "integer", "format": "int64" }, { "in": "path", "name": "profitEntitiesId", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/ProposedBankLoanBusinessSbaFinancialDto" } }, "404": { "description": "Not Found" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ], "x-external-consumers": [ "Sba" ] } }, "/internal-deprecated/v1/sba-financials/business": { "post": { "tags": [ "SbaFinancials" ], "summary": "Save or update business financial data for a proposed loan", "operationId": "SaveBusinessFinancialData", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/ProposedBankLoanBusinessSbaFinancialData" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/ProposedBankLoanBusinessSbaFinancialDto" } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] } }, "/internal-deprecated/v1/sba-financials/personal/{inputDataId}": { "get": { "tags": [ "SbaFinancials" ], "summary": "Get personal financial data by input data ID", "operationId": "GetPersonalFinancialData", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "inputDataId", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/SbaPersonalFinancialData" } }, "404": { "description": "Not Found" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] } }, "/internal-deprecated/v1/sba-financials/proposed-loans/{proposedLoanId}/personal/{profitEntitiesId}": { "get": { "tags": [ "SbaFinancials", "Consumer:Sba", "external" ], "summary": "Get personal financial data for a proposed loan and profit entity", "operationId": "GetProposedLoanPersonalFinancials", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "proposedLoanId", "required": true, "type": "integer", "format": "int64" }, { "in": "path", "name": "profitEntitiesId", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/ProposedBankLoanPersonalSbaFinancialDto" } }, "404": { "description": "Not Found" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ], "x-external-consumers": [ "Sba" ] } }, "/internal-deprecated/v1/sba-financials/personal": { "post": { "tags": [ "SbaFinancials" ], "summary": "Save or update personal financial data for a proposed loan", "operationId": "SavePersonalFinancialData", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/ProposedBankLoanPersonalSbaFinancialData" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/ProposedBankLoanPersonalSbaFinancialDto" } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] } }, "/v2/business-financials": { "get": { "tags": [ "Business Financials V2" ], "summary": "Gets all business financials", "operationId": "GetPaged", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "page", "description": "The page number of results to retrieve (first page = 1, default = 1)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "perPage", "description": "The number of records to return on each page (minimum = 1, maximum = 1000, default = 200)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "customerIds", "description": "CustomerId values to filter by", "type": "array", "items": { "format": "int64", "type": "integer" }, "collectionFormat": "multi" }, { "in": "query", "name": "periodEndDate", "description": "The date that the period in question ended", "type": "string", "format": "date-time", "x-nullable": true }, { "in": "query", "name": "dataSources", "description": "The sources of the information being entered", "type": "array", "items": { "format": "string", "description": "The Source of Data for an income statement", "enum": [ "annualized", "audit", "companyPrepared", "compilation", "financialStatement", "projection", "merged", "other", "review", "sample", "taxReturn", "trailing12Months", "average", "projection2", "projection3", "projection4", "projection5", "consolidation" ], "type": "string" }, "collectionFormat": "multi" }, { "in": "query", "name": "periodDuration", "description": "The length (in months) of the period in question", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "taxForm", "description": "The type of tax form", "type": "string" }, { "in": "query", "name": "taxYears", "description": "Tax return years", "type": "array", "items": { "format": "int32", "type": "integer" }, "collectionFormat": "multi" } ], "responses": { "200": { "description": "Gets all current, existing, and active business financials in the account", "schema": { "$ref": "#/definitions/CollectionResponse[BusinessFinancialV2]" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "ReadBusinessFinancials" ] } ] }, "post": { "tags": [ "Business Financials V2" ], "summary": "Creates a business financial", "operationId": "Create", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "The business financial to create", "schema": { "$ref": "#/definitions/BusinessFinancialV2" } } ], "responses": { "201": { "description": "The business financial has been created successfully. The business financial that was created\r\n is returned and has the Sageworks id that was assigned.", "schema": { "$ref": "#/definitions/BusinessFinancialV2" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "ApiAccess" ] } ] } }, "/v2/business-financials/{id}": { "get": { "tags": [ "Business Financials V2" ], "summary": "Gets an business financial by id", "operationId": "GetById", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "id of the existing business financials to get", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "Gets the business financials with the specified id", "schema": { "$ref": "#/definitions/BusinessFinancialV2" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "ReadBusinessFinancials" ] } ] }, "patch": { "tags": [ "Business Financials V2" ], "summary": "Updates a business financial", "operationId": "Update", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "The id of the existing financial that is to be updated", "required": true, "type": "integer", "format": "int32" }, { "in": "body", "name": "body", "description": "The financial values to use when updating", "schema": { "$ref": "#/definitions/BusinessFinancialV2" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/BusinessFinancialV2" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "ApiAccess" ] } ] } }, "/v2/business-financials/calculate-fields": { "post": { "tags": [ "Business Financials V2" ], "summary": "Gets calculated fields for a business financial", "operationId": "GetBusinessFinancialCalculatedFieldValues", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "The business financial to use for calculations", "schema": { "$ref": "#/definitions/BusinessFinancialV2" } } ], "responses": { "200": { "description": "The business financial calculations have calculated successfully.", "schema": { "$ref": "#/definitions/BusinessFinancialCalculatedFields" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "ApiAccess" ] } ] } }, "/v2/business-financials/{id}/map-real-estate-investments": { "post": { "tags": [ "Business Financials V2" ], "summary": "Maps the income values for the linked real estate financials to the given business financial income\r\nstatement fields", "operationId": "MapRealEstateInvestmentsToIncomeStatement", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "The id of the business financial to map", "required": true, "type": "integer", "format": "int32" }, { "in": "body", "name": "body", "description": "", "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/BusinessFinancialV2" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "ApiAccess" ] } ] } }, "/v1/financial-information/business-financials": { "get": { "tags": [ "Financial Information" ], "summary": "Gets all business financial information\r\n \r\nNote: Use of the CustomerId query parameter is required", "operationId": "GetPagedBusinessFinancials", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "page", "description": "The page number of results to retrieve (first page = 1, default = 1)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "perPage", "description": "The number of records to return on each page (minimum = 1, maximum = 1000, default = 200)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "customerId", "description": "CustomerId value to filter by - REQUIRED", "type": "integer", "format": "int32" }, { "in": "query", "name": "periodEndDate", "description": "Period End Date to filter by", "type": "string", "format": "date-time" }, { "in": "query", "name": "dataSource", "description": "Data Source to filter by", "type": "string", "format": "string", "enum": [ "none", "annualized", "audit", "companyPrepared", "compilation", "financialStatement", "foreignCurrencyStatement", "merged", "other", "projection", "quickFinancials", "review", "sample", "taxReturn", "trailingTwelveMonths", "average", "payStub", "wTwo", "organizationPrepared", "selfReported" ] } ], "responses": { "200": { "description": "Gets all current, existing, and active business financial information in the account", "schema": { "$ref": "#/definitions/CollectionResponse[FinancialInfoExtractBusinessFinancialInformation]" }, "examples": { "application/json": {"items":[{"id":17813517,"periodEndDate":"2021-04-15","customerId":62747735,"dataSource":"compilation","incomeStatement":{"accountingMethod":"AccrualMethod","periodDuration":12,"personEnteringData":"Tom","accountingFirm":"Accounting Firm","description":"2020 data","salesIncome":33213.0,"costOfSales":3213.0,"depreciationCostOfSales":321.0,"grossProfit":30000.0,"depreciation":321.0,"amortization":321.0,"overheadOrSGAExpenses":6078.0,"gaPayrollExpense":412.0,"rent":5234.0,"advertising":432.0,"otherOperatingIncome":552.0,"otherOperatingExpenses":2342.0,"totalOperatingExpenses":9062.0,"operatingProfit":21490.0,"interestExpense":432.0,"otherIncome":3423.0,"otherExpenses":432.0,"unadjustedEBITDA":25444.0,"ebitdaAdjustments":445.0,"ebitda":25889.0,"netProfitBeforeTaxes":24049.0,"taxesPaid":643.0,"extraordinaryGain":63.0,"extraordinaryLoss":432.0,"netIncome":23046.0,"comments":"Income statement comments","additionalFields":{"Additional Field":"123.0000"}},"balanceSheet":{"cashBankFunds":20.0,"accountsReceivable":21.0,"inventory":22.0,"otherCurrentAssets":23.0,"totalCurrentAssets":86.0,"grossFixedAssets":24.0,"accumulatedDepreciation":25.0,"netFixedAssets":-1.0,"grossIntangibleAssets":26.0,"accumulatedAmortization":27.0,"netIntangibleAssets":-1.0,"otherAssets":28.0,"totalAssets":112.0,"accountsPayable":29.0,"shortTermDebt":30.0,"notesPayableCurrentPortionOfLongTermDebt":31.0,"otherCurrentLiabilities":32.0,"totalCurrentLiabilities":122.0,"notesPayableSeniorDebt":33.0,"notesPayableSubordinatedDebt":34.0,"otherLongTermLiabilities":35.0,"totalLongTermLiabilities":102.0,"totalLiabilities":224.0,"preferredStock":36.0,"commonStock":337.0,"additionalPaidInCapital":38.0,"otherStockEquity":39.0,"endingRetainedEarnings":40.0,"totalEquity":490.0,"totalLiabilitiesAndEquity":714.0,"totalAssetsMinusLiabilitiesAndEquity":-602.0,"tangibleNetWorth":491.0,"contingentLiabilities":41.0,"comments":"balance sheet comment","additionalFields":{"Additional Field":"123.0000"}},"statementOfEquity":{"specifyRealEstateInvestments":false,"specifyLoanInformation":false,"beginningRetainedEarnings":42.0,"netIncome":23046.0,"dividendsPaidWithdrawals":43.0,"otherChangesToRetainedEarnings":44.0,"calculatedEndingRetainedEarnings":-23.0,"actualEndingRetainedEarningsFromBalanceSheet":40.0,"differenceUnexplainedChangeInRetainedEarnings":63.0,"comments":"statement of equity comments","additionalFields":{"Additional Field":"123.0000"}},"realEstateInvestment":[{"propertyName":"Property Name","propertyType":"Existing","annualPotentialGrossRentalIncome":1.0,"annualPotentialCAMAndOtherIncome":2.0,"anticipatedVacancyRate":0.03,"annualGrossIncome":3.0,"postVacancyRateIncome":4.0,"effectiveGrossIncome":7.0,"insurance":5.0,"taxes":6.0,"propertyManagementFees":7.0,"advertisingAndMarketing":8.0,"maintenanceCareImprovements":9.0,"reserveForStructuralReplacements":0.0,"otherOperatingExpenses":10.0,"totalOperatingExpenses":45.0,"netOperatingIncome":-38.0,"capitalizationRate":0.11,"propertyValue":12.0,"percentOwnership":0.13,"adjustedNetOperatingIncome":-4.94,"adjustedPropertyValue":1.56,"nonCashExpensesDepreciation":14.0,"interestExpense":15.0,"comments":"Property comments","additionalFields":{"Additional Field":"123.0000"}}],"businessLoans":{"otherAnnualDebtService":50.0,"refinancedOtherDebtService":51.0,"shortTermDebt":30.0,"currentPortionOfLongTermDebt":31.0,"notesPayableSeniorDebt":33.0,"notesPayableSubordinatedDebt":34.0,"totalDebtFromBalanceSheet":128.0,"totalBalanceOfAllCurrentLoans":0.0,"outstandingBalanceSheetDebt":128.0,"itemizedAnnualDebtService":0.0,"additionalFields":{"Additional Field":"123.0000"}},"additionalFields":{"incomeStatementFields":{"Income Statement Field":"123.0000"},"balanceSheetFields":{"Balance Sheet Field":"123.0000"},"statementOfEquityFields":{"Statement of Equity Field":"123.0000"},"otherFields":{"Other Field":"123.0000"},"additionalMetricsFields":{"Metric Field":"123.0000"},"realEstateFields":{}}},{"id":17813518,"periodEndDate":"2021-04-15","customerId":62747735,"dataSource":"compilation","incomeStatement":{"accountingMethod":"AccrualMethod","periodDuration":12,"personEnteringData":"Tom","accountingFirm":"Accounting Firm","description":"2020 data","salesIncome":33213.0,"costOfSales":3213.0,"depreciationCostOfSales":321.0,"grossProfit":30000.0,"depreciation":321.0,"amortization":321.0,"overheadOrSGAExpenses":6078.0,"gaPayrollExpense":412.0,"rent":5234.0,"advertising":432.0,"otherOperatingIncome":552.0,"otherOperatingExpenses":2342.0,"totalOperatingExpenses":9062.0,"operatingProfit":21490.0,"interestExpense":432.0,"otherIncome":3423.0,"otherExpenses":432.0,"unadjustedEBITDA":25444.0,"ebitdaAdjustments":445.0,"ebitda":25889.0,"netProfitBeforeTaxes":24049.0,"taxesPaid":643.0,"extraordinaryGain":63.0,"extraordinaryLoss":432.0,"netIncome":23046.0,"comments":"Income statement comments","additionalFields":{}},"balanceSheet":{"cashBankFunds":20.0,"accountsReceivable":21.0,"inventory":22.0,"otherCurrentAssets":23.0,"totalCurrentAssets":86.0,"grossFixedAssets":24.0,"accumulatedDepreciation":25.0,"netFixedAssets":-1.0,"grossIntangibleAssets":26.0,"accumulatedAmortization":27.0,"netIntangibleAssets":-1.0,"otherAssets":28.0,"totalAssets":112.0,"accountsPayable":29.0,"shortTermDebt":30.0,"notesPayableCurrentPortionOfLongTermDebt":31.0,"otherCurrentLiabilities":32.0,"totalCurrentLiabilities":122.0,"notesPayableSeniorDebt":33.0,"notesPayableSubordinatedDebt":34.0,"otherLongTermLiabilities":35.0,"totalLongTermLiabilities":102.0,"totalLiabilities":224.0,"preferredStock":36.0,"commonStock":337.0,"additionalPaidInCapital":38.0,"otherStockEquity":39.0,"endingRetainedEarnings":40.0,"totalEquity":490.0,"totalLiabilitiesAndEquity":714.0,"totalAssetsMinusLiabilitiesAndEquity":-602.0,"tangibleNetWorth":491.0,"contingentLiabilities":41.0,"comments":"balance sheet comment","additionalFields":{}},"statementOfEquity":{"specifyRealEstateInvestments":false,"specifyLoanInformation":false,"beginningRetainedEarnings":42.0,"netIncome":23046.0,"dividendsPaidWithdrawals":43.0,"otherChangesToRetainedEarnings":44.0,"calculatedEndingRetainedEarnings":-23.0,"actualEndingRetainedEarningsFromBalanceSheet":40.0,"differenceUnexplainedChangeInRetainedEarnings":63.0,"comments":"statement of equity comments","additionalFields":{}},"realEstateInvestment":[{"propertyName":"Property Name","propertyType":"Proposed","annualPotentialGrossRentalIncome":1.0,"annualPotentialCAMAndOtherIncome":2.0,"anticipatedVacancyRate":0.03,"annualGrossIncome":3.0,"postVacancyRateIncome":4.0,"effectiveGrossIncome":7.0,"insurance":5.0,"taxes":6.0,"propertyManagementFees":7.0,"advertisingAndMarketing":8.0,"maintenanceCareImprovements":9.0,"reserveForStructuralReplacements":0.0,"otherOperatingExpenses":10.0,"totalOperatingExpenses":45.0,"netOperatingIncome":-38.0,"capitalizationRate":0.11,"propertyValue":12.0,"percentOwnership":0.13,"adjustedNetOperatingIncome":-4.94,"adjustedPropertyValue":1.56,"nonCashExpensesDepreciation":14.0,"interestExpense":15.0,"comments":"Property comments","additionalFields":{}}],"businessLoans":{"otherAnnualDebtService":53.0,"refinancedOtherDebtService":52.0,"shortTermDebt":0.0,"currentPortionOfLongTermDebt":0.0,"notesPayableSeniorDebt":0.0,"notesPayableSubordinatedDebt":0.0,"totalDebtFromBalanceSheet":0.0,"totalBalanceOfAllCurrentLoans":0.0,"outstandingBalanceSheetDebt":0.0,"itemizedAnnualDebtService":0.0,"additionalFields":{"Additional Field":"123.0000"}},"additionalFields":{"incomeStatementFields":{"Income Statement Field":"123.0000"},"balanceSheetFields":{"Balance Sheet Field":"123.0000"},"statementOfEquityFields":{"Statement of Equity Field":"123.0000"},"otherFields":{"Other Field":"123.0000"},"additionalMetricsFields":{"Metric Field":"123.0000"},"realEstateFields":{"Income":"123.0000"}}}]} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ReadFinancialInformation", null ] } ] } }, "/v1/financial-information/business-financials/{id}": { "get": { "tags": [ "Financial Information" ], "summary": "Gets a business financial information by id", "operationId": "GetByIdBusinessFinancials", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "id of the business financial information to get", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "Gets the business financial information with the specified id", "schema": { "$ref": "#/definitions/FinancialInfoExtractBusinessFinancialInformation" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ReadFinancialInformation", null ] } ] } }, "/v1/financial-information/personal-financials": { "get": { "tags": [ "Financial Information" ], "summary": "Gets all personal financial information\r\n \r\nNote: Use of the CustomerId query parameter is required", "operationId": "GetPagedPersonalFinancials", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "page", "description": "The page number of results to retrieve (first page = 1, default = 1)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "perPage", "description": "The number of records to return on each page (minimum = 1, maximum = 1000, default = 200)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "customerId", "description": "CustomerId value to filter by - REQUIRED", "type": "integer", "format": "int32" }, { "in": "query", "name": "periodEndDate", "description": "Period End Date to filter by", "type": "string", "format": "date-time" }, { "in": "query", "name": "dataSource", "description": "Data Source to filter by", "type": "string", "format": "string", "enum": [ "none", "annualized", "audit", "companyPrepared", "compilation", "financialStatement", "foreignCurrencyStatement", "merged", "other", "projection", "quickFinancials", "review", "sample", "taxReturn", "trailingTwelveMonths", "average", "payStub", "wTwo", "organizationPrepared", "selfReported" ] } ], "responses": { "200": { "description": "Gets all current, existing, and active personal financial information in the account", "schema": { "$ref": "#/definitions/CollectionResponse[FinancialInfoExtractPersonalFinancialInformation]" }, "examples": { "application/json": {"items":[{"id":4682896,"periodEndDate":"2021-01-01","customerId":81198153,"dataSource":"none","incomeAndExpenses":{"personEnteringData":"Worker","accountingFirm":"Acct Firm","sourceOfIncome":"payStub","taxReturnDate":null,"description":"Description","yearlyGrossWagesSalaries":32131.0,"otherRegularAndDependableSourcesOfIncome":231.0,"cashFlowFromRealEstateInvestmentsBeforeDebtService":33421.0,"cashFlowFromBusinessInvestmentsBeforeDebtService":5532.0,"personalIncomeAdjustments":231.0,"totalPersonalIncome":321.0,"yearlyRentPayments":552.0,"taxesPaidOptional":634.0,"personalExpenses":23.0,"netPersonalIncomeBeforeDebtService":123.0,"investmentRealEstateProperty":false,"stockInAPrivatelyHeldBusiness":true,"comments":"Income comments","additionalFields":{"Additional Field":"123.0000"}},"realEstateInvestments":[{"propertyName":"Property Name","propertyType":"Existing","annualPotentialGrossRentalIncome":1.0,"annualPotentialCAMAndOtherIncome":2.0,"anticipatedVacancyRate":0.03,"annualGrossIncome":3.0,"postVacancyRateIncome":4.0,"effectiveGrossIncome":7.0,"insurance":5.0,"taxes":6.0,"propertyManagementFees":7.0,"advertisingAndMarketing":8.0,"maintenanceCareImprovements":9.0,"reserveForStructuralReplacements":0.0,"otherOperatingExpenses":10.0,"totalOperatingExpenses":45.0,"netOperatingIncome":-38.0,"capitalizationRate":0.11,"propertyValue":12.0,"percentOwnership":0.13,"adjustedNetOperatingIncome":-4.94,"adjustedPropertyValue":1.56,"nonCashExpensesDepreciation":14.0,"interestExpense":15.0,"comments":"Property comments","additionalFields":{"Additional Field":"123.0000"}}],"businessInvestments":[{"customerId":55324234,"estimatedValueOfOwnership":32124.22,"cashFlow":55324.0,"percentOwnership":0.55,"comments":"Business Investment Comment"}],"recurringDebt":{"otherAnnualDebtService":432.43,"portionOfOtherDebtServiceToBeRefinanced":77435.85,"additionalFields":{"Additional Field":"123.0000"}},"personalAssets":{"cashCheckingSavingsMoneyMarket":5342.0,"publicCompanyStocksBonds":64534.0,"mutualFundsOrPooledSecurities":4325.0,"otherLiquidOrSemiLiquidAssetsOnHand":99382.0,"totalLiquidAndSemiLiquidAssetsOnHand":4738.0,"closelyHeldCompanyStock":9832.0,"cashValueOfLifeInsurance":7932.0,"retirementAccounts":4247.0,"automobiles":3523.43,"jewelry":1300.0,"furnitureFixtures":5432.0,"otherPersonalAssets":313.0,"valueOfPersonalResidence":55324.0,"valueOfOtherNonInvestmentProperties":1861.0,"valueOfItemizedRealEstateInvestments":3516.0,"valueOfOtherRealEstateInvestments":4984.0,"totalValueOfRealEstateInvestments":468.0,"totalValueOfBusinessAndInvestmentHoldings":991.0,"totalAssets":345311.0,"comments":"Personal Asset comments","additionalFields":{"Additional Field":"123.0000"}},"personalLiabilities":{"balanceOfAllCreditCards":55342.0,"taxesOwed":1651.0,"otherLinesOfCredit":5499.0,"otherShortTermLoansLiabilities":302.0,"totalCurrentLiabilities":55.61,"automobileLoans":65649.0,"firstMortgageOnPrimaryResidence":1351.0,"secondMortgageOnPrimaryResidence":335.0,"homeEquityBalanceOnPrimaryResidence":4465.0,"studentLoans":6449.0,"loansOnOtherNonInvestmentProperties":315.0,"otherInstallmentLoans":213.0,"otherLongTermLoansLiabilities":2315.0,"loansOnRealEstateInvestments":631.65,"loansOnBusinessAndInvestmentHoldings":66445.0,"totalLiabilities":131.0,"personalNetWorth":389.0,"contingentLiabilities":975.0,"comments":"Personal Liabilities Comments","additionalFields":{"Additional Field":"123.0000"}},"additionalFields":{"incomeAndExpensesFields":{"Income Statement Field":"123.0000"},"balanceSheetFields":{"Balance Sheet Field":"123.0000"},"otherFields":{"Other Field":"123.0000"},"additionalMetricsFields":{"Metric Field":"123.0000"},"realEstateFields":{"Income":"127.0000"}}}]} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ReadFinancialInformation", null ] } ] } }, "/v1/financial-information/personal-financials/{id}": { "get": { "tags": [ "Financial Information" ], "summary": "Gets a personal financial information by id", "operationId": "GetByIdPersonalFinancials", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "id of the personal financial information to get", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "Gets the personal financial information with the specified id", "schema": { "$ref": "#/definitions/FinancialInfoExtractPersonalFinancialInformation" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ReadFinancialInformation", null ] } ] } }, "/v1/financial-information/nonprofit-financials": { "get": { "tags": [ "Financial Information" ], "summary": "Gets all non profit financial information\r\n \r\nNote: Use of the CustomerId query parameter is required", "operationId": "GetPagedNonProfitFinancials", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "page", "description": "The page number of results to retrieve (first page = 1, default = 1)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "perPage", "description": "The number of records to return on each page (minimum = 1, maximum = 1000, default = 200)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "customerId", "description": "CustomerId value to filter by - REQUIRED", "type": "integer", "format": "int32" }, { "in": "query", "name": "periodEndDate", "description": "Period End Date to filter by", "type": "string", "format": "date-time" }, { "in": "query", "name": "dataSource", "description": "Data Source to filter by", "type": "string", "format": "string", "enum": [ "none", "annualized", "audit", "companyPrepared", "compilation", "financialStatement", "foreignCurrencyStatement", "merged", "other", "projection", "quickFinancials", "review", "sample", "taxReturn", "trailingTwelveMonths", "average", "payStub", "wTwo", "organizationPrepared", "selfReported" ] } ], "responses": { "200": { "description": "Gets all current, existing, and active non profit financial information in the account", "schema": { "$ref": "#/definitions/CollectionResponse[FinancialInfoExtractNonProfitFinancialInformation]" }, "examples": { "application/json": {"items":[{"id":2334,"periodEndDate":"2019-12-31","customerId":343433,"dataSource":"merged","breakoutOption":"DonorRestricted","statementOfActivities":{"accountingMethod":"AccrualMethod","dataSource":"none","periodDuration":12,"description":"Desc","personEnteringData":"Jim","accountingFirm":"Some Accounting Firm","programServiceRevenue":543.0,"contributions":3.0,"governmentGrants":4.0,"membershipDues":7.0,"investmentRevenue":6.0,"otherOperatingRevenue":8.0,"netAssetsReleasedFromRestrictions":9.0,"totalUnrestrictedRevenue":580.0,"programServiceExpenses":50.0,"programExpensesPayrollAndBenefits":11.0,"programExpensesDepreciationAndAmortization":12.0,"programExpensesInterestExpense":13.0,"fundraisingExpenses":51.0,"fundraisingExpensesPayrollAndBenefits":16.0,"fundraisingExpensesDepreciationAndAmortization":17.0,"fundraisingExpensesInterestExpense":18.0,"administrationExpenses":63.0,"administrationExpensesPayrollAndBenefits":20.0,"administrationExpensesDepreciationAndAmortization":21.0,"administrationExpensesInterestExpense":22.0,"otherOperatingExpenses":75.0,"otherOperatingExpensesPayrollAndBenefits":24.0,"otherOperatingExpensesDepreciationAndAmortization":25.0,"otherOperatingExpensesInterestExpense":26.0,"totalOperatingExpenses":239.0,"operatingYield":341.0,"otherInflows":27.0,"otherOutflows":28.0,"excessOfRevenues":340.0,"otherChangesInUnrestrictedNetAssets":29.0,"totalChangeInUnrestrictedNetAssets":369.0,"comments":"Test Comments","additionalFields":{"test field":"test1","another test field":"test2"}},"statementOfActivitiesTempRestricted":{"tempRestrictedProgramServiceRevenue":2332.0,"tempRestrictedContributions":543.0,"tempRestrictedGovernmentGrants":655.0,"tempRestrictedInvestmentRevenue":757.0,"tempRestrictedMembershipDues":755.0,"tempRestrictedOtherOperatingRevenue":383.0,"netAssetsReleased":343.0,"totalTempRestrictedRevenue":336.0,"otherTempRestrictedRevenue":479.0,"otherTempRestrictedExpenses":694.0,"otherChangesInTempRestrictedNetAssets":45.0,"totalChangeInTempRestrictedNetAssets":46.0,"comments":"sample comments","additionalFields":{}},"statementOfActivitiesPermRestricted":{"permRestrictedProgramServiceRevenue":2332.0,"permRestrictedContributions":543.0,"permRestrictedGovernmentGrants":655.0,"permRestrictedInvestmentRevenue":757.0,"permRestrictedMembershipDues":755.0,"permRestrictedOtherOperatingRevenue":383.0,"totalPermRestrictedRevenue":336.0,"otherPermRestrictedRevenue":479.0,"otherPermRestrictedExpenses":694.0,"otherChangesInPermRestrictedNetAssets":45.0,"totalChangeInPermRestrictedNetAssets":46.0,"comments":"sample comments","additionalFields":{}},"statementOfActivitiesDonorRestricted":{"donorRestrictedProgramServiceRevenue":2332.0,"donorRestrictedContributions":543.0,"donorRestrictedGovernmentGrants":655.0,"donorRestrictedInvestmentRevenue":757.0,"donorRestrictedMembershipDues":755.0,"donorRestrictedOtherOperatingRevenue":383.0,"totalDonorRestrictedRevenue":336.0,"netAssetsReleased":null,"otherDonorRestrictedRevenue":479.0,"otherDonorRestrictedExpenses":694.0,"otherChangesInDonorRestrictedNetAssets":45.0,"totalChangeInDonorRestrictedNetAssets":46.0,"comments":"sample comments","additionalFields":{}},"statementOfFinancialPosition":{"totalCashAndCashEquivalent":5.0,"unrestrictedCash":2.0,"restrictedCash":3.0,"totalReceivables":18.0,"contributionsReceivable":5.0,"accountsReceivable":6.0,"otherReceivables":7.0,"inventory":8.0,"currentInvestments":9.0,"otherCurrentAssets":10.0,"totalCurrentAssets":50.0,"grossFixedAssets":99.0,"accumulatedDepreciation":12.0,"netFixedAssets":87.0,"longTermInvestmentAssets":13.0,"otherAssets":14.0,"totalAssets":164.0,"payables":15.0,"shortTermDebt":16.0,"currentPortionOfLongTermDebt":17.0,"otherCurrentLiabilities":18.0,"totalCurrentLiabilities":66.0,"notesPayableSeniorDebt":20.0,"notesPayableSubordinatedDebt":21.0,"otherLongTermLiabilities":22.0,"totalLongTermLiabilities":63.0,"totalLiabilities":129.0,"totalNetAssets":35.0,"totalLiabilitiesAndNetAssets":164.0,"numberOfEmployees":24.0,"numberOfMembers":26.0,"numberOfDonors":25.0,"comments":"Some Comments","additionalFields":{"new field":"123","another new field":"456"}},"reconciliationOfNetAssets":{"unrestrictedBeginningNetAssets":3.0,"totalChangeInUnrestrictedNetAssets":369.0,"unrestrictedOtherAdjustmentsToNetAssets":6.0,"calculatedEndingUnrestrictedNetAssets":378.0,"actualEndingUnrestrictedNetAssets":35.0,"unexplainedDifferenceInUnrestrictedNetAssets":343.0,"additionalFields":{"another field ":"abc","another test field":"129"}},"nonprofitLoans":{"shortTermDebt":16.0,"currentPortionOfLongTermDebt":17.0,"notesPayableSeniorDebt":20.0,"notesPayableSubordinatedDebt":21.0,"totalDebtFromBalanceSheet":74.0,"totalBalanceOfAllCurrentLoans":454.0,"outstandingBalanceSheetDebt":-380.0,"itemizedAnnualDebtService":465.0,"otherAnnualDebtService":1.0,"portionOfOtherDebtServiceToBeRefinanced":99.0,"totalProposedDebtService":367.0,"additionalFields":{"Additional Field":"123.0000"}},"additionalFields":{"statementOfActivitiesFields":{"test abc":"454.54"},"statementOfActivitiesTempRestrictedFields":{"test def":"3534"},"statementOfActivitiesPermRestrictedFields":{"test 123":"485383","test 456":"45435"}}}]} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ReadFinancialInformation", null ] } ] } }, "/v1/financial-information/nonprofit-financials/{id}": { "get": { "tags": [ "Financial Information" ], "summary": "Gets a non profit financial information by id", "operationId": "GetByIdNonProfitFinancials", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "id of the non profit financial information to get", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "Gets the non profit financial information with the specified id", "schema": { "$ref": "#/definitions/FinancialInfoExtractNonProfitFinancialInformation" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ReadFinancialInformation", null ] } ] } }, "/v2/financial-information/business-financials": { "get": { "tags": [ "Financial Information" ], "summary": "Gets all business financial information\r\n \r\nNote: Use of the CustomerId query parameter is required", "operationId": "GetPagedBusinessFinancials", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "page", "description": "The page number of results to retrieve (first page = 1, default = 1)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "perPage", "description": "The number of records to return on each page (minimum = 1, maximum = 1000, default = 200)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "customerId", "description": "CustomerId value to filter by - REQUIRED", "type": "integer", "format": "int32" }, { "in": "query", "name": "periodEndDate", "description": "Period End Date to filter by", "type": "string", "format": "date-time" }, { "in": "query", "name": "dataSource", "description": "Data Source to filter by", "type": "string", "format": "string", "enum": [ "none", "annualized", "audit", "companyPrepared", "compilation", "financialStatement", "foreignCurrencyStatement", "merged", "other", "projection", "quickFinancials", "review", "sample", "taxReturn", "trailingTwelveMonths", "average", "payStub", "wTwo", "organizationPrepared", "selfReported" ] } ], "responses": { "200": { "description": "Gets all current, existing, and active business financial information in the account", "schema": { "$ref": "#/definitions/CollectionResponse[FinancialInfoExtractBusinessFinancialInformationV2]" }, "examples": { "application/json": {"items":[{"id":17813517,"periodEndDate":"2021-04-15","customerId":62747735,"dataSource":"compilation","incomeStatement":{"accountingMethod":"AccrualMethod","periodDuration":12,"personEnteringData":"Tom","accountingFirm":"Accounting Firm","description":"2020 data","salesIncome":33213.0,"costOfSales":3213.0,"depreciationCostOfSales":321.0,"grossProfit":30000.0,"depreciation":321.0,"amortization":321.0,"overheadOrSGAExpenses":6078.0,"gaPayrollExpense":412.0,"rent":5234.0,"advertising":432.0,"otherOperatingIncome":552.0,"otherOperatingExpenses":2342.0,"totalOperatingExpenses":9062.0,"operatingProfit":21490.0,"interestExpense":432.0,"otherIncome":3423.0,"otherExpenses":432.0,"unadjustedEBITDA":25444.0,"ebitdaAdjustments":445.0,"ebitda":25889.0,"netProfitBeforeTaxes":24049.0,"taxesPaid":643.0,"extraordinaryGain":63.0,"extraordinaryLoss":432.0,"netIncome":23046.0,"comments":"Income statement comments","additionalFields":{"Additional Field":"123.0000"}},"balanceSheet":{"cashBankFunds":20.0,"accountsReceivable":21.0,"inventory":22.0,"otherCurrentAssets":23.0,"totalCurrentAssets":86.0,"grossFixedAssets":24.0,"accumulatedDepreciation":25.0,"netFixedAssets":-1.0,"grossIntangibleAssets":26.0,"accumulatedAmortization":27.0,"netIntangibleAssets":-1.0,"otherAssets":28.0,"totalAssets":112.0,"accountsPayable":29.0,"shortTermDebt":30.0,"notesPayableCurrentPortionOfLongTermDebt":31.0,"otherCurrentLiabilities":32.0,"totalCurrentLiabilities":122.0,"notesPayableSeniorDebt":33.0,"notesPayableSubordinatedDebt":34.0,"otherLongTermLiabilities":35.0,"totalLongTermLiabilities":102.0,"totalLiabilities":224.0,"preferredStock":36.0,"commonStock":337.0,"additionalPaidInCapital":38.0,"otherStockEquity":39.0,"endingRetainedEarnings":40.0,"totalEquity":490.0,"totalLiabilitiesAndEquity":714.0,"totalAssetsMinusLiabilitiesAndEquity":-602.0,"tangibleNetWorth":491.0,"contingentLiabilities":41.0,"comments":"balance sheet comment","additionalFields":{"Additional Field":"123.0000"}},"statementOfEquity":{"specifyRealEstateInvestments":false,"specifyLoanInformation":false,"beginningRetainedEarnings":42.0,"netIncome":23046.0,"dividendsPaidWithdrawals":43.0,"otherChangesToRetainedEarnings":44.0,"calculatedEndingRetainedEarnings":-23.0,"actualEndingRetainedEarningsFromBalanceSheet":40.0,"differenceUnexplainedChangeInRetainedEarnings":63.0,"comments":"statement of equity comments","additionalFields":{"Additional Field":"123.0000"}},"realEstateInvestment":[{"propertyName":"Property Name","propertyType":"Existing","annualPotentialGrossRentalIncome":1.0,"annualPotentialCAMAndOtherIncome":2.0,"anticipatedVacancyRate":0.03,"annualGrossIncome":3.0,"postVacancyRateIncome":4.0,"effectiveGrossIncome":7.0,"insurance":5.0,"taxes":6.0,"propertyManagementFees":7.0,"advertisingAndMarketing":8.0,"maintenanceCareImprovements":9.0,"reserveForStructuralReplacements":0.0,"otherOperatingExpenses":10.0,"totalOperatingExpenses":45.0,"netOperatingIncome":-38.0,"capitalizationRate":0.11,"propertyValue":12.0,"percentOwnership":0.13,"adjustedNetOperatingIncome":-4.94,"adjustedPropertyValue":1.56,"nonCashExpensesDepreciation":14.0,"interestExpense":15.0,"comments":"Property comments","additionalFields":{"Additional Field":"123.0000"}}],"businessLoans":{"otherAnnualDebtService":50.0,"refinancedOtherDebtService":51.0,"shortTermDebt":30.0,"currentPortionOfLongTermDebt":31.0,"notesPayableSeniorDebt":33.0,"notesPayableSubordinatedDebt":34.0,"totalDebtFromBalanceSheet":128.0,"totalBalanceOfAllCurrentLoans":0.0,"outstandingBalanceSheetDebt":128.0,"itemizedAnnualDebtService":0.0,"additionalFields":{"Additional Field":"123.0000"}},"additionalFields":{"incomeStatementFields":{"Income Statement Field":"123.0000"},"balanceSheetFields":{"Balance Sheet Field":"123.0000"},"statementOfEquityFields":{"Statement of Equity Field":"123.0000"},"otherFields":{"Other Field":"123.0000"},"additionalMetricsFields":{"Metric Field":"123.0000"},"realEstateFields":{}}},{"id":17813518,"periodEndDate":"2021-04-15","customerId":62747735,"dataSource":"compilation","incomeStatement":{"accountingMethod":"AccrualMethod","periodDuration":12,"personEnteringData":"Tom","accountingFirm":"Accounting Firm","description":"2020 data","salesIncome":33213.0,"costOfSales":3213.0,"depreciationCostOfSales":321.0,"grossProfit":30000.0,"depreciation":321.0,"amortization":321.0,"overheadOrSGAExpenses":6078.0,"gaPayrollExpense":412.0,"rent":5234.0,"advertising":432.0,"otherOperatingIncome":552.0,"otherOperatingExpenses":2342.0,"totalOperatingExpenses":9062.0,"operatingProfit":21490.0,"interestExpense":432.0,"otherIncome":3423.0,"otherExpenses":432.0,"unadjustedEBITDA":25444.0,"ebitdaAdjustments":445.0,"ebitda":25889.0,"netProfitBeforeTaxes":24049.0,"taxesPaid":643.0,"extraordinaryGain":63.0,"extraordinaryLoss":432.0,"netIncome":23046.0,"comments":"Income statement comments","additionalFields":{}},"balanceSheet":{"cashBankFunds":20.0,"accountsReceivable":21.0,"inventory":22.0,"otherCurrentAssets":23.0,"totalCurrentAssets":86.0,"grossFixedAssets":24.0,"accumulatedDepreciation":25.0,"netFixedAssets":-1.0,"grossIntangibleAssets":26.0,"accumulatedAmortization":27.0,"netIntangibleAssets":-1.0,"otherAssets":28.0,"totalAssets":112.0,"accountsPayable":29.0,"shortTermDebt":30.0,"notesPayableCurrentPortionOfLongTermDebt":31.0,"otherCurrentLiabilities":32.0,"totalCurrentLiabilities":122.0,"notesPayableSeniorDebt":33.0,"notesPayableSubordinatedDebt":34.0,"otherLongTermLiabilities":35.0,"totalLongTermLiabilities":102.0,"totalLiabilities":224.0,"preferredStock":36.0,"commonStock":337.0,"additionalPaidInCapital":38.0,"otherStockEquity":39.0,"endingRetainedEarnings":40.0,"totalEquity":490.0,"totalLiabilitiesAndEquity":714.0,"totalAssetsMinusLiabilitiesAndEquity":-602.0,"tangibleNetWorth":491.0,"contingentLiabilities":41.0,"comments":"balance sheet comment","additionalFields":{}},"statementOfEquity":{"specifyRealEstateInvestments":false,"specifyLoanInformation":false,"beginningRetainedEarnings":42.0,"netIncome":23046.0,"dividendsPaidWithdrawals":43.0,"otherChangesToRetainedEarnings":44.0,"calculatedEndingRetainedEarnings":-23.0,"actualEndingRetainedEarningsFromBalanceSheet":40.0,"differenceUnexplainedChangeInRetainedEarnings":63.0,"comments":"statement of equity comments","additionalFields":{}},"realEstateInvestment":[{"propertyName":"Property Name","propertyType":"Proposed","annualPotentialGrossRentalIncome":1.0,"annualPotentialCAMAndOtherIncome":2.0,"anticipatedVacancyRate":0.03,"annualGrossIncome":3.0,"postVacancyRateIncome":4.0,"effectiveGrossIncome":7.0,"insurance":5.0,"taxes":6.0,"propertyManagementFees":7.0,"advertisingAndMarketing":8.0,"maintenanceCareImprovements":9.0,"reserveForStructuralReplacements":0.0,"otherOperatingExpenses":10.0,"totalOperatingExpenses":45.0,"netOperatingIncome":-38.0,"capitalizationRate":0.11,"propertyValue":12.0,"percentOwnership":0.13,"adjustedNetOperatingIncome":-4.94,"adjustedPropertyValue":1.56,"nonCashExpensesDepreciation":14.0,"interestExpense":15.0,"comments":"Property comments","additionalFields":{}}],"businessLoans":{"otherAnnualDebtService":53.0,"refinancedOtherDebtService":52.0,"shortTermDebt":0.0,"currentPortionOfLongTermDebt":0.0,"notesPayableSeniorDebt":0.0,"notesPayableSubordinatedDebt":0.0,"totalDebtFromBalanceSheet":0.0,"totalBalanceOfAllCurrentLoans":0.0,"outstandingBalanceSheetDebt":0.0,"itemizedAnnualDebtService":0.0,"additionalFields":{"Additional Field":"123.0000"}},"additionalFields":{"incomeStatementFields":{"Income Statement Field":"123.0000"},"balanceSheetFields":{"Balance Sheet Field":"123.0000"},"statementOfEquityFields":{"Statement of Equity Field":"123.0000"},"otherFields":{"Other Field":"123.0000"},"additionalMetricsFields":{"Metric Field":"123.0000"},"realEstateFields":{"Income":"123.0000"}}}]} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ReadFinancialInformation", null ] } ] } }, "/v2/financial-information/business-financials/{id}": { "get": { "tags": [ "Financial Information" ], "summary": "Gets a business financial information by id", "operationId": "GetByIdBusinessFinancials", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "id of the business financial information to get", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "Gets the business financial information with the specified id", "schema": { "$ref": "#/definitions/FinancialInfoExtractBusinessFinancialInformationV2" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ReadFinancialInformation", null ] } ] } }, "/v2/financial-information/personal-financials": { "get": { "tags": [ "Financial Information" ], "summary": "Gets all personal financial information\r\n \r\nNote: Use of the CustomerId query parameter is required", "operationId": "GetPagedPersonalFinancials", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "page", "description": "The page number of results to retrieve (first page = 1, default = 1)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "perPage", "description": "The number of records to return on each page (minimum = 1, maximum = 1000, default = 200)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "customerId", "description": "CustomerId value to filter by - REQUIRED", "type": "integer", "format": "int32" }, { "in": "query", "name": "periodEndDate", "description": "Period End Date to filter by", "type": "string", "format": "date-time" }, { "in": "query", "name": "dataSource", "description": "Data Source to filter by", "type": "string", "format": "string", "enum": [ "none", "annualized", "audit", "companyPrepared", "compilation", "financialStatement", "foreignCurrencyStatement", "merged", "other", "projection", "quickFinancials", "review", "sample", "taxReturn", "trailingTwelveMonths", "average", "payStub", "wTwo", "organizationPrepared", "selfReported" ] } ], "responses": { "200": { "description": "Gets all current, existing, and active personal financial information in the account", "schema": { "$ref": "#/definitions/CollectionResponse[FinancialInfoExtractPersonalFinancialInformationV2]" }, "examples": { "application/json": {"items":[{"id":4682896,"periodEndDate":"2021-01-01","customerId":81198153,"dataSource":"none","incomeAndExpenses":{"personEnteringData":"Worker","accountingFirm":"Acct Firm","sourceOfIncome":"payStub","taxReturnDate":null,"description":"Description","yearlyGrossWagesSalaries":32131.0,"otherRegularAndDependableSourcesOfIncome":231.0,"cashFlowFromRealEstateInvestmentsBeforeDebtService":33421.0,"cashFlowFromBusinessInvestmentsBeforeDebtService":5532.0,"personalIncomeAdjustments":231.0,"totalPersonalIncome":321.0,"yearlyRentPayments":552.0,"taxesPaidOptional":634.0,"personalExpenses":23.0,"netPersonalIncomeBeforeDebtService":123.0,"investmentRealEstateProperty":false,"stockInAPrivatelyHeldBusiness":true,"comments":"Income comments","additionalFields":{"Additional Field":"123.0000"}},"realEstateInvestments":[{"propertyName":"Property Name","propertyType":"Existing","annualPotentialGrossRentalIncome":1.0,"annualPotentialCAMAndOtherIncome":2.0,"anticipatedVacancyRate":0.03,"annualGrossIncome":3.0,"postVacancyRateIncome":4.0,"effectiveGrossIncome":7.0,"insurance":5.0,"taxes":6.0,"propertyManagementFees":7.0,"advertisingAndMarketing":8.0,"maintenanceCareImprovements":9.0,"reserveForStructuralReplacements":0.0,"otherOperatingExpenses":10.0,"totalOperatingExpenses":45.0,"netOperatingIncome":-38.0,"capitalizationRate":0.11,"propertyValue":12.0,"percentOwnership":0.13,"adjustedNetOperatingIncome":-4.94,"adjustedPropertyValue":1.56,"nonCashExpensesDepreciation":14.0,"interestExpense":15.0,"comments":"Property comments","additionalFields":{"Additional Field":"123.0000"}}],"businessInvestments":[{"customerId":55324234,"estimatedValueOfOwnership":32124.22,"cashFlow":55324.0,"percentOwnership":0.55,"comments":"Business Investment Comment"}],"recurringDebt":{"otherAnnualDebtService":432.43,"portionOfOtherDebtServiceToBeRefinanced":77435.85,"additionalFields":{"Additional Field":"123.0000"}},"personalAssets":{"cashCheckingSavingsMoneyMarket":5342.0,"publicCompanyStocksBonds":64534.0,"mutualFundsOrPooledSecurities":4325.0,"otherLiquidOrSemiLiquidAssetsOnHand":99382.0,"totalLiquidAndSemiLiquidAssetsOnHand":4738.0,"closelyHeldCompanyStock":9832.0,"cashValueOfLifeInsurance":7932.0,"retirementAccounts":4247.0,"automobiles":3523.43,"jewelry":1300.0,"furnitureFixtures":5432.0,"otherPersonalAssets":313.0,"valueOfPersonalResidence":55324.0,"valueOfOtherNonInvestmentProperties":1861.0,"valueOfItemizedRealEstateInvestments":3516.0,"valueOfOtherRealEstateInvestments":4984.0,"totalValueOfRealEstateInvestments":468.0,"totalValueOfBusinessAndInvestmentHoldings":991.0,"totalAssets":345311.0,"comments":"Personal Asset comments","additionalFields":{"Additional Field":"123.0000"}},"personalLiabilities":{"balanceOfAllCreditCards":55342.0,"taxesOwed":1651.0,"otherLinesOfCredit":5499.0,"otherShortTermLoansLiabilities":302.0,"totalCurrentLiabilities":55.61,"automobileLoans":65649.0,"firstMortgageOnPrimaryResidence":1351.0,"secondMortgageOnPrimaryResidence":335.0,"homeEquityBalanceOnPrimaryResidence":4465.0,"studentLoans":6449.0,"loansOnOtherNonInvestmentProperties":315.0,"otherInstallmentLoans":213.0,"otherLongTermLoansLiabilities":2315.0,"loansOnRealEstateInvestments":631.65,"loansOnBusinessAndInvestmentHoldings":66445.0,"totalLiabilities":131.0,"personalNetWorth":389.0,"contingentLiabilities":975.0,"comments":"Personal Liabilities Comments","additionalFields":{"Additional Field":"123.0000"}},"additionalFields":{"incomeAndExpensesFields":{"Income Statement Field":"123.0000"},"balanceSheetFields":{"Balance Sheet Field":"123.0000"},"otherFields":{"Other Field":"123.0000"},"additionalMetricsFields":{"Metric Field":"123.0000"},"realEstateFields":{"Income":"127.0000"}}}]} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ReadFinancialInformation", null ] } ] } }, "/v2/financial-information/personal-financials/{id}": { "get": { "tags": [ "Financial Information" ], "summary": "Gets a personal financial information by id", "operationId": "GetByIdPersonalFinancials", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "id of the personal financial information to get", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "Gets the personal financial information with the specified id", "schema": { "$ref": "#/definitions/FinancialInfoExtractPersonalFinancialInformationV2" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ReadFinancialInformation", null ] } ] } }, "/v2/financial-information/nonprofit-financials": { "get": { "tags": [ "Financial Information" ], "summary": "Gets all non profit financial information\r\n \r\nNote: Use of the CustomerId query parameter is required", "operationId": "GetPagedNonProfitFinancials", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "page", "description": "The page number of results to retrieve (first page = 1, default = 1)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "perPage", "description": "The number of records to return on each page (minimum = 1, maximum = 1000, default = 200)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "customerId", "description": "CustomerId value to filter by - REQUIRED", "type": "integer", "format": "int32" }, { "in": "query", "name": "periodEndDate", "description": "Period End Date to filter by", "type": "string", "format": "date-time" }, { "in": "query", "name": "dataSource", "description": "Data Source to filter by", "type": "string", "format": "string", "enum": [ "none", "annualized", "audit", "companyPrepared", "compilation", "financialStatement", "foreignCurrencyStatement", "merged", "other", "projection", "quickFinancials", "review", "sample", "taxReturn", "trailingTwelveMonths", "average", "payStub", "wTwo", "organizationPrepared", "selfReported" ] } ], "responses": { "200": { "description": "Gets all current, existing, and active non profit financial information in the account", "schema": { "$ref": "#/definitions/CollectionResponse[FinancialInfoExtractNonProfitFinancialInformationV2]" }, "examples": { "application/json": {"items":[{"id":2334,"periodEndDate":"2019-12-31","customerId":343433,"dataSource":"merged","breakoutOption":"DonorRestricted","statementOfActivities":{"accountingMethod":"AccrualMethod","dataSource":"none","periodDuration":12,"description":"Desc","personEnteringData":"Jim","accountingFirm":"Some Accounting Firm","programServiceRevenue":543.0,"contributions":3.0,"governmentGrants":4.0,"membershipDues":7.0,"investmentRevenue":6.0,"otherOperatingRevenue":8.0,"netAssetsReleasedFromRestrictions":9.0,"totalUnrestrictedRevenue":580.0,"programServiceExpenses":50.0,"programExpensesPayrollAndBenefits":11.0,"programExpensesDepreciationAndAmortization":12.0,"programExpensesInterestExpense":13.0,"fundraisingExpenses":51.0,"fundraisingExpensesPayrollAndBenefits":16.0,"fundraisingExpensesDepreciationAndAmortization":17.0,"fundraisingExpensesInterestExpense":18.0,"administrationExpenses":63.0,"administrationExpensesPayrollAndBenefits":20.0,"administrationExpensesDepreciationAndAmortization":21.0,"administrationExpensesInterestExpense":22.0,"otherOperatingExpenses":75.0,"otherOperatingExpensesPayrollAndBenefits":24.0,"otherOperatingExpensesDepreciationAndAmortization":25.0,"otherOperatingExpensesInterestExpense":26.0,"totalOperatingExpenses":239.0,"operatingYield":341.0,"otherInflows":27.0,"otherOutflows":28.0,"excessOfRevenues":340.0,"otherChangesInUnrestrictedNetAssets":29.0,"totalChangeInUnrestrictedNetAssets":369.0,"comments":"Test Comments","additionalFields":{"test field":"test1","another test field":"test2"}},"statementOfActivitiesTempRestricted":{"tempRestrictedProgramServiceRevenue":2332.0,"tempRestrictedContributions":543.0,"tempRestrictedGovernmentGrants":655.0,"tempRestrictedInvestmentRevenue":757.0,"tempRestrictedMembershipDues":755.0,"tempRestrictedOtherOperatingRevenue":383.0,"netAssetsReleased":343.0,"totalTempRestrictedRevenue":336.0,"otherTempRestrictedRevenue":479.0,"otherTempRestrictedExpenses":694.0,"otherChangesInTempRestrictedNetAssets":45.0,"totalChangeInTempRestrictedNetAssets":46.0,"comments":"sample comments","additionalFields":{}},"statementOfActivitiesPermRestricted":{"permRestrictedProgramServiceRevenue":2332.0,"permRestrictedContributions":543.0,"permRestrictedGovernmentGrants":655.0,"permRestrictedInvestmentRevenue":757.0,"permRestrictedMembershipDues":755.0,"permRestrictedOtherOperatingRevenue":383.0,"totalPermRestrictedRevenue":336.0,"otherPermRestrictedRevenue":479.0,"otherPermRestrictedExpenses":694.0,"otherChangesInPermRestrictedNetAssets":45.0,"totalChangeInPermRestrictedNetAssets":46.0,"comments":"sample comments","additionalFields":{}},"statementOfActivitiesDonorRestricted":{"donorRestrictedProgramServiceRevenue":2332.0,"donorRestrictedContributions":543.0,"donorRestrictedGovernmentGrants":655.0,"donorRestrictedInvestmentRevenue":757.0,"donorRestrictedMembershipDues":755.0,"donorRestrictedOtherOperatingRevenue":383.0,"totalDonorRestrictedRevenue":336.0,"netAssetsReleased":null,"otherDonorRestrictedRevenue":479.0,"otherDonorRestrictedExpenses":694.0,"otherChangesInDonorRestrictedNetAssets":45.0,"totalChangeInDonorRestrictedNetAssets":46.0,"comments":"sample comments","additionalFields":{}},"statementOfFinancialPosition":{"totalCashAndCashEquivalent":5.0,"unrestrictedCash":2.0,"restrictedCash":3.0,"totalReceivables":18.0,"contributionsReceivable":5.0,"accountsReceivable":6.0,"otherReceivables":7.0,"inventory":8.0,"currentInvestments":9.0,"otherCurrentAssets":10.0,"totalCurrentAssets":50.0,"grossFixedAssets":99.0,"accumulatedDepreciation":12.0,"netFixedAssets":87.0,"longTermInvestmentAssets":13.0,"otherAssets":14.0,"totalAssets":164.0,"payables":15.0,"shortTermDebt":16.0,"currentPortionOfLongTermDebt":17.0,"otherCurrentLiabilities":18.0,"totalCurrentLiabilities":66.0,"notesPayableSeniorDebt":20.0,"notesPayableSubordinatedDebt":21.0,"otherLongTermLiabilities":22.0,"totalLongTermLiabilities":63.0,"totalLiabilities":129.0,"totalNetAssets":35.0,"totalLiabilitiesAndNetAssets":164.0,"numberOfEmployees":24.0,"numberOfMembers":26.0,"numberOfDonors":25.0,"comments":"Some Comments","additionalFields":{"new field":"123","another new field":"456"}},"reconciliationOfNetAssets":{"unrestrictedBeginningNetAssets":3.0,"totalChangeInUnrestrictedNetAssets":369.0,"unrestrictedOtherAdjustmentsToNetAssets":6.0,"calculatedEndingUnrestrictedNetAssets":378.0,"actualEndingUnrestrictedNetAssets":35.0,"unexplainedDifferenceInUnrestrictedNetAssets":343.0,"additionalFields":{"another field ":"abc","another test field":"129"}},"nonprofitLoans":{"shortTermDebt":16.0,"currentPortionOfLongTermDebt":17.0,"notesPayableSeniorDebt":20.0,"notesPayableSubordinatedDebt":21.0,"totalDebtFromBalanceSheet":74.0,"totalBalanceOfAllCurrentLoans":454.0,"outstandingBalanceSheetDebt":-380.0,"itemizedAnnualDebtService":465.0,"otherAnnualDebtService":1.0,"portionOfOtherDebtServiceToBeRefinanced":99.0,"totalProposedDebtService":367.0,"additionalFields":{"Additional Field":"123.0000"}},"additionalFields":{"statementOfActivitiesFields":{"test abc":"454.54"},"statementOfActivitiesTempRestrictedFields":{"test def":"3534"},"statementOfActivitiesPermRestrictedFields":{"test 123":"485383","test 456":"45435"}}}]} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ReadFinancialInformation", null ] } ] } }, "/v2/financial-information/nonprofit-financials/{id}": { "get": { "tags": [ "Financial Information" ], "summary": "Gets a non profit financial information by id", "operationId": "GetByIdNonProfitFinancials", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "id of the non profit financial information to get", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "Gets the non profit financial information with the specified id", "schema": { "$ref": "#/definitions/FinancialInfoExtractNonProfitFinancialInformationV2" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ReadFinancialInformation", null ] } ] } }, "/v1/loan-application-loan-personal-input-data-mapping": { "post": { "tags": [ "Loan Application Loan Personal Input Data Mapping" ], "summary": "Creates a LoanApplicationPersonalInputData mapping", "operationId": "Create", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "The mapping to create", "schema": { "$ref": "#/definitions/LoanApplicationPersonalInputData" } } ], "responses": { "201": { "description": "The mapping has been created successfully. The mapping that was created\r\n is returned and has the Sageworks id that was assigned.", "schema": { "$ref": "#/definitions/LoanApplicationPersonalInputData" }, "examples": { "application/json": {"id":12345,"loanApplicationProposedLoanMappingId":56575,"personalInputDataId":23242} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] }, "get": { "tags": [ "Loan Application Loan Personal Input Data Mapping" ], "summary": "Gets all loan application personal input data mappings", "operationId": "GetPaged", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "page", "description": "The page number of results to retrieve (first page = 1, default = 1)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "perPage", "description": "The number of records to return on each page (minimum = 1, maximum = 1000, default = 200)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "loanApplicationProposedLoanMappingId", "description": "LoanApplicationProposedLoanMappingId value to filter by", "type": "integer", "format": "int32", "x-nullable": true } ], "responses": { "200": { "description": "Gets all current, existing, and active loan application personal input data mappings in the account", "schema": { "$ref": "#/definitions/CollectionResponse[LoanApplicationPersonalInputData]" }, "examples": { "application/json": {"id":12345,"loanApplicationProposedLoanMappingId":56575,"personalInputDataId":23242} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] } }, "/v1/loan-application-loan-personal-input-data-mapping/bulk": { "patch": { "tags": [ "Loan Application Loan Personal Input Data Mapping" ], "summary": "Updates a collection of loan application personal input data mappings", "operationId": "UpdateMany", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "The collection of loan application personal input data mappings to update", "schema": { "$ref": "#/definitions/BulkUpdateRequest[LoanApplicationPersonalInputData]" } } ], "responses": { "200": { "description": "All loan application personal input data mappings were processed. Please check the errors property of the response object\r\n to determine if there were errors updating any individual loan application personal input data mapping", "schema": { "$ref": "#/definitions/BulkUpdateRequest[LoanApplicationPersonalInputData]" }, "examples": { "application/json": {"itemsUpdated":[{"id":65354,"loanApplicationProposedLoanMappingId":273945,"personalInputDataId":45453},{"id":75675,"loanApplicationProposedLoanMappingId":453434,"personalInputDataId":774768},{"id":2422,"loanApplicationProposedLoanMappingId":65645,"personalInputDataId":34920}],"errors":null} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] }, "post": { "tags": [ "Loan Application Loan Personal Input Data Mapping" ], "summary": "Creates a collection of loan application personal input data mappings", "operationId": "CreateMany", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "The collection of loan application personal input data mappings to create", "schema": { "$ref": "#/definitions/BulkCreateRequest[LoanApplicationPersonalInputData]" } } ], "responses": { "200": { "description": "All loan application personal input data mappings were processed. Please check the errors property of the response object\r\n to determine if there were errors creating any individual loan application personal input data mappings", "schema": { "$ref": "#/definitions/BulkCreateResponse[LoanApplicationPersonalInputData]" }, "examples": { "application/json": {"itemsUpdated":[{"id":65354,"loanApplicationProposedLoanMappingId":273945,"personalInputDataId":45453},{"id":75675,"loanApplicationProposedLoanMappingId":453434,"personalInputDataId":774768},{"id":2422,"loanApplicationProposedLoanMappingId":65645,"personalInputDataId":34920}],"errors":null} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] } }, "/v1/loan-application-loan-personal-input-data-mapping/{id}": { "get": { "tags": [ "Loan Application Loan Personal Input Data Mapping" ], "summary": "Gets a loan application personal input data mapping by id", "operationId": "GetById", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "id of the existing loan application personal input data mapping to get", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "Gets the loan application personal input data mappings with the specified id", "schema": { "$ref": "#/definitions/LoanApplicationPersonalInputData" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] }, "patch": { "tags": [ "Loan Application Loan Personal Input Data Mapping" ], "summary": "Updates a loan application personal input data mapping", "operationId": "Update", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "id of the existing loan application personal input data mapping to update", "required": true, "type": "integer", "format": "int32" }, { "in": "body", "name": "body", "description": "The loan application personal input data mapping values to update", "schema": { "$ref": "#/definitions/LoanApplicationPersonalInputData" } } ], "responses": { "200": { "description": "Returns the modified loan application personal input data mapping", "schema": { "$ref": "#/definitions/LoanApplicationPersonalInputData" }, "examples": { "application/json": {"id":12345,"loanApplicationProposedLoanMappingId":56575,"personalInputDataId":23242} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] }, "delete": { "tags": [ "Loan Application Loan Personal Input Data Mapping" ], "summary": "Deletes a loan application personal input data mapping by id", "operationId": "Delete", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "id of the existing loan application personal input data mapping to delete", "required": true, "type": "integer", "format": "int32" } ], "responses": { "204": { "description": "The loan application personal input data mapping has been deleted successfully." }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] } }, "/v1/events/{id}/complete": { "patch": { "tags": [ "Events" ], "operationId": "Complete", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/Event" }, "examples": { "application/json": {"id":125464545,"eventTime":"2021-08-01T09:21:03-04:00","eventType":"loanBoardedEvent","eventContent":{"ProposedLoanId":"654321"},"isComplete":false} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "Events", null ] } ] } }, "/v1/events": { "get": { "tags": [ "Events" ], "summary": "Gets all events", "operationId": "GetPaged", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "page", "description": "The page number of results to retrieve (first page = 1, default = 1)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "perPage", "description": "The number of records to return on each page (minimum = 1, maximum = 1000, default = 200)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "fromEventTime", "description": "Beginning time range of events", "type": "string", "format": "date-time", "x-nullable": true }, { "in": "query", "name": "toEventTime", "description": "Ending time range of events", "type": "string", "format": "date-time", "x-nullable": true }, { "in": "query", "name": "eventType", "description": "The type of the event", "type": "string", "enum": [ "loanBoardedEvent", "documentAssociationSavedEvent", "documentChangedEvent", "documentDeletedEvent", "documentUploadedEvent", "appraisalStatusChangedEvent", "loanStageChangedEvent", "loanStatusChangedEvent", "builtConstructionEvent", "collateralWidgetEvent", "coreIntegrationCompletedEvent", "customerWidgetEvent", "laserProDocumentsReturnedEvent", "dynamicApplicationSubmittedEvent", "thoughtspotPermissionsEvent", "genericWidgetEvent" ], "x-nullable": true } ], "responses": { "200": { "description": "Gets all events", "schema": { "$ref": "#/definitions/CollectionResponse[Event]" }, "examples": { "application/json": {"items":[{"id":125464545,"eventTime":"2021-08-01T09:21:03-04:00","eventType":"loanBoardedEvent","eventContent":{"ProposedLoanId":"654321"},"isComplete":false},{"id":125464546,"eventTime":"2021-08-03T10:01:33-04:00","eventType":"loanBoardedEvent","eventContent":{"ProposedLoanId":"654321"},"isComplete":false}]} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "Events", null ] } ] } }, "/v1/events/{id}": { "get": { "tags": [ "Events" ], "summary": "Gets an event by id", "operationId": "GetById", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "id of the existing event to get", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "Gets the event with the specified id", "schema": { "$ref": "#/definitions/Event" }, "examples": { "application/json": {"id":125464545,"eventTime":"2021-08-01T09:21:03-04:00","eventType":"loanBoardedEvent","eventContent":{"ProposedLoanId":"654321"},"isComplete":false} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "Events", null ] } ] } }, "/v1/entities": { "get": { "tags": [ "Entities" ], "summary": "Gets all entities", "operationId": "GetPaged", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "page", "description": "The page number of results to retrieve (first page = 1, default = 1)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "perPage", "description": "The number of records to return on each page (minimum = 1, maximum = 1000, default = 200)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "uniqueIdentifier", "description": "Unique identifier to filter by", "type": "string" }, { "in": "query", "name": "name", "description": "Name to filter by", "type": "string" } ], "responses": { "200": { "description": "Gets all current, existing, and active entities in the account", "schema": { "$ref": "#/definitions/CollectionResponse[Entity]" }, "examples": { "application/json": {"items":[{"id":7456123,"name":"Example, LLC","type":"business","uniqueIdentifier":"785654","isDeleted":false},{"id":4213102,"name":"Smith, John","type":"person","uniqueIdentifier":"746313","isDeleted":false},{"id":45123997,"name":"Example Farm","type":"farm","uniqueIdentifier":"798845","isDeleted":false},{"id":63169788,"name":"Example Group","type":"group","uniqueIdentifier":"889763","isDeleted":false}]} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "ReadEntities" ] } ] } }, "/v1/entities/{id}": { "get": { "tags": [ "Entities" ], "summary": "Gets an entity by id", "operationId": "GetById", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "id of the entity to get", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "Gets the entity with the specified id", "schema": { "$ref": "#/definitions/Entity" }, "examples": { "application/json": {"id":7456123,"name":"Example, LLC","type":"business","uniqueIdentifier":"785654","isDeleted":false} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "ReadEntities" ] } ] } }, "/v1/entities/{id}/spouse-details": { "get": { "tags": [ "Entities" ], "summary": "Gets spouse details for a person entity", "operationId": "GetSpouseDetails", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "id of the person entity", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "Gets the spouse details for the specified person", "schema": { "$ref": "#/definitions/SpouseDetails" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "ReadEntities" ] } ] } }, "/v1/entity-groups": { "post": { "tags": [ "Entity Groups" ], "summary": "Creates an entity group", "operationId": "CreateEntityGroup", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "The entity group to create", "schema": { "$ref": "#/definitions/CreateEntityGroupRequest" } } ], "responses": { "201": { "description": "The entity group has been created successfully. The group that was created\r\n is returned and has the Sageworks id that was assigned, inside the items list of group summaries.", "schema": { "$ref": "#/definitions/CollectionResponse[EntityGroupSummary]" }, "examples": { "application/json": {"items":[{"groupId":5532423,"name":"Example, LLC (Group)","uniqueIdentifier":"5785637","isDeleted":false,"groupMembers":[{"id":4213102,"name":"Smith, John","type":"person","uniqueIdentifier":"746313","isDeleted":false},{"id":45123997,"name":"Example Farm","type":"farm","uniqueIdentifier":"798845","isDeleted":false}]},{"groupId":4312341,"name":"Smith Inc (Group)","uniqueIdentifier":"785654","isDeleted":false,"groupMembers":[{"id":4213102,"name":"Smith, John","type":"person","uniqueIdentifier":"746313","isDeleted":false},{"id":4213104,"name":"Smith, Jane","type":"person","uniqueIdentifier":"7463164","isDeleted":false},{"id":7456123,"name":"Smith Inc","type":"business","uniqueIdentifier":"785654","isDeleted":false}]}]} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] } }, "/v1/entity-groups/group-name-unique": { "get": { "tags": [ "Entity Groups" ], "summary": "Check to see if a group name is unique", "operationId": "GetGroupNameUnique", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "groupName", "description": "The group name to check for uniqueness", "type": "string" }, { "in": "query", "name": "excludeGroupId", "description": "An existing group to be excluded from uniqueness check", "type": "integer", "format": "int32", "x-nullable": true } ], "responses": { "201": { "description": "Created", "schema": { "type": "boolean" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] } }, "/v1/entity-groups/{id}/update-group-name": { "patch": { "tags": [ "Entity Groups" ], "summary": "Update group name for existing group", "operationId": "UpdateGroupName", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "groupName", "description": "", "type": "string" }, { "in": "path", "name": "id", "description": "", "required": true, "type": "integer", "format": "int64" } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] } }, "/v1/entity-groups/{id}/add-members": { "patch": { "tags": [ "Entity Groups" ], "summary": "Add members (businesses or people) to an entity group in bulk.", "operationId": "AddMembersToEntityGroup", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "The Euid of the entity group to which members will be added.", "required": true, "type": "integer", "format": "int64" }, { "in": "body", "name": "body", "description": "A list of Euid (businesses or people) to add to the group.", "schema": { "type": "array", "items": { "format": "int64", "type": "integer" } } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/CollectionResponse[EntityGroupSummary]" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] } }, "/v1/entity-groups/{id}/remove-members": { "patch": { "tags": [ "Entity Groups" ], "summary": "Removes members (businesses or people) from an entity group in bulk.", "operationId": "RemoveMembersFromEntityGroup", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "The ID of the entity group from which members will be removed.", "required": true, "type": "integer", "format": "int64" }, { "in": "body", "name": "body", "description": "A list of entity IDs (businesses or people) to remove from the group.", "schema": { "type": "array", "items": { "format": "int64", "type": "integer" } } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/CollectionResponse[EntityGroupSummary]" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] } }, "/v1/entity-groups/all-groups-with-members-by-entityid": { "get": { "tags": [ "Entity Groups" ], "summary": "Get group and member details by profit entity id", "operationId": "GetAllGroupsContaining", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "profitEntityId", "description": "The profit entity ID", "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "Successfully retrieved all group details and member list", "schema": { "type": "array", "items": { "$ref": "#/definitions/EntityGroupDetail" } } }, "404": { "description": "Entity not found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] } }, "/v1/entity-group-summary/{entityId}": { "get": { "tags": [ "Entities" ], "summary": "Returns the entity group with the members of the group if the given ID is a group. Returns all entity groups containing the entity with the given ID if the ID is not a group.", "operationId": "GetEntityGroupsSummary", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "entityId", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "Returns the entity group summary or an empty list if the given id does not exist or is not part of a group", "schema": { "$ref": "#/definitions/CollectionResponse[EntityGroupSummary]" }, "examples": { "application/json": {"items":[{"groupId":5532423,"name":"Example, LLC (Group)","uniqueIdentifier":"5785637","isDeleted":false,"groupMembers":[{"id":4213102,"name":"Smith, John","type":"person","uniqueIdentifier":"746313","isDeleted":false},{"id":45123997,"name":"Example Farm","type":"farm","uniqueIdentifier":"798845","isDeleted":false}]},{"groupId":4312341,"name":"Smith Inc (Group)","uniqueIdentifier":"785654","isDeleted":false,"groupMembers":[{"id":4213102,"name":"Smith, John","type":"person","uniqueIdentifier":"746313","isDeleted":false},{"id":4213104,"name":"Smith, Jane","type":"person","uniqueIdentifier":"7463164","isDeleted":false},{"id":7456123,"name":"Smith Inc","type":"business","uniqueIdentifier":"785654","isDeleted":false}]}]} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "ReadEntities" ] } ] } }, "/v1/entity-group-summary": { "get": { "tags": [ "Entities" ], "operationId": "GetAllEntityGroups", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "page", "description": "The page number of results to retrieve (first page = 1, default = 1)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "perPage", "description": "The number of records to return on each page (minimum = 1, maximum = 1000, default = 200)", "type": "integer", "format": "int32", "x-nullable": true } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/CollectionResponse[EntityGroupSummary]" }, "examples": { "application/json": {"items":[{"groupId":5532423,"name":"Example, LLC (Group)","uniqueIdentifier":"5785637","isDeleted":false,"groupMembers":[{"id":4213102,"name":"Smith, John","type":"person","uniqueIdentifier":"746313","isDeleted":false},{"id":45123997,"name":"Example Farm","type":"farm","uniqueIdentifier":"798845","isDeleted":false}]},{"groupId":4312341,"name":"Smith Inc (Group)","uniqueIdentifier":"785654","isDeleted":false,"groupMembers":[{"id":4213102,"name":"Smith, John","type":"person","uniqueIdentifier":"746313","isDeleted":false},{"id":4213104,"name":"Smith, Jane","type":"person","uniqueIdentifier":"7463164","isDeleted":false},{"id":7456123,"name":"Smith Inc","type":"business","uniqueIdentifier":"785654","isDeleted":false}]}]} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "ReadEntities" ] } ] } }, "/v1/deposits": { "post": { "tags": [ "Deposits" ], "summary": "Creates a deposit", "operationId": "Create", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "The deposit to create", "schema": { "$ref": "#/definitions/Deposit" } } ], "responses": { "201": { "description": "The deposit has been created successfully. The deposit that was created\r\n is returned and has the Sageworks id that was assigned.", "schema": { "$ref": "#/definitions/Deposit" }, "examples": { "application/json": {"id":125464545,"accountNumber":"12245600014","customerId":12356548,"type":"Commercial CD","balance":12000.0,"interestRate":0.078,"annualFees":100.0,"originationDate":"2007-12-01","maturityDate":"2023-05-17","isDeleted":false,"branchBankCodeId":null,"userDefinedFields":null} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] }, "get": { "tags": [ "Deposits" ], "summary": "Gets all deposits", "operationId": "GetPaged", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "page", "description": "The page number of results to retrieve (first page = 1, default = 1)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "perPage", "description": "The number of records to return on each page (minimum = 1, maximum = 1000, default = 200)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "customerId", "description": "CustomerId value to filter by", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "accountNumber", "description": "Account number to filter by", "type": "string" }, { "in": "query", "name": "includeUserDefinedFields", "description": "include user defined fields in response", "type": "boolean", "default": false, "x-nullable": true }, { "in": "query", "name": "excludeDepositsForDeletedCustomers", "description": "Set to true to ensure the deposits returned are not linked to deleted customer", "type": "boolean", "default": false } ], "responses": { "200": { "description": "Gets all current, existing, and active deposit accounts in the account", "schema": { "$ref": "#/definitions/CollectionResponse[Deposit]" }, "examples": { "application/json": {"items":[{"id":125464545,"accountNumber":"12245600014","customerId":12356548,"type":"Commercial CD","balance":12000.0,"interestRate":0.078,"annualFees":100.0,"originationDate":"2007-12-01","maturityDate":"2023-05-17","isDeleted":false,"branchBankCodeId":null,"userDefinedFields":null},{"id":425464545,"accountNumber":"772245600014","customerId":42356548,"type":"Personal Savings","balance":100000.0,"interestRate":0.03,"annualFees":0.0,"originationDate":"2010-03-31","maturityDate":"2040-03-31","isDeleted":false,"branchBankCodeId":null,"userDefinedFields":null}]} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] } }, "/v1/deposits/bulk": { "post": { "tags": [ "Deposits" ], "summary": "Creates a collection of deposits", "operationId": "CreateMany", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "The collection of deposits to create", "schema": { "$ref": "#/definitions/BulkCreateRequest[Deposit]" } } ], "responses": { "200": { "description": "All deposits were processed. Please check the errors property of the response object\r\n to determine if there were errors creating any individual deposit", "schema": { "$ref": "#/definitions/BulkCreateResponse[Deposit]" }, "examples": { "application/json": {"itemsCreated":[{"id":125464545,"accountNumber":"12245600014","customerId":12356548,"type":"Commercial CD","balance":12000.0,"interestRate":0.078,"annualFees":100.0,"originationDate":"2007-12-01","maturityDate":"2023-05-17","isDeleted":false,"branchBankCodeId":null,"userDefinedFields":null},{"id":425464545,"accountNumber":"772245600014","customerId":42356548,"type":"Personal Savings","balance":100000.0,"interestRate":0.03,"annualFees":0.0,"originationDate":"2010-03-31","maturityDate":"2040-03-31","isDeleted":false,"branchBankCodeId":null,"userDefinedFields":null},null,{"id":46454545,"accountNumber":"709245600014","customerId":42356548,"type":"Personal Savings","balance":200000.0,"interestRate":0.03,"annualFees":0.0,"originationDate":"2010-03-31","maturityDate":"2040-03-31","isDeleted":false,"branchBankCodeId":null,"userDefinedFields":null}],"errors":{"2":{"errorType":"invalidRequest","message":"Input model for request is invalid","modelErrors":[{"propertyName":"accountNumber","message":"A deposit with accountNumber '1234' already exists"}]}}} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] }, "patch": { "tags": [ "Deposits" ], "summary": "Updates a collection of deposits", "operationId": "UpdateMany", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "The collection of deposits to update", "schema": { "$ref": "#/definitions/BulkUpdateRequest[Deposit]" } } ], "responses": { "200": { "description": "All deposits were processed. Please check the errors property of the response object\r\n to determine if there were errors updating any individual deposit", "schema": { "$ref": "#/definitions/BulkUpdateRequest[Deposit]" }, "examples": { "application/json": {"itemsUpdated":[{"id":125464545,"accountNumber":"12245600014","customerId":12356548,"type":"Commercial CD","balance":12000.0,"interestRate":0.078,"annualFees":100.0,"originationDate":"2007-12-01","maturityDate":"2023-05-17","isDeleted":false,"branchBankCodeId":null,"userDefinedFields":null},{"id":425464545,"accountNumber":"772245600014","customerId":-1,"type":"Personal Savings","balance":100000.0,"interestRate":0.03,"annualFees":0.0,"originationDate":"2010-03-31","maturityDate":"2040-03-31","isDeleted":false,"branchBankCodeId":null,"userDefinedFields":null},{"id":46454545,"accountNumber":"709245600014","customerId":42356548,"type":"Personal Savings","balance":200000.0,"interestRate":0.03,"annualFees":0.0,"originationDate":"2010-03-31","maturityDate":"2040-03-31","isDeleted":false,"branchBankCodeId":null,"userDefinedFields":null}],"errors":{"2":{"errorType":"invalidRequest","message":"Input model for request is invalid","modelErrors":[{"propertyName":"customerId","message":"customerId must be >= 0"}]}}} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] } }, "/v1/deposits/{id}": { "get": { "tags": [ "Deposits" ], "summary": "Gets a deposit by id", "operationId": "GetById", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "id of the existing deposit to get", "required": true, "type": "integer", "format": "int32" }, { "in": "query", "name": "includeUserDefinedFields", "description": "include user defined fields in response", "type": "boolean", "default": false, "x-nullable": true } ], "responses": { "200": { "description": "Gets the deposit account with the specified id", "schema": { "$ref": "#/definitions/Deposit" }, "examples": { "application/json": {"id":125464545,"accountNumber":"12245600014","customerId":12356548,"type":"Commercial CD","balance":12000.0,"interestRate":0.078,"annualFees":100.0,"originationDate":"2007-12-01","maturityDate":"2023-05-17","isDeleted":false,"branchBankCodeId":null,"userDefinedFields":null} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] }, "patch": { "tags": [ "Deposits" ], "summary": "Updates a deposit", "operationId": "Update", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "id of the existing deposit to update", "required": true, "type": "integer", "format": "int32" }, { "in": "body", "name": "body", "description": "The deposit values to update", "schema": { "$ref": "#/definitions/Deposit" } } ], "responses": { "200": { "description": "Returns the modified deposit", "schema": { "$ref": "#/definitions/Deposit" }, "examples": { "application/json": {"id":125464545,"accountNumber":"12245600014","customerId":12356548,"type":"Commercial CD","balance":12000.0,"interestRate":0.078,"annualFees":100.0,"originationDate":"2007-12-01","maturityDate":"2023-05-17","isDeleted":false,"branchBankCodeId":null,"userDefinedFields":null} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] }, "delete": { "tags": [ "Deposits" ], "summary": "Deletes a deposit by id", "operationId": "Delete", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "id of the existing deposit to delete", "required": true, "type": "integer", "format": "int32" } ], "responses": { "204": { "description": "The deposit has been deleted successfully." }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] } }, "/v1/proposed-deposits": { "post": { "tags": [ "Proposed Deposits" ], "summary": "Creates a proposed deposit", "operationId": "Create", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "The deposit to create", "schema": { "$ref": "#/definitions/ProposedDeposit" } } ], "responses": { "201": { "description": "The proposed deposit has been created successfully. The proposed deposit that was created\r\n is returned and has the Sageworks id that was assigned.", "schema": { "$ref": "#/definitions/ProposedDeposit" }, "examples": { "application/json": {"id":125464545,"accountNumber":"12245600014","customerId":12356548,"type":"Commercial CD","balance":12000.0,"interestRate":0.078,"annualFees":100.0,"originationDate":"2007-12-01","maturityDate":"2023-05-17","isDeleted":false,"proposedDepositStageId":null,"userDefinedFields":null} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] }, "get": { "tags": [ "Proposed Deposits" ], "summary": "Get all proposed deposits", "operationId": "GetPaged", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "page", "description": "The page number of results to retrieve (first page = 1, default = 1)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "perPage", "description": "The number of records to return on each page (minimum = 1, maximum = 1000, default = 200)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "customerId", "description": "CustomerId value to filter by", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "accountNumber", "description": "Account number to filter by", "type": "string" }, { "in": "query", "name": "includeUserDefinedFields", "description": "include user defined fields in response", "type": "boolean", "default": false, "x-nullable": true } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/CollectionResponse[ProposedDeposit]" }, "examples": { "application/json": {"items":[{"id":125464545,"accountNumber":"12245600014","customerId":12356548,"type":"Commercial CD","balance":12000.0,"interestRate":0.078,"annualFees":100.0,"originationDate":"2007-12-01","maturityDate":"2023-05-17","isDeleted":false,"proposedDepositStageId":null,"userDefinedFields":null},{"id":425464545,"accountNumber":"772245600014","customerId":42356548,"type":"Personal Savings","balance":100000.0,"interestRate":0.03,"annualFees":0.0,"originationDate":"2010-03-31","maturityDate":"2040-03-31","isDeleted":false,"proposedDepositStageId":null,"userDefinedFields":null}]} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] } }, "/v1/proposed-deposits/{id}": { "delete": { "tags": [ "Proposed Deposits" ], "summary": "Deletes a proposed deposit by id", "operationId": "Delete", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "id of the proposed deposit to delete", "required": true, "type": "integer", "format": "int32" } ], "responses": { "204": { "description": "The proposed deposit has been deleted successfully." }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] }, "get": { "tags": [ "Proposed Deposits" ], "summary": "Gets a proposed deposit by id", "operationId": "GetById", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "id of the proposed deposit to get", "required": true, "type": "integer", "format": "int32" }, { "in": "query", "name": "includeUserDefinedFields", "description": "include user defined fields in response", "type": "boolean", "default": false, "x-nullable": true } ], "responses": { "200": { "description": "Gets the deposit with the specified id", "schema": { "$ref": "#/definitions/ProposedDeposit" }, "examples": { "application/json": {"id":125464545,"accountNumber":"12245600014","customerId":12356548,"type":"Commercial CD","balance":12000.0,"interestRate":0.078,"annualFees":100.0,"originationDate":"2007-12-01","maturityDate":"2023-05-17","isDeleted":false,"proposedDepositStageId":null,"userDefinedFields":null} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] }, "patch": { "tags": [ "Proposed Deposits" ], "summary": "Updates a proposed deposit", "operationId": "Update", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "id of the proposed deposit to update", "required": true, "type": "integer", "format": "int32" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/ProposedDeposit" } } ], "responses": { "200": { "description": "Returns the modified proposed deposit", "schema": { "$ref": "#/definitions/ProposedDeposit" }, "examples": { "application/json": {"id":125464545,"accountNumber":"12245600014","customerId":12356548,"type":"Commercial CD","balance":12000.0,"interestRate":0.078,"annualFees":100.0,"originationDate":"2007-12-01","maturityDate":"2023-05-17","isDeleted":false,"proposedDepositStageId":null,"userDefinedFields":null} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] } }, "/v1/customers/beneficial-owners": { "post": { "tags": [ "Beneficial Owners" ], "summary": "Creates a beneficial owner", "operationId": "Create", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "The beneficial owner to create", "schema": { "$ref": "#/definitions/BeneficialOwner" } } ], "responses": { "201": { "description": "The beneficial owner has been created successfully. The beneficial owner that was created\r\n is returned and has the Sageworks id that was assigned.", "schema": { "$ref": "#/definitions/BeneficialOwner" }, "examples": { "application/json": [{"role":"beneficialOwner","ownershipPercent":0.5,"lastUpdated":"2019-09-10","customerId":43545345,"ownerCustomerId":4594354,"id":4657447},{"role":"certifier","ownershipPercent":0.0,"lastUpdated":"2019-09-10","customerId":4354333,"ownerCustomerId":4567554,"id":674447}] } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "ApiAccess" ] } ] }, "get": { "tags": [ "Beneficial Owners" ], "summary": "Gets all beneficial owners", "operationId": "GetPaged", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "page", "description": "The page number of results to retrieve (first page = 1, default = 1)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "perPage", "description": "The number of records to return on each page (minimum = 1, maximum = 1000, default = 200)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "customerId", "description": "CustomerId value to filter by", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "ownerCustomerIds", "description": "BeneficialOwnerCustomerId value to filter by", "type": "array", "items": { "format": "int64", "type": "integer" }, "collectionFormat": "multi" } ], "responses": { "200": { "description": "Gets all current, existing, and active beneficial owners in the account", "schema": { "$ref": "#/definitions/CollectionResponse[BeneficialOwner]" }, "examples": { "application/json": [{"role":"beneficialOwner","ownershipPercent":0.5,"lastUpdated":"2019-09-10","customerId":43545345,"ownerCustomerId":4594354,"id":4657447},{"role":"certifier","ownershipPercent":0.0,"lastUpdated":"2019-09-10","customerId":4354333,"ownerCustomerId":4567554,"id":674447}] } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "ReadBeneficialOwners" ] } ] } }, "/v1/customers/beneficial-owners/{id}": { "get": { "tags": [ "Beneficial Owners" ], "summary": "Gets a beneficial owner by id", "operationId": "GetById", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "id of the existing beneficial owner to get", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "Gets the beneficial owner with the specified id", "schema": { "$ref": "#/definitions/BeneficialOwner" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "ReadBeneficialOwners" ] } ] }, "patch": { "tags": [ "Beneficial Owners" ], "summary": "Updates a beneficial owner", "operationId": "Update", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "id of the existing beneficial owner to update", "required": true, "type": "integer", "format": "int32" }, { "in": "body", "name": "body", "description": "The beneficial owner values to update", "schema": { "$ref": "#/definitions/BeneficialOwner" } } ], "responses": { "200": { "description": "Returns the modified beneficial owner", "schema": { "$ref": "#/definitions/BeneficialOwner" }, "examples": { "application/json": [{"role":"beneficialOwner","ownershipPercent":0.5,"lastUpdated":"2019-09-10","customerId":43545345,"ownerCustomerId":4594354,"id":4657447},{"role":"certifier","ownershipPercent":0.0,"lastUpdated":"2019-09-10","customerId":4354333,"ownerCustomerId":4567554,"id":674447}] } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "ApiAccess" ] } ] } }, "/v1/customer-contacts": { "post": { "tags": [ "Customer Contacts" ], "summary": "Creates a Customer Contact", "operationId": "Create", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "The customerContact to create", "schema": { "$ref": "#/definitions/CustomerContact" } } ], "responses": { "201": { "description": "The Customer Contact has been created successfully. The Customer Contact that was created\r\n is returned and has the Sageworks id that was assigned.", "schema": { "$ref": "#/definitions/CustomerContact" }, "examples": { "application/json": {"id":556491,"ownerCustomerId":123423,"namePrefix":"Mr.","jobTitle":"Engineer","firstName":"John","lastName":"Doe","company":"Abrigo","phone":"(555) 555-5555","mobile":"(555) 555-5555","emailAddress":"testing@email.com","address1":"1234 Lake View Rd","address2":"Apt 123","city":"Verona","state":"WI","postalCode":"53593","country":"US","comments":"This is a contact","role":"owner","isUniversalContact":false} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "ApiAccess" ] } ] }, "get": { "tags": [ "Customer Contacts" ], "summary": "Gets all Customer Contacts", "operationId": "GetPaged", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "page", "description": "The page number of results to retrieve (first page = 1, default = 1)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "perPage", "description": "The number of records to return on each page (minimum = 1, maximum = 1000, default = 200)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "ownerCustomerId", "description": "OwnerCustomerId value to filter by", "type": "integer", "format": "int32", "x-nullable": true } ], "responses": { "200": { "description": "Gets all current, existing, and active Customer Contacts in the account", "schema": { "$ref": "#/definitions/CollectionResponse[CustomerContact]" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "ReadCustomerContacts" ] } ] } }, "/v1/customer-contacts/bulk": { "post": { "tags": [ "Customer Contacts" ], "summary": "Creates a collection of Customer Contacts", "operationId": "CreateMany", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "The collection of Customer Contacts to create", "schema": { "$ref": "#/definitions/BulkCreateRequest[CustomerContact]" } } ], "responses": { "200": { "description": "All Customer Contacts were processed. Please check the errors property of the response object\r\n to determine if there were errors creating any individual Customer Contact", "schema": { "$ref": "#/definitions/BulkCreateResponse[CustomerContact]" }, "examples": { "application/json": {"itemsCreated":[{"id":556491,"ownerCustomerId":123423,"namePrefix":"Mr.","jobTitle":"Engineer","firstName":"John","lastName":"Doe","company":"Abrigo","phone":"(555) 555-5555","mobile":"(555) 555-5555","emailAddress":"testing@email.com","address1":"1234 Lake View Rd","address2":"Apt 123","city":"Verona","state":"WI","postalCode":"53593","country":"US","comments":"This is a contact","role":"owner","isUniversalContact":false},{"id":556492,"ownerCustomerId":123423,"namePrefix":"PhD","jobTitle":"Manager","firstName":"Jane","lastName":"Doe","company":"Abrigo","phone":"(555) 555-5555","mobile":"(555) 555-5555","emailAddress":"testing@email.com","address1":"1234 Lake View Rd","address2":"Apt 123","city":"Verona","state":"WI","postalCode":"53593","country":"US","comments":"This is a contact","role":"owner","isUniversalContact":false}],"errors":null} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "ApiAccess" ] } ] }, "patch": { "tags": [ "Customer Contacts" ], "summary": "Updates a collection of Customer Contacts", "operationId": "UpdateMany", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "The collection of Customer Contacts to update", "schema": { "$ref": "#/definitions/BulkUpdateRequest[CustomerContact]" } } ], "responses": { "200": { "description": "All Customer Contacts were processed. Please check the errors property of the response object\r\n to determine if there were errors updating any individual customerContact", "schema": { "$ref": "#/definitions/BulkUpdateRequest[CustomerContact]" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "ApiAccess" ] } ] } }, "/v1/customer-contacts/role-options": { "get": { "tags": [ "Customer Contacts" ], "summary": "Gets all customer contact role options", "operationId": "GetRoleOptions", "produces": [ "application/json" ], "responses": { "200": { "description": "Gets the all the customer contact role field options", "schema": { "$ref": "#/definitions/CollectionResponse[DataFieldOption]" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "ReadCustomerContacts" ] } ] } }, "/v1/customer-contacts/{id}": { "get": { "tags": [ "Customer Contacts" ], "summary": "Gets a customerContact by id", "operationId": "GetById", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "id of the existing customerContact to get", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "Gets the customerContact with the specified id", "schema": { "$ref": "#/definitions/CustomerContact" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "ReadCustomerContacts" ] } ] }, "patch": { "tags": [ "Customer Contacts" ], "summary": "Updates a customerContact", "operationId": "Update", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "id of the existing customerContact to update", "required": true, "type": "integer", "format": "int32" }, { "in": "body", "name": "body", "description": "The customerContact values to update", "schema": { "$ref": "#/definitions/CustomerContact" } } ], "responses": { "200": { "description": "Returns the modified customerContact", "schema": { "$ref": "#/definitions/CustomerContact" }, "examples": { "application/json": {"id":556491,"ownerCustomerId":123423,"namePrefix":"Mr.","jobTitle":"Engineer","firstName":"John","lastName":"Doe","company":"Abrigo","phone":"(555) 555-5555","mobile":"(555) 555-5555","emailAddress":"testing@email.com","address1":"1234 Lake View Rd","address2":"Apt 123","city":"Verona","state":"WI","postalCode":"53593","country":"US","comments":"This is a contact","role":"owner","isUniversalContact":false} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "ApiAccess" ] } ] } }, "/v1/online-portal-users/connect-online-portal-user-to-customer": { "post": { "tags": [ "Online Portal Users" ], "operationId": "ConnectPortalUserToCustomer", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "parameters": [ { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/OnlinePortalUserCustomerConnection" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] } }, "/v1/online-portal-users/online-portal-user-mapping/{customerId}": { "get": { "tags": [ "Online Portal Users" ], "operationId": "GetOnlinePortalUserMappingByCustomerId", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "customerId", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/OnlinePortalUserCustomerConnection" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] } }, "/v1/online-portal-users": { "get": { "tags": [ "Online Portal Users" ], "summary": "Gets bank customer users with their associated borrower information", "operationId": "GetBankCustomers", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "page", "description": "The page number of results to retrieve (first page = 1, default = 1)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "perPage", "description": "The number of records to return on each page (minimum = 1, maximum = 1000, default = 200)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "id", "description": "Filter by BankCustomerUsersID", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "email", "description": "Filter by email address", "type": "string" }, { "in": "query", "name": "firstName", "description": "Filter by first name", "type": "string" }, { "in": "query", "name": "lastName", "description": "Filter by last name", "type": "string" }, { "in": "query", "name": "customerId", "description": "Filter by customer ID (username)", "type": "string" } ], "responses": { "200": { "description": "Gets all bank customer users with their associated borrower where relationship type is IsProfitEntity", "schema": { "$ref": "#/definitions/CollectionResponse[BankCustomerUserWithProfitEntity]" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] } }, "/v1/activities": { "post": { "tags": [ "Activities" ], "summary": "Creates an activity", "operationId": "Create", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "The CRMActivity to create", "schema": { "$ref": "#/definitions/Activity" } } ], "responses": { "201": { "description": "The CRMActivity has been created successfully. The CRMActivity that was created\r\n is returned and has the Sageworks id that was assigned.", "schema": { "$ref": "#/definitions/Activity" }, "examples": { "application/json": {"id":0,"type":"Call","subject":"Decrease in Deposit Amount","objectType":"customer","objectId":123,"assignedToUsersID":456,"date":"2020-09-25","comments":"An account's monthly deposit amount has decreased 67% and the average monthly balance has decreased 72% when compared to the prior 6 months.","isDeleted":false} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] }, "get": { "tags": [ "Activities" ], "summary": "Gets all activities", "operationId": "GetPaged", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "page", "description": "The page number of results to retrieve (first page = 1, default = 1)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "perPage", "description": "The number of records to return on each page (minimum = 1, maximum = 1000, default = 200)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "lastModifiedStartDate", "description": "The start of the LastModifiedDate range to be used when doing a date range query.Use the format yyyy-MM-dd. This date is inclusive.", "type": "string", "format": "date-time", "x-nullable": true }, { "in": "query", "name": "lastModifiedEndDate", "description": "The end of the LastModifiedDate range to be used when doing a date range query. Use the format yyyy-MM-dd. This date is inclusive.", "type": "string", "format": "date-time", "x-nullable": true }, { "in": "query", "name": "startDate", "description": "The start of the Date range to be used when doing a date range query.Use the format yyyy-MM-dd. This date is inclusive.", "type": "string", "format": "date-time", "x-nullable": true }, { "in": "query", "name": "endDate", "description": "The end of the Date range to be used when doing a date range query.Use the format yyyy-MM-dd. This date is inclusive.", "type": "string", "format": "date-time", "x-nullable": true }, { "in": "query", "name": "assignedToUsersId", "description": "The Id of the assigned user on which to filter.", "type": "integer", "format": "int64", "x-nullable": true }, { "in": "query", "name": "statusIds", "description": "The status ids on which to filter", "type": "array", "items": { "format": "int32", "type": "integer", "x-nullable": true }, "collectionFormat": "multi" }, { "in": "query", "name": "includeUserDefinedFields", "description": "Include User Defined fields in the response", "type": "boolean", "default": false, "x-nullable": true } ], "responses": { "200": { "description": "Gets all current, existing, and active CRMActivities in the account", "schema": { "$ref": "#/definitions/CollectionResponse[Activity]" }, "examples": { "application/json": {"items":[{"id":0,"objectType":"customer","objectId":123,"type":"Call","subject":"Decrease in Deposit Amount","comments":"An account's monthly deposit amount has decreased 67% and the average monthly balance has decreased 72% when compared to the prior 6 months.","isDeleted":false,"assignedToUsersID":null,"date":null,"status":null,"createdDate":null,"lastModifiedDate":null,"relatedOpportunityID":null,"userDefinedFields":{"User Defined Field 1":"Value 1","User Defined Field 2":"Value 2"}},{"id":0,"objectType":"customer","objectId":123,"type":"Other","subject":"string","comments":"string","isDeleted":false,"assignedToUsersID":null,"date":null,"status":null,"createdDate":null,"lastModifiedDate":null,"relatedOpportunityID":null,"userDefinedFields":{"User Defined Field 2":"Value 2","User Defined Field 3":"Value 3"}}]} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] } }, "/v1/activities/bulk": { "post": { "tags": [ "Activities" ], "summary": "Creates a collection of activities", "operationId": "CreateMany", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "The collection of activities to create", "schema": { "$ref": "#/definitions/BulkCreateRequest[Activity]" } } ], "responses": { "200": { "description": "All activities were processed. Please check the errors property of the response object\r\n to determine if there were errors creating any individual activity", "schema": { "$ref": "#/definitions/BulkCreateResponse[Activity]" }, "examples": { "application/json": {"itemsCreated":[{"id":123,"objectType":"customer","objectId":123,"type":"Call","subject":"Decrease in Deposit Amount","comments":"An account's monthly deposit amount has decreased 67% and the average monthly balance has decreased 72% when compared to the prior 6 months.","isDeleted":false,"assignedToUsersID":456,"date":"2020-09-25","status":null,"createdDate":null,"lastModifiedDate":null,"relatedOpportunityID":null,"userDefinedFields":null},{"id":234,"objectType":"customer","objectId":123,"type":"Other","subject":"string","comments":"string","isDeleted":false,"assignedToUsersID":789,"date":"2020-08-01","status":null,"createdDate":null,"lastModifiedDate":null,"relatedOpportunityID":null,"userDefinedFields":null},null,{"id":456,"objectType":"customer","objectId":123,"type":"Call","subject":"Decrease in Deposit Amount","comments":"An account's monthly deposit amount has decreased 67% and the average monthly balance has decreased 72% when compared to the prior 6 months.","isDeleted":false,"assignedToUsersID":123,"date":"1991-06-15","status":null,"createdDate":null,"lastModifiedDate":null,"relatedOpportunityID":null,"userDefinedFields":null}],"errors":{"2":{"errorType":"invalidRequest","message":"Input model for request is invalid","modelErrors":[{"propertyName":"subject","message":"subject is required"}]}}} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] } }, "/v1/activities/status-options": { "get": { "tags": [ "Activities" ], "summary": "Gets all activity status options", "operationId": "GetStatusOptions", "produces": [ "application/json" ], "responses": { "200": { "description": "Gets the all the activity status field options", "schema": { "$ref": "#/definitions/CollectionResponse[DataFieldOption]" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] } }, "/v1/activities/type-options": { "get": { "tags": [ "Activities" ], "summary": "Gets all activity type options", "operationId": "GetTypeOptions", "produces": [ "application/json" ], "responses": { "200": { "description": "Gets the all the activity type field options", "schema": { "$ref": "#/definitions/CollectionResponse[DataFieldOption]" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] } }, "/v1/activities/count": { "get": { "tags": [ "Activities" ], "operationId": "GetCount", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "lastModifiedStartDate", "description": "The start of the LastModifiedDate range to be used when doing a date range query.Use the format yyyy-MM-dd. This date is inclusive.", "type": "string", "format": "date-time", "x-nullable": true }, { "in": "query", "name": "lastModifiedEndDate", "description": "The end of the LastModifiedDate range to be used when doing a date range query. Use the format yyyy-MM-dd. This date is inclusive.", "type": "string", "format": "date-time", "x-nullable": true }, { "in": "query", "name": "startDate", "description": "The start of the Date range to be used when doing a date range query.Use the format yyyy-MM-dd. This date is inclusive.", "type": "string", "format": "date-time", "x-nullable": true }, { "in": "query", "name": "endDate", "description": "The end of the Date range to be used when doing a date range query.Use the format yyyy-MM-dd. This date is inclusive.", "type": "string", "format": "date-time", "x-nullable": true }, { "in": "query", "name": "assignedToUsersId", "description": "The Id of the assigned user on which to filter.", "type": "integer", "format": "int64", "x-nullable": true }, { "in": "query", "name": "statusIds", "description": "The status ids on which to filter", "type": "array", "items": { "format": "int32", "type": "integer", "x-nullable": true }, "collectionFormat": "multi" } ], "responses": { "200": { "description": "Success", "schema": { "format": "int32", "type": "integer" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] } }, "/v1/activities/{id}": { "get": { "tags": [ "Activities" ], "summary": "Gets an activity by id", "operationId": "GetById", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "id of the existing cRMActivity to get", "required": true, "type": "integer", "format": "int32" }, { "in": "query", "name": "includeUserDefinedFields", "description": "Include User Defined fields in the response", "type": "boolean", "default": false, "x-nullable": true } ], "responses": { "200": { "description": "Gets the cRMActivity with the specified id", "schema": { "$ref": "#/definitions/Activity" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] } }, "/v1/covenant-compliant-statuses": { "get": { "tags": [ "Covenant Compliant Statuses" ], "summary": "Gets all covenant compliant statuses", "operationId": "GetPaged", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "page", "description": "The page number of results to retrieve (first page = 1, default = 1)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "perPage", "description": "The number of records to return on each page (minimum = 1, maximum = 1000, default = 200)", "type": "integer", "format": "int32", "x-nullable": true } ], "responses": { "200": { "description": "Gets all covenant compliant statuses in the account", "schema": { "$ref": "#/definitions/CollectionResponse[CovenantCompliantStatus]" }, "examples": { "application/json": {"items":[{"id":66541,"description":"Pending","isCompliant":true,"isActive":true,"isEnabledForUpdateTestUsers":false,"isDefault":true},{"id":66542,"description":"Past Due","isCompliant":false,"isActive":true,"isEnabledForUpdateTestUsers":true,"isDefault":false},{"id":66543,"description":"Waived","isCompliant":true,"isActive":false,"isEnabledForUpdateTestUsers":true,"isDefault":true}]} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] }, "post": { "tags": [ "Covenant Compliant Statuses" ], "summary": "Creates a Covenant status", "operationId": "Create", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "The Covenant status to create", "schema": { "$ref": "#/definitions/CovenantCompliantStatus" } } ], "responses": { "201": { "description": "The Covenant status has been created successfully. The Covenant status that was created\r\n is returned and has the Sageworks id that was assigned.", "schema": { "$ref": "#/definitions/CovenantCompliantStatus" }, "examples": { "application/json": {"id":66541,"description":"Pending","isCompliant":true,"isActive":true,"isEnabledForUpdateTestUsers":false,"isDefault":false} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] } }, "/v1/covenant-compliant-statuses/{id}": { "get": { "tags": [ "Covenant Compliant Statuses" ], "summary": "Gets a covenant compliant status by id", "operationId": "GetById", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "id of the covenant compliant status to get", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "Gets the covenant compliant status with the specified id", "schema": { "$ref": "#/definitions/TicklerLoanMapping" }, "examples": { "application/json": {"id":66541,"description":"Pending","isCompliant":true,"isActive":true,"isEnabledForUpdateTestUsers":false,"isDefault":false} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] }, "patch": { "tags": [ "Covenant Compliant Statuses" ], "summary": "Updates a Covenant status", "operationId": "Update", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "The Covenant status id to update", "required": true, "type": "integer", "format": "int32" }, { "in": "body", "name": "body", "description": "The Covenant status data to update", "schema": { "$ref": "#/definitions/CovenantCompliantStatus" } } ], "responses": { "200": { "description": "The Covenant status has been updated successfully. The Covenant status that was updated\r\n is returned and has the Sageworks id that was assigned.", "schema": { "$ref": "#/definitions/CovenantCompliantStatus" }, "examples": { "application/json": {"id":66541,"description":"Pending","isCompliant":true,"isActive":true,"isEnabledForUpdateTestUsers":false,"isDefault":false} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] }, "delete": { "tags": [ "Covenant Compliant Statuses" ], "summary": "Deletes a compliant status by id", "operationId": "Delete", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "id of the compliant status to delete", "required": true, "type": "integer", "format": "int32" } ], "responses": { "204": { "description": "The compliant status has been deleted successfully." }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] } }, "/v1/Covenants": { "get": { "tags": [ "Covenants" ], "summary": "Gets all Covenants", "operationId": "GetPaged", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "page", "description": "The page number of results to retrieve (first page = 1, default = 1)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "perPage", "description": "The number of records to return on each page (minimum = 1, maximum = 1000, default = 200)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "customerId", "description": "Customer Id to filter by", "type": "integer", "format": "int32" }, { "in": "query", "name": "portfolioLoanId", "description": "Portfolio Loan Id to filter by", "type": "integer", "format": "int32", "x-nullable": true } ], "responses": { "200": { "description": "Gets all current, existing, and active Covenants in the account", "schema": { "$ref": "#/definitions/CollectionResponse[Covenant]" }, "examples": { "application/json": {"items":[{"id":1231446,"portfolioLoanId":4567231,"customerId":5546485,"covenantName":"CapitalExpenditures","comparison":"greaterThan","expectedValue":5546.0,"currentValue":2254.22,"valueDate":"2020-12-30","comments":"Comments","definition":null,"covenantCompliantStatusId":5564,"monitoringFrequency":0,"nextValueDate":null,"nextMonitoringDate":null,"personResponsibleId":null,"isDisabled":false},{"id":1231447,"portfolioLoanId":4567231,"customerId":5546485,"covenantName":"Cash","comparison":"greaterThanOrEqual","expectedValue":10000.0,"currentValue":9561.78,"valueDate":"2020-12-30","comments":"Comments","definition":null,"covenantCompliantStatusId":5565,"monitoringFrequency":0,"nextValueDate":null,"nextMonitoringDate":null,"personResponsibleId":null,"isDisabled":false}]} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] }, "post": { "tags": [ "Covenants" ], "operationId": "Create", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/Covenant" } } ], "responses": { "201": { "description": "Created", "schema": { "$ref": "#/definitions/Covenant" }, "examples": { "application/json": {"id":1231446,"portfolioLoanId":4567231,"customerId":5546485,"covenantName":"CapitalExpenditures","comparison":"greaterThan","expectedValue":5546.0,"currentValue":2254.22,"valueDate":"2020-12-30","comments":"Comments","definition":null,"covenantCompliantStatusId":5564,"monitoringFrequency":0,"nextValueDate":null,"nextMonitoringDate":null,"personResponsibleId":null,"isDisabled":false} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null, "CreateCovenant" ] } ] } }, "/v1/Covenants/{id}": { "get": { "tags": [ "Covenants" ], "summary": "Gets a Covenant by id", "operationId": "GetById", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "id of the Covenant to get", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "Gets the Covenant with the specified id", "schema": { "$ref": "#/definitions/Covenant" }, "examples": { "application/json": {"id":1231446,"portfolioLoanId":4567231,"customerId":5546485,"covenantName":"CapitalExpenditures","comparison":"greaterThan","expectedValue":5546.0,"currentValue":2254.22,"valueDate":"2020-12-30","comments":"Comments","definition":null,"covenantCompliantStatusId":5564,"monitoringFrequency":0,"nextValueDate":null,"nextMonitoringDate":null,"personResponsibleId":null,"isDisabled":false} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] }, "patch": { "tags": [ "Covenants" ], "operationId": "Update", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "required": true, "type": "integer", "format": "int32" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/Covenant" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/Covenant" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null, "UpdateCovenant" ] } ] } }, "/v1/bank-codes": { "get": { "tags": [ "Bank Codes" ], "summary": "Gets all bank codes", "operationId": "GetPaged", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "page", "description": "The page number of results to retrieve (first page = 1, default = 1)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "perPage", "description": "The number of records to return on each page (minimum = 1, maximum = 1000, default = 200)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "type", "description": "Bank code type to filter by", "type": "string", "enum": [ "callCode", "collateralCode", "productCode", "loanTypeCode", "purposeCode", "classCode", "businessUnitCode", "branchCode", "costCenterCode", "generalLedgerCode", "depositProductType", "depositAccountType" ], "x-nullable": true } ], "responses": { "200": { "description": "Gets all current, existing, and active bank codes in the account", "schema": { "$ref": "#/definitions/CollectionResponse[BankCode]" }, "examples": { "application/json": {"items":[{"id":7456123,"code":"CCL01","label":"All - Commercial","type":"collateralCode"},{"id":7456142,"code":"COL01","label":"ALL - Commercial","type":"collateralCode"},{"id":7464577,"code":"00034","label":"North Carolina Branch","type":"branchCode"},{"id":7454591,"code":"111","label":"Res Prop (Purchase)","type":"purposeCode"}]} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "ReadBankCodes" ] } ] } }, "/v1/bank-codes/branches": { "get": { "tags": [ "Bank Codes" ], "summary": "Gets all branch codes", "operationId": "GetBranchesPaged", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "page", "description": "The page number of results to retrieve (first page = 1, default = 1)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "perPage", "description": "The number of records to return on each page (minimum = 1, maximum = 1000, default = 200)", "type": "integer", "format": "int32", "x-nullable": true } ], "responses": { "200": { "description": "Gets all current, existing, and active branch codes in the account", "schema": { "$ref": "#/definitions/CollectionResponse[BankCode]" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "ReadBankCodes" ] } ] } }, "/v1/bank-codes/{id}": { "get": { "tags": [ "Bank Codes" ], "summary": "Gets a bank code by id", "operationId": "GetById", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "id of the bank code to get", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "Gets the bank code with the specified id", "schema": { "$ref": "#/definitions/BankCode" }, "examples": { "application/json": {"id":7456123,"code":"CCL01","label":"All - Commercial","type":"collateralCode"} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "ReadBankCodes" ] } ] } }, "/v1/loan-application-proposed-loan-mappings": { "get": { "tags": [ "Loan Application Proposed Loan Mappings" ], "summary": "Gets all loan application proposed loan mappings", "operationId": "GetPaged", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "page", "description": "The page number of results to retrieve (first page = 1, default = 1)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "perPage", "description": "The number of records to return on each page (minimum = 1, maximum = 1000, default = 200)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "loanApplicationId", "description": "LoanApplicationId value to filter by", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "proposedLoanId", "description": "ProposedLoanId value to filter by", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "loanApplicationNumber", "description": "Loan Application number to filter by", "type": "integer", "format": "int32", "x-nullable": true } ], "responses": { "200": { "description": "Gets all loan application proposed loan mappings in the account", "schema": { "$ref": "#/definitions/CollectionResponse[LoanApplicationProposedLoanMapping]" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "ReadLoanApplicationProposedLoanMappings" ] } ] } }, "/v1/loan-application-proposed-loan-mappings/{id}": { "get": { "tags": [ "Loan Application Proposed Loan Mappings" ], "summary": "Gets a loan application proposed loan mapping by id", "operationId": "GetById", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "id of the existing loan application proposed loan mapping to get", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "Gets the loan application proposed loan mapping with the specified id", "schema": { "$ref": "#/definitions/LoanApplicationProposedLoanMapping" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "ReadLoanApplicationProposedLoanMappings" ] } ] } }, "/v1/loan-applications": { "get": { "tags": [ "Loan Applications" ], "summary": "Gets all loan applications", "operationId": "GetPaged", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "page", "description": "The page number of results to retrieve (first page = 1, default = 1)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "perPage", "description": "The number of records to return on each page (minimum = 1, maximum = 1000, default = 200)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "customerId", "description": "CustomerId value to filter by", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "proposedLoanId", "description": "ProposedLoanId value to filter by", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "loanApplicationNumber", "description": "Loan Application number to filter by", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "createdDateFrom", "description": "The start of the date range to be used when doing a Created Date range query. Use the format yyyy-MM-dd. This date is inclusive.", "type": "string", "format": "date-time", "x-nullable": true }, { "in": "query", "name": "createdDateTo", "description": "The end of the date range to be used when doing a Created Date range query. Use the format yyyy-MM-dd. This date is inclusive.", "type": "string", "format": "date-time", "x-nullable": true }, { "in": "query", "name": "lastModifiedDateFrom", "description": "The start of the date range to be used when doing a Last Modified Date range query. Use the format yyyy-MM-dd. This date is inclusive.", "type": "string", "format": "date-time", "x-nullable": true }, { "in": "query", "name": "lastModifiedDateTo", "description": "The end of the date range to be used when doing a Last Modified Date range query. Use the format yyyy-MM-dd. This date is inclusive.", "type": "string", "format": "date-time", "x-nullable": true }, { "in": "query", "name": "isSubmitted", "description": "Filter by Submitted Date if it has a value or not", "type": "boolean", "x-nullable": true }, { "in": "query", "name": "crmIdentifier", "description": "CRM System's identifier to filter by", "type": "string" } ], "responses": { "200": { "description": "Gets all loan applications in the account", "schema": { "$ref": "#/definitions/CollectionResponse[LoanApplication]" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "ReadLoanApplications" ] } ] }, "post": { "tags": [ "Loan Applications" ], "summary": "Creates a loan application", "operationId": "CreateClassicLoanApplication", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/ClassicLoanApplicationCreateRequest" } } ], "responses": { "201": { "description": "The loan application has been created successfully. The loan application\r\n that was created is returned and has the Sageworks id that was assigned.", "schema": { "$ref": "#/definitions/LoanApplication" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "ApiAccess" ] } ] } }, "/v1/loan-applications/{id}": { "get": { "tags": [ "Loan Applications" ], "operationId": "GetById", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/LoanApplication" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "ReadLoanApplications" ] } ] }, "patch": { "tags": [ "Loan Applications" ], "summary": "Updates an existing loan application", "operationId": "Update", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "id of the existing loan application to update", "required": true, "type": "integer", "format": "int32" }, { "in": "body", "name": "body", "description": "The loan application values to update", "schema": { "$ref": "#/definitions/LoanApplication" } } ], "responses": { "200": { "description": "Returns the modified loan application", "schema": { "$ref": "#/definitions/LoanApplication" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "ApiAccess" ] } ] }, "delete": { "tags": [ "Loan Applications" ], "summary": "Deletes a loan application by id", "operationId": "Delete", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "id of the existing loan application to delete", "required": true, "type": "integer", "format": "int32" } ], "responses": { "204": { "description": "The loan application has been deleted successfully." }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" } }, "security": [ { "oauth2": [ null, "ApiAccess" ] } ] } }, "/v1/loan-applications/submit-by-id": { "post": { "tags": [ "Loan Applications" ], "summary": "Submits a loan application by id", "operationId": "SubmitByIdAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "object with details of the existing loan application to submit", "schema": { "$ref": "#/definitions/LoanApplicationSubmitByIdRequest" } } ], "responses": { "200": { "description": "Returns the modified loan application.", "schema": { "$ref": "#/definitions/LoanApplication" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "ApiAccess" ] } ] } }, "/v1/loan-applications/{id}/lock": { "post": { "tags": [ "Loan Applications" ], "summary": "Locks a loan application by id", "operationId": "LockApplication", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "id of the existing loan application to lock", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "The loan application has been locked successfully.", "schema": { "$ref": "#/definitions/LoanApplication" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" } }, "security": [ { "oauth2": [ null, "ApiAccess" ] } ] } }, "/v1/loan-applications/{id}/unlock": { "post": { "tags": [ "Loan Applications" ], "summary": "Unlocks a loan application by id", "operationId": "UnlockApplication", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "id of the existing loan application to unlock", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "The loan application has been unlocked successfully.", "schema": { "$ref": "#/definitions/LoanApplication" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" } }, "security": [ { "oauth2": [ null, "ApiAccess" ] } ] } }, "/v1/loan-applications/{id}/esign/has-agreement": { "get": { "tags": [ "Loan Applications" ], "summary": "Check whether or not a loan application has an Adobe eSign agreement created", "operationId": "HasESignAgreement", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "id of the loan application", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "Returns true if the application has an Adobe eSign agreement, false otherwise", "schema": { "type": "boolean" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "ApiAccess" ] } ] } }, "/v1/loan-applications/{id}/esign/signed-agreement": { "get": { "tags": [ "Loan Applications" ], "summary": "Get view URL for a signed agreement PDF for a loan application.\r\nReturns a URL that allows the caller to open the signed document in a new browser tab.", "operationId": "GetSignedAgreement", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "id of the loan application", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "Returns the document URL for opening in a new tab", "schema": { "$ref": "#/definitions/SignedAgreementViewResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "No signed agreement found for this application" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "ApiAccess" ] } ] } }, "/v1/loan-applications/{id}/export-url": { "get": { "tags": [ "Loan Applications" ], "summary": "Get an authenticated URL for viewing/exporting a loan application in the Online Portal.\r\nThis URL can be opened in a new browser tab to view the application in export mode.", "operationId": "GetApplicationExportUrl", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "id of the loan application", "required": true, "type": "integer", "format": "int32" }, { "in": "query", "name": "lenderOnlyMode", "description": "If true, returns URL for lender-only export view (default: true)", "type": "boolean", "default": true } ], "responses": { "200": { "description": "Returns the authenticated export URL", "schema": { "$ref": "#/definitions/ApplicationExportUrlResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "ApiAccess" ] } ] } }, "/v1/loan-applications/withdraw-application": { "post": { "tags": [ "Loan Applications" ], "summary": "Withdraws a loan application with the specified withdrawal reasons and comments.", "operationId": "WithdrawApplication", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "parameters": [ { "in": "body", "name": "body", "description": "The withdrawal request containing the application ID, decision reasons, and optional comments.", "schema": { "$ref": "#/definitions/ApplicationWithdrawalInformation" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null, "ApiAccess" ] } ] } }, "/v1/loan-reconciliation-summary": { "get": { "tags": [ "Loan Reconciliation" ], "summary": "Gets loan reconciliation values", "operationId": "LoanReconciliationSummary", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "segmentationCode", "description": "The code to segment aggregations by (callCode, collateralCode, productCode, etc.)", "required": true, "type": "string", "format": "string", "enum": [ "callCode", "collateralCode", "productCode", "loanTypeCode" ] }, { "in": "query", "name": "coreLoansOnly", "description": "True means only loans pulled in from bank's core will be shown", "required": true, "type": "boolean" }, { "in": "query", "name": "archiveMonth", "description": "Month of the archive calculation to use for the loan reconciliation summary, will use \"Today's Values\" if null or empty", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "archiveYear", "description": "Year of the archive calculation to use for the loan reconciliation summary, will use \"Today's Values\" if null or empty", "type": "integer", "format": "int32", "x-nullable": true } ], "responses": { "200": { "description": "Gets loan reconciliation values", "schema": { "$ref": "#/definitions/CollectionResponse[LoanSegment]" }, "examples": { "application/json": {"items":[{"segmentationCode":"0","totalLoanBalance":2444705006.41,"totalIndividualLoanBalance":2379957564.28,"totalPooledLoanBalance":49547294.13,"totalOtherLoanBalance":15199998.0,"totalPurchasedImpairedLoanBalance":150.0,"totalPurchasedNonImpairedLoanBalance":0.0,"totalLoanCount":301},{"segmentationCode":"1","totalLoanBalance":230662521.32,"totalIndividualLoanBalance":70565842.32,"totalPooledLoanBalance":135057576.0,"totalOtherLoanBalance":25039103.0,"totalPurchasedImpairedLoanBalance":0.0,"totalPurchasedNonImpairedLoanBalance":0.0,"totalLoanCount":183},{"segmentationCode":"10","totalLoanBalance":1294000.0,"totalIndividualLoanBalance":400000.0,"totalPooledLoanBalance":894000.0,"totalOtherLoanBalance":0.0,"totalPurchasedImpairedLoanBalance":0.0,"totalPurchasedNonImpairedLoanBalance":0.0,"totalLoanCount":3}]} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ApiAccess", null ] } ] } }, "/v1/account/loan-officers": { "get": { "tags": [ "Loan Officers" ], "summary": "Gets a list of all loan officers", "operationId": "GetPaged", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "page", "description": "The page number of results to retrieve (first page = 1, default = 1)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "perPage", "description": "The number of records to return on each page (minimum = 1, maximum = 1000, default = 200)", "type": "integer", "format": "int32", "x-nullable": true }, { "in": "query", "name": "ids", "description": "List of ids to filter by", "type": "array", "items": { "format": "int64", "type": "integer" }, "collectionFormat": "multi" }, { "in": "query", "name": "sortByName", "description": "If true, sort loan officers alphabetically by first name, then last name (case-insensitive).\r\nIf false or null, returns loan officers in default order (by ID).", "type": "boolean", "x-nullable": true } ], "responses": { "404": { "description": "Not Found" }, "200": { "description": "Gets all loan officers that are available for selection\r\n in the 'Loan Officer' drop down in Sageworks to associate with loans and other items", "schema": { "$ref": "#/definitions/CollectionResponse[LoanOfficer]" }, "examples": { "application/json": {"items":[{"id":1245613,"firstName":"John","lastName":"Smith","loanRepresentativeCode":null,"email":"JohnSmith@email.com"},{"id":7453312,"firstName":"Suzie","lastName":"Wilson","loanRepresentativeCode":null,"email":"SuzieWilson@email.com"},{"id":456423121,"firstName":"Test","lastName":"Officer","loanRepresentativeCode":null,"email":"TestOfficer@email.com"}]} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "LoanOfficers", null ] } ] } }, "/v1/account/loan-officers/{id}": { "get": { "tags": [ "Loan Officers" ], "summary": "Gets a loan officer by id", "operationId": "GetById", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "id of the loan officer to get", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "Gets the loan officer with the specified id", "schema": { "$ref": "#/definitions/LoanOfficer" }, "examples": { "application/json": {"id":1245613,"firstName":"John","lastName":"Smith","loanRepresentativeCode":null,"email":"JohnSmith@email.com"} } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "LoanOfficers", null ] } ] } } }, "definitions": { "Activity": { "description": "An activity", "type": "object", "properties": { "assignedToUsersID": { "format": "int32", "description": "The user that the activity is assigned to", "type": "integer", "x-nullable": true }, "comments": { "description": "Comments related to the activity", "type": "string" }, "createdDate": { "format": "Date", "description": "The date the activity was created", "type": "string", "x-nullable": true }, "date": { "format": "Date", "description": "The date of the activity", "type": "string", "x-nullable": true }, "id": { "format": "int32", "description": "id of the activity", "type": "integer" }, "isDeleted": { "description": "Indicates if the activity has been deleted", "type": "boolean" }, "lastModifiedDate": { "format": "Date", "description": "The date the activity was modified", "type": "string", "x-nullable": true }, "objectId": { "format": "int32", "description": "The id of the object that is being associated with the activity", "type": "integer" }, "objectType": { "description": "The type of object that is being associated with the activity", "type": "string" }, "relatedOpportunityID": { "format": "int32", "description": "The opportunity this activity relates to", "type": "integer", "x-nullable": true }, "status": { "description": "The of the status of activity (ex: outstanding, completed)", "type": "string" }, "subject": { "description": "A subject describing the activity", "type": "string" }, "type": { "description": "The type of activity (ex: appointment, call, email)", "type": "string" }, "userDefinedFields": { "description": "User-defined fields for the activity", "type": "object", "additionalProperties": { "type": "string" } } }, "additionalProperties": false }, "Address": { "description": "Represents an address", "type": "object", "properties": { "addressType": { "format": "string", "description": "Type of address (primary, mailing)", "enum": [ "primary", "mailing" ], "type": "string" }, "city": { "description": "City of the address", "type": "string" }, "country": { "description": "Country of the address", "type": "string" }, "line1": { "description": "The first line of the address", "type": "string" }, "line2": { "description": "The second line of the address", "type": "string" }, "postalCode": { "description": "Postal code of the address", "type": "string" }, "state": { "description": "State of the address", "type": "string" } }, "additionalProperties": false }, "AdobeAgreement": { "description": "An Adobe Agreement", "type": "object", "properties": { "agreementId": { "format": "int32", "description": "Agreement ID", "type": "integer" } }, "additionalProperties": false }, "AdobeAgreementProposedLoanMapping": { "description": "An Adobe Agreement Proposed Loan Mapping", "type": "object", "properties": { "agreementId": { "format": "int64", "description": "Agreement ID", "type": "integer" }, "proposedLoanId": { "format": "int64", "description": "Proposed Loan ID", "type": "integer" } }, "additionalProperties": false }, "AdobeAgreementStatus": { "description": "Agreement status and returned document if available", "type": "object", "properties": { "lastSignatureEmailRequestSent": { "format": "Date", "description": "Date the last signature request email was sent", "type": "string", "x-nullable": true }, "recipientStatuses": { "description": "List of recipient information for the agreement", "type": "array", "items": { "$ref": "#/definitions/EsignRecipientStatuses" } }, "requestedDate": { "format": "Date", "description": "Date the Adobe Agreement was created", "type": "string", "x-nullable": true } }, "additionalProperties": false }, "AdobeEsignAgreementStatus": { "description": "Agreement status and returned document if available", "type": "object", "properties": { "agreementStatus": { "$ref": "#/definitions/AdobeAgreementStatus" } }, "additionalProperties": false }, "ApplicationExportUrlResponse": { "description": "Response containing the authenticated URL for viewing/exporting a loan application in the Online Portal", "type": "object", "properties": { "exportUrl": { "description": "The authenticated URL to view the application in export mode in the Online Portal", "type": "string" } }, "additionalProperties": false }, "ApplicationTemplate": { "description": "A template for use with dynamic applications.\r\nTies to a dynamic form for collecting data", "type": "object", "properties": { "active": { "description": "Specifies if the template is currently available for use with an application", "type": "boolean" }, "applicationTemplateAdditionalSettings": { "$ref": "#/definitions/ApplicationTemplateAdditionalSettings" }, "id": { "format": "int32", "description": "The unique identifier of the template", "type": "integer" }, "name": { "description": "The name of the template", "type": "string" }, "proposedProducts": { "description": "The list of accounts that are available for use in applications with this template", "type": "array", "items": { "$ref": "#/definitions/ProposedProduct" } }, "type": { "format": "string", "description": "The type of application this can be used to create", "enum": [ "preApp", "business", "person", "sba", "nonprofit", "farm" ], "type": "string" } }, "additionalProperties": false }, "ApplicationTemplateAdditionalSettings": { "type": "object", "properties": { "customersID": { "format": "int64", "type": "integer" }, "id": { "format": "int64", "type": "integer" }, "requiresReview": { "type": "boolean" } }, "additionalProperties": false }, "ApplicationWithdrawalInformation": { "type": "object", "properties": { "applicationID": { "format": "int64", "type": "integer" }, "decisionReasons": { "type": "array", "items": { "$ref": "#/definitions/ProposedBankLoanDecisionReason" } }, "withdrawalReasonComment": { "type": "string" } }, "additionalProperties": false }, "BankCode": { "description": "Represents a Bank Code in Sageworks", "type": "object", "properties": { "code": { "description": "The unique code for this bank code", "type": "string" }, "id": { "format": "int32", "description": "The id of the bank code in Sageworks", "type": "integer" }, "label": { "description": "The label for this bank code", "type": "string" }, "type": { "format": "string", "description": "The type of bank code (ex: BranchCode, ClassCode)", "enum": [ "callCode", "collateralCode", "productCode", "loanTypeCode", "purposeCode", "classCode", "businessUnitCode", "branchCode", "costCenterCode", "generalLedgerCode", "depositProductType", "depositAccountType" ], "type": "string" } }, "additionalProperties": false }, "BankCustomerUserWithProfitEntity": { "description": "Represents a bank customer user with their associated profit entity information", "type": "object", "properties": { "borrowerId": { "format": "int32", "description": "The ID of the associated borrower (profit entity) where the relationship type is IsProfitEntity", "type": "integer", "x-nullable": true }, "customerId": { "description": "Customer ID (username) of the bank customer user", "type": "string" }, "email": { "description": "Email address of the bank customer user", "type": "string" }, "firstName": { "description": "First name of the bank customer user", "type": "string" }, "id": { "format": "int32", "description": "The bank customer user ID", "type": "integer" }, "lastName": { "description": "Last name of the bank customer user", "type": "string" } }, "additionalProperties": false }, "BaseFieldMetadata": { "type": "object", "properties": { "additionalMetadata": { "readOnly": true, "x-nullable": true }, "columnName": { "type": "string" }, "customersID": { "format": "int64", "type": "integer" }, "customTableAlias": { "type": "string" }, "customTableDataFieldDefaultsID": { "format": "int64", "type": "integer", "x-nullable": true }, "customTableDataFieldsID": { "format": "int64", "type": "integer" }, "dataType": { "format": "string", "enum": [ "other", "text", "numeric", "currency", "date", "boolean", "percent" ], "type": "string" }, "dataTypeOverride": { "enum": [ "other", "text", "numeric", "currency", "date", "boolean", "percent" ], "type": "string", "x-nullable": true }, "encodedFieldKey": { "type": "string" }, "fieldCategory": { "format": "string", "enum": [ "standard", "userDefined", "virtual", "relationship", "relationshipUserDefined" ], "type": "string" }, "fieldKey": { "type": "string" }, "fieldType": { "format": "string", "enum": [ "standard", "navigation" ], "type": "string" }, "formatString": { "format": "string", "enum": [ "other", "c2", "p2", "yesNo", "n0", "n1", "n2", "n3", "n4", "p3", "p4", "textLength500", "textLength1000", "textLength200", "c0", "c4", "p0", "f0", "trueFalse", "textLength255", "yesNoBool", "ordered", "yyyyMM", "textLength25" ], "type": "string" }, "hasDefinedValueOptions": { "type": "boolean", "readOnly": true }, "inputFormat": { "format": "string", "enum": [ "other", "text", "numeric", "currency", "date", "percent", "dropdown", "radio", "label", "labelRow", "comments", "divider", "link", "checkbox", "textArea", "expandingTextArea", "combobox", "multiSelect", "industryCode", "birthDate", "spacer", "customMetric", "fixedPointNumeric", "groupedValues", "socialSecurityNumber", "autoComplete", "textWithDropdownOptions", "phoneNumber", "userDropdown" ], "type": "string" }, "isActive": { "type": "boolean" }, "label": { "type": "string" }, "readOnly": { "type": "boolean" }, "required": { "type": "boolean" }, "sectionType": { "format": "string", "enum": [ "customerProfileCompany", "profitEntities", "contacts", "activities", "opportunities", "proposedLoans", "existingLoans", "bankDeposits", "bankLoanCollateral", "customerProfilePerson", "customerProfileFarm", "bankLoansArchive", "workflowsList", "loanApplication", "ticklers", "documents", "bankLoanCovenants", "loanPricingScenarios", "riskRatingCalculations", "sbaAlternateContacts", "sbaProceedsUses", "businessIncomeStatement", "businessBalanceSheet", "businessRatios", "businessOtherInformation", "businessCustomFields", "personIncomeExpenses", "personAssetsLiabilities", "personRatios", "personOtherInformation", "personCustomFields", "groupMetrics", "riskRatingApprovals", "personalFinancialStatementCashAccounts", "personalFinancialStatementSecurities", "personalFinancialStatementLifeInsurancePolicies", "personalFinancialStatementRetirementAccounts", "personalFinancialStatementAccountsReceivable", "personalFinancialStatementVehicles", "personalFinancialStatementRealEstate", "personalFinancialStatementOtherAssets", "personalFinancialStatementLoans", "personalFinancialStatementAccountsPayable", "personalFinancialStatementOtherLiabilities", "companyFinancialStatement", "policyExceptions", "workflowReason", "workflows", "farmFinancialStatement", "nonProfitFinancialStatement", "personFinancialStatement", "revenueProducts", "segmentInsights", "realEstateFinancialStatement", "customers", "hmdaLoanRecords", "bankLoanRoles", "loanDecisioning", "bankLoanWorkoutsTDRCaresActReliefs", "bankLoanWorkoutsTDRInteragencyStatements", "bankLoanWorkoutsTDRExistingGuidances", "financialSubaccounts", "profitCompanyOwners", "narrativeForCRM", "proposedLoanFinancialCalculations", "businessInvestments", "loanPortfolioMonitoring", "proposedScenarioCollateralLiens", "covenantsList" ], "type": "string" }, "tableName": { "type": "string" }, "valueOptions": { "type": "array", "items": { "$ref": "#/definitions/ISelectOption" } } }, "additionalProperties": false }, "BeneficialOwner": { "description": "Beneficial Owner for company", "required": [ "customerId", "ownerCustomerId", "ownershipPercent", "role" ], "type": "object", "properties": { "customerId": { "format": "int32", "description": "The ID of the customer that is being owned or certified.", "type": "integer" }, "id": { "format": "int32", "description": "The ID of Beneficial Owner record in Sageworks", "type": "integer" }, "lastUpdated": { "format": "Date", "description": "This will automatically update any time information for this role has been changed and saved. It can also be manually changed by the user to show the information has been re-verified and there were no changes.", "type": "string", "x-nullable": true }, "ownerCustomerId": { "format": "int32", "description": "The ID of the customer that is the beneficial owner or certifier.", "type": "integer" }, "ownershipPercent": { "format": "double", "description": "If a beneficial owner, what percent of the business is owned by them.", "type": "number" }, "role": { "format": "string", "description": "Selected person or business is a beneficial owner (owns 25% or more of the business), a control person, or a certifier.", "enum": [ "beneficialOwner", "controlPerson", "beneficialOwnerControlPerson", "certifier", "beneficialOwnerControlPersonCertifier", "beneficialOwnerCertifier", "controlPersonCertifier" ], "type": "string" } }, "additionalProperties": false }, "BeneficialOwnership": { "type": "object", "properties": { "lastUpdated": { "format": "Date", "description": "This will automatically update any time information for this role has been changed and saved. It can also be manually changed by the user to show the information has been re-verified and there were no changes.", "type": "string", "x-nullable": true }, "name": { "description": "The name of the customer that is being owned or certified.", "type": "string" }, "ownerCustomerId": { "format": "int32", "description": "The ID of the customer that is the beneficial owner or certifier.", "type": "integer" }, "ownerCustomerNumber": { "description": "The customer number of the customer that is being owned or certified.", "type": "string" }, "ownerLoanBoardingIdentifier": { "description": "The loan boarding identifier of the customer that is being owned or certified.", "type": "string" }, "ownershipPercent": { "format": "double", "description": "If a beneficial owner, what percent of the business is owned by them.", "type": "number" }, "role": { "format": "string", "description": "Selected person or business is a beneficial owner (owns 25% or more of the business), a control person, or a certifier.", "enum": [ "beneficialOwner", "controlPerson", "beneficialOwnerControlPerson", "certifier", "beneficialOwnerControlPersonCertifier", "beneficialOwnerCertifier", "controlPersonCertifier" ], "type": "string" } }, "additionalProperties": false }, "BulkCreateRequest[Activity]": { "description": "Contains the input necessary to perform a request to create a collection of items\r\nin a single request", "type": "object", "properties": { "itemsToCreate": { "description": "The items to be created", "type": "array", "items": { "$ref": "#/definitions/Activity" } } }, "additionalProperties": false }, "BulkCreateRequest[CollateralWidget]": { "description": "Contains the input necessary to perform a request to create a collection of items\r\nin a single request", "type": "object", "properties": { "itemsToCreate": { "description": "The items to be created", "type": "array", "items": { "$ref": "#/definitions/CollateralWidget" } } }, "additionalProperties": false }, "BulkCreateRequest[Collateral]": { "description": "Contains the input necessary to perform a request to create a collection of items\r\nin a single request", "type": "object", "properties": { "itemsToCreate": { "description": "The items to be created", "type": "array", "items": { "$ref": "#/definitions/Collateral" } } }, "additionalProperties": false }, "BulkCreateRequest[CustomerContact]": { "description": "Contains the input necessary to perform a request to create a collection of items\r\nin a single request", "type": "object", "properties": { "itemsToCreate": { "description": "The items to be created", "type": "array", "items": { "$ref": "#/definitions/CustomerContact" } } }, "additionalProperties": false }, "BulkCreateRequest[Customer]": { "description": "Contains the input necessary to perform a request to create a collection of items\r\nin a single request", "type": "object", "properties": { "itemsToCreate": { "description": "The items to be created", "type": "array", "items": { "$ref": "#/definitions/Customer" } } }, "additionalProperties": false }, "BulkCreateRequest[Deposit]": { "description": "Contains the input necessary to perform a request to create a collection of items\r\nin a single request", "type": "object", "properties": { "itemsToCreate": { "description": "The items to be created", "type": "array", "items": { "$ref": "#/definitions/Deposit" } } }, "additionalProperties": false }, "BulkCreateRequest[Lien]": { "description": "Contains the input necessary to perform a request to create a collection of items\r\nin a single request", "type": "object", "properties": { "itemsToCreate": { "description": "The items to be created", "type": "array", "items": { "$ref": "#/definitions/Lien" } } }, "additionalProperties": false }, "BulkCreateRequest[LoanApplicationPersonalInputData]": { "description": "Contains the input necessary to perform a request to create a collection of items\r\nin a single request", "type": "object", "properties": { "itemsToCreate": { "description": "The items to be created", "type": "array", "items": { "$ref": "#/definitions/LoanApplicationPersonalInputData" } } }, "additionalProperties": false }, "BulkCreateRequest[Opportunity]": { "description": "Contains the input necessary to perform a request to create a collection of items\r\nin a single request", "type": "object", "properties": { "itemsToCreate": { "description": "The items to be created", "type": "array", "items": { "$ref": "#/definitions/Opportunity" } } }, "additionalProperties": false }, "BulkCreateRequest[PolicyException]": { "description": "Contains the input necessary to perform a request to create a collection of items\r\nin a single request", "type": "object", "properties": { "itemsToCreate": { "description": "The items to be created", "type": "array", "items": { "$ref": "#/definitions/PolicyException" } } }, "additionalProperties": false }, "BulkCreateRequest[PortfolioLoan]": { "description": "Contains the input necessary to perform a request to create a collection of items\r\nin a single request", "type": "object", "properties": { "itemsToCreate": { "description": "The items to be created", "type": "array", "items": { "$ref": "#/definitions/PortfolioLoan" } } }, "additionalProperties": false }, "BulkCreateRequest[ProposedLien]": { "description": "Contains the input necessary to perform a request to create a collection of items\r\nin a single request", "type": "object", "properties": { "itemsToCreate": { "description": "The items to be created", "type": "array", "items": { "$ref": "#/definitions/ProposedLien" } } }, "additionalProperties": false }, "BulkCreateRequest[ProposedLoan]": { "description": "Contains the input necessary to perform a request to create a collection of items\r\nin a single request", "type": "object", "properties": { "itemsToCreate": { "description": "The items to be created", "type": "array", "items": { "$ref": "#/definitions/ProposedLoan" } } }, "additionalProperties": false }, "BulkCreateRequest[ProposedProduct]": { "description": "Contains the input necessary to perform a request to create a collection of items\r\nin a single request", "type": "object", "properties": { "itemsToCreate": { "description": "The items to be created", "type": "array", "items": { "$ref": "#/definitions/ProposedProduct" } } }, "additionalProperties": false }, "BulkCreateRequest[RevenueProduct]": { "description": "Contains the input necessary to perform a request to create a collection of items\r\nin a single request", "type": "object", "properties": { "itemsToCreate": { "description": "The items to be created", "type": "array", "items": { "$ref": "#/definitions/RevenueProduct" } } }, "additionalProperties": false }, "BulkCreateResponse[Activity]": { "description": "Contains the response of a bulk creation request", "type": "object", "properties": { "errors": { "description": "A dictionary of errors where the key of the dictionary is the index of the item in the list that\r\nwas provided in the request that had an error and the value is the error that occurred. If this collection is empty,\r\nthat means no errors occurred", "type": "object", "additionalProperties": { "$ref": "#/definitions/Error" } }, "itemsCreated": { "description": "A list of the items created in the same order that was provided in the request so that the index of the\r\nitem in the list can be used as a key to match up client side items with the server side items\r\nand set the server generated properties (Id, etc.) \r\n \r\nItems that were unable to be created are returned as \"null\"", "type": "array", "items": { "$ref": "#/definitions/Activity" } } }, "additionalProperties": false }, "BulkCreateResponse[CollateralWidget]": { "description": "Contains the response of a bulk creation request", "type": "object", "properties": { "errors": { "description": "A dictionary of errors where the key of the dictionary is the index of the item in the list that\r\nwas provided in the request that had an error and the value is the error that occurred. If this collection is empty,\r\nthat means no errors occurred", "type": "object", "additionalProperties": { "$ref": "#/definitions/Error" } }, "itemsCreated": { "description": "A list of the items created in the same order that was provided in the request so that the index of the\r\nitem in the list can be used as a key to match up client side items with the server side items\r\nand set the server generated properties (Id, etc.) \r\n \r\nItems that were unable to be created are returned as \"null\"", "type": "array", "items": { "$ref": "#/definitions/CollateralWidget" } } }, "additionalProperties": false }, "BulkCreateResponse[Collateral]": { "description": "Contains the response of a bulk creation request", "type": "object", "properties": { "errors": { "description": "A dictionary of errors where the key of the dictionary is the index of the item in the list that\r\nwas provided in the request that had an error and the value is the error that occurred. If this collection is empty,\r\nthat means no errors occurred", "type": "object", "additionalProperties": { "$ref": "#/definitions/Error" } }, "itemsCreated": { "description": "A list of the items created in the same order that was provided in the request so that the index of the\r\nitem in the list can be used as a key to match up client side items with the server side items\r\nand set the server generated properties (Id, etc.) \r\n \r\nItems that were unable to be created are returned as \"null\"", "type": "array", "items": { "$ref": "#/definitions/Collateral" } } }, "additionalProperties": false }, "BulkCreateResponse[CustomerContact]": { "description": "Contains the response of a bulk creation request", "type": "object", "properties": { "errors": { "description": "A dictionary of errors where the key of the dictionary is the index of the item in the list that\r\nwas provided in the request that had an error and the value is the error that occurred. If this collection is empty,\r\nthat means no errors occurred", "type": "object", "additionalProperties": { "$ref": "#/definitions/Error" } }, "itemsCreated": { "description": "A list of the items created in the same order that was provided in the request so that the index of the\r\nitem in the list can be used as a key to match up client side items with the server side items\r\nand set the server generated properties (Id, etc.) \r\n \r\nItems that were unable to be created are returned as \"null\"", "type": "array", "items": { "$ref": "#/definitions/CustomerContact" } } }, "additionalProperties": false }, "BulkCreateResponse[Customer]": { "description": "Contains the response of a bulk creation request", "type": "object", "properties": { "errors": { "description": "A dictionary of errors where the key of the dictionary is the index of the item in the list that\r\nwas provided in the request that had an error and the value is the error that occurred. If this collection is empty,\r\nthat means no errors occurred", "type": "object", "additionalProperties": { "$ref": "#/definitions/Error" } }, "itemsCreated": { "description": "A list of the items created in the same order that was provided in the request so that the index of the\r\nitem in the list can be used as a key to match up client side items with the server side items\r\nand set the server generated properties (Id, etc.) \r\n \r\nItems that were unable to be created are returned as \"null\"", "type": "array", "items": { "$ref": "#/definitions/Customer" } } }, "additionalProperties": false }, "BulkCreateResponse[Deposit]": { "description": "Contains the response of a bulk creation request", "type": "object", "properties": { "errors": { "description": "A dictionary of errors where the key of the dictionary is the index of the item in the list that\r\nwas provided in the request that had an error and the value is the error that occurred. If this collection is empty,\r\nthat means no errors occurred", "type": "object", "additionalProperties": { "$ref": "#/definitions/Error" } }, "itemsCreated": { "description": "A list of the items created in the same order that was provided in the request so that the index of the\r\nitem in the list can be used as a key to match up client side items with the server side items\r\nand set the server generated properties (Id, etc.) \r\n \r\nItems that were unable to be created are returned as \"null\"", "type": "array", "items": { "$ref": "#/definitions/Deposit" } } }, "additionalProperties": false }, "BulkCreateResponse[Lien]": { "description": "Contains the response of a bulk creation request", "type": "object", "properties": { "errors": { "description": "A dictionary of errors where the key of the dictionary is the index of the item in the list that\r\nwas provided in the request that had an error and the value is the error that occurred. If this collection is empty,\r\nthat means no errors occurred", "type": "object", "additionalProperties": { "$ref": "#/definitions/Error" } }, "itemsCreated": { "description": "A list of the items created in the same order that was provided in the request so that the index of the\r\nitem in the list can be used as a key to match up client side items with the server side items\r\nand set the server generated properties (Id, etc.) \r\n \r\nItems that were unable to be created are returned as \"null\"", "type": "array", "items": { "$ref": "#/definitions/Lien" } } }, "additionalProperties": false }, "BulkCreateResponse[LoanApplicationPersonalInputData]": { "description": "Contains the response of a bulk creation request", "type": "object", "properties": { "errors": { "description": "A dictionary of errors where the key of the dictionary is the index of the item in the list that\r\nwas provided in the request that had an error and the value is the error that occurred. If this collection is empty,\r\nthat means no errors occurred", "type": "object", "additionalProperties": { "$ref": "#/definitions/Error" } }, "itemsCreated": { "description": "A list of the items created in the same order that was provided in the request so that the index of the\r\nitem in the list can be used as a key to match up client side items with the server side items\r\nand set the server generated properties (Id, etc.) \r\n \r\nItems that were unable to be created are returned as \"null\"", "type": "array", "items": { "$ref": "#/definitions/LoanApplicationPersonalInputData" } } }, "additionalProperties": false }, "BulkCreateResponse[Opportunity]": { "description": "Contains the response of a bulk creation request", "type": "object", "properties": { "errors": { "description": "A dictionary of errors where the key of the dictionary is the index of the item in the list that\r\nwas provided in the request that had an error and the value is the error that occurred. If this collection is empty,\r\nthat means no errors occurred", "type": "object", "additionalProperties": { "$ref": "#/definitions/Error" } }, "itemsCreated": { "description": "A list of the items created in the same order that was provided in the request so that the index of the\r\nitem in the list can be used as a key to match up client side items with the server side items\r\nand set the server generated properties (Id, etc.) \r\n \r\nItems that were unable to be created are returned as \"null\"", "type": "array", "items": { "$ref": "#/definitions/Opportunity" } } }, "additionalProperties": false }, "BulkCreateResponse[PolicyException]": { "description": "Contains the response of a bulk creation request", "type": "object", "properties": { "errors": { "description": "A dictionary of errors where the key of the dictionary is the index of the item in the list that\r\nwas provided in the request that had an error and the value is the error that occurred. If this collection is empty,\r\nthat means no errors occurred", "type": "object", "additionalProperties": { "$ref": "#/definitions/Error" } }, "itemsCreated": { "description": "A list of the items created in the same order that was provided in the request so that the index of the\r\nitem in the list can be used as a key to match up client side items with the server side items\r\nand set the server generated properties (Id, etc.) \r\n \r\nItems that were unable to be created are returned as \"null\"", "type": "array", "items": { "$ref": "#/definitions/PolicyException" } } }, "additionalProperties": false }, "BulkCreateResponse[PortfolioLoan]": { "description": "Contains the response of a bulk creation request", "type": "object", "properties": { "errors": { "description": "A dictionary of errors where the key of the dictionary is the index of the item in the list that\r\nwas provided in the request that had an error and the value is the error that occurred. If this collection is empty,\r\nthat means no errors occurred", "type": "object", "additionalProperties": { "$ref": "#/definitions/Error" } }, "itemsCreated": { "description": "A list of the items created in the same order that was provided in the request so that the index of the\r\nitem in the list can be used as a key to match up client side items with the server side items\r\nand set the server generated properties (Id, etc.) \r\n \r\nItems that were unable to be created are returned as \"null\"", "type": "array", "items": { "$ref": "#/definitions/PortfolioLoan" } } }, "additionalProperties": false }, "BulkCreateResponse[ProposedLien]": { "description": "Contains the response of a bulk creation request", "type": "object", "properties": { "errors": { "description": "A dictionary of errors where the key of the dictionary is the index of the item in the list that\r\nwas provided in the request that had an error and the value is the error that occurred. If this collection is empty,\r\nthat means no errors occurred", "type": "object", "additionalProperties": { "$ref": "#/definitions/Error" } }, "itemsCreated": { "description": "A list of the items created in the same order that was provided in the request so that the index of the\r\nitem in the list can be used as a key to match up client side items with the server side items\r\nand set the server generated properties (Id, etc.) \r\n \r\nItems that were unable to be created are returned as \"null\"", "type": "array", "items": { "$ref": "#/definitions/ProposedLien" } } }, "additionalProperties": false }, "BulkCreateResponse[ProposedLoan]": { "description": "Contains the response of a bulk creation request", "type": "object", "properties": { "errors": { "description": "A dictionary of errors where the key of the dictionary is the index of the item in the list that\r\nwas provided in the request that had an error and the value is the error that occurred. If this collection is empty,\r\nthat means no errors occurred", "type": "object", "additionalProperties": { "$ref": "#/definitions/Error" } }, "itemsCreated": { "description": "A list of the items created in the same order that was provided in the request so that the index of the\r\nitem in the list can be used as a key to match up client side items with the server side items\r\nand set the server generated properties (Id, etc.) \r\n \r\nItems that were unable to be created are returned as \"null\"", "type": "array", "items": { "$ref": "#/definitions/ProposedLoan" } } }, "additionalProperties": false }, "BulkCreateResponse[ProposedProduct]": { "description": "Contains the response of a bulk creation request", "type": "object", "properties": { "errors": { "description": "A dictionary of errors where the key of the dictionary is the index of the item in the list that\r\nwas provided in the request that had an error and the value is the error that occurred. If this collection is empty,\r\nthat means no errors occurred", "type": "object", "additionalProperties": { "$ref": "#/definitions/Error" } }, "itemsCreated": { "description": "A list of the items created in the same order that was provided in the request so that the index of the\r\nitem in the list can be used as a key to match up client side items with the server side items\r\nand set the server generated properties (Id, etc.) \r\n \r\nItems that were unable to be created are returned as \"null\"", "type": "array", "items": { "$ref": "#/definitions/ProposedProduct" } } }, "additionalProperties": false }, "BulkCreateResponse[RevenueProduct]": { "description": "Contains the response of a bulk creation request", "type": "object", "properties": { "errors": { "description": "A dictionary of errors where the key of the dictionary is the index of the item in the list that\r\nwas provided in the request that had an error and the value is the error that occurred. If this collection is empty,\r\nthat means no errors occurred", "type": "object", "additionalProperties": { "$ref": "#/definitions/Error" } }, "itemsCreated": { "description": "A list of the items created in the same order that was provided in the request so that the index of the\r\nitem in the list can be used as a key to match up client side items with the server side items\r\nand set the server generated properties (Id, etc.) \r\n \r\nItems that were unable to be created are returned as \"null\"", "type": "array", "items": { "$ref": "#/definitions/RevenueProduct" } } }, "additionalProperties": false }, "BulkUpdateRequest[CollateralWidget]": { "description": "Contains the input necessary to perform a request to update a collection of items\r\nin a single request", "type": "object", "properties": { "itemsToUpdate": { "description": "The items to be updated", "type": "array", "items": { "$ref": "#/definitions/CollateralWidget" } } }, "additionalProperties": false }, "BulkUpdateRequest[Collateral]": { "description": "Contains the input necessary to perform a request to update a collection of items\r\nin a single request", "type": "object", "properties": { "itemsToUpdate": { "description": "The items to be updated", "type": "array", "items": { "$ref": "#/definitions/Collateral" } } }, "additionalProperties": false }, "BulkUpdateRequest[CustomerContact]": { "description": "Contains the input necessary to perform a request to update a collection of items\r\nin a single request", "type": "object", "properties": { "itemsToUpdate": { "description": "The items to be updated", "type": "array", "items": { "$ref": "#/definitions/CustomerContact" } } }, "additionalProperties": false }, "BulkUpdateRequest[Customer]": { "description": "Contains the input necessary to perform a request to update a collection of items\r\nin a single request", "type": "object", "properties": { "itemsToUpdate": { "description": "The items to be updated", "type": "array", "items": { "$ref": "#/definitions/Customer" } } }, "additionalProperties": false }, "BulkUpdateRequest[Deposit]": { "description": "Contains the input necessary to perform a request to update a collection of items\r\nin a single request", "type": "object", "properties": { "itemsToUpdate": { "description": "The items to be updated", "type": "array", "items": { "$ref": "#/definitions/Deposit" } } }, "additionalProperties": false }, "BulkUpdateRequest[Lien]": { "description": "Contains the input necessary to perform a request to update a collection of items\r\nin a single request", "type": "object", "properties": { "itemsToUpdate": { "description": "The items to be updated", "type": "array", "items": { "$ref": "#/definitions/Lien" } } }, "additionalProperties": false }, "BulkUpdateRequest[LoanApplicationPersonalInputData]": { "description": "Contains the input necessary to perform a request to update a collection of items\r\nin a single request", "type": "object", "properties": { "itemsToUpdate": { "description": "The items to be updated", "type": "array", "items": { "$ref": "#/definitions/LoanApplicationPersonalInputData" } } }, "additionalProperties": false }, "BulkUpdateRequest[Opportunity]": { "description": "Contains the input necessary to perform a request to update a collection of items\r\nin a single request", "type": "object", "properties": { "itemsToUpdate": { "description": "The items to be updated", "type": "array", "items": { "$ref": "#/definitions/Opportunity" } } }, "additionalProperties": false }, "BulkUpdateRequest[PolicyException]": { "description": "Contains the input necessary to perform a request to update a collection of items\r\nin a single request", "type": "object", "properties": { "itemsToUpdate": { "description": "The items to be updated", "type": "array", "items": { "$ref": "#/definitions/PolicyException" } } }, "additionalProperties": false }, "BulkUpdateRequest[PortfolioLoan]": { "description": "Contains the input necessary to perform a request to update a collection of items\r\nin a single request", "type": "object", "properties": { "itemsToUpdate": { "description": "The items to be updated", "type": "array", "items": { "$ref": "#/definitions/PortfolioLoan" } } }, "additionalProperties": false }, "BulkUpdateRequest[ProposedLien]": { "description": "Contains the input necessary to perform a request to update a collection of items\r\nin a single request", "type": "object", "properties": { "itemsToUpdate": { "description": "The items to be updated", "type": "array", "items": { "$ref": "#/definitions/ProposedLien" } } }, "additionalProperties": false }, "BulkUpdateRequest[ProposedLoan]": { "description": "Contains the input necessary to perform a request to update a collection of items\r\nin a single request", "type": "object", "properties": { "itemsToUpdate": { "description": "The items to be updated", "type": "array", "items": { "$ref": "#/definitions/ProposedLoan" } } }, "additionalProperties": false }, "BulkUpdateRequest[ProposedProduct]": { "description": "Contains the input necessary to perform a request to update a collection of items\r\nin a single request", "type": "object", "properties": { "itemsToUpdate": { "description": "The items to be updated", "type": "array", "items": { "$ref": "#/definitions/ProposedProduct" } } }, "additionalProperties": false }, "BulkUpdateRequest[RevenueProduct]": { "description": "Contains the input necessary to perform a request to update a collection of items\r\nin a single request", "type": "object", "properties": { "itemsToUpdate": { "description": "The items to be updated", "type": "array", "items": { "$ref": "#/definitions/RevenueProduct" } } }, "additionalProperties": false }, "BulkUpdateResponse[ProposedProduct]": { "description": "Contains the response of a bulk update request", "type": "object", "properties": { "errors": { "description": "A dictionary of errors where the key of the dictionary is the index of the item in the list that\r\nwas provided in the request that had an error and the value is the error that occurred. If this collection is empty,\r\nthat means no errors occurred", "type": "object", "additionalProperties": { "$ref": "#/definitions/Error" } }, "itemsUpdated": { "description": "A list of the items updated in the same order that was provided in the request \r\n \r\nItems that were unable to be created are returned as null", "type": "array", "items": { "$ref": "#/definitions/ProposedProduct" } } }, "additionalProperties": false }, "BusinessFinancialCalculatedFields": { "description": "Calculated fields for a business financial", "type": "object", "properties": { "calculatedEndingRetainedEarnings": { "format": "double", "description": "Total of retained earnings, net income, dividends paid, and any other changes to retained earnings\r\nfor a business", "type": "number" }, "ebitda": { "format": "double", "description": "Earnings before interest, taxes, depreciation, and amortization", "type": "number" }, "grossProfit": { "format": "double", "description": "Excess of revenue after subtracting out cost of sales", "type": "number" }, "id": { "format": "int32", "description": "ID of the business financial", "type": "integer" }, "netFixedAssets": { "format": "double", "description": "The value of your fixed assets after having accounted for depreciation.", "type": "number" }, "netIncome": { "format": "double", "description": "Sales minus any and all expenses of the company", "type": "number" }, "netIntangibleAssets": { "format": "double", "description": "The value of your intangible assets after accounting for amortization.", "type": "number" }, "netProfitBeforeTaxes": { "format": "double", "description": "Company profit for the period before income taxes are paid", "type": "number" }, "operatingProfit": { "format": "double", "description": "Income or loss from normal business operations before tax", "type": "number" }, "tangibleNetWorth": { "format": "double", "description": "The value of the business excluding intangible assets.", "type": "number" }, "totalAssets": { "format": "double", "description": "The full total of all assets", "type": "number" }, "totalAssetsMinusLiabilitiesPlusEquity": { "format": "double", "description": "Total Assets minus (Liabilities plus Total Equity). If this amount equals zero, then the balance sheet\r\nreconciles.", "type": "number" }, "totalCurrentAssets": { "format": "double", "description": "The total of cash, marketable securities, accounts receivable, inventory, prepaid expenses, and any other\r\nasset the company owns that can reasonably be expected to convert to cash within approximately one year.", "type": "number" }, "totalCurrentLiabilities": { "format": "double", "description": "Most Balance Sheets make a distinction between current and long-term liabilities. In cases where the\r\ndistinction is not made, include the total of accounts payable, short-term notes payable, payroll taxes\r\npayable, and any other liability that would typically be paid by the company within one year.", "type": "number" }, "totalEquity": { "format": "double", "description": "All retained earnings, treasury stock, additional paid-in capital, and original investments in the company.", "type": "number" }, "totalLiabilities": { "format": "double", "description": "All amounts owed by the company as of the Balance Sheet date in question.", "type": "number" }, "totalLiabilitiesPlusEquity": { "format": "double", "description": "Total Liabilities plus Total Equity. This amount equals Total Assets if the Balance Sheet is in balance.", "type": "number" }, "totalLongTermLiabilities": { "format": "double", "description": "The firm's liabilities that will not need to be paid back for at least one year.", "type": "number" }, "totalOperatingExpenses": { "format": "double", "description": "Total recurring expenses and costs associated with the day to day activities", "type": "number" }, "unadjustedEbitda": { "format": "double", "description": "EBITDA before adjustments made", "type": "number" }, "unexplainedRetainedEarnings": { "format": "double", "description": "Difference between the calculated ending retained earnings and Balance Sheet ending retained earnings", "type": "number" } }, "additionalProperties": false }, "BusinessFinancialV2": { "description": "Financial model for a business", "type": "object", "properties": { "accountingFirm": { "description": "The entity for accounting", "type": "string" }, "accountingMethod": { "description": "Identifies whether this data is based off the accrual method of accounting or the cash method of accounting.", "enum": [ "accrualMethod", "cashMethod", "modifiedCashBasis", "taxBasis", "other" ], "type": "string", "x-nullable": true }, "accountsPayable": { "format": "double", "description": "Amounts owed to vendors", "type": "number" }, "accountsReceivable": { "format": "double", "description": "All amounts owed by customers to the company", "type": "number" }, "accumulatedAmortization": { "format": "double", "description": "Amount of amortization expense the entity has recognized for intangible assets on the books", "type": "number" }, "accumulatedDepreciation": { "format": "double", "description": "Total amount of depreciation accumulated by the business since the start of operations", "type": "number" }, "additionalPaidInCapital": { "format": "double", "description": "Difference between the par value of the stock issued to owners and the total cash contributed in exchange for the issued stock", "type": "number" }, "amortization": { "format": "double", "description": "An estimate for the amount by which an intangible asset category has decreased in value over a certain period of time (rounds to the nearest whole number)", "type": "number" }, "balanceSheetAdditionalFields": { "description": "Any additional user defined fields for the balance sheet", "type": "object", "additionalProperties": { "type": "string" } }, "balanceSheetComments": { "description": "Any additional comments about the balance sheet", "type": "string" }, "beginningRetainedEarnings": { "format": "double", "description": "Retained earnings balance at the beginning of the period being analyzed", "type": "number" }, "cash": { "format": "double", "description": "All monies in cash, checking, and money market accounts", "type": "number" }, "cogsDepreciation": { "format": "double", "description": "Includes all depreciation related expenses directly associated with cost of sales, but not other depreciation", "type": "number" }, "commonStock": { "format": "double", "description": "Security which represents ownership in a corporation and which normally carries voting privileges", "type": "number" }, "contingentLiabilities": { "format": "double", "description": "Any operating leases, pension obligations, purchase commitments, contingent liabilities and all other contractual obligations", "type": "number" }, "costOfSales": { "format": "double", "description": "Includes inventory, direct labor, material and other costs for the company", "type": "number" }, "currentPortionOfLongTermDebt": { "format": "double", "description": "Portion of Long Term Liabilities being paid off within 12 months of financial statement date (notes payable that have a maturity of less than one year)", "type": "number" }, "customerId": { "format": "int32", "description": "The ID of the customer that this financial data is for", "type": "integer" }, "dataPreparedBy": { "description": "The person who is responsible for preparing the financials", "type": "string" }, "dataSource": { "description": "The source of the information being entered", "enum": [ "annualized", "audit", "companyPrepared", "compilation", "financialStatement", "projection", "merged", "other", "review", "sample", "taxReturn", "trailing12Months", "average", "projection2", "projection3", "projection4", "projection5", "consolidation" ], "type": "string", "x-nullable": true }, "depreciation": { "format": "double", "description": "All depreciation expenses of the company. Does not include depreciation already included in the Depreciation (COGS-related) account (rounds to the nearest whole number)", "type": "number" }, "description": { "description": "The description of the financial", "type": "string" }, "dividendsPaid": { "format": "double", "description": "Amount of any distributions made to the company's shareholders / owners", "type": "number" }, "ebitdaAdjustments": { "format": "double", "description": "Earnings before Interest, Taxes, Depreciation, and Amortization for the entity", "type": "number", "x-nullable": true }, "endingRetainedEarnings": { "format": "double", "description": "All profits that the company has earned and re-invested in itself for the dates in question", "type": "number" }, "extraordinaryGain": { "format": "double", "description": "Any income generated by the company outside of normal operations that is neither regular nor recurring", "type": "number" }, "extraordinaryLoss": { "format": "double", "description": "Any non-operating expenses incurred by the company that are neither regular nor recurring", "type": "number" }, "financialStatementFullFormat": { "description": "Is this a \"full format\" financial or a \"quick financial\"", "type": "boolean" }, "formulas": { "description": "Mathematic expressions for field values that are formulas", "type": "array", "items": { "$ref": "#/definitions/DataFieldFormula" } }, "grossFixedAssets": { "format": "double", "description": "Amount for gross fixed assets or the value for Plant, Property, and Equipment before depreciation is subtracted", "type": "number" }, "grossIntangibleAssets": { "format": "double", "description": "Intellectual property or other \"soft assets\" that have a useful life but are not fixed assets", "type": "number" }, "id": { "format": "int32", "description": "The ID of the financial data in Sageworks", "type": "integer" }, "incomeStatementAdditionalFields": { "description": "Any additional user defined fields for the income statement", "type": "object", "additionalProperties": { "type": "string" } }, "incomeStatementComments": { "description": "Comments on the income statement", "type": "string" }, "interestExpenses": { "format": "double", "description": "How much money was paid in interest", "type": "number" }, "inventory": { "format": "double", "description": "Value of all items available for resale to customers (Direct labor included if included in calculation of inventory cost)", "type": "number" }, "netIntangibleAssets": { "format": "double", "description": "The company's net intangible assets", "type": "number" }, "nonItemizedDebtService": { "format": "double", "description": "Annual debt service payment for debt responsibilities that are not itemized", "type": "number", "x-nullable": true }, "otherAdditionalFields": { "description": "Any other additional user defined fields", "type": "object", "additionalProperties": { "type": "string" } }, "otherAnnualDebtService": { "format": "double", "description": "This is the annual debt service payment for debt responsibilities that are not itemized. You may enter an annual debt service amount here if you do not have information about some or all of the loans.", "type": "number", "x-nullable": true }, "otherAssets": { "format": "double", "description": "Value of all of the company's assets not covered in Current or Gross Fixed asset accounts", "type": "number" }, "otherCurrentAssets": { "format": "double", "description": "Value of all of the company's current assets not included in Cash, Accounts Receivable, or Inventory", "type": "number" }, "otherCurrentLiabilities": { "format": "double", "description": "Value of all of the company's liabilities that are due in the next year", "type": "number" }, "otherExpenses": { "format": "double", "description": "How much money was paid in others", "type": "number" }, "otherIncome": { "format": "double", "description": "Any regular and recurring income generated by the company not included in other fields", "type": "number" }, "otherLongTermLiabilities": { "format": "double", "description": "Any Other Long Term Liabilities that would not be considered either Senior or Subordinated Debt (Ex: deferred taxes and the long term portion of a capital lease)", "type": "number" }, "otherOperatingExpenses": { "format": "double", "description": "How much money was paid in other operating fields", "type": "number" }, "otherOperatingIncome": { "format": "double", "description": "Any operating income not already accounted for", "type": "number" }, "otherRetainedEarnings": { "format": "double", "description": "Any changes to retained earnings not already accounted for", "type": "number" }, "otherStockAndEquity": { "format": "double", "description": "Any stock or other equity amounts, excluding retained earnings", "type": "number" }, "overhead": { "format": "double", "description": "Costs of day-to-day operations, also includes costs that were not covered by Costs of Sales", "type": "number" }, "periodDuration": { "format": "int32", "description": "The length (in months) of the period in question", "type": "integer" }, "periodEndDate": { "format": "Date", "description": "The date that the period in question ended", "type": "string", "x-nullable": true }, "portionOfNonItemizedDebtToBeRefinanced": { "format": "double", "description": "Portion of other debt service to be refinanced in the calculation of proposed debt service and proposed debt service coverage ratio", "type": "number" }, "preferredStock": { "format": "double", "description": "Provides the shareholder with preferential payment of dividends but does not carry voting rights", "type": "number" }, "preventRealEstateToIncome": { "description": "If set to true then Prevent mapping Real Estate Investment data to Income Statement", "type": "boolean" }, "refinancedOtherDebtService": { "format": "double", "description": "This is the portion of the other debt service to be refinanced and included in the calculation of proposed debt service and proposed debt service coverage ratio.", "type": "number" }, "sales": { "format": "double", "description": "All sales and revenues for the company", "type": "number" }, "seniorDebt": { "format": "double", "description": "Debt which has seniority or preference in case of a default or bankruptcy", "type": "number" }, "shortTermDebt": { "format": "double", "description": "Outstanding balance of any short term debt owed by the company (lines of credit, short term operating loans, etc.)", "type": "number" }, "specifyLoanInformation": { "description": "Whether loans are specified", "type": "boolean" }, "specifyRealEstateInvestments": { "description": "Whether real estate investments are specified", "type": "boolean" }, "statementOfEquityAdditionalFields": { "description": "Any additional user defined fields for the statement of equity", "type": "object", "additionalProperties": { "type": "string" } }, "statementOfEquityComments": { "description": "Any additional comments about the statement of equity", "type": "string" }, "subordinatedDebt": { "format": "double", "description": "Liabilities that are subordinate or have less preference in case of a default or bankruptcy", "type": "number" }, "taxesPaid": { "format": "double", "description": "The amount of taxes paid by the entity on its most recent tax filing corresponding to the period length being analyzed (rounds to the nearest whole number)", "type": "number" }, "taxForm": { "description": "The type of tax form", "type": "string" }, "taxYear": { "format": "int32", "description": "Tax return year", "type": "integer", "x-nullable": true } }, "additionalProperties": false }, "ClassicLoanApplicationCreateRequest": { "description": "A classic loan application request", "type": "object", "properties": { "customerLoanRoles": { "description": "Customer Ids / Loan Role", "type": "array", "items": { "$ref": "#/definitions/CustomerLoanRole" } }, "loanApplicationOrigin": { "format": "string", "description": "Loan Application Origin", "enum": [ "unknown", "web", "internal", "salesforce" ], "type": "string" }, "loanApplicationType": { "format": "string", "description": "Loan Application Type", "enum": [ "business", "personal", "sba", "nonprofit", "farm" ], "type": "string" }, "loanOfficerId": { "format": "int64", "description": "Loan Officer Id", "type": "integer", "x-nullable": true }, "proposedLoanId": { "format": "int64", "description": "Proposed Loan Id", "type": "integer", "x-nullable": true } }, "additionalProperties": false }, "Collateral": { "description": "Collateral used to back a loan", "required": [ "customerId", "description" ], "type": "object", "properties": { "accountLOCNumber": { "description": "Account/LOC Number of the collateral", "type": "string" }, "aircraftNumber": { "description": "Aircraft Number of the collateral", "type": "string" }, "beneficiary": { "description": "Beneficiary of the collateral", "type": "string" }, "bodyStyle": { "description": "Body/Style of the collateral vehicle", "type": "string" }, "capitalizationRate": { "format": "double", "description": "Capitalization Rate of the collateral", "type": "number" }, "cbraAndOPADesignationDate": { "format": "Date", "description": "CBRA and OPA Designation Date of the collateral", "type": "string", "x-nullable": true }, "collateralBreakout": { "description": "Collateral Breakout", "type": "string" }, "collateralCode": { "description": "A code indicating the type of collateral", "type": "string" }, "collateralIdentifier": { "description": "Identifier of the collateral - READ ONLY", "type": "string" }, "collateralMetadataType": { "format": "string", "description": "The type of this collateral. Ex: proposed, existing, archive, etc.\r\n \r\nWhen creating a new collateral, field can only be set to proposed or existing. Value cannot be updated once it is set.", "enum": [ "existing", "proposed", "savedCopy", "archive" ], "type": "string" }, "collateralType": { "description": "The type of collateral (ex: equipment, land, etc.)", "type": "string" }, "comments": { "description": "Comments for the collateral", "type": "string" }, "constructionMethod": { "description": "Construction Method of collateral", "enum": [ "siteBuilt", "manufacturedHome", "other" ], "type": "string", "x-nullable": true }, "coOwnerCustomerIds": { "description": "Co-Owners for the collateral", "type": "array", "items": { "format": "int64", "type": "integer" } }, "countyCode": { "description": "County Code for collateral location\r\nRead only if Geocodio is enabled", "type": "string" }, "currentValue": { "format": "double", "description": "The current value of the collateral, this value is autocalculated and therefore ignored on POST and PATCH requests", "type": "number" }, "cusip": { "description": "CUSIP of the collateral", "type": "string" }, "customerId": { "format": "int32", "description": "Id of the customer that is pledging the collateral", "type": "integer" }, "dateAppraisalRequested": { "format": "Date", "description": "The date the appraisal was requested for this collateral", "type": "string", "x-nullable": true }, "description": { "description": "Description of the collateral", "minLength": 1, "type": "string" }, "discountRate": { "format": "double", "description": "Percentage used to \"discount\" or adjust the current value for this piece of collateral", "type": "number" }, "dwelling": { "description": "Dwelling type of collateral", "enum": [ "principal", "secondary", "none" ], "type": "string", "x-nullable": true }, "equipmentManufacturer": { "description": "The manufacturer of the equipment", "type": "string" }, "equipmentYear": { "description": "The year of the equipment", "type": "string" }, "floodDeterminationDate": { "format": "Date", "description": "Flood determination date of the collateral", "type": "string", "x-nullable": true }, "floodProgramType": { "description": "Is Flood Program Type", "type": "boolean", "x-nullable": true }, "floodZone": { "description": "Flood Zone of Collateral", "enum": [ "a", "v", "other", "ao", "ah", "a1A30", "ae", "a99", "ar", "arae", "arao", "arA1A30", "ara", "ve", "v1V30", "b", "x", "c", "d" ], "type": "string", "x-nullable": true }, "floodZoneCode": { "description": "Flood Zone Code of Collateral", "type": "string" }, "govtContractDate": { "format": "Date", "description": "Govt Contract Date of the collateral", "type": "string", "x-nullable": true }, "govtContractNumber": { "description": "Govt Contract Number of the collateral", "type": "string" }, "heldBy": { "description": "Held By for the collateral", "enum": [ "none", "lender", "other" ], "type": "string", "x-nullable": true }, "id": { "format": "int32", "description": "The id of the collateral in Sageworks", "type": "integer" }, "includeInProposedScenario": { "description": "Include existing collateral in proposed scenario", "type": "boolean", "x-nullable": true }, "isDeleted": { "description": "Indicates if the collateral has been deleted", "type": "boolean" }, "isForAgriculturalPurpose": { "description": "Whether collateral is for agricultural purpose", "type": "boolean", "x-nullable": true }, "isLandImprovements": { "description": "Is Land Improvements", "type": "boolean", "x-nullable": true }, "isLOMC": { "description": "Whether collateral is LOMC", "type": "boolean", "x-nullable": true }, "isOwnerOccupied": { "description": "Whether collateral is owner occupied", "type": "boolean", "x-nullable": true }, "isProtectedArea": { "description": "Whether collateral is in a protected area", "type": "boolean", "x-nullable": true }, "isReadyForAppraisal": { "description": "Is this collateral ready for appraisal?", "type": "boolean", "x-nullable": true }, "isSecondHome": { "description": "Whether collateral is a second home", "type": "boolean", "x-nullable": true }, "issuedBy": { "description": "Collateral issued by", "enum": [ "none", "lender", "other" ], "type": "string", "x-nullable": true }, "issuer": { "description": "Issuer of the collateral", "type": "string" }, "latitude": { "format": "double", "description": "Latitude of collateral location\r\nRead only if Geocodio is enabled", "type": "number", "x-nullable": true }, "legalDescription": { "description": "Legal description of the collateral", "type": "string" }, "letterOfCreditDate": { "format": "Date", "description": "Letter of Credit Date of the collateral", "type": "string", "x-nullable": true }, "lomcCaseNumber": { "description": "LOMC Case Number", "type": "string" }, "lomcDate": { "format": "Date", "description": "LOMC Date", "type": "string", "x-nullable": true }, "longitude": { "format": "double", "description": "Longitude of collateral location\r\nRead only if Geocodio is enabled", "type": "number", "x-nullable": true }, "make": { "description": "Make of the collateral vehicle", "type": "string" }, "manufacturedHomeLandPropertyInterest": { "description": "Manufactured Home Land Property Interest of collateral", "enum": [ "directOwnership", "indirectOwnership", "paidLeasehold", "unpaidLeasehold", "notApplicable" ], "type": "string", "x-nullable": true }, "manufacturedHomeType": { "description": "Manufactured Home Type of collateral", "enum": [ "manufacturedHomeAndLand", "manufacturedHomeAndNotLand", "notApplicable" ], "type": "string", "x-nullable": true }, "manufacturer": { "description": "Manufacturer of the collateral", "type": "string" }, "medianHouseholdIncome": { "format": "double", "description": "Median Household Income for collateral location\r\nRead only if Geocodio is enabled", "type": "number", "x-nullable": true }, "metropolitanDivision": { "description": "Metropolitan Division of collateral location\r\nRead only if Geocodio is enabled", "type": "string" }, "metropolitanDivisionCode": { "description": "Metropolitan Division Code of collateral location\r\nRead only if Geocodio is enabled", "type": "string" }, "metropolitanStatisticalArea": { "format": "int32", "description": "Metropolitan Statistical Area for collateral location\r\nRead only if Geocodio is enabled", "type": "integer", "x-nullable": true }, "mileage": { "format": "double", "description": "The mileage of the vehicle", "type": "number", "x-nullable": true }, "model": { "description": "Model of the collateral vehicle", "type": "string" }, "mostRecentAppraisalDate": { "format": "Date", "description": "The date of the most recent appraisal for this collateral", "type": "string", "x-nullable": true }, "mostRecentAppraisalValue": { "format": "double", "description": "The value of the most recent appraisal for this collateral", "type": "number" }, "multiFamilyAffordableUnits": { "description": "Multi family affordable units of collateral", "type": "string" }, "nfipCommunityName": { "description": "NFIP Community Name", "type": "string" }, "nfipCommunityNumber": { "description": "NFIP Community Number", "type": "string" }, "nfipMapNumber": { "description": "NFIP Map Number", "type": "string" }, "nfipMapPanelDate": { "format": "Date", "description": "NFIP Panel Date", "type": "string", "x-nullable": true }, "nfipPropertyDescription": { "description": "NFIP Property Description", "type": "string" }, "occupancyType": { "description": "Occupancy type of collateral", "enum": [ "principalResidence", "secondResidence", "investmentProperty" ], "type": "string", "x-nullable": true }, "originalValue": { "format": "double", "description": "The original value of the collateral", "type": "number" }, "possessoryType": { "description": "Possessory Type of the collateral", "enum": [ "allAccounts", "cd", "savings", "checking", "stock", "bond", "mutualFund", "warehouseReceipts", "billsOfLading", "bothReceiptsAndBills", "revocableLetterOfCredit", "irrevocableLetterOfCredit", "wholeLife", "termLife", "creditLife" ], "type": "string", "x-nullable": true }, "propertyAddress": { "description": "Property Address of the collateral", "type": "string" }, "propertyCity": { "description": "Property City of the collateral", "type": "string" }, "propertyCounty": { "description": "Property County of the collateral", "type": "string" }, "propertyState": { "description": "Property State of the collateral", "type": "string" }, "propertyTaxID": { "description": "Property Tax ID of the collateral", "type": "string" }, "propertyZip": { "description": "Property Zip of the collateral", "type": "string" }, "proposedAdjustmentComments": { "description": "Comments for proposed adjustment", "type": "string" }, "proposedCurrentValue": { "format": "double", "description": "ProposedCurrentValue", "type": "number" }, "proposedValueAdjustment": { "format": "double", "description": "ProposedValueAdjustment", "type": "number" }, "serialNumber": { "description": "Serial Number of the collateral", "type": "string" }, "shares": { "format": "int32", "description": "Shares of the collateral", "type": "integer", "x-nullable": true }, "source": { "description": "Source of the collateral", "type": "string" }, "specialFloodHazardArea": { "format": "int32", "description": "Indicates whether the collateral is in a flood zone", "type": "integer", "x-nullable": true }, "stateCode": { "format": "int32", "description": "State Code for collateral location\r\nRead only if Geocodio is enabled", "type": "integer", "x-nullable": true }, "titledType": { "format": "string", "description": "Indicates whether the collateral is titled", "enum": [ "unknown", "titled", "untitled" ], "type": "string" }, "totalUnits": { "format": "int32", "description": "Total Units of collateral", "type": "integer", "x-nullable": true }, "tractCode": { "description": "Tract Code for collateral location\r\nRead only if Geocodio is enabled", "type": "string" }, "userDefinedFields": { "description": "User defined collateral fields", "type": "object", "additionalProperties": { "type": "string" } }, "vesselLength": { "format": "int32", "description": "Vessel Length of collateral", "type": "integer", "x-nullable": true }, "vesselName": { "description": "Vessel Name of the collateral", "type": "string" }, "vesselNumber": { "description": "Vessel Number of the collateral", "type": "string" }, "vin": { "description": "VIN of the collateral vehicle", "type": "string" }, "year": { "description": "Year of the collateral vehicle", "type": "string" } }, "additionalProperties": false }, "CollateralBasicInformation": { "description": "A collateral with just the basic information", "type": "object", "properties": { "collateralCode": { "description": "A code indicating the type of collateral", "type": "string" }, "collateralIdentifier": { "description": "Identifier of the collateral", "type": "string" }, "collateralType": { "description": "The type of collateral (ex: equipment, land, etc.)", "type": "string" }, "customerId": { "format": "int32", "description": "Id of the customer that is pledging the collateral", "type": "integer" }, "description": { "description": "Description of the collateral", "type": "string" }, "id": { "format": "int32", "description": "The id of the collateral in Sageworks", "type": "integer" }, "isDeleted": { "description": "Indicates if the collateral has been deleted", "type": "boolean" } }, "additionalProperties": false }, "CollateralWidget": { "type": "object", "properties": { "id": { "format": "int32", "description": "The id of the lien in Sageworks", "type": "integer" }, "name": { "description": "The name of the Collateral Widget", "type": "string" }, "nonRequiredFields": { "description": "The list of non required fields for the Collateral Widget", "type": "array", "items": { "$ref": "#/definitions/CollateralWidgetField" } }, "requiredFields": { "description": "The list of required fields for the Collateral Widget", "type": "array", "items": { "$ref": "#/definitions/CollateralWidgetField" } }, "statusUserDefinedFieldName": { "description": "The name of the user defined field that contains the status of the Collateral Widget", "type": "string" } }, "additionalProperties": false }, "CollateralWidgetAvailableFields": { "type": "object", "properties": { "fields": { "description": "The list of available fields for Collateral Widgets", "type": "array", "items": { "$ref": "#/definitions/CollateralWidgetField" } } }, "additionalProperties": false }, "CollateralWidgetField": { "type": "object", "properties": { "fieldName": { "description": "The name of the Collateral Widget field", "type": "string" }, "fieldType": { "description": "The type of the Collateral Widget field", "type": "string" }, "isCalculated": { "description": "Indicates whether the field is calculated", "type": "boolean" }, "isDisabled": { "description": "Indicates whether the field is disabled", "type": "boolean" }, "isReadOnly": { "description": "Indicates whether the field is read-only", "type": "boolean" }, "options": { "description": "The dropdown options for the field (if applicable)", "type": "array", "items": { "$ref": "#/definitions/SelectOptionModel" } } }, "additionalProperties": false }, "CollateralWidgetOrderRequest": { "description": "Request model for ordering a collateral widget", "type": "object", "properties": { "collateralId": { "format": "int32", "description": "The id of the collateral", "type": "integer" }, "collateralWidgetId": { "format": "int32", "description": "The id of the collateral widget to order", "type": "integer" }, "isProposedLoan": { "description": "Indicates whether the loan is a proposed loan", "type": "boolean" }, "loansID": { "format": "int32", "description": "The id of the loan", "type": "integer" }, "ordererCustomerId": { "format": "int32", "description": "The id of the customer (company, person, farm, or nonprofit) placing the order", "type": "integer" } }, "additionalProperties": false }, "CollateralWidgetStatus": { "description": "The status of the collateral widget for a collateral", "type": "object", "properties": { "status": { "description": "The status of the collateral widget for a collateral.\r\nHyperlinks within the widget status, must have the following pattern: [DisplayName|Url]", "type": "string" } }, "additionalProperties": false }, "CollectionResponse[Activity]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/Activity" } } }, "additionalProperties": false }, "CollectionResponse[AdobeAgreementProposedLoanMapping]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/AdobeAgreementProposedLoanMapping" } } }, "additionalProperties": false }, "CollectionResponse[BankCode]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/BankCode" } } }, "additionalProperties": false }, "CollectionResponse[BankCustomerUserWithProfitEntity]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/BankCustomerUserWithProfitEntity" } } }, "additionalProperties": false }, "CollectionResponse[BeneficialOwner]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/BeneficialOwner" } } }, "additionalProperties": false }, "CollectionResponse[BusinessFinancialV2]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/BusinessFinancialV2" } } }, "additionalProperties": false }, "CollectionResponse[CollateralBasicInformation]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/CollateralBasicInformation" } } }, "additionalProperties": false }, "CollectionResponse[CollateralWidget]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/CollateralWidget" } } }, "additionalProperties": false }, "CollectionResponse[Collateral]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/Collateral" } } }, "additionalProperties": false }, "CollectionResponse[CovenantCompliantStatus]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/CovenantCompliantStatus" } } }, "additionalProperties": false }, "CollectionResponse[Covenant]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/Covenant" } } }, "additionalProperties": false }, "CollectionResponse[CustomerBasicInformation]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/CustomerBasicInformation" } } }, "additionalProperties": false }, "CollectionResponse[CustomerContact]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/CustomerContact" } } }, "additionalProperties": false }, "CollectionResponse[CustomerWidget]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/CustomerWidget" } } }, "additionalProperties": false }, "CollectionResponse[Customer]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/Customer" } } }, "additionalProperties": false }, "CollectionResponse[DataFieldOption]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/DataFieldOption" } } }, "additionalProperties": false }, "CollectionResponse[Deposit]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/Deposit" } } }, "additionalProperties": false }, "CollectionResponse[DocumentAssociation]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/DocumentAssociation" } } }, "additionalProperties": false }, "CollectionResponse[DocumentFolder]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/DocumentFolder" } } }, "additionalProperties": false }, "CollectionResponse[Document]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/Document" } } }, "additionalProperties": false }, "CollectionResponse[EntityGroupSummary]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/EntityGroupSummary" } } }, "additionalProperties": false }, "CollectionResponse[Entity]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/Entity" } } }, "additionalProperties": false }, "CollectionResponse[Event]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/Event" } } }, "additionalProperties": false }, "CollectionResponse[FinancialInfoExtractBusinessFinancialInformationV2]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/FinancialInfoExtractBusinessFinancialInformationV2" } } }, "additionalProperties": false }, "CollectionResponse[FinancialInfoExtractBusinessFinancialInformation]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/FinancialInfoExtractBusinessFinancialInformation" } } }, "additionalProperties": false }, "CollectionResponse[FinancialInfoExtractNonProfitFinancialInformationV2]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/FinancialInfoExtractNonProfitFinancialInformationV2" } } }, "additionalProperties": false }, "CollectionResponse[FinancialInfoExtractNonProfitFinancialInformation]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/FinancialInfoExtractNonProfitFinancialInformation" } } }, "additionalProperties": false }, "CollectionResponse[FinancialInfoExtractPersonalFinancialInformationV2]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/FinancialInfoExtractPersonalFinancialInformationV2" } } }, "additionalProperties": false }, "CollectionResponse[FinancialInfoExtractPersonalFinancialInformation]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/FinancialInfoExtractPersonalFinancialInformation" } } }, "additionalProperties": false }, "CollectionResponse[Lien]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/Lien" } } }, "additionalProperties": false }, "CollectionResponse[LoanApplicationPersonalInputData]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/LoanApplicationPersonalInputData" } } }, "additionalProperties": false }, "CollectionResponse[LoanApplicationProposedLoanMapping]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/LoanApplicationProposedLoanMapping" } } }, "additionalProperties": false }, "CollectionResponse[LoanApplication]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/LoanApplication" } } }, "additionalProperties": false }, "CollectionResponse[LoanOfficer]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/LoanOfficer" } } }, "additionalProperties": false }, "CollectionResponse[LoanOrigination]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/LoanOrigination" } } }, "additionalProperties": false }, "CollectionResponse[LoanRole]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/LoanRole" } } }, "additionalProperties": false }, "CollectionResponse[LoanSegment]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/LoanSegment" } } }, "additionalProperties": false }, "CollectionResponse[Opportunity]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/Opportunity" } } }, "additionalProperties": false }, "CollectionResponse[PolicyExceptionStatus]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/PolicyExceptionStatus" } } }, "additionalProperties": false }, "CollectionResponse[PolicyExceptionType]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/PolicyExceptionType" } } }, "additionalProperties": false }, "CollectionResponse[PolicyException]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/PolicyException" } } }, "additionalProperties": false }, "CollectionResponse[PortfolioLoanBasicInformation]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/PortfolioLoanBasicInformation" } } }, "additionalProperties": false }, "CollectionResponse[PortfolioLoanTakedownDetailResponse]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/PortfolioLoanTakedownDetailResponse" } } }, "additionalProperties": false }, "CollectionResponse[PortfolioLoan]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/PortfolioLoan" } } }, "additionalProperties": false }, "CollectionResponse[ProposedDepositStage]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/ProposedDepositStage" } } }, "additionalProperties": false }, "CollectionResponse[ProposedDeposit]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/ProposedDeposit" } } }, "additionalProperties": false }, "CollectionResponse[ProposedLien]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/ProposedLien" } } }, "additionalProperties": false }, "CollectionResponse[ProposedLoanBasicInformation]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/ProposedLoanBasicInformation" } } }, "additionalProperties": false }, "CollectionResponse[ProposedLoanStage]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/ProposedLoanStage" } } }, "additionalProperties": false }, "CollectionResponse[ProposedLoan]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/ProposedLoan" } } }, "additionalProperties": false }, "CollectionResponse[ProposedProduct]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/ProposedProduct" } } }, "additionalProperties": false }, "CollectionResponse[ProposedSBALoanDetails]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/ProposedSBALoanDetails" } } }, "additionalProperties": false }, "CollectionResponse[RefinanceScenarioFinancialStatementOption]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/RefinanceScenarioFinancialStatementOption" } } }, "additionalProperties": false }, "CollectionResponse[RelatedLoanRole]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/RelatedLoanRole" } } }, "additionalProperties": false }, "CollectionResponse[RevenueProduct]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/RevenueProduct" } } }, "additionalProperties": false }, "CollectionResponse[RiskRatingCalculation]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/RiskRatingCalculation" } } }, "additionalProperties": false }, "CollectionResponse[SBAExportData]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/SBAExportData" } } }, "additionalProperties": false }, "CollectionResponse[SbaForm]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/SbaForm" } } }, "additionalProperties": false }, "CollectionResponse[State]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/State" } } }, "additionalProperties": false }, "CollectionResponse[TicklerLoanMapping]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/TicklerLoanMapping" } } }, "additionalProperties": false }, "CollectionResponse[TicklerRequest]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/TicklerRequest" } } }, "additionalProperties": false }, "CollectionResponse[TicklerV2]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/TicklerV2" } } }, "additionalProperties": false }, "CollectionResponse[Tickler]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/Tickler" } } }, "additionalProperties": false }, "CollectionResponse[UserRoleMapping]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/UserRoleMapping" } } }, "additionalProperties": false }, "CollectionResponse[UserRole]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/UserRole" } } }, "additionalProperties": false }, "CollectionResponse[User]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/User" } } }, "additionalProperties": false }, "CollectionResponse[WorkflowLoanMapping]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/WorkflowLoanMapping" } } }, "additionalProperties": false }, "CollectionResponse[WorkflowPhase]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/WorkflowPhase" } } }, "additionalProperties": false }, "CollectionResponse[WorkflowReasonOptionMapping]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/WorkflowReasonOptionMapping" } } }, "additionalProperties": false }, "CollectionResponse[WorkflowReasonOption]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/WorkflowReasonOption" } } }, "additionalProperties": false }, "CollectionResponse[WorkflowRoleUserSetting]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/WorkflowRoleUserSetting" } } }, "additionalProperties": false }, "CollectionResponse[WorkflowStepListItem]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/WorkflowStepListItem" } } }, "additionalProperties": false }, "CollectionResponse[WorkflowStepOwnerMapping]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/WorkflowStepOwnerMapping" } } }, "additionalProperties": false }, "CollectionResponse[WorkflowStepOwnerRole]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/WorkflowStepOwnerRole" } } }, "additionalProperties": false }, "CollectionResponse[WorkflowStep]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/WorkflowStep" } } }, "additionalProperties": false }, "CollectionResponse[WorkflowTemplatePhase]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/WorkflowTemplatePhase" } } }, "additionalProperties": false }, "CollectionResponse[WorkflowTemplate]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/WorkflowTemplate" } } }, "additionalProperties": false }, "CollectionResponse[Workflow]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/Workflow" } } }, "additionalProperties": false }, "Covenant": { "description": "Represents a Covenant in Sageworks", "type": "object", "properties": { "comments": { "description": "Comments related to the covenant", "type": "string" }, "comparison": { "format": "string", "description": "Comparison between the covenant's ExpectedValue and CurrentValue required for the covenant to be compliant", "enum": [ "greaterThan", "greaterThanOrEqual", "lessThan", "lessThanOrEqual", "na" ], "type": "string" }, "covenantCompliantStatusId": { "format": "int32", "description": "The id of the organization specific Covenant Compliant Status which includes the description and whether\r\nthis status is compliant", "type": "integer" }, "covenantName": { "description": "The name of the type of covenant", "type": "string" }, "currentValue": { "format": "double", "description": "The actual value of the covenant", "type": "number" }, "customerId": { "format": "int32", "description": "Id of the customer or group in Sageworks that this covenant is attached to", "type": "integer" }, "definition": { "description": "Definition or description of the covenant", "type": "string" }, "disabledByUserName": { "description": "The full name of the user who manually disabled/closed the covenant", "type": "string" }, "disabledDate": { "format": "Date", "description": "The date when the covenant was disabled/closed", "type": "string", "x-nullable": true }, "expectedValue": { "format": "double", "description": "The threshold that the covenant must be above or below to be compliant", "type": "number" }, "id": { "format": "int32", "description": "Id of the covenant in Sageworks", "type": "integer" }, "isDisabled": { "description": "Whether the covenant is disabled/closed", "type": "boolean" }, "monitoringFrequency": { "format": "int32", "description": "The value of the Monitoring Frequency represented in months", "type": "integer" }, "nextMonitoringDate": { "format": "Date", "description": "The next monitoring date", "type": "string", "x-nullable": true }, "nextValueDate": { "format": "Date", "description": "The next date where the value of the covenant needs to be calculated / determined", "type": "string", "x-nullable": true }, "personResponsibleId": { "format": "int32", "description": "The ID of the user responsible for monitoring this covenant", "type": "integer", "x-nullable": true }, "portfolioLoanId": { "format": "int32", "description": "The loan that the covenant applies to", "type": "integer", "x-nullable": true }, "valueDate": { "format": "Date", "description": "The date on which the current value of the covenant was calculated / determined", "type": "string", "x-nullable": true } }, "additionalProperties": false }, "CovenantCompliantStatus": { "description": "Represents a Covenant Compliant Status", "type": "object", "properties": { "description": { "description": "Covenant compliant status description", "type": "string" }, "id": { "format": "int32", "description": "Id of the covenant compliant status in Sageworks", "type": "integer" }, "isActive": { "description": "Whether this covenant status is Active", "type": "boolean" }, "isCompliant": { "description": "Whether this covenant status is compliant", "type": "boolean" }, "isDefault": { "description": "Whether this covenant status is default", "type": "boolean" }, "isEnabledForUpdateTestUsers": { "description": "Whether this covenant status is Enabled For UpdateTest Users", "type": "boolean" } }, "additionalProperties": false }, "CreateEntityGroupRequest": { "description": "Represents the requested entity group in Sageworks with all entity group members", "type": "object", "properties": { "groupMemberIds": { "description": "A list of Entity or Customer Ids that should be included in this group", "type": "array", "items": { "format": "int64", "type": "integer" } }, "name": { "description": "Name of the entity group", "type": "string" }, "uniqueIdentifier": { "description": "Something that uniquely identifies the entity group (usually an \"entity number\" from the core system)", "type": "string" } }, "additionalProperties": false }, "CsiSendForESignatureResponse": { "type": "object", "properties": { "adobeAgreementsId": { "format": "int64", "type": "integer" }, "success": { "type": "boolean" } }, "additionalProperties": false }, "Customer": { "description": "A financial institution customer", "required": [ "addresses", "type" ], "type": "object", "properties": { "addresses": { "description": "Addresses of the customer. The customer may have multiple addresses (ex: primary, mailing).\r\n \r\nA primary address with a valid State is required for a Business, Farm, or NonProfit", "type": "array", "items": { "$ref": "#/definitions/Address" } }, "ansoniaCreditRating": { "description": "The rating is the average monthly balance and average Days Beyond Terms for the rating period (business only)", "type": "string" }, "ansoniaRiskScore": { "format": "int32", "description": "Low Risk greater than 87, Medium Risk 70 - 87, High Risk less than 70 (business only)", "type": "integer", "x-nullable": true }, "averageCDs": { "format": "double", "description": "The average amount of CDs over the last year", "type": "number", "x-nullable": true }, "averageChecking": { "format": "double", "description": "The average amount in checking accounts over the last year", "type": "number", "x-nullable": true }, "averageSavings": { "format": "double", "description": "The average amount in savings accounts over the last year", "type": "number", "x-nullable": true }, "averageUnitRevenueGrowth": { "format": "int32", "description": "A transparency measure for new unit sales over time plus a comparative assessment of average unit revenues to peers and industry. Scoring Range (0-70) (business only)", "type": "integer", "x-nullable": true }, "avgInitial": { "format": "int32", "description": "Average cost of the project for a new franchisee (business only)", "type": "integer", "x-nullable": true }, "bankruptcies": { "description": "Number of bankruptcies the customer has had (people only)", "type": "string" }, "bankruptciesCount": { "format": "int32", "description": "Count of bankruptcies reported in the last 24 months (business only)", "type": "integer", "x-nullable": true }, "branch": { "description": "Branch of the bank that is responsible for this customer", "type": "string" }, "businessRegistered": { "description": "The state where the business is registered (business only)", "type": "string" }, "businessType": { "description": "Type of business (ex: C Corporation, LLC, Partnership, etc.)", "enum": [ "cCorp", "llc", "llp", "partnership", "sCorp", "soleProp", "cooperative", "employeeStockOwnershipPlan", "jointVenture", "independentContractors", "nonprofitChildcareCenter", "professionalAssociation", "rolloverAsBusinessStartUps", "tenantInCommon", "trust", "nonProfit501C1", "nonProfit501C2", "nonProfit501C3", "nonProfit501C4", "nonProfit501C5", "nonProfit501C6", "nonProfit501C7", "nonProfit501C8", "nonProfit501C9", "nonProfit501C10", "nonProfit501C11", "nonProfit501C12", "nonProfit501C13", "nonProfit501C14", "nonProfit501C15", "nonProfit501C16", "nonProfit501C17", "nonProfit501C18", "nonProfit501C19", "nonProfit501C20", "nonProfit501C21", "nonProfit501C22", "nonProfit501C23", "nonProfit501C24", "nonProfit501C25", "nonProfit501C26", "nonProfit501C27", "nonProfit501C28", "nonProfit501C29", "nonProfit501D", "nonProfit501E", "nonProfit501F", "nonProfit501K", "nonProfit501N", "nonProfit501A", "nonProfit527", "other", "nonprofit" ], "type": "string", "x-nullable": true }, "cDsBalance": { "format": "double", "description": "The current balance of CDs for the customer", "type": "number", "x-nullable": true }, "chargeOffsCount": { "format": "int32", "description": "Count of charge-offs reported in the last 24 months (business only)", "type": "integer", "x-nullable": true }, "checkingBalance": { "format": "double", "description": "The current balance in the checking accounts", "type": "number", "x-nullable": true }, "citizenshipStatus": { "description": "Citizenship Status of the customer (people only)", "enum": [ "usCitizen", "residentAlien", "nonResidentAlien" ], "type": "string", "x-nullable": true }, "cityHQ": { "description": "City HQ of Franchise Brand (business only)", "type": "string" }, "civDescription": { "description": "Type of identification that the borrower is providing for an institution's customer identification verification (CIV) form (people only)", "type": "string" }, "collectionsCount": { "format": "int32", "description": "Count of collections reported in the last 24 months (business only)", "type": "integer", "x-nullable": true }, "comments": { "description": "Additional comments about the customer", "type": "string" }, "companyOwnedUnits": { "format": "int32", "description": "The Number of Company locations (business only)", "type": "integer", "x-nullable": true }, "compoundAnnualUnitGrowthRate": { "format": "double", "description": "The trailing 3 year growth rate at the franchise unit level (business only)", "type": "number", "x-nullable": true }, "compoundedUnitSuccessRate": { "format": "double", "description": "Eight year Compounded Unit Success Rate based on past historical unit success rates in the Franchise Branding Underwriting Report Section (business only)", "type": "number", "x-nullable": true }, "countyCode": { "description": "County code of the customer's address", "type": "string" }, "creditLogicScore": { "format": "int32", "description": "Ranging from 0 (high risk) to 100 (low risk), the Credit Logic Score is a predictive business credit indicator (business only)", "type": "integer", "x-nullable": true }, "creditScore": { "format": "int32", "description": "Credit score of the customer", "type": "integer" }, "crmIdentifier": { "description": "The CRM identifier for this customer", "type": "string" }, "currentAutoPastDue": { "description": "The current dollar amount that is past due on all auto loans for the customer (people only)", "type": "string" }, "currentEducationPastDue": { "description": "The current dollar amount that is past due on all education loans for the customer (people only)", "type": "string" }, "currentInstallmentPastDue": { "description": "The current dollar amount that is past due on all installment loans for the customer (people only)", "type": "string" }, "currentMortgagePastDue": { "description": "The current dollar amount that is past due on all mortgage loans for the customer (people only)", "type": "string" }, "currentOpenPastDue": { "description": "The current dollar amount that is past due on all open loans for the customer (people only)", "type": "string" }, "currentOtherPastDue": { "description": "The current dollar amount that is past due on all other loans for the customer (people only)", "type": "string" }, "currentRevolvingPastDue": { "description": "The current dollar amount that is past due on all revolving loans for the customer (people only)", "type": "string" }, "currentTotalPastDue": { "description": "The current dollar amount that is past due on all loans for the customer (people only)", "type": "string" }, "dataDepthScore": { "format": "int32", "description": "Indicates the volume of predictive data that is available on a company. Ranking from on a scale from 0-9, where 9 indicates the greatest level of predictive data with ALL three national bureaus reporting (business only)", "type": "integer", "x-nullable": true }, "dateBusinessEstablished": { "format": "Date", "description": "The date the business was established", "type": "string", "x-nullable": true }, "dateOfBirth": { "format": "Date", "description": "Date of Birth for this customer (people only)", "type": "string", "x-nullable": true }, "dateOfLastBankruptcy": { "description": "Date of customer's last bankruptcy (people only)", "type": "string" }, "dba": { "description": "The name that the customer is \"doing business as\"", "type": "string" }, "dbdbt": { "format": "int32", "type": "integer", "x-nullable": true }, "dbPaydex": { "format": "int32", "type": "integer", "x-nullable": true }, "dbViabilityRating": { "description": "Assessment of the probability that a company will no longer be in business within the next 12 months (business only)", "type": "string" }, "department": { "description": "Department of the bank that is responsible for this customer", "type": "string" }, "description": { "description": "Description of the customer (businesses only)", "type": "string" }, "dnbScore": { "description": "DNB score of the customer", "type": "string" }, "emailAddress": { "description": "Email address of the customer", "type": "string" }, "employer": { "description": "Name of person or organization that employs the customer (people only)", "type": "string" }, "entryMethod": { "format": "string", "description": "The Entry method for this business (business only)", "enum": [ "operatingCompany", "bank", "hospital", "hotel", "insurance", "retail", "restaurant", "floorPlan", "ebitdaAddBack", "realEstateCompany" ], "type": "string" }, "equifaxCreditScore": { "format": "int32", "description": "Customer's Equifax Credit Score", "type": "integer", "x-nullable": true }, "equifaxCreditScoreDate": { "format": "Date", "description": "Customer's Equifax Credit Score Date Pulled", "type": "string", "x-nullable": true }, "equifaxDBT": { "format": "int32", "description": "Equifax Days Beyond Terms (business only)", "type": "integer", "x-nullable": true }, "experianCreditScore": { "format": "int32", "description": "Customer's Experian Credit Score", "type": "integer", "x-nullable": true }, "experianCreditScoreDate": { "format": "Date", "description": "Customer's Experian Credit Score Date Pulled", "type": "string", "x-nullable": true }, "experianDBT": { "format": "int32", "description": "Experian Days Beyond Terms (business only)", "type": "integer", "x-nullable": true }, "farmRegistered": { "description": "The state where the farm is registered (farm only)", "type": "string" }, "ficoSbssCreditScore": { "format": "int32", "description": "Customer's FICO SBSS Credit Score", "type": "integer", "x-nullable": true }, "ficoSbssCreditScoreDate": { "format": "Date", "description": "Customer's FICO SBSS Principal Credit Score Date Pulled (people only)", "type": "string", "x-nullable": true }, "finStatementStrength": { "format": "int32", "description": "A measure of a franchisor's financial/capital ability to support system growth. Scoring Range (0-50) (business only)", "type": "integer", "x-nullable": true }, "firstName": { "description": "First name of the customer (people only)", "type": "string" }, "franchiseAgreementAssessment": { "format": "int32", "description": "Identifies unusual control terms that affect the borrower and unusual control terms that affect the lender. Scoring Range (0-40) (business only)", "type": "integer", "x-nullable": true }, "franchiseDataFinancialPeriod": { "format": "int32", "description": "The financial year of Franchise Data used (business only)", "type": "integer", "x-nullable": true }, "franchiseDataImportDate": { "format": "Date", "description": "Franchise data import date (business only)", "type": "string", "x-nullable": true }, "franchisedUnits": { "format": "int32", "description": "The Number of Franchisee locations (business only)", "type": "integer", "x-nullable": true }, "franchiseeRelationship": { "format": "int32", "description": "Based on information from an independent franchisee satisfaction assessment. Scoring Range (0-40) (business only)", "type": "integer", "x-nullable": true }, "franchiseLegalName": { "description": "Franchise legal name (business only)", "type": "string" }, "franchiseName": { "description": "Franchise brand name (business only)", "type": "string" }, "franchiseStartDate": { "format": "int32", "description": "Franchise start date (business only)", "type": "integer", "x-nullable": true }, "historical30DayDelinquencies": { "description": "The total number of 30 day delinquencies listed on the customer's credit report (people only)", "type": "string" }, "historical60DayDelinquencies": { "description": "The total number of 60 day delinquencies listed on the customer's credit report (people only)", "type": "string" }, "historical90DayDelinquencies": { "description": "The total number of 90 day delinquencies listed on the customer's credit report (people only)", "type": "string" }, "historicalOtherDelinquencies": { "description": "The total number of delinquencies listed on the customer's credit report that exceed 90 days (people only)", "type": "string" }, "historicalSuccessRate": { "format": "int32", "description": "Assesses the overall health of a franchise system (business only)", "type": "integer", "x-nullable": true }, "id": { "format": "int32", "description": "The id of the customer in Sageworks", "type": "integer" }, "idDescription": { "description": "Description for the type of identification presented to the financial institution, such as a state issued driver's license or a passport (people only)", "type": "string" }, "idExpirationDate": { "format": "Date", "description": "This is the expiration date of the customer's identification (people only)", "type": "string", "x-nullable": true }, "idIssueDate": { "format": "Date", "description": "This is the date on which the authoritative entity issued the customer's identification (people only)", "type": "string", "x-nullable": true }, "idIssuingAuthority": { "description": "This is the name or a description of the authoritative entity who has issued the customer's identification (people only)", "type": "string" }, "idNumber": { "description": "This is the description of unique information(such as mothers' maiden name or high school mascot) provided to the financial institution by the customer (people only)", "type": "string" }, "idState": { "description": "This is the state of the customer's identification (people only)", "type": "string" }, "industryCode": { "description": "The NAICS code related to the customer. This field is required for a Business or Farm", "type": "string" }, "isActiveMiltaryDuty": { "description": "Whether the customer is currently on active military duty (people only)", "type": "boolean", "x-nullable": true }, "isDeleted": { "description": "Indicates if this customer has been deleted", "type": "boolean" }, "isDependentOfActiveMiltaryDuty": { "description": "Whether the customer is a dependent of someone currently on active military duty (people only)", "type": "boolean", "x-nullable": true }, "isMailingAddressDifferent": { "description": "Whether the mailing address is different than the primary address", "type": "boolean" }, "jobTitle": { "description": "Job title of the customer", "type": "string" }, "judgmentsCount": { "format": "int32", "description": "Count of judgments reported in the last 24 months (business only)", "type": "integer", "x-nullable": true }, "lastName": { "description": "Last name of the customer (people only)", "type": "string" }, "lastReportRun": { "format": "Date", "description": "Date last business credit report was run (business only)", "type": "string", "x-nullable": true }, "latitude": { "format": "double", "description": "Latitude of the customer's address", "type": "number", "x-nullable": true }, "licenseNumber": { "description": "License number for the customer (business, farm, and nonprofit only)", "type": "string" }, "liensCount": { "format": "int32", "description": "Count of liens reported in the last 24 months (business only)", "type": "integer", "x-nullable": true }, "loanAdministrator": { "description": "Customer's loan adminstrator", "type": "string" }, "loanBoardingIdentifier": { "description": "The identifier used for loan boarding for this customer", "type": "string" }, "loanOfficer": { "description": "Customer's loan officer - OBSOLETE", "type": "string" }, "loanOfficerId": { "format": "int32", "description": "Id of the customer's loan officer", "type": "integer", "x-nullable": true }, "longitude": { "format": "double", "description": "Longitude of the customer's address", "type": "number", "x-nullable": true }, "maritalStatus": { "description": "Marital Status of the customer (people only)", "enum": [ "married", "unmarried", "legallySeparated" ], "type": "string", "x-nullable": true }, "maxInitial": { "format": "int32", "description": "Maximum cost of the project for a new franchisee (business only)", "type": "integer", "x-nullable": true }, "medianHouseholdIncome": { "format": "double", "description": "Median Household Income of the area where customer's address is located", "type": "number", "x-nullable": true }, "metropolitanDivision": { "description": "Metropolitan Division of the customer's address", "type": "string" }, "metropolitanDivisionCode": { "description": "Metropolitan division code of the customer's address", "type": "string" }, "middleInitial": { "description": "Middle initial of the customer (people only)", "type": "string" }, "minInitial": { "format": "int32", "description": "Minimum cost of the project for a new franchisee (business only)", "type": "integer", "x-nullable": true }, "mngmtExperienceStability": { "format": "int32", "description": "Measures the stability and level of experience of an executive team (business only)", "type": "integer", "x-nullable": true }, "msa": { "format": "int32", "description": "Metropolitan statistical area of the customer's address", "type": "integer", "x-nullable": true }, "name": { "description": "Name of the customer", "type": "string" }, "namePrefix": { "description": "Prefix of the customer's name (ex: Mr, Mrs, Dr, etc.)", "type": "string" }, "nameSuffix": { "description": "Suffix of the Customer's name (Jr, Sr, etc) (people only)", "type": "string" }, "nsfChecksCount": { "format": "int32", "description": "Count of NSF checks reported in the last 24 months (business only)", "type": "integer", "x-nullable": true }, "numberOfYearsEmployed": { "format": "double", "description": "Number of years the customer has worked for the person or organization that employs them (people only)", "type": "number" }, "ofacDesignation": { "description": "OFAC designation for this customer (Positive, Negative)", "type": "string" }, "phoneNumbers": { "description": "Phone numbers of the customer. The customer may have multiple phone numbers (ex: primary, mobile, fax)", "type": "array", "items": { "$ref": "#/definitions/PhoneNumber" } }, "professionalLLC": { "description": "This indicates whether or not the limited liability entity is a professional limited liability company (business only)", "type": "boolean", "x-nullable": true }, "projectedOpenings": { "format": "int32", "description": "Projected Franchised Unit Openings for the next year (business only)", "type": "integer", "x-nullable": true }, "projectedUnitSuccess": { "format": "int32", "description": "Adjusts the Historical Unit Success Rate based on brand, peer and industry trend analysis. Scoring Range (0-250) (business only)", "type": "integer", "x-nullable": true }, "prospectScreening": { "format": "int32", "description": "Metric that gauges franchisor selection practices when screening franchise applicants. Scoring Range (0-40) (business only)", "type": "integer", "x-nullable": true }, "recurringRevenueSelfSufficiency": { "format": "int32", "description": "A standard that measures whether a franchisor can cover operating expenses from ongoing revenue without having to rely on expanding the franchised system size. Scoring Range (0-50) (business only)", "type": "integer", "x-nullable": true }, "resaleActivityLevel": { "format": "int32", "description": "Level of transfer activity a system goes through (business only)", "type": "integer", "x-nullable": true }, "restricted": { "description": "Indicates if the customer is restricted", "type": "boolean" }, "savingsBalance": { "format": "double", "description": "The current balance in the savings accounts", "type": "number", "x-nullable": true }, "sbaCode": { "description": "SBA Program Approval Code (business only)", "type": "string" }, "secondaryCreditScore": { "format": "int32", "description": "Secondary credit score of the customer", "type": "integer", "x-nullable": true }, "stateCode": { "format": "int32", "description": "State code of the customer's address", "type": "integer", "x-nullable": true }, "stateHQ": { "description": "State HQ of Franchise Brand (business only)", "type": "string" }, "stateOfFormation": { "description": "The state in which the business was incorporated (business only)", "type": "string" }, "systemSupportAndExpenseCommitment": { "format": "int32", "description": "Metric for determining the types of support the franchisor provides to its franchises (business only)", "type": "integer", "x-nullable": true }, "taxId": { "description": "Tax ID of the customer", "type": "string" }, "totalFundScore": { "format": "int32", "description": "Overall Franchise score. Scoring Range (0-950) (business only)", "type": "integer", "x-nullable": true }, "tractCode": { "description": "Tract code of the customer's address", "type": "string" }, "transunionCreditScore": { "format": "int32", "description": "Customer's Transunion Credit Score", "type": "integer", "x-nullable": true }, "transunionCreditScoreDate": { "format": "Date", "description": "Customer's Equifax Credit Score Date Pulled", "type": "string", "x-nullable": true }, "type": { "description": "Type of customer (business, person, farm, etc.)", "enum": [ "business", "person", "farm", "nonProfit" ], "type": "string", "x-nullable": true }, "underFormation": { "description": "Indicates if the business is under formation (business only)", "type": "boolean", "x-nullable": true }, "uniqueIdentifier": { "description": "Something that uniquely identifies this customer (usually a \"customer number\" or tax id from the core system)", "type": "string" }, "unitEconomics": { "format": "int32", "description": "Level of transparency which affects whether the amount of information a franchisor discloses allows a franchisee to estimate their unit's potential financial performance and profitability. Scoring Range (0-100) (business only)", "type": "integer", "x-nullable": true }, "userDefinedFields": { "description": "User-defined fields for the customer", "type": "object", "additionalProperties": { "type": "string" } }, "website": { "description": "Website of the customer", "type": "string" }, "yearFounded": { "format": "int32", "description": "The year in which the business was formed (business only)", "type": "integer" } }, "additionalProperties": false }, "CustomerBasicInformation": { "description": "A customer with just the basic information", "type": "object", "properties": { "id": { "format": "int32", "description": "The id of the customer in Sageworks", "type": "integer" }, "isDeleted": { "description": "Indicates if this customer has been deleted", "type": "boolean" }, "name": { "description": "Name of the customer", "type": "string" }, "type": { "description": "Type of customer (business, person, etc.)", "enum": [ "business", "person", "farm", "nonProfit" ], "type": "string", "x-nullable": true }, "uniqueIdentifier": { "description": "Something that uniquely identifies this customer (usually an \"customer number\" or tax id from the core system)", "type": "string" } }, "additionalProperties": false }, "CustomerContact": { "description": "Contact for a customer", "required": [ "firstName", "ownerCustomerId" ], "type": "object", "properties": { "address1": { "description": "First line of the address for the contact", "type": "string" }, "address2": { "description": "Second line of the address for the contact", "type": "string" }, "city": { "description": "City where the contact is located", "type": "string" }, "comments": { "description": "Additional comments about the contact", "type": "string" }, "company": { "description": "Company name of the contact", "type": "string" }, "country": { "description": "Country where the contact is located", "type": "string" }, "emailAddress": { "description": "Email Address of the contact", "type": "string" }, "firstName": { "description": "First name or an identifier for the contact", "minLength": 1, "type": "string" }, "id": { "format": "int32", "description": "The ID of Customer Contact record in Sageworks", "type": "integer" }, "isUniversalContact": { "description": "Indicates whether this contact is a universal contact that can be used across all customers/entities", "type": "boolean" }, "jobTitle": { "description": "Job Title of the Contact", "type": "string" }, "lastName": { "description": "Last name or an identifier for the contact", "type": "string" }, "mobile": { "description": "Mobile phone number of the contact", "type": "string" }, "namePrefix": { "description": "Prefix for the contact (e.g., Mr., Mrs., Ms., Miss or Dr.)", "type": "string" }, "ownerCustomerId": { "format": "int32", "description": "The ID of the customer that this contact relates to", "type": "integer" }, "phone": { "description": "Phone number of the contact", "type": "string" }, "postalCode": { "description": "Postal Code where the contact is located", "type": "string" }, "role": { "description": "Role of the contact (ex: owner, accountant, vendor, spouse, etc.)", "type": "string" }, "state": { "description": "State where the contact is located", "type": "string" } }, "additionalProperties": false }, "CustomerLoanRole": { "description": "Represents a customer with a relationship to a loan (primary borrower, co-signer, etc.)", "type": "object", "properties": { "customerId": { "format": "int32", "description": "Id of the customer that is related to the loan", "type": "integer" }, "percentResponsible": { "format": "double", "description": "The percent of the loan is the customer responsible for with respect to the role", "type": "number" }, "roleType": { "description": "The type of role that the customer has with respect to the loan\r\n \r\nDefault options are: Co-Borrower, Cosigner, Credit Applicant, and Guarantor, but other options may be available\r\nfor your institution", "type": "string" } }, "additionalProperties": false }, "CustomerWidget": { "type": "object", "properties": { "customerType": { "format": "string", "description": "The type of the Customer Widget", "enum": [ "business", "person", "farm", "nonProfit" ], "type": "string" }, "id": { "format": "int32", "description": "The id of the Customer Widget in Sageworks", "type": "integer" }, "name": { "description": "The name of the Customer Widget", "type": "string" }, "nonRequiredFields": { "description": "The list of non required fields for the Customer Widget", "type": "array", "items": { "$ref": "#/definitions/CustomerWidgetField" } }, "requiredFields": { "description": "The list of required fields for the Customer Widget", "type": "array", "items": { "$ref": "#/definitions/CustomerWidgetField" } }, "returnInformation": { "description": "The list of return fields for the Customer Widget", "type": "array", "items": { "$ref": "#/definitions/CustomerWidgetField" } }, "statusUserDefinedFieldName": { "description": "The name of the user defined field that contains the status of the Customer Widget", "type": "string" } }, "additionalProperties": false }, "CustomerWidgetAvailableFieldDefinitions": { "description": "Response model containing available customer widget field definitions", "type": "object", "properties": { "fields": { "description": "The list of available field definitions for Customer Widgets.\r\nReturns BaseFieldMetadata objects which include all field properties including\r\ninput format, data type, value options, field category, and other metadata.", "type": "array", "items": { "$ref": "#/definitions/BaseFieldMetadata" } } }, "additionalProperties": false }, "CustomerWidgetAvailableFields": { "type": "object", "properties": { "fields": { "description": "The list of available fields for Customer Widgets", "type": "array", "items": { "$ref": "#/definitions/CustomerWidgetField" } } }, "additionalProperties": false }, "CustomerWidgetField": { "type": "object", "properties": { "fieldName": { "description": "The name of the Customer Widget field", "type": "string" } }, "additionalProperties": false }, "CustomerWidgetFieldValues": { "type": "object", "properties": { "fieldValues": { "description": "FieldName and Values of Widget fields", "type": "object", "additionalProperties": { "type": "string" } } }, "additionalProperties": false }, "CustomerWidgetOrderRequest": { "description": "Request model for ordering a customer widget", "type": "object", "properties": { "customerId": { "format": "int32", "description": "The id of the customer", "type": "integer" }, "widgetId": { "format": "int32", "description": "The id of the customer widget to order", "type": "integer" } }, "additionalProperties": false }, "CustomerWidgetStatus": { "description": "The status of the customer widget for a customer", "type": "object", "properties": { "status": { "description": "The status of the customer widget for a customer\r\nHyperlinks within the widget status, must have the following pattern: [DisplayName|Url]", "type": "string" } }, "additionalProperties": false }, "DataFieldFormula": { "type": "object", "properties": { "dataField": { "format": "string", "enum": [ "camAndOtherIncome", "vacancyRate", "postVacancyRateIncome", "annualGrossIncome", "effectiveGrossIncome", "insurance", "taxesPaid", "propertyManagementFees", "advertisingAndMarketingFees", "maintenanceCosts", "reserveRequirements", "otherExpenses", "totalOperatingExpenses", "netOperatingIncome", "capitalizationRate", "propertyValue", "percentOwnership", "adjustedNetOperatingIncome", "adjustedPropertyValue", "depreciation", "interestExpenses", "sales", "costOfSales", "overhead", "inventory", "grossFixedAssets", "accumulatedDepreciation", "otherAssets", "seniorDebt", "subordinatedDebt", "dividendsPaid", "cogsDepreciation", "otherOperatingIncome", "otherOperatingExpenses", "amortization", "ebitdaAdjustments", "extraordinaryGain", "extraordinaryLoss", "accountsReceivable", "otherCurrentAssets", "grossIntangibleAssets", "accumulatedAmortization", "accountsPayable", "shortTermDebt", "currentPortionOfLongTermDebt", "otherCurrentLiabilities", "otherLongTermLiabilities", "preferredStock", "commonStock", "additionalPaidInCapital", "otherStockAndEquity", "endingRetainedEarnings", "contingentLiabilities", "beginningRetainedEarnings", "otherRetainedEarnings", "otherIncome", "cash", "nonItemizedDebtService", "portionOfNonItemizedDebtToBeRefinanced", "rentalIncome", "cropSales", "cropAccrualAdjustment", "livestockSales", "livestockSalesCostBasis", "livestockSalesCostBasisAdjustment", "marketLivestockAccrualAdjustment", "breedingLivestockAccrualAdjustment", "livestockProductSales", "livestockProductAccrualAdjustment", "cropInsuranceAndDisasterProceeds", "accountsReceivableAccrualAdjustment", "accountsPayableAccrualAdjustment", "prepaidExpensesAccrualAdjustment", "investmentInGrowingCropsAccrualAdjustment", "otherInventoryAccrualAdjustment", "accruedInterestAccrualAdjustment", "withdrawalsForUnpaidLaborManagement", "otherOwnerShareholderWithdrawals", "changeInEquity", "changeInEquityAdjustments", "breedingOrHeldLivestockAssets", "titledMachineryAndEquipment", "machineryAndEquipment", "accumulatedDepreciationMachineryAndEquipment", "accumulatedDepreciationLandAndBuildings", "personalIncome", "personalIncomeAdjustments", "rentPayment", "personalExpenses", "stocks", "mutualFunds", "otherLiquidAssets", "closelyHeldCompanyStock", "lifeInsurance", "retirement", "automobiles", "jewelry", "furniture", "personalResidence", "nonInvestmentProperties", "otherRealEstateValue", "creditCardBalances", "taxesOwed", "otherLinesOfCredit", "otherShortTermLoans", "automobileLoans", "firstMortgage", "secondMortgage", "personalResidenceEquity", "studentLoans", "nonInvestmentPropertyLoans", "otherInstallmentLoans", "otherLongTermLoans", "administrationExpenses", "currentInvestments", "donorRestrictedBeginningNetAssets", "donorRestrictedContributions", "donorRestrictedDues", "donorRestrictedGovernmentGrants", "donorRestrictedInvestmentRevenue", "donorRestrictedNetAssets", "donorRestrictedOtherAdjustmentsToNetAssets", "donorRestrictedOtherChangesInNetAssets", "donorRestrictedOtherOperatingRevenue", "donorRestrictedProgramRevenue", "donors", "fundraisingExpenses", "investmentAssets", "longTermLiabilities", "members", "netAssetsReleased", "otherDonorRestrictedInflows", "otherDonorRestrictedOutflows", "otherPermRestrictedInflows", "otherPermRestrictedOutflows", "otherTempRestrictedInflows", "otherTempRestrictedOutflows", "otherUnrestrictedInflows", "otherUnrestrictedOutflows", "payables", "permRestrictedBeginningNetAssets", "permRestrictedContributions", "permRestrictedDues", "permRestrictedGovernmentGrants", "permRestrictedInvestmentRevenue", "permRestrictedNetAssets", "permRestrictedOtherAdjustmentsToNetAssets", "permRestrictedOtherOperatingRevenue", "permRestrictedProgramRevenue", "programExpenses", "tempRestrictedBeginningNetAssets", "tempRestrictedContributions", "tempRestrictedDues", "tempRestrictedGovernmentGrants", "tempRestrictedInvestmentRevenue", "tempRestrictedNetAssets", "tempRestrictedOtherAdjustmentsToNetAssets", "tempRestrictedOtherChangesInNetAssets", "tempRestrictedOtherOperatingRevenue", "tempRestrictedProgramRevenue", "totalNetAssets", "totalReceivables", "unrestrictedBeginningNetAssets", "unrestrictedContributions", "unrestrictedDues", "unrestrictedGovernmentGrants", "unrestrictedInvestmentRevenue", "unrestrictedNetAssets", "unrestrictedOtherAdjustmentsToNetAssets", "unrestrictedOtherChangesInNetAssets", "unrestrictedOtherOperatingRevenue", "unrestrictedProgramRevenue", "employees", "ebitda", "cccLoans", "otherLongTermAssets", "longTermSeniorDebt", "accruedInterest", "prepaidExpenses", "hedgingAccounts", "otherIntermediateAssets", "otherInventory", "buildings", "cropInventory", "otherIntermediateLiabilities", "longTermSubordinatedDebt", "marketableSecurities", "investmentInGrowingCrops", "marketLivestockInventory", "intermediateSubordinatedDebt", "intermediateSeniorDebt", "permRestrictedOtherChangesInNetAssets", "land", "livestockProducts" ], "type": "string" }, "formula": { "type": "string" }, "id": { "format": "int64", "type": "integer" } }, "additionalProperties": false }, "DataFieldOption": { "description": "A single Data Field Option", "type": "object", "properties": { "label": { "description": "The label of the Data Field Option", "type": "string" }, "value": { "description": "Value of Data Field Option", "x-nullable": true } }, "additionalProperties": false }, "Deposit": { "description": "A deposit account (checking, savings, etc.) in Sageworks", "required": [ "accountNumber", "customerId", "type" ], "type": "object", "properties": { "accountNumber": { "description": "Account number of the deposit", "minLength": 1, "type": "string" }, "annualFees": { "format": "double", "description": "The annual fees for the deposit account", "type": "number" }, "balance": { "format": "double", "description": "The current balance of the deposit account", "type": "number" }, "branchBankCodeId": { "format": "int64", "description": "The ID of the bank branch in Sageworks", "type": "integer", "x-nullable": true }, "customerId": { "format": "int32", "description": "The id of the customer that is the owner of this deposit account", "type": "integer" }, "id": { "format": "int32", "description": "The id of the deposit account in Sageworks", "type": "integer" }, "interestRate": { "format": "float", "description": "The interest rate of the deposit account", "type": "number" }, "isDeleted": { "description": "Indicates if the deposit account has been deleted", "type": "boolean" }, "maturityDate": { "format": "Date", "description": "The date that the deposit account matures", "type": "string", "x-nullable": true }, "originationDate": { "format": "Date", "description": "The date that the deposit account was opened", "type": "string", "x-nullable": true }, "type": { "description": "The type of deposit account (ex: Commercial DDA, Personal Savings, etc.)", "minLength": 1, "type": "string" }, "userDefinedFields": { "description": "User defined deposit fields", "type": "object", "additionalProperties": { "type": "string" } } }, "additionalProperties": false }, "DetailedTickler": { "description": "Represents a tickler in Sageworks with additional information", "type": "object", "properties": { "bankLoanCollateralId": { "format": "int64", "description": "Id of the collateral that is related to this tickler.", "type": "integer", "x-nullable": true }, "collateralDescription": { "type": "string" }, "comments": { "description": "General comments on the tickler", "type": "string" }, "customerId": { "format": "int32", "description": "Id of the customer or group in Sageworks that this tickler is attached to", "type": "integer" }, "documentAppliesToCustomerId": { "format": "int32", "description": "Id of the customer the tickler applies to", "type": "integer" }, "documentAppliesToName": { "type": "string" }, "documentDated": { "format": "Date", "type": "string", "x-nullable": true }, "documentIdentifier": { "description": "The identifying number or descriptive phrase for this tickler.", "type": "string" }, "documentLocation": { "description": "Physical location of the hard copy of this document at your institution.", "type": "string" }, "documentRecipientToCustomerId": { "format": "int32", "description": "Id of the customer the tickler should be sent to", "type": "integer", "x-nullable": true }, "effectiveDueDate": { "format": "Date", "type": "string", "x-nullable": true }, "frequency": { "description": "How often your institution will make the tickler request", "type": "string" }, "id": { "format": "int32", "description": "Id of the tickler in Sageworks", "type": "integer" }, "loanOfficerId": { "format": "int32", "description": "Id of the loan officer assigned to this tickler", "type": "integer" }, "nextDueDate": { "format": "Date", "description": "The date that the document being requested is due.", "type": "string", "x-nullable": true }, "nextPdEndDate": { "format": "Date", "description": "The period ending date for the document being requested.", "type": "string", "x-nullable": true }, "ticklerName": { "description": "Name of the tickler", "type": "string" } }, "additionalProperties": false }, "DetailedTicklerResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/DetailedTickler" } }, "totalResultCount": { "format": "int32", "type": "integer" } }, "additionalProperties": false }, "Document": { "description": "A document in document library", "type": "object", "properties": { "customerFacingName": { "description": "READ ONLY: The customer facing name of the document", "type": "string" }, "customerId": { "format": "int32", "description": "The id of the customer that this document is associated with. This value may not be updated", "type": "integer", "x-nullable": true }, "dateUploaded": { "format": "Date", "description": "Date that the document was uploaded", "type": "string" }, "description": { "description": "A description of the document", "type": "string" }, "documentDated": { "format": "Date", "description": "The date of the document", "type": "string", "x-nullable": true }, "documentFolderId": { "format": "int32", "description": "The id of the folder that this document is in", "type": "integer", "x-nullable": true }, "exportDate": { "format": "Date", "description": "Date that the document was exported", "type": "string", "x-nullable": true }, "exportTime": { "description": "Time that the document was exported (HH:mm:ss or HH:mm:ss.fff format).\r\nThis field is combined with ExportDate to form the complete export datetime.\r\nIf not provided when setting ExportDate, defaults to 00:00:00.", "type": "string" }, "fileName": { "description": "The name of the provided document file", "type": "string" }, "id": { "format": "int32", "description": "The id of the document in Sageworks", "type": "integer" }, "isDeleted": { "description": "Indicates if the file has been deleted", "type": "boolean" }, "isImage": { "description": "Indicates if the file is an image", "type": "boolean" }, "name": { "description": "The name of the document", "type": "string" }, "sizeInBytes": { "format": "int32", "description": "The size of the file in bytes", "type": "integer" }, "uniqueIdentifier": { "description": "The identifier assigned to docs for easier communication between Sageworks and external systems", "type": "string" } }, "additionalProperties": false }, "DocumentAssociation": { "description": "An association between a document and another object", "type": "object", "properties": { "documentId": { "format": "int64", "description": "id of the document that is being associated with another object", "type": "integer" }, "id": { "format": "int32", "description": "id of the association", "type": "integer" }, "objectId": { "format": "int64", "description": "The id of the object that is being associated with the document", "type": "integer" }, "objectType": { "description": "The type of object that is being associated with the document", "type": "string" } }, "additionalProperties": false }, "DocumentContent": { "description": "Content of the document", "type": "object", "properties": { "content": { "description": "Base64 encoded string of the document", "type": "string" } }, "additionalProperties": false }, "DocumentFolder": { "description": "A folder in document library", "type": "object", "properties": { "id": { "format": "int32", "description": "The id of the folder", "type": "integer" }, "isDeleted": { "description": "Indicates if the folder has been deleted", "type": "boolean" }, "name": { "description": "The name of the folder", "type": "string" }, "parentDocumentFolderId": { "format": "int32", "description": "The id of the folder that is the parent of this folder, or null if this is a top level folder", "type": "integer", "x-nullable": true }, "type": { "format": "string", "description": "The type of folder", "enum": [ "general", "customer" ], "type": "string" } }, "additionalProperties": false }, "DocumentPostRequest": { "description": "A request that includes all the information required to create a new document in document library", "type": "object", "properties": { "associationCustomerId": { "format": "int32", "description": "[DEPRECATED] - Please pass in a CustomerId with the Document Object.\r\n \r\nCustomerId to associate document with when creating a document in a Customer folder. Not allowed to be specified on documents that are not created in a customer folder", "type": "integer", "x-nullable": true }, "document": { "$ref": "#/definitions/Document" }, "documentContent": { "$ref": "#/definitions/DocumentContent" }, "documentPassword": { "description": "(Optional) Document Password to decrypt the document", "type": "string" } }, "additionalProperties": false }, "Entity": { "description": "An entity in Sageworks", "required": [ "id", "isDeleted", "name", "type", "uniqueIdentifier" ], "type": "object", "properties": { "id": { "format": "int32", "description": "The id of the entity in Sageworks", "type": "integer" }, "isDeleted": { "description": "Indicates if this entity has been deleted", "type": "boolean" }, "name": { "description": "Name of the entity", "minLength": 1, "type": "string" }, "type": { "description": "Type of entity (business, person, property, group, etc.)", "enum": [ "business", "person", "farm", "nonProfit", "group", "property", "contact", "government", "financialInstitution", "trust", "all", "unknown", "unsupported" ], "type": "string", "x-nullable": true }, "uniqueIdentifier": { "description": "Something that uniquely identifies this entity (usually an \"entity number\" or tax id from the core system)", "minLength": 1, "type": "string" } }, "additionalProperties": false }, "EntityGroupDetail": { "description": "Represents an entity group with its members", "type": "object", "properties": { "groupEntity": { "$ref": "#/definitions/Entity" }, "members": { "description": "All entities that are members of this group", "type": "array", "items": { "$ref": "#/definitions/Entity" } } }, "additionalProperties": false }, "EntityGroupSummary": { "description": "An entity group in Sageworks with all entity group members", "type": "object", "properties": { "groupId": { "format": "int32", "description": "The id of the entity group in Sageworks", "type": "integer" }, "groupMembers": { "description": "All entities that are part of the entity group", "type": "array", "items": { "$ref": "#/definitions/Entity" } }, "isDeleted": { "description": "Indicates if the entity group has been deleted", "type": "boolean" }, "name": { "description": "Name of the entity group", "type": "string" }, "uniqueIdentifier": { "description": "Something that uniquely identifies the entity group (usually an \"entity number\" from the core system)", "type": "string" } }, "additionalProperties": false }, "Error": { "description": "Represents an error that occurred while making processing an API call", "type": "object", "properties": { "errorType": { "format": "string", "description": "Type of error that occurred", "enum": [ "invalidRequest", "serverError", "notFound" ], "type": "string" }, "message": { "description": "Error message describing what error occurred and remediation steps for the client (if any)", "type": "string" }, "modelErrors": { "description": "Error messages related to input models provided in an API request", "type": "array", "items": { "$ref": "#/definitions/ModelError" } } }, "additionalProperties": false }, "EsignAutoSendSignatureResponse": { "description": "AgreementId from Adobe", "type": "object", "properties": { "agreementId": { "format": "int64", "description": "AgreementId to identify the Agreement that was created", "type": "integer" }, "docusignSignedDocumentsId": { "format": "int64", "description": "DocusignSignedDocumentsId to identify the DocusignEnvelopeID that was created", "type": "integer" } }, "additionalProperties": false }, "EsignRecipientStatuses": { "description": "List of recipients for the agreement", "type": "object", "properties": { "dateSigned": { "format": "Date", "description": "DateTime when signer signed document", "type": "string", "x-nullable": true }, "email": { "description": "Signer's email", "type": "string" }, "isSigned": { "description": "Whether signer has signed", "type": "boolean" }, "name": { "description": "Signer's name", "type": "string" } }, "additionalProperties": false }, "Event": { "description": "An event that has happened", "type": "object", "properties": { "eventContent": { "description": "The content of the event. The structure of the content will vary depending on the event type.", "type": "object", "additionalProperties": { "type": "string" } }, "eventTime": { "format": "date-time", "description": "The time the event was triggered", "type": "string" }, "eventType": { "format": "string", "description": "The type of the event", "enum": [ "loanBoardedEvent", "documentAssociationSavedEvent", "documentChangedEvent", "documentDeletedEvent", "documentUploadedEvent", "appraisalStatusChangedEvent", "loanStageChangedEvent", "loanStatusChangedEvent", "builtConstructionEvent", "collateralWidgetEvent", "coreIntegrationCompletedEvent", "customerWidgetEvent", "laserProDocumentsReturnedEvent", "dynamicApplicationSubmittedEvent", "thoughtspotPermissionsEvent", "genericWidgetEvent" ], "type": "string" }, "id": { "format": "int32", "description": "The unique identifier for the object", "type": "integer" }, "isComplete": { "description": "Whether this event has been completed", "type": "boolean" } }, "additionalProperties": false }, "FinancialInfoBusinessBalanceSheet": { "description": "Represents the Balance Sheet Section of Business Financials", "type": "object", "properties": { "accountsPayable": { "format": "double", "description": "Amounts owed to vendors.", "type": "number" }, "accountsReceivable": { "format": "double", "description": "All amounts owed by customers to the company, net of any allowances for uncollectibles.", "type": "number" }, "accumulatedAmortization": { "format": "double", "description": "The amount of amortization expense the business has recognized for intangible assets on the books.", "type": "number" }, "accumulatedDepreciation": { "format": "double", "description": "The total amount of depreciation accumulated by the business since the start of operations.", "type": "number" }, "additionalFields": { "description": "Additional Balance Sheet Fields", "type": "object", "additionalProperties": { "type": "string" } }, "additionalPaidInCapital": { "format": "double", "description": "The difference between the par value of the stock issued to owners and the total cash contributed in exchange for the issued stock.", "type": "number" }, "cashBankFunds": { "format": "double", "description": "All monies in cash, checking, and money market accounts. Include marketable securities.", "type": "number" }, "comments": { "description": "Relevant comments for balance sheet information.", "type": "string" }, "commonStock": { "format": "double", "description": "A security which represents ownership in a corporation and which normally carries voting privileges.", "type": "number" }, "contingentLiabilities": { "format": "double", "description": "Any operating leases, pension obligations, purchase commitments, contingent liabilities and all other contractual obligations not presented on the balance sheet.\r\n \r\nAmounts entered here will not be included in the calculation for Total Liabilities.", "type": "number" }, "endingRetainedEarnings": { "format": "double", "description": "All profits that the company has earned and re-invested in itself for the dates in question.\r\n \r\nShould include current period's Beginning Retained Earnings, Net Income, Withdraws, and Dividends.", "type": "number" }, "grossFixedAssets": { "format": "double", "description": "The amount for gross fixed assets or the value for Plant, Property, and Equipment before depreciation is subtracted. The expert system, however, will still work if net PPE or net fixed assets is inputted.", "type": "number" }, "grossIntangibleAssets": { "format": "double", "description": "Intellectual property or other \"soft assets\" that have a useful life but are not fixed assets.", "type": "number" }, "inventory": { "format": "double", "description": "The value of all items available for resale to customers. Direct labor would only be included here if it is included in the calculation of inventory cost.", "type": "number" }, "netFixedAssets": { "format": "double", "description": "The value of your fixed assets after having accounted for depreciation.", "type": "number" }, "netIntangibleAssets": { "format": "double", "description": "The value of your intangible assets after accounting for amortization.", "type": "number" }, "notesPayableCurrentPortionOfLongTermDebt": { "format": "double", "description": "The portion of Long Term Liabilities being paid off within 12 months of the particular financial statement date and notes payable that have a maturity of less than one year.", "type": "number" }, "notesPayableSeniorDebt": { "format": "double", "description": "This term applies to debt which has seniority or preference in case of a default or bankruptcy.", "type": "number" }, "notesPayableSubordinatedDebt": { "format": "double", "description": "This term applies to liabilities that are subordinate or have less preference in case of a default or bankruptcy.", "type": "number" }, "otherAssets": { "format": "double", "description": "The value of all of the company's assets that are not already covered under the Current or Gross Fixed asset accounts.", "type": "number" }, "otherCurrentAssets": { "format": "double", "description": "The value of all of the company's current assets that have not already been included under Cash, Accounts Receivable, or Inventory.", "type": "number" }, "otherCurrentLiabilities": { "format": "double", "description": "The value of all of the company's liabilities that are due in the next year and that are not already included elsewhere.", "type": "number" }, "otherLongTermLiabilities": { "format": "double", "description": "Generally, it is recommended that you input into this field any Other Long Term Liabilities that would not be considered either Senior or Subordinated Debt. Some possible examples include deferred taxes and the long term portion of a capital lease.", "type": "number" }, "otherStockEquity": { "format": "double", "description": "Any stock or other equity amounts, excluding retained earnings, not previously accounted for above.", "type": "number" }, "preferredStock": { "format": "double", "description": "Stock which generally provides the shareholder with preferential payment of dividends but does not carry voting rights.", "type": "number" }, "shortTermDebt": { "format": "double", "description": "The outstanding balance of any short term debt owed by the company. This may include lines of credit, short term operating loans, etc.", "type": "number" }, "tangibleNetWorth": { "format": "double", "description": "The value of the business excluding intangible assets.\r\n \r\nTangible Net Worth = Total Equity - Net Intangible Assets", "type": "number" }, "totalAssets": { "format": "double", "description": "This field has been calculated using the information above.", "type": "number" }, "totalAssetsMinusLiabilitiesAndEquity": { "format": "double", "description": "Total Assets minus (Liabilities plus Total Equity). If this amount equals zero, then the balance sheet reconciles.", "type": "number" }, "totalCurrentAssets": { "format": "double", "description": "The total of cash, marketable securities, accounts receivable, inventory, prepaid expenses, and any other asset the company owns that can reasonably be expected to convert to cash within approximately one year.", "type": "number" }, "totalCurrentLiabilities": { "format": "double", "description": "Most Balance Sheets make a distinction between current and long-term liabilities. In cases where the distinction is not made, include the total of accounts payable, short-term notes payable, payroll taxes payable, and any other liability that would typically be paid by the company within one year.", "type": "number" }, "totalEquity": { "format": "double", "description": "All retained earnings, treasury stock, additional paid-in capital, and original investments in the company.", "type": "number" }, "totalLiabilities": { "format": "double", "description": "All amounts owed by the company as of the Balance Sheet date in question.", "type": "number" }, "totalLiabilitiesAndEquity": { "format": "double", "description": "Total Liabilities plus Total Equity. This amount equals Total Assets if the Balance Sheet is in balance.", "type": "number" }, "totalLongTermLiabilities": { "format": "double", "description": "The value of the firm's liabilities that will not need to be paid back for at least one year.", "type": "number" } }, "additionalProperties": false }, "FinancialInfoBusinessBalanceSheetV2": { "description": "Represents the Balance Sheet Section of Business Financials", "type": "object", "properties": { "accountsPayable": { "format": "double", "description": "Amounts owed to vendors.", "type": "number" }, "accountsReceivable": { "format": "double", "description": "All amounts owed by customers to the company, net of any allowances for uncollectibles.", "type": "number" }, "accumulatedAmortization": { "format": "double", "description": "The amount of amortization expense the business has recognized for intangible assets on the books.", "type": "number" }, "accumulatedDepreciation": { "format": "double", "description": "The total amount of depreciation accumulated by the business since the start of operations.", "type": "number" }, "additionalFields": { "description": "Additional Balance Sheet Fields", "type": "array", "items": { "$ref": "#/definitions/FinancialInfoExtractAdditionalFieldsData" } }, "additionalPaidInCapital": { "format": "double", "description": "The difference between the par value of the stock issued to owners and the total cash contributed in exchange for the issued stock.", "type": "number" }, "cashBankFunds": { "format": "double", "description": "All monies in cash, checking, and money market accounts. Include marketable securities.", "type": "number" }, "comments": { "description": "Relevant comments for balance sheet information.", "type": "string" }, "commonStock": { "format": "double", "description": "A security which represents ownership in a corporation and which normally carries voting privileges.", "type": "number" }, "contingentLiabilities": { "format": "double", "description": "Any operating leases, pension obligations, purchase commitments, contingent liabilities and all other contractual obligations not presented on the balance sheet.\r\n \r\nAmounts entered here will not be included in the calculation for Total Liabilities.", "type": "number" }, "endingRetainedEarnings": { "format": "double", "description": "All profits that the company has earned and re-invested in itself for the dates in question.\r\n \r\nShould include current period's Beginning Retained Earnings, Net Income, Withdraws, and Dividends.", "type": "number" }, "grossFixedAssets": { "format": "double", "description": "The amount for gross fixed assets or the value for Plant, Property, and Equipment before depreciation is subtracted. The expert system, however, will still work if net PPE or net fixed assets is inputted.", "type": "number" }, "grossIntangibleAssets": { "format": "double", "description": "Intellectual property or other \"soft assets\" that have a useful life but are not fixed assets.", "type": "number" }, "inventory": { "format": "double", "description": "The value of all items available for resale to customers. Direct labor would only be included here if it is included in the calculation of inventory cost.", "type": "number" }, "netFixedAssets": { "format": "double", "description": "The value of your fixed assets after having accounted for depreciation.", "type": "number" }, "netIntangibleAssets": { "format": "double", "description": "The value of your intangible assets after accounting for amortization.", "type": "number" }, "notesPayableCurrentPortionOfLongTermDebt": { "format": "double", "description": "The portion of Long Term Liabilities being paid off within 12 months of the particular financial statement date and notes payable that have a maturity of less than one year.", "type": "number" }, "notesPayableSeniorDebt": { "format": "double", "description": "This term applies to debt which has seniority or preference in case of a default or bankruptcy.", "type": "number" }, "notesPayableSubordinatedDebt": { "format": "double", "description": "This term applies to liabilities that are subordinate or have less preference in case of a default or bankruptcy.", "type": "number" }, "otherAssets": { "format": "double", "description": "The value of all of the company's assets that are not already covered under the Current or Gross Fixed asset accounts.", "type": "number" }, "otherCurrentAssets": { "format": "double", "description": "The value of all of the company's current assets that have not already been included under Cash, Accounts Receivable, or Inventory.", "type": "number" }, "otherCurrentLiabilities": { "format": "double", "description": "The value of all of the company's liabilities that are due in the next year and that are not already included elsewhere.", "type": "number" }, "otherLongTermLiabilities": { "format": "double", "description": "Generally, it is recommended that you input into this field any Other Long Term Liabilities that would not be considered either Senior or Subordinated Debt. Some possible examples include deferred taxes and the long term portion of a capital lease.", "type": "number" }, "otherStockEquity": { "format": "double", "description": "Any stock or other equity amounts, excluding retained earnings, not previously accounted for above.", "type": "number" }, "preferredStock": { "format": "double", "description": "Stock which generally provides the shareholder with preferential payment of dividends but does not carry voting rights.", "type": "number" }, "shortTermDebt": { "format": "double", "description": "The outstanding balance of any short term debt owed by the company. This may include lines of credit, short term operating loans, etc.", "type": "number" }, "tangibleNetWorth": { "format": "double", "description": "The value of the business excluding intangible assets.\r\n \r\nTangible Net Worth = Total Equity - Net Intangible Assets", "type": "number" }, "totalAssets": { "format": "double", "description": "This field has been calculated using the information above.", "type": "number" }, "totalAssetsMinusLiabilitiesAndEquity": { "format": "double", "description": "Total Assets minus (Liabilities plus Total Equity). If this amount equals zero, then the balance sheet reconciles.", "type": "number" }, "totalCurrentAssets": { "format": "double", "description": "The total of cash, marketable securities, accounts receivable, inventory, prepaid expenses, and any other asset the company owns that can reasonably be expected to convert to cash within approximately one year.", "type": "number" }, "totalCurrentLiabilities": { "format": "double", "description": "Most Balance Sheets make a distinction between current and long-term liabilities. In cases where the distinction is not made, include the total of accounts payable, short-term notes payable, payroll taxes payable, and any other liability that would typically be paid by the company within one year.", "type": "number" }, "totalEquity": { "format": "double", "description": "All retained earnings, treasury stock, additional paid-in capital, and original investments in the company.", "type": "number" }, "totalLiabilities": { "format": "double", "description": "All amounts owed by the company as of the Balance Sheet date in question.", "type": "number" }, "totalLiabilitiesAndEquity": { "format": "double", "description": "Total Liabilities plus Total Equity. This amount equals Total Assets if the Balance Sheet is in balance.", "type": "number" }, "totalLongTermLiabilities": { "format": "double", "description": "The value of the firm's liabilities that will not need to be paid back for at least one year.", "type": "number" } }, "additionalProperties": false }, "FinancialInfoExtractAdditionalFieldsData": { "description": "Represents Financial Statement Additional Field Value", "type": "object", "properties": { "name": { "description": "Name of the Financial Statement Additional Field", "type": "string" }, "parent": { "description": "Parent Field of the Financial Statement Additional Field", "type": "string" }, "value": { "description": "Value of the Financial Statement Additional Field", "type": "string" } }, "additionalProperties": false }, "FinancialInfoExtractBusinessFinancialAdditionalFields": { "description": "Represents Financial Statement Additional Fields broken apart by section", "type": "object", "properties": { "additionalMetricsFields": { "description": "Additional Metrics Fields", "type": "object", "additionalProperties": { "type": "string" } }, "balanceSheetFields": { "description": "Balance Sheet Additional Fields", "type": "object", "additionalProperties": { "type": "string" } }, "incomeStatementFields": { "description": "Income Statement Additional Fields", "type": "object", "additionalProperties": { "type": "string" } }, "otherFields": { "description": "Other Additional Fields", "type": "object", "additionalProperties": { "type": "string" } }, "realEstateFields": { "description": "Real Estate Fields", "type": "object", "additionalProperties": { "type": "string" } }, "statementOfEquityFields": { "description": "Statement Of Equity Additional Fields", "type": "object", "additionalProperties": { "type": "string" } } }, "additionalProperties": false }, "FinancialInfoExtractBusinessFinancialAdditionalFieldsV2": { "description": "Represents Financial Statement Additional Fields broken apart by section", "type": "object", "properties": { "additionalMetricsFields": { "description": "Additional Metrics Fields", "type": "array", "items": { "$ref": "#/definitions/FinancialInfoExtractAdditionalFieldsData" } }, "balanceSheetFields": { "description": "Balance Sheet Additional Fields", "type": "array", "items": { "$ref": "#/definitions/FinancialInfoExtractAdditionalFieldsData" } }, "incomeStatementFields": { "description": "Income Statement Additional Fields", "type": "array", "items": { "$ref": "#/definitions/FinancialInfoExtractAdditionalFieldsData" } }, "otherFields": { "description": "Other Additional Fields", "type": "array", "items": { "$ref": "#/definitions/FinancialInfoExtractAdditionalFieldsData" } }, "realEstateFields": { "description": "Real Estate Fields", "type": "array", "items": { "$ref": "#/definitions/FinancialInfoExtractAdditionalFieldsData" } }, "statementOfEquityFields": { "description": "Statement Of Equity Additional Fields", "type": "array", "items": { "$ref": "#/definitions/FinancialInfoExtractAdditionalFieldsData" } } }, "additionalProperties": false }, "FinancialInfoExtractBusinessFinancialInformation": { "description": "Represents Business Financial Information in Sageworks", "type": "object", "properties": { "additionalFields": { "$ref": "#/definitions/FinancialInfoExtractBusinessFinancialAdditionalFields" }, "balanceSheet": { "$ref": "#/definitions/FinancialInfoBusinessBalanceSheet" }, "businessLoans": { "$ref": "#/definitions/FinancialInfoExtractBusinessLoans" }, "customerId": { "format": "int32", "description": "The id of the Customer this financial information record belongs to", "type": "integer" }, "dataSource": { "format": "string", "description": "Source of this financial data", "enum": [ "none", "annualized", "audit", "companyPrepared", "compilation", "financialStatement", "foreignCurrencyStatement", "merged", "other", "projection", "quickFinancials", "review", "sample", "taxReturn", "trailingTwelveMonths", "average", "payStub", "wTwo", "organizationPrepared", "selfReported" ], "type": "string" }, "id": { "format": "int32", "description": "Id of the business financial information in Sageworks", "type": "integer" }, "incomeStatement": { "$ref": "#/definitions/FinancialInfoExtractBusinessIncomeStatement" }, "periodEndDate": { "format": "Date", "description": "Period end date for this financial information record", "type": "string", "x-nullable": true }, "realEstateInvestment": { "description": "Collection of Real Estate Investment Fields for this financial statement", "type": "array", "items": { "$ref": "#/definitions/FinancialInfoExtractRealEstateInvestment" } }, "statementOfEquity": { "$ref": "#/definitions/FinancialInfoExtractBusinessStatementOfEquity" } }, "additionalProperties": false }, "FinancialInfoExtractBusinessFinancialInformationV2": { "description": "Represents Business Financial Information in Sageworks", "type": "object", "properties": { "additionalFields": { "$ref": "#/definitions/FinancialInfoExtractBusinessFinancialAdditionalFieldsV2" }, "balanceSheet": { "$ref": "#/definitions/FinancialInfoBusinessBalanceSheetV2" }, "businessLoans": { "$ref": "#/definitions/FinancialInfoExtractBusinessLoansV2" }, "customerId": { "format": "int32", "description": "The id of the Customer this financial information record belongs to", "type": "integer" }, "dataSource": { "format": "string", "description": "Source of this financial data", "enum": [ "none", "annualized", "audit", "companyPrepared", "compilation", "financialStatement", "foreignCurrencyStatement", "merged", "other", "projection", "quickFinancials", "review", "sample", "taxReturn", "trailingTwelveMonths", "average", "payStub", "wTwo", "organizationPrepared", "selfReported" ], "type": "string" }, "id": { "format": "int32", "description": "Id of the business financial information in Sageworks", "type": "integer" }, "incomeStatement": { "$ref": "#/definitions/FinancialInfoExtractBusinessIncomeStatementV2" }, "periodEndDate": { "format": "Date", "description": "Period end date for this financial information record", "type": "string", "x-nullable": true }, "realEstateInvestment": { "description": "Collection of Real Estate Investment Fields for this financial statement", "type": "array", "items": { "$ref": "#/definitions/FinancialInfoExtractRealEstateInvestmentV2" } }, "statementOfEquity": { "$ref": "#/definitions/FinancialInfoExtractBusinessStatementOfEquityV2" } }, "additionalProperties": false }, "FinancialInfoExtractBusinessIncomeStatement": { "description": "Represents the Income Statement Section of Business Financials", "type": "object", "properties": { "accountingFirm": { "description": "The name of the accounting firm that prepared the financial statement or tax return.", "type": "string" }, "accountingMethod": { "description": "Whether this data is based off the accrual method of accounting or the cash method of accounting.", "type": "string" }, "additionalFields": { "description": "Additional Income Statement Fields", "type": "object", "additionalProperties": { "type": "string" } }, "advertising": { "format": "double", "description": "Any advertising expense incurred by the company.", "type": "number" }, "amortization": { "format": "double", "description": "An estimate for the amount by which an intangible asset category has decreased in value over a certain period of time. Amortization expense is similar to depreciation expense except that amortization expense is applied to intangible assets, whereas depreciation expense is applied to fixed assets.", "type": "number" }, "comments": { "description": "Comments for income statement information.", "type": "string" }, "costOfSales": { "format": "double", "description": "The Income Statement of the company as the model for inputting values to this area.", "type": "number" }, "depreciation": { "format": "double", "description": "All depreciation expenses of the company. In the case where a company has other non-cash expenses associated with Plant, Property, and Equipment, include those costs as well. Do NOT include any depreciation already included in the Depreciation (COGS-related) account.", "type": "number" }, "depreciationCostOfSales": { "format": "double", "description": "This field should includes all depreciation-related expenses directly associated with Cost of Sales. Depreciation expenses NOT related to Cost of Sales should be included separately in the Depreciation field below.", "type": "number" }, "description": { "description": "The description that identifies this financial statement.", "type": "string" }, "ebitda": { "format": "double", "description": "Earnings before Interest, Taxes, Depreciation, and Amortization for the business entity.\r\n \r\nCalculation:\r\nEBITDA = Net Profit Before Taxes + Depreciation + COGS Depreciation + Amortization + Interest Expense + EBITDA Adjustments", "type": "number" }, "ebitdaAdjustments": { "format": "double", "description": "Any adjustments that should be made to the EBITDA calculation for which would otherwise not be accounted.\r\n \r\nNote this amount does not affect net income.", "type": "number" }, "extraordinaryGain": { "format": "double", "description": "Any income generated by the company outside of normal operations that is neither regular nor recurring.", "type": "number" }, "extraordinaryLoss": { "format": "double", "description": "Any non-operating expenses incurred by the company that are neither regular nor recurring.", "type": "number" }, "gaPayrollExpense": { "format": "double", "description": "This field should includes all wages, salaries, payroll taxes, and other employer-related payroll expenses (health insurance, pension funds, etc.).", "type": "number" }, "grossProfit": { "format": "double", "description": "Gross Profit is the excess of revenue after subtracting out cost of sales. The Gross Profit field is calculated according to the formula: Gross Profit = Sales - Cost of Sales.", "type": "number" }, "interestExpense": { "format": "double", "description": "All costs associated with borrowing activities. How much money was paid in interest?", "type": "number" }, "netIncome": { "format": "double", "description": "Equals sales minus any and all expenses of the company. Keep in mind that net income, which will be expressed as a negative or positive number, is the very last number that appears on the Income Statement.\r\n \r\nCalculation:\r\nNet Income = Net Profit Before Taxes - Taxes Paid + Extraordinary Gain - Extraordinary Loss", "type": "number" }, "netProfitBeforeTaxes": { "format": "double", "description": "The company's net profit for the period before income taxes are paid. Extraordinary gains or losses are not included in this field.\r\n \r\nCalculation:\r\nNet Profit Before Taxes = Operating Profit - Interest Expense + Other Income - Other Expenses", "type": "number" }, "operatingProfit": { "format": "double", "description": "Income or loss from normal business operations before tax.\r\n \r\nCalculation: Gross Profit + Other Operating Income - Total Operating Expenses", "type": "number" }, "otherExpenses": { "format": "double", "description": "Any regular and recurring expense incurred by the company that has not already been included above.", "type": "number" }, "otherIncome": { "format": "double", "description": "Any regular and recurring income generated by the company that has not already been included above.", "type": "number" }, "otherOperatingExpenses": { "format": "double", "description": "Any operating expenses not already accounted for.", "type": "number" }, "otherOperatingIncome": { "format": "double", "description": "Any operating income not already accounted for.", "type": "number" }, "overheadOrSGAExpenses": { "format": "double", "description": "This represents costs involved with the day-to-day operations of the company. Include rent, utilities, other overhead, and all selling, general, and administrative costs, which have been incurred and are not already covered by the Cost of Sales (COGS) measure.", "type": "number" }, "periodDuration": { "format": "int32", "description": "This field gives the length (in months) of the period in question.", "type": "integer" }, "personEnteringData": { "description": "The name of the person who prepared the data for this period.", "type": "string" }, "rent": { "format": "double", "description": "The total amount of rent paid by the company.", "type": "number" }, "salesIncome": { "format": "double", "description": "All sales and revenues for the company. It would be best to include net revenues (gross revenues less any allowances).", "type": "number" }, "taxesPaid": { "format": "double", "description": "The amount of taxes paid by the company on its most recent tax filing corresponding to the period length being analyzed.", "type": "number" }, "totalOperatingExpenses": { "format": "double", "type": "number" }, "unadjustedEBITDA": { "format": "double", "description": "This is the EBITDA before any adjustments are made.\r\n \r\nCalculation:\r\nUnadjusted EBITDA = Net Profit Before Taxes + Depreciation + COGS Depreciation + Amortization + Interest Expense", "type": "number" } }, "additionalProperties": false }, "FinancialInfoExtractBusinessIncomeStatementV2": { "description": "Represents the Income Statement Section of Business Financials", "type": "object", "properties": { "accountingFirm": { "description": "The name of the accounting firm that prepared the financial statement or tax return.", "type": "string" }, "accountingMethod": { "description": "Whether this data is based off the accrual method of accounting or the cash method of accounting.", "type": "string" }, "additionalFields": { "description": "Additional Income Statement Fields", "type": "array", "items": { "$ref": "#/definitions/FinancialInfoExtractAdditionalFieldsData" } }, "advertising": { "format": "double", "description": "Any advertising expense incurred by the company.", "type": "number" }, "amortization": { "format": "double", "description": "An estimate for the amount by which an intangible asset category has decreased in value over a certain period of time. Amortization expense is similar to depreciation expense except that amortization expense is applied to intangible assets, whereas depreciation expense is applied to fixed assets.", "type": "number" }, "comments": { "description": "Comments for income statement information.", "type": "string" }, "costOfSales": { "format": "double", "description": "The Income Statement of the company as the model for inputting values to this area.", "type": "number" }, "depreciation": { "format": "double", "description": "All depreciation expenses of the company. In the case where a company has other non-cash expenses associated with Plant, Property, and Equipment, include those costs as well. Do NOT include any depreciation already included in the Depreciation (COGS-related) account.", "type": "number" }, "depreciationCostOfSales": { "format": "double", "description": "This field should includes all depreciation-related expenses directly associated with Cost of Sales. Depreciation expenses NOT related to Cost of Sales should be included separately in the Depreciation field below.", "type": "number" }, "description": { "description": "The description that identifies this financial statement.", "type": "string" }, "ebitda": { "format": "double", "description": "Earnings before Interest, Taxes, Depreciation, and Amortization for the business entity.\r\n \r\nCalculation:\r\nEBITDA = Net Profit Before Taxes + Depreciation + COGS Depreciation + Amortization + Interest Expense + EBITDA Adjustments", "type": "number" }, "ebitdaAdjustments": { "format": "double", "description": "Any adjustments that should be made to the EBITDA calculation for which would otherwise not be accounted.\r\n \r\nNote this amount does not affect net income.", "type": "number" }, "extraordinaryGain": { "format": "double", "description": "Any income generated by the company outside of normal operations that is neither regular nor recurring.", "type": "number" }, "extraordinaryLoss": { "format": "double", "description": "Any non-operating expenses incurred by the company that are neither regular nor recurring.", "type": "number" }, "gaPayrollExpense": { "format": "double", "description": "This field should includes all wages, salaries, payroll taxes, and other employer-related payroll expenses (health insurance, pension funds, etc.).", "type": "number" }, "grossProfit": { "format": "double", "description": "Gross Profit is the excess of revenue after subtracting out cost of sales. The Gross Profit field is calculated according to the formula: Gross Profit = Sales - Cost of Sales.", "type": "number" }, "interestExpense": { "format": "double", "description": "All costs associated with borrowing activities. How much money was paid in interest?", "type": "number" }, "netIncome": { "format": "double", "description": "Equals sales minus any and all expenses of the company. Keep in mind that net income, which will be expressed as a negative or positive number, is the very last number that appears on the Income Statement.\r\n \r\nCalculation:\r\nNet Income = Net Profit Before Taxes - Taxes Paid + Extraordinary Gain - Extraordinary Loss", "type": "number" }, "netProfitBeforeTaxes": { "format": "double", "description": "The company's net profit for the period before income taxes are paid. Extraordinary gains or losses are not included in this field.\r\n \r\nCalculation:\r\nNet Profit Before Taxes = Operating Profit - Interest Expense + Other Income - Other Expenses", "type": "number" }, "operatingProfit": { "format": "double", "description": "Income or loss from normal business operations before tax.\r\n \r\nCalculation: Gross Profit + Other Operating Income - Total Operating Expenses", "type": "number" }, "otherExpenses": { "format": "double", "description": "Any regular and recurring expense incurred by the company that has not already been included above.", "type": "number" }, "otherIncome": { "format": "double", "description": "Any regular and recurring income generated by the company that has not already been included above.", "type": "number" }, "otherOperatingExpenses": { "format": "double", "description": "Any operating expenses not already accounted for.", "type": "number" }, "otherOperatingIncome": { "format": "double", "description": "Any operating income not already accounted for.", "type": "number" }, "overheadOrSGAExpenses": { "format": "double", "description": "This represents costs involved with the day-to-day operations of the company. Include rent, utilities, other overhead, and all selling, general, and administrative costs, which have been incurred and are not already covered by the Cost of Sales (COGS) measure.", "type": "number" }, "periodDuration": { "format": "int32", "description": "This field gives the length (in months) of the period in question.", "type": "integer" }, "personEnteringData": { "description": "The name of the person who prepared the data for this period.", "type": "string" }, "rent": { "format": "double", "description": "The total amount of rent paid by the company.", "type": "number" }, "salesIncome": { "format": "double", "description": "All sales and revenues for the company. It would be best to include net revenues (gross revenues less any allowances).", "type": "number" }, "taxesPaid": { "format": "double", "description": "The amount of taxes paid by the company on its most recent tax filing corresponding to the period length being analyzed.", "type": "number" }, "totalOperatingExpenses": { "format": "double", "type": "number" }, "unadjustedEBITDA": { "format": "double", "description": "This is the EBITDA before any adjustments are made.\r\n \r\nCalculation:\r\nUnadjusted EBITDA = Net Profit Before Taxes + Depreciation + COGS Depreciation + Amortization + Interest Expense", "type": "number" } }, "additionalProperties": false }, "FinancialInfoExtractBusinessLoans": { "description": "Represents the Business Loans Section of Business Financials", "type": "object", "properties": { "additionalFields": { "description": "Additional Business Loan Fields", "type": "object", "additionalProperties": { "type": "string" } }, "currentPortionOfLongTermDebt": { "format": "double", "description": "The portion of Long Term Liabilities being paid off within 12 months of the particular financial statement date and notes payable that have a maturity of less than one year.", "type": "number" }, "itemizedAnnualDebtService": { "format": "double", "description": "This is the annual debt service payment for the customer as calculated from the loans.", "type": "number" }, "notesPayableSeniorDebt": { "format": "double", "description": "This term applies to debt which has seniority or preference in case of a default or bankruptcy.", "type": "number" }, "notesPayableSubordinatedDebt": { "format": "double", "description": "This term applies to liabilities that are subordinate or have less preference in case of a default or bankruptcy.", "type": "number" }, "otherAnnualDebtService": { "format": "double", "description": "This is the annual debt service payment for debt responsibilities that are not itemized below. You may enter an annual debt service amount here if you do not have information about some or all of the loans.", "type": "number" }, "outstandingBalanceSheetDebt": { "format": "double", "description": "TotalBalanceofAllCurrentLoans subtracted from TotalDebtFromBalanceSheet", "type": "number" }, "refinancedOtherDebtService": { "format": "double", "description": "This is the portion of the other debt service to be refinanced and included in the calculation of proposed debt service and proposed debt service coverage ratio.", "type": "number" }, "shortTermDebt": { "format": "double", "description": "The outstanding balance of any short term debt owed by the organization. This may include lines of credit, short term operating loans, etc.", "type": "number" }, "totalBalanceOfAllCurrentLoans": { "format": "double", "description": "Total Balance of All Current Loans", "type": "number" }, "totalDebtFromBalanceSheet": { "format": "double", "description": "Total debt from balance sheet (consists of ShortTermDebt, CurrentPortionOfLongTermDebt, NotesPayableSeniorDebt and NotesPayableSubordinatedDebt).", "type": "number" } }, "additionalProperties": false }, "FinancialInfoExtractBusinessLoansV2": { "description": "Represents the Business Loans Section of Business Financials", "type": "object", "properties": { "additionalFields": { "description": "Additional Business Loan Fields", "type": "array", "items": { "$ref": "#/definitions/FinancialInfoExtractAdditionalFieldsData" } }, "currentPortionOfLongTermDebt": { "format": "double", "description": "The portion of Long Term Liabilities being paid off within 12 months of the particular financial statement date and notes payable that have a maturity of less than one year.", "type": "number" }, "itemizedAnnualDebtService": { "format": "double", "description": "This is the annual debt service payment for the customer as calculated from the loans.", "type": "number" }, "notesPayableSeniorDebt": { "format": "double", "description": "This term applies to debt which has seniority or preference in case of a default or bankruptcy.", "type": "number" }, "notesPayableSubordinatedDebt": { "format": "double", "description": "This term applies to liabilities that are subordinate or have less preference in case of a default or bankruptcy.", "type": "number" }, "otherAnnualDebtService": { "format": "double", "description": "This is the annual debt service payment for debt responsibilities that are not itemized below. You may enter an annual debt service amount here if you do not have information about some or all of the loans.", "type": "number" }, "outstandingBalanceSheetDebt": { "format": "double", "description": "TotalBalanceofAllCurrentLoans subtracted from TotalDebtFromBalanceSheet", "type": "number" }, "refinancedOtherDebtService": { "format": "double", "description": "This is the portion of the other debt service to be refinanced and included in the calculation of proposed debt service and proposed debt service coverage ratio.", "type": "number" }, "shortTermDebt": { "format": "double", "description": "The outstanding balance of any short term debt owed by the organization. This may include lines of credit, short term operating loans, etc.", "type": "number" }, "totalBalanceOfAllCurrentLoans": { "format": "double", "description": "Total Balance of All Current Loans", "type": "number" }, "totalDebtFromBalanceSheet": { "format": "double", "description": "Total debt from balance sheet (consists of ShortTermDebt, CurrentPortionOfLongTermDebt, NotesPayableSeniorDebt and NotesPayableSubordinatedDebt).", "type": "number" } }, "additionalProperties": false }, "FinancialInfoExtractBusinessStatementOfEquity": { "description": "Represents the Statement Of Equity Section of Business Financials", "type": "object", "properties": { "actualEndingRetainedEarningsFromBalanceSheet": { "format": "double", "description": "The value entered on the balance sheet.", "type": "number" }, "additionalFields": { "description": "Additional Statement of Equity Fields", "type": "object", "additionalProperties": { "type": "string" } }, "beginningRetainedEarnings": { "format": "double", "description": "The retained earnings balance at the beginning of the period being analyzed.", "type": "number" }, "calculatedEndingRetainedEarnings": { "format": "double", "description": "Calculated: Beginning Retained Earnings + Net Income - Dividends Paid/Withdrawals + Other changes to retained earnings.", "type": "number" }, "comments": { "description": "Comments for the statement of equity.", "type": "string" }, "differenceUnexplainedChangeInRetainedEarnings": { "format": "double", "description": "The difference between the calculated ending retained earnings and the retained earnings entered on the balance sheet.", "type": "number" }, "dividendsPaidWithdrawals": { "format": "double", "description": "The amount of any distributions made to the company's shareholders / owners.", "type": "number" }, "netIncome": { "format": "double", "description": "This field should equal sales minus any and all expenses of the company. Keep in mind that net income, which will be expressed as a negative or positive number, is the very last number that appears on the Income Statement.", "type": "number" }, "otherChangesToRetainedEarnings": { "format": "double", "description": "Any changes to retained earnings not already accounted for.", "type": "number" }, "specifyLoanInformation": { "description": "Whether there is detailed loan information for this financial.", "type": "boolean" }, "specifyRealEstateInvestments": { "description": "Whether the business own real estate / properties.", "type": "boolean" } }, "additionalProperties": false }, "FinancialInfoExtractBusinessStatementOfEquityV2": { "description": "Represents the Statement Of Equity Section of Business Financials", "type": "object", "properties": { "actualEndingRetainedEarningsFromBalanceSheet": { "format": "double", "description": "The value entered on the balance sheet.", "type": "number" }, "additionalFields": { "description": "Additional Statement of Equity Fields", "type": "array", "items": { "$ref": "#/definitions/FinancialInfoExtractAdditionalFieldsData" } }, "beginningRetainedEarnings": { "format": "double", "description": "The retained earnings balance at the beginning of the period being analyzed.", "type": "number" }, "calculatedEndingRetainedEarnings": { "format": "double", "description": "Calculated: Beginning Retained Earnings + Net Income - Dividends Paid/Withdrawals + Other changes to retained earnings.", "type": "number" }, "comments": { "description": "Comments for the statement of equity.", "type": "string" }, "differenceUnexplainedChangeInRetainedEarnings": { "format": "double", "description": "The difference between the calculated ending retained earnings and the retained earnings entered on the balance sheet.", "type": "number" }, "dividendsPaidWithdrawals": { "format": "double", "description": "The amount of any distributions made to the company's shareholders / owners.", "type": "number" }, "netIncome": { "format": "double", "description": "This field should equal sales minus any and all expenses of the company. Keep in mind that net income, which will be expressed as a negative or positive number, is the very last number that appears on the Income Statement.", "type": "number" }, "otherChangesToRetainedEarnings": { "format": "double", "description": "Any changes to retained earnings not already accounted for.", "type": "number" }, "specifyLoanInformation": { "description": "Whether there is detailed loan information for this financial.", "type": "boolean" }, "specifyRealEstateInvestments": { "description": "Whether the business own real estate / properties.", "type": "boolean" } }, "additionalProperties": false }, "FinancialInfoExtractNonProfitFinancialInformation": { "description": "Represents Non Profit Financial Information in Sageworks", "type": "object", "properties": { "additionalFields": { "$ref": "#/definitions/FinancialInfoExtractNonprofitFinancialAdditionalFields" }, "breakoutOption": { "description": "Breakout option for this financial data", "type": "string" }, "customerId": { "format": "int32", "description": "The id of the Customer this financial information record belongs to", "type": "integer" }, "dataSource": { "format": "string", "description": "Source of this financial data", "enum": [ "none", "annualized", "audit", "companyPrepared", "compilation", "financialStatement", "foreignCurrencyStatement", "merged", "other", "projection", "quickFinancials", "review", "sample", "taxReturn", "trailingTwelveMonths", "average", "payStub", "wTwo", "organizationPrepared", "selfReported" ], "type": "string" }, "id": { "format": "int32", "description": "Id of the non profit financial information in Sageworks", "type": "integer" }, "nonprofitLoans": { "$ref": "#/definitions/FinancialInfoExtractNonprofitLoans" }, "periodEndDate": { "format": "Date", "description": "Period end date for this financial information record", "type": "string", "x-nullable": true }, "reconciliationOfNetAssets": { "$ref": "#/definitions/FinancialInfoExtractReconciliationOfNetAssets" }, "statementOfActivities": { "$ref": "#/definitions/FinancialInfoExtractStatementOfActivities" }, "statementOfActivitiesDonorRestricted": { "$ref": "#/definitions/FinancialInfoExtractStatementOfActivitiesDonorRestricted" }, "statementOfActivitiesPermRestricted": { "$ref": "#/definitions/FinancialInfoExtractStatementOfActivitiesPermRestricted" }, "statementOfActivitiesTempRestricted": { "$ref": "#/definitions/FinancialInfoExtractStatementOfActivitiesTempRestricted" }, "statementOfFinancialPosition": { "$ref": "#/definitions/FinancialInfoExtractStatementOfFinancialPosition" } }, "additionalProperties": false }, "FinancialInfoExtractNonProfitFinancialInformationV2": { "description": "Represents Non Profit Financial Information in Sageworks", "type": "object", "properties": { "additionalFields": { "$ref": "#/definitions/FinancialInfoExtractNonprofitFinancialAdditionalFieldsV2" }, "breakoutOption": { "description": "Breakout option for this financial data", "type": "string" }, "customerId": { "format": "int32", "description": "The id of the Customer this financial information record belongs to", "type": "integer" }, "dataSource": { "format": "string", "description": "Source of this financial data", "enum": [ "none", "annualized", "audit", "companyPrepared", "compilation", "financialStatement", "foreignCurrencyStatement", "merged", "other", "projection", "quickFinancials", "review", "sample", "taxReturn", "trailingTwelveMonths", "average", "payStub", "wTwo", "organizationPrepared", "selfReported" ], "type": "string" }, "id": { "format": "int32", "description": "Id of the non profit financial information in Sageworks", "type": "integer" }, "nonprofitLoans": { "$ref": "#/definitions/FinancialInfoExtractNonprofitLoansV2" }, "periodEndDate": { "format": "Date", "description": "Period end date for this financial information record", "type": "string", "x-nullable": true }, "reconciliationOfNetAssets": { "$ref": "#/definitions/FinancialInfoExtractReconciliationOfNetAssetsV2" }, "statementOfActivities": { "$ref": "#/definitions/FinancialInfoExtractStatementOfActivitiesV2" }, "statementOfActivitiesDonorRestricted": { "$ref": "#/definitions/FinancialInfoExtractStatementOfActivitiesDonorRestrictedV2" }, "statementOfActivitiesPermRestricted": { "$ref": "#/definitions/FinancialInfoExtractStatementOfActivitiesPermRestrictedV2" }, "statementOfActivitiesTempRestricted": { "$ref": "#/definitions/FinancialInfoExtractStatementOfActivitiesTempRestrictedV2" }, "statementOfFinancialPosition": { "$ref": "#/definitions/FinancialInfoExtractStatementOfFinancialPositionV2" } }, "additionalProperties": false }, "FinancialInfoExtractNonprofitFinancialAdditionalFields": { "description": "Nonprofit Additional Fields broken apart by section", "type": "object", "properties": { "statementOfActivitiesFields": { "description": "Statement of Activities Additional Fields", "type": "object", "additionalProperties": { "type": "string" } }, "statementOfActivitiesPermRestrictedFields": { "description": "Statement of Activities Perm Restricted Additional Fields", "type": "object", "additionalProperties": { "type": "string" } }, "statementOfActivitiesTempRestrictedFields": { "description": "Statement of Activities Temp Restricted Additional Fields", "type": "object", "additionalProperties": { "type": "string" } } }, "additionalProperties": false }, "FinancialInfoExtractNonprofitFinancialAdditionalFieldsV2": { "description": "Nonprofit Additional Fields broken apart by section", "type": "object", "properties": { "statementOfActivitiesFields": { "description": "Statement of Activities Additional Fields", "type": "array", "items": { "$ref": "#/definitions/FinancialInfoExtractAdditionalFieldsData" } }, "statementOfActivitiesPermRestrictedFields": { "description": "Statement of Activities Perm Restricted Additional Fields", "type": "array", "items": { "$ref": "#/definitions/FinancialInfoExtractAdditionalFieldsData" } }, "statementOfActivitiesTempRestrictedFields": { "description": "Statement of Activities Temp Restricted Additional Fields", "type": "array", "items": { "$ref": "#/definitions/FinancialInfoExtractAdditionalFieldsData" } } }, "additionalProperties": false }, "FinancialInfoExtractNonprofitLoans": { "description": "Represents Non Profit Loans in Sageworks", "type": "object", "properties": { "additionalFields": { "description": "Additional Non profit loan fields", "type": "object", "additionalProperties": { "type": "string" } }, "currentPortionOfLongTermDebt": { "format": "double", "description": "The portion of Long Term Liabilities being paid off within 12 months of the particular financial statement date and notes payable that have a maturity of less than one year.", "type": "number" }, "itemizedAnnualDebtService": { "format": "double", "description": "This is the annual debt service payment for the customer as calculated from the loans.", "type": "number" }, "notesPayableSeniorDebt": { "format": "double", "description": "This term applies to debt which has seniority or preference in case of a default or bankruptcy.", "type": "number" }, "notesPayableSubordinatedDebt": { "format": "double", "description": "This term applies to liabilities that are subordinate or have less preference in case of a default or bankruptcy.", "type": "number" }, "otherAnnualDebtService": { "format": "double", "description": "This is the annual debt service payment for the customer as calculated from the loans.", "type": "number" }, "outstandingBalanceSheetDebt": { "format": "double", "description": "TotalBalanceofAllCurrentLoans subtracted from TotalDebtFromBalanceSheet", "type": "number" }, "portionOfOtherDebtServiceToBeRefinanced": { "format": "double", "description": "This is the portion of the other debt service to be refinanced and included in the calculation of proposed debt service and proposed debt service coverage ratio.", "type": "number" }, "shortTermDebt": { "format": "double", "description": "The outstanding balance of any short term debt owed by the organization. This may include lines of credit, short term operating loans, etc.", "type": "number" }, "totalBalanceOfAllCurrentLoans": { "format": "double", "description": "Total Balance of All Current Loans", "type": "number" }, "totalDebtFromBalanceSheet": { "format": "double", "description": "Total debt from balance sheet (consists of ShortTermDebt, CurrentPortionOfLongTermDebt, NotesPayableSeniorDebt and NotesPayableSubordinatedDebt).", "type": "number" }, "totalProposedDebtService": { "format": "double", "description": "This is the total proposed annual debt service of the customer calculated by adding the Total Annual Proposed Debt Service to the debt service from proposed loans and subtracting out the debt service of refinanced loans.", "type": "number" } }, "additionalProperties": false }, "FinancialInfoExtractNonprofitLoansV2": { "description": "Represents Non Profit Loans in Sageworks", "type": "object", "properties": { "additionalFields": { "description": "Additional Non profit loan fields", "type": "array", "items": { "$ref": "#/definitions/FinancialInfoExtractAdditionalFieldsData" } }, "currentPortionOfLongTermDebt": { "format": "double", "description": "The portion of Long Term Liabilities being paid off within 12 months of the particular financial statement date and notes payable that have a maturity of less than one year.", "type": "number" }, "itemizedAnnualDebtService": { "format": "double", "description": "This is the annual debt service payment for the customer as calculated from the loans.", "type": "number" }, "notesPayableSeniorDebt": { "format": "double", "description": "This term applies to debt which has seniority or preference in case of a default or bankruptcy.", "type": "number" }, "notesPayableSubordinatedDebt": { "format": "double", "description": "This term applies to liabilities that are subordinate or have less preference in case of a default or bankruptcy.", "type": "number" }, "otherAnnualDebtService": { "format": "double", "description": "This is the annual debt service payment for the customer as calculated from the loans.", "type": "number" }, "outstandingBalanceSheetDebt": { "format": "double", "description": "TotalBalanceofAllCurrentLoans subtracted from TotalDebtFromBalanceSheet", "type": "number" }, "portionOfOtherDebtServiceToBeRefinanced": { "format": "double", "description": "This is the portion of the other debt service to be refinanced and included in the calculation of proposed debt service and proposed debt service coverage ratio.", "type": "number" }, "shortTermDebt": { "format": "double", "description": "The outstanding balance of any short term debt owed by the organization. This may include lines of credit, short term operating loans, etc.", "type": "number" }, "totalBalanceOfAllCurrentLoans": { "format": "double", "description": "Total Balance of All Current Loans", "type": "number" }, "totalDebtFromBalanceSheet": { "format": "double", "description": "Total debt from balance sheet (consists of ShortTermDebt, CurrentPortionOfLongTermDebt, NotesPayableSeniorDebt and NotesPayableSubordinatedDebt).", "type": "number" }, "totalProposedDebtService": { "format": "double", "description": "This is the total proposed annual debt service of the customer calculated by adding the Total Annual Proposed Debt Service to the debt service from proposed loans and subtracting out the debt service of refinanced loans.", "type": "number" } }, "additionalProperties": false }, "FinancialInfoExtractPersonalAssets": { "description": "Represents the Personal Assets section of Personal Financials", "type": "object", "properties": { "additionalFields": { "description": "Additional Personal Asset Fields", "type": "object", "additionalProperties": { "type": "string" } }, "automobiles": { "format": "double", "description": "An estimate of the current value of all automobiles.", "type": "number" }, "cashCheckingSavingsMoneyMarket": { "format": "double", "description": "The total cash on hand.", "type": "number" }, "cashValueOfLifeInsurance": { "format": "double", "description": "Total cash value of all life insurance policies.", "type": "number" }, "closelyHeldCompanyStock": { "format": "double", "description": "The value of stock the individual has in closely held companies.", "type": "number" }, "comments": { "description": "Comments for personal assets information.", "type": "string" }, "furnitureFixtures": { "format": "double", "description": "An estimate of the current value of furniture and fixtures on hand.", "type": "number" }, "jewelry": { "format": "double", "description": "An estimate of the current value of all jewelry.", "type": "number" }, "mutualFundsOrPooledSecurities": { "format": "double", "description": "The total of funds invested in mutual funds or other pooled securities.", "type": "number" }, "otherLiquidOrSemiLiquidAssetsOnHand": { "format": "double", "description": "All other liquid or semi-liquid assets that you have not previously entered.", "type": "number" }, "otherPersonalAssets": { "format": "double", "description": "An estimate of the current value of other personal assets that you have not previously entered.", "type": "number" }, "publicCompanyStocksBonds": { "format": "double", "description": "The total investment in stock and bonds that can be converted to cash within 7-10 business days.", "type": "number" }, "retirementAccounts": { "format": "double", "description": "All retirement funds that can be converted into cash within 30-120 days.", "type": "number" }, "totalAssets": { "format": "double", "description": "The total value of all assets.", "type": "number" }, "totalLiquidAndSemiLiquidAssetsOnHand": { "format": "double", "description": "The total value of all current assets which is defined as cash (liquid) and/or assets easily converted to cash (semi-liquid).", "type": "number" }, "totalValueOfBusinessAndInvestmentHoldings": { "format": "double", "description": "Total value of all business and investment holdings that have been entered on the previously seen Business Investments screen.", "type": "number" }, "totalValueOfRealEstateInvestments": { "format": "double", "description": "Total value of all real estate investments that have been entered on the previously seen Real Estate Investments screen.", "type": "number" }, "valueOfItemizedRealEstateInvestments": { "format": "double", "description": "Total value of all real estate investments that have been entered on the previously seen Real Estate Investments screen.", "type": "number" }, "valueOfOtherNonInvestmentProperties": { "format": "double", "description": "An estimate of the current value of all other non-investment real estate holdings.", "type": "number" }, "valueOfOtherRealEstateInvestments": { "format": "double", "description": "Total value of real estate investments that have not been entered on the previously seen Real Estate Investments screen.", "type": "number" }, "valueOfPersonalResidence": { "format": "double", "description": "An estimate of the current value of the primary residence.", "type": "number" } }, "additionalProperties": false }, "FinancialInfoExtractPersonalAssetsV2": { "description": "Represents the Personal Assets section of Personal Financials", "type": "object", "properties": { "additionalFields": { "description": "Additional Personal Asset Fields", "type": "array", "items": { "$ref": "#/definitions/FinancialInfoExtractAdditionalFieldsData" } }, "automobiles": { "format": "double", "description": "An estimate of the current value of all automobiles.", "type": "number" }, "cashCheckingSavingsMoneyMarket": { "format": "double", "description": "The total cash on hand.", "type": "number" }, "cashValueOfLifeInsurance": { "format": "double", "description": "Total cash value of all life insurance policies.", "type": "number" }, "closelyHeldCompanyStock": { "format": "double", "description": "The value of stock the individual has in closely held companies.", "type": "number" }, "comments": { "description": "Comments for personal assets information.", "type": "string" }, "furnitureFixtures": { "format": "double", "description": "An estimate of the current value of furniture and fixtures on hand.", "type": "number" }, "jewelry": { "format": "double", "description": "An estimate of the current value of all jewelry.", "type": "number" }, "mutualFundsOrPooledSecurities": { "format": "double", "description": "The total of funds invested in mutual funds or other pooled securities.", "type": "number" }, "otherLiquidOrSemiLiquidAssetsOnHand": { "format": "double", "description": "All other liquid or semi-liquid assets that you have not previously entered.", "type": "number" }, "otherPersonalAssets": { "format": "double", "description": "An estimate of the current value of other personal assets that you have not previously entered.", "type": "number" }, "publicCompanyStocksBonds": { "format": "double", "description": "The total investment in stock and bonds that can be converted to cash within 7-10 business days.", "type": "number" }, "retirementAccounts": { "format": "double", "description": "All retirement funds that can be converted into cash within 30-120 days.", "type": "number" }, "totalAssets": { "format": "double", "description": "The total value of all assets.", "type": "number" }, "totalLiquidAndSemiLiquidAssetsOnHand": { "format": "double", "description": "The total value of all current assets which is defined as cash (liquid) and/or assets easily converted to cash (semi-liquid).", "type": "number" }, "totalValueOfBusinessAndInvestmentHoldings": { "format": "double", "description": "Total value of all business and investment holdings that have been entered on the previously seen Business Investments screen.", "type": "number" }, "totalValueOfRealEstateInvestments": { "format": "double", "description": "Total value of all real estate investments that have been entered on the previously seen Real Estate Investments screen.", "type": "number" }, "valueOfItemizedRealEstateInvestments": { "format": "double", "description": "Total value of all real estate investments that have been entered on the previously seen Real Estate Investments screen.", "type": "number" }, "valueOfOtherNonInvestmentProperties": { "format": "double", "description": "An estimate of the current value of all other non-investment real estate holdings.", "type": "number" }, "valueOfOtherRealEstateInvestments": { "format": "double", "description": "Total value of real estate investments that have not been entered on the previously seen Real Estate Investments screen.", "type": "number" }, "valueOfPersonalResidence": { "format": "double", "description": "An estimate of the current value of the primary residence.", "type": "number" } }, "additionalProperties": false }, "FinancialInfoExtractPersonalBusinessInvestment": { "description": "Represents a Business Investment", "type": "object", "properties": { "cashFlow": { "format": "double", "description": "The individual's share of any cash flow generated by the business.", "type": "number" }, "comments": { "description": "Any comments related to this investment.", "type": "string" }, "customerId": { "format": "int32", "description": "The business in which the person has an investment.", "type": "integer" }, "estimatedValueOfOwnership": { "format": "double", "description": "The estimated value of the ownership.", "type": "number" }, "percentOwnership": { "format": "double", "description": "The person's percent ownership of this investment.", "type": "number" } }, "additionalProperties": false }, "FinancialInfoExtractPersonalFinancialAdditionalFields": { "description": "Represents Financial Statement Additional Fields broken apart by section", "type": "object", "properties": { "additionalMetricsFields": { "description": "Additional Metrics Fields", "type": "object", "additionalProperties": { "type": "string" } }, "balanceSheetFields": { "description": "Balance Sheet Additional Fields", "type": "object", "additionalProperties": { "type": "string" } }, "incomeAndExpensesFields": { "description": "Income Statement Additional Fields", "type": "object", "additionalProperties": { "type": "string" } }, "otherFields": { "description": "Other Additional Fields", "type": "object", "additionalProperties": { "type": "string" } }, "realEstateFields": { "description": "Real Estate Fields", "type": "object", "additionalProperties": { "type": "string" } } }, "additionalProperties": false }, "FinancialInfoExtractPersonalFinancialAdditionalFieldsV2": { "description": "Represents Financial Statement Additional Fields broken apart by section", "type": "object", "properties": { "additionalMetricsFields": { "description": "Additional Metrics Fields", "type": "array", "items": { "$ref": "#/definitions/FinancialInfoExtractAdditionalFieldsData" } }, "balanceSheetFields": { "description": "Balance Sheet Additional Fields", "type": "array", "items": { "$ref": "#/definitions/FinancialInfoExtractAdditionalFieldsData" } }, "incomeAndExpensesFields": { "description": "Income Statement Additional Fields", "type": "array", "items": { "$ref": "#/definitions/FinancialInfoExtractAdditionalFieldsData" } }, "otherFields": { "description": "Other Additional Fields", "type": "array", "items": { "$ref": "#/definitions/FinancialInfoExtractAdditionalFieldsData" } }, "realEstateFields": { "description": "Real Estate Fields", "type": "array", "items": { "$ref": "#/definitions/FinancialInfoExtractAdditionalFieldsData" } } }, "additionalProperties": false }, "FinancialInfoExtractPersonalFinancialInformation": { "description": "Represents Personal Financial Information in Sageworks", "type": "object", "properties": { "additionalFields": { "$ref": "#/definitions/FinancialInfoExtractPersonalFinancialAdditionalFields" }, "businessInvestments": { "description": "Personal Business Investments", "type": "array", "items": { "$ref": "#/definitions/FinancialInfoExtractPersonalBusinessInvestment" } }, "customerId": { "format": "int32", "description": "The id of the Customer this financial information record belongs to", "type": "integer" }, "dataSource": { "format": "string", "description": "Source of this financial data", "enum": [ "none", "annualized", "audit", "companyPrepared", "compilation", "financialStatement", "foreignCurrencyStatement", "merged", "other", "projection", "quickFinancials", "review", "sample", "taxReturn", "trailingTwelveMonths", "average", "payStub", "wTwo", "organizationPrepared", "selfReported" ], "type": "string" }, "id": { "format": "int32", "description": "Id of the business financial information in Sageworks", "type": "integer" }, "incomeAndExpenses": { "$ref": "#/definitions/FinancialInfoExtractPersonalIncomeAndExpenses" }, "periodEndDate": { "format": "Date", "description": "Period end date for this financial information record", "type": "string", "x-nullable": true }, "personalAssets": { "$ref": "#/definitions/FinancialInfoExtractPersonalAssets" }, "personalLiabilities": { "$ref": "#/definitions/FinancialInfoExtractPersonalLiabilities" }, "realEstateInvestments": { "description": "Personal Real Estate Investments", "type": "array", "items": { "$ref": "#/definitions/FinancialInfoExtractRealEstateInvestment" } }, "recurringDebt": { "$ref": "#/definitions/FinancialInfoExtractPersonalRecurringDebt" } }, "additionalProperties": false }, "FinancialInfoExtractPersonalFinancialInformationV2": { "description": "Represents Personal Financial Information in Sageworks", "type": "object", "properties": { "additionalFields": { "$ref": "#/definitions/FinancialInfoExtractPersonalFinancialAdditionalFieldsV2" }, "businessInvestments": { "description": "Personal Business Investments", "type": "array", "items": { "$ref": "#/definitions/FinancialInfoExtractPersonalBusinessInvestment" } }, "customerId": { "format": "int32", "description": "The id of the Customer this financial information record belongs to", "type": "integer" }, "dataSource": { "format": "string", "description": "Source of this financial data", "enum": [ "none", "annualized", "audit", "companyPrepared", "compilation", "financialStatement", "foreignCurrencyStatement", "merged", "other", "projection", "quickFinancials", "review", "sample", "taxReturn", "trailingTwelveMonths", "average", "payStub", "wTwo", "organizationPrepared", "selfReported" ], "type": "string" }, "id": { "format": "int32", "description": "Id of the business financial information in Sageworks", "type": "integer" }, "incomeAndExpenses": { "$ref": "#/definitions/FinancialInfoExtractPersonalIncomeAndExpensesV2" }, "periodEndDate": { "format": "Date", "description": "Period end date for this financial information record", "type": "string", "x-nullable": true }, "personalAssets": { "$ref": "#/definitions/FinancialInfoExtractPersonalAssetsV2" }, "personalLiabilities": { "$ref": "#/definitions/FinancialInfoExtractPersonalLiabilitiesV2" }, "realEstateInvestments": { "description": "Personal Real Estate Investments", "type": "array", "items": { "$ref": "#/definitions/FinancialInfoExtractRealEstateInvestmentV2" } }, "recurringDebt": { "$ref": "#/definitions/FinancialInfoExtractPersonalRecurringDebtV2" } }, "additionalProperties": false }, "FinancialInfoExtractPersonalIncomeAndExpenses": { "description": "Represents the Personal Income and Expenses of Personal Financials", "type": "object", "properties": { "accountingFirm": { "description": "The accounting firm that prepared the financial statement or tax return.", "type": "string" }, "additionalFields": { "description": "Additional Personal Income Fields", "type": "object", "additionalProperties": { "type": "string" } }, "cashFlowFromBusinessInvestmentsBeforeDebtService": { "format": "double", "description": "The individual's share of any cash flow generated from Businesses and Farms.", "type": "number" }, "cashFlowFromRealEstateInvestmentsBeforeDebtService": { "format": "double", "description": "The sum of the Adjusted Net Operating Income from all properties.", "type": "number" }, "comments": { "description": "Any relevant comments for the income and living expense information.", "type": "string" }, "description": { "description": "A description here that may identify this financial statement.", "type": "string" }, "investmentRealEstateProperty": { "description": "If the guarantor owns any investment real estate property.", "type": "boolean" }, "netPersonalIncomeBeforeDebtService": { "format": "double", "description": "Total net annual income of the customer.", "type": "number" }, "otherRegularAndDependableSourcesOfIncome": { "format": "double", "description": "Extra consistent and very reliable sources of income, which might include dividend income, interest income, trust income, or guaranteed payments.", "type": "number" }, "personalExpenses": { "format": "double", "description": "Any other regular expenses incurred by the individual, not already accounted for.", "type": "number" }, "personalIncomeAdjustments": { "format": "double", "description": "Any adjustments to Net or Gross Personal Income that you or your institution's policies deem necessary.", "type": "number" }, "personEnteringData": { "description": "The name of the person who is entering the data for this period.", "type": "string" }, "sourceOfIncome": { "format": "string", "description": "The source of the Yearly Gross Wages/Salaries.", "enum": [ "taxReturn", "payStub", "w2", "other", "selfReported" ], "type": "string" }, "stockInAPrivatelyHeldBusiness": { "description": "If the guarantor owns stock in privately-held businesses, or ownership interest in other investment vehicles.", "type": "boolean" }, "taxesPaidOptional": { "format": "double", "description": "Total amount of any taxes paid by the individual. Includes federal and state income tax.", "type": "number" }, "taxReturnDate": { "format": "Date", "description": "This field gives the tax return date.", "type": "string", "x-nullable": true }, "totalPersonalIncome": { "format": "double", "description": "The total income before expenses and debt.", "type": "number" }, "yearlyGrossWagesSalaries": { "format": "double", "description": "The yearly gross salary of the person, or gross wages.", "type": "number" }, "yearlyRentPayments": { "format": "double", "description": "Any yearly rent payments the borrower is making towards their primary residence.", "type": "number" } }, "additionalProperties": false }, "FinancialInfoExtractPersonalIncomeAndExpensesV2": { "description": "Represents the Personal Income and Expenses of Personal Financials", "type": "object", "properties": { "accountingFirm": { "description": "The accounting firm that prepared the financial statement or tax return.", "type": "string" }, "additionalFields": { "description": "Additional Personal Income Fields", "type": "array", "items": { "$ref": "#/definitions/FinancialInfoExtractAdditionalFieldsData" } }, "cashFlowFromBusinessInvestmentsBeforeDebtService": { "format": "double", "description": "The individual's share of any cash flow generated from Businesses and Farms.", "type": "number" }, "cashFlowFromRealEstateInvestmentsBeforeDebtService": { "format": "double", "description": "The sum of the Adjusted Net Operating Income from all properties.", "type": "number" }, "comments": { "description": "Any relevant comments for the income and living expense information.", "type": "string" }, "description": { "description": "A description here that may identify this financial statement.", "type": "string" }, "investmentRealEstateProperty": { "description": "If the guarantor owns any investment real estate property.", "type": "boolean" }, "netPersonalIncomeBeforeDebtService": { "format": "double", "description": "Total net annual income of the customer.", "type": "number" }, "otherRegularAndDependableSourcesOfIncome": { "format": "double", "description": "Extra consistent and very reliable sources of income, which might include dividend income, interest income, trust income, or guaranteed payments.", "type": "number" }, "personalExpenses": { "format": "double", "description": "Any other regular expenses incurred by the individual, not already accounted for.", "type": "number" }, "personalIncomeAdjustments": { "format": "double", "description": "Any adjustments to Net or Gross Personal Income that you or your institution's policies deem necessary.", "type": "number" }, "personEnteringData": { "description": "The name of the person who is entering the data for this period.", "type": "string" }, "sourceOfIncome": { "format": "string", "description": "The source of the Yearly Gross Wages/Salaries.", "enum": [ "taxReturn", "payStub", "w2", "other", "selfReported" ], "type": "string" }, "stockInAPrivatelyHeldBusiness": { "description": "If the guarantor owns stock in privately-held businesses, or ownership interest in other investment vehicles.", "type": "boolean" }, "taxesPaidOptional": { "format": "double", "description": "Total amount of any taxes paid by the individual. Includes federal and state income tax.", "type": "number" }, "taxReturnDate": { "format": "Date", "description": "This field gives the tax return date.", "type": "string", "x-nullable": true }, "totalPersonalIncome": { "format": "double", "description": "The total income before expenses and debt.", "type": "number" }, "yearlyGrossWagesSalaries": { "format": "double", "description": "The yearly gross salary of the person, or gross wages.", "type": "number" }, "yearlyRentPayments": { "format": "double", "description": "Any yearly rent payments the borrower is making towards their primary residence.", "type": "number" } }, "additionalProperties": false }, "FinancialInfoExtractPersonalLiabilities": { "description": "Represents the Personal Liabilities section of Personal Financials", "type": "object", "properties": { "additionalFields": { "description": "Additional Personal Liability Fields", "type": "object", "additionalProperties": { "type": "string" } }, "automobileLoans": { "format": "double", "description": "Enter the total outstanding balance on all automobile loans incurred by the guarantor.", "type": "number" }, "balanceOfAllCreditCards": { "format": "double", "description": "Enter the total outstanding balance owed on all credit cards.", "type": "number" }, "comments": { "description": "Please enter any relevant comments for personal liabilities information. You may enter separate comments for each period of data.", "type": "string" }, "contingentLiabilities": { "format": "double", "description": "Enter any operating leases, pension obligations, purchase commitments, contingent liabilities and all other contractural obligations not presented on the balance sheet.", "type": "number" }, "firstMortgageOnPrimaryResidence": { "format": "double", "description": "Enter the outstanding balance on the first mortgage on the guarantor's personal residence, if any.", "type": "number" }, "homeEquityBalanceOnPrimaryResidence": { "format": "double", "description": "Enter the outstanding balance on any home equity loans on the guarantor's personal residence.", "type": "number" }, "loansOnBusinessAndInvestmentHoldings": { "format": "double", "description": "This should include the outstanding balances of all loans the guarantor has incurred on other businesses or investments. You have already provided these numbers in the Recurring Debt input page.", "type": "number" }, "loansOnOtherNonInvestmentProperties": { "format": "double", "description": "Enter the outstanding balance on any of the loans the guarantor has incurred on other non-investment properties.", "type": "number" }, "loansOnRealEstateInvestments": { "format": "double", "description": "Enter the outstanding balance of all loans the guarantor has incurred on investment property.", "type": "number" }, "otherInstallmentLoans": { "format": "double", "description": "Enter the outstanding balance of all installment loans incurred by the guarantor, if any.", "type": "number" }, "otherLinesOfCredit": { "format": "double", "description": "Enter the balances of any other personal lines of credit for the guarantor that have not been included elsewhere.", "type": "number" }, "otherLongTermLoansLiabilities": { "format": "double", "description": "Enter the value of any other outstanding long-term loans of liabilities that the guarantor has that has not been included elsewhere.", "type": "number" }, "otherShortTermLoansLiabilities": { "format": "double", "description": "Enter any short-term liabilities that have not already been included in the Credit Card or Taxes fields above.", "type": "number" }, "personalNetWorth": { "format": "double", "description": "The amount by which the individual's assets exceed their liabilities.", "type": "number" }, "secondMortgageOnPrimaryResidence": { "format": "double", "description": "Enter the outstanding balance on the second mortgage on the guarantor's personal residence, if any.", "type": "number" }, "studentLoans": { "format": "double", "description": "Enter the outstanding balance on the guarantor's student loans, if any.", "type": "number" }, "taxesOwed": { "format": "double", "description": "Enter the total of all taxes owed.", "type": "number" }, "totalCurrentLiabilities": { "format": "double", "description": "The total value of all current liabilities (those due in less than one year) of the guarantor.", "type": "number" }, "totalLiabilities": { "format": "double", "description": "The total value of all liabilities that the guarantor has outstanding.", "type": "number" } }, "additionalProperties": false }, "FinancialInfoExtractPersonalLiabilitiesV2": { "description": "Represents the Personal Liabilities section of Personal Financials", "type": "object", "properties": { "additionalFields": { "description": "Additional Personal Liability Fields", "type": "array", "items": { "$ref": "#/definitions/FinancialInfoExtractAdditionalFieldsData" } }, "automobileLoans": { "format": "double", "description": "Enter the total outstanding balance on all automobile loans incurred by the guarantor.", "type": "number" }, "balanceOfAllCreditCards": { "format": "double", "description": "Enter the total outstanding balance owed on all credit cards.", "type": "number" }, "comments": { "description": "Please enter any relevant comments for personal liabilities information. You may enter separate comments for each period of data.", "type": "string" }, "contingentLiabilities": { "format": "double", "description": "Enter any operating leases, pension obligations, purchase commitments, contingent liabilities and all other contractural obligations not presented on the balance sheet.", "type": "number" }, "firstMortgageOnPrimaryResidence": { "format": "double", "description": "Enter the outstanding balance on the first mortgage on the guarantor's personal residence, if any.", "type": "number" }, "homeEquityBalanceOnPrimaryResidence": { "format": "double", "description": "Enter the outstanding balance on any home equity loans on the guarantor's personal residence.", "type": "number" }, "loansOnBusinessAndInvestmentHoldings": { "format": "double", "description": "This should include the outstanding balances of all loans the guarantor has incurred on other businesses or investments. You have already provided these numbers in the Recurring Debt input page.", "type": "number" }, "loansOnOtherNonInvestmentProperties": { "format": "double", "description": "Enter the outstanding balance on any of the loans the guarantor has incurred on other non-investment properties.", "type": "number" }, "loansOnRealEstateInvestments": { "format": "double", "description": "Enter the outstanding balance of all loans the guarantor has incurred on investment property.", "type": "number" }, "otherInstallmentLoans": { "format": "double", "description": "Enter the outstanding balance of all installment loans incurred by the guarantor, if any.", "type": "number" }, "otherLinesOfCredit": { "format": "double", "description": "Enter the balances of any other personal lines of credit for the guarantor that have not been included elsewhere.", "type": "number" }, "otherLongTermLoansLiabilities": { "format": "double", "description": "Enter the value of any other outstanding long-term loans of liabilities that the guarantor has that has not been included elsewhere.", "type": "number" }, "otherShortTermLoansLiabilities": { "format": "double", "description": "Enter any short-term liabilities that have not already been included in the Credit Card or Taxes fields above.", "type": "number" }, "personalNetWorth": { "format": "double", "description": "The amount by which the individual's assets exceed their liabilities.", "type": "number" }, "secondMortgageOnPrimaryResidence": { "format": "double", "description": "Enter the outstanding balance on the second mortgage on the guarantor's personal residence, if any.", "type": "number" }, "studentLoans": { "format": "double", "description": "Enter the outstanding balance on the guarantor's student loans, if any.", "type": "number" }, "taxesOwed": { "format": "double", "description": "Enter the total of all taxes owed.", "type": "number" }, "totalCurrentLiabilities": { "format": "double", "description": "The total value of all current liabilities (those due in less than one year) of the guarantor.", "type": "number" }, "totalLiabilities": { "format": "double", "description": "The total value of all liabilities that the guarantor has outstanding.", "type": "number" } }, "additionalProperties": false }, "FinancialInfoExtractPersonalRecurringDebt": { "description": "Represents the Recurring Debt section of Personal Financials", "type": "object", "properties": { "additionalFields": { "description": "Additional Recurring Debt Fields", "type": "object", "additionalProperties": { "type": "string" } }, "otherAnnualDebtService": { "format": "double", "description": "The annual debt service payment for the customer for debt responsibilities that are not itemized below.", "type": "number" }, "portionOfOtherDebtServiceToBeRefinanced": { "format": "double", "description": "The portion of the other debt service to be refinanced and included in the calculation of proposed debt service and proposed debt service coverage ratio.", "type": "number" } }, "additionalProperties": false }, "FinancialInfoExtractPersonalRecurringDebtV2": { "description": "Represents the Recurring Debt section of Personal Financials", "type": "object", "properties": { "additionalFields": { "description": "Additional Recurring Debt Fields", "type": "array", "items": { "$ref": "#/definitions/FinancialInfoExtractAdditionalFieldsData" } }, "otherAnnualDebtService": { "format": "double", "description": "The annual debt service payment for the customer for debt responsibilities that are not itemized below.", "type": "number" }, "portionOfOtherDebtServiceToBeRefinanced": { "format": "double", "description": "The portion of the other debt service to be refinanced and included in the calculation of proposed debt service and proposed debt service coverage ratio.", "type": "number" } }, "additionalProperties": false }, "FinancialInfoExtractRealEstateInvestment": { "description": "Represents a Real Estate Investment in Business Financials", "type": "object", "properties": { "additionalFields": { "description": "Additional Real Estate Fields", "type": "object", "additionalProperties": { "type": "string" } }, "adjustedNetOperatingIncome": { "format": "double", "description": "The net operating income adjusted for the percentage ownership interest that the borrower has in the property.", "type": "number" }, "adjustedPropertyValue": { "format": "double", "description": "The approximate market value of the property adjusted for the percentage ownership interest that the borrower has in the property.", "type": "number" }, "advertisingAndMarketing": { "format": "double", "description": "All advertising and marketing costs associated with the property on an annual basis.", "type": "number" }, "annualGrossIncome": { "format": "double", "description": "An estimated value of the property's annual rental income, discounted for vacancy.", "type": "number" }, "annualPotentialCAMAndOtherIncome": { "format": "double", "description": "Any other pre-vacancy rate annual income associated with the property not already captured by the Annual Potential Gross Rental Income field.", "type": "number" }, "annualPotentialGrossRentalIncome": { "format": "double", "description": "The potential value of the property's rental income over the course of a year, if the property were rented 100% of the time, or if 100% of the property's space was rented.", "type": "number" }, "anticipatedVacancyRate": { "format": "double", "description": "The approximate percentage of time the property is not rented or the percentage of space that is not rented.", "type": "number" }, "capitalizationRate": { "format": "double", "description": "Capitalization rate that best suits this property. The capitalization rate represents the assumed rate of return on the property.", "type": "number" }, "comments": { "description": "Comments for this property.", "type": "string" }, "effectiveGrossIncome": { "format": "double", "description": "The annual gross income plus any post-vacancy rate annual income associated with the property including common area maintenance fees and expenses paid for by the tenants.", "type": "number" }, "insurance": { "format": "double", "description": "All insurance costs associated with the property on an annual basis.", "type": "number" }, "interestExpense": { "format": "double", "description": "Interest paid to banks.", "type": "number" }, "maintenanceCareImprovements": { "format": "double", "description": "The cost of general maintenance on the property on an annual basis. Include any costs associated with property improvements that will occur over the upcoming year.", "type": "number" }, "netOperatingIncome": { "format": "double", "description": "This entry equals the Effective Gross Income generated by the property over the course of a year, less the costs of running it. Non-cash expenses and Interest Expense are added back to this amount.", "type": "number" }, "nonCashExpensesDepreciation": { "format": "double", "description": "All non-cash expenses associated with the property.", "type": "number" }, "otherOperatingExpenses": { "format": "double", "description": "Any other operating expenses associated with the property, on an annual basis, that have not already been included elsewhere.", "type": "number" }, "percentOwnership": { "format": "double", "description": "Percentage of ownership interest that the borrower has in the property.", "type": "number" }, "postVacancyRateIncome": { "format": "double", "description": "Any post-vacancy rate annual income associated with the property including common area maintenance fees and expenses paid for by the tenants.\r\n \r\nNote: This value will not be affected by vacancy rate", "type": "number" }, "propertyManagementFees": { "format": "double", "description": "The yearly property management costs associated with this real estate.", "type": "number" }, "propertyName": { "description": "The name of the property.", "type": "string" }, "propertyType": { "description": "Type of property. If the property is already owned by the business/person, the type should be \"Existing\". If the property is something that the business/person is considering purchasing the type should be \"Proposed\".", "type": "string" }, "propertyValue": { "format": "double", "description": "The approximate market value of the property.", "type": "number" }, "reserveForStructuralReplacements": { "format": "double", "description": "The reserve requirement for structural replacements associated with the property.", "type": "number" }, "taxes": { "format": "double", "description": "All tax costs associated with the property on an annual basis.", "type": "number" }, "totalOperatingExpenses": { "format": "double", "description": "This entry should equal the estimated total cost of running this property over the course of a year.", "type": "number" } }, "additionalProperties": false }, "FinancialInfoExtractRealEstateInvestmentV2": { "description": "Represents a Real Estate Investment in Business Financials", "type": "object", "properties": { "additionalFields": { "description": "Additional Real Estate Fields", "type": "array", "items": { "$ref": "#/definitions/FinancialInfoExtractAdditionalFieldsData" } }, "adjustedNetOperatingIncome": { "format": "double", "description": "The net operating income adjusted for the percentage ownership interest that the borrower has in the property.", "type": "number" }, "adjustedPropertyValue": { "format": "double", "description": "The approximate market value of the property adjusted for the percentage ownership interest that the borrower has in the property.", "type": "number" }, "advertisingAndMarketing": { "format": "double", "description": "All advertising and marketing costs associated with the property on an annual basis.", "type": "number" }, "annualGrossIncome": { "format": "double", "description": "An estimated value of the property's annual rental income, discounted for vacancy.", "type": "number" }, "annualPotentialCAMAndOtherIncome": { "format": "double", "description": "Any other pre-vacancy rate annual income associated with the property not already captured by the Annual Potential Gross Rental Income field.", "type": "number" }, "annualPotentialGrossRentalIncome": { "format": "double", "description": "The potential value of the property's rental income over the course of a year, if the property were rented 100% of the time, or if 100% of the property's space was rented.", "type": "number" }, "anticipatedVacancyRate": { "format": "double", "description": "The approximate percentage of time the property is not rented or the percentage of space that is not rented.", "type": "number" }, "capitalizationRate": { "format": "double", "description": "Capitalization rate that best suits this property. The capitalization rate represents the assumed rate of return on the property.", "type": "number" }, "comments": { "description": "Comments for this property.", "type": "string" }, "effectiveGrossIncome": { "format": "double", "description": "The annual gross income plus any post-vacancy rate annual income associated with the property including common area maintenance fees and expenses paid for by the tenants.", "type": "number" }, "insurance": { "format": "double", "description": "All insurance costs associated with the property on an annual basis.", "type": "number" }, "interestExpense": { "format": "double", "description": "Interest paid to banks.", "type": "number" }, "maintenanceCareImprovements": { "format": "double", "description": "The cost of general maintenance on the property on an annual basis. Include any costs associated with property improvements that will occur over the upcoming year.", "type": "number" }, "netOperatingIncome": { "format": "double", "description": "This entry equals the Effective Gross Income generated by the property over the course of a year, less the costs of running it. Non-cash expenses and Interest Expense are added back to this amount.", "type": "number" }, "nonCashExpensesDepreciation": { "format": "double", "description": "All non-cash expenses associated with the property.", "type": "number" }, "otherOperatingExpenses": { "format": "double", "description": "Any other operating expenses associated with the property, on an annual basis, that have not already been included elsewhere.", "type": "number" }, "percentOwnership": { "format": "double", "description": "Percentage of ownership interest that the borrower has in the property.", "type": "number" }, "postVacancyRateIncome": { "format": "double", "description": "Any post-vacancy rate annual income associated with the property including common area maintenance fees and expenses paid for by the tenants.\r\n \r\nNote: This value will not be affected by vacancy rate", "type": "number" }, "propertyManagementFees": { "format": "double", "description": "The yearly property management costs associated with this real estate.", "type": "number" }, "propertyName": { "description": "The name of the property.", "type": "string" }, "propertyType": { "description": "Type of property. If the property is already owned by the business/person, the type should be \"Existing\". If the property is something that the business/person is considering purchasing the type should be \"Proposed\".", "type": "string" }, "propertyValue": { "format": "double", "description": "The approximate market value of the property.", "type": "number" }, "reserveForStructuralReplacements": { "format": "double", "description": "The reserve requirement for structural replacements associated with the property.", "type": "number" }, "taxes": { "format": "double", "description": "All tax costs associated with the property on an annual basis.", "type": "number" }, "totalOperatingExpenses": { "format": "double", "description": "This entry should equal the estimated total cost of running this property over the course of a year.", "type": "number" } }, "additionalProperties": false }, "FinancialInfoExtractReconciliationOfNetAssets": { "description": "Represents Reconciliation of Net Assets in Sageworks", "type": "object", "properties": { "actualEndingUnrestrictedNetAssets": { "format": "double", "description": "This field shows the value entered for the Unrestricted Net Assets on the Statement of Financial Position.", "type": "number" }, "additionalFields": { "description": "Additional Reconciliation of Net Assets Fields", "type": "object", "additionalProperties": { "type": "string" } }, "calculatedEndingUnrestrictedNetAssets": { "format": "double", "description": "This field is calculated using: Beginning Unrestricted Net Assets + Total Change in Unrestricted Net Assets + Other Adjustments to Unrestricted Net Assets.", "type": "number" }, "totalChangeInUnrestrictedNetAssets": { "format": "double", "description": "This field measures the difference between unrestricted revenues and inflows against total expenses and outflows incurred by the organization.", "type": "number" }, "unexplainedDifferenceInUnrestrictedNetAssets": { "format": "double", "description": "This field shows the difference between the Calculated Ending Unrestricted Net Assets and the Unrestricted Net Assets entered on the Statement of Financial Position.", "type": "number" }, "unrestrictedBeginningNetAssets": { "format": "double", "description": "The Unrestricted Net Asset balance at the beginning of the period being analyzed.", "type": "number" }, "unrestrictedOtherAdjustmentsToNetAssets": { "format": "double", "description": "Any changes to Unrestricted Net Assets not already accounted for.", "type": "number" } }, "additionalProperties": false }, "FinancialInfoExtractReconciliationOfNetAssetsV2": { "description": "Represents Reconciliation of Net Assets in Sageworks", "type": "object", "properties": { "actualEndingUnrestrictedNetAssets": { "format": "double", "description": "This field shows the value entered for the Unrestricted Net Assets on the Statement of Financial Position.", "type": "number" }, "additionalFields": { "description": "Additional Reconciliation of Net Assets Fields", "type": "array", "items": { "$ref": "#/definitions/FinancialInfoExtractAdditionalFieldsData" } }, "calculatedEndingUnrestrictedNetAssets": { "format": "double", "description": "This field is calculated using: Beginning Unrestricted Net Assets + Total Change in Unrestricted Net Assets + Other Adjustments to Unrestricted Net Assets.", "type": "number" }, "totalChangeInUnrestrictedNetAssets": { "format": "double", "description": "This field measures the difference between unrestricted revenues and inflows against total expenses and outflows incurred by the organization.", "type": "number" }, "unexplainedDifferenceInUnrestrictedNetAssets": { "format": "double", "description": "This field shows the difference between the Calculated Ending Unrestricted Net Assets and the Unrestricted Net Assets entered on the Statement of Financial Position.", "type": "number" }, "unrestrictedBeginningNetAssets": { "format": "double", "description": "The Unrestricted Net Asset balance at the beginning of the period being analyzed.", "type": "number" }, "unrestrictedOtherAdjustmentsToNetAssets": { "format": "double", "description": "Any changes to Unrestricted Net Assets not already accounted for.", "type": "number" } }, "additionalProperties": false }, "FinancialInfoExtractStatementOfActivities": { "description": "Represents the Statement Of Activities Section of Non Profit Financials in Sageworks", "type": "object", "properties": { "accountingFirm": { "description": "The name of the accounting firm that prepared the financial statement or tax return.", "type": "string" }, "accountingMethod": { "description": "Whether this data is based off the accrual method of accounting or the cash method of accounting.", "type": "string" }, "additionalFields": { "description": "Additional Statement of Activities Fields", "type": "object", "additionalProperties": { "type": "string" } }, "administrationExpenses": { "format": "double", "description": "Expenses that typically represent overhead charged or administrative expenses.", "type": "number" }, "administrationExpensesDepreciationAndAmortization": { "format": "double", "description": "Expenses representing depreciation and amortization of fixed assets. In the case where the organization has other non-cash expenses associated with Plant, Property, and Equipment, include those costs as well. Include only the amount that applies to administration expenses.", "type": "number" }, "administrationExpensesInterestExpense": { "format": "double", "description": "Expenses representing all costs associated with borrowing activities. Include only the amount that applies to administration expenses.", "type": "number" }, "administrationExpensesPayrollAndBenefits": { "format": "double", "description": "The amount of payroll, benefits and payroll taxes paid by the organization. Include only the amount that applies to adminstration expenses.", "type": "number" }, "comments": { "description": "Any relevant comments for statement of activities information.", "type": "string" }, "contributions": { "format": "double", "description": "Funds received from contributions. This should also include fundraising revenue. Don't forget that, often, these are not always a regular source of revenue for an organization.", "type": "number" }, "dataSource": { "format": "string", "description": "Source of this financial data", "enum": [ "none", "annualized", "audit", "companyPrepared", "compilation", "financialStatement", "foreignCurrencyStatement", "merged", "other", "projection", "quickFinancials", "review", "sample", "taxReturn", "trailingTwelveMonths", "average", "payStub", "wTwo", "organizationPrepared", "selfReported" ], "type": "string" }, "description": { "description": "The description that identifies this financial statement.", "type": "string" }, "excessOfRevenues": { "format": "double", "description": "This field measures the difference between unrestricted revenues and inflows against total expenses and outflows incurred by the organization.", "type": "number" }, "fundraisingExpenses": { "format": "double", "description": "Expenses related directly to fundraising activities.", "type": "number" }, "fundraisingExpensesDepreciationAndAmortization": { "format": "double", "description": "Expenses representing depreciation and amortization of fixed assets. In the case where the organization has other non-cash expenses associated with Plant, Property, and Equipment, include those costs as well. Include only the amount that applies to fundraising expenses.", "type": "number" }, "fundraisingExpensesInterestExpense": { "format": "double", "description": "Expenses representing all costs associated with borrowing activities. Include only the amount that applies to fundraising expenses.", "type": "number" }, "fundraisingExpensesPayrollAndBenefits": { "format": "double", "description": "The amount of payroll, benefits and payroll taxes paid by the organization. Include only the amount that applies to fundraising expenses.", "type": "number" }, "governmentGrants": { "format": "double", "description": "Funds received from government grants.", "type": "number" }, "investmentRevenue": { "format": "double", "description": "Funds received from investments.", "type": "number" }, "membershipDues": { "format": "double", "description": "Include the amount of dues collected from members during the period. This typically only applies to membership organizations.", "type": "number" }, "netAssetsReleasedFromRestrictions": { "format": "double", "description": "The dollar value of assets that have been released from restrictions over the period of time specified.", "type": "number" }, "operatingYield": { "format": "double", "description": "Total Operating Revenue less Total Expenses.", "type": "number" }, "otherChangesInUnrestrictedNetAssets": { "format": "double", "description": "Any other changes to unrestricted net assets that have not already been included.", "type": "number" }, "otherInflows": { "format": "double", "description": "Any other revenue sources/cash inflows that are not related to operations.", "type": "number" }, "otherOperatingExpenses": { "format": "double", "description": "Any other operating expenses incurred by the organization that have not been previously accounted for.", "type": "number" }, "otherOperatingExpensesDepreciationAndAmortization": { "format": "double", "description": "Expenses representing depreciation and amortization of fixed assets. In the case where the organization has other non-cash expenses associated with Plant, Property, and Equipment, include those costs as well. Include only the amount that applies to other operating expenses.", "type": "number" }, "otherOperatingExpensesInterestExpense": { "format": "double", "description": "Expenses representing all costs associated with borrowing activities. Include only the amount that applies to other operating expenses.", "type": "number" }, "otherOperatingExpensesPayrollAndBenefits": { "format": "double", "type": "number" }, "otherOperatingRevenue": { "format": "double", "description": "Any other operating revenue generated by the organization.", "type": "number" }, "otherOutflows": { "format": "double", "description": "Any other expenses/cash outflows that are not related to operations.", "type": "number" }, "periodDuration": { "format": "int32", "description": "This field gives the length (in months) of the period in question.", "type": "integer" }, "personEnteringData": { "description": "The name of the person who prepared the data for this period.", "type": "string" }, "programExpensesDepreciationAndAmortization": { "format": "double", "description": "Expenses representing depreciation and amortization of fixed assets. In the case where the organization has other non-cash expenses associated with Plant, Property, and Equipment, include those costs as well. Include only the amount that applies to program service expenses.", "type": "number" }, "programExpensesInterestExpense": { "format": "double", "description": "Expenses representing all costs associated with borrowing activities. Include only the amount that applies to program service expenses.", "type": "number" }, "programExpensesPayrollAndBenefits": { "format": "double", "description": "The amount of payroll, benefits and payroll taxes paid by the organization. Only includes the amount that applies to program service expenses.", "type": "number" }, "programServiceExpenses": { "format": "double", "description": "Expenses directly related to providing services that are core to the mission of the organization.", "type": "number" }, "programServiceRevenue": { "format": "double", "description": "Funds received from regular program services. Often, this category is the regular and consistent way an organization is funded.", "type": "number" }, "totalChangeInUnrestrictedNetAssets": { "format": "double", "description": "This field measures the difference between unrestricted revenues and inflows against total expenses and outflows incurred by the organization.", "type": "number" }, "totalOperatingExpenses": { "format": "double", "description": "This field holds the total amount for all organization operating expenses.", "type": "number" }, "totalUnrestrictedRevenue": { "format": "double", "description": "This is the total of all unrestricted revenue sources.", "type": "number" } }, "additionalProperties": false }, "FinancialInfoExtractStatementOfActivitiesDonorRestricted": { "description": "Represents the Statement Of Activities - Donor Restricted Section of Non Profit Financials in Sageworks", "type": "object", "properties": { "additionalFields": { "description": "Additional Statement of Activities - Donor Restricted Fields", "type": "object", "additionalProperties": { "type": "string" } }, "comments": { "description": "Any relevant comments for statement of activities information. You may enter separate comments for each period of data.", "type": "string" }, "donorRestrictedContributions": { "format": "double", "description": "Any revenue from contributions to the organization where use of the funds is donor restricted.", "type": "number", "x-nullable": true }, "donorRestrictedGovernmentGrants": { "format": "double", "description": "Any federal, state, or local government grants received by the organization, where use of the funds is donor restricted.", "type": "number", "x-nullable": true }, "donorRestrictedInvestmentRevenue": { "format": "double", "description": "Any investment revenue earned by the organization, where use of the funds is donor restricted.", "type": "number", "x-nullable": true }, "donorRestrictedMembershipDues": { "format": "double", "description": "The amount of dues collected from members during the period, where use of the funds is donor restricted. This typically only applies to membership organizations.", "type": "number", "x-nullable": true }, "donorRestrictedOtherOperatingRevenue": { "format": "double", "description": "Any other operating revenue generated by the organization that is donor restricted in use.", "type": "number", "x-nullable": true }, "donorRestrictedProgramServiceRevenue": { "format": "double", "description": "Any revenue generated through program services where use of the funds is donor restricted.", "type": "number", "x-nullable": true }, "netAssetsReleased": { "format": "double", "description": "The dollar value of assets that have been released from restrictions over the period of time specified.", "type": "number", "x-nullable": true }, "otherChangesInDonorRestrictedNetAssets": { "format": "double", "description": "Any other changes to donor restricted net assets that have not already been included.", "type": "number", "x-nullable": true }, "otherDonorRestrictedExpenses": { "format": "double", "description": "Any other expenses.", "type": "number", "x-nullable": true }, "otherDonorRestrictedRevenue": { "format": "double", "description": "Any other revenue sources.", "type": "number", "x-nullable": true }, "totalChangeInDonorRestrictedNetAssets": { "format": "double", "description": "This field measures the difference between donor restricted revenues against other expenses associated with the donor restricted accounts.", "type": "number", "x-nullable": true }, "totalDonorRestrictedRevenue": { "format": "double", "description": "This amount should equal the total amount of revenue generated by the organization over the period that has Permorary restrictions on its use.", "type": "number", "x-nullable": true } }, "additionalProperties": false }, "FinancialInfoExtractStatementOfActivitiesDonorRestrictedV2": { "description": "Represents the Statement Of Activities - Donor Restricted Section of Non Profit Financials in Sageworks", "type": "object", "properties": { "additionalFields": { "description": "Additional Statement of Activities - Donor Restricted Fields", "type": "array", "items": { "$ref": "#/definitions/FinancialInfoExtractAdditionalFieldsData" } }, "comments": { "description": "Any relevant comments for statement of activities information. You may enter separate comments for each period of data.", "type": "string" }, "donorRestrictedContributions": { "format": "double", "description": "Any revenue from contributions to the organization where use of the funds is donor restricted.", "type": "number", "x-nullable": true }, "donorRestrictedGovernmentGrants": { "format": "double", "description": "Any federal, state, or local government grants received by the organization, where use of the funds is donor restricted.", "type": "number", "x-nullable": true }, "donorRestrictedInvestmentRevenue": { "format": "double", "description": "Any investment revenue earned by the organization, where use of the funds is donor restricted.", "type": "number", "x-nullable": true }, "donorRestrictedMembershipDues": { "format": "double", "description": "The amount of dues collected from members during the period, where use of the funds is donor restricted. This typically only applies to membership organizations.", "type": "number", "x-nullable": true }, "donorRestrictedOtherOperatingRevenue": { "format": "double", "description": "Any other operating revenue generated by the organization that is donor restricted in use.", "type": "number", "x-nullable": true }, "donorRestrictedProgramServiceRevenue": { "format": "double", "description": "Any revenue generated through program services where use of the funds is donor restricted.", "type": "number", "x-nullable": true }, "netAssetsReleased": { "format": "double", "description": "The dollar value of assets that have been released from restrictions over the period of time specified.", "type": "number", "x-nullable": true }, "otherChangesInDonorRestrictedNetAssets": { "format": "double", "description": "Any other changes to donor restricted net assets that have not already been included.", "type": "number", "x-nullable": true }, "otherDonorRestrictedExpenses": { "format": "double", "description": "Any other expenses.", "type": "number", "x-nullable": true }, "otherDonorRestrictedRevenue": { "format": "double", "description": "Any other revenue sources.", "type": "number", "x-nullable": true }, "totalChangeInDonorRestrictedNetAssets": { "format": "double", "description": "This field measures the difference between donor restricted revenues against other expenses associated with the donor restricted accounts.", "type": "number", "x-nullable": true }, "totalDonorRestrictedRevenue": { "format": "double", "description": "This amount should equal the total amount of revenue generated by the organization over the period that has Permorary restrictions on its use.", "type": "number", "x-nullable": true } }, "additionalProperties": false }, "FinancialInfoExtractStatementOfActivitiesPermRestricted": { "description": "Represents the Statement Of Activities - Perm Restricted Section of Non Profit Financials in Sageworks", "type": "object", "properties": { "additionalFields": { "description": "Additional Statement of Activities - Perm Restricted Fields", "type": "object", "additionalProperties": { "type": "string" } }, "comments": { "description": "Any relevant comments for statement of activities information. You may enter separate comments for each period of data.", "type": "string" }, "otherChangesInPermRestrictedNetAssets": { "format": "double", "description": "Any other changes to permanently restricted net assets that have not already been included.", "type": "number", "x-nullable": true }, "otherPermRestrictedExpenses": { "format": "double", "description": "Any other expenses.", "type": "number", "x-nullable": true }, "otherPermRestrictedRevenue": { "format": "double", "description": "Any other revenue sources.", "type": "number", "x-nullable": true }, "permRestrictedContributions": { "format": "double", "description": "Any revenue from contributions to the organization where use of the funds is permanently restricted.", "type": "number", "x-nullable": true }, "permRestrictedGovernmentGrants": { "format": "double", "description": "Any federal, state, or local government grants received by the organization, where use of the funds is permanently restricted.", "type": "number", "x-nullable": true }, "permRestrictedInvestmentRevenue": { "format": "double", "description": "Any investment revenue earned by the organization, where use of the funds is permanently restricted.", "type": "number", "x-nullable": true }, "permRestrictedMembershipDues": { "format": "double", "description": "The amount of dues collected from members during the period, where use of the funds is permanently restricted. This typically only applies to membership organizations.", "type": "number", "x-nullable": true }, "permRestrictedOtherOperatingRevenue": { "format": "double", "description": "Any other operating revenue generated by the organization that is permanently restricted in use.", "type": "number", "x-nullable": true }, "permRestrictedProgramServiceRevenue": { "format": "double", "description": "Any revenue generated through program services where use of the funds is permanently restricted.", "type": "number", "x-nullable": true }, "totalChangeInPermRestrictedNetAssets": { "format": "double", "description": "This field measures the difference between permanently restricted revenues against other expenses associated with the permanently restricted accounts.", "type": "number", "x-nullable": true }, "totalPermRestrictedRevenue": { "format": "double", "description": "This amount should equal the total amount of revenue generated by the organization over the period that has Permorary restrictions on its use.", "type": "number", "x-nullable": true } }, "additionalProperties": false }, "FinancialInfoExtractStatementOfActivitiesPermRestrictedV2": { "description": "Represents the Statement Of Activities - Perm Restricted Section of Non Profit Financials in Sageworks", "type": "object", "properties": { "additionalFields": { "description": "Additional Statement of Activities - Perm Restricted Fields", "type": "array", "items": { "$ref": "#/definitions/FinancialInfoExtractAdditionalFieldsData" } }, "comments": { "description": "Any relevant comments for statement of activities information. You may enter separate comments for each period of data.", "type": "string" }, "otherChangesInPermRestrictedNetAssets": { "format": "double", "description": "Any other changes to permanently restricted net assets that have not already been included.", "type": "number", "x-nullable": true }, "otherPermRestrictedExpenses": { "format": "double", "description": "Any other expenses.", "type": "number", "x-nullable": true }, "otherPermRestrictedRevenue": { "format": "double", "description": "Any other revenue sources.", "type": "number", "x-nullable": true }, "permRestrictedContributions": { "format": "double", "description": "Any revenue from contributions to the organization where use of the funds is permanently restricted.", "type": "number", "x-nullable": true }, "permRestrictedGovernmentGrants": { "format": "double", "description": "Any federal, state, or local government grants received by the organization, where use of the funds is permanently restricted.", "type": "number", "x-nullable": true }, "permRestrictedInvestmentRevenue": { "format": "double", "description": "Any investment revenue earned by the organization, where use of the funds is permanently restricted.", "type": "number", "x-nullable": true }, "permRestrictedMembershipDues": { "format": "double", "description": "The amount of dues collected from members during the period, where use of the funds is permanently restricted. This typically only applies to membership organizations.", "type": "number", "x-nullable": true }, "permRestrictedOtherOperatingRevenue": { "format": "double", "description": "Any other operating revenue generated by the organization that is permanently restricted in use.", "type": "number", "x-nullable": true }, "permRestrictedProgramServiceRevenue": { "format": "double", "description": "Any revenue generated through program services where use of the funds is permanently restricted.", "type": "number", "x-nullable": true }, "totalChangeInPermRestrictedNetAssets": { "format": "double", "description": "This field measures the difference between permanently restricted revenues against other expenses associated with the permanently restricted accounts.", "type": "number", "x-nullable": true }, "totalPermRestrictedRevenue": { "format": "double", "description": "This amount should equal the total amount of revenue generated by the organization over the period that has Permorary restrictions on its use.", "type": "number", "x-nullable": true } }, "additionalProperties": false }, "FinancialInfoExtractStatementOfActivitiesTempRestricted": { "description": "Represents the Statement Of Activities - Temp Restricted Section of Non Profit Financials in Sageworks", "type": "object", "properties": { "additionalFields": { "description": "Additional Statement of Activities - Temp Restricted Fields", "type": "object", "additionalProperties": { "type": "string" } }, "comments": { "description": "Any relevant comments for statement of activities information. You may enter separate comments for each period of data.", "type": "string" }, "netAssetsReleased": { "format": "double", "description": "The dollar value of assets that have been released from restrictions over the period of time specified.", "type": "number", "x-nullable": true }, "otherChangesInTempRestrictedNetAssets": { "format": "double", "description": "Any other changes to temporarily restricted net assets that have not already been included.", "type": "number", "x-nullable": true }, "otherTempRestrictedExpenses": { "format": "double", "description": "Any other expenses.", "type": "number", "x-nullable": true }, "otherTempRestrictedRevenue": { "format": "double", "description": "Any other revenue sources.", "type": "number", "x-nullable": true }, "tempRestrictedContributions": { "format": "double", "description": "Any revenue from contributions to the organization where use of the funds is temporarily restricted.", "type": "number", "x-nullable": true }, "tempRestrictedGovernmentGrants": { "format": "double", "description": "Any federal, state, or local government grants received by the organization, where use of the funds is temporarily restricted.", "type": "number", "x-nullable": true }, "tempRestrictedInvestmentRevenue": { "format": "double", "description": "Any investment revenue earned by the organization, where use of the funds is temporarily restricted.", "type": "number", "x-nullable": true }, "tempRestrictedMembershipDues": { "format": "double", "description": "The amount of dues collected from members during the period, where use of the funds is temporarily restricted. This typically only applies to membership organizations.", "type": "number", "x-nullable": true }, "tempRestrictedOtherOperatingRevenue": { "format": "double", "description": "Any other operating revenue generated by the organization that is temporarily restricted in use.", "type": "number", "x-nullable": true }, "tempRestrictedProgramServiceRevenue": { "format": "double", "description": "Any revenue generated through program services where the use of the revenue is temporarily restricted.", "type": "number", "x-nullable": true }, "totalChangeInTempRestrictedNetAssets": { "format": "double", "description": "This field measures the difference between temporarily restricted revenues against other expenses associated with the temporarily restricted accounts.", "type": "number", "x-nullable": true }, "totalTempRestrictedRevenue": { "format": "double", "description": "This amount should equal the total amount of revenue generated by the organization over the period that has temporary restrictions on its use.", "type": "number", "x-nullable": true } }, "additionalProperties": false }, "FinancialInfoExtractStatementOfActivitiesTempRestrictedV2": { "description": "Represents the Statement Of Activities - Temp Restricted Section of Non Profit Financials in Sageworks", "type": "object", "properties": { "additionalFields": { "description": "Additional Statement of Activities - Temp Restricted Fields", "type": "array", "items": { "$ref": "#/definitions/FinancialInfoExtractAdditionalFieldsData" } }, "comments": { "description": "Any relevant comments for statement of activities information. You may enter separate comments for each period of data.", "type": "string" }, "netAssetsReleased": { "format": "double", "description": "The dollar value of assets that have been released from restrictions over the period of time specified.", "type": "number", "x-nullable": true }, "otherChangesInTempRestrictedNetAssets": { "format": "double", "description": "Any other changes to temporarily restricted net assets that have not already been included.", "type": "number", "x-nullable": true }, "otherTempRestrictedExpenses": { "format": "double", "description": "Any other expenses.", "type": "number", "x-nullable": true }, "otherTempRestrictedRevenue": { "format": "double", "description": "Any other revenue sources.", "type": "number", "x-nullable": true }, "tempRestrictedContributions": { "format": "double", "description": "Any revenue from contributions to the organization where use of the funds is temporarily restricted.", "type": "number", "x-nullable": true }, "tempRestrictedGovernmentGrants": { "format": "double", "description": "Any federal, state, or local government grants received by the organization, where use of the funds is temporarily restricted.", "type": "number", "x-nullable": true }, "tempRestrictedInvestmentRevenue": { "format": "double", "description": "Any investment revenue earned by the organization, where use of the funds is temporarily restricted.", "type": "number", "x-nullable": true }, "tempRestrictedMembershipDues": { "format": "double", "description": "The amount of dues collected from members during the period, where use of the funds is temporarily restricted. This typically only applies to membership organizations.", "type": "number", "x-nullable": true }, "tempRestrictedOtherOperatingRevenue": { "format": "double", "description": "Any other operating revenue generated by the organization that is temporarily restricted in use.", "type": "number", "x-nullable": true }, "tempRestrictedProgramServiceRevenue": { "format": "double", "description": "Any revenue generated through program services where the use of the revenue is temporarily restricted.", "type": "number", "x-nullable": true }, "totalChangeInTempRestrictedNetAssets": { "format": "double", "description": "This field measures the difference between temporarily restricted revenues against other expenses associated with the temporarily restricted accounts.", "type": "number", "x-nullable": true }, "totalTempRestrictedRevenue": { "format": "double", "description": "This amount should equal the total amount of revenue generated by the organization over the period that has temporary restrictions on its use.", "type": "number", "x-nullable": true } }, "additionalProperties": false }, "FinancialInfoExtractStatementOfActivitiesV2": { "description": "Represents the Statement Of Activities Section of Non Profit Financials in Sageworks", "type": "object", "properties": { "accountingFirm": { "description": "The name of the accounting firm that prepared the financial statement or tax return.", "type": "string" }, "accountingMethod": { "description": "Whether this data is based off the accrual method of accounting or the cash method of accounting.", "type": "string" }, "additionalFields": { "description": "Additional Statement of Activities Fields", "type": "array", "items": { "$ref": "#/definitions/FinancialInfoExtractAdditionalFieldsData" } }, "administrationExpenses": { "format": "double", "description": "Expenses that typically represent overhead charged or administrative expenses.", "type": "number" }, "administrationExpensesDepreciationAndAmortization": { "format": "double", "description": "Expenses representing depreciation and amortization of fixed assets. In the case where the organization has other non-cash expenses associated with Plant, Property, and Equipment, include those costs as well. Include only the amount that applies to administration expenses.", "type": "number" }, "administrationExpensesInterestExpense": { "format": "double", "description": "Expenses representing all costs associated with borrowing activities. Include only the amount that applies to administration expenses.", "type": "number" }, "administrationExpensesPayrollAndBenefits": { "format": "double", "description": "The amount of payroll, benefits and payroll taxes paid by the organization. Include only the amount that applies to adminstration expenses.", "type": "number" }, "comments": { "description": "Any relevant comments for statement of activities information.", "type": "string" }, "contributions": { "format": "double", "description": "Funds received from contributions. This should also include fundraising revenue. Don't forget that, often, these are not always a regular source of revenue for an organization.", "type": "number" }, "dataSource": { "format": "string", "description": "Source of this financial data", "enum": [ "none", "annualized", "audit", "companyPrepared", "compilation", "financialStatement", "foreignCurrencyStatement", "merged", "other", "projection", "quickFinancials", "review", "sample", "taxReturn", "trailingTwelveMonths", "average", "payStub", "wTwo", "organizationPrepared", "selfReported" ], "type": "string" }, "description": { "description": "The description that identifies this financial statement.", "type": "string" }, "excessOfRevenues": { "format": "double", "description": "This field measures the difference between unrestricted revenues and inflows against total expenses and outflows incurred by the organization.", "type": "number" }, "fundraisingExpenses": { "format": "double", "description": "Expenses related directly to fundraising activities.", "type": "number" }, "fundraisingExpensesDepreciationAndAmortization": { "format": "double", "description": "Expenses representing depreciation and amortization of fixed assets. In the case where the organization has other non-cash expenses associated with Plant, Property, and Equipment, include those costs as well. Include only the amount that applies to fundraising expenses.", "type": "number" }, "fundraisingExpensesInterestExpense": { "format": "double", "description": "Expenses representing all costs associated with borrowing activities. Include only the amount that applies to fundraising expenses.", "type": "number" }, "fundraisingExpensesPayrollAndBenefits": { "format": "double", "description": "The amount of payroll, benefits and payroll taxes paid by the organization. Include only the amount that applies to fundraising expenses.", "type": "number" }, "governmentGrants": { "format": "double", "description": "Funds received from government grants.", "type": "number" }, "investmentRevenue": { "format": "double", "description": "Funds received from investments.", "type": "number" }, "membershipDues": { "format": "double", "description": "Include the amount of dues collected from members during the period. This typically only applies to membership organizations.", "type": "number" }, "netAssetsReleasedFromRestrictions": { "format": "double", "description": "The dollar value of assets that have been released from restrictions over the period of time specified.", "type": "number" }, "operatingYield": { "format": "double", "description": "Total Operating Revenue less Total Expenses.", "type": "number" }, "otherChangesInUnrestrictedNetAssets": { "format": "double", "description": "Any other changes to unrestricted net assets that have not already been included.", "type": "number" }, "otherInflows": { "format": "double", "description": "Any other revenue sources/cash inflows that are not related to operations.", "type": "number" }, "otherOperatingExpenses": { "format": "double", "description": "Any other operating expenses incurred by the organization that have not been previously accounted for.", "type": "number" }, "otherOperatingExpensesDepreciationAndAmortization": { "format": "double", "description": "Expenses representing depreciation and amortization of fixed assets. In the case where the organization has other non-cash expenses associated with Plant, Property, and Equipment, include those costs as well. Include only the amount that applies to other operating expenses.", "type": "number" }, "otherOperatingExpensesInterestExpense": { "format": "double", "description": "Expenses representing all costs associated with borrowing activities. Include only the amount that applies to other operating expenses.", "type": "number" }, "otherOperatingExpensesPayrollAndBenefits": { "format": "double", "type": "number" }, "otherOperatingRevenue": { "format": "double", "description": "Any other operating revenue generated by the organization.", "type": "number" }, "otherOutflows": { "format": "double", "description": "Any other expenses/cash outflows that are not related to operations.", "type": "number" }, "periodDuration": { "format": "int32", "description": "This field gives the length (in months) of the period in question.", "type": "integer" }, "personEnteringData": { "description": "The name of the person who prepared the data for this period.", "type": "string" }, "programExpensesDepreciationAndAmortization": { "format": "double", "description": "Expenses representing depreciation and amortization of fixed assets. In the case where the organization has other non-cash expenses associated with Plant, Property, and Equipment, include those costs as well. Include only the amount that applies to program service expenses.", "type": "number" }, "programExpensesInterestExpense": { "format": "double", "description": "Expenses representing all costs associated with borrowing activities. Include only the amount that applies to program service expenses.", "type": "number" }, "programExpensesPayrollAndBenefits": { "format": "double", "description": "The amount of payroll, benefits and payroll taxes paid by the organization. Only includes the amount that applies to program service expenses.", "type": "number" }, "programServiceExpenses": { "format": "double", "description": "Expenses directly related to providing services that are core to the mission of the organization.", "type": "number" }, "programServiceRevenue": { "format": "double", "description": "Funds received from regular program services. Often, this category is the regular and consistent way an organization is funded.", "type": "number" }, "totalChangeInUnrestrictedNetAssets": { "format": "double", "description": "This field measures the difference between unrestricted revenues and inflows against total expenses and outflows incurred by the organization.", "type": "number" }, "totalOperatingExpenses": { "format": "double", "description": "This field holds the total amount for all organization operating expenses.", "type": "number" }, "totalUnrestrictedRevenue": { "format": "double", "description": "This is the total of all unrestricted revenue sources.", "type": "number" } }, "additionalProperties": false }, "FinancialInfoExtractStatementOfFinancialPosition": { "description": "Represents the Statement of Financial Position Section of NonProfit Financials", "type": "object", "properties": { "accountsReceivable": { "format": "double", "description": "All accounts receivable owed to the organization, net of any allowances for uncollectibles.", "type": "number" }, "accumulatedDepreciation": { "format": "double", "description": "The total amount of depreciation accumulated by the organization since the start of operations.", "type": "number" }, "additionalFields": { "description": "Additional Statement of Financial Position Fields", "type": "object", "additionalProperties": { "type": "string" } }, "comments": { "description": "Any relevant comments for statement of financial position information. You may enter separate comments for each period of data.", "type": "string" }, "contributionsReceivable": { "format": "double", "description": "All contribution receivables owed to the organization within the next year, net of any allowances for uncollectibles.", "type": "number" }, "currentInvestments": { "format": "double", "description": "The total of current investment assets owned by the organization.", "type": "number" }, "currentPortionOfLongTermDebt": { "format": "double", "description": "The portion of Long Term Liabilities being paid off within 12 months of the particular financial statement date and notes payable that have a maturity of less than one year.", "type": "number" }, "grossFixedAssets": { "format": "double", "description": "The amount for gross fixed assets or the value for Plant, Property, and Equipment before depreciation is subtracted.", "type": "number" }, "inventory": { "format": "double", "description": "The value of all items available for resale. Direct labor would only be included here if it is included in the calculation of inventory cost.", "type": "number" }, "longTermInvestmentAssets": { "format": "double", "description": "The total of long term investment assets owned by the organization.", "type": "number" }, "netFixedAssets": { "format": "double", "description": "The value of your fixed assets after having accounted for depreciation.", "type": "number" }, "notesPayableSeniorDebt": { "format": "double", "description": "This term applies to debt which has seniority or preference in case of a default or bankruptcy.", "type": "number" }, "notesPayableSubordinatedDebt": { "format": "double", "description": "This term applies to liabilities that are subordinate or have less preference in case of a default or bankruptcy.", "type": "number" }, "numberOfDonors": { "format": "double", "description": "Number of people and/or entities that made any kind of donation to the organization during the period. They do not necessarily have to be members.", "type": "number" }, "numberOfEmployees": { "format": "double", "description": "Total number of full-time employees and contractors. In the case of several part-time employees, take the total hours worked by the part-time employees and divide by the full-time equivalent hours. Enter the number of full-time equivalents as of the end of the period in question.", "type": "number" }, "numberOfMembers": { "format": "double", "description": "The total number of members in the organization.", "type": "number" }, "otherAssets": { "format": "double", "description": "Any additional assets held by the organization that have not already been accounted for.", "type": "number" }, "otherCurrentAssets": { "format": "double", "description": "Any current assets held by the organization that have not been accounted for in the Cash, Receivables, or Inventory fields.", "type": "number" }, "otherCurrentLiabilities": { "format": "double", "description": "Any current liabilities incurred by the organization that have not been accounted for in the Payables field. This field includes liabilities that would be paid by the organization in the upcoming year.", "type": "number" }, "otherLongTermLiabilities": { "format": "double", "description": "Other Long Term Liabilities that would not be considered either Senior or Subordinated Debt. Some possible examples include deferred taxes and the long term portion of a capital lease.", "type": "number" }, "otherReceivables": { "format": "double", "description": "All other receivables owed to the organization, net of any allowances for uncollectibles.", "type": "number" }, "payables": { "format": "double", "description": "Amounts owed to vendors.", "type": "number" }, "restrictedCash": { "format": "double", "description": "The total of all monies in cash, checking, and money market accounts. Does not include investment assets (stocks, bonds, etc.). These should be included in the investments category. These should only be funds which have restrictions.", "type": "number" }, "shortTermDebt": { "format": "double", "description": "The outstanding balance of any short term debt owed by the organization. This may include lines of credit, short term operating loans, etc.", "type": "number" }, "totalAssets": { "format": "double", "description": "This field should be available directly from any Balance Sheet.", "type": "number" }, "totalCashAndCashEquivalent": { "format": "double", "description": "The total of all monies in cash, checking, and money market accounts. Does not include investment assets (stocks, bonds, etc.). These should be included in the investments category.", "type": "number" }, "totalCurrentAssets": { "format": "double", "description": "The total of cash, marketable securities, accounts receivable, inventory, prepaid expenses, and any other asset the company owns that can reasonably be expected to convert to cash within approximately one year.", "type": "number" }, "totalCurrentLiabilities": { "format": "double", "description": "Most Balance Sheets make a distinction between current and long-term liabilities. In cases where the distinction is not made, the total of trade creditors, short-term notes payable, payroll taxes payable, and any other liability that would typically be paid by the company within one year.", "type": "number" }, "totalLiabilities": { "format": "double", "description": "All amounts owed by the company as of the Balance Sheet date in question.", "type": "number" }, "totalLiabilitiesAndNetAssets": { "format": "double", "description": "Total Liabilities plus Total Net Assets. This amount equals Total Assets if the Statement of Financial Position is in balance.", "type": "number" }, "totalLongTermLiabilities": { "format": "double", "description": "Any long term debt or liabilities that the organization has.", "type": "number" }, "totalNetAssets": { "format": "double", "description": "The total value of net assets. This should be equal to the value of total assets minus total liabilities.", "type": "number" }, "totalReceivables": { "format": "double", "description": "Total receivables owed to the organization - includes grants, accounts receivable and other receivables.", "type": "number" }, "unrestrictedCash": { "format": "double", "description": "The total of all monies in cash, checking, and money market accounts. Does not include investment assets (stocks, bonds, etc.). These should be included in the investments category. This should only be funds which are not restricted.", "type": "number" } }, "additionalProperties": false }, "FinancialInfoExtractStatementOfFinancialPositionV2": { "description": "Represents the Statement of Financial Position Section of NonProfit Financials", "type": "object", "properties": { "accountsReceivable": { "format": "double", "description": "All accounts receivable owed to the organization, net of any allowances for uncollectibles.", "type": "number" }, "accumulatedDepreciation": { "format": "double", "description": "The total amount of depreciation accumulated by the organization since the start of operations.", "type": "number" }, "additionalFields": { "description": "Additional Statement of Financial Position Fields", "type": "array", "items": { "$ref": "#/definitions/FinancialInfoExtractAdditionalFieldsData" } }, "comments": { "description": "Any relevant comments for statement of financial position information. You may enter separate comments for each period of data.", "type": "string" }, "contributionsReceivable": { "format": "double", "description": "All contribution receivables owed to the organization within the next year, net of any allowances for uncollectibles.", "type": "number" }, "currentInvestments": { "format": "double", "description": "The total of current investment assets owned by the organization.", "type": "number" }, "currentPortionOfLongTermDebt": { "format": "double", "description": "The portion of Long Term Liabilities being paid off within 12 months of the particular financial statement date and notes payable that have a maturity of less than one year.", "type": "number" }, "grossFixedAssets": { "format": "double", "description": "The amount for gross fixed assets or the value for Plant, Property, and Equipment before depreciation is subtracted.", "type": "number" }, "inventory": { "format": "double", "description": "The value of all items available for resale. Direct labor would only be included here if it is included in the calculation of inventory cost.", "type": "number" }, "longTermInvestmentAssets": { "format": "double", "description": "The total of long term investment assets owned by the organization.", "type": "number" }, "netFixedAssets": { "format": "double", "description": "The value of your fixed assets after having accounted for depreciation.", "type": "number" }, "notesPayableSeniorDebt": { "format": "double", "description": "This term applies to debt which has seniority or preference in case of a default or bankruptcy.", "type": "number" }, "notesPayableSubordinatedDebt": { "format": "double", "description": "This term applies to liabilities that are subordinate or have less preference in case of a default or bankruptcy.", "type": "number" }, "numberOfDonors": { "format": "double", "description": "Number of people and/or entities that made any kind of donation to the organization during the period. They do not necessarily have to be members.", "type": "number" }, "numberOfEmployees": { "format": "double", "description": "Total number of full-time employees and contractors. In the case of several part-time employees, take the total hours worked by the part-time employees and divide by the full-time equivalent hours. Enter the number of full-time equivalents as of the end of the period in question.", "type": "number" }, "numberOfMembers": { "format": "double", "description": "The total number of members in the organization.", "type": "number" }, "otherAssets": { "format": "double", "description": "Any additional assets held by the organization that have not already been accounted for.", "type": "number" }, "otherCurrentAssets": { "format": "double", "description": "Any current assets held by the organization that have not been accounted for in the Cash, Receivables, or Inventory fields.", "type": "number" }, "otherCurrentLiabilities": { "format": "double", "description": "Any current liabilities incurred by the organization that have not been accounted for in the Payables field. This field includes liabilities that would be paid by the organization in the upcoming year.", "type": "number" }, "otherLongTermLiabilities": { "format": "double", "description": "Other Long Term Liabilities that would not be considered either Senior or Subordinated Debt. Some possible examples include deferred taxes and the long term portion of a capital lease.", "type": "number" }, "otherReceivables": { "format": "double", "description": "All other receivables owed to the organization, net of any allowances for uncollectibles.", "type": "number" }, "payables": { "format": "double", "description": "Amounts owed to vendors.", "type": "number" }, "restrictedCash": { "format": "double", "description": "The total of all monies in cash, checking, and money market accounts. Does not include investment assets (stocks, bonds, etc.). These should be included in the investments category. These should only be funds which have restrictions.", "type": "number" }, "shortTermDebt": { "format": "double", "description": "The outstanding balance of any short term debt owed by the organization. This may include lines of credit, short term operating loans, etc.", "type": "number" }, "totalAssets": { "format": "double", "description": "This field should be available directly from any Balance Sheet.", "type": "number" }, "totalCashAndCashEquivalent": { "format": "double", "description": "The total of all monies in cash, checking, and money market accounts. Does not include investment assets (stocks, bonds, etc.). These should be included in the investments category.", "type": "number" }, "totalCurrentAssets": { "format": "double", "description": "The total of cash, marketable securities, accounts receivable, inventory, prepaid expenses, and any other asset the company owns that can reasonably be expected to convert to cash within approximately one year.", "type": "number" }, "totalCurrentLiabilities": { "format": "double", "description": "Most Balance Sheets make a distinction between current and long-term liabilities. In cases where the distinction is not made, the total of trade creditors, short-term notes payable, payroll taxes payable, and any other liability that would typically be paid by the company within one year.", "type": "number" }, "totalLiabilities": { "format": "double", "description": "All amounts owed by the company as of the Balance Sheet date in question.", "type": "number" }, "totalLiabilitiesAndNetAssets": { "format": "double", "description": "Total Liabilities plus Total Net Assets. This amount equals Total Assets if the Statement of Financial Position is in balance.", "type": "number" }, "totalLongTermLiabilities": { "format": "double", "description": "Any long term debt or liabilities that the organization has.", "type": "number" }, "totalNetAssets": { "format": "double", "description": "The total value of net assets. This should be equal to the value of total assets minus total liabilities.", "type": "number" }, "totalReceivables": { "format": "double", "description": "Total receivables owed to the organization - includes grants, accounts receivable and other receivables.", "type": "number" }, "unrestrictedCash": { "format": "double", "description": "The total of all monies in cash, checking, and money market accounts. Does not include investment assets (stocks, bonds, etc.). These should be included in the investments category. This should only be funds which are not restricted.", "type": "number" } }, "additionalProperties": false }, "GenerateLoanBoardingIdentifierResponse": { "type": "object", "properties": { "loanBoardingIdentifier": { "type": "string" } }, "additionalProperties": false }, "GenericWidgetStatus": { "description": "Status of a generic widget for an entity", "type": "object", "properties": { "status": { "description": "The status string. Must be one of: Pending, InProgress, Complete, or Failed.", "type": "string" } }, "additionalProperties": false }, "HmdaDenialReasons": { "description": "Reasons for denying a HMDA loan", "type": "object", "properties": { "hmdaLoanRecordId": { "format": "int64", "description": "The HMDA record to deny", "type": "integer" }, "reasons": { "description": "The reasons we are denying this HMDA record", "type": "array", "items": { "format": "string", "enum": [ "debtToIncomeRatio", "employmentHistory", "creditHistory", "collateral", "insufficientCash", "unverifiableInformation", "creditApplicationIncomplete", "mortgageInsuranceDenied", "other", "notApplicable" ], "type": "string" } } }, "additionalProperties": false }, "ISelectOption": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "x-nullable": true } }, "additionalProperties": false }, "IndirectAutoDealerInformationResponse": { "type": "object", "properties": { "address": { "description": "The address of the dealer", "type": "string" }, "dealerName": { "description": "The name of the dealer", "type": "string" }, "externalOrganizationId": { "description": "The identifier of the external organization", "type": "string" }, "id": { "format": "int64", "description": "The identifier of the dealer", "type": "integer" }, "phone": { "description": "The phone number of the dealer", "type": "string" } }, "additionalProperties": false }, "IndirectAutoLoanResponse": { "description": "Response model for indirect auto loan information", "type": "object", "properties": { "applicationId": { "format": "int64", "description": "The application ID associated with this loan", "type": "integer" }, "applicationNumber": { "format": "int32", "description": "The application number associated with this loan", "type": "integer" }, "balance": { "format": "double", "description": "The current balance of the loan", "type": "number" }, "dealerName": { "description": "The name of the dealer associated with this loan", "type": "string" }, "identifier": { "description": "The unique identifier for the loan", "type": "string" }, "loanApplicationOrigin": { "description": "The origin of the loan application (RouteOne, Dealertrack, etc.)", "type": "string" }, "loanOfficerName": { "description": "The name of the loan officer assigned to this loan", "type": "string" }, "primaryApplicantName": { "description": "The name of the primary applicant for the loan", "type": "string" }, "requestStartDate": { "format": "Date", "description": "The date when the loan request was started", "type": "string", "x-nullable": true }, "status": { "description": "The current status of the loan", "type": "string" }, "statusChangedDate": { "format": "Date", "description": "The date when the loan status was last changed", "type": "string", "x-nullable": true } }, "additionalProperties": false }, "JXchangeBoardLoanToCoreErrorMessage": { "type": "object", "properties": { "category": { "description": "The category of the error from jXchange", "type": "string" }, "code": { "description": "The code of the error from jXchange", "type": "string" }, "description": { "description": "The description of the error from jXchange", "type": "string" }, "element": { "description": "The element of the error from jXchange", "type": "string" }, "elementValue": { "description": "The element value of the error from jXchange", "type": "string" }, "location": { "description": "The location of the error from jXchange", "type": "string" } }, "additionalProperties": false }, "JXchangeBoardLoanToCoreErrorResponse": { "type": "object", "properties": { "actor": { "description": "The actor of the error response from jXchange", "type": "string" }, "code": { "description": "The code of the error response from jXchange", "type": "string" }, "errorMessages": { "description": "The list of errors from jXchange", "type": "array", "items": { "$ref": "#/definitions/JXchangeBoardLoanToCoreErrorMessage" } }, "message": { "description": "The message of the error response from jXchange", "type": "string" } }, "additionalProperties": false }, "JXchangeBoardLoanToCoreResponse": { "type": "object", "properties": { "lastBoardedDate": { "description": "Last Boarded Date of jXchange Export", "type": "string" }, "userName": { "description": "User Name of jXchange Export", "type": "string" } }, "additionalProperties": false }, "Lien": { "description": "A lien against collateral", "required": [ "collateralId", "lienPosition" ], "type": "object", "properties": { "collateralId": { "format": "int32", "description": "id of the collateral in Sageworks that the lien is associated with", "type": "integer" }, "id": { "format": "int32", "description": "id of the lien in Sageworks", "type": "integer" }, "isDeleted": { "description": "Indicates if the lien has been deleted", "type": "boolean" }, "lienAmount": { "format": "double", "description": "The amount of the lien (if the lien is with a different institution)", "type": "number" }, "lienHolder": { "description": "The lien holder for the lien (if the lien is with a different institution)", "type": "string" }, "lienPosition": { "format": "int32", "description": "The lien position of this loan for this collateral", "type": "integer", "x-nullable": true }, "loanId": { "format": "int32", "description": "id of the loan in Sageworks that the lien is associated with. Not specified if the loan is with a different institution", "type": "integer", "x-nullable": true } }, "additionalProperties": false }, "LoanApplication": { "description": "A loan application", "required": [ "applicationNumber", "createdDate", "id", "lastModifiedDate" ], "type": "object", "properties": { "agreedToTerms": { "description": "If the loan application terms have been agreed to", "type": "boolean" }, "agreedToTermsDate": { "format": "Date", "description": "Date of loan application terms agreement", "type": "string", "x-nullable": true }, "agreedToTermsUsername": { "description": "Username of loan application terms agreement", "type": "string" }, "applicationNumber": { "format": "int32", "description": "READ ONLY - A unique numeric identifier for the application", "type": "integer" }, "applicationStatus": { "format": "string", "description": "Status of the application (ex: new application, withdrawn, declined, application complete)", "enum": [ "eligibilityInProcess", "eligibilityUnderReview", "notEligible", "new", "profileComplete", "applicationComplete", "locked", "approved", "declined", "withdrawn", "associated", "lenderReview", "readyForBorrowerSubmission" ], "type": "string" }, "applicationTemplateId": { "format": "int32", "description": "ID of the loan application template", "type": "integer" }, "bankLoanOfficerID": { "format": "int32", "description": "ID of the bank loan officer", "type": "integer" }, "createdDate": { "format": "Date", "description": "READ ONLY - The date that this loan application was created", "type": "string" }, "crmIdentifier": { "description": "CRM System's identifier", "type": "string" }, "customerGroupId": { "format": "int32", "description": "ID of the group associated with the loan application if there is one", "type": "integer" }, "id": { "format": "int32", "description": "READ ONLY - The id of the application in Sageworks", "type": "integer" }, "isDynamicApplication": { "description": "READ ONLY - True if a loan application is built using the dynamic application system, hosted in OnlinePortalNow.com.\r\nFalse if classic loan application, hosted in SageworksAnalyst.com.", "type": "boolean" }, "lastModifiedDate": { "format": "Date", "description": "READ ONLY - The date that this loan application was last modified\r\nThis is updated on the server upon saving changes to the application model", "type": "string" }, "lockedDate": { "format": "Date", "description": "Date the application was locked", "type": "string", "x-nullable": true }, "submittedDate": { "format": "Date", "description": "READ ONLY - The date that this loan application was submitted\r\nThis is updated on the server upon submitting the application\r\nDate must be greater than January 1, 2010", "type": "string", "x-nullable": true }, "type": { "description": "READ ONLY - Type of the application (ex: business, personal, SBA, nonprofit)", "enum": [ "business", "personal", "sba", "nonprofit", "farm" ], "type": "string", "x-nullable": true } }, "additionalProperties": false }, "LoanApplicationPersonalInputData": { "description": "Loan Application Personal Input Data Mapping", "type": "object", "properties": { "id": { "format": "int32", "description": "The ID of the mapping in Sageworks", "type": "integer" }, "loanApplicationProposedLoanMappingId": { "format": "int32", "description": "The ID of the Loan Application Loan in Sageworks", "type": "integer" }, "personalInputDataId": { "format": "int32", "description": "The ID of the Personal Input Data in Sageworks", "type": "integer" } }, "additionalProperties": false }, "LoanApplicationProposedLoanMapping": { "description": "Represents that a loan application contains a proposed loan", "required": [ "loanApplicationId", "proposedLoanId" ], "type": "object", "properties": { "applicationTemplateId": { "format": "int32", "description": "The id of the application template in Sageworks", "type": "integer", "x-nullable": true }, "id": { "format": "int32", "description": "READ ONLY- The id of the mapping object in Sageworks", "type": "integer" }, "loanApplicationId": { "format": "int32", "description": "The id of the loan application in Sageworks", "type": "integer" }, "proposedLoanId": { "format": "int32", "description": "The id of the proposed loan in Sageworks", "type": "integer" } }, "additionalProperties": false }, "LoanApplicationSubmitByIdRequest": { "description": "Represents an object containing the items necessary to submit a LoanApplication by ID", "type": "object", "properties": { "id": { "format": "int32", "description": "ID of the LoanApplication to submit", "type": "integer" } }, "additionalProperties": false }, "LoanAssociationCollateralMapping": { "description": "Represents the mapping between Proposed and Existing Collateral for Proposed Loan Associations", "type": "object", "properties": { "existingCollateralId": { "format": "int32", "description": "Id of the existing collateral that proposed collateral data will be copied to", "type": "integer" }, "proposedCollateralId": { "format": "int32", "description": "Id of the proposed collateral whose data should be copied to the existing collateral", "type": "integer" } }, "additionalProperties": false }, "LoanAssociationCollateralOption": { "description": "Represents a Collateral Option for Loan Association", "type": "object", "properties": { "description": { "description": "Description of the Collateral", "type": "string" }, "id": { "format": "int32", "description": "Id of the Collateral", "type": "integer" } }, "additionalProperties": false }, "LoanAssociationCollateralOptions": { "description": "Represents the collection of Proposed and Existing Collateral that can be used with a Loan Association", "type": "object", "properties": { "existingCollateralOptions": { "description": "The list of Existing Collateral Options", "type": "array", "items": { "$ref": "#/definitions/LoanAssociationCollateralOption" } }, "proposedCollateralOptions": { "description": "The list of Proposed Collateral Options", "type": "array", "items": { "$ref": "#/definitions/LoanAssociationCollateralOption" } } }, "additionalProperties": false }, "LoanBoardingNotificationRequest": { "type": "object", "properties": { "message": { "description": "Message of the notification", "type": "string" }, "messageType": { "format": "string", "description": "Message type of the notification", "enum": [ "information", "error" ], "type": "string" }, "proposedLoanId": { "format": "int32", "description": "Id of the proposed loan", "type": "integer" }, "recipients": { "$ref": "#/definitions/NotificationRequestRecipients" } }, "additionalProperties": false }, "LoanOfficer": { "description": "A loan officer in the Sageworks account", "type": "object", "properties": { "email": { "description": "Email of the loan officer", "type": "string" }, "firstName": { "description": "First name of the loan officer", "type": "string" }, "id": { "format": "int32", "description": "id of the loan officer", "type": "integer" }, "lastName": { "description": "Last name of the loan officer", "type": "string" }, "loanRepresentativeCode": { "description": "NMLS Code of the loan officer", "type": "string" } }, "additionalProperties": false }, "LoanOrigination": { "description": "Represents a Loan Origination in Sageworks", "type": "object", "properties": { "companyStatesId": { "format": "int32", "description": "This is the id for governing state for the loan transaction", "type": "integer", "x-nullable": true }, "coreSystemLoanNumber": { "description": "This is the loan number that will appear on the loan documents that are created. It is also the loan number that will be used in the core system once the loan is booked.", "type": "string" }, "csLoanType": { "description": "This indicates whether the transaction is a consumer or a commercial loan", "enum": [ "consumer", "commercial" ], "type": "string", "x-nullable": true }, "id": { "format": "int32", "description": "ID of the Loan Origination in Sageworks", "type": "integer" }, "loanOriginationDocumentsStarted": { "description": "Whether the Loan Origination Documents have been started in CS.\r\n \r\nIf set to true, all other fields are read-only. To be able to edit other fields for this Loan Origination, Document Data for this Loan Origination must be deleted from within Sageworks Document Preparation.", "type": "boolean" }, "loanPaymentType": { "description": "This indicates the payment type of the loan", "enum": [ "principalAndInterestPayment", "interestOnlyPayment", "specifiedPeriodicPayment", "additionalPrincipalPayment", "skippedPayment", "replacementPayment", "accruedInterestOnly", "dollarAmountPlusAccruedInterest", "fixedDollarAmount", "dollarAmountPerThousandOfOutstandingBalance", "fixedFractionOfOutstandingPrincipalBalancePlusAccruedInterest", "greaterOfADollarAmountOrAccruedInterest", "greaterOfAPercentageOfTheOutstandingBalanceOrADollarAmount", "greaterOfAPercentageOfTheOutstandingBalancePlusAccruedInterestOrADollarAmount", "greaterOfAPercentageOfTheOutstandingBalanceOrAccruedInterest", "percentageOfTheOutstandingBalance", "percentageOfTheOutstandingBalancePlusAccruedInterest", "othersAsSpecified", "balloon", "amortizedPaymentPrincipalAndInterest" ], "type": "string", "x-nullable": true }, "loanStatusType": { "description": "This indicates the Loan Status - READ ONLY", "enum": [ "none", "application", "closingApproved", "denial" ], "type": "string", "x-nullable": true }, "loanTermType": { "description": "This indicates whether the loan is either open end or closed end", "enum": [ "closedEndTermLoan", "openEndLineOfCredit" ], "type": "string", "x-nullable": true }, "proposedLoanId": { "format": "int32", "description": "Id of the Proposed Loan tied to this Loan Origination", "type": "integer", "x-nullable": true } }, "additionalProperties": false }, "LoanRole": { "description": "Represents a customer with a relationship to a loan (primary borrower, co-signer, etc.)", "type": "object", "properties": { "customerId": { "format": "int32", "description": "Id of the customer that is related to the loan - READ ONLY", "type": "integer" }, "id": { "format": "int32", "description": "Id of the loan role that is related to the loan - READ ONLY", "type": "integer" }, "isDeleted": { "description": "True if this role has been deleted", "type": "boolean" }, "percentResponsible": { "format": "double", "description": "The percent of the loan is the customer responsible for with respect to the role", "type": "number" }, "portfolioLoanId": { "format": "int32", "description": "Id of the Portfolio Loan that the customer plays a role on -- READ ONLY\r\nLoan Role cannot have BOTH PortfolioLoanId and ProposedLoanId populated", "type": "integer", "x-nullable": true }, "proposedLoanId": { "format": "int32", "description": "Id of the Proposed Loan that the customer plays a role on -- READ ONLY\r\nLoan Role cannot have BOTH PortfolioLoanId and ProposedLoanId populated", "type": "integer", "x-nullable": true }, "roleType": { "description": "The type of role that the customer has with respect to the loan -- READ ONLY\r\n \r\nDefault options are: Co-Borrower, Cosigner, Credit Applicant, and Guarantor, but other options may be available\r\nfor your institution", "type": "string" } }, "additionalProperties": false }, "LoanRoleType": { "description": "Represents the different roles that can be related to a loan, such as Primary Borrower or Guarantor", "type": "object", "properties": { "description": { "description": "Describes the type of the role", "type": "string" }, "id": { "format": "int32", "description": "The identifier for this role", "type": "integer" }, "isDirectRole": { "description": "Indicates if this role type is directly against the loan, or must be related to another role type", "type": "boolean" } }, "additionalProperties": false }, "LoanSegment": { "description": "A segment of loans and its associated aggregate balances", "type": "object", "properties": { "segmentationCode": { "description": "Segmentation code associated with this segment of loans", "type": "string" }, "totalIndividualLoanBalance": { "format": "double", "description": "The total balance of all individual loans in this segment", "type": "number" }, "totalLoanBalance": { "format": "double", "description": "The total balance of all loans in this segment", "type": "number" }, "totalLoanCount": { "format": "int32", "description": "Number of loans in this segment", "type": "integer" }, "totalOtherLoanBalance": { "format": "double", "description": "The total balance of all other loans in this segment", "type": "number" }, "totalPooledLoanBalance": { "format": "double", "description": "The total balance of all pooled loans in this segment", "type": "number" }, "totalPurchasedImpairedLoanBalance": { "format": "double", "description": "The total balance of all purchased impaired loans in this segment", "type": "number" }, "totalPurchasedNonImpairedLoanBalance": { "format": "double", "description": "The total balance of all purchased non-impaired loans in this segment", "type": "number" } }, "additionalProperties": false }, "LosLiteLoanSummaryInformation": { "description": "A portfolio loan with just the summary information used on Lost Lite Loan Information", "type": "object", "properties": { "borrowerName": { "description": "This is the name of the primary borrower", "type": "string" }, "currentBalance": { "format": "double", "description": "This is the current outstanding amount on the loan prior to any charge-offs and other adjustments", "type": "number" }, "customerId": { "format": "int32", "description": "The id of the customer that is the primary borrower for the loan", "type": "integer" }, "daysCurrentlyPastDue": { "format": "int32", "description": "Number of days a payment has not been made", "type": "integer", "x-nullable": true }, "id": { "format": "int32", "description": "The id of the loan in Sageworks", "type": "integer" }, "loanNumber": { "description": "Loan number assigned to the loan. This is also the unique identifier of the loan\r\nin the source system", "type": "string" }, "loanOfficer": { "description": "This is the name of the loan officer assigned", "type": "string" }, "maturityDate": { "description": "The date when loan the must be paid to the investor", "type": "string" }, "originalBalance": { "format": "double", "description": "This is the original amount of credit that was approved", "type": "number" }, "paymentAmount": { "format": "double", "description": "The payment amount for the loan. For fixed principal and fixed payment loans, this will include principal and interest. For lines of credit, this will include interest only.", "type": "number" }, "paymentFrequency": { "description": "The frequency of the payments for the loan (ex: weekly, monthly, annual, etc.)", "enum": [ "annual", "semiannual", "quarterly", "bimonthly", "monthly", "semimonthly", "biweekly", "weekly" ], "type": "string", "x-nullable": true }, "productCode": { "description": "Product Code", "type": "string" } }, "additionalProperties": false }, "ModelError": { "type": "object", "properties": { "message": { "type": "string" }, "propertyName": { "type": "string" } }, "additionalProperties": false }, "NotificationRequest": { "description": "Notification Requests", "type": "object", "properties": { "emailNotification": { "description": "Flag to send email notification", "type": "boolean" }, "hyperLinkEnabled": { "description": "Flag to add a link to the notification", "type": "boolean" }, "hyperLinkId": { "format": "int32", "description": "The id to get the information on the page you are going to navigate", "type": "integer", "x-nullable": true }, "hyperLinkPage": { "description": "The page to navigate", "enum": [ "dealSummary", "documents" ], "type": "string", "x-nullable": true }, "message": { "description": "Message of the notification", "type": "string" }, "messageType": { "format": "string", "description": "Message type of the notification", "enum": [ "information", "error" ], "type": "string" }, "recipients": { "$ref": "#/definitions/NotificationRequestRecipients" } }, "additionalProperties": false }, "NotificationRequestRecipients": { "type": "object", "properties": { "roleIds": { "description": "Ids of the roles to notify", "type": "array", "items": { "format": "int64", "type": "integer" } }, "userIds": { "description": "Ids of the users to notify", "type": "array", "items": { "format": "int64", "type": "integer" } } }, "additionalProperties": false }, "OnlinePortalUserCustomerConnection": { "type": "object", "properties": { "customerId": { "format": "int64", "description": "Customer to map with Portal User", "type": "integer" }, "onlinePortalUserId": { "format": "int64", "description": "OnlinePortalUserId to map with Customer", "type": "integer" } }, "additionalProperties": false }, "Opportunity": { "description": "An opportunity in Sageworks", "type": "object", "properties": { "amount": { "format": "double", "description": "The amount of the opportunity", "type": "number", "x-nullable": true }, "assignedToUsersId": { "format": "int32", "description": "The usersID of the loan officer the opportunity is assigned to", "type": "integer", "x-nullable": true }, "comments": { "description": "Comments related to this opportunity", "type": "string" }, "createdDate": { "format": "Date", "description": "The date the opportunity was created", "type": "string", "x-nullable": true }, "estimatedCloseDate": { "format": "Date", "description": "The estimated close date for this opportunity", "type": "string", "x-nullable": true }, "id": { "format": "int32", "description": "id of the opportunity", "type": "integer" }, "isDeleted": { "description": "Indicates if this opportunity has been deleted", "type": "boolean" }, "lastModifiedDate": { "format": "Date", "description": "The date the opportunity was modified", "type": "string", "x-nullable": true }, "name": { "description": "Name of the opportunity", "type": "string" }, "objectId": { "format": "int32", "description": "The id of the object that is being associated with the opportunity", "type": "integer" }, "objectType": { "description": "The type of object that is being associated with the opportunity", "type": "string" }, "probabilityOfClose": { "format": "double", "description": "The probability of close of the opportunity", "type": "number", "x-nullable": true }, "referredBy": { "description": "The person who referred this opportunity", "type": "string" }, "stage": { "description": "The stage that the opportunity is in (ex: Approval, Pricing, Closed Won, etc.)", "type": "string" }, "type": { "description": "The type of opportunity (ex: CRE, Line of Credit, Credit Card)", "type": "string" }, "userDefinedFields": { "description": "User-defined fields for the opportunity", "type": "object", "additionalProperties": { "type": "string" } } }, "additionalProperties": false }, "OtherEntityRole": { "type": "object", "properties": { "jobTitle": { "description": "The job title of the customer.", "type": "string" }, "name": { "description": "The name of the customer.", "type": "string" }, "ownerCustomerId": { "format": "int32", "description": "The customerId of the customer.", "type": "integer" }, "ownerCustomerNumber": { "description": "The customer number of the customer.", "type": "string" }, "ownerLoanBoardingIdentifier": { "description": "The loan boarding identifier of the customer.", "type": "string" }, "roles": { "description": "The roles for the customer.", "type": "array", "items": { "format": "string", "enum": [ "authorizedSigner", "cosigner", "creditApplicant", "trustee", "beneficialOwner", "coBorrower", "guarantor", "primaryBorrower", "resolvingPartyAuthorizedSigner", "resolvingPartyCertifier", "affiliate", "programAdministrator", "alternateProgramAdministrator" ], "type": "string" } }, "signingCapacity": { "description": "The signing capacity of the customer.", "type": "string" } }, "additionalProperties": false }, "PagedCollectionResponse[LosLiteLoanSummaryInformation]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/LosLiteLoanSummaryInformation" } }, "totalResultsCount": { "format": "int32", "type": "integer" } }, "additionalProperties": false }, "PagedCollectionResponse[PortfolioLoanSummaryInformation]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/PortfolioLoanSummaryInformation" } }, "totalResultsCount": { "format": "int32", "type": "integer" } }, "additionalProperties": false }, "PagedCollectionResponse[ProposedLoanSummaryInformation]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/ProposedLoanSummaryInformation" } }, "totalResultsCount": { "format": "int32", "type": "integer" } }, "additionalProperties": false }, "PhoneNumber": { "description": "Represents a phone number", "type": "object", "properties": { "number": { "description": "The phone number", "type": "string" }, "type": { "format": "string", "description": "The type of phone number (ex: primary, mobile, fax)", "enum": [ "primary", "mobile", "fax" ], "type": "string" } }, "additionalProperties": false }, "PlaidJsonAssetReport": { "type": "object", "properties": { "dateGenerated": { "format": "Date", "description": "The date the report was created", "type": "string" }, "rawJson": { "description": "Asset report json for the specific customer", "type": "string" } }, "additionalProperties": false }, "PlaidJsonAssetReportResponse": { "type": "object", "properties": { "assetReports": { "description": "All Asset report json records for the specific customer", "type": "array", "items": { "$ref": "#/definitions/PlaidJsonAssetReport" } } }, "additionalProperties": false }, "PolicyException": { "description": "An policy exception in Sageworks", "type": "object", "properties": { "comments": { "description": "Comments associated with the policy exception", "type": "string" }, "createdDate": { "format": "Date", "description": "Created date of the policy exception", "type": "string" }, "customerId": { "format": "int64", "description": "The Id of the customer associated with the policy exception", "type": "integer" }, "id": { "format": "int32", "description": "Id of the policy exception", "type": "integer" }, "isDeleted": { "description": "Whether the policy exception has been deleted", "type": "boolean" }, "isProposed": { "description": "Whether the LoanId references a proposed or portfolio loan", "type": "boolean" }, "loanId": { "format": "int64", "description": "The Id of the loan associated with the policy exception", "type": "integer" }, "policyExceptionStatusId": { "format": "int64", "description": "Status of the policy exception (optional)", "type": "integer", "x-nullable": true }, "policyExceptionTypeId": { "format": "int64", "description": "Type of the policy exception", "type": "integer" }, "workflowId": { "format": "int32", "description": "The Id of the workflow associated with the policy exception", "type": "integer", "x-nullable": true } }, "additionalProperties": false }, "PolicyExceptionStatus": { "description": "A policy exception type in Sageworks", "type": "object", "properties": { "description": { "description": "Description of the policy exception status", "type": "string" }, "id": { "format": "int32", "description": "Id of the policy exception status", "type": "integer" }, "isDeleted": { "description": "Whether the policy exception status is deleted", "type": "boolean" } }, "additionalProperties": false }, "PolicyExceptionType": { "description": "A policy exception type in Sageworks", "type": "object", "properties": { "description": { "description": "Description of the policy exception type", "type": "string" }, "id": { "format": "int32", "description": "Id of the policy exception type", "type": "integer" }, "isDeleted": { "description": "Whether the policy exception type is deleted", "type": "boolean" } }, "additionalProperties": false }, "PortfolioLoan": { "description": "A loan to a customer of a financial institution", "required": [ "customerId", "loanNumber", "paymentType" ], "type": "object", "properties": { "accountType": { "description": "The level of the loan in the hierarchy. For example, these could be a facility, limit, loan.", "enum": [ "loan", "facility" ], "type": "string", "x-nullable": true }, "accruedInterest": { "format": "double", "description": "Interest that has accumulated since the principal investment,\r\nor since the previous interest payment if there has been one already.\r\nFor purposes of the calculation of reserves for individually analyzed loans, the accrued interest\r\nshould be included in the Total Recorded Investment in the loan", "type": "number", "x-nullable": true }, "adjustableInterestRate": { "description": "Indicates if the interest rate for the loan is adjustable", "type": "boolean" }, "amortizedOver": { "format": "int32", "description": "The term in which the loan payment is calculated", "type": "integer", "x-nullable": true }, "amountPastDue": { "format": "double", "description": "The total past due amount", "type": "number", "x-nullable": true }, "annualFee": { "format": "double", "description": "Annual fees associated with this loan", "type": "number" }, "bankCodeBranch": { "description": "The Branch Code corresponding to the Bank Code Branch for the proposed loan", "type": "string" }, "bookBalance": { "format": "double", "description": "This is the balance of the loan after accounting for charge-offs and other adjustments to the current outstanding loan balance.", "type": "number", "x-nullable": true }, "callCode": { "description": "Code taken from the Report of Condition Schedule RC-C", "type": "string" }, "ceilingRate": { "format": "double", "description": "Maximum rate that can be charged for an adjustable rate loan", "type": "number" }, "chargedOffAmount": { "format": "double", "description": "The amount of principal balance that has been charged off for this loan", "type": "number", "x-nullable": true }, "collateralCode": { "description": "Code to identify the primary type of collateral associated with the loan", "type": "string" }, "comments": { "description": "Added Comments", "type": "string" }, "currentAvailableCredit": { "format": "double", "description": "Current amount of available credit on the loan", "type": "number", "x-nullable": true }, "currentBalance": { "format": "double", "description": "This is the current outstanding amount on the loan prior to any charge-offs and other adjustments", "type": "number" }, "customerId": { "format": "int32", "description": "The id of the customer that is the primary borrower for the loan", "type": "integer" }, "dayCountConvention": { "description": "Amortization Days are used to calculate the interest and payment amount for the life of the loan.", "enum": [ "c_30_360", "c_30_365", "c_Actual_360", "c_Actual_365" ], "type": "string", "x-nullable": true }, "daysCurrentlyPastDue": { "format": "int32", "description": "Then number of days that the loan is currently past due", "type": "integer", "x-nullable": true }, "defaultStartDate": { "format": "Date", "description": "The date at which the loan went into default", "type": "string", "x-nullable": true }, "expectedUtilizationRate": { "format": "double", "description": "The percentage of the Line of Credit the borrower is expected to use", "type": "number", "x-nullable": true }, "floorRate": { "format": "double", "description": "Rate in the lower range of rates associated with a floating rate loan", "type": "number" }, "governmentGuaranteed": { "description": "Indicates if the loan is backed by government guarantees", "type": "boolean" }, "governmentGuaranteedBalance": { "format": "double", "description": "The dollar amount of the loan balance that is backed by a government guarantee", "type": "number", "x-nullable": true }, "governmentGuaranteedPercent": { "format": "double", "description": "The percent of the loan balance that is backed by a government guarantee", "type": "number", "x-nullable": true }, "id": { "format": "int32", "description": "The id of the loan in Sageworks", "type": "integer" }, "indexRate": { "format": "double", "description": "Floating rate peg rate", "type": "number" }, "indexRateDescription": { "description": "The floating rate that this loan is pegged to", "type": "string" }, "industryCode": { "description": "Industry code (NAICS) associated with the business if the borrower for this loan is a business", "type": "string" }, "institutionAvailableCredit": { "format": "double", "description": "Current amount of available credit on the loan (specific to this institution)", "type": "number", "x-nullable": true }, "institutionWithheld": { "format": "double", "description": "The amount of the loan that is not available to the borrower to draw (specific to this institution)", "type": "number", "x-nullable": true }, "interestRate": { "format": "double", "description": "Interest rate for the loan", "type": "number" }, "isDeleted": { "description": "Indicates if the loan has been deleted", "type": "boolean" }, "isGuidanceLineOfCredit": { "description": "Whether the loan is a guidance line of credit", "type": "boolean", "x-nullable": true }, "latestPaymentDate": { "format": "Date", "description": "The date of the most recent payment made on the loan", "type": "string", "x-nullable": true }, "loanNumber": { "description": "Loan number assigned to the loan. This is also the unique identifier of the loan\r\nin the source system", "minLength": 1, "type": "string" }, "loanOfficerId": { "format": "int32", "description": "if of the loan officer for this loan", "type": "integer", "x-nullable": true }, "loanToValueRatio": { "format": "double", "description": "The loan to value (LTV) ratio for the loan", "type": "number", "x-nullable": true }, "loanTypeCode": { "description": "A code to represent the primary type of the loan (ex: CRE, C/I, etc.)", "type": "string" }, "lossGivenDefaultRiskRating": { "description": "The loss given default risk rating", "type": "string" }, "maturityDate": { "format": "Date", "description": "The date that the loan will expire / mature", "type": "string", "x-nullable": true }, "name": { "description": "The name/description of the loan", "type": "string" }, "netDeferredFeesOrCosts": { "format": "double", "description": "Net deferred loan fees or costs are certain fees and other direct costs associated with originating\r\nloans over the life of the loan as an adjustment of yield, net of any related fees received.\r\nFor purposes of the calculation of reserves for individually analyzed loans, net deferred loan fees or\r\ncosts should be included in the Total Recorded Investment in the loan", "type": "number", "x-nullable": true }, "nonAccrual": { "description": "Indicates if the loan has been placed on non accrual", "type": "boolean" }, "nonAccrualDate": { "format": "Date", "description": "The date that loan was placed on non accrual", "type": "string", "x-nullable": true }, "originalLoanAmount": { "format": "double", "description": "The amount (full value) of the loan at the time of origination", "type": "number", "x-nullable": true }, "originalTermInMonths": { "format": "int32", "description": "The original term of the loan (in months)", "type": "integer", "x-nullable": true }, "originationDate": { "format": "Date", "description": "The date that the loan was originated", "type": "string", "x-nullable": true }, "originationExpenses": { "format": "double", "description": "Origination fees associated with this loan", "type": "number" }, "overheadExpenses": { "format": "double", "description": "Overhead fees associated with this loan", "type": "number" }, "parentLoansId": { "format": "int64", "description": "The ID of the parent loan in Sageworks", "type": "integer", "x-nullable": true }, "paymentAmount": { "format": "double", "description": "The payment amount for the loan. For fixed principal and fixed payment loans, this will include principal and interest. For lines of credit, this will include interest only.", "type": "number" }, "paymentFrequency": { "description": "The frequency of the payments for the loan (ex: weekly, monthly, annual, etc.)", "enum": [ "annual", "semiannual", "quarterly", "bimonthly", "monthly", "semimonthly", "biweekly", "weekly" ], "type": "string", "x-nullable": true }, "paymentType": { "description": "The type of payment for the loan (ex: fixed payment, interest only, line of credit, etc.)", "enum": [ "fixedPayment", "fixedPrincipal", "lineOfCredit", "revolvingLineOfCredit", "interestOnly", "fixedPaymentBalloon", "fixedPrincipalBalloon", "singlePaymentBalloon", "principalOnly", "other", "noPayment" ], "type": "string", "x-nullable": true }, "points": { "format": "double", "description": "Points associated with the loan", "type": "number", "x-nullable": true }, "prepaymentPenalty": { "description": "Whether or not the loan has a prepayment penalty", "type": "boolean", "x-nullable": true }, "probabilityOfDefaultRiskRating": { "format": "double", "description": "The probability of default risk rating", "type": "number", "x-nullable": true }, "productCode": { "description": "Code for the product that is associated with the loan", "type": "string" }, "purposeCode": { "description": "A code indicating the purpose of the loan", "type": "string" }, "refinance": { "description": "Indicates whether the loan is a refinance", "type": "boolean" }, "remainingTermInMonths": { "format": "int32", "description": "Remaining term of the loan in months", "type": "integer" }, "renewalDate": { "format": "Date", "description": "The renewal date of the loan", "type": "string", "x-nullable": true }, "repricingDate": { "format": "Date", "description": "The repricing date of the loan", "type": "string", "x-nullable": true }, "riskRating": { "format": "int32", "description": "Risk rating of the loan (typically a number between 1 and 10)", "type": "integer" }, "riskRatingId": { "format": "int64", "description": "The Id of the Risk Rating Calculation for the loan. This field is READ ONLY.", "type": "integer", "x-nullable": true }, "servicingExpenses": { "format": "double", "description": "Servicing fees associated with this loan", "type": "number" }, "spread": { "format": "double", "description": "The difference between two rates", "type": "number" }, "timesPastDue3060": { "format": "int32", "description": "Number of times the loan has been past due 30-60 days since origination", "type": "integer", "x-nullable": true }, "timesPastDue6090": { "format": "int32", "description": "Number of times the loan has been past due 60-90 days since origination", "type": "integer", "x-nullable": true }, "timesPastDue90Plus": { "format": "int32", "description": "Number of times the loan has been past due 90 or more days since origination", "type": "integer", "x-nullable": true }, "totalFees": { "format": "double", "description": "Fees associated with this loan", "type": "number", "x-nullable": true }, "troubledDebtRestructure": { "description": "Indicates if the loan is considered to be a troubled debt restructure", "type": "boolean" }, "troubledDebtRestructureDate": { "format": "Date", "description": "The date that the loan became a troubled debt restructure", "type": "string", "x-nullable": true }, "unamortizedPremium": { "format": "double", "description": "Unamortized premium value for the loan", "type": "number", "x-nullable": true }, "unusedCommitmentFee": { "format": "double", "description": "Unused commitment fee associated with this loan", "type": "number" }, "upfrontFee": { "format": "double", "description": "Upfront fees associated with this loan", "type": "number" }, "userDefinedDate1": { "format": "Date", "description": "User Defined Date 1", "type": "string", "x-nullable": true }, "userDefinedDate10": { "format": "Date", "description": "User Defined Date 10", "type": "string", "x-nullable": true }, "userDefinedDate2": { "format": "Date", "description": "User Defined Date 2", "type": "string", "x-nullable": true }, "userDefinedDate3": { "format": "Date", "description": "User Defined Date 3", "type": "string", "x-nullable": true }, "userDefinedDate4": { "format": "Date", "description": "User Defined Date 4", "type": "string", "x-nullable": true }, "userDefinedDate5": { "format": "Date", "description": "User Defined Date 5", "type": "string", "x-nullable": true }, "userDefinedDate6": { "format": "Date", "description": "User Defined Date 6", "type": "string", "x-nullable": true }, "userDefinedDate7": { "format": "Date", "description": "User Defined Date 7", "type": "string", "x-nullable": true }, "userDefinedDate8": { "format": "Date", "description": "User Defined Date 8", "type": "string", "x-nullable": true }, "userDefinedDate9": { "format": "Date", "description": "User Defined Date 9", "type": "string", "x-nullable": true }, "userDefinedFields": { "description": "User-defined fields for the proposed loan", "type": "object", "additionalProperties": { "type": "string" } }, "userDefinedNumber1": { "format": "double", "description": "User Defined Number 1", "type": "number", "x-nullable": true }, "userDefinedNumber10": { "format": "double", "description": "User Defined Number 10", "type": "number", "x-nullable": true }, "userDefinedNumber11": { "format": "double", "description": "User Defined Number 11", "type": "number", "x-nullable": true }, "userDefinedNumber12": { "format": "double", "description": "User Defined Number 12", "type": "number", "x-nullable": true }, "userDefinedNumber13": { "format": "double", "description": "User Defined Number 13", "type": "number", "x-nullable": true }, "userDefinedNumber14": { "format": "double", "description": "User Defined Number 14", "type": "number", "x-nullable": true }, "userDefinedNumber15": { "format": "double", "description": "User Defined Number 15", "type": "number", "x-nullable": true }, "userDefinedNumber16": { "format": "double", "description": "User Defined Number 16", "type": "number", "x-nullable": true }, "userDefinedNumber17": { "format": "double", "description": "User Defined Number 17", "type": "number", "x-nullable": true }, "userDefinedNumber18": { "format": "double", "description": "User Defined Number 18", "type": "number", "x-nullable": true }, "userDefinedNumber19": { "format": "double", "description": "User Defined Number 19", "type": "number", "x-nullable": true }, "userDefinedNumber2": { "format": "double", "description": "User Defined Number 2", "type": "number", "x-nullable": true }, "userDefinedNumber20": { "format": "double", "description": "User Defined Number 20", "type": "number", "x-nullable": true }, "userDefinedNumber3": { "format": "double", "description": "User Defined Number 3", "type": "number", "x-nullable": true }, "userDefinedNumber4": { "format": "double", "description": "User Defined Number 4", "type": "number", "x-nullable": true }, "userDefinedNumber5": { "format": "double", "description": "User Defined Number 5", "type": "number", "x-nullable": true }, "userDefinedNumber6": { "format": "double", "description": "User Defined Number 6", "type": "number", "x-nullable": true }, "userDefinedNumber7": { "format": "double", "description": "User Defined Number 7", "type": "number", "x-nullable": true }, "userDefinedNumber8": { "format": "double", "description": "User Defined Number 8", "type": "number", "x-nullable": true }, "userDefinedNumber9": { "format": "double", "description": "User Defined Number 9", "type": "number", "x-nullable": true }, "userDefinedString1": { "description": "User Defined String 1", "type": "string" }, "userDefinedString10": { "description": "User Defined String 10", "type": "string" }, "userDefinedString11": { "description": "User Defined String 11", "type": "string" }, "userDefinedString12": { "description": "User Defined String 12", "type": "string" }, "userDefinedString13": { "description": "User Defined String 13", "type": "string" }, "userDefinedString14": { "description": "User Defined String 14", "type": "string" }, "userDefinedString15": { "description": "User Defined String 15", "type": "string" }, "userDefinedString16": { "description": "User Defined String 16", "type": "string" }, "userDefinedString17": { "description": "User Defined String 17", "type": "string" }, "userDefinedString18": { "description": "User Defined String 18", "type": "string" }, "userDefinedString19": { "description": "User Defined String 19", "type": "string" }, "userDefinedString2": { "description": "User Defined String 2", "type": "string" }, "userDefinedString20": { "description": "User Defined String 20", "type": "string" }, "userDefinedString3": { "description": "User Defined String 3", "type": "string" }, "userDefinedString4": { "description": "User Defined String 4", "type": "string" }, "userDefinedString5": { "description": "User Defined String 5", "type": "string" }, "userDefinedString6": { "description": "User Defined String 6", "type": "string" }, "userDefinedString7": { "description": "User Defined String 7", "type": "string" }, "userDefinedString8": { "description": "User Defined String 8", "type": "string" }, "userDefinedString9": { "description": "User Defined String 9", "type": "string" }, "watchList": { "description": "Indicates if the loan has been placed on a watch list", "type": "boolean" }, "withheldAmount": { "format": "double", "description": "The amount of the loan that is not available to the borrower to draw", "type": "number", "x-nullable": true } }, "additionalProperties": false }, "PortfolioLoanBasicInformation": { "description": "A portfolio loan with just the basic information", "type": "object", "properties": { "currentBalance": { "format": "double", "description": "This is the current outstanding amount on the loan prior to any charge-offs and other adjustments", "type": "number" }, "customerId": { "format": "int32", "description": "The id of the customer that is the primary borrower for the loan", "type": "integer" }, "id": { "format": "int32", "description": "The id of the loan in Sageworks", "type": "integer" }, "loanNumber": { "description": "Loan number assigned to the loan. This is also the unique identifier of the loan\r\nin the source system", "type": "string" } }, "additionalProperties": false }, "PortfolioLoanSummaryInformation": { "description": "A portfolio loan with just the summary information used on Loan Information page", "type": "object", "properties": { "bankCustomerProfitEntitiesID": { "format": "int64", "description": "The unique ID of the primary borrower.", "type": "integer" }, "borrowerName": { "description": "This is the name of the primary borrower", "type": "string" }, "currentAvailableCredit": { "format": "double", "description": "This is the amount of credit that has been approved, but has not yet been used.", "type": "number" }, "currentBalance": { "format": "double", "description": "This is the current outstanding amount on the loan prior to any charge-offs and other adjustments", "type": "number" }, "customerId": { "format": "int32", "description": "The id of the customer that is the primary borrower for the loan", "type": "integer" }, "id": { "format": "int32", "description": "The id of the loan in Sageworks", "type": "integer" }, "loanNumber": { "description": "Loan number assigned to the loan. This is also the unique identifier of the loan\r\nin the source system", "type": "string" }, "paymentType": { "description": "This is the method with which the loan's payments are calculated (fixed payment, line of credit, etc.)", "enum": [ "fixedPayment", "fixedPrincipal", "lineOfCredit", "revolvingLineOfCredit", "interestOnly", "fixedPaymentBalloon", "fixedPrincipalBalloon", "singlePaymentBalloon", "principalOnly", "other", "noPayment" ], "type": "string", "x-nullable": true }, "riskRating": { "format": "int32", "description": "This is the bank's calculated risk rating for the loan", "type": "integer", "x-nullable": true }, "watchList": { "description": "Indicates whether or not the loan has been added to the watch list (true) or not (false)", "type": "boolean" } }, "additionalProperties": false }, "PortfolioLoanTakedownDetailResponse": { "description": "Detailed response after a takedown loan was created", "type": "object", "properties": { "loanAmount": { "format": "double", "description": "The amount of the takedown loan", "type": "number" }, "loanName": { "description": "The name of the takedown loan", "type": "string" }, "loanPaymentType": { "description": "The payment type of the takedown loan", "type": "string" }, "proposedLoanId": { "format": "int32", "description": "The id of the proposed loan from the takedown in Sageworks", "type": "integer" } }, "additionalProperties": false }, "PortfolioLoanTakedownRequest": { "description": "Information required to create a takedown of a portfolio loan", "type": "object", "properties": { "loanAmount": { "format": "double", "description": "The amount of the takedown loan", "type": "number" }, "loanName": { "description": "A descriptor that will help identify the takedown loan", "type": "string" }, "loanPaymentType": { "format": "string", "description": "The type of payment for the takedown loan (ex: fixed payment, interest only, line of credit, etc.)", "enum": [ "fixedPayment", "fixedPrincipal", "lineOfCredit", "revolvingLineOfCredit", "interestOnly", "fixedPaymentBalloon", "fixedPrincipalBalloon", "singlePaymentBalloon", "principalOnly", "other", "noPayment" ], "type": "string" } }, "additionalProperties": false }, "PortfolioLoanTakedownResponse": { "description": "Response after a takedown loan was created", "type": "object", "properties": { "proposedLoanId": { "format": "int32", "description": "The id of the proposed loan from the takedown in Sageworks", "type": "integer" } }, "additionalProperties": false }, "PrelimBeneficialOwnerCustomer": { "type": "object", "properties": { "customerId": { "format": "int32", "description": "The ID of the customer that is being owned or certified.", "type": "integer" }, "email": { "description": "Email of Customer to create", "type": "string" }, "firstName": { "description": "First Name of Customer to create", "type": "string" }, "lastName": { "description": "Last Name of Customer to create", "type": "string" }, "ownershipPercent": { "format": "double", "description": "If a beneficial owner, what percent of the business is owned by them.", "type": "number" }, "role": { "format": "string", "description": "Selected person is a beneficial owner (owns 25% or more of the business), a control person, or a certifier.", "enum": [ "beneficialOwner", "controlPerson", "beneficialOwnerControlPerson", "certifier", "beneficialOwnerControlPersonCertifier", "beneficialOwnerCertifier", "controlPersonCertifier" ], "type": "string" } }, "additionalProperties": false }, "PrelimDepositAppPipelineDataBusiness": { "description": "Prelim Deposit App Pipeline Data for a Person within Sageworks", "type": "object", "properties": { "address": { "$ref": "#/definitions/Address" }, "applicationCategory": { "description": "Category of application (i.e.e business)", "type": "string" }, "businessName": { "description": "Business Name", "type": "string" }, "country": { "description": "Country the business is located", "type": "string" }, "customerId": { "format": "int64", "description": "CustomerId if exists", "type": "integer", "x-nullable": true }, "dba": { "description": "Doing business as", "type": "string" }, "description": { "description": "Description of the business", "type": "string" }, "id": { "format": "int32", "type": "integer" }, "industryCode": { "description": "Industry Code", "type": "string" }, "isMailingAddressDifferent": { "description": "Is the business mailing address different than address", "type": "boolean" }, "mailingAddress": { "$ref": "#/definitions/Address" }, "organizationType": { "description": "Organization Type of the business", "type": "string" }, "phone": { "description": "Phone number of the business", "type": "string" }, "prelimApplicationId": { "description": "Prelim Application ID", "type": "string" }, "prelimDepositAppPipelineDataStatus": { "format": "string", "description": "Status of application", "enum": [ "inProgress", "completed" ], "type": "string" }, "product": { "description": "Product", "type": "string" }, "taxId": { "description": "TaxId of Business", "type": "string" }, "website": { "description": "Website of the business", "type": "string" } }, "additionalProperties": false }, "PrelimDepositAppPipelineDataPerson": { "description": "Prelim Deposit App Pipeline Data for a Person within Sageworks", "type": "object", "properties": { "address": { "$ref": "#/definitions/Address" }, "applicationCategory": { "description": "Category of application (i.e.e business)", "type": "string" }, "citizenshipStatus": { "description": "Citizenship Status of the customer", "enum": [ "usCitizen", "residentAlien", "nonResidentAlien" ], "type": "string", "x-nullable": true }, "customerId": { "format": "int64", "description": "CustomerId if exists", "type": "integer", "x-nullable": true }, "email": { "description": "Email of Borrower", "type": "string" }, "firstName": { "description": "First Name of Borrower", "type": "string" }, "id": { "format": "int32", "description": "Id of the row", "type": "integer" }, "idDescription": { "description": "Description for the type of identification presented to the financial institution, such as a state issued driver's license or a passport", "type": "string" }, "idExpirationDate": { "format": "Date", "description": "This is the expiration date of the customer's identification", "type": "string", "x-nullable": true }, "idIssueDate": { "format": "Date", "description": "This is the date on which the authoritative entity issued the customer's identification", "type": "string", "x-nullable": true }, "idIssuingAuthority": { "description": "This is the name or a description of the authoritative entity who has issued the customer's identification", "type": "string" }, "idNumber": { "description": "This is the description of unique information(such as mothers' maiden name or high school mascot) provided to the financial institution by the customer", "type": "string" }, "lastName": { "description": "Last Name of Borrower", "type": "string" }, "prelimApplicationId": { "description": "Prelim Application ID", "type": "string" }, "prelimDepositAppPipelineDataStatus": { "format": "string", "description": "Status of application", "enum": [ "inProgress", "completed" ], "type": "string" }, "product": { "description": "Product", "type": "string" }, "ssn": { "description": "Ssn of Borrower", "type": "string" } }, "additionalProperties": false }, "PrelimDepositAppPipelineDataUpdateRequest": { "description": "Patch request model for PrelimDepositAppPipelineData", "type": "object", "properties": { "applicationCategory": { "description": "Category of application (i.e.e business)", "type": "string" }, "id": { "format": "int32", "description": "Id of the row", "type": "integer" }, "prelimApplicationId": { "description": "Prelim Application ID", "type": "string" }, "prelimDepositAppPipelineDataStatus": { "description": "Status of application", "enum": [ "inProgress", "completed" ], "type": "string", "x-nullable": true }, "product": { "description": "Product", "type": "string" } }, "additionalProperties": false }, "ProposedBankLoanBusinessSbaFinancialData": { "type": "object", "properties": { "balanceSbaSourceVerificationOfFinancialSheetType": { "enum": [ "auditedFinancialStatement", "reviewedFinancialStatement", "compiledFinancialStatement", "incomeTaxRecords", "generatedByBorrower", "generatedByLender", "generatedByLoanPackager", "generatedByThirdParty" ], "type": "string", "x-nullable": true }, "customersID": { "format": "int64", "type": "integer" }, "id": { "format": "int64", "type": "integer" }, "incomeSbaSourceVerificationOfFinancialSheetType": { "enum": [ "auditedFinancialStatement", "reviewedFinancialStatement", "compiledFinancialStatement", "incomeTaxRecords", "generatedByBorrower", "generatedByLender", "generatedByLoanPackager", "generatedByThirdParty" ], "type": "string", "x-nullable": true }, "profitEntitiesID": { "format": "int64", "type": "integer" }, "profitInputDataID": { "format": "int64", "type": "integer", "x-nullable": true }, "proposedBankLoansID": { "format": "int64", "type": "integer" } }, "additionalProperties": false }, "ProposedBankLoanBusinessSbaFinancialDto": { "type": "object", "properties": { "balanceSbaSourceVerificationOfFinancialSheetType": { "enum": [ "auditedFinancialStatement", "reviewedFinancialStatement", "compiledFinancialStatement", "incomeTaxRecords", "generatedByBorrower", "generatedByLender", "generatedByLoanPackager", "generatedByThirdParty" ], "type": "string", "x-nullable": true }, "businessFinancialData": { "$ref": "#/definitions/SbaBusinessFinancialData" }, "incomeSbaSourceVerificationOfFinancialSheetType": { "enum": [ "auditedFinancialStatement", "reviewedFinancialStatement", "compiledFinancialStatement", "incomeTaxRecords", "generatedByBorrower", "generatedByLender", "generatedByLoanPackager", "generatedByThirdParty" ], "type": "string", "x-nullable": true }, "inputDataID": { "format": "int64", "type": "integer", "x-nullable": true }, "profitEntitiesID": { "format": "int64", "type": "integer" }, "proposedBankLoansID": { "format": "int64", "type": "integer" } }, "additionalProperties": false }, "ProposedBankLoanDecisionReason": { "type": "object", "properties": { "customersID": { "format": "int64", "type": "integer" }, "description": { "type": "string" }, "id": { "format": "int64", "type": "integer" }, "isActive": { "type": "boolean" }, "isDefault": { "type": "boolean" }, "proposedLoanDecisionReasonType": { "format": "string", "enum": [ "denial", "withdrawal" ], "type": "string" }, "show": { "type": "boolean" } }, "additionalProperties": false }, "ProposedBankLoanPersonalSbaFinancialData": { "type": "object", "properties": { "annualSalaryFromBusiness": { "format": "double", "type": "number", "x-nullable": true }, "customersID": { "format": "int64", "type": "integer" }, "id": { "format": "int64", "type": "integer" }, "otherIncome": { "format": "double", "type": "number", "x-nullable": true }, "personalInputDataID": { "format": "int64", "type": "integer", "x-nullable": true }, "profitEntitiesID": { "format": "int64", "type": "integer" }, "proposedBankLoansID": { "format": "int64", "type": "integer" }, "sourceOfOtherIncome": { "type": "string" } }, "additionalProperties": false }, "ProposedBankLoanPersonalSbaFinancialDto": { "type": "object", "properties": { "annualSalaryFromBusiness": { "format": "double", "type": "number", "x-nullable": true }, "inputDataID": { "format": "int64", "type": "integer", "x-nullable": true }, "otherIncome": { "format": "double", "type": "number", "x-nullable": true }, "personalFinancialData": { "$ref": "#/definitions/SbaPersonalFinancialData" }, "profitEntitiesID": { "format": "int64", "type": "integer" }, "proposedBankLoansID": { "format": "int64", "type": "integer" }, "sourceOfOtherIncome": { "type": "string" } }, "additionalProperties": false }, "ProposedDeposit": { "description": "A proposed deposit account (checking, savings, etc.) in Sageworks", "type": "object", "properties": { "accountNumber": { "description": "The account number of the deposit account", "type": "string" }, "annualFees": { "format": "double", "description": "The annual fees of the deposit account", "type": "number" }, "balance": { "format": "double", "description": "The current balance of the deposit account", "type": "number" }, "customerId": { "format": "int32", "description": "The ID of the customer that is the owner of this deposit account", "type": "integer" }, "id": { "format": "int32", "description": "The ID of the deposit account in Sageworks", "type": "integer" }, "interestRate": { "format": "float", "description": "The interest rate of the deposit account", "type": "number" }, "isDeleted": { "description": "Indicates if the deposit account has been deleted", "type": "boolean" }, "maturityDate": { "format": "Date", "description": "The date that the deposit account matures", "type": "string", "x-nullable": true }, "originationDate": { "format": "Date", "description": "The date that the deposit account was opened", "type": "string", "x-nullable": true }, "proposedDepositStageId": { "format": "int32", "description": "Deposit stage Id for the proposed deposit", "type": "integer", "x-nullable": true }, "type": { "description": "The type of deposit account (ex: Commercial DDA, Personal Savings, etc.)", "type": "string" }, "userDefinedFields": { "description": "User defined deposit fields", "type": "object", "additionalProperties": { "type": "string" } } }, "additionalProperties": false }, "ProposedDepositStage": { "description": "A proposed deposit stage in Sageworks", "type": "object", "properties": { "displayOrder": { "format": "int32", "description": "The logical order of this deposit stage vs other deposit stages", "type": "integer" }, "id": { "format": "int32", "description": "The id of the proposed deposit stage in Sageworks", "type": "integer" }, "isDeleted": { "description": "Indicates if this proposed deposit stage has been deleted", "type": "boolean" }, "name": { "description": "Name of the proposed deposit stage", "type": "string" } }, "additionalProperties": false }, "ProposedLien": { "description": "A Proposed Lien in Sageworks", "required": [ "collateralId" ], "type": "object", "properties": { "collateralId": { "format": "int64", "description": "id of the proposed collateral in Sageworks that the lien is associated with", "type": "integer" }, "id": { "format": "int32", "description": "The id of the lien in Sageworks", "type": "integer" }, "isDeleted": { "description": "Indicates if the proposed lien has been deleted", "type": "boolean" }, "lienAmount": { "format": "double", "description": "The amount of the proposed lien (if the proposed lien is with a different institution)", "type": "number", "x-nullable": true }, "lienHolder": { "description": "The lien holder for the proposed lien (if the proposed lien is with a different institution)", "type": "string" }, "lienPosition": { "format": "int32", "description": "The proposed lien position of this proposed loan for this proposed collateral", "type": "integer", "x-nullable": true }, "loanReferenceLoanId": { "format": "int64", "description": "id of the loan in Sageworks that the proposed lien is associated with. Not specified if the loan is with a different institution", "type": "integer", "x-nullable": true }, "loanReferenceType": { "description": "Loan Reference Type of the Loan. Not specified if the loan is with a different institution", "enum": [ "portfolio", "proposed" ], "type": "string", "x-nullable": true } }, "additionalProperties": false }, "ProposedLoan": { "description": "A loan to a customer of a financial institution", "required": [ "customerId", "loanName", "paymentType" ], "type": "object", "properties": { "accountType": { "description": "The level of the loan in the hierarchy. For example, these could be a facility, limit, loan.", "enum": [ "loan", "facility" ], "type": "string", "x-nullable": true }, "adjustableInterestRate": { "description": "Indiciates if the interest rate for the loan is adjustable", "type": "boolean" }, "amortizedOver": { "format": "int32", "description": "The term in which the loan payment is calculated", "type": "integer", "x-nullable": true }, "annualFee": { "format": "double", "description": "Annual fees associated with this loan", "type": "number" }, "balloonPayment": { "format": "double", "description": "This is final principal payment when the loan is due.", "type": "number", "x-nullable": true }, "bankCodeBranch": { "description": "The Branch Code corresponding to the Bank Code Branch for the proposed loan", "type": "string" }, "brokerCompensationPercent": { "format": "float", "description": "Broker Compensation Percent", "type": "number", "x-nullable": true }, "callCode": { "description": "Code taken from the Report of Condition Schedule RC-C", "type": "string" }, "cdChangeOfCircumstanceDate": { "format": "Date", "description": "CD Change of Circumstance Date for TRID compliance", "type": "string", "x-nullable": true }, "cdIssueDate": { "format": "Date", "description": "The Closing Disclosure (CD) issue date for mortgage compliance tracking", "type": "string", "x-nullable": true }, "cdReissueDate": { "format": "Date", "description": "The Closing Disclosure (CD) reissue date for mortgage compliance tracking", "type": "string", "x-nullable": true }, "cdRequiredDate": { "format": "Date", "description": "The Closing Disclosure (CD) required date for mortgage compliance tracking", "type": "string", "x-nullable": true }, "ceilingRate": { "format": "double", "description": "Maximum rate that can be charged for an adjustable rate loan", "type": "number" }, "classCode": { "description": "A code indicating the class of the loan", "type": "string" }, "closingCostExpirationDate": { "format": "date-time", "description": "The closing cost expiration date and time for TRID compliance tracking (includes time zone)", "type": "string", "x-nullable": true }, "collateralCode": { "description": "Code to identify the primary type of collateral associated with the loan", "type": "string" }, "comments": { "description": "Added Comments", "type": "string" }, "consummationDate": { "format": "Date", "description": "The consummation date for mortgage compliance tracking", "type": "string", "x-nullable": true }, "craLoanPurposeType": { "description": "CRA Loan Purpose", "enum": [ "affordableHousing", "lmiCommunityServices", "promoteEconomicDevelopment", "lmiRevitalizationStabilization", "lmiCommunityServicesPromoteEconomicDevelopment", "lmiRevitalizationStabilizationAffordableHousing", "lmiRevitalizationStabilizationCommunityServices", "lmiRevitalizationStabilizationEconomicDevelopment" ], "type": "string", "x-nullable": true }, "craLoanType": { "description": "CRA Loan Type", "enum": [ "smallBusiness", "smallFarm", "otherLinesOrLoansSmallBusiness", "homeEquity", "motorVehicle", "creditCard", "otherSecuredConsumerLoans", "otherUnsecuredConsumerLoans", "otherLoanData", "consortiumOrThirdParty", "communityDevelopment" ], "type": "string", "x-nullable": true }, "craRevenueCodeType": { "description": "Revenue Code", "enum": [ "lessThanOrEqualToOneMillion", "greaterThanOrEqualToOneMillion", "notKnown", "notApplicable" ], "type": "string", "x-nullable": true }, "createdDate": { "format": "Date", "description": "READ ONLY - The date that this proposed loan was created", "type": "string", "x-nullable": true }, "creditRating": { "description": "The Credit Rating for the loan", "type": "string" }, "crmIdentifier": { "description": "The CRM Identifier for the loan", "type": "string" }, "customerId": { "format": "int32", "description": "The id of the customer that is the primary borrower for the loan", "type": "integer" }, "dayCountConvention": { "description": "Amortization Days are used to calculate the interest and payment amount for the life of the loan.", "enum": [ "c_30_360", "c_30_365", "c_Actual_360", "c_Actual_365" ], "type": "string", "x-nullable": true }, "denialOrWithdrawalReason": { "description": "DEPRECATED - Withdrawal Reason (if status is 'Withdrawn' or 'Declined') - READ ONLY", "enum": [ "noCreditFile", "insufficientNumberOfCreditReferencesProvided", "limitedCreditExperience", "collectionActionOrJudgmentInCreditHistory", "garnishmentOrAttachmentInCreditHistory", "foreclosureOrRepossessionInCreditHistory", "delinquentCreditObligationsPastOrPresentWithOthers", "bankruptcy", "excessiveNumberOfRecentInquiriesOnCreditBureauReport", "unacceptableTypeOfCreditReferences", "poorCreditPerformanceWithUs", "temporaryOrIrregularEmployment", "insufficientLengthOfEmployment", "insufficientIncomeForAmountOfCreditRequested", "excessiveCreditObligationsInRelationToIncome", "temporaryResidence", "insufficientLengthOfResidence", "unableToVerifyCreditReferences", "unableToVerifyEmployment", "unableToVerifyIncome", "unableToVerifyResidence", "valueOrTypeOfCollateralInsufficient", "unacceptableAppraisalValue", "unacceptableLeaseholdEstate", "weDoNotGrantCreditToAnyApplicantOnTheTermsAndConditionsYouHaveRequested", "insufficientNumberOfPointsForApproval", "slowOrPastDueInTradeOrLoanPayments", "loanTypeIsListedAsUndesirableUnderFinancialInstitutionsLoanPolicy", "currentEconomicConditionsDoNotWarrantGrantingTheRequest", "businessSalesAndOrEarningsReflectADownwardTrend", "inadequateCapitalOrAssets", "cashFlowInsufficientToServiceExistingAndOrNewDebt", "amountRequestedIsInExcessOfFinancialInstitutionsLendingLimit", "creditInformationObtainedFromAThirdPartiesIsUnsatisfactory", "unacceptableCollateralCondition", "inadequateBusinessSalesAndOrEarningsHistory", "lackOfEstablishedEarningsRecord", "loanProceedsToBeUsedOutsideOfFinancialInstitutionsPrimaryAndSecondaryMarketArea", "loanTermIsInExcessOfFinancialInstitutionsPolicyForLoansOfThisType", "unacceptableCollateralLocation", "unacceptableCollateralLienPosition", "locationOrConditionOfCollateral", "other" ], "type": "string", "x-nullable": true }, "denialOrWithdrawalReasons": { "description": "The selected reasons if the status is 'Withdrawn' or 'Declined'", "type": "array", "items": { "type": "string" } }, "disbursementDate": { "format": "Date", "description": "First payment date of the proposed loan", "type": "string", "x-nullable": true }, "discountPointsDollarAmount": { "format": "double", "description": "Discount Points Dollar Amount", "type": "number", "x-nullable": true }, "earliestTridCloseDate": { "format": "Date", "description": "The earliest TRID closing date for mortgage compliance tracking", "type": "string", "x-nullable": true }, "ecoaAdverseAction1": { "description": "ECOA Adverse Action 1", "type": "string" }, "ecoaAdverseAction2": { "description": "ECOA Adverse Action 2", "type": "string" }, "ecoaAdverseAction3": { "description": "ECOA Adverse Action 3", "type": "string" }, "evaluatedCreditScore": { "format": "int32", "description": "The credit score evaluated using the settings defined for the assigned proposed product", "type": "integer", "x-nullable": true }, "expectedUtilizationRate": { "format": "double", "description": "Percentage of the Line of Credit the borrower is expected to use", "type": "number" }, "firstInterestPaymentDate": { "format": "Date", "description": "First Interest Payment Date", "type": "string", "x-nullable": true }, "firstPaymentDate": { "format": "Date", "description": "First Payment Date", "type": "string", "x-nullable": true }, "floorRate": { "format": "double", "description": "An agreed upon rate in the lower range of rates associated with a floating rate loan", "type": "number" }, "fundingDate": { "format": "Date", "description": "The date when loan funds were disbursed to the borrower", "type": "string", "x-nullable": true }, "glCostCenter": { "description": "The GL Cost Center for the loan", "type": "string" }, "hasSecondaryRate": { "description": "The loan has a secondary rate", "type": "boolean" }, "hmdaAmortizationType": { "description": "Amortization Type", "enum": [ "adjustableRateLoan", "convertibleArm", "hybridArm", "payOptionArm", "twoStepArm", "fixedRateLoan", "fixedRatewithBalloonPayment", "graduatedPaymentLoan", "heloc", "reverseMortgage", "hecmStandard", "hecmSaver" ], "type": "string", "x-nullable": true }, "hmdaFinalActionTakenType": { "description": "HMDA Final Action Type", "enum": [ "loanOriginated", "applicationApprovedButNotAccepted", "applicationDeniedByFinancialInstitution", "applicationWithdrawnByApplicant", "fileClosedForIncompleteness", "loanPurchasedByFinancialInstitution", "preapprovalRequestDeniedByFinancialInstitution", "preapprovalRequestApprovedButNotAccepted", "inProcess" ], "type": "string", "x-nullable": true }, "hmdaHoepaStatusType": { "description": "HOEPA Status", "enum": [ "highCostMortgage", "notAHighCostMortgage", "notApplicable" ], "type": "string", "x-nullable": true }, "hmdaLoanPurposeType": { "description": "HMDA Loan Purpose", "enum": [ "homePurchase", "homeImprovement", "other", "notApplicable", "refinancing", "cashoutRefinancing" ], "type": "string", "x-nullable": true }, "hmdaLoanType": { "description": "HMDA Loan Type", "enum": [ "conventional", "fhaInsured", "vaGuaranteed", "fsaOrRhs" ], "type": "string", "x-nullable": true }, "hmdaPurchaserType": { "description": "Type of Purchaser", "enum": [ "notApplicable", "fannieMae", "ginnieMae", "freddieMac", "farmerMac", "privateSecuritization", "commercialBankSavingsBankOrSavingsAssociation", "affiliateInstitution", "otherTypeOfPurchaser", "creditUnionMortgageBankOrFinanceCompany", "lifeInsuranceCompany" ], "type": "string", "x-nullable": true }, "id": { "format": "int32", "description": "The id of the loan in Sageworks", "type": "integer" }, "includeNegativeAmortization": { "description": "Negative Amortization", "type": "boolean", "x-nullable": true }, "includeOtherNonAmortizingFeatures": { "description": "Other Non-amortizing Features", "type": "boolean", "x-nullable": true }, "indexRate": { "format": "double", "description": "Floating rate peg rate", "type": "number" }, "indexRateDescription": { "description": "Floating rate that this loan is pegged to", "type": "string" }, "industryCode": { "description": "Industry code (NAICS) associated with the business if the borrower for this loan is a business", "type": "string" }, "institutionAvailableCredit": { "format": "double", "description": "Current amount of available credit on the loan (specific to this institution)", "type": "number", "x-nullable": true }, "institutionWithheld": { "format": "double", "description": "The amount of the loan that is not available to the borrower to draw (specific to this institution)", "type": "number", "x-nullable": true }, "intentToProceedDate": { "format": "Date", "description": "The Intent to Proceed date for TRID compliance tracking", "type": "string", "x-nullable": true }, "interestOnlyPaymentFrequency": { "description": "Interest Only Payment Frequency", "enum": [ "annual", "semiannual", "quarterly", "bimonthly", "monthly", "semimonthly", "biweekly", "weekly" ], "type": "string", "x-nullable": true }, "interestOnlyTerm": { "format": "int32", "description": "Interest Only Term", "type": "integer", "x-nullable": true }, "interestRate": { "format": "double", "description": "Interest rate for the loan", "type": "number" }, "introductionRatePeriodInMonths": { "format": "int32", "description": "Introductory Rate Period", "type": "integer", "x-nullable": true }, "isDeleted": { "description": "Indicates if the loan has been deleted", "type": "boolean" }, "isGuidanceLineOfCredit": { "description": "Whether the loan is a guidance line of credit", "type": "boolean", "x-nullable": true }, "isPreapprovalRequested": { "description": "Preapproval Request", "type": "boolean", "x-nullable": true }, "isReverseMortgage": { "description": "Reverse Mortgage", "type": "boolean", "x-nullable": true }, "isSubjectToRegO": { "description": "Whether the loan is subject to Reg O", "type": "boolean", "x-nullable": true }, "isTakedownLoan": { "description": "Whether the loan is a Takedown loan - READ ONLY", "type": "boolean", "x-nullable": true }, "leChangeOfCircumstanceDate": { "format": "Date", "description": "LE Change of Circumstance Date - Tracks when qualifying TRID fees change", "type": "string", "x-nullable": true }, "leIssueDate": { "format": "Date", "description": "The Loan Estimate (LE) issue date for mortgage compliance tracking", "type": "string", "x-nullable": true }, "lenderCredits": { "format": "double", "description": "Lender Credits", "type": "number", "x-nullable": true }, "leReissueDate": { "format": "Date", "description": "The Loan Estimate (LE) reissue date - tracks when a revised Loan Estimate was provided to the borrower", "type": "string", "x-nullable": true }, "leRequiredDate": { "format": "Date", "description": "The Loan Estimate (LE) required date for mortgage compliance tracking", "type": "string", "x-nullable": true }, "loanAmount": { "format": "double", "description": "This is the amount of the proposed loan", "type": "number" }, "loanBoardingIdentifier": { "description": "The Loan Boarding Identifier for the loan", "type": "string" }, "loanId": { "format": "int32", "description": "The id of the portfolio loan that this proposed loan is associated with (if applicable)", "type": "integer", "x-nullable": true }, "loanName": { "description": "A descriptor that will help identify the loan", "minLength": 1, "type": "string" }, "loanOfficerId": { "format": "int32", "description": "id of the loan officer for this loan", "type": "integer", "x-nullable": true }, "loanTerm": { "format": "int32", "description": "Total number of payments for the loan", "type": "integer" }, "loanTypeCode": { "description": "A code to represent the primary type of the loan (ex: CRE, C/I, etc.)", "type": "string" }, "loanTypeForDenialOrWithdrawal": { "enum": [ "directInstallment", "indirectInstallment", "lineOfCredit", "creditCard", "mortgageLoan", "termLoan", "singlePayment", "letterOfCredit", "loanRenewal", "loanModification", "other" ], "type": "string", "x-nullable": true }, "lossGivenDefaultRiskRating": { "description": "The Loss Given Default Risk Rating on this loan", "type": "string" }, "maturityDate": { "format": "Date", "description": "Maturity date of the proposed loan", "type": "string", "x-nullable": true }, "mortgageRateLockDate": { "format": "date-time", "description": "The Mortgage Rate Lock Date and time when the interest rate was locked for the loan (includes time zone)", "type": "string", "x-nullable": true }, "noteDate": { "format": "Date", "description": "Note date of the proposed loan", "type": "string", "x-nullable": true }, "originationExpenses": { "format": "double", "description": "Origination fees associated with this loan", "type": "number" }, "originationFee": { "description": "The Origination Fee for the loan", "type": "string" }, "otherFees": { "format": "double", "description": "Other fees associated with this loan", "type": "number", "x-nullable": true }, "overheadExpenses": { "format": "double", "description": "Overhead fees associated with this loan", "type": "number" }, "parentIsProposed": { "description": "Flag indicating whether or not the parent loan is a proposed loan", "type": "boolean", "x-nullable": true }, "parentLoansId": { "format": "int64", "description": "The ID of the parent loan in Sageworks", "type": "integer", "x-nullable": true }, "participatedAmount": { "format": "double", "description": "The amount of the loan that is being participated/sold to other financial institutions or lenders.", "type": "number", "x-nullable": true }, "participationType": { "format": "string", "description": "This specifies the type of participation relationship for this loan. Indicate N/A if not part of a participation. Otherwise state whether this institution is the lead institution for this loan or whether they are a participant.", "enum": [ "na", "lead", "participant" ], "type": "string" }, "paymentAmount": { "format": "double", "description": "The payment amount for the loan. For fixed principal and fixed payment loans, this will include principal and interest. For lines of credit, this will include interest only.", "type": "number" }, "paymentFrequency": { "description": "The frequency of the payments for the loan (ex: weekly, monthly, annual, etc.)", "enum": [ "annual", "semiannual", "quarterly", "bimonthly", "monthly", "semimonthly", "biweekly", "weekly" ], "type": "string", "x-nullable": true }, "paymentType": { "description": "The type of payment for the loan (ex: fixed payment, interest only, line of credit, etc.)", "enum": [ "fixedPayment", "fixedPrincipal", "lineOfCredit", "revolvingLineOfCredit", "interestOnly", "fixedPaymentBalloon", "fixedPrincipalBalloon", "singlePaymentBalloon", "principalOnly", "other", "noPayment" ], "type": "string", "x-nullable": true }, "pointsAndFees": { "format": "double", "description": "Points and Fees", "type": "number", "x-nullable": true }, "prepaymentPenaltyCode": { "description": "The Prepayment Penalty Code for the loan", "type": "string" }, "probabilityOfClosing": { "format": "double", "description": "Probability of the loan closing", "type": "number", "x-nullable": true }, "probabilityOfDefaultRiskRating": { "format": "double", "description": "The Probability of Default Risk Rating on this loan", "type": "number", "x-nullable": true }, "productCode": { "description": "Code for the product that is associated with the loan", "type": "string" }, "projectedClosingDate": { "format": "Date", "description": "Projected closing date of the proposed loan", "type": "string", "x-nullable": true }, "proposedLoanStageId": { "format": "int32", "description": "Loan stage Id for the proposed loan", "type": "integer", "x-nullable": true }, "proposedProductsId": { "format": "int64", "description": "Proposed Product Id for the proposed loan", "type": "integer", "x-nullable": true }, "purpose": { "description": "The Purpose of the loan", "type": "string" }, "purposeCode": { "description": "A code indicating the purpose of the loan", "type": "string" }, "rateLockDate": { "format": "Date", "description": "Rate Lock Date", "type": "string", "x-nullable": true }, "rateLockExpirationDate": { "format": "date-time", "description": "The rate lock expiration date and time for mortgage lending (includes time zone)", "type": "string", "x-nullable": true }, "repriceFrequencyInterval": { "format": "int32", "description": "The Loan Reprice Frequency Interval", "type": "integer", "x-nullable": true }, "repriceFrequencyUnits": { "description": "The Loan Reprice Frequency Units", "enum": [ "annual", "semiAnnual", "quarterly", "bimonthly", "monthly", "semiMonthly", "biweekly", "weekly", "daily" ], "type": "string", "x-nullable": true }, "repricingDate": { "format": "Date", "description": "The repricing date of the loan", "type": "string", "x-nullable": true }, "requestType": { "description": "The Request Type, such as New Loan, Renewal, Refinance, Modification. Options are customizable in Sageworks", "type": "string" }, "rescissionDate": { "format": "Date", "description": "Rescission Date for TRID right of rescission compliance", "type": "string", "x-nullable": true }, "riskRating": { "format": "int32", "description": "Risk rating of the loan (typically a number between 1 and 10)", "type": "integer" }, "riskRatingId": { "format": "int64", "description": "The Id of the Risk Rating Calculation for the loan. This field is READ ONLY.", "type": "integer", "x-nullable": true }, "secondaryAdjustableInterestRate": { "description": "The Loan Secondary Adjustment Interest Rate", "type": "boolean", "x-nullable": true }, "secondaryCeilingRate": { "format": "double", "description": "The Loan Secondary Ceiling Rate", "type": "number", "x-nullable": true }, "secondaryFloorRate": { "format": "double", "description": "The Loan Secondary Floor Rate", "type": "number", "x-nullable": true }, "secondaryIndexRate": { "format": "double", "description": "The Loan Secondary Index Rate", "type": "number", "x-nullable": true }, "secondaryIndexRateDescription": { "description": "The Loan Secondary Index Rate Description", "type": "string" }, "secondaryInterestRate": { "format": "double", "description": "The Loan Secondary Interest Rate", "type": "number", "x-nullable": true }, "secondaryRepriceFrequencyInterval": { "format": "int32", "description": "The Loan Secondary Reprice Frequency Interval", "type": "integer", "x-nullable": true }, "secondaryRepriceFrequencyUnits": { "description": "The Loan Secondary Reprice Frequency Units", "enum": [ "annual", "semiAnnual", "quarterly", "bimonthly", "monthly", "semiMonthly", "biweekly", "weekly", "daily" ], "type": "string", "x-nullable": true }, "secondarySpread": { "format": "double", "description": "The Loan Secondary Spread", "type": "number", "x-nullable": true }, "secondaryTypeOfPaymentAdjustment": { "format": "string", "description": "The Loan Secondary Payment Adjustment Type", "enum": [ "higherInstallmentAmount", "changeInFinalPayment" ], "type": "string" }, "servicingExpenses": { "format": "double", "description": "Servicing fees associated with this loan", "type": "number" }, "spread": { "format": "double", "description": "Difference between two different rates", "type": "number" }, "status": { "description": "The status of the proposed loan", "enum": [ "approved", "withdrawn", "declined", "associated" ], "type": "string", "x-nullable": true }, "statusChangedByUsersID": { "format": "int64", "description": "User that last changed the status - read only", "type": "integer", "x-nullable": true }, "statusLastUpdatedDate": { "format": "Date", "description": "READ ONLY - The date that the status was last updated for this proposed loan", "type": "string", "x-nullable": true }, "statusReason": { "description": "Reason for the Declined/Withdrawn status - READ ONLY", "type": "string" }, "termBeforeSecondaryRate": { "format": "int32", "description": "The Loan Term Before Secondary Rate", "type": "integer", "x-nullable": true }, "totalFees": { "format": "double", "description": "Fees associated with this loan", "type": "number", "x-nullable": true }, "tridApplicationDate": { "format": "Date", "description": "The TRID application date for mortgage compliance tracking", "type": "string", "x-nullable": true }, "unusedCommitmentFee": { "format": "double", "description": "Unused commitment fee associated with this loan", "type": "number" }, "upfrontFee": { "format": "double", "description": "Any upfront fees associated with the loan", "type": "number" }, "userDefinedDate1": { "format": "Date", "description": "User Defined Date 1", "type": "string", "x-nullable": true }, "userDefinedDate10": { "format": "Date", "description": "User Defined Date 10", "type": "string", "x-nullable": true }, "userDefinedDate2": { "format": "Date", "description": "User Defined Date 2", "type": "string", "x-nullable": true }, "userDefinedDate3": { "format": "Date", "description": "User Defined Date 3", "type": "string", "x-nullable": true }, "userDefinedDate4": { "format": "Date", "description": "User Defined Date 4", "type": "string", "x-nullable": true }, "userDefinedDate5": { "format": "Date", "description": "User Defined Date 5", "type": "string", "x-nullable": true }, "userDefinedDate6": { "format": "Date", "description": "User Defined Date 6", "type": "string", "x-nullable": true }, "userDefinedDate7": { "format": "Date", "description": "User Defined Date 7", "type": "string", "x-nullable": true }, "userDefinedDate8": { "format": "Date", "description": "User Defined Date 8", "type": "string", "x-nullable": true }, "userDefinedDate9": { "format": "Date", "description": "User Defined Date 9", "type": "string", "x-nullable": true }, "userDefinedFields": { "description": "User-defined fields for the proposed loan", "type": "object", "additionalProperties": { "type": "string" } }, "userDefinedNumber1": { "format": "double", "description": "User Defined Number 1", "type": "number", "x-nullable": true }, "userDefinedNumber10": { "format": "double", "description": "User Defined Number 10", "type": "number", "x-nullable": true }, "userDefinedNumber11": { "format": "double", "description": "User Defined Number 11", "type": "number", "x-nullable": true }, "userDefinedNumber12": { "format": "double", "description": "User Defined Number 12", "type": "number", "x-nullable": true }, "userDefinedNumber13": { "format": "double", "description": "User Defined Number 13", "type": "number", "x-nullable": true }, "userDefinedNumber14": { "format": "double", "description": "User Defined Number 14", "type": "number", "x-nullable": true }, "userDefinedNumber15": { "format": "double", "description": "User Defined Number 15", "type": "number", "x-nullable": true }, "userDefinedNumber16": { "format": "double", "description": "User Defined Number 16", "type": "number", "x-nullable": true }, "userDefinedNumber17": { "format": "double", "description": "User Defined Number 17", "type": "number", "x-nullable": true }, "userDefinedNumber18": { "format": "double", "description": "User Defined Number 18", "type": "number", "x-nullable": true }, "userDefinedNumber19": { "format": "double", "description": "User Defined Number 19", "type": "number", "x-nullable": true }, "userDefinedNumber2": { "format": "double", "description": "User Defined Number 2", "type": "number", "x-nullable": true }, "userDefinedNumber20": { "format": "double", "description": "User Defined Number 20", "type": "number", "x-nullable": true }, "userDefinedNumber3": { "format": "double", "description": "User Defined Number 3", "type": "number", "x-nullable": true }, "userDefinedNumber4": { "format": "double", "description": "User Defined Number 4", "type": "number", "x-nullable": true }, "userDefinedNumber5": { "format": "double", "description": "User Defined Number 5", "type": "number", "x-nullable": true }, "userDefinedNumber6": { "format": "double", "description": "User Defined Number 6", "type": "number", "x-nullable": true }, "userDefinedNumber7": { "format": "double", "description": "User Defined Number 7", "type": "number", "x-nullable": true }, "userDefinedNumber8": { "format": "double", "description": "User Defined Number 8", "type": "number", "x-nullable": true }, "userDefinedNumber9": { "format": "double", "description": "User Defined Number 9", "type": "number", "x-nullable": true }, "userDefinedString1": { "description": "User Defined String 1", "type": "string" }, "userDefinedString10": { "description": "User Defined String 10", "type": "string" }, "userDefinedString11": { "description": "User Defined String 11", "type": "string" }, "userDefinedString12": { "description": "User Defined String 12", "type": "string" }, "userDefinedString13": { "description": "User Defined String 13", "type": "string" }, "userDefinedString14": { "description": "User Defined String 14", "type": "string" }, "userDefinedString15": { "description": "User Defined String 15", "type": "string" }, "userDefinedString16": { "description": "User Defined String 16", "type": "string" }, "userDefinedString17": { "description": "User Defined String 17", "type": "string" }, "userDefinedString18": { "description": "User Defined String 18", "type": "string" }, "userDefinedString19": { "description": "User Defined String 19", "type": "string" }, "userDefinedString2": { "description": "User Defined String 2", "type": "string" }, "userDefinedString20": { "description": "User Defined String 20", "type": "string" }, "userDefinedString3": { "description": "User Defined String 3", "type": "string" }, "userDefinedString4": { "description": "User Defined String 4", "type": "string" }, "userDefinedString5": { "description": "User Defined String 5", "type": "string" }, "userDefinedString6": { "description": "User Defined String 6", "type": "string" }, "userDefinedString7": { "description": "User Defined String 7", "type": "string" }, "userDefinedString8": { "description": "User Defined String 8", "type": "string" }, "userDefinedString9": { "description": "User Defined String 9", "type": "string" }, "withheldAmount": { "format": "double", "description": "The amount of the loan that is not available to the borrower to draw", "type": "number", "x-nullable": true } }, "additionalProperties": false }, "ProposedLoanAssociationRequest": { "description": "Information required to associate a Proposed Loan with a Portfolio Loan", "type": "object", "properties": { "collateralMappings": { "description": "Collection of Collateral Mappings to be used when CopyCollateral is set to true", "type": "array", "items": { "$ref": "#/definitions/LoanAssociationCollateralMapping" } }, "copyCollateral": { "description": "If set to true and this proposed loan was a proposed lien on any proposed collateral, we will copy any collateral information fields from the proposed collateral to existing collateral. This action will also set the associated existing loan as a lien for the existing collateral, and documents will be moved from the proposed collateral to the existing collateral. Since all of the information will be transferred, the proposed collateral will then be deleted so as to not be double counted in LTV calculations.", "type": "boolean" }, "copyLoanInformation": { "description": "Whether the value of each field on the proposed loan will be copied to the corresponding field on the existing loan. Any data already entered for the existing loan, including fields that are complete from core integration, will not be overwritten.", "type": "boolean" }, "copyPolicyExceptions": { "description": "If set to true, policy exceptions related to the proposed loan will be copied to the existing loan.", "type": "boolean" }, "moveCovenants": { "description": "If set to true, transfer covenants associated to this proposed loan to the existing loan", "type": "boolean" }, "moveDocuments": { "description": "Whether documents related to the proposed loan will now be related to the existing loan.", "type": "boolean" }, "moveNarratives": { "description": "If set to true, any narrative entries related to the proposed loan will be moved to the associated with the existing loan.", "type": "boolean" }, "moveRiskRatings": { "description": "If set to true, move risk ratings associated to the proposed loan to the existing loan", "type": "boolean" }, "moveTicklers": { "description": "If set to true, any ticklers related to the proposed loan will be moved to the existing loan.", "type": "boolean" }, "portfolioLoanId": { "format": "int32", "description": "Id of the Portfolio Loan that should be associated with the Proposed Loan", "type": "integer" }, "proposedLoanId": { "format": "int32", "description": "Id of the Proposed Loan that should be associated with the Portfolio Loan", "type": "integer" } }, "additionalProperties": false }, "ProposedLoanBasicInformation": { "description": "A proposed loan with just the basic information", "type": "object", "properties": { "customerId": { "format": "int32", "description": "The id of the customer that is the primary borrower for the proposed loan", "type": "integer" }, "id": { "format": "int32", "description": "The id of the proposed loan in Sageworks", "type": "integer" }, "loanAmount": { "format": "double", "description": "This is the amount of the proposed loan", "type": "number" }, "loanName": { "description": "A descriptor that will help identify the loan", "type": "string" } }, "additionalProperties": false }, "ProposedLoanExposure": { "description": "Loan Exposure information for Proposed Loans", "type": "object", "properties": { "currentAvailableCredit": { "format": "double", "description": "This field indicates the amount of credit that has been approved, but has not yet been used.", "type": "number" }, "currentOutstandingBalance": { "format": "double", "description": "The amount of the loan that still needs to be paid.", "type": "number" }, "customerId": { "format": "int32", "description": "The id of the customer that is the primary borrower for the loan", "type": "integer" }, "totalCommitment": { "format": "double", "description": "This is the sum of the Current Outstanding Balance and the Current Available Credit.", "type": "number" }, "totalRelatedCommitment": { "format": "double", "description": "This is the sum of the Total Commitment and the amount liable from all related loans. Related loans are portfolio loans where the customer is a co-borrower or guarantor. The amount liable is calculated by multiplying the loan's total commitment with the guarantor or co-borrower percentage.", "type": "number" } }, "additionalProperties": false }, "ProposedLoanFile": { "description": "Represents a Proposed Loan File", "type": "object", "properties": { "collaterals": { "description": "Collaterals for the loan", "type": "array", "items": { "$ref": "#/definitions/Collateral" } }, "customers": { "description": "Customers on the loan", "type": "array", "items": { "$ref": "#/definitions/ProposedLoanFileCustomer" } }, "proposedLoan": { "$ref": "#/definitions/ProposedLoan" } }, "additionalProperties": false }, "ProposedLoanFileCustomer": { "description": "Represents a Customer on a Proposed Loan", "type": "object", "properties": { "customer": { "$ref": "#/definitions/Customer" }, "loanRole": { "$ref": "#/definitions/LoanRole" }, "roles": { "$ref": "#/definitions/Roles" } }, "additionalProperties": false }, "ProposedLoanStage": { "description": "A proposed loan stage in Sageworks", "type": "object", "properties": { "displayOrder": { "format": "int32", "description": "The logical order of this loan stage vs other loan stages", "type": "integer" }, "id": { "format": "int32", "description": "The id of the proposed loan stage in Sageworks", "type": "integer" }, "isDeleted": { "description": "Indicates if this proposed loan stage has been deleted", "type": "boolean" }, "name": { "description": "Name of the proposed loan stage", "type": "string" } }, "additionalProperties": false }, "ProposedLoanStatusUpdate": { "description": "Updates to a proposed loans status", "type": "object", "properties": { "decisionReasons": { "description": "The list of reasons the loan was denied or withdrawn", "type": "array", "items": { "$ref": "#/definitions/ProposedBankLoanDecisionReason" } }, "denialWithdrawalReason": { "description": "The reason the loan was denied or withdrawn", "enum": [ "noCreditFile", "insufficientNumberOfCreditReferencesProvided", "limitedCreditExperience", "collectionActionOrJudgmentInCreditHistory", "garnishmentOrAttachmentInCreditHistory", "foreclosureOrRepossessionInCreditHistory", "delinquentCreditObligationsPastOrPresentWithOthers", "bankruptcy", "excessiveNumberOfRecentInquiriesOnCreditBureauReport", "unacceptableTypeOfCreditReferences", "poorCreditPerformanceWithUs", "temporaryOrIrregularEmployment", "insufficientLengthOfEmployment", "insufficientIncomeForAmountOfCreditRequested", "excessiveCreditObligationsInRelationToIncome", "temporaryResidence", "insufficientLengthOfResidence", "unableToVerifyCreditReferences", "unableToVerifyEmployment", "unableToVerifyIncome", "unableToVerifyResidence", "valueOrTypeOfCollateralInsufficient", "unacceptableAppraisalValue", "unacceptableLeaseholdEstate", "weDoNotGrantCreditToAnyApplicantOnTheTermsAndConditionsYouHaveRequested", "insufficientNumberOfPointsForApproval", "slowOrPastDueInTradeOrLoanPayments", "loanTypeIsListedAsUndesirableUnderFinancialInstitutionsLoanPolicy", "currentEconomicConditionsDoNotWarrantGrantingTheRequest", "businessSalesAndOrEarningsReflectADownwardTrend", "inadequateCapitalOrAssets", "cashFlowInsufficientToServiceExistingAndOrNewDebt", "amountRequestedIsInExcessOfFinancialInstitutionsLendingLimit", "creditInformationObtainedFromAThirdPartiesIsUnsatisfactory", "unacceptableCollateralCondition", "inadequateBusinessSalesAndOrEarningsHistory", "lackOfEstablishedEarningsRecord", "loanProceedsToBeUsedOutsideOfFinancialInstitutionsPrimaryAndSecondaryMarketArea", "loanTermIsInExcessOfFinancialInstitutionsPolicyForLoansOfThisType", "unacceptableCollateralLocation", "unacceptableCollateralLienPosition", "locationOrConditionOfCollateral", "other" ], "type": "string", "x-nullable": true }, "denialWithdrawalType": { "description": "The type of loan being denied or withdrawn", "enum": [ "directInstallment", "indirectInstallment", "lineOfCredit", "creditCard", "mortgageLoan", "termLoan", "singlePayment", "letterOfCredit", "loanRenewal", "loanModification", "other" ], "type": "string", "x-nullable": true }, "hmdaDenialReasons": { "$ref": "#/definitions/HmdaDenialReasons" }, "proposedLoanId": { "format": "int64", "description": "The ID to update", "type": "integer" }, "skipOptionalPhases": { "type": "boolean" }, "status": { "description": "The status to which the proposed loan should be updated", "enum": [ "approved", "withdrawn", "declined", "associated", "notApplicable" ], "type": "string", "x-nullable": true }, "statusReason": { "description": "The reason for the status update", "type": "string" } }, "additionalProperties": false }, "ProposedLoanStatusUpdates": { "description": "An object containing the info to perform multiple proposed loan status updates, optionally\r\nincluding workflow details for notification processing", "type": "object", "properties": { "statusUpdates": { "description": "List of status updates to perform", "type": "array", "items": { "$ref": "#/definitions/ProposedLoanStatusUpdate" } }, "workflowId": { "format": "int64", "description": "Workflow to process notifications for", "type": "integer", "x-nullable": true }, "workflowPhaseId": { "format": "int64", "description": "Final approval phase ID the status updates correspond to", "type": "integer", "x-nullable": true } }, "additionalProperties": false }, "ProposedLoanSummaryInformation": { "description": "A portfolio loan with just the summary information used on Loan Information page", "type": "object", "properties": { "bankCustomerProfitEntitiesID": { "format": "int64", "type": "integer" }, "borrowerName": { "description": "This is the name of the primary borrower.", "type": "string" }, "customerId": { "format": "int32", "description": "The id of the customer that is the primary borrower for the loan", "type": "integer" }, "id": { "format": "int32", "description": "The id of the loan in Sageworks", "type": "integer" }, "importedDate": { "format": "Date", "description": "Date the loan was imported. Null if it has not been imported.", "type": "string", "x-nullable": true }, "loanAmount": { "format": "double", "description": "This is the current outstanding amount on the loan prior to any charge-offs and other adjustments", "type": "number" }, "loanApplicationId": { "format": "int64", "description": "LoanApplicationId if loan application exists", "type": "integer", "x-nullable": true }, "loanName": { "description": "This is the unique identifier of the proposed loan.", "type": "string" }, "loanStage": { "description": "This is the current stage in the proposed loan process this loan is in.", "type": "string" }, "paymentType": { "description": "This is the method with which the loan's payments are calculated (fixed payment, line of credit, etc.)", "enum": [ "fixedPayment", "fixedPrincipal", "lineOfCredit", "revolvingLineOfCredit", "interestOnly", "fixedPaymentBalloon", "fixedPrincipalBalloon", "singlePaymentBalloon", "principalOnly", "other", "noPayment" ], "type": "string", "x-nullable": true }, "riskRating": { "format": "int32", "description": "This is the bank's calculated risk rating for the loan", "type": "integer", "x-nullable": true }, "status": { "description": "This is the current status of the proposed loan: Approved, Declined, Withdrawn, etc.", "type": "string" } }, "additionalProperties": false }, "ProposedLoanXml": { "description": "Xml for a Proposed Loan", "type": "object", "properties": { "txl": { "description": "Txl data for a proposed loan", "type": "string" } }, "additionalProperties": false }, "ProposedProduct": { "description": "A product that an institution used to, currently, or plans to offer\r\nto customers", "required": [ "id" ], "type": "object", "properties": { "applicationTemplates": { "description": "The list of application templates that are associated with this proposed product\r\n \r\nNote: currently changing the ApplicationTemplateMappings using the proposed product model is not supported via the API.", "type": "array", "items": { "$ref": "#/definitions/ApplicationTemplate" } }, "applicationTypes": { "description": "A list of the application types this product can be requested with", "type": "array", "items": { "format": "string", "description": "The type of an application or template. Used to drive functionality available", "enum": [ "preApp", "business", "person", "sba", "nonprofit", "farm" ], "type": "string" } }, "calculateEvaluatedCreditScore": { "description": "Indicates if this proposed product uses the evaluated credit score pattern", "type": "boolean" }, "creditBureauSelectionStrategy": { "description": "Indicates how to choose what score to use in relation to multiple scores for a single borrower", "enum": [ "highest", "middle", "lowest", "average" ], "type": "string", "x-nullable": true }, "customerFacingName": { "description": "The external name for this proposed product", "type": "string" }, "description": { "description": "Description for the proposed product", "type": "string" }, "evaluatedCreditScoreCreditBureaus": { "description": "Lists the credit bureaus to be used in evaluating this product's credit score", "type": "array", "items": { "format": "string", "description": "Type of credit bureau", "enum": [ "equifax", "experian", "transunion" ], "type": "string" } }, "evaluatedCreditScoreLoanRoleTypes": { "description": "A list of the loan roles included in the evaluated credit score calculation", "type": "array", "items": { "$ref": "#/definitions/LoanRoleType" } }, "iconName": { "description": "Icon name for the proposed product", "type": "string" }, "id": { "format": "int32", "description": "The identifier for this proposed product", "type": "integer" }, "isTridLoan": { "description": "Indicates if this product applies to TRID loans", "type": "boolean" }, "loanRoleSelectionStrategy": { "description": "Indicates how to choose what score to use in relation to multiple borrowers with scores", "enum": [ "highest", "middle", "lowest", "average" ], "type": "string", "x-nullable": true }, "name": { "description": "The internal name for this proposed product", "type": "string" }, "paymentType": { "format": "string", "description": "The default type of payment for loans with this proposed product\r\n(ex: fixed payment, interest only, line of credit, etc.)", "enum": [ "fixedPayment", "fixedPrincipal", "lineOfCredit", "revolvingLineOfCredit", "interestOnly", "fixedPaymentBalloon", "fixedPrincipalBalloon", "singlePaymentBalloon", "principalOnly", "other", "noPayment" ], "type": "string" }, "rateSheetsId": { "format": "int64", "description": "The identifier of the Rate Sheet (if any) associated with this proposed product", "type": "integer", "x-nullable": true } }, "additionalProperties": false }, "ProposedProductAvailableFinancialImportSource": { "description": "Used to associate ProposedProducts with DataSourceTypes of financials that institution wishes to consider for automatic importing", "required": [ "dataSourceType", "id", "proposedProductsID" ], "type": "object", "properties": { "dataSourceType": { "format": "string", "description": "Data source type that should be considered for proposed product import", "enum": [ "none", "annualized", "audit", "companyPrepared", "compilation", "financialStatement", "foreignCurrencyStatement", "merged", "other", "projection", "quickFinancials", "review", "sample", "taxReturn", "trailingTwelveMonths", "average", "projection2", "projection3", "projection4", "projection5", "payStub", "wTwo", "organizationPrepared", "selfReported", "consolidation", "probabilityOfDefault" ], "type": "string" }, "id": { "format": "int32", "description": "Identifier for this ProposedProductAvailableFinancialImportSource", "type": "integer" }, "proposedProductsID": { "format": "int32", "description": "Identifier for proposed product", "type": "integer" } }, "additionalProperties": false }, "ProposedSBALoanDetails": { "description": "The SBA-specific information associated with a particular SBA Loan.", "type": "object", "properties": { "applicantBusinessCustomerId": { "format": "int32", "description": "The CustomerID of the applicant business.", "type": "integer", "x-nullable": true }, "applicationProcessingMethodType": { "description": "The SBA Application Processing Method (ex: PaycheckProtectionProgram, SBAExpress)", "enum": [ "general", "sbaExpress", "plpLenderUnderwrite", "communityAdvantage", "other", "paycheckProtectionProgram", "sevenAWithWcp", "sevenAWithEwcp", "communityAdvantageInternationalTrade", "contractLoanLineOfCredit", "exportExpress", "internationalTradeLoans", "marC7aGeneral", "preferredLendersWithEWCP", "plpmarc", "preferredLendersWithWCP", "buildersLineOfCredit", "seasonalLineOfCredit", "standardAssetBaseWorkingCapitalLineOfCredit" ], "type": "string", "x-nullable": true }, "firstDrawLoanAmount": { "format": "double", "description": "The First Draw Loan Amount if this is a Second Draw Loan (only applies to PPP Application Processing Method)", "type": "number", "x-nullable": true }, "firstDrawSbaLoanNumber": { "description": "The First Draw SBA Loan Number if this is a Second Draw Loan (only applies to PPP Application Processing Method)", "type": "string" }, "id": { "format": "int32", "description": "The ID of the proposed loan of this record.", "type": "integer" }, "isSecondDrawLoan": { "description": "Whether this is a second draw SBA Loan for this application (only applies to PPP Application Processing\r\nMethod)", "type": "boolean", "x-nullable": true }, "sbaGuaranteePercentage": { "format": "double", "description": "The Percentage the Sba Guarantees", "type": "number", "x-nullable": true } }, "additionalProperties": false }, "RefinanceScenarioFinancialStatementOption": { "description": "Financial Statement information", "type": "object", "properties": { "id": { "format": "int32", "description": "The ID of the financial data in Sageworks", "type": "integer" }, "periodDuration": { "format": "int32", "description": "The length (in months) of the period in question", "type": "integer", "x-nullable": true }, "periodEndDate": { "format": "Date", "description": "The date that the period in question ended", "type": "string", "x-nullable": true }, "sourceOfData": { "description": "The source of the information being entered", "enum": [ "annualized", "audit", "companyPrepared", "compilation", "financialStatement", "projection", "merged", "other", "review", "sample", "taxReturn", "trailing12Months", "average", "projection2", "projection3", "projection4", "projection5", "consolidation" ], "type": "string", "x-nullable": true } }, "additionalProperties": false }, "RefinanceScenarioRequest": { "description": "Request for creating a new Refinance Scenario", "required": [ "financialStatementId", "loanName" ], "type": "object", "properties": { "financialStatementId": { "format": "int64", "description": "The Id of the financial statement", "type": "integer" }, "loanName": { "description": "The name/description of the proposed loan to create", "minLength": 1, "type": "string" } }, "additionalProperties": false }, "RefinanceScenarioResponse": { "description": "Refinance Scenario Creation response", "type": "object", "properties": { "proposedLoanId": { "format": "int64", "description": "The id of the proposed loan in Sageworks", "type": "integer" } }, "additionalProperties": false }, "RelatedLoanRole": { "description": "Represents a relationship between a related loan role and its parent primary loan role", "type": "object", "properties": { "customerId": { "format": "int32", "description": "Id of the customer that is related to the loan - READ ONLY FOR EXISTING ROLES", "type": "integer" }, "id": { "format": "int32", "description": "Id of the loan role that is related to the loan - READ ONLY", "type": "integer" }, "isDeleted": { "description": "True if this role has been deleted", "type": "boolean" }, "parentLoanRoleId": { "format": "int32", "description": "Id of the primary loan role that is the parent of the related role -- READ ONLY FOR EXISTING ROLES", "type": "integer", "x-nullable": true }, "parentLoanRoleType": { "description": "Type of the parent loan role (Primary Borrower, Co-borrower, etc.) -- READ ONLY FOR EXISTING ROLES", "enum": [ "coBorrower", "guarantor", "other", "affiliate" ], "type": "string", "x-nullable": true }, "portfolioLoanId": { "format": "int32", "description": "Id of the Portfolio Loan that the customer plays a role on -- READ ONLY FOR EXISTING ROLES\r\nLoan Role cannot have BOTH PortfolioLoanId and ProposedLoanId populated", "type": "integer", "x-nullable": true }, "proposedLoanId": { "format": "int32", "description": "Id of the Proposed Loan that the customer plays a role on -- READ ONLY FOR EXISTING ROLES\r\nLoan Role cannot have BOTH PortfolioLoanId and ProposedLoanId populated", "type": "integer", "x-nullable": true }, "roleType": { "description": "The type of role that the customer has with respect to the loan -- READ ONLY FOR EXISTING ROLES", "type": "string" } }, "additionalProperties": false }, "RevenueProduct": { "description": "A revenue-generating account belonging to a customer of a financial institution (ex: Cash Management accounts, Brokerage accounts, Retirement accounts, etc.)", "type": "object", "properties": { "amortizedMonths": { "format": "int32", "description": "The number of months the should be spread over. This field only applies to One-Time Revenue products.", "type": "integer", "x-nullable": true }, "annualRevenue": { "format": "double", "description": "The revenue received for the product annually. This field only applies to Annual Revenue products, Annual Revenue with Balance products, and Fee-Based Revenue products", "type": "number", "x-nullable": true }, "averageBalance": { "format": "double", "description": "The average balance of the product. You may elect to use this field for monthly, quarterly, annual, or other averages. This field only applies to Annual Revenue with Balance products.", "type": "number", "x-nullable": true }, "comments": { "description": "Comments for the RevenueProduct", "type": "string" }, "customerId": { "format": "int32", "description": "The id of the customer that is the primary owner of this revenue product", "type": "integer" }, "feeAmount": { "format": "double", "description": "The dollar amount of each fee charged to the customer. If the fee amount varies, enter an average fee amount. This field only applies to Fee-Based Revenue products.", "type": "number", "x-nullable": true }, "id": { "format": "int32", "description": "Id of the revenue product in Sageworks", "type": "integer" }, "isDeleted": { "description": "Indicates if the RevenueProduct has been deleted", "type": "boolean" }, "isProposed": { "description": "true if the RevenueProduct is proposed, false if the RevenueProduct is existing", "type": "boolean" }, "oneTimeRevenue": { "format": "double", "description": "The revenue received for the product in a single payment. This field only applies to One-Time Revenue products.", "type": "number", "x-nullable": true }, "originationDate": { "format": "Date", "description": "The date that this product was originated. For One-Time Revenue products, use the date the payment was received, or is expected to be received.", "type": "string", "x-nullable": true }, "revenueProductTypeId": { "format": "int32", "description": "Id of the RevenueProductType for this revenue product", "type": "integer" }, "timesFeeChargedAnnually": { "format": "int32", "description": "The number of times the fee is expected to be charged annually. This field only applies to Fee-Based Revenue products.", "type": "integer", "x-nullable": true }, "uniqueIdentifier": { "description": "The account number of unique identifier of the revenue product in the source system", "type": "string" } }, "additionalProperties": false }, "RiskRatingCalculation": { "type": "object", "properties": { "approvalStatus": { "description": "The approval status of the risk rating calculation.", "enum": [ "none", "pending", "approved", "declined", "withdrawn", "deferred", "needsRevision" ], "type": "string", "x-nullable": true }, "borrowerGradeRiskRatingId": { "format": "int64", "description": "Borrower grade risk rating calculations ID", "type": "integer", "x-nullable": true }, "calculatedRiskLabel": { "description": "Calculated risk label", "type": "string" }, "calculatedRiskRating": { "description": "Calculated risk rating", "type": "string" }, "comments": { "description": "Comments", "type": "string" }, "entityId": { "format": "int64", "description": "Id of the Entity", "type": "integer" }, "expectedLoss": { "format": "double", "description": "Expected loss", "type": "number" }, "financialStatementId": { "format": "int64", "description": "Id of the financial statement", "type": "integer", "x-nullable": true }, "hasManualChanges": { "description": "Indicates if the calculation has manual changes", "type": "boolean" }, "id": { "format": "int32", "description": "Id of the calculation", "type": "integer" }, "isFinalized": { "description": "Indicates if the calculation is finalized", "type": "boolean" }, "lastModifiedByUserId": { "format": "int64", "description": "Id of the User who last modified the RiskRatingCalculation", "type": "integer", "x-nullable": true }, "lastModifiedDate": { "format": "date-time", "description": "Last modified date", "type": "string", "x-nullable": true }, "loanIsProposed": { "description": "Indicates if the loan is proposed", "type": "boolean" }, "loansId": { "format": "int64", "description": "Id of the loan", "type": "integer", "x-nullable": true }, "lossGivenDefault": { "format": "double", "description": "Loss given default", "type": "number" }, "lossGivenDefaultCalculatedRiskLabel": { "description": "Loss given default calculated risk label", "type": "string" }, "lossGivenDefaultCalculatedRiskRating": { "description": "Loss given default calculated risk rating", "type": "string" }, "lossGivenDefaultRiskLabel": { "description": "Loss given default risk label", "type": "string" }, "lossGivenDefaultRiskRating": { "description": "Loss given default risk rating", "type": "string" }, "lossGivenDefaultWeightedScore": { "format": "double", "description": "Loss given default weighted score", "type": "number" }, "modelType": { "format": "string", "description": "The risk rating calculation model", "enum": [ "single", "dual", "customer" ], "type": "string" }, "periodEndingDate": { "format": "Date", "description": "Date when the period ends", "type": "string", "x-nullable": true }, "probabilityOfDefault": { "format": "double", "description": "Probability of default", "type": "number" }, "probabilityOfDefaultCalculatedRiskLabel": { "description": "Probability of default calculated risk label", "type": "string" }, "probabilityOfDefaultCalculatedRiskRating": { "description": "Probability of default calculated risk rating", "type": "string" }, "probabilityOfDefaultRiskLabel": { "description": "Probability of default risk label", "type": "string" }, "probabilityOfDefaultRiskRating": { "description": "Probability of default risk rating", "type": "string" }, "probabilityOfDefaultWeightedScore": { "format": "double", "description": "Probability of default weighted score", "type": "number" }, "riskLabel": { "description": "Label of the risk", "type": "string" }, "riskRating": { "description": "Risk rating", "type": "string" }, "templateName": { "description": "The name of template used to calculate the risk rating", "type": "string" }, "weightedScore": { "format": "double", "description": "The weighted score", "type": "number" } }, "additionalProperties": false }, "RiskRatingCalculationApproval": { "type": "object", "properties": { "customersID": { "format": "int64", "type": "integer" }, "deferredDate": { "format": "Date", "type": "string", "x-nullable": true }, "id": { "format": "int64", "type": "integer" }, "lastModifiedDate": { "format": "Date", "type": "string" }, "notifyUser": { "type": "boolean" }, "reason": { "type": "string" }, "riskRatingApprovalStatusDescription": { "format": "string", "enum": [ "none", "pending", "approved", "declined", "withdrawn", "deferred", "needsRevision" ], "type": "string", "readOnly": true }, "riskRatingCalculationApprovalStatusID": { "format": "int32", "type": "integer" }, "riskRatingCalculationsID": { "format": "int32", "type": "integer" }, "show": { "type": "boolean" }, "usersID": { "format": "int32", "type": "integer" } }, "additionalProperties": false }, "RiskRatingCalculationSection": { "description": "Represents a risk rating calculation section.", "type": "object", "properties": { "factors": { "description": "The factors that contribute to this section's calculation", "type": "array", "items": { "$ref": "#/definitions/RiskRatingCalculationSectionFactor" } }, "id": { "format": "int32", "description": "The ID of the risk rating calculation section.", "type": "integer" }, "name": { "description": "The name of the risk rating calculation section.", "type": "string" }, "score": { "format": "double", "description": "This is the total contributing amount from this section to the overall risk rating.\r\nIt is calculated by taking the raw score and multiplying it by the weight.", "type": "number" }, "weight": { "format": "double", "description": "The weight of this section as a percentage of the overall risk rating.", "type": "number" } }, "additionalProperties": false }, "RiskRatingCalculationSectionFactor": { "description": "Represents a risk rating calculation section factor.", "type": "object", "properties": { "comments": { "description": "The comments about the factor and/or any notes as to why the value was manually entered.", "type": "string" }, "id": { "format": "int32", "description": "The Id of the risk rating calculation section factor.", "type": "integer" }, "latestFactorValue": { "format": "double", "description": "The latest factor value.", "type": "number", "x-nullable": true }, "manuallyUpdated": { "description": "A value indicating whether it was manually updated.", "type": "boolean" }, "metricName": { "description": "The name of the metric used for the factor.", "type": "string" }, "rawScore": { "format": "double", "description": "The raw score is calculated by taking the risk score and multiplying it by the risk weight times 100.\r\nIt contributes to the overall raw score of the section", "type": "number" }, "score": { "format": "double", "description": "This is the risk score assigned to the benchmark range in which the value falls to show the riskiness of the factor.", "type": "number" }, "value": { "format": "double", "description": "This is the value calculated or manually entered for the factor.", "type": "number", "x-nullable": true }, "valueRange": { "description": "This is the range between which the factor value falls.", "type": "string" }, "weight": { "format": "double", "description": "This weight determines the influence that the risk score of this factor has on this section score\r\nwhich impacts the overall risk rating.", "type": "number" } }, "additionalProperties": false }, "RiskRatingCalculationWithSectionsAndFactors": { "description": "Represents a risk rating calculation with sections and factors.\r\nThis class inherits from the RiskRatingCalculation class.", "type": "object", "properties": { "approvalStatus": { "description": "The approval status of the risk rating calculation.", "enum": [ "none", "pending", "approved", "declined", "withdrawn", "deferred", "needsRevision" ], "type": "string", "x-nullable": true }, "borrowerGradeRiskRatingId": { "format": "int64", "description": "Borrower grade risk rating calculations ID", "type": "integer", "x-nullable": true }, "calculatedRiskLabel": { "description": "Calculated risk label", "type": "string" }, "calculatedRiskRating": { "description": "Calculated risk rating", "type": "string" }, "comments": { "description": "Comments", "type": "string" }, "entityId": { "format": "int64", "description": "Id of the Entity", "type": "integer" }, "expectedLoss": { "format": "double", "description": "Expected loss", "type": "number" }, "financialStatementId": { "format": "int64", "description": "Id of the financial statement", "type": "integer", "x-nullable": true }, "hasManualChanges": { "description": "Indicates if the calculation has manual changes", "type": "boolean" }, "id": { "format": "int32", "description": "Id of the calculation", "type": "integer" }, "isFinalized": { "description": "Indicates if the calculation is finalized", "type": "boolean" }, "lastModifiedByUserId": { "format": "int64", "description": "Id of the User who last modified the RiskRatingCalculation", "type": "integer", "x-nullable": true }, "lastModifiedDate": { "format": "date-time", "description": "Last modified date", "type": "string", "x-nullable": true }, "loanIsProposed": { "description": "Indicates if the loan is proposed", "type": "boolean" }, "loansId": { "format": "int64", "description": "Id of the loan", "type": "integer", "x-nullable": true }, "lossGivenDefault": { "format": "double", "description": "Loss given default", "type": "number" }, "lossGivenDefaultCalculatedRiskLabel": { "description": "Loss given default calculated risk label", "type": "string" }, "lossGivenDefaultCalculatedRiskRating": { "description": "Loss given default calculated risk rating", "type": "string" }, "lossGivenDefaultRiskLabel": { "description": "Loss given default risk label", "type": "string" }, "lossGivenDefaultRiskRating": { "description": "Loss given default risk rating", "type": "string" }, "lossGivenDefaultWeightedScore": { "format": "double", "description": "Loss given default weighted score", "type": "number" }, "modelType": { "format": "string", "description": "The risk rating calculation model", "enum": [ "single", "dual", "customer" ], "type": "string" }, "periodEndingDate": { "format": "Date", "description": "Date when the period ends", "type": "string", "x-nullable": true }, "probabilityOfDefault": { "format": "double", "description": "Probability of default", "type": "number" }, "probabilityOfDefaultCalculatedRiskLabel": { "description": "Probability of default calculated risk label", "type": "string" }, "probabilityOfDefaultCalculatedRiskRating": { "description": "Probability of default calculated risk rating", "type": "string" }, "probabilityOfDefaultRiskLabel": { "description": "Probability of default risk label", "type": "string" }, "probabilityOfDefaultRiskRating": { "description": "Probability of default risk rating", "type": "string" }, "probabilityOfDefaultWeightedScore": { "format": "double", "description": "Probability of default weighted score", "type": "number" }, "riskLabel": { "description": "Label of the risk", "type": "string" }, "riskRating": { "description": "Risk rating", "type": "string" }, "sections": { "description": "List of sections in the risk rating calculation.", "type": "array", "items": { "$ref": "#/definitions/RiskRatingCalculationSection" } }, "templateName": { "description": "The name of template used to calculate the risk rating", "type": "string" }, "weightedScore": { "format": "double", "description": "The weighted score", "type": "number" } }, "additionalProperties": false }, "RiskRatingDecisionInputModel": { "description": "The parameters for a risk rating decision.", "type": "object", "properties": { "deferredDate": { "format": "Date", "description": "For deferrals, the date the decision should be reconsidered.", "type": "string", "x-nullable": true }, "reason": { "description": "The reason for the decision and any supporting notes.", "type": "string" }, "shouldNotifyUser": { "description": "Flag indicating if the user that made risk rating changes should be notified of the decision.", "type": "boolean" } }, "additionalProperties": false }, "Roles": { "type": "object", "properties": { "beneficialOwnership": { "description": "List of beneficial owners on the loan", "type": "array", "items": { "$ref": "#/definitions/BeneficialOwnership" } }, "otherEntityRoles": { "description": "List of other entity roles on the loan", "type": "array", "items": { "$ref": "#/definitions/OtherEntityRole" } } }, "additionalProperties": false }, "SBAExportData": { "description": "SBA export information for a loan", "type": "object", "properties": { "eTranApplicationNumber": { "format": "int64", "description": "E-Tran app number", "type": "integer" }, "eTranApprovalDate": { "format": "Date", "description": "E-Tran approval date", "type": "string", "x-nullable": true }, "eTranLoanNumber": { "description": "E-Tran loan number", "type": "string" }, "eTranReadyStatus": { "description": "Is loan ready for e-tran export", "enum": [ "notExportedNotReady", "exported", "notExportedReady" ], "type": "string", "x-nullable": true }, "eTranStatus": { "description": "E-Tran status", "type": "string" }, "id": { "format": "int32", "type": "integer" }, "proposedLoanId": { "format": "int32", "description": "The id of the proposed loan that this sba export data is associated with", "type": "integer" } }, "additionalProperties": false }, "SbaBusinessFinancialData": { "type": "object", "properties": { "accountsPayable": { "format": "double", "type": "number", "x-nullable": true }, "annualInterestExpense": { "format": "double", "type": "number", "x-nullable": true }, "cashEquivalent": { "format": "double", "type": "number", "x-nullable": true }, "cashFlow": { "format": "double", "type": "number", "x-nullable": true }, "costOfGoodsSold": { "format": "double", "type": "number", "x-nullable": true }, "currentLtdCpltd": { "format": "double", "type": "number", "x-nullable": true }, "depreciationAmortization": { "format": "double", "type": "number", "x-nullable": true }, "grossProfit": { "format": "double", "type": "number", "x-nullable": true }, "incomeStatementEndDate": { "format": "Date", "type": "string", "x-nullable": true }, "incomeStatementStartDate": { "format": "Date", "type": "string", "x-nullable": true }, "incomeTaxes": { "format": "double", "type": "number", "x-nullable": true }, "longTermDebt": { "format": "double", "type": "number", "x-nullable": true }, "netIncomeAfterTaxes": { "format": "double", "type": "number", "x-nullable": true }, "netIncomeBeforeTaxesWithdrawals": { "format": "double", "type": "number", "x-nullable": true }, "netSalesRevenue": { "format": "double", "type": "number", "x-nullable": true }, "netTradeReceivables": { "format": "double", "type": "number", "x-nullable": true }, "netWorth": { "format": "double", "type": "number", "x-nullable": true }, "operatingProfit": { "format": "double", "type": "number", "x-nullable": true }, "otherCurrentAssets": { "format": "double", "type": "number", "x-nullable": true }, "otherCurrentLiabilities": { "format": "double", "type": "number", "x-nullable": true }, "otherLongTermLiabilities": { "format": "double", "type": "number", "x-nullable": true }, "ownersSalariesWithdrawals": { "format": "double", "type": "number", "x-nullable": true }, "standbyDebt": { "format": "double", "type": "number", "x-nullable": true }, "tangibleNetWorth": { "format": "double", "type": "number", "x-nullable": true }, "totalAssets": { "format": "double", "type": "number", "x-nullable": true }, "totalCurrentAssets": { "format": "double", "type": "number", "x-nullable": true }, "totalCurrentLiabilities": { "format": "double", "type": "number", "x-nullable": true }, "totalFixedAssets": { "format": "double", "type": "number", "x-nullable": true }, "totalInventory": { "format": "double", "type": "number", "x-nullable": true }, "totalLiabilities": { "format": "double", "type": "number", "x-nullable": true }, "totalOtherAssets": { "format": "double", "type": "number", "x-nullable": true } }, "additionalProperties": false }, "SbaForm": { "description": "A form required for SBA loans. Could be one of many types", "type": "object", "properties": { "customerId": { "format": "int32", "description": "The customer assigned to the form", "type": "integer" }, "formType": { "format": "string", "description": "The type of the form", "enum": [ "form1920", "form1919ApplicantBusinessInformation", "form1919PersonPrincipalInformation", "form2484", "form2483ApplicantBusinessInformation", "form147", "form3508", "form1919BusinessPrincipalInformation", "form1919BusinessInformationJan2024Revision", "personDemographicsInformation" ], "type": "string" }, "id": { "format": "int32", "description": "The form's ID in the database", "type": "integer" }, "proposedLoanId": { "format": "int32", "description": "The loan the given form is for", "type": "integer", "x-nullable": true }, "status": { "format": "string", "description": "The status of the form", "enum": [ "new", "sent", "inProgress", "underReview", "approved", "declined", "waived" ], "type": "string" }, "statusChangedById": { "format": "int32", "description": "If the document is approved, declined or waived, contains the Id of the user who changed the status", "type": "integer", "x-nullable": true }, "statusChangedDate": { "format": "Date", "description": "If the document's status changes, records the date of the last change", "type": "string", "x-nullable": true }, "statusReason": { "description": "The reason the loan officer gave when waiving/declining a form", "type": "string" } }, "additionalProperties": false }, "SbaPersonalFinancialData": { "type": "object", "properties": { "creditCardDebt": { "format": "double", "type": "number", "x-nullable": true }, "installmentDebt": { "format": "double", "type": "number", "x-nullable": true }, "liquidAssets": { "format": "double", "type": "number", "x-nullable": true }, "netWorth": { "format": "double", "type": "number", "x-nullable": true }, "otherAssets": { "format": "double", "type": "number", "x-nullable": true }, "otherLiabilities": { "format": "double", "type": "number", "x-nullable": true }, "ownershipInBusinesses": { "format": "double", "type": "number", "x-nullable": true }, "realEstateAssets": { "format": "double", "type": "number", "x-nullable": true }, "realEstateLibabilities": { "format": "double", "type": "number", "x-nullable": true }, "totalAssets": { "format": "double", "type": "number", "x-nullable": true }, "totalLiabilities": { "format": "double", "type": "number", "x-nullable": true } }, "additionalProperties": false }, "SelectOption": { "type": "object", "properties": { "displayOrder": { "format": "int32", "type": "integer", "x-nullable": true }, "isActive": { "type": "boolean" }, "label": { "type": "string" }, "optionGroup": { "type": "string" }, "value": { "x-nullable": true } }, "additionalProperties": false }, "SelectOptionModel": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "x-nullable": true } }, "additionalProperties": false }, "SendToLaserProErrorCause": { "type": "object", "properties": { "fieldName": { "description": "Field Name", "type": "string" }, "fieldValue": { "description": "Field Value", "type": "string" }, "message": { "description": "Error Message", "type": "string" } }, "additionalProperties": false }, "SendToLaserProErrorDetails": { "type": "object", "properties": { "causes": { "description": "LaserPro Error Causes", "type": "array", "items": { "$ref": "#/definitions/SendToLaserProErrorCause" } }, "detail": { "description": "LaserPro Error Detail", "type": "string" }, "status": { "format": "int32", "description": "LaserPro Error Status", "type": "integer" }, "title": { "description": "LaserPro Error Title", "type": "string" } }, "additionalProperties": false }, "SendToLaserProResponse": { "type": "object", "properties": { "errorDetails": { "$ref": "#/definitions/SendToLaserProErrorDetails" }, "laserProTransactionNumber": { "description": "LaserPro Transaction Number", "type": "string" }, "status": { "format": "string", "description": "Status of the request", "enum": [ "laserProApiError", "unauthorizedError", "success" ], "type": "string" } }, "additionalProperties": false }, "SignedAgreementViewResponse": { "description": "Response containing the URL for viewing a signed agreement in a new browser tab", "type": "object", "properties": { "documentUrl": { "description": "The direct URL to view/download the signed document from Adobe Sign", "type": "string" } }, "additionalProperties": false }, "SpouseDetails": { "description": "Spouse details for a person entity", "type": "object", "properties": { "email": { "description": "Spouse email address", "type": "string" }, "firstName": { "description": "First name of the spouse", "type": "string" }, "lastName": { "description": "Last name of the spouse", "type": "string" }, "middleName": { "description": "Middle name or initial of the spouse", "type": "string" }, "ssn": { "description": "Social Security Number of the spouse", "type": "string" } }, "additionalProperties": false }, "StartWorkflowRequest": { "description": "Information required to start a workflow", "required": [ "customerId", "name", "workflowTemplateId" ], "type": "object", "properties": { "customerId": { "format": "int32", "description": "Id of the customer", "type": "integer" }, "depositIds": { "description": "List of DepositIds for the workflow", "type": "array", "items": { "format": "int64", "type": "integer" } }, "name": { "description": "Name of the workflow", "minLength": 1, "type": "string" }, "portfolioLoanIds": { "description": "List of PortfolioLoanIds for the workflow", "type": "array", "items": { "format": "int32", "type": "integer" } }, "proposedLoanIds": { "description": "List of ProposedLoanIds for the workflow", "type": "array", "items": { "format": "int32", "type": "integer" } }, "workflowReasonOptionsIds": { "description": "List of WorkflowReasonOPtionsIds for the workflow", "type": "array", "items": { "format": "int32", "type": "integer" } }, "workflowTemplateId": { "format": "int32", "description": "Id of the workflow template for the workflow", "type": "integer" } }, "additionalProperties": false }, "StartWorkflowResponse": { "description": "Response after a workflow was created", "type": "object", "properties": { "workflowId": { "format": "int32", "description": "Id of the workflow", "type": "integer" } }, "additionalProperties": false }, "State": { "description": "Represents a state in a country", "type": "object", "properties": { "country": { "description": "The country the state is in.", "type": "string" }, "id": { "format": "int32", "description": "The ID of the state in Sageworks.", "type": "integer" }, "region": { "description": "The region the state is in.", "type": "string" }, "stateCode": { "description": "The state code of the state.", "type": "string" }, "stateName": { "description": "The name of the state.", "type": "string" } }, "additionalProperties": false }, "TaxFormItem": { "description": "Represents an item from a tax form", "type": "object", "properties": { "ddkey": { "description": "FlashSpread JSON field name (DDKey) for this item.\r\nUsed for stable entity mapping. Example: \"se_28a_a_name\"", "type": "string" }, "form": { "description": "The form that this item appears on (1040, 1065, 1120, 8825, or 1120S)", "type": "string" }, "itemValue": { "description": "The value of the tax return item after the rawText has been scrubbed", "type": "string" }, "line": { "description": "The line on the tax form that this item corresponds to", "type": "string" }, "page": { "format": "int32", "description": "Page number of the tax form that this item appears on", "type": "integer" }, "rawText": { "description": "The value of the tax return item. This should be the same as ItemValue", "type": "string" }, "schedule": { "description": "If applicable, the schedule that this item appears on (A, C, D, E, F)", "type": "string" }, "year": { "description": "The year of the tax return that this item appears on (this can be from 2010 - current year)", "type": "string" } }, "additionalProperties": false }, "TaxReturnReaderParsePdfRequest": { "description": "Represents the data required to parse a tax return PDF", "type": "object", "properties": { "documentName": { "description": "Customer-facing name of the document", "type": "string" }, "password": { "description": "Password of the PDF file (if applicable)", "type": "string" }, "pdfBytes": { "description": "Base64 encoded byte array of the PDF file to parse", "type": "string" } }, "additionalProperties": false }, "TaxReturnReaderResponse": { "type": "object", "properties": { "taxFormItems": { "description": "Tax form data", "type": "array", "items": { "$ref": "#/definitions/TaxFormItem" } } }, "additionalProperties": false }, "Tickler": { "description": "Represents a Tickler in Sageworks", "type": "object", "properties": { "bankLoanCollateralId": { "format": "int64", "description": "Id of the collateral that is related to this tickler.", "type": "integer", "x-nullable": true }, "comments": { "description": "General comments on the tickler", "type": "string" }, "customerId": { "format": "int32", "description": "Id of the customer or group in Sageworks that this tickler is attached to", "type": "integer" }, "documentAppliesToCustomerId": { "format": "int32", "description": "Id of the customer the tickler applies to", "type": "integer" }, "documentIdentifier": { "description": "The identifying number or descriptive phrase for this tickler.", "type": "string" }, "documentLocation": { "description": "Physical location of the hard copy of this document at your institution.", "type": "string" }, "documentRecipientToCustomerId": { "format": "int32", "description": "Id of the customer the tickler should be sent to", "type": "integer", "x-nullable": true }, "frequency": { "description": "How often your institution will make the tickler request", "type": "string" }, "id": { "format": "int32", "description": "Id of the tickler in Sageworks", "type": "integer" }, "loanOfficerId": { "format": "int32", "description": "Id of the loan officer assigned to this tickler", "type": "integer" }, "nextDueDate": { "format": "Date", "description": "The date that the document being requested is due.", "type": "string", "x-nullable": true }, "nextPdEndDate": { "format": "Date", "description": "The period ending date for the document being requested.", "type": "string", "x-nullable": true }, "ticklerName": { "description": "Name of the tickler", "type": "string" } }, "additionalProperties": false }, "TicklerLoanMapping": { "description": "Represents the mapping between a Tickler and Portfolio Loan", "type": "object", "properties": { "id": { "format": "int32", "description": "Id of the tickler loan mapping in Sageworks", "type": "integer" }, "isProposed": { "description": "Flag to indicate if the Portfolio Loan is proposed loan", "type": "boolean" }, "portfolioLoanId": { "format": "int32", "description": "Id of the Portfolio Loan", "type": "integer" }, "ticklerId": { "format": "int32", "description": "Id of the tickler", "type": "integer" } }, "additionalProperties": false }, "TicklerRequest": { "description": "Represents a tickler request (document tracking request instance)", "type": "object", "properties": { "closeTickler": { "description": "Optional flag to explicitly close the parent tickler when updating this request.\r\nOnly used for PATCH operations. When true, the parent tickler will be closed using\r\nthe DisabledDate (or today if not specified).", "type": "boolean", "x-nullable": true }, "comments": { "description": "Relevant comments for the tickler request", "type": "string" }, "disabledDate": { "format": "Date", "description": "The date when the request was closed/disabled", "type": "string", "x-nullable": true }, "documentDated": { "format": "Date", "description": "The period ending date for the document being requested", "type": "string", "x-nullable": true }, "documentIdentifier": { "description": "Identifying number or descriptive phrase for the document", "type": "string" }, "documentLocation": { "description": "Physical location of the hard copy document at the institution", "type": "string" }, "dueDate": { "format": "Date", "description": "The current due date for the document (may differ from original if extended)", "type": "string", "x-nullable": true }, "extendedDate": { "format": "Date", "description": "The date when the request was extended", "type": "string", "x-nullable": true }, "id": { "format": "int32", "description": "Unique identifier for the tickler request", "type": "integer" }, "originalDueDate": { "format": "Date", "description": "The original due date before any extensions were applied", "type": "string", "x-nullable": true }, "receivedDate": { "format": "Date", "description": "The date when the document was received", "type": "string", "x-nullable": true }, "status": { "description": "Current status of the request", "enum": [ "received", "waived", "extended", "closed" ], "type": "string", "x-nullable": true }, "ticklerId": { "format": "int32", "description": "The tickler (BankLoanDocument) this request belongs to", "type": "integer" } }, "additionalProperties": false }, "TicklerV2": { "description": "Represents a Tickler in Sageworks", "type": "object", "properties": { "allEntityLoans": { "description": "Indicates if this tickler applies to all loans for the entity", "type": "boolean" }, "classification": { "description": "Classification of the tickler (e.g., \"financialdocument\", \"otherdocument\")", "type": "string" }, "closed": { "description": "Indicates if the tickler is closed", "type": "boolean" }, "closedDate": { "format": "Date", "description": "The date when the tickler was closed", "type": "string", "x-nullable": true }, "collateralId": { "format": "int32", "description": "Id of the collateral that is related to this tickler", "type": "integer", "x-nullable": true }, "comments": { "description": "General comments on the tickler", "type": "string" }, "documentIdentifier": { "description": "The identifying number or descriptive phrase for this tickler", "type": "string" }, "documentLocation": { "description": "Physical location of the hard copy of this document at your institution", "type": "string" }, "existingLoanIds": { "description": "List of existing loan ids associated with this tickler", "type": "array", "items": { "format": "int32", "type": "integer" } }, "frequencyUnit": { "description": "The unit of the frequency (e.g., Months, Quarters, Years)", "enum": [ "oneTime", "weekly", "months", "quarters", "years", "annualOutstanding" ], "type": "string", "x-nullable": true }, "frequencyValue": { "format": "int32", "description": "The numeric value of the frequency (e.g., 2 for \"every 2 months\").\r\nNull for frequencies without a numeric value such as OneTime, Weekly, or AnnualOutstanding.", "type": "integer", "x-nullable": true }, "id": { "format": "int32", "description": "Id of the tickler in Sageworks", "type": "integer" }, "nextDueDate": { "format": "Date", "description": "The date that the document being requested is due", "type": "string", "x-nullable": true }, "nextPdEndDate": { "format": "Date", "description": "The period ending date for the document being requested", "type": "string", "x-nullable": true }, "personResponsibleId": { "format": "int32", "description": "Id of the person responsible for this tickler", "type": "integer" }, "proposedLoanIds": { "description": "List of proposed loan ids associated with this tickler", "type": "array", "items": { "format": "int32", "type": "integer" } }, "sendTicklerToCustomerId": { "format": "int32", "description": "Id of the customer the tickler should be sent to", "type": "integer", "x-nullable": true }, "ticklerAppliesToCustomerId": { "format": "int32", "description": "Id of the customer the tickler applies to", "type": "integer" }, "ticklerName": { "description": "Name of the tickler", "type": "string" }, "warnings": { "description": "Warning messages related to this tickler (e.g., if request generation failed during creation)", "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "TrustageDocumentsResponse": { "type": "object", "properties": { "documentIds": { "description": "Ids of the saved documents", "type": "array", "items": { "format": "int64", "type": "integer" } } }, "additionalProperties": false }, "User": { "description": "Represents a Sageworks User", "type": "object", "properties": { "accountCreatedDate": { "format": "Date", "description": "Date the Account was created in Sageworks", "type": "string" }, "email": { "description": "Email of the user in Sageworks", "type": "string" }, "firstName": { "description": "First Name in Sageworks", "type": "string" }, "id": { "format": "int32", "description": "ID of the user in Sageworks", "type": "integer" }, "isDeleted": { "description": "Whether the user is deleted in Sageworks", "type": "boolean" }, "isNonUser": { "description": "Whether the user is a Non-User in Sageworks\r\n \r\nThis is often used for users who do not need access to the system but need to be assigned Workflow steps", "type": "boolean" }, "lastLoginDate": { "format": "Date", "description": "Last date the user logged into Sageworks", "type": "string", "x-nullable": true }, "lastName": { "description": "Last Name in Sageworks", "type": "string" }, "officerCode": { "description": "Officer Code for the user in Sageworks", "type": "string" } }, "additionalProperties": false }, "UserDefinedDataFieldPatchRequest": { "description": "Represents a user-defined data field", "type": "object", "properties": { "id": { "format": "int64", "description": "The name of the custom field", "type": "integer" }, "name": { "description": "The name of the custom field", "type": "string" } }, "additionalProperties": false }, "UserDefinedDataFieldPostRequest": { "description": "Represents a user-defined data field", "type": "object", "properties": { "dataFieldFormatString": { "description": "Represents the format string for certain format types\r\nOptions:\tother [represents any other format string],\r\n\t\t\tc2 [represents currency formatted to 2 decimals],\r\n\t\t\tp2 [represents a percentage formatted to 2 decimals],\r\n\t\t\tyesNo [represents a radio with yes/no options],\r\n\t\t\tn0 [represents a number formatted with no decimals]\r\n\t\t\tn1 [represents a number formatted with 1 decimal],\r\n\t\t\tn2 [represents a number formatted to 2 decimals],\r\n\t\t\tn3 [represents a number fomatted to 3 decimals],\r\n\t\t\tn4 [represents a number formatted to 4 decimals],\r\n\t\t\tp3 [represents a percentage formatted to 3 decimals],\r\n\t\t\tp4 [represents a percentage formatted to 4 decimals],\r\n\t\t\ttextLength500 [represents text up to 500 characters],\r\n\t\t\ttextLength1000 [represents text up to 1000 characters],\r\n\t\t\ttextLength200 [represents text up to 200 characters],\r\n\t\t\tc0 [represents currency formatted with no decimals],\r\n\t\t\tc4 [represents currency formatted to 4 decimals],\r\n\t\t\tp0 [represents a percentage formatted with no decimals],\r\n\t\t\tf0 [represents 'fixed-point' numeric without commas and no decimals],\r\n\t\t\ttrueFalse [represents a radio with true/false options],\r\n\t\t\ttextLength255 [represents text up to 255 characters],\r\n\t\t\tyesNoBool [represents a radio with yes/no options],\r\n\t\t\tordered [this is a custom format for numeric and text fields that are displayed as dropdowns but still need to support operations that use ordering],\r\n\t\t\tyyyyMM [represents date format],\r\n\t\t\ttextLength25 [represents text up to 25 characters]", "enum": [ "other", "c2", "p2", "yesNo", "n0", "n1", "n2", "n3", "n4", "p3", "p4", "textLength500", "textLength1000", "textLength200", "c0", "c4", "p0", "f0", "trueFalse", "textLength255", "yesNoBool", "ordered", "yyyyMM", "textLength25" ], "type": "string", "x-nullable": true }, "dataFieldInputFormat": { "format": "string", "description": "Represents the input type of the field\r\nOptions: other [value is other],\r\n\t\ttext [value is text],\r\n\t\tnumeric [value is a pure number],\r\n\t\tcurrency [value represents currency],\r\n\t\tdate [value is a date],\r\n\t\tpercent [value is a percentage],\r\n\t\tdropdown [value is a dropdown],\r\n\t\tradio [value is a radio button group],\r\n\t\tlabel [value is a label],\r\n\t\tlabelRow [value is a label row],\r\n\t\tcomments [value represents comments],\r\n\t\tdivider [value represents a divider],\r\n\t\tlink [value is a hyperlink],\r\n\t\tcheckbox [value is a checkbox],\r\n\t\ttextArea [value is a textarea],\r\n\t\texpandingTextArea [value is longer test that can be expanded],\r\n\t\tcombobox [value is a combobox],\r\n\t\tmultiSelect [value is a multi-select],\r\n\t\tindustryCode [value is an industry code],\r\n\t\tbirthDate [value is a birth date],\r\n\t\tspacer [value is a spacer],\r\n\t\tcustomMetric [value is a custom metric],\r\n\t\tfixedPointNumeric [value is a numeric without commas],\r\n\t\tgroupedValues [value represents grouped values],\r\n\t\tsocialSecurityNumber [value represents a SSN],\r\n\t\tautoComplete [value has auto complete],\r\n\t\ttextWithDropdownOptions [value represents text with dropdown options],\r\n\t\tphoneNumber [value represents a 10 or 11 digit phone number]", "enum": [ "other", "text", "numeric", "currency", "date", "percent", "dropdown", "radio", "label", "labelRow", "comments", "divider", "link", "checkbox", "textArea", "expandingTextArea", "combobox", "multiSelect", "industryCode", "birthDate", "spacer", "customMetric", "fixedPointNumeric", "groupedValues", "socialSecurityNumber", "autoComplete", "textWithDropdownOptions", "phoneNumber" ], "type": "string" }, "id": { "format": "int32", "description": "The Id of the datafield", "type": "integer" }, "name": { "description": "The name of the custom field", "type": "string" }, "options": { "description": "Represents a list of options when the format type is dropdown\r\nThis property must be null when the input type is not dropdown", "type": "array", "items": { "$ref": "#/definitions/DataFieldOption" } } }, "additionalProperties": false }, "UserDepartment": { "type": "object", "properties": { "active": { "type": "boolean" }, "customersID": { "format": "int64", "type": "integer" }, "departmentName": { "type": "string" }, "id": { "format": "int64", "type": "integer" } }, "additionalProperties": false }, "UserMarket": { "type": "object", "properties": { "active": { "type": "boolean" }, "customersID": { "format": "int64", "type": "integer" }, "id": { "format": "int64", "type": "integer" }, "marketName": { "type": "string" } }, "additionalProperties": false }, "UserRegion": { "type": "object", "properties": { "active": { "type": "boolean" }, "customersID": { "format": "int64", "type": "integer" }, "id": { "format": "int64", "type": "integer" }, "regionName": { "type": "string" } }, "additionalProperties": false }, "UserRole": { "type": "object", "properties": { "id": { "format": "int32", "description": "ID of the role in Sageworks", "type": "integer" }, "isDeleted": { "description": "Whether the role is deleted in Sageworks", "type": "boolean" }, "name": { "description": "Role Name in Sageworks", "type": "string" } }, "additionalProperties": false }, "UserRoleMapping": { "type": "object", "properties": { "id": { "format": "int32", "description": "ID of the user role in Sageworks", "type": "integer" }, "userId": { "format": "int64", "description": "ID of the user in Sageworks", "type": "integer" }, "userRoleId": { "format": "int64", "description": "ID of the role in Sageworks", "type": "integer" } }, "additionalProperties": false }, "UserTeam": { "type": "object", "properties": { "active": { "type": "boolean" }, "customersID": { "format": "int64", "type": "integer" }, "id": { "format": "int64", "type": "integer" }, "teamName": { "type": "string" } }, "additionalProperties": false }, "WidgetFieldValues": { "type": "object", "properties": { "collateralCoOwnerCustomerIds": { "description": "Co-Owners for the collateral", "type": "array", "items": { "format": "int64", "type": "integer" } }, "customerId": { "format": "int64", "description": "Pledged By CustomerId for Collateral", "type": "integer", "x-nullable": true }, "fieldValues": { "description": "FieldName and Values of Widget fields", "type": "object", "additionalProperties": { "type": "string" } } }, "additionalProperties": false }, "Workflow": { "description": "Represents a Workflow in Sageworks", "required": [ "customerId", "name", "workflowTemplateId" ], "type": "object", "properties": { "customerId": { "format": "int32", "description": "Id of the customer", "type": "integer" }, "id": { "format": "int32", "description": "Id of the workflow in Sageworks - READ ONLY", "type": "integer" }, "isDeleted": { "description": "Indicates if the workflow is deleted (for external API consumers) - READ ONLY", "type": "boolean" }, "lastModifiedDate": { "format": "Date", "description": "LastModifiedDate of the workflow - READ ONLY", "type": "string", "x-nullable": true }, "name": { "description": "Name of the workflow", "minLength": 1, "type": "string" }, "status": { "description": "Status of the workflow, ex: Open, Closed - READ ONLY", "enum": [ "open", "closed" ], "type": "string", "x-nullable": true }, "workflowTemplateId": { "format": "int32", "description": "Id of the workflow template for the workflow", "type": "integer", "x-nullable": true } }, "additionalProperties": false }, "WorkflowLoanMapping": { "description": "Represents a Workflow Loan Mapping in Sageworks", "type": "object", "properties": { "id": { "format": "int32", "description": "Id of the workflow loan mapping in Sageworks", "type": "integer" }, "loanId": { "format": "int64", "description": "Id of the loan mapped to a workflow", "type": "integer" }, "loanType": { "format": "string", "description": "Type of loan (ex: portfolio, proposed)", "enum": [ "portfolio", "proposed" ], "type": "string" }, "workflowId": { "format": "int32", "description": "Id of the workflow mapped to a loan", "type": "integer" } }, "additionalProperties": false }, "WorkflowPhase": { "description": "Represents a WorkflowPhase in Sageworks", "type": "object", "properties": { "id": { "format": "int32", "description": "ID of workflow phase in Sageworks", "type": "integer" }, "isDeleted": { "description": "Indicates if this workflow phase has been deleted", "type": "boolean" }, "name": { "description": "Name of workflow phase in Sageworks", "type": "string" }, "workflowId": { "format": "int32", "description": "ID of associated workflow in Sageworks", "type": "integer" } }, "additionalProperties": false }, "WorkflowReasonOption": { "description": "Represents a WorkflowReasonOptions in Sageworks", "type": "object", "properties": { "id": { "format": "int32", "description": "ID of the workflow reason in Sageworks", "type": "integer" }, "isDeleted": { "description": "Indicates if this workflow reason option has been deleted", "type": "boolean" }, "reason": { "description": "Reason for workflow in Sageworks", "type": "string" } }, "additionalProperties": false }, "WorkflowReasonOptionMapping": { "description": "Represents a WorkflowReasonOptionMappings in Sageworks", "type": "object", "properties": { "id": { "format": "int32", "description": "ID of workflow reason option mapping in Sageworks", "type": "integer" }, "workflowReasonOptionsId": { "format": "int32", "description": "ID of associated workflowsreasonoptions in Sageworks", "type": "integer" }, "workflowsId": { "format": "int32", "description": "ID of associated workflow in Sageworks", "type": "integer" } }, "additionalProperties": false }, "WorkflowRoleAssignmentsResponse": { "description": "Represents a WorkflowRoleAssignmentsResponse in Sageworks", "type": "object", "properties": { "userRoleAssignments": { "description": "Lists all RoleIds and their corresponding UserIds", "type": "array", "items": { "$ref": "#/definitions/WorkflowUserRoleAssignment" } } }, "additionalProperties": false }, "WorkflowRoleUserSetting": { "description": "Represents a Workflow Role User Setting in Sageworks", "type": "object", "properties": { "id": { "format": "int32", "description": "Id of the workflow role user setting", "type": "integer" }, "isDefault": { "description": "Whether the setting is the default", "type": "boolean" }, "userId": { "format": "int32", "description": "User Id in Sageworks", "type": "integer" }, "workflowRoleId": { "format": "int32", "description": "Workflow Role Id in Sageworks", "type": "integer" } }, "additionalProperties": false }, "WorkflowStep": { "description": "Represents a Workflow Step in Sageworks", "type": "object", "properties": { "dueDate": { "format": "Date", "description": "Date the step is due", "type": "string", "x-nullable": true }, "id": { "format": "int32", "description": "Id of the workflow step in Sageworks - READ ONLY", "type": "integer" }, "isDeleted": { "description": "Whether the step has been deleted", "type": "boolean" }, "name": { "description": "Name of the workflow step", "type": "string" }, "notes": { "description": "Notes specific to the workflow step in Sageworks", "type": "string" }, "status": { "description": "Status of the workflow step, ex: outstanding, approved, waived, etc.\r\nNote: A status of notRequired is not applicable for all organizations.", "enum": [ "pending", "outstanding", "completed", "waived", "approved", "notApproved", "notRequired", "notApplicable", "running" ], "type": "string", "x-nullable": true }, "statusChangedDate": { "format": "Date", "description": "Date and time when the status of the workflow step was last changed.", "type": "string", "x-nullable": true }, "stepType": { "description": "Type of the workflow step, ex: task, list, approval", "enum": [ "task", "list", "approval", "form", "automation", "agent" ], "type": "string", "x-nullable": true }, "workflowId": { "format": "int32", "description": "Id of the workflow to which the workflow step belongs", "type": "integer" }, "workflowPhaseId": { "format": "int32", "description": "Id of the workflow phase in Sageworks", "type": "integer" } }, "additionalProperties": false }, "WorkflowStepListItem": { "description": "Represents a Workflow Step List Item in Sageworks", "type": "object", "properties": { "completionDate": { "format": "Date", "description": "The date and time when the workflow step was completed, if applicable.", "type": "string", "x-nullable": true }, "id": { "format": "int32", "description": "Id of the workflow step in Sageworks - READ ONLY", "type": "integer" }, "isDeleted": { "description": "Whether the step has been deleted", "type": "boolean" }, "name": { "description": "Name of the workflow step list item", "type": "string" }, "notes": { "description": "Notes specific to the workflow step list item in Sageworks", "type": "string" }, "status": { "format": "string", "description": "Status of the workflow step list item, ex: outstanding, completed, waived", "enum": [ "outstanding", "completed", "waived", "notApplicable" ], "type": "string" }, "workflowStepId": { "format": "int32", "description": "Id of the workflow step to which the workflow step list item belongs", "type": "integer" } }, "additionalProperties": false }, "WorkflowStepListItemStatusUpdateRequest": { "description": "Information required to update the status and notes for a workflow step list item", "type": "object", "properties": { "notes": { "description": "Notes on the workflow step list item", "type": "string" }, "status": { "format": "string", "description": "Status of the workflow step list item", "enum": [ "outstanding", "completed", "waived", "notApplicable" ], "type": "string" } }, "additionalProperties": false }, "WorkflowStepOwnerMapping": { "description": "Represents a Workflow Step Owner Mapping in Sageworks", "type": "object", "properties": { "id": { "format": "int32", "description": "Id of the workflow step owner mapping in Sageworks", "type": "integer" }, "ownerUserId": { "format": "int64", "description": "UserId of the owner mapped to a workflow step", "type": "integer" }, "workflowStepId": { "format": "int32", "description": "Id of the workflow step mapped to an owner", "type": "integer" } }, "additionalProperties": false }, "WorkflowStepOwnerRole": { "description": "A workflow step owner role in Sageworks", "type": "object", "properties": { "id": { "format": "int32", "description": "ID of workflow step owner role in Sageworks", "type": "integer" }, "roleName": { "description": "Name of the role in Sageworks", "type": "string" } }, "additionalProperties": false }, "WorkflowStepResponseExample": { "type": "object", "additionalProperties": false }, "WorkflowStepStatusUpdateRequest": { "description": "Information required to start a workflow", "type": "object", "properties": { "notes": { "description": "Notes on the workflow step", "type": "string" }, "status": { "format": "string", "description": "Status of the workflow step", "enum": [ "pending", "outstanding", "completed", "waived", "approved", "notApproved", "notRequired", "notApplicable", "running" ], "type": "string" } }, "additionalProperties": false }, "WorkflowTemplate": { "description": "Represents a workflow template", "type": "object", "properties": { "id": { "format": "int32", "description": "Workflow template ID in Sageworks", "type": "integer" }, "isPublished": { "description": "Published status of the template version", "type": "boolean" }, "name": { "description": "Workflow template name", "type": "string" } }, "additionalProperties": false }, "WorkflowTemplatePhase": { "description": "Represents a workflow template", "type": "object", "properties": { "id": { "format": "int32", "description": "Workflow template phase ID in Sageworks", "type": "integer" }, "isDeleted": { "description": "Whether the workflow template phase is deleted", "type": "boolean" }, "isOptional": { "description": "Whether the workflow template phase is optional", "type": "boolean" }, "name": { "description": "Workflow template phase name", "type": "string" }, "position": { "format": "int32", "description": "Workflow template phase position", "type": "integer" }, "type": { "format": "string", "description": "Workflow template phase type (e.g. standard, final approval)", "enum": [ "standard", "finalApproval", "fas5", "fas114", "fas91", "sop", "fas114Individual" ], "type": "string" }, "workflowTemplateId": { "format": "int32", "description": "WorkflowTemplateId of the workflow this phase belongs to", "type": "integer", "x-nullable": true } }, "additionalProperties": false }, "WorkflowUserRoleAssignment": { "description": "Represents a WorkflowUserRoleAssignment in Sageworks", "type": "object", "properties": { "roleId": { "format": "int64", "description": "Represents a role in Sageworks", "type": "integer" }, "usersId": { "format": "int64", "description": "UsersIds for the given role", "type": "integer", "x-nullable": true } }, "additionalProperties": false } }, "securityDefinitions": { "oauth2": { "type": "oauth2", "flow": "application", "tokenUrl": "https://auth.sageworks.com/connect/token" } } }