IDI version 26.8 is now available.  Click here for details: IDI Updates.

Flags Always Included

Prev Next

The following table lists tags that are always included in the XML file:

XML Tag

Description

Example

version

Standard release version associated with the release level and build number.

<ifx version=”8.01.03”>

corp_ charge

Rolled-up child taxes, recurring and non-recurring charges.

<corp_charge amt=”32.05”>

parent_ charge

Total tax for the parent.

<parent_charge amt=”53.91”>

payment_ type

Identifies customers who pay automatically by credit card or debit card. Value = “direct_debit” or “e_pay”.

<indicators payment_type=”direct_debit” />

or

<indicators payment_type=”e_pay” />

Invoice New Customer

The following tag requires that the new customer entry be set in Admin Console.

XML Tag

Description

Example

status

Identifies new customer bills.

<indicators status=”N” />

or

<indicators status=”Y” />

Customer Invoice Messages

The following tag identifies report group notes and customer notes.

  • ReportGroupNote messages are received by all customers in that Report Group.

  • CustomerNote messages are received only by the specific customer as designated in Customer Management.

    XML Tag

    Description

    Example

    messages

    Identifies invoice messages.

    <messages>

    <message name=”ReportGroupNote”> Subscribe to our Pager Plus Service and receive 25 FREE local calls each month!!!</message>

    <message name=”CustomerNote”>THIS INVOICE IS OVER DUE AND PAYABLE IMMEDIATELY< /message>

    </messages>

Entitlements

The following tag displays the amount of the entitlements that the customer receives. This is part of the financials section of the output.

XML Tag

Description

Example

entitlements

Identifies value of customer’s entitlements.

<entitlements amt=”-2.00” />

Sales Person

To include sales person information, the sales tag must be included with the indicators.

XML Tag

Description

Example

sales_person

Enters the sales person’s name.

<indicators suppress_print=”N” report_group=”2” sales_person=”John Doe” />

Additional Company Address

An additional company address can be added for inclusion on the invoice. This centralized information is not specific to any Billing Group. See the settings in Admin Console.

XML Tag

Description

Example

company_info

Identifies an alternative “return” address on the invoice.

<company_info>

<name>Info Directions</name>

<location>

<address>833 Phillips Rd.</address>

<address>Suite C</address>

<city>Victor</city>

<region>NY</region>

<postal>14564</postal>

</location>

<phone>585-924-4110</phone>

</company_info>

OCN Tiered Rating Method

Information can be included in the usage summary reports for OCN tiered rating if your company uses the OCN Tiered rating method. See settings in Admin Console. OCN tiered rating method only applies to Equal Access, Toll Free, Equal Access Dedicated, and Toll Free Dedicated based services.

XML Tag

Description

Example

from_tier

Displays the name of the OCN tier used for the originating OCN.

see below

to_tier

Displays the name of the OCN tier used for the terminating OCN.

see below

OrigOCN

Displays the originating OCN (Operating Company Number).

see below

OrigOCNTier

Displays the origination OCN tier name.

see below

TermOCN

Displays the terminating OCN.

see below

TermOCNTier

Displays the terminating OCN tier name.

see below

<usage_summary desc="Usage Summary" unit_type="Minutes">

<usage_svc_charges>

<usg_sum_item type="Test User_800 service" usg_type="800 Service" distance="Interstate" from_tier="Default" to_tier="Default" qty="31" nUnits="153.4" amt="5.4330"/>

<subTotal_type type="Test User 800 service" qty="31" nUnits="153.4" amt="5.4330"/>

</usage_svc_charges>

<usage_svc_charges>

<usg_sum_item type="Test User EA" usg_type="Directory Assistance" distance="Intrastate" from_tier="Default" to_tier="Default" qty="1" nUnits="1.0" amt="1.0000"/>

<subTotal_type type="Test User EA" qty="1" nUnits="1.0" amt="1.0000"/>

</usage_svc_charges>

<subTotal qty="32" nUnits="154.4" amt="6.4330"/>

</usage_summary>

