PUT api/entity1098parameters/{id}

Update an entity parameters

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

integer

Required

Body Parameters

Entity1098ParameterViewModel
NameDescriptionTypeAdditional information
Id

Parameter ID

integer

Range: inclusive between 1 and 2147483647

EntityId

Entity ID

integer

Required

Range: inclusive between 1 and 2147483647

Year

Export year. Must be current year or last year.

integer

Required

Range: inclusive between 2000 and 2999

CalculationMethodId

Calculation Method ID

integer

Required

Range: inclusive between 1 and 2147483647

BaseChargeCodeId

Base Charge Code ID

integer

None.

IsExported

Is Exported

boolean

None.

CreatedOn

Created On

date

None.

CreatedBy

Created By

integer

None.

ModifiedOn

Modified On

date

None.

ModifiedBy

Modified By

integer

None.

RealEstateTaxes

decimal number

None.

MortgageInterest

decimal number

None.

MortgageOriginationPrincipal

decimal number

None.

MortgageOriginationDate

date

None.

Request Formats

application/json, text/json

Sample:
{
  "id": 1,
  "entityId": 2,
  "year": 3,
  "calculationMethodId": 4,
  "baseChargeCodeId": 1,
  "isExported": true,
  "createdOn": "2024-10-14T08:25:33.9824046-04:00",
  "createdBy": 6,
  "modifiedOn": "2024-10-14T08:25:33.9824046-04:00",
  "modifiedBy": 1,
  "realEstateTaxes": 7.0,
  "mortgageInterest": 8.0,
  "mortgageOriginationPrincipal": 9.0,
  "mortgageOriginationDate": "2024-10-14T08:25:33.9824046-04:00"
}

application/xml, text/xml

Sample:
<Entity1098ParameterViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.Controllers.TAX.Models">
  <MortgageInterest xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels">8</MortgageInterest>
  <MortgageOriginationDate xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels">2024-10-14T08:25:33.9824046-04:00</MortgageOriginationDate>
  <MortgageOriginationPrincipal xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels">9</MortgageOriginationPrincipal>
  <RealEstateTaxes xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels">7</RealEstateTaxes>
  <BaseChargeCodeId>1</BaseChargeCodeId>
  <CalculationMethodId>4</CalculationMethodId>
  <CreatedBy>6</CreatedBy>
  <CreatedOn>2024-10-14T08:25:33.9824046-04:00</CreatedOn>
  <EntityId>2</EntityId>
  <Id>1</Id>
  <IsExported>true</IsExported>
  <ModifiedBy>1</ModifiedBy>
  <ModifiedOn>2024-10-14T08:25:33.9824046-04:00</ModifiedOn>
  <Year>3</Year>
</Entity1098ParameterViewModel>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'Entity1098ParameterViewModel'.

Response Information

Resource Description

boolean

Response Formats

application/json, text/json

Sample:
true

application/xml, text/xml

Sample:
<boolean xmlns="http://schemas.microsoft.com/2003/10/Serialization/">true</boolean>