Skip to main content
Aria Knowledge Central

get_payment_plan_details_m

  1. Last updated
  2. Save as PDF

Summary

API Name get_payment_plan_details_m
Class account_services_m
Update Version 72

Description

Returns the full details and schedule for a specific payment plan on an account. Payment plans allow customers to pay outstanding balances in installments over multiple billing periods. This API returns the plan's configuration (type, total amount, number of installments, frequency), current status, and the individual installment schedule showing each payment's amount, due date, and payment status (paid, pending, or missed). Specify the payment plan by payment_plan_no or client_payment_plan_id. To list all payment plans on an account first, use get_payment_plan_list_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
payment_plan_no long 22 Yes

Aria-assigned payment plan no.

Alternative required field: client_payment_plan_id
client_payment_plan_id string 100 Yes

Client unique payment plan id.

Alternative required field: payment_plan_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.
payment_plan_schedule_details object   No

Payment plan details.

See fields below
initial_balance double   No

Specifies the balance to be paid by the payment plan at time of payment plan creation.
remaining_balance double   No

Specifies the remaining balance to be paid by the payment plan at the time of the API call.
paid_amount double   No

The paid amount of payment plan at the time of the API call.
payment_plan_create_date string   No

Date when payment plan created.
payment_plan_name string   No

Payment plan name.
payment_plan_description string   No

Payment plan description.
client_billing_group_id string 100 No

Client-defined billing group ID.
payment_plan_client_payment_method_id string   No

Client-defined ID for this payment method. If null, payment method or payment term associated with the billing group will be used.
payment_plan_status string   No

Specifies the status of payment plan (active, completed, or cancelled).
payment_method_no long 22 No

Payment method number associated with the Payment Plan. If null, payment method or payment term associated with the billing group will be used.

payment_plan_schedule_details.payment_plan_seq_transaction_list fields

Name Type Length Required Description
transaction_create_date string   No

The creation datetime of this transaction.
transaction_id long   No

Unique transaction ID.
invoice_no long   No

The Aria-assigned unique identifier for invoices. Supports both self-pay and parent-pay invoice types.
plan_instance_no long   No

Aria-assigned account's plan instance number.
client_plan_instance_id string   No

Client unique id of account's plan instance.
client_plan_instance_name string   No

Plan instance name.
transaction_due_amount double   No

The transaction due amount of a specific payment plan sequence.
transaction_paid_amount double   No

The transaction paid amount of a specific payment plan sequence.
transaction_remaining_balance double   No

The transaction remaining balance of a specific payment plan sequence.
child_acct_no long   No

Aria-assigned account identifier.
child_client_acct_id string   No

Client defined account identifier.

payment_plan_schedule_details.payment_plan_seq_applied_payment_list fields

Name Type Length Required Description
payment_trans_type long   No

Specifies the payment transaction type number.
transaction_id long   No

Aria-assigned identifier for this transaction.
applied_payment_amount double   No

Payment applied amount.
date_applied string   No

Payment application date.
client_receipt_id string 50 No

Client-defined unique identifier used to track related system actions.
client_payment_method_id string   No

Client-defined ID for this payment method.
payment_method_no long 22 No

Aria-assigned sequence number for this payment method.

payment_plan_schedule_details fields

Name Type Length Required Description
seq_no long   No

Aria assigned sequence number of a payment plan
seq_notify_date string   No

The date of when customer is notified of a specific payment plan sequence.
seq_due_date string   No

The due date of a specific payment plan sequence.
seq_due_amount double   No

The principal amount due for a payment plan sequence.
seq_fee_due double   No

The fee amount due for a payment plan sequence.
seq_total_due double   No

The total amount due for a payment plan sequence (principal + fee).
seq_remaining_due double   No

The remaining principal amount due for a payment plan sequence.
seq_fee_remaining_due double   No

The remaining fee amount due for a payment plan sequence.
seq_paid_amount double   No

The total amount paid for a payment plan sequence, including fees.
seq_remaining_balance double   No

The remaining balance for a payment plan sequence, including fees.
seq_status string   No

The status of a specific payment plan sequence [paid, not paid, closed].
payment_plan_seq_transaction_list object   No

A list of transactions associated with a payment plan sequence.

See fields below
payment_plan_seq_applied_payment_list object   No

A list of payments (including credit memo and cash credit) applied to payment plan sequence.

See fields below
seq_statement_no long   No

Aria-assigned statement number for a payment plan sequence.
seq_message_id long   No

Unique identifier of message due reminder sent for a payment plan sequence.
TOP
  1. Back to top
  • Was this article helpful?

Recommended articles

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