GET api/Billing/BillingStructureEntityGroups?skip={skip}&take={take}&field={field}&reverse={reverse}&groupName={groupName}&billingStructureID={billingStructureID}&isAggregated={isAggregated}&entityCode={entityCode}&poliEntityId={poliEntityId}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
skip

integer

None.
take

integer

None.
field

string

None.
reverse

boolean

None.
groupName

string

None.
billingStructureID

integer

None.
isAggregated

boolean

None.
entityCode

string

None.
poliEntityId

globally unique identifier

None.

Body Parameters

None.

Response Information

Resource Description

PaginationOfBillingStructureEntityGroup
NameDescriptionTypeAdditional information
IsAllSuccess

boolean

None.
Items

Collection of BillingStructureEntityGroup

None.
UnPaginatedItems

Collection of BillingStructureEntityGroup

None.
FullCount

integer

None.
Skip

integer

None.
Take

integer

None.
Properties

Dictionary of string [key] and string [value]

None.

Response Formats

application/json, text/json

Sample: 
{
  "IsAllSuccess": true,
  "Items": [
    {
      "BillingStructureEntityGroupID": 1,
      "Name": "sample string 2",
      "BillingStructureID": 3,
      "BillingStructureName": "sample string 4",
      "IsAggregated": true,
      "StartDate": "2026-04-07T20:11:31.070162+10:00",
      "EndDate": "2026-04-07T20:11:31.070162+10:00",
      "FeeFreePeriodEnd": "2026-04-07T20:11:31.070162+10:00",
      "MemberCount": 8,
      "GroupEntities": [
        {
          "BillingStructureEntityGroupEntryID": 1,
          "BillingStructureEntityGroupID": 2,
          "POLiEntityID": "67b785a0-682b-4951-8950-6deed98aad81",
          "EntityCommonName": "sample string 4",
          "StartDate": "2026-04-07T20:11:31.070162+10:00",
          "EndDate": "2026-04-07T20:11:31.070162+10:00",
          "IsDefault": true
        },
        {
          "BillingStructureEntityGroupEntryID": 1,
          "BillingStructureEntityGroupID": 2,
          "POLiEntityID": "67b785a0-682b-4951-8950-6deed98aad81",
          "EntityCommonName": "sample string 4",
          "StartDate": "2026-04-07T20:11:31.070162+10:00",
          "EndDate": "2026-04-07T20:11:31.070162+10:00",
          "IsDefault": true
        }
      ]
    },
    {
      "BillingStructureEntityGroupID": 1,
      "Name": "sample string 2",
      "BillingStructureID": 3,
      "BillingStructureName": "sample string 4",
      "IsAggregated": true,
      "StartDate": "2026-04-07T20:11:31.070162+10:00",
      "EndDate": "2026-04-07T20:11:31.070162+10:00",
      "FeeFreePeriodEnd": "2026-04-07T20:11:31.070162+10:00",
      "MemberCount": 8,
      "GroupEntities": [
        {
          "BillingStructureEntityGroupEntryID": 1,
          "BillingStructureEntityGroupID": 2,
          "POLiEntityID": "67b785a0-682b-4951-8950-6deed98aad81",
          "EntityCommonName": "sample string 4",
          "StartDate": "2026-04-07T20:11:31.070162+10:00",
          "EndDate": "2026-04-07T20:11:31.070162+10:00",
          "IsDefault": true
        },
        {
          "BillingStructureEntityGroupEntryID": 1,
          "BillingStructureEntityGroupID": 2,
          "POLiEntityID": "67b785a0-682b-4951-8950-6deed98aad81",
          "EntityCommonName": "sample string 4",
          "StartDate": "2026-04-07T20:11:31.070162+10:00",
          "EndDate": "2026-04-07T20:11:31.070162+10:00",
          "IsDefault": true
        }
      ]
    }
  ],
  "UnPaginatedItems": [
    {
      "BillingStructureEntityGroupID": 1,
      "Name": "sample string 2",
      "BillingStructureID": 3,
      "BillingStructureName": "sample string 4",
      "IsAggregated": true,
      "StartDate": "2026-04-07T20:11:31.070162+10:00",
      "EndDate": "2026-04-07T20:11:31.070162+10:00",
      "FeeFreePeriodEnd": "2026-04-07T20:11:31.070162+10:00",
      "MemberCount": 8,
      "GroupEntities": [
        {
          "BillingStructureEntityGroupEntryID": 1,
          "BillingStructureEntityGroupID": 2,
          "POLiEntityID": "67b785a0-682b-4951-8950-6deed98aad81",
          "EntityCommonName": "sample string 4",
          "StartDate": "2026-04-07T20:11:31.070162+10:00",
          "EndDate": "2026-04-07T20:11:31.070162+10:00",
          "IsDefault": true
        },
        {
          "BillingStructureEntityGroupEntryID": 1,
          "BillingStructureEntityGroupID": 2,
          "POLiEntityID": "67b785a0-682b-4951-8950-6deed98aad81",
          "EntityCommonName": "sample string 4",
          "StartDate": "2026-04-07T20:11:31.070162+10:00",
          "EndDate": "2026-04-07T20:11:31.070162+10:00",
          "IsDefault": true
        }
      ]
    },
    {
      "BillingStructureEntityGroupID": 1,
      "Name": "sample string 2",
      "BillingStructureID": 3,
      "BillingStructureName": "sample string 4",
      "IsAggregated": true,
      "StartDate": "2026-04-07T20:11:31.070162+10:00",
      "EndDate": "2026-04-07T20:11:31.070162+10:00",
      "FeeFreePeriodEnd": "2026-04-07T20:11:31.070162+10:00",
      "MemberCount": 8,
      "GroupEntities": [
        {
          "BillingStructureEntityGroupEntryID": 1,
          "BillingStructureEntityGroupID": 2,
          "POLiEntityID": "67b785a0-682b-4951-8950-6deed98aad81",
          "EntityCommonName": "sample string 4",
          "StartDate": "2026-04-07T20:11:31.070162+10:00",
          "EndDate": "2026-04-07T20:11:31.070162+10:00",
          "IsDefault": true
        },
        {
          "BillingStructureEntityGroupEntryID": 1,
          "BillingStructureEntityGroupID": 2,
          "POLiEntityID": "67b785a0-682b-4951-8950-6deed98aad81",
          "EntityCommonName": "sample string 4",
          "StartDate": "2026-04-07T20:11:31.070162+10:00",
          "EndDate": "2026-04-07T20:11:31.070162+10:00",
          "IsDefault": true
        }
      ]
    }
  ],
  "FullCount": 2,
  "Skip": 3,
  "Take": 4,
  "Properties": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  }
}

