Skip to main content
GET
/
v1
/
platform
/
businesses
/
{business_id}
/
vendor-credits
/
{credit_id}
Get Vendor Credit
curl --request GET \
  --url https://sandbox.thredfi.com/v1/platform/businesses/{business_id}/vendor-credits/{credit_id}/ \
  --header 'Authorization: Bearer <token>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "<string>",
  "received_at": "2023-11-07T05:31:56Z",
  "vendor": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "external_id": "<string>",
    "display_name": "<string>"
  },
  "source_bill_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "line_items": [
    {
      "amount": 123,
      "expense_account_identifier": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "type": "AccountId"
      },
      "tags": [
        "<string>"
      ],
      "memo": "<string>",
      "metadata": "<unknown>"
    }
  ],
  "allocations": [
    {
      "bill_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "bill_number": "<string>",
      "amount_cents": 123,
      "bill_outstanding_balance_cents": 123,
      "applied_at": "2023-11-07T05:31:56Z"
    }
  ],
  "tags": [
    {}
  ],
  "total_amount": 123,
  "applied_amount": 123,
  "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>",
  "currency": "EUR"
}

Authorizations

Authorization
string
header
required

Partner-level JWT token (unscoped). Token payload includes partner_id. Business access is validated via partner ownership. Format: Bearer <your-jwt-token>

Use this for: Multi-business operations where the business_id is specified in the URL and partner has access to multiple businesses.

Path Parameters

business_id
string
required
credit_id
string<uuid>
required

A UUID string identifying this vendor credit note.

Response

Vendor credit serializer for API responses.

id
string<uuid>
required

Unique vendor credit identifier

status
string
required

Credit status: draft, received, partially_applied, applied, void (computed from allocations)

received_at
string<date-time>
required

When the credit was received

vendor
object
required

Vendor who issued the credit (inline details)

source_bill_id
string<uuid> | null
required

Bill ID this credit was created from (origin tracking, not allocation)

line_items
object[]
required

Array of credit line items

allocations
object[]
required

Array of bill allocations

tags
object[]
required

Transaction tags for the credit

total_amount
integer
required

Total credit amount in cents

applied_amount
integer
required

Applied credit amount in cents

document
object
required

Latest document linked to this vendor credit

created_at
string<date-time>
required

Credit creation timestamp

updated_at
string<date-time>
required

Last update timestamp

external_id
string

Your external system identifier for this credit (used for idempotency)

Maximum string length: 255
currency
enum<string>

Credit currency (e.g., GBP, EUR, USD)

  • EUR - Euro
  • GBP - British Pound
  • USD - US Dollar
  • SEK - Swedish Krona
  • NOK - Norwegian Krone
  • DKK - Danish Krone
  • ISK - Icelandic Króna
  • MYR - Malaysian Ringgit
  • SGD - Singapore Dollar
Available options:
EUR,
GBP,
USD,
SEK,
NOK,
DKK,
ISK,
MYR,
SGD