get_statement_for_invoice_m
Summary
| API Name | get_statement_for_invoice_m |
|---|---|
| Class | transaction_services_m |
| Update Version | 6.33 |
Description
Retrieves the statement document associated with a specified account and invoice number. Statements are customer-facing billing documents that summarize charges, payments, credits, and the current balance for a billing period. Returns the statement content which can be used for display or PDF generation.
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:
|
||||||
| alt_stmt_template_no | long | 22 | No |
The statement template number to use when viewing the output. Please note this input will be honored only when there is no statement content previously generated and stored. Alternative field: alt_client_stmt_template_id |
||||||
| alt_client_stmt_template_id | string | 100 | No |
The client-defined statement template identifier to use when viewing the output. Please note this input will be honored only when there is no statement content previously generated and stored. Alternative field: alt_stmt_template_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. |
|
| out_statement | string | No |
The returned account statement. |
|
| mime_type | string | No |
MIME type for statement encoding. |