Skip to main content
Aria Knowledge Central

get_invoice_history_m

  1. Last updated
  2. Save as PDF

Summary

API Name get_invoice_history_m
Class account_services_m
Update Version 44

Description

Returns the invoice history for a specified master plan instance. The call can return invoices for all billing dates or only invoices for a particular billing date range.

Inputs

Name Type Length Required Description
client_no long 22 Yes

Aria-assigned unique identifier indicating the Aria client providing service to this account.
auth_key string 32 Yes

Aria-assigned unique key for authenticating the validity of the requestor. This key is passed with each method call.
acct_no long 22 Yes

Aria-assigned account identifier. This value is unique across all Aria-managed accounts.

Alternative required field: client_acct_id or user_id
client_acct_id string 50 Yes

Client-defined account identifier.

Alternative required field: acct_no or user_id
master_plan_instance_id long 22 Yes

It allow Aria-generated unique identifier for the master plan instance and also '-1' value. If user wants to retrieve specific MPI's invoices by passing values to 'filter_master_plan_instance' array then user must pass '-1' in this input. If user pass '-1' without providing any inputs to 'filter_master_plan_instance' array then API will retrieve all the invoices in the account. If user provides MPI instead of '-1' to this input along with 'filter_master_plan_instance' array input then API will consolidate both the single and array input MPI's and retrieve the invoices of those MPI's.

Alternative required field: client_master_plan_instance_id
client_master_plan_instance_id string 100 Yes

It allow Client-defined unique identifier for the master plan instance.

Alternative required field: master_plan_instance_id
user_id string 32 Yes

Account's user ID. Alternative to using acct_no.

Alternative required field: client_acct_id or acct_no
start_bill_date string 10 No

The beginning of the date range to search for account invoices.
end_bill_date string 10 No

The end of the range to search for invoice history on the account.
include_voided string 5 No

Include voided invoices in the search results.

Allowed values:

Value Description
True  
False  
rb_option long 1 No

Filters the return results of the api call.

Allowed values:

Value Description
0 or NULL The account history provided will include all invoices, including rebilled ones. (default)
1 The account history provided will include only original invoices and will not return rebill invoices.
2 For those invoices that have been rebilled, the account history provided will include only the rebilled ones.
filter_master_plan_instance object   No

The list of master plan instance to filter

See fields below
include_payment_plan_info string   No

Specifies whether payment plan info need to be included or not. By default, it's set as 'false'. When it's 'true', payment plan details will be part of the response.

Allowed values:

Value Description
True  
False  

filter_master_plan_instance fields

Name Type Length Required Description
plan_instance_no long   No

The Aria-assigned unique identifier of the master plan that will be used to filter the results for this API. To honor this input we need to pass '-1' value in 'master_plan_instance_id'.

Alternative field: client_plan_instance_id
client_plan_instance_id string   No

The client-defined unique identifier of the master plan that will be used to filter the results for this API. To honor this input we need to pass '-1' value in 'master_plan_instance_id'.

Alternative field: plan_instance_no

Outputs

Name Type Length Required Description
error_code long   No

Aria-assigned error identifier. 0 indicates no error.
error_msg string   No

Description of any error that occurred. "OK" if there was no error.
invoice_hist object   No

Array of invoices.

See fields below

invoice_hist.invoice_payment_plan_info fields

Name Type Length Required Description
payment_plan_create_date string   No

Date when payment plan created
payment_plan_no long   No

Aria-assigned payment plan no
client_payment_plan_id string   No

Client-defined unique payment plan ID
invoice_initial_balance double   No

The invoice initial balance to be paid at the time of payment plan creation
invoice_paid_amount double   No

The invoice paid amount on a payment plan at the time of the API call
payment_plan_status string   No

Specifies the other status of payment plan (active, completed, or cancelled)

invoice_hist fields

Name Type Length Required Description
invoice_no long   No

The Aria-assigned unique identifier of a given invoice.
outacct_no long   No

Aria-assigned account identifier. This value is unique across all Aria-managed accounts.
outclient_acct_id string   No

This is the client-assigned identifier for the account.
billing_group_no long 22 No

The billing group number mapped against each master plan.
client_billing_group_id string 100 No

Client-defined billing group ID.
master_plan_no long   No

Note: This field is deprecated. Aria no longer supports master_plan_no.
master_plan_name string   No

Note: This field is deprecated. Aria no longer supports master_plan_name.
currency_cd string   No

The 3-character ISO-compliant currency code in lowercase for monetary values used in the context of this API method.
bill_date string   No

The date the invoice was billed.
paid_date string   No

The date the invoice was paid.
amount double   No

Debit amount applied by the invoice.
credit double   No

Credit amount applied by the invoice.
recurring_bill_from string   No

The recurring bill-from date.
recurring_bill_thru string   No

The recurring bill-through date.
usage_bill_from string   No

The usage bill from date.
usage_bill_thru string   No

The usage bill-through date of the invoice.
is_voided_ind long   No

A boolean value indicating if the invoice has been voided.

Allowed values:

Value Description
0  
1  
client_master_plan_id string 100 No

Note: This field is deprecated. Aria no longer supports client_master_plan_id.
invoice_type_cd string   No

This field identifies the type of the invoice generated

Allowed values:

Value Description
O Order based Invoice
F Full Invoice
P Prorated invoice.
orig_invoice_no long   No

The Aria generated unique invoice number of the original invoice. This field is populated on rebill invoices.
rb_no long   No

The Aria generated unique invoice number for the rebill invoice. This field is populated on the original invoice.
rb_reason_cd long   No

The Client-defined reason code for the rebill.
rb_comments string   No

Explanatory text for the rebill.
rb_flag long   No

Rebill indicator.

Allowed values:

Value Description
1 Invoice is a rebill.
0 or NULL Invoice is not a rebill.
rb_status string   No

Indicates whether the current invoice has been rebilled.

Allowed values:

Value Description
True Rebilled
False Not rebilled
overall_bill_from_date string   No

The earliest date for this invoicing period.
overall_bill_thru_date string   No

The latest date for this invoicing period.
installment_ind long   No

'Indicates if one or more invoice lines have installments. Allowable values are 0 [No installment] or 1 [Has installment].'
balance_due double   No

Balance due amount
invoice_payment_plan_info object   No

Array of payment plan information related to an invoice

See fields below
TOP
  1. Back to top
  • Was this article helpful?

Recommended articles

  1. Page type
    Topic
  2. Tags
    This page has no tags.