get_acct_preview_next_bill_m
Summary
| API Name | get_acct_preview_next_bill_m |
|---|---|
| Class | transaction_services_m |
| Update Version | 60 |
Description
Returns a preview of an account's next bill based on the provided master plan instance.
Inputs
| Name | Type | Length | Required | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| client_no | long | 22 | Yes |
Aria-assigned unique identifier indicating the Aria client providing service to this account. |
||||||||
| auth_key | string | 32 | No |
Aria-assigned unique key for authenticating the validity of the requestor. This key is passed with each method call. |
||||||||
| acct_no | long | 22 | Yes |
Aria-assigned account identifier. This value is unique across all Aria-managed accounts. Alternative required field: client_acct_id |
||||||||
| client_acct_id | string | 50 | Yes |
Client-defined account identifier. Alternative required field: acct_no |
||||||||
| master_plan_instance_no | long | 22 | Yes |
The unique identifier for the master plan instance. Alternative required field: client_master_plan_instance_id |
||||||||
| client_master_plan_instance_id | string | 100 | Yes |
Client-defined unique identifier for the master plan instance. Alternative required field: master_plan_instance_no |
||||||||
| auto_skip_to_next_bill_date | long | 1 | No |
Preview either prior period not billed statement or current period statement when called during bill lag days Allowed values:
|
Outputs
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| error_code | long | No |
Aria-assigned error identifier. 0 indicates no error. |
|
| error_msg | string | No |
Description of any error that occurred. "OK" if there was no error. |
|
| acct_no | long | 22 | No |
Aria-assigned account identifier. This value is unique across all Aria-managed accounts. |
| client_acct_id | string | 50 | No |
Aria-assigned account identifier. This value is unique across all Aria-managed accounts. |
| acct_currency | string | No |
Account currency ISO Codes |
|
| acct_status | string | No |
List of account statuses: Active, Registered Pending Activation, Permanent, Deactivated, Archived, Temporary Service Ban. |
|
| acct_balance_forward | double | 12 | No |
Previous balance on an account that was carried over to the next billing period |
| total_payments | double | No |
Total payments including cash credits that are not reflected on the last statement. |
|
| preview_date | string | No |
The date when a preview is requested per virtual time. |
|
| bill_date | string | No |
The date when the preview invoice will be billed. This field displays the date in the format defined by the client parameter Date Format Mask. If it is not defined by the client, then it is YYYY-MM-DD format. |
|
| due_date | string | No |
The date when a payment is due. The field displays in the date in format defined by the client parameter 'Date Format Mask'. If not defined, then it is YYYY-MM-DD. |
|
| balance_due | double | No |
Next invoice balance due. |
|
| adv_billing_period_start | string | No |
Future billing period start date. |
|
| adv_billing_period_end | string | No |
Future billing period end date. |
|
| billing_group_no | long | 22 | No |
Billing group number mapped to a master plan instance. |
| client_billing_group_id | string | 100 | No |
Client defined billing group ID. |
| amount_owed | double | No |
Amount owed represents total invoice balance after payment. |
|
| stmt_amount_owed | double | No |
Statement amount owed at the time of preview which includes transactions done after last statement generated in addition to next invoice which may include (if any) balance transfer transactions for parent-pay. |
|
| acct_total_owed | double | No |
Total account balance at the time of preview which includes next invoice that may have (if any) balance transfer transactions for parent-pay. |
|
| total_charges | double | No |
Total charges with tax of next invoice which includes balance transfer transactions (if any) for parent-pay. |
|
| total_pretax_charges | double | No |
Total charges without tax of the next invoice. |
|
| total_tax | double | No |
Total tax of the next invoice. |
|
| total_recur_charges | double | No |
Total recurring service charges of the next invoice which includes balance transfer transactions (if any) for parent pay. |
|
| total_recur_after_credits | double | No |
Total recurring service charges minus service credits applied. |
|
| total_recur_discount_credits | double | No |
Total discount and service credits applied to recurring service charges including balance transfer on recurring service. |
|
| total_order_charges | double | No |
Total order charges on the next invoice including balance transfer transaction for orders (if any) for parent pay. |
|
| total_order_after_credits | double | No |
Total order charges minus service credits and discounts. |
|
| total_order_discount_credits | double | No |
Total discounts and service credits on order on the next invoice. |
|
| total_service_credit | double | No |
Total service credit applied to the next invoice. |
|
| total_discounts | double | No |
Total discount (coupon with discount rule) applied on the next invoice. |
|
| total_activation_charges | double | No |
Total of all activation charges of the next invoice which includes balance transfer transactions (if any) for parent pay. |
|
| total_activation_charges_after_credits | double | No |
Total activation charges minus credits on it which includes balance transfer transactions. |
|
| total_activation_discount_credits | double | No |
'Total discount and service credits applied to activation charges including balance transfer activation discount & credits' |