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

 

Home > Aria Crescendo object query api > get_invoice_information_m

get_invoice_information_m

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". You must leave a space before and after each operation. 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
client_acct_id Client-specified account identifier
amount
bill_date
due_date
paid_date
balance_forward
total_due
last_updated
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
master_plan_instance_id Aria generated unique identifier for the master plan instance
client_master_plan_instance_id Client defined unique identifier for the master plan instance
invoice_transaction_id
po_num Purchase order number assigned to the invoice.

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_m 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
client_acct_id string Client-specified account identifier
amount 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
last_updated string
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
billing_group_no long Billing group for which the invoice was generated
client_billing_group_id long Client assigned billing group id for which the invoice was generated
invoice_line_m 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
bill_from_address_no long Address sent as the bill-from address to the tax engine for tax calculations. Depending on the taxation configuration, this parameter may return the Aria-assigned unique identifier of the service location for the invoice line item. Note that service locations can be associated with a service for a given plan instance on an account, with an item (NSO) purchased as part of a one-time order, or with a service as defined in the product catalog.
ship_from_address_no long Address sent as the ship-from address to the tax engine for tax calculations. Depending on the taxation configuration, this parameter may return the Aria-assigned unique identifier of the service location for the invoice line item. Note that service locations can be associated with a service for a given plan instance on an account, with an item (NSO) purchased as part of a one-time order, or with a service as defined in the product catalog.
bill_to_address_no long Address sent as the bill-to address to the tax engine for tax calculations. This parameter will return the Aria-assigned unique identifier of the contact on the account used as the bill-to address for the invoice line item.
ship_to_address_no long Address sent as the ship-to address to the tax engine for tax calculations. This parameter will return the Aria-assigned unique identifier of the contact on the account used as the ship-to address for the invoice line item
transaction_type string
master_plan_instance_id long Aria generated unique identifier for the master plan instance
client_master_plan_instance_id string Client defined unique identifier for the master plan instance
invoice_transaction_id long
po_num string Purchase order number assigned to the invoice.
invoice_line_tax_m 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

You must to post a comment.
Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.