Home > Aria Crescendo Documentation > Aria Crescendo core api > gen_invoice_m
gen_invoice_m
gen_invoice_m
This API generates invoices for specified master plan instance, a specific billing group under an account, or for all the billing groups under the account. If a master plan instance has a pending invoice, no other invoice can be applied to the master plan instance until the current pending invoice is approved. An invoice does not generate if the master plan instance billing date is in the future.
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 gen_invoice_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. | |||||||||
| master_plan_instance_no | long | 22 | The master subscription plan instance number. | |||||||||
| client_master_plan_instance_id | string | 100 | Client-defined master plan subscription plan instance ID. | |||||||||
| billing_group_no | long | 22 | Billing group number | |||||||||
| client_billing_group_id | string | 100 | Client-defined unique identifier for billing group | |||||||||
| force_pending | string | Determines whether to create the invoice as a pending invoice (if client is not already configured to do so). Note: If the client is configured for pending invoices, passing "false" here will NOT override the client setting. In addition, an invoice_mode value of 1 also overrides this setting.
Allowable values for force_pending:
|
||||||||||
| client_receipt_id | string | 50 | Client-defined unique identifier used to track related system actions | |||||||||
| alt_bill_day | long | 2 | Number specifying a day of the month to use as an alternate bill day. You can enter a bill date other than the anniversary date in this field. The invoice_mode must be set to 0 or must be blank to enter a date in this field, it cannot be set to 1. | |||||||||
| invoice_mode | long | 1 | For generating advance invoices. Use 0 for the current cycle and 1 for advanced cycle. | |||||||||
| combine_invoices | long | 1 | Indicator for combining invoices when retroactive start dates, negative bill lag days, or plan changes just prior to the next billing date would otherwise generate multiple invoices. The allowable values are 1, 2, or 3.
Allowable values for combine_invoices:
|
|||||||||
| 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. | |||||||||
| alt_client_acct_group_id | string | 100 |
One-time collection group to use for this specific call. The default collection group to which the account belongs or the collection group assigned to a billing group will not be changed. (DEPRECATED) |
Output Arguments
| Field Name | Field Type | 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. | ||||||||||||||||||||
| invoice_no | long | Aria-assigned unique identifier of the invoice generated. Note that if multiple invoices are generated, this parameter is null and details for all invoices are returned in the out_invoices array. | ||||||||||||||||||||
| out_acct_no | long | Aria-assigned unique identifier of the account. This value is unique across all Aria-managed accounts. | ||||||||||||||||||||
| out_client_acct_id | string | The client-defined identifier of the account. | ||||||||||||||||||||
| out_billing_group_no | long | Aria-assigned unique identifier of the billing group associated with the invoice generated. Note that if multiple invoices are generated, this parameter will be null and details for all invoices will be returned in the out_invoices array. | ||||||||||||||||||||
| out_client_billing_group_id | string | The client-defined identifier of the billing group associated with the invoice generated. Note that if multiple invoices are generated, this parameter will be null and details for all invoices will be returned in the out_invoices array. | ||||||||||||||||||||
| third_party_errors | hash | Errors from third-party systems like taxation engines are returned in this array. Aria-generated error codes are returned in the error_code and error_msg fields at the root level of the API return. Note that if multiple invoices are generated, parameters in this array will be null and details for all invoices will be returned in the out_invoices array. | ||||||||||||||||||||
| error_class |
string | The type of error code being represented, such as taxation. | ||||||||||||||||||||
| error_code |
string | The error code returned by the third party system. | ||||||||||||||||||||
| error_msg |
string | The error message returned by the third party system. | ||||||||||||||||||||
| out_invoices | hash | (DEPRECATED) | ||||||||||||||||||||
| out_invoices_list | hash | List of invoice-related details | ||||||||||||||||||||
| invoicing_error_code |
long | The error code generated by Aria when Aria attempted to generate a invoice. | ||||||||||||||||||||
| invoicing_error_msg |
string | The text message associated with 'invoicing_error_code'. | ||||||||||||||||||||
| invoice_no |
long | The Aria-assigned unique identifier of a given invoice. | ||||||||||||||||||||
| billing_group_no |
long | Aria-assigned unique identifier of the billing group associated with the invoice generated. | ||||||||||||||||||||
| client_billing_group_id |
string | The client-defined identifier of the billing group associated with the invoice generated. | ||||||||||||||||||||
| invoice_charges_before_tax |
double | Total of charges before tax for the invoice. | ||||||||||||||||||||
| invoice_tax_charges |
double | Total of tax charges for the invoice. | ||||||||||||||||||||
| invoice_charges_after_tax |
double | Total of all charges including tax for the invoice. The sum of invoice_charges_before_tax and invoice_tax_charges. | ||||||||||||||||||||
| invoice_credit_amount |
double | Total of all credits for the invoice. | ||||||||||||||||||||
| invoice_total_amount |
double | Total of all charges and all credits for the invoice. The sum of invoice_charges_after_tax net of invoice_credit_amount. | ||||||||||||||||||||
| invoice_items |
hash | List of invoice line items. | ||||||||||||||||||||
| invoice_line_no |
long | The line number on the invoice. | ||||||||||||||||||||
| plan_no |
long | Aria-assigned unique identifier of the plan associated with the invoice line item. | ||||||||||||||||||||
| client_plan_id |
string | Client-defined identifier of the plan associated with the invoice line item. | ||||||||||||||||||||
| plan_instance_no |
long | Aria-assigned unique identifier of the plan instance associated with the invoice line item. | ||||||||||||||||||||
| client_plan_instance_id |
string | Client-defined identifier of the plan instance associated with the invoice line item. | ||||||||||||||||||||
| plan_name |
string | Name of the plan associated with the invoice line item. | ||||||||||||||||||||
| service_no |
long | Aria-assigned unique identifier of the service associated with the invoice line item. | ||||||||||||||||||||
| client_service_id |
string | Client-defined identifier of the service associated with the invoice line item. | ||||||||||||||||||||
| service_name |
string | Name of the service associated with the invoice line item. | ||||||||||||||||||||
| service_coa_id |
long | Chart of Accounts identifier for the service associated with the invoice line item. | ||||||||||||||||||||
| client_service_coa_code |
string | Client-defined identifier of the Chart of Accounts for the service associated with the invoice line item. | ||||||||||||||||||||
| units |
double | Number of units of the item or service on the invoice line item. | ||||||||||||||||||||
| rate_per_unit |
double | Charge per unit of the item or service on the invoice line item. | ||||||||||||||||||||
| line_amount |
double | Subtotal amount of the invoice line item. | ||||||||||||||||||||
| line_description |
string | Long description of the invoice line item, used when printing or otherwise displaying invoices. | ||||||||||||||||||||
| start_date_range |
string | The starting date for the item or service on the invoice line item. | ||||||||||||||||||||
| end_date_range |
string | The ending date for the item or service on the invoice line item. | ||||||||||||||||||||
| line_type |
long | Specifies the type of charge or credit associated with this line item.
Allowable values for line_type:
|
||||||||||||||||||||
| base_plan_units |
double | Specifies the full, non-prorated number of units of the service code. | ||||||||||||||||||||
| proration_factor |
double | Specifies the percentage of the line_base_units billed. | ||||||||||||||||||||
| proration_text |
string | Specifies the prorated days in total days. | ||||||||||||||||||||
| proration_remaining_days |
long | Prorated days of period in this invoice. | ||||||||||||||||||||
| proration_description |
string | Prorated invoice description. | ||||||||||||||||||||
| credit_coupon_code |
string | Specifies the coupon code applied to the invoice. | ||||||||||||||||||||
 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. | ||||||||||||||||||||
| adv_billing_period_total_days |
long | Total days of period in this invoice. | ||||||||||||||||||||
| rate_schedule_no |
long | Aria-assigned unique rate schedule number. | ||||||||||||||||||||
| rate_schedule_tier_no |
long | Sequential number in the rate schedule for determining tiers. | ||||||||||||||||||||
| 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. | ||||||||||||||||||||
| 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. | ||||||||||||||||||||
| tax_details |
hash | List of tax details for the 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." |
||||||||||||||||||||
| third_party_errors |
hash | Errors from third-party systems like taxation engines are returned in this array. Aria-generated error codes are returned in the error_code and error_msg fields at the root level of the API return. Note that if multiple invoices are generated, parameters in this array will be null and details for all invoices will be returned in the out_invoices array. | ||||||||||||||||||||
| error_class |
string | The type of error code being represented, such as taxation. | ||||||||||||||||||||
| error_code |
string | The error code returned by the third party system. | ||||||||||||||||||||
| error_msg |
string | The error message returned by the third party system. |
- © Copyright 2023 Aria Developer Central