Request Information

URI Parameters

NameDescriptionTypeAdditional information
userCommissionId

The user commission identifier.

integer

Required

Body Parameters

The user commission.

Pico.UserCommission
NameDescriptionTypeAdditional information
accountingCode

Gets or sets the accounting code.

string

None.

amount

Gets or sets the amount.

decimal number

None.

applicableStatus

Gets or sets the applicable status.

string

None.

basisPoints

Gets or sets the basis point.

decimal number

None.

endDate

Gets or sets the end date.

date

None.

endDateDialsUpdate

Gets or sets end date update.

date

None.

isActive

Gets or sets a value indicating whether user commission is active.

boolean

None.

isUpdateEndDate

Gets or sets a value indicating whether end date is null.

boolean

None.

loanPurpose

Gets or sets the loan purpose.

string

None.

maxDollarAmount

Gets or sets the max dollar amount.

decimal number

None.

maxLoanAmount

Gets or sets the max loan amount.

decimal number

None.

minLoanAmount

Gets or sets the min loan amount.

decimal number

None.

startDate

Gets or sets the start date.

date

None.

id

Gets or sets the user commission id.

integer

None.

commissionBasisType

Gets or sets the commission basis type.

integer

None.

loanProductGroup

Gets or sets the loan product group.

integer

None.

role

Gets or sets the role.

integer

None.

rootOrganization

Gets or sets the root organization.

integer

None.

user

Gets or sets the user id.

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "accountingCode": "sample String 1",
  "amount": 1.0,
  "applicableStatus": "sample String 2",
  "basisPoints": 1.0,
  "endDate": "2025-04-26T00:21:30.418715Z",
  "endDateDialsUpdate": "2025-04-26T00:21:30.418715Z",
  "isActive": true,
  "isUpdateEndDate": true,
  "loanPurpose": "sample String 5",
  "maxDollarAmount": 1.0,
  "maxLoanAmount": 1.0,
  "minLoanAmount": 1.0,
  "startDate": "2025-04-26T00:21:30.4193971Z",
  "id": "6",
  "commissionBasisType": "1",
  "loanProductGroup": "1",
  "role": "1",
  "rootOrganization": "1",
  "user": "7"
}

text/html

Sample:
{"accountingCode":"sample String 1","amount":1.0,"applicableStatus":"sample String 2","basisPoints":1.0,"endDate":"2025-04-26T00:21:30.418715Z","endDateDialsUpdate":"2025-04-26T00:21:30.418715Z","isActive":true,"isUpdateEndDate":true,"loanPurpose":"sample String 5","maxDollarAmount":1.0,"maxLoanAmount":1.0,"minLoanAmount":1.0,"startDate":"2025-04-26T00:21:30.4193971Z","id":"6","commissionBasisType":"1","loanProductGroup":"1","role":"1","rootOrganization":"1","user":"7"}

application/xml, text/xml

Sample:
<UserCommission xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <AccountingCode>sample String 1</AccountingCode>
  <Amount>1</Amount>
  <ApplicableStatus>sample String 2</ApplicableStatus>
  <BasisPoints>1</BasisPoints>
  <EndDate>2025-04-26T00:21:30.418715Z</EndDate>
  <EndDateDialsUpdate>2025-04-26T00:21:30.418715Z</EndDateDialsUpdate>
  <IsActive>true</IsActive>
  <IsUpdateEndDate>true</IsUpdateEndDate>
  <LoanPurpose>sample String 5</LoanPurpose>
  <MaxDollarAmount>1</MaxDollarAmount>
  <MaxLoanAmount>1</MaxLoanAmount>
  <MinLoanAmount>1</MinLoanAmount>
  <StartDate>2025-04-26T00:21:30.4193971Z</StartDate>
  <UserCommissionId>6</UserCommissionId>
  <CommissionBasisTypeId>1</CommissionBasisTypeId>
  <LoanProductGroupId>1</LoanProductGroupId>
  <RoleId>1</RoleId>
  <RootOrganizationId>1</RootOrganizationId>
  <UserId>7</UserId>
