create_acct_complete_m
All of the following information can be assigned to the account as it is created using this API.
- User ID and related login information: User ID, password and secret question information for the account.
- Contact information: 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 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.
Note: Inputs passed to this API call will override any fraud options that you specified in your payment gateway, collection group, or Direct Post settings, unless stated otherwise below.
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. | |||||||||||||||||||||||||||||||||||||||
do_write | string | 5 | Boolean indicator that specifies whether to actually perform the requested operation. If 'false' is passed in this field, Aria calculates, if applicable, any potential effects from this call such as proration, Plan assignments, etc. and return all relevant data without actually performing the requested operation or making any changes to the account. This is useful to interfaces that want to present the user with a 'confirmation page' informing them of the potential effects of the requested operation prior to actually performing it. Do_write defaults to 'true'
Allowable values for do_write
|
|||||||||||||||||||||||||||||||||||||||
client_receipt_id | string | 50 | Client-defined unique identifier used to track related system actions | |||||||||||||||||||||||||||||||||||||||
Start of acct array | ||||||||||||||||||||||||||||||||||||||||||
acct | array | A list of parameters that define a single account. Zero or more child accounts can be created under a top-level account within nested <acct> arrays. This supports the creation of an account hierarchy within a single call to create_acct_complete_m. | ||||||||||||||||||||||||||||||||||||||||
Field Name | Field Type | Max Length | Description | |||||||||||||||||||||||||||||||||||||||
array | 50 |
An array of parameters that define one or more child accounts of this parent-level account. The fields in this array are identical to the <acct> array of which it is a member, and can be invoked recursively to create an account hierarchy of n levels and/or members. For more information about how to format a call that utilizes this option, see Calling create_acct_complete_m: Advanced Topics and Best Practices. |
||||||||||||||||||||||||||||||||||||||||
string | 50 | Client-defined account identifier. | ||||||||||||||||||||||||||||||||||||||||
string | 32 | The user's unique identifier. Every account must have a userid. If the client parameters are not configured to generate this value, the userid must be provided in this API request. | ||||||||||||||||||||||||||||||||||||||||
long | 8 |
The status of the account after it is created. Allowable values for status_cd
|
||||||||||||||||||||||||||||||||||||||||
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 for notify_method
|
||||||||||||||||||||||||||||||||||||||||
long | 22 | Notify template number. Aria-assigned unique identifier for the notification template group to be associated with the account. | ||||||||||||||||||||||||||||||||||||||||
string | 50 |
Client-defined unique identifier for the notification template group to be associated with the account. |
||||||||||||||||||||||||||||||||||||||||
string | 100 | Password for the given user | ||||||||||||||||||||||||||||||||||||||||
string | 300 | User's secret question recorded to recover a password | ||||||||||||||||||||||||||||||||||||||||
string | 300 | Response to a user's secret_question | ||||||||||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||||||||||
string | 32 | First name of the contact | ||||||||||||||||||||||||||||||||||||||||
string | 2 | Middle initial of the contact | ||||||||||||||||||||||||||||||||||||||||
string | 32 | Last name of the contact | ||||||||||||||||||||||||||||||||||||||||
string | 100 | Company name of the contact | ||||||||||||||||||||||||||||||||||||||||
string | 300 | First address line of the contact. | ||||||||||||||||||||||||||||||||||||||||
string | 300 | 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. | ||||||||||||||||||||||||||||||||||||||||
string | 300 | The third line of the address | ||||||||||||||||||||||||||||||||||||||||
string | 32 | City of the contact | ||||||||||||||||||||||||||||||||||||||||
string | 32 |
Locality of the contact. Use this field instead of the <state_prov> field to identify 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 addresses in the United States, Australia, and Canada. |
||||||||||||||||||||||||||||||||||||||||
string | 10 |
State or province of the contact. The official postal-service code for any state, province, or territory in the United States, Australia, or Canada. This field does not support states, provinces, or territories in other countries. This field is ignored for all addresses outside the United States, Australia, and Canada. Use the <locality> field for addresses in those countries. |
||||||||||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||||||||||
string | 15 | Postal/Zip code for the contact's address | ||||||||||||||||||||||||||||||||||||||||
string | 25 | Phone number for the contact | ||||||||||||||||||||||||||||||||||||||||
string | 10 | Extension for the contact's phone number | ||||||||||||||||||||||||||||||||||||||||
string | 20 | Cell phone number for the contact | ||||||||||||||||||||||||||||||||||||||||
string | 25 | Work phone number for the contact | ||||||||||||||||||||||||||||||||||||||||
string | 10 | Extension for the contact work phone | ||||||||||||||||||||||||||||||||||||||||
string | 25 | Fax phone number for the contact | ||||||||||||||||||||||||||||||||||||||||
string | 320 | Email for the contact. | ||||||||||||||||||||||||||||||||||||||||
string | 3000 | Comma-delimited list of email addresses to which the account holder's statements should be cc'd (carbon copied) | ||||||||||||||||||||||||||||||||||||||||
string | 3000 | Comma-delimited list of email addresses to which the account holder's statements should be bcc'd (blind carbon copied) | ||||||||||||||||||||||||||||||||||||||||
string | 10 | Birthdate of the contact in yyyy-mm-dd format. | ||||||||||||||||||||||||||||||||||||||||
long | 22 | Unique account number for the parent account. It is used to establish parent-child billing relationships. This field, or senior_acct_userid, or client_senior_acct_userid, is required if you are using the current API call to create a child account. | ||||||||||||||||||||||||||||||||||||||||
OR | ||||||||||||||||||||||||||||||||||||||||||
string | 32 | User ID of the parent account | ||||||||||||||||||||||||||||||||||||||||
OR | ||||||||||||||||||||||||||||||||||||||||||
string | 50 | Client-account ID of the parent account | ||||||||||||||||||||||||||||||||||||||||
long | 22 | Aria-assigned legal entity identification number. | ||||||||||||||||||||||||||||||||||||||||
OR | ||||||||||||||||||||||||||||||||||||||||||
string | 50 | Client-assigned unique identifier for the legal entity. | ||||||||||||||||||||||||||||||||||||||||
long | 1 |
Indicator for performing full invoicing, prorated invoicing or client-defined configuration setting on this account as part of this call. Allowable values for invoicing_option
|
||||||||||||||||||||||||||||||||||||||||
string | 10 | Alternative start date, in yyyy-mm-dd format, for the Master Plan Instance being assigned on the account. This date can be used to delay providing services to the account holder (for example: until they have been email validated), and must be within one billing interval of the Plan being assigned. | ||||||||||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||||||||||
string | 10 | Date, in yyyy-mm-dd format, to set for retroactive start. | ||||||||||||||||||||||||||||||||||||||||
string | 10 | Applicable only for Master Plan assignment. When provided, this date is used as the bill thru date for the Master Plan Instance. The alt_start_date or retroactive_start_date input is honored with override_bill_thru_date, but invoicing_option must be set to Perform Prorated Invoicing. The date provided must be in the future, must be after the alt_start_date (if provided), and cannot exceed one recurring billing interval. This parameter cannot be used with alt_bill_day or status_until_alt_start (defaults to Inactive). A prorated invoice is generated for recurring services from the effective start date of the Plan instance through the override_bill_thru_date provided. If the Plan being assigned has no usage services, the next_bill_date (aka anniversary date) is the override_bill_thru_date + 1 day. If the Plan has usage services, then the next_bill_date is calculated based on the usage interval to be the earliest date in the future that ensures usage and recurring services are invoiced together on the override_bill_thru_date + 1 day. | ||||||||||||||||||||||||||||||||||||||||
Start of functional_acct_group array | ||||||||||||||||||||||||||||||||||||||||||
array | Array of functional account groups | |||||||||||||||||||||||||||||||||||||||||
Field Name | Field Type | Max Length | Description | |||||||||||||||||||||||||||||||||||||||
long | 22 | The Aria-assigned identifier of the functional account group in which to place this account. A functional account group allows you to categorize your customers based on some common element such as geography, product, or channel. | ||||||||||||||||||||||||||||||||||||||||
OR | ||||||||||||||||||||||||||||||||||||||||||
string | 100 | Client-defined functional account group ID to which to assign this account | ||||||||||||||||||||||||||||||||||||||||
End of functional_acct_group array | ||||||||||||||||||||||||||||||||||||||||||
Start of collection_acct_group array | ||||||||||||||||||||||||||||||||||||||||||
array | Array for collection account groups. | |||||||||||||||||||||||||||||||||||||||||
Field Name | Field Type | Max Length | Description | |||||||||||||||||||||||||||||||||||||||
long | 22 | Group ID for the collections account groups in which to place this account. You can create collections account groups to specify that financial transactions conducted with specific groups of accounts are completed with a specific payment gateway or combination of payment gateways and merchant accounts.
If you created a collections group for a specific payment gateway, be sure to add the account to that collections group during the account registration process or soon afterward. This ensures that collections for accounts in that collections group are completed successfully. |
||||||||||||||||||||||||||||||||||||||||
OR | ||||||||||||||||||||||||||||||||||||||||||
string | 100 | Client-defined collections account group ID to assign to this account | ||||||||||||||||||||||||||||||||||||||||
End of collection_acct_group array | ||||||||||||||||||||||||||||||||||||||||||
Start of supp_field array | ||||||||||||||||||||||||||||||||||||||||||
array | Assigns one or more supplemental field values to the account | |||||||||||||||||||||||||||||||||||||||||
Field Name | Field Type | Max Length | Description | |||||||||||||||||||||||||||||||||||||||
string | 100 | Name of the supplemental field. 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. | ||||||||||||||||||||||||||||||||||||||||
string | 300 | Value for the supplemental field | ||||||||||||||||||||||||||||||||||||||||
End of supp_field array | ||||||||||||||||||||||||||||||||||||||||||
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 for test_acct_ind
|
||||||||||||||||||||||||||||||||||||||||
string | 10 | Date, in yyyy-mm-dd format, on which the account was first created outside of Aria | ||||||||||||||||||||||||||||||||||||||||
string | 3 | 3-character ISO-compliant currency code in lowercase for monetary values used for this account (a list of codes can be accessed here). | ||||||||||||||||||||||||||||||||||||||||
long | 22 | Functional account group number specifically designated for statement sequence number assignment | ||||||||||||||||||||||||||||||||||||||||
OR | ||||||||||||||||||||||||||||||||||||||||||
string | 100 | Client-defined functional account group number specifically designated for statement sequence number assignment | ||||||||||||||||||||||||||||||||||||||||
string | 32 | Taxpayer identification number | ||||||||||||||||||||||||||||||||||||||||
long | 1 |
Provides the Tax Exemption Level for the account. This field only applies to the Aria internal tax engine. Allowable values for tax_exemption_level
|
||||||||||||||||||||||||||||||||||||||||
long | 1 |
Indicates whether the account is listed at the start of a master file. Allowable values for list_start_master_file
|
||||||||||||||||||||||||||||||||||||||||
long | 22 | Email template number assigned to this account | ||||||||||||||||||||||||||||||||||||||||
OR | ||||||||||||||||||||||||||||||||||||||||||
string | 100 | Client-defined email template ID assigned to this account | ||||||||||||||||||||||||||||||||||||||||
long | 22 | Alternate email template number to use for this account | ||||||||||||||||||||||||||||||||||||||||
OR | ||||||||||||||||||||||||||||||||||||||||||
long | 100 | Client-defined alternate email template ID to use for this account | ||||||||||||||||||||||||||||||||||||||||
string | 5 |
Boolean indicator to override client's default configured behavior for creating Pending/Real invoice. Allowable values for invoice_approval_required
|
||||||||||||||||||||||||||||||||||||||||
string | 5 |
Creates an Aria session for the newly created account. Within an Aria session, you can perform functions such as securely processing payment transactions or securely retrieving account information in registration or User Self Service applications. Allowable values for create_session
|
||||||||||||||||||||||||||||||||||||||||
Start of acct_surcharges array | ||||||||||||||||||||||||||||||||||||||||||
array | ||||||||||||||||||||||||||||||||||||||||||
Field Name | Field Type | Max Length | Description | |||||||||||||||||||||||||||||||||||||||
long | 22 | Surcharge number to be attached to the account | ||||||||||||||||||||||||||||||||||||||||
string | 100 | Note that only those surcharges with Surcharge Applicablity Scope of Account or Account and Master Plan Instance should be accepted. | ||||||||||||||||||||||||||||||||||||||||
long | 22 | |||||||||||||||||||||||||||||||||||||||||
End of acct_surcharges array | ||||||||||||||||||||||||||||||||||||||||||
string array | 30 | Coupon codes to assign to this account, if any | ||||||||||||||||||||||||||||||||||||||||
Start of payment_method array | ||||||||||||||||||||||||||||||||||||||||||
array | ||||||||||||||||||||||||||||||||||||||||||
Field Name | Field Type | Max Length | Description | |||||||||||||||||||||||||||||||||||||||
long | 8 |
ID corresponding to a payment method such as card, electronic check, prepaid, etc. You must specify a payment method when creating billing information. Allowable values for pay_method_type
|
||||||||||||||||||||||||||||||||||||||||
string | 100 | Human-readable name of the payment method | ||||||||||||||||||||||||||||||||||||||||
string | 1000 | Description for the Plan method | ||||||||||||||||||||||||||||||||||||||||
string | 100 | System-defined statement payment method ID | ||||||||||||||||||||||||||||||||||||||||
long | 8 | For non-persistent referencing of a payment method within the API request | ||||||||||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||||||||||
string | 32 | First name of the billing contact | ||||||||||||||||||||||||||||||||||||||||
string | 2 | Middle initial of the billing contact | ||||||||||||||||||||||||||||||||||||||||
string | 32 | Last name of the billing contact | ||||||||||||||||||||||||||||||||||||||||
string | 100 | Company name of the billing contact | ||||||||||||||||||||||||||||||||||||||||
string | 100 | First address line of the contact. | ||||||||||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||||||||||
string | 100 | The third line of the address | ||||||||||||||||||||||||||||||||||||||||
string | 32 | City of the billing contact | ||||||||||||||||||||||||||||||||||||||||
string | 32 |
Locality of the billing contact. 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 addresses in the United States, Australia, and Canada. |
||||||||||||||||||||||||||||||||||||||||
string | 10 |
State or province of the billing contact. The official postal-service code for any state, province, or territory in the United States, Australia, or Canada. This field is ignored for all addresses outside the United States, Australia, and Canada. Use the <locality> field for addresses in those countries. |
||||||||||||||||||||||||||||||||||||||||
string | 2 | Country of the billing contact as the ISO-compliant 2-character country code abbreviation in uppercase. | ||||||||||||||||||||||||||||||||||||||||
string | 14 | Postal/Zip code for the billing contact's address | ||||||||||||||||||||||||||||||||||||||||
string | 25 | Phone number for the billing contact | ||||||||||||||||||||||||||||||||||||||||
string | 10 | Extension for the billing contact's phone number | ||||||||||||||||||||||||||||||||||||||||
string | 20 | Cell phone number for the billing contact | ||||||||||||||||||||||||||||||||||||||||
string | 25 | Work phone for the billing contact. | ||||||||||||||||||||||||||||||||||||||||
string | 10 | Extension for the billing contact's work phone | ||||||||||||||||||||||||||||||||||||||||
string | 25 | Fax phone number for the billing contact | ||||||||||||||||||||||||||||||||||||||||
string | 320 | Email for the billing contact | ||||||||||||||||||||||||||||||||||||||||
string | 10 | Birthdate of the contact in yyyy-mm-dd format. | ||||||||||||||||||||||||||||||||||||||||
string | 20 | Card number | ||||||||||||||||||||||||||||||||||||||||
long | 2 | Expiration month for the card payment instrument | ||||||||||||||||||||||||||||||||||||||||
long | 4 | Expiration year for the card payment instrument | ||||||||||||||||||||||||||||||||||||||||
string | 19 | Bank account number of the account holder's payment method. Together with the (ABA) bank_routing_no, this value is used to execute electronic check or ACH transactions. The <bank_acct_num>, <bank_routing_no> or <bill_agreement_id> |
||||||||||||||||||||||||||||||||||||||||
string | 9 | This is the ABA (American Banking Association) unique identifier for the financial institution. The <bank_acct_num>, <bank_routing_no> or <bill_agreement_id> is needed for the Tokenized ACH payment method - 48. |
||||||||||||||||||||||||||||||||||||||||
string | 6 | Card Verification Value, used to verify a transaction is being requested by the card holder since this value is physically printed on the card | ||||||||||||||||||||||||||||||||||||||||
string | 300 | Raw "track 1" data from a swiped card used in a card-present transaction to initiate this request | ||||||||||||||||||||||||||||||||||||||||
string | 300 | Raw "track 2" data from a swiped card used in a card-present transaction to initiate this request | ||||||||||||||||||||||||||||||||||||||||
string | 32 | Taxpayer identification number | ||||||||||||||||||||||||||||||||||||||||
string | 32 | Unique ID of the bill agreement (also referred to as a token). The <bank_acct_num>, <bank_routing_no> or <bill_agreement_id> is needed for the Tokenized ACH payment method - 48. | ||||||||||||||||||||||||||||||||||||||||
string | 50 | International Bank Account Number(IBAN). Used for the Direct Debit payment method. It consists of 16 to 34 alphanumeric characters. Only hyphens and spaces are allowed to format the IBAN. | ||||||||||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||||||||||
string | 15 | 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. | ||||||||||||||||||||||||||||||||||||||||
string | 15 | 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. | ||||||||||||||||||||||||||||||||||||||||
string | 100 | Bank name for the account payment method. | ||||||||||||||||||||||||||||||||||||||||
string | 100 | Bank city for the account payment method. | ||||||||||||||||||||||||||||||||||||||||
string | 32 |
The type of bank account used for pay_method_type 2. Allowable values for bank_acct_type:
|
||||||||||||||||||||||||||||||||||||||||
long | 2 |
A numeric code indicating the type of card. Allowable values for cc_id
|
||||||||||||||||||||||||||||||||||||||||
End of payment_method array | ||||||||||||||||||||||||||||||||||||||||||
Start of billing_group array | ||||||||||||||||||||||||||||||||||||||||||
array | This array contains information about the account's billing groups. A billing group defines the statement configuration, primary payment method, and/or backup payment method for one or more Master Plan Instances. | |||||||||||||||||||||||||||||||||||||||||
Field Name | Field Type | Max Length | Description | |||||||||||||||||||||||||||||||||||||||
string | 32 | Billing group name. | ||||||||||||||||||||||||||||||||||||||||
string | 1000 | Billing group description. | ||||||||||||||||||||||||||||||||||||||||
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. Either the client_billing_group_id or billing_group_idx must be defined if the billing group is used by one or more Master Plans within the API request. | ||||||||||||||||||||||||||||||||||||||||
long | 22 | Non-persistent billing group identifier. This numeric identifier (1 for the first billing group, 2 for the second, and etc.) allows the billing group to be assigned to one or more Master Plan Instances within this API request. Either the client_billing_group_id or billing_group_idx must be defined if the billing group is used by one or more Master Plans within the API request. | ||||||||||||||||||||||||||||||||||||||||
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 for notify_method
|
||||||||||||||||||||||||||||||||||||||||
long | 22 | Notify template number. Aria-assigned unique identifier for the notification template group to be associated with the account. | ||||||||||||||||||||||||||||||||||||||||
string | 50 |
Client-defined unique identifier for the notification template group to be associated with the account. |
||||||||||||||||||||||||||||||||||||||||
long | 22 | Statement template number | ||||||||||||||||||||||||||||||||||||||||
long | 22 | Credit note template number | ||||||||||||||||||||||||||||||||||||||||
string | 7 |
This allows you to select either payment methods (such as a 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
|
||||||||||||||||||||||||||||||||||||||||
string | 100 | Client-defined identifier for the billing group's primary payment method (Note: The same pay method sequence number cannot be used for the primary and secondary payment method). | ||||||||||||||||||||||||||||||||||||||||
OR | ||||||||||||||||||||||||||||||||||||||||||
long | 32 | Non-persistent identifier for the billing group's primary payment method (Note: The same pay method sequence number cannot be used for the primary and secondary payment method). | ||||||||||||||||||||||||||||||||||||||||
string | 100 | Client-defined identifier for the billing group's backup payment method (Note: The same pay method sequence number cannot be used for the primary and secondary payment method). | ||||||||||||||||||||||||||||||||||||||||
OR | ||||||||||||||||||||||||||||||||||||||||||
long | 32 | Non-persistent identifier for the billing group's backup payment method (Note: The same pay method sequence number cannot be used for the primary and secondary payment method). | ||||||||||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||||||||||
string | 32 | First name of the statement contact | ||||||||||||||||||||||||||||||||||||||||
string | 2 | Middle initial of the statement contact | ||||||||||||||||||||||||||||||||||||||||
string | 32 | Last name of the statement contact | ||||||||||||||||||||||||||||||||||||||||
string | 100 | Company name of the statement contact | ||||||||||||||||||||||||||||||||||||||||
string | 100 | First address line of the contact. | ||||||||||||||||||||||||||||||||||||||||
string | 100 | 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. | ||||||||||||||||||||||||||||||||||||||||
string | 100 | The third line of the address | ||||||||||||||||||||||||||||||||||||||||
string | 32 | City of the statement contact | ||||||||||||||||||||||||||||||||||||||||
string | 32 |
Locality of the statement contact. 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 addresses in the United States, Australia, and Canada. |
||||||||||||||||||||||||||||||||||||||||
string | 10 |
State or province of the statement contact. The official postal-service code for any state, province, or territory in the United States, Australia, or Canada. This field does not support states, provinces, or territories in other countries. This field is ignored for all addresses outside the United States, Australia, and Canada. Use the <locality> field for addresses in those countries. |
||||||||||||||||||||||||||||||||||||||||
string | 2 | Country of the statement contact. The ISO-compliant 2-character country code abbreviation in uppercase. | ||||||||||||||||||||||||||||||||||||||||
string | 14 | Postal/Zip code for the statement contact's address | ||||||||||||||||||||||||||||||||||||||||
string | 25 | Phone number of the statement contact | ||||||||||||||||||||||||||||||||||||||||
string | 10 | Extension for the statement contact's phone number. | ||||||||||||||||||||||||||||||||||||||||
string | 20 | Cell phone number of the statement contact | ||||||||||||||||||||||||||||||||||||||||
string | 25 | Work phone number of the statement contact | ||||||||||||||||||||||||||||||||||||||||
string | 10 | Extension for the statement contact's work phone. | ||||||||||||||||||||||||||||||||||||||||
string | 25 | Fax phone number for the statement contact | ||||||||||||||||||||||||||||||||||||||||
string | 320 | Email for the statement contact | ||||||||||||||||||||||||||||||||||||||||
string | 10 | Birthdate of the contact in yyyy-mm-dd format. | ||||||||||||||||||||||||||||||||||||||||
long | 1 |
Indicates whether the account is listed at the start of a master file. Allowable values for list_start_master_file
|
||||||||||||||||||||||||||||||||||||||||
long | 22 | Payment terms number assigned to the account. | ||||||||||||||||||||||||||||||||||||||||
string | 50 | Payment terms name assigned to the account. | ||||||||||||||||||||||||||||||||||||||||
string | 100 | Client-defined identifier for the billing group's payment term | ||||||||||||||||||||||||||||||||||||||||
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 is provided by Aria's client's customers and is unique to each customer (account).' | ||||||||||||||||||||||||||||||||||||||||
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 is 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' | ||||||||||||||||||||||||||||||||||||||||
long | 22 | Credit template no. | ||||||||||||||||||||||||||||||||||||||||
long | 22 | Rebill template no. | ||||||||||||||||||||||||||||||||||||||||
array |
Array of collection groups that should be assigned to the specified billing groups. For cost savings or for other reasons, you may choose to have payments made with a particular payment method (associated with a billing group) processed by a specific payment gateway. To do so, you can assign a collection group to a billing group by passing values into the collection_group_bg_row array. |
|||||||||||||||||||||||||||||||||||||||||
OR |
long string |
22 100 |
Aria-assigned identifier of the collection group to assign to the specified billing group. Client-defined identifier of the collection group to assign to the specified billing group. |
|||||||||||||||||||||||||||||||||||||||
End of billing_group array | ||||||||||||||||||||||||||||||||||||||||||
Start of dunning_group array | ||||||||||||||||||||||||||||||||||||||||||
array | This array contains information about the account's dunning groups. A dunning group defines the process followed for delinquent payments associated with one or more Master Plan Instances. Each account must have at least one Master Plan Instance, and each Master Plan Instance must have a dunning group. Therefore, you must define at least one dunning group for each account in the API request. | |||||||||||||||||||||||||||||||||||||||||
Field Name | Field Type | Max Length | Description | |||||||||||||||||||||||||||||||||||||||
string | 100 | Name of the dunning group | ||||||||||||||||||||||||||||||||||||||||
string | 1000 | Description of the dunning group | ||||||||||||||||||||||||||||||||||||||||
string | 100 | Client-defined dunning group ID. This value must be unique across all client accounts. This field can also be used as a reference to assign this dunning group to one or more Master Plan Instances within this API request. Either the client_dunning_group_id or dunning_group_idx must be defined if the dunning group is used by one or more Master Plans within the API request. | ||||||||||||||||||||||||||||||||||||||||
long | 22 | Non-persistent dunning group identifier. This numeric identifier (1 for the first dunning group, 2 for the second, and etc.) allows the dunning group to be assigned to one or more Master Plan Instances within this API request. Either the client_dunning_group_id or dunning_group_idx must be defined if the dunning group is used by one or more Master Plans within the API request. | ||||||||||||||||||||||||||||||||||||||||
long | 22 | Dunning process. | ||||||||||||||||||||||||||||||||||||||||
OR | ||||||||||||||||||||||||||||||||||||||||||
string | 100 | Client-defined dunning process identifier. | ||||||||||||||||||||||||||||||||||||||||
Note: It is now required that dunning groups are associated with parent-pay Master Plan Instances, so even if a dunning group is not specified by the client upon MPI assignment, an empty dunning group (i.e., without any values in the attributes) will be created and assigned to that MPI automatically, without issuing an error or warning. |
||||||||||||||||||||||||||||||||||||||||||
End of dunning_group array | ||||||||||||||||||||||||||||||||||||||||||
Start of contracts array | ||||||||||||||||||||||||||||||||||||||||||
array | ||||||||||||||||||||||||||||||||||||||||||
Field Name | Field Type | Max Length | Description | |||||||||||||||||||||||||||||||||||||||
string | 100 | Client-assigned unique contract identifier | ||||||||||||||||||||||||||||||||||||||||
long | 8 |
Type ID of this contract. Placing a value in this field indicates that you are assigning a contract to this account. Allowable values for contract_type_no
|
||||||||||||||||||||||||||||||||||||||||
long | 4 | Number of months this contract remains on the account. This field must be blank if you specify values in the contract_end_date field.' | ||||||||||||||||||||||||||||||||||||||||
double | 12 | Fee charged to the account for prematurely ending this contract | ||||||||||||||||||||||||||||||||||||||||
string | 300 | Any client-defined comments stored on this contract at the account level | ||||||||||||||||||||||||||||||||||||||||
string | 10 | Date, in yyyy-mm-dd format, on which this contract takes effect. If contract_length_months is blank, and this field is blank, but client_contract_id is specified, then the start date for the contract defaults to today's date. | ||||||||||||||||||||||||||||||||||||||||
string | 10 | Date, in YYYY-MM-DD format, on which this contract ends. If the contract_length_months field is valued, this field must be blank. If the contract_start_date field has a value, and the contract_length_months field is blank, then this field must have a value that falls after the value in the contract_start_date field. | ||||||||||||||||||||||||||||||||||||||||
Start of contract_plans array | ||||||||||||||||||||||||||||||||||||||||||
array | List of Plan instance(s) to be associated with the contract. | |||||||||||||||||||||||||||||||||||||||||
Field Name | Field Type | Max Length | Description | |||||||||||||||||||||||||||||||||||||||
long | 22 | If you enter a value in this field, the contract you specify in the client_contract_id field is applied to the Plan(s) you specify here. Otherwise, the contract is assigned at the account level. | ||||||||||||||||||||||||||||||||||||||||
OR | ||||||||||||||||||||||||||||||||||||||||||
string | 100 | Client-defined Plan instance to be associated with the contract | ||||||||||||||||||||||||||||||||||||||||
string | 5 | Determines whether to include all child Plan instances of the Plan instance specified at the time of contract assignment in the contract
Allowable values for cascade_action
|
||||||||||||||||||||||||||||||||||||||||
End of contract_plans array | ||||||||||||||||||||||||||||||||||||||||||
End of contracts array | ||||||||||||||||||||||||||||||||||||||||||
Start of master_plans_detail array | ||||||||||||||||||||||||||||||||||||||||||
array | Allows multiple Master Plans subscription for an account | |||||||||||||||||||||||||||||||||||||||||
Field Name | Field Type | Max Length | Description | |||||||||||||||||||||||||||||||||||||||
long | 22 | System-defined master subscription Plan number. This is the Plan number you are assigning to the account. You must assign at least one Plan to the account. | ||||||||||||||||||||||||||||||||||||||||
OR | ||||||||||||||||||||||||||||||||||||||||||
string | 100 | Client-defined Master Plan subscription Plan ID. | ||||||||||||||||||||||||||||||||||||||||
string | 1000 | Description for each assigned Master Plan | ||||||||||||||||||||||||||||||||||||||||
string | 100 | Unique client-defined ID for each assigned Master Plan | ||||||||||||||||||||||||||||||||||||||||
long | 22 | For non-persistent referencing of a Plan instance within the API request | ||||||||||||||||||||||||||||||||||||||||
string | 30 | Code provided by 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 | ||||||||||||||||||||||||||||||||||||||||
long | 8 | 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 | ||||||||||||||||||||||||||||||||||||||||
long | 10 |
Bill lag days refer to the number of days prior to (negative) or after (positive) an account billing date at which an invoice should be generated for your specified Master Plan Instance. |
||||||||||||||||||||||||||||||||||||||||
string | 10 | The date the Non Subscription Offering is fulfilled. A date in the past, present, or future can be specified. | ||||||||||||||||||||||||||||||||||||||||
Start of plan_unit_instances array | ||||||||||||||||||||||||||||||||||||||||||
array | Array of Plan unit instances | |||||||||||||||||||||||||||||||||||||||||
Field Name | Field Type | Max Length | Description | |||||||||||||||||||||||||||||||||||||||
string | 100 | Client-assigned identifier for the Plan unit instance. If valued, creates a Plan unit instance for the Plan you are assigning to this account. | ||||||||||||||||||||||||||||||||||||||||
Start of plan_unit_instance_services array | ||||||||||||||||||||||||||||||||||||||||||
array | Array of Plan unit instance services | |||||||||||||||||||||||||||||||||||||||||
Field Name | Field Type | Max Length | Description | |||||||||||||||||||||||||||||||||||||||
long | 22 | Specifies the Aria-assigned unique service identifier against which fulfillment details must be captured and stored. | ||||||||||||||||||||||||||||||||||||||||
OR | ||||||||||||||||||||||||||||||||||||||||||
string | 100 | Client-assigned identifier for the service (only for fulfillment based service) | ||||||||||||||||||||||||||||||||||||||||
string | 10 | Fulfilment completion date. Can be a past, current or future date. This field is required if the fulfillment_directive field is set to "2". | ||||||||||||||||||||||||||||||||||||||||
long | 1 |
Derives whether the fulfillment date is assigned/modified or removed from the fulfillment based service on the Plan unit instance Allowable values for fulfillment_directive
|
||||||||||||||||||||||||||||||||||||||||
End of plan_unit_instance_services array | ||||||||||||||||||||||||||||||||||||||||||
Start of plan_unit_inst_fields array | ||||||||||||||||||||||||||||||||||||||||||
array | Array of client-defined Plan unit instance fields | |||||||||||||||||||||||||||||||||||||||||
Field Name | Field Type | Max Length | Description | |||||||||||||||||||||||||||||||||||||||
string | 300 | Field name of Plan unit instance field. Entering a value in this field creates a field if it does not exist, or assigns it if it does exist. | ||||||||||||||||||||||||||||||||||||||||
string | 1000 | Value stored under this field | ||||||||||||||||||||||||||||||||||||||||
long | 1 |
Directive is mandatory if field name/value pair are specified Allowable values for plan_unit_inst_directive
|
||||||||||||||||||||||||||||||||||||||||
End of plan_unit_inst_fields array | ||||||||||||||||||||||||||||||||||||||||||
End of plan_unit_instances array | ||||||||||||||||||||||||||||||||||||||||||
long | 8 |
Status of the object in question for the current API call Allowable values for plan_instance_status
|
||||||||||||||||||||||||||||||||||||||||
long | 1 | Responsibility level code. This determines how the usage, invoicing, statement generation, and payment processing are managed under this Master Plan Instance
If the value is "1" (Standard Self Pay), the Master Plan Instance must have a billing group, which you assign using either client_billing_group_id or billing_group_idx. If the value is "2" (Parent Pay) or "3" (Parent Usage & Pay), the Master Plan Instance does not need a billing group, but must have a responsible Master Plan Instance, which you assign using either <resp_master_plan_instance_no>, <resp_client_master_plan_instance_id>, or <resp_master_plan_instance_idx>. The responsible Master Plan Instance must be owned by another account that is a parent or ancestor of the account you are creating. To specify the responsible Master Plan Instance for the assigned Plan, pass in a <resp_master_plan_instance_no>, <resp_client_master_plan_instance_id>, or <resp_master_plan_instance_idx> as described below. Please see Parent-child Account Best Practicesfor more information. Allowable values for resp_level_cd
|
||||||||||||||||||||||||||||||||||||||||
|
long |
22 |
The unique identifier of the Master Plan Instance that will have payment responsibility for the assigned Plan. If the responsibility level (in the <resp_level_cd> field) is set to one of the two parent pay options, one of these fields is required: <resp_master_plan_instance_no>, <resp_client_master_plan_instance_id>, or <resp_master_plan_instance_idx>. |
|||||||||||||||||||||||||||||||||||||||
OR | ||||||||||||||||||||||||||||||||||||||||||
string | 100 |
The client-defined identifier of the Master Plan Instance that will have payment responsibility for the assigned Plan. If the responsibility level (in the <resp_level_cd> field) is set to one of the two parent pay options, one of these fields is required: <resp_master_plan_instance_no>, <resp_client_master_plan_instance_id>, or <resp_master_plan_instance_idx>. |
||||||||||||||||||||||||||||||||||||||||
OR | ||||||||||||||||||||||||||||||||||||||||||
long |
22 |
Your chosen identifier for the Master Plan Instance (MPI) in a parent account that is You can use this identifier to reference the same MPI multiple time in the same API call. If the responsibility level (in the <resp_level_cd> field) is set to one of the two parent pay options, one of these fields is required: <resp_master_plan_instance_no>, <resp_client_master_plan_instance_id>, or <resp_master_plan_instance_idx>. |
||||||||||||||||||||||||||||||||||||||||
long | 22 | System-defined identifier for the Master Plan Instance in a parent account that is responsible for payment and/or usage tracking of this Master Plan. The responsible Master Plan Instance must exist before this API request is executed. Either this field, client_resp_master_plan_inst_id, or resp_master_plan_inst_idx must be valued if the resp_level_cd is set to either "2" or "3". Otherwise, it must be blank. | ||||||||||||||||||||||||||||||||||||||||
OR | ||||||||||||||||||||||||||||||||||||||||||
string | 100 | Client-defined identifier for the Master Plan Instance in a parent account that is responsible for payment and/or usage tracking of this Master Plan. The responsible Master Plan Instance must either exist before this API request is executed, or is created within this API request. Either this field, resp_master_plan_inst_id, or resp_master_plan_inst_idx must be valued if the resp_level_cd is set to either "2" or "3". Otherwise, it must be blank. | ||||||||||||||||||||||||||||||||||||||||
OR | ||||||||||||||||||||||||||||||||||||||||||
long | 22 | Non-persistent identifier for the Master Plan Instance in a parent account that is responsible for payment and/or usage tracking of this Master Plan Instance. The responsible Master Plan Instance must be created within this API request. Either this field, client_resp_master_plan_inst_id, or resp_master_plan_inst_no must be valued if the resp_level_cd is set to either "2" or "3". Otherwise, it must be blank. | ||||||||||||||||||||||||||||||||||||||||
OR | ||||||||||||||||||||||||||||||||||||||||||
string | 100 | Client-defined identifier for the billing group to which this Master Plan Instance belongs. Either this field, or billing_group_idx must be valued if the resp_level_cd is set to "1". Otherwise, it must be blank. | ||||||||||||||||||||||||||||||||||||||||
OR | ||||||||||||||||||||||||||||||||||||||||||
long | 22 | Non-persistent identifier for the billing group to which this Master Plan Instance belongs. Either this field, or client_billing_group_id must be valued if the resp_level_cd is set to "1". Otherwise, it must be blank. | ||||||||||||||||||||||||||||||||||||||||
string | 100 | Client-defined identifier for the dunning group to which this Master Plan Instance belongs. Each Master Plan Instance must be assigned to one of the dunning groups defined in this API request, using either the client_dunning_group_id or dunning_group_idx. | ||||||||||||||||||||||||||||||||||||||||
OR | ||||||||||||||||||||||||||||||||||||||||||
long | 22 | Non-persistent identifier for the dunning group to which this Master Plan Instance belongs. Each Master Plan Instance must be assigned to one of the dunning groups defined in this API request, using either the client_dunning_group_id or dunning_group_idx. | ||||||||||||||||||||||||||||||||||||||||
long | 8 |
Status of the Master Plan Instance prior to alt_start_date or alt_bill_day. If the alt_start_date or alt_bill_day field is used, this field is required and defaults to 0 (inactive) if no value is provided. If an alternate starting date or alternate bill day is provided, the Master Plan Instance remains in this status until its start date arrives. This only applies if a prorated invoice is not created. If a prorated invoice is created, this field is ignored. When a Master Plan is assigned with an alt_start_date and status_until_alt_start as pending activation (32), then the user will not have the option to delete the queued future Plan changes for the Master Plan and Supplemental Plan. If the user needs to delete the queued future Plan change, then select a status other than pending activation. Allowable values for status_until_alt_start
|
||||||||||||||||||||||||||||||||||||||||
double | 12 | balance forward | ||||||||||||||||||||||||||||||||||||||||
string array | 30 | Coupon codes to assign to this Plan instance, if any | ||||||||||||||||||||||||||||||||||||||||
Start of mpi_surcharges array | ||||||||||||||||||||||||||||||||||||||||||
array | Surcharge for Master Plan. | |||||||||||||||||||||||||||||||||||||||||
Field Name | Field Type | Max Length | Description | |||||||||||||||||||||||||||||||||||||||
long | 22 | |||||||||||||||||||||||||||||||||||||||||
long | 22 | |||||||||||||||||||||||||||||||||||||||||
End of mpi_surcharges array | ||||||||||||||||||||||||||||||||||||||||||
long | 1 |
Indicates whether to bill the NSO items immediately or, if not, to set bill on next billing anniversary date Allowable values for nso_bill_immediately
|
||||||||||||||||||||||||||||||||||||||||
Start of master_plan_services array | ||||||||||||||||||||||||||||||||||||||||||
array | List of services associated with the Master Plan being assigned on the account | |||||||||||||||||||||||||||||||||||||||||
Field Name | Field Type | Max Length | Description | |||||||||||||||||||||||||||||||||||||||
long | 22 | Multidimensional array of services for this Plan | ||||||||||||||||||||||||||||||||||||||||
OR | ||||||||||||||||||||||||||||||||||||||||||
string | 100 | Multidimensional array of client-defined service ID for this Plan | ||||||||||||||||||||||||||||||||||||||||
long | 22 | Aria-assigned unique location identifier | ||||||||||||||||||||||||||||||||||||||||
string | 100 | The client-defined unique identifier for the origin location for the service associated with the Plan. Depending on taxation configuration, this address may be used for tax calculations. If both svc_location_no and client_svc_location_id are provided, svc_location_no takes precedence. | ||||||||||||||||||||||||||||||||||||||||
long | 32 | The Aria-assigned address sequence number | ||||||||||||||||||||||||||||||||||||||||
End of master_plan_services array | ||||||||||||||||||||||||||||||||||||||||||
Start of master_plan_nso_list array | ||||||||||||||||||||||||||||||||||||||||||
array | Non-Subscription Offerings that are purchased with the Plan | |||||||||||||||||||||||||||||||||||||||||
Field Name | Field Type | Max Length | Description | |||||||||||||||||||||||||||||||||||||||
string | 100 | Client SKU of NSO/Inventory item. Entering a value in this field includes this SKU in the order being created. | ||||||||||||||||||||||||||||||||||||||||
long | 22 | NSO quantity that is purchased along with Plan. | ||||||||||||||||||||||||||||||||||||||||
long | 22 | The Aria-assigned unique identifier for the origin location for the item (NSO) being purchased. Depending on taxation configuration, this address may be used for tax calculations. If both svc_location_no and client_svc_location_id are provided, svc_location_no takes precedence. | ||||||||||||||||||||||||||||||||||||||||
string | 100 | Client-defined unique identifier for the origin location for the item (NSO) being purchased | ||||||||||||||||||||||||||||||||||||||||
long | 32 | Aria-assigned address sequence number | ||||||||||||||||||||||||||||||||||||||||
End of master_plan_nso_list array | ||||||||||||||||||||||||||||||||||||||||||
string | 100 | Purchase order number assigned to the one-time order | ||||||||||||||||||||||||||||||||||||||||
Start of plan_instance_fields_info array | ||||||||||||||||||||||||||||||||||||||||||
array | ||||||||||||||||||||||||||||||||||||||||||
Field Name | Field Type | Max Length | Description | |||||||||||||||||||||||||||||||||||||||
long | 22 | Product field number | ||||||||||||||||||||||||||||||||||||||||
OR | ||||||||||||||||||||||||||||||||||||||||||
string | 100 | Product field name | ||||||||||||||||||||||||||||||||||||||||
string | 1000 | Value of the product field. Values for product fields that do not match what is expected based on product field configuration are ignored. | ||||||||||||||||||||||||||||||||||||||||
End of plan_instance_fields_info | ||||||||||||||||||||||||||||||||||||||||||
long | 22 | Aria-assigned identifier for an alternative rate schedule that is assigned to the Master Plan in place of the default rate schedule | ||||||||||||||||||||||||||||||||||||||||
OR | ||||||||||||||||||||||||||||||||||||||||||
string | 100 | Client-defined alternate rate schedule ID | ||||||||||||||||||||||||||||||||||||||||
long | 4 | Number of reset months for each Plan. | ||||||||||||||||||||||||||||||||||||||||
long | 1 |
Determines whether the usage accumulation reset months will automatically reset to same value at the end of the current period or will expire at end of current period. Allowable values for usage_accumulation_reset_months_ renewal_option
|
||||||||||||||||||||||||||||||||||||||||
string | 5 |
Indicates whether usage pooling is enabled for this Plan instance. Allowable values are 'true' and 'false'. Allowable values for usage_pooling
|
||||||||||||||||||||||||||||||||||||||||
string | 2 | Usage tracking options on the Plans in the account.
Allowable values for usage_threshold_applicability
|
||||||||||||||||||||||||||||||||||||||||
Start of custom_rates array | ||||||||||||||||||||||||||||||||||||||||||
array | Array of custom rates for the services provided in the Master Plan | |||||||||||||||||||||||||||||||||||||||||
Field Name | Field Type | Max Length | Description | |||||||||||||||||||||||||||||||||||||||
long | 22 | Aria-assigned identifier for the service. Entering a value in this field creates a custom rate for the Plan instance you are assigning to the account. | ||||||||||||||||||||||||||||||||||||||||
OR | ||||||||||||||||||||||||||||||||||||||||||
string | 100 | Client-defined identifier for the service | ||||||||||||||||||||||||||||||||||||||||
long | 22 | Rate tier number, relative to the specified service, to which this custom rate is applied. This field is required if you are creating a custom rate for this Plan instance. | ||||||||||||||||||||||||||||||||||||||||
long | 22 | Unit starting point for the specified rate tier number | ||||||||||||||||||||||||||||||||||||||||
long | 22 | Unit-end point for the specified rate tier number | ||||||||||||||||||||||||||||||||||||||||
double | 22 | Custom rate per unit for the specified service and rate tier number | ||||||||||||||||||||||||||||||||||||||||
End of custom_rates array | ||||||||||||||||||||||||||||||||||||||||||
string | 100 | Purchase order number assigned to the Plan instance | ||||||||||||||||||||||||||||||||||||||||
Start of supp_plan array | ||||||||||||||||||||||||||||||||||||||||||
array |
Supplemental Plan assigned under the Master Plan, defined as a subset of the master_plans_detail. You can define more than one Supplemental Plan array to support a Master Plan with more than one Supplemental Plan in a Plan hierarchy. |
|||||||||||||||||||||||||||||||||||||||||
Field Name | Field Type | Max Length | Description | |||||||||||||||||||||||||||||||||||||||
array |
An array of parameters that define one or more child Supplemental Plans of this parent-level Supplemental Plan. The fields in this array are identical to the <supp_plan> array of which it is a member, and can be invoked recursively to create a Supplemental Plan hierarchy of n levels and/or members. For more information about how to format a call that utilizes this option, see Calling create_acct_complete_m: Advanced Topics and Best Practices. |
|||||||||||||||||||||||||||||||||||||||||
long | 22 | Aria-assigned identifier for a supplemental service Plan. Allowable values are limited to valid custom Plan numbers for a client. Entering a value in this field assigns a Supplemental Plan to a Master Plan Instance on an account. | ||||||||||||||||||||||||||||||||||||||||
OR | ||||||||||||||||||||||||||||||||||||||||||
string | 100 | Client-defined Supplemental Plan ID | ||||||||||||||||||||||||||||||||||||||||
string | 1000 | Description for each assigned Master Plan | ||||||||||||||||||||||||||||||||||||||||
string | 100 | Unique client-defined ID for each assigned Master Plan | ||||||||||||||||||||||||||||||||||||||||
long | 22 | Used for non-persistent referencing of a Plan instance within the API request. Entering a value in this field is required to map the Supplemental Plan to its parent Plan instance. | ||||||||||||||||||||||||||||||||||||||||
long | 8 | 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. | ||||||||||||||||||||||||||||||||||||||||
Start of supp_plan_services array | ||||||||||||||||||||||||||||||||||||||||||
array | List of services associated with the Master Plan being assigned on the account | |||||||||||||||||||||||||||||||||||||||||
Field Name | Field Type | Max Length | Description | |||||||||||||||||||||||||||||||||||||||
long | 22 | A multidimensional array of Services for this Plan | ||||||||||||||||||||||||||||||||||||||||
OR | ||||||||||||||||||||||||||||||||||||||||||
string | 100 | Multidimensional array of client-defined service ID for this Plan | ||||||||||||||||||||||||||||||||||||||||
long | 22 | Aria-assigned unique location identifier. | ||||||||||||||||||||||||||||||||||||||||
string | 100 | Client-defined unique identifier for the origin location for the service associated with the Plan. Depending on taxation configuration, this address may be used for tax calculations. If both svc_location_no and client_svc_location_id are provided, svc_location_no takes precedence. | ||||||||||||||||||||||||||||||||||||||||
long | 32 | Aria-assigned address sequence number | ||||||||||||||||||||||||||||||||||||||||
End of supp_plan_services array | ||||||||||||||||||||||||||||||||||||||||||
Start of plan_unit_instances array | ||||||||||||||||||||||||||||||||||||||||||
array | Array of Plan unit instances | |||||||||||||||||||||||||||||||||||||||||
Field Name | Field Type | Max Length | Description | |||||||||||||||||||||||||||||||||||||||
string | 100 | Client-assigned identifier for the Plan unit instance. Entering a value in this field is required if you are creating a Plan unit instance for a Supplemental Plan. | ||||||||||||||||||||||||||||||||||||||||
Start of plan_unit_instance_services array | ||||||||||||||||||||||||||||||||||||||||||
array | Array of Plan unit instance services | |||||||||||||||||||||||||||||||||||||||||
Field Name | Field Type | Max Length | Description | |||||||||||||||||||||||||||||||||||||||
long | 22 | Specifies the Aria-assigned unique service identifier against which fulfillment details must be captured and stored. You must enter a value in this field if you are creating a plan_unit_instance for a Supplemental Plan. | ||||||||||||||||||||||||||||||||||||||||
OR | ||||||||||||||||||||||||||||||||||||||||||
string | 100 | Client-assigned identifier for the service (only for fulfillment based service) | ||||||||||||||||||||||||||||||||||||||||
string | 10 | Fulfillment completion date. Can be in past, today or future date. | ||||||||||||||||||||||||||||||||||||||||
long | 1 |
Derives whether the fulfillment date is assigned/modified or removed from the fulfillment based service on the Plan unit instance. Allowable values for fulfillment_directive
|
||||||||||||||||||||||||||||||||||||||||
End of plan_unit_instance_services array | ||||||||||||||||||||||||||||||||||||||||||
Start of plan_unit_inst_fields array | ||||||||||||||||||||||||||||||||||||||||||
array | Array of client-defined Plan unit instance fields | |||||||||||||||||||||||||||||||||||||||||
Field Name | Field Type | Max Length | Description | |||||||||||||||||||||||||||||||||||||||
string | 300 | Field name of Plan unit instance field. Entering a value in this field creates a supplemental field for the Plan unit instance. | ||||||||||||||||||||||||||||||||||||||||
string | 1000 | The value stored under this field | ||||||||||||||||||||||||||||||||||||||||
long | 1 |
Directive is mandatory if field name/value pair are specified. Allowable values for plan_unit_inst_directive
|
||||||||||||||||||||||||||||||||||||||||
End of plan_unit_inst_fields array | ||||||||||||||||||||||||||||||||||||||||||
End of plan_unit_instances array | ||||||||||||||||||||||||||||||||||||||||||
Start of supp_plan_nso_list array | ||||||||||||||||||||||||||||||||||||||||||
array | Non-Subscription offerings that are purchased with the Plan | |||||||||||||||||||||||||||||||||||||||||
Field Name | Field Type | Max Length | Description | |||||||||||||||||||||||||||||||||||||||
string | 100 | Client SKU of the NSO/Inventory item. Entering a value in this field includes the item in the order being created. | ||||||||||||||||||||||||||||||||||||||||
long | 22 | NSO quantity that is purchased along with Plan | ||||||||||||||||||||||||||||||||||||||||
long | 22 | Aria-assigned unique identifier for the origin location for the item (NSO) being purchased. Depending on taxation configuration, this address may be used for tax calculations. If both svc_location_no and client_svc_location_id are provided, svc_location_no takes precedence. | ||||||||||||||||||||||||||||||||||||||||
string | 100 | Client-defined unique identifier for the origin location for the item (NSO) being purchased | ||||||||||||||||||||||||||||||||||||||||
long | 32 | Aria-assigned address sequence number | ||||||||||||||||||||||||||||||||||||||||
End of supp_plan_nso_list array | ||||||||||||||||||||||||||||||||||||||||||
Start of plan_instance_fields_info array | ||||||||||||||||||||||||||||||||||||||||||
array | ||||||||||||||||||||||||||||||||||||||||||
Field Name | Field Type | Max Length | Description | |||||||||||||||||||||||||||||||||||||||
long | 22 | Product field number. Entering a value in this field creates a Plan instance field for the Supplemental Plan. | ||||||||||||||||||||||||||||||||||||||||
OR | ||||||||||||||||||||||||||||||||||||||||||
string | 100 | Field name of Plan unit instance field. Entering a value in this field creates a field if it does not exist, or assigns it if it does exist. | ||||||||||||||||||||||||||||||||||||||||
string | 1000 | Value of the product field. Values for product fields that do not match what is expected based on product field configuration are ignored. | ||||||||||||||||||||||||||||||||||||||||
End of plan_instance_fields_info array | ||||||||||||||||||||||||||||||||||||||||||
long | 22 | Aria-assigned identifier for an alternative rate schedule that is assigned to the Supplemental Plan in place of the default rate schedule | ||||||||||||||||||||||||||||||||||||||||
OR | ||||||||||||||||||||||||||||||||||||||||||
string | 100 | Client-defined alternate rate schedule ID | ||||||||||||||||||||||||||||||||||||||||
long | 4 | Number of reset months for each Plan | ||||||||||||||||||||||||||||||||||||||||
|
long | 1 |
Determines whether the usage accumulation reset months will automatically reset to same value at the end of the current period or will expire at end of current period. Allowable values for usage_accumulation_reset_months_ renewal_option
|
|||||||||||||||||||||||||||||||||||||||
string | 5 |
Indicates whether usage pooling is enabled for this Plan instance. Allowable values are 'true' and 'false'. Allowable values for usage_pooling
|
||||||||||||||||||||||||||||||||||||||||
string | 2 |
Usage tracking options on the Plans in the account Allowable values for usage_threshold_applicability
|
||||||||||||||||||||||||||||||||||||||||
Start of custom_rates array | ||||||||||||||||||||||||||||||||||||||||||
array | Array of custom rates for the services provided in the Supplemental Plan | |||||||||||||||||||||||||||||||||||||||||
Field Name | Field Type | Max Length | Description | |||||||||||||||||||||||||||||||||||||||
long | 22 | Aria-assigned identifier for the service. Entering a value in this field is required to create custom rates for the associated Plan. | ||||||||||||||||||||||||||||||||||||||||
OR | ||||||||||||||||||||||||||||||||||||||||||
string | 100 | Client-defined identifier for the service. | ||||||||||||||||||||||||||||||||||||||||
long | 22 | Rate tier number, relative to the specified service, to which this custom rate is applied. Entering a value in this field is required to create custom rates for the associated Plan. | ||||||||||||||||||||||||||||||||||||||||
long | 22 | Unit starting point for the specified rate tier number | ||||||||||||||||||||||||||||||||||||||||
long | 22 | Unit ending point for the specified rate tier number | ||||||||||||||||||||||||||||||||||||||||
double | 22 | Custom rate per unit for the specified service and rate tier number | ||||||||||||||||||||||||||||||||||||||||
End of custom_rates array | ||||||||||||||||||||||||||||||||||||||||||
string | 100 | Purchase order number assigned to the Plan instance | ||||||||||||||||||||||||||||||||||||||||
End of supp_plan array | ||||||||||||||||||||||||||||||||||||||||||
End of master_plans_detail array | ||||||||||||||||||||||||||||||||||||||||||
string | 5 |
Indicates that the account represents a single individual, used primarily in Business-to-Consumer (B2C) business models. The primary purpose of this field is to support Person Accounts objects in Salesforce via Aria for Salesforce. Allowable values for consumer_acct_ind
|
||||||||||||||||||||||||||||||||||||||||
long | 8 | Profile ID of an existing revenue recognition profile | ||||||||||||||||||||||||||||||||||||||||
OR | ||||||||||||||||||||||||||||||||||||||||||
string | 100 | Client-defined identifier of an existing revenue recognition profile. If this parameter is specified, it takes precedence over revrec_profile_no. | ||||||||||||||||||||||||||||||||||||||||
string | 100 | Purchase order number assigned to the account. | ||||||||||||||||||||||||||||||||||||||||
long | 22 | Aria-assigned unique identifier of the locale used for translations. This value must be unique across all Aria clients. | ||||||||||||||||||||||||||||||||||||||||
OR | ||||||||||||||||||||||||||||||||||||||||||
string | 50 | Name of the locale. | ||||||||||||||||||||||||||||||||||||||||
Start of contacts array | ||||||||||||||||||||||||||||||||||||||||||
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. | |||||||||||||||||||||||||||||||||||||||||
Field Name | Field Type | Max Length | Description | |||||||||||||||||||||||||||||||||||||||
long | 32 | A caller-defined numeric value is required if you wish to add a new contact as an account contact, billing contact, statement contact, or destination contact. This value can then be used to reference this new contact within the context of this API request (and is not stored in Aria). | ||||||||||||||||||||||||||||||||||||||||
string | 32 | The first name of the contact. | ||||||||||||||||||||||||||||||||||||||||
string | 2 | The middle initial of the contact. | ||||||||||||||||||||||||||||||||||||||||
string | 32 | The last name of the contact. | ||||||||||||||||||||||||||||||||||||||||
string | 100 | The company name of the contact. | ||||||||||||||||||||||||||||||||||||||||
string | 100 | The first address line of the contact. | ||||||||||||||||||||||||||||||||||||||||
string | 100 | The second address line of the contact. | ||||||||||||||||||||||||||||||||||||||||
string | 100 | The third address line of the contact. | ||||||||||||||||||||||||||||||||||||||||
string | 32 | The city of the contact. | ||||||||||||||||||||||||||||||||||||||||
string | 32 |
Locality of the contact. 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 addresses in the United States, Australia, and Canada. |
||||||||||||||||||||||||||||||||||||||||
string | 10 |
State or province of the contact. The official postal-service code for any state, province, or territory in the United States, Australia, or Canada. This field does not support states, provinces, or territories in other countries. This field is ignored for all addresses outside the United States, Australia, and Canada. Use the <locality> field for addresses in those countries. |
||||||||||||||||||||||||||||||||||||||||
string | 2 | The country of the contact. Provide the ISO-compliant 2-character country code abbreviation in uppercase. | ||||||||||||||||||||||||||||||||||||||||
string | 14 | The postal/zip code of the contact. | ||||||||||||||||||||||||||||||||||||||||
string | 25 | The phone number of the contact. | ||||||||||||||||||||||||||||||||||||||||
string | 10 | The phone number extension of the contact. | ||||||||||||||||||||||||||||||||||||||||
string | 20 | The cell phone number of the contact. | ||||||||||||||||||||||||||||||||||||||||
string | 25 | The work phone number of the contact. | ||||||||||||||||||||||||||||||||||||||||
string | 10 | The work phone number extension of the contact. | ||||||||||||||||||||||||||||||||||||||||
string | 25 | The fax number of the contact. | ||||||||||||||||||||||||||||||||||||||||
string | 320 | The email address of the contact. | ||||||||||||||||||||||||||||||||||||||||
string | 10 | Birthdate of the contact in yyyy-mm-dd format. | ||||||||||||||||||||||||||||||||||||||||
End of contacts array | ||||||||||||||||||||||||||||||||||||||||||
long | 1 |
Indicator for combining invoices when retroactive start dates, negative bill lag days, or Plan changes just prior to the next billing date would otherwise have generated multiple invoices. The allowable values are 1, 2, or 3. Allowable values for combine_invoices
|
||||||||||||||||||||||||||||||||||||||||
long | 1 |
Enables or disables fraud filtering. If no value is provided, the system will default to 2. To use fraud filtering, you must have it enabled and configured in your payment gateway. Contact your payment gateway representative for setup information and additional documentation.
Allowable values for fraud_filter
|
||||||||||||||||||||||||||||||||||||||||
Start of fraud_control_fields array | ||||||||||||||||||||||||||||||||||||||||||
array |
Your chosen fraud protection options passed as an array of fraud_control_field_name/fraud_control_field_value key-value pairs. This array allows you to specify your fraud filtering options. To use fraud filtering, you must have fraud functionality enabled and configured in your payment gateway's portal. Contact your payment gateway representative for setup information and additional documentation. The allowable fields and values for the key-value pairs are listed below. |
|||||||||||||||||||||||||||||||||||||||||
Field Name | Field Type | Max Length | Description | |||||||||||||||||||||||||||||||||||||||
string | 100 |
Indicates whether to send a request to the processor for fraud filtering information. If you set it to 0 (disable), then Aria will ignore all other fraud filtering fields. Allowable values for fraud_filtering_enabled
|
||||||||||||||||||||||||||||||||||||||||
string | 100 | Indicates whether to change the status of the account or Master Plan Instance(s) if:
Set it to 1 (true) if you want to change the status. Set it to 0 (false) if you do not want to change the status. Allowable values for change_status_on_fraud_filtering_failure
|
||||||||||||||||||||||||||||||||||||||||
string | 100 | If change_status _on_fraud_filtering_failure is set to true and the fraud filtering request returns a failure response, use this field to indicate the desired status of theMaster Plan Instance. | ||||||||||||||||||||||||||||||||||||||||
string | 100 |
Indicates whether to change the status of the account or Master Plan Instance(s) if fraud_filtering_enabled is set to 1 (enable). Set it to 1 (true) if you want to change the status. Set it to 0 (false) if you do not want to change the status. Allowable values for change_status_on_fraud_filtering_review
|
||||||||||||||||||||||||||||||||||||||||
string | 100 | If change_status _on_fraud_filtering_review is set to 1 (true), use this field to indicate the desired status of the Master Plan Instance. | ||||||||||||||||||||||||||||||||||||||||
string | 100 |
Indicates whether to change the status of the Master Plan Instance(s) if the purchase transaction failed the fraud filtering check for the credit card prefix. Set it to 1 (true) if you want to change the status. Set it to 0 (false) if you do not want to change the status. (applies to Direct Post) Allowable values for change_mp_status_on_fraud_filtering_cc_prefix_failure
|
||||||||||||||||||||||||||||||||||||||||
string | 100 | If change_mp_status_on_fraud_filtering_cc_prefix_failure is set to 1 (true), use this field to indicate the desired status of the Master Plan Instance. (applies to Direct Post) | ||||||||||||||||||||||||||||||||||||||||
string | 100 | Indicates whether to change the status of the Master Plan Instance(s) if the purchase transaction failed the fraud filtering check for the credit card number. Set it to 1 (true) if you want to change the status. Set it to 0 (false) if you do not want to change the status. (applies to Direct Post)
Allowable values for change_mp_status_on_fraud_filtering_cc_number_failure
|
||||||||||||||||||||||||||||||||||||||||
string | 100 | If change_mp_status_on_fraud_filtering_cc_number_failure is set to 1 (true), use this field to indicate the desired status of the Master Plan Instance. (applies to Direct Post) | ||||||||||||||||||||||||||||||||||||||||
string | 100 |
Indicates whether to change the status of the Master Plan Instance(s) if the purchase transaction failed the fraud filtering check for the credit card issuing country. Set it to 1 (true) if you want to change the status. Set it to 0 (false) if you do not want to change the status. (applies to Direct Post) Allowable values for change_mp_status_on_fraud_filtering_cc_issuing_country_failure
|
||||||||||||||||||||||||||||||||||||||||
string | 100 | If change_mp_status_on_fraud_filtering_cc_issuing_country_failure is set to 1 (true), use this fie ld to indicate the desired status of the Master Plan Instance. (applies to Direct Post) | ||||||||||||||||||||||||||||||||||||||||
string | 100 | Indicates whether to change the status of the Master Plan Instance(s) if the fraud filtering check for the credit card issuing country returned a "suspect" value. Set it to 1 (true) if you want to change the status. Set it to 0 (false) if you do not want to change the status. (applies to Direct Post)
Allowable values for change_mp_status_on_fraud_filtering_cc_issuing_country_suspect
|
||||||||||||||||||||||||||||||||||||||||
string | 100 | If change_mp_status_on_fraud_filtering_cc_issuing_country_suspect is set to 1 (true), use this field to indicate the desired status of the Master Plan Instance. (applies to Direct Post) | ||||||||||||||||||||||||||||||||||||||||
End of fraud_control_fields array | ||||||||||||||||||||||||||||||||||||||||||
long | 1 |
Defines a recurring payment type for Credit Card and Tokenized Credit Cards. Allowable values for recurring_processing_model_ind
|
||||||||||||||||||||||||||||||||||||||||
End of acct array | ||||||||||||||||||||||||||||||||||||||||||
Start of optional_transaction_qualifiers array | ||||||||||||||||||||||||||||||||||||||||||
optional_transaction_qualifiers | array | Array of additional values you can associate with this API call. | ||||||||||||||||||||||||||||||||||||||||
Field Name | Field Type | Max Length | Description | |||||||||||||||||||||||||||||||||||||||
string | 100 | Name of the field you want to associate with this API call. | ||||||||||||||||||||||||||||||||||||||||
string | 100 | Corresponding value of the field you want to associate with this API call. | ||||||||||||||||||||||||||||||||||||||||
End of optional_transaction_qualfiers array | ||||||||||||||||||||||||||||||||||||||||||
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. | |||||||||||||||||||||||||||||||||||||||
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. | |||||||||||||||||||||||||||||||||||||||
include_plan_instance_queue | string | 5 |
Use this field to obtain the list of Plan changes that you scheduled using this API. Allowable values for include_plan_instance_queue
|
|||||||||||||||||||||||||||||||||||||||
auto_assign_mandatory_supp_plans | string | 5 |
Governs the behavior of mandatory Supplemental Plans. If set to true, it will include all the mandatory Supplemental Plans belonging to the parent Plan without having to explicitly set them. If set to false, you must enter each of those mandatory Supplemental Plans. Defaults to 'False'. This will override the "Included by Default" setting in the Product Catalog for a given Supplemental Plan. Allowable values for auto_assign_mandatory_supp_plans
|
|||||||||||||||||||||||||||||||||||||||
Start of proc_field_override array | ||||||||||||||||||||||||||||||||||||||||||
array |
Your chosen data to send to your payment gateway passed as an array of proc_field_name/proc_field_value key-value pairs. The allowable field(s) and values for the key-value pairs are listed below. |
|||||||||||||||||||||||||||||||||||||||||
Field Name | Field Type | Max Length | Description | |||||||||||||||||||||||||||||||||||||||
string | 2 |
If you use Chase Paymentech or Vantiv, this field allows you to tell that payment gateway which transaction type is involved (examples: single or recurring transaction) when you process a customer's payment information. This field applies to credit cards and tokenized credit cards. If you don't pass a value into this field, it will default to -1 (use client configuration settings). Notes:
Aria will use this order of precedence to determine the transaction type:
Allowable values for transaction_type
|
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. | ||||||||||||
out_acct | hash | |||||||||||||
long | Aria-assigned account identifier. This value is unique across all Aria-managed accounts. | |||||||||||||
string | The user ID, unique among all accounts for this Aria client, assigned to the newly created account. If input parameter "user_id" was provided, the same value is returned. If no "user_id" was provided as input and the client is configured within Aria for automatic generation of random user_id values OR is configured to use account email addresses as user_ids, the generated value is returned. | |||||||||||||
string | Client-defined account identifier. | |||||||||||||
long | Aria-assigned unique identifier of the locale used for translations. This value is unique across all Aria-managed accounts. | |||||||||||||
string | Name of the account level locale. | |||||||||||||
long | The Aria-assigned unique identifier for the account contact saved on the account. | |||||||||||||
hash | List of billing contacts saved on the account. | |||||||||||||
long | Aria-assigned sequence number for this payment method. | |||||||||||||
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. | |||||||||||||
hash | List of statement contacts saved on the account. | |||||||||||||
long | Aria-assigned unique identifier for the billing group on the account | |||||||||||||
long | The Aria-assigned unique identifier for the statement contact associated with a billing group on the account. | |||||||||||||
hash | List of contacts saved on the account that are not used as an account, billing, or statement contact | |||||||||||||
long | Aria-assigned unique identifier for the contact saved on the account | |||||||||||||
long | Value provided for the idx parameter in the API request | |||||||||||||
hash | ||||||||||||||
long | Unique ID of the contract assigned to this account | |||||||||||||
string | Client-assigned unique contract identifier | |||||||||||||
hash | ||||||||||||||
long | List of Plan instance(s) to be associated with the contract | |||||||||||||
string | List of client-defined Plan instance(s) to associated with the contract | |||||||||||||
string | Specifies the scope of Plan subscription coverage enforced by the contract | |||||||||||||
string | Returns the newly created cookie ID of the account | |||||||||||||
hash | ||||||||||||||
long | Aria-defined error code specific to any error encountered during any invoicing/billing processes performed inline as a result of this method call | |||||||||||||
string | The explanatory text corresponding to the value returned (if any) in output "invoicing_error_code" | |||||||||||||
long | If a collection is attempted, returns the error code associated with the collection | |||||||||||||
string | The error message associated with collection_error_code | |||||||||||||
long | The error code if statement generation fails | |||||||||||||
string | Text message associated with statement_error_code | |||||||||||||
long | The billing group number mapped against each Master Plan | |||||||||||||
string | Client-defined billing group ID | |||||||||||||
hash | ||||||||||||||
long | Unique Plan-instance number for each assigned Master Plan | |||||||||||||
string | Unique client-defined ID for each assigned Master Plan | |||||||||||||
long | Unique identifier for an order that is created for bundled NSOs | |||||||||||||
string | Status label for this order | |||||||||||||
hash | Array of Plan unit instances | |||||||||||||
long | Aria unique Plan unit instance number | |||||||||||||
string | Client-assigned identifier for the Plan unit instance | |||||||||||||
hash | ||||||||||||||
long | Unique Plan instance number for each assigned supplementary Plan | |||||||||||||
string | Unique client-defined ID for each assigned supplementary Plan Plan | |||||||||||||
hash | Array of Plan unit instances | |||||||||||||
long | Aria unique Plan-unit instance number | |||||||||||||
string | Client-assigned identifier for the Plan unit instance | |||||||||||||
hash | ||||||||||||||
long | Unique ID of the contract assigned to this account | |||||||||||||
long | Unique Plan-instance number for each assigned Master Plan | |||||||||||||
string | Unique client-defined ID for each assigned Master Plan | |||||||||||||
hash | Errors from third-party systems like taxation engines are returned here, whereas the Aria-generated error codes are returned in the error_code and error_msg fields at the root level of the API return. | |||||||||||||
string | The type of error code being represented, such as taxation | |||||||||||||
string | The error code returned by the third party system | |||||||||||||
string | The error message returned by the third party system | |||||||||||||
hash | ||||||||||||||
long | The unique identifier of the invoice, if any, created automatically by Aria in conjunction with this call | |||||||||||||
long | The billing group number mapped against each Master Plan | |||||||||||||
string | Unique client-defined ID for each assigned Master Plan (DEPRECATED) | |||||||||||||
string | Client-defined billing group ID. | |||||||||||||
string | Processor return code from CVV validation | |||||||||||||
string | Processor return code from address validation | |||||||||||||
string | Processor return code for security validation | |||||||||||||
string | Processor status code | |||||||||||||
string | Processors status description | |||||||||||||
string | Processor payment ID | |||||||||||||
string | Authorization code provided by the issuing bank | |||||||||||||
string | Additional information passed to payment processor | |||||||||||||
string | Transaction ID from payment processor. If received as part of an auth request, it must be retained for future settlement and match the value from the auth response. It should also be used for future recurring transaction auths/settlement. | |||||||||||||
string | The fraud filtering information provided by the payment processor in response to a fraud filtering request. | |||||||||||||
double | Charges before tax on the initial invoice for this account | |||||||||||||
double | Tax charges on the initial invoice for this account | |||||||||||||
double | The sum of invoice_charges_before_tax and invoice_tax_charges | |||||||||||||
double | The amount of credit on the initial invoice for this account | |||||||||||||
double | The total owed on the initial invoice for this account | |||||||||||||
double | Total amount of the credit to be applied to the account | |||||||||||||
double | The tax amount of the credit to be applied | |||||||||||||
double | The credit to be applied before tax is taken into account | |||||||||||||
double | Grand total of this invoice | |||||||||||||
double | The currency amount of any resulting proration action performed as a result of the fulfillment based service unit assignment. When proration is performed the value returned in this field is a positive currency value (indicating a resulting charge to the account). If the value passed in field do_write is false then any positive value returned in this field is notational only, demonstrating what proration effect would be applied to the account if the requested fulfillment based Plan unit instance were to be actually assigned. | |||||||||||||
double | Predicted monthly recurring cost of the items and Plans on this invoice | |||||||||||||
double | Predicted annual recurring cost of the items and Plans on this invoice | |||||||||||||
hash | ||||||||||||||
long | The line number on the initial invoice | |||||||||||||
long | The unique ID Plan this line represents | |||||||||||||
string | Client-defined unique ID for Plan this line represents | |||||||||||||
long | Unique Plan instance number for each assigned Master Plan | |||||||||||||
string | Unique client-defined ID for each assigned Master Plan | |||||||||||||
string | Name of the Plan this line represents | |||||||||||||
long | Unique ID for the service this line represents | |||||||||||||
string | Client-defined unique ID for the service this line represents | |||||||||||||
string | Name of the service this line represents | |||||||||||||
long | Chart of Accounts ID for the service this line represents | |||||||||||||
string | Client-defined Chart of Accounts code for the service this line represents | |||||||||||||
double | Number of units of the item or Plan on this line | |||||||||||||
double | Charge per unit of the item or Plan on this line | |||||||||||||
double | Subtotal amount of this line | |||||||||||||
string | Long description of this line, used when printing or otherwise displaying invoices | |||||||||||||
string | Starting date range for the item or Plan on this line | |||||||||||||
string | Ending date range for the item or Plan on this line, if any | |||||||||||||
long | Type of charge or credit associated with this line item | |||||||||||||
double | Full, non-prorated number of units of the service code | |||||||||||||
double | Percentage of the line_base_units billed | |||||||||||||
string | Prorated days in total days | |||||||||||||
long | Prorated days of period in this invoice | |||||||||||||
string | Prorated invoice description | |||||||||||||
string | Coupon code applied to the invoice | |||||||||||||
string | Client SKU of the NSO/Inventory item. | |||||||||||||
long | Unique identifier for an order in the context of an client_no and account_no | |||||||||||||
long | Unique ID of the item being retrieved | |||||||||||||
string | Unique client-defined item ID being retrieved | |||||||||||||
long | Total days of period in this invoice | |||||||||||||
long | Aria-assigned unique rate schedule number | |||||||||||||
long | Sequential number in the rate schedule for determining tiers | |||||||||||||
long | Address sent as the bill-from address to the tax engine for tax calculations. Depending on the taxation configuration, this parameter may return the Aria-assigned unique identifier of the service location for the invoice line item. Note that service locations can be associated with a service for a given Plan instance on an account, with an item (NSO) purchased as part of a one-time order, or with a service as defined in the product catalog. | |||||||||||||
long | Address sent as the ship-from address to the tax engine for tax calculations. Depending on the taxation configuration, this parameter may return the Aria-assigned unique identifier of the service location for the invoice line item. Note that service locations can be associated with a service for a given Plan instance on an account, with an item (NSO) purchased as part of a one-time order, or with a service as defined in the product catalog. | |||||||||||||
long | Address sent as the bill-to address to the tax engine for tax calculations. This parameter returns the Aria-assigned unique identifier of the contact on the account used as the bill-to address for the invoice line item. | |||||||||||||
long | Address sent as the ship-to address to the tax engine for tax calculations. This parameter returns the Aria-assigned unique identifier of the contact on the account used as the ship-to address for the invoice line item. | |||||||||||||
long | Identifies whether this is a custom rate. A value of 1 indicates that it is a custom rate. A value of 0 indicates that it is a standard rate. Please note that there are cases in which the custom_rate_ind is null/0 but rate_schedule_no is also null. These special cases include rebill rate changes and multi-plan contract early cancellation fees the charges are neither from regular rate schedule nor from custom rates. Another such case is the dummy zero amount line formed when net usage is negative for a usage service. | |||||||||||||
hash | ||||||||||||||
long | Line number associated with each tax detail record | |||||||||||||
long | Tax line on the invoice which includes the tax amount associated with this tax_detail_line | |||||||||||||
long | Invoice line item for which the tax for this tax_detail_line was calculated. | |||||||||||||
double | Amount of tax applied for the given tax type | |||||||||||||
long | Tax jurisdiction code: 0 = Federal, 1 = State / Province. | |||||||||||||
double | Rate at which tax is calculated for the tax type used by the tax engine | |||||||||||||
long | Indicates whether the invoice line amount was tax inclusive | |||||||||||||
string | Identifier of the tax type returned by the tax engine | |||||||||||||
string | Description of the tax type returned by the tax engine | |||||||||||||
string | Category of the tax type returned by the tax engine | |||||||||||||
string | Jurisdiction name returned by the tax engine | |||||||||||||
string | Invoice summary text returned by the tax engine | |||||||||||||
double |
The amount multiplied by tax rate before rounding precision. Also referred to as "raw tax amount." Note: Assuming that the client setting Aria Internal Tax Rounding Method is set to "Per invoice." |
|||||||||||||
double |
The amount carried over from previous <unrounded_tax_amt>. It is a remainder, and its value can be positive or negative (based on the previous remainder). Note: Assuming that the client setting Aria Internal Tax Rounding Method is set to "Per invoice." |
|||||||||||||
double |
The amount of adjusted tax before rounding precision, calculated as the sum of <unrounded_tax_amt> and <carryover_from_prev_amt>. Note: Assuming that the client setting Aria Internal Tax Rounding Method is set to "Per invoice." |
|||||||||||||
double |
The amount carried over from current <unrounded_tax_amt>. It is a remainder, and its value can be positive or negative based on the previous remainder. Note: Assuming that the client setting Aria Internal Tax Rounding Method is set to "Per invoice." |
|||||||||||||
hash | ||||||||||||||
array | The fraud filtering information provided by the payment processor as described below. (DEPRECATED) | |||||||||||||
string | Fraud country status provided by the payment processor (DEPRECATED) | |||||||||||||
string | Fraud country code provided by the payment processor. (DEPRECATED) | |||||||||||||
hash | Fraud filtering response returned from the Payment Processor | |||||||||||||
string | Fraud country status provided by the payment processor. | |||||||||||||
string | Fraud country code provided by the payment processor. | |||||||||||||
plan_instance_queue | array | List of Plan changes scheduled using this API call. | ||||||||||||
long | Unique identifier associated with a specific scheduled Plan change. | |||||||||||||
long |
This identifies the type of scheduled Plan change. Allowable values for queue_type_ind
|
|||||||||||||
long | Aria Plan instance number of the future Plan scheduled to be assigned to the account. | |||||||||||||
chief_acct_info | hash |
Array of information about the “chief” account, which is the ancestor at the highest level in a parent-child account hierarchy. Example: if you have a child account with a parent and "grandparent", this array will identify the "grandparent" account as the “chief” account. This array will return values even if the queried account is not part of an account hierarchy. If the account is not part of account hierarchy, this array will return the queried account details in this output parameter. |
||||||||||||
long | Account number of the “chief” account, which is the ancestor at the highest level in a parent-child account hierarchy. | |||||||||||||
string | User ID of the “chief” account, which is the ancestor at the highest level in a parent-child account hierarchy. | |||||||||||||
string | Client-defined identifier of the “chief” account, which is the ancestor at the highest level in a parent-child account hierarchy. | |||||||||||||