ESesahayak
Reference data

Required & optional fields for a stamp combination

Changed on

Machine-readable required/optional-field spec for a (state, article, denomination, category) combination — the discovery counterpart to POST /stamp-orders/validate. articleCode, denomination and category are optional; when supplied, conditional rules (payerGender over ₹500, second-party-not-applicable, etc.) resolve to concrete required booleans instead of requiredWhen rules. The fields marked required here are exactly what /validate and /create reject when blank.

get/states/{code}/requirements

Request

  • Base URL
    https://esahayak.io/api/v1
  • URL
    https://esahayak.io/api/v1/states/{code}/requirements
  • Auth
    HTTP bearer

Path parameters

codestring required
Example:DL

Query parameters

articleCodestring
Example:DL-RG-31
denominationnumber
Example:500
category'e_stamp' | 'traditional_stamp'
Example:e_stamp

Response

Resolved requirement spec.

category'e_stamp' | 'traditional_stamp' required

Example response

{
  "state": {
    "code": "DL",
    "name": "Delhi",
    "minAmount": 10,
    "maxAmount": 500,
    "amountMultipleOf": 10
  },
  "article": {
    "code": "DL-RG-31"
  },
  "fields": [
    {
      "field": "payerGender"
    }
  ],
  "limits": {
    "maxStampsPerRequest": 5000,
    "maxQuantityPerLine": 1000
  },
  "meta": {
    "payerGenderRequiredAboveAmount": 500
  }
}

Changes

  • cca124862a3eRevision changes
    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status