POST api/Billing/BillingStructureEntityGroup

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
BillingStructureEntityGroupID	integer	None.
Name	string	None.
BillingStructureID	integer	None.
BillingStructureName	string	None.
IsAggregated	boolean	None.
StartDate	date	None.
EndDate	date	None.
FeeFreePeriodEnd	date	None.
MemberCount	integer	None.
GroupEntities	Collection of BillingStructureEntityGroupEntry	None.

Request Formats

application/json, text/json

Sample:

{
  "BillingStructureEntityGroupID": 1,
  "Name": "sample string 2",
  "BillingStructureID": 3,
  "BillingStructureName": "sample string 4",
  "IsAggregated": true,
  "StartDate": "2026-04-07T20:12:58.3366306+10:00",
  "EndDate": "2026-04-07T20:12:58.3366306+10:00",
  "FeeFreePeriodEnd": "2026-04-07T20:12:58.3366306+10:00",
  "MemberCount": 8,
  "GroupEntities": [
    {
      "BillingStructureEntityGroupEntryID": 1,
      "BillingStructureEntityGroupID": 2,
      "POLiEntityID": "11182b01-6492-4d7d-a05d-3cfcc7072f16",
      "EntityCommonName": "sample string 4",
      "StartDate": "2026-04-07T20:12:58.3366306+10:00",
      "EndDate": "2026-04-07T20:12:58.3366306+10:00",
      "IsDefault": true
    },
    {
      "BillingStructureEntityGroupEntryID": 1,
      "BillingStructureEntityGroupID": 2,
      "POLiEntityID": "11182b01-6492-4d7d-a05d-3cfcc7072f16",
      "EntityCommonName": "sample string 4",
      "StartDate": "2026-04-07T20:12:58.3366306+10:00",
      "EndDate": "2026-04-07T20:12:58.3366306+10:00",
      "IsDefault": true
    }
  ]
}

application/xml, text/xml

Sample:

<BillingStructureEntityGroup xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ConsoleAPI.Internal.Models.BillingStructure">
  <BillingStructureEntityGroupID>1</BillingStructureEntityGroupID>
  <BillingStructureID>3</BillingStructureID>
  <BillingStructureName>sample string 4</BillingStructureName>
  <EndDate>2026-04-07T20:12:58.3366306+10:00</EndDate>
  <FeeFreePeriodEnd>2026-04-07T20:12:58.3366306+10:00</FeeFreePeriodEnd>
  <GroupEntities>
    <BillingStructureEntityGroupEntry>
      <BillingStructureEntityGroupEntryID>1</BillingStructureEntityGroupEntryID>
      <BillingStructureEntityGroupID>2</BillingStructureEntityGroupID>
      <EndDate>2026-04-07T20:12:58.3366306+10:00</EndDate>
      <EntityCommonName>sample string 4</EntityCommonName>
      <IsDefault>true</IsDefault>
      <POLiEntityID>11182b01-6492-4d7d-a05d-3cfcc7072f16</POLiEntityID>
      <StartDate>2026-04-07T20:12:58.3366306+10:00</StartDate>
    </BillingStructureEntityGroupEntry>
    <BillingStructureEntityGroupEntry>
      <BillingStructureEntityGroupEntryID>1</BillingStructureEntityGroupEntryID>
      <BillingStructureEntityGroupID>2</BillingStructureEntityGroupID>
      <EndDate>2026-04-07T20:12:58.3366306+10:00</EndDate>
      <EntityCommonName>sample string 4</EntityCommonName>
      <IsDefault>true</IsDefault>
      <POLiEntityID>11182b01-6492-4d7d-a05d-3cfcc7072f16</POLiEntityID>
      <StartDate>2026-04-07T20:12:58.3366306+10:00</StartDate>
    </BillingStructureEntityGroupEntry>
  </GroupEntities>
  <IsAggregated>true</IsAggregated>
  <MemberCount>8</MemberCount>
  <Name>sample string 2</Name>
  <StartDate>2026-04-07T20:12:58.3366306+10:00</StartDate>
</BillingStructureEntityGroup>

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

Response Information

Resource Description

CommonResult

Name	Description	Type	Additional information
ErrorMessage		string	None.
Result		Object	None.

Response Formats

application/json, text/json

Sample:

{
  "ErrorMessage": "sample string 1",
  "Result": {}
}

application/xml, text/xml

Sample:

<CommonResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ConsoleAPI.Internal.Models.Common">
  <ErrorMessage>sample string 1</ErrorMessage>
  <Result />
</CommonResult>