API docs by Redocly

Workday Strategic Sourcing Supplier API (1.0)

Download OpenAPI specification:

Customer Support

We've provided detailed documentation below to guide you. However, if you need additional assistance, here's how you can get the support you need:

  • Community Discussions: Join the conversation on our Workday Community Discussion Boards (found under the "Collaborate" section in community). Connect with other users, share best practices, and get answers to your configuration questions.
  • Expert Configuration Assistance (Professional Services): For tailored, hands-on support with your specific project, our Professional Services team is available.
    • Looking for personalized guidance? Workday Success Plan customers can submit an "Ask" for expert insights on configuration and best practices.
    • Need custom solutions? Consider Expert Assist, our consulting service for detailed changes and project support.
  • Reporting System Issues: If you suspect a problem with the Workday system itself, please connect with our dedicated support team. Your company's Named Support Contact (NSC) can log a Product Support Defect case. We'll review the issue based on its impact and Workday's service level agreement (SLA).

API Specification

The API conforms to the JSON API Specification.

The current version of this service is indicated by the X-Api-Version header.

Sample version header: X-Api-Version: 1.0.

Date and Time Fields

Our API adheres to the ISO 8601 standard when accepting and formatting Date and Time fields. All Date and Time fields returned by this API will be in the UTC timezone.

Date and Time fields sent to this API can be in any timezone, provided they adhere to the ISO 8601 standard.

Authentication

The Workday Strategic Sourcing API uses API keys to authenticate requests. Every request will require all 3 HTTP headers:

HTTP Header Description
X-Api-Key a company-wide API key
X-User-Token a user-specific API token
X-User-Email user email

You can generate all of those from the API tokens section of your Profile page.

Your API keys carry many privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth.

All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.

Rate Limiting

Rate limit windows are per second and are shared by all API Keys for a company.

The rate limit is 5 requests per second.

When request submissions exceed the limits, the limit-exceeding requests return 429 Too Many Requests error responses to the client.

Upon receiving a 429 response, it is recommended to retry the request in compliance with the rate limit. One example would be to add a sleep function for 1 second and retry.

External Identifiers (IDs)

The external_id field exists on many of the Workday Strategic Sourcing resources. This optional and mutable extension is intended to store foreign keys of the corresponding resource from a third party system. These IDs are not considered Sourcing Data and may be logged in external systems. Do not include any sensitive or personal data in IDs.

The purpose of external IDs is to:

  • Prevent duplicate record creation
  • Allow resources in Workday Strategic Sourcing and a third party system to share the same identifier
  • Allow for records to be queried or updated without requiring knowledge of the Workday Strategic Sourcing generated IDs

Pagination

Paginated endpoints may return a subset of the total results for a GET request that returns multiple resources. Endpoints that support pagination will include usage details in the Query Parameters section for the resource.

The paginated results can be configured using the page query parameter to configure the number of returned results. The default pagination size is 10 results and the maximum pagination size is 100 results per request.

Endpoints that support pagination may return "self" and "next" sections within the "links" section that navigate to the current and next pages respectively.

Example Paginated Request

Request Query Parameter Format

/projects?page[size]=25

Response Schema

The paginated response will also include the following schema

object

Result set metadata.

object (PaginationLinks)

List of related links.

{}

Filters

The results can be filtered to a subset of the total set of results using filter query parameters.

Endpoints that support filtering will include usage details in the Query Parameters section for the resource.

Most filters that end in equals support a Query Parameter array format to filter by multiple values.

Example:

?filter[status_equals][]=submitted&filter[status_equals][]=resubmitted

Supplier Companies

Use the supplier companies API to create, update, and query the suppliers in Workday Strategic Sourcing.

Supplier Company Object

type
required
string (SupplierCompanyType)

Object type, should always be supplier_companies.

id
required
integer (SupplierCompanyId)

Supplier company identifier string.

object (SupplierCompanyAttributes)

Supplier company attributes.

object (SupplierCompanyRelationship)

Supplier company relationships.

object (ResourceLinks)

List of related links.

{
  • "type": "supplier_companies",
  • "id": "1",
  • "attributes": {
    },
  • "links": {}
}

Supplier Classification Value Object

type
required
string (SupplierClassificationValueType)

Object type, should always be supplier_classification_values.

id
required
string (SupplierClassificationValueId)

A composite identifier for a virtual object created from the id of the supplier and the id of the classification in the response. Id or the external Id of a classification in the request.

object (SupplierClassificationValueAttributes)

SupplierClassificationValue attributes.

object (SupplierClassificationValueRelationship)

Supplier classification value relationships.

{
  • "id": "1-21",
  • "type": "supplier_classification_values",
  • "attributes": {
    },
  • "relationships": {
    }
}

Supplier Classification Field Value Object

type
required
string (SupplierClassificationFieldValueType)

Object type, should always be supplier_classification_field_values.

id
required
integer (SupplierClassificationFieldValueId)

Supplier classification field value identifier string.

object (SupplierClassificationFieldValueAttributes)

SupplierClassificationFieldValue attributes.

object (SupplierClassificationFieldValueRelationship)

Supplier classification relationships.

{
  • "id": "1",
  • "type": "supplier_classification_field_values",
  • "attributes": {
    },
  • "relationships": {
    }
}

List Supplier Companies

Returns a list of supplier companies for the specified criteria.

Authorizations:
(api_keyuser_tokenuser_email)
query Parameters
object (SupplierCompanyInputFilter)

Filter supplier companies by multiple criteria. Only one filter per attribute is supported. For best performance, we recommend 5 or less filters.

include
string (SupplierCompanyRelatedResources)
Enum: "attachments" "supplier_category" "supplier_groups" "default_payment_term" "payment_types" "default_payment_type" "payment_currencies" "default_payment_currency" "supplier_classification_values"

To reduce the number of HTTP requests, related resources can be requested along with the requested primary resources. Such responses are called "compound documents". In a compound document, all included resources will be represented as an array of resource objects in a top-level included member.

The value of the include parameter must be a comma-separated list of relationships from the list of available relationships.

/supplier_companies?include=payment_types,default_payment_type

In the response, relationships will be represented as normal linkage objects (containing id and type), and full related resource details will be presented in the included section as resource objects (with attributes, links, and potentially relationships).

