> For the complete documentation index, see [llms.txt](https://standards.spdci.org/standards/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://standards.spdci.org/standards/dci-standards/wip-integrated-beneficiary-registry-v1.0.0/ibr/1.-crvs/data/data-objects/do.ibr.03-benefit.md).

# 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="/standards/dci-standards/wip-integrated-beneficiary-registry-v1.0.0/ibr/1.-crvs/data/code-directory/cd.ibr.02-benefit_type.md">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="/standards/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.md">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="/standards/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.md">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="/standards/standards-for-interoperability-interfaces/common-standards-for-interoperability-interfaces/data/data-types-and-formats/dt.com.02-string.md">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="/standards/standards-for-interoperability-interfaces/common-standards-for-interoperability-interfaces/data/data-types-and-formats/dt.com.03-integer.md">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>" %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://standards.spdci.org/standards/dci-standards/wip-integrated-beneficiary-registry-v1.0.0/ibr/1.-crvs/data/data-objects/do.ibr.03-benefit.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