<account_code_service_detail number="(800) 778-5658" type="Test User 800 service" name="" department="" branch="" pin="" provisioningcompany="Sprint" disconnect_date="8/10/2001" unit_type="Minutes">

<usgitem nn="1" date="10/06/1997 01:21AM" minutes="4.2" number="(502) 298-8880" location="Louisville" region="KY" amt="0.0000" period="3" usgtype="800 Service" orig_ocn="7471" orig_ocn_tier="Default" term_ocn="0772" term_ocn_tier="Default" payphone="N" cic_symbol=""/>

<usgitem nn="2" date="10/06/1997 01:31AM" minutes="8.4" number="(209) 993-8497" location="Stockton" region="CA" amt="0.1200" period="3" usgtype="800 Service" orig_ocn="6232" orig_ocn_tier="Default" term_ocn="0772" term_ocn_tier="Default" payphone="N" cic_symbol=""/>

<usgitem nn="3" date="10/06/1997 01:31AM" minutes="8.4" number="(209) 993-8497" location="Stockton" region="CA" amt="0.1200" period="3" usgtype="800 Service" orig_ocn="6232" orig_ocn_tier="Default" term_ocn="0772" term_ocn_tier="Default" payphone="N" cic_symbol=""/>

<usgitem nn="4" date="10/06/1997 04:57AM" minutes="6.5" number="(215) 592-0542" location="Phila" region="PA" amt="0.2860" period="3" usgtype="800 Service" orig_ocn="9208" orig_ocn_tier="Default" term_ocn="0772" term_ocn_tier="Default" payphone="N" cic_symbol=""/>

<usgitem nn="5" date="10/06/1997 04:57AM" minutes="6.5" number="(215) 592-0542" location="Phila" region="PA" amt="0.0250" period="3" usgtype="800 Service" orig_ocn="9208" orig_ocn_tier="Default" term_ocn="0772" term_ocn_tier="Default" payphone="N" cic_symbol=""/>

<usgitem nn="6" date="10/06/1997 06:30AM" minutes="6.7" number="(507) 744-7909" location="Lonsdale" region="MN" amt="0.0350" period="3" usgtype="800 Service" orig_ocn="1422" orig_ocn_tier="Default" term_ocn="0772" term_ocn_tier="Default" payphone="N" cic_symbol=""/>

Packages Tree Structure

