The gen_rb_m API executes the rebill process against the specified invoice. It creates a credit memo to offset the charges in the original invoice. Then it creates a new rebill invoice using the changes specified in the <rb_line_items> array.
|
API Specification:
|
gen_rb_m
|
|
Required Fields:
|
- <client_no>
- <auth_key>
- <acct_no> or <client_acct_id>
- <orig_invoice_no>
- <reason_cd>
- <rb_line_items> (array)
- <line_no>
- <service_no> or <client_service_id>
|
| Sample Call and Response: |
gen_rb_m Sample Call and Response |
Additional Guidance
Input Fields
| <rb_line_items> |
If sending multiple line items, you must send the line items in ascending order using the line_no field in the rb_line_items array for the tax line items to be calculated correctly.
|
| <do_collect> |
Allowable Values
| Values |
Description |
| true |
true |
| false |
false |
|
| <do_write> |
Allowable Values
| Values |
Description |
| true |
The requested operation will be performed |
| false |
The requested operation will not be performed |
|
Output Fields
<invoice_items> (array)
<unrounded_tax_amt>
|
Assuming that the client setting Aria Internal Tax Rounding Method is set to "Per invoice."
|
<carryover_from_prev_amt>
|
Assuming that the client setting Aria Internal Tax Rounding Method is set to "Per invoice." |
<before_round_adjusted_tax_amt>
|
Assuming that the client setting Aria Internal Tax Rounding Method is set to "Per invoice." |
<carryover_from_current_amt>
|
Assuming that the client setting Aria Internal Tax Rounding Method is set to "Per invoice." |
| <line_type> |
Allowable Values
| 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 |
|
Non-public API fields are for internal use only and should not be disclosed to clients.
| Field Name |
Notes |
| <include_usage_fields> |
Use this field to include usage fields with usage records. |
| <proc_pmt_resp_fld_invoice_no> |
Field name of various response returned by the processor, example: micro_deposit_verify_url. |
| <usage_field> |
Client-defined values specific to usage records. |
Error Codes
| Error Code/Description |
Associated Inputs |
|
|
|
1010: missing required parameters, Missing input: (object-name) is required with assignment_directive ($AriaNo)
|
|
3073: Invalid invoice. The original invoice has been rebilled
|
|
3074: Invalid invoice. The original invoice has been voided
|
|
3075: Invalid invoice. The original invoice has been written off
|
|
3078: Invalid invoice. The original invoice has been subject to one or more reversal transactions
|
|
3079: Invalid invoice. One or more Master Plan Instances on the original invoice have moved to another billing group
|
|
3080: Invalid line. Line_no must refer to line details from the original invoice
|
|
3082: Invalid line. Line_no must refer to a non-tax charge line
|
|
3085: Cannot modify service to one belonging to a different service type
|
|
3086: Invalid tax inputs. Tax address fields not populated on the original invoice must not be populated during rebill
|
|
3087: Invalid tax inputs. All tax address fields populated on the original invoice must be populated during rebill
|
|
|
|
|
3089: Unable to create rebill line. Rb_units is required for recurring, order_based, and usage_based services
|
|
3092: Invalid amount. Only zero and positive invoice line amounts are supported
|
|
3094: An invoice line cannot be entered more than once in the input.
|
|
3117: A ($action) cannot be performed since this invoice contains usage with either, precalculated taxes, or taxes calculated at the individual record level.
|
|
3123: Unable to create rebill invoice. The total credits and discounts on a charge line cannot exceed the charge line amount.
|
|
14107: Invalid Service Number.
|
|
25001: failed to calculate taxes
|
|
29001: The service location provided is not valid.
Additional Comments: The given service location is not available for the client.
|
|
