GET api/ValueAddedService/VASBillingRunChargeForEntity?skip={skip}&take={take}&field={field}&reverse={reverse}&vasBillingRunId={vasBillingRunId}&poliEntityID={poliEntityID}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
skip

integer

None.

take

integer

None.

field

string

None.

reverse

boolean

None.

vasBillingRunId

globally unique identifier

None.

poliEntityID

globally unique identifier

None.

Body Parameters

None.

Response Information

Resource Description

PaginationOfVASBillingRunChargesByTxn
NameDescriptionTypeAdditional information
IsAllSuccess

boolean

None.

Items

Collection of VASBillingRunChargesByTxn

None.

UnPaginatedItems

Collection of VASBillingRunChargesByTxn

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": [
    {
      "VASBillingRunID": "8f4dcca4-7976-46dd-8a3f-865ca978b20a",
      "TxnRowID": 2,
      "TransactionRefNo": "sample string 3",
      "RefundRefNo": "sample string 4",
      "TransactionDate": "2026-04-07T20:11:24.159324+10:00",
      "ReconciledDate": "2026-04-07T20:11:24.159324+10:00",
      "AmountPaid": 6.1,
      "ChargeValue": 7.1,
      "ChargeValueIncGST": 8.1,
      "GSTAmount": 9.1,
      "TierNum": 10,
      "IsProcessed": true,
      "EntityCode": "sample string 12",
      "EntityCommonName": "sample string 13"
    },
    {
      "VASBillingRunID": "8f4dcca4-7976-46dd-8a3f-865ca978b20a",
      "TxnRowID": 2,
      "TransactionRefNo": "sample string 3",
      "RefundRefNo": "sample string 4",
      "TransactionDate": "2026-04-07T20:11:24.159324+10:00",
      "ReconciledDate": "2026-04-07T20:11:24.159324+10:00",
      "AmountPaid": 6.1,
      "ChargeValue": 7.1,
      "ChargeValueIncGST": 8.1,
      "GSTAmount": 9.1,
      "TierNum": 10,
      "IsProcessed": true,
      "EntityCode": "sample string 12",
      "EntityCommonName": "sample string 13"
    }
  ],
  "UnPaginatedItems": [
    {
      "VASBillingRunID": "8f4dcca4-7976-46dd-8a3f-865ca978b20a",
      "TxnRowID": 2,
      "TransactionRefNo": "sample string 3",
      "RefundRefNo": "sample string 4",
      "TransactionDate": "2026-04-07T20:11:24.159324+10:00",
      "ReconciledDate": "2026-04-07T20:11:24.159324+10:00",
      "AmountPaid": 6.1,
      "ChargeValue": 7.1,
      "ChargeValueIncGST": 8.1,
      "GSTAmount": 9.1,
      "TierNum": 10,
      "IsProcessed": true,
      "EntityCode": "sample string 12",
      "EntityCommonName": "sample string 13"
    },
    {
      "VASBillingRunID": "8f4dcca4-7976-46dd-8a3f-865ca978b20a",
      "TxnRowID": 2,
      "TransactionRefNo": "sample string 3",
      "RefundRefNo": "sample string 4",
      "TransactionDate": "2026-04-07T20:11:24.159324+10:00",
      "ReconciledDate": "2026-04-07T20:11:24.159324+10:00",
      "AmountPaid": 6.1,
      "ChargeValue": 7.1,
      "ChargeValueIncGST": 8.1,
      "GSTAmount": 9.1,
      "TierNum": 10,
      "IsProcessed": true,
      "EntityCode": "sample string 12",
      "EntityCommonName": "sample string 13"
    }
  ],
  "FullCount": 2,
  "Skip": 3,
  "Take": 4,
  "Properties": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  }
}

application/xml, text/xml

