POST
Create a vendor
Company space For: Buyer, Manager · Permission: vendors.create Conditions
  • name and phone_number are required.
  • name is lower-cased and must be unique among the company’s suppliers.
  • email must be a valid address; max_debt_balance and max_order_amount must be 0 or more with at most currency_exponent decimals; standard_payment_terms must be an integer of 0 or more.
  • country, when sent, is free text of 255 characters at most.
What else happens
  • The supplier is created for the current company and organization, not creditable (is_creditable false) and with standard_payment_terms 0 unless sent.
Part of Manage suppliers.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

response
enum<string>
default:none

Response mode. Default none; none answers 204 No Content.

Available options:
none,
resource
fields
string

Comma-separated JSON keys of the root resource (id is always rendered). Available: id, name, id_number, phone_number, address, country, email, is_creditable, max_debt_balance, max_order_amount, standard_payment_terms, computed_debt, created_at, updated_at.

include
string

Comma-separated include paths, each optionally followed by its fields in parentheses: units(id,sku),units.uomUnit(id,name). Max depth 6, max 40 paths. Available: .

Response

Resource (only with response=resource).

id

Identifier of the supplier (27-character KSUID).

name

Supplier name, stored in lower case.

id_number

Tax or registration number of the supplier.

phone_number

Phone number of the supplier.

address

Postal address of the supplier.

country

Country of the supplier, free text as entered.

email

Email address of the supplier.

is_creditable
boolean

Whether the company may buy on credit from this supplier.

max_debt_balance
number | null

Maximum total debt allowed toward this supplier; null means no limit. In major units (the stored minor-unit amount divided by 10 to the power currency_exponent).

max_order_amount
number | null

Maximum payable total of a single credit purchase; null means no limit. In major units (the stored minor-unit amount divided by 10 to the power currency_exponent).

standard_payment_terms
integer | null

Default number of days before a credit purchase is due, used when a credit purchase has no due date.

computed_debt
number

Amount currently owed to the supplier: the sum of remaining_amount of its credit purchases in pending, completed or closed status. In major units (the stored minor-unit amount divided by 10 to the power currency_exponent).

created_at

Date and time the record was created (ISO 8601, UTC).

updated_at

Date and time the record was last changed (ISO 8601, UTC).