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



 

Home > Aria Crescendo Documentation > Aria Crescendo core api > get_client_item_prices_m

get_client_item_prices_m

Returns a list of prices for inventory item.

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.
  filter_currency_cd string 3 The 3-character ISO-compliant currency code in lowercase for monetary values used in the context of this API method.
  return_no_cost_items string 5 A boolean value that asserts the API call should include no-cost items in its returned results (true/1=yes, false/0=no). (DEPRECATED)
required-icon.png filter_item_no long 8 Aria-assigned unique identifier indicating Client Inventory Item.
  OR      
  filter_client_item_id string 100 Client assigned unique identifier indicating client Inventory Item.

Output Arguments

Field Name Field Type Description
item_rates hash (DEPRECATED)
brd_arrow.gif price double (DEPRECATED) The total price for this item
brd_arrow.gif price_per_unit double (DEPRECATED) The price for a single unit of this item
brd_arrow.gif currency_cd string (DEPRECATED) The ISO-compatible 3-digit currency code for the currency this item price bills in
schedule    
brd_arrow.gifschedule_no long The ID of this rate schedule
brd_arrow.gifschedule_name string Name for the rate schedule
brd_arrow.gifclient_rate_schedule_id string Client-defined unique identifier
brd_arrow.gifcurrency_cd string Currency for the schedule
brd_arrow.gifis_default string This flag denotes if this rate schedule is the default one for this plan. One and only one rate schedule can be marked as default. The value of 1 is defaulted for the first rate schedule for a given currency denoting it is the default. For subsequent rate schedules, the default is set to 0.
brd_arrow.giftax_inclusive_ind    
brd_arrow.giftier array This array contains tiered pricing information for the given rate schedule.
brd_arrow.gifbrd_arrow.gifrate_schedule_name string Name of rate schedule this tier belongs to.
brd_arrow.gifbrd_arrow.gifclient_rate_schedule_id string Client-defined unique identifier for the rate schedule.
brd_arrow.gifbrd_arrow.gifamount float Tiered pricing rule that specifies rate per unit.
brd_arrow.gifbrd_arrow.giffrom int Tiered pricing rule that specifies "from" units.
brd_arrow.gifbrd_arrow.gifto int Tiered pricing rule that specifies to units.
brd_arrow.gifbrd_arrow.gifdescription string This field is used to display custom rate tier description. This will override the rate tier's description at service level.
nso_rate_schedules    
brd_arrow.gifrate_schedule_no long The ID of this rate schedule
brd_arrow.gifrate_schedule_name string Name for the rate schedule
brd_arrow.gifclient_rate_schedule_id string Client-defined unique identifier
brd_arrow.gifcurrency_cd string Currency for the schedule
brd_arrow.gifis_default string This flag denotes if this rate schedule is the default one for this item. One and only one rate schedule can be marked as default. The value of 1 is defaulted for the first rate schedule for a given currency denoting it is the default. For subsequent rate schedules, the default is set to 0.
brd_arrow.giftax_inclusive_ind string This flag denotes if a rate is inclusive of taxes. Valid values are: 1 -  Means tax inclusive rates and 0 (default) - Means tax exclusive rates.
brd_arrow.gifnso_rate_tiers    
brd_arrow.gifbrd_arrow.gifrate_seq_no long Sequential number in the rate schedule for dertermining tiers
brd_arrow.gifbrd_arrow.giffrom_unit double Specifies the starting unit for the given tier.
brd_arrow.gifbrd_arrow.gifto_unit double Specifies the ending unit for the given tier
brd_arrow.gifbrd_arrow.gifrate_per_unit double Specifies the rate per unit billed
brd_arrow.gifbrd_arrow.gifdescription string This field is used to display custom rate tier description. This will override the rate tier's description at service level.
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.
Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.