Skip to main content
Aria Knowledge Central

set_payment_responsibility_m

Summary

API Name set_payment_responsibility_m
Class account_services_m
Update Version 38

Description

Specifies the master plan instance on a parent account that is responsible for paying the invoices associated with a master plan instance for a child 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.

account_no long 22 Yes

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

Alternative required field: client_acct_id

plan_instance_no long 22 Yes

The unique identifier of the master plan instance on the child account for which payment responsibility is being set.

Alternative required field: client_plan_instance_id

client_plan_instance_id string 100 Yes

The client-defined identifier of the master plan instance on the child account for which payment responsibility is being set.

Alternative required field: plan_instance_no

resp_level_cd long 1 Yes

The responsibility level code. These are values 1 through 3 as described in the legend for this argument.

Allowed values:

Value Description
1 Standard Self Pay: Child account will be responsible for payment.
2 Parent Pay: Parent account will be responsible for payment, with usage being recorded and rated based on the child account master plan instance usage rules.
3 Parent Usage & Pay: Parent account will be responsible for payment, with usage being recorded and rated based on the parent account master plan instance usage rules.
senior_acct_no long 14 No

Note: This field is deprecated. Aria no longer supports senior_acct_no.

senior_acct_user_id string 32 No

Note: This field is deprecated. Aria no longer supports senior_acct_user_id.

client_senior_acct_id string 50 No

Note: This field is deprecated. Aria no longer supports client_senior_acct_id.

senior_plan_instance_no long 22 No

Note: This field is deprecated. Aria no longer supports senior_plan_instance_no.

client_senior_plan_instance_id string 100 No

Note: This field is deprecated. Aria no longer supports client_senior_plan_instance_id.

resp_acct_no long 14 No

The account number of the account that contains the responsible master plan.

Alternative field: resp_acct_user_id or resp_client_acct_id

resp_acct_user_id string 32 No

The user ID of the account that contains the responsible master plan.

Alternative field: resp_acct_no or resp_client_acct_id

resp_client_acct_id string 50 No

The client account ID of the account that contains the responsible master plan.

Alternative field: resp_acct_no or resp_acct_user_id

resp_master_plan_instance_no long 22 No

The unique identifier of the master plan instance on the responsible account. Required if responsibility level is set to one of the two parent pay options.

Alternative field: resp_client_master_plan_instance_id

resp_client_master_plan_instance_id string 100 No

The client-defined identifier of the master plan instance on the responsible account. Required if responsibility level is set to one of the two parent pay options.

Alternative field: resp_master_plan_instance_no

client_acct_id string 50 Yes

Client-defined account identifier.

Alternative required field: account_no

billing_group_no long 22 No

Unique identifier associated with an existing billing group for the specified account.

Alternative field: client_billing_group_id

client_billing_group_id string 100 No

Unique client-defined identifier associated with an existing billing group for the specified account.

Alternative field: billing_group_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.

TOP
  • Was this article helpful?