THthredfi
Vendor Credits

Create Vendor Credit

Create a vendor credit note with line items and optional allocations. Supports idempotency via external_id and can create vendors on-the-fly using vendor_external_id.

post/v1/platform/businesses/{business_id}/vendor-credits/

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

Request body

external_idstring required

External system identifier for this vendor credit

vendor_idstring uuid

Existing vendor ID to assign credit to

vendor_external_idstring

External vendor ID. Will create vendor if not found

source_bill_idstring uuid nullable

Optional bill ID this credit note was created from (origin tracking, not allocation)

received_atstring date-time

When the credit was received (ISO 8601). Defaults to now if provided

tagsobject[]

Transaction tags for the credit

Response

idstring uuid required

Unique vendor credit identifier

external_idstring

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

statusstring required

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

received_atstring date-time required

When the credit was received

source_bill_idstring uuid nullable required

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

tagsobject[] required

Transaction tags for the credit

total_amountinteger required

Total credit amount in cents

applied_amountinteger required

Applied credit amount in cents

currency'EUR' | 'GBP' | 'USD' | 'SEK' | 'NOK' | 'DKK' | 'ISK' | 'MYR' | 'SGD'

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
created_atstring date-time required

Credit creation timestamp

updated_atstring date-time required

Last update timestamp

Changes

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