vendors

Get list of all active vendors

Vendor Type Codes

Vendor Type Type Description
OTHER 1 Previously 'OTHER' vendor (ID=1), used for storing non-vendor
for storing non-vendor Vendor names in request.
HIDDEN 2 New type of vendors that is reserved for system purposes (eg. Amazon Business).
PREFERRED (default) 3 The default vendors from previous list
where active vendor dropdowns everywhere previously showed.
Request now ONLY shows these vendors (+OTHER)
REGULAR 4 New type of vendors that are non-preferred,
for any AP purposes and purchasers to update.
(DOES NOT show up in Request, but shows up in Procure)
EMPLOYEE 5 New type of vendors that do not show up anywhere except in AP employees list.
CC_PROVIDER 6 Similar type of vendors to AP employees, but for AP credit card providers.
SecurityRemoteAuthentication or M2MAuthentication or BasicAuthentication or cookieAuth
Request
path Parameters
vendor_group
required
string

"all": Get list of all vendors.

"credit_card_providers": Get list of credit card provider vendors. These vendors are displayed in Payee Management for Credit Card Providers.

"default": Get list of "preferred" and "regular" vendors. These vendors are displayed in Procure (procurement, vendors, etc) and AP i.e., default vendor list. OTHER is discontinued from procure.

"other": Get list of "other" vendors. Only returns the 'OTHER' vendor reserved for requesting non-vendor names.

"preferred": Get list of "preferred" vendors.

"purchasable": Get list of "purchasable" vendors.

"requestable": Get list of "requestable" vendors. These vendors are displayed in Request and designated by Purchaser.

Enum: "all" "credit_card_providers" "default" "other" "preferred" "purchasable" "requestable"
query Parameters
exclude_other
boolean
external_id
string
format
string
Enum: "csv" "json"
name
string
order_by
string

Which field to use when ordering the results.

page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

search
string

A search term.

type
integer

Type of the vendor. See above for possible options.

  • 1 - other
  • 2 - amazon punchout
  • 3 - preferred
  • 4 - regular
  • 5 - employee
  • 6 - credit card provider
  • 7 - checkout
Enum: 1 2 3 4 5 6 7
type__in
Array of strings
  • other - other
  • amazon_punchout - amazon_punchout
  • preferred - preferred
  • regular - regular
  • employee - employee
  • cc_provider - cc_provider
  • checkout - checkout
  • pending - pending
Items Enum: "amazon_punchout" "cc_provider" "checkout" "employee" "other" "pending" "preferred" "regular"
Responses
200
Response Schema:
object
Array of objects (OptimizedVendor)
get/api/v3/vendors/
Response samples
{
  • "metadata": {
    },
  • "data": [
    ]
}

Create Vendor

Create a new vendor

Due to having multiple vendors with the same name, especially common if user keeps deleting vendors with the same name, these deleted vendors get thrown into the inactive list.

Vendor Types

Vendor Type Type
OTHER 1
HIDDEN 2
PREFERRED (default) 3
REGULAR 4
EMPLOYEE 5
CC_PROVIDER 6
SecurityRemoteAuthentication or M2MAuthentication or BasicAuthentication or cookieAuth
Request
query Parameters
format
string
Enum: "csv" "json"
Request Body schema:
required
name
required
string [ 1 .. 150 ] characters

Name of the vendor

active
boolean
addressLineOne
string or null (Address line 1) <= 300 characters

First line of address

addressLineTwo
string or null (Address line 2) <= 300 characters

Second line of address

postalCode
string or null (Postal Code) <= 20 characters

Postal or Zip code of the vendor

city
string or null <= 50 characters

City of the vendor

state_province
string or null (State/Province) <= 40 characters

State or Province of the vendor

country
string or null <= 80 characters

Country of the vendor

phoneOne
string or null <= 20 characters

Primary phone no. of the vendor

phoneTwo
string or null <= 20 characters

Secondary phone no. of the vendor

fax
string or null <= 20 characters

Fax no. of the vendor

email
required
Array of strings <email>
comments
string or null

Notes about the vendor

contact
string or null <= 50 characters

Contact person of the vendor

