get_all_invoice_information_m

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.

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.

all_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

invoice_type

string

Identifies an invoice as real (R) or pending (P)

Allowable Values

Values	Description
R	Real invoice
P	Pending invoice

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.

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.

taxed_email

string

The email address of the taxed contact, or the general billing email address.

taxed_first_name

string

The first name of the taxed contact for the account.

taxed_middle_initial

string

The middle initial of the taxed contact.

taxed_last_name

string

The last name of the taxed contact.

taxed_address1

string

Street address (number and name) of the taxed contact address.

taxed_address2

string

The second taxed address line (for example: bldg, suite, apt., etc.)

taxed_address3

string

The third taxed address line (for example: bldg, suite, apt., etc.)

taxed_city

string

The city name of the taxed contact address.

taxed_state

string

The state or province of the taxed contact's address. The official postal-service codes for all United States and Canada states, provinces, and territories.

taxed_locality

string

The billing contact's locality (for example: county, rural unincorporated area name).

taxed_zip

string

The zip or postal code for the taxed contact's address.

taxed_country

string

The country for the taxed contact's address. The ISO-compliant 2-character country code abbreviation in uppercase.

amount

double

Amount charged on an 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

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_m API.

last_updated

string

Most recent date on which the invoice was updated

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.

invoice_line_items

string

Whether or not the invoice has any line items Allowable Values

Values	Description
true	Line items are available for the invoice.
false	No line items are available for the invoice.

voiding_event_no

long

The number given for a voided invoice

bill_company_name

string

The company name of the billing contact for the invoice

pay_method_type

long

Integer values for the Aria supported payment method types. Allowable values are: 1, 0, 1-19 and 26.

pay_method_name

string

Human readable names for the Aria supported payment method types. Allowable values are: i. External Payment, ii. Other, iii. Credit card, iv. Electronic Check (ACH), v. Pre-paid4Net terms 30, vi. Net terms 10, vii. Net terms 15, viii. Net terms 60, ix. Click&Buy, x. Net Terms 0, xi. PayByCash, xii. PayPal Express Checkout, xiii. Net Terms 45, xiv. Tokenized Credit Card, xv. Purchase Power, xvi. Net Terms 35, xvii. Net Terms 75, xviii. Net Terms 90, xix. Net Terms 120, xx. Net Terms 25, xxi. Direct Debit.

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

billing_group_no

long

Billing group for which the invoice was generated

client_billing_group_id

string

Client assigned billing group id for which the invoice was generated

all_invoice_line_m

hash

line_item_no

long

Invoice line item number

credit_reason_code_description

string

Name of the reason code for any credit issued to the specified account holder

description

string

Description of an invoice line item

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) number 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

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

Type of transaction that applies to the invoice line item Allowable Values

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	Out-of-band Electronic Credit
-7	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

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

Identifier for the transaction that applies to the invoice line item

po_num

string

Purchase order number assigned to the invoice.

plan_instance_no

int

Aria-assigned unique identifier of the plan instance directly associated with this invoice line item. Note that this parameter may be a master plan instance or a supplemental plan instance.

client_plan_instance_id

string

Client-defined unique identifier of the plan instance directly associated with this invoice line item. Note that this parameter may be a master plan instance or a supplemental plan instance.

all_invoice_line_tax_m

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

Values	Description
0	The invoice line item is taxable (included)
1	The invoice line item is not taxable (excluded)

line_type

double

Specifies the type of charge or credit associated with this line item. Allowable Values

Values	Description
1	Recurring charge
2	Tax charge
3	Service credit
4	Coupon Credit
5	Activation Charge
6	Usage Charge
7	Recurring arrears charge
8	Order charge
9	Surcharge

get_all_invoice_information_m

Table of contents

Input Arguments

Querystring Keys

Output Arguments

Tags

Classifications

Values	Description
0	The service is tax-exclusive.
1	The service is tax-inclusive.

get_all_invoice_information_m

Table of contents

Input Arguments

Querystring Keys

Output Arguments

Related articles

Tags

Classifications