GET api/entities/{entityId}/glAccounts?activeOnly={activeOnly}

Get gl accounts linked to entity

Request Information

URI Parameters

Name	Description	Type	Additional information
entityId		integer	Required
activeOnly		boolean	Default value is False

Body Parameters

None.

Response Information

Resource Description

Collection of GLAccountViewModelExtended

Name	Description	Type	Additional information
SubAccounts		Collection of GLSubAccountViewModel	None.
TotalSubAccounts		integer	None.
GLAccountId	GL Account Id	integer	None.
GLAccountNumber	GL Account Number	string	None.
Description	Description	string	None.
IsBalance		boolean	None.
Is1099Account		boolean	None.
Active		boolean	None.
BudgetCheck		boolean	None.
IsAssigned		boolean	None.
IsChargeCodeAssigned		boolean	None.
isGlAccountExists		boolean	None.
TotalLinkedEntities		integer	None.
GlAccountType		GlAccountTypeViewModel	None.
GlAccountTypeCategory		GlAccountTypeCategoryViewModel	None.
GlAccountTypeSubCategory		GlAccountTypeSubCategoryViewModel	None.
DisplayAccount	Display account	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "subAccounts": [
      {
        "glSubAccountId": 1,
        "glAccountId": 2,
        "subAccountName": "sample string 3",
        "description": "sample string 4"
      },
      {
        "glSubAccountId": 1,
        "glAccountId": 2,
        "subAccountName": "sample string 3",
        "description": "sample string 4"
      }
    ],
    "totalSubAccounts": 2,
    "glAccountId": 1,
    "glAccountNumber": "sample string 2",
    "description": "sample string 3",
    "isBalance": true,
    "is1099Account": true,
    "active": true,
    "budgetCheck": true,
    "isAssigned": true,
    "isChargeCodeAssigned": true,
    "isGlAccountExists": true,
    "totalLinkedEntities": 1,
    "glAccountType": {
      "id": 1,
      "name": "sample string 2",
      "description": "sample string 3"
    },
    "glAccountTypeCategory": {
      "id": 1,
      "glAccountTypeId": 2,
      "name": "sample string 3",
      "description": "sample string 4",
      "entityCategoryName": "sample string 5"
    },
    "glAccountTypeSubCategory": {
      "id": 1,
      "glAccountTypeCategoryId": 2,
      "name": "sample string 3",
      "description": "sample string 4",
      "entitySubCategoryName": "sample string 5"
    },
    "displayAccount": "sample string 2 - sample string 3"
  },
  {
    "subAccounts": [
      {
        "glSubAccountId": 1,
        "glAccountId": 2,
        "subAccountName": "sample string 3",
        "description": "sample string 4"
      },
      {
        "glSubAccountId": 1,
        "glAccountId": 2,
        "subAccountName": "sample string 3",
        "description": "sample string 4"
      }
    ],
    "totalSubAccounts": 2,
    "glAccountId": 1,
    "glAccountNumber": "sample string 2",
    "description": "sample string 3",
    "isBalance": true,
    "is1099Account": true,
    "active": true,
    "budgetCheck": true,
    "isAssigned": true,
    "isChargeCodeAssigned": true,
    "isGlAccountExists": true,
    "totalLinkedEntities": 1,
    "glAccountType": {
      "id": 1,
      "name": "sample string 2",
      "description": "sample string 3"
    },
    "glAccountTypeCategory": {
      "id": 1,
      "glAccountTypeId": 2,
      "name": "sample string 3",
      "description": "sample string 4",
      "entityCategoryName": "sample string 5"
    },
    "glAccountTypeSubCategory": {
      "id": 1,
      "glAccountTypeCategoryId": 2,
      "name": "sample string 3",
      "description": "sample string 4",
      "entitySubCategoryName": "sample string 5"
    },
    "displayAccount": "sample string 2 - sample string 3"
  }
]

application/xml, text/xml

Sample:

<ArrayOfGLAccountViewModelExtended xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels">
  <GLAccountViewModelExtended>
    <Active>true</Active>
    <BudgetCheck>true</BudgetCheck>
    <Description>sample string 3</Description>
    <GLAccountId>1</GLAccountId>
    <GLAccountNumber>sample string 2</GLAccountNumber>
    <GlAccountType xmlns:d3p1="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.GlAccounts">
      <d3p1:Description>sample string 3</d3p1:Description>
      <d3p1:Id>1</d3p1:Id>
      <d3p1:Name>sample string 2</d3p1:Name>
    </GlAccountType>
    <GlAccountTypeCategory xmlns:d3p1="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.GlAccounts">
      <d3p1:Description>sample string 4</d3p1:Description>
      <d3p1:EntityCategoryName>sample string 5</d3p1:EntityCategoryName>
      <d3p1:GlAccountTypeId>2</d3p1:GlAccountTypeId>
      <d3p1:Id>1</d3p1:Id>
      <d3p1:Name>sample string 3</d3p1:Name>
    </GlAccountTypeCategory>
    <GlAccountTypeSubCategory xmlns:d3p1="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.GlAccounts">
      <d3p1:Description>sample string 4</d3p1:Description>
      <d3p1:EntitySubCategoryName>sample string 5</d3p1:EntitySubCategoryName>
      <d3p1:GlAccountTypeCategoryId>2</d3p1:GlAccountTypeCategoryId>
      <d3p1:Id>1</d3p1:Id>
      <d3p1:Name>sample string 3</d3p1:Name>
    </GlAccountTypeSubCategory>
    <Is1099Account>true</Is1099Account>
    <IsAssigned>true</IsAssigned>
    <IsBalance>true</IsBalance>
    <IsChargeCodeAssigned>true</IsChargeCodeAssigned>
    <TotalLinkedEntities>1</TotalLinkedEntities>
    <TotalSubAccounts>0</TotalSubAccounts>
    <isGlAccountExists>true</isGlAccountExists>
    <SubAccounts>
      <GLSubAccountViewModel>
        <Description>sample string 4</Description>
        <SubAccountName>sample string 3</SubAccountName>
        <GLAccountId>2</GLAccountId>
        <GLSubAccountId>1</GLSubAccountId>
      </GLSubAccountViewModel>
      <GLSubAccountViewModel>
        <Description>sample string 4</Description>
        <SubAccountName>sample string 3</SubAccountName>
        <GLAccountId>2</GLAccountId>
        <GLSubAccountId>1</GLSubAccountId>
      </GLSubAccountViewModel>
    </SubAccounts>
  </GLAccountViewModelExtended>
  <GLAccountViewModelExtended>
    <Active>true</Active>
    <BudgetCheck>true</BudgetCheck>
    <Description>sample string 3</Description>
    <GLAccountId>1</GLAccountId>
    <GLAccountNumber>sample string 2</GLAccountNumber>
    <GlAccountType xmlns:d3p1="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.GlAccounts">
      <d3p1:Description>sample string 3</d3p1:Description>
      <d3p1:Id>1</d3p1:Id>
      <d3p1:Name>sample string 2</d3p1:Name>
    </GlAccountType>
    <GlAccountTypeCategory xmlns:d3p1="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.GlAccounts">
      <d3p1:Description>sample string 4</d3p1:Description>
      <d3p1:EntityCategoryName>sample string 5</d3p1:EntityCategoryName>
      <d3p1:GlAccountTypeId>2</d3p1:GlAccountTypeId>
      <d3p1:Id>1</d3p1:Id>
      <d3p1:Name>sample string 3</d3p1:Name>
    </GlAccountTypeCategory>
    <GlAccountTypeSubCategory xmlns:d3p1="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.GlAccounts">
      <d3p1:Description>sample string 4</d3p1:Description>
      <d3p1:EntitySubCategoryName>sample string 5</d3p1:EntitySubCategoryName>
      <d3p1:GlAccountTypeCategoryId>2</d3p1:GlAccountTypeCategoryId>
      <d3p1:Id>1</d3p1:Id>
      <d3p1:Name>sample string 3</d3p1:Name>
    </GlAccountTypeSubCategory>
    <Is1099Account>true</Is1099Account>
    <IsAssigned>true</IsAssigned>
    <IsBalance>true</IsBalance>
    <IsChargeCodeAssigned>true</IsChargeCodeAssigned>
    <TotalLinkedEntities>1</TotalLinkedEntities>
    <TotalSubAccounts>0</TotalSubAccounts>
    <isGlAccountExists>true</isGlAccountExists>
    <SubAccounts>
      <GLSubAccountViewModel>
        <Description>sample string 4</Description>
        <SubAccountName>sample string 3</SubAccountName>
        <GLAccountId>2</GLAccountId>
        <GLSubAccountId>1</GLSubAccountId>
      </GLSubAccountViewModel>
      <GLSubAccountViewModel>
        <Description>sample string 4</Description>
        <SubAccountName>sample string 3</SubAccountName>
        <GLAccountId>2</GLAccountId>
        <GLSubAccountId>1</GLSubAccountId>
      </GLSubAccountViewModel>
    </SubAccounts>
  </GLAccountViewModelExtended>
</ArrayOfGLAccountViewModelExtended>