get_all_invoice_information_m

Last updated
Save as PDF
Share
1. Share
2. Tweet
3. Share

Description

This API returns both real and pending invoice details for all accounts matching specified query

Inputs

Name	Type	Length	Required	Description
username	string	30	No	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	No	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.
client_no	long	12	Yes	Aria-assigned unique identifier indicating the Aria client providing service to this account.
auth_key	string	32	Yes	Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor.
limit	long	12	No	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	No	The number of records to skip. Note that both "0" and NULL will cause the interface not to skip any records.
query_string	string	1000	Yes	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".

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

invoice_type

Determines if this is a real invoice (R) or a pending invoice (P)

Allowed values:

Value	Description
R
P

bill_company_name

The company name of the billing contact for the invoice

pay_method_type

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

pay_method_name

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

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

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.

plan_instance_no

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

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.

Outputs

Name

Type

Length

Required

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.

Start of all_invoice_details_m hash

all_invoice_details_m

hash

List of all_invoice_details_m associated with this method.

Name

Type

Length

Required

Description

▶invoice_no

long

The Aria assigned ID of the invoice

▶acct_no

long

The Aria assigned ID of the account

▶user_id

string

100

The client defined user_id for the account

▶client_acct_id

string

Client-specified account identifier

▶invoice_type

string

100

Determines if this is a real invoice (R) or a pending invoice (P)

Allowed values:

Value	Description
R
P

▶from_date (deprecated)

string

▶to_date (deprecated)

string

▶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

▶bill_date

string

▶due_date

string

▶paid_date

string

▶notify_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

▶invoice_line_items

string

Whether or not the invoice has any line items

Allowed values:

Value	Description
0
1

▶voiding_event_no

long

The number given for a voided invoice

▶bill_company_name

string

100

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

100

▶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

Start of all_invoice_line_m hash

▶all_invoice_line_m

hash

List of all_invoice_line_m associated with this method.

Name

Type

Length

Required

Description

▶▶line_item_no

long

▶▶credit_reason_code_description

string

▶▶description

string

▶▶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

▶▶plan_units_change

double

Number of units changed because of an upgrade or downgrade to a plan. For an upgrade from 1 unit to 3 units, this would return a value of 2. The calculation is “base plan units minus prior base plan units”. This value will only be calculated if both values are present.

▶▶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

100

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

100

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.

Start of all_invoice_line_tax_m hash

▶▶all_invoice_line_tax_m

hash

List of all_invoice_line_tax_m associated with this method.

Name

Type

Length

Required

Description

▶▶▶tax_id

long

▶▶▶amount

double

▶▶▶before_credit_amount

double

▶▶▶jurisdiction

string

▶▶▶description

string

▶▶▶is_excluded

long

Allowed values:

Value	Description
0
1

End of all_invoice_line_tax_m hash

▶▶line_type

double

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

Allowed values:

Value	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

▶▶rate_schedule_no

double

Aria-assigned unique identifier for the rate schedule used to generate this invoice line item. Either the catalog rate of this rate schedule is used for this line item or the account custom rate against this underlying rate schedule is used. 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.

▶▶client_rate_schedule_id

string

Client-defined 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.

▶▶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.

▶▶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.

End of all_invoice_line_m hash

▶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.

End of all_invoice_details_m hash