adjust_acct_plan_billing_dates_m Guide

Last updated
Save as PDF

Adjusts the billing date for a specified set of master plans under one or more accounts to date(s) in the future or in the past.

API Specification:	adjust_acct_plan_billing_dates_m
Required Fields:	<client_no> <auth_key> <acct_no> or <client_acct_id> <billing_dates> (array) <master_plan_instance_no> or <client_master_plan_instance_id> <action_directive>

Error Codes

Error Code/Description	Associated Inputs
1001: unexpected error
1004: authentication error Associated Inputs: auth_key, client_id, client_no	<auth_key>, <client_id>, <client_no>
1024: invalid date format Associated Inputs: bill_birthdate, birthdate, degrade_date, initial_credit_date, invoice_line_reversing_date, service_fulfillment_date, queue_date, start_bill_date, end_bill_date, start_date, end_date, stmt_birthdate, bill_birthdate Additional Comments: All date inputs must be in yyyy-mm-dd format.	<bill_birthdate>, <birthdate>, <degrade_date>, <initial_credit_date>, <invoice_line_reversing_date>, <service_fulfillment_date>, <queue_date>, <start_bill_date>, <end_bill_date>, <start_date>, <end_date>, <stmt_birthdate>, <bill_birthdate>
1039: invalid action directive Associated Inputs: action_directive	<action_directive>
1040: A maximum range of -27 to +27 days is permissible to be entered in the Adjust Days field. Associated Inputs: adjustment_days, adjustment_date	<adjustment_days>, <adjustment_date>
1061: Missing required parameter Adjustment Days Associated Inputs: adjustment_days Additional Comments: This is required when the action_directive equals 1 or 2.	<adjustment_days>
1062: Missing required parameter: Adjustment Date Associated Inputs: adjustment_date	<adjustment_date>
1102: A maximum range of -99 to +27 days is permissible to be entered in the Adjust Days field Associated Inputs: adjustment_days, adjustment_date	<adjustment_days>, <adjustment_date>
1103: Invalid adjustment days Associated Inputs: adjustment_days Additional Comments: The number of days cannot be fractional.	<adjustment_days>
14046: If you passed in an invalid plan_instance_no, this message will appear: "Invalid Plan instance number". If you passed in an invalid master_plan_instance_id, this message will appear: "Invalid master_plan_instance_id". Associated Inputs: plan_instance_no, master_plan_instance_id, filter_plan_instance_no, percent_eval_plan_instance_no, client_plan_instance_id Additional Comments: The plan_instance_no or master_plan_instance_id must belong to the account, or it is invalid. The percent_eval_plan_instance_no must belong to the account and also to the MPI given in input.	<plan_instance_no>, <master_plan_instance_id>, <filter_plan_instance_no>, <percent_eval_plan_instance_no>, <client_plan_instance_id>
14047: If you passed in an invalid client_plan_instance_id, this message will appear: "Invalid client Plan instance identifier". If you passed in an invalid client_master_plan_instance_id , this message will appear: "Invalid client_master_plan_instance_id". Associated Inputs: client_plan_instance_id, client_master_plan_instance_id, client_percent_eval_plan_instance_id	<client_plan_instance_id>, <client_master_plan_instance_id>, <client_percent_eval_plan_instance_id>
14052: Missing maser Plan instance number/identifier Associated Inputs: master_plan_instance_no, client_master_plan_instance_id Additional Comments: Either mpi_no or cdid is required.	<master_plan_instance_no>, <client_master_plan_instance_id>
25020: Illegal characters entered Associated Inputs: All character field inputs like firstname lastname, dunning_group_name, comments, etc.	All character field inputs like <firstname>, <lastname>, <dunning_group_name>, <comments>, etc.

Additional Guidance:

When you call this API, Aria will not perform proration. Examples:

If you move a Plan's billing date 15 days forward, Aria will not collect recurring charges for the additional 15 days.
If you move a Plan's billing date backward, Aria will double-bill for the recurring charges that apply to the overlapping period.

Input Fields

Field Name:

Notes:

adjustment_days

Number of days to adjust the billing date.

The number of days cannot exceed 27 days before or after the current next billing date. This applies regardless of the Master Plan's or any associated Supplemental Plan's billing interval.

This field is required if <action_directive> is set to 1 or 2.

adjustment_date

The date to set the next billing date. The adjustment date cannot exceed 27 days before or after the current next billing date. This applies regardless of the Master Plan's or any associated Supplemental Plan's billing interval.

This field is required if <action_directive> is set to 3.

These rules apply to <adjustment_days> and <adjustment_date>:

For a daily or weekly Master Plan whose billing interval is 27 days or less, the <adjustment_days> or <adjustment_date> cannot exceed the Plan's billing interval -1 day. This applies regardless of the billing interval of any associated Supplemental Plan(s).

Example: If you have a 5-day master plan with a billing date of 15 July 2020 and you try to adjust the billing date by +5 days or more, Aria will automatically adjust the billing date to 19 July 2020 (+4 days).

You cannot use this API to adjust the billing date of a 1-day Plan.

action_directive

Determines whether the billing date is adjusted forward or backward.

Allowable values:

Values	Description
1	Adjust billing dates forward. Using action_directive=1 requires that you provide a value for adjustment_days.
2	Adjust billing dates backward. Using action_directive=2 requires that you provide a value for adjustment_days.
3	Set Date. Using action_directive=3 requires that you provide a value for adjustment_date.