apply_cm_m
Applies credit memo line credits to invoice gross line amounts.
Input Arguments
| Req | Field Name | Field Type | Max Length | Description | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
 |
client_no | long | 22 | Aria-assigned unique identifier indicating the Aria client providing service to this account. | ||||||
|
auth_key | string | 32 | Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor. | ||||||
|
acct_no | long | Aria-assigned account identifier. This value is unique across all Aria-managed accounts. | |||||||
| OR | ||||||||||
| client_acct_id | string | 50 | This is the client-assigned identifier for the account. | |||||||
| Start of credit_application_details array | ||||||||||
|
credit_application_details | array | Array of credit memo line application. | |||||||
| Field Name | Field Type | Max Length | Description | |||||||
|
 cm_no |
long | The unique Aria-generated number for the credit memo. | |||||||
|
cm_line_no |
long | Credit memo line number. | |||||||
| OR | ||||||||||
| cm_transaction_id |
long | Credit memo line transaction id. | ||||||||
|
apply_to_invoice_no |
long | The invoice number this credit memo line applies to. | |||||||
|
apply_to_invoice_line_no |
long | The invoice line number this credit memo line applies to. | |||||||
| OR | ||||||||||
| apply_to_invoice_line_tran_id |
long | The invoice line transaction id this credit memo line applies to. | ||||||||
|
gross_line_application_amt |
double | Gross amount to be applied against the invoice line. | |||||||
| End of credit_application_details array | ||||||||||
| do_write | string | 5 |
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' Allowable values for do_write:
|
|||||||
| alt_caller_id | string | 30 | Person or process that submitted the API call. This can be someone's user ID, or the name of an application. | |||||||
| Start of optional_transaction_qualifiers array | ||||||||||
| optional_transaction_qualifiers | array | Array of additional values you can associate with this API call. | ||||||||
| Field Name | Field Type | Max Length | Description | |||||||
| string | 100 | Name of the field you want to associate with this API call. | ||||||||
| string | 100 | Corresponding value of the field you want to associate with this API call. | ||||||||
| End of optional_transaction_qualifiers array | ||||||||||
| application_id | string | 300 | The application identifier in which the API is being used in. (Example: “Sales Force”) | |||||||
| application_date | string | 300 | The application date/timestamp, ie. 01/01/2014 10:00:00 to track when the application called the API. | |||||||
Output Arguments
| Field Name | Field Type | Description |
|---|---|---|
| error_code | long | Aria-assigned error identifier. 0 indicates no error. |
| error_msg | string | Description of any error that occurred. "OK" if there was no error. |
| applied_cm_line_details | hash | Array of credit memo line application. |
| long | The invoice number this credit applied to. | |
| long | The invoice line number this credit applied to. | |
| long | The invoice line transaction id. | |
| long | The unique Aria-generated number for the credit memo. | |
| long | Credit memo line number. | |
| long | Credit memo line transaction id. | |
| double | Credit amount applied against the invoice service line. | |
| double | Credit amount applied against taxes of the invoice service line. |