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

 

Home > Aria Crescendo core api > update_acct_billing_group_m

update_acct_billing_group_m

Updates information associated with a specified billing group.

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.
  billing_group_no long 22 Billing group number
  OR      
  client_billing_group_id string 100 Client-defined unique identifier for billing group
  billing_group_name string 100 Billing Group name
  billing_group_description string 1000 Billing group description
  new_client_billing_group_id string 100 Specifies new client-defined unique identifier for billing group
  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
  notify_template_group long 22 Notify template No.
  statement_template long 22 Statement template No.
  credit_note_template long 22 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 Primary payment method ID
  client_primary_payment_method_id string 100 Client-defined unique identifier of the primary payment method
  backup_payment_method_no long 22 Backup payment method ID.
  client_backup_payment_method_id string 100 Client-defined unique identifier of the backup payment method
  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 300 Statement contact first name
  stmt_mi string 2 The Middle Initial of the statement contact.
  stmt_last_name string 300 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 Third address line of the statement contact
  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.
  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 Payment method name.
  client_payment_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.
  billing_group_directive long 1 Directive to update / disable the specified billing group   Allowable Values
  master_plans_summary array   List of master plan instances associated with the billing group.
  plan_instance_no long 22 The unique numberic identifier of the master plan instance.
  client_plan_instance_id string 100 The unique client-defined identifier of the master plan instance.
  client_receipt_id string 50 Client-defined unique identifier used to track related system actions
  list_start_master_file long 1 Indicates whether the account is listed at the start of a master file.   Allowable Values
  cc_id long 2 A numeric code indicating the type of credit card.   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 'This is 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 'This is 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.
  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.
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
billing_group_no long The Aria-assigned unique identifier for billing group on this account.
stmt_contact_no long The Aria-assigned unique identifier for the statement contact associated with a billing group on the account.
billing_contact_info hash Array
payment_method_no long The Aria-assigned unique identifier for payment method on this 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.

You must to post a comment.
Last modified
10:43, 9 May 2017

Tags

This page has no custom tags.

Classifications

This page has no classifications.