object (PageInput)

Customize pagination results with size.

Responses

Request samples 

curl -H "X-Api-Key: ${COMPANY_KEY}" \
     -H "X-User-Token: ${USER_TOKEN}" \
     -H "X-User-Email: ${USER_EMAIL}" \
     -H "Content-Type: application/vnd.api+json" \
     "https://api.us.workdayspend.com/services/suppliers/v1/supplier_companies"

Response samples

Content type
application/vnd.api+json
Example
{
  • "meta": {
    },
  • "data": [
    ],
  • "links": {}
}

Create a Supplier Company

Create a supplier company with given attributes, relationships, and related complex resources.

When creating a supplier company with relationships, keep in mind that there are two kinds of relationships: linked resources and composite resources.

Linked Resources

These are normal relationship resources managed outside of primary resource (supplier company). For example, payment currencies exist on their own, and can be assigned to one or many supplier companies, contracts, etc. These resources usually have their own API management endpoints.

All related objects should exist prior to being linked to the supplier company. They can be referenced by Workday Strategic Sourcing identifier, or by external ID; in the latter case, the relationship name is used with prefix external_. For example, a payment currency with Workday Strategic Sourcing ID "1" and external ID "C$EUR" can be used to initialize default_payment_currency:

{
  "default_payment_currency": {
    "data" {
      "id": "1",
      "type": "payment_currencies"
    }
  }
}

{
  "external_default_payment_currency": {
    "data" {
      "id": "C$EUR",
      "type": "payment_currencies"
    }
  }
}

When external_ prefix is applied to a "many" relationship, like external_payment_currencies, all of the identifiers will be treated as external IDs.

Authorizations:
(api_keyuser_tokenuser_email)
query Parameters
include
string (SupplierCompanyRelatedResources)
Enum: "attachments" "supplier_category" "supplier_groups" "default_payment_term" "payment_types" "default_payment_type" "payment_currencies" "default_payment_currency" "supplier_classification_values"

Use the include parameter to request related resources along with the primary resource. (see "List Supplier Companies" for more details).

Request Body schema: application/vnd.api+json
object (SupplierCompanyCreate)

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
Example
{
  • "data": {
    }
}

Get a Supplier Company

Retrieves the details of an existing supplier company. You need to supply the unique supplier company identifier that was returned upon supplier company creation.

Authorizations:
(api_keyuser_tokenuser_email)
path Parameters
id
required
integer
Example: 1

Unique Supplier Company identifier.

query Parameters
include
string (SupplierCompanyRelatedResources)
Enum: "attachments" "supplier_category" "supplier_groups" "default_payment_term" "payment_types" "default_payment_type" "payment_currencies" "default_payment_currency" "supplier_classification_values"

Use the include parameter to request related resources along with the primary resource. (see "List Supplier Companies" for more details).

Responses

Request samples 

curl -H "X-Api-Key: ${COMPANY_KEY}" \
     -H "X-User-Token: ${USER_TOKEN}" \
     -H "X-User-Email: ${USER_EMAIL}" \
     -H "Content-Type: application/vnd.api+json" \
     "https://api.us.workdayspend.com/services/suppliers/v1/supplier_companies/1"

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Update a Supplier Company

Updates the details of an existing supplier company. You need to supply the unique supplier company identifier that was returned upon supplier company creation.

Please note, that request body must include an id attribute with the value of your supplier unique identifier (the same one you passed in the URL).

Linked Resources

When updating relationships on a supplier company resource, keep in mind the whole relationship will be replaced the new values. For example, if a supplier company has currencies with IDs "1" and "2", and in update request payload payment_currencies relationship is specified with ID "3", the only payment currency associated after the request succeeded will be "3".

Authorizations:
(api_keyuser_tokenuser_email)
path Parameters
id
required
integer
Example: 1

Unique Supplier Company identifier.

query Parameters
include
string (SupplierCompanyRelatedResources)
Enum: "attachments" "supplier_category" "supplier_groups" "default_payment_term" "payment_types" "default_payment_type" "payment_currencies" "default_payment_currency" "supplier_classification_values"

Use the include parameter to request related resources along with the primary resource. (see "List Supplier Companies" for more details).

Request Body schema: application/vnd.api+json
object (SupplierCompanyUpdate)

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
Example
{
  • "data": {
    }
}

Delete a Supplier Company

Deletes a supplier company. You need to supply the unique supplier company identifier that was returned upon supplier company creation.

Authorizations:
(api_keyuser_tokenuser_email)
path Parameters
id
required
integer
Example: 1

Unique Supplier Company identifier.

Responses

Request samples 

curl -H "X-Api-Key: ${COMPANY_KEY}" \
     -H "X-User-Token: ${USER_TOKEN}" \
     -H "X-User-Email: ${USER_EMAIL}" \
     -H "Content-Type: application/vnd.api+json" \
     -X DELETE \
     "https://api.us.workdayspend.com/services/suppliers/v1/supplier_companies/1"

Get a Supplier Company by External ID

Retrieves the details of an existing supplier company. You need to supply the unique supplier company external identifier (the one you used when created the supplier company).

Authorizations:
(api_keyuser_tokenuser_email)
path Parameters
external_id
required
string
Example: 1234-5678-abcd-efgh

Supplier company external identifier.

query Parameters
include
string (SupplierCompanyRelatedResources)
Enum: "attachments" "supplier_category" "supplier_groups" "default_payment_term" "payment_types" "default_payment_type" "payment_currencies" "default_payment_currency" "supplier_classification_values"

Use the include parameter to request related resources along with the primary resource. (see "List Supplier Companies" for more details).

Responses

Request samples 

curl -H "X-Api-Key: ${COMPANY_KEY}" \
     -H "X-User-Token: ${USER_TOKEN}" \
     -H "X-User-Email: ${USER_EMAIL}" \
     -H "Content-Type: application/vnd.api+json" \
     "https://api.us.workdayspend.com/services/suppliers/v1/supplier_companies/SUP-1234/external_id"

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Update a Supplier Company by External ID

Updates the details of an existing supplier company. You need to supply the unique supplier company external identifier (the one you used when created the supplier company).

Please note, that request body must include an id attribute with the value of your supplier external identifier (the same one you passed in the URL).

