THthredfi
Vendor Refunds

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 UUID
    - `refund_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
get/v1/platform/businesses/{business_id}/vendor-refunds/

Request

  • Base URL
    https://docs.thredfi.com (the document declares no server; this is the origin it was published from)
  • Auth
    • HTTP bearer
    • or HTTP bearer
    • or HTTP basic
    • or HTTP bearer
    • or HTTP bearer

Path parameters

business_idstring required

Query parameters

currencystring

Filter by currency code (EUR, GBP, USD)

external_idstring

Filter by external ID (partial match)

is_fully_allocatedboolean

Filter by allocation status (true=fully allocated, false=has unallocated amount)

max_amountinteger

Maximum refund amount in cents

min_amountinteger

Minimum refund amount in cents

orderingstring

Order results by field (prefix with - for descending)

pageinteger

A page number within the paginated result set.

page_sizeinteger

Number of results to return per page.

reference_numberstring

Filter by reference number (partial match)

refund_date_endstring date

Filter refunds to this date (YYYY-MM-DD)

refund_date_startstring date

Filter refunds from this date (YYYY-MM-DD)

refund_type'billing_error' | 'credit_balance' | 'duplicate_payment' | 'goods_return' | 'other' | 'overpayment' | 'service_cancellation'

Filter by refund type

  • overpayment - Overpayment Refund
  • credit_balance - Credit Balance Refund
  • duplicate_payment - Duplicate Payment
  • billing_error - Billing Error
  • goods_return - Goods Return
  • service_cancellation - Service Cancellation
  • other - Other
searchstring

Search across reference_number, external_id, description, vendor name

statusstring

Filter by refund status (comma-separated for multiple)

vendor_external_idstring

Filter by vendor external ID

vendor_idstring

Filter by vendor ID (supports comma-separated UUIDs for multiple vendors)

Response

countinteger required

Total number of items

Example response

{
  "count": 123,
  "page_info": {
    "total_count": 123,
    "current_page": 1,
    "total_pages": 7,
    "page_size": 20
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.