APIs That Generate Invoices

Overview

This article serves as a quick-reference guide for developers integrating with Aria's billing platform. Among other uses, understanding this guide can help avoid unintentionally generating an invoice. It can also help you select API methods to use for managing your customers' full billing lifecycle.

Several configurable Aria instance-wide parameters define when to attempt a collection against a customer account—important to consider, because collections occur after Aria creates invoices.

You might also find the Invoice-Related API Usage Guide article helpful.

Aria Core and Admintools API Methods That Might Generate Invoices

Examples provided in the following list do not necessarily represent a full list of invoice-generating circumstances, but are meant to provide additional guidance.

• apply_cm_m—Applies credit memo line credits to invoice gross line amounts. Generates an invoice record when credit application results in a balance change that must be tracked against the original invoice.
• assign_acct_plan_m—Assigns a new master or supplemental plan to the specified account. Generates an invoice when a plan is assigned mid-cycle and proration charges apply.
• calc_credit_reference_line_m—Calculates credit reference over invoice line items in the past. Generates an invoice reference when the calculated credit is applied as an adjustment to a prior billing period.
• cancel_acct_plan_m—Cancels a master or supplemental plan assigned to a specified account. Generates an invoice when cancellation triggers a proration credit or early termination fee.
• create_cm_m—Creates a credit memo to adjust line item charges on the specified invoice. Generates an invoice reference when the credit memo is tied to an existing invoice for line-level adjustment.
• create_order_m—Creates an invoice for one or more inventory items ordered by a specified account holder. Generates an invoice directly upon order creation when bill_immediately is set to true.
• create_order_with_plan_m—Creates an order and plan changes on a single invoice. Generates an invoice when the combined order and plan assignment produces billable charges in the same transaction.
• create_writeoff_or_dispute_m—Creates a writeoff or dispute hold for a given invoice. Generates an invoice reference when a partial writeoff requires a new adjustment line against the original invoice.
• edit_acct_plan_queued_changes_m—Modifies all existing queued plan changes for an account or a specific plan instance, with options to execute, delete, or reschedule them. Generates an invoice when a queued plan change is executed immediately and the resulting plan assignment carries billable charges.
• gen_invoice_m—Generates invoices for a specified master plan instance, a specific billing group, or all billing groups under the account. Generates an invoice directly when called against a master plan instance whose billing date has passed.
• gen_rb_m—Executes the rebill process against the specified invoice, creating a credit memo to offset the original charges and a new rebill invoice. Generates a new invoice each time a rebill is executed to replace corrected line items on the original.
• issue_refund_to_acct_m—Issues refunds of payment amounts and any invoice line items to be reversed for a specified account. Generates an invoice when a line item reversal is included, creating a new credit invoice to offset the original charges.
• manage_pending_invoice_m—Approves, discards, or regenerates a pending invoice, with options to collect payment and send a statement. Generates an invoice when a pending invoice is approved or regenerated with updated charges.
• modify_acct_plan_unit_instances_m—Assigns a new plan unit instance to a specified plan or removes a plan unit instance from a specified plan. Generates an invoice when adding units mid-cycle causes immediate prorated charges.
• replace_acct_plan_m—Replaces an existing master or supplemental plan with a new master or supplemental plan for a specified account. Generates an invoice when the replacement plan carries a higher rate and an immediate charge is triggered at the time of swap.
• settle_dispute_hold_m—Settles a dispute for the given dispute number. Generates an invoice when settlement results in a partial charge or adjustment that must be billed to the account.
• unapply_cm_m—Unapplies credit memo line credits from invoice gross lines. Generates an invoice when unapplying a credit restores a balance that triggers a new charge event.
• update_acct_complete_m—Updates a broad range of information associated with an account, including contact info, payment methods, plan assignments, billing dates, and more. Generates an invoice when a billing date change causes an immediate cycle close and charge.
• update_acct_plan_m—Updates a plan instance's rates, units, coupons, status, description, plan instance fields, usage management tracking, and/or service location. Generates an invoice when a unit quantity increase mid-cycle triggers an immediate prorated charge.
• update_acct_plan_multi_m—Assigns, replaces, updates, and/or cancels multiple master and supplemental plans for a specified account in a single API call. Generates an invoice when one or more plan operations in the batch trigger immediate charges or proration.
• update_acct_plan_unit_instance_m—Updates fulfillment or supplemental fields on the unit instances of a plan. Generates an invoice when a fulfillment status change triggers a billable event on the associated plan.
• update_order_m—Updates an order for one or more inventory items ordered by a specified account holder. Generates an invoice when an order update increases the order total and bill_immediately is set to true.