Authorizations:
(api_keyuser_tokenuser_email)
path Parameters
external_id
required
string
Example: 1234-5678-abcd-efgh

Supplier company external identifier.

query Parameters
include
string (SupplierCompanyRelatedResources)
Enum: "attachments" "supplier_category" "supplier_groups" "default_payment_term" "payment_types" "default_payment_type" "payment_currencies" "default_payment_currency" "supplier_classification_values"

Use the include parameter to request related resources along with the primary resource. (see "List Supplier Companies" for more details).

Request Body schema: application/vnd.api+json
object (SupplierCompanyUpdate)

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Delete a Supplier Company by External ID

Deletes a supplier company. You need to supply the unique supplier company external identifier (the one you used when created the supplier company).

Authorizations:
(api_keyuser_tokenuser_email)
path Parameters
external_id
required
string
Example: 1234-5678-abcd-efgh

Supplier company external identifier.

Responses

Request samples 

curl -H "X-Api-Key: ${COMPANY_KEY}" \
     -H "X-User-Token: ${USER_TOKEN}" \
     -H "X-User-Email: ${USER_EMAIL}" \
     -H "Content-Type: application/vnd.api+json" \
     -X DELETE \
     "https://api.us.workdayspend.com/services/suppliers/v1/supplier_companies/SUP-1234/external_id"

Describe Supplier Company object

Returns a list of fields for the supplier company object.

Authorizations:
(api_keyuser_tokenuser_email)

Responses

Request samples 

curl -H "X-Api-Key: ${COMPANY_KEY}" \
     -H "X-User-Token: ${USER_TOKEN}" \
     -H "X-User-Email: ${USER_EMAIL}" \
     -H "Content-Type: application/vnd.api+json" \
     "https://api.us.workdayspend.com/services/suppliers/v1/supplier_companies/describe"

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "links": { },
  • "meta": {
    }
}

Supplier Contacts

Supplier Contact Object

type
required
string (SupplierContactType)

Object type, should always be supplier_contacts.

id
required
integer (SupplierContactId)

Supplier contact identifier string.

object (SupplierContactAttributes)

Supplier contact attributes.

object (SupplierContactRelationshipCreate)

Supplier contact relationships.

object (ResourceLinks)

List of related links.

{
  • "type": "supplier_contacts",
  • "id": "1",
  • "attributes": {
    },
  • "relationships": {
    },
  • "links": {}
}

List Supplier Contacts

Retrieves the list of contacts for an existing supplier company.

Authorizations:
(api_keyuser_tokenuser_email)
path Parameters
company_id
required
integer
Example: 1

Unique supplier company identifier.

query Parameters
include
string (SupplierContactRelatedResources)
Enum: "supplier_company" "contact_types" "phones"

To reduce the number of HTTP requests, related resources can be requested along with the requested primary resources. Such responses are called "compound documents". In a compound document, all included resources will be represented as an array of resource objects in a top-level included member.

The value of the include parameter must be a comma-separated list of relationships from the list of available relationships.

/supplier_contacts?include=supplier_company

In the response, relationships will be represented as normal linkage objects (containing id and type), and related resource details will be presented in the included section as resource objects (with attributes that have a corresponding external_id).

object (SupplierContactInputFilter)

Filter supplier contacts by multiple criteria. Only one filter per attribute is supported. For best performance, we recommend 5 or less filters.

Responses

Request samples 

curl -H "X-Api-Key: ${COMPANY_KEY}" \
     -H "X-User-Token: ${USER_TOKEN}" \
     -H "X-User-Email: ${USER_EMAIL}" \
     -H "Content-Type: application/vnd.api+json" \
     "https://api.us.workdayspend.com/services/suppliers/v1/supplier_companies/1/supplier_contacts"

Response samples

Content type
application/vnd.api+json
Example
{
  • "meta": {
    },
  • "data": [
    ],
  • "links": {}
}

Create a Supplier Contact

Create a supplier contact with given attributes.

Linked Resources

The supplier company should exist prior to being linked to the supplier contact. It can be referenced by Workday Strategic Sourcing identifier, or by external ID; in the latter case, the relationship name is used with prefix external_. For example, a supplier company with Workday Strategic Sourcing ID "1" and external ID "SCM-1" can be used to initialize supplier_company:

{
  "supplier_company": {
    "data" {
      "id": "1",
      "type": "supplier_companies"
    }
  }
}

{
  "external_supplier_company": {
    "data" {
      "id": "SCM-1",
      "type": "supplier_companies"
    }
  }
}
Authorizations:
(api_keyuser_tokenuser_email)
query Parameters
include
string (SupplierContactRelatedResources)
Enum: "supplier_company" "contact_types" "phones"

Use the include parameter to request a primary resource supplier company.

Request Body schema: application/vnd.api+json
object (SupplierContactCreate)

Responses

Request samples

Content type
application/vnd.api+json
Example
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
Example
{
  • "data": {
    }
}

Get a Supplier Contact

Retrieves the details of an existing supplier contact.

Authorizations:
(api_keyuser_tokenuser_email)
path Parameters
id
required
integer
Example: 1

Unique supplier contact identifier.

query Parameters
include
string (SupplierContactRelatedResources)
Enum: "supplier_company" "contact_types" "phones"

Use the include parameter to request a primary resource supplier company.

Responses

Request samples 

curl -H "X-Api-Key: ${COMPANY_KEY}" \
     -H "X-User-Token: ${USER_TOKEN}" \
     -H "X-User-Email: ${USER_EMAIL}" \
     -H "Content-Type: application/vnd.api+json" \
     "https://api.us.workdayspend.com/services/suppliers/v1/supplier_contacts/1"

Response samples

Content type
application/vnd.api+json
Example
{
  • "data": {
    }
}

Update a Supplier Contact

Updates the details of an existing supplier contact. You need to supply the unique supplier company and contact identifiers.

Please note, that request body must include an id attribute with the value of your supplier contact unique identifier (the same one you passed in the URL).

Authorizations:
(api_keyuser_tokenuser_email)
path Parameters
id
required
integer
Example: 1

Unique supplier contact identifier.

query Parameters
include
string (SupplierContactRelatedResources)
Enum: "supplier_company" "contact_types" "phones"

Use the include parameter to request a primary resource supplier company.

