Skip to main content
POST
/
customer-credits
/
{id}
/
apply
Apply credit memo to an order
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
}
'
{
  "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"
}

Documentation Index

Fetch the complete documentation index at: https://docs.arcuserp.com/llms.txt

Use this file to discover all available pages before exploring further.

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
required

Must not exceed remaining credit or order balance.

Required range: x >= 0.01

Response

Updated credit memo after application

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.

​
id
string<uuid>
read-only
​
entity_id
string<uuid>
read-only
​
account_id
string<uuid>

The customer account this credit belongs to.

​
amount
number

Original credit amount issued.

​
open_balance
number
read-only

Remaining unapplied balance.

​
status
enum<string>
read-only
Available options:
open,
partially_applied,
fully_applied,
voided
​
reason
string | null
​
memo
string | null
​
gl_account_id
string<uuid> | null

Clearing account used for this credit.

​
journal_entry_id
string<uuid> | null
read-only

The GL entry that created this credit.

​
created_at
string<date-time>
read-only
​
updated_at
string<date-time>
read-only
​
voided_at
string<date-time> | null
read-only