GET api/entities/selector?active={active}&isShadow={isShadow}&includeInFinancials={includeInFinancials}

Entity Selector that returns minimum information

Request Information

URI Parameters

Name	Type	Additional information
active	boolean	None.
isShadow	boolean	None.
includeInFinancials	boolean	None.

Body Parameters

None.

Response Information

Resource Description

EntitySelectorViewModel

Collection of EntitySelectorViewModel

Name	Description	Type	Additional information
Id	Entity Id	integer	None.
EntityNumber	Entity Number	string	None.
EntityType	Entity Type	string	None.
Name	Entity Name	string	None.
SuperEntityId	Super Entity Id	integer	None.
IsShadow	Is Shadow flag.	boolean	None.
IsConsolidated	Is Consolidated Flag	boolean	None.
ApPostOutsidePeriod	AP_Post_Outside_Period	boolean	None.
ArPostOutsidePeriod	AR_Post_Outside_Period column	boolean	None.
BoardApprovalId	BoardApprovalId column	integer	None.
AccountingPeriodCodeId	period code	AccountingPeriodCode	None.
IsActive	IsActive	boolean	None.
IsCheckExport		boolean	None.
IsAutomatedCheckIssuanceRestricted	Is Automated Check Issuance Restricted	boolean	None.
IncludeInFinancials		boolean	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "id": 1,
    "entityNumber": "sample string 2",
    "entityType": "sample string 3",
    "name": "sample string 4",
    "superEntityId": 5,
    "isShadow": true,
    "isConsolidated": true,
    "apPostOutsidePeriod": true,
    "arPostOutsidePeriod": true,
    "boardApprovalId": 10,
    "accountingPeriodCodeId": 0,
    "isActive": true,
    "isCheckExport": true,
    "isAutomatedCheckIssuanceRestricted": true,
    "includeInFinancials": true
  },
  {
    "id": 1,
    "entityNumber": "sample string 2",
    "entityType": "sample string 3",
    "name": "sample string 4",
    "superEntityId": 5,
    "isShadow": true,
    "isConsolidated": true,
    "apPostOutsidePeriod": true,
    "arPostOutsidePeriod": true,
    "boardApprovalId": 10,
    "accountingPeriodCodeId": 0,
    "isActive": true,
    "isCheckExport": true,
    "isAutomatedCheckIssuanceRestricted": true,
    "includeInFinancials": true
  }
]

application/xml, text/xml

Sample:

<ArrayOfEntitySelectorViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels">
  <EntitySelectorViewModel>
    <AccountingPeriodCodeId>None</AccountingPeriodCodeId>
    <ApPostOutsidePeriod>true</ApPostOutsidePeriod>
    <ArPostOutsidePeriod>true</ArPostOutsidePeriod>
    <BoardApprovalId>10</BoardApprovalId>
    <EntityNumber>sample string 2</EntityNumber>
    <EntityType>sample string 3</EntityType>
    <Id>1</Id>
    <IncludeInFinancials>true</IncludeInFinancials>
    <IsActive>true</IsActive>
    <IsAutomatedCheckIssuanceRestricted>true</IsAutomatedCheckIssuanceRestricted>
    <IsCheckExport>true</IsCheckExport>
    <IsConsolidated>true</IsConsolidated>
    <IsShadow>true</IsShadow>
    <Name>sample string 4</Name>
    <SuperEntityId>5</SuperEntityId>
  </EntitySelectorViewModel>
  <EntitySelectorViewModel>
    <AccountingPeriodCodeId>None</AccountingPeriodCodeId>
    <ApPostOutsidePeriod>true</ApPostOutsidePeriod>
    <ArPostOutsidePeriod>true</ArPostOutsidePeriod>
    <BoardApprovalId>10</BoardApprovalId>
    <EntityNumber>sample string 2</EntityNumber>
    <EntityType>sample string 3</EntityType>
    <Id>1</Id>
    <IncludeInFinancials>true</IncludeInFinancials>
    <IsActive>true</IsActive>
    <IsAutomatedCheckIssuanceRestricted>true</IsAutomatedCheckIssuanceRestricted>
    <IsCheckExport>true</IsCheckExport>
    <IsConsolidated>true</IsConsolidated>
    <IsShadow>true</IsShadow>
    <Name>sample string 4</Name>
    <SuperEntityId>5</SuperEntityId>
  </EntitySelectorViewModel>
</ArrayOfEntitySelectorViewModel>