DO.IBR.03 Benefit

DO.IBR.03: Benefit

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

AttributeTypeCardinalityDescription

benefit_type

0...1

The type of benefit received (eg. cash, voucher etc)

benefit_date

0...1

The date on which the benefit was received

benefit_value

0...1

The value of the benefit received

benefit_description

0...1

A more specific description of the benefit. May be used to specify the type of in-kind benefit (eg sacks of rice)

benefit_quantity

0...1

The quantity of benefit provided. May be used to specific quantities of in-kind benefit (eg 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",
              }
            }
          ]
        }
      }
    ]
  }
}

Last updated