# DO.IBR.03 Benefit

### DO.IBR.03: Benefit

This data object contains the details of the benefit received by a beneficiary.

<table><thead><tr><th width="194">Attribute</th><th width="194">Type</th><th width="119">Cardinality</th><th>Description</th></tr></thead><tbody><tr><td>benefit_type</td><td><a data-mention href="../code-directory/cd.ibr.02-benefit_type">cd.ibr.02-benefit_type</a></td><td>0...1</td><td>Type of benefit received (e.g. cash, voucher etc.)</td></tr><tr><td>benefit_date</td><td><a data-mention href="https://app.gitbook.com/s/F9fu0tIY1rJUsF03WdAv/standards-for-interoperability-interfaces/common-standards-for-interoperability-interfaces/data/data-types-and-formats/dt.com.02-string/data-formats/df.com.string.01-date_time">DF.COM.STRING.01 date_time</a></td><td>0...1</td><td>Date on which the benefit was received</td></tr><tr><td>benefit_value</td><td><a data-mention href="https://app.gitbook.com/s/F9fu0tIY1rJUsF03WdAv/standards-for-interoperability-interfaces/common-standards-for-interoperability-interfaces/data/data-types-and-formats/dt.com.02-string/data-formats/df.com.string.08-currency">DF.COM.STRING.08 currency</a></td><td>0...1</td><td>Value of the benefit received</td></tr><tr><td>benefit_description</td><td><a data-mention href="https://app.gitbook.com/s/F9fu0tIY1rJUsF03WdAv/standards-for-interoperability-interfaces/common-standards-for-interoperability-interfaces/data/data-types-and-formats/dt.com.02-string">DT.COM.02 string</a></td><td>0...1</td><td>More specific description of the benefit (may be used to specify the type of in-kind benefit, e.g. sacks of rice)</td></tr><tr><td>benefit_quantity</td><td><a data-mention href="https://app.gitbook.com/s/F9fu0tIY1rJUsF03WdAv/standards-for-interoperability-interfaces/common-standards-for-interoperability-interfaces/data/data-types-and-formats/dt.com.03-integer">DT.COM.03 integer</a></td><td>0...1</td><td>Quantity of benefit provided (may be used to specific quantities of in-kind benefit, e.g. 5)</td></tr></tbody></table>

### Example JSON Data Structure of the Benefit Data Object

```json
{
  "message": {
    "search_response": [
      {
        "response_entity": "Benefit",
        "data": {
          "reg_records": [
            {
              "benefits": {
                "benefit_type": "In-kind",
                "benefit_date": "02.05.2024",
                "benefit_value": "USD 20",
                "benefit_label": "Shopping voucher",
                "benefit_unit": "",
                "benefit_quantity": "6",
              }
            }
          ]
        }
      }
    ]
  }
}
```

{% @github-files/github-code-block url="<https://github.com/spdci/schemas/blob/main/extensions/ibr/v1/Benefit.jsonld>" %}
