apply_cm_m
Summary
| API Name | apply_cm_m |
|---|---|
| Class | transaction_services_m |
| Update Version | 12.0 |
Description
Applies credit memo line credits to invoice gross line amounts.
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 |
||||||
| credit_application_details | object | Yes |
Array of credit memo line application. |
|||||||
| do_write | string | 5 | No |
Boolean indicator that specifies whether to actually perform the requested operation. If 'false' is passed in this field, Aria calculates, if applicable, any potential effects from this call such as proration, plan assignments, etc. and return all relevant data without actually performing the requested operation or making any changes to the account. This is useful to interfaces that want to present the user with a 'confirmation page' informing them of the potential effects of the requested operation prior to actually performing it. Do_write defaults to 'true' Allowed values:
|
credit_application_details fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| cm_no | long | Yes |
The unique Aria-generated number for the credit memo. |
|
| cm_line_no | long | 30 | Yes |
Credit memo line number. Alternative required field: cm_transaction_id |
| cm_transaction_id | long | 30 | Yes |
Credit memo line transaction id. Alternative required field: cm_line_no |
| apply_to_invoice_no | long | 30 | Yes |
The invoice number this credit memo line applies to. |
| apply_to_invoice_line_no | long | 30 | Yes |
The invoice line number this credit memo line applies to. Alternative required field: apply_to_invoice_line_tran_id |
| apply_to_invoice_line_tran_id | long | 30 | Yes |
The invoice line transaction id this credit memo line applies to. Alternative required field: apply_to_invoice_line_no |
| gross_line_application_amt | double | Yes |
Gross amount to be applied against the invoice line. |
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. |
|
| applied_cm_line_details | object | No |
Array of credit memo line application. |
applied_cm_line_details fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| applied_to_invoice_no | long | No |
The invoice number this credit applied to. |
|
| applied_to_invoice_line_no | long | No |
The invoice line number this credit applied to. |
|
| invoice_line_transaction_id | long | No |
The invoice line transaction id. |
|
| cm_no_out | long | No |
The unique Aria-generated number for the credit memo. |
|
| cm_line_no_out | long | No |
Credit memo line number. |
|
| cm_transaction_id_out | long | No |
Credit memo line transaction id. |
|
| line_amt_applied | double | No |
Credit amount applied against the invoice service line. |
|
| line_tax_amt_applied | double | No |
Credit amount applied against taxes of the invoice service line. |