Search the Aria Knowledgebase for
User Documentation, APIs, SDKs, and more!

 

Home > 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.

Input Arguments

Req Field Name Field Type Max Length Description
client_no long 22 Aria-assigned unique identifier indicating the Aria client providing service to this account.
auth_key string 32 Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor.
acct_no long 22 Aria-assigned account identifier. This value is unique across all Aria-managed accounts.
  OR      
  client_acct_id string 50 This is the client-assigned identifier for the master plan instance
master_plan_instance_id long 22 Aria-generated unique identifier for the master plan instance.
  OR      
  client_master_plan_instance_id string 100 Client-defined unique identifier for the master plan instance.
  user_id string 32 Account's user ID. Alternative to using acct_no.
  start_bill_date string 12 The beginning of the date range to search for account invoices.
  end_bill_date string 12 The end of the range to search for invoice history on the account.
  include_voided string   Include voided invoices in the search results.   Allowable Values
  rb_option long 1 Filters the return results of the api call. 0 or null = the account history provided will include all invoices, including rebilled ones. 1 = the account history provided will include only original invoices and will not return rebill invoices. 2 = for those invoices that have been rebilled, the account history provided will include only the rebilled ones.
  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.
  qualifier_name string 100 Name of the field you want to associate with this API call.
  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.
invoice_no long The unique identifier of a given invoice.
outacct_no long Aria-assigned account identifier. This value is unique across all Aria-managed accounts.
outclient_acct_id string This is the client-assigned identifier for the account.
billing_group_no long The billing group number mapped against each master plan.
client_billing_group_id string Client defined billing group ID.
master_plan_no long Aria-assigned plan number for this invoice.
master_plan_name string The name of the master plan for this invoice.
currency_cd string The 3-character ISO-compliant currency code in lowercase for monetary values used in the context of this API method.
bill_date string The date the invoice was billed.
paid_date string The date the invoice was paid.
amount double Debit amount applied by the invoice.
credit double Credit amount applied by the invoice.
recurring_bill_from string The recurring bill-from date.
recurring_bill_thru string The recurring bill-through date.
usage_bill_from string The usage bill from date.
usage_bill_thru string The usage bill-through date of the invoice.
is_voided_ind long A boolean value indicating if the invoice has been voided.   Allowable Values
client_master_plan_id string The client-defined Master Subscription plan ID.
invoice_type_cd string This field identifies the type of the invoice generated   Allowable Values
orig_invoice_no long The Aria generated unique invoice number of the original invoice. This field is populated on rebill invoices.
rb_no long The Aria generated unique invoice number for the rebill invoice. This field is populated on the original invoice.
rb_reason_cd long The client defined reason code for the rebill.
rb_comments string Explanatory text for the rebill.
rb_flag long Rebill indicator. 1 = rebill, 0 or null = not a rebill.
rb_status string Indicates whether the current invoice has been rebilled. "True" = rebilled, "False" = not rebilled.

You must to post a comment.
Last modified
14:39, 2 Feb 2017

Tags

This page has no custom tags.

Classifications

This page has no classifications.