Skip to main content
Aria Knowledge Central

get_acct_billing_group_details_m

  1. Last updated
  2. Save as PDF

Summary

API Name get_acct_billing_group_details_m
Class account_services_m
Update Version 56

Description

Retreives the details for a specified billing group, including the list of master plans associated with that billing group.

Inputs

Name Type Length Required Description
client_no long 22 Yes

Aria-assigned unique identifier indicating the Aria client providing service to this account.
auth_key string 32 No

Aria-assigned unique key for authenticating the validity of the requestor. This key is passed with each method call.
acct_no long 22 Yes

Aria-assigned account identifier. This value is unique across all Aria-managed accounts.

Alternative required field: client_acct_id
client_acct_id string 50 Yes

Client-defined account identifier.

Alternative required field: acct_no
plan_instance_no long 22 No

The Master Subscription plan instance number.

Alternative field: client_plan_instance_id, billing_group_no, or client_billing_group_id
client_plan_instance_id string 100 No

Unique client-defined identifier for the master plan instance.

Alternative field: plan_instance_no, billing_group_no, or client_billing_group_id
billing_group_no long 22 No

Billing group number

Alternative field: plan_instance_no, client_plan_instance_id, or client_billing_group_id
client_billing_group_id string 100 No

Client-defined unique identifier for billing group

Alternative field: plan_instance_no, client_plan_instance_id, or billing_group_no
client_receipt_id string 50 No

Client-defined unique identifier used to track related system actions

Outputs

Name Type Length Required Description
error_code long   No

Aria-assigned error identifier. 0 indicates no error.
error_msg string   No

Description of any error that occurred. "OK" if there was no error.
billing_group_details object   No

See fields below
billing_groups object   No

Note: This field is deprecated. Aria no longer supports billing_groups.
payment_methods_summary object   No

See fields below

billing_group_details.master_plans_summary fields

Name Type Length Required Description
plan_instance_no long 22 No

The unique numberic identifier of the master plan instance.
client_plan_instance_id string 100 No

The unique client-defined identifier of the master plan instance.

billing_group_details.collection_group_bg_info fields

Name Type Length Required Description
collections_group_bg_no long 22 No

Collection Group Number to which this billing group should be assigned.
client_collections_group_bg_id string 100 No

Collection Group ID to which this billing group should be assigned.
collections_group_name string 300 No

Collection Group Name
collections_group_description string 1000 No

Collections group description

billing_group_details.bg_einvoicing_field_list fields

Name Type Length Required Description
bg_einvoicing_field_name string 100 No

Name of the e-invoicing field.
bg_einvoicing_field_value string 100 No

The value corresponding to the e-invoicing field name.

billing_group_details fields

Name Type Length Required Description
billing_group_no long 22 No

Billing group number
billing_group_name string 100 No

Billing Group name
billing_group_description string 1000 No

Billing group description
client_billing_group_id string 100 No

Client-defined unique identifier for billing group
status long   No

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.

Allowed values:

Value 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.
notify_method long 2 No

How the client communicates with the account holder. If a notification method is not provided, this value defaults to "1" (HTML email).

Allowed values:

Value 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
notify_template_group long 22 No

Aria-assigned template group number.
statement_template long 22 No

Aria-assigned statement template number.
credit_note_template long 22 No

Aria-assigned credit note template number.
payment_option string 7 No

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'

Allowed values:

Value Description
Methods  
Terms  
primary_payment_method_name string 100 No

Pay Method Name from Pay Methods configuration.
primary_payment_method_no long 22 No

Primary payment method ID
client_primary_payment_method_id string 100 No

Client-defined unique identifier of the primary payment method
backup_payment_method_name string 100 No

Pay Method Name from Pay Methods configuration
backup_payment_method_no long 22 No

Backup payment method ID.
client_backup_payment_method_id string 100 No

Client-defined unique identifier of the backup payment method
client_payment_term_id string 32 No

Client Payment Term ID from Payment Terms configuration.
payment_terms_name string 50 No

Payment Terms Name from Payment Terms configuration.
payment_terms_no long 22 No

Payment Terms Number from Payment Terms configuration.
payment_terms_type string 50 No

Payment Terms Type from Payment Terms configuration (e.g. Net Terms or EAN/GLN).

Allowed values:

Value Description
Net Terms Net Terms
EAN/GLN EAN/GLN
ean_gln_num string 50 No

'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 50 No

'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 300 No

Statement contact first name
stmt_mi string 2 No

The Middle Initial of the statement contact.
stmt_last_name string 300 No

Statement contact Last name
stmt_company_name string 100 No

Company name of the statement contact
stmt_address1 string 300 No

First address line of the statement contact
stmt_address2 string 300 No

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 No

Third address line of the statement contact
stmt_city string 300 No

City of the statement contact
stmt_locality string 300 No

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 No

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 No

Country of the contact. The ISO-compliant 2-character country code abbreviation in uppercase.
stmt_postal_cd string 15 No

Postal/Zip code for the statement contact address.
stmt_phone string 25 No

