Preview an edit of a posted bank deposit ticket
curl --request POST \
--url https://api.arcuserp.com/v1/deposits/{id}/edit-preview \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"deposit_date": "2023-12-25",
"memo": "<string>",
"remove_item_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"add_items": [
{}
]
}
'import requests
url = "https://api.arcuserp.com/v1/deposits/{id}/edit-preview"
payload = {
"deposit_date": "2023-12-25",
"memo": "<string>",
"remove_item_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"add_items": [{}]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
deposit_date: '2023-12-25',
memo: '<string>',
remove_item_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
add_items: [{}]
})
};
fetch('https://api.arcuserp.com/v1/deposits/{id}/edit-preview', 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}/edit-preview",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'deposit_date' => '2023-12-25',
'memo' => '<string>',
'remove_item_ids' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'add_items' => [
[
]
]
]),
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}/edit-preview"
payload := strings.NewReader("{\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 ]\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.arcuserp.com/v1/deposits/{id}/edit-preview")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\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 ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.arcuserp.com/v1/deposits/{id}/edit-preview")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\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 ]\n}"
response = http.request(request)
puts response.read_body{
"before": {},
"after": {},
"difference": 123,
"entry": {},
"sentence": "<string>",
"warnings": [
{}
]
}{
"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
Preview an edit of a posted bank deposit ticket
Everything PATCH /deposits/ would do, decided and named, with nothing written: the before and after totals, the entry it would reverse and post with both dates, the sentence the edit dialog shows, and a warning when a bank line would stop pairing the ticket. A refusal is the PATCH’s own envelope (the same codes and statuses). Requires accounting:write scope.
POST
/
deposits
/
{id}
/
edit-preview
Preview an edit of a posted bank deposit ticket
curl --request POST \
--url https://api.arcuserp.com/v1/deposits/{id}/edit-preview \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"deposit_date": "2023-12-25",
"memo": "<string>",
"remove_item_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"add_items": [
{}
]
}
'import requests
url = "https://api.arcuserp.com/v1/deposits/{id}/edit-preview"
payload = {
"deposit_date": "2023-12-25",
"memo": "<string>",
"remove_item_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"add_items": [{}]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
deposit_date: '2023-12-25',
memo: '<string>',
remove_item_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
add_items: [{}]
})
};
fetch('https://api.arcuserp.com/v1/deposits/{id}/edit-preview', 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}/edit-preview",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'deposit_date' => '2023-12-25',
'memo' => '<string>',
'remove_item_ids' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'add_items' => [
[
]
]
]),
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}/edit-preview"
payload := strings.NewReader("{\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 ]\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.arcuserp.com/v1/deposits/{id}/edit-preview")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\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 ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.arcuserp.com/v1/deposits/{id}/edit-preview")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\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 ]\n}"
response = http.request(request)
puts response.read_body{
"before": {},
"after": {},
"difference": 123,
"entry": {},
"sentence": "<string>",
"warnings": [
{}
]
}{
"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.
Path Parameters
Body
application/json
Was this page helpful?