Request Body schema: application/vnd.api+json
object (SupplierContactUpdate)

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
Example
{
  • "data": {
    }
}

Delete a Supplier Contact

Deletes a supplier contact.

Authorizations:
(api_keyuser_tokenuser_email)
path Parameters
id
required
integer
Example: 1

Unique supplier contact identifier.

Responses

Request samples 

curl -H "X-Api-Key: ${COMPANY_KEY}" \
     -H "X-User-Token: ${USER_TOKEN}" \
     -H "X-User-Email: ${USER_EMAIL}" \
     -H "Content-Type: application/vnd.api+json" \
     -X DELETE \
     "https://api.us.workdayspend.com/services/suppliers/v1/supplier_contacts/1/external_id"

List Supplier Contacts by Supplier Company External ID

Retrieves the list of contacts for an existing supplier company by Supplier Company External ID.

Authorizations:
(api_keyuser_tokenuser_email)
path Parameters
external_id
required
string
Example: 1234-5678-abcd-efgh

Supplier company external identifier.

query Parameters
include
string (SupplierContactRelatedResources)
Enum: "supplier_company" "contact_types" "phones"

To reduce the number of HTTP requests, related resources can be requested along with the requested primary resources. Such responses are called "compound documents". In a compound document, all included resources will be represented as an array of resource objects in a top-level included member.

The value of the include parameter must be a comma-separated list of relationships from the list of available relationships.

/supplier_contacts?include=supplier_company

In the response, relationships will be represented as normal linkage objects (containing id and type), and related resource details will be presented in the included section as resource objects (with attributes that have a corresponding external_id).

object (SupplierContactInputFilter)

Filter supplier contacts by multiple criteria. Only one filter per attribute is supported. For best performance, we recommend 5 or less filters.

Responses

Request samples 

curl -H "X-Api-Key: ${COMPANY_KEY}" \
     -H "X-User-Token: ${USER_TOKEN}" \
     -H "X-User-Email: ${USER_EMAIL}" \
     -H "Content-Type: application/vnd.api+json" \
     "https://api.us.workdayspend.com/services/suppliers/v1/supplier_companies/1234-5678-abcd-efgh/supplier_contacts/external_id"

Response samples

Content type
application/vnd.api+json
Example
{
  • "meta": {
    },
  • "data": [
    ],
  • "links": {}
}

Get a Supplier Contact by External ID

Retrieves the details of an existing supplier contact by Supplier Contact External ID.

Authorizations:
(api_keyuser_tokenuser_email)
path Parameters
external_id
required
string
Example: CNT-17

Unique supplier contact identifier.

query Parameters
include
string (SupplierContactRelatedResources)
Enum: "supplier_company" "contact_types" "phones"

Use the include parameter to request a primary resource supplier company.

Responses

Request samples 

curl -H "X-Api-Key: ${COMPANY_KEY}" \
     -H "X-User-Token: ${USER_TOKEN}" \
     -H "X-User-Email: ${USER_EMAIL}" \
     -H "Content-Type: application/vnd.api+json" \
     "https://api.us.workdayspend.com/services/suppliers/v1/supplier_contacts/CNT-17/external_id"

Response samples

Content type
application/vnd.api+json
Example
{
  • "data": {
    }
}

Update a Supplier Contact by External ID

Updates the details of an existing supplier contact by Supplir Contact External ID.

Please note, that request body must include an id attribute with the value of your supplier contact unique identifier (the same one you passed in the URL).

Authorizations:
(api_keyuser_tokenuser_email)
path Parameters
external_id
required
string
Example: CNT-17

Unique supplier contact external identifier.

query Parameters
include
string (SupplierContactRelatedResources)
Enum: "supplier_company" "contact_types" "phones"

Use the include parameter to request a primary resource supplier company.

Request Body schema: application/vnd.api+json
object (SupplierContactUpdate)

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
Example
{
  • "data": {
    }
}

Delete a Supplier Contact by External ID

Deletes a supplier contact by Supplier Contact External ID.

Authorizations:
(api_keyuser_tokenuser_email)
path Parameters
external_id
required
string
Example: CNT-17

Unique supplier contact identifier.

Responses

Request samples 

curl -H "X-Api-Key: ${COMPANY_KEY}" \
     -H "X-User-Token: ${USER_TOKEN}" \
     -H "X-User-Email: ${USER_EMAIL}" \
     -H "Content-Type: application/vnd.api+json" \
     -X DELETE \
     "https://api.us.workdayspend.com/services/suppliers/v1/supplier_contacts/CNT-17/external_id"

Supplier Classifications

Supplier Classification Object

type
required
string (SupplierClassificationType)

Object type, should always be supplier_classifications.

id
required
integer (SupplierClassificationId)

Supplier classification identifier string.

object (SupplierClassificationAttributes)

SupplierClassification attributes.

object (SupplierClassificationRelationship)

Supplier classification relationships.

{
  • "data": {
    }
}

List Supplier Classifications

Returns a list of supplier classifications.

Authorizations:
(api_keyuser_tokenuser_email)
query Parameters
include
string (SupplierClassificationRelatedResources)
Value: "supplier_classification_fields"

To reduce the number of HTTP requests, related resources can be requested along with the requested primary resources. Such responses are called "compound documents". In a compound document, all included resources will be represented as an array of resource objects in a top-level included member.

The value of the include parameter must be a comma-separated list of relationships from the list of available relationships.

/supplier_classifications?include=supplier_classification_fields

In the response, relationships will be represented as normal linkage objects (containing id and type), and related resource details will be presented in the included section as resource objects (with attributes that have a corresponding external_id).

object (SupplierClassificationInputFilter)

Filter supplier classifications by codename.

Responses

Request samples 

curl -H "X-Api-Key: ${COMPANY_KEY}" \
     -H "X-User-Token: ${USER_TOKEN}" \
     -H "X-User-Email: ${USER_EMAIL}" \
     -H "Content-Type: application/vnd.api+json" \
     "https://api.us.workdayspend.com/services/suppliers/v1/supplier_classifications"

Response samples

Content type
application/vnd.api+json
Example
{}

Create a Supplier Classification

Create a supplier classifications with given attributes, relationships, and related complex resources.

