Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

The price adjustment identifier.

integer

Required

Body Parameters

The price adjustment.

Pico.PriceAdjustment
NameDescriptionTypeAdditional information
affectedEntity

Gets or sets the affected entity.

string

None.

amount

Gets or sets the amount.

decimal number

None.

endDate

Gets or sets the end date.

date

None.

escrowWaiver

Gets or sets a value indicating whether there is an escrow waiver.

boolean

None.

exceptionDescription

Gets or sets the exceptions description.

string

None.

exceptions

Gets or sets the exceptions.

string

None.

isActive

Gets or sets a value indicating whether this is active.

boolean

None.

isOverride

Gets or sets a value indicating whether this is override.

boolean

None.

loanPurpose

Gets or sets the loan purpose.

string

None.

lockPeriod

Gets or sets the lock period.

integer

None.

maxCLTV

Gets or sets the maximum CLTV.

decimal number

None.

maxCreditScore

Gets or sets the maximum credit score.

integer

None.

maxDollarAmount

Gets or sets the maximum dollar amount.

decimal number

None.

maxHCLTV

Gets or sets the maximum HCLTV.

decimal number

None.

maxLoanAmount

Gets or sets the maximum loan amount.

decimal number

None.

maxLTV

Gets or sets the maximum LTV.

decimal number

None.

maxRate

Gets or sets the maximum rate.

decimal number

None.

maxUnits

Gets or sets the maximum units.

integer

None.

minCLTV

Gets or sets the minimum CLTV.

decimal number

None.

minCreditScore

Gets or sets the minimum credit score.

integer

None.

minHCLTV

Gets or sets the minimum HCLTV.

decimal number

None.

minLoanAmount

Gets or sets the minimum loan amount.

decimal number

None.

minLTV

Gets or sets the minimum LTV.

decimal number

None.

minRate

Gets or sets the minimum rate.

decimal number

None.

minUnits

Gets or sets the minimum units.

integer

None.

occupancyType

Gets or sets the type of the occupancy.

string

None.

startDate

Gets or sets the start date.

date

None.

state

Gets or sets the state.

string

None.

source

Gets or sets the source.

string

None.

subordinateFinancing

Gets or sets a value indicating whether there is subordinate financing.

boolean

None.

brokerCompensationType

Gets or sets the broker compensation type identifier.

integer

None.

corporatePartner

Gets or sets the corporate partner identifier.

integer

None.

loanProductGroup

Gets or sets the loan product group identifier.

integer

None.

organization

Gets or sets the organization identifier.

integer

None.

id

Gets or sets the price adjustment identifier.

integer

None.

priceAdjustmentType

Gets or sets the price adjustment type identifier.

integer

None.

promotion

Gets or sets the promotion identifier.

integer

None.

propertyType

Gets or sets the property type identifier.

integer

None.

specialFeature

Gets or sets the special feature identifier.

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "affectedEntity": "sample String 1",
  "amount": 2.0,
  "endDate": "2025-04-26T00:45:02.074468Z",
  "escrowWaiver": true,
  "exceptionDescription": "sample String 4",
  "exceptions": "sample String 5",
  "isActive": true,
  "isOverride": true,
  "loanPurpose": "sample String 8",
  "lockPeriod": 1,
  "maxCLTV": 1.0,
  "maxCreditScore": 1,
  "maxDollarAmount": 1.0,
  "maxHCLTV": 1.0,
  "maxLoanAmount": 1.0,
  "maxLTV": 1.0,
  "maxRate": 1.0,
  "maxUnits": 1,
  "minCLTV": 1.0,
  "minCreditScore": 1,
  "minHCLTV": 1.0,
  "minLoanAmount": 1.0,
  "minLTV": 1.0,
  "minRate": 1.0,
  "minUnits": 1,
  "occupancyType": "sample String 9",
  "startDate": "2025-04-26T00:45:02.074468Z",
  "state": "sample String 10",
  "source": "sample String 11",
  "subordinateFinancing": true,
  "brokerCompensationType": 1,
  "corporatePartner": "1",
  "loanProductGroup": "13",
  "organization": "14",
  "id": "15",
  "priceAdjustmentType": "16",
  "promotion": "1",
  "propertyType": "1",
  "specialFeature": "1"
}

text/html

Sample:
{"affectedEntity":"sample String 1","amount":2.0,"endDate":"2025-04-26T00:45:02.074468Z","escrowWaiver":true,"exceptionDescription":"sample String 4","exceptions":"sample String 5","isActive":true,"isOverride":true,"loanPurpose":"sample String 8","lockPeriod":1,"maxCLTV":1.0,"maxCreditScore":1,"maxDollarAmount":1.0,"maxHCLTV":1.0,"maxLoanAmount":1.0,"maxLTV":1.0,"maxRate":1.0,"maxUnits":1,"minCLTV":1.0,"minCreditScore":1,"minHCLTV":1.0,"minLoanAmount":1.0,"minLTV":1.0,"minRate":1.0,"minUnits":1,"occupancyType":"sample String 9","startDate":"2025-04-26T00:45:02.074468Z","state":"sample String 10","source":"sample String 11","subordinateFinancing":true,"brokerCompensationType":1,"corporatePartner":"1","loanProductGroup":"13","organization":"14","id":"15","priceAdjustmentType":"16","promotion":"1","propertyType":"1","specialFeature":"1"}

