manage_pending_invoice_m Guide

Last updated
Save as PDF

This API can be used to approve, discard, or regenerate a pending invoice. A pending invoice can be retrieved based on the invoice number or master plan instance ID. After a pending invoice is approved, this call can also collect a payment and send a statement. If the collection fails, the pending invoice will automatically be voided provided the system setting "Auto Void Pending Invoice on Collection Failure" is set to true. This API can also set the custom_status_label, and client_notes at the time of approval, or regeneration.

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

Error Codes

Error Code/Description	Associated Inputs
1001: unexpected error
1004: authentication error Associated Inputs: 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) Associated Inputs: 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 Associated Inputs: 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
1039: invalid action directive Associated Inputs: action_directive
1500: Unsupported bank/country code for this payment method. Associated Inputs: proc_status_code, proc_status_code, bank_country_cd Additional Comments: Added in support of ACH payments via Direct Debit (country code must be US).
3011: pending invoice approval failed
3012: pending invoice discard failed
3013: pending invoice regen failed - old invoice could not be discarded
3015: invalid pending invoice number Associated Input: invoice_no
3044: Client notes exceeds length limit of 1000 characters. Associated Input: client_notes
3045: Custom status value does not exist. Associated Input: custom_status_label
4008: invalid expiration date Associated Inputs: alt_pay_method, cc_expire_mm, cc_expire_yyyy, credit_expiry_date, pay_method_type Additional Comments: Dates must be in yyyy-mm-dd format.
4009: invalid cc number Associated Inputs: cc_number, alt_pay_method, cc_num, pay_method_type
4010: invalid bank draft info Associated Inputs: bank_acct_no, bank_routing_no, alt_pay_method Additional Comments: The client parameter BANK_DRAFT_INDICATOR must be enabled. Bank_acct_no and bank_routing_no are required. Valid bank_routing_no from Aria's ABA lookup in case of US address. Bank_routing_no must be numeric. For US, bank_routing_no should be 9 digits in length (left padded with zeros). Bank_routing_no must pass checksum validation.
4011: cc authorization failed Associated Inputs: alt_pay_method, cc_number, cc_expire_mm, cc_expire_yyyy, pay_method_type Additional Comments: $1 authorization has failed.
4019: Invalid Bank Account Type. Associated Inputs: alt_pay_method, bank_acct_type
4044: Missing a required value. Please check that either bank_account_no, bank_routing_number or agreement_id is present.
5017: invalid iso country code Associated Inputs country, bank_country_cd, bill_country
5022: account does not have a pending invoice Associated Inputs: invoice_no, master_plan_instance_no, client_master_plan_instance_id Additional Comments: An invoice_no was not passed, and the Master Plan Instance did not have a pending invoice.
5054: The Account Contact name, Billing Contact name, and Statement Contact name must be the same for consumer accounts. Additional Comments: The first name, middle initial and last name of account contact, billing contact and statement contact must be the same when consumer_acct_ind = 1.
6027: IBAN is alphanumeric and is 16 to 34 characters in length Associated Inputs: iban, alt_pay_method_iban
6029: Bank swift code is alphanumeric and is 8 or 11 characters in length Associated Inputs: bank_swift_cd, alt_pay_method
6031: BBAN is numeric and up to 16 digits Associated Inputs: alt_payment_method, bank_acct_no

6033: Bank branch code is numeric and up to 10 digits Associated Inputs: bank_branch_cd
6034: Basic bank account number or IBAN is required for Direct Debit Associated Inputs: iban, bank_acct_no
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.
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
14071: Master Plan Instance information is missing Associated Inputs: plan_instance_no, client_plan_instance_id, master_plan_instance_no, client_master_plan_instance_id Additional Comments: Both plan_no and plan_id must be entered. Master Plan Instance is required if the invoice_no is not provided.
25001: failed to calculate taxes
25020: Illegal characters entered Associated Inputs: All character field inputs like firstname lastname, dunning_group_name, comments, etc.

Additional Guidance

Input Fields

Field Name

Notes

<recurring_processing_model_ind>

Currently, for only the Vantiv payment gateway, the value in this field will automatically be set to 2 if your payment gateway or collection group configuration has the Send orderSource as recurring for all transactions option enabled.

Refer to your payment gateway documentation to see if this applies.

Please contact your payment gateway representative for more information.

<proc_field_override> (array)

<transaction_type>

The value that you pass into this field will override the Recurring Options that you set in the Aria application under:
- Configuration > Payments > Payment Gateways > Chase Paymentech/Vantiv > Gateway Options; and
- Configuration > Payments > Collection Groups > Chase Paymentech/Vantiv > Collection Group Options.
Currently, only Chase Paymentech or Vantiv support this field. Other payment gateways might not honor all of the allowable values for this field. You will need to check your payment gateway documentation for confirmation.

