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>'
import requests

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

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.arcuserp.com/v1/vendor-credits/{id}', 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/vendor-credits/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

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

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "Bearer <token>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.arcuserp.com/v1/vendor-credits/{id}")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

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

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "vendor_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "credit_number": "<string>",
  "amount": "<string>",
  "remaining_amount": "<string>",
  "source_type": "manual",
  "source_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "expires_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_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

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 vendor credit -- a ledger entry that reduces what you owe a vendor. Issued from a vendor return, a negotiated discount, or a manual grant. Posts GL: DR vendor_returns_receivable / CR vendor_credits at issuance. Apply to an open vendor bill via POST /v1/ap-payments with vendor_credit_ids[]. Mirrors the canonical public.vendor_credits ledger (NOT the legacy vendor_bills negative-amount pattern).

id
string<uuid>
read-only
entity_id
string<uuid>
read-only
vendor_id
string<uuid>
credit_number
string
read-only

Auto-generated, e.g. VC-0000001

amount
string

Total issued amount (numeric, 4 dp)

remaining_amount
string
read-only

Unapplied balance (numeric, 4 dp)

source_type
enum<string>
default:manual

Origin of the credit. Free-form text; common values listed.

Available options:
manual,
vendor_return,
price_adjustment,
rebate,
duplicate_payment,
other
source_id
string<uuid> | null

Linked vendor_return or vendor_bill id when applicable

status
enum<string>
read-only
Available options:
open,
partially_applied,
applied,
voided,
expired
expires_at
string<date-time> | null

Forfeits remaining balance after this date; NULL = never expire

created_at
string<date-time>
read-only
updated_at
string<date-time>
read-only