Generates a statement based on a master plan instance on the account. This call can also send the statement to the statement contact's email address on the associated billing group and if statement contact is not specified or email address on the statement contact is not specified then to the associated billing group's primary payment method billing contact's email address. If email address for associated billing group's primary payment method is not specified then to the account contact's email address.
Please note: If there are more than one invoices for a master plan instance that has not been included in an statement, an error will occur. If the send_email field is set to true and an email address either on statement contact or on billing contact associated with the primary payment on the associated billing group or on account contact is not found then an error will occur.
API Specification: |
gen_statement_m
|
Required Fields: |
- <client_no>
- <auth_key>
- <acct_no> or <client_acct_id>
- <master_plan_instance_no> or <client_master_plan_instance_id>
|
Additional Guidance:
Input Fields
<send_email> |
Allowable Values
Values |
Description |
true |
true |
false |
false |
|
Error Codes:
Error Code/Description |
Associated inputs |
|
|
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> |
1033: a parameter that represents a true or false value contains invalid input
|
<alt_collect_on_approve>, <alt_send_statement_on_approve>, <cancel_orders_on_discard>, <cascade_action, do_auto_discard>, <do_collect>, <change_status_after_coll>, <reset_dates_after_status>, <disable_existing_on_update>, <do_write, exclude_terminated_plan_inst>, <include_all_rate_schedules>, <include_plan_hierarchy>, <retrieve_bundled_nso>, <retrieve_included_nso, <include_translations>, <include_inactive_items>, <include_invoice_activity_eligibility>, <include_rs_summary>, <include_translations>, <include_service_supp_fields>/<include_product_fields>/, <include_plan_instance_fields>/<include_plan_services>, <include_surcharges>, <include_void_transactions>, <include_voided>, <invoice_unbilled_usage>, <is_unlinked_refund>, <record_cc_on_auth_failure>, <retrieve_excluded_usage, <send_email>, <usage_pooling>, <do_write> |
3004: Invoice does not exist
|
<invoice_no> |
3019: too many unstatementized invoice
|
|
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> |
18001: could not create statement
|
|
18002: could not send statement
|
|