Home > Aria Crescendo Documentation > 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
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 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 Deprecated. The 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 Deprecated. The 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. The API returns data when you pass a real invoice_no. But when you pass a pending invoice_no, API does not return data.
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 Amount charged on an invoice
bill_date The date on which the account was billed for the invoice. Use the format yyyy-mm-dd.
due_date Date on which payment for an invoice was due
paid_date Date on which the invoice was paid
balance_forward Previous balance on an account that was carried over to the next billing period
total_due Total balance due on the invoice
last_updated Most recent date on which the invoice was updated
aria_statement_no The unique, Aria-assigned statement number with which an invoice is associated
acct_statement_seq_str Client-defined invoice identifier. This may be a combination of elements such as the customer's ISO country code and the statement number, depending on your client configuration. Please contact Aria Customer Support for information and setup related to client-defined invoice numbering.
second_acct_statement_seq_str Additional client-defined invoice identifier. This may be a combination of elements such as the customer's bank account number and the statement number, depending on your client configuration. Please contact Aria Customer Support for information and setup related to client-defined invoice numbering.
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: 'C' - Combined Invoice, 'F' - Anniversary Period Invoice, 'H' - Hybrid Invoice, 'O' - Order-based Invoice, 'P' - Non-anniversary Subscription Invoice, and 'R' - Rebill 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 Identifier for a transaction that applies to an invoice line item
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 Detailed invoice information for any accounts matching the query
brd_arrow.gif invoice_no long The Aria assigned ID of the invoice
brd_arrow.gif acct_no long The Aria assigned ID of the account
brd_arrow.gif user_id string The client defined user_id for the account
brd_arrow.gif client_acct_id string Client-specified account identifier
brd_arrow.gif amount double Total amount charged for the invoice
brd_arrow.gif bill_date string The date on which the account was billed for an invoice. The date is in the format yyyy-mm-dd.
brd_arrow.gif due_date string Date on which payment for an invoice was due
brd_arrow.gif paid_date string Date on which the invoice was paid
brd_arrow.gif notify_date string Date on which the statement was sent to the account holder
brd_arrow.gif from_date string Deprecated. Start date of the period that an invoice is for. The date is in the format yyyy-mm-dd.
brd_arrow.gif to_date string Deprecated. End date of the period that an invoice is for. The date is in the format yyyy-mm-dd.
brd_arrow.gif currency_cd string The 3-character ISO-compliant currency code for monetary values on an invoice
brd_arrow.gif balance_forward double Previous balance on an account that was carried over to the next billing period
brd_arrow.gif statement_balance_forward double Balance on a statement that reflects all activity dated between from_date and to_date
brd_arrow.gif total_due double Total balance due on the invoice
brd_arrow.gif comments string Any client-defined comments entered on an invoice by a CSR (Customer Service Representative) or by the system, if any
brd_arrow.gif additional_comments string Comments entered by a CSR when placing an order or passed into the order_comments field in the create_order_m API.
brd_arrow.gif last_updated string Most recent date on which the invoice was updated
brd_arrow.gif aria_statement_no long The unique, Aria-assigned statement number with which an invoice is associated
brd_arrow.gif acct_statement_seq_str string An alternate statement number, which may be a combination of elements such as the account's ISO country code and the statement number depending on your client configuration. Please contact Aria Customer Support for information and setup related to alternate statement numbering.
brd_arrow.gif second_acct_statement_seq_str string An additional alternate statement number, which may be a combination of elements such as the account's ISO country code and the customer's bank account number depending on your client configuration. Please contact Aria Customer Support for information and setup related to alternate statement numbering.
brd_arrow.gif voiding_event_no long The number given for a voided invoice
brd_arrow.gif custom_status_label string Value allowed for Client specific custom invoice status that can be edited at the invoice or pending invoice level
brd_arrow.gif client_notes string Client specific custom invoice notes that can be edited at the invoice or pending invoice level
brd_arrow.gif invoice_type_cd string This field identifies the type of the invoice generated: 'C' - Combined Invoice, 'F' - Anniversary Period Invoice, 'H' - Hybrid Invoice, 'O' - Order based Invoice, ''P' - Non-anniversary Subscription Invoice, 'R' - Rebill Invoice
brd_arrow.gif billing_group_no long Billing group for which the invoice was generated
brd_arrow.gif client_billing_group_id long Client assigned billing group id for which the invoice was generated
brd_arrow.gif invoice_line_m hash List of details about invoice line items
brd_arrow.gif line_item_no long Invoice line item number
brd_arrow.gif amount double Amount charged or credited for an invoice line item
brd_arrow.gif comments string Any client-defined comments entered for an invoice line item by a CSR (Customer Service Representative) or by the system
brd_arrow.gif plan_name string Name of the plan to which an invoice line item applies
brd_arrow.gif plan_no long Identifier for the plan to which an invoice line item applies
brd_arrow.gif service_name string Name of the service to which an invoice line item applies
brd_arrow.gif service_no long Identifier for the service to which an invoice line item applies
brd_arrow.gif ledger_code string Identifier for a debit or credit entry in your general ledger
brd_arrow.gif coa_id long Chart of accounts identifier to the account in your general ledger
brd_arrow.gif coa_description string Description of the coa_id
brd_arrow.gif usage_units double Amount of usage that the account holder consumed
brd_arrow.gif usage_rate double Cost per usage unit
brd_arrow.gif usage_type_no double The Aria-assigned identifier for the usage type
brd_arrow.gif start_date string Start date of the period to which the invoice line item applies
brd_arrow.gif end_date string End date of the period to which the invoice line item applies
brd_arrow.gif client_sku string Client-defined SKU (stock keeping unit) identifier of an inventory item
brd_arrow.gif order_no long The Aria-assigned identifier for an order
brd_arrow.gif item_no long The Aria-assigned identifier for an inventory item
brd_arrow.gif base_plan_units long The number of units to which the account holder is subscribed
brd_arrow.gif proration_factor double The percentage of the plan units for which the account holder was billed
brd_arrow.gif proration_text string The number of prorated days for which the account holder was billed
brd_arrow.gif adv_billing_period_total_days long Total number of days to which the invoice line item applies
brd_arrow.gif proration_remaining_days long The number of days in the period covered by the invoice for which charges were prorated
brd_arrow.gif proration_description string Prorated invoice description
brd_arrow.gif 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.
brd_arrow.gif 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.
brd_arrow.gif 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.
brd_arrow.gif 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
brd_arrow.gif transaction_type string Type of transaction that applies to the invoice line item 

