Reason Codes

A reason code classifies an inventory transaction — explaining why stock was received or issued. Reason codes are created in the Desktop application; this API provides read access and the ability to discontinue them.

The Reason Code Object

{
  "rec": 1,
  "code": "PO-RECEIVE",
  "description": "Purchase Order Receipt",
  "type": "receive",
  "active": true
}

Codes with type: "receive" are used on Inventory Receive operations; type: "issue" codes are used on Inventory Issue operations.

List Active Reason Codes

GET /ReasonCode

Returns active reason codes with standard pagination parameters.

{
  "value": [
    {
      "rec": 1,
      "code": "PO-RECEIVE",
      "description": "Purchase Order Receipt",
      "type": "receive",
      "active": true
    },
    {
      "rec": 4,
      "code": "PRODUCTION",
      "description": "Issued to Production",
      "type": "issue",
      "active": true
    },
    {
      "rec": 7,
      "code": "ADJ-IN",
      "description": "Inventory Adjustment In",
      "type": "receive",
      "active": true
    }
  ],
  "totalCount": 12,
  "page": 1,
  "pageSize": 25,
  "pageCount": 1,
  "hasMore": false
}

List All Reason Codes

GET /ReasonCode/All

Includes discontinued reason codes. Uses the same response shape as the active list.

{
  "value": [
    {
      "rec": 2,
      "code": "LEGACY-RCV",
      "description": "Legacy Receive Code",
      "type": "receive",
      "active": false
    },
    {
      "rec": 4,
      "code": "PRODUCTION",
      "description": "Issued to Production",
      "type": "issue",
      "active": true
    }
  ],
  "totalCount": 15,
  "page": 1,
  "pageSize": 25,
  "pageCount": 1,
  "hasMore": false
}

Get a Reason Code

GET /ReasonCode/{id}

Returns 404 if the reason code does not exist.

GET /ReasonCode/1

{
  "rec": 1,
  "code": "PO-RECEIVE",
  "description": "Purchase Order Receipt",
  "type": "receive",
  "active": true
}

Discontinue a Reason Code

DELETE /ReasonCode/{id}

Marks the reason code as discontinued. Existing transactions that used this code are not affected. Returns 204 on success.

DELETE /ReasonCode/1

Permissions