{
  "data": {
    "type": "supplier_classifications",
    "attributes": {
      "name": "Classification 1",
      "order": 1,
      "country_alpha2": "CA",
      "codename": "diversity",
      "active": true,
      "external_id": "CLASSIFICATION-1",
      "request_additional_information": false
    }
  }
}

Composite Resources

Resources that do not exist outside of parent resource, and are managed within the scope of parent resource, cannot be pre-created in advance. Supplier classifications have one composite resource supplier_classification_fields that includes another composite resource in itself - supplier_classification_field_options.

In order to create these resource along with the parent object, compound document must be used:

{
  "data": {
    "type": "supplier_classifications",
    "attributes": {
      "name": "Classification 1",
      "order": 1,
      "country_alpha2": "CA",
      "codename": "diversity",
      "active": true,
      "external_id": "CLASSIFICATION-1",
      "request_additional_information": true
    },
    "relationships": {
      "supplier_classification_fields": {
        "data": [
          {
            "id": "CLASSIFICATION-FIELD-1",
            "type": "supplier_classification_fields"
          },
        ]
      }
    },
    "included": [
      {
        "id": "CLASSIFICATION-FIELD-1",
        "type": "supplier_classification_fields",
        "attributes": {
          "name": "Field 1",
          "order": 1,
          "required": false,
          "kind": "SELECT",
          "external_id": "CLASSIFICATION-FIELD-1"
        },
        "relationships": {
          "supplier_classification_field_options": {
            "data": [
              {
                "id": "CLASSIFICATION-FIELD-OPTION-1",
                "type": "supplier_classification_field_options"
              },
              {
                "id": "CLASSIFICATION-FIELD-OPTION-2",
                "type": "supplier_classification_field_options"
              }
            ]
          }
        }
      },
      {
        "id": "CLASSIFICATION-FIELD-OPTION-1",
        "type": "supplier_classification_field_options",
        "attributes": {
          "label": "Option 1",
          "order": 1,
          "external_id": "CLASSIFICATION-FIELD-OPTION-1"
        }
      },
      {
        "id": "CLASSIFICATION-FIELD-OPTION-2",
        "type": "supplier_classification_field_options",
        "attributes": {
          "label": "Option 2",
          "order": 2,
          "external_id": "CLASSIFICATION-FIELD-OPTION-2"
        }
      }
    ]
  }
}
Authorizations:
(api_keyuser_tokenuser_email)
query Parameters
include
string (SupplierClassificationRelatedResources)
Value: "supplier_classification_fields"

Use the include parameter to request related resources along with the primary resource.

Request Body schema: application/vnd.api+json
object (SupplierClassification)
Array of SupplierClassificationField (object) or SupplierClassificationFieldOption (object) (SupplierClassificationIncludedMutationResources)

Responses

Request samples

Content type
application/vnd.api+json
Example
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
Example
{
  • "data": {
    }
}

Get a Supplier Classification

Retrieves the details of an existing supplier classification.

Authorizations:
(api_keyuser_tokenuser_email)
path Parameters
id
required
integer
Example: 1

Unique supplier classification identifier.

query Parameters
include
string (SupplierClassificationRelatedResources)
Value: "supplier_classification_fields"

Use the include parameter to request related resources.

Responses

Request samples 

curl -H "X-Api-Key: ${COMPANY_KEY}" \
     -H "X-User-Token: ${USER_TOKEN}" \
     -H "X-User-Email: ${USER_EMAIL}" \
     -H "Content-Type: application/vnd.api+json" \
     "https://api.us.workdayspend.com/services/suppliers/v1/supplier_classifications/1"

Response samples

Content type
application/vnd.api+json
Example
{
  • "data": {
    }
}

Update a Supplier Classification

Update a supplier classification with given attributes, relationships, and related complex resources.

Authorizations:
(api_keyuser_tokenuser_email)
path Parameters
id
required
integer
Example: 1

Unique Supplier Classification identifier.

query Parameters
include
string (SupplierClassificationRelatedResources)
Value: "supplier_classification_fields"

Use the include parameter to request related resources along with the primary resource.

Request Body schema: application/vnd.api+json
object (SupplierClassification)
included
string (SupplierClassificationRelatedResources)
Value: "supplier_classification_fields"

Responses

Request samples

Content type
application/vnd.api+json
Example
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
Example
{
  • "data": {}
}

Delete a Supplier Classification

Deletes a supplier classification.

Authorizations:
(api_keyuser_tokenuser_email)
path Parameters
id
required
integer
Example: 1

Unique supplier classification identifier.

Responses

Request samples 

curl -H "X-Api-Key: ${COMPANY_KEY}" \
     -H "X-User-Token: ${USER_TOKEN}" \
     -H "X-User-Email: ${USER_EMAIL}" \
     -H "Content-Type: application/vnd.api+json" \
     -X DELETE \
     "https://api.us.workdayspend.com/services/suppliers/v1/supplier_classifications/1"

Get a Supplier Classification by External ID

Retrieves the details of an existing supplier classification. You need to supply the unique supplier classification external identifier (the one you used when created the supplier classification).

Authorizations:
(api_keyuser_tokenuser_email)
path Parameters
external_id
required
string
Example: CL-1

Supplier classification external identifier.

query Parameters
include
string (SupplierClassificationRelatedResources)
Value: "supplier_classification_fields"

Use the include parameter to request related resources.

Responses

Request samples 

curl -H "X-Api-Key: ${COMPANY_KEY}" \
     -H "X-User-Token: ${USER_TOKEN}" \
     -H "X-User-Email: ${USER_EMAIL}" \
     -H "Content-Type: application/vnd.api+json" \
     "https://api.us.workdayspend.com/services/suppliers/v1/supplier_classifications/CL-1/external_id"

Response samples

Content type
application/vnd.api+json
Example
{
  • "data": {
    }
}

Update a Supplier Classification by External ID

Update a supplier classification with given attributes, relationships, and related complex resources.

Authorizations:
(api_keyuser_tokenuser_email)
path Parameters
external_id
required
string
Example: CL-1

Supplier classification external identifier.

query Parameters
include
string (SupplierClassificationRelatedResources)
Value: "supplier_classification_fields"

Use the include parameter to request related resources along with the primary resource.

Request Body schema: application/vnd.api+json
object (SupplierClassification)
included
string (SupplierClassificationRelatedResources)
Value: "supplier_classification_fields"

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
Example
{
  • "data": {
    }
}

