get_cm_list_m
Summary
| API Name | get_cm_list_m |
|---|---|
| Class | transaction_services_m |
| Update Version | 6.50.1 |
Description
Use this API to return information on all credit memos associated to an account.
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 |
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. |
|
| cm_details_all | object | No |
Array of returned credit memo numbers and relevand details for each credit memo |
cm_details_all fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| cm_no | long | No |
The unique Aria-generated number for the credit memo |
|
| created_by | string | No |
User ID that created the credit memo. |
|
| created_date | string | No |
Date the credit memo was created. |
|
| cm_total | double | No |
Amount of the credit memo |
|
| cm_tax_total | double | No |
Total amount of tax credit with the Credit Memo. This is a aum of the tax lines for a given CM. |
|
| cm_reason_code | long | No |
Note: This field is deprecated. Aria no longer supports cm_reason_code. |
|
| invoice_no | long | No |
The Aria-assigned unique identifier of a given invoice. |
|
| is_voided | long | No |
Returns whether or not the invoice was voided. |
|
| cm_reason_code_2 | long | No |
Reason code |