url
string or null <= 200 characters

Website of the vendor

external_id
string or null <= 100 characters

External id of the vendor

currency
integer or null
object or null
object or null
object or null
object or null
tax
integer or null
type
required
integer (VendorTypeEnum)
  • 2 - amazon punchout
  • 3 - preferred
  • 4 - regular
  • 6 - credit card provider
  • 7 - checkout
Enum: 2 3 4 6 7
default_payment_method
integer or null
is_1099_eligible
boolean or null (1099 Eligible?)
overall_score
required
string or null <decimal> ^-?\d{0,2}(?:\.\d{0,3})?$
is_auto_email_po_enabled
boolean
po_pdf_labels
string <= 200 characters

Placeholder for a KVStore value

Responses
201
Response Schema:
object
Default: {}
required
object (VendorDetail)
post/api/v3/vendors/
Request samples
{
  • "name": "string",
  • "active": true,
  • "addressLineOne": "string",
  • "addressLineTwo": "string",
  • "postalCode": "string",
  • "city": "string",
  • "state_province": "string",
  • "country": "string",
  • "phoneOne": "string",
  • "phoneTwo": "string",
  • "fax": "string",
  • "email": [
    ],
  • "comments": "string",
  • "contact": "string",
  • "url": "string",
  • "external_id": "string",
  • "currency": 0,
  • "payment_term_ref": {
    },
  • "shipping_term_ref": {
    },
  • "payment_method_ref": {
    },
  • "shipping_method_ref": {
    },
  • "tax": 0,
  • "type": 2,
  • "default_payment_method": 0,
  • "is_1099_eligible": true,
  • "overall_score": "string",
  • "is_auto_email_po_enabled": true,
  • "po_pdf_labels": "string"
}
Response samples
{
  • "metadata": { },
  • "data": {
    }
}

Get Vendor by ID

Get detail of a vendor by id

SecurityRemoteAuthentication or M2MAuthentication or BasicAuthentication or cookieAuth
Request
path Parameters
id
required
integer

A unique integer value identifying this vendor.

query Parameters
format
string
Enum: "csv" "json"
Responses
200
Response Schema:
object
Default: {}
required
object (VendorDetail)
get/api/v3/vendors/{id}/
Response samples
{
  • "metadata": { },
  • "data": {
    }
}

Update Vendor

SecurityRemoteAuthentication or M2MAuthentication or BasicAuthentication or cookieAuth
Request
path Parameters
id
required
integer

A unique integer value identifying this vendor.

query Parameters
format
string
Enum: "csv" "json"
Request Body schema:
required
name
required
string [ 1 .. 150 ] characters

Name of the vendor

active
boolean
addressLineOne
string or null (Address line 1) <= 300 characters

First line of address

addressLineTwo
string or null (Address line 2) <= 300 characters

Second line of address

postalCode
string or null (Postal Code) <= 20 characters

Postal or Zip code of the vendor

city
string or null <= 50 characters

City of the vendor

state_province
string or null (State/Province) <= 40 characters

State or Province of the vendor

country
string or null <= 80 characters

Country of the vendor

phoneOne
string or null <= 20 characters

Primary phone no. of the vendor

phoneTwo
string or null <= 20 characters

Secondary phone no. of the vendor

fax
string or null <= 20 characters

Fax no. of the vendor

email
required
Array of strings <email>
comments
string or null

Notes about the vendor

contact
string or null <= 50 characters

Contact person of the vendor

url
string or null <= 200 characters

Website of the vendor

external_id
string or null <= 100 characters

External id of the vendor

currency
integer or null
object or null
object or null
object or null
object or null
tax
integer or null
type
required
integer (VendorTypeEnum)
  • 2 - amazon punchout
  • 3 - preferred
  • 4 - regular
  • 6 - credit card provider
  • 7 - checkout
Enum: 2 3 4 6 7
default_payment_method
integer or null
is_1099_eligible
boolean or null (1099 Eligible?)
overall_score
required
string or null <decimal> ^-?\d{0,2}(?:\.\d{0,3})?$
is_auto_email_po_enabled
boolean
po_pdf_labels
string <= 200 characters