application/xml, text/xml

Sample:
<PriceAdjustment xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <AffectedEntity>sample String 1</AffectedEntity>
  <Amount>2</Amount>
  <EndDate>2025-04-26T00:45:02.074468Z</EndDate>
  <EscrowWaiver>true</EscrowWaiver>
  <ExceptionDescription>sample String 4</ExceptionDescription>
  <Exceptions>sample String 5</Exceptions>
  <IsActive>true</IsActive>
  <IsOverride>true</IsOverride>
  <LoanPurpose>sample String 8</LoanPurpose>
  <LockPeriod>1</LockPeriod>
  <MaxCLTV>1</MaxCLTV>
  <MaxCreditScore>1</MaxCreditScore>
  <MaxDollarAmount>1</MaxDollarAmount>
  <MaxHCLTV>1</MaxHCLTV>
  <MaxLoanAmount>1</MaxLoanAmount>
  <MaxLTV>1</MaxLTV>
  <MaxRate>1</MaxRate>
  <MaxUnits>1</MaxUnits>
  <MinCLTV>1</MinCLTV>
  <MinCreditScore>1</MinCreditScore>
  <MinHCLTV>1</MinHCLTV>
  <MinLoanAmount>1</MinLoanAmount>
  <MinLTV>1</MinLTV>
  <MinRate>1</MinRate>
  <MinUnits>1</MinUnits>
  <OccupancyType>sample String 9</OccupancyType>
  <StartDate>2025-04-26T00:45:02.074468Z</StartDate>
  <State>sample String 10</State>
  <Source>sample String 11</Source>
  <SubordinateFinancing>true</SubordinateFinancing>
  <BrokerCompensationTypeId>1</BrokerCompensationTypeId>
  <CorporatePartnerId>1</CorporatePartnerId>
  <LoanProductGroupId>13</LoanProductGroupId>
  <OrganizationId>14</OrganizationId>
  <PriceAdjustmentId>15</PriceAdjustmentId>
  <PriceAdjustmentTypeId>16</PriceAdjustmentTypeId>
  <PromotionId>1</PromotionId>
  <PropertyTypeId>1</PropertyTypeId>
  <SpecialFeatureId>1</SpecialFeatureId>
</PriceAdjustment>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

The updated price adjustment.

Pico.PriceAdjustment
NameDescriptionTypeAdditional information
affectedEntity

Gets or sets the affected entity.

string

None.

amount

Gets or sets the amount.

decimal number

None.

endDate

Gets or sets the end date.

date

None.

escrowWaiver

Gets or sets a value indicating whether there is an escrow waiver.

boolean

None.

exceptionDescription

Gets or sets the exceptions description.

string

None.

exceptions

Gets or sets the exceptions.

string

None.

isActive

Gets or sets a value indicating whether this is active.

boolean

None.

isOverride

Gets or sets a value indicating whether this is override.

boolean

None.

loanPurpose

Gets or sets the loan purpose.

string

None.

lockPeriod

Gets or sets the lock period.

integer

None.

maxCLTV

Gets or sets the maximum CLTV.

decimal number

None.

maxCreditScore

Gets or sets the maximum credit score.

integer

None.

maxDollarAmount

Gets or sets the maximum dollar amount.

decimal number

None.

maxHCLTV

Gets or sets the maximum HCLTV.

decimal number

None.

maxLoanAmount

Gets or sets the maximum loan amount.

decimal number

None.

maxLTV

Gets or sets the maximum LTV.

decimal number

None.

maxRate

Gets or sets the maximum rate.

decimal number

None.

maxUnits

Gets or sets the maximum units.

integer

None.

minCLTV

Gets or sets the minimum CLTV.

decimal number

None.

minCreditScore

Gets or sets the minimum credit score.

integer

None.

minHCLTV

Gets or sets the minimum HCLTV.

decimal number

None.

minLoanAmount

Gets or sets the minimum loan amount.

decimal number

None.

minLTV

Gets or sets the minimum LTV.

decimal number

None.

minRate

Gets or sets the minimum rate.

decimal number

None.

minUnits

Gets or sets the minimum units.

integer

None.

occupancyType

Gets or sets the type of the occupancy.

string

None.

startDate

Gets or sets the start date.

date

None.

state

Gets or sets the state.

string

None.

source

Gets or sets the source.

string

None.

subordinateFinancing

Gets or sets a value indicating whether there is subordinate financing.

boolean

None.

brokerCompensationType

Gets or sets the broker compensation type identifier.

integer

None.

corporatePartner

Gets or sets the corporate partner identifier.

integer

None.

loanProductGroup

Gets or sets the loan product group identifier.

integer

None.

organization

Gets or sets the organization identifier.

integer

None.

id

Gets or sets the price adjustment identifier.

