Skip to main content
Aria Knowledge Central

get_invoice_details_m

  1. Last updated
  2. Save as PDF

Summary

API Name get_invoice_details_m
Class transaction_services_m
Update Version 58

Description

Retrieves the detailed line items of a specified invoice, including each charge's service, plan instance, amount, tax breakdown, and usage details. This provides the full itemized view of what was billed on an invoice, including recurring subscription charges, usage-based charges, order charges, surcharges, discounts, and taxes. Returns the invoice header (dates, totals, billing group) and individual line items with their associated service and plan information. Use this for invoice reconciliation, customer billing inquiries, or building custom invoice displays.

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 No

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
invoice_no long   Yes

The Aria-assigned unique identifier of a given invoice.
client_acct_id string 50 Yes

Client-defined account identifier.

Alternative required field: acct_no
master_plan_instance_no long 22 No

The Master Subscription plan instance number. The line items in the response are filtered by the master plan instance number or client master plan instance ID

Alternative field: client_master_plan_instance_id
client_master_plan_instance_id string 100 No

Client-defined Master plan Subscription plan instance ID.

Alternative field: master_plan_instance_no
locale_no long 30 No

Specifies the language in which the information is returned.

Alternative field: locale_name
locale_name string 100 No

Name of the locale.

Alternative field: locale_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_line_details object   No

Array of invoice line items for this invoice.

See fields below
tax_details object   No

Array of Tax details for this invoice.

See fields below
is_pending_ind long   No

Note: This field is deprecated. Aria no longer supports is_pending_ind.
custom_status_label string   No

Value allowed for Client specific custom invoice status that can be edited at the invoice or pending invoice level.
custom_status_desc string   No

Description of the Client specific custom invoice status.
client_notes string   No

Client notes that are free text.
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.
from_date string   No

Note: This field is deprecated. Aria no longer supports from_date.
to_date string   No

Note: This field is deprecated. Aria no longer supports to_date.
billing_group_no long 22 No

Note: This field is deprecated. Aria no longer supports billing_group_no.
client_billing_group_no string   No

client assagined billing group number
acct_locale_no long 30 No

Note: This field is deprecated. Aria no longer supports acct_locale_no.
acct_locale_name string 100 No

Name of the account level locale.
rb_flag long   No

Indicates whether the invoice is a rebill or not. 1 = rebill, 0 or null = not a rebill.
rb_status string   No

Indicates whether the invoice was rebilled or not. Values - "True" (it was rebilled) or "False" (it was not rebilled).
orig_invoice_no long   No

Original invoice number (for a rebilled invoice). The orig invoice number is the predecessor invoice, which could be a rebill.
is_pending_ind_2 long   No

Whether or not this invoice is pending
billing_group_no_2 long   No

Aria-assigned billing group number
acct_locale_no_2 long 30 No

Aria-assigned unique identifier of the locale used for translations. This value is unique across all Aria-managed accounts.
usage_from_date string   No

Invoice usage start date.
usage_to_date string   No

Invoice usage end date.
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.
recurring_bill_from_date string   No

The recurring bill-from date.
recurring_bill_thru_date string   No

The recurring bill-through date.
invoice_payment_plan_details object   No

Array of payment plan schedule details related to an invoice

See fields below

invoice_line_details.installment_schedule_details fields

Name Type Length Required Description
notify_date string   No

Dates when customer will be notified of an installment.
notify_id long   No

Installment Due Reminder (IDR) notification ID
due_date string   No

Due dates of when individual installment is due
due_amount double   No

Amount due of each individual installment
paid_amount_to_date double   No

Paid amount of each individual installment.
remaining_installment_balance double   No

Remaining balance of each individual installment.
installment_status string   No

Status of each individual installment related to payment [Paid, Not Paid, Closed]
statement_no long   No

Statement number
installment_principal_due double   No

Installment principal due amount of each individual installment.
installment_principal_tax_due double   No

Sum of principal tax due amount of each individual installment.
installment_surcharge_due double   No

Installment surcharge due amount of each individual installment.
installment_surcharge_tax_due double   No

Sum of surcharge tax due amount of each individual installment.

invoice_line_details fields

Name Type Length Required Description
line_no long   No

The sequential line number of this line item. Initial record value is always 1.
service_no long   No

Aria-assigned unique service identifier
service_name string   No

The name corresponding to this line items service code.
units double   No

The number of units of this service code billed on this line item.
rate_per_unit double   No

The rate per unit billed
amount double   No

The total amount of this line item
description string   No

Text description of this line item
date_range_start string   No

(Deprecated) The starting date range for this line item
date_range_end string   No

(Deprecated) The ending date range for this line item
usage_type_no long   No

The usage type code associated with this line item
plan_no long 22 No

The unique plan ID associated with this line item
plan_name string   No

The name of the plan associated with this line item
credit_reason_cd long   No

The reason code associated with the credit that was applied, if any.
credit_reason_code_description string   No

The long description of the credit reason code which was applied, if any
csr_comments string   No

The manually-entered CSR comments, if any
client_sku string   No  
order_no long 22 No

The unique identifier for an order in the context of an client_no and account_no.
item_no long   No

The unique ID of the item being retrieved
client_service_id string 100 No

The unique client-defined unique service ID associated with this line item.
usage_type_cd string 100 No

An array containing usage_type_cd(s) to denote which usage type(s) to record.
client_plan_id string 100 No

