Skip to main content
Aria Knowledge Central

set_usg_mtd_ptd_bal_m

Summary

API Name set_usg_mtd_ptd_bal_m
Class account_services_m
Update Version 6.33

Description

This API resets the client or master plan instance Billing-Period-To-Date or Month-To-Date unbilled usage balance to zero.

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 No

Aria-assigned account identifier. This value is unique across all Aria-managed accounts.

Alternative field: client_acct_id

client_acct_id string 50 No

Client-defined account identifier.

Alternative field: acct_no

master_plan_instance_id long 22 No

Aria generated unique identifier for the master plan instance.

Alternative field: client_master_plan_instance_id

client_master_plan_instance_id string 100 No

Client-defined unique identifier for the master plan instance.

Alternative field: master_plan_instance_id

threshold_category long 1 Yes

Indicates whether category is PTD or MTD 0 means PTD. 1 means MTD.

Allowed values:

Value Description
0 PTD (Billing-Period-To-Date)
1 MTD (Month-To-Date)

Outputs

Name Type Length Required Description
acct_no long 22 No

Aria-assigned account identifier. This value is unique across all Aria-managed accounts.

client_acct_id string 50 No

Client-defined account identifier.

master_plan_instance_id long 22 No

The Master Subscription plan instance number.

client_master_plan_instance_id string 100 No

Client-defined Master plan Subscription plan instance ID.

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.

TOP
  • Was this article helpful?