Update a posted bank deposit
curl --request PATCH \
--url https://api.arcuserp.com/v1/deposits/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"expected_updated_at": "2023-11-07T05:31:56Z",
"reason": "<string>",
"deposit_date": "2023-12-25",
"memo": "<string>",
"remove_item_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"add_items": [
{
"bank_check_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"register_session_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"order_payment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"amount": 123
}
]
}
'import requests
url = "https://api.arcuserp.com/v1/deposits/{id}"
payload = {
"expected_updated_at": "2023-11-07T05:31:56Z",
"reason": "<string>",
"deposit_date": "2023-12-25",
"memo": "<string>",
"remove_item_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"add_items": [
{
"bank_check_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"register_session_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"order_payment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"amount": 123
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
expected_updated_at: '2023-11-07T05:31:56Z',
reason: '<string>',
deposit_date: '2023-12-25',
memo: '<string>',
remove_item_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
add_items: [
{
bank_check_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
register_session_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
order_payment_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
amount: 123
}
]
})
};
fetch('https://api.arcuserp.com/v1/deposits/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.arcuserp.com/v1/deposits/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'expected_updated_at' => '2023-11-07T05:31:56Z',
'reason' => '<string>',
'deposit_date' => '2023-12-25',
'memo' => '<string>',
'remove_item_ids' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'add_items' => [
[
'bank_check_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'register_session_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'order_payment_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'amount' => 123
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.arcuserp.com/v1/deposits/{id}"
payload := strings.NewReader("{\n \"expected_updated_at\": \"2023-11-07T05:31:56Z\",\n \"reason\": \"<string>\",\n \"deposit_date\": \"2023-12-25\",\n \"memo\": \"<string>\",\n \"remove_item_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"add_items\": [\n {\n \"bank_check_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"register_session_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"order_payment_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"amount\": 123\n }\n ]\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(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.arcuserp.com/v1/deposits/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"expected_updated_at\": \"2023-11-07T05:31:56Z\",\n \"reason\": \"<string>\",\n \"deposit_date\": \"2023-12-25\",\n \"memo\": \"<string>\",\n \"remove_item_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"add_items\": [\n {\n \"bank_check_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"register_session_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"order_payment_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"amount\": 123\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.arcuserp.com/v1/deposits/{id}")
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 \"expected_updated_at\": \"2023-11-07T05:31:56Z\",\n \"reason\": \"<string>\",\n \"deposit_date\": \"2023-12-25\",\n \"memo\": \"<string>\",\n \"remove_item_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"add_items\": [\n {\n \"bank_check_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"register_session_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"order_payment_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"amount\": 123\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"deposit_number": "<string>",
"deposit_date": "2023-12-25",
"total_amount": 123,
"journal_entry_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"released_items": [
{}
],
"memo_only": true,
"previous_deposit_date": "2023-12-25",
"reversed_entry": {},
"reversal_entry": {},
"posted_entry": {},
"sweep_reversed_entry": {},
"sweep_posted_entry": {},
"sentence": "<string>"
}{
"error": "not_found",
"code": "not_found",
"type": "not_found",
"hint": "The requested order does not exist or does not belong to this entity.",
"param": "expand[0]",
"required": "accounts:read",
"request_id": "req_abc123",
"message": "<string>",
"field": "<string>",
"reason_code": "<string>",
"received": "<string>",
"picked": "2023-12-25",
"today": "2023-12-25",
"delta_days": 123,
"max_future_days": 123,
"max_backdate_days": 123
}{
"error": "not_found",
"code": "not_found",
"type": "not_found",
"hint": "The requested order does not exist or does not belong to this entity.",
"param": "expand[0]",
"required": "accounts:read",
"request_id": "req_abc123"
}{
"error": "not_found",
"code": "not_found",
"type": "not_found",
"hint": "The requested order does not exist or does not belong to this entity.",
"param": "expand[0]",
"required": "accounts:read",
"request_id": "req_abc123"
}{
"error": "not_found",
"code": "not_found",
"type": "not_found",
"hint": "The requested order does not exist or does not belong to this entity.",
"param": "expand[0]",
"required": "accounts:read",
"request_id": "req_abc123",
"message": "<string>",
"field": "<string>",
"reason_code": "<string>",
"received": "<string>",
"picked": "2023-12-25",
"today": "2023-12-25",
"delta_days": 123,
"max_future_days": 123,
"max_backdate_days": 123
}{
"error": "not_found",
"code": "not_found",
"type": "not_found",
"hint": "The requested order does not exist or does not belong to this entity.",
"param": "expand[0]",
"required": "accounts:read",
"request_id": "req_abc123",
"message": "<string>",
"field": "<string>",
"reason_code": "<string>",
"received": "<string>",
"picked": "2023-12-25",
"today": "2023-12-25",
"delta_days": 123,
"max_future_days": 123,
"max_backdate_days": 123
}{
"error": "not_found",
"code": "not_found",
"type": "not_found",
"hint": "The requested order does not exist or does not belong to this entity.",
"param": "expand[0]",
"required": "accounts:read",
"request_id": "req_abc123",
"message": "<string>",
"field": "<string>",
"reason_code": "<string>",
"received": "<string>",
"picked": "2023-12-25",
"today": "2023-12-25",
"delta_days": 123,
"max_future_days": 123,
"max_backdate_days": 123
}Accounting
Update a posted bank deposit
Adds or removes items on a posted deposit ticket, or changes its date or memo: the ticket’s journal entry is reversed on the ticket’s own date and the whole ticket is re-posted (one live entry per ticket), so both the original and the new date’s periods must be open. A removed check goes back to received, removed drawer cash returns to its session, and removed items are released, never deleted; every refusal writes nothing and is named by code (the 400, 404, 409 and 422 responses list them). Requires accounting:write scope and the key creator’s accounting.deposits.void permission.
PATCH
/
deposits
/
{id}
Update a posted bank deposit
curl --request PATCH \
--url https://api.arcuserp.com/v1/deposits/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"expected_updated_at": "2023-11-07T05:31:56Z",
"reason": "<string>",
"deposit_date": "2023-12-25",
"memo": "<string>",
"remove_item_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"add_items": [
{
"bank_check_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"register_session_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"order_payment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"amount": 123
}
]
}
'import requests
url = "https://api.arcuserp.com/v1/deposits/{id}"
payload = {
"expected_updated_at": "2023-11-07T05:31:56Z",
"reason": "<string>",
"deposit_date": "2023-12-25",
"memo": "<string>",
"remove_item_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"add_items": [
{
"bank_check_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"register_session_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"order_payment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"amount": 123
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
expected_updated_at: '2023-11-07T05:31:56Z',
reason: '<string>',
deposit_date: '2023-12-25',
memo: '<string>',
remove_item_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
add_items: [
{
bank_check_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
register_session_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
order_payment_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
amount: 123
}
]
})
};
fetch('https://api.arcuserp.com/v1/deposits/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.arcuserp.com/v1/deposits/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'expected_updated_at' => '2023-11-07T05:31:56Z',
'reason' => '<string>',
'deposit_date' => '2023-12-25',
'memo' => '<string>',
'remove_item_ids' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'add_items' => [
[
'bank_check_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'register_session_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'order_payment_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'amount' => 123
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.arcuserp.com/v1/deposits/{id}"
payload := strings.NewReader("{\n \"expected_updated_at\": \"2023-11-07T05:31:56Z\",\n \"reason\": \"<string>\",\n \"deposit_date\": \"2023-12-25\",\n \"memo\": \"<string>\",\n \"remove_item_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"add_items\": [\n {\n \"bank_check_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"register_session_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"order_payment_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"amount\": 123\n }\n ]\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(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.arcuserp.com/v1/deposits/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"expected_updated_at\": \"2023-11-07T05:31:56Z\",\n \"reason\": \"<string>\",\n \"deposit_date\": \"2023-12-25\",\n \"memo\": \"<string>\",\n \"remove_item_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"add_items\": [\n {\n \"bank_check_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"register_session_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"order_payment_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"amount\": 123\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.arcuserp.com/v1/deposits/{id}")
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 \"expected_updated_at\": \"2023-11-07T05:31:56Z\",\n \"reason\": \"<string>\",\n \"deposit_date\": \"2023-12-25\",\n \"memo\": \"<string>\",\n \"remove_item_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"add_items\": [\n {\n \"bank_check_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"register_session_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"order_payment_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"amount\": 123\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"deposit_number": "<string>",
"deposit_date": "2023-12-25",
"total_amount": 123,
"journal_entry_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"released_items": [
{}
],
"memo_only": true,
"previous_deposit_date": "2023-12-25",
"reversed_entry": {},
"reversal_entry": {},
"posted_entry": {},
"sweep_reversed_entry": {},
"sweep_posted_entry": {},
"sentence": "<string>"
}{
"error": "not_found",
"code": "not_found",
"type": "not_found",
"hint": "The requested order does not exist or does not belong to this entity.",
"param": "expand[0]",
"required": "accounts:read",
"request_id": "req_abc123",
"message": "<string>",
"field": "<string>",
"reason_code": "<string>",
"received": "<string>",
"picked": "2023-12-25",
"today": "2023-12-25",
"delta_days": 123,
"max_future_days": 123,
"max_backdate_days": 123
}{
"error": "not_found",
"code": "not_found",
"type": "not_found",
"hint": "The requested order does not exist or does not belong to this entity.",
"param": "expand[0]",
"required": "accounts:read",
"request_id": "req_abc123"
}{
"error": "not_found",
"code": "not_found",
"type": "not_found",
"hint": "The requested order does not exist or does not belong to this entity.",
"param": "expand[0]",
"required": "accounts:read",
"request_id": "req_abc123"
}{
"error": "not_found",
"code": "not_found",
"type": "not_found",
"hint": "The requested order does not exist or does not belong to this entity.",
"param": "expand[0]",
"required": "accounts:read",
"request_id": "req_abc123",
"message": "<string>",
"field": "<string>",
"reason_code": "<string>",
"received": "<string>",
"picked": "2023-12-25",
"today": "2023-12-25",
"delta_days": 123,
"max_future_days": 123,
"max_backdate_days": 123
}{
"error": "not_found",
"code": "not_found",
"type": "not_found",
"hint": "The requested order does not exist or does not belong to this entity.",
"param": "expand[0]",
"required": "accounts:read",
"request_id": "req_abc123",
"message": "<string>",
"field": "<string>",
"reason_code": "<string>",
"received": "<string>",
"picked": "2023-12-25",
"today": "2023-12-25",
"delta_days": 123,
"max_future_days": 123,
"max_backdate_days": 123
}{
"error": "not_found",
"code": "not_found",
"type": "not_found",
"hint": "The requested order does not exist or does not belong to this entity.",
"param": "expand[0]",
"required": "accounts:read",
"request_id": "req_abc123",
"message": "<string>",
"field": "<string>",
"reason_code": "<string>",
"received": "<string>",
"picked": "2023-12-25",
"today": "2023-12-25",
"delta_days": 123,
"max_future_days": 123,
"max_backdate_days": 123
}Authorizations
API key issued per entity via Settings > Developers > API Keys.
Each key carries scopes (e.g. orders:read, products:write).
Bearer token format: Authorization: Bearer ark_live_ent_Test keys use ark_test_ent_. Both are issued per entity
via Settings > Developers > API Keys.
Headers
Path Parameters
Body
application/json
The ticket's updated_at as last read; a stale value is refused deposit_changed_since_loaded.
Required string length:
3 - 500Show child attributes
Show child attributes
Response
The edited ticket, with the entries it moved beside it
The entry the edit reversed: id, entry_number, entry_date (the contra's date, the ticket's original date), amount
The ticket's new live entry: id, entry_number, entry_date, amount
Was this page helpful?