Delete a Supplier Classification by External ID

Deletes a supplier classification.

Authorizations:
(api_keyuser_tokenuser_email)
path Parameters
external_id
required
string
Example: CL-1

Supplier classification external identifier.

Responses

Request samples 

curl -H "X-Api-Key: ${COMPANY_KEY}" \
     -H "X-User-Token: ${USER_TOKEN}" \
     -H "X-User-Email: ${USER_EMAIL}" \
     -H "Content-Type: application/vnd.api+json" \
     -X DELETE \
     "https://api.us.workdayspend.com/services/suppliers/v1/supplier_classifications/CL-1/external_id"

Supplier Company Segmentations

Use the supplier company segmentations API to create, update, and query the supplier company segmentations in Workday Strategic Sourcing.

Supplier Company Segmentation Object

type
required
string (SupplierCompanySegmentationType)

Object type, should always be supplier_company_segmentations.

id
required
integer (SupplierCompanySegmentationId)

Supplier company segmentation identifier string.

object (SupplierCompanySegmentationCreateAttributes)

Supplier company segmentation attributes.

{
  • "type": "supplier_company_segmentations",
  • "id": 1,
  • "attributes": {
    }
}

List Supplier Company Segmentations

Returns a list of supplier company segmentations.

Authorizations:
(api_keyuser_tokenuser_email)

Responses

Request samples 

curl -H "X-Api-Key: ${COMPANY_KEY}" \
     -H "X-User-Token: ${USER_TOKEN}" \
     -H "X-User-Email: ${USER_EMAIL}" \
     -H "Content-Type: application/vnd.api+json" \
     "https://api.us.workdayspend.com/services/suppliers/v1/supplier_company_segmentations"

Response samples

Content type
application/vnd.api+json
{}

Create a Supplier Company Segmentation

Create a supplier company segmentation with given parameters.

Authorizations:
(api_keyuser_tokenuser_email)
Request Body schema: application/vnd.api+json
object (SupplierCompanySegmentationCreate)

Responses

Request samples

Content type
application/vnd.api+json
Example
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
Example
{}

Update a Supplier Company Segmentation

Updates the details of an existing supplier company segmentation. You need to supply the unique identifier that was returned upon supplier company segmentation creation.

Please note, that request body must include an id attribute with the value of your supplier company segmentation unique identifier (the same one you passed in the URL).

Authorizations:
(api_keyuser_tokenuser_email)
path Parameters
id
required
integer
Example: 1

Unique supplier company segmentation identifier.

Request Body schema: application/vnd.api+json
object (SupplierCompanySegmentationUpdate)

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{}

Delete a Supplier Company Segmentation

Deletes a supplier company segmentation. You need to supply the unique supplier company segmentation identifier that was returned upon supplier company segmentation creation.

Authorizations:
(api_keyuser_tokenuser_email)
path Parameters
id
required
integer
Example: 1

Unique supplier company segmentation identifier.

Responses

Request samples 

curl -H "X-Api-Key: ${COMPANY_KEY}" \
     -H "X-User-Token: ${USER_TOKEN}" \
     -H "X-User-Email: ${USER_EMAIL}" \
     -H "Content-Type: application/vnd.api+json" \
     -X DELETE \
     "https://api.us.workdayspend.com/services/suppliers/v1/supplier_company_segmentations/1"

Supplier Company Risks

Use the supplier company risks API to create, update, and query the supplier company risks in Workday Strategic Sourcing.

Supplier Company Risk Object

type
required
string (SupplierCompanyRiskType)

Object type, should always be supplier_company_risks.

id
required
integer (SupplierCompanyRiskId)

Supplier company risk identifier string.

object (SupplierCompanyRiskCreateAttributes)

Supplier company risk attributes.

{
  • "type": "supplier_company_risks",
  • "id": 1,
  • "attributes": {
    }
}

List Supplier Company Risks

Returns a list of supplier company risks.

Authorizations:
(api_keyuser_tokenuser_email)

Responses

Request samples 

curl -H "X-Api-Key: ${COMPANY_KEY}" \
     -H "X-User-Token: ${USER_TOKEN}" \
     -H "X-User-Email: ${USER_EMAIL}" \
     -H "Content-Type: application/vnd.api+json" \
     "https://api.us.workdayspend.com/services/suppliers/v1/supplier_company_risks"

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "links": {}
}

Create a Supplier Company Risk

Create a supplier company risk with given parameters.

Authorizations:
(api_keyuser_tokenuser_email)
Request Body schema: application/vnd.api+json
object (SupplierCompanyRiskCreate)

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Update a Supplier Company Risk

Updates the details of an existing supplier company risk. You need to supply the unique identifier that was returned upon supplier company risk creation.

Please note, that request body must include an id attribute with the value of your supplier company risk unique identifier (the same one you passed in the URL).

Authorizations:
(api_keyuser_tokenuser_email)
path Parameters
id
required
integer
Example: 1

Unique supplier company risk identifier.

Request Body schema: application/vnd.api+json
object (SupplierCompanyRiskUpdate)

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Delete a Supplier Company Risk

Deletes a supplier company risk. You need to supply the unique supplier company risk identifier that was returned upon supplier company risk creation.

Authorizations:
(api_keyuser_tokenuser_email)
path Parameters
id
required
integer
Example: 1

Unique supplier company risk identifier.

Responses

Request samples 

curl -H "X-Api-Key: ${COMPANY_KEY}" \
     -H "X-User-Token: ${USER_TOKEN}" \
     -H "X-User-Email: ${USER_EMAIL}" \
     -H "Content-Type: application/vnd.api+json" \
     -X DELETE \
     "https://api.us.workdayspend.com/services/suppliers/v1/supplier_company_risks/1"

Supplier Company Segmentation Statuses

Use the supplier company segmentation statuses API to create, update, and query the supplier company segmentation statuses in Workday Strategic Sourcing.

Supplier Company Segmentation Status Object

type
required
string (SupplierCompanySegmentationStatusType)

Object type, should always be supplier_company_segmentation_statuses.

id
required
integer (SupplierCompanySegmentationStatusId)

Supplier company segmentation status identifier string.

object (SupplierCompanySegmentationStatusCreateAttributes)

