Skip to main content
Aria Knowledge Central

update_acct_installment_m

  1. Last updated
  2. Save as PDF

Summary

API Name update_acct_installment_m
Class account_services_m
Update Version 62

Description

Updates the installment attributes for a specified account. Fields not included in the update will retain their existing values. If the update changes the number of installments or installment amounts, a new installment schedule will be created. Otherwise, the original installment schedule number will be retained, and only installments that have not been communicated will be updated.

Inputs

Name Type Length Required Description
client_no long 22 Yes

Aria-assigned unique identifier indicating the Aria client providing service to this account.
auth_key string 32 Yes

Aria-assigned unique key for authenticating the validity of the requestor. This key is passed with each method call.
acct_no long 22 Yes

Aria-assigned account identifier. This value is unique across all Aria-managed accounts.

Alternative required field: client_acct_id
client_acct_id string 50 Yes

Client-defined account identifier.

Alternative required field: acct_no
installment_no long 22 Yes

Aria assigned installment schedule no.
effective_date string 10 No

Date on which the installment will be updated, in yyyy-mm-dd format. If null, it will be treated as immediate.
installment_amount double   No

The individual installment amount, inclusive of tax. For example, if a purchase is taxed at 15%, a $20 installment amount will be split into $17.39 (charge) and $2.61 (tax). The total tax-inclusive purchase amount will be divided by this amount to calculate the length of installment. Note: If this field is provided, the installment_term_length field will be ignored.

Alternative field: installment_term_length
installment_term_length long   No

The installment term length for the assigned installment. For independent installment the input will be used jointly with the interval type. For aligned installment, this will be the number of statements that the installment amount will be part of.

Alternative field: installment_amount
installment_term_type string 1 No

Specifies the installment term type for the assigned installment. Allowable values are: M (Months), W (Weeks), D (Days).
installment_interval long   No

Specifies the installment interval and work jointly with installment term type. Applicable only for independent installment.
installment_days_until_due long   No

Specifies the number of days until due for the independent installment. Determines how many days after customer is notified on the installment that it's due. If 5 is passed, then 5 days after customers are notified, the installment will be due.
installment_lump_sum_type string 1 No

Specifies the installment lump sum type for the assigned installment. Allowable values are: P - for proportionately split charge/tax; T - for purchase tax only.
installment_lump_sum_amount double   No

Specifies the lump sum amount, mandatory when lump sump type is proportionately split (lump_sum_type = P).
installment_aligned_lump_sum long   No

Specifies when to notify customers of the lump sum, applicable only for aligned installment. Allowable values are: 0 - Aligned with when an invoice is created; 1 - Aligned with the 1st installment.
installment_lump_sum_days long   No

Specifies how many days after a purchase or invoice date that a lump sum is charged and be notified to customers, applicable only for independent installment.
installment_lump_sum_days_until_due long   No

Specifies the lump sum days until due, applicable for both types of installment. Determines how many days after customers are notified that a lump sum is due.
installment_comments string 500 No

Additional explanatory text relating to the update.
installment_master_plan_instance_no long 22 No

The unique identifier of the existing master plan instance that will be associated with the installment.

Alternative field: installment_client_master_plan_instance_id
installment_client_master_plan_instance_id string 100 No

The client-defined identifier of the existing master plan instance that will be associated with installment.

Alternative field: installment_master_plan_instance_no
do_write string 5 No

Boolean indicator that specifies whether to actually perform the requested operation. If 'false' is passed in this field, Aria calculates, any potential effects from this call such as last installment amount 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. Installment_do_write defaults to 'true'.

Allowed values:

Value Description
True  
False  
last_installment_amount_threshold long   No

Specifies the percentage used to calculate the allowable additional amount for the last installment's threshold. For example: If the installment amount is $50 and the remainder is $80, with 0%, the remainder is split into $50 and $30 (last installment). With 90%, the allowable additional amount is $45, making the last installment threshold $95. In this case, the last installment amount will be $80. If set to NULL, it defaults to 0%. Valid values are 0 to 99.

Outputs

Name Type Length Required Description
error_code long   No

Aria-assigned error identifier. 0 indicates no error.
error_msg string   No

Description of any error that occurred. "OK" if there was no error.
installment_schedule_info object   No

Installment schedule info array.

See fields below

installment_schedule_info fields

Name Type Length Required Description
installment_no long   No

Aria assigned installment schedule no.
seq_no long   No

Aria assigned seq schedule no.
notify_date string   No

Dates when customer will be notified of an installment.
due_date string   No

Due dates of when individual installment is due.
due_amount double   No

Amount due of each individual installment.
TOP
  1. Back to top
  • Was this article helpful?

Recommended articles

  1. Page type
    Topic
  2. Tags
    This page has no tags.