Skip to main content
Aria Knowledge Central

get_acct_installment_m

  1. Last updated
  2. Save as PDF

Summary

API Name get_acct_installment_m
Class account_services_m
Update Version 56

Description

Returns installment term details for all installment plans on an account. Installment plans allow customers to pay off a balance over multiple billing periods in fixed or variable installments rather than paying the full amount at once. This API returns each installment plan's configuration including the total balance, number of installments, installment amounts, schedule dates, and current payment progress. To view payment plans (a related but distinct concept), use get_payment_plan_list_m. To cancel an installment plan, use cancel_acct_installment_m. To modify installment terms, use update_acct_installment_m.

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
include_all_installment_statuses string 5 No

Include all installment statuses (Completed, Cancelled, Discontinued) not only Active in the search results. Allowable values are: TRUE or FALSE. If it's null, by default is set to FALSE. Ignored when installment_no is passed.

Allowed values:

Value Description
true show all installment statuses
false show only active installments
installment_no long   No

Aria assigned installment schedule no

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_balance double   No

Sum total of all installment balances
installment_past_due double   No

Sum total of all past due balances
installment_term_details object   No

array of details about this account's installment terms

See fields below

installment_term_details.installment_schedule_details fields

Name Type Length Required Description
notify_date string   No

Date when customer will be notified of an installment. For aligned installment the notify dates follow master plan instance anniversary invoice bill dates.
notify_id long   No

Installment Due Reminder (IDR) notification ID
due_date string   No

Due date of when individual installment is due. For aligned installment the due dates follow master plan instance anniversary invoice due dates.
due_amount double   No

Amount due of each individual installment.
paid_amount_to_date double   No

Paid amount of each individual installment.
remaining_installment_balance double   No

Remaining balance of each individual installment.
installment_status string   No

Status of each individual installment related to payment. Statuses are Paid, Not Paid, Closed. Closed status applies to the rest of installment balance when an installment schedule is cancelled.
statement_no long   No

Statement number
installment_principal_due double   No

Installment principal due amount of each individual installment.
installment_principal_tax_due double   No

Sum of principal tax due amount of each individual installment.
installment_surcharge_due double   No

Installment surcharge due amount of each individual installment.
installment_surcharge_tax_due double   No

Sum of surcharge tax due amount of each individual installment.

installment_term_details.previous_installment_no_list fields

Name Type Length Required Description
previous_installment_no long   No

previous Aria assigned installment schedule no

installment_term_details fields

Name Type Length Required Description
installment_no long   No

Aria assigned installment schedule no
installment_term_no long   No

Aria assigned installment term no
client_installment_term_id string   No

Specifies client installment term ID
installment_term_name string   No

Specifies installment term name
installment_description string   No

Installment term description
aligned_installment string   No

Aligned installment schedule with existing master plan instance. If aligned, installment amount will be charged along with master plan instance anniversary invoice/statement. Allowable values are - Yes (Y) - Aligned with existing master plan instance OR No (N) - Its own installment schedule and due dates.
term_type string   No

M (Months), W (Weeks), D (Days). If Null, will be treated as Months
term_length long   No

Installment term length. For example if interval type is M (Monthly), if users enter 36, then installment period is 36 months.
installment_term_interval long   No

Installment interval, works jointly with terms type. For example - 2 on interval and months in terms type mean installment is due every 2 months. If defined, must be less than terms length.
days_to_start long   No

Applicable only when aligned_installment is No (N) - Its own installment schedule and due dates. Determines how many days after a purchase or subscription date that the first installment will start. For example: if 5 is passed, then 5 days after a purchase date 1st installment will start. If 0 is passed, then 1st installment will start on purchase date.
days_til_due long   No

Applicable only when aligned_installment is No (N) - Its own installment schedule and due dates. Determines how many days after customer is notified on the installment that it's due. For example: If 5 is passed, then 5 days after customers are notified, the installment will be due.
create_date string   No

Date when installment assigned to an account
invoice_date string   No

Date of invoice
invoice_no long   No

Aria-assigned unique identifier of a given invoice
paid_to_date double   No

Installment paid amount to date (at the time of API call), includes tax and surcharge.
remaining_balance double   No

Installment remaining balance to date (at the time of API call), includes tax and surcharge.
past_due double   No

Installment past due amount, includes tax and surcharge.
installment_schedule_status string   No

Installment status related to payments (Active, Completed, Cancelled, Discontinued)
charge_amount double   No

charge amount on installment plan
tax_amount double   No

tax amount on installment plan
lump_sum_type string   No

Lump sum type determines type of charges to be considered as a lump sum. Allowable values are: P - for proportionately split charge/tax; T - for purchase tax only.
lump_sum_amount double   No

A one-time amount that will reduce the total installment to be spread over the course of installment term. Applicable only when lump sump type is proportionately split (lump_sum_type = P).
aligned_lump_sum long   No

Determines when to notify customers of the lump sum. Applicable only for aligned installment (aligned_installment = Y). Allowable values are: 0 - Aligned with when an invoice is created; 1 - Aligned with the 1st installment
lump_sum_days long   No

Determines 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 (aligned_installment = N).
lump_sum_days_until_due long   No

Applicable for both type of installments. Determines how many days after customers are notified that a lump sum is due.
status_change_date string   No

the date that installment status is updated
comments string   No

additional comments regarding status updates
order_no long 22 No

The unique identifier for an order in the context of a client_no and account_no
billing_group_no long 22 No

Billing Group Number
client_billing_group_id string 100 No

The billing group's client assigned identifier
master_plan_instance_no long 22 No

The Master Subscription plan instance number
client_master_plan_instance_id string 100 No

Client-defined Master plan Subscription plan instance ID
total_amount double   No

Total amount on installment, includes tax and surcharge.
invoice_line_total_amount double   No

Invoice line total amount after service credit and discount, inclusive of tax. Excludes surcharge.
surcharge_amount double   No

Total surcharge amount.
surcharge_tax_amount double   No

Total surcharge tax amount.
installment_schedule_details object   No

Array for details about the individual installments on an installment schedule.

See fields below
previous_installment_no_list object   No

A list of previous Aria assigned installment schedule no

See fields below
TOP
  1. Back to top
  • Was this article helpful?

Recommended articles

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