GET api/PayIdBilling/GetPayIdBillingStructuresPaginated?skip={skip}&take={take}&field={field}&reverse={reverse}&name={name}&includeDeleted={includeDeleted}

Request Information

URI Parameters

Name	Type	Additional information
skip	integer	Default value is -1
take	integer	Default value is -1
field	string	Default value is Name
reverse	boolean	Default value is False
name	string	Default value is
includeDeleted	boolean	Default value is False

Body Parameters

None.

Response Information

Resource Description

PaginationOfPayIdBillingStructure

Name	Type	Additional information
IsAllSuccess	boolean	None.
Items	Collection of PayIdBillingStructure	None.
UnPaginatedItems	Collection of PayIdBillingStructure	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": [
    {
      "PayIdBillingStructureID": 1,
      "BillingStructureTypeID": 2,
      "Name": "sample string 3",
      "IncludesGSTInFee": true,
      "ChargeForRUFTxns": true,
      "ChargeForTimeoutTxns": true,
      "ChargeForCancelledTxns": true,
      "GSTPercentage": 8.1,
      "IsDeleted": true,
      "ModifiedDateTimeUtc": "2026-04-07T20:12:11.3157569+10:00",
      "PayIdBillingStructureToEntity": {
        "BillingStructureToEntityID": 1,
        "PayIdBillingStructureID": 2,
        "BillingStructureName": "sample string 3",
        "Name": "sample string 4",
        "EntityCode": "sample string 5",
        "POLiEntityID": "e9d6db19-38e7-4ef8-944d-3d9720d4a2f0",
        "StatusCode": "sample string 7",
        "ActiveDate": "2026-04-07T20:12:11.3157569+10:00",
        "IsDeleted": true
      },
      "CurrencyCode": "sample string 11",
      "CountryID": "439405d7-be41-438f-834b-3ea0ae1f47d2",
      "BillingStructureType": {
        "BillingStructureTypeID": 1,
        "Name": "sample string 2"
      },
      "FixedPrice": {
        "PayIdBillingStructureID": 1,
        "FixedAmount": 2.1
      }
    },
    {
      "PayIdBillingStructureID": 1,
      "BillingStructureTypeID": 2,
      "Name": "sample string 3",
      "IncludesGSTInFee": true,
      "ChargeForRUFTxns": true,
      "ChargeForTimeoutTxns": true,
      "ChargeForCancelledTxns": true,
      "GSTPercentage": 8.1,
      "IsDeleted": true,
      "ModifiedDateTimeUtc": "2026-04-07T20:12:11.3157569+10:00",
      "PayIdBillingStructureToEntity": {
        "BillingStructureToEntityID": 1,
        "PayIdBillingStructureID": 2,
        "BillingStructureName": "sample string 3",
        "Name": "sample string 4",
        "EntityCode": "sample string 5",
        "POLiEntityID": "e9d6db19-38e7-4ef8-944d-3d9720d4a2f0",
        "StatusCode": "sample string 7",
        "ActiveDate": "2026-04-07T20:12:11.3157569+10:00",
        "IsDeleted": true
      },
      "CurrencyCode": "sample string 11",
      "CountryID": "439405d7-be41-438f-834b-3ea0ae1f47d2",
      "BillingStructureType": {
        "BillingStructureTypeID": 1,
        "Name": "sample string 2"
      },
      "FixedPrice": {
        "PayIdBillingStructureID": 1,
        "FixedAmount": 2.1
      }
    }
  ],
  "UnPaginatedItems": [
    {
      "PayIdBillingStructureID": 1,
      "BillingStructureTypeID": 2,
      "Name": "sample string 3",
      "IncludesGSTInFee": true,
      "ChargeForRUFTxns": true,
      "ChargeForTimeoutTxns": true,
      "ChargeForCancelledTxns": true,
      "GSTPercentage": 8.1,
      "IsDeleted": true,
      "ModifiedDateTimeUtc": "2026-04-07T20:12:11.3157569+10:00",
      "PayIdBillingStructureToEntity": {
        "BillingStructureToEntityID": 1,
        "PayIdBillingStructureID": 2,
        "BillingStructureName": "sample string 3",
        "Name": "sample string 4",
        "EntityCode": "sample string 5",
        "POLiEntityID": "e9d6db19-38e7-4ef8-944d-3d9720d4a2f0",
        "StatusCode": "sample string 7",
        "ActiveDate": "2026-04-07T20:12:11.3157569+10:00",
        "IsDeleted": true
      },
      "CurrencyCode": "sample string 11",
      "CountryID": "439405d7-be41-438f-834b-3ea0ae1f47d2",
      "BillingStructureType": {
        "BillingStructureTypeID": 1,
        "Name": "sample string 2"
      },
      "FixedPrice": {
        "PayIdBillingStructureID": 1,
        "FixedAmount": 2.1
      }
    },
    {
      "PayIdBillingStructureID": 1,
      "BillingStructureTypeID": 2,
      "Name": "sample string 3",
      "IncludesGSTInFee": true,
      "ChargeForRUFTxns": true,
      "ChargeForTimeoutTxns": true,
      "ChargeForCancelledTxns": true,
      "GSTPercentage": 8.1,
      "IsDeleted": true,
      "ModifiedDateTimeUtc": "2026-04-07T20:12:11.3157569+10:00",
      "PayIdBillingStructureToEntity": {
        "BillingStructureToEntityID": 1,
        "PayIdBillingStructureID": 2,
        "BillingStructureName": "sample string 3",
        "Name": "sample string 4",
        "EntityCode": "sample string 5",
        "POLiEntityID": "e9d6db19-38e7-4ef8-944d-3d9720d4a2f0",
        "StatusCode": "sample string 7",
        "ActiveDate": "2026-04-07T20:12:11.3157569+10:00",
        "IsDeleted": true
      },
      "CurrencyCode": "sample string 11",
      "CountryID": "439405d7-be41-438f-834b-3ea0ae1f47d2",
      "BillingStructureType": {
        "BillingStructureTypeID": 1,
        "Name": "sample string 2"
      },
      "FixedPrice": {
        "PayIdBillingStructureID": 1,
        "FixedAmount": 2.1
      }
    }
  ],
  "FullCount": 2,
  "Skip": 3,
  "Take": 4,
  "Properties": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  }
}

