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

 

Home > Aria Crescendo core api > update_acct_complete_m

update_acct_complete_m

This API allows you to update a broad range of information associated with an account. This information includes:
  • User ID and related login information: Add or change user ID, password and secret question information for the account.
  • Contact information: Add or change account, billing and statement contact information, including name, address, email and phone number.
  • Statement information: Specify the statement notification method and format, such as HTML or PDF, and the associated template used to generate a statement for this account.
  • Parent and child plan assignment: Specify which plans on this account are parent plans or child plans and the relationships between them. You can also assign standard and custom rate schedules to plans on the account.
  • Collection, dunning and functional account group assignment: Specify the collection, dunning or functional account groups to which this account is assigned.
  • Payment method/term and taxation status: Specify if the account payment method is a credit card, direct debit, or a payment term, an whether the account is tax-exempt.
  • Invoicing/billing information: Specify proration policy and account or billing start/end dates.
  • Surcharges: Specify the type and amount of surcharges applied to the account.
  • Usage: Specify whether unbilled usage is invoiced and if usage pooling is enabled for the account,
  • Coupons and promotions: Specify coupons and promotions to be applied to the account.
  • Revenue recognition: Specify the revenue recognition profile assigned to this account.

Any field on an account can be updated. You can clear the value in any field with a type of "string", provided that the field is nullable for an account, by entering a '~' in that field.

For information on error messages generated by this API, see update_acct_complete_m error messages.

Input Arguments

