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

 

Home > Aria6 object query api > get_invoice_information

get_invoice_information

Gets invoice details for all accounts matching specified query

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.
query_string string 1000 The criteria which all returned objects must match. Different objects have a different set of searchable criteria.Fields marked with "*Query" in the returns section can be used as part of the query_string. Valid operations for the query string include "=", "!=", "<", "<=", ">=", ">", "IS NULL", "IS NOT NULL", "LIKE", and "NOT LIKE". The first operand must always be a field name, and the second operand must always be a value (except for "IS NULL" and "IS NOT NULL", where the second operand is implicitly "NULL"). If the second operand contains a space, less than, greater than, or equals sign, then it must be enclosed in double quotes. The second operand may not contain double quotes. Multiple conditions must be joined with either "AND" or "OR". Additionally, any queryable field can also be used to order the results, by appending "ORDER BY" to the query, followed by a field name and either "ASC" or "DESC".
username string 30 DeprecatedThe login name of the user making this request. It is the same name that is used to log in to the Aria Administration and Configuration Tool.
password string 1000 DeprecatedThe password of the user making this request. It is the same password that is used to log in to the Aria Administration and Configuration Tool.
limit long 12 The maximum number of objects to be returned by this call. Note that Aria recommends a maximum limit of less than 1,000. Higher limits may take much longer to return data. If you do not specify a value, or specify a value of "0", this field defaults to 100. Specifying a value of "-1" returns a count of the number of matching records, but does not return any records.
offset long 12 The number of records to skip. Note that both "0" and NULL will cause the interface not to skip any records.

Querystring Keys

Key Name Description
invoice_no The Aria assigned ID of the invoice
acct_no The Aria assigned ID of the account
user_id The client defined user_id for the account
debit
bill_date
due_date
paid_date
balance_forward
total_due
transaction_type
last_updated
aria_event_no
aria_statement_no
acct_statement_seq_str
second_acct_statement_seq_str
custom_status_label Value allowed for Client specific custom invoice status that can be edited at the invoice or pending invoice level
client_notes Client specific custom invoice notes that can be edited at the invoice or pending invoice level
invoice_type_cd This field identifies the type of the invoice generated: 'O' - Order based, 'F' - Full (anniversary) invoice and 'P' - Prorated invoice
posting_status_cd Posting status of an invoice
posting_user The user who manual posted this invoice. If set to "System" then the invoice was auto posted by the system.

Output Arguments

Field Name Field Type Description
error_code long Aria-assigned error identifier. 0 indicates no error
error_msg string Textual description of any error that occurred. "OK" if there was no error.
starting_record long This indicates the number of objects that were (or would be) skipped before beginning output.
total_records long This is the total number of objects that matched the provided criteria.
invoice_details hash
invoice_no long The Aria assigned ID of the invoice
acct_no long The Aria assigned ID of the account
user_id string The client defined user_id for the account
debit double
credit double
bill_date string
due_date string
paid_date string
notify_date string
from_date string
to_date string
currency_cd string
balance_forward double
statement_balance_forward double
total_due double
comments string
additional_comments string
transaction_type string
last_updated string
aria_event_no long
aria_statement_no long
acct_statement_seq_str string
second_acct_statement_seq_str string
voiding_event_no long The number given for a voided invoice
custom_status_label string Value allowed for Client specific custom invoice status that can be edited at the invoice or pending invoice level
client_notes string Client specific custom invoice notes that can be edited at the invoice or pending invoice level
invoice_type_cd string This field identifies the type of the invoice generated: 'O' - Order based, 'F' - Full (anniversary) invoice and 'P' - Prorated invoice
posting_status_cd long Posting status of an invoice  Allowable Values
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.
posting_user string The user who manual posted this invoice. If set to "System" then the invoice was auto posted by the system.
invoice_line hash
line_item_no long
amount double
comments string
plan_name string
plan_no long
service_name string
service_no long
ledger_code string
coa_id long
coa_description string
usage_units double
usage_rate double
usage_type_no double
start_date string
end_date string
client_sku string
order_no long
item_no long
base_plan_units long
proration_factor double
proration_text string
adv_billing_period_total_days long
proration_remaining_days long
proration_description string
invoice_line_tax hash
tax_id long
amount double
before_credit_amount double
jurisdiction string
description string
is_excluded long   Allowable Values
rate_schedule_no double
rate_schedule_tier_no double
client_no long Aria-assigned unique identifier indicating the Aria client providing service to this account.

You must to post a comment.
Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.