Suppliers

Suppliers

Returns information about suppliers.

More information: https://it.byu.edu
Contact Info: api@byu.edu

Base URL: /domains/erp/fs/suppliers

Version: v1

Schemes:

Summary

Path Operation Description
/* GET

Returns information for vendors and their locations that match the query string
/{vendor_id} GET

Returns information for a specific vendor and their locations.
/{vendor_id}/locations GET

Returns information for a specific vendor and any of their locations.
/{vendor_id}/locations/{location_code} GET

Returns information for a specific vendor and their specific location.
/{vendor_id}/locations/{location_code}/addresses/{address_type} GET

Returns information for a specific vendor and their specific location.

Paths

Returns information for vendors and their locations that match the query string

GET /*

Tags: supplier

If the user is not specific with the vendor name this could return multiple vendors with multiple locations attached to each vendor.
supplier_name

Returns any vendor with a partial match on the query string

 query string
200 OK #/responses/supplier_name_200

Success

suppliers
Example for application/json
{
    "supplier": {
        "category": "XYZ",
        "contacts": {
            "contact_name": "dwight",
            "email_id": "talk@gmail.com",
            "sequence_number": "2",
            "title": "manager",
            "url": "www.example.com"
        },
        "default_loc": 1,
        "location": {
            "addresses": {
                "address1": "Institute of Tech",
                "address2": "110 S State corner",
                "address3": "2000 Hope Ridge",
                "city": "Provo",
                "country": "United States",
                "email": "example@gmail.com",
                "state": "UT",
                "type": "Either Remit, Return or Invoice",
                "zip": "55555"
            },
            "location": "0001",
            "payment terms": "50",
            "withholding": "N"
        },
        "remit_loc": 1,
        "supplier id": "0123456789",
        "supplier name": "THE BEST UNIVERSITY",
        "tin": "123456789",
        "withholdings": {
            "default_class": "07",
            "default_jurisdiction": "Y",
            "entity": "IRS",
            "jurisdiction": "FED",
            "supplier_category": "NONE",
            "type": "1099",
            "withhold": "Y",
            "withholding_condition": "N"
        }
    }
}
400 Bad Request #/responses/supplier_name_400

Error

error_name_400
Example for application/json
{
    "validation_information": [
        "Location must have a value"
    ],
    "validation_response": {
        "code": 400,
        "message": "Bad Request"
    }
}
404 Not Found #/responses/supplier_name_404

Will return to many vendors, please be more specific

error_name_404
Example for application/json
{
    "validation_information": [
        "Supplier does not exist with specific location"
    ],
    "validation_response": {
        "code": 404,
        "message": "Bad Request"
    }
}
Returns information for a specific vendor and their locations.

GET /{vendor_id}

Tags: supplier

Each vendor could have multiple locations, but only one vendor should be returned
vendor_id

Returns a specific vendor that matches the vendor_id

 path string , must match [0-10]{10}
200 OK #/responses/supplier_200

Success

supplier
Example for application/json
{
    "supplier": {
        "category": "XYZ",
        "contacts": {
            "contact_name": "dwight",
            "email_id": "talk@gmail.com",
            "sequence_number": "2",
            "title": "manager",
            "url": "www.example.com"
        },
        "default_loc": 1,
        "location": {
            "addresses": {
                "address1": "Institute of Tech",
                "address2": "110 S State corner",
                "address3": "2000 Hope Ridge",
                "city": "Provo",
                "country": "United States",
                "email": "example@gmail.com",
                "state": "UT",
                "type": "Either Remit, Return or Invoice",
                "zip": "55555"
            },
            "location": "0001",
            "payment terms": "50",
            "withholding": "N"
        },
        "remit_loc": 1,
        "supplier id": "0123456789",
        "supplier name": "THE BEST UNIVERSITY",
        "tin": "123456789",
        "withholdings": {
            "default_class": "07",
            "default_jurisdiction": "Y",
            "entity": "IRS",
            "jurisdiction": "FED",
            "supplier_category": "NONE",
            "type": "1099",
            "withhold": "Y",
            "withholding_condition": "N"
        }
    }
}
400 Bad Request #/responses/supplier_400

Bad Request

error_vendor_400
Example for application/json
{
    "validation_information": [
        "Supplier ID must be 10 digits"
    ],
    "validation_response": {
        "code": 400,
        "message": "Bad Request"
    }
}
404 Not Found #/responses/supplier_404

Vendor Not Found

error_vendor_404
Example for application/json
{
    "validation_information": [
        "Supplier with Id (0123456789) not found."
    ],
    "validation_response": {
        "code": 404,
        "message": "Not Found"
    }
}
Returns information for a specific vendor and any of their locations.

GET /{vendor_id}/locations

Tags: supplier

Only one vendor should be returned but any number of locations
vendor_id

Returns a specific vendor that matches the vendor_id

 path string , must match [0-10]{10}
200 OK #/responses/supplier_200

Success

supplier
Example for application/json
{
    "supplier": {
        "category": "XYZ",
        "contacts": {
            "contact_name": "dwight",
            "email_id": "talk@gmail.com",
            "sequence_number": "2",
            "title": "manager",
            "url": "www.example.com"
        },
        "default_loc": 1,
        "location": {
            "addresses": {
                "address1": "Institute of Tech",
                "address2": "110 S State corner",
                "address3": "2000 Hope Ridge",
                "city": "Provo",
                "country": "United States",
                "email": "example@gmail.com",
                "state": "UT",
                "type": "Either Remit, Return or Invoice",
                "zip": "55555"
            },
            "location": "0001",
            "payment terms": "50",
            "withholding": "N"
        },
        "remit_loc": 1,
        "supplier id": "0123456789",
        "supplier name": "THE BEST UNIVERSITY",
        "tin": "123456789",
        "withholdings": {
            "default_class": "07",
            "default_jurisdiction": "Y",
            "entity": "IRS",
            "jurisdiction": "FED",
            "supplier_category": "NONE",
            "type": "1099",
            "withhold": "Y",
            "withholding_condition": "N"
        }
    }
}
400 Bad Request #/responses/supplier_400

Bad Request

error_vendor_400
Example for application/json
{
    "validation_information": [
        "Supplier ID must be 10 digits"
    ],
    "validation_response": {
        "code": 400,
        "message": "Bad Request"
    }
}
404 Not Found #/responses/supplier_404

Vendor Not Found

error_vendor_404
Example for application/json
{
    "validation_information": [
        "Supplier with Id (0123456789) not found."
    ],
    "validation_response": {
        "code": 404,
        "message": "Not Found"
    }
}
Returns information for a specific vendor and their specific location.

GET /{vendor_id}/locations/{location_code}

Tags: supplier

Only one vendor should be returned and a specific location
vendor_id

Returns a specific vendor that matches the vendor_id

 path string , must match [0-10]{10}
location_code

Default location is 000001. BYU_STORE is 02

 path string
200 OK #/responses/supplier_200

Success

supplier
Example for application/json
{
    "supplier": {
        "category": "XYZ",
        "contacts": {
            "contact_name": "dwight",
            "email_id": "talk@gmail.com",
            "sequence_number": "2",
            "title": "manager",
            "url": "www.example.com"
        },
        "default_loc": 1,
        "location": {
            "addresses": {
                "address1": "Institute of Tech",
                "address2": "110 S State corner",
                "address3": "2000 Hope Ridge",
                "city": "Provo",
                "country": "United States",
                "email": "example@gmail.com",
                "state": "UT",
                "type": "Either Remit, Return or Invoice",
                "zip": "55555"
            },
            "location": "0001",
            "payment terms": "50",
            "withholding": "N"
        },
        "remit_loc": 1,
        "supplier id": "0123456789",
        "supplier name": "THE BEST UNIVERSITY",
        "tin": "123456789",
        "withholdings": {
            "default_class": "07",
            "default_jurisdiction": "Y",
            "entity": "IRS",
            "jurisdiction": "FED",
            "supplier_category": "NONE",
            "type": "1099",
            "withhold": "Y",
            "withholding_condition": "N"
        }
    }
}
400 Bad Request #/responses/supplier_400

Bad Request

error_vendor_400
Example for application/json
{
    "validation_information": [
        "Supplier ID must be 10 digits"
    ],
    "validation_response": {
        "code": 400,
        "message": "Bad Request"
    }
}
404 Not Found #/responses/supplier_404

Vendor Not Found

error_vendor_404
Example for application/json
{
    "validation_information": [
        "Supplier with Id (0123456789) not found."
    ],
    "validation_response": {
        "code": 404,
        "message": "Not Found"
    }
}
Returns information for a specific vendor and their specific location.

GET /{vendor_id}/locations/{location_code}/addresses/{address_type}

Tags: supplier

Only one vendor should be returned and a specific location
vendor_id

Returns a specific vendor that matches the vendor_id

 path string , must match [0-10]{10}
location_code

Default location is 000001. BYU_STORE is 02

 path string
address_type

can be remit, invoice, shipping, order or return

 path string
200 OK #/responses/supplier_200

Success

supplier
Example for application/json
{
    "supplier": {
        "category": "XYZ",
        "contacts": {
            "contact_name": "dwight",
            "email_id": "talk@gmail.com",
            "sequence_number": "2",
            "title": "manager",
            "url": "www.example.com"
        },
        "default_loc": 1,
        "location": {
            "addresses": {
                "address1": "Institute of Tech",
                "address2": "110 S State corner",
                "address3": "2000 Hope Ridge",
                "city": "Provo",
                "country": "United States",
                "email": "example@gmail.com",
                "state": "UT",
                "type": "Either Remit, Return or Invoice",
                "zip": "55555"
            },
            "location": "0001",
            "payment terms": "50",
            "withholding": "N"
        },
        "remit_loc": 1,
        "supplier id": "0123456789",
        "supplier name": "THE BEST UNIVERSITY",
        "tin": "123456789",
        "withholdings": {
            "default_class": "07",
            "default_jurisdiction": "Y",
            "entity": "IRS",
            "jurisdiction": "FED",
            "supplier_category": "NONE",
            "type": "1099",
            "withhold": "Y",
            "withholding_condition": "N"
        }
    }
}
400 Bad Request #/responses/supplier_400

Bad Request

error_vendor_400
Example for application/json
{
    "validation_information": [
        "Supplier ID must be 10 digits"
    ],
    "validation_response": {
        "code": 400,
        "message": "Bad Request"
    }
}
404 Not Found #/responses/supplier_404

Vendor Not Found

error_vendor_404
Example for application/json
{
    "validation_information": [
        "Supplier with Id (0123456789) not found."
    ],
    "validation_response": {
        "code": 404,
        "message": "Not Found"
    }
}

Parameter definitions
vendor_id vendor_id

Returns a specific vendor that matches the vendor_id

 path string , must match [0-10]{10}
supplier_name supplier_name

Returns any vendor with a partial match on the query string

 query string
location_code location_code

Default location is 000001. BYU_STORE is 02

 path string
address_type address_type

?????

 path string

Response definitions

supplier_200

Success

supplier
Example for application/json
{
    "supplier": {
        "category": "XYZ",
        "contacts": {
            "contact_name": "dwight",
            "email_id": "talk@gmail.com",
            "sequence_number": "2",
            "title": "manager",
            "url": "www.example.com"
        },
        "default_loc": 1,
        "location": {
            "addresses": {
                "address1": "Institute of Tech",
                "address2": "110 S State corner",
                "address3": "2000 Hope Ridge",
                "city": "Provo",
                "country": "United States",
                "email": "example@gmail.com",
                "state": "UT",
                "type": "Either Remit, Return or Invoice",
                "zip": "55555"
            },
            "location": "0001",
            "payment terms": "50",
            "withholding": "N"
        },
        "remit_loc": 1,
        "supplier id": "0123456789",
        "supplier name": "THE BEST UNIVERSITY",
        "tin": "123456789",
        "withholdings": {
            "default_class": "07",
            "default_jurisdiction": "Y",
            "entity": "IRS",
            "jurisdiction": "FED",
            "supplier_category": "NONE",
            "type": "1099",
            "withhold": "Y",
            "withholding_condition": "N"
        }
    }
}
supplier_400

Bad Request

error_vendor_400
Example for application/json
{
    "validation_information": [
        "Supplier ID must be 10 digits"
    ],
    "validation_response": {
        "code": 400,
        "message": "Bad Request"
    }
}
supplier_404

Vendor Not Found

error_vendor_404
Example for application/json
{
    "validation_information": [
        "Supplier with Id (0123456789) not found."
    ],
    "validation_response": {
        "code": 404,
        "message": "Not Found"
    }
}
supplier_name_200

Success

suppliers
Example for application/json
{
    "supplier": {
        "category": "XYZ",
        "contacts": {
            "contact_name": "dwight",
            "email_id": "talk@gmail.com",
            "sequence_number": "2",
            "title": "manager",
            "url": "www.example.com"
        },
        "default_loc": 1,
        "location": {
            "addresses": {
                "address1": "Institute of Tech",
                "address2": "110 S State corner",
                "address3": "2000 Hope Ridge",
                "city": "Provo",
                "country": "United States",
                "email": "example@gmail.com",
                "state": "UT",
                "type": "Either Remit, Return or Invoice",
                "zip": "55555"
            },
            "location": "0001",
            "payment terms": "50",
            "withholding": "N"
        },
        "remit_loc": 1,
        "supplier id": "0123456789",
        "supplier name": "THE BEST UNIVERSITY",
        "tin": "123456789",
        "withholdings": {
            "default_class": "07",
            "default_jurisdiction": "Y",
            "entity": "IRS",
            "jurisdiction": "FED",
            "supplier_category": "NONE",
            "type": "1099",
            "withhold": "Y",
            "withholding_condition": "N"
        }
    }
}
supplier_name_400

Error

error_name_400
Example for application/json
{
    "validation_information": [
        "Location must have a value"
    ],
    "validation_response": {
        "code": 400,
        "message": "Bad Request"
    }
}
supplier_name_404

Will return to many vendors, please be more specific

error_name_404
Example for application/json
{
    "validation_information": [
        "Supplier does not exist with specific location"
    ],
    "validation_response": {
        "code": 404,
        "message": "Bad Request"
    }
}
suppliers_200

Success

suppliers
Example for application/json
{
    "supplier": {
        "category": "XYZ",
        "contacts": {
            "contact_name": "dwight",
            "email_id": "talk@gmail.com",
            "sequence_number": "2",
            "title": "manager",
            "url": "www.example.com"
        },
        "default_loc": 1,
        "location": {
            "addresses": {
                "address1": "Institute of Tech",
                "address2": "110 S State corner",
                "address3": "2000 Hope Ridge",
                "city": "Provo",
                "country": "United States",
                "email": "example@gmail.com",
                "state": "UT",
                "type": "Either Remit, Return or Invoice",
                "zip": "55555"
            },
            "location": "0001",
            "payment terms": "50",
            "withholding": "N"
        },
        "remit_loc": 1,
        "supplier id": "0123456789",
        "supplier name": "THE BEST UNIVERSITY",
        "tin": "123456789",
        "withholdings": {
            "default_class": "07",
            "default_jurisdiction": "Y",
            "entity": "IRS",
            "jurisdiction": "FED",
            "supplier_category": "NONE",
            "type": "1099",
            "withhold": "Y",
            "withholding_condition": "N"
        }
    }
}

Schema definitions

address: object

email: email_id
addr1: address_line_1
addr2: address_line_2
addr3: address_line_3
addr4: address_line_4
city: city
state: state
postal: postal
country: country

address_line_1: string

First address field

address_line_2: string

Second address field

address_line_3: string

Third address field

address_line_4: string

Fourth address field

addresses: object

address_order: address
address_remit: address
address_return: address
address_invoice: address
address_shipping: address

byu_store_supplier: string

Validates if the vendor supplies to BYU Store

category: string

Type of vendor

city: string

City for remit, invoice, shipping, ordering or return addresses

contact_name: string

Contact Name

contacts: object

contact_name: contact_name
title: title
url: url
email_id: email_id

country: string

Country remit, invoice, shipping, ordering or return addresses

default_class: string

default is '7'

default_loc: string

default location

default_withholding_flag: string

Determine if the vendor withholding its 1099

email_id: string

Email address

entity: string

Should be IRS

error_name_400: string

Supplier name must not be empty!

error_name_404: string

Request will return too many vendors, please be more specific

error_vendor_400: string

Vendor ID must be 10 digits

error_vendor_404: string

Vendor does not exist

jurisdiction: string

FED

jurisdiction_flag: string

Tax Identification for each location

location: object

location_code: location_code
payment_terms: payment_terms
default_withholding_flag: default_withholding_flag
addresses: object

location_code: string

How a vendor does business with different departments

payment_terms: string

How do they do payments with a certain department

postal: string

Postal for remit, invoice, shipping, ordering or return addresses

remit_loc: string

remit location

state: string

State for remit, invoice, shipping, ordering or return addresses

supplier: object

vendor_id: vendor_id
supplier_name: supplier_name
category: category
supplier_byu_store: byu_store_supplier
withholding_code: withholding_code
default_loc: default_loc
remit_loc: remit_loc
tin: tin
locations: object[]
location
contacts: object[]
contacts
withholdings: object

supplier_name: string

The name of the supplier

suppliers: object[]

supplier

tin: string

Tax Identification

title: string

Contact Title

type: string

Normally 1099

url: string

Contact Url

vendor_id: string

The id of the vendor

withhold: string

Y or N

withholding_category: string

Exempt or not applicable

withholding_code: string

Type of TIN

withholding_condition: string

Yes or No value

withholdings: object

entity: entity
type: type
jurisdiction: jurisdiction
default_class: default_class
withhold: withhold
default_jurisdiction: jurisdiction_flag
supplier_category: withholding_category
withholding_condition: withholding_condition
Service Path: 
/domains/erp/fs/suppliers
Domain or University API: 
/domains/erp/fs/suppliers
Tags: 
domains
erp
fs
suppliers

Community

 

Don't see your question listed here? Ask!

View This API in the API Store

Get Elevated Access