get_acct_charges_paid_status_m
Summary
| API Name | get_acct_charges_paid_status_m |
|---|---|
| Class | transaction_services_m |
| Update Version | 68 |
Description
Returns the list of charges with balance/paid info to pay/unpay
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 |
||||||
| charge_level_type | long | 1 | Yes |
Determines whether to return charges at invoice level (along with non-invoice charges) or invoice lines level. Allowed values:
|
||||||
| charge_retrieval_type | long | 1 | Yes |
Determines whether to return the charges to be paid or unpaid. Allowed values:
|
||||||
| master_plan_instance_no | long | 22 | No |
The unique identifier for the master plan instance. Used only for charge_level_type = 2 to filter the invoice lines by this master plan instance. Alternative field: client_master_plan_instance_id |
||||||
| client_master_plan_instance_id | string | 100 | No |
Client-defined unique identifier for the master plan instance. Used only for charge_level_type = 2 to filter the invoice lines by this master plan instance. Alternative field: master_plan_instance_no |
||||||
| invoice_no | long | 22 | No |
The Aria-generated invoice number to filter from the charges retrieved to pay or unpay. |
||||||
| payment_transaction_id | long | 22 | No |
The Aria-generated transaction ID of the payment to filter from the charges retrieved to unpay (charge_retrieval_type = 2). |
||||||
| offset | long | 10 | No |
The number of records to skip in the array. Min of 0 with no maximum value. If no value specified the default is 0. If an offset value greater than the total matching charges count is passed, then no records will be returned in the response since that is an invalid offset. |
||||||
| limit | long | 3 | No |
Limits the number of records returned in the array. Min of 1 and Max 999. If no value is specified, it defaults to 999. |
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. |
|
| acct_charges | object | No |
Charges at invoice level along with non-invoice charges. |
|
| invoice_lines | object | No |
Returns charges at the invoice line level. |
acct_charges fields
| Name | Type | Length | Required | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| transaction_id | long | No |
The unique identifier for a given transaction. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| transaction_date | string | No |
Date the transaction was executed. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| transaction_type | long | 8 | No |
Transaction type to search account history for. Allowed values:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| transaction_desc | string | No |
Text description of the transaction. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| invoice_no | long | No |
The Aria-assigned unique identifier of a given invoice. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| source_no | long | No |
A unique identifier defining the originating source of the transaction, such as a balance transfers and dunning charges etc. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| amount | double | No |
Total monetary value of this transaction. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| paid_amount | double | No |
The paid amount of this transaction. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| balance_due | double | No |
Balance due amount of this transaction. |
invoice_lines fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| invoice_no | long | No |
The Aria-assigned unique identifier of a given invoice. |
|
| line_no | long | No |
Specifies the sequential line number of this line item. |
|
| service_no | long | No |
Specifies the Aria-assigned unique service identifier. |
|
| line_description | string | No |
Specifies the corresponding description to this line item. |
|
| master_plan_instance_no | long | 22 | No |
Unique plan instance number associated with the line item. |
| charge_amount | double | No |
Charge amount for the invoice line item. |
|
| tax_amount | double | No |
Amount of tax applied to the invoice line item. |
|
| paid_amount | double | No |
The paid amount of the invoice line item. |
|
| balance_due | double | No |
Balance due amount of the invoice line item. |