calc_credit_reference_line_m
Summary
| API Name | calc_credit_reference_line_m |
|---|---|
| Class | transaction_services_m |
| Update Version | 12.0 |
Description
Calculates credit reference over invoice line items in the past.
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 | 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 |
This is the client-assigned identifier for the account. Alternative required field: acct_no |
||||||
| plan_instance_no | long | Yes |
Unique plan instance number for each assigned master or supplemental plan. Alternative required field: client_plan_instance_id |
|||||||
| client_plan_instance_id | string | Yes |
Client-defined plan instance ID for each assigned master or supplemental plan. Alternative required field: plan_instance_no |
|||||||
| service_no | long | Yes |
Service number. Alternative required field: client_service_id |
|||||||
| client_service_id | string | Yes |
Client defined service id. Alternative required field: service_no |
|||||||
| credit_ref_type | long | Yes |
Credit reference type. Allowed values:
|
|||||||
| credit_reference_start_date | string | Yes |
The start date, in yyyy-mm-dd format, from which the credit reference calculation begins. |
|||||||
| monthly_price | double | No |
Monthly price for specified plan instance / service. |
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. |
|
| plan_instance_no_out | long | No |
Unique plan instance number for each assigned supplemental plan. |
|
| service_no_out | long | No |
Service number. |
|
| client_service_id_out | string | No |
Client defined service id. |
|
| credit_reference_amount | double | No |
Total credit reference amount. |
|
| charge_reference_amount | double | No |
Total charge reference amount. |
|
| amount | double | No |
Total amount: credit_reference_amount - charge_reference_amount. |
|
| invoice_reference_details | object | No |
Array of invoice reference details. |
invoice_reference_details fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| invoice_no | long | No |
The invoice number. |
|
| invoice_line_no | long | No |
The invoice line number. |
|
| invoice_ref_line_amount | double | No |
The invoice reference line's gross amount. |
|
| invoice_line_charge_amt | double | No |
The invoice reference line's charge amount. |
|
| invoice_line_surcharge_amt | double | No |
The invoice reference line's surcharge gross amount. |
|
| invoice_line_credit_amt | double | No |
The invoice reference line's service credit amount. |
|
| invoice_line_discount_amt | double | No |
The invoice reference line's off-line discount amount. |
|
| invoice_line_tax_amt | double | No |
The invoice reference line's gross tax amount. |