application/xml, text/xml

Sample: 
<PaginationOfBillingStructureEntityGrouptaHJ6_P0R xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ConsoleAPI.Internal.Models.Common">
  <FullCount>2</FullCount>
  <IsAllSuccess>true</IsAllSuccess>
  <Items xmlns:d2p1="http://schemas.datacontract.org/2004/07/ConsoleAPI.Internal.Models.BillingStructure">
    <d2p1:BillingStructureEntityGroup>
      <d2p1:BillingStructureEntityGroupID>1</d2p1:BillingStructureEntityGroupID>
      <d2p1:BillingStructureID>3</d2p1:BillingStructureID>
      <d2p1:BillingStructureName>sample string 4</d2p1:BillingStructureName>
      <d2p1:EndDate>2026-04-07T20:11:31.070162+10:00</d2p1:EndDate>
      <d2p1:FeeFreePeriodEnd>2026-04-07T20:11:31.070162+10:00</d2p1:FeeFreePeriodEnd>
      <d2p1:GroupEntities>
        <d2p1:BillingStructureEntityGroupEntry>
          <d2p1:BillingStructureEntityGroupEntryID>1</d2p1:BillingStructureEntityGroupEntryID>
          <d2p1:BillingStructureEntityGroupID>2</d2p1:BillingStructureEntityGroupID>
          <d2p1:EndDate>2026-04-07T20:11:31.070162+10:00</d2p1:EndDate>
          <d2p1:EntityCommonName>sample string 4</d2p1:EntityCommonName>
          <d2p1:IsDefault>true</d2p1:IsDefault>
          <d2p1:POLiEntityID>67b785a0-682b-4951-8950-6deed98aad81</d2p1:POLiEntityID>
          <d2p1:StartDate>2026-04-07T20:11:31.070162+10:00</d2p1:StartDate>
        </d2p1:BillingStructureEntityGroupEntry>
        <d2p1:BillingStructureEntityGroupEntry>
          <d2p1:BillingStructureEntityGroupEntryID>1</d2p1:BillingStructureEntityGroupEntryID>
          <d2p1:BillingStructureEntityGroupID>2</d2p1:BillingStructureEntityGroupID>
          <d2p1:EndDate>2026-04-07T20:11:31.070162+10:00</d2p1:EndDate>
          <d2p1:EntityCommonName>sample string 4</d2p1:EntityCommonName>
          <d2p1:IsDefault>true</d2p1:IsDefault>
          <d2p1:POLiEntityID>67b785a0-682b-4951-8950-6deed98aad81</d2p1:POLiEntityID>
          <d2p1:StartDate>2026-04-07T20:11:31.070162+10:00</d2p1:StartDate>
        </d2p1:BillingStructureEntityGroupEntry>
      </d2p1:GroupEntities>
      <d2p1:IsAggregated>true</d2p1:IsAggregated>
      <d2p1:MemberCount>8</d2p1:MemberCount>
      <d2p1:Name>sample string 2</d2p1:Name>
      <d2p1:StartDate>2026-04-07T20:11:31.070162+10:00</d2p1:StartDate>
    </d2p1:BillingStructureEntityGroup>
    <d2p1:BillingStructureEntityGroup>
      <d2p1:BillingStructureEntityGroupID>1</d2p1:BillingStructureEntityGroupID>
      <d2p1:BillingStructureID>3</d2p1:BillingStructureID>
      <d2p1:BillingStructureName>sample string 4</d2p1:BillingStructureName>
      <d2p1:EndDate>2026-04-07T20:11:31.070162+10:00</d2p1:EndDate>
      <d2p1:FeeFreePeriodEnd>2026-04-07T20:11:31.070162+10:00</d2p1:FeeFreePeriodEnd>
      <d2p1:GroupEntities>
        <d2p1:BillingStructureEntityGroupEntry>
          <d2p1:BillingStructureEntityGroupEntryID>1</d2p1:BillingStructureEntityGroupEntryID>
          <d2p1:BillingStructureEntityGroupID>2</d2p1:BillingStructureEntityGroupID>
          <d2p1:EndDate>2026-04-07T20:11:31.070162+10:00</d2p1:EndDate>
          <d2p1:EntityCommonName>sample string 4</d2p1:EntityCommonName>
          <d2p1:IsDefault>true</d2p1:IsDefault>
          <d2p1:POLiEntityID>67b785a0-682b-4951-8950-6deed98aad81</d2p1:POLiEntityID>
          <d2p1:StartDate>2026-04-07T20:11:31.070162+10:00</d2p1:StartDate>
        </d2p1:BillingStructureEntityGroupEntry>
        <d2p1:BillingStructureEntityGroupEntry>
          <d2p1:BillingStructureEntityGroupEntryID>1</d2p1:BillingStructureEntityGroupEntryID>
          <d2p1:BillingStructureEntityGroupID>2</d2p1:BillingStructureEntityGroupID>
          <d2p1:EndDate>2026-04-07T20:11:31.070162+10:00</d2p1:EndDate>
          <d2p1:EntityCommonName>sample string 4</d2p1:EntityCommonName>
          <d2p1:IsDefault>true</d2p1:IsDefault>
          <d2p1:POLiEntityID>67b785a0-682b-4951-8950-6deed98aad81</d2p1:POLiEntityID>
          <d2p1:StartDate>2026-04-07T20:11:31.070162+10:00</d2p1:StartDate>
        </d2p1:BillingStructureEntityGroupEntry>
      </d2p1:GroupEntities>
      <d2p1:IsAggregated>true</d2p1:IsAggregated>
      <d2p1:MemberCount>8</d2p1:MemberCount>
      <d2p1:Name>sample string 2</d2p1:Name>
      <d2p1:StartDate>2026-04-07T20:11:31.070162+10:00</d2p1:StartDate>
    </d2p1:BillingStructureEntityGroup>
  </Items>
  <Properties xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value>sample string 2</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 3</d2p1:Key>
      <d2p1:Value>sample string 4</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Properties>
  <Skip>3</Skip>
  <Take>4</Take>
  <UnPaginatedItems xmlns:d2p1="http://schemas.datacontract.org/2004/07/ConsoleAPI.Internal.Models.BillingStructure">
    <d2p1:BillingStructureEntityGroup>
      <d2p1:BillingStructureEntityGroupID>1</d2p1:BillingStructureEntityGroupID>
      <d2p1:BillingStructureID>3</d2p1:BillingStructureID>
      <d2p1:BillingStructureName>sample string 4</d2p1:BillingStructureName>
      <d2p1:EndDate>2026-04-07T20:11:31.070162+10:00</d2p1:EndDate>
      <d2p1:FeeFreePeriodEnd>2026-04-07T20:11:31.070162+10:00</d2p1:FeeFreePeriodEnd>
      <d2p1:GroupEntities>
        <d2p1:BillingStructureEntityGroupEntry>
          <d2p1:BillingStructureEntityGroupEntryID>1</d2p1:BillingStructureEntityGroupEntryID>
          <d2p1:BillingStructureEntityGroupID>2</d2p1:BillingStructureEntityGroupID>
          <d2p1:EndDate>2026-04-07T20:11:31.070162+10:00</d2p1:EndDate>
          <d2p1:EntityCommonName>sample string 4</d2p1:EntityCommonName>
          <d2p1:IsDefault>true</d2p1:IsDefault>
          <d2p1:POLiEntityID>67b785a0-682b-4951-8950-6deed98aad81</d2p1:POLiEntityID>
          <d2p1:StartDate>2026-04-07T20:11:31.070162+10:00</d2p1:StartDate>
        </d2p1:BillingStructureEntityGroupEntry>
        <d2p1:BillingStructureEntityGroupEntry>
          <d2p1:BillingStructureEntityGroupEntryID>1</d2p1:BillingStructureEntityGroupEntryID>
          <d2p1:BillingStructureEntityGroupID>2</d2p1:BillingStructureEntityGroupID>
          <d2p1:EndDate>2026-04-07T20:11:31.070162+10:00</d2p1:EndDate>
          <d2p1:EntityCommonName>sample string 4</d2p1:EntityCommonName>
          <d2p1:IsDefault>true</d2p1:IsDefault>
          <d2p1:POLiEntityID>67b785a0-682b-4951-8950-6deed98aad81</d2p1:POLiEntityID>
          <d2p1:StartDate>2026-04-07T20:11:31.070162+10:00</d2p1:StartDate>
        </d2p1:BillingStructureEntityGroupEntry>
      </d2p1:GroupEntities>
      <d2p1:IsAggregated>true</d2p1:IsAggregated>
      <d2p1:MemberCount>8</d2p1:MemberCount>
      <d2p1:Name>sample string 2</d2p1:Name>
      <d2p1:StartDate>2026-04-07T20:11:31.070162+10:00</d2p1:StartDate>
    </d2p1:BillingStructureEntityGroup>
    <d2p1:BillingStructureEntityGroup>
      <d2p1:BillingStructureEntityGroupID>1</d2p1:BillingStructureEntityGroupID>
      <d2p1:BillingStructureID>3</d2p1:BillingStructureID>
      <d2p1:BillingStructureName>sample string 4</d2p1:BillingStructureName>
      <d2p1:EndDate>2026-04-07T20:11:31.070162+10:00</d2p1:EndDate>
      <d2p1:FeeFreePeriodEnd>2026-04-07T20:11:31.070162+10:00</d2p1:FeeFreePeriodEnd>
      <d2p1:GroupEntities>
        <d2p1:BillingStructureEntityGroupEntry>
          <d2p1:BillingStructureEntityGroupEntryID>1</d2p1:BillingStructureEntityGroupEntryID>
          <d2p1:BillingStructureEntityGroupID>2</d2p1:BillingStructureEntityGroupID>
          <d2p1:EndDate>2026-04-07T20:11:31.070162+10:00</d2p1:EndDate>
          <d2p1:EntityCommonName>sample string 4</d2p1:EntityCommonName>
          <d2p1:IsDefault>true</d2p1:IsDefault>
          <d2p1:POLiEntityID>67b785a0-682b-4951-8950-6deed98aad81</d2p1:POLiEntityID>
          <d2p1:StartDate>2026-04-07T20:11:31.070162+10:00</d2p1:StartDate>
        </d2p1:BillingStructureEntityGroupEntry>
        <d2p1:BillingStructureEntityGroupEntry>
          <d2p1:BillingStructureEntityGroupEntryID>1</d2p1:BillingStructureEntityGroupEntryID>
          <d2p1:BillingStructureEntityGroupID>2</d2p1:BillingStructureEntityGroupID>
          <d2p1:EndDate>2026-04-07T20:11:31.070162+10:00</d2p1:EndDate>
          <d2p1:EntityCommonName>sample string 4</d2p1:EntityCommonName>
          <d2p1:IsDefault>true</d2p1:IsDefault>
          <d2p1:POLiEntityID>67b785a0-682b-4951-8950-6deed98aad81</d2p1:POLiEntityID>
          <d2p1:StartDate>2026-04-07T20:11:31.070162+10:00</d2p1:StartDate>
        </d2p1:BillingStructureEntityGroupEntry>
      </d2p1:GroupEntities>
      <d2p1:IsAggregated>true</d2p1:IsAggregated>
      <d2p1:MemberCount>8</d2p1:MemberCount>
      <d2p1:Name>sample string 2</d2p1:Name>
      <d2p1:StartDate>2026-04-07T20:11:31.070162+10:00</d2p1:StartDate>
    </d2p1:BillingStructureEntityGroup>
  </UnPaginatedItems>
</PaginationOfBillingStructureEntityGrouptaHJ6_P0R>