get_acct_open_charges_m
Summary
| API Name | get_acct_open_charges_m |
|---|---|
| Class | account_services_m |
| Update Version | 44 |
Description
gets open charges for the given account
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 |
| filter_mpi_stack | object | No |
This will retrieve charges at MPI stack level, which includes MP and SP charges. |
|
| filter_plan_instance | object | No |
This will retrieve the particular master/supp plan instance(s) charges. |
filter_mpi_stack fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| master_plan_instance_no | long | 22 | No |
The Aria-assigned unique identifier of the master plan that will be used to filter the results for this API. Alternative field: client_master_plan_instance_id |
| client_master_plan_instance_id | string | 100 | No |
The client-defined unique identifier of the master plan that will be used to filter the results for this API. Alternative field: master_plan_instance_no |
filter_plan_instance fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| plan_instance_no | long | 22 | No |
The Aria-assigned unique identifier of the plan instance that will be used to filter the results for this API. Alternative field: client_plan_instance_id |
| client_plan_instance_id | string | 100 | No |
The client-defined unique identifier of the plan instance that will be used to filter the results for this API. Alternative field: plan_instance_no |
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. |
|
| total_amount | double | No |
The total amount of all the open charges |
|
| open_charge_items | object | No |
Array of open charge line items. |
|
| charge_mpi_info | object | No |
Array of Master Plan Instance details |
|
| charge_spi_info | object | No |
Array of supplemental Plan Instance details |
open_charge_items fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| proration_no | long | No |
Represents proration sequence number, which is generated out of different proration calls. |
|
| line_no | long | No |
The sequential line number of this line item. Initial record value is always 1. |
|
| posting_date | string | No |
Date on which this charge occurred in the system. |
|
| service_no | long | No |
Aria-assigned unique service identifier. |
|
| service_name | string | No |
The name corresponding to this line items service code. |
|
| units | double | No |
The number of units of this service code billed on this line item. |
|
| rate_per_unit | double | No |
The rate per unit billed. |
|
| amount | double | No |
The amount of this line item. |
|
| description | string | No |
Text description of this line item. |
|
| usage_type_no | long | No |
The usage type code associated with this line item. |
|
| plan_no | long | 22 | No |
The unique plan ID associated with this line item. |
| plan_name | string | No |
The name of the plan associated with this line item. |
|
| master_plan_instance_no | long | 22 | No |
Unique plan instance number for each master plan. |
| plan_instance_no | long | 22 | No |
Unique plan instance number for each plan. |
| update_date | string | No |
Update date is for any plan change actions that require an update to open charge value. |
|
| start_date | string | No |
Period start date for which the line of open charge is covering for. |
|
| end_date | string | No |
Period end date for open charge. |
|
| comments | string | No |
Additional information. |
charge_mpi_info fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| master_plan_instance_no | long | 22 | No |
Unique plan instance number for each master plan. |
| client_master_plan_instance_id | string | 100 | No |
Client-defined plan instance ID for each master plan. |
| master_plan_no | long | No |
The Master Subscription plan number. |
|
| client_master_plan_id | string | No |
The client-defined unique ID for plan this line represents. |
|
| master_plan_instance_description | string | No |
Description for each master plan instance. |
|
| next_bill_date | string | No |
The next bill date for the master plan instance. |
charge_spi_info fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| master_plan_instance_no | long | 22 | No |
Unique master plan instance number for each supplemental plan. |
| supp_plan_instance_no | long | No |
Unique plan instance number for each supplemental plan. |
|
| client_supp_plan_instance_id | string | No |
Client-defined plan instance ID for each supplemental plan. |
|
| supp_plan_no | long | No |
The Aria-assigned identifier for each supplemental service plan. |
|
| client_supp_plan_id | string | No |
Client-defined supplemental plan ID. |
|
| supp_plan_instance_description | string | No |
Description for each supplemental plan instance. |
|
| next_bill_date | string | No |
The next bill date for the supplemental plan instance. |