PUT api/accounttypes

Update a AccountType. Returns Conflict (409) if the object is being referenced and updateReferences is set to false.

Request Information

URI Parameters

None.

Body Parameters

Update Model.

AccountTypeEditViewModel
NameDescriptionTypeAdditional information
UserId

User Id

integer

Range: inclusive between 1 and 1.79769313486232E+308

AccountTypeId

Account Type Id.

integer

Range: inclusive between 1 and 1.79769313486232E+308

Description

Description

string

Required

UpdateReferences

Update all Bank Accounts referencing this Account Use.

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "userId": 1,
  "accountTypeId": 2,
  "description": "sample string 3",
  "updateReferences": true
}

application/xml, text/xml

Sample:
<AccountTypeEditViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels">
  <AccountTypeId>2</AccountTypeId>
  <Description>sample string 3</Description>
  <UpdateReferences>true</UpdateReferences>
  <UserId>1</UserId>
</AccountTypeEditViewModel>

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 'AccountTypeEditViewModel'.

Response Information

Resource Description

AccountTypeViewModel
NameDescriptionTypeAdditional information
AccountTypeId

AccountTypeId

integer

None.

Description

Description

string

None.

IsUserEditable

IsUserEditable

boolean

None.

IsInterestBearingAccount

IsInterestBearingAccount

boolean

None.

IsDescriptionRequired

Required all fields

boolean

None.

CreatedOn

CreatedOn

date

None.

CreatedBy

CreatedBy

integer

None.

ModifiedOn

ModifiedOn

date

None.

ModifiedBy

ModifiedBy

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "accountTypeId": 1,
  "description": "sample string 2",
  "isUserEditable": true,
  "isInterestBearingAccount": true,
  "isDescriptionRequired": true,
  "createdOn": "2024-10-14T08:25:47.1847664-04:00",
  "createdBy": 7,
  "modifiedOn": "2024-10-14T08:25:47.1847664-04:00",
  "modifiedBy": 1
}

application/xml, text/xml

Sample:
<AccountTypeViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels">
  <AccountTypeId>1</AccountTypeId>
  <CreatedBy>7</CreatedBy>
  <CreatedOn>2024-10-14T08:25:47.1847664-04:00</CreatedOn>
  <Description>sample string 2</Description>
  <IsDescriptionRequired>true</IsDescriptionRequired>
  <IsInterestBearingAccount>true</IsInterestBearingAccount>
  <IsUserEditable>true</IsUserEditable>
  <ModifiedBy>1</ModifiedBy>
  <ModifiedOn>2024-10-14T08:25:47.1847664-04:00</ModifiedOn>
</AccountTypeViewModel>