Skip to main content
GET
Get Vendor Credit

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
Pattern: ^[0-9a-f-]+$
credit_id
string<uuid>
required

A UUID string identifying this vendor credit note.

Response

Vendor credit serializer for API responses.

id
string<uuid>
required
read-only

Unique vendor credit identifier

status
string
required
read-only

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

received_at
string<date-time>
required
read-only

When the credit was received

vendor
object
required

Vendor who issued the credit (inline details)

source_bill_id
string<uuid> | null
required
read-only

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

line_items
object[]
required
read-only

Array of credit line items

allocations
object[]
required
read-only

Array of bill allocations

tags
object[]
required
read-only

Transaction tags for the credit

total_amount
integer
required
read-only

Total credit amount in cents

applied_amount
integer
required
read-only

Applied credit amount in cents

document
object
required

Latest document linked to this vendor credit

created_at
string<date-time>
required
read-only

Credit creation timestamp

updated_at
string<date-time>
required
read-only

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