application/xml, text/xml

Sample:

<PaginationOfPayIdBillingStructurew09FMLyr 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.PayIdBilling">
    <d2p1:PayIdBillingStructure>
      <d2p1:BillingStructureType xmlns:d4p1="http://schemas.datacontract.org/2004/07/ConsoleAPI.Internal.Models.BillingStructure">
        <d4p1:BillingStructureTypeID>1</d4p1:BillingStructureTypeID>
        <d4p1:Name>sample string 2</d4p1:Name>
      </d2p1:BillingStructureType>
      <d2p1:BillingStructureTypeID>2</d2p1:BillingStructureTypeID>
      <d2p1:ChargeForCancelledTxns>true</d2p1:ChargeForCancelledTxns>
      <d2p1:ChargeForRUFTxns>true</d2p1:ChargeForRUFTxns>
      <d2p1:ChargeForTimeoutTxns>true</d2p1:ChargeForTimeoutTxns>
      <d2p1:CountryID>439405d7-be41-438f-834b-3ea0ae1f47d2</d2p1:CountryID>
      <d2p1:CurrencyCode>sample string 11</d2p1:CurrencyCode>
      <d2p1:FixedPrice>
        <d2p1:FixedAmount>2.1</d2p1:FixedAmount>
        <d2p1:PayIdBillingStructureID>1</d2p1:PayIdBillingStructureID>
      </d2p1:FixedPrice>
      <d2p1:GSTPercentage>8.1</d2p1:GSTPercentage>
      <d2p1:IncludesGSTInFee>true</d2p1:IncludesGSTInFee>
      <d2p1:IsDeleted>true</d2p1:IsDeleted>
      <d2p1:ModifiedDateTimeUtc>2026-04-07T20:12:11.3157569+10:00</d2p1:ModifiedDateTimeUtc>
      <d2p1:Name>sample string 3</d2p1:Name>
      <d2p1:PayIdBillingStructureID>1</d2p1:PayIdBillingStructureID>
      <d2p1:PayIdBillingStructureToEntity>
        <d2p1:ActiveDate>2026-04-07T20:12:11.3157569+10:00</d2p1:ActiveDate>
        <d2p1:BillingStructureName>sample string 3</d2p1:BillingStructureName>
        <d2p1:BillingStructureToEntityID>1</d2p1:BillingStructureToEntityID>
        <d2p1:EntityCode>sample string 5</d2p1:EntityCode>
        <d2p1:IsDeleted>true</d2p1:IsDeleted>
        <d2p1:Name>sample string 4</d2p1:Name>
        <d2p1:POLiEntityID>e9d6db19-38e7-4ef8-944d-3d9720d4a2f0</d2p1:POLiEntityID>
        <d2p1:PayIdBillingStructureID>2</d2p1:PayIdBillingStructureID>
        <d2p1:StatusCode>sample string 7</d2p1:StatusCode>
      </d2p1:PayIdBillingStructureToEntity>
    </d2p1:PayIdBillingStructure>
    <d2p1:PayIdBillingStructure>
      <d2p1:BillingStructureType xmlns:d4p1="http://schemas.datacontract.org/2004/07/ConsoleAPI.Internal.Models.BillingStructure">
        <d4p1:BillingStructureTypeID>1</d4p1:BillingStructureTypeID>
        <d4p1:Name>sample string 2</d4p1:Name>
      </d2p1:BillingStructureType>
      <d2p1:BillingStructureTypeID>2</d2p1:BillingStructureTypeID>
      <d2p1:ChargeForCancelledTxns>true</d2p1:ChargeForCancelledTxns>
      <d2p1:ChargeForRUFTxns>true</d2p1:ChargeForRUFTxns>
      <d2p1:ChargeForTimeoutTxns>true</d2p1:ChargeForTimeoutTxns>
      <d2p1:CountryID>439405d7-be41-438f-834b-3ea0ae1f47d2</d2p1:CountryID>
      <d2p1:CurrencyCode>sample string 11</d2p1:CurrencyCode>
      <d2p1:FixedPrice>
        <d2p1:FixedAmount>2.1</d2p1:FixedAmount>
        <d2p1:PayIdBillingStructureID>1</d2p1:PayIdBillingStructureID>
      </d2p1:FixedPrice>
      <d2p1:GSTPercentage>8.1</d2p1:GSTPercentage>
      <d2p1:IncludesGSTInFee>true</d2p1:IncludesGSTInFee>
      <d2p1:IsDeleted>true</d2p1:IsDeleted>
      <d2p1:ModifiedDateTimeUtc>2026-04-07T20:12:11.3157569+10:00</d2p1:ModifiedDateTimeUtc>
      <d2p1:Name>sample string 3</d2p1:Name>
      <d2p1:PayIdBillingStructureID>1</d2p1:PayIdBillingStructureID>
      <d2p1:PayIdBillingStructureToEntity>
        <d2p1:ActiveDate>2026-04-07T20:12:11.3157569+10:00</d2p1:ActiveDate>
        <d2p1:BillingStructureName>sample string 3</d2p1:BillingStructureName>
        <d2p1:BillingStructureToEntityID>1</d2p1:BillingStructureToEntityID>
        <d2p1:EntityCode>sample string 5</d2p1:EntityCode>
        <d2p1:IsDeleted>true</d2p1:IsDeleted>
        <d2p1:Name>sample string 4</d2p1:Name>
        <d2p1:POLiEntityID>e9d6db19-38e7-4ef8-944d-3d9720d4a2f0</d2p1:POLiEntityID>
        <d2p1:PayIdBillingStructureID>2</d2p1:PayIdBillingStructureID>
        <d2p1:StatusCode>sample string 7</d2p1:StatusCode>
      </d2p1:PayIdBillingStructureToEntity>
    </d2p1:PayIdBillingStructure>
  </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.PayIdBilling">
    <d2p1:PayIdBillingStructure>
      <d2p1:BillingStructureType xmlns:d4p1="http://schemas.datacontract.org/2004/07/ConsoleAPI.Internal.Models.BillingStructure">
        <d4p1:BillingStructureTypeID>1</d4p1:BillingStructureTypeID>
        <d4p1:Name>sample string 2</d4p1:Name>
      </d2p1:BillingStructureType>
      <d2p1:BillingStructureTypeID>2</d2p1:BillingStructureTypeID>
      <d2p1:ChargeForCancelledTxns>true</d2p1:ChargeForCancelledTxns>
      <d2p1:ChargeForRUFTxns>true</d2p1:ChargeForRUFTxns>
      <d2p1:ChargeForTimeoutTxns>true</d2p1:ChargeForTimeoutTxns>
      <d2p1:CountryID>439405d7-be41-438f-834b-3ea0ae1f47d2</d2p1:CountryID>
      <d2p1:CurrencyCode>sample string 11</d2p1:CurrencyCode>
      <d2p1:FixedPrice>
        <d2p1:FixedAmount>2.1</d2p1:FixedAmount>
        <d2p1:PayIdBillingStructureID>1</d2p1:PayIdBillingStructureID>
      </d2p1:FixedPrice>
      <d2p1:GSTPercentage>8.1</d2p1:GSTPercentage>
      <d2p1:IncludesGSTInFee>true</d2p1:IncludesGSTInFee>
      <d2p1:IsDeleted>true</d2p1:IsDeleted>
      <d2p1:ModifiedDateTimeUtc>2026-04-07T20:12:11.3157569+10:00</d2p1:ModifiedDateTimeUtc>
      <d2p1:Name>sample string 3</d2p1:Name>
      <d2p1:PayIdBillingStructureID>1</d2p1:PayIdBillingStructureID>
      <d2p1:PayIdBillingStructureToEntity>
        <d2p1:ActiveDate>2026-04-07T20:12:11.3157569+10:00</d2p1:ActiveDate>
        <d2p1:BillingStructureName>sample string 3</d2p1:BillingStructureName>
        <d2p1:BillingStructureToEntityID>1</d2p1:BillingStructureToEntityID>
        <d2p1:EntityCode>sample string 5</d2p1:EntityCode>
        <d2p1:IsDeleted>true</d2p1:IsDeleted>
        <d2p1:Name>sample string 4</d2p1:Name>
        <d2p1:POLiEntityID>e9d6db19-38e7-4ef8-944d-3d9720d4a2f0</d2p1:POLiEntityID>
        <d2p1:PayIdBillingStructureID>2</d2p1:PayIdBillingStructureID>
        <d2p1:StatusCode>sample string 7</d2p1:StatusCode>
      </d2p1:PayIdBillingStructureToEntity>
    </d2p1:PayIdBillingStructure>
    <d2p1:PayIdBillingStructure>
      <d2p1:BillingStructureType xmlns:d4p1="http://schemas.datacontract.org/2004/07/ConsoleAPI.Internal.Models.BillingStructure">
        <d4p1:BillingStructureTypeID>1</d4p1:BillingStructureTypeID>
        <d4p1:Name>sample string 2</d4p1:Name>
      </d2p1:BillingStructureType>
      <d2p1:BillingStructureTypeID>2</d2p1:BillingStructureTypeID>
      <d2p1:ChargeForCancelledTxns>true</d2p1:ChargeForCancelledTxns>
      <d2p1:ChargeForRUFTxns>true</d2p1:ChargeForRUFTxns>
      <d2p1:ChargeForTimeoutTxns>true</d2p1:ChargeForTimeoutTxns>
      <d2p1:CountryID>439405d7-be41-438f-834b-3ea0ae1f47d2</d2p1:CountryID>
      <d2p1:CurrencyCode>sample string 11</d2p1:CurrencyCode>
      <d2p1:FixedPrice>
        <d2p1:FixedAmount>2.1</d2p1:FixedAmount>
        <d2p1:PayIdBillingStructureID>1</d2p1:PayIdBillingStructureID>
      </d2p1:FixedPrice>
      <d2p1:GSTPercentage>8.1</d2p1:GSTPercentage>
      <d2p1:IncludesGSTInFee>true</d2p1:IncludesGSTInFee>
      <d2p1:IsDeleted>true</d2p1:IsDeleted>
      <d2p1:ModifiedDateTimeUtc>2026-04-07T20:12:11.3157569+10:00</d2p1:ModifiedDateTimeUtc>
      <d2p1:Name>sample string 3</d2p1:Name>
      <d2p1:PayIdBillingStructureID>1</d2p1:PayIdBillingStructureID>
      <d2p1:PayIdBillingStructureToEntity>
        <d2p1:ActiveDate>2026-04-07T20:12:11.3157569+10:00</d2p1:ActiveDate>
        <d2p1:BillingStructureName>sample string 3</d2p1:BillingStructureName>
        <d2p1:BillingStructureToEntityID>1</d2p1:BillingStructureToEntityID>
        <d2p1:EntityCode>sample string 5</d2p1:EntityCode>
        <d2p1:IsDeleted>true</d2p1:IsDeleted>
        <d2p1:Name>sample string 4</d2p1:Name>
        <d2p1:POLiEntityID>e9d6db19-38e7-4ef8-944d-3d9720d4a2f0</d2p1:POLiEntityID>
        <d2p1:PayIdBillingStructureID>2</d2p1:PayIdBillingStructureID>
        <d2p1:StatusCode>sample string 7</d2p1:StatusCode>
      </d2p1:PayIdBillingStructureToEntity>
    </d2p1:PayIdBillingStructure>
  </UnPaginatedItems>
</PaginationOfPayIdBillingStructurew09FMLyr>