Skip to main content
Aria Knowledge Central

get_all_reason_codes_m

  1. Last updated
  2. Save as PDF

Summary

API Name get_all_reason_codes_m
Class administration_services_m
Update Version 6.50

Description

Returns all Reason code for client

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 string 50 No

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)

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.
all_reason_codes object   No

The all_reason_codes associated with this method.

See fields below

all_reason_codes fields

Name Type Length Required Description
created_by string   Yes

User that created record
created_date string   Yes

Date and time the record was created
updated_by string   Yes

User id of most recent party to update the reason code
updated_date string   Yes

Date and time the record was created
reason_code string   Yes

An existing reason code number. Reason codes are unique per type.
type string   Yes

Reason code type
reason_code_name string   Yes

Client designated name for the reason code
is_active int 1 Yes

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

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

Mandatory when the on_acct_credit_flag parameter = 1. Expense GL Code.
credit_gl_code string   No

Mandatory when the on_acct_credit_flag parameter = 1. 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 = 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.
TOP
  1. Back to top
  • Was this article helpful?

Recommended articles

  1. Page type
    Topic
  2. Tags
    This page has no tags.