Home > Aria Crescendo Documentation > Aria Crescendo core api > get_invoice_history_m

get_invoice_history_m

Returns the invoice history for a specified master plan instance. The call can return invoices for all billing dates or only invoices for a particular billing date range.

For information on error messages generated by this API, see get_invoice_history_m Error Messages.

Input Arguments

Req Field Name Field Type Max Length Description
required-icon.png client_no long 22 Aria-assigned unique identifier indicating the Aria client providing service to this account.
required-icon.png auth_key string 32 Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor.
required-icon.png acct_no long 22 Aria-assigned account identifier. This value is unique across all Aria-managed accounts.
  OR      
  client_acct_id string 50 Client-defined account identifier.
  OR      
  user_id string 32 Account's user ID. Alternative to using acct_no.
required-icon.png master_plan_instance_id long 22

You can:

  1. Pass in the Aria-generated unique identifier for the master plan instance (MPI) to get the invoice history of only that MPI; or
  2. Pass in -1 to get the invoice history of all MPIs for the specified account.

 

Note:

  • If you pass in both a <master_plan_instance_id> and   <filter_master_plan_instance> array details, then this API will return the history of all of your specified MPIs.
  • If you pass -1 into the <master_plan_instance_id> field and you pass in  <filter_master_plan_instance> array details, then this API will return the history of only the MPIs that you specified.
  • If you pass -1 into this field, then the following outputs will be empty:<master_plan_no>, <master_plan_name>, and    <client_master_plan_id>.
  OR      
  client_master_plan_instance_id string 100 Client-defined unique identifier for the master plan instance.
  start_bill_date string 10 The beginning of the date range to search for account invoices.
  end_bill_date string 10 The end of the range to search for invoice history on the account.
  include_voided string 5 Include voided invoices in the search results.   Allowable Values
  rb_option long 1 Filters the return results of the api call.   Allowable Values
Start of <filter_master_plan_instance> array
  filter_master_plan_instance array  

Array of MPIs for which you want to get the invoice history.

Note:

  • If you pass in both a <master_plan_instance_id> and   <filter_master_plan_instance> array details, then this API will return the history of all of your specified MPIs.
  • If you pass -1 into the <master_plan_instance_id> field and you pass in  <filter_master_plan_instance> array details, then this API will return the history of only the MPIs that you specified.
  brd_arrow.gif plan_instance_no string 100 Aria-generated unique identifier for the master plan instance.
  OR      
  brd_arrow.gif client_plan_instance_id string 100 Client-defined unique identifier for the master plan instance.
End of <filter_master_plan_instance> array
  alt_caller_id string 30 Person or process that submitted the API call. This can be someone's user ID, or the name of an application.
  optional_transaction_qualifiers array   Array of additional values you can associate with this API call.
  brd_arrow.gif qualifier_name string 100 Name of the field you want to associate with this API call.
  brd_arrow.gif qualifier_value string 100 Corresponding value of the field you want to associate with this API call.

Output Arguments

Field Name Field Type Description
error_code long Aria-assigned error identifier. 0 indicates no error.
error_msg string Description of any error that occurred. "OK" if there was no error.
invoice_hist hash Array of invoices.
brd_arrow.gif invoice_no long The Aria-assigned unique identifier of a given invoice.
brd_arrow.gif outacct_no long Aria-assigned account identifier. This value is unique across all Aria-managed accounts.
brd_arrow.gif outclient_acct_id string This is the client-assigned identifier for the account.
brd_arrow.gif billing_group_no long The billing group number mapped against each master plan.
brd_arrow.gif client_billing_group_id string Client-defined billing group ID.
brd_arrow.gif master_plan_no long Aria-assigned plan number for the Master Plan Instance input filter.
brd_arrow.gif master_plan_name string The name of the master plan for the Master Plan Instance input filter.
brd_arrow.gif currency_cd string The 3-character ISO-compliant currency code in lowercase for monetary values used in the context of this API method.
brd_arrow.gif bill_date string The date the invoice was billed.
brd_arrow.gif paid_date string The date the invoice was paid.
brd_arrow.gif amount double Debit amount applied by the invoice.
brd_arrow.gif credit double Credit amount applied by the invoice.
brd_arrow.gif recurring_bill_from string The recurring bill-from date.
brd_arrow.gif recurring_bill_thru string The recurring bill-through date.
brd_arrow.gif usage_bill_from string The usage bill from date.
brd_arrow.gif usage_bill_thru string The usage bill-through date of the invoice.
brd_arrow.gif is_voided_ind long A boolean value indicating if the invoice has been voided.   Allowable Values
brd_arrow.gif client_master_plan_id string The client_plan_id of the given Master Plan Instance input filter.
brd_arrow.gif invoice_type_cd string This field identifies the type of the invoice generated   Allowable Values
brd_arrow.gif orig_invoice_no long The Aria generated unique invoice number of the original invoice. This field is populated on rebill invoices.
brd_arrow.gif rb_no long The Aria generated unique invoice number for the rebill invoice. This field is populated on the original invoice.
brd_arrow.gif rb_reason_cd long The Client-defined reason code for the rebill.
brd_arrow.gif rb_comments string Explanatory text for the rebill.
brd_arrow.gif rb_flag long Rebill indicator.   Allowable Values
brd_arrow.gif rb_status string Indicates whether the current invoice has been rebilled.   Allowable Values
Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.
Powered by CXone Expert ®