Skip to main content
Aria Knowledge Central

get_acct_statement_all_m

  1. Last updated
  2. Save as PDF

Summary

API Name get_acct_statement_all_m
Class account_services_m
Update Version 74

Description

Returns the list of all statements on an account for all the master plan instances or a specified master plan instance, statement, statement sequence string, secondary statement sequence string, or invoice associated with the account.

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
master_plan_instance_id long 22 No

The Master Subscription plan instance number.

Alternative field: client_master_plan_instance_id
client_master_plan_instance_id string 100 No

Client-defined Master plan Subscription plan instance ID.

Alternative field: master_plan_instance_id
statement_no long 22 No

The unique, Aria-assigned statement number with which an invoice is associated.

Alternative field: invoice_no, acct_statement_seq_str, or second_acct_statement_seq_str
invoice_no long 22 No

The Aria assigned ID of the invoice.

Alternative field: statement_no, acct_statement_seq_str, or second_acct_statement_seq_str
acct_statement_seq_str string 100 No

Client-defined statement identifier.

Alternative field: statement_no, invoice_no, or second_acct_statement_seq_str
second_acct_statement_seq_str string 100 No

Additional client-defined statement identifier.

Alternative field: statement_no, invoice_no, or acct_statement_seq_str
include_balance_transfer_details long 1 No

Determines whether or not the balance_transfer_details array is included in the return. Default is 0.

Allowed values:

Value Description
0 (Default) The balance_transfer_details array will not be included in the return.
1 The balance_transfer_details array will be included in the return.

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.
Start of statement_all object
statement_all object   No  
Name Type Length Required Description
▶billing_group_no long 22 No

Billing group number mapped to a master plan instance.
▶client_billing_group_id string 100 No

Client defined billing group ID.
▶payment_method_type long 8 No

Aria supported payment method type.
▶primary_payment_method_name string 100 No

Pay Method Name from Pay Methods configuration.
▶primary_payment_method_no long   No

Primary payment method number.
▶client_primary_payment_method_id string   No

The client-defined billing primary payment method ID.
▶secondary_payment_method_name string 100 No

Pay Method Name from Pay Methods configuration.
▶secondary_payment_method_no long   No

Secondary payment method number.
▶client_secondary_payment_method_id string   No

The client-defined billing secondary payment method ID.
▶client_payment_term_id string 32 No

Client Payment Term ID from Payment Terms configuration.
▶payment_terms_name string 50 No

Payment Terms Name from Payment Terms configuration.
▶payment_terms_no long 22 No

Payment Terms Number from Payment Terms configuration.
▶payment_terms_type string 50 No

Payment Terms Type from Payment Terms configuration (e.g. Net Terms or EAN/GLN).
▶statement_no long   No

The unique, Aria-assigned statement number with which an invoice is associated.
▶acct_statement_seq_str string   No

Client-defined invoice identifier. This may be a combination of elements such as the customer's ISO country code and the statement number, depending on your client configuration. Please contact Aria Customer Support for information and setup related to client-defined invoice numbering.
▶second_acct_statement_seq_str string   No

Additional client-defined invoice identifier. This may be a combination of elements such as the customer's bank account number and the statement number, depending on your client configuration. Please contact Aria Customer Support for information and setup related to client-defined invoice numbering.
▶currency_cd string   No

The 3-character ISO-compliant currency code in lowercase for monetary values used in the context of this API method.
▶invoice_no long 22 No

The Aria assigned ID of the invoice.
▶due_date string   No

The date monies are due.
▶due_date_plus_grace_period string   No

The date monies are due calculated to include any grace period.
▶bill_date string   No

The date the invoice was billed.
▶recurring_bill_from_date string   No

The recurring bill-from date.
▶recurring_bill_thru_date string   No

The recurring bill-through date.
▶usage_bill_from_date string   No

The usage bill from date.
▶usage_bill_thru_date string   No