Supplier company segmentation status attributes.

{
  • "type": "supplier_company_segmentation_statuses",
  • "id": 1,
  • "attributes": {
    }
}

List Supplier Company segmentation_statuses

Returns a list of supplier company segmentation_statuses.

Authorizations:
(api_keyuser_tokenuser_email)

Responses

Request samples 

curl -H "X-Api-Key: ${COMPANY_KEY}" \
     -H "X-User-Token: ${USER_TOKEN}" \
     -H "X-User-Email: ${USER_EMAIL}" \
     -H "Content-Type: application/vnd.api+json" \
     "https://api.us.workdayspend.com/services/suppliers/v1/supplier_company_segmentation_statuses"

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "links": {}
}

Create a Supplier Company Segmentation Status

Create a supplier company segmentation status with given parameters.

Authorizations:
(api_keyuser_tokenuser_email)
Request Body schema: application/vnd.api+json
object (SupplierCompanySegmentationStatusCreate)

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Update a Supplier Company Segmentation Status

Updates the details of an existing supplier company segmentation status. You need to supply the unique identifier that was returned upon supplier company segmentation status creation.

Please note, that request body must include an id attribute with the value of your supplier company segmentation status unique identifier (the same one you passed in the URL).

Authorizations:
(api_keyuser_tokenuser_email)
path Parameters
id
required
integer
Example: 1

Unique supplier company segmentation status identifier.

Request Body schema: application/vnd.api+json
object (SupplierCompanySegmentationStatusUpdate)

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Delete a Supplier Company Segmentation Status

Deletes a supplier company segmentation status. You need to supply the unique supplier company segmentation status identifier that was returned upon supplier company segmentation status creation.

Authorizations:
(api_keyuser_tokenuser_email)
path Parameters
id
required
integer
Example: 1

Unique supplier company segmentation status identifier.

Responses

Request samples 

curl -H "X-Api-Key: ${COMPANY_KEY}" \
     -H "X-User-Token: ${USER_TOKEN}" \
     -H "X-User-Email: ${USER_EMAIL}" \
     -H "Content-Type: application/vnd.api+json" \
     -X DELETE \
     "https://api.us.workdayspend.com/services/suppliers/v1/supplier_company_segmentation_statuses/1"

Supplier Categories

Use the supplier categories API to create, update, and query the supplier categories in Workday Strategic Sourcing.

Supplier Category Object

type
required
string (SupplierCategoryType)

Object type, should always be supplier_categories.

id
required
integer (SupplierCategoryId)

Supplier category identifier string.

object (SupplierCategoryAttributes)

Supplier category attributes.

{
  • "type": "supplier_categories",
  • "id": 1,
  • "attributes": {
    }
}

List Supplier Categories

Returns a list of supplier categories.

Authorizations:
(api_keyuser_tokenuser_email)

Responses

Request samples 

curl -H "X-Api-Key: ${COMPANY_KEY}" \
     -H "X-User-Token: ${USER_TOKEN}" \
     -H "X-User-Email: ${USER_EMAIL}" \
     -H "Content-Type: application/vnd.api+json" \
     "https://api.us.workdayspend.com/services/suppliers/v1/supplier_categories"

Response samples

Content type
application/vnd.api+json
Example
{}

Create a Supplier Category

Create a supplier category with given parameters.

Authorizations:
(api_keyuser_tokenuser_email)
Request Body schema: application/vnd.api+json
object (SupplierCategoryCreate)

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
Example
{}

Update a Supplier Category

Updates the details of an existing supplier category. You need to supply the unique identifier that was returned upon supplier category creation.

Please note, that request body must include an id attribute with the value of your supplier category unique identifier (the same one you passed in the URL).

Authorizations:
(api_keyuser_tokenuser_email)
path Parameters
id
required
integer
Example: 1

Unique supplier category identifier.

Request Body schema: application/vnd.api+json
object (SupplierCategoryUpdate)

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
Example
{}

Delete a Supplier Category

Deletes a supplier category. You need to supply the unique supplier category identifier that was returned upon supplier category creation.

Authorizations:
(api_keyuser_tokenuser_email)
path Parameters
id
required
integer
Example: 1

Unique supplier category identifier.

Responses

Request samples 

curl -H "X-Api-Key: ${COMPANY_KEY}" \
     -H "X-User-Token: ${USER_TOKEN}" \
     -H "X-User-Email: ${USER_EMAIL}" \
     -H "Content-Type: application/vnd.api+json" \
     -X DELETE \
     "https://api.us.workdayspend.com/services/suppliers/v1/supplier_categories/1"

Update a Supplier Category by External ID

Updates the details of an existing supplier category. You need to supply the unique external identifier assigned to the supplier category on creation.

Please note, that request body must include an id attribute with the value of your supplier category unique identifier (the same one you passed in the URL).

Authorizations:
(api_keyuser_tokenuser_email)
path Parameters
external_id
required
string
Example: SUPCAT

Unique supplier category external identifier.

Request Body schema: application/vnd.api+json
object (SupplierCategoryUpdate)

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{}

Delete a Supplier Category by External ID

Deletes a supplier category. You need to supply the unique supplier category external identifier assigned to the supplier category on creation.

Authorizations:
(api_keyuser_tokenuser_email)
path Parameters
external_id
required
string
Example: SUPCAT

Unique supplier category external identifier.

Responses

Request samples 

curl -H "X-Api-Key: ${COMPANY_KEY}" \
     -H "X-User-Token: ${USER_TOKEN}" \
     -H "X-User-Email: ${USER_EMAIL}" \
     -H "Content-Type: application/vnd.api+json" \
     -X DELETE \
     "https://api.us.workdayspend.com/services/suppliers/v1/supplier_categories/SUPCAT/external_id"

Supplier Groups

Use the supplier groups API to create, update, and query the supplier groups in Workday Strategic Sourcing.

Supplier Group Object

type
required
string (SupplierGroupType)

Object type, should always be supplier_groups.

id
required
integer (SupplierGroupId)

Supplier group identifier string.

object (SupplierGroupAttributes)

Supplier group attributes.

{
  • "type": "supplier_groups",
  • "id": 1,
  • "attributes": {
    }
}

List Supplier Groups

Returns a list of supplier groups.

Authorizations:
(api_keyuser_tokenuser_email)

