Apply credit memo to an order

Applies the credit memo to an open invoice/order as a payment, through the canonical credit-apply path (same code path as the internal UI): the memo’s balance_remaining and the account’s spendable credit_balance decrement, an order_payments row is recorded (method credit), order.balance_due / payment_status recalculate, and the GL entry posts (DR Customer Credits liability / CR Accounts Receivable).

Refusal guards:

• 409 order_already_fully_paid — target order has zero open balance. Issue an unapplied customer credit instead, or apply to a different open invoice.
• 422 apply_amount_exceeds_order_balance — requested apply amount is greater than the order’s current open balance. Reduce the amount and retry.
• 400 credit_memo_not_applicable — the memo is voided / expired / fully applied (terminal states are locked). The body includes the memo status.
• 422 amount_exceeds_balance_remaining — requested apply amount exceeds the credit’s balance_remaining.
• 403 credit_memo_account_mismatch — the memo belongs to a different customer account than the target order.

If amount is omitted, the full remaining credit is applied (capped at the order’s open balance). Industry parity: NetSuite + Acumatica + QuickBooks all refuse credit-to-fully-paid; Arcus matches that behavior.

POST /customer-credits/{id}/apply

Apply credit memo to an order

cURL

curl --request POST \
  --url https://api.arcuserp.com/v1/customer-credits/{id}/apply \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "amount": 1.01,
  "notes": "<string>"
}
'

import requests

url = "https://api.arcuserp.com/v1/customer-credits/{id}/apply"

payload = {
    "order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "amount": 1.01,
    "notes": "<string>"
}
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({
    order_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    amount: 1.01,
    notes: '<string>'
  })
};

fetch('https://api.arcuserp.com/v1/customer-credits/{id}/apply', 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/customer-credits/{id}/apply",
  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([
    'order_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'amount' => 1.01,
    'notes' => '<string>'
  ]),
  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/customer-credits/{id}/apply"

	payload := strings.NewReader("{\n  \"order_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"amount\": 1.01,\n  \"notes\": \"<string>\"\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/customer-credits/{id}/apply")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"order_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"amount\": 1.01,\n  \"notes\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.arcuserp.com/v1/customer-credits/{id}/apply")

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  \"order_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"amount\": 1.01,\n  \"notes\": \"<string>\"\n}"

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

200

{
  "credit_memo_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "amount_applied": 123,
  "balance_remaining": 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"
}

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

id · string<uuid> · required

Body

application/json

order_id · string<uuid> · required

amount · number

Must not exceed remaining credit or order open balance. Omit to apply the full remaining credit (capped at the order's open balance).

Required range: x >= 0.01

notes · string

Response

200

application/json

Application result

credit_memo_id · string<uuid>

order_id · string<uuid>

amount_applied · number

balance_remaining · number

Memo balance remaining after this application.