integer

None.

priceAdjustmentType

Gets or sets the price adjustment type identifier.

integer

None.

promotion

Gets or sets the promotion identifier.

integer

None.

propertyType

Gets or sets the property type identifier.

integer

None.

specialFeature

Gets or sets the special feature identifier.

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "affectedEntity": "sample String 1",
  "amount": 2.0,
  "endDate": "2025-04-26T00:45:02.0900945Z",
  "escrowWaiver": true,
  "exceptionDescription": "sample String 4",
  "exceptions": "sample String 5",
  "isActive": true,
  "isOverride": true,
  "loanPurpose": "sample String 8",
  "lockPeriod": 1,
  "maxCLTV": 1.0,
  "maxCreditScore": 1,
  "maxDollarAmount": 1.0,
  "maxHCLTV": 1.0,
  "maxLoanAmount": 1.0,
  "maxLTV": 1.0,
  "maxRate": 1.0,
  "maxUnits": 1,
  "minCLTV": 1.0,
  "minCreditScore": 1,
  "minHCLTV": 1.0,
  "minLoanAmount": 1.0,
  "minLTV": 1.0,
  "minRate": 1.0,
  "minUnits": 1,
  "occupancyType": "sample String 9",
  "startDate": "2025-04-26T00:45:02.0900945Z",
  "state": "sample String 10",
  "source": "sample String 11",
  "subordinateFinancing": true,
  "brokerCompensationType": 1,
  "corporatePartner": "1",
  "loanProductGroup": "13",
  "organization": "14",
  "id": "15",
  "priceAdjustmentType": "16",
  "promotion": "1",
  "propertyType": "1",
  "specialFeature": "1"
}

text/html

Sample:
{"affectedEntity":"sample String 1","amount":2.0,"endDate":"2025-04-26T00:45:02.0900945Z","escrowWaiver":true,"exceptionDescription":"sample String 4","exceptions":"sample String 5","isActive":true,"isOverride":true,"loanPurpose":"sample String 8","lockPeriod":1,"maxCLTV":1.0,"maxCreditScore":1,"maxDollarAmount":1.0,"maxHCLTV":1.0,"maxLoanAmount":1.0,"maxLTV":1.0,"maxRate":1.0,"maxUnits":1,"minCLTV":1.0,"minCreditScore":1,"minHCLTV":1.0,"minLoanAmount":1.0,"minLTV":1.0,"minRate":1.0,"minUnits":1,"occupancyType":"sample String 9","startDate":"2025-04-26T00:45:02.0900945Z","state":"sample String 10","source":"sample String 11","subordinateFinancing":true,"brokerCompensationType":1,"corporatePartner":"1","loanProductGroup":"13","organization":"14","id":"15","priceAdjustmentType":"16","promotion":"1","propertyType":"1","specialFeature":"1"}

application/xml, text/xml

Sample:
<PriceAdjustment xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <AffectedEntity>sample String 1</AffectedEntity>
  <Amount>2</Amount>
  <EndDate>2025-04-26T00:45:02.0900945Z</EndDate>
  <EscrowWaiver>true</EscrowWaiver>
  <ExceptionDescription>sample String 4</ExceptionDescription>
  <Exceptions>sample String 5</Exceptions>
  <IsActive>true</IsActive>
  <IsOverride>true</IsOverride>
  <LoanPurpose>sample String 8</LoanPurpose>
  <LockPeriod>1</LockPeriod>
  <MaxCLTV>1</MaxCLTV>
  <MaxCreditScore>1</MaxCreditScore>
  <MaxDollarAmount>1</MaxDollarAmount>
  <MaxHCLTV>1</MaxHCLTV>
  <MaxLoanAmount>1</MaxLoanAmount>
  <MaxLTV>1</MaxLTV>
  <MaxRate>1</MaxRate>
  <MaxUnits>1</MaxUnits>
  <MinCLTV>1</MinCLTV>
  <MinCreditScore>1</MinCreditScore>
  <MinHCLTV>1</MinHCLTV>
  <MinLoanAmount>1</MinLoanAmount>
  <MinLTV>1</MinLTV>
  <MinRate>1</MinRate>
  <MinUnits>1</MinUnits>
  <OccupancyType>sample String 9</OccupancyType>
  <StartDate>2025-04-26T00:45:02.0900945Z</StartDate>
  <State>sample String 10</State>
  <Source>sample String 11</Source>
  <SubordinateFinancing>true</SubordinateFinancing>
  <BrokerCompensationTypeId>1</BrokerCompensationTypeId>
  <CorporatePartnerId>1</CorporatePartnerId>
  <LoanProductGroupId>13</LoanProductGroupId>
  <OrganizationId>14</OrganizationId>
  <PriceAdjustmentId>15</PriceAdjustmentId>
  <PriceAdjustmentTypeId>16</PriceAdjustmentTypeId>
  <PromotionId>1</PromotionId>
  <PropertyTypeId>1</PropertyTypeId>
  <SpecialFeatureId>1</SpecialFeatureId>
</PriceAdjustment>