Create Budget Rule With Provider Rules

Create budget rule with provider_rules containing amount/support_item pairs.

This endpoint accepts provider_rules as either:

  • JSON string: "[{"amount":0,"support_item":"04_049_0104_1_1"}]"
  • Direct array: [{"amount":0,"support_item":"04_049_0104_1_1"}]

Both formats are automatically converted to JSON string for processing.

Example payload (works with both JSON string and array formats):

{
  "participant_id": "d347efc2-5eca-4efd-bb5c-cf6144fa96bf",
  "budget_category": "Assistance with Social, Economic and Community Participation",
  "effective_date": "2024-02-01",
  "expiry_date": "2026-02-01",
  "provider_rules": [{"amount":0,"support_item":"04_049_0104_1_1"},{"amount":1000,"support_item":"04_402_0104_1_1"}],
  "invoice_rule": {
    "name": "Budget Rule",
    "target": "ndis_line_items",
    "rule_message": "Budget rule exceeded, please check"
  }
}

Creates one provider_budget_rule for each item in the provider_rules array.

post/api/v1/budget_rules/with-provider-rules

Query parameters

plan_manager_idstring nullable

Request body

plan_managerstring uuid nullable
participant_idstring uuid required
budget_categorystring required
effective_datestring date required
expiry_datestring date nullable
provider_rulesstring required
pm_provider_idstring uuid nullable
budget_rule_typestring
budget_table_namestring nullable
budget_idinteger nullable
linked_documentinteger nullable
namestring nullable

Response

Successful Response

Changes

No recorded changes to this endpoint across all 1 revision of this API.