Skip to main content
POST
/
credits
Issue a credit memo to an account
curl --request POST \
  --url https://api.arcuserp.com/v1/credits \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "amount": 123,
  "reason": "<string>",
  "source_type": "<string>",
  "source_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "expires_at": "2023-11-07T05:31:56Z",
  "notes": "<string>"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "object": "credit_memo",
  "entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "credit_memo_number": "<string>",
  "amount": 123,
  "amount_applied": 123,
  "amount_refunded": 123,
  "reason": "return",
  "source_return_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "source_order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "issued",
  "notes": "<string>",
  "issued_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.

Body

application/json
​
account_id
string<uuid>
required
​
amount
number
required

Credit amount in dollars (positive)

​
reason
string

Reason for issuing credit

​
source_type
string

Source reference type (e.g. 'return', 'adjustment')

​
source_id
string<uuid>
​
expires_at
​
notes
string

Response

Credit memo issued

A customer credit issued (reduces account credit_balance or refunds a payment).

​
id
string<uuid>
​
object
enum<string>
Available options:
credit_memo
​
entity_id
string<uuid>
read-only
​
account_id
string<uuid>
​
credit_memo_number
string
read-only
​
amount
number
​
amount_applied
number
read-only
​
amount_refunded
number
read-only
​
reason
enum<string>
Available options:
return,
write_off,
goodwill,
price_adjustment,
duplicate_payment,
other
​
source_return_id
string<uuid> | null
​
source_order_id
string<uuid> | null
​
status
enum<string>
read-only
Available options:
issued,
partially_applied,
fully_applied,
voided
​
notes
string | null
​
issued_at
string<date-time>
read-only
​
voided_at
string<date-time> | null
read-only