Packages can be a part of a package creating a tree structure of up to 4 levels. The attribute “package” can have the following values PP (package parent, PC (package child), PSP (package under a parent package or a subpackage under a child package), PSC (child under a child package or child under a subchild package), and NP (single product).

XML Tag

Description

Example

package

Describes the level of the product in the package tree structure.

see below for an example

<detail_new_charges_recurr>

<account_charges>

<charge desc="test package" type="recur" prod_num="3394" vendor_num="" amt="47.0000" charge_status="Prorated Charge" qty="2" start_date="03/07/2002" end_date="03/31/2002" unit_rate="23.5000" package="PP"/>

<charge desc="Call Waiting" type="recur" prod_num="1009" vendor_num="" amt="0.0000" charge_status="Prorated Charge" qty="2" start_date="03/07/2002" end_date="03/31/2002" unit_rate="0.0000" package="PC" p_p_num="3394"/>

<charge desc="Voice Mail" type="recur" prod_num="1011" vendor_num="" amt="0.0000" charge_status="Prorated Charge" qty="2" start_date="03/07/2002" end_date="03/31/2002" unit_rate="0.0000" package="PC" p_p_num="3394"/>

<charge desc="Entitlement Test" type="recur" prod_num="21571" vendor_num="" amt="4.0000" charge_status="Monthly Charge" qty="1" start_date="03/01/2002" end_date="03/31/2002" unit_rate="4.0000" package="NP"/>

<charge desc="test package" type="recur" prod_num="3394" vendor_num="" amt="0.0000" charge_status="Prorated Charge" qty="2" start_date="03/07/2002" end_date="03/31/2002" unit_rate="0.0000" package="PP"/>

<charge desc="Call Waiting" type="recur" prod_num="1009" vendor_num="" amt="0.0000" charge_status="Prorated Charge" qty="2" start_date="03/07/2002" end_date="03/31/2002" unit_rate="0.0000" package="PC" p_p_num="3394"/>

<charge desc="Voice Mail" type="recur" prod_num="1011" vendor_num="" amt="0.0000" charge_status="Prorated Charge" qty="2" start_date="03/07/2002" end_date="03/31/2002" unit_rate="0.0000" package="PC" p_p_num="3394"/>

<subTotal qty="7" amt="51.0000"/>

</account_charges>

<service_charges number="(201) 202-2010" type="Equal Access" name="" usgsvcid="104740">

<charge desc="Internet Access" type="recur" prod_num="1000" vendor_num="" amt="15.0000" charge_status="Monthly Charge" qty="1" start_date="03/01/2002" end_date="03/31/2002" unit_rate="15.0000" package="NP"/>

<subTotal qty="1" amt="15.0000"/>

</service_charges>

<service_charges number="(401) 464-8801" type="QATest_User_EA" name="" usgsvcid="9996">

<charge desc="Call Waiting" type="recur" prod_num="1009" vendor_num="" amt="3.9500" charge_status="Monthly Charge" qty="1" start_date="03/01/2002" end_date="03/31/2002" unit_rate="3.9500" package="NP"/>

<charge desc="Voice Mail" type="recur" prod_num="1011" vendor_num="" amt="4.9500" charge_status="Monthly Charge" qty="1" start_date="03/01/2002" end_date="03/31/2002" unit_rate="4.9500" package="NP"/>

<charge desc="pager-min-usage" type="recur" prod_num="2000" vendor_num="" amt="2.9500" charge_status="Monthly Charge" qty="1" start_date="03/01/2002" end_date="03/31/2002" unit_rate="2.9500" package="NP"/>

<subTotal qty="3" amt="11.8500"/>

</service_charges>

<subTotal qty="11" amt="77.8500"/>

</detail_new_charges_recurr>

<detail_new_charges_nonrecurr>

<account_charges>

<charge desc="Non-Recurring Product" type="nonrecur" prod_num="21593" vendor_num="" amt="15.0000" qty="1" charge_status="" start_date="03/15/2002" end_date="" unit_rate="15.0000" package="NP"/>

<charge desc="AR678 One Price Package NR" type="nonrecur" prod_num="21634" vendor_num="" amt="10.0000" qty="1" charge_status="" start_date="03/05/2002" end_date="" unit_rate="10.0000" package="PP"/>

<charge desc="AR678 - Child Product 1 NR" type="nonrecur" prod_num="21635" vendor_num="" amt="0.0000" charge_status="" qty="1" start_date="03/05/2002" end_date="" unit_rate="0.0000" package="PC" p_p_num="21634"/>

<charge desc="AR678 - Child Product 2NR" type="nonrecur" prod_num="21636" vendor_num="" amt="0.0000" charge_status="" qty="1" start_date="03/05/2002" end_date="" unit_rate="0.0000" package="PC" p_p_num="21634"/>

<charge desc="AR678 - Child One Price Pkg NR" type="nonrecur" prod_num="21637(21634)" vendor_num="" amt="0.0000" charge_status="" qty="1" start_date="03/05/2002" end_date="" unit_rate="0.0000" package="PSP"/>

<charge desc="AR678 - Child Pkg Product 1 NR" type="nonrecur" prod_num="21638" vendor_num="" amt="0.0000" charge_status="" qty="1" start_date="03/05/2002" end_date="" unit_rate="0.0000" package="PSC" p_p_num="21637"/>

<charge desc="AR678 - Child Pkg Product 2 NR" type="nonrecur" prod_num="21639" vendor_num="" amt="0.0000" charge_status="" qty="1" start_date="03/05/2002" end_date="" unit_rate="0.0000" package="PSC" p_p_num="21637"/>

<subTotal qty="2" amt="25.0000"/>

</account_charges>

<subTotal qty="2" amt="25.0000"/>

</detail_new_charges_nonrecurr>