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

Update Entity information

Request Information

URI Parameters

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

Body Parameters

UpdateEntityPeriodCloseViewModel

Name	Type	Additional information
EntityType	string	None.
FiscalYearEnd	date	None.
AccountingPeriodCodeId	integer	None.
InterCompanyAccount	integer	None.
ClosingChartOfAccountsID	integer	None.
ClosingGLSubAccountID	integer	None.
Complexity	decimal number	None.
PeriodCloseFrequencyID	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "entityType": "sample string 1",
  "fiscalYearEnd": "2025-04-03T18:05:56.7437031-04:00",
  "accountingPeriodCodeId": 2,
  "interCompanyAccount": 3,
  "closingChartOfAccountsID": 4,
  "closingGLSubAccountID": 1,
  "complexity": 1.0,
  "periodCloseFrequencyID": 1
}

application/xml, text/xml

Sample:

<UpdateEntityPeriodCloseViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels">
  <AccountingPeriodCodeId>2</AccountingPeriodCodeId>
  <ClosingChartOfAccountsID>4</ClosingChartOfAccountsID>
  <ClosingGLSubAccountID>1</ClosingGLSubAccountID>
  <Complexity>1</Complexity>
  <EntityType>sample string 1</EntityType>
  <FiscalYearEnd>2025-04-03T18:05:56.7437031-04:00</FiscalYearEnd>
  <InterCompanyAccount>3</InterCompanyAccount>
  <PeriodCloseFrequencyID>1</PeriodCloseFrequencyID>
</UpdateEntityPeriodCloseViewModel>

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

Response Information

Resource Description

Collection of EntityViewModel

Name	Description	Type	Additional information
Id	Entity Id	integer	None.
Name	Name	string	None.
IsActive	Is Active	boolean	None.
IsShadow	Is Shadow	integer	None.
EntityNumber	Entity Number	string	None.
EntityType	Entity Number	string	None.
FiscalYearEnd		date	None.
FederalIdNumber	Federal Id Number	string	None.
Phone	Phone	string	None.
NumberOfShares	Number of shares that lives on the units	decimal number	None.
SuperEntityId	Super Entity Id	integer	None.
EntityNameForChecks	Entity Name For Checks	string	None.
DefaultAPBank	Default AP Bank	integer	None.
ApPostOutsidePeriod	AP_Post_Outside_Period	boolean	None.
ArPostOutsidePeriod		boolean	None.
IsAutomatedCheckIssuanceRestricted		boolean	None.
IsAutoSignatureUsed		boolean	None.
IsAvidInvoiceApprovalUsed		boolean	None.
IsCheckExport		boolean	None.
BoardApprovalId		integer	None.
APAccount		integer	None.
APGlSubAccountID		integer	None.
InterCompanyAccount		integer	None.
ClosingChartOfAccountsID		integer	None.
ClosingGLSubAccountID		integer	None.
IsConsolidated		boolean	None.
Complexity		decimal number	None.
PeriodCloseFrequencyID		integer	None.
AccountingPeriodCodeId	period code	AccountingPeriodCode	None.
SuperEntity	Super Entity	SuperEntityViewModel	None.
Address		AddressViewModel	None.
BuildingList		Collection of BuildingViewModel	None.
IncludeInFinancials		boolean	None.