</UserCommission>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

The updated user commission.

Pico.UserCommission
NameDescriptionTypeAdditional information
accountingCode

Gets or sets the accounting code.

string

None.

amount

Gets or sets the amount.

decimal number

None.

applicableStatus

Gets or sets the applicable status.

string

None.

basisPoints

Gets or sets the basis point.

decimal number

None.

endDate

Gets or sets the end date.

date

None.

endDateDialsUpdate

Gets or sets end date update.

date

None.

isActive

Gets or sets a value indicating whether user commission is active.

boolean

None.

isUpdateEndDate

Gets or sets a value indicating whether end date is null.

boolean

None.

loanPurpose

Gets or sets the loan purpose.

string

None.

maxDollarAmount

Gets or sets the max dollar amount.

decimal number

None.

maxLoanAmount

Gets or sets the max loan amount.

decimal number

None.

minLoanAmount

Gets or sets the min loan amount.

decimal number

None.

startDate

Gets or sets the start date.

date

None.

id

Gets or sets the user commission id.

integer

None.

commissionBasisType

Gets or sets the commission basis type.

integer

None.

loanProductGroup

Gets or sets the loan product group.

integer

None.

role

Gets or sets the role.

integer

None.

rootOrganization

Gets or sets the root organization.

integer

None.

user

Gets or sets the user id.

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "accountingCode": "sample String 1",
  "amount": 1.0,
  "applicableStatus": "sample String 2",
  "basisPoints": 1.0,
  "endDate": "2025-04-26T00:21:30.4428762Z",
  "endDateDialsUpdate": "2025-04-26T00:21:30.4428762Z",
  "isActive": true,
  "isUpdateEndDate": true,
  "loanPurpose": "sample String 5",
  "maxDollarAmount": 1.0,
  "maxLoanAmount": 1.0,
  "minLoanAmount": 1.0,
  "startDate": "2025-04-26T00:21:30.4428762Z",
  "id": "6",
  "commissionBasisType": "1",
  "loanProductGroup": "1",
  "role": "1",
  "rootOrganization": "1",
  "user": "7"
}

text/html

Sample:
{"accountingCode":"sample String 1","amount":1.0,"applicableStatus":"sample String 2","basisPoints":1.0,"endDate":"2025-04-26T00:21:30.4428762Z","endDateDialsUpdate":"2025-04-26T00:21:30.4428762Z","isActive":true,"isUpdateEndDate":true,"loanPurpose":"sample String 5","maxDollarAmount":1.0,"maxLoanAmount":1.0,"minLoanAmount":1.0,"startDate":"2025-04-26T00:21:30.4428762Z","id":"6","commissionBasisType":"1","loanProductGroup":"1","role":"1","rootOrganization":"1","user":"7"}

application/xml, text/xml

Sample:
<UserCommission xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <AccountingCode>sample String 1</AccountingCode>
  <Amount>1</Amount>
  <ApplicableStatus>sample String 2</ApplicableStatus>
  <BasisPoints>1</BasisPoints>
  <EndDate>2025-04-26T00:21:30.4428762Z</EndDate>
  <EndDateDialsUpdate>2025-04-26T00:21:30.4428762Z</EndDateDialsUpdate>
  <IsActive>true</IsActive>
  <IsUpdateEndDate>true</IsUpdateEndDate>
  <LoanPurpose>sample String 5</LoanPurpose>
  <MaxDollarAmount>1</MaxDollarAmount>
  <MaxLoanAmount>1</MaxLoanAmount>
  <MinLoanAmount>1</MinLoanAmount>
  <StartDate>2025-04-26T00:21:30.4428762Z</StartDate>
  <UserCommissionId>6</UserCommissionId>
  <CommissionBasisTypeId>1</CommissionBasisTypeId>
  <LoanProductGroupId>1</LoanProductGroupId>
  <RoleId>1</RoleId>
  <RootOrganizationId>1</RootOrganizationId>
  <UserId>7</UserId>
</UserCommission>