create_surcharge_m Guide

Last updated
Save as PDF

Creates a surcharge

Note: The previously existing input and/or output fields <client_item_id>, <client_item_id_out> and/or <filter_client_item_id> were removed from this API call in Release 47.

API Specification:	create_surcharge_m
Required Fields:	<client_no> <auth_key> <surcharge_name> <description> <currency_cd> <surcharge_type_cd> <inline_offset_ind> <apply_b4_or_after_discount_cd> <scope_no> <surcharge_tier> (array) <from> <rate> <schedule> (array) <schedule_name> <currency_cd>

Additional Guidance:

Input Fields

Field Name

Notes

<surcharge_type_cd>

Allowable Values

Values	Description
F	Fixed surcharge
V	Volume percentage (Volume surcharge)
S	Standard percentage

<inline_offset_ind>

Allowable Values

Values	Description
I	Includes with original line item(s)
O	Adds a separate surcharge line item

<apply_b4_or_after_discount_cd>

Allowable Values

Values	Description
B	Before the discount
A	After the discount

<scope_no>

Allowable Values

Values	Description
1	All Charges
2	All Plan Charges, All Plans
3	All Plan Charges, Specified Plans
4	All Plans, Specified Service Charges
5	Specified Plan/Service Charges
6	All Recurring Service Charges
7	All Usage Service Charges
8	All Activation Service Charges
9	All Item Charges
10	Specified Item Charges
11	Payment Method
12	Payment Term

<is_default>

Allowable Values

Values	Description
0	The rate schedule is taken as default for the currency
1	The rate schedule is not taken as default for the currency

<include_zero>

Allowable Values

Values	Description
1	Include zero in rate tier
0	Ignore zero in rate tier

<surcharge_scope>

Allowable Values

Values	Description
1	Surcharge can be applied to Account only.
2	Surcharge can be applied to Master plan instance only.
3	Surcharge can be applied to Account & Master plan instance.

<tax_inclusive_ind>

Allowable Values

Values	Description
0	False or indicates tax exclusive surcharge (default)
1	True or indicates surcharge is inclusive of taxes.