Allowable values for transaction_type:

Values Description
1 Invoice
-1 Voided Invoice
2 check
-2 Voided Check
3 Electronic Payment
-3 Voided Electronic Payment
4 Balance Transfer To Account
-4 Voided Balance Transfer To Account
5 Balance Transfer From Account
-5 Voided Balance Transfer From Account
6 Write Off
-6 Voided Write Off
7 (Deprecated) Out-of-band Electronic Credit
-7 (Deprecated) Voided Out-of-band Electronic Credit
8 Refund Request
-8 Voided Refund Request
9 Balance Forward
-9 Voided Balance Forward
10 Cash Credit
-10 Voided Cash Credit
11 Credit From Overpayment
-11 Voided Credit From Overpayment
12 Electronic Refund Disbursement
-12 Voided Electronic Refund Disbursement
13 Check Refund Disbursementt
-13 Voided Check Refund Disbursement
14 External charge
-14 Voided External Charge
15 Dunning Charge
-15 Voided Dunning Charge
16 Reinstated Charge transaction
-16 Voided reinstated Charge transaction
17 Reinstated Payment transaction
-17 Voided reinstated payment transaction
18 Negative Balance Forward
-18 Voided Negative Balance Forward
19 3rd party payment
-19 Voided 3rd party payment
20 3rd party payment refund
-20 Voided 3rd party payment refund
21 Invoice charge line item
-21 Voided Invoice charge line item
22 Invoice credit line item
-22 Voided Invoice credit line item
24 Credit memo line
-24 Voided credit memo line
brd_arrow.gif master_plan_instance_id long Aria generated unique identifier for the master plan instance
brd_arrow.gif client_master_plan_instance_id string Client defined unique identifier for the master plan instance
brd_arrow.gif invoice_transaction_id long Identifier for the transaction that applies to the invoice line item
brd_arrow.gif po_num string Purchase order number assigned to the invoice.
brd_arrow.gif invoice_line_tax_m hash List of details about the tax-related invoice line items
brd_arrow.gif tax_id long Identifier for the type of tax charged
brd_arrow.gif amount double

Amount of tax charged against the line item amount. 

This amount will vary depending on whether you configured your tax engine to charge taxes before or after a credit is applied.
brd_arrow.gif before_credit_amount double

Amount of tax charged before credits were applied.

This amount will vary depending on which tax engine you are using. Please contact Aria Customer Support for more information.
brd_arrow.gif jurisdiction string Jurisdiction to which the tax applies
brd_arrow.gif description string Tax description
brd_arrow.gif is_excluded long

Specifies whether an invoice line item is taxable.

Allowable values for is_excluded:

Values Description
0 The invoice line item is taxable (included)
1 The invoice line item is not taxable (excluded)
brd_arrow.gif rate_schedule_no double Aria-assigned unique identifier for the rate schedule used to generate this invoice line item
brd_arrow.gif rate_schedule_tier_no double Sequential number for the rate tier associated with the rate schedule used to generate this invoice line item
brd_arrow.gif tax_inclusive_ind long This flag denotes if a rate is inclusive of the taxes. Value of 1 means tax inclusive rates and a value of 0 (default) means tax exclusive rates.
brd_arrow.gif custom_rate_ind long Identifies whether this is a custom rate. A value of 1 indicates that it is a custom rate.  A value of 0 indicates that it is a standard rate. Please note that there are cases in which the custom_rate_ind is null/0 but rate_schedule_no is also null. These special cases include rebill rate changes and multi-plan contract early cancellation fees where the charges are neither from regular rate schedule nor from custom rates.
overall_bill_from_date string The earliest date for this invoicing period.
overall_bill_thru_date string The latest date for this invoicing period.
recurring_bill_from_date string The recurring bill-from date.
recurring_bill_thru_date string The recurring bill-through date.
usage_bill_from_date string Start date of the period for which usage was billed. The date is in the format yyyy-mm-dd.
usage_bill_thru_date string End date of the period for which usage was billed. The date is in the format yyyy-mm-dd.
Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.
Powered by CXone Expert ®