Creating a balance update docs

Author: DanJezeph15

pages/balance_updates/balance_updates.yml

@@ -23,3 +23,11 @@ sections:
     code_type: GET
     code_url: /api/balance_updates/{id}/
     response: /balance_updates/get-a-balance-update.json
+  -
+    title: Create a balance update
+    id: create-a-balance-update
+    description: /balance_updates/create-a-balance-update.md
+    code: /balance_updates/create-a-balance-update.py
+    code_type: POST
+    code_url: /api/balance_updates/
+    response: /balance_updates/create-a-balance-update.json

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

@@ -0,0 +1,27 @@
+{
+    "id": 385,
+    "client": {
+        "id": 67,
+        "first_name": "Billy",
+        "last_name": "Holiday",
+        "email": "[email protected]",
+        "role_type": "Client",
+        "url": "http://localhost:8000/api/clients/67/"
+    },
+    "created": "2025-09-25T10:00:00.000000+01:00",
+    "creator": {
+        "id": 64,
+        "first_name": "Billy",
+        "last_name": "Holiday",
+        "email": "[email protected]",
+        "role_type": "Administrator"
+    },
+    "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"
+}
+

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

@@ -0,0 +1,9 @@
+### Creating a Balance Update
+
+Creating a Balance Update can be completed by simply supplying the `client`, `credit_amount` and `method` as the 
+`description` field is 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. 
+
+The possible values for the `method` field are:
+`cash`, `cheque`, `credit_card`, `transferwise`, `debit_card`, `bank_transfer`, `direct_debit`, `bonus_credit`, 
+`manual`, `voucher`, `correction`.

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

@@ -0,0 +1,11 @@
+import pprint, requests
+
+headers = {'Authorization': 'token <API KEY>'}
+data = {
+    "client": 67,
+    "credit_amount": 100,
+    "method": "cash",
+    "description": "Client paid by cash.",
+}
+response = requests.post('https://secure.tutorcruncher.com/api/balance_updates/', json=data, headers=headers)
+pprint.pprint(response.json())