| error_code |
long |
Aria-assigned error identifier. 0 indicates no error. |
| error_msg |
string |
Textual description of any error that occurred. "OK" if there was no error. |
| surcharge_no |
int |
Specifies Surcharge No |
| surcharge_name |
string |
Specifies Surcharge Name |
| client_surcharge_id |
string |
Specifies client defined id for Surcharge |
| description |
string |
Specifies description for the Surcharge |
| ext_description |
string |
Specifies description that can be added to statment and is visible to the user. |
| currency_cd |
string |
Specifies the currency code of the surcharge |
| surcharge_type_cd |
string |
Specifies whether the discount is going to be fixed or percentage based.
Allowable values for surcharge_type_cd
| Values |
Description |
| F |
Fixed discount |
| S |
Standard percentage discount |
| V |
Volume percentage discount |
|
| inline_offset_ind |
string |
Specifies how the discount will be displayed in the invoice.
Allowable values for inline_offset_ind
| Values |
Description |
| I |
Includes with original line item(s) |
| O |
Adds a separate surcharge line item |
|
| tax_group |
int |
Specifies the tax group to be used while calculating surcharge. |
| gl_cd |
string |
Specifies the revenue account chart of access code |
| ar_gl_cd |
string |
Specifies the account recievable chart of access code |
| apply_b4_or_after_discount_cd |
string |
Specifies whether the surcharge should consider item totals before or after discounts are applied
Allowable values for apply_b4_or_after_discount_cd
| Values |
Description |
| B |
Before the discount |
| A |
After the discount |
|
| apply_to_zero_invoice_ind |
int |
Deprecated Specifies whether the minimum surcharge should apply to zero dollar invoice or not. |
| scope_no |
int |
Specifies the charges eligible for the discount.
Allowable values for scope_no
| 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 |
|
| surcharge_tier |
hash |
|
 from |
int |
Returned in the following format: surcharge_tier[0][from]=1&surcharge_tier[1][from]=1 etc. Index 0 specifies the first tier and 1 specifies the second tier and so on. |
| to |
int |
Returned in the following format: surcharge_tier[0][to]=3&surcharge_tier[1][to]=7 etc. Index 0 specifies the first tier and 1 specifies the second tier and so on. |
| rate |
float |
Returned in the following format: surcharge_tier[0][rate]=3&surcharge_tier[1][rate]=4 etc. |
| description |
string |
Returned in the following format: surcharge_tier[0][description]=description&surcharge_tier[1][rate]=surcharge etc. |
| plan_no |
hash |
Aria-assigned unique plan identifier |
| plan_nos |
int |
Specifies the plan that are eligible for the surcharge. This is mandatory for scope 3 and 5.REST input arrays should be passed in the following format: plan_no[0]=1002&plan_no[1]=1003 etc |
| client_plan_id |
hash |
|
| client_plan_ids |
string |
Specifies the plan that are eligible for the surcharge. This is mandatory for scope 3 and 5.REST input arrays should be passed in the following format: client_plan_id[0]=1002&client_plan_id[1]=1003 etc |
| service_no |
hash |
|
| service_nos |
int |
Specifies the services that are eligible for the surcharge. This is mandatory for scope 4 and 5. REST input arrays should be passed in the following format: For scope 4 service_no[0]=1002&service_no[1]=1003 For scope 5 service_no[0][0]=10002&service_no[0][1]=1001&service_no[1][0]=100&service_no[1][1]=103 |
| client_service_id |
hash |
|
| client_service_ids |
string |
Specifies the services that are eligible for the surcharge. This is mandatory for scope 4 and 5. REST input arrays should be passed in the following format: For scope 4 client_service_id[0]=1002&client_service_id[1]=1003 For scope 5 client_service_id[0][0]=10002 |
| item_no |
hash |
|
| item_nos |
int |
Specifies the inventory items that are eligible for the surcharge. This is mandatory for scope 10. REST input arrays should be passed in the following format: item_no[0]=1002&item_no[1]=103 |
| client_sku |
string array |
Client SKU of the NSO/Inventory item |
| plan_service |
hash |
|
| plan_no |
int |
Specifies the plans that are eligible for the surcharge. |
| client_plan_id |
string |
|
| service_no |
hash |
|
| service_nos |
int |
Specifies the services that are eligible for the surcharge. |
| client_service_id |
hash |
|
| client_service_ids |
string |
Specifies the client defined id for the services that are eligible for the surcharge. |
| surcharge_scope |
int |
Specifies the surcharge application. The value will be available only for EOM Clients.
Allowable values for surcharge_scope
| 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. |
|
| pay_method |
hash |
Payment method types on which this surcharge is applied to. |
| payment_method_type |
string |
|
| surcharge_translation_details |
hash |
Array that contains all the translated values for a given locale. |
| locale_name |
string |
Name of the locale |
| locale_no |
int |
Aria-assigned unique identifier of the locale used for translations. |
| surcharge_no |
int |
Specifies Surcharge No |
| surcharge_name |
string |
Specifies Surcharge Name |
| description |
string |
Specifies description for the Surcharge |
| ext_description |
string |
Specifies description that can be added to statment and is visible to the user. |
| surcharge_tier_t |
hash |
|
| description |
string |
Returned in the following format: surcharge_tier[0][description]=description&surcharge_tier[1][rate]=surcharge etc. |
