Update docs

Author: DanJezeph15

pages/balance_updates/balance-update-object.json

@@ -11,7 +11,6 @@
   "credit_amount": "-567.50",
   "description": "Invoice raised",
   "method": "auto",
-  "method_display": "System Generated",
   "related_item": {
     "id": 54,
     "display_id": "INV-54",
@@ -38,6 +37,5 @@
     "role_type": "Client",
     "url": "https://secure.tutorcruncher.com/api/clients/42/"
   },
-  "update_type": "invoice_creation",
-  "update_type_display": "Invoice Creation"
+  "update_type": "invoice_creation"
 }

pages/balance_updates/balance-update-object.yml

@@ -42,10 +42,6 @@ attributes:
     name: method
     type: string
     description: The payment method used for the balance update. Options for this field are ['cash', 'cheque', 'credit_card', 'transferwise', 'debit_card', 'bank_transfer', 'direct_debit', 'bonus_credit', 'manual', 'voucher', 'correction'].
-  -
-    name: method_display
-    type: string
-    description: Human-readable display name for the payment method.
   -
     name: related_item
     type: object
@@ -77,10 +73,6 @@ attributes:
     name: update_type
     type: string
     description: The type of update being performed (e.g., "via_api", "manual").
-  -
-    name: update_type_display
-    type: string
-    description: Human-readable display name for the update type.
 
 filters:
   -
@@ -99,3 +91,19 @@ filters:
     name: update_type
     type: string
     description: Filter by the Balance Updates update_type. Options for this field are ['proforma_invoice_paid', 'invoice_creation', 'invoice_payment', 'po_creation', 'po_payment', 'adjustment', 'refund', 'stripe_bank_transfer_refund', 'voucher', 'credit_note', 'debit_note', 'via_api', 'top_up', 'app_fee']'
+  -
+    name: credit_amount_gte
+    type: decimal
+    description: Filter by Balance Updates with a credit_amount greater than or equal to this value.
+  -
+    name: credit_amount_lte
+    type: decimal
+    description: Filter by Balance Updates with a credit_amount less than or equal to this value.
+  -
+    name: created_gte
+    type: datetime
+    description: Filter by Balance Updates created on or after this date and time.
+  -
+    name: created_lte
+    type: datetime
+    description: Filter by Balance Updates created on or before this date and time.

pages/balance_updates/create-a-balance-update.json

@@ -19,9 +19,7 @@
     "credit_amount": "100.00",
     "description": "This is a test description about why the credit was added to this client",
     "method": "cash",
-    "method_display": "Cash",
     "related_item": null,
-    "update_type": "via_api",
-    "update_type_display": "Via API"
+    "update_type": "via_api"
 }
 

pages/balance_updates/create-a-balance-update.md

@@ -1,6 +1,6 @@
 ### Creating a Balance Update
 
-Creating a Balance Update can be completed by simply supplying the `client`, `credit_amount` and `method` as the 
+Creating a Balance Update can be completed by simply supplying the `role`, `credit_amount` and `method` as the 
 `description` and `send_receipt` fields are optional. The `credit_amount` field must always be a positive value, 
 however if the method is set to `"correction"` then `credit_amount` can be a negative value. If `send_receipt` is set 
 to `True` then the `Payment receipt` email will be sent to the client if the email definition is enabled.

pages/balance_updates/create-a-balance-update.py

@@ -2,7 +2,7 @@
 
 headers = {'Authorization': 'token <API KEY>'}
 data = {
-    "client": 67,
+    "role": 67,
     "credit_amount": 100,
     "method": "cash",
     "description": "Client paid by cash.",

pages/balance_updates/get-a-balance-update.json

@@ -11,7 +11,6 @@
   "credit_amount": "-567.50",
   "description": "Invoice raised",
   "method": "auto",
-  "method_display": "System Generated",
   "related_item": {
     "id": 54,
     "display_id": "INV-54",
@@ -38,6 +37,5 @@
     "role_type": "Client",
     "url": "https://secure.tutorcruncher.com/api/clients/42/"
   },
-  "update_type": "invoice_creation",
-  "update_type_display": "Invoice Creation"
+  "update_type": "invoice_creation"
 }

pages/balance_updates/list-all-balance-updates.json

@@ -7,9 +7,9 @@
       "id": 182,
       "created": "2025-09-30T15:03:58.676657+01:00",
       "credit_amount": "-567.50",
-      "method_display": "System Generated",
+      "method": "auto",
       "role": 42,
-      "update_type_display": "Invoice Creation",
+      "update_type": "invoice_creation",
       "url": "https://secure.tutorcruncher.com/api/balance-updates/182/"
     }
   ]