Home > Aria Crescendo Documentation > Aria Crescendo core api > get_acct_billing_group_details_m

get_acct_billing_group_details_m

Retrieves the details for a specified billing group, including the list of Master Plans associated with that billing group.

For information on error messages generated by this API, see get_acct_billing_group_details_m Error Messages.

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.
required-icon.png 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.
  brd_arrow.gif qualifier_name string 100 Name of the field you want to associate with this API call.
  brd_arrow.gif 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_group_details hash  
brd_arrow.gif billing_group_no long Billing group number.
brd_arrow.gif billing_group_name string Billing Group name.
brd_arrow.gif billing_group_description string Billing group description.
brd_arrow.gif client_billing_group_id string Client-defined unique identifier for billing group.
brd_arrow.gif 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 for status:

Values Description
0 The status is "0", the billing group is disabled for this account.
1 The status is "1", the billing group is active for this account.
brd_arrow.gif 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 for notify_method:

Values Description
0 None
1 HTML Email
2 Text Email
3 Text Email w/link to HTML
4 Data export
5 Printable (no Email) w/Surcharge
6 Printable & Text Email
7 Printable & HTML Email w/Surcharge
8 Printable (no Email)
9 PDF (Printing required, no Email)
10 PDF (delivered by Email)
11 PDF (Printing req & Email)w/surcharge
12 PDF (Printing req, no Email)w/surcharge
13 XML Master File
14 PDF Master File
15 XML Master File and HTML Email
16 XML Master File and Text Email
17 PDF Master File and HTML Email
brd_arrow.gif notify_template_group long Aria-assigned template group number.
brd_arrow.gif statement_template long Aria-assigned statement template number.
brd_arrow.gif credit_note_template long Aria-assigned credit note template number.
brd_arrow.gif 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 for payment_option:

Values Description
Methods Methods
Terms Terms
brd_arrow.gif primary_payment_method_name string Pay Method Name from Pay Methods configuration.
brd_arrow.gif primary_payment_method_no long Primary payment method ID.
brd_arrow.gif client_primary_payment_method_id string Client-defined unique identifier of the primary payment method.
brd_arrow.gif backup_payment_method_name string Pay Method Name from Pay Methods configuration.
brd_arrow.gif backup_payment_method_no long Backup payment method ID.
brd_arrow.gif client_backup_payment_method_id string Client-defined unique identifier of the backup payment method.
brd_arrow.gif client_payment_term_id string Client Payment Term ID from Payment Terms configuration.
brd_arrow.gif payment_terms_name string Payment Terms Name from Payment Terms configuration.
brd_arrow.gif payment_terms_no long Payment Terms Number from Payment Terms configuration.
brd_arrow.gif payment_terms_type string Payment Terms Type from Payment Terms configuration (e.g. Net Terms or EAN/GLN).  

Allowable values for payment_terms_type:

Values Description
Net Terms Net Terms
EAN/GLN EAN/GLN
brd_arrow.gif 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"'.
brd_arrow.gif 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"'.
brd_arrow.gif stmt_first_name string Statement contact first name.
brd_arrow.gif stmt_mi string The Middle Initial of the statement contact.
brd_arrow.gif stmt_last_name string Statement contact Last name.
brd_arrow.gif stmt_company_name string Company name of the statement contact.
brd_arrow.gif stmt_address1 string First address line of the statement contact.
brd_arrow.gif 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.
brd_arrow.gif stmt_address3 string Third address line of the statement contact.
brd_arrow.gif stmt_city string City of the statement contact.
brd_arrow.gif 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.
brd_arrow.gif 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.
brd_arrow.gif stmt_country string Country of the contact. The ISO-compliant 2-character country code abbreviation in uppercase.
brd_arrow.gif stmt_postal_cd string Postal/Zip code for the statement contact address.
brd_arrow.gif stmt_addr_method_cd string This field denotes the tax address method code which was used to generate the geo code of the statement contact.
brd_arrow.gif stmt_phone string The phone number of the statement contact.
brd_arrow.gif stmt_phone_ext string The extension for the statement contact phone.
brd_arrow.gif stmt_cell_phone string The contact cell phone of the statement contact.
brd_arrow.gif stmt_work_phone string Work phone number of the statement contact.
brd_arrow.gif stmt_work_phone_ext string The extension for the statement contact work phone.
brd_arrow.gif stmt_fax string The fax number for the statement contact.
brd_arrow.gif stmt_email string Email of the statement contact.
brd_arrow.gif stmt_birthdate string The birthdate, in yyyy-mm-dd format, of the statement contact.
brd_arrow.gif list_start_master_file long Indicates whether the account is listed at the start of a master file.  

