Dartmouth API Developer Portal

Vendor Sites

This API returns information about Vendor Sites used for purchasing and invoice payment in Dartmouth's Procurement and Accounts Payable system.

The API includes Vendor entries representing Dartmouth Students and Employees. It is the responsibility of the consumer to understand when any attributes such as Address information may be more sensitive for Students and Employees than for other vendor types.

Notes on usage

Returns resources describing a Vendor/Site combination. Vendors are not currently made available as a stand-alone resource.

All ERP vendors are available regardless of Vendor Type, regardless of whether the Vendor or Site are active, and regardless of whether they are valid Purchase Sites or Pay Sites.

Requests

GET /procurement/vendor_sites

GET /procurement/vendor_sites/{id}

Required Scopes

Scope	Description
"urn:dartmouth:procurement:read.sensitive"	This scope is required for any results to be returned. No further document or attribute level access is configured.

Required Headers

Authorization: Bearer {jwt}

Search paramenters

Searching is allowed on any of the resource attributes in the query parameters. For example, to query currently active Vendor Sites:

GET /procurement/vendor_sites?is_site_active=true&is_supplier_active=true

Paging

Any collection GET will include return headers allowing paging:

X-Request-ID: 66da34c9-569f-484b-b48e-49634efa7fc1
X-Total-Count: 99696

Subsequent pages can be accessed by specifying the continuation key, page size, and page number:

GET /procurement/vendor_sites?continuation_key=66da34c9-569f-484b-b48e-49634efa7fc1&page=2&pagesize=100

Attribute Definitions

All "dates" are ISO8601 date formatted strings

Attribute	Type	Notes
vendor_name	string
vendor_id	string	Oracle EBS internal id
supplier_number	string	"Supplier Num" or "Vendor Num" in Oracle EBS GUI
vendor_type	string
vendor_netid	string	exists only for vendor_types [STUDENT, EMPLOYEE]
supplier_start_date_active	date string	date that vendor became active
federal_reportable_flag	string	Y or N indicating federal reporting required
tax_reporting_name	string	the name used for tax reporting
organization_type	string
party_site_id	integer
supplier_inactive_date	date	may be future date
is_supplier_active	boolean
site_id	string	Oracle EBS internal id
site_name	string	"Site Code" in Oracle EBS GUI
is_purchasing_site	boolean
is_pay_site	boolean
is_primary_pay_site	boolean
site_inactive_date	date	may be future date
is_site_active	boolean
address_line_1	string
address_line_2	string
address_line_3	string
address_city	string
address_state	string
address_postal_code	string
address_province	string
address_country	string
site_phone_number	string
pay_to_name	string	payee name when payments are issued
payment_method_lookup_code	string
ship_via_lookup_code	string
freight_terms_lookup_code	string
cache_date	date	When this resource was last refreshed from Oracle EBS

Sample Collection Search Request

https://api.dartmouth.edu/api/procurement/vendor_sites?vendor_name=Red%20Hen*

Sample Collection Return

[
    {
        "vendor_name": "Red Hen Baking Company",
        "vendor_id": "5223551",
        "supplier_number": "259840",
        "vendor_type": "COMMERCIAL",
        "vendor_netid": null,
        "supplier_start_date_active": "2014-09-29T00:00:00",
        "supplier_inactive_date": null,
        "is_supplier_active": true,
        "federal_reportable_flag": "N",
        "tax_reporting_name": null,
        "organization_type": "CORPORATION",
        "party_site_id": 6708973,
        "site_id": "6813530",
        "site_name": "MIDDLESEXVT",
        "is_purchasing_site": true,
        "is_pay_site": true,
        "is_primary_pay_site": false,
        "site_inactive_date": null,
        "is_site_active": true,
        "address_line_1": "961 B US Rt 2",
        "address_line_2": null,
        "address_line_3": null,
        "address_city": "Middlesex",
        "address_state": "VT",
        "address_postal_code": "05602",
        "address_province": null,
        "address_country": "US",
        "site_phone_number": null,
        "pay_to_name": null,
        "payment_method_lookup_code": "PW-ACH",
        "ship_via_lookup_code": "Best Way",
        "freight_terms_lookup_code": "Prepaid",
        "cache_date": "2023-07-19T14:15:08Z"
    }
]

Sample Resource Request

https://api.dartmouth.edu/api/procurement/vendor_sites/6813530

Sample Resource Return

{
    "vendor_name": "Red Hen Baking Company",
    "vendor_id": "5223551",
    "supplier_number": "259840",
    "vendor_type": "COMMERCIAL",
    "vendor_netid": null,
    "supplier_start_date_active": "2014-09-29T00:00:00",
    "supplier_inactive_date": null,
    "is_supplier_active": true,
    "federal_reportable_flag": "N",
    "tax_reporting_name": null,
    "organization_type": "CORPORATION",
    "party_site_id": 6708973,
    "site_id": "6813530",
    "site_name": "MIDDLESEXVT",
    "is_purchasing_site": true,
    "is_pay_site": true,
    "is_primary_pay_site": false,
    "site_inactive_date": null,
    "is_site_active": true,
    "address_line_1": "961 B US Rt 2",
    "address_line_2": null,
    "address_line_3": null,
    "address_city": "Middlesex",
    "address_state": "VT",
    "address_postal_code": "05602",
    "address_province": null,
    "address_country": "US",
    "site_phone_number": null,
    "pay_to_name": null,
    "payment_method_lookup_code": "PW-ACH",
    "ship_via_lookup_code": "Best Way",
    "freight_terms_lookup_code": "Prepaid",
    "cache_date": "2023-07-19T14:15:08Z"
}