Skip to main content
Aria Knowledge Central

create_reason_code_m

Summary

API Name create_reason_code_m
Class administration_services_m
Update Version 6.38

Description

Creates a new reason code and associated attributes

Inputs

Name Type Length Required Description
client_no long 12 Yes

Aria-assigned unique identifier indicating the Aria client providing service to this account.

auth_key string 32 Yes

Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor.

type long 50 Yes

Reason code type.

Allowed values:

Value Description
Service Credit Service Credit (23)
Cash Credit Cash Credit (10)
Credit Memo Credit Memo (24)
Rebill Rebill (1)
Write Off Write Off (6)
Refund Refunds and Payment Auth Reversals (12)
reason_code long 4 Yes

The reason code (number). Reason codes are unique per type.

reason_code_name string 100 Yes

The client description for the reason code

on_acct_credit_flag long 1 No

Indicates whether GL Accounts will be derived from the originating transaction or from the reason code.

Allowed values:

Value Description
1 True.
0 False.
debit_gl_code string 50 No

Mandatory when the on_acct_credit_flag parameter = 1. Expense GL Code.

credit_gl_code string 50 No

Mandatory when the on_acct_credit_flag parameter = 1. Unapplied Credit GL Code.

enable_for_csr string 1 No

Flag to indicate whether CSR can use the reason code.

allow_time_restrictions string 1 No

Determines whether time based scope restictions such as expiry may be defined by csr. Y value valid if enable for csr = y, otherwise null or N.

allow_plan_restrictions string 1 No

Determines whether plan / service based scope restrictions such as applicability to a specific service type, may be used. Y value valid if enabled for csr = Y, otherwise null or N.

record_service_credit_trans string 1 No

Determines whether service credit transactions will be posted in revenue recognition (Y) or whether they will be netted with revenue (N). Null value accepted as N.

record_liability long 2 No

Indicates whether accounting treatment begins at issuance with the creation of unapplied service credit liability.

Allowed values:

Value Description
1 True.
0 False.
expense_gl_code string 50 No

Mandatory when the record_liability parameter = 1. Indicates the charge account when the service credit is immediately accounted at issuance.

unapplied_sc_gl_code string 50 No

Mandatory when the record_liability parameter = 1. Indicates the credit account when the service credit is immediately accounted at issuance.

canceled_sc_gl_code string 50 No

Mandatory when the record_liability parameter = 1. Indicates a credit account when the unapplied service credit is canceled.

expired_sc_gl_code string 50 No

Mandatory when the record_liability parameter = 1. Indicates a credit account when the unapplied service credit expires.

Outputs

Name Type Length Required Description
error_code long   No

Aria-assigned error identifier. 0 indicates no error

error_msg string   No

Textual description of any error that occurred. "OK" if there was no error.

created_by string   No

User that created record

created_date string   No

Date and time the record was created

TOP
  • Was this article helpful?