Home > Aria6 User Documentation > Aria6 object query api > get_invoice_information
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 | Total debit amount (charges) on the 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 |
| transaction_type | Type of transaction that applies to the invoice |
| last_updated | Most recent date on which the invoice was updated |
| aria_event_no | The Aria-assigned identifier for the event |
| 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 |
| 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 | Total debit amount (charges) on the invoice |
| credit |
double | Total credit applied to the invoice. |
| bill_date |
string | The date on which the account was billed for an invoice. The date is in the format yyyy-mm-dd. |
| due_date |
string | Date on which payment for an invoice was due |
| paid_date |
string | Date on which the invoice was paid |
| notify_date |
string | Date on which the statement was sent to the account holder |
| from_date |
string | Start date of the period that an invoice is for. The date is in the format yyyy-mm-dd. |
| to_date |
string | End date of the period that an invoice is for. The date is in the format yyyy-mm-dd. |
| currency_cd |
string | The 3-character ISO-compliant currency code for monetary values on an invoice |
| balance_forward |
double | Previous balance on an account that was carried over to the next billing period |
| statement_balance_forward |
double | Balance on a statement that reflects all activity dated between from_date and to_date |
| total_due |
double | Total balance due on the invoice |
| comments |
string | Any client-defined comments entered on an invoice by a CSR (Customer Service Representative) or by the system, if any |
| additional_comments |
string | Comments entered by a CSR when placing an order or passed into the order_comments field in the create_order API. |
| transaction_type |
string | Type of transaction that applies to the invoice line item |
| last_updated |
string | Most recent date on which the invoice was updated |
| aria_event_no |
long | The Aria assigned identifier for the event |
| aria_statement_no |
long | The unique, Aria-assigned statement number with which an invoice is associated |
| acct_statement_seq_str |
string | 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 |
string | 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. |
| 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' - Anniversary Period Invoice, and 'P' - Mid-Period Change 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 | Invoice line item number |
| amount |
double | Amount charged or credited for an invoice line item |
| comments |
string | Any client-defined comments entered for an invoice line item by a CSR (Customer Service Representative) or by the system |
| plan_name |
string | Name of the plan to which an invoice line item applies |
| plan_no |
long | Identifier for the plan to which an invoice line item applies |
| service_name |
string | Name of the service to which an invoice line item applies |
| service_no |
long | Identifier for the service to which an invoice line item applies |
| ledger_code |
string | Identifier for a debit or credit entry in your general ledger |
| coa_id |
long | Chart of accounts identifier to the account in your general ledger |
| coa_description |
string | Description of the coa_id |
| usage_units |
double | Amount of usage that the account holder consumed |
| usage_rate |
double | Cost per usage unit |
| usage_type_no |
double | The Aria-assigned identifier for the usage type |
| start_date |
string | Start date of the period to which the invoice line item applies |
| end_date |
string | End date of the period to which the invoice line item applies |
| client_sku |
string | Client-defined SKU (stock keeping unit) identifier of an inventory item |
| order_no |
long | The Aria-assigned identifier for an order |
| item_no |
long | The Aria-assigned identifier for an inventory item |
| base_plan_units |
long | The number of units to which the account holder is subscribed |
| proration_factor |
double | The percentage of the plan units for which the account holder was billed |
| proration_text |
string | The number of prorated days for which the account holder was billed |
| adv_billing_period_total_days |
long | Total number of days to which the invoice line item applies |
| proration_remaining_days |
long | The number of days in the period covered by the invoice for which charges were prorated |
| proration_description |
string | Prorated invoice description |
| invoice_line_tax |
hash | |
| tax_id |
long | Identifier for the type of tax charged |
| amount |
double | Amount of tax charged |
| before_credit_amount |
double | Amount charged before taxes |
| jurisdiction |
string | Jurisdiction to which the tax applies |
| description |
string | Tax description |
| is_excluded |
long |
Specifies whether an invoice line item is taxable. Allowable Values |
| rate_schedule_no |
double | Aria-assigned unique identifier for the rate schedule used to generate this invoice line item. |
| rate_schedule_tier_no |
double | Sequential number for the rate tier associated with the rate schedule used to generate this invoice line item. |
| client_no |
long | Aria-assigned unique identifier indicating the Aria client providing service to this account. |
- © Copyright 2020 Aria Developer Central