Home > Aria6 User Documentation > Aria6 core api > get_acct_invoice_history


Returns the invoice history for a specified account. 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
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.
  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 5 Include voided invoices in the search results.  

Allowable values for include_voided:

  posting_status_cd long 1 Posting status of an invoice  

Allowable values for posting_status_cd:

  posting_user string 100 The user who manual posted this invoice. If set to "System" then the invoice was auto posted by the system.
  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_history hash  
brd_arrow.gif invoice_no long The unique identifier of a given invoice.
brd_arrow.gif master_plan_no long Aria-assigned plan number for this invoice.
brd_arrow.gif master_plan_name string The name of the master plan for this invoice.
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 debit 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 for is_voided_ind:

brd_arrow.gif client_master_plan_id string Client-defined plan number assigned for this invoice.
brd_arrow.gif invoice_type_cd string This field identifies the type of the invoice generated 

Allowable values for invoice_type_cd:

brd_arrow.gif posting_status_cd long Posting status of an invoice 

Allowable values for posting_status_cd:

brd_arrow.gif posting_user string The user who manual posted this invoice. If set to "System" then the invoice was auto posted by the system.
brd_arrow.gif posting_date string Date when the invoice was posted to the GL/External Finance System. The posting date is Null for unposted invoices, the invoice creation date for system posted invoices, and is set to the date and time when an invoice is manually posted.
Last modified


This page has no custom tags.


This page has no classifications.