GET api/Billing/InProgressAggregatedMerchantBillingRuns
Request Information
URI Parameters
None.
Body Parameters
None.
Response Information
Resource Description
PaginationOfBillingRun| Name | Description | Type | Additional information |
|---|---|---|---|
| IsAllSuccess | boolean |
None. |
|
| Items | Collection of BillingRun |
None. |
|
| UnPaginatedItems | Collection of BillingRun |
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,
"BillingStructureID": 2,
"BillingStructureName": "sample string 3",
"RunDateUTC": "2026-04-07T20:12:58.1347919+10:00",
"StartDateUTC": "2026-04-07T20:12:58.1347919+10:00",
"EndDateUTC": "2026-04-07T20:12:58.1347919+10:00",
"CurrentRun": true,
"RunValue": 8.1,
"RunValueIncTax": 9.1,
"TxnValue": 10.1,
"TxnCount": 11.1,
"RunProcessed": true,
"GSTPercentage": 13.1,
"GSTAmount": 14.1,
"BillingRunChargesByEntity": [
{
"BillNumber": 1,
"BillingRunID": 2,
"POLiEntityID": "6a18f9be-4dfa-4363-b0b2-8a37a83a9773",
"BillingStructureEntityGroupID": 4,
"EntityCode": "sample string 5",
"EntityCommonName": "sample string 6",
"AmountBilled": 7.1,
"AmountBilledIncTax": 8.1,
"GSTPercentage": 9.1,
"GSTAmount": 10.1,
"TxnCount": 11,
"TxnValue": 12.1,
"CurrentRun": true,
"BillingStructureName": "sample string 14"
},
{
"BillNumber": 1,
"BillingRunID": 2,
"POLiEntityID": "6a18f9be-4dfa-4363-b0b2-8a37a83a9773",
"BillingStructureEntityGroupID": 4,
"EntityCode": "sample string 5",
"EntityCommonName": "sample string 6",
"AmountBilled": 7.1,
"AmountBilledIncTax": 8.1,
"GSTPercentage": 9.1,
"GSTAmount": 10.1,
"TxnCount": 11,
"TxnValue": 12.1,
"CurrentRun": true,
"BillingStructureName": "sample string 14"
}
]
},
{
"BillingRunID": 1,
"BillingStructureID": 2,
"BillingStructureName": "sample string 3",
"RunDateUTC": "2026-04-07T20:12:58.1347919+10:00",
"StartDateUTC": "2026-04-07T20:12:58.1347919+10:00",
"EndDateUTC": "2026-04-07T20:12:58.1347919+10:00",
"CurrentRun": true,
"RunValue": 8.1,
"RunValueIncTax": 9.1,
"TxnValue": 10.1,
"TxnCount": 11.1,
"RunProcessed": true,
"GSTPercentage": 13.1,
"GSTAmount": 14.1,
"BillingRunChargesByEntity": [
{
"BillNumber": 1,
"BillingRunID": 2,
"POLiEntityID": "6a18f9be-4dfa-4363-b0b2-8a37a83a9773",
"BillingStructureEntityGroupID": 4,
"EntityCode": "sample string 5",
"EntityCommonName": "sample string 6",
"AmountBilled": 7.1,
"AmountBilledIncTax": 8.1,
"GSTPercentage": 9.1,
"GSTAmount": 10.1,
"TxnCount": 11,
"TxnValue": 12.1,
"CurrentRun": true,
"BillingStructureName": "sample string 14"
},
{
"BillNumber": 1,
"BillingRunID": 2,
"POLiEntityID": "6a18f9be-4dfa-4363-b0b2-8a37a83a9773",
"BillingStructureEntityGroupID": 4,
"EntityCode": "sample string 5",
"EntityCommonName": "sample string 6",
"AmountBilled": 7.1,
"AmountBilledIncTax": 8.1,
"GSTPercentage": 9.1,
"GSTAmount": 10.1,
"TxnCount": 11,
"TxnValue": 12.1,
"CurrentRun": true,
"BillingStructureName": "sample string 14"
}
]
}
],
"UnPaginatedItems": [
{
"BillingRunID": 1,
"BillingStructureID": 2,
"BillingStructureName": "sample string 3",
"RunDateUTC": "2026-04-07T20:12:58.1347919+10:00",
"StartDateUTC": "2026-04-07T20:12:58.1347919+10:00",
"EndDateUTC": "2026-04-07T20:12:58.1347919+10:00",
"CurrentRun": true,
"RunValue": 8.1,
"RunValueIncTax": 9.1,
"TxnValue": 10.1,
"TxnCount": 11.1,
"RunProcessed": true,
"GSTPercentage": 13.1,
"GSTAmount": 14.1,
"BillingRunChargesByEntity": [
{
"BillNumber": 1,
"BillingRunID": 2,
"POLiEntityID": "6a18f9be-4dfa-4363-b0b2-8a37a83a9773",
"BillingStructureEntityGroupID": 4,
"EntityCode": "sample string 5",
"EntityCommonName": "sample string 6",
"AmountBilled": 7.1,
"AmountBilledIncTax": 8.1,
"GSTPercentage": 9.1,
"GSTAmount": 10.1,
"TxnCount": 11,
"TxnValue": 12.1,
"CurrentRun": true,
"BillingStructureName": "sample string 14"
},
{
"BillNumber": 1,
"BillingRunID": 2,
"POLiEntityID": "6a18f9be-4dfa-4363-b0b2-8a37a83a9773",
"BillingStructureEntityGroupID": 4,
"EntityCode": "sample string 5",
"EntityCommonName": "sample string 6",
"AmountBilled": 7.1,
"AmountBilledIncTax": 8.1,
"GSTPercentage": 9.1,
"GSTAmount": 10.1,
"TxnCount": 11,
"TxnValue": 12.1,
"CurrentRun": true,
"BillingStructureName": "sample string 14"
}
]
},
{
"BillingRunID": 1,
"BillingStructureID": 2,
"BillingStructureName": "sample string 3",
"RunDateUTC": "2026-04-07T20:12:58.1347919+10:00",
"StartDateUTC": "2026-04-07T20:12:58.1347919+10:00",
"EndDateUTC": "2026-04-07T20:12:58.1347919+10:00",
"CurrentRun": true,
"RunValue": 8.1,
"RunValueIncTax": 9.1,
"TxnValue": 10.1,
"TxnCount": 11.1,
"RunProcessed": true,
"GSTPercentage": 13.1,
"GSTAmount": 14.1,
"BillingRunChargesByEntity": [
{
"BillNumber": 1,
"BillingRunID": 2,
"POLiEntityID": "6a18f9be-4dfa-4363-b0b2-8a37a83a9773",
"BillingStructureEntityGroupID": 4,
"EntityCode": "sample string 5",
"EntityCommonName": "sample string 6",
"AmountBilled": 7.1,
"AmountBilledIncTax": 8.1,
"GSTPercentage": 9.1,
"GSTAmount": 10.1,
"TxnCount": 11,
"TxnValue": 12.1,
"CurrentRun": true,
"BillingStructureName": "sample string 14"
},
{
"BillNumber": 1,
"BillingRunID": 2,
"POLiEntityID": "6a18f9be-4dfa-4363-b0b2-8a37a83a9773",
"BillingStructureEntityGroupID": 4,
"EntityCode": "sample string 5",
"EntityCommonName": "sample string 6",
"AmountBilled": 7.1,
"AmountBilledIncTax": 8.1,
"GSTPercentage": 9.1,
"GSTAmount": 10.1,
"TxnCount": 11,
"TxnValue": 12.1,
"CurrentRun": true,
"BillingStructureName": "sample string 14"
}
]
}
],
"FullCount": 2,
"Skip": 3,
"Take": 4,
"Properties": {
"sample string 1": "sample string 2",
"sample string 3": "sample string 4"
}
}
application/xml, text/xml
Sample:
<PaginationOfBillingRuntaHJ6_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:BillingRun>
<d2p1:BillingRunChargesByEntity>
<d2p1:BillingRunChargesByEntity>
<d2p1:AmountBilled>7.1</d2p1:AmountBilled>
<d2p1:AmountBilledIncTax>8.1</d2p1:AmountBilledIncTax>
<d2p1:BillNumber>1</d2p1:BillNumber>
<d2p1:BillingRunID>2</d2p1:BillingRunID>
<d2p1:BillingStructureEntityGroupID>4</d2p1:BillingStructureEntityGroupID>
<d2p1:BillingStructureName>sample string 14</d2p1:BillingStructureName>
<d2p1:CurrentRun>true</d2p1:CurrentRun>
<d2p1:EntityCode>sample string 5</d2p1:EntityCode>
<d2p1:EntityCommonName>sample string 6</d2p1:EntityCommonName>
<d2p1:GSTAmount>10.1</d2p1:GSTAmount>
<d2p1:GSTPercentage>9.1</d2p1:GSTPercentage>
<d2p1:POLiEntityID>6a18f9be-4dfa-4363-b0b2-8a37a83a9773</d2p1:POLiEntityID>
<d2p1:TxnCount>11</d2p1:TxnCount>
<d2p1:TxnValue>12.1</d2p1:TxnValue>
</d2p1:BillingRunChargesByEntity>
<d2p1:BillingRunChargesByEntity>
<d2p1:AmountBilled>7.1</d2p1:AmountBilled>
<d2p1:AmountBilledIncTax>8.1</d2p1:AmountBilledIncTax>
<d2p1:BillNumber>1</d2p1:BillNumber>
<d2p1:BillingRunID>2</d2p1:BillingRunID>
<d2p1:BillingStructureEntityGroupID>4</d2p1:BillingStructureEntityGroupID>
<d2p1:BillingStructureName>sample string 14</d2p1:BillingStructureName>
<d2p1:CurrentRun>true</d2p1:CurrentRun>
<d2p1:EntityCode>sample string 5</d2p1:EntityCode>
<d2p1:EntityCommonName>sample string 6</d2p1:EntityCommonName>
<d2p1:GSTAmount>10.1</d2p1:GSTAmount>
<d2p1:GSTPercentage>9.1</d2p1:GSTPercentage>
<d2p1:POLiEntityID>6a18f9be-4dfa-4363-b0b2-8a37a83a9773</d2p1:POLiEntityID>
<d2p1:TxnCount>11</d2p1:TxnCount>
<d2p1:TxnValue>12.1</d2p1:TxnValue>
</d2p1:BillingRunChargesByEntity>
</d2p1:BillingRunChargesByEntity>
<d2p1:BillingRunID>1</d2p1:BillingRunID>
<d2p1:BillingStructureID>2</d2p1:BillingStructureID>
<d2p1:BillingStructureName>sample string 3</d2p1:BillingStructureName>
<d2p1:CurrentRun>true</d2p1:CurrentRun>
<d2p1:EndDateUTC>2026-04-07T20:12:58.1347919+10:00</d2p1:EndDateUTC>
<d2p1:GSTAmount>14.1</d2p1:GSTAmount>
<d2p1:GSTPercentage>13.1</d2p1:GSTPercentage>
<d2p1:RunDateUTC>2026-04-07T20:12:58.1347919+10:00</d2p1:RunDateUTC>
<d2p1:RunProcessed>true</d2p1:RunProcessed>
<d2p1:RunValue>8.1</d2p1:RunValue>
<d2p1:RunValueIncTax>9.1</d2p1:RunValueIncTax>
<d2p1:StartDateUTC>2026-04-07T20:12:58.1347919+10:00</d2p1:StartDateUTC>
<d2p1:TxnCount>11.1</d2p1:TxnCount>
<d2p1:TxnValue>10.1</d2p1:TxnValue>
</d2p1:BillingRun>
<d2p1:BillingRun>
<d2p1:BillingRunChargesByEntity>
<d2p1:BillingRunChargesByEntity>
<d2p1:AmountBilled>7.1</d2p1:AmountBilled>
<d2p1:AmountBilledIncTax>8.1</d2p1:AmountBilledIncTax>
<d2p1:BillNumber>1</d2p1:BillNumber>
<d2p1:BillingRunID>2</d2p1:BillingRunID>
<d2p1:BillingStructureEntityGroupID>4</d2p1:BillingStructureEntityGroupID>
<d2p1:BillingStructureName>sample string 14</d2p1:BillingStructureName>
<d2p1:CurrentRun>true</d2p1:CurrentRun>
<d2p1:EntityCode>sample string 5</d2p1:EntityCode>
<d2p1:EntityCommonName>sample string 6</d2p1:EntityCommonName>
<d2p1:GSTAmount>10.1</d2p1:GSTAmount>
<d2p1:GSTPercentage>9.1</d2p1:GSTPercentage>
<d2p1:POLiEntityID>6a18f9be-4dfa-4363-b0b2-8a37a83a9773</d2p1:POLiEntityID>
<d2p1:TxnCount>11</d2p1:TxnCount>
<d2p1:TxnValue>12.1</d2p1:TxnValue>
</d2p1:BillingRunChargesByEntity>
<d2p1:BillingRunChargesByEntity>
<d2p1:AmountBilled>7.1</d2p1:AmountBilled>
<d2p1:AmountBilledIncTax>8.1</d2p1:AmountBilledIncTax>
<d2p1:BillNumber>1</d2p1:BillNumber>
<d2p1:BillingRunID>2</d2p1:BillingRunID>
<d2p1:BillingStructureEntityGroupID>4</d2p1:BillingStructureEntityGroupID>
<d2p1:BillingStructureName>sample string 14</d2p1:BillingStructureName>
<d2p1:CurrentRun>true</d2p1:CurrentRun>
<d2p1:EntityCode>sample string 5</d2p1:EntityCode>
<d2p1:EntityCommonName>sample string 6</d2p1:EntityCommonName>
<d2p1:GSTAmount>10.1</d2p1:GSTAmount>
<d2p1:GSTPercentage>9.1</d2p1:GSTPercentage>
<d2p1:POLiEntityID>6a18f9be-4dfa-4363-b0b2-8a37a83a9773</d2p1:POLiEntityID>
<d2p1:TxnCount>11</d2p1:TxnCount>
<d2p1:TxnValue>12.1</d2p1:TxnValue>
</d2p1:BillingRunChargesByEntity>
</d2p1:BillingRunChargesByEntity>
<d2p1:BillingRunID>1</d2p1:BillingRunID>
<d2p1:BillingStructureID>2</d2p1:BillingStructureID>
<d2p1:BillingStructureName>sample string 3</d2p1:BillingStructureName>
<d2p1:CurrentRun>true</d2p1:CurrentRun>
<d2p1:EndDateUTC>2026-04-07T20:12:58.1347919+10:00</d2p1:EndDateUTC>
<d2p1:GSTAmount>14.1</d2p1:GSTAmount>
<d2p1:GSTPercentage>13.1</d2p1:GSTPercentage>
<d2p1:RunDateUTC>2026-04-07T20:12:58.1347919+10:00</d2p1:RunDateUTC>
<d2p1:RunProcessed>true</d2p1:RunProcessed>
<d2p1:RunValue>8.1</d2p1:RunValue>
<d2p1:RunValueIncTax>9.1</d2p1:RunValueIncTax>
<d2p1:StartDateUTC>2026-04-07T20:12:58.1347919+10:00</d2p1:StartDateUTC>
<d2p1:TxnCount>11.1</d2p1:TxnCount>
<d2p1:TxnValue>10.1</d2p1:TxnValue>
</d2p1:BillingRun>
</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:BillingRun>
<d2p1:BillingRunChargesByEntity>
<d2p1:BillingRunChargesByEntity>
<d2p1:AmountBilled>7.1</d2p1:AmountBilled>
<d2p1:AmountBilledIncTax>8.1</d2p1:AmountBilledIncTax>
<d2p1:BillNumber>1</d2p1:BillNumber>
<d2p1:BillingRunID>2</d2p1:BillingRunID>
<d2p1:BillingStructureEntityGroupID>4</d2p1:BillingStructureEntityGroupID>
<d2p1:BillingStructureName>sample string 14</d2p1:BillingStructureName>
<d2p1:CurrentRun>true</d2p1:CurrentRun>
<d2p1:EntityCode>sample string 5</d2p1:EntityCode>
<d2p1:EntityCommonName>sample string 6</d2p1:EntityCommonName>
<d2p1:GSTAmount>10.1</d2p1:GSTAmount>
<d2p1:GSTPercentage>9.1</d2p1:GSTPercentage>
<d2p1:POLiEntityID>6a18f9be-4dfa-4363-b0b2-8a37a83a9773</d2p1:POLiEntityID>
<d2p1:TxnCount>11</d2p1:TxnCount>
<d2p1:TxnValue>12.1</d2p1:TxnValue>
</d2p1:BillingRunChargesByEntity>
<d2p1:BillingRunChargesByEntity>
<d2p1:AmountBilled>7.1</d2p1:AmountBilled>
<d2p1:AmountBilledIncTax>8.1</d2p1:AmountBilledIncTax>
<d2p1:BillNumber>1</d2p1:BillNumber>
<d2p1:BillingRunID>2</d2p1:BillingRunID>
<d2p1:BillingStructureEntityGroupID>4</d2p1:BillingStructureEntityGroupID>
<d2p1:BillingStructureName>sample string 14</d2p1:BillingStructureName>
<d2p1:CurrentRun>true</d2p1:CurrentRun>
<d2p1:EntityCode>sample string 5</d2p1:EntityCode>
<d2p1:EntityCommonName>sample string 6</d2p1:EntityCommonName>
<d2p1:GSTAmount>10.1</d2p1:GSTAmount>
<d2p1:GSTPercentage>9.1</d2p1:GSTPercentage>
<d2p1:POLiEntityID>6a18f9be-4dfa-4363-b0b2-8a37a83a9773</d2p1:POLiEntityID>
<d2p1:TxnCount>11</d2p1:TxnCount>
<d2p1:TxnValue>12.1</d2p1:TxnValue>
</d2p1:BillingRunChargesByEntity>
</d2p1:BillingRunChargesByEntity>
<d2p1:BillingRunID>1</d2p1:BillingRunID>
<d2p1:BillingStructureID>2</d2p1:BillingStructureID>
<d2p1:BillingStructureName>sample string 3</d2p1:BillingStructureName>
<d2p1:CurrentRun>true</d2p1:CurrentRun>
<d2p1:EndDateUTC>2026-04-07T20:12:58.1347919+10:00</d2p1:EndDateUTC>
<d2p1:GSTAmount>14.1</d2p1:GSTAmount>
<d2p1:GSTPercentage>13.1</d2p1:GSTPercentage>
<d2p1:RunDateUTC>2026-04-07T20:12:58.1347919+10:00</d2p1:RunDateUTC>
<d2p1:RunProcessed>true</d2p1:RunProcessed>
<d2p1:RunValue>8.1</d2p1:RunValue>
<d2p1:RunValueIncTax>9.1</d2p1:RunValueIncTax>
<d2p1:StartDateUTC>2026-04-07T20:12:58.1347919+10:00</d2p1:StartDateUTC>
<d2p1:TxnCount>11.1</d2p1:TxnCount>
<d2p1:TxnValue>10.1</d2p1:TxnValue>
</d2p1:BillingRun>
<d2p1:BillingRun>
<d2p1:BillingRunChargesByEntity>
<d2p1:BillingRunChargesByEntity>
<d2p1:AmountBilled>7.1</d2p1:AmountBilled>
<d2p1:AmountBilledIncTax>8.1</d2p1:AmountBilledIncTax>
<d2p1:BillNumber>1</d2p1:BillNumber>
<d2p1:BillingRunID>2</d2p1:BillingRunID>
<d2p1:BillingStructureEntityGroupID>4</d2p1:BillingStructureEntityGroupID>
<d2p1:BillingStructureName>sample string 14</d2p1:BillingStructureName>
<d2p1:CurrentRun>true</d2p1:CurrentRun>
<d2p1:EntityCode>sample string 5</d2p1:EntityCode>
<d2p1:EntityCommonName>sample string 6</d2p1:EntityCommonName>
<d2p1:GSTAmount>10.1</d2p1:GSTAmount>
<d2p1:GSTPercentage>9.1</d2p1:GSTPercentage>
<d2p1:POLiEntityID>6a18f9be-4dfa-4363-b0b2-8a37a83a9773</d2p1:POLiEntityID>
<d2p1:TxnCount>11</d2p1:TxnCount>
<d2p1:TxnValue>12.1</d2p1:TxnValue>
</d2p1:BillingRunChargesByEntity>
<d2p1:BillingRunChargesByEntity>
<d2p1:AmountBilled>7.1</d2p1:AmountBilled>
<d2p1:AmountBilledIncTax>8.1</d2p1:AmountBilledIncTax>
<d2p1:BillNumber>1</d2p1:BillNumber>
<d2p1:BillingRunID>2</d2p1:BillingRunID>
<d2p1:BillingStructureEntityGroupID>4</d2p1:BillingStructureEntityGroupID>
<d2p1:BillingStructureName>sample string 14</d2p1:BillingStructureName>
<d2p1:CurrentRun>true</d2p1:CurrentRun>
<d2p1:EntityCode>sample string 5</d2p1:EntityCode>
<d2p1:EntityCommonName>sample string 6</d2p1:EntityCommonName>
<d2p1:GSTAmount>10.1</d2p1:GSTAmount>
<d2p1:GSTPercentage>9.1</d2p1:GSTPercentage>
<d2p1:POLiEntityID>6a18f9be-4dfa-4363-b0b2-8a37a83a9773</d2p1:POLiEntityID>
<d2p1:TxnCount>11</d2p1:TxnCount>
<d2p1:TxnValue>12.1</d2p1:TxnValue>
</d2p1:BillingRunChargesByEntity>
</d2p1:BillingRunChargesByEntity>
<d2p1:BillingRunID>1</d2p1:BillingRunID>
<d2p1:BillingStructureID>2</d2p1:BillingStructureID>
<d2p1:BillingStructureName>sample string 3</d2p1:BillingStructureName>
<d2p1:CurrentRun>true</d2p1:CurrentRun>
<d2p1:EndDateUTC>2026-04-07T20:12:58.1347919+10:00</d2p1:EndDateUTC>
<d2p1:GSTAmount>14.1</d2p1:GSTAmount>
<d2p1:GSTPercentage>13.1</d2p1:GSTPercentage>
<d2p1:RunDateUTC>2026-04-07T20:12:58.1347919+10:00</d2p1:RunDateUTC>
<d2p1:RunProcessed>true</d2p1:RunProcessed>
<d2p1:RunValue>8.1</d2p1:RunValue>
<d2p1:RunValueIncTax>9.1</d2p1:RunValueIncTax>
<d2p1:StartDateUTC>2026-04-07T20:12:58.1347919+10:00</d2p1:StartDateUTC>
<d2p1:TxnCount>11.1</d2p1:TxnCount>
<d2p1:TxnValue>10.1</d2p1:TxnValue>
</d2p1:BillingRun>
</UnPaginatedItems>
</PaginationOfBillingRuntaHJ6_P0R>