POST api/Billing/RecurringAndOneOffCharges

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
RecurringAndOneOffChargeID	integer	None.
POLiEntityID	globally unique identifier	None.
EntityCommonName	string	None.
EntityCode	string	None.
IsAggregated	boolean	None.
BillingStructureName	string	None.
ChargeName	string	None.
ChargeValue	decimal number	None.
ChargeIncludesGST	boolean	None.
IsOneOffCharge	boolean	None.
IsOptional	boolean	None.
IsActive	boolean	None.
IsDeleted	boolean	None.
StartDate	date	None.
EndDate	date	None.
IsBilledOnNoTxns	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "RecurringAndOneOffChargeID": 1,
  "POLiEntityID": "e3614ac8-3371-44c6-b87c-9d9ba01a271f",
  "EntityCommonName": "sample string 3",
  "EntityCode": "sample string 4",
  "IsAggregated": true,
  "BillingStructureName": "sample string 6",
  "ChargeName": "sample string 7",
  "ChargeValue": 8.1,
  "ChargeIncludesGST": true,
  "IsOneOffCharge": true,
  "IsOptional": true,
  "IsActive": true,
  "IsDeleted": true,
  "StartDate": "2026-04-07T20:06:33.9341809+10:00",
  "EndDate": "2026-04-07T20:06:33.9341809+10:00",
  "IsBilledOnNoTxns": true
}

application/xml, text/xml

Sample:

<RecurringAndOneOffCharge xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ConsoleAPI.Internal.Models.BillingStructure">
  <BillingStructureName>sample string 6</BillingStructureName>
  <ChargeIncludesGST>true</ChargeIncludesGST>
  <ChargeName>sample string 7</ChargeName>
  <ChargeValue>8.1</ChargeValue>
  <EndDate>2026-04-07T20:06:33.9341809+10:00</EndDate>
  <EntityCode>sample string 4</EntityCode>
  <EntityCommonName>sample string 3</EntityCommonName>
  <IsActive>true</IsActive>
  <IsAggregated>true</IsAggregated>
  <IsBilledOnNoTxns>true</IsBilledOnNoTxns>
  <IsDeleted>true</IsDeleted>
  <IsOneOffCharge>true</IsOneOffCharge>
  <IsOptional>true</IsOptional>
  <POLiEntityID>e3614ac8-3371-44c6-b87c-9d9ba01a271f</POLiEntityID>
  <RecurringAndOneOffChargeID>1</RecurringAndOneOffChargeID>
  <StartDate>2026-04-07T20:06:33.9341809+10:00</StartDate>
</RecurringAndOneOffCharge>

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

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>