Placeholder for a KVStore value

Responses
200
Response Schema:
object
Default: {}
required
object (Vendor)
put/api/v3/vendors/{id}/
Request samples
{
  • "name": "string",
  • "active": true,
  • "addressLineOne": "string",
  • "addressLineTwo": "string",
  • "postalCode": "string",
  • "city": "string",
  • "state_province": "string",
  • "country": "string",
  • "phoneOne": "string",
  • "phoneTwo": "string",
  • "fax": "string",
  • "email": [
    ],
  • "comments": "string",
  • "contact": "string",
  • "url": "string",
  • "external_id": "string",
  • "currency": 0,
  • "payment_term_ref": {
    },
  • "shipping_term_ref": {
    },
  • "payment_method_ref": {
    },
  • "shipping_method_ref": {
    },
  • "tax": 0,
  • "type": 2,
  • "default_payment_method": 0,
  • "is_1099_eligible": true,
  • "overall_score": "string",
  • "is_auto_email_po_enabled": true,
  • "po_pdf_labels": "string"
}
Response samples
{
  • "metadata": { },
  • "data": {
    }
}

Partial Update Vendor

SecurityRemoteAuthentication or M2MAuthentication or BasicAuthentication or cookieAuth
Request
path Parameters
id
required
integer

A unique integer value identifying this vendor.

query Parameters
format
string
Enum: "csv" "json"
Request Body schema:
name
string [ 1 .. 150 ] characters

Name of the vendor

active
boolean
addressLineOne
string or null (Address line 1) <= 300 characters

First line of address

addressLineTwo
string or null (Address line 2) <= 300 characters

Second line of address

postalCode
string or null (Postal Code) <= 20 characters

Postal or Zip code of the vendor

city
string or null <= 50 characters

City of the vendor

state_province
string or null (State/Province) <= 40 characters

State or Province of the vendor

country
string or null <= 80 characters

Country of the vendor

phoneOne
string or null <= 20 characters

Primary phone no. of the vendor

phoneTwo
string or null <= 20 characters

Secondary phone no. of the vendor

fax
string or null <= 20 characters

Fax no. of the vendor

email
Array of strings <email>
comments
string or null

Notes about the vendor

contact
string or null <= 50 characters

Contact person of the vendor

url
string or null <= 200 characters

Website of the vendor

external_id
string or null <= 100 characters

External id of the vendor

currency
integer or null
object or null
object or null
object or null
object or null
tax
integer or null
type
integer (VendorTypeEnum)
  • 2 - amazon punchout
  • 3 - preferred
  • 4 - regular
  • 6 - credit card provider
  • 7 - checkout
Enum: 2 3 4 6 7
default_payment_method
integer or null
is_1099_eligible
boolean or null (1099 Eligible?)
overall_score
string or null <decimal> ^-?\d{0,2}(?:\.\d{0,3})?$
is_auto_email_po_enabled
boolean
po_pdf_labels
string <= 200 characters

Placeholder for a KVStore value

Responses
200
Response Schema:
object
Default: {}
required
object (OptimizedVendor)
patch/api/v3/vendors/{id}/
Request samples
{
  • "name": "string",
  • "active": true,
  • "addressLineOne": "string",
  • "addressLineTwo": "string",
  • "postalCode": "string",
  • "city": "string",
  • "state_province": "string",
  • "country": "string",
  • "phoneOne": "string",
  • "phoneTwo": "string",
  • "fax": "string",
  • "email": [
    ],
  • "comments": "string",
  • "contact": "string",
  • "url": "string",
  • "external_id": "string",
  • "currency": 0,
  • "payment_term_ref": {
    },
  • "shipping_term_ref": {
    },
  • "payment_method_ref": {
    },
  • "shipping_method_ref": {
    },
  • "tax": 0,
  • "type": 2,
  • "default_payment_method": 0,
  • "is_1099_eligible": true,
  • "overall_score": "string",
  • "is_auto_email_po_enabled": true,
  • "po_pdf_labels": "string"
}
Response samples
{
  • "metadata": { },
  • "data": {
    }
}
➔ Next to currencies