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

 

Home > Aria Crescendo core api > get_acct_billing_group_details_m

get_acct_billing_group_details_m

Retreives the details for a specified billing group, including the list of master plans associated with that 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.
  OR      
  client_acct_id string 50 Client-defined account identifier.
  plan_instance_no long 22 The Master Subscription plan instance number.
  OR      
  client_plan_instance_id string 100 Unique client-defined identifier for the master plan instance.
  OR      
  billing_group_no long 22 Billing group number
  OR      
  client_billing_group_id string 100 Client-defined unique identifier for billing group
  client_receipt_id string 50 Client-defined unique identifier used to track related system actions
  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.

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.
billing_groups hash  
billing_group_no long Billing group number
billing_group_name string Billing Group name
billing_group_description string Billing group description
client_billing_group_id string Client-defined unique identifier for billing group
status long If the status is "1", the billing group is active for this account. If the status is "0", the billing group is disabled for this account.   Allowable Values
notify_method long 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 Notify template No.
statement_template long Statement template No.
credit_note_template long Credit note template No.
payment_option string 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_name string Pay Method Name from Pay Methods configuration.
primary_payment_method_no long Primary payment method ID
client_primary_payment_method_id string Client-defined unique identifier of the primary payment method
backup_payment_method_name string Pay Method Name from Pay Methods configuration
backup_payment_method_no long Backup payment method ID.
client_backup_payment_method_id string Client-defined unique identifier of the backup payment method
client_payment_term_id string Client Payment Term ID from Payment Terms configuration.
payment_terms_name string Payment Terms Name from Payment Terms configuration.
payment_terms_no long Payment Terms Number from Payment Terms configuration.
payment_terms_type string Payment Terms Type from Payment Terms configuration.
ean_gln_num string 'EAN or GLN Number from billing group that is only applicable if payment_option="Terms" and pmt_terms_type="EAN/GLN"'
ean_gln_requisition_num string 'EAN or GLN Requisition Number from billing group that is only applicable if payment_option="Terms" and pmt_terms_type="EAN/GLN"'
stmt_first_name string Statement contact first name
stmt_mi string The Middle Initial of the statement contact.
stmt_last_name string Statement contact Last name
stmt_company_name string Company name of the statement contact
stmt_address1 string First address line of the statement contact
stmt_address2 string 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 Third address line of the statement contact
stmt_city string City of the statement contact
stmt_locality string 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 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 Country of the contact. The ISO-compliant 2-character country code abbreviation in uppercase.
stmt_postal_cd string Postal/Zip code for the statement contact address.
stmt_phone string The phone number of the statement contact
stmt_phone_ext string The extension for the statement contact phone
stmt_cell_phone string The contact cell phone of the statement contact.
stmt_work_phone string Work phone number of the statement contact.
stmt_work_phone_ext string The extension for the statement contact work phone
stmt_fax string The fax number for the statement contact.
stmt_email string Email of the statement contact
stmt_birthdate string The birthdate, in yyyy-mm-dd format, of the statement contact.
list_start_master_file long Indicates whether the account is listed at the start of a master file.   Allowable Values
address_verification_code string Verification code for the account contact address
address_match_score double Match score for the account contact address
master_plans_summary hash List of master plan instances to be associated with the billing group.
plan_instance_no long The unique numberic identifier of the master plan instance.
client_plan_instance_id string The unique client-defined identifier of the master plan instance.
credit_memo_template long Credit template No.
rebill_template long Rebill template No.
payment_methods_summary hash  
bill_first_name string First name of the billing contact.
bill_middle_initial string Middle initial of the billing contact.
bill_last_name string Last name of the billing contact.
bill_company_name string Company name of the billing contact.
bill_address1 string First address line of the billing contact.
bill_address2 string 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 The third line of the billing address.
bill_city string City of the billing contact.
bill_locality string 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 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 Country of the billing contact. The ISO-compliant 2-character country code abbreviation in uppercase.
bill_postal_cd string Postal code for the billing contact.
bill_phone string Phone number of the billing contact.
bill_phone_ext string Phone extension of the billing contact.
bill_cell_phone string Cell phone number of the billing contact.
bill_work_phone string Work phone number of the billing contact.
bill_work_phone_ext string This is the work phone extension for the billing contact work phone.
bill_fax string Fax number of the billing contact.
bill_email string Email of the billing contact.
bill_birthdate string Birthdate of the billing contact.
bill_address_verification_code string Verification code for the account contact address
bill_address_match_score double Match score for the account contact address
pay_method_name string Payment method name.
payment_method_no long Aria-assigned sequence number for this payment method.
client_payment_method_id string Client-defined unique identifier for the payment method.
pay_method_description string Payment method description
pay_method_type long This is the method_id corresponding to a payment method such as credit card, Electronic Check, Pre-Paid, Net Terms, etc.
cc_expire_mm long Expiration month for the credit card payment instrument.
cc_expire_yyyy long Expiration year for the credit card payment instrument.
bill_agreement_id string Unique ID of the bill agreement (also referred to as a token).
bank_swift_cd string 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 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 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.
list_start_master_file long Indicates whether the account is listed at the start of a master file.   Allowable Values
bank_id_cd string 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 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.
suffix string Last four digits of account number

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.