Aria API Glossary of Abbreviations (Core, AdminTools, ObjectQuery)

Last updated
Save as PDF
Share
1. Share
2. Tweet
3. Share

Overview

Below are abbreviations and their common usage within the Aria Core, AdminTools, and ObjectQuery API methods.

Sources: plsql_m.yml, methods_m.yml, app_m.yml

Method Name Abbreviations


Abbreviation	Full English Word/Phrase	Example Method(s)
`acct`/`accts`	account/accounts	`get_acct_balance_m`, `get_child_accts_m`
`ariara`	Aria Revenue Analytics	`enable_ariara_m`, `update_ariara_user_permission_m`
`associ`	associated	`get_associ_plan_for_surcharge_internal_m`
`auth`	authorization/authentication (context-dependent)	`set_session_auth_m`, `reverse_authorized_electronic_payment_m`
`avail`	available	`get_avail_plans_for_acct_m`
`avs`	Address Verification System	`get_paypal_avs_status_m`
`bal`	balance	`get_inv_no_from_bal_xfer_m`
`calc`	calculate	`calc_credit_reference_line_m`, `pre_calc_invoice_m`
`cc`	credit card	`compare_against_cc_blacklist_m`, `get_cc_uuid_m`
`cm`	credit memo	`apply_cm_m`, `create_cm_m`, `get_cm_details_m`
`config`	configuration	`get_reg_uss_config_params_m`, `clear_reg_uss_config_params_m`
`dtls`	details	`get_payment_application_dtls_m`
`gen`	generate	`gen_invoice_m`, `gen_statement_m`, `gen_random_string_m`
`grp`	group	`set_acct_notify_tmplt_grp_m`
`inst`	instance	`get_plan_unit_inst_fields_internal_m`
`inv`/`invs`	invoice/invoices	`get_inv_no_from_bal_xfer_m`, `get_reversible_invs_by_payment_m`
`mpis`	master plan instances	`get_mpis_for_billing_group_internal_m`
`mtd`	month-to-date	`set_usg_mtd_ptd_bal_m`
`no`	number	`get_acct_no_from_user_id_m`, `get_pending_invoice_no_m`
`notify`	notification	`get_acct_notify_method_m`, `set_acct_notify_override_m`
`nso`	non-subscription offering	`get_acct_nso_inclusion_list_m`, `get_client_plan_nso_prices_internal_m`
`obj`	object	`create_supp_obj_field_m`, `get_supp_obj_fields_m`, `list_supp_obj_fields_m`
`params`	parameters	`get_reg_uss_params_m`, `clear_reg_uss_config_params_m`
`pmt`	payment	`get_pmt_uuid_m`
`promo`	promotional	`get_plans_by_promo_code_m`, `get_supp_plans_by_promo_code_m`
`prov`	provisioning	`set_prov_engine_m`
`ptd`	period-to-date	`set_usg_mtd_ptd_bal_m`
`rb`	rebill	`gen_rb_m`
`reg`	registration	`get_reg_uss_params_m`, `clear_reg_uss_config_params_m`
`revrec`	revenue recognition	`create_revrec_profile_m`, `delete_revrec_profile_m`, `get_revrec_profiles_m`
`srvcs`	services	`get_plan_unit_instance_srvcs_internal_m`
`supp`	supplemental	`get_acct_supp_fields_m`, `get_supp_plans_by_promo_code_m`
`tmplt`	template	`set_acct_notify_tmplt_grp_m`, `get_credit_tmplt_service_types_internal_m`
`trans`	transaction	`get_acct_trans_history_m`, `get_family_trans_history_m`
`usg`	usage	`set_usg_threshold_m`, `set_usg_mtd_ptd_bal_m`
`uss`	user self-service	`get_reg_uss_params_m`, `clear_reg_uss_config_params_m`
`uuid`/`uuids`	universally unique identifier(s)	`get_cc_uuid_m`, `get_pmt_uuid_m`, `get_acct_uuids_m`
`vals`	values	`get_web_replacement_vals_m`
`xfer`	transfer	`get_inv_no_from_bal_xfer_m`

Field Name Abbreviations


