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 does not support states, provinces, or territories in other countries.
create_order_with_plan_m
Allows creation of order and plan changes on a single invoice
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.
For a list of error messages generated by this API, see create_order_with_plan_m Error Messages.
Input Arguments
Req | Field Name | Field Type | Max Length | Description | ||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
client_no | long | 22 | Aria-assigned unique identifier indicating the Aria client providing service to this account. | |||||||||||||||||||||||||||||
auth_key | string | 32 | Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor. | |||||||||||||||||||||||||||||
acct_no | long | 22 | Aria-assigned account identifier. This value is unique across all Aria-managed accounts. | |||||||||||||||||||||||||||||
OR | ||||||||||||||||||||||||||||||||
client_acct_id | string | 50 | Client-defined account identifier. | |||||||||||||||||||||||||||||
Start of order_line_items array | ||||||||||||||||||||||||||||||||
order_line_items | array | |||||||||||||||||||||||||||||||
Field Name | Field Type | Max Length | Description | |||||||||||||||||||||||||||||
long | Aria-assigned unique identifier for the rate schedule. | |||||||||||||||||||||||||||||||
OR | ||||||||||||||||||||||||||||||||
string |
Client-defined unique identifier for the rate schedule. If both are not specified, the default rate schedule for the account's currency is chosen. |
|||||||||||||||||||||||||||||||
string | 100 | Client SKU of the NSO/Inventory item. | ||||||||||||||||||||||||||||||
double | The number of this item being purchased | |||||||||||||||||||||||||||||||
double | The subtotal of this line | |||||||||||||||||||||||||||||||
double | The discount per unit applied and included in the amount | |||||||||||||||||||||||||||||||
string | Any available client-supplied comments for this line | |||||||||||||||||||||||||||||||
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 will take precedence. | ||||||||||||||||||||||||||||||
string | 100 | The client-defined 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 will take precedence. | ||||||||||||||||||||||||||||||
long | 22 | The Aria-assigned unique identifier for the destination contact for the item (NSO) being purchased. Depending on taxation configuration, this address may be used for tax calculations. If both item_dest_contact_idx and item_dest_contact_no are provided, item_dest_contact_no will take precedence. | ||||||||||||||||||||||||||||||
long | 32 | For non-persistent referencing of a destination contact in the contacts array within the API request. Depending on taxation configuration, the address associated with this destination contact may be used for tax calculations. | ||||||||||||||||||||||||||||||
End of order_line_items array | ||||||||||||||||||||||||||||||||
parent_plan_instance_no | long | 22 | Parent plan instance number to identify each supplemental plan and child supplemental plan heirarchy. | |||||||||||||||||||||||||||||
client_parent_plan_instance_id | string | 100 | Client parent plan instance ID to identify each supplemental plan and child supplemental plan heirarchy. | |||||||||||||||||||||||||||||
supp_plan_instance_no | long | Unique plan instance number for each assigned supplemental plan. | ||||||||||||||||||||||||||||||
client_plan_instance_id | string | Client-defined plan instance ID for each assigned supplemental plan. | ||||||||||||||||||||||||||||||
supp_plan_no | long | The Aria-assigned identifier for a supplemental service plan. Allowable values are limited to valid custom plan numbers for client. | ||||||||||||||||||||||||||||||
client_supp_plan_id | string | Client-defined supplemental plan ID. | ||||||||||||||||||||||||||||||
supp_plan_units | long | Number of units for the supplemental plan | ||||||||||||||||||||||||||||||
assignment_directive | long | 8 |
The rule to be applied to this assignment request, governing the proration rule is applied. Default behavior is to make the plan change (assign/deassign a plan to an account, change units on an existing plan, etc.) immediately based on client-defined default proration rule, resulting in appropriate prorated charge and credit. Allowable values for assignment_directive:
|
|||||||||||||||||||||||||||||
bill_immediately | long | 1 |
Indicates whether to bill the account holder immediately or, if not set bill on next billing anniversary date. Allowable values for bill_immediately:
|
|||||||||||||||||||||||||||||
bill_seq | long | 22 | The billing sequence number | |||||||||||||||||||||||||||||
client_order_id | string | This is the client-assigned order identifier. | ||||||||||||||||||||||||||||||
client_receipt_id | string | 50 | Client-defined unique identifier used to track related system actions | |||||||||||||||||||||||||||||
alt_pay_method | long | If you want to use the account's current form of payment, leave this field empty. If you want to use an alternate card, enter '1' in this field. | ||||||||||||||||||||||||||||||
cc_number | string | 24 | Card number. | |||||||||||||||||||||||||||||
cc_expire_mm | long | Expiration month for the card payment instrument. | ||||||||||||||||||||||||||||||
cc_expire_yyyy | long | Expiration year for the card payment instrument. | ||||||||||||||||||||||||||||||
bank_routing_num | string | The American Banking Association (ABA) routing number for the financial institution. | ||||||||||||||||||||||||||||||
bank_acct_num | string | 19 | The bank account number. | |||||||||||||||||||||||||||||
bank_check_digit | 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. | |||||||||||||||||||||||||||||
bank_swift_cd | 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. | |||||||||||||||||||||||||||||
bank_country_cd | 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. | |||||||||||||||||||||||||||||
bank_id_cd | string | 10 | Up to 10 digit numeric bank identifier code. Used for the Direct Debit payment method. Only hyphen and space are allowed to format the bank ID code. It is required for BBAN. | |||||||||||||||||||||||||||||
bank_branch_cd | string | 10 | 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. | |||||||||||||||||||||||||||||
bank_name | string | 100 | Bank name for the account payment method. | |||||||||||||||||||||||||||||
bank_city | string | 100 | Bank city for the account payment method. | |||||||||||||||||||||||||||||
mandate_id | string | 35 |
Used for the Direct Debit payment method, including UK-based payments for the Basic Bank Account Number (BBAN) payment method for payments and refunds. 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. |
|||||||||||||||||||||||||||||
iban | string | 50 | International Bank Account Number(IBAN). Used for the Direct Debit payment method. It consists of 16 to 34 alphanumeric characters. Only hyphen and space are allowed to format the IBAN. | |||||||||||||||||||||||||||||
bill_company_name | string | 100 | Company name of the billing contact. | |||||||||||||||||||||||||||||
bill_first_name | string | 100 | First name of the billing contact. | |||||||||||||||||||||||||||||
bill_middle_initial | string | 2 | Middle initial of the billing contact. | |||||||||||||||||||||||||||||
bill_last_name | string | 100 | Last name of the billing contact. | |||||||||||||||||||||||||||||
bill_address1 | string | 100 | First address line of the billing contact. | |||||||||||||||||||||||||||||
bill_address2 | 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. | |||||||||||||||||||||||||||||
bill_city | string | 32 | City of the billing contact. | |||||||||||||||||||||||||||||
bill_locality | string | 32 |
Locality of thebilling contact. Use this field instead of the <bill_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. |
|||||||||||||||||||||||||||||
bill_state_prov | string | 10 |
This field is ignored for all addresses outside the United States, Australia, and Canada. Use the <bill_locality> field for addresses in those countries. |
|||||||||||||||||||||||||||||
bill_zip | string | Zip Code of the billing contact | ||||||||||||||||||||||||||||||
bill_country | string | 2 | Country of the billing contact. The ISO-compliant 2-character country code abbreviation in uppercase. | |||||||||||||||||||||||||||||
bill_email | string | 320 | Email of the billing contact. | |||||||||||||||||||||||||||||
bill_phone | string | 25 | Phone number of the billing contact. | |||||||||||||||||||||||||||||
bill_phone_extension | string | Phone extension of the billing contact. | ||||||||||||||||||||||||||||||
bill_cell_phone | string | 20 | Cell phone number of the billing contact. | |||||||||||||||||||||||||||||
bill_work_phone | string | 25 | Work phone number of the billing contact. | |||||||||||||||||||||||||||||
bill_work_phone_extension | string | Work phone extenstion of the billing contact | ||||||||||||||||||||||||||||||
bill_drivers_license_no | string | 32 | Driver's license number of the billing contact | |||||||||||||||||||||||||||||
bill_drivers_license_state | string | 32 | Driver’s license state of the billing contact. The official postal service code for all United States and Canada states, provinces, and territories. | |||||||||||||||||||||||||||||
bill_taxpayer_id | string | 32 | Taxpayer ID of the billing contact. | |||||||||||||||||||||||||||||
cvv | string | 6 | Card Verification Value, used to help verify a transaction is being requested by the card holder since this value is physically printed on the card. | |||||||||||||||||||||||||||||
bank_acct_type | string | 32 | The type of bank account being used.
Allowable values for bank_acct_type:
|
|||||||||||||||||||||||||||||
bill_address3 | string | 100 | The third line of the billing address. | |||||||||||||||||||||||||||||
coupon_codes | string array | 30 | associate multiple coupons. | |||||||||||||||||||||||||||||
alt_client_acct_group_id | string | 100 | One-time collections account group to use for this specific call. Default collections group on the account is not changed. | |||||||||||||||||||||||||||||
client_alt_inv_template_id | string | 100 | The client alternate invoice template number to use for this order, if different from the default template | |||||||||||||||||||||||||||||
OR | ||||||||||||||||||||||||||||||||
alt_inv_template_no | long | The invoice template number to use for this order, if different from the default template | ||||||||||||||||||||||||||||||
force_supp_bill_date_reset | long | 1 | (Deprecated) This input is not operational. Use 'force_master_bill_date_reset' to perform this input's activity. | |||||||||||||||||||||||||||||
statement_message | string | 1000 | Alternate contact details for orders. | |||||||||||||||||||||||||||||
track_data1 | string | 300 | Raw "track 1" data from a swiped card used in a card-present transaction to initiate this request | |||||||||||||||||||||||||||||
track_data2 | string | 300 | Raw "track 2" data from a swiped card used in a card-present transaction to initiate this request | |||||||||||||||||||||||||||||
soft_descriptor | string | Transaction description shown on the buyer's statement that displays a Merchant Name or Item Description typically. This field will be ignored if not supported/certified by the payment processor. | ||||||||||||||||||||||||||||||
soft_descriptor_customer_service | string | Transaction description shown on the buyer's statement that displays a City for Card Present transactions or a Phone Number for Card Not Present transactions. This field will be ignored if not supported/certified by the payment processor. | ||||||||||||||||||||||||||||||
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:
|
|||||||||||||||||||||||||||||
order_comments | string | 3000 | Comments for this order | |||||||||||||||||||||||||||||
nso_po_num | string | 100 | Purchase order number assigned to the one-time order. | |||||||||||||||||||||||||||||
po_num | string | 100 | Purchase order number assigned to the plan instance. | |||||||||||||||||||||||||||||
Start of plan_service_updates array | ||||||||||||||||||||||||||||||||
plan_service_updates | array | List of services associated with the plan being assigned or updated on the account. | ||||||||||||||||||||||||||||||
Field Name | Field Type | Max Length | Description | |||||||||||||||||||||||||||||
long | 22 | The Aria-assigned unique identifier for the service associated with the plan instance. Either this field, or client_service_id is required to map plan services to the plan instance. | ||||||||||||||||||||||||||||||
OR | ||||||||||||||||||||||||||||||||
string | 100 | The client-defined identifier for the service associated with the plan instance. | ||||||||||||||||||||||||||||||
long | 22 | The Aria-assigned unique identifier for the origin location for the specified 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 will take precedence. | ||||||||||||||||||||||||||||||
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 will take precedence. | ||||||||||||||||||||||||||||||
long | 22 | The Aria-assigned unique identifier for the destination contact for the specified service associated with the plan. Depending on taxation configuration, this address may be used for tax calculations. If both dest_contact_idx and dest_contact_no are provided, dest_contact_no will take precedence. | ||||||||||||||||||||||||||||||
long | 32 | For non-persistent referencing of a destination contact in the contacts array within the API request. Depending on taxation configuration, the address associated with this destination contact may be used for tax calculations. If both dest_contact_idx and dest_contact_no are provided, dest_contact_no will take precedence. | ||||||||||||||||||||||||||||||
End of plan_service_updates array | ||||||||||||||||||||||||||||||||
Start of contacts array | ||||||||||||||||||||||||||||||||
contacts | 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 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 | 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 | ||||||||||||||||||||||||||||||||
existing_pay_method_cvv | string | 6 | Sends the CVV value of the current card on file. | |||||||||||||||||||||||||||||
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. | |||||||||||||||||||||||||||||
Start of optional_transaction_qualifiers | ||||||||||||||||||||||||||||||||
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_qualifiers | ||||||||||||||||||||||||||||||||
fraud_filter | 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. Notes:
Allowable values for fraud_filter:
|
|||||||||||||||||||||||||||||
Start of fraud_control_fields array | ||||||||||||||||||||||||||||||||
fraud_control_fields | 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 highlighted in blue 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 the master 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. | ||||||||||||||||||||||||||||||
change_mp_status_on_fraud_filtering_cc_prefix_failure |
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:
|
|||||||||||||||||||||||||||||
mp_status_on_fraud_filtering_cc_prefix_failure |
string | 100 | Ifchange_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 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) | ||||||||||||||||||||||||||||||
change_mp_status_on_fraud_filtering_cc_issuing_country_failure |
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:
|
|||||||||||||||||||||||||||||
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 field to indicate the desired status of the master plan instance. (applies to Direct Post) | |||||||||||||||||||||||||||||
change_mp_status_on_fraud_filtering_cc_issuing_country_suspect |
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:
|
|||||||||||||||||||||||||||||
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 | ||||||||||||||||||||||||||||||||
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:
|
|||||||||||||||||||||||||||||
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 | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Numeric value describing the type of item described on an invoice line. Allowable values for line_type:
|
||||||||||||||||||||||
proc_fraud_filtering_info | array | The fraud filtering information provided by the payment processor as described below. | ||||||||||||||||||||
total_charges_before_tax | double | Total charges on this invoice before taxes are applied. DEPRECATED | ||||||||||||||||||||
total_charges_before_tax_2 | double | Total charges on this invoice before taxes are applied. | ||||||||||||||||||||
total_tax_charges | double | Total amount of taxes charged. DEPRECATED | ||||||||||||||||||||
total_tax_charges_2 | double | Total amount of taxes charged. | ||||||||||||||||||||
total_charges_after_tax | double | Subtotal combining the total pre-tax charges and the total taxes charged. DEPRECATED | ||||||||||||||||||||
total_charges_after_tax_2 | double | Subtotal combining the total pre-tax charges and the total taxes charged. | ||||||||||||||||||||
total_credit | double | Sum of all the credits on the invoice. DEPRECATED | ||||||||||||||||||||
total_credit_2 | double | Sum of all the credits on the invoice. | ||||||||||||||||||||
double | Number of units for the specified invoice line. | |||||||||||||||||||||
double | The monetary rate per unit of service. | |||||||||||||||||||||
double | The total line amount for this invoice line. | |||||||||||||||||||||
cart_inv_line_items | hash | |||||||||||||||||||||
hash | 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. | |||||||||||||||||||||
third_party_errors | hash | Errors from third-party systems like taxation engines are returned here. Aria-generated error codes are returned in the error_code and error_msg fields at the root level of the API return. | ||||||||||||||||||||
error_code | long | Aria-assigned error identifier. 0 indicates no error. | ||||||||||||||||||||
order_no | long | The unique identifier for an order in the context of an client_no and account_no. | ||||||||||||||||||||
invoice_no | long | The Aria-assigned unique identifier of a given invoice. | ||||||||||||||||||||
transaction_id | long | The unique identifier for a given transaction. | ||||||||||||||||||||
invoicing_error_code | long | The error code generated by Aria when Aria attempted to generate a invoice. DEPRECATED | ||||||||||||||||||||
invoicing_error_code_2 | long | The error code generated by Aria when Aria attempted to generate a invoice. | ||||||||||||||||||||
statement_error_code | long | The error code generated by Aria when Aria attempted to generate a statement. | ||||||||||||||||||||
long | The invoice line number associated with the current record. | |||||||||||||||||||||
long | Aria-assigned unique service identifier. | |||||||||||||||||||||
long |
A boolean value indicating the service is actually a tax. (true/1=yes, false/0=no) Allowable values for service_is_tax_ind:
|
|||||||||||||||||||||
long | The usage type of the usage units specified. | |||||||||||||||||||||
long | The plan number associated with the usage asserted in this invoice. | |||||||||||||||||||||
long | The reference charge line number to indicate the item to which the discount applies. | |||||||||||||||||||||
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 will return 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 will return the Aria-assigned unique identifier of the contact on the account used as the ship-to address for the invoice line item. | |||||||||||||||||||||
long | Aria-assigned unique identifier for the rate schedule used to price this NSO. | |||||||||||||||||||||
error_msg | string | Description of any error that occurred. "OK" if there was no error. | ||||||||||||||||||||
invoicing_error_msg | string | The text message associated with 'invoicing_error_code' | ||||||||||||||||||||
statement_error_msg | string | The text message associated with 'statement_error_code.' | ||||||||||||||||||||
proc_cvv_response | string | The processor return code from CVV validation. | ||||||||||||||||||||
proc_avs_response | string | Processor return code from address validation. | ||||||||||||||||||||
proc_cavv_response | string | The processors return code for security validation. | ||||||||||||||||||||
proc_status_code | string | The processor status code. | ||||||||||||||||||||
proc_status_text | string | The processors status description. | ||||||||||||||||||||
proc_payment_id | string | The processor payment ID. | ||||||||||||||||||||
proc_auth_code | string | Authorization code provided by the issuing bank. | ||||||||||||||||||||
proc_merch_comments | string | Additional information passed to payment processor. | ||||||||||||||||||||
proc_fraud_filter_response | string | The fraud filtering information provided by the payment processor in response to a fraud filtering request. | ||||||||||||||||||||
string | Fraud country status provided by the payment processor. | |||||||||||||||||||||
string | Fraud country code provided by the payment processor. | |||||||||||||||||||||
string | Name for the rate schedule to be created. | |||||||||||||||||||||
string | Client-defined unique identifier. | |||||||||||||||||||||
string | The name corresponding to this line item's service code. | |||||||||||||||||||||
string | Description of the invoice line item. | |||||||||||||||||||||
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. | |||||||||||||||||||||
string | The name of the plan for the specified plan_no. | |||||||||||||||||||||
string | Client-defined service identifier. | |||||||||||||||||||||
string | The usage type code of the usage type specified. | |||||||||||||||||||||
string | Client-defined Plan ID associated with the usage asserted in this invoice. | |||||||||||||||||||||
string | Purchase order number assigned to the plan instance. | |||||||||||||||||||||
string | Type of error code being represented, such as taxation. | |||||||||||||||||||||
string | Aria-assigned error identifier. 0 indicates no error. | |||||||||||||||||||||
string | Description of any error that occurred. "OK" if there was no error. |