DO.IBR.03 Benefit

DO.IBR.03: Benefit

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

Attribute	Type	Cardinality	Description
benefit_type	CD.IBR.02 benefit_type	0...1	Type of benefit received (e.g. cash, voucher etc.)
benefit_date	DF.COM.STRING.01 date_time	0...1	Date on which the benefit was received
benefit_value	DF.COM.STRING.08 currency	0...1	Value of the benefit received
benefit_description	DT.COM.02 string	0...1	More specific description of the benefit (may be used to specify the type of in-kind benefit, e.g. sacks of rice)
benefit_quantity	DT.COM.03 integer	0...1	Quantity of benefit provided (may be used to specific quantities of in-kind benefit, e.g. 5)

Example JSON Data Structure of the Benefit Data Object

{
  "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",
              }
            }
          ]
        }
      }
    ]
  }
}

https://github.com/spdci/schemas/blob/main/extensions/ibr/v1/Benefit.jsonld