Bill Profiles

BillProfiles_Query

Used to search for one or more Bill Profiles.

Required Input
None

Optional/Conditional Input

BillProfileID As Integer – when specified, will only return a Bill Profile matching the ID provided.
Name As String – when specified, will only return a Bill Profile matching the Name provided.

Output

A list of matching:
ID As Integer – Bill_Profile_ID field from Rev.io's Bill Profile.
Name As String – Name field from Rev.io's Bill Profile.

Examples

<BillProfiles_Query xmlns="http://api.myh2o.com/">
    <Request>
        <Session>
            <SessionKey>xyzabc123</SessionKey>
        </Session>
    </Request>
</BillProfiles_Query>

<BillProfiles_QueryResponse xmlns="http://api.myh2o.com/">
    <BillProfiles_QueryResult>
        <Header>
            <Success>true</Success>
            <SessionKey>xyzabc123</SessionKey>
        </Header>
        <BillProfiles>
            <BillProfile>
                <ID>1</ID>
                <Name>Prepaid Customers</Name>
            </BillProfile>
            <BillProfile>
                <ID>2</ID>
                <Name>Postpaid Customers</Name>
            </BillProfile>
        </BillProfiles>
    </BillProfiles_QueryResult>
</BillProfiles_QueryResponse>