THthredfi
Vendors

Create vendor

Create a new vendor within a business.

post/v1/platform/businesses/{business_id}/vendors/

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

Your unique identifier for this vendor (used for idempotency)

individual_namestring

Vendor individual name (required if company_name not provided)

company_namestring

Registered company name (required if individual_name not provided)

emailstring email

Primary email address for vendor communications

mobile_phonestring

Mobile phone number (E.164 format recommended, e.g., +44 7700 900123)

office_phonestring

Office phone number (E.164 format recommended, e.g., +44 20 7946 0958)

address_stringstring

Vendor mailing address (single string)

memostring

Internal notes or description for this vendor

countrystring

Two-letter country code (ISO 3166-1 alpha-2, e.g., NL, DE, US)

vat_numberstring

VAT/Tax registration number (e.g., NL123456789B01 for Netherlands)

Response

typestring required

Resource type (always 'VendorData')

idstring uuid required

Unique vendor identifier

external_idstring

Your unique identifier for this vendor (used for idempotency)

individual_namestring

Vendor individual name (for sole traders/freelancers)

company_namestring

Registered company name (for limited companies)

emailstring email

Primary email address for vendor communications

mobile_phonestring required

Mobile phone number (E.164 format, e.g., +44 7700 900123)

office_phonestring required

Office phone number (E.164 format, e.g., +44 20 7946 0958)

address_stringstring required

Full formatted address (read-only, auto-generated)

memostring required

Internal notes or description for this vendor

statusstring required

Vendor status (ACTIVE, INACTIVE, ARCHIVED, BLOCKED)

Changes

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