Home > Aria6 User Documentation > Aria6 object query api > get_invoice_details

get_invoice_details

Returns the line items of a specified invoice.

Note: The previously existing input and/or output fields <client_item_id>, <client_item_id_out> and/or <filter_client_item_id> were removed from this API call in Release 47.

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.
acct_no long 22 Aria-assigned account identifier. This value is unique across all Aria-managed accounts.
src_transaction_id long 38 Either the Aria transaction ID or the Aria invoice number for the invoice
  alt_caller_id string 30 Person or process that submitted the API call. This can be someone's user ID, or the name of an application.
  optional_transaction_qualifiers array   Array of additional values you can associate with this API call.
  qualifier_name string 100 Name of the field you want to associate with this API call.
  qualifier_value string 100 Corresponding value of the field you want to associate with this API call.
 

Output Arguments

Field Name Field Type Description
error_code long Aria-assigned error identifier. 0 indicates no error.
error_msg string Description of any error that occurred. "OK" if there was no error.
invoice_line_items hash Array of invoice line items for this invoice.
 line_no long The sequential line number of this line item. Initial record value is always 1.
 service_no long Aria-assigned unique service identifier
 service_name string The name corresponding to this line items service code.
 units double The number of units of this service code billed on this line item.
 rate_per_unit double The rate per unit billed
 amount double The total amount of this line item
 description string Text description of this line item
 date_range_start string (Deprecated) The starting date range for this line item
 date_range_end string (Deprecated) The ending date range for this line item
 usage_type_no long The usage type code associated with this line item
 plan_no long The unique plan ID associated with this line item
 plan_name string The name of the plan associated with this line item
 credit_reason_code_description string The long description of the credit reason code which was applied, if any
 csr_comments string The manually-entered CSR comments, if any
 client_sku string The client-defined item identifier
 order_no long The unique identifier for an order in the context of an client_no and account_no.
 item_no long The unique ID of the item being retrieved
 client_service_id string The unique client-defined unique service ID associated with this line item.
 usage_type_cd string An array containing usage_type_cd(s) to denote which usage type(s) to record.
 client_plan_id string The unique client-defined plan ID associated with this line item
 base_plan_units double Total base unit of this invoice.
 proration_factor double Specifies the percentage of the line_base_units billed.
 proration_text string Specifies the prorated days in total days.
 adv_billing_period_total_days long Total days of period in this invoice.
 proration_remaining_days long Prorated days of period in this invoice.
 proration_description string Prorated invoice description.
 line_type long Specifies the type of charge or credit associated with this line item.
Values Description
1 Recurring Charge
2 Tax Charge
3 Service Credit
4 Coupon Credit
5 Activation Charge
6 Usage Charge
7 Recurring Arrears
8 Order Charge
9 Surcharge
 rate_schedule_no long Aria-assigned unique rate schedule number
 rate_schedule_tier_no long Sequential number in the rate schedule for dertermining tiers
 credit_coupon_code string Specifies the coupon code applied to the invoice.
is_pending_ind long Whether or not this invoice is pending
custom_status_label string Value allowed for Client specific custom invoice status that can be edited at the invoice or pending invoice level.
custom_status_desc string Description of the Client specific custom invoice status.
client_notes string Client notes that are free text.
invoice_type_cd string This field identifies the type of the invoice generated 

Allowable values for invoice_type_cd

Values Description
C Combined Invoice
F Anniversary Period Invoice
H Hybrid Invoice
O Order based Invoice
P Non-anniversary Subscription Invoice
R Rebill Invoice
from_date string Invoice start date.
to_date string Invoice end date.
posting_status_cd long Posting status of an invoice 

Allowable values for posting_status_cd

Values Description
0 Unposted
1 Posted
posting_user string The user who manual posted this invoice. If set to "System" then the invoice was auto posted by the system.
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.
 
 
 
Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.
Powered by CXone Expert ®