Allowable values for list_start_master_file:

Values Description
0 0
1 When value=1, account is listed at the top of the master file when generated.
brd_arrow.gif address_verification_code string Verification code for the account contact address.
brd_arrow.gif address_match_score double Match score for the account contact address.
brd_arrow.gif collections_group_bg_no long Aria-assigned identifier of the collection group assigned to a billing group.
brd_arrow.gif client_collections_group_bg_id string Client-defined identifier of the collection group assigned to a billing group.
brd_arrow.gif collections_group_name string Collection group name.
brd_arrow.gif collections_group_description string Collection group description.
brd_arrow.gif master_plans_summary hash List of Master Plan Instances to be associated with the billing group.
brd_arrow.gif plan_instance_no long The unique numeric identifier of the Master Plan Instance.
brd_arrow.gif client_plan_instance_id string The unique client-defined identifier of the Master Plan Instance.
brd_arrow.gif credit_memo_template long Credit template No.
brd_arrow.gif rebill_template long Rebill template No.
brd_arrow.gif stmt_email_list_cc string Comma-delimited list of email addresses to which the statements associated with the billing group are currently cc'd (carbon copied).
brd_arrow.gif stmt_email_list_bcc string Comma-delimited list of email addresses to which the statements associated with the billing group are currently bcc'd (blind carbon copied).
billing_groups hash DEPRECATED
brd_arrow.gif billing_group_no long Billing group number DEPRECATED
brd_arrow.gif billing_group_name string Billing Group name DEPRECATED
brd_arrow.gif billing_group_description string Billing group description DEPRECATED
brd_arrow.gif client_billing_group_id string Client-defined unique identifier for billing group DEPRECATED
brd_arrow.gif 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. DEPRECATED 

Allowable values for status:

Values Description
0 The status is "0", the billing group is disabled for this account.
1 The status is "1", the billing group is active for this account.
brd_arrow.gif 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). DEPRECATED 

Allowable values for notify_method:

Values Description
0 None
1 HTML Email
2 Text Email
3 Text Email w/link to HTML
4 Data export
5 Printable (no Email) w/Surcharge
6 Printable & Text Email
7 Printable & HTML Email w/Surcharge
8 Printable (no Email)
9 PDF (Printing required, no Email)
10 PDF (delivered by Email)
11 PDF (Printing req & Email)w/surcharge
12 PDF (Printing req, no Email)w/surcharge
13 XML Master File
14 PDF Master File
15 XML Master File and HTML Email
16 XML Master File and Text Email
17 PDF Master File and HTML Email
brd_arrow.gif notify_template_group long Aria-assigned template group number. DEPRECATED
brd_arrow.gif statement_template long Aria-assigned statement template number. DEPRECATED
brd_arrow.gif credit_note_template long Aria-assigned credit note template number. DEPRECATED
brd_arrow.gif 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' DEPRECATED 

Allowable values for payment_option:

