PUT api/entities/{id}/information?isCopyToTiersRequired={isCopyToTiersRequired}

Update Entity

Request Information

URI Parameters

Name	Description	Type	Additional information
id	Entity ID	integer	Required
isCopyToTiersRequired		boolean	Default value is False

Body Parameters

UpdateEntityInformationViewModel

Name	Type	Additional information
IsActive	boolean	None.
Name	string	None.
Number	string	None.
EntityNameForChecks	string	None.
FederalIdNumber	string	None.
IrsName	string	None.
Phone	string	None.
NumberOfUnits	integer	Required Range: inclusive between 0 and 2147483647
SuperEntity	SuperEntityInformationViewModel	None.
Address	AddressViewModel	None.
RSMGLEntityConfigurations	Collection of RSMGLEntityConfigurationViewModel	None.

Request Formats

application/json, text/json

Sample:

{
  "isActive": true,
  "name": "sample string 2",
  "number": "sample string 3",
  "entityNameForChecks": "sample string 4",
  "federalIdNumber": "sample string 5",
  "irsName": "sample string 6",
  "phone": "sample string 7",
  "numberOfUnits": 1,
  "superEntity": {
    "id": 1,
    "name": "sample string 2",
    "defaultGLEntityID": 3,
    "useCombinedCashEntity": true,
    "combinedCashEntityID": 5,
    "managementCompanyId": 6
  },
  "address": {
    "addressId": 1,
    "address1": "sample string 2",
    "address2": "sample string 3",
    "city": "sample string 4",
    "state": "sample string 5",
    "zipCode": "sample string 6",
    "country": "sample string 7"
  },
  "rsmglEntityConfigurations": [
    {
      "entityId": 1,
      "includeInFinancials": true,
      "entityNumber": "sample string 3"
    },
    {
      "entityId": 1,
      "includeInFinancials": true,
      "entityNumber": "sample string 3"
    }
  ]
}

application/xml, text/xml

Sample:

<UpdateEntityInformationViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels">
  <Address>
    <Address1 xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.Address">sample string 2</Address1>
    <Address2 xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.Address">sample string 3</Address2>
    <City xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.Address">sample string 4</City>
    <Country xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.Address">sample string 7</Country>
    <State xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.Address">sample string 5</State>
    <ZipCode xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.Address">sample string 6</ZipCode>
    <AddressId>1</AddressId>
  </Address>
  <EntityNameForChecks>sample string 4</EntityNameForChecks>
  <FederalIdNumber>sample string 5</FederalIdNumber>
  <IrsName>sample string 6</IrsName>
  <IsActive>true</IsActive>
  <Name>sample string 2</Name>
  <Number>sample string 3</Number>
  <NumberOfUnits>1</NumberOfUnits>
  <Phone>sample string 7</Phone>
  <RSMGLEntityConfigurations>
    <RSMGLEntityConfigurationViewModel>
      <EntityId>1</EntityId>
      <EntityNumber>sample string 3</EntityNumber>
      <IncludeInFinancials>true</IncludeInFinancials>
    </RSMGLEntityConfigurationViewModel>
    <RSMGLEntityConfigurationViewModel>
      <EntityId>1</EntityId>
      <EntityNumber>sample string 3</EntityNumber>
      <IncludeInFinancials>true</IncludeInFinancials>
    </RSMGLEntityConfigurationViewModel>
  </RSMGLEntityConfigurations>
  <SuperEntity>
    <CombinedCashEntityID>5</CombinedCashEntityID>
    <DefaultGLEntityID>3</DefaultGLEntityID>
    <Id>1</Id>
    <ManagementCompanyId>6</ManagementCompanyId>
    <UseCombinedCashEntity>true</UseCombinedCashEntity>
    <name>sample string 2</name>
  </SuperEntity>
</UpdateEntityInformationViewModel>

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

Response Information

Resource Description

EntityViewModel

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.