Get Individual Reason Code Master Details

This endpoint retrieves the details of a specific reason code based on the reason code name returned by the Reason Code Master endpoint.

Endpoint

GET {{url}}/api/resource/Reason Code Master/{name}

Supporting APIs

📘

Get the reason code name first

Use the Reason Code Master API to get the list of active reason codes, then pass a name from that list to this endpoint.

1. Get Reason Codes

GET {{url}}/api/resource/Reason Code Master?filters=[["is_active","=","1"]]&limit_page_length=0

Use data[].name as {name}.

Path Parameters

NameTypeRequiredDescription
namestringYesReason code name returned by the Reason Code Master API, for example Add Fee Reason.

Response

The root key in the response is data. It contains the reason code details, its active status, and flags indicating which actions the reason code applies to.

  • name – Unique reason code ID
  • reason_code – Reason code name
  • description – Description of the reason code
  • short_code – Short code for the reason code
  • is_system – Whether the reason code is system-defined
  • is_active – Whether the reason code is active
  • acceleration_reason, account_transfer, add_fee, adjustment_reason and other reason type flags – 1 if the reason code applies to that action, otherwise 0
  • owner, creation, modified, modified_by, docstatus, idx – System metadata

Example Response

{
  "data": {
    "name": "Add Fee Reason",
    "owner": "Administrator",
    "creation": "2024-11-26 06:08:30.592443",
    "modified": "2025-04-01 02:43:55.520537",
    "modified_by": "Administrator",
    "docstatus": 0,
    "idx": 9414,
    "reason_code": "Add Fee Reason",
    "description": "This is add fee reason!!!",
    "short_code": "ADF",
    "is_system": 0,
    "is_active": 1,
    "acceleration_reason": 0,
    "account_transfer": 0,
    "add_fee": 1,
    "adjustment_reason": 0
  }
}

Status Codes

CodeMeaning
200OK