Values Description
Methods Methods
Terms Terms
brd_arrow.gif primary_payment_method_name string Pay Method Name from Pay Methods configuration. DEPRECATED
brd_arrow.gif primary_payment_method_no long Primary payment method ID DEPRECATED
brd_arrow.gif client_primary_payment_method_id string Client-defined unique identifier of the primary payment method DEPRECATED
brd_arrow.gif backup_payment_method_name string Pay Method Name from Pay Methods configuration DEPRECATED
brd_arrow.gif backup_payment_method_no long Backup payment method ID. DEPRECATED
brd_arrow.gif client_backup_payment_method_id string Client-defined unique identifier of the backup payment method DEPRECATED
brd_arrow.gif client_payment_term_id string Client Payment Term ID from Payment Terms configuration. DEPRECATED
brd_arrow.gif payment_terms_name string Payment Terms Name from Payment Terms configuration. DEPRECATED
brd_arrow.gif payment_terms_no long Payment Terms Number from Payment Terms configuration. DEPRECATED
brd_arrow.gif payment_terms_type string Payment Terms Type from Payment Terms configuration (e.g. Net Terms or EAN/GLN). DEPRECATED 

Allowable values for payment_terms_type:

Values Description
Net Terms Net Terms
EAN/GLN EAN/GLN
brd_arrow.gif 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"' DEPRECATED
brd_arrow.gif 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"' DEPRECATED
brd_arrow.gif stmt_first_name string Statement contact first name DEPRECATED
brd_arrow.gif stmt_mi string The Middle Initial of the statement contact. DEPRECATED
brd_arrow.gif stmt_last_name string Statement contact Last name DEPRECATED
brd_arrow.gif stmt_company_name string Company name of the statement contact 
brd_arrow.gif stmt_address1 string First address line of the statement contact DEPRECATED
brd_arrow.gif 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. DEPRECATED
brd_arrow.gif stmt_address3 string Third address line of the statement contact DEPRECATED
brd_arrow.gif stmt_city string City of the statement contact DEPRECATED
brd_arrow.gif 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. DEPRECATED
brd_arrow.gif 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. DEPRECATED
brd_arrow.gif stmt_country string Country of the contact. The ISO-compliant 2-character country code abbreviation in uppercase. DEPRECATED
brd_arrow.gif stmt_postal_cd string Postal/Zip code for the statement contact address. DEPRECATED
brd_arrow.gif stmt_phone string The phone number of the statement contact DEPRECATED
brd_arrow.gif stmt_phone_ext string The extension for the statement contact phone DEPRECATED
brd_arrow.gif stmt_cell_phone string The contact cell phone of the statement contact. DEPRECATED
brd_arrow.gif stmt_work_phone string Work phone number of the statement contact. DEPRECATED
brd_arrow.gif stmt_work_phone_ext string The extension for the statement contact work phone DEPRECATED
brd_arrow.gif stmt_fax string The fax number for the statement contact. DEPRECATED
brd_arrow.gif stmt_email string Email of the statement contact DEPRECATED
brd_arrow.gif stmt_birthdate string The birthdate, in yyyy-mm-dd format, of the statement contact. DEPRECATED
brd_arrow.gif list_start_master_file long Indicates whether the account is listed at the start of a master file. DEPRECATED

Allowable values for list_start_master_file:

