Update Budget Rule With Provider Rules

Update an existing budget rule using the simplified provider_rules format.

This endpoint updates a budget rule with the same format as creation:

  • JSON string or array for provider_rules
  • Will replace ALL existing provider rules with the new ones
  • Will update or create the invoice rule

Example:

{
  "budget_category": "Assistance with Social, Economic and Community Participation",
  "effective_date": "2024-02-01",
  "expiry_date": "2026-02-01", 
  "provider_rules": "[{"amount":500,"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"
  }
}
put/api/v1/budget_rules/{rule_group_id}/with-provider-rules

Path parameters

rule_group_idinteger required

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.