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 firstUse the Reason Code Master API to get the list of active reason codes, then pass a
namefrom that list to this endpoint.
1. Get Reason Codes
GET {{url}}/api/resource/Reason Code Master?filters=[["is_active","=","1"]]&limit_page_length=0Use data[].name as {name}.
Path Parameters
| Name | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Reason 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 IDreason_code– Reason code namedescription– Description of the reason codeshort_code– Short code for the reason codeis_system– Whether the reason code is system-definedis_active– Whether the reason code is activeacceleration_reason,account_transfer,add_fee,adjustment_reasonand other reason type flags –1if the reason code applies to that action, otherwise0owner,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
| Code | Meaning |
|---|---|
200 | OK |
