Home > Aria Crescendo Documentation > Aria Crescendo core api > update_acct_plan_unit_instance_m
update_acct_plan_unit_instance_m
update_acct_plan_unit_instance_m
Table of contents
This API can be used to either update fulfillment, or the supplemental field(s) on the unit instances of a plan.
For information on error messages generated by this API, see update_acct_plan_unit_instance_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. | ||||||||
|
plan_unit_inst_no | long | 100 | Aria unique Plan Unit Instance Number. | ||||||||
| OR | ||||||||||||
|
client_plan_unit_inst_id | string | 100 | Client-assigned identifier for the plan unit instance. | ||||||||
| new_client_plan_unit_inst_id | string | 100 | New client-assigned identifier for the plan unit instance, which will replace the existing client-assigned identifier currently on the plan unit instance.' | |||||||||
| Start of plan_unit_instance_services array | ||||||||||||
| plan_unit_instance_services | array | Array of plan unit instance services to be updated. | ||||||||||
| Field Name | Field Type | Max Length | Description | |||||||||
 service_no |
long | 22 | Specifies the Aria-assigned unique service identifier against which fulfillment details must be captured and stored. | |||||||||
| OR | ||||||||||||
| client_service_id |
string | 100 | Client-assigned identifier for the service. | |||||||||
| service_fulfillment_date |
string | 10 | This is the service fulfillment date, which can be past, present, or future date. | |||||||||
| fulfillment_directive |
long | 1 | This derives whether the fulfillment date should be assigned/modified or removed from the fulfillment based service on then plan unit instance.
|
|||||||||
| End of plan_unit_instance_services array | ||||||||||||
| Start of plan_unit_inst_fields array | ||||||||||||
| plan_unit_inst_fields | array | Array of client-defined plan unit instance fields. | ||||||||||
| Field Name | Field Type | Max Length | Description | |||||||||
| field_name |
string | 100 | Field name of plan unit instance field | |||||||||
| field_value |
string | 1000 | The value stored under this field | |||||||||
| plan_unit_inst_directive |
long | 1 | The directive is mandatory if field name/value pair are specified.
|
|||||||||
| End of plan_unit_inst_fields array | ||||||||||||
| do_write | string | 5 | Boolean indicator that specifies whether to actually perform the requested operation. If 'false' is passed in this field, Aria calculates, if applicable, any potential effects from this call such as proration, plan assignments, etc. and return all relevant data without actually performing the requested operation or making any changes to the account. This is useful to interfaces that want to present the user with a 'confirmation page' informing them of the potential effects of the requested operation prior to actually performing it. Do_write defaults to 'true'
|
|||||||||
| proration_invoice_timing | long | 1 | Determines whether to create a separate invoice for prorated charges immediately, or defer to the next anniversary date. Note that this will override the Proration Invoice Timing configuration saved with the plan in the product catalog.
|
|||||||||
| 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. | |||||||||
| Start of optional_transaction_qualifiers array | ||||||||||||
| optional_transaction_qualifiers | array | Array of additional values you can associate with this API call. | ||||||||||
| Field Name | Field Type | Max Length | Description | |||||||||
| 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. | |||||||||
| End of optional_transaction_qualifiers array | ||||||||||||
| application_id | string | 300 | The application identifier in which the API is being used in. (Example: “Sales Force”) | |||||||||
| application_date | string | 300 | The application date/timestamp, ie. 01/01/2014 10:00:00 to track when the application called the API. | |||||||||
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. | ||||||||||||||||||||
| out_acct_no | long | Aria generated unique identifier for the account | ||||||||||||||||||||
| out_client_acct_id | string | This is the client-assigned identifier for the account. | ||||||||||||||||||||
| out_plan_unit_inst_no | long | Aria unique Plan Unit Instance Number. | ||||||||||||||||||||
| out_client_plan_unit_inst_id | string | Client-assigned identifier for the plan unit instance. | ||||||||||||||||||||
| proration_result_amount | double | The currency amount of any resulting proration action performed as a result of the fulfillment based service unit assignment. When proration is performed the value returned in this field will be a positive currency value (indicating a resulting charge to the account). If the value passed in field do_write is false then any positive value returned in this field is notational only, demonstrating what proration effect would be applied to the account if the requested fulfillment based plan unit instance were to be actually assigned. | ||||||||||||||||||||
| invoice_no | long | The Aria-assigned unique identifier of a given invoice. | ||||||||||||||||||||
| invoice_line_items | hash | |||||||||||||||||||||
| line_type |
long |
Specifies the type of charge or credit associated with this line item.
|
||||||||||||||||||||
| service_no |
long | Specifies the Aria-assigned unique service identifier. | ||||||||||||||||||||
| units |
double | Specifies the number of units of this service code billed on this line item. On a prorated invoice, line_units = line_base_units X proration_factor. | ||||||||||||||||||||
| amount |
double | Specifies the total charge associated with this line item. | ||||||||||||||||||||
| base_plan_units |
double | Specifies the full, non-prorated number of units of the service code. | ||||||||||||||||||||
| client_service_id |
string | A client defiend Service ID for this plan. | ||||||||||||||||||||
| collection_error_code | long | If a collection is attempted, returns the error code associated with the collection. | ||||||||||||||||||||
| collection_error_msg | string | The error message associated with collection_error_code. | ||||||||||||||||||||
| statement_error_code | long | The error code generated when attempting to create the statement resulting from this call, if any | ||||||||||||||||||||
| statement_error_msg | string | The text message associated with 'statement_error_code' | ||||||||||||||||||||
| proc_cvv_response | string | The processor return code from CVV validation. | ||||||||||||||||||||
| proc_avs_response | string | Processor return code from address validation | ||||||||||||||||||||
| proc_cavv_response | string | The processors return code for security validation. | ||||||||||||||||||||
| proc_status_code | string | The processor status code | ||||||||||||||||||||
| proc_status_text | string | The processors status description | ||||||||||||||||||||
| proc_payment_id | string | The processor payment id | ||||||||||||||||||||
| proc_auth_code | string | Authorization code provided by the issuing bank | ||||||||||||||||||||
| proc_merch_comments | string | Additional information passed to payment processor | ||||||||||||||||||||
| total_charges_before_tax | double | Total amount to be charged to the account before taxes have been calculated. | ||||||||||||||||||||
| total_tax_charges | double | Total taxes as calculated for the amount of the transaction. | ||||||||||||||||||||
| total_charges_after_tax | double | Total amount to be charged to the account after taxes have been calculated.' | ||||||||||||||||||||
| total_credit | double | The total amount of the credit to be applied to the account | ||||||||||||||||||||
| total_tax_credit | double | The tax amount of the credit to be applies | ||||||||||||||||||||
| total_credit_before_tax | double | The credit to be applied before tax is taken into account | ||||||||||||||||||||
| total | double | The grand total of this invoice | ||||||||||||||||||||
| expectd_monthly_rec_cost | double | The predicted monthly recurring cost of the items and plans on this invoice | ||||||||||||||||||||
| expectd_annual_rec_cost | double | The predicted annual recurring cost of the items and plans on this invoice | ||||||||||||||||||||
| third_party_errors | hash | Errors from third-party systems like taxation engines are returned here. Aria-generated error codes are returned in the error_code and error_msg fields at the root level of the API return. | ||||||||||||||||||||
| error_class |
string | Type of error code, such as taxation. | ||||||||||||||||||||
| error_code |
string | Error code returned by the third-party system. | ||||||||||||||||||||
| error_msg |
string | Error message returned by the third party system. |
- © Copyright 2022 Aria Developer Central