Abbreviation	Full English Word/Phrase	Example Field(s)
`addr`	address	`addr_address1`, `addr_method_cd`, `bill_addr_method_cd`
`adv`	advance	`adv_billing_period_end`, `adv_billing_period_start`
`alt`	alternate	`alt_label`, `alt_pay_method`, `alt_rate_schedule_no`
`amt`	amount	`applied_amt`, `apply_amt`, `before_round_adjusted_tax_amt`
`ar`	accounts receivable	`ar_gl_code`
`b4`	before	`apply_b4_or_after_discount_cd`
`bcc`	blind carbon copy	`acct_email_list_bcc`
`bg`	billing group	`bg_notify_method`, `collections_bg_no`, `mp_billing_group_no`
`bkup`	backup	`bkup_cc_id`, `bkup_address1`, `bkup_bill_state_prov`
`cdi`	client-defined identifier	`suppress_cdi_error`
`cn`	credit note	`client_cn_alt_msg_template_id`
`coll`	collection	`bill_group_coll_group_agreement_id_info`, `change_status_after_coll`
`csr`	Customer Service Representative	`enable_for_csr`
`cvv`	Card Verification Value	`cvv`
`def`	default	`def_gl_cd`, `def_ind`
`desc`	description	`action_type_desc`, `plan_desc`, `service_desc`, `long_desc`
`dest`	destination	`item_dest_contact_no`, `allow_copy_pi_service_dest_contact`
`dt`	date	`available_from_dt`, `available_to_dt`
`ean`	European Article Number	`ean_gln_num`, `ean_gln_requisition_num`
`ext`	extension	`bill_phone_ext`, `addr_phone_ext`, `addr_work_phone_ext`
`func`	functional	`seq_func_group_no`
`gl`	general ledger	`ar_gl_code`
`gln`	Global Location Number	`ean_gln_num`, `ean_gln_requisition_num`
`iban`	International Bank Account Number	`iban`
`idx`	index	`acct_contact_idx`, `addr_contact_idx`, `bill_contact_idx`
`incl`	inclusion	`acct_nso_incl_list`, `nso_incl_list_scope`, `plan_nso_incl_list`
`ind`	indicator	`active_ind`, `billing_ind`, `custom_rate_ind`, `display_ind`
`init`	initial	`init_free_months`, `init_free_period_uom_cd`
`intl`	international	`billing_intl_phone`, `bkup_billing_intl_phone`
`merch`	merchant	`proc_merch_comments`
`mi`	middle initial	`bill_mi`
`min`	minimum	`early_cancel_min_months`, `min_qty`
`mm`	month	`cc_expire_mm`, `bkup_cc_expire_mm`
`mp`	master plan	`mp_billing_group_no`, `client_mp_instance_id`, `mp_rate_schedule_no`
`mpi`	master plan instance	`mpi`
`msg`	message	`error_msg`, `invoicing_error_msg`, `master_plan_coll_error_msg`
`num`	number	`bank_acct_num`, `bank_routing_num`, `po_num`, `ean_gln_num`
`obj`	object	`supplemental_obj_field`, `supplemental_obj_fields`, `supp_obj_field_translations`
`orig`	original	`orig_invoice_no`, `orig_transaction_amount`, `orig_transaction_date`
`pay`	payment	`accts_with_pay_method`
`pi`	plan instance	`pi_coupon_codes`, `assigned_pi_coupon_codes`, `remove_pi_custom_rates`
`po`	purchase order	`po_num`, `mp_po_num`, `nso_po_num`, `order_po_num`
`qty`	quantity	`max_qty`, `min_qty`, `nso_group_max_qty`, `subunit_qty`
`rec`	record (see Notes)	`action_rec_id_label`, `rec_no`, `parent_usage_rec_no`
`ref`	reference	`credit_ref_type`, `invoice_ref_line_amount`, `ref_payment_amount`
`resp`	responsibility (see Notes)	`resp_level_cd`, `resp_acct_no`, `resp_master_plan_instance_no`
`rev`	revenue	`rev_rec_ind`
`rs`	rate schedule	`followup_rs_no`, `client_followup_rs_id`, `rollover_rate_sched_no`
`sc`	service credit	`canceled_sc_gl_code`, `expired_sc_gl_code`, `unapplied_sc_gl_code`
`sched`	schedule	`rate_sched_is_assigned_ind`, `contract_rollover_rate_sched_no`
`sel`	selection	`sel_ind`, `sel_options`
`seq`	sequence	`rate_seq_no`, `bill_seq_no`, `acct_statement_seq_str`
`src`	source	`payment_src_cc_prefix`
`stat`	statement (see Notes)	`stat_address1`, `stat_contact_no`, `stat_billing_group_no`
`stmt`	statement (see Notes)	`stmt_contact_no`, `stmt_state_prov`, `stmt_locality`
`str`	string	`acct_statement_seq_str`, `second_acct_statement_seq_str`
`susp`	suspension	`plan_2_assign_on_susp`, `client_plan_2_assign_on_susp`
`svc`	service	`svc_location_no`, `client_svc_location_id`, `svc_credit_applied_line_no`
`telco`	telecommunications	`telco_from`, `telco_to`
`thru`	through	`bill_thru_date`, `last_bill_thru_date`, `recurring_bill_thru_date`
`txn`	transaction	`proc_initial_auth_txn_id`
`uom`	unit of measure	`init_free_period_uom_cd`, `rollover_plan_uom_cd`
`val`	value	`action_qualifier_1_val`, `action_rec_id_val`
`wddx`	Web Distributed Data Exchange	`wddx`
`yyyy`	year	`cc_expire_yyyy`, `bkup_cc_expire_yyyy`

Notes

rec has three meanings depending on context: "record" (rec_no, action_rec_id_label), "recurring" (expectd_annual_rec_cost), and "recognition" (rev_rec_ind). Read surrounding field names to determine which applies.
resp has two meanings depending on context: "responsibility" (resp_level_cd, resp_acct_no) and "response" (proc_pmt_resp_fld_invoice_no). The resp_ prefix on its own consistently means "responsibility."
stat and stmt both abbreviate "statement" but in different contexts. stat_ fields represent statement contact and address data. stmt_ fields represent statement contact identifiers on billing groups.
num and no both mean "number." num appears primarily in banking fields (bank_acct_num, bank_routing_num); no is the standard form used throughout the rest of the API.
rs and sched both relate to "rate schedule." rs is used as a standalone identifier suffix (followup_rs_no); sched is used as a mid-compound modifier (rate_sched_is_assigned_ind).
reg_uss always appears as a compound in method names: "registration user self-service."
ean and gln always appear together in the compound ean_gln, referencing the combined EAN/GLN product and location numbering standard.
mm and yyyy appear exclusively as credit card expiration date components and follow standard date-formatting notation.