Aria will use this order of precedence to determine the transaction type:

value passed into this field
collection group configuration
payment gatewayconfiguration
transaction type that you specified in the <recurring_processing_model_ind> field

<action_directive>

Allowable Values

Values	Description
1	Approve pending invoice.
2	Discard pending invoice.
3	Regenerate pending invoice.
4	Discard pending invoice and discard usage.

<alt_collect_on_approve>

Allowable Values

Values	Description
true	Automatically perform a collection attempt.
false	Do not automatically perform a collection attempt
null	If left null, the behavior defaults to the client setting

<alt_send_statement_on_approve>

Allowable Values

Values	Description
true	Automatically send a statement.
false	Do not automatically send a statement.
null	If left null, the behavior defaults to the client setting

<cancel_orders_on_discard>

Allowable Values

Values	Description
false	false
true	true

<bank_acct_type>

Allowable Values

Values	Description
savings	savings
checking	checking
business	business

<recurring_processing_model_ind>

Allowable Values

Values	Description
0	Cardholder-Initiated Transaction – Credentials on File: a credit card transaction initiated by the cardholder for a new order or a plan upgrade that uses a credit card that is currently stored in Aria. (Default)
1	Cardholder-Initiated Transaction: a credit card transaction initiated by the cardholder for a new account or creating an order that uses an alternate credit card that is not currently stored in Aria.
2	Merchant-Initiated Transaction – Standing Instruction – Recurring: a credit card transaction initiated by Aria’s clients for a recurring charge that uses a credit card that is currently stored in Aria.
3	Merchant-Initiated Transaction – Unscheduled Credentials on File: a credit card transaction initiated by Aria’s clients for a non-recurring charge (one-time order or plan upgrade) that uses a credit card that is currently stored in Aria.

<transaction_type>

Allowable Values

Values	Description
-1	Use client configuration settings for "Send Transaction Type as Recurring for Initial Request Where Possible" or "Send Transaction Type as Recurring for Subsequent Request" as applicable. (default)
1	(Chase) Single transaction mail/telephone order (MOTO) - Designates a transaction where the accountholder is not present at a merchant location and completes the sale over the phone or through the mail. The transaction is not for recurring services or products and does not include sales that are processed via an installment plan.
2	(Chase) Recurring Transaction - Designates a transaction that represents an arrangement between an accountholder and the merchant where transactions are going to occur on a periodic basis.
3	(Chase) Installment Transaction - Designates a group of transactions that originated from a single purchase where the merchant agrees to bill the accountholder in installments.
4	(Chase) Deferred Transaction - Designates a transaction that represents an order with a payment delayed for a specified amount of time.
5	(Chase) Secure Electronic Commerce Transaction - Designates a transaction completed via the Internet at a 3-D Secure capable merchant and in which the accountholder was fully authenticated. (examples: 3-D Secure includes Verified by Visa, Mastercard Identity Check, American Express SafeKey and Discover ProtectBuy.)
6	(Chase) Non-Authenticated Electronic Commerce Transaction - Designates a transaction completed via the Internet at a 3-D Secure capable merchant that attempted to authenticate the accountholder using 3-D Secure (examples: 3-D Secure includes Verified by Visa and Mastercard Identity Check.) Verified by Visa, Mastercard Identity Check, American Express SafeKey and Discover ProtectBuy transactions in the event of: * A non-participating issuer * A non-participating accountholder of a participating issuer * A participating issuer, but the authentication server is not available
7	(Chase) Channel Encrypted Transaction - Designates a transaction between an accountholder and a merchant completed via the Internet where the transaction includes the use of transaction encryption such as SSL (Secure Sockets Layer), but authentication was not performed. The accountholder payment data was protected with a form of Internet security, such as SSL, but authentication was not performed. For Discover, indicates an e-commerce Card Transaction with data protection in which ProtectBuy for Cardholder authentication was not used.
8	(Chase) Non-Secure Electronic Commerce Transaction - Designates a transaction between an accountholder and a merchant completed via the Internet where: * The transaction does not include the use of any transaction encryption such as SSL * Authentication is not performed * An accountholder certificate is not managed.
I	(Chase) IVR Transaction (PINless Debit only) - Designates a transaction where the accountholder completes the sale via an interactive voice response (IVR) system.
R	(Chase) Retail Transaction - Designates a transaction where the accountholder was present at a merchant location.
telephone	(Vantiv) The transaction is for a single telephone order.
mailorder	(Vantiv) The transaction is for a single mail order transaction.