Values Description
0 0
1 When value=1, account is listed at the top of the master file when generated.
brd_arrow.gif address_verification_code string Verification code for the account contact address DEPRECATED
brd_arrow.gif address_match_score double Match score for the account contact address DEPRECATED
brd_arrow.gif collections_group_bg_no long Aria-assigned identifier of the collection group assigned to a billing group DEPRECATED
brd_arrow.gif client_collections_group_bg_id string Client-defined identifier of the collection group assigned to a billing group DEPRECATED
brd_arrow.gif collections_group_name string Collection group name DEPRECATED
brd_arrow.gif collections_group_description string Collection group description DEPRECATED
brd_arrow.gif master_plans_summary hash List of Master Plan Instances to be associated with the billing group. DEPRECATED
brd_arrow.gif plan_instance_no long The unique numeric identifier of the Master Plan Instance. DEPRECATED
brd_arrow.gif client_plan_instance_id string The unique client-defined identifier of the Master Plan Instance. DEPRECATED
brd_arrow.gif credit_memo_template long Credit template No. DEPRECATED
brd_arrow.gif rebill_template long Rebill template No. DEPRECATED
brd_arrow.gif stmt_email_list_cc string Comma-delimited list of email addresses to which the statements associated with the billing group are currently cc'd (carbon copied). DEPRECATED
brd_arrow.gif stmt_email_list_bcc string Comma-delimited list of email addresses to which the statements associated with the billing group are currently bcc'd (blind carbon copied). DEPRECATED
payment_methods_summary hash  
brd_arrow.gif bill_first_name string First name of the billing contact.
brd_arrow.gif bill_middle_initial string Middle initial of the billing contact.
brd_arrow.gif bill_last_name string Last name of the billing contact.
brd_arrow.gif bill_company_name string Company name of the billing contact.
brd_arrow.gif bill_address1 string First address line of the billing contact.
brd_arrow.gif 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.
brd_arrow.gif bill_address3 string The third line of the billing address.
brd_arrow.gif bill_city string City of the billing contact.
brd_arrow.gif 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.
brd_arrow.gif 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.
brd_arrow.gif bill_country string Country of the billing contact. The ISO-compliant 2-character country code abbreviation in uppercase.
brd_arrow.gif bill_postal_cd string Postal code for the billing contact.
brd_arrow.gif bill_addr_method_cd string This field denotes the tax address method code which was used to generate the geo code of the billing contact.
brd_arrow.gif bill_phone string Phone number of the billing contact.
brd_arrow.gif bill_phone_ext string Phone extension of the billing contact.
brd_arrow.gif bill_cell_phone string Cell phone number of the billing contact.
brd_arrow.gif bill_work_phone string Work phone number of the billing contact.
brd_arrow.gif bill_work_phone_ext string This is the work phone extension for the billing contact work phone.
brd_arrow.gif bill_fax string Fax number of the billing contact.
brd_arrow.gif bill_email string Email of the billing contact.
brd_arrow.gif bill_birthdate string Birthdate of the billing contact.
brd_arrow.gif bill_address_verification_code string Verification code for the account contact address
brd_arrow.gif bill_address_match_score double Match score for the account contact address
brd_arrow.gif pay_method_name string Payment method name.
brd_arrow.gif payment_method_no long Aria-assigned sequence number for this payment method.
brd_arrow.gif client_payment_method_id string Client-defined unique identifier for the payment method.
brd_arrow.gif pay_method_description string Payment method description
brd_arrow.gif 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.  

Allowable values for pay_method_type:

Values Description
-1 External Payment
0 Other
1 Credit card
2 Electronic Check (ACH)
3 Pre-paid
4 Net terms 30
5 Net terms 10
6 Net terms 15
7 Net terms 60
8 Click&Buy
9 Net Terms 0
10 PayByCash
11 PayPal Express Checkout
12 Net Terms 45
13 Tokenized Credit Card
14 Purchase Power
15 Net Terms 35
16 Net Terms 75
17 Net Terms 90
18 Net Terms 120
19 Net Terms 25
26 Direct Debit
brd_arrow.gif cc_expire_mm long Expiration month for the credit card payment instrument.
brd_arrow.gif cc_expire_yyyy long Expiration year for the credit card payment instrument.
brd_arrow.gif bill_agreement_id string Unique ID of the bill agreement (also referred to as a token).
brd_arrow.gif 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.
brd_arrow.gif 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.
brd_arrow.gif 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.
brd_arrow.gif list_start_master_file long Indicates whether the account is listed at the start of a master file.  

Allowable values for list_start_master_file:

Values Description
0 0
1 When value=1, account is listed at the top of the master file when generated.
brd_arrow.gif 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.
brd_arrow.gif 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.
brd_arrow.gif suffix string Last four digits of account number
Last modified

Tags

Classifications

This page has no classifications.
Powered by CXone Expert ®