Skip to main content
Aria Knowledge Central

get_statement_for_inv_size_m

Summary

API Name get_statement_for_inv_size_m
Class transaction_services_m
Update Version 6.33

Description

Returns the number of characters in a statement associated with a specified account and invoice. You can use this call to determine the size of a statement before trying to capture the statement in a variable.

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 No

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

invoice_no long   Yes

The Aria-assigned unique identifier of a given invoice.

do_encoding string 5 No

True indicates to acquire the message size after doing MIME encoding, False acquires message size without MIME encoding.

Allowed values:

Value Description
False False acquires message size without MIME encoding
True True indicates to acquire the message size after doing MIME encoding

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.

num_chars long   No

The number of the characters in the statement.

TOP
  • Was this article helpful?