Req Field Name Field Type Max Length Description
client_no long 22 Aria-assigned unique identifier indicating the Aria client providing service to this account.
auth_key string 32 Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor.
acct_no long 22 Aria-assigned account identifier. This value is unique across all Aria-managed accounts.
  OR      
  client_acct_id string 50 This is the client-assigned identifier for the account.
  client_receipt_id string 50 Client-defined unique identifier used to track related system actions
  userid string 32 The user's unique identifier. Every account must have an associated user ID.
  password string 100 Password for the given user
  secret_question string 300 The user's secret question recorded to recover a password.
  secret_question_answer string 300 The response to a user's secret_question
  pin string 10 Persinal Identification number
  acct_contact_idx long 32 For non-persistent referencing of a contact in the contacts array within the API request. If an idx value is specified, inputs provided for other account contact fields are ignored.
  acct_contact_no long 100 The Aria-assigned unique identifier for the account contact saved on the account.
  first_name string 32 Contact First name
  mi string 2 The Middle Initial of the contact.
  last_name string 32 Contact last name
  company_name string 100 Company name of the contact
  address1 string 100 First address line of the contact.
  address2 string 100 Second address line of the billing contact. If you want to delete existing data in this field, leaving it blank, you must enter a '~' in this field.
  address3 string 300 Third address line of the billing contact. If you want to delete existing data in this field, leaving it blank, you must enter a '~' in this field.
  city string 32 City of the contact
  locality string 32 Use this field instead of the state_prov field to designate the state, province or other local designation as appropriate for addresses in all countries other than the United States, Australia, and Canada. This field is ignored for all United States, Australia and Canada addresses.
  state_prov string 2 State or Province of the contact. The official postal-service codes for all United States, Australia and Canada states, provinces, and territories. This field does not support states, provinces or territories from other countries. Use the locality field for other countries.
  country_cd string 2 Country of the contact as the ISO-compliant 2-character country code abbreviation in uppercase. If you enter contact address information, but leave this field blank, then this field defaults to "US". If no contact address information is entered, this field remains blank.
  postal_cd string 15 Postal/Zip code for the contact address.
  phone string 25 The phone number of the contact
  phone_ext string 10 The extension for the contact phone
  cell_phone string 20 The contact cell phone.
  work_phone string 25 Work phone number of the contact.
  work_phone_ext string 10 The extension for the contact work phone
  fax string 25 The FAX phone number for the contact.
  email string 320 Email of the contact
  birthdate string 10 Birthdate of the contact in yyyy-mm-dd format.
  status_cd long 8 The status to which you are setting this account.   Allowable Values
  notify_method long 2 How the client communicates with the account holder. If a notification method is not provided, this value defaults to "1" (HTML email).   Allowable Values
  senior_acct_no long 22 The senior_acct_no is the unique account number for the parent account and is used to establish parent-child billing relationships. To remove a parent account from a child account, you must enter '-999' in this field.
  senior_acct_userid string 32 User ID of the parent account
  senior_client_acct_id string 50 Client-account ID of the parent account
  test_acct_ind long 1 Indicates that the account is a test account and is treated as such in the system. The default value is 0.   Allowable Values
  taxpayer_id string 32 Taxpayer Identification number.
  alt_client_acct_group_id string 100 One-time collections account group to use for this specific call. Default collections group on the account is not changed.
  acct_coupon_cd string array 30 The coupon codes to assign to this account, if any
  acct_start_date string 10 Date, in yyyy-mm-dd format, on which the account was first created outside of Aria
  alt_msg_template_no long 22 Email template number to assign to this account.
  OR      
  client_alt_msg_template_id string 100 Client-defined email template ID assigned to this account.
  cn_alt_msg_template_no long 22 Email template number to assign to this account.
  OR      
  client_cn_alt_msg_template_id string 100 The client-defined alternate email template ID to use for this account
  seq_func_group_no long 22 Functional account group number specifically designated for statement sequence number assignment.
  OR      
  client_seq_func_group_id string 100 Client-defined functional account group number specifically designated for statement sequence number assignment.
  tax_exemption_level long 1 Provides the Tax Exemption Level for the account. This field only applies to the Aria internal tax engine.   Allowable Values
  reset_dates_after_status string 5 If 'true', resets the billing dates after an account status change.   Allowable Values
  new_client_acct_id string 50 New Client-defined account ID for updating existing Client-defined account ID.
  invoicing_option long 1 Indicator for performing full invoicing, prorated invoicing or client-defined on this account as part of this call.   Allowable Values
  alt_start_date string 10 This is an alternative start date, in yyyy-mm-dd format, for the master plan instance being updated/assigned. This date can be used to delay providing services to the account holder (for example: until they have been email validated). This date must be within one billing interval of the plan being updated/assigned.
  alt_bill_day long 2 Number specifying a day of the month to use as an alternate bill day. You can enter a bill date other than the anniversary date in this field. The invoice_mode must be set to 0 or must be blank to enter a date in this field, it cannot be set to 1.
  retroactive_start_date string 10 Date, in yyyy-mm-dd format, to set for retroactive start.
  functional_acct_groups_update array   Array of functional groups to update.
  functional_acct_group_no long 22 Array of functional account groups.
  OR      
  client_functional_acct_group_id string 100 Array of functional account group IDs to which this account should be assigned
  functional_acct_grp_directive long 1 For each functional group, this specifies what action to take   Allowable Values
  collection_acct_groups_update array   Array of account collection groups to update
  collection_acct_group_no long 22 Array of collections account groups.
  client_collection_acct_group_id string 100 Array of collections account group IDs to which this account should be assigned
  collection_acct_grp_directive long 1 Whether to add or remove the account to or from the specified groups   Allowable Values
  acct_supp_fields_update array   Array of objects to be updated. Each object contains a list of values for one of the following fields: acct_supp_field_name, acct_supp_field_value, or acct_supp_field_directive. The first value in each object is automatically associated with the first values in the other objects, as are the second values, third values and so on. Each object must contain the same number of values, or the API fails.
  acct_supp_field_name string 100 Pipe-delimited array of supplemental field names. This value is required if you want to assign supplemental fields. For example, if you have any accounts that are tax-exempt or international, you must set up corresponding account supplemental fields prior to your tax provider configuration. Create fields for the tax exemption number and for the VAT ID used by the tax provider.
  acct_supp_field_value string 300 Pipe-delimited array of supplemental field values.
  acct_supp_field_directive long 1 Pipe-delimited array of account supplemental field directives. Specifies what actions to take (update, delete, etc.)   Allowable Values
  account_surcharges array    
  surcharge_no long 22 The Surcharge number to be attached to the account
  surcharge_directive long 1 The surcharge directive to assign/remove the surcharge from the account   Allowable Values
  rate_schedule_no long 22 The Schedule number for this surcharge
  client_master_plan_instance_id string 100 Client-defined unique identifier for Master plan instance
  master_plan_instance_no long 22 The Master Subscription plan instance number.
  new_client_master_plan_instance_id string 100 New Client-defined master plan instance ID for updating existing Client-defined master plan instance ID.
  client_master_plan_id string 100 Client-defined unique identifier for Master plan
  master_plan_no long 22 Master plan number
  master_plan_instance_desc string 1000 Master plan instance description
  dunning_group_no long 22 Dunning group to assign to master plan instance
  client_dunning_group_id string 100 Client-defined unique identifier of dunning group to assign to master plan instance
  mp_billing_group_no long 22 Billing group to assign to master plan instance
  client_mp_billing_group_id string 100 Client-defined unique identifier of billing group to assign to master plan
  master_plan_instance_status long 8 Master plan instance status   Allowable Values
  master_plan_units long 8 This is multiplier variable for the recurring rate on the plan. Generally this value is 1, indicating the face value of the plan's recurring fee is used.
  resp_level_cd long 1 The responsibility level code. These are values 1 through 4 as described in the legend for this argument.   Allowable Values
  parent_master_plan_inst_no long 22 The system-defined master plan instance number of the parent account. This field is required if the resp_level_cd is not equal to 1
  alt_rate_schedule_no long 22 The alternate rate schedule number for the master subscription plan being considered.
  OR      
  client_alt_rate_schedule_id string 100 The client-defined unique alternate rate schedule identifier for the master plan
  promo_cd string 30 This is the code provided the client and used by the account holder during registration or when executing a transaction. A promotion generally provides access to a custom set of reduced-rate plans.
  mp_coupon_cd string array 30 The coupon codes to assign to this master plan instance, if any
  master_plan_assign_directive long 2 The scope rule to be applied to this assignment/de-assignment request, governing both the date upon which the assignment should take place (immediately or on the account's anniversary date) and the proration rule that should be applied (per client's default rules for proration on plan assignment v. forcing proration on or off for this request only). Default behavior is to assign plan to account on the account's anniversary date, resulting in no proration effect.   Allowable Values
  offset_months long 4 Number of months to add to the prorated period.
  offset_interval long 4 If assigning a change on an anniversary day, the number of billing periods by which to delay that change. If the new plan is different from the old plan, and this value is greater than 0, then the billing date continues to be the annniversary date.
  invoice_unbilled_usage string 5 Specifies whether to invoice the unbilled usage if a plan is terminated in the middle of a billing period.   Allowable Values
  invoice_approval_required string 5 Boolean indicator to override client's default configured behaviour for creating Pending/Real invoice.   Allowable Values
  status_degrade_date string 10 Specifies the date, in yyyy-mm-dd format, to degrade the account status.
  usage_accumulation_reset_months long 4 The number of reset months for each plan
  usage_pooling string 5 Indicates whether usage pooling is enabled for this plan instance. Allowable values are 'true' and 'false'.   Allowable Values
  usage_threshold_applicability string 2 Usage tracking options on the plans in the account   Allowable Values
  master_plan_plan_inst_fields array    
  plan_instance_field_name string 300 Required based on the definition of each plan instance field associated with the new plan.
  plan_instance_field_value string 1000 The value of the product field. Values for product fields that do not match what is expected based on product field configuration will be ignored.
  plan_instance_field_directive long 8 Required for each plan instance field provided.   Allowable Values
  mp_surcharges array   Surcharge for master plan
  mp_surcharge_no long 22  
  mp_surcharge_directive long 1 The surcharge directive to assign/remove the surcharge from the master plan instance   Allowable Values
  mp_rate_schedule_no long 22  
  update_acct_custom_rates array    
  custom_rate_service_no long 22 The unique identifier for the service no, relative to the value provided in corresponding "custom_rate_plan_no", to which this custom rate is to be applied for this account.
  custom_rate_seq_no long 22 The rate tier number, relative to the values provided in corresponding "custom_rate_plan_no" and "custom_rate_service_no", to which this custom rate is to be applied for this account.
  custom_rate_from_unit long 22 The unit starting point, relative to the values provided in corresponding "custom_rate_plan_no", "custom_rate_service_no" and "custom_rate_seq_no", to which this custom rate is to be applied for this account.
  custom_rate_to_unit long 22 The unit ending point, relative to the values provided in corresponding "custom_rate_plan_no", "custom_rate_service_no" and "custom_rate_seq_no", to which this custom rate is to be applied for this account.
  custom_rate_per_unit double 22 The custom rate per unit, relative to the values provided in corresponding "custom_rate_plan_no", "custom_rate_service_no" and "custom_rate_seq_no", to be applied for this account.
  custom_rate_client_service_id string 100 The unique identifier by client the service ID to determine which custom rate is to be applied for this account.
  OR      
  custom_rate_service_no long 22 The unique identifier for the service no, relative to the value provided in corresponding "custom_rate_plan_no", to which this custom rate is to be applied for this account.
  billing_groups_array array    
  billing_group_name string 100 Billing Group name
  billing_group_description string 1000 Billing group description
  billing_group_no long 22 Billing group number
  client_billing_group_id string 38 Client-defined billing group ID. This value must be unique across all client accounts. This field can also be used as a reference to assign this billing group to one or more master plan instances within this API request.
  bg_notify_method long 22 How the client communicates with the account holder. If a notification method is not provided, this value defaults to "1" (HTML email).   Allowable Values
  notify_template_group long 32 Notify template number.
  statement_template long 32 Statement template number.
  credit_note_template long 32 Credit note template No.
  payment_option string 7 This allows you to select either payment methods (such as a credit card or other electronic form of payment) or payment terms (such as a physical check) when creating or modifying a billing group'   Allowable Values
  primary_payment_method_no long 22 ID corresponding to the primary payment method such as credit card, electronic check, prepaid, etc. You must specify a payment method when creating billing information.   Allowable Values
  client_primary_payment_method_id string 100 Client-defined unique identifier of the primary payment method
  backup_payment_method_no long 22 ID corresponding to the backup payment method such as credit card, electronic check, prepaid, etc. The backup payment method must be the same as the primary payment method. You must specify a payment method when creating billing information.   Allowable Values
  client_backup_payment_method_id string 100 Client-defined unique identifier of the backup payment method. The payment method specified must be the same as the primary payment method.
  stmt_contact_idx long 32 For non-persistent referencing of a contact in the contacts array within the API request. If an idx value is specified, inputs provided for other account contact fields will be ignored.
  stmt_contact_no long 22 The Aria-assigned unique identifier for the statement contact associated with a billing group on the account.
  stmt_first_name string 32 Statement contact first name
  stmt_mi string 2 The Middle Initial of the statement contact.
  stmt_last_name string 32 Statement contact Last name
  stmt_company_name string 100 Company name of the statement contact
  stmt_address1 string 300 First address line of the statement contact
  stmt_address2 string 300 Second address line of the statement contact. If you want to delete existing data in this field, leaving it blank, you must enter a '~' in this field.
  stmt_address3 string 300 Thirs address line of the statement contact. If you want to delete existing data in this field, leaving it blank, you must enter a '~' in this field.
  stmt_city string 300 City of the statement contact
  stmt_locality string 300 Use this field instead of the state_prov field to designate the state, province or other local designation as appropriate for addresses in all countries other than the United States, Australia, and Canada. This field is ignored for all United States, Australia and Canada addresses.
  stmt_state_prov string 10 State or Province of the billing contact. The official postal-service codes for all United States, Australia and Canada states, provinces, and territories. This field does not support states, provinces or territories from other countries. Use the locality field for other countries.
  stmt_country string 25 Country of the contact. The ISO-compliant 2-character country code abbreviation in uppercase.
  stmt_postal_cd string 15 Postal/Zip code for the statement contact address.
  stmt_phone string 25 The phone number of the statement contact
  stmt_phone_ext string 10 The extension for the statement contact phone
  stmt_cell_phone string 20 The contact cell phone of the statement contact.
  stmt_work_phone string 25 Work phone number of the statement contact.
  stmt_work_phone_ext string 10 The extension for the statement contact work phone
  stmt_fax string 25 The fax number for the statement contact.
  stmt_email string 320 Email of the statement contact
  stmt_birthdate string 10 The birthdate, in yyyy-mm-dd format, of the statement contact.
  bg_list_start_master_file long 1 Indicates whether the account is listed at the start of a master file.   Allowable Values
  payment_terms_no long 22 Payment terms number assigned to the account.
  payment_terms_name string 50 Payment terms name assigned to the account.
  client_payment_term_id string 32 Client-defined identifier for the billing group's payment term
  ean_gln_num string 50 The European Article Number or Global Location Number that is a required field if a payment option is terms AND client payment term ID matches a term in which the payment term type equals EAN/GLN. This number should be provided by Aria''s client'' customers and is unique to each customer (account).
  ean_gln_requisition_num string 50 The European Article Number requisition number or Global Location Number requisition number that is a required field if a payment option is terms AND client payment term ID matches a term in which the payment term type equals EAN/GLN. This number should be provided by Aria''s client''s customers and is used to track their individual projects similarly to a purchase order. This number is generated by the individual customer (account) and is not provided by any other party.
  credit_memo_template long 22 Credit template No.
  rebill_template long 22 Rebill template No.
  payment_methods_array array    
  payment_method_no long 22 Payment method number
  bill_contact_idx long 32 For non-persistent referencing of a contact in the contacts array within the API request. If an idx value is specified, inputs provided for other account contact fields will be ignored.
  bill_contact_no long 22 The Aria-assigned unique identifier for the contact on this account to be used as the billing contact for the payment method. If bill_contact_no is included in the API request, all other billing contact parameters are ignored.
  bill_first_name string 300 First name of the billing contact.
  bill_middle_initial string 2 Middle initial of the billing contact.
  bill_last_name string 300 Last name of the billing contact.
  bill_company_name string 100 Company name of the billing contact.
  bill_address1 string 300 First address line of the billing contact.
  bill_address2 string 300 Second address line of the billing contact. If you want to delete existing data in this field, leaving it blank, you must enter a '~' in this field.
  bill_address3 string 300 The third line of the billing address.
  bill_city string 300 City of the billing contact.
  bill_locality string 300 Use this field instead of the state_prov field to designate the state, province or other local designation as appropriate for addresses in all countries other than the United States, Australia, and Canada. This field is ignored for all United States, Australia and Canada addresses.
  bill_state_prov string 10 State or Province of the billing contact. The official postal-service codes for all United States, Australia and Canada states, provinces, and territories. This field does not support states, provinces or territories from other countries. Use the locality field for other countries.
  bill_country string 25 Country of the billing contact. The ISO-compliant 2-character country code abbreviation in uppercase.
  bill_postal_cd string 15 Postal code for the billing contact.
  bill_phone string 25 Phone number of the billing contact.
  bill_phone_ext string 10 Phone extension of the billing contact.
  bill_cell_phone string 20 Cell phone number of the billing contact.
  bill_work_phone string 25 Work phone number of the billing contact.
  bill_work_phone_ext string 10 This is the work phone extension for the billing contact work phone.
  bill_fax string 25 Fax number of the billing contact.
  bill_email string 320 Email of the billing contact.
  bill_birthdate string 10 Birthdate of the billing contact.
  pay_method_name string 100 Human-readable name of the payment method
  client_pay_method_id string 100 Client-defined unique identifier for the payment method.
  pay_method_description string 1000 Payment method description
  pay_method_type long 8 This is the method_id corresponding to a payment method such as credit card, Electronic Check, Pre-Paid, etc.   Allowable Values
  cc_num string 20 Credit card number.
  cc_expire_mm long 2 Expiration month for the credit card payment instrument.
  cc_expire_yyyy long 4 Expiration year for the credit card payment instrument.
  bank_acct_num string 19 The bank account number.
  bank_routing_num string 9 The American Banking Association (ABA) routing number for the financial institution.
  cvv string 6 Card Verification Value, used to help verify a transaction is being requested by the card holder since this value is physically printed on the credit card.
  track_data1 string 300 Raw "track 1" data from a swiped credit card used in a card-present transaction to initiate this request
  track_data2 string 300 Raw "track 2" data from a swiped credit card used in a card-present transaction to initiate this request
  bill_agreement_id string 32 Unique ID of the bill agreement (also referred to as a token).
  iban string 50 International Bank Account Number(IBAN). Used for the Direct Debit payment method. It consists of 16 to 34 alphanumeric characters. Only hyphen and space are allowed to format the IBAN.
  bank_check_digit long 2 Bank check digits enable a sanity check of the bank account number to confirm its integrity before submitting a transaction. Used for the Direct Debit payment method.
  bank_swift_cd string 15 SWIFT code is a standard format of Bank Identifier Codes (BIC). It is used for the Direct Debit payment method. It consists of 8 or 11 alphanumeric characters. Only hyphen and space are allowed to format the SWIFT code. It is required for IBAN.
  bank_country_cd string 2 Country of the bank. The ISO-compliant 2-character country code abbreviation in uppercase. Used for the Direct Debit payment method. It is required for IBAN and BBAN.
  mandate_id string 35 Used for the Direct Debit payment method. A mandate is signed by the debtor to authorize the creditor to collect a payment and to instruct the bank of the debtor to pay those collections.
  bank_id_cd string 15 Up to 10 digit numeric bank identifier code. Used for the Direct Debit payment method. Used in Europe. Only hyphen and space are allowed to format the bank ID code. It is required for BBAN.
  bank_branch_cd string 10 Up to 10 digit numeric bank branch code. Used for the Direct Debit payment method. Used in Europe. Only hyphen and space are allowed to format the bank branch code.
  do_collect string 5 If 'true', a collection is attempted after updating electronic billing information on accounts with outstanding balances.   Allowable Values
  change_status_after_coll string   If 'true' the account status is is changed after a collection is completed.   Allowable Values
  cc_id long 2 A numeric code indicating the type of credit card.   Allowable Values
  revrec_profile_no long 8 Profile ID of an existing Revenue Recognition Profile.
  OR      
  client_revrec_id string 100 Client-defined identifier of an existing Revenue Recognition Profile. If this parameter is specified it will take precedence over revrec_profile_no.
  mp_proration_invoice_timing long 1 Determines whether to create a separate invoice for prorated charges immediately, or defer to the next anniversary date. Note that this will override the Proration Invoice Timing configuration saved with the plan in the product catalog.   Allowable Values
  po_num string 100 Purchase order number assigned to the account.
  mp_po_num string 100 : Purchase order number assigned to a master plan instance.
  list_start_master_file long 1 Indicates whether the account is listed at the start of a master file.   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 50 Name of the locale.
  contacts_list array   List of contacts to be created on the account. Note that contacts not used as an account contact, billing contact, or statement contact will be saved on the account.
  addr_contact_idx long 32 The Aria-assigned address sequence number.
  addr_first_name string 32 The first name of the contact.
  addr_middle_initial string 2 The middle initial of the contact.
  addr_last_name string 32 The last name of the contact.
  addr_company_name string 100 The company name of the contact.
  addr_address1 string 100 The first address line of the contact.
  addr_address2 string 100 Second address line of the contact. If you want to delete existing data in this field, leaving it blank, you must enter a '~' in this field
  addr_address3 string 100 The third line of the address
  addr_city string 32 The city of the contact.
  addr_locality string 32 The locality of the contact.
  addr_state_prov string 2 The state or province of the contact. Note that only the official postal-service codes for states, provinces, and territories in the United States, Australia and Canada are supported. Use the other_locality field for states, provinces, or territories in other countries.
  addr_country string 2 The country of the contact. Provide the ISO-compliant 2-character country code abbreviation in uppercase.
  addr_postal_cd string 14 The postal/zip code of the contact.
  addr_phone string 25 The phone number of the contact.
  addr_phone_ext string 10 The phone number extension of the contact.
  addr_cell_phone string 20 The cell phone number of the contact.
  addr_work_phone string 25 The work phone number of the contact.
  addr_work_phone_ext string 10 The work phone number extension of the contact.
  addr_fax string 25 The fax number of the contact.
  addr_email string 320 The email address of the contact.
  addr_birthdate string 10 The birthdate of the contact.
  legal_entity_no long 22 Aria-assigned legal entity identification number. You can only update this field if the account has not yet been assigned to a legal entity, and if legal entities are enabled for this client.
  OR      
  client_legal_entity_id string 50 Client-assigned unique identifier for the legal entity.
  alt_caller_id string 30 Person or process that submitted the API call. This can be someone's user ID, or the name of an application.
  optional_transaction_qualifiers array   Array of additional values you can associate with this API call.
  qualifier_name string 100 Name of the field you want to associate with this API call.
  qualifier_value string 100 Corresponding value of the field you want to associate with this API call.
  application_id string 300 The application identifier in which the API is being used in. (Example: “Sales Force”)
  application_date string 300 The application date/timestamp, ie. 01/01/2014 10:00:00 to track when the application called the API.