Responses

Request samples 

curl -H "X-Api-Key: ${COMPANY_KEY}" \
     -H "X-User-Token: ${USER_TOKEN}" \
     -H "X-User-Email: ${USER_EMAIL}" \
     -H "Content-Type: application/vnd.api+json" \
     "https://api.us.workdayspend.com/services/suppliers/v1/supplier_groups"

Response samples

Content type
application/vnd.api+json
{}

Create a Supplier Group

Create a supplier group with given parameters.

Authorizations:
(api_keyuser_tokenuser_email)
Request Body schema: application/vnd.api+json
object (SupplierGroupCreate)

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{}

Update a Supplier Group

Updates the details of an existing supplier group. You need to supply the unique identifier that was returned upon supplier group creation.

Please note, that request body must include an id attribute with the value of your supplier group unique identifier (the same one you passed in the URL).

Authorizations:
(api_keyuser_tokenuser_email)
path Parameters
id
required
integer
Example: 1

Unique supplier group identifier.

Request Body schema: application/vnd.api+json
object (SupplierGroupUpdate)

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{}

Delete a Supplier Group

Deletes a supplier group. You need to supply the unique supplier group identifier that was returned upon supplier group creation.

Authorizations:
(api_keyuser_tokenuser_email)
path Parameters
id
required
integer
Example: 1

Unique supplier group identifier.

Responses

Request samples 

curl -H "X-Api-Key: ${COMPANY_KEY}" \
     -H "X-User-Token: ${USER_TOKEN}" \
     -H "X-User-Email: ${USER_EMAIL}" \
     -H "Content-Type: application/vnd.api+json" \
     -X DELETE \
     "https://api.us.workdayspend.com/services/suppliers/v1/supplier_groups/1"

Update a Supplier Group by External ID

Updates the details of an existing supplier group. You need to supply the unique external identifier assigned to the supplier group on creation.

Please note, that request body must include an id attribute with the value of your supplier group unique identifier (the same one you passed in the URL).

Authorizations:
(api_keyuser_tokenuser_email)
path Parameters
external_id
required
string
Example: SUPGROUP

Unique supplier group external identifier.

Request Body schema: application/vnd.api+json
object (SupplierGroupUpdate)

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{}

Delete a Supplier Group by External ID

Deletes a supplier group. You need to supply the unique supplier group external identifier assigned to the supplier group on creation.

Authorizations:
(api_keyuser_tokenuser_email)
path Parameters
external_id
required
string
Example: SUPGROUP

Unique supplier group external identifier.

Responses

Request samples 

curl -H "X-Api-Key: ${COMPANY_KEY}" \
     -H "X-User-Token: ${USER_TOKEN}" \
     -H "X-User-Email: ${USER_EMAIL}" \
     -H "Content-Type: application/vnd.api+json" \
     -X DELETE \
     "https://api.us.workdayspend.com/services/suppliers/v1/supplier_groups/SUPGROUP/external_id"

Contact Types

Use the contact types API to create, update, and query the contact types in Workday Strategic Sourcing.

ContactType Object

type
required
string (ContactTypeType)

Object type, should always be contact_types.

id
required
integer (ContactTypeId)

Contact type identifier string.

object (ContactTypeAttributes)

Contact type attributes.

{
  • "type": "contact_types",
  • "id": 1,
  • "attributes": {
    }
}

List Contact Types

Returns a list of contact types.

Authorizations:
(api_keyuser_tokenuser_email)

Responses

Request samples 

curl -H "X-Api-Key: ${COMPANY_KEY}" \
     -H "X-User-Token: ${USER_TOKEN}" \
     -H "X-User-Email: ${USER_EMAIL}" \
     -H "Content-Type: application/vnd.api+json" \
     "https://api.us.workdayspend.com/services/suppliers/v1/contact_types"

Response samples

Content type
application/vnd.api+json
{}

Create a Contact Type

Create a contact type with given parameters.

Authorizations:
(api_keyuser_tokenuser_email)
Request Body schema: application/vnd.api+json
object (ContactTypeCreate)

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{}

Update a Contact Type

Updates the details of an existing contact type. You need to supply the unique identifier that was returned upon contact type creation.

Please note, that request body must include an id attribute with the value of your contact type unique identifier (the same one you passed in the URL).

Authorizations:
(api_keyuser_tokenuser_email)
path Parameters
id
required
integer
Example: 1

Unique contact type identifier.

Request Body schema: application/vnd.api+json
object (ContactTypeUpdate)

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{}

Delete a Contact Type

Deletes a contact type. You need to supply the unique contact type identifier that was returned upon contact type creation.

Authorizations:
(api_keyuser_tokenuser_email)
path Parameters
id
required
integer
Example: 1

Unique contact type identifier.

Responses

Request samples 

curl -H "X-Api-Key: ${COMPANY_KEY}" \
     -H "X-User-Token: ${USER_TOKEN}" \
     -H "X-User-Email: ${USER_EMAIL}" \
     -H "Content-Type: application/vnd.api+json" \
     -X DELETE \
     "https://api.us.workdayspend.com/services/suppliers/v1/contact_types/1"

Update a Contact Type by External ID

Updates the details of an existing contact type. You need to supply the unique external identifier assigned to the contact type on creation.

Please note, that request body must include an id attribute with the value of your contact type unique identifier (the same one you passed in the URL).

Authorizations:
(api_keyuser_tokenuser_email)
path Parameters
external_id
required
string
Example: CTYPE

Unique contact type external identifier.

Request Body schema: application/vnd.api+json
object (ContactTypeUpdate)

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{}

Delete a Contact Type by External ID

Deletes a contact type. You need to supply the unique contact type external identifier assigned to the contact type on creation.

Authorizations:
(api_keyuser_tokenuser_email)
path Parameters
external_id
required
string
Example: CTYPE

Unique contact type external identifier.

Responses

Request samples 

curl -H "X-Api-Key: ${COMPANY_KEY}" \
     -H "X-User-Token: ${USER_TOKEN}" \
     -H "X-User-Email: ${USER_EMAIL}" \
     -H "Content-Type: application/vnd.api+json" \
     -X DELETE \
     "https://api.us.workdayspend.com/services/suppliers/v1/contact_types/CTYPE/external_id"