GET api/Billing/BillingRunChargeForEntity?skip={skip}&take={take}&field={field}&reverse={reverse}&billingRunId={billingRunId}&poliEntityID={poliEntityID}&entityCode={entityCode}&billingStructureEntityGroupID={billingStructureEntityGroupID}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| skip | integer |
None. |
|
| take | integer |
None. |
|
| field | string |
None. |
|
| reverse | boolean |
None. |
|
| billingRunId | integer |
None. |
|
| poliEntityID | globally unique identifier |
None. |
|
| entityCode | string |
None. |
|
| billingStructureEntityGroupID | integer |
None. |
Body Parameters
None.
Response Information
Resource Description
PaginationOfBillingRunChargesByTxn| Name | Description | Type | Additional information |
|---|---|---|---|
| IsAllSuccess | boolean |
None. |
|
| Items | Collection of BillingRunChargesByTxn |
None. |
|
| UnPaginatedItems | Collection of BillingRunChargesByTxn |
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": [
{
"BillingRunID": 1,
"TxnRowID": 2,
"TransactionRefNo": "sample string 3",
"TransactionDate": "2026-04-07T20:10:49.8460078+10:00",
"ReconciledDate": "2026-04-07T20:10:49.8460078+10:00",
"AmountPaid": 5.1,
"ChargeValue": 6.1,
"ChargeValueIncGST": 7.1,
"GSTAmount": 8.1,
"TierNum": 9,
"TransactionStatus": "sample string 10",
"EntityCode": "sample string 11",
"EntityCommonName": "sample string 12"
},
{
"BillingRunID": 1,
"TxnRowID": 2,
"TransactionRefNo": "sample string 3",
"TransactionDate": "2026-04-07T20:10:49.8460078+10:00",
"ReconciledDate": "2026-04-07T20:10:49.8460078+10:00",
"AmountPaid": 5.1,
"ChargeValue": 6.1,
"ChargeValueIncGST": 7.1,
"GSTAmount": 8.1,
"TierNum": 9,
"TransactionStatus": "sample string 10",
"EntityCode": "sample string 11",
"EntityCommonName": "sample string 12"
}
],
"UnPaginatedItems": [
{
"BillingRunID": 1,
"TxnRowID": 2,
"TransactionRefNo": "sample string 3",
"TransactionDate": "2026-04-07T20:10:49.8460078+10:00",
"ReconciledDate": "2026-04-07T20:10:49.8460078+10:00",
"AmountPaid": 5.1,
"ChargeValue": 6.1,
"ChargeValueIncGST": 7.1,
"GSTAmount": 8.1,
"TierNum": 9,
"TransactionStatus": "sample string 10",
"EntityCode": "sample string 11",
"EntityCommonName": "sample string 12"
},
{
"BillingRunID": 1,
"TxnRowID": 2,
"TransactionRefNo": "sample string 3",
"TransactionDate": "2026-04-07T20:10:49.8460078+10:00",
"ReconciledDate": "2026-04-07T20:10:49.8460078+10:00",
"AmountPaid": 5.1,
"ChargeValue": 6.1,
"ChargeValueIncGST": 7.1,
"GSTAmount": 8.1,
"TierNum": 9,
"TransactionStatus": "sample string 10",
"EntityCode": "sample string 11",
"EntityCommonName": "sample string 12"
}
],
"FullCount": 2,
"Skip": 3,
"Take": 4,
"Properties": {
"sample string 1": "sample string 2",
"sample string 3": "sample string 4"
}
}
application/xml, text/xml
Sample:
<PaginationOfBillingRunChargesByTxntaHJ6_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:BillingRunChargesByTxn>
<d2p1:AmountPaid>5.1</d2p1:AmountPaid>
<d2p1:BillingRunID>1</d2p1:BillingRunID>
<d2p1:ChargeValue>6.1</d2p1:ChargeValue>
<d2p1:ChargeValueIncGST>7.1</d2p1:ChargeValueIncGST>
<d2p1:EntityCode>sample string 11</d2p1:EntityCode>
<d2p1:EntityCommonName>sample string 12</d2p1:EntityCommonName>
<d2p1:GSTAmount>8.1</d2p1:GSTAmount>
<d2p1:ReconciledDate>2026-04-07T20:10:49.8460078+10:00</d2p1:ReconciledDate>
<d2p1:TierNum>9</d2p1:TierNum>
<d2p1:TransactionDate>2026-04-07T20:10:49.8460078+10:00</d2p1:TransactionDate>
<d2p1:TransactionRefNo>sample string 3</d2p1:TransactionRefNo>
<d2p1:TransactionStatus>sample string 10</d2p1:TransactionStatus>
<d2p1:TxnRowID>2</d2p1:TxnRowID>
</d2p1:BillingRunChargesByTxn>
<d2p1:BillingRunChargesByTxn>
<d2p1:AmountPaid>5.1</d2p1:AmountPaid>
<d2p1:BillingRunID>1</d2p1:BillingRunID>
<d2p1:ChargeValue>6.1</d2p1:ChargeValue>
<d2p1:ChargeValueIncGST>7.1</d2p1:ChargeValueIncGST>
<d2p1:EntityCode>sample string 11</d2p1:EntityCode>
<d2p1:EntityCommonName>sample string 12</d2p1:EntityCommonName>
<d2p1:GSTAmount>8.1</d2p1:GSTAmount>
<d2p1:ReconciledDate>2026-04-07T20:10:49.8460078+10:00</d2p1:ReconciledDate>
<d2p1:TierNum>9</d2p1:TierNum>
<d2p1:TransactionDate>2026-04-07T20:10:49.8460078+10:00</d2p1:TransactionDate>
<d2p1:TransactionRefNo>sample string 3</d2p1:TransactionRefNo>
<d2p1:TransactionStatus>sample string 10</d2p1:TransactionStatus>
<d2p1:TxnRowID>2</d2p1:TxnRowID>
</d2p1:BillingRunChargesByTxn>
</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:BillingRunChargesByTxn>
<d2p1:AmountPaid>5.1</d2p1:AmountPaid>
<d2p1:BillingRunID>1</d2p1:BillingRunID>
<d2p1:ChargeValue>6.1</d2p1:ChargeValue>
<d2p1:ChargeValueIncGST>7.1</d2p1:ChargeValueIncGST>
<d2p1:EntityCode>sample string 11</d2p1:EntityCode>
<d2p1:EntityCommonName>sample string 12</d2p1:EntityCommonName>
<d2p1:GSTAmount>8.1</d2p1:GSTAmount>
<d2p1:ReconciledDate>2026-04-07T20:10:49.8460078+10:00</d2p1:ReconciledDate>
<d2p1:TierNum>9</d2p1:TierNum>
<d2p1:TransactionDate>2026-04-07T20:10:49.8460078+10:00</d2p1:TransactionDate>
<d2p1:TransactionRefNo>sample string 3</d2p1:TransactionRefNo>
<d2p1:TransactionStatus>sample string 10</d2p1:TransactionStatus>
<d2p1:TxnRowID>2</d2p1:TxnRowID>
</d2p1:BillingRunChargesByTxn>
<d2p1:BillingRunChargesByTxn>
<d2p1:AmountPaid>5.1</d2p1:AmountPaid>
<d2p1:BillingRunID>1</d2p1:BillingRunID>
<d2p1:ChargeValue>6.1</d2p1:ChargeValue>
<d2p1:ChargeValueIncGST>7.1</d2p1:ChargeValueIncGST>
<d2p1:EntityCode>sample string 11</d2p1:EntityCode>
<d2p1:EntityCommonName>sample string 12</d2p1:EntityCommonName>
<d2p1:GSTAmount>8.1</d2p1:GSTAmount>
<d2p1:ReconciledDate>2026-04-07T20:10:49.8460078+10:00</d2p1:ReconciledDate>
<d2p1:TierNum>9</d2p1:TierNum>
<d2p1:TransactionDate>2026-04-07T20:10:49.8460078+10:00</d2p1:TransactionDate>
<d2p1:TransactionRefNo>sample string 3</d2p1:TransactionRefNo>
<d2p1:TransactionStatus>sample string 10</d2p1:TransactionStatus>
<d2p1:TxnRowID>2</d2p1:TxnRowID>
</d2p1:BillingRunChargesByTxn>
</UnPaginatedItems>
</PaginationOfBillingRunChargesByTxntaHJ6_P0R>