Output Arguments

Field Name Field Type Description
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.
collection_error_code long If a collection is attempted, returns the error code associated with the collection.
collection_error_msg string The error message associated with collection_error_code.
parent_child_sync_error_code long The result of the synchronization of the parent/child billing dates (if attempted).
parent_child_sync_error_msg string The corresponding text error message for the parent_child_sync_error_code value.
master_plan_error_code long Error code returned upon failure when attempting to update the master plan
master_plan_error_msg string Human-readable error message corresponding to master_plan_error_code
master_plan_coll_error_code long Error code for master plan collection errors.
master_plan_coll_error_msg string Human-readable error text corresponding to the master_plan_coll_error_code
master_plan_stmt_error_code long Error code returned upon failure to update the master plan statement
master_plan_stmt_error_msg string Human-readable error message corresponding to master_plan_stmt_error_code.
proc_cvv_response string The processor return code from CVV validation.
proc_avs_response string Processor return code from address validation
proc_cavv_response string The processors return code for security validation.
proc_status_code string The processor status code
proc_status_text string The processors status description
proc_payment_id string The processor payment ID
proc_auth_code string Authorization code provided by the issuing bank
proc_merch_comments string Additional information passed to payment processor
third_party_errors hash Errors from third-party systems like taxation engines are returned here. Aria-generated error codes are returned in the error_code and error_msg fields at the root level of the API return.
error_class string The type of error code being represented, such as taxation
error_code string The error code returned by the third party system
error_msg string The error message returned by the third party system
master_plan_instance_id long Master plan instance number
out_client_mp_instance_id string Client-defined unique identifier for Master plan instance
out_master_plan_no long Master plan number
out_client_master_plan_id string Client-defined unique identifier for Master plan
out_master_plan_instance_description string Master plan instance description
master_plan_proration_result_total_amount double Master plan proration total amount
master_plan_proration_amount double Master plan proration amount
master_plan_proration_tax_amount double Master plan proration tax amount
master_plan_proration_surcharge_amount double Master plan proration surcharge amount
master_plan_proration_credit_amount double Master plan prorration credit amount
supp_plan_instance_id long Supplemental plan instance number
out_client_supp_plan_instance_id string Client-defined unique identifier for supplemental plan instance
supp_plan_proration_amount double Supplemental plan proration amount
supp_plan_proration_tax_amount double Supplemental plan proration tax amount
supp_plan_proration_surcharge_amount double Supplemental plan proration surcharge amount
supp_plan_proration_credit_amount double Supplemental plan proration credit amount
out_invoice_no long The unique identifier of a given invoice.
out_billing_group_no long Billing group number
out_client_billing_group_id string Client-defined unique identifier for billing group
acct_locale_no 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.
acct_contact_no long The Aria-assigned unique identifier for the account contact saved on the account.
billing_contact_details hash List of billing contacts saved on the account.
payment_method_no long The Aria-assigned unique identifier for the payment method on the account.
bill_contact_no long The Aria-assigned unique identifier for the contact on this account to be used as the billing contact for the payment method. If bill_contact_no is included in the API request, all other billing contact parameters are ignored.
statement_contact_details hash List of statement contacts saved on the account.
billing_group_no long The Aria-assigned unique identifier for the billing group on the account.
stmt_contact_no long The Aria-assigned unique identifier for the statement contact associated with a billing group on the account.
other_contact_details hash List of contacts saved on the account that are not used as an account, billing, or statement contact.
other_contact_no long The Aria-assigned unique identifier for the contact saved on the account.
other_contact_idx long Value provided for the idx parameter in the API request.

You must to post a comment.
Last modified
09:45, 27 Jul 2017

Tags

This page has no custom tags.

Classifications

This page has no classifications.