Skip to main content
Aria Knowledge Central

get_reason_code_m

  1. Last updated
  2. Save as PDF

Summary

API Name get_reason_code_m
Class administration_services_m
Update Version 6.38

Description

Returns the attributes of an existing reason code.

Inputs

Name Type Length Required Description
client_no long 22 No

Aria-assigned unique identifier indicating the Aria client providing service to this account.
auth_key string 32 No

Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor.
type string 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.

Outputs

Name Type Length Required Description
error_code long   Yes

Aria-assigned error identifier. 0 indicates no error.
error_msg string   Yes

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

User that created the record.
created_date object   No

Date and time the record was created.

See fields below
updated_by string   No

User ID of the most recent party to update the reason code.
updated_date object   No

Date and time the record was updated.

See fields below
reason_code_name string   No

Client-designated name for the reason code.
is_active int 1 No

Indicates if the reason code is hidden or displayed.
on_acct_credit_flag long   No

Indicates whether GL accounts are derived from the originating transaction or from the reason code.
debit_gl_code string   No

Mandatory when the on_acct_credit_flag parameter equals one. Expense GL code.
credit_gl_code string   No

Mandatory when the on_acct_credit_flag parameter equals one. Unapplied credit GL code.
allow_time_restrictions string   No

Identifies whether the reason code allows the CSR to define time-based restrictions.
allow_plan_restrictions string   No

Identifies whether the reason code allows the CSR to define plan or service based restrictions.
record_service_credit_transactions string   No

Identifies whether the reason code records revenue recognition transactions net or gross.
record_liability long 2 No

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

Mandatory when the record_liability parameter equals one. Indicates the charge account used when the service credit is immediately accounted for at issuance.
unapplied_sc_gl_code string 50 No

Mandatory when the record_liability parameter equals one. Indicates the credit account used when the service credit is immediately accounted for at issuance.
canceled_sc_gl_code string 50 No

Mandatory when the record_liability parameter equals one. Indicates a credit account used when the unapplied service credit is canceled.
expired_sc_gl_code string 50 No

Mandatory when the record_liability parameter equals one. Indicates a credit account used when the unapplied service credit expires.

created_date fields

Name Type Length Required Description
date string   No  
timezone_type string   No  
timezone string   No  

updated_date fields

Name Type Length Required Description
date string   No  
timezone_type string   No  
timezone string   No  
TOP
  1. Back to top
  • Was this article helpful?

Recommended articles

  1. Page type
    Topic
  2. Tags
    1. admintools api
    2. API Specification