Search the Aria Knowledgebase for
User Documentation, APIs, SDKs, and more!



 

Home > Aria Crescendo core api > get_acct_surcharges_m

get_acct_surcharges_m

Use this API to return the details of surcharges assigned to the given account/Master Plan Instance.

For error messages generated by this API, see get_acct_surcharges_m Error Messages.

Input Arguments

Req Field Name Field Type Max Length Description
required-icon.png client_no long 22 Aria-assigned unique identifier indicating the Aria client providing service to this account.
required-icon.png auth_key string 32 Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor.
required-icon.png acct_no long 22 Aria-assigned account identifier. This value is unique across all Aria-managed accounts.
  OR      
  client_acct_id string 50 Client-defined account identifier.
  master_plan_instance_no long 22 The unique identifier for the master plan instance.
  OR      
  client_master_plan_instance_id string 100 Client-defined unique identifier for the master plan instance.
  include_detail_ind string 5 Whether or not this is to retrieve the surcharge rate details   Allowable Values
  locale_no long 22 Aria-assigned unique identifier of the locale used for translations. This value must be unique across all Aria clients.
  OR      
  locale_name string 100 Name of the locale.
 

Output Arguments

Field Name Field Type Description
all_surcharges hash An array containing surcharges.
brd_arrow.gif surcharge_no long The surcharge number for a specific account
brd_arrow.gif surcharge_name string The Aria-assigned surcharge name for that account
brd_arrow.gif client_surcharge_id string Client-defined surcharge id.
brd_arrow.gif description string Description for the surcharge number
brd_arrow.gif ext_description string Ext_description for the surcharge number
brd_arrow.gif surcharge_type string It specifies the surcharge type   Allowable Values
brd_arrow.gif currency string The currency to which this surcharge applies
brd_arrow.gif tax_group string If taxable, the tax group this item belongs to
brd_arrow.gif invoice_app_method string Invoice applied method
brd_arrow.gif rev_gl_code string rev gl code for this surcharge
brd_arrow.gif ar_gl_code string Aria-defined general ledger code
brd_arrow.gif surcharge_plan hash Represents all the plans of the surcharge
brd_arrow.gif plan_no long Aria-assigned unique plan identifier
brd_arrow.gif plan_name string Specifies the name of the plan associated with the plan_no.
brd_arrow.gif surcharge_rate hash Represents the rates for the default rate schedule for the default currency for the plan
brd_arrow.gif rate_seq_no long Sequential number in the rate schedule for dertermining tiers
brd_arrow.gif from_unit double Tiered Units (from) This value represents the start of a tiered range of values.
brd_arrow.gif to_unit double Tiered Units (to) This value represents the end of the range for a single tier of values.
brd_arrow.gif rate_per_unit double The cost per unit of this service over the time period the plan is billed for
brd_arrow.gif include_zero long This indicator indicates whether the rate schedule has includes zero or not.   Allowable Values
brd_arrow.gif rate_sched_is_assigned_ind long This indicator indicates the assigned rate schedule for the surcharge.   Allowable Values
error_code long Aria-assigned error identifier. 0 indicates no error.
error_msg string Description of any error that occurred. "OK" if there was no error.
acct_locale_no long Aria-assigned unique identifier of the locale used for translations. This value is unique across all Aria-managed accounts. DEPRECATED
acct_locale_no_2 long Aria-assigned unique identifier of the locale used for translations. This value is unique across all Aria-managed accounts.
acct_locale_name string Name of the account level locale.
 
 
 
Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.