Apply or release the account credit hold

curl --request POST \
  --url https://api.arcuserp.com/v1/accounts/{id}/credit-hold \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "on_hold": true,
  "reason": "manual"
}
'

import requests

url = "https://api.arcuserp.com/v1/accounts/{id}/credit-hold"

payload = {
    "on_hold": True,
    "reason": "manual"
}
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({on_hold: true, reason: 'manual'})
};

fetch('https://api.arcuserp.com/v1/accounts/{id}/credit-hold', 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/accounts/{id}/credit-hold",
  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([
    'on_hold' => true,
    'reason' => 'manual'
  ]),
  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/accounts/{id}/credit-hold"

	payload := strings.NewReader("{\n  \"on_hold\": true,\n  \"reason\": \"manual\"\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/accounts/{id}/credit-hold")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"on_hold\": true,\n  \"reason\": \"manual\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.arcuserp.com/v1/accounts/{id}/credit-hold")

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  \"on_hold\": true,\n  \"reason\": \"manual\"\n}"

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

{
  "data": {
    "account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "is_credit_hold": true,
    "changed": true,
    "blocked_order_ids": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ],
    "released_order_ids": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ]
  }
}

{
  "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"
}

{
  "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"
}

Accounts

Apply or release the account credit hold

Applies or releases the credit hold on an account. Delegates to the canonical setCreditHold writer (utils/credit-hold-helpers.mjs), which owns the single SSOT path for every flip of accounts.is_credit_hold (Rule 23).

Side effects on apply (on_hold: true):

accounts.is_credit_hold = true
For every open sales order on this account (order_status IN ('draft','open','processing','awaiting_ach_clearance')), sets orders.is_credit_hold_blocked = true and credit_hold_blocked_at = NOW(). The orders_credit_hold_sync CHECK constraint enforces the pair stays consistent.
Realtime broadcast account.credit_hold_changed with full payload + secondary account.updated broadcast.
activity_log entry with action account_credit_hold_changed.

Side effects on release (on_hold: false):

accounts.is_credit_hold = false
Clears is_credit_hold_blocked / credit_hold_blocked_at on every order still carrying the flag for this account.
Same broadcast + activity log shape.

Idempotent: a re-POST that matches the current state returns 200 with changed: false and emits no new broadcast or activity row.

is_credit_hold is intentionally readOnly on the Account schema and BLOCKED by the PATCH allowlist on PATCH /v1/accounts/{id} (returns 422 forbidden_field). This dedicated action endpoint is the SSOT write surface, mirroring NetSuite’s creditHoldOverride writable field on the customer record.

Requires accounts:write scope.

POST

accounts

{id}

credit-hold

Apply or release the account credit hold

curl --request POST \
  --url https://api.arcuserp.com/v1/accounts/{id}/credit-hold \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "on_hold": true,
  "reason": "manual"
}
'

import requests

url = "https://api.arcuserp.com/v1/accounts/{id}/credit-hold"

payload = {
    "on_hold": True,
    "reason": "manual"
}
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({on_hold: true, reason: 'manual'})
};

fetch('https://api.arcuserp.com/v1/accounts/{id}/credit-hold', 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/accounts/{id}/credit-hold",
  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([
    'on_hold' => true,
    'reason' => 'manual'
  ]),
  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/accounts/{id}/credit-hold"

	payload := strings.NewReader("{\n  \"on_hold\": true,\n  \"reason\": \"manual\"\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/accounts/{id}/credit-hold")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"on_hold\": true,\n  \"reason\": \"manual\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.arcuserp.com/v1/accounts/{id}/credit-hold")

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  \"on_hold\": true,\n  \"reason\": \"manual\"\n}"

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

{
  "data": {
    "account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "is_credit_hold": true,
    "changed": true,
    "blocked_order_ids": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ],
    "released_order_ids": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ]
  }
}

{
  "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"
}

{
  "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"
}

Authorizations

Authorization

string

header

required

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

string<uuid>

required

Body

application/json

on_hold

boolean

required

true to apply the credit hold (and cascade-block open sales orders), false to release.

reason

string

Optional human-readable reason recorded in the activity_log row and the account.credit_hold_changed broadcast payload. Defaults to manual on apply and released on release when omitted.

Example:

"manual"

Response

Credit hold transition result

data

object

Show child attributes

Overview

All Endpoints

Apply or release the account credit hold

Authorizations

Path Parameters

Body

Response