Summary

Description

Saves additional details in the credit memo.

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
cm_no	long	22	Yes	The unique Aria-generated number for the credit memo. Alternative required field: client_cm_seq_id
client_cm_seq_id	string	50	Yes	Client-defined credit memo sequence ID. Alternative required field: cm_no
cm_qualifiers_update	object		No	Array of additional values you can associate with the credit memo. See fields below

Name

Type

Length

Required

Description

cm_qualifier_name

string

100

No

Name of the field you want to associate with the credit memo.

cm_qualifier_value

string

100

No

Corresponding value of the field you want to associate with the credit memo.

cm_qualifier_directive

long

1

No

Specifies the Credit Memo qualifier directive, indicating whether qualifiers should be added or removed for the credit memo.

Allowed values:

Value	Description
1	Add qualifiers to the credit memo (Default).
2	Remove the qualifier name and value from the credit memo. If the qualifier name exists with other values, those will remain untouched.
3	Remove all qualifiers entries with the specified name. Any provided value is ignored.

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.