gen_invoice_m Guide

Last updated
Save as PDF

The gen_invoice_m API generates invoices for a specified master plan instance, a specific billing group under an account, or for all the billing groups under the account. If a master plan instance has a pending invoice, no other invoice can be applied to the master plan instance until the current pending invoice is approved. An invoice does not generate if the master plan instance billing date is in the future.

API Specification:	gen_invoice_m
Required Fields:	<client_no> <auth_key> <acct_no> or <client_acct_id>

Error Codes

Error Code/Description	Associated Inputs
1001: unexpected error
1004: authentication error	<auth_key>, <client_id>, <client_no>
1009: account does not exist, Account not found: AriaNo (acct_no), Account not found: Userid (userid), or Account not found: ClientId (client_acct_id)	<acct_no>, <account_no>, <client_acct_id>, <user_id>, <userid>, <parent_acct_no>
1059: Invalid input: invoice_mode should be either 0 or 1	<invoice_mode>
1068: Combine invoices must be either 1-Long Cycle or 2-Short Cycle or 3-Consider Client Param.	<combine_invoices>
3059: Dispute transaction is not supported for child invoices.
3108: The invoice for this account cannot be generated at this time, since there is another invoice in progress for the same billing group.
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". 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".	<client_plan_instance_id>, <client_master_plan_instance_id>, <client_percent_eval_plan_instance_id>
26010: Invalid billing group number	<billing_group_no>
26012: Invalid client-defined billing group ID.	<client_billing_group_id>

Additional Guidance

Input Fields

Field Name

Notes

<force_pending>

Allowable Values

Values	Description
false	false
true	true

<combine_invoices>

Allowable Values

Values	Description
1	Combine Invoices (long cycle)
2	Do Not Combine Invoices (short cycle)
3	Use client default configuration setting

<usage_rate>

When an invoice is generated for an account for a one-day period in an annual plan, <usage_rate> is set as the 'debit/discount' amount and <usage_units> is set to 1 for the discount line item when 'usage_units' for the charge line item is 0.

Output Fields

Field Name:

Notes:

<tax_details> (array)

<unrounded_tax_amt>

Assuming that the client setting Aria Internal Tax Rounding Methodis set to "Per invoice."

<carryover_from_prev_amt>

Assuming that the client setting Aria Internal Tax Rounding Method is set to "Per invoice."

<before_round_adjusted_tax_amt>

Assuming that the client setting Aria Internal Tax Rounding Method is set to "Per invoice."

<carryover_from_current_amt>

Assuming that the client setting Aria Internal Tax Rounding Method is set to "Per invoice."

<line_type>

Allowable Values

Values	Description
1	Recurring charge
2	Tax charge
3	Service credit
4	Coupon Credit
5	Activation Charge
6	Usage Charge
7	Recurring Arrears
8	Order Charge
9	Surcharge