Summary

API Name	get_invoice_cm_details_m
Class	transaction_services_m
Update Version	6.50

Description

Provides the allowable credit memo line values for a given invoice.

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
invoice_no	long		Yes	The Aria-assigned unique identifier of a given invoice. Alternative required field: client_cm_seq_id
client_cm_seq_id	string	50	Yes	Client credit memo sequence id. Alternative required field: invoice_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.

restriction_reason

string

No

If the invoice cannot be credited using a credit memo, the reason for the restriction.

Allowed values:

Value	Description
a	Unable to apply credit memo to a voided invoice.
b	Unable to apply credit memo to a pending invoice.
c	Unable to apply credit memo to an invoice that is in dispute hold.
d	Unable to apply credit memo to an invoice that has been written off.
e	Unable to apply credit memo to an invoice that has been fully paid.
f	Unable to apply credit memo to a child invoice when parent pay responsibility is used.
g	Unable to apply credit memo to an invoice that has refund-related reversals applied.

invoice_cm_line_details

object

No

Array of invoice line items.

See fields below

invoice_cm_line_details fields

Name

Type

Length

Required

Description

line_no

long

No

Invoice line number.

service_no

long

No

Aria generated service number.

service_name

string

No

Service name.

client_sku

string

No

Client-defined SKU.

item_no

long

No

Aria generated unique item ID.

client_service_id

string

No

Unique Client-defined service ID.

client_item_id

string

No

Note: This field is deprecated. Aria no longer supports client_item_id.

amount

double

No

Amount.

max_credit_amount

double

No

Maximum Credit Amount.

max_on_charge_credit_amount

double

No

Maximum Credit Amount on Net Charge Only, Excluding Taxes.

orig_charge_tax_inclusive_indicator

long

No

Indicating if the charge is tax inclusive or not.

Allowed values:

Value	Description
1	Original charge line is tax inclusive.
0	Original charge line is not tax inclusive.

max_on_tax_credit_amount

double

No

Maximum Credit Amount on Taxes.