The usage bill-through date of the invoice.
▶paid_date string   No

The date the invoice was paid.
▶invoice_due_amount double   No

The outstanding amount due on the invoice after discounts and service credits have been applied, including any installment due on the invoice (if any) at the time the statement was generated.
▶invoice_amount double   No

The net total amount billed, after applying any discounts and service credits, at the time the statement was generated.
▶invoice_due_balance double   No

Invoice due balance after discounts, service credits, payments and cash credit at the time of statement generated.
▶balance_forward double   No

Invoice balance carried forward to the next billing period. Excludes non-invoice transactions (i.e. dunning charges, balance transfer)
▶statement_balance_forward double   No

Previous balance on an account that was carried over to the next billing period which includes non-invoice transactions (i.e. dunning charges, balance transfer)
▶statement_installment_due double   No

The total amount of any new instalments due on this statement.
▶statement_total_due double   No

Total amount due on the statement, including new invoice, installments due, payment plans due and prior balance forward. Excludes installment and payment plan charges with a future notification date.
Start of installment_on_statement_details object
▶installment_on_statement_details object   No

Aligned installment detail on statement array.
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.
▶▶invoice_no long   No

The Aria assigned ID of the invoice.
▶▶invoice_bill_date string   No

The date the invoice with installment was billed.
▶▶installment_seq_no long   No

Installment sequence number.
▶▶installment_due_amount double   No

Original amount due of each individual installment.
▶▶installment_due_balance double   No

Installment due balance after payment and cash credit at the time of statement generated.
End of installment_on_statement_details object
▶statement_payment_plan_due double   No

Sum of payment plan balances due on this statement, aggregated from payment_plan_seq_due_balance for each sequence.
Start of payment_plan_on_statement_details object
▶payment_plan_on_statement_details object   No

Details of payment plan sequences associated with this statement.
Name Type Length Required Description
▶▶payment_plan_no long   No

Aria-assigned payment plan number.
▶▶client_payment_plan_id string   No

Client-defined unique payment plan ID.
▶▶payment_plan_seq_no long   No

Sequential number within the payment plan.
▶▶payment_plan_seq_due_amount double   No

Original scheduled due amount for a payment plan sequence, before payments or credits are applied.
▶▶payment_plan_seq_due_balance double   No

Outstanding balance for a payment plan sequence as of statement generation, after applying all existing payments and credits.
End of payment_plan_on_statement_details object
▶custom_filename string 255 No

Custom PDF statement filename used (or to be used) when emailing the statement PDF.
▶custom_status_label string   No

Client specific custom invoice status.
▶custom_status_desc string   No

Description of the Client specific custom invoice status.
▶client_notes string   No

Free-text notes recorded against the invoice.
Start of balance_transfer_details object
▶balance_transfer_details object   No

Invoice-related balance transfers (parent-pay) associated with this statement, both inbound and outbound.
Name Type Length Required Description
▶▶transfer_no long   No

Aria-assigned balance transfer number.
▶▶transaction_type long 3 No

Aria-assigned identifier for this type of transaction.

Allowed values:

Value Description
4 Balance Transfer To Account
-4 Voided Balance Transfer To Account
5 Balance Transfer From Account
-5 Voided Balance Transfer From Account
▶▶from_acct_no long   No

Account number the balance was transferred from.
▶▶to_acct_no long   No

Account number the balance was transferred to.
▶▶from_master_plan_instance_no long   No

Master plan instance number of the account the balance was transferred from.
▶▶to_master_plan_instance_no long   No

Master plan instance number of the account the balance was transferred to.
▶▶amount double   No

Amount of the balance transfer.
▶▶invoice_no long   No

The Aria assigned ID of the invoice this balance transfer is associated with.
▶▶invoice_date string   No

Specifies Invoice Date.
End of balance_transfer_details object
End of statement_all object
TOP
  1. Back to top
  • Was this article helpful?

Recommended articles

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