Skip to main content
GET
/
vendor-credits
/
{id}
Retrieve a vendor credit
curl --request GET \
  --url https://api.arcuserp.com/v1/vendor-credits/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "object": "vendor_credit",
  "entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "credit_number": "<string>",
  "vendor_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "amount": 123,
  "amount_applied": 123,
  "reason": "return",
  "source_vendor_return_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "issued",
  "issued_at": "2023-11-07T05:31:56Z",
  "notes": "<string>"
}

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

Query Parameters

​
expand[]
enum<string>[]
Available options:
vendor,
source,
applications

Response

Vendor credit

A credit issued by a vendor (reduces AP balance or refunds a payment).

​
id
string<uuid>
​
object
enum<string>
Available options:
vendor_credit
​
entity_id
string<uuid>
read-only
​
credit_number
string
read-only
​
vendor_id
string<uuid>
​
amount
number
​
amount_applied
number
read-only
​
reason
enum<string>
Available options:
return,
price_adjustment,
duplicate_payment,
rebate,
other
​
source_vendor_return_id
string<uuid> | null
​
status
enum<string>
read-only
Available options:
issued,
partially_applied,
fully_applied,
voided
​
issued_at
string<date-time>
read-only
​
notes
string | null