curl --request GET \
--url https://sandbox.thredfi.com/v1/platform/businesses/{business_id}/vendor-refunds/ \
--header 'Authorization: Bearer <token>'import requests
url = "https://sandbox.thredfi.com/v1/platform/businesses/{business_id}/vendor-refunds/"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://sandbox.thredfi.com/v1/platform/businesses/{business_id}/vendor-refunds/', 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://sandbox.thredfi.com/v1/platform/businesses/{business_id}/vendor-refunds/",
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://sandbox.thredfi.com/v1/platform/businesses/{business_id}/vendor-refunds/"
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://sandbox.thredfi.com/v1/platform/businesses/{business_id}/vendor-refunds/")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.thredfi.com/v1/platform/businesses/{business_id}/vendor-refunds/")
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{
"count": 123,
"page_info": {
"total_count": 123,
"current_page": 1,
"total_pages": 7,
"page_size": 20
},
"results": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"vendor_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"vendor_name": "<string>",
"total_refunded_amount": 123,
"allocated_amount": 123,
"unallocated_amount": 123,
"allocations": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"amount": 123,
"bill_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"bill_number": "<string>",
"bill_outstanding_balance_cents": 123,
"bill_payment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"target_description": "<string>",
"allocation_type": "bill",
"allocation_date": "2023-11-07T05:31:56Z",
"description": "<string>",
"metadata": "<unknown>"
}
],
"vendor_refund_payments": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"vendor_refund_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"refunded_amount": 123,
"processing_fee": 123,
"net_amount": 123,
"reconciled_bank_transactions": [
{
"bank_transaction_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"bank_transaction_date": "2023-11-07T05:31:56Z",
"bank_transaction_amount_cents": 123,
"bank_transaction_direction": "<string>",
"reconciled_amount_cents": 123,
"reconciliation_link_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"reconciled_at": "2023-11-07T05:31:56Z",
"currency": "<string>",
"payment_type": "<string>",
"bank_account_name": "<string>",
"notes": "<string>"
}
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"payment_reference": "<string>",
"processor_payment_id": "<string>",
"payment_date": "2023-12-25",
"payment_method": "bank_transfer",
"processor": "stripe",
"status": "pending",
"submitted_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z",
"failed_at": "2023-11-07T05:31:56Z",
"failure_reason": "<string>",
"description": "<string>",
"memo": "<string>",
"metadata": "<unknown>",
"transaction_tags": "<unknown>"
}
],
"document": {
"url": "<string>",
"expires_in": 123,
"document_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"file_name": "<string>",
"file_size": 123,
"mime_type": "<string>"
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"external_id": "<string>",
"refund_type": "overpayment",
"reference_number": "<string>",
"refund_date": "2023-12-25",
"expected_completion_date": "2023-12-25",
"currency": "EUR",
"status": "pending",
"description": "<string>",
"memo": "<string>",
"reason": "<string>",
"metadata": "<unknown>"
}
]
}List vendor refunds
List all vendor refunds for a business with advanced filtering and search.
Features:
- Filter by status, refund type, vendor, date range, amount
- Full-text search across reference numbers and descriptions
- Sort by any field
- Pagination support
Use Cases:
- View all pending refunds requiring processing
- Find refunds for a specific vendor
- Track refund history for accounting reconciliation
- Monitor unallocated refunds
Available Filters:
status: Filter by refund status (pending, partially_allocated, allocated, completed, cancelled). Comma-separated for multiple.refund_type: Filter by type (overpayment, credit_balance, billing_error, etc.)vendor_id: Filter by specific vendor UUIDrefund_date_start/refund_date_end: Filter by date range (YYYY-MM-DD)min_amount/max_amount: Filter by amount range (in cents)currency: Filter by currency code (EUR, GBP, USD)is_fully_allocated: Filter by allocation status (true/false)search: Full-text search across reference_number, external_id, description, vendor name
Ordering:
- Default:
-refund_date,-created_at(newest first) - Options:
refund_date,total_refunded_amount_cents,status,vendor__company_name - Prefix with
-for descending order
curl --request GET \
--url https://sandbox.thredfi.com/v1/platform/businesses/{business_id}/vendor-refunds/ \
--header 'Authorization: Bearer <token>'import requests
url = "https://sandbox.thredfi.com/v1/platform/businesses/{business_id}/vendor-refunds/"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://sandbox.thredfi.com/v1/platform/businesses/{business_id}/vendor-refunds/', 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://sandbox.thredfi.com/v1/platform/businesses/{business_id}/vendor-refunds/",
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://sandbox.thredfi.com/v1/platform/businesses/{business_id}/vendor-refunds/"
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://sandbox.thredfi.com/v1/platform/businesses/{business_id}/vendor-refunds/")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.thredfi.com/v1/platform/businesses/{business_id}/vendor-refunds/")
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{
"count": 123,
"page_info": {
"total_count": 123,
"current_page": 1,
"total_pages": 7,
"page_size": 20
},
"results": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"vendor_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"vendor_name": "<string>",
"total_refunded_amount": 123,
"allocated_amount": 123,
"unallocated_amount": 123,
"allocations": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"amount": 123,
"bill_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"bill_number": "<string>",
"bill_outstanding_balance_cents": 123,
"bill_payment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"target_description": "<string>",
"allocation_type": "bill",
"allocation_date": "2023-11-07T05:31:56Z",
"description": "<string>",
"metadata": "<unknown>"
}
],
"vendor_refund_payments": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"vendor_refund_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"refunded_amount": 123,
"processing_fee": 123,
"net_amount": 123,
"reconciled_bank_transactions": [
{
"bank_transaction_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"bank_transaction_date": "2023-11-07T05:31:56Z",
"bank_transaction_amount_cents": 123,
"bank_transaction_direction": "<string>",
"reconciled_amount_cents": 123,
"reconciliation_link_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"reconciled_at": "2023-11-07T05:31:56Z",
"currency": "<string>",
"payment_type": "<string>",
"bank_account_name": "<string>",
"notes": "<string>"
}
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"payment_reference": "<string>",
"processor_payment_id": "<string>",
"payment_date": "2023-12-25",
"payment_method": "bank_transfer",
"processor": "stripe",
"status": "pending",
"submitted_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z",
"failed_at": "2023-11-07T05:31:56Z",
"failure_reason": "<string>",
"description": "<string>",
"memo": "<string>",
"metadata": "<unknown>",
"transaction_tags": "<unknown>"
}
],
"document": {
"url": "<string>",
"expires_in": 123,
"document_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"file_name": "<string>",
"file_size": 123,
"mime_type": "<string>"
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"external_id": "<string>",
"refund_type": "overpayment",
"reference_number": "<string>",
"refund_date": "2023-12-25",
"expected_completion_date": "2023-12-25",
"currency": "EUR",
"status": "pending",
"description": "<string>",
"memo": "<string>",
"reason": "<string>",
"metadata": "<unknown>"
}
]
}Authorizations
Business-scoped JWT token. Token payload includes business_id to automatically scope requests. Format: Bearer <your-jwt-token>
Use this for: Business-specific operations where the business context is embedded in the token.
Path Parameters
^[0-9a-f-]+$Query Parameters
Filter by currency code (EUR, GBP, USD)
Filter by external ID (partial match)
Filter by allocation status (true=fully allocated, false=has unallocated amount)
Maximum refund amount in cents
Minimum refund amount in cents
Order results by field (prefix with - for descending)
A page number within the paginated result set.
Number of results to return per page.
Filter by reference number (partial match)
Filter refunds to this date (YYYY-MM-DD)
Filter refunds from this date (YYYY-MM-DD)
Filter by refund type
overpayment- Overpayment Refundcredit_balance- Credit Balance Refundduplicate_payment- Duplicate Paymentbilling_error- Billing Errorgoods_return- Goods Returnservice_cancellation- Service Cancellationother- Other
billing_error, credit_balance, duplicate_payment, goods_return, other, overpayment, service_cancellation Search across reference_number, external_id, description, vendor name
Filter by refund status (comma-separated for multiple)
Filter by vendor external ID
Filter by vendor ID (supports comma-separated UUIDs for multiple vendors)
Was this page helpful?