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 | Boolean indicator informing Aria whether or not to actually perform the requested operation. If 'false' is passed in this field Aria will, if applicable, calculate any potential effects stemming from this call such as pro-ration, 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 wish to present the user with a 'confirmation page' informing of the would-be effects of the requested operation prior to actually performing it. Do_write defaults to 'true' Allowable Values | ||
client_receipt_id | string | 50 | Client-defined unique identifier used to track related system actions | |
acct_row | array | Defines all information about the top-level account, including contact information, assigned client plans, and payment configuration. | ||
![]() | array | Defines the child accounts. Zero or more child accounts can be created under the top-level account. Each child account contains the same set of fields as the top-level account, including their own child accounts. This supports the creation of an account hierarchy within a single call to create_acct_complete_m. | ||
![]() | string | 50 | Client-assigned identifier for the account. | |
![]() | 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 object in question for the current API call. Allowable Values | |
![]() | long | If a notification method is not provided, this value defaults to 1 (HTML email). Allowable Values | ||
![]() | string | 100 | Password for the given user. | |
![]() | string | 300 | Users secret question recorded to recover a password. | |
![]() | string | 300 | Response to a user's secret_question. | |
![]() | string | 32 | Contact First name. | |
![]() | string | 1 | Middle Initial of the contact. | |
![]() | string | 32 | Contact last name. | |
![]() | string | 100 | Company name of the contact. | |
![]() | string | 300 | First address line of the contact. | |
![]() | string | 300 | Second address line of the contact. | |
![]() | string | 300 | Third address line of the contact. | |
![]() | string | 32 | City of the contact. | |
![]() | string | 32 | Locality of the contact. | |
![]() | string | 2 | State or Province of the contact. The official postal-service codes for all United States, Australia and Canada states, provinces, and territories. This field does not support states, provinces or territories from other countries. Use the locality field for other countries. | |
![]() | string | 2 | Country of the contact. The ISO-compliant 2-character country code abbreviation in uppercase. | |
![]() | string | 15 | Postal/Zip code for the contact address. | |
![]() | string | 25 | Phone number of the contact. | |
![]() | string | 10 | Extension for the contact phone. | |
![]() | string | 20 | Contact cell phone. | |
![]() | string | 25 | Work phone number of the contact. | |
![]() | string | 10 | Extension for the contact work phone. | |
![]() | string | 25 | FAX phone number for the contact. | |
![]() | string | 500 | Email of the contact. | |
![]() | string | 14 | Contact date of birth. | |
![]() | long | 22 | Unique account number for the parent account. It is used in establishing parent-child billing relationships. | |
OR | ||||
![]() | string | 32 | User ID of the parent account. | |
OR | ||||
![]() | string | 50 | Client account ID of the parent account. | |
![]() | long | Indicator for performing full invoicing, and Perform Prorated Invoicing or client-defined on this account as part of this call. Allowable Values | ||
![]() | string | 14 | Alternative start date for the account. This date can be used to delay providing services to the account holder (for example: until they have been email validated). | |
![]() | long | 14 | Alternate bill day. | |
![]() | string | 14 | Date to set for retroactive start. | |
![]() | array | |||
![]() | long | Array of functional account groups. | ||
OR | ||||
![]() | string | Functional account group ID to which this account should be assigned. | ||
![]() | array | |||
![]() | long | Group ID for the collections account groups in which to place this account. | ||
OR | ||||
![]() | string | Collections account group ID to which this account should be assigned. | ||
![]() | array | Assigns one or more supplemental field values to the account. | ||
![]() | string | Name of the supplemental field. | ||
![]() | string | Value for the supplemental field. | ||
![]() | long | 1 | Indicates that the account is a test account and is treated as such in the system. Allowable Values | |
![]() | string | 14 | Date on which the account was first created outside of Aria. | |
![]() | string | 3-character ISO-compliant currency code in lowercase for monetary values used in the context of this API method. | ||
![]() | long | 22 | Functional account group number specifically designated for statement sequence number assignment. | |
OR | ||||
![]() | string | 100 | System-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. Allowable Values | |
![]() | long | Indicates whether or not the account is listed at the start of a master file. Allowable Values | ||
![]() | long | 22 | Email template number assigned to this account. | |
OR | ||||
![]() | string | 100 | Client-defined email template ID assigned to this account. | |
![]() | long | Alternate email template number to use for this account. | ||
OR | ||||
![]() | long | 100 | Client-defined alternate email template ID to use for this account. | |
![]() | string | Boolean indicator to override client's default configured behaviour for creating Pending/Real invoice. Allowable Values | ||
![]() | string | 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 | ||
![]() | array | |||
![]() | long | Surcharge number to be attached to the account. | ||
![]() | long | 22 | ||
![]() | string array | Coupon codes to assign to this account, if any. | ||
![]() | array | |||
![]() | long | 8 | Method_id corresponding to a payment method such as credit card, Electronic Check, Pre-Paid, Net Terms, etc. Allowable Values | |
![]() | string | 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. | |
![]() | string | 32 | First name of the billing contact. | |
![]() | string | 1 | 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 billing contact. | |
![]() | string | 100 | Second address line of the billing contact. | |
![]() | string | 100 | Third address line of the billing contact. | |
![]() | string | 32 | City of the billing contact. | |
![]() | string | 32 | Locality of the billing contact. | |
![]() | string | 2 | State or Province of the contact. The official postal-service codes for all United States, Australia and Canada states, provinces, and territories. This field does not support states, provinces or territories from other countries. Use the locality field for other countries. | |
![]() | string | 2 | Country of the billing contact. The ISO-compliant 2-character country code abbreviation in uppercase. | |
![]() | string | 14 | Postal code for the billing contact address. | |
![]() | string | 25 | Phone of the billing contact. | |
![]() | string | 10 | Billing contacts extension for the phone given. | |
![]() | string | 20 | Cell phone of the billing contact. | |
![]() | string | 25 | Work phone of the billing contact. | |
![]() | string | 100 | Extension for the billing contact work phone. | |
![]() | string | 25 | FAX phone number for the billing contact. | |
![]() | string | 500 | Email of the billing contact. | |
![]() | string | 14 | Billing contact date of birth. | |
![]() | string | 24 | Credit card number. | |
![]() | long | 2 | Expiration month for the credit card payment instrument. | |
![]() | long | 4 | Expiration year for the credit 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. | |
![]() | string | ABA (American Banking Association) unique identifier for the financial institution. | ||
![]() | string | 5 | Card Verification Value, used to help verify a transaction is being requested by the card holder since this value is physically printed on the credit card. | |
![]() | string | Raw "track 1" data from a swiped credit card used in a card-present transaction to initiate this request | ||
![]() | string | Raw "track 2" data from a swiped credit 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). | |
![]() | 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 | Enables 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 | A standard format of Bank Identifier Codes (BIC). Used for the Direct Debit payment method. It consists of 8 or 11 alphanumeric characters. Only hyphens and spaces 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 | 50 | 35 characters alphanumeric. Used for the Direct Debit payment method. A mandate is signed by the debtor to authorise 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. Used in Europe. 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. Used in Europe. Only hyphen and space are allowed to format the bank branch code. | |
![]() | long | 2 | Numeric code indicating the type of credit card. Allowable Values | |
![]() | 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. | ||
![]() | 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 | 8 | Non-persistent billing group identifier. This numeric identifier (that is., 1 for the first billing group, 2 for the second, and so on) 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 | If notification method is not provided, value defaults to 1 (HTML email). Allowable Values | ||
![]() | long | 32 | Notify template No. | |
![]() | long | 32 | Statement template No. | |
![]() | long | 32 | Credit note template No. | |
![]() | string | 32 | Client-defined identifier for the billing group's primary payment method. | |
OR | ||||
![]() | long | 32 | Non-persistent identifier for the billing group's primary payment method. | |
![]() | string | 32 | Client-defined identifier for the billing group's backup payment method. | |
OR | ||||
![]() | long | 100 | Non-persistent identifier for the billing group's backup payment method. | |
![]() | string | 32 | First name of the statement contact. | |
![]() | string | 1 | 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 statement contact. | |
![]() | string | 100 | Second address line of the statement contact. | |
![]() | string | 100 | Third address line of the statement contact. | |
![]() | string | 32 | City of the statement contact. | |
![]() | string | 32 | Locality of the statement contact. | |
![]() | string | 2 | State or Province of the contact. The official postal-service codes for all United States, Australia and Canada states, provinces, and territories. This field does not support states, provinces or territories from other countries. Use the locality field for other countries. | |
![]() | string | 2 | Country of the statement contact. The ISO-compliant 2-character country code abbreviation in uppercase. | |
![]() | string | 14 | Postal code for the statement contact address. | |
![]() | string | 25 | Phone of the statement contact. | |
![]() | string | 10 | This is the statement contacts extension for the phone given. | |
![]() | string | 20 | Cell phone of the statement contact. | |
![]() | string | 25 | Work phone of the statement contact. | |
![]() | string | 100 | This is the work phone extension for the statement contact work phone. | |
![]() | string | 25 | Specifies the FAX phone number for the statement contact. | |
![]() | string | 500 | Email of the statement contact. | |
![]() | string | 14 | Statement contact date of birth. | |
![]() | long | 8 | When value=1, account shall be sorted at the top of the master file when generated. Allowable Values | |
![]() | long | Payment terms number assigned to the account. | ||
![]() | string | 50 | Payment terms name assigned to the account. | |
![]() | ![]() | 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 for each account in the API request. | |
![]() | 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 | 8 | Non-persistent dunning group identifier. This numeric identifier (that is., 1 for the first dunning group, 2 for the second, and so on) 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. | |
![]() | array | |||
![]() | string | 100 | Client assigned unique contract identifier. | |
![]() | long | 8 | Type ID of this contract. Allowable Values | |
![]() | long | Number of months this contract should remain on the account. | ||
![]() | double | Fee charged to the account for prematurely ending this contract. | ||
![]() | string | Any client-defined comments stored on this contract at the account level. | ||
![]() | string | Date on which this contract takes effect. | ||
![]() | string | Allows the caller to set a specific end date when creating or modifying plan contracts. | ||
![]() | array | |||
![]() | long | 22 | List of plan instance(s) to be associated with the contract. | |
OR | ||||
![]() | string | 100 | List of client defined plan instance(s) 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 | |
![]() | ![]() | array | Allow multiple master plans subscription for an account. | |
![]() | ![]() | long | 22 | The system-defined Master Subscription plan number. |
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 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. | |
![]() | array | Array of plan unit instances. | ||
![]() | string | Client-assigned identifier for the plan unit instance. | ||
![]() | array | Array of plan unit instance services. | ||
![]() | long | 100 | Specifies the Aria-assigned unique service identifier. | |
OR | ||||
![]() | string | Client-assigned identifier for the service (only for fulfillment based service). | ||
![]() | string | It is a Fulfillment completion date. It can be in past, today or future date. | ||
![]() | long | 8 | This derives whether the fulfillment date should be assigned/modified or removed from the fulfillment based service on the plan unit instance. Allowable Values | |
![]() | array | Array of client-defined plan unit instance fields. | ||
![]() | string | Field name of plan unit instance field. | ||
![]() | string | The value stored under this field. | ||
![]() | long | 8 | The directive is mandatory if field name/value pair are specified. Allowable Values | |
![]() | long | 8 | Status of the object in question for the current API call. Allowable Values | |
![]() | long | 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_inst_no, client_resp_master_plan_inst_id, or resp_master_plan_inst_idx. The responsible Master Plan Instance must be owned by another account that is a parent or ancestor of the account you are creating. Allowable Values | ||
![]() | ![]() | long | 100 | 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 | 8 | 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. |
OR | ||||
![]() | long | 8 | 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. Other acceptable values for status_until_alt_start are any valid plan statuses. If an alternate starting date or alternate bill day is passed in, 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. | |
![]() | double | 12 | balance forward | |
![]() | string array | Coupon codes to assign to this plan instance, if any. | ||
![]() | array | Surcharge for master plan. | ||
![]() | long | 22 | ||
![]() | long | 22 | ||
![]() | long | Indicates whether to bill the NSO items immediately or, if not, to set bill on next billing anniversary date. Allowable Values | ||
![]() | array | Non-Subscription Offerings that are purchased with the plan. | ||
![]() | string | Client SKU of NSO/Inventory item. | ||
![]() | long | NSO quantity that is purchased along with plan. | ||
![]() | string | 100 | Purchase order number assigned to the one-time order. | |
![]() | array | |||
![]() | long | 38 | 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. | |
![]() | 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 | Number of reset months for each plan. | ||
![]() | string | 32 | Client-defined plan ID on which to enable usage pooling. | |
![]() | string | 100 | Usage tracking options on the plans in the account. Allowable Values | |
![]() | array | Array of custom rates for the services provided in the master plan. | ||
![]() | long | 22 | Aria-assigned identifier for the service. | |
OR | ||||
![]() | string | 32 | Client-defined identifier for the service. | |
![]() | long | 22 | Rate tier number, relative to the specified service, to which this custom rate is applied. | |
![]() | long | 12 | Unit starting point for the specified rate tier number. | |
![]() | long | 12 | Unit ending point for the specified rate tier number. | |
![]() | double | 12 | Custom rate per unit for the specified service and rate tier number. | |
![]() | string | 100 | Purchase order number assigned to the plan instance. | |
![]() | array | Supplemental plan instances assigned directly under a master plan instance. | ||
![]() | array | Supplemental plan instances assigned under another supplemental plan instance. This contains the same set of fields as the supplemental plan instances located directly under a master plan instance. This supports the creation of a master/supplemental plan structure, with a top-level master plan instance containing a hierarchy of supplemental plan instances. | ||
![]() | long | 22 | Aria-assigned identifier for a supplemental service plan. Allowable values are limited to valid custom plan numbers for client. | |
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. | |
![]() | 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. | |
![]() | array | Array of plan unit instances. | ||
![]() | string | Client-assigned identifier for the plan unit instance. | ||
![]() | array | Array of plan unit instance services. | ||
![]() | long | 100 | Specifies the Aria-assigned unique service identifier. | |
OR | ||||
![]() | string | Client-assigned identifier for the service (only for fulfillment based service). | ||
![]() | string | It is a Fulfillment completion date. It can be in past, today or future date. | ||
![]() | long | 8 | This derives whether the fulfillment date should be assigned/modified or removed from the fulfillment based service on the plan unit instance. Allowable Values | |
![]() | array | Array of client-defined plan unit instance fields. | ||
![]() | string | Field name of plan unit instance field. | ||
![]() | string | The value stored under this field. | ||
![]() | long | 8 | The directive is mandatory if field name/value pair are specified. Allowable Values | |
![]() | array | Non-Subscription Offerings that are purchased with the plan. | ||
![]() | string | The client sku of NSO/Inventory item | ||
![]() | long | NSO quantity that is purchased along with plan. | ||
![]() | array | |||
![]() | long | 38 | 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. | |
![]() | 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 | Number of reset months for each plan. | ||
![]() | string | 32 | Client-defined plan ID on which to enable usage pooling. | |
![]() | string | 100 | Usage tracking options on the plans in the account. Allowable Values | |
![]() | array | Array of custom rates for the services provided in the supplemental plan. | ||
![]() | long | 22 | Aria-assigned identifier for the service. | |
OR | ||||
![]() | string | 32 | Client-defined identifier for the service. | |
![]() | long | 22 | Rate tier number, relative to the specified service, to which this custom rate is applied. | |
![]() | long | 12 | Unit starting point for the specified rate tier number. | |
![]() | long | 12 | Unit ending point for the specified rate tier number. | |
![]() | double | 12 | Custom rate per unit for the specified service and rate tier number. | |
![]() | string | 100 | Purchase order number assigned to the plan instance. | |
![]() | string | 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 the SFDC Connector. Allowable Values | ||
![]() | 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 will take precedence over revrec_profile_no. | |
![]() | string | 100 | Purchase order number assigned to the account. | |
alt_caller_id | string | 100 | ||
optional_transaction_qualifiers | array | |||
![]() | string | 100 | ||
![]() | string | 100 | ||
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. |
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 will be 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 will be returned. |
![]() | string | The client_acct_id of this account, if one was supplied by the client. |
![]() | hash | |
![]() | long | The 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 be 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 | The 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 | The 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. |
![]() | hash | Array of plan unit instances |
![]() | long | Aria unique Plan Unit Instance Number. |
![]() | string | Client-assigned identifier for the plan unit instance. |
![]() | hash | |
![]() | long | The 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 identifer 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. |
![]() | string | The processor return code from CVV validation. |
![]() | string | Processor return code from address validation |
![]() | string | The processors return code for security validation. |
![]() | string | The processor status code |
![]() | string | The processors status description |
![]() | string | The processor payment ID |
![]() | string | Authorization code provided by the issuing bank |
![]() | string | Additional information passed to payment processor |
![]() | 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 | The 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 | The 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 will be 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 | The predicted monthly recurring cost of the items and plans on this invoice. |
![]() | double | The 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 | The 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 | The name of the plan this line represents |
![]() | long | The unique ID for the service this line represents |
![]() | string | The client-defined unique ID for the service this line represents |
![]() | string | The name of the service this line represents |
![]() | long | The Chart of Accounts ID for the service this line represents |
![]() | string | The client-defined Chart of Accounts code for the service this line represents |
![]() | double | The number of units of the item or plan on this line |
![]() | double | The charge per unit of the item or plan on this line |
![]() | double | The subtotal amount of this line |
![]() | string | The long description of this line, used when printing or otherwise displaying invoices |
![]() | string | The starting date range for the item or plan on this line |
![]() | string | If any, the ending date range for the item or plan on this line. |
![]() | long | Specifies the type of charge or credit associated with this line item. |
![]() | double | Specifies the full, non-prorated number of units of the service code. |
![]() | double | Specifies the percentage of the line_base_units billed. |
![]() | string | Specifies the prorated days in total days. |
![]() | long | Prorated days of period in this invoice |
![]() | string | Prorated invoice description. |
![]() | string | Specifies the coupon code applied to the invoice. |
![]() | string | The client-defined item identifier. |
![]() | long | The unique identifier for an order in the context of an client_no and account_no. |
![]() | long | The unique ID of the item being retrieved. |
![]() | string | The 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. |
![]() | hash | |
![]() | long | Line number associated with each tax detail record. |
![]() | long | The tax line on the invoice which includes the tax amount associated with this tax_detail_line. |
![]() | string | The invoice line item for which the tax for this tax_detail_line was calculated. |
![]() | double | Amount of tax applied for the given tax type. |
![]() | double | Tax jurisdiction code: 0 = Federal, 1 = State / Province. |
![]() | double | Rate at which tax is calculated for the tax type used by the tax engine. |
![]() | string | Indicates whether or not 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. |
![]() | hash |
Fill out the required input parameter to execute API Live. A Live call will be made against the URL you specify to give you actual results formatted.