Create a customer credit memo
curl --request POST \
--url https://api.arcuserp.com/v1/customer-credits \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"amount": 1.01,
"reason": "<string>",
"source_type": "<string>",
"source_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"expires_at": "<string>",
"memo": "<string>",
"metadata": {}
}
'import requests
url = "https://api.arcuserp.com/v1/customer-credits"
payload = {
"account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"amount": 1.01,
"reason": "<string>",
"source_type": "<string>",
"source_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"expires_at": "<string>",
"memo": "<string>",
"metadata": {}
}
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({
account_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
amount: 1.01,
reason: '<string>',
source_type: '<string>',
source_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
expires_at: '<string>',
memo: '<string>',
metadata: {}
})
};
fetch('https://api.arcuserp.com/v1/customer-credits', 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",
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([
'account_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'amount' => 1.01,
'reason' => '<string>',
'source_type' => '<string>',
'source_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'expires_at' => '<string>',
'memo' => '<string>',
'metadata' => [
]
]),
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"
payload := strings.NewReader("{\n \"account_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"amount\": 1.01,\n \"reason\": \"<string>\",\n \"source_type\": \"<string>\",\n \"source_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"expires_at\": \"<string>\",\n \"memo\": \"<string>\",\n \"metadata\": {}\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")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"account_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"amount\": 1.01,\n \"reason\": \"<string>\",\n \"source_type\": \"<string>\",\n \"source_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"expires_at\": \"<string>\",\n \"memo\": \"<string>\",\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.arcuserp.com/v1/customer-credits")
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 \"account_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"amount\": 1.01,\n \"reason\": \"<string>\",\n \"source_type\": \"<string>\",\n \"source_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"expires_at\": \"<string>\",\n \"memo\": \"<string>\",\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"amount": 123,
"open_balance": 123,
"status": "open",
"reason": "<string>",
"memo": "<string>",
"gl_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"journal_entry_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"voided_at": "2023-11-07T05:31:56Z"
}{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"amount": 123,
"open_balance": 123,
"status": "open",
"reason": "<string>",
"memo": "<string>",
"gl_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"journal_entry_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"voided_at": "2023-11-07T05:31:56Z"
}{
"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 Receivable
Create a customer credit memo
Issues a credit memo against an account, posting the matching GL entry and increasing the account’s spendable credit balance for later application to an order. Supplying the same source_type and source_id again returns the existing memo instead of creating a duplicate.
POST
/
customer-credits
Create a customer credit memo
curl --request POST \
--url https://api.arcuserp.com/v1/customer-credits \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"amount": 1.01,
"reason": "<string>",
"source_type": "<string>",
"source_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"expires_at": "<string>",
"memo": "<string>",
"metadata": {}
}
'import requests
url = "https://api.arcuserp.com/v1/customer-credits"
payload = {
"account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"amount": 1.01,
"reason": "<string>",
"source_type": "<string>",
"source_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"expires_at": "<string>",
"memo": "<string>",
"metadata": {}
}
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({
account_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
amount: 1.01,
reason: '<string>',
source_type: '<string>',
source_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
expires_at: '<string>',
memo: '<string>',
metadata: {}
})
};
fetch('https://api.arcuserp.com/v1/customer-credits', 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",
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([
'account_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'amount' => 1.01,
'reason' => '<string>',
'source_type' => '<string>',
'source_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'expires_at' => '<string>',
'memo' => '<string>',
'metadata' => [
]
]),
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"
payload := strings.NewReader("{\n \"account_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"amount\": 1.01,\n \"reason\": \"<string>\",\n \"source_type\": \"<string>\",\n \"source_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"expires_at\": \"<string>\",\n \"memo\": \"<string>\",\n \"metadata\": {}\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")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"account_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"amount\": 1.01,\n \"reason\": \"<string>\",\n \"source_type\": \"<string>\",\n \"source_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"expires_at\": \"<string>\",\n \"memo\": \"<string>\",\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.arcuserp.com/v1/customer-credits")
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 \"account_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"amount\": 1.01,\n \"reason\": \"<string>\",\n \"source_type\": \"<string>\",\n \"source_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"expires_at\": \"<string>\",\n \"memo\": \"<string>\",\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"amount": 123,
"open_balance": 123,
"status": "open",
"reason": "<string>",
"memo": "<string>",
"gl_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"journal_entry_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"voided_at": "2023-11-07T05:31:56Z"
}{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"amount": 123,
"open_balance": 123,
"status": "open",
"reason": "<string>",
"memo": "<string>",
"gl_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"journal_entry_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"voided_at": "2023-11-07T05:31:56Z"
}{
"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
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.
Body
application/json
Required range:
x >= 0.01Registered credit source type (default: manual). Unregistered values are rejected 422.
Optional source-document UUID; forms the idempotency triple with source_type. Non-UUID values are rejected.
ISO date-time in the future
Free-text note stored on the credit memo.
Arbitrary object; serialized into the memo notes. Takes precedence over memo.
Response
Existing memo returned (idempotent replay of the same source_type + source_id)
A customer credit memo representing a future payment obligation by Arcus to an account. Tracks open_balance for partial application across multiple orders. GL: DR AR Clearing / CR AR on creation; DR AR / CR Cash on application.
The customer account this credit belongs to.
Original credit amount issued.
Remaining unapplied balance.
Available options:
open, partially_applied, fully_applied, voided Clearing account used for this credit.
The GL entry that created this credit.
Was this page helpful?