Sample:
<PaginationOfVASBillingRunChargesByTxnYHAUxzTW 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.ValueAddedServices">
    <d2p1:VASBillingRunChargesByTxn>
      <d2p1:AmountPaid>6.1</d2p1:AmountPaid>
      <d2p1:ChargeValue>7.1</d2p1:ChargeValue>
      <d2p1:ChargeValueIncGST>8.1</d2p1:ChargeValueIncGST>
      <d2p1:EntityCode>sample string 12</d2p1:EntityCode>
      <d2p1:EntityCommonName>sample string 13</d2p1:EntityCommonName>
      <d2p1:GSTAmount>9.1</d2p1:GSTAmount>
      <d2p1:IsProcessed>true</d2p1:IsProcessed>
      <d2p1:ReconciledDate>2026-04-07T20:11:24.159324+10:00</d2p1:ReconciledDate>
      <d2p1:RefundRefNo>sample string 4</d2p1:RefundRefNo>
      <d2p1:TierNum>10</d2p1:TierNum>
      <d2p1:TransactionDate>2026-04-07T20:11:24.159324+10:00</d2p1:TransactionDate>
      <d2p1:TransactionRefNo>sample string 3</d2p1:TransactionRefNo>
      <d2p1:TxnRowID>2</d2p1:TxnRowID>
      <d2p1:VASBillingRunID>8f4dcca4-7976-46dd-8a3f-865ca978b20a</d2p1:VASBillingRunID>
    </d2p1:VASBillingRunChargesByTxn>
    <d2p1:VASBillingRunChargesByTxn>
      <d2p1:AmountPaid>6.1</d2p1:AmountPaid>
      <d2p1:ChargeValue>7.1</d2p1:ChargeValue>
      <d2p1:ChargeValueIncGST>8.1</d2p1:ChargeValueIncGST>
      <d2p1:EntityCode>sample string 12</d2p1:EntityCode>
      <d2p1:EntityCommonName>sample string 13</d2p1:EntityCommonName>
      <d2p1:GSTAmount>9.1</d2p1:GSTAmount>
      <d2p1:IsProcessed>true</d2p1:IsProcessed>
      <d2p1:ReconciledDate>2026-04-07T20:11:24.159324+10:00</d2p1:ReconciledDate>
      <d2p1:RefundRefNo>sample string 4</d2p1:RefundRefNo>
      <d2p1:TierNum>10</d2p1:TierNum>
      <d2p1:TransactionDate>2026-04-07T20:11:24.159324+10:00</d2p1:TransactionDate>
      <d2p1:TransactionRefNo>sample string 3</d2p1:TransactionRefNo>
      <d2p1:TxnRowID>2</d2p1:TxnRowID>
      <d2p1:VASBillingRunID>8f4dcca4-7976-46dd-8a3f-865ca978b20a</d2p1:VASBillingRunID>
    </d2p1:VASBillingRunChargesByTxn>
  </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.ValueAddedServices">
    <d2p1:VASBillingRunChargesByTxn>
      <d2p1:AmountPaid>6.1</d2p1:AmountPaid>
      <d2p1:ChargeValue>7.1</d2p1:ChargeValue>
      <d2p1:ChargeValueIncGST>8.1</d2p1:ChargeValueIncGST>
      <d2p1:EntityCode>sample string 12</d2p1:EntityCode>
      <d2p1:EntityCommonName>sample string 13</d2p1:EntityCommonName>
      <d2p1:GSTAmount>9.1</d2p1:GSTAmount>
      <d2p1:IsProcessed>true</d2p1:IsProcessed>
      <d2p1:ReconciledDate>2026-04-07T20:11:24.159324+10:00</d2p1:ReconciledDate>
      <d2p1:RefundRefNo>sample string 4</d2p1:RefundRefNo>
      <d2p1:TierNum>10</d2p1:TierNum>
      <d2p1:TransactionDate>2026-04-07T20:11:24.159324+10:00</d2p1:TransactionDate>
      <d2p1:TransactionRefNo>sample string 3</d2p1:TransactionRefNo>
      <d2p1:TxnRowID>2</d2p1:TxnRowID>
      <d2p1:VASBillingRunID>8f4dcca4-7976-46dd-8a3f-865ca978b20a</d2p1:VASBillingRunID>
    </d2p1:VASBillingRunChargesByTxn>
    <d2p1:VASBillingRunChargesByTxn>
      <d2p1:AmountPaid>6.1</d2p1:AmountPaid>
      <d2p1:ChargeValue>7.1</d2p1:ChargeValue>
      <d2p1:ChargeValueIncGST>8.1</d2p1:ChargeValueIncGST>
      <d2p1:EntityCode>sample string 12</d2p1:EntityCode>
      <d2p1:EntityCommonName>sample string 13</d2p1:EntityCommonName>
      <d2p1:GSTAmount>9.1</d2p1:GSTAmount>
      <d2p1:IsProcessed>true</d2p1:IsProcessed>
      <d2p1:ReconciledDate>2026-04-07T20:11:24.159324+10:00</d2p1:ReconciledDate>
      <d2p1:RefundRefNo>sample string 4</d2p1:RefundRefNo>
      <d2p1:TierNum>10</d2p1:TierNum>
      <d2p1:TransactionDate>2026-04-07T20:11:24.159324+10:00</d2p1:TransactionDate>
      <d2p1:TransactionRefNo>sample string 3</d2p1:TransactionRefNo>
      <d2p1:TxnRowID>2</d2p1:TxnRowID>
      <d2p1:VASBillingRunID>8f4dcca4-7976-46dd-8a3f-865ca978b20a</d2p1:VASBillingRunID>
    </d2p1:VASBillingRunChargesByTxn>
  </UnPaginatedItems>
</PaginationOfVASBillingRunChargesByTxnYHAUxzTW>