The phone number of the statement contact
stmt_phone_ext string 10 No

The extension for the statement contact phone
stmt_cell_phone string 20 No

The contact cell phone of the statement contact.
stmt_work_phone string 25 No

Work phone number of the statement contact.
stmt_work_phone_ext string 10 No

The extension for the statement contact work phone
stmt_fax string 25 No

The fax number for the statement contact.
stmt_email string 320 No

Email of the statement contact
stmt_birthdate string 10 No

The birthdate, in yyyy-mm-dd format, of the statement contact.
list_start_master_file long 1 No

Indicates whether the account is listed at the start of a master file.

Allowed values:

Value Description
0  
1 When value=1, account is listed at the top of the master file when generated.
address_verification_code string   No

Verification code for the account contact address
address_match_score double   No

Match score for the account contact address
master_plans_summary object   No

List of master plan instances to be associated with the billing group.

See fields below
credit_memo_template long   No

Credit template No.
rebill_template long   No

Rebill template No.
stmt_email_list_cc string 3000 No

An array containing the list of additional cc email addresses
stmt_email_list_bcc string 3000 No

An array containing the list of additional bcc email addresses
collection_group_bg_info object   No

Array for collection groups for billing group.

See fields below
stmt_addr_method_cd long   No

This field denotes the tax address method code which was used to generate the geo code of the statement contact.
taxation_company_code string 10 No

A unique ID number defined in a taxation provider (like Avalara) to identify your different company's or business units.
bg_einvoicing_field_list object   No

Array of e-invoicing fields associated with the billing group.

See fields below

payment_methods_summary.collection_group_bill_agreement_id_info fields

Name Type Length Required Description
collections_group_no long 22 No

Collection Group Number associated with the Billing Group.
client_collections_group_id string 100 No

Client defined ID of Collection Group associcated with the Billing Group.
collections_group_name string 300 No

Name of the Collection Group associated with the Billing Group
collections_group_description string 1000 No

Description of Collection Group associated with the Billing Group.
agreement_id string 100 No

Agreement id of the Collection Group and Payment Method associated with Billing Group.

payment_methods_summary fields

Name Type Length Required Description
bill_first_name string 300 No

First name of the billing contact.
bill_middle_initial string 2 No

Middle initial of the billing contact.
bill_last_name string 300 No

Last name of the billing contact.
bill_company_name string 100 No

Company name of the billing contact.
bill_address1 string 300 No

First address line of the billing contact.
bill_address2 string 300 No

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 No

The third line of the billing address.
bill_city string 300 No

City of the billing contact.
bill_locality string 300 No

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 No

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 No

Country of the billing contact. The ISO-compliant 2-character country code abbreviation in uppercase.
bill_postal_cd string 15 No

Postal code for the billing contact.
bill_phone string 25 No

Phone number of the billing contact.
bill_phone_ext string 10 No

Phone extension of the billing contact.
bill_cell_phone string 20 No

Cell phone number of the billing contact.
bill_work_phone string 25 No

Work phone number of the billing contact.
bill_work_phone_ext string 10 No

This is the work phone extension for the billing contact work phone.
bill_fax string 25 No

Fax number of the billing contact.
bill_email string 320 No

Email of the billing contact.
bill_birthdate string 10 No

Birthdate of the billing contact.
bill_address_verification_code string   No

Verification code for the account contact address
bill_address_match_score double   No

Match score for the account contact address
pay_method_name string 100 No

Payment method name.
payment_method_no long 22 No

Aria-assigned sequence number for this payment method.
client_payment_method_id string 100 No

Client-defined unique identifier for the payment method.
pay_method_description string 1000 No

Payment method description
pay_method_type long 8 No

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 2 No

Expiration month for the credit card payment instrument.
cc_expire_yyyy long 4 No

Expiration year for the credit card payment instrument.
bill_agreement_id string 32 No

Unique ID of the bill agreement (also referred to as a token).
bank_swift_cd string 15 No

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 No

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 No

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 1 No

Indicates whether the account is listed at the start of a master file.

Allowed values:

Value Description
0  
1 When value=1, account is listed at the top of the master file when generated.
bank_id_cd string 15 No

Up to 10 digit numeric bank identifier code. Used for the Direct Debit payment method. Only hyphen and space are allowed to format the bank ID code. It is required for BBAN.
bank_branch_cd string 15 No

Up to 10 digit numeric bank branch code. Used for the Direct Debit payment method. Only hyphen and space are allowed to format the bank branch code.
suffix string 4 No

Last four digits of account number
collection_group_bill_agreement_id_info object   No

Array for collection groups and bill agreement ids.

See fields below
cc_prefix string 6 No

The first 6 digit of the credit card number.
bill_addr_method_cd long   No

This field denotes the tax address method code which was used to generate the geo code of the billing contact.
mandate_signature_date string   No

The date, in yyyy-mm-dd format, on which the mandate was signed.
TOP
  1. Back to top
  • Was this article helpful?

Recommended articles

  1. Page type
    Topic
  2. Tags
    This page has no tags.