The unique client-defined plan ID associated with this line item
client_item_id string 100 No

Note: This field is deprecated. Aria no longer supports client_item_id.
base_plan_units double   No

Total base unit of this invoice.
plan_units_change double   No

Total base units change from last invoice.
proration_factor double   No

Specifies the percentage of the line_base_units billed.
proration_text string 100 No

Specifies the prorated days in total days.
adv_billing_period_total_days long   No

Total days of period in this invoice.
proration_remaining_days long   No

Prorated days of period in this invoice.
proration_description string 100 No

Prorated invoice description.
line_type long   No

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 long   No

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. Another such case is the dummy zero amount line formed when net usage is negative for a usage service.
client_rate_schedule_id string 100 No

Client-defined unique identifier for the rate schedule used to generate this invoice line item.
rate_schedule_tier_no long   No

Sequential number for the rate tier associated with the rate schedule used to generate this invoice line item.
credit_coupon_code string   No

Specifies the coupon code applied to the invoice.
plan_instance_no long 22 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 string 100 No

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.
tax_related_ind long   No

Indicates whether the invoice line is related to tax. Invoice lines that are a tax charge or a credit applied to a tax charge will be returned as '1'. All other invoice lines will be returned as '0'.
svc_credit_source_invoice_no long   No

Unique number of the original invoice associated with the service credit.
svc_credit_source_line_no long   No

Line item (sequence number) from the original invoice associated with the service credit.
svc_credit_source_trans_id long   No

Aria transaction ID (aka event_no) associated with the original invoice that was the source of the service credit.
svc_credit_applied_line_no long   No

Line item (sequence number) from this invoice against which this service credit was applied.
svc_credit_applied_trans_id long   No

Aria transaction ID (aka event_no) from this invoice against which this service credit was applied.
client_acct_id string 50 No

Client-defined account identifier.
master_plan_instance_no long 22 No

The Master Subscription plan instance number.
client_mp_instance_id string 100 No

Client-defined Master plan Subscription plan instance ID.
invoice_transaction_id long 22 No

event_no for invoice line item transactions (type 21, 22).
po_num string 100 No

Purchase order number assigned to the plan instance.
bill_from_location_no long   No

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_location_no long   No

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_seq long   No

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_seq long   No

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.
rb_excluded long   No

Indicates that the original invoice line was not rebilled.
rb_line_comments string   No

Comments introduced on the rebill line.
custom_rate_ind long   No

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. Another such case is the dummy zero amount line formed when net usage is negative for a usage service.
latest_installment_no long   No

Aria assigned latest installment schedule no
installment_schedule_details object   No

Array of installment schedule details for this invoice line.

See fields below

tax_details fields

Name Type Length Required Description
tax_detail_line long   No

Line number associated with each tax detail record.
seq_num long   No

The tax line on the invoice which includes the tax amount associated with this tax_detail_line.
taxed_seq_num long   No

The invoice line item for which the tax for this tax_detail_line was calculated.
debit double   No

Amount of tax applied for the given tax type.
tax_authority_level long   No

Tax jurisdiction code: 0 = Federal, 1 = State / Province.
tax_rate double   No

Rate at which tax is calculated for the tax type used by the tax engine.
orig_was_tax_inclusive long   No

Indicates whether or not the invoice line amount was tax inclusive.
tax_srv_tax_type_id string   No

Identifier of the tax type returned by the tax engine.
tax_srv_tax_type_desc string   No

Description of the tax type returned by the tax engine.
tax_srv_cat_text string   No

Category of the tax type returned by the tax engine
tax_srv_juris_nm string   No

Jurisdiction name returned by the tax engine
tax_srv_tax_sum_text string   No

Invoice summary text returned by the tax engine.
unrounded_tax_amt double   No

The amount multiplied by tax rate before rounding precision. Also referred to as raw tax amount. *Note: Aria internal tax rounding method set to invoice.
carryover_from_prev_amt double   No

The amount that is a carryover from previous unrounded tax amt. It is remainder and value can be positive or negative based on the previous remainder. *Note: Aria internal tax rounding method set to invoice.
before_round_adjusted_tax_amt double   No

The amount adjusted Tax before rounding precision. i.e. Sum of unrounded_tax_amt, and carryover_from_prev_amt. *Note: Aria internal tax rounding method set to invoice.
carryover_from_current_amt double   No

The amount that is a carryover from current unrounded tax amt. It is remainder and value can be positive or negative based on the previous remainder. *Note: Aria internal tax rounding method set to invoice.
tax_nominal_rate double   No

Nominal Rate returned by the tax engine.

invoice_payment_plan_details fields

Name Type Length Required Description
payment_plan_no long   No

Aria-assigned payment plan no
client_payment_plan_id string   No

Client-defined unique payment plan ID
seq_no long   No

Aria assigned sequence number of a payment plan
seq_statement_no long   No

Aria-assigned statement number
seq_message_id long   No

Unique identifier of message due reminder sent
seq_notify_date string   No

The date of when customer is notified of a specific payment plan sequence
seq_due_date string   No

The due date of a specific payment plan sequence
seq_due_amount double   No

The due amount of a specific payment plan sequence
seq_paid_amount double   No

The paid amount of a specific payment plan sequence
seq_remaining_balance double   No

The remaining balance of a specific payment plan sequence
seq_status string   No

The status of a specific payment plan sequence [paid, not paid, closed]
TOP
  1. Back to top
  • Was this article helpful?

Recommended articles

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