> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.schoolset.io/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.schoolset.io/_mcp/server.

# Update deposit batch details

PATCH https://ssuccessv2.com/app/api/v2/payment/deposit-batches/{id}
Content-Type: application/json

Updates editable account, naming, reference, date, and note fields on a manual deposit batch and returns its resource.

Reference: https://docs.schoolset.io/api-reference/school-set-api/deposit-batches/update-deposit-batch

## Authentication

- `Authorization` header (bearer token, required) — The signed-in SchoolSet user token sent by the frontend.

## Request

### Path parameters

- `id` (integer, required) — Deposit batch identifier.

### Body (application/json)

This endpoint expects an object.

- `account_id` (integer, optional, nullable)
- `name` (string, optional)
- `reference` (string, optional)
- `batch_date` (date, optional)
- `note` (string, optional)

## Response

### 200

The deposit batch was updated and returned.

- `status` (string, optional)
- `message` (string, optional)
- `data` (ApiV2PaymentDepositBatchesIdPatchResponsesContentApplicationJsonSchemaData, optional)

## Errors

### 401 Unauthorized Error

Authentication is required to update a deposit batch.

- `status` (string, required)
- `message` (string, required)
- `data` (any, optional, nullable)

### 403 Forbidden Error

The user lacks accounting edit permission in the active school.

- `status` (string, required)
- `message` (string, required)
- `data` (any, optional, nullable)

### 404 Not Found Error

The deposit batch does not exist in the active school.

- `status` (string, required)
- `message` (string, required)
- `data` (any, optional, nullable)

### 422 Unprocessable Entity Error

An account

- `message` (string, required)
- `errors` (map from string to list of string, required)

## Types

### ApiV2PaymentDepositBatchesIdPatchResponsesContentApplicationJsonSchemaData

- `id` (integer, optional)
- `name` (string, optional)
- `reference` (string, optional)
- `status` (string, optional)
- `is_locked` (boolean, optional)
- `totals` (ApiV2PaymentDepositBatchesIdPatchResponsesContentApplicationJsonSchemaDataTotals, optional)

### ApiV2PaymentDepositBatchesIdPatchResponsesContentApplicationJsonSchemaDataTotals

- `amount` (double, optional)
- `count` (integer, optional)

## Examples

**Request**

```json
{
  "account_id": 7,
  "name": "July Tuition Deposit",
  "reference": "SLIP-0002",
  "note": "Corrected bank slip"
}
```

**Response**

```json
{
  "status": "success",
  "message": "Saved successfully.",
  "data": {
    "id": 42,
    "name": "July Tuition Deposit",
    "reference": "SLIP-0002",
    "status": "open",
    "is_locked": false,
    "totals": {
      "amount": 1250.5,
      "count": 8
    }
  }
}
```

**SDK Code**

```python
import requests

url = "https://ssuccessv2.com/app/api/v2/payment/deposit-batches/42"

payload = {
    "account_id": 7,
    "name": "July Tuition Deposit",
    "reference": "SLIP-0002",
    "note": "Corrected bank slip"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://ssuccessv2.com/app/api/v2/payment/deposit-batches/42';
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"account_id":7,"name":"July Tuition Deposit","reference":"SLIP-0002","note":"Corrected bank slip"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://ssuccessv2.com/app/api/v2/payment/deposit-batches/42"

	payload := strings.NewReader("{\n  \"account_id\": 7,\n  \"name\": \"July Tuition Deposit\",\n  \"reference\": \"SLIP-0002\",\n  \"note\": \"Corrected bank slip\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://ssuccessv2.com/app/api/v2/payment/deposit-batches/42")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"account_id\": 7,\n  \"name\": \"July Tuition Deposit\",\n  \"reference\": \"SLIP-0002\",\n  \"note\": \"Corrected bank slip\"\n}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.patch("https://ssuccessv2.com/app/api/v2/payment/deposit-batches/42")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"account_id\": 7,\n  \"name\": \"July Tuition Deposit\",\n  \"reference\": \"SLIP-0002\",\n  \"note\": \"Corrected bank slip\"\n}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('PATCH', 'https://ssuccessv2.com/app/api/v2/payment/deposit-batches/42', [
  'body' => '{
  "account_id": 7,
  "name": "July Tuition Deposit",
  "reference": "SLIP-0002",
  "note": "Corrected bank slip"
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://ssuccessv2.com/app/api/v2/payment/deposit-batches/42");
var request = new RestRequest(Method.PATCH);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"account_id\": 7,\n  \"name\": \"July Tuition Deposit\",\n  \"reference\": \"SLIP-0002\",\n  \"note\": \"Corrected bank slip\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [
  "account_id": 7,
  "name": "July Tuition Deposit",
  "reference": "SLIP-0002",
  "note": "Corrected bank slip"
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://ssuccessv2.com/app/api/v2/payment/deposit-batches/42")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "PATCH"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```