Home > Aria Crescendo Documentation > Aria Crescendo core api > get_invoice_details_m
get_invoice_details_m
get_invoice_details_m
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.
For information on error messages generated by this API, see get_invoice_details_m Error Messages.
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. | |
| OR | ||||
| client_acct_id | string | 50 | Client-defined account identifier. | |
| invoice_no | long | 22 | The Aria-assigned unique identifier of a given invoice. | |
| master_plan_instance_no | long | 22 | 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 | |
| OR | ||||
| client_master_plan_instance_id | string | 100 | Client-defined Master plan Subscription plan instance ID. | |
| locale_no | long | 22 | Specifies the language in which the information is returned. | |
| OR | ||||
| locale_name | string | 50 | Name of the locale. | |
| 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_details | 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 | The starting date range for this line item; for an invoice created via contract completion where the plan instance has only a usage-based service mapped to it, this is the usage period start date. | ||||||||||||||||||||
| date_range_end |
string | The ending date range for this line item; for an invoice created via contract completion where the plan instance has only a usage-based service mapped to it, this is the usage period end date. | ||||||||||||||||||||
| 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_cd |
long | The reason code associated with the credit that was applied, if any. | ||||||||||||||||||||
| 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 | Client SKU of the NSO/Inventory item. | ||||||||||||||||||||
| 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.
Allowable values for line_type:
|
||||||||||||||||||||
| rate_schedule_no |
long | Aria-assigned unique identifier for the rate schedule used to generate this invoice line item. | ||||||||||||||||||||
| client_rate_schedule_id |
string | Client-defined unique identifier for the rate schedule used to generate this invoice line item. | ||||||||||||||||||||
| rate_schedule_tier_no |
long | Sequential number for the rate tier associated with the rate schedule used to generate this invoice line item. | ||||||||||||||||||||
| credit_coupon_code |
string | Specifies the coupon code applied to the invoice. | ||||||||||||||||||||
| plan_instance_no |
long | 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. | ||||||||||||||||||||
| tax_related_ind |
long | 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 | Unique number of the original invoice associated with the service credit. | ||||||||||||||||||||
| svc_credit_source_line_no |
long | Line item (sequence number) from the original invoice associated with the service credit. | ||||||||||||||||||||
| svc_credit_source_trans_id |
long | 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 | Line item (sequence number) from this invoice against which this service credit was applied. | ||||||||||||||||||||
| svc_credit_applied_trans_id |
long | Aria transaction ID (aka event_no) from this invoice against which this service credit was applied. | ||||||||||||||||||||
| client_acct_id |
string | Client-defined account identifier. | ||||||||||||||||||||
| master_plan_instance_no |
long | The Master Subscription plan instance number. | ||||||||||||||||||||
| client_mp_instance_id |
string | Client-defined Master plan Subscription plan instance ID. | ||||||||||||||||||||
| invoice_transaction_id |
long | event_no for invoice line item transactions (type 21, 22). | ||||||||||||||||||||
| po_num |
string | Purchase order number assigned to the plan instance. | ||||||||||||||||||||
| bill_from_location_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_location_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_seq |
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_seq |
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. | ||||||||||||||||||||
| rb_excluded |
long | Indicates that the original invoice line was not rebilled. | ||||||||||||||||||||
| rb_line_comments |
string | Comments introduced on the rebill line. | ||||||||||||||||||||
| 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. | ||||||||||||||||||||
| tax_details | hash | Array of Tax details for this invoice. | ||||||||||||||||||||
| tax_detail_line |
long | Line number associated with each tax detail record. | ||||||||||||||||||||
| seq_num |
long | The tax line on the invoice which includes the tax amount associated with this tax_detail_line. | ||||||||||||||||||||
| taxed_seq_num |
long | The invoice line item for which the tax for this tax_detail_line was calculated. | ||||||||||||||||||||
| debit |
double | Amount of tax applied for the given tax type. | ||||||||||||||||||||
| tax_authority_level |
long | Tax jurisdiction code: 0 = Federal, 1 = State / Province. | ||||||||||||||||||||
| tax_rate |
double | Rate at which tax is calculated for the tax type used by the tax engine. | ||||||||||||||||||||
| orig_was_tax_inclusive |
long | Indicates whether or not the invoice line amount was tax inclusive. | ||||||||||||||||||||
| tax_srv_tax_type_id |
string | Identifier of the tax type returned by the tax engine. | ||||||||||||||||||||
| tax_srv_tax_type_desc |
string | Description of the tax type returned by the tax engine. | ||||||||||||||||||||
| tax_srv_cat_text |
string | Category of the tax type returned by the tax engine | ||||||||||||||||||||
| tax_srv_juris_nm |
string | Jurisdiction name returned by the tax engine | ||||||||||||||||||||
| tax_srv_tax_sum_text |
string | Invoice summary text returned by the tax engine. | ||||||||||||||||||||
| unrounded_tax_amt |
double |
The amount multiplied by tax rate before rounding precision. Also referred to as "raw tax amount." Note: Assuming that the client setting Aria Internal Tax Rounding Method is set to "Per invoice." |
||||||||||||||||||||
| carryover_from_prev_amt |
double |
The amount carried over from previous <unrounded_tax_amt>. It is a remainder, and its value can be positive or negative (based on the previous remainder). Note: Assuming that the client setting Aria Internal Tax Rounding Method is set to "Per invoice." |
||||||||||||||||||||
| before_round_adjusted_tax_amt |
double |
The amount of adjusted tax before rounding precision, calculated as the sum of <unrounded_tax_amt> and <carryover_from_prev_amt>. Note: Assuming that the client setting Aria Internal Tax Rounding Method is set to "Per invoice." |
||||||||||||||||||||
| carryover_from_current_amt |
double |
The amount carried over from current <unrounded_tax_amt>. It is a remainder, and its value can be positive or negative based on the previous remainder. Note: Assuming that the client setting Aria Internal Tax Rounding Method is set to "Per invoice." |
||||||||||||||||||||
| is_pending_ind | long | Whether or not this invoice is pending. DEPRECATED | ||||||||||||||||||||
| is_pending_ind_2 | 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:
|
||||||||||||||||||||
| from_date | string | Invoice start date. DEPRECATED | ||||||||||||||||||||
| to_date | string | Invoice end date. DEPRECATED | ||||||||||||||||||||
| billing_group_no | long | Aria-assigned billing group number. DEPRECATED | ||||||||||||||||||||
| billing_group_no_2 | long | Aria-assigned billing group number. | ||||||||||||||||||||
| client_billing_group_no | string | client assigned billing group number | ||||||||||||||||||||
| acct_locale_no | long | Aria-assigned unique identifier of the locale used for translations. This value is unique across all Aria-managed accounts. DEPRECATED | ||||||||||||||||||||
| acct_locale_no_2 | long | Aria-assigned unique identifier of the locale used for translations. This value is unique across all Aria-managed accounts. | ||||||||||||||||||||
| acct_locale_name | string | Name of the account level locale. | ||||||||||||||||||||
| rb_flag | long | Indicates whether the invoice is a rebill or not. 1 = rebill, 0 or null = not a rebill. | ||||||||||||||||||||
| rb_status | string | Indicates whether the invoice was rebilled or not. Values - "True" (it was rebilled) or "False" (it was not rebilled). | ||||||||||||||||||||
| orig_invoice_no | long | Original invoice number (for a rebilled invoice). The orig invoice number is the predecessor invoice, which could be a rebill. | ||||||||||||||||||||
| usage_from_date | string | The usage bill-from date of the invoice. | ||||||||||||||||||||
| usage_to_date | string | The usage bill-through date of the invoice. | ||||||||||||||||||||
| 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. |
- © Copyright 2022 Aria Developer Central