Workday Strategic Sourcing Reports 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).

Servers

A corresponding "region domain" should be used on every request. Please contact customer support if you are not sure which one to use.

Note, our original domain api.scoutrfp.com is currently deprecated. Please switch to a new US region domain on or before April-2025.

Region	Domain
US (Default)	https://api.us.workdayspend.com
Canada	https://api.ca.workdayspend.com
Europe/EU	https://api.eu.workdayspend.com

API Specification

The API conforms to the JSON API Specification.

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 for reporting only is 1 request 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.

Versioning

Note: The Reporting API handles versioning differently than our public APIs.

We release a new dated version when we make backwards incompatible changes to the API. So to be sure that the version used is consistent, we require it to be supplied in the request Accept header mime type com.workdayspend.api.version parameter.

As the JSON API spec requires to supply its mime type at least once with no parameters, the recommended way is to supply the Accept header as follows:

  application/vnd.api+json,application/vnd.api+json; com.workdayspend.api.version=2019-01-01

The next Accept header will be deprecated in April-2025:

  application/vnd.api+json,application/vnd.api+json; com.scoutrfp.api.version=2019-01-01

where 2019-01-01 is the current version.

There is 2018-04-01 version still available, which allows to pass given report id as a parameter (See 2018-04-01 Projects or Events documentation), however it might be depricated without a warning.

Pagination

The list endpoints are paginated - the records are returned in batches of 10 by default. You can change this amount by passing the page[size] parameter that supports values from 1 to 100. If the previous/next page is available for the requested records, the prev/next key respectively has a value with a link to the corresponding page in the top level links object of the response. Otherwise, if the next/previous page is not available, the value for the corresponding key is null. So normally you would fetch the record with the standard URL and repeatedly fetch the next page till it is not available any more (which means that you have fetched all the pages).

Sorting

The results of each list endpoint are sorted by its default sort value. You can override the sort value by passing the sort param to the request. Default and available values are visible in the documentation list endpoint section of each resource.

Including Relationships

By default only the id and type of record relationships will be included. To include other attributes in the response, use the include parameter with a single value or multiple comma-separated values. An array of relationship objects is then available under the top level included key. Valid include values are noted in the documentation endpoint section of each resource.

Contract Milestone Reports

This report returns a list of contract milestone report entries.

Contract Milestone Report Entries

Returns a list of milestone report entries.

Authorizations:

(api_keyuser_tokenuser_email)

Responses

Request samples

Curl

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" \
     -H "Accept: application/vnd.api+json,application/vnd.api+json; com.workdayspend.api.version=2019-01-01"
     "https://api.us.workdayspend.com/contract_milestone_reports/entries"

Response samples

Content type

application/vnd.api+json

{"data": [{"id": "1",
"type": "contract_milestone_report_entries",
"attributes": {"Scout-System ID": 1,
"Scout-Milestone Name": "example 1",
"Scout-Milestone Date": "2020-04-16",
"Scout-Milestone Date FY": 2020,
"Scout-Milestone Date FQ": 2,
"Scout-Milestone Status": "Open",
"Scout-Milestone Complete Date": null,
"Scout-Milestone Complete Date FY": null,
"Scout-Milestone Complete Date FQ": null,
"Scout-Template Milestone": false,
"Scout-Milestone Created By": null,
"Scout-Milestone Create Date": "2020-04-14",
"Scout-Milestone Create Date FY": 2020,
"Scout-Milestone Create Date FQ": 2,
"Scout-Milestone Assign Date": null,
"Scout-Milestone Assignee": null,
"Scout-Mark Completed By": null,
"Scout-# of Days Milestone is Open": null,
"Scout-Requestor Name": null,
"Scout-Request Submitted": null,
"Scout-Request Opened": null,
"Scout-ID #": 1,
"Scout-Contract Type": "Contract Type #11",
"Scout-Contract Type Short Code": "11VD",
"Scout-Supplier": null,
"Scout-Contract Title": "Fantastic Steel Plate",
"Scout-Contract State & Status": "In Progress",
"Scout-Auto Renewal": "no",
"Scout-Start Date": null,
"Scout-Start Date FY": null,
"Scout-Start Date FQ": null,
"Scout-End Date": null,
"Scout-End Date FY": null,
"Scout-End Date FQ": null,
"Scout-Sourcing Owner": "Sophie II",
"Scout-Category": null,
"Scout-Renewal Term": null,
"Custom field for project!": "Custom field value"
}
},
{"id": "2",
"type": "contract_milestone_report_entries",
"attributes": {"Scout-System ID": 2,
"Scout-Milestone Name": "example 2",
"Scout-Milestone Date": "2020-04-16",
"Scout-Milestone Date FY": 2020,
"Scout-Milestone Date FQ": 2,
"Scout-Milestone Status": "Open",
"Scout-Milestone Complete Date": null,
"Scout-Milestone Complete Date FY": null,
"Scout-Milestone Complete Date FQ": null,
"Scout-Template Milestone": false,
"Scout-Milestone Created By": null,
"Scout-Milestone Create Date": "2020-04-14",
"Scout-Milestone Create Date FY": 2020,
"Scout-Milestone Create Date FQ": 2,
"Scout-Milestone Assign Date": null,
"Scout-Milestone Assignee": null,
"Scout-Mark Completed By": null,
"Scout-# of Days Milestone is Open": null,
"Scout-Requestor Name": null,
"Scout-Request Submitted": null,
"Scout-Request Opened": null,
"Scout-ID #": 1,
"Scout-Contract Type": "Contract Type #11",
"Scout-Contract Type Short Code": "11VD",
"Scout-Supplier": null,
"Scout-Contract Title": "Fantastic Steel Plate",
"Scout-Contract State & Status": "In Progress",
"Scout-Auto Renewal": "no",
"Scout-Start Date": null,
"Scout-Start Date FY": null,
"Scout-Start Date FQ": null,
"Scout-End Date": null,
"Scout-End Date FY": null,
"Scout-End Date FQ": null,
"Scout-Sourcing Owner": "Sophie II",
"Scout-Category": null,
"Scout-Renewal Term": null,
"Custom field for project!": "Custom field value"
}
},
{"id": "3",
"type": "contract_milestone_report_entries",
"attributes": {"Scout-System ID": 3,
"Scout-Milestone Name": "this will not show up",
"Scout-Milestone Date": "2020-04-16",
"Scout-Milestone Date FY": 2020,
"Scout-Milestone Date FQ": 2,
"Scout-Milestone Status": "Open",
"Scout-Milestone Complete Date": null,
"Scout-Milestone Complete Date FY": null,
"Scout-Milestone Complete Date FQ": null,
"Scout-Template Milestone": false,
"Scout-Milestone Created By": null,
"Scout-Milestone Create Date": "2020-04-14",
"Scout-Milestone Create Date FY": 2020,
"Scout-Milestone Create Date FQ": 2,
"Scout-Milestone Assign Date": null,
"Scout-Milestone Assignee": null,
"Scout-Mark Completed By": null,
"Scout-# of Days Milestone is Open": null,
"Scout-Requestor Name": null,
"Scout-Request Submitted": null,
"Scout-Request Opened": null,
"Scout-ID #": 1,
"Scout-Contract Type": "Contract Type #11",
"Scout-Contract Type Short Code": "11VD",
"Scout-Supplier": null,
"Scout-Contract Title": "Fantastic Steel Plate",
"Scout-Contract State & Status": "In Progress",
"Scout-Auto Renewal": "no",
"Scout-Start Date": null,
"Scout-Start Date FY": null,
"Scout-Start Date FQ": null,
"Scout-End Date": null,
"Scout-End Date FY": null,
"Scout-End Date FQ": null,
"Scout-Sourcing Owner": "Sophie II",
"Scout-Category": null,
"Scout-Renewal Term": null,
"Custom field for project!": "Custom field value"
}
}
],
"links": {"prev": null,
"next": null
}
}

Contract Milestone Report Schema

Returns the contract milestone report schema.

Authorizations:

(api_keyuser_tokenuser_email)

Responses

Request samples

Curl

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" \
     -H "Accept: application/vnd.api+json,application/vnd.api+json; com.workdayspend.api.version=2019-01-01"
     "https://api.us.workdayspend.com/contract_milestone_reports/schema"

Response samples

Content type

application/vnd.api+json

{"data": {"id": "contract_milestone_schemas",
"type": "contract_milestone_schemas",
"attributes": {"fields": [{"type": "text",
"name": "Scout-System ID"
},
{"type": "text",
"name": "Scout-Milestone Name"
},
{"type": "date",
"name": "Scout-Milestone Date"
},
{"type": "integer",
"name": "Scout-Milestone Date FY"
},
{"type": "integer",
"name": "Scout-Milestone Date FQ"
},
{"type": "select",
"name": "Scout-Milestone Status"
},
{"type": "date",
"name": "Scout-Milestone Complete Date"
},
{"type": "integer",
"name": "Scout-Milestone Complete Date FY"
},
{"type": "integer",
"name": "Scout-Milestone Complete Date FQ"
},
{"type": "select",
"name": "Scout-Template Milestone"
},
{"type": "select",
"name": "Scout-Milestone Created By"
},
{"type": "date",
"name": "Scout-Milestone Create Date"
},
{"type": "integer",
"name": "Scout-Milestone Create Date FY"
},
{"type": "integer",
"name": "Scout-Milestone Create Date FQ"
},
{"type": "date",
"name": "Scout-Milestone Assign Date"
},
{"type": "select",
"name": "Scout-Milestone Assignee"
},
{"type": "select",
"name": "Scout-Mark Completed By"
},
{"type": "integer",
"name": "Scout-# of Days Milestone is Open"
},
{"type": "select",
"name": "Scout-Requestor Name"
},
{"type": "date",
"name": "Scout-Request Submitted"
},
{"type": "date",
"name": "Scout-Request Opened"
},
{"type": "text",
"name": "Scout-ID #"
},
{"type": "select",
"name": "Scout-Contract Type"
},
{"type": "select",
"name": "Scout-Contract Type Short Code"
},
{"type": "select",
"name": "Scout-Supplier"
},
{"type": "text",
"name": "Scout-Contract Title"
},
{"type": "select",
"name": "Scout-Contract State & Status"
},
{"type": "select",
"name": "Scout-Auto Renewal"
},
{"type": "date",
"name": "Scout-Start Date"
},
{"type": "integer",
"name": "Scout-Start Date FY"
},
{"type": "integer",
"name": "Scout-Start Date FQ"
},
{"type": "date",
"name": "Scout-End Date"
},
{"type": "integer",
"name": "Scout-End Date FY"
},
{"type": "integer",
"name": "Scout-End Date FQ"
},
{"type": "select",
"name": "Scout-Sourcing Owner"
},
{"type": "select",
"name": "Scout-Category"
},
{"type": "text",
"name": "Scout-Renewal Term"
},
{"type": "string",
"name": "Field #3"
}
]
}
}
}

Contract Reports

This report returns a list of contract report entries.

Contract Report Entries

Returns a list of contract report entries.

Authorizations:

(api_keyuser_tokenuser_email)

Responses

Request samples

Curl

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" \
     -H "Accept: application/vnd.api+json,application/vnd.api+json; com.workdayspend.api.version=2019-01-01"
     "https://api.us.workdayspend.com/contract_reports/entries"

Response samples

Content type

application/vnd.api+json

{"data": [{"id": "1",
"type": "contract_report_entries",
"attributes": {"Scout-Record ID": 100,
"Scout-ID #": 1,
"Scout-Contract Type": "Contract Type #22",
"Scout-Contract Type Short Code": "22JD",
"Scout-Supplier": null,
"Scout-Contract Title": "New contract",
"Scout-Contract State & Status": "In Progress - Internal Review",
"Scout-Auto Renewal": "no",
"Scout-Start Date": null,
"Scout-Start Date FY": null,
"Scout-Start Date FQ": null,
"Scout-End Date": null,
"Scout-End Date FY": null,
"Scout-End Date FQ": null,
"Scout-Currency": "USD",
"Scout-Spend": null,
"Scout-Sourcing Owner": "Gabriel Keebler",
"Scout-Category": null,
"Scout-Contract Description": "Facilis assumenda voluptatem magnam.",
"Scout-Renewal Number of Times": null,
"Scout-Renewal Term": null,
"Scout-Renewal Termination Notice": null,
"Scout-Renewal Termination Reminder": null,
"Scout-Attachments": null,
"Scout-Related Contract ID #": null,
"Scout-Related Projects": null,
"Scout-Related Project ID #": null,
"Scout-Stakeholders": "Gabriel Keebler",
"Scout-Termination Reason": null,
"Scout-Original Approval Request Date": null,
"Scout-Original Approval Request Date FY": null,
"Scout-Original Approval Request Date FQ": null,
"Scout-Approved Date": null,
"Scout-Approved FY": null,
"Scout-Approved FQ": null,
"Scout-Sent for Approval": null,
"Scout-Sent for Approval FY": null,
"Scout-Sent for Approval FQ": null,
"Scout-Contract Requester": "Gabriel Keebler",
"Scout-Contract Request Submitted Date": "2021-11-04",
"Scout-Contract Request Submitted FY": 2021,
"Scout-Contract Request Submitted FQ": 4,
"Scout-Contract Request Opened Date": "2021-11-04",
"Scout-Contract Request Opened FY": 2021,
"Scout-Contract Request Opened FQ": 4,
"Scout-Record Type": "Contract",
"Scout-Revised Contract ID #": null,
"Scout-Creator": "Gabriel Keebler",
"Scout-Last Updated Date": "2021-11-04",
"Scout-Has Attachments": false,
"Scout-Needs Attention Reason": null,
"Scout-Canceled Reason": null,
"Scout-First Milestone Assign Date": null,
"Scout-ESign Platforms": null,
"Scout-ESign States": null,
"Scout-External ID": null,
"Scout-Company": null,
"Scout-Company Hierarchy": null,
"Scout-Milestone Name": null,
"Scout-Milestone Date": null,
"Scout-Milestone Assignee": null,
"Scout-Days Requested": "0.0",
"Scout-Days In Progress - Internal Review": "0.0",
"Scout-Days In Progress - External Review": "0.0",
"Scout-Days In Progress - Negotiating": "0.0",
"Scout-Days In Progress - Out for Signature": "0.0",
"Scout-Days Approved": "0.0",
"Scout-Days Active": "0.0",
"Custom field for contract!": null
}
},
{"id": "2",
"type": "contract_report_entries",
"attributes": {"Scout-Record ID": 200,
"Scout-ID #": 2,
"Scout-Contract Type": "Contract Type #22",
"Scout-Contract Type Short Code": "22JD",
"Scout-Supplier": null,
"Scout-Contract Title": "New contract 2",
"Scout-Contract State & Status": "In Progress - Internal Review",
"Scout-Auto Renewal": "no",
"Scout-Start Date": null,
"Scout-Start Date FY": null,
"Scout-Start Date FQ": null,
"Scout-End Date": null,
"Scout-End Date FY": null,
"Scout-End Date FQ": null,
"Scout-Currency": "USD",
"Scout-Spend": null,
"Scout-Sourcing Owner": "Gabriel Keebler",
"Scout-Category": null,
"Scout-Contract Description": "Distinctio vel iure voluptas.",
"Scout-Renewal Number of Times": null,
"Scout-Renewal Term": null,
"Scout-Renewal Termination Notice": null,
"Scout-Renewal Termination Reminder": null,
"Scout-Attachments": null,
"Scout-Related Contract ID #": null,
"Scout-Related Projects": null,
"Scout-Related Project ID #": null,
"Scout-Stakeholders": "Gabriel Keebler",
"Scout-Termination Reason": null,
"Scout-Original Approval Request Date": null,
"Scout-Original Approval Request Date FY": null,
"Scout-Original Approval Request Date FQ": null,
"Scout-Approved Date": null,
"Scout-Approved FY": null,
"Scout-Approved FQ": null,
"Scout-Sent for Approval": null,
"Scout-Sent for Approval FY": null,
"Scout-Sent for Approval FQ": null,
"Scout-Contract Requester": "Gabriel Keebler",
"Scout-Contract Request Submitted Date": "2021-11-04",
"Scout-Contract Request Submitted FY": 2021,
"Scout-Contract Request Submitted FQ": 4,
"Scout-Contract Request Opened Date": "2021-11-04",
"Scout-Contract Request Opened FY": 2021,
"Scout-Contract Request Opened FQ": 4,
"Scout-Record Type": "Contract",
"Scout-Revised Contract ID #": null,
"Scout-Creator": "Gabriel Keebler",
"Scout-Last Updated Date": "2021-11-04",
"Scout-Has Attachments": false,
"Scout-Needs Attention Reason": null,
"Scout-Canceled Reason": null,
"Scout-First Milestone Assign Date": null,
"Scout-ESign Platforms": null,
"Scout-ESign States": null,
"Scout-External ID": null,
"Scout-Company": null,
"Scout-Company Hierarchy": null,
"Scout-Milestone Name": null,
"Scout-Milestone Date": null,
"Scout-Milestone Assignee": null,
"Scout-Days Requested": "0.0",
"Scout-Days In Progress - Internal Review": "0.0",
"Scout-Days In Progress - External Review": "0.0",
"Scout-Days In Progress - Negotiating": "0.0",
"Scout-Days In Progress - Out for Signature": "0.0",
"Scout-Days Approved": "0.0",
"Scout-Days Active": "0.0",
"Custom field for contract!": "Custom field value"
}
},
{"id": "3",
"type": "contract_report_entries",
"attributes": {"Scout-Record ID": 300,
"Scout-ID #": 3,
"Scout-Contract Type": "Contract Type #22",
"Scout-Contract Type Short Code": "22JD",
"Scout-Supplier": null,
"Scout-Contract Title": "Old contract",
"Scout-Contract State & Status": "In Progress - Internal Review",
"Scout-Auto Renewal": "no",
"Scout-Start Date": null,
"Scout-Start Date FY": null,
"Scout-Start Date FQ": null,
"Scout-End Date": null,
"Scout-End Date FY": null,
"Scout-End Date FQ": null,
"Scout-Currency": "USD",
"Scout-Spend": null,
"Scout-Sourcing Owner": "Gabriel Keebler",
"Scout-Category": null,
"Scout-Contract Description": "Ipsa voluptatem vel recusandae.",
"Scout-Renewal Number of Times": null,
"Scout-Renewal Term": null,
"Scout-Renewal Termination Notice": null,
"Scout-Renewal Termination Reminder": null,
"Scout-Attachments": null,
"Scout-Related Contract ID #": null,
"Scout-Related Projects": null,
"Scout-Related Project ID #": null,
"Scout-Stakeholders": "Gabriel Keebler",
"Scout-Termination Reason": null,
"Scout-Original Approval Request Date": null,
"Scout-Original Approval Request Date FY": null,
"Scout-Original Approval Request Date FQ": null,
"Scout-Approved Date": null,
"Scout-Approved FY": null,
"Scout-Approved FQ": null,
"Scout-Sent for Approval": null,
"Scout-Sent for Approval FY": null,
"Scout-Sent for Approval FQ": null,
"Scout-Contract Requester": "Gabriel Keebler",
"Scout-Contract Request Submitted Date": "2021-11-04",
"Scout-Contract Request Submitted FY": 2021,
"Scout-Contract Request Submitted FQ": 4,
"Scout-Contract Request Opened Date": "2021-11-04",
"Scout-Contract Request Opened FY": 2021,
"Scout-Contract Request Opened FQ": 4,
"Scout-Record Type": "Contract",
"Scout-Revised Contract ID #": null,
"Scout-Creator": "Gabriel Keebler",
"Scout-Last Updated Date": "2021-11-04",
"Scout-Has Attachments": false,
"Scout-Needs Attention Reason": null,
"Scout-Canceled Reason": null,
"Scout-First Milestone Assign Date": null,
"Scout-ESign Platforms": "Adobe Sign, Docusign",
"Scout-ESign States": "Creating, Waiting For Notarization",
"Scout-External ID": null,
"Scout-Company": null,
"Scout-Company Hierarchy": null,
"Scout-Milestone Name": null,
"Scout-Milestone Date": null,
"Scout-Milestone Assignee": null,
"Scout-Days Requested": "0.0",
"Scout-Days In Progress - Internal Review": "0.0",
"Scout-Days In Progress - External Review": "0.0",
"Scout-Days In Progress - Negotiating": "0.0",
"Scout-Days In Progress - Out for Signature": "0.0",
"Scout-Days Approved": "0.0",
"Scout-Days Active": "0.0",
"Custom field for contract!": null
}
}
],
"links": {"prev": null,
"next": null
}
}

Contract Report Schema

Returns the contract report schema.

Authorizations:

(api_keyuser_tokenuser_email)

Responses

Request samples

Curl

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" \
     -H "Accept: application/vnd.api+json,application/vnd.api+json; com.workdayspend.api.version=2019-01-01"
     "https://api.us.workdayspend.com/contract_reports/schema"

Response samples

Content type

application/vnd.api+json

{"data": {"id": "contract_schemas",
"type": "contract_schemas",
"attributes": {"fields": [{"type": "text",
"name": "Scout-Record ID"
},
{"type": "text",
"name": "Scout-ID #"
},
{"type": "select",
"name": "Scout-Contract Type"
},
{"type": "select",
"name": "Scout-Contract Type Short Code"
},
{"type": "select",
"name": "Scout-Supplier"
},
{"type": "text",
"name": "Scout-Contract Title"
},
{"type": "select",
"name": "Scout-Contract State & Status"
},
{"type": "select",
"name": "Scout-Auto Renewal"
},
{"type": "date",
"name": "Scout-Start Date"
},
{"type": "integer",
"name": "Scout-Start Date FY"
},
{"type": "integer",
"name": "Scout-Start Date FQ"
},
{"type": "date",
"name": "Scout-End Date"
},
{"type": "integer",
"name": "Scout-End Date FY"
},
{"type": "integer",
"name": "Scout-End Date FQ"
},
{"type": "select",
"name": "Scout-Currency"
},
{"type": "currency",
"name": "Scout-Spend"
},
{"type": "select",
"name": "Scout-Sourcing Owner"
},
{"type": "select",
"name": "Scout-Category"
},
{"type": "text",
"name": "Scout-Contract Description"
},
{"type": "integer",
"name": "Scout-Renewal Number of Times"
},
{"type": "text",
"name": "Scout-Renewal Term"
},
{"type": "date",
"name": "Scout-Renewal Termination Notice"
},
{"type": "date",
"name": "Scout-Renewal Termination Reminder"
},
{"type": "text",
"name": "Scout-Attachments"
},
{"type": "text",
"name": "Scout-Related Contract ID #"
},
{"type": "text",
"name": "Scout-Related Projects"
},
{"type": "text",
"name": "Scout-Related Project ID #"
},
{"type": "select",
"name": "Scout-Stakeholders"
},
{"type": "text",
"name": "Scout-Termination Reason"
},
{"type": "date",
"name": "Scout-Original Approval Request Date"
},
{"type": "integer",
"name": "Scout-Original Approval Request Date FY"
},
{"type": "integer",
"name": "Scout-Original Approval Request Date FQ"
},
{"type": "date",
"name": "Scout-Approved Date"
},
{"type": "integer",
"name": "Scout-Approved FY"
},
{"type": "integer",
"name": "Scout-Approved FQ"
},
{"type": "date",
"name": "Scout-Sent for Approval"
},
{"type": "integer",
"name": "Scout-Sent for Approval FY"
},
{"type": "integer",
"name": "Scout-Sent for Approval FQ"
},
{"type": "select",
"name": "Scout-Contract Requester"
},
{"type": "date",
"name": "Scout-Contract Request Submitted Date"
},
{"type": "integer",
"name": "Scout-Contract Request Submitted FY"
},
{"type": "integer",
"name": "Scout-Contract Request Submitted FQ"
},
{"type": "date",
"name": "Scout-Contract Request Opened Date"
},
{"type": "integer",
"name": "Scout-Contract Request Opened FY"
},
{"type": "integer",
"name": "Scout-Contract Request Opened FQ"
},
{"type": "select",
"name": "Scout-Record Type"
},
{"type": "text",
"name": "Scout-Revised Contract ID #"
},
{"type": "select",
"name": "Scout-Creator"
},
{"type": "date",
"name": "Scout-Last Updated Date"
},
{"type": "text",
"name": "Scout-Has Attachments"
},
{"type": "select",
"name": "Scout-Needs Attention Reason"
},
{"type": "text",
"name": "Scout-Canceled Reason"
},
{"type": "date",
"name": "Scout-First Milestone Assign Date"
},
{"type": "select",
"name": "Scout-ESign Platforms"
},
{"type": "select",
"name": "Scout-ESign States"
},
{"type": "text",
"name": "Scout-External ID"
},
{"type": "select",
"name": "Scout-Company"
},
{"type": "select",
"name": "Scout-Company Hierarchy"
},
{"type": "integer",
"name": "Scout-Days Requested"
},
{"type": "integer",
"name": "Scout-Days In Progress - Internal Review"
},
{"type": "integer",
"name": "Scout-Days In Progress - External Review"
},
{"type": "integer",
"name": "Scout-Days In Progress - Negotiating"
},
{"type": "integer",
"name": "Scout-Days In Progress - Out for Signature"
},
{"type": "integer",
"name": "Scout-Days Out For Approval"
},
{"type": "integer",
"name": "Scout-Days Approved"
},
{"type": "integer",
"name": "Scout-Days Active"
},
{"type": "text",
"name": "Scout-Milestone Name"
},
{"type": "date",
"name": "Scout-Milestone Date"
},
{"type": "select",
"name": "Scout-Milestone Assignee"
},
{"type": "string",
"name": "Custom field for contract"
}
]
}
}
}

Event Reports

This report returns a list of event report entries.

Event Report Entries

Returns a list of event report entries.

Authorizations:

(api_keyuser_tokenuser_email)

Responses

Request samples

Curl

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" \
     -H "Accept: application/vnd.api+json,application/vnd.api+json; com.workdayspend.api.version=2019-01-01"
     "https://api.us.workdayspend.com/event_reports/entries"

Response samples

Content type

application/vnd.api+json

Example

Version 2018-04-01

{"data": [{"id": "1-1",
"type": "event_report_entries",
"attributes": {"Scout-Supplier Name": "Carolina Fisher's General Store",
"Scout-Response ID": 1,
"Scout-Response Status": "Unclaimed",
"Scout-RSVP Response": null,
"Scout-Intend to Respond Date": null,
"Scout-Response Submitted Date": null,
"Scout-Response Submitted Date FY": null,
"Scout-Response Submitted Date FQ": null,
"Scout-Response Re-submitted Date": null,
"Scout-Response Re-submitted Date FY": null,
"Scout-Response Re-submitted Date FQ": null,
"Scout-Terms Accepted Date": null,
"Scout-Event ID": 1,
"Scout-Event Title": "Event",
"Scout-Event Type": "RFP",
"Scout-Event Status": "Draft",
"Scout-Categories": null,
"Scout-Sourcing Owner": "Ardella Ernser",
"Scout-Savings": "100.0",
"Scout-Spend": "1000.0",
"Scout-Currency": "USD $",
"Scout-# of Stakeholders": 1,
"Scout-Stakeholders List": "Ardella Ernser",
"Scout-Created Date": "2020-04-14",
"Scout-Created Date FY": 2020,
"Scout-Created Date FQ": 2,
"Scout-Publish Date": "2020-04-14",
"Scout-Publish Date FY": 2020,
"Scout-Publish Date FQ": 2,
"Scout-RSVP Deadline": null,
"Scout-Message Center Due Date": null,
"Scout-Submission Due Date": "2020-04-28",
"Scout-Closed Date": null,
"Scout-Closed Date FY": null,
"Scout-Closed Date FQ": null,
"Scout-Construction Request": false,
"Scout-Sealed Bids": false,
"Scout-Public": false,
"Scout-Days in Draft": "0.0",
"Scout-Days in Scheduled": "0.0",
"Scout-Days in Publish": "0.0",
"Scout-Days in Edit": "0.0",
"Scout-ID #": 1,
"Scout-Project Title": "Project 1",
"Scout-Project Type": "Project Type #38",
"Scout-Project State & Status": "Planned",
"Scout-Estimated Start Date": "2020-04-28",
"Scout-Estimated End Date": "2020-06-14",
"Scout-Actual Start Date": null,
"Scout-Actual End Date": null,
"Scout-Last Updated Date": "2020-04-14",
"Scout-Has Attachments": false,
"Field #5": "Some text"
}
},
{"id": "2-1",
"type": "event_report_entries",
"attributes": {"Scout-Supplier Name": "Priscila Collins's General Store",
"Scout-Response ID": 2,
"Scout-Response Status": "Unclaimed",
"Scout-RSVP Response": null,
"Scout-Intend to Respond Date": null,
"Scout-Response Submitted Date": null,
"Scout-Response Submitted Date FY": null,
"Scout-Response Submitted Date FQ": null,
"Scout-Response Re-submitted Date": null,
"Scout-Response Re-submitted Date FY": null,
"Scout-Response Re-submitted Date FQ": null,
"Scout-Terms Accepted Date": null,
"Scout-Event ID": 1,
"Scout-Event Title": "Event",
"Scout-Event Type": "RFP",
"Scout-Event Status": "Draft",
"Scout-Categories": null,
"Scout-Sourcing Owner": "Ardella Ernser",
"Scout-Savings": "100.0",
"Scout-Spend": "1000.0",
"Scout-Currency": "USD $",
"Scout-# of Stakeholders": 1,
"Scout-Stakeholders List": "Ardella Ernser",
"Scout-Created Date": "2020-04-14",
"Scout-Created Date FY": 2020,
"Scout-Created Date FQ": 2,
"Scout-Publish Date": "2020-04-14",
"Scout-Publish Date FY": 2020,
"Scout-Publish Date FQ": 2,
"Scout-RSVP Deadline": null,
"Scout-Message Center Due Date": null,
"Scout-Submission Due Date": "2020-04-28",
"Scout-Closed Date": null,
"Scout-Closed Date FY": null,
"Scout-Closed Date FQ": null,
"Scout-Construction Request": false,
"Scout-Sealed Bids": false,
"Scout-Public": false,
"Scout-Days in Draft": "0.0",
"Scout-Days in Scheduled": "0.0",
"Scout-Days in Publish": "0.0",
"Scout-Days in Edit": "0.0",
"Scout-ID #": 1,
"Scout-Project Title": "Project 1",
"Scout-Project Type": "Project Type #38",
"Scout-Project State & Status": "Planned",
"Scout-Estimated Start Date": "2020-04-28",
"Scout-Estimated End Date": "2020-06-14",
"Scout-Actual Start Date": null,
"Scout-Actual End Date": null,
"Scout-Last Updated Date": "2020-04-14",
"Scout-Has Attachments": false,
"Field #5": "Some text"
}
}
],
"links": {"prev": null,
"next": null
}
}

Event Single Report Entries

Returns a list of event report entries.

Authorizations:

(api_keyuser_tokenuser_email)

path Parameters

event_report_id

required

integer

Example: 1

Unique Event Report identifier.

Responses

Request samples

Curl

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" \
     -H "Accept: application/vnd.api+json,application/vnd.api+json; com.workdayspend.api.version=2019-01-01"
     "https://api.us.workdayspend.com/event_reports/{event_report_id}/entries"

Response samples

Content type

application/vnd.api+json

Example

Version 2018-04-01

{"data": [{"id": "1-1",
"type": "event_report_entries",
"attributes": {"Scout-Supplier Name": "Agustina Jones's General Store",
"Scout-Response ID": 1,
"Scout-Response Status": "Unclaimed",
"Scout-RSVP Response": null,
"Scout-Intend to Respond Date": null,
"Scout-Response Submitted Date": null,
"Scout-Response Submitted Date FY": null,
"Scout-Response Submitted Date FQ": null,
"Scout-Response Re-submitted Date": null,
"Scout-Response Re-submitted Date FY": null,
"Scout-Response Re-submitted Date FQ": null,
"Scout-Terms Accepted Date": null,
"Scout-Event ID": 1,
"Scout-Event Title": "Event",
"Scout-Event Type": "RFP",
"Scout-Event Status": "Draft",
"Scout-Categories": null,
"Scout-Sourcing Owner": "Margarito Mante",
"Scout-Savings": "100.0",
"Scout-Spend": "1000.0",
"Scout-Currency": "USD $",
"Scout-# of Stakeholders": 1,
"Scout-Stakeholders List": "Margarito Mante",
"Scout-Created Date": "2020-04-14",
"Scout-Created Date FY": 2020,
"Scout-Created Date FQ": 2,
"Scout-Publish Date": "2020-04-14",
"Scout-Publish Date FY": 2020,
"Scout-Publish Date FQ": 2,
"Scout-RSVP Deadline": null,
"Scout-Message Center Due Date": null,
"Scout-Submission Due Date": "2020-04-28",
"Scout-Closed Date": null,
"Scout-Closed Date FY": null,
"Scout-Closed Date FQ": null,
"Scout-Construction Request": false,
"Scout-Sealed Bids": false,
"Scout-Public": false,
"Scout-Days in Draft": "0.0",
"Scout-Days in Scheduled": "0.0",
"Scout-Days in Publish": "0.0",
"Scout-Days in Edit": "0.0",
"Scout-ID #": 1,
"Scout-Project Title": "Project 1",
"Scout-Project Type": "Project Type #41",
"Scout-Project State & Status": "Planned",
"Scout-Estimated Start Date": "2020-04-28",
"Scout-Estimated End Date": "2020-06-14",
"Scout-Actual Start Date": null,
"Scout-Actual End Date": null,
"Scout-Last Updated Date": "2020-04-14",
"Scout-Has Attachments": false,
"Field #6": "Some text"
}
},
{"id": "2-1",
"type": "event_report_entries",
"attributes": {"Scout-Supplier Name": "Tod Stark's General Store",
"Scout-Response ID": 2,
"Scout-Response Status": "Unclaimed",
"Scout-RSVP Response": null,
"Scout-Intend to Respond Date": null,
"Scout-Response Submitted Date": null,
"Scout-Response Submitted Date FY": null,
"Scout-Response Submitted Date FQ": null,
"Scout-Response Re-submitted Date": null,
"Scout-Response Re-submitted Date FY": null,
"Scout-Response Re-submitted Date FQ": null,
"Scout-Terms Accepted Date": null,
"Scout-Event ID": 1,
"Scout-Event Title": "Event",
"Scout-Event Type": "RFP",
"Scout-Event Status": "Draft",
"Scout-Categories": null,
"Scout-Sourcing Owner": "Margarito Mante",
"Scout-Savings": "100.0",
"Scout-Spend": "1000.0",
"Scout-Currency": "USD $",
"Scout-# of Stakeholders": 1,
"Scout-Stakeholders List": "Margarito Mante",
"Scout-Created Date": "2020-04-14",
"Scout-Created Date FY": 2020,
"Scout-Created Date FQ": 2,
"Scout-Publish Date": "2020-04-14",
"Scout-Publish Date FY": 2020,
"Scout-Publish Date FQ": 2,
"Scout-RSVP Deadline": null,
"Scout-Message Center Due Date": null,
"Scout-Submission Due Date": "2020-04-28",
"Scout-Closed Date": null,
"Scout-Closed Date FY": null,
"Scout-Closed Date FQ": null,
"Scout-Construction Request": false,
"Scout-Sealed Bids": false,
"Scout-Public": false,
"Scout-Days in Draft": "0.0",
"Scout-Days in Scheduled": "0.0",
"Scout-Days in Publish": "0.0",
"Scout-Days in Edit": "0.0",
"Scout-ID #": 1,
"Scout-Project Title": "Project 1",
"Scout-Project Type": "Project Type #41",
"Scout-Project State & Status": "Planned",
"Scout-Estimated Start Date": "2020-04-28",
"Scout-Estimated End Date": "2020-06-14",
"Scout-Actual Start Date": null,
"Scout-Actual End Date": null,
"Scout-Last Updated Date": "2020-04-14",
"Scout-Has Attachments": false,
"Field #6": "Some text"
}
}
],
"links": {"prev": null,
"next": null
}
}

Event Report Entries (Deprecated)

Returns a list of reports owned by the user.

This report endpoint is only valid in version 2018-04-01.

It is deprecated and unavailable in subsequent versions.

Authorizations:

(api_keyuser_tokenuser_email)

Responses

Request samples

Curl

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" \
     -H "Accept: application/vnd.api+json,application/vnd.api+json; com.workdayspend.api.version=2018-04-01"
     "https://api.us.workdayspend.com/event_reports"

Response samples

Content type

application/vnd.api+json

{"data": [{"id": "1",
"type": "event_reports",
"attributes": {"title": "Report 1",
"description": "Report 1 description"
},
"links": {"entries": "https://api.us.workdayspend.com/event_reports/1/entries",
"schema": "https://api.us.workdayspend.com/event_reports/1/schema"
}
},
{"id": "2",
"type": "event_reports",
"attributes": {"title": "Report 2",
"description": "Report 2 description"
},
"links": {"entries": "https://api.us.workdayspend.com/event_reports/2/entries",
"schema": "https://api.us.workdayspend.com/event_reports/2/schema"
}
},
{"id": "3",
"type": "event_reports",
"attributes": {"title": "Report 3",
"description": "Report 3 description"
},
"links": {"entries": "https://api.us.workdayspend.com/event_reports/3/entries",
"schema": "https://api.us.workdayspend.com/event_reports/3/schema"
}
}
],
"links": {"prev": null,
"next": null
}
}

Event Report Schema

Returns the event report schema.

Authorizations:

(api_keyuser_tokenuser_email)

Responses

Request samples

Curl

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" \
     -H "Accept: application/vnd.api+json,application/vnd.api+json; com.workdayspend.api.version=2019-01-01"
     "https://api.us.workdayspend.com/event_reports/schema"

Response samples

Content type

application/vnd.api+json

{"data": {"id": "event_schemas",
"type": "event_schemas",
"attributes": {"fields": [{"type": "select",
"name": "Scout-Supplier Name"
},
{"type": "text",
"name": "Scout-Response ID"
},
{"type": "select",
"name": "Scout-Response Status"
},
{"type": "text",
"name": "Scout-RSVP Response"
},
{"type": "date",
"name": "Scout-Intend to Respond Date"
},
{"type": "date",
"name": "Scout-Response Submitted Date"
},
{"type": "integer",
"name": "Scout-Response Submitted Date FY"
},
{"type": "integer",
"name": "Scout-Response Submitted Date FQ"
},
{"type": "date",
"name": "Scout-Response Re-submitted Date"
},
{"type": "integer",
"name": "Scout-Response Re-submitted Date FY"
},
{"type": "integer",
"name": "Scout-Response Re-submitted Date FQ"
},
{"type": "date",
"name": "Scout-Terms Accepted Date"
},
{"type": "text",
"name": "Scout-Event ID"
},
{"type": "text",
"name": "Scout-Event Title"
},
{"type": "select",
"name": "Scout-Event Type"
},
{"type": "select",
"name": "Scout-Event Status"
},
{"type": "select",
"name": "Scout-Categories"
},
{"type": "select",
"name": "Scout-Sourcing Owner"
},
{"type": "currency",
"name": "Scout-Savings"
},
{"type": "currency",
"name": "Scout-Spend"
},
{"type": "text",
"name": "Scout-Currency"
},
{"type": "integer",
"name": "Scout-# of Stakeholders"
},
{"type": "text",
"name": "Scout-Stakeholders List"
},
{"type": "date",
"name": "Scout-Created Date"
},
{"type": "integer",
"name": "Scout-Created Date FY"
},
{"type": "integer",
"name": "Scout-Created Date FQ"
},
{"type": "date",
"name": "Scout-Publish Date"
},
{"type": "integer",
"name": "Scout-Publish Date FY"
},
{"type": "integer",
"name": "Scout-Publish Date FQ"
},
{"type": "date",
"name": "Scout-RSVP Deadline"
},
{"type": "date",
"name": "Scout-Message Center Due Date"
},
{"type": "date",
"name": "Scout-Submission Due Date"
},
{"type": "date",
"name": "Scout-Closed Date"
},
{"type": "integer",
"name": "Scout-Closed Date FY"
},
{"type": "integer",
"name": "Scout-Closed Date FQ"
},
{"type": "text",
"name": "Scout-Construction Request"
},
{"type": "text",
"name": "Scout-Sealed Bids"
},
{"type": "text",
"name": "Scout-Public"
},
{"type": "integer",
"name": "Scout-Days in Draft"
},
{"type": "integer",
"name": "Scout-Days in Scheduled"
},
{"type": "integer",
"name": "Scout-Days in Publish"
},
{"type": "integer",
"name": "Scout-Days in Edit"
},
{"type": "text",
"name": "Scout-ID #"
},
{"type": "text",
"name": "Scout-Project Title"
},
{"type": "select",
"name": "Scout-Project Type"
},
{"type": "select",
"name": "Scout-Project State & Status"
},
{"type": "date",
"name": "Scout-Estimated Start Date"
},
{"type": "date",
"name": "Scout-Estimated End Date"
},
{"type": "date",
"name": "Scout-Actual Start Date"
},
{"type": "date",
"name": "Scout-Actual End Date"
},
{"type": "date",
"name": "Scout-Last Updated Date"
},
{"type": "text",
"name": "Scout-Has Attachments"
},
{"type": "string",
"name": "Field #11"
}
]
}
}
}

Performance Review Answer Reports

This report returns a list of Performance Review Answer report entries.

Performance Review Answer Report Entries

Returns a list of performance review answer entries.

Authorizations:

(api_keyuser_tokenuser_email)

Responses

Request samples

Curl

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" \
     -H "Accept: application/vnd.api+json,application/vnd.api+json; com.workdayspend.api.version=2019-01-01"
     "https://api.us.workdayspend.com/performance_review_answer_reports/entries"

Response samples

Content type

application/vnd.api+json

{"data": [{"id": "1",
"type": "performance_review_answer_report_entries",
"attributes": {"Scout-Supplier Name": "Mr. Dannielle Von's General Store",
"Scout-Supplier Description": null,
"Scout-Supplier Segmentation Status": null,
"Scout-Supplier Risk": null,
"Scout-Supplier Segmentation": null,
"Scout-Supplier Tags": null,
"Scout-Supplier Website": null,
"Scout-System ID": 100,
"Scout-Project ID": 1,
"Scout-Performance Review Title": "Ergonomic Wooden Table",
"Scout-Project Number": 1000,
"Scout-Event ID": 111,
"Scout-Event Title": "Event",
"Scout-Section Title": "Section A",
"Scout-Section Order": null,
"Scout-Section Weight": 100,
"Scout-Question Type": "file",
"Scout-Question Content": "Question 1",
"Scout-Question Weight": 25,
"Scout-Answer Content": "Answer 1",
"Scout-Answer Score": null,
"Scout-Answer Selected Options": null,
"Scout-Answer Weighted Score": null,
"Scout-Answer Not Applicable": false,
"Scout-Stakeholder Email": "gabriel.keebler@test.com",
"Scout-Stakeholder Name": "Gabriel Keebler",
"Scout-Supplier Company ID": 1111,
"Scout-Has Attachments": false
}
},
{"id": "2",
"type": "performance_review_answer_report_entries",
"attributes": {"Scout-Supplier Name": "Mr. Dannielle Von's General Store",
"Scout-Supplier Description": null,
"Scout-Supplier Segmentation Status": null,
"Scout-Supplier Risk": null,
"Scout-Supplier Segmentation": null,
"Scout-Supplier Tags": null,
"Scout-Supplier Website": null,
"Scout-System ID": 100,
"Scout-Project ID": 1,
"Scout-Performance Review Title": "Ergonomic Wooden Table",
"Scout-Project Number": 1000,
"Scout-Event ID": 111,
"Scout-Event Title": "Event",
"Scout-Section Title": "Section A",
"Scout-Section Order": null,
"Scout-Section Weight": 100,
"Scout-Question Type": "short",
"Scout-Question Content": "Question 2",
"Scout-Question Weight": 25,
"Scout-Answer Content": "Answer 2",
"Scout-Answer Score": null,
"Scout-Answer Selected Options": null,
"Scout-Answer Weighted Score": null,
"Scout-Answer Not Applicable": false,
"Scout-Stakeholder Email": "gabriel.keebler@test.com",
"Scout-Stakeholder Name": "Gabriel Keebler",
"Scout-Supplier Company ID": 1111,
"Scout-Has Attachments": false
}
},
{"id": "3",
"type": "performance_review_answer_report_entries",
"attributes": {"Scout-Supplier Name": "Mr. Dannielle Von's General Store",
"Scout-Supplier Description": null,
"Scout-Supplier Segmentation Status": null,
"Scout-Supplier Risk": null,
"Scout-Supplier Segmentation": null,
"Scout-Supplier Tags": null,
"Scout-Supplier Website": null,
"Scout-System ID": 100,
"Scout-Project ID": 1,
"Scout-Performance Review Title": "Ergonomic Wooden Table",
"Scout-Project Number": 1000,
"Scout-Event ID": 111,
"Scout-Event Title": "Event",
"Scout-Section Title": "Section A",
"Scout-Section Order": null,
"Scout-Section Weight": 100,
"Scout-Question Type": "short",
"Scout-Question Content": "Question 3",
"Scout-Question Weight": 50,
"Scout-Answer Content": "Answer 3",
"Scout-Answer Score": null,
"Scout-Answer Selected Options": null,
"Scout-Answer Weighted Score": null,
"Scout-Answer Not Applicable": false,
"Scout-Stakeholder Email": "gabriel.keebler@test.com",
"Scout-Stakeholder Name": "Gabriel Keebler",
"Scout-Supplier Company ID": 1111,
"Scout-Has Attachments": false
}
}
],
"links": {"prev": null,
"next": null
}
}

Performance Review Answer Schema

Returns the performance review answer report schema.

Authorizations:

(api_keyuser_tokenuser_email)

Responses

Request samples

Curl

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" \
     -H "Accept: application/vnd.api+json,application/vnd.api+json; com.workdayspend.api.version=2019-01-01"
     "https://api.us.workdayspend.com/performance_review_answer_reports/schema"

Response samples

Content type

application/vnd.api+json

{"data": {"id": "performance_review_answer_schemas",
"type": "performance_review_answer_schemas",
"attributes": {"fields": [{"type": "text",
"name": "Scout-Supplier Name"
},
{"type": "text",
"name": "Scout-Supplier Description"
},
{"type": "select",
"name": "Scout-Supplier Segmentation Status"
},
{"type": "select",
"name": "Scout-Supplier Risk"
},
{"type": "select",
"name": "Scout-Supplier Segmentation"
},
{"type": "select",
"name": "Scout-Supplier Tags"
},
{"type": "text",
"name": "Scout-Supplier Website"
},
{"type": "text",
"name": "Scout-System ID"
},
{"type": "text",
"name": "Scout-Project ID"
},
{"type": "text",
"name": "Scout-Performance Review Title"
},
{"type": "text",
"name": "Scout-Project Number"
},
{"type": "text",
"name": "Scout-Event ID"
},
{"type": "text",
"name": "Scout-Event Title"
},
{"type": "text",
"name": "Scout-Section Title"
},
{"type": "integer",
"name": "Scout-Section Order"
},
{"type": "decimal",
"name": "Scout-Section Weight"
},
{"type": "select",
"name": "Scout-Question Type"
},
{"type": "text",
"name": "Scout-Question Content"
},
{"type": "decimal",
"name": "Scout-Question Weight"
},
{"type": "text",
"name": "Scout-Answer Content"
},
{"type": "decimal",
"name": "Scout-Answer Score"
},
{"type": "text",
"name": "Scout-Answer Selected Options"
},
{"type": "decimal",
"name": "Scout-Answer Weighted Score"
},
{"type": "select",
"name": "Scout-Answer Not Applicable"
},
{"type": "text",
"name": "Scout-Stakeholder Email"
},
{"type": "text",
"name": "Scout-Stakeholder Name"
},
{"type": "text",
"name": "Scout-Supplier Company ID"
},
{"type": "text",
"name": "Scout-Has Attachments"
}
]
}
}
}

Performance Review Reports

This report returns a list of Performance Review report entries.

Performance Review Report Entries

Returns a list of peformance review entries.

Authorizations:

(api_keyuser_tokenuser_email)

Responses

Request samples

Curl

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" \
     -H "Accept: application/vnd.api+json,application/vnd.api+json; com.workdayspend.api.version=2019-01-01"
     "https://api.us.workdayspend.com/performance_review_reports/entries"

Response samples

Content type

application/vnd.api+json

{"data": [{"id": "1",
"type": "performance_review_report_entries",
"attributes": {"Scout-Supplier Name": "Mr. Dannielle Von's General Store",
"Scout-Project ID": 1,
"Scout-Performance Review Title": "Ergonomic Wooden Table",
"Scout-Total Score": null,
"Scout-High": null,
"Scout-Low": null,
"Scout-Median": null,
"Scout-Executive Summary": "Executive summary 1",
"Scout-Scorecard Completed Date": null,
"Scout-Category": null,
"Scout-Sourcing Owner": null,
"Scout-Total: Pricing & Financials": null,
"Scout-Weight: Pricing & Financials": null,
"Scout-Total: Quality & Level of Service": null,
"Scout-Weight: Quality & Level of Service": null,
"Scout-Total: Maintenance & Delivery": null,
"Scout-Weight: Maintenance & Delivery": null,
"Scout-Total: Account Management": null,
"Scout-Weight: Account Management": null,
"Scout-Total: Innovation": null,
"Scout-Weight: Innovation": null,
"Custom string field name": null
}
},
{"id": "2",
"type": "performance_review_report_entries",
"attributes": {"Scout-Supplier Name": "Alejandro Konopelski's General Store",
"Scout-Project ID": 1,
"Scout-Performance Review Title": "Ergonomic Wooden Table",
"Scout-Total Score": null,
"Scout-High": null,
"Scout-Low": null,
"Scout-Median": null,
"Scout-Executive Summary": "Executive summary 2",
"Scout-Scorecard Completed Date": null,
"Scout-Category": null,
"Scout-Sourcing Owner": null,
"Scout-Total: Pricing & Financials": null,
"Scout-Weight: Pricing & Financials": null,
"Scout-Total: Quality & Level of Service": null,
"Scout-Weight: Quality & Level of Service": null,
"Scout-Total: Maintenance & Delivery": null,
"Scout-Weight: Maintenance & Delivery": null,
"Scout-Total: Account Management": null,
"Scout-Weight: Account Management": null,
"Scout-Total: Innovation": null,
"Scout-Weight: Innovation": null,
"Custom string field name": "Custom string field value"
}
},
{"id": "3",
"type": "performance_review_report_entries",
"attributes": {"Scout-Supplier Name": "Giovanni Watsica's General Store",
"Scout-Project ID": 1,
"Scout-Performance Review Title": "Ergonomic Wooden Table",
"Scout-Total Score": null,
"Scout-High": null,
"Scout-Low": null,
"Scout-Median": null,
"Scout-Executive Summary": "Executive summary 3",
"Scout-Scorecard Completed Date": null,
"Scout-Category": null,
"Scout-Sourcing Owner": null,
"Scout-Total: Pricing & Financials": null,
"Scout-Weight: Pricing & Financials": null,
"Scout-Total: Quality & Level of Service": null,
"Scout-Weight: Quality & Level of Service": null,
"Scout-Total: Maintenance & Delivery": null,
"Scout-Weight: Maintenance & Delivery": null,
"Scout-Total: Account Management": null,
"Scout-Weight: Account Management": null,
"Scout-Total: Innovation": null,
"Scout-Weight: Innovation": null,
"Custom string field name": null
}
}
],
"links": {"prev": null,
"next": null
}
}

Performance Review Report Schema

Returns the performance review report schema.

Authorizations:

(api_keyuser_tokenuser_email)

Responses

Request samples

Curl

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" \
     -H "Accept: application/vnd.api+json,application/vnd.api+json; com.workdayspend.api.version=2019-01-01"
     "https://api.us.workdayspend.com/performance_review_reports/schema"

Response samples

Content type

application/vnd.api+json

{"data": {"id": "performance_review_schemas",
"type": "performance_review_schemas",
"attributes": {"fields": [{"type": "text",
"name": "Scout-Supplier Name"
},
{"type": "text",
"name": "Scout-Project ID"
},
{"type": "text",
"name": "Scout-Performance Review Title"
},
{"type": "integer",
"name": "Scout-Total Score"
},
{"type": "integer",
"name": "Scout-High"
},
{"type": "integer",
"name": "Scout-Low"
},
{"type": "integer",
"name": "Scout-Median"
},
{"type": "text",
"name": "Scout-Executive Summary"
},
{"type": "date",
"name": "Scout-Scorecard Completed Date"
},
{"type": "select",
"name": "Scout-Category"
},
{"type": "select",
"name": "Scout-Sourcing Owner"
},
{"type": "string",
"name": "Field #13"
}
]
}
}
}

Project Milestone Reports

This report returns a list of Project Milestone report entries.

Project Milestone Report Entries

Returns a list of project milestone entries.

Authorizations:

(api_keyuser_tokenuser_email)

Responses

Request samples

Curl

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" \
     -H "Accept: application/vnd.api+json,application/vnd.api+json; com.workdayspend.api.version=2019-01-01"
     "https://api.us.workdayspend.com/project_milestone_reports/entries"

Response samples

Content type

application/vnd.api+json

{"data": [{"id": "1",
"type": "project_milestone_report_entries",
"attributes": {"Scout-Milestone Name": "example 1",
"Scout-Milestone Date": "2020-04-16",
"Scout-Milestone Date FY": 2020,
"Scout-Milestone Date FQ": 2,
"Scout-Milestone Status": "Open",
"Scout-Milestone Complete Date": null,
"Scout-Milestone Complete Date FY": null,
"Scout-Milestone Complete Date FQ": null,
"Scout-Template Milestone": false,
"Scout-Milestone Created By": null,
"Scout-Milestone Create Date": "2020-04-14",
"Scout-Milestone Create Date FY": 2020,
"Scout-Milestone Create Date FQ": 2,
"Scout-Milestone Assign Date": null,
"Scout-Milestone Assignee": null,
"Scout-Mark Completed By": null,
"Scout-# of Days Milestone is Open": null,
"Scout-ID #": 1,
"Scout-Project Title": "Enormous Rubber Plate",
"Scout-Project Type": "Project Type #72",
"Scout-Project Type Short Code": "72P5",
"Scout-Project Needs Attention": "No",
"Scout-Project State & Status": "Planned",
"Scout-Sourcing Owner": "Miss McLaughlin",
"Scout-Project Requester": null,
"Scout-Category": null,
"Scout-Estimated Start Date": "2020-04-28",
"Scout-Estimated Start Date FY": 2020,
"Scout-Estimated Start Date FQ": 2,
"Scout-Estimated End Date": "2020-06-14",
"Scout-Estimated End Date FY": 2020,
"Scout-Estimated End Date FQ": 2,
"Scout-Actual Start Date": null,
"Scout-Actual Start Date FY": null,
"Scout-Actual Start Date FQ": null,
"Scout-Actual End Date": null,
"Scout-Actual End Date FY": null,
"Scout-Actual End Date FQ": null,
"Scout-Request Submitted": null,
"Scout-Request Opened": null,
"Custom field for project!": "Custom field value"
}
},
{"id": "2",
"type": "project_milestone_report_entries",
"attributes": {"Scout-Milestone Name": "example 2",
"Scout-Milestone Date": "2020-04-16",
"Scout-Milestone Date FY": 2020,
"Scout-Milestone Date FQ": 2,
"Scout-Milestone Status": "Open",
"Scout-Milestone Complete Date": null,
"Scout-Milestone Complete Date FY": null,
"Scout-Milestone Complete Date FQ": null,
"Scout-Template Milestone": false,
"Scout-Milestone Created By": null,
"Scout-Milestone Create Date": "2020-04-14",
"Scout-Milestone Create Date FY": 2020,
"Scout-Milestone Create Date FQ": 2,
"Scout-Milestone Assign Date": null,
"Scout-Milestone Assignee": null,
"Scout-Mark Completed By": null,
"Scout-# of Days Milestone is Open": null,
"Scout-ID #": 1,
"Scout-Project Title": "Enormous Rubber Plate",
"Scout-Project Type": "Project Type #72",
"Scout-Project Type Short Code": "72P5",
"Scout-Project Needs Attention": "No",
"Scout-Project State & Status": "Planned",
"Scout-Sourcing Owner": "Miss McLaughlin",
"Scout-Project Requester": null,
"Scout-Category": null,
"Scout-Estimated Start Date": "2020-04-28",
"Scout-Estimated Start Date FY": 2020,
"Scout-Estimated Start Date FQ": 2,
"Scout-Estimated End Date": "2020-06-14",
"Scout-Estimated End Date FY": 2020,
"Scout-Estimated End Date FQ": 2,
"Scout-Actual Start Date": null,
"Scout-Actual Start Date FY": null,
"Scout-Actual Start Date FQ": null,
"Scout-Actual End Date": null,
"Scout-Actual End Date FY": null,
"Scout-Actual End Date FQ": null,
"Scout-Request Submitted": null,
"Scout-Request Opened": null,
"Custom field for project!": "Custom field value"
}
},
{"id": "3",
"type": "project_milestone_report_entries",
"attributes": {"Scout-Milestone Name": "this will not show up",
"Scout-Milestone Date": "2020-04-16",
"Scout-Milestone Date FY": 2020,
"Scout-Milestone Date FQ": 2,
"Scout-Milestone Status": "Open",
"Scout-Milestone Complete Date": null,
"Scout-Milestone Complete Date FY": null,
"Scout-Milestone Complete Date FQ": null,
"Scout-Template Milestone": false,
"Scout-Milestone Created By": null,
"Scout-Milestone Create Date": "2020-04-14",
"Scout-Milestone Create Date FY": 2020,
"Scout-Milestone Create Date FQ": 2,
"Scout-Milestone Assign Date": null,
"Scout-Milestone Assignee": null,
"Scout-Mark Completed By": null,
"Scout-# of Days Milestone is Open": null,
"Scout-ID #": 1,
"Scout-Project Title": "Enormous Rubber Plate",
"Scout-Project Type": "Project Type #72",
"Scout-Project Type Short Code": "72P5",
"Scout-Project Needs Attention": "No",
"Scout-Project State & Status": "Planned",
"Scout-Sourcing Owner": "Miss McLaughlin",
"Scout-Project Requester": null,
"Scout-Category": null,
"Scout-Estimated Start Date": "2020-04-28",
"Scout-Estimated Start Date FY": 2020,
"Scout-Estimated Start Date FQ": 2,
"Scout-Estimated End Date": "2020-06-14",
"Scout-Estimated End Date FY": 2020,
"Scout-Estimated End Date FQ": 2,
"Scout-Actual Start Date": null,
"Scout-Actual Start Date FY": null,
"Scout-Actual Start Date FQ": null,
"Scout-Actual End Date": null,
"Scout-Actual End Date FY": null,
"Scout-Actual End Date FQ": null,
"Scout-Request Submitted": null,
"Scout-Request Opened": null,
"Custom field for project!": "Custom field value"
}
}
],
"links": {"prev": null,
"next": null
}
}

Project Milestone Report Schema

Returns the project milestone report schema.

Authorizations:

(api_keyuser_tokenuser_email)

Responses

Request samples

Curl

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" \
     -H "Accept: application/vnd.api+json,application/vnd.api+json; com.workdayspend.api.version=2019-01-01"
     "https://api.us.workdayspend.com/project_milestone_reports/schema"

Response samples

Content type

application/vnd.api+json

{"data": {"id": "project_milestone_schemas",
"type": "project_milestone_schemas",
"attributes": {"fields": [{"type": "text",
"name": "Scout-Milestone Name"
},
{"type": "date",
"name": "Scout-Milestone Date"
},
{"type": "integer",
"name": "Scout-Milestone Date FY"
},
{"type": "integer",
"name": "Scout-Milestone Date FQ"
},
{"type": "select",
"name": "Scout-Milestone Status"
},
{"type": "date",
"name": "Scout-Milestone Complete Date"
},
{"type": "integer",
"name": "Scout-Milestone Complete Date FY"
},
{"type": "integer",
"name": "Scout-Milestone Complete Date FQ"
},
{"type": "select",
"name": "Scout-Template Milestone"
},
{"type": "select",
"name": "Scout-Milestone Created By"
},
{"type": "date",
"name": "Scout-Milestone Create Date"
},
{"type": "integer",
"name": "Scout-Milestone Create Date FY"
},
{"type": "integer",
"name": "Scout-Milestone Create Date FQ"
},
{"type": "date",
"name": "Scout-Milestone Assign Date"
},
{"type": "select",
"name": "Scout-Milestone Assignee"
},
{"type": "select",
"name": "Scout-Mark Completed By"
},
{"type": "integer",
"name": "Scout-# of Days Milestone is Open"
},
{"type": "text",
"name": "Scout-ID #"
},
{"type": "text",
"name": "Scout-Project Title"
},
{"type": "select",
"name": "Scout-Project Type"
},
{"type": "select",
"name": "Scout-Project Type Short Code"
},
{"type": "text",
"name": "Scout-Project Needs Attention"
},
{"type": "select",
"name": "Scout-Project State & Status"
},
{"type": "select",
"name": "Scout-Sourcing Owner"
},
{"type": "select",
"name": "Scout-Project Requester"
},
{"type": "select",
"name": "Scout-Category"
},
{"type": "date",
"name": "Scout-Estimated Start Date"
},
{"type": "integer",
"name": "Scout-Estimated Start Date FY"
},
{"type": "integer",
"name": "Scout-Estimated Start Date FQ"
},
{"type": "date",
"name": "Scout-Estimated End Date"
},
{"type": "integer",
"name": "Scout-Estimated End Date FY"
},
{"type": "integer",
"name": "Scout-Estimated End Date FQ"
},
{"type": "date",
"name": "Scout-Actual Start Date"
},
{"type": "integer",
"name": "Scout-Actual Start Date FY"
},
{"type": "integer",
"name": "Scout-Actual Start Date FQ"
},
{"type": "date",
"name": "Scout-Actual End Date"
},
{"type": "integer",
"name": "Scout-Actual End Date FY"
},
{"type": "integer",
"name": "Scout-Actual End Date FQ"
},
{"type": "date",
"name": "Scout-Request Submitted"
},
{"type": "date",
"name": "Scout-Request Opened"
},
{"type": "string",
"name": "Field #15"
}
]
}
}
}

Project Reports

This report returns a list of Project report entries.

Project Report Entries

Returns a list of project report entries.

Does not support project_report_id parameter for the 2019-01-01 version.

Authorizations:

(api_keyuser_tokenuser_email)

Responses

Request samples

Curl

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" \
     -H "Accept: application/vnd.api+json,application/vnd.api+json; com.workdayspend.api.version=2019-01-01"
     "https://api.us.workdayspend.com/project_reports/entries"

Response samples

Content type

application/vnd.api+json

{"data": [{"id": "1",
"type": "project_report_entries",
"attributes": {"Scout-System ID": 100,
"Scout-ID #": 1,
"Scout-Project Title": "Project 1",
"Scout-Project Type": "General Project",
"Scout-Project Type Short Code": "GENR",
"Scout-Project Needs Attention": false,
"Scout-Project State & Status": "Planned",
"Scout-Sourcing Owner": "Gabriel Keebler",
"Scout-Project Requester": "Gabriel Keebler",
"Scout-Category": null,
"Scout-Project Description": null,
"Scout-# of Suppliers on Project": 0,
"Scout-Suppliers on Project": null,
"Scout-Estimated Start Date": "2018-08-30",
"Scout-Estimated Start Date FY": 2018,
"Scout-Estimated Start Date FQ": 3,
"Scout-Estimated End Date": "2018-08-31",
"Scout-Estimated End Date FY": 2018,
"Scout-Estimated End Date FQ": 3,
"Scout-Actual Start Date": "2018-08-30",
"Scout-Actual Start Date FY": 2018,
"Scout-Actual Start Date FQ": 3,
"Scout-Actual End Date": "2018-08-31",
"Scout-Actual End Date FY": 2018,
"Scout-Actual End Date FQ": 3,
"Scout-Request Submitted": "2018-08-01",
"Scout-Request Opened": "2018-08-01",
"Scout-Estimated Spend": null,
"Scout-Estimated Savings": null,
"Scout-Final Spend": null,
"Scout-Savings Type": null,
"Scout-Recognized Savings": null,
"Scout-Projected Recognized Savings": null,
"Scout-Unrecognized Savings": null,
"Scout-Projected Unrecognized Savings": null,
"Scout-Total Savings": null,
"Scout-# of Stakeholders": 1,
"Scout-Stakeholders List": "Gabriel Keebler",
"Scout-Event Names": null,
"Scout-Event Status": null,
"Scout-# of Suppliers Invited to Event(s)": 0,
"Scout-Suppliers Invited to Event(s)": null,
"Scout-External ID": null,
"Scout-Canceled Reason": null,
"Scout-Original Approval Request Date": null,
"Scout-Original Approval Request Date FY": null,
"Scout-Original Approval Request Date FQ": null,
"Scout-Approved Date": null,
"Scout-Approved FY": null,
"Scout-Approved FQ": null,
"Scout-Sent for Approval": null,
"Scout-Sent for Approval FY": null,
"Scout-Sent for Approval FQ": null,
"Scout-Needs Attention Reason": null,
"Scout-Last Updated Date": "2018-08-31",
"Scout-Has Attachments": false,
"Scout-Related Project ID #": "1000",
"Scout-First Milestone Assign Date": null,
"Scout-Milestone Name": null,
"Scout-Milestone Date": null,
"Scout-Milestone Status": null,
"Scout-Milestone Complete Date": null,
"Scout-Template Milestone": null,
"Scout-Milestone Created By": null,
"Scout-Milestone Create Date": null,
"Scout-Milestone Assignee": null,
"Scout-Mark Completed By": null,
"Scout-# of Days Milestone is Open": null,
"Scout-Days Requested": "0.0",
"Scout-Days Planned": "0.0",
"Scout-Days Active - Discovery": "0.0",
"Scout-Days Active - Planning Performance Review": "0.0",
"Scout-Days Active - Sourcing": "0.0",
"Scout-Days Active - Published Stakeholder & Supplier Review": "0.0",
"Scout-Days Active - Negotiation": "0.0",
"Scout-Days Active - Evaluating Responses": "0.0",
"Scout-Days Active - Contract": "0.0",
"Scout-Days Active - Supplier Meeting": "0.0",
"Scout-Days Active - Develop Action Item Plan": "0.0",
"Scout-Days Out For Approval": "0.0",
"Scout-Days Approved": "0.0",
"Scout-Days On hold": "0.0",
"Custom field for project!": null,
"Custom date field": null
}
},
{"id": "2",
"type": "project_report_entries",
"attributes": {"Scout-System ID": 200,
"Scout-ID #": 2,
"Scout-Project Title": "Project 2",
"Scout-Project Type": "General Project",
"Scout-Project Type Short Code": "GENR",
"Scout-Project Needs Attention": false,
"Scout-Project State & Status": "Planned",
"Scout-Sourcing Owner": "Gabriel Keebler",
"Scout-Project Requester": "Gabriel Keebler",
"Scout-Category": null,
"Scout-Project Description": null,
"Scout-# of Suppliers on Project": 0,
"Scout-Suppliers on Project": null,
"Scout-Estimated Start Date": "2018-08-30",
"Scout-Estimated Start Date FY": 2018,
"Scout-Estimated Start Date FQ": 3,
"Scout-Estimated End Date": "2018-08-31",
"Scout-Estimated End Date FY": 2018,
"Scout-Estimated End Date FQ": 3,
"Scout-Actual Start Date": "2018-08-30",
"Scout-Actual Start Date FY": 2018,
"Scout-Actual Start Date FQ": 3,
"Scout-Actual End Date": "2018-08-31",
"Scout-Actual End Date FY": 2018,
"Scout-Actual End Date FQ": 3,
"Scout-Request Submitted": "2018-08-01",
"Scout-Request Opened": "2018-08-01",
"Scout-Estimated Spend": null,
"Scout-Estimated Savings": null,
"Scout-Final Spend": null,
"Scout-Savings Type": null,
"Scout-Recognized Savings": null,
"Scout-Projected Recognized Savings": null,
"Scout-Unrecognized Savings": null,
"Scout-Projected Unrecognized Savings": null,
"Scout-Total Savings": null,
"Scout-# of Stakeholders": 1,
"Scout-Stakeholders List": "Gabriel Keebler",
"Scout-Event Names": null,
"Scout-Event Status": null,
"Scout-# of Suppliers Invited to Event(s)": 0,
"Scout-Suppliers Invited to Event(s)": null,
"Scout-External ID": null,
"Scout-Canceled Reason": null,
"Scout-Original Approval Request Date": null,
"Scout-Original Approval Request Date FY": null,
"Scout-Original Approval Request Date FQ": null,
"Scout-Approved Date": null,
"Scout-Approved FY": null,
"Scout-Approved FQ": null,
"Scout-Sent for Approval": null,
"Scout-Sent for Approval FY": null,
"Scout-Sent for Approval FQ": null,
"Scout-Needs Attention Reason": null,
"Scout-Last Updated Date": "2018-08-31",
"Scout-Has Attachments": false,
"Scout-Related Project ID #": "2000",
"Scout-First Milestone Assign Date": null,
"Scout-Milestone Name": null,
"Scout-Milestone Date": null,
"Scout-Milestone Status": null,
"Scout-Milestone Complete Date": null,
"Scout-Template Milestone": null,
"Scout-Milestone Created By": null,
"Scout-Milestone Create Date": null,
"Scout-Milestone Assignee": null,
"Scout-Mark Completed By": null,
"Scout-# of Days Milestone is Open": null,
"Scout-Days Requested": "0.0",
"Scout-Days Planned": "0.0",
"Scout-Days Active - Discovery": "0.0",
"Scout-Days Active - Planning Performance Review": "0.0",
"Scout-Days Active - Sourcing": "0.0",
"Scout-Days Active - Published Stakeholder & Supplier Review": "0.0",
"Scout-Days Active - Negotiation": "0.0",
"Scout-Days Active - Evaluating Responses": "0.0",
"Scout-Days Active - Contract": "0.0",
"Scout-Days Active - Supplier Meeting": "0.0",
"Scout-Days Active - Develop Action Item Plan": "0.0",
"Scout-Days Out For Approval": "0.0",
"Scout-Days Approved": "0.0",
"Scout-Days On hold": "0.0",
"Custom field for project!": "Custom string field value",
"Custom date field": "2018-01-01"
}
},
{"id": "3",
"type": "project_report_entries",
"attributes": {"Scout-System ID": 300,
"Scout-ID #": 3,
"Scout-Project Title": "Project 3",
"Scout-Project Type": "General Project",
"Scout-Project Type Short Code": "GENR",
"Scout-Project Needs Attention": false,
"Scout-Project State & Status": "Planned",
"Scout-Sourcing Owner": "Gabriel Keebler",
"Scout-Project Requester": "Gabriel Keebler",
"Scout-Category": null,
"Scout-Project Description": null,
"Scout-# of Suppliers on Project": 0,
"Scout-Suppliers on Project": null,
"Scout-Estimated Start Date": "2018-08-30",
"Scout-Estimated Start Date FY": 2018,
"Scout-Estimated Start Date FQ": 3,
"Scout-Estimated End Date": "2018-08-31",
"Scout-Estimated End Date FY": 2018,
"Scout-Estimated End Date FQ": 3,
"Scout-Actual Start Date": "2018-08-30",
"Scout-Actual Start Date FY": 2018,
"Scout-Actual Start Date FQ": 3,
"Scout-Actual End Date": "2018-08-31",
"Scout-Actual End Date FY": 2018,
"Scout-Actual End Date FQ": 3,
"Scout-Request Submitted": "2018-08-01",
"Scout-Request Opened": "2018-08-01",
"Scout-Estimated Spend": null,
"Scout-Estimated Savings": null,
"Scout-Final Spend": null,
"Scout-Savings Type": null,
"Scout-Recognized Savings": null,
"Scout-Projected Recognized Savings": null,
"Scout-Unrecognized Savings": null,
"Scout-Projected Unrecognized Savings": null,
"Scout-Total Savings": null,
"Scout-# of Stakeholders": 1,
"Scout-Stakeholders List": "Gabriel Keebler",
"Scout-Event Names": null,
"Scout-Event Status": null,
"Scout-# of Suppliers Invited to Event(s)": 0,
"Scout-Suppliers Invited to Event(s)": null,
"Scout-External ID": null,
"Scout-Canceled Reason": null,
"Scout-Original Approval Request Date": null,
"Scout-Original Approval Request Date FY": null,
"Scout-Original Approval Request Date FQ": null,
"Scout-Approved Date": null,
"Scout-Approved FY": null,
"Scout-Approved FQ": null,
"Scout-Sent for Approval": null,
"Scout-Sent for Approval FY": null,
"Scout-Sent for Approval FQ": null,
"Scout-Needs Attention Reason": null,
"Scout-Last Updated Date": "2018-08-31",
"Scout-Has Attachments": false,
"Scout-Related Project ID #": "3000",
"Scout-First Milestone Assign Date": null,
"Scout-Milestone Name": null,
"Scout-Milestone Date": null,
"Scout-Milestone Status": null,
"Scout-Milestone Complete Date": null,
"Scout-Template Milestone": null,
"Scout-Milestone Created By": null,
"Scout-Milestone Create Date": null,
"Scout-Milestone Assignee": null,
"Scout-Mark Completed By": null,
"Scout-# of Days Milestone is Open": null,
"Scout-Days Requested": "0.0",
"Scout-Days Planned": "0.0",
"Scout-Days Active - Discovery": "0.0",
"Scout-Days Active - Planning Performance Review": "0.0",
"Scout-Days Active - Sourcing": "0.0",
"Scout-Days Active - Published Stakeholder & Supplier Review": "0.0",
"Scout-Days Active - Negotiation": "0.0",
"Scout-Days Active - Evaluating Responses": "0.0",
"Scout-Days Active - Contract": "0.0",
"Scout-Days Active - Supplier Meeting": "0.0",
"Scout-Days Active - Develop Action Item Plan": "0.0",
"Scout-Days Out For Approval": "0.0",
"Scout-Days Approved": "0.0",
"Scout-Days On hold": "0.0",
"Custom field for project!": null,
"Custom date field": null
}
}
],
"links": {"prev": null,
"next": null
}
}

Project Report Schema

Returns the project report schema.

Authorizations:

(api_keyuser_tokenuser_email)

Responses

Request samples

Curl

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" \
     -H "Accept: application/vnd.api+json,application/vnd.api+json; com.workdayspend.api.version=2019-01-01"
     "https://api.us.workdayspend.com/project_reports/schema"

Response samples

Content type

application/vnd.api+json

{"data": {"id": "project_schemas",
"type": "project_schemas",
"attributes": {"fields": [{"type": "text",
"name": "Scout-System ID"
},
{"type": "text",
"name": "Scout-ID #"
},
{"type": "text",
"name": "Scout-Project Title"
},
{"type": "select",
"name": "Scout-Project Type"
},
{"type": "select",
"name": "Scout-Project Type Short Code"
},
{"type": "text",
"name": "Scout-Project Needs Attention"
},
{"type": "select",
"name": "Scout-Project State & Status"
},
{"type": "select",
"name": "Scout-Sourcing Owner"
},
{"type": "select",
"name": "Scout-Project Requester"
},
{"type": "select",
"name": "Scout-Category"
},
{"type": "text",
"name": "Scout-Project Description"
},
{"type": "integer",
"name": "Scout-# of Suppliers on Project"
},
{"type": "select",
"name": "Scout-Suppliers on Project"
},
{"type": "date",
"name": "Scout-Estimated Start Date"
},
{"type": "integer",
"name": "Scout-Estimated Start Date FY"
},
{"type": "integer",
"name": "Scout-Estimated Start Date FQ"
},
{"type": "date",
"name": "Scout-Estimated End Date"
},
{"type": "integer",
"name": "Scout-Estimated End Date FY"
},
{"type": "integer",
"name": "Scout-Estimated End Date FQ"
},
{"type": "date",
"name": "Scout-Actual Start Date"
},
{"type": "integer",
"name": "Scout-Actual Start Date FY"
},
{"type": "integer",
"name": "Scout-Actual Start Date FQ"
},
{"type": "date",
"name": "Scout-Actual End Date"
},
{"type": "integer",
"name": "Scout-Actual End Date FY"
},
{"type": "integer",
"name": "Scout-Actual End Date FQ"
},
{"type": "date",
"name": "Scout-Request Submitted"
},
{"type": "date",
"name": "Scout-Request Opened"
},
{"type": "currency",
"name": "Scout-Estimated Spend"
},
{"type": "currency",
"name": "Scout-Estimated Savings"
},
{"type": "currency",
"name": "Scout-Final Spend"
},
{"type": "select",
"name": "Scout-Savings Type"
},
{"type": "currency",
"name": "Scout-Recognized Savings"
},
{"type": "currency",
"name": "Scout-Projected Recognized Savings"
},
{"type": "currency",
"name": "Scout-Unrecognized Savings"
},
{"type": "currency",
"name": "Scout-Projected Unrecognized Savings"
},
{"type": "currency",
"name": "Scout-Total Savings"
},
{"type": "integer",
"name": "Scout-# of Stakeholders"
},
{"type": "select",
"name": "Scout-Stakeholders List"
},
{"type": "text",
"name": "Scout-Event Names"
},
{"type": "select",
"name": "Scout-Event Status"
},
{"type": "integer",
"name": "Scout-# of Suppliers Invited to Event(s)"
},
{"type": "select",
"name": "Scout-Suppliers Invited to Event(s)"
},
{"type": "text",
"name": "Scout-External ID"
},
{"type": "text",
"name": "Scout-Canceled Reason"
},
{"type": "date",
"name": "Scout-Original Approval Request Date"
},
{"type": "integer",
"name": "Scout-Original Approval Request Date FY"
},
{"type": "integer",
"name": "Scout-Original Approval Request Date FQ"
},
{"type": "date",
"name": "Scout-Approved Date"
},
{"type": "integer",
"name": "Scout-Approved FY"
},
{"type": "integer",
"name": "Scout-Approved FQ"
},
{"type": "date",
"name": "Scout-Sent for Approval"
},
{"type": "integer",
"name": "Scout-Sent for Approval FY"
},
{"type": "integer",
"name": "Scout-Sent for Approval FQ"
},
{"type": "select",
"name": "Scout-Needs Attention Reason"
},
{"type": "date",
"name": "Scout-Last Updated Date"
},
{"type": "text",
"name": "Scout-Has Attachments"
},
{"type": "text",
"name": "Scout-Related Project ID #"
},
{"type": "date",
"name": "Scout-First Milestone Assign Date"
},
{"type": "integer",
"name": "Scout-Days Requested"
},
{"type": "integer",
"name": "Scout-Days Planned"
},
{"type": "integer",
"name": "Scout-Days Active"
},
{"type": "integer",
"name": "Scout-Days On hold"
},
{"type": "text",
"name": "Scout-Milestone Name"
},
{"type": "date",
"name": "Scout-Milestone Date"
},
{"type": "select",
"name": "Scout-Milestone Status"
},
{"type": "date",
"name": "Scout-Milestone Complete Date"
},
{"type": "select",
"name": "Scout-Template Milestone"
},
{"type": "select",
"name": "Scout-Milestone Created By"
},
{"type": "date",
"name": "Scout-Milestone Create Date"
},
{"type": "select",
"name": "Scout-Milestone Assignee"
},
{"type": "select",
"name": "Scout-Mark Completed By"
},
{"type": "integer",
"name": "Scout-# of Days Milestone is Open"
},
{"type": "string",
"name": "Field #21"
}
]
}
}
}

Savings Reports

This report returns a list of Savings report entries.

Savings Report Entries

Returns a list of savings entries.

Authorizations:

(api_keyuser_tokenuser_email)

Responses

Request samples

Curl

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" \
     -H "Accept: application/vnd.api+json,application/vnd.api+json; com.workdayspend.api.version=2019-01-01"
     "https://api.us.workdayspend.com/savings_reports/entries"

Response samples

Content type

application/vnd.api+json

{"data": [{"id": "1-2018-04-01",
"type": "savings_report_entries",
"attributes": {"Scout-ID": 1,
"Scout-Savings Type": "Savings Type #0",
"Scout-Realized Date": "2018-04-01",
"Scout-Realized Date FY": 2018,
"Scout-Realized Date FQ": 2,
"Scout-Savings Start Date": "2018-04-20",
"Scout-Savings Start Date FY": 2018,
"Scout-Savings Start Date FQ": 2,
"Scout-Savings End Date": "2018-04-25",
"Scout-Savings End Date FY": 2018,
"Scout-Savings End Date FQ": 2,
"Scout-Frequency": "Calculated",
"Scout-Realized Savings": "100.0",
"Scout-Projected Savings": "0.0",
"Scout-Monthly Total": "100.0",
"Scout-Total": "100.0",
"Scout-Savings Notes": "Some notes",
"Scout-Last Updated Date": "2018-04-25",
"Scout-ID #": 1,
"Scout-Project Title": "Project 1",
"Scout-Project Type": "Project Type #183",
"Scout-Project Type Short Code": "1833",
"Scout-Project State & Status": "Planned",
"Scout-Sourcing Owner": "Cammy Ankunding",
"Scout-Category": null,
"Scout-Suppliers on Project": null,
"Scout-Actual Start Date": "2018-04-20",
"Scout-Actual End Date": "2018-04-25",
"Scout-Estimated Savings": "20000.0",
"Scout-ID-Unique": "1-2018-04-01",
"Custom field for project!": null,
"Custom date field": null
}
},
{"id": "2-2018-04-01",
"type": "savings_report_entries",
"attributes": {"Scout-ID": 2,
"Scout-Savings Type": "Savings Type #0",
"Scout-Realized Date": "2018-04-01",
"Scout-Realized Date FY": 2018,
"Scout-Realized Date FQ": 2,
"Scout-Savings Start Date": "2018-04-19",
"Scout-Savings Start Date FY": 2018,
"Scout-Savings Start Date FQ": 2,
"Scout-Savings End Date": "2018-05-24",
"Scout-Savings End Date FY": 2018,
"Scout-Savings End Date FQ": 2,
"Scout-Frequency": "Calculated",
"Scout-Realized Savings": "33.3333333333333333",
"Scout-Projected Savings": "0.0",
"Scout-Monthly Total": "33.3333333333333333",
"Scout-Total": "100.0",
"Scout-Savings Notes": "Some notes",
"Scout-Last Updated Date": "2018-04-25",
"Scout-ID #": 2,
"Scout-Project Title": "Project 2",
"Scout-Project Type": "Project Type #185",
"Scout-Project Type Short Code": "1859",
"Scout-Project State & Status": "Planned",
"Scout-Sourcing Owner": "Cammy Ankunding",
"Scout-Category": null,
"Scout-Suppliers on Project": null,
"Scout-Actual Start Date": "2018-04-20",
"Scout-Actual End Date": "2018-04-25",
"Scout-Estimated Savings": "20000.0",
"Scout-ID-Unique": "2-2018-04-01",
"Custom field for project!": "Custom string field value",
"Custom date field": "2018-01-01"
}
},
{"id": "2-2018-05-01",
"type": "savings_report_entries",
"attributes": {"Scout-ID": 2,
"Scout-Savings Type": "Savings Type #0",
"Scout-Realized Date": "2018-05-01",
"Scout-Realized Date FY": 2018,
"Scout-Realized Date FQ": 2,
"Scout-Savings Start Date": "2018-04-19",
"Scout-Savings Start Date FY": 2018,
"Scout-Savings Start Date FQ": 2,
"Scout-Savings End Date": "2018-05-24",
"Scout-Savings End Date FY": 2018,
"Scout-Savings End Date FQ": 2,
"Scout-Frequency": "Calculated",
"Scout-Realized Savings": "66.6666666666666667",
"Scout-Projected Savings": "0.0",
"Scout-Monthly Total": "66.6666666666666667",
"Scout-Total": "100.0",
"Scout-Savings Notes": "Some notes",
"Scout-Last Updated Date": "2018-04-25",
"Scout-ID #": 2,
"Scout-Project Title": "Project 2",
"Scout-Project Type": "Project Type #185",
"Scout-Project Type Short Code": "1859",
"Scout-Project State & Status": "Planned",
"Scout-Sourcing Owner": "Cammy Ankunding",
"Scout-Category": null,
"Scout-Suppliers on Project": null,
"Scout-Actual Start Date": "2018-04-20",
"Scout-Actual End Date": "2018-04-25",
"Scout-Estimated Savings": "20000.0",
"Scout-ID-Unique": "2-2018-05-01",
"Custom field for project!": "Custom string field value",
"Custom date field": "2018-01-01"
}
}
],
"links": {"prev": null,
"next": null
}
}

Savings Report Schema

Returns the savings report schema.

Authorizations:

(api_keyuser_tokenuser_email)

Responses

Request samples

Curl

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" \
     -H "Accept: application/vnd.api+json,application/vnd.api+json; com.workdayspend.api.version=2019-01-01"
     "https://api.us.workdayspend.com/savings_reports/schema"

Response samples

Content type

application/vnd.api+json

{"data": {"id": "savings_schemas",
"type": "savings_schemas",
"attributes": {"fields": [{"type": "text",
"name": "Scout-ID"
},
{"type": "select",
"name": "Scout-Savings Type"
},
{"type": "date",
"name": "Scout-Realized Date"
},
{"type": "integer",
"name": "Scout-Realized Date FY"
},
{"type": "integer",
"name": "Scout-Realized Date FQ"
},
{"type": "date",
"name": "Scout-Savings Start Date"
},
{"type": "integer",
"name": "Scout-Savings Start Date FY"
},
{"type": "integer",
"name": "Scout-Savings Start Date FQ"
},
{"type": "date",
"name": "Scout-Savings End Date"
},
{"type": "integer",
"name": "Scout-Savings End Date FY"
},
{"type": "integer",
"name": "Scout-Savings End Date FQ"
},
{"type": "select",
"name": "Scout-Frequency"
},
{"type": "currency",
"name": "Scout-Realized Savings"
},
{"type": "currency",
"name": "Scout-Projected Savings"
},
{"type": "currency",
"name": "Scout-Monthly Total"
},
{"type": "currency",
"name": "Scout-Total"
},
{"type": "text",
"name": "Scout-Savings Notes"
},
{"type": "date",
"name": "Scout-Last Updated Date"
},
{"type": "text",
"name": "Scout-ID #"
},
{"type": "text",
"name": "Scout-Project Title"
},
{"type": "select",
"name": "Scout-Project Type"
},
{"type": "select",
"name": "Scout-Project Type Short Code"
},
{"type": "select",
"name": "Scout-Project State & Status"
},
{"type": "select",
"name": "Scout-Sourcing Owner"
},
{"type": "select",
"name": "Scout-Category"
},
{"type": "select",
"name": "Scout-Suppliers on Project"
},
{"type": "date",
"name": "Scout-Actual Start Date"
},
{"type": "date",
"name": "Scout-Actual End Date"
},
{"type": "currency",
"name": "Scout-Estimated Savings"
},
{"type": "string",
"name": "Field #23"
}
]
}
}
}

Supplier Reports

This report returns a list of Supplier report entries.

Supplier Report Entries

Returns a list of supplier entries.

Authorizations:

(api_keyuser_tokenuser_email)

Responses

Request samples

Curl

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" \
     -H "Accept: application/vnd.api+json,application/vnd.api+json; com.workdayspend.api.version=2019-01-01"
     "https://api.us.workdayspend.com/supplier_reports/entries"

Response samples

Content type

application/vnd.api+json

{"data": {"id": "supplier_schemas",
"type": "supplier_schemas",
"attributes": {"fields": [{"type": "text",
"name": "Scout-Supplier ID"
},
{"type": "text",
"name": "Scout-Supplier Name"
},
{"type": "text",
"name": "Scout-Website"
},
{"type": "text",
"name": "Scout-Supplier Description"
},
{"type": "select",
"name": "Scout-Tags"
},
{"type": "text",
"name": "Scout-External ID"
},
{"type": "select",
"name": "Scout-Workday Supplier Status"
},
{"type": "select",
"name": "Scout-Supplier Status"
},
{"type": "select",
"name": "Scout-Segmentation"
},
{"type": "select",
"name": "Scout-Supplier Risk"
},
{"type": "text",
"name": "Scout-Segmentation Notes"
},
{"type": "select",
"name": "Scout-Supplier Category"
},
{"type": "select",
"name": "Scout-Supplier Groups"
},
{"type": "date",
"name": "Scout-Created Date"
},
{"type": "date",
"name": "Scout-Last Updated Date"
},
{"type": "integer",
"name": "Scout-# of Events"
},
{"type": "select",
"name": "Scout-Events List"
},
{"type": "select",
"name": "Scout-Event Type List"
},
{"type": "integer",
"name": "Scout-# of Sourcing Owners (Events)"
},
{"type": "select",
"name": "Scout-Sourcing Owner List (Events)"
},
{"type": "integer",
"name": "Scout-# of Contacts"
},
{"type": "text",
"name": "Scout-Contact(s)"
},
{"type": "text",
"name": "Scout-Contact Email"
},
{"type": "text",
"name": "Scout-Contact Title"
},
{"type": "text",
"name": "Scout-Contact Phone"
},
{"type": "select",
"name": "Scout-Contact International Calling Code"
},
{"type": "select",
"name": "Scout-Contact Types"
},
{"type": "text",
"name": "Scout-Contact Notes"
},
{"type": "text",
"name": "Scout-Last Login"
},
{"type": "integer",
"name": "Scout-# of RSVP Yes"
},
{"type": "integer",
"name": "Scout-# of RSVP No"
},
{"type": "integer",
"name": "Scout-# of Bids Submitted"
},
{"type": "integer",
"name": "Scout-# of Awarded Bids"
},
{"type": "text",
"name": "Scout-Awarded Event List"
},
{"type": "select",
"name": "Scout-Sanction List Screening Status"
},
{"type": "date",
"name": "Scout-Sanction List Screening Date"
},
{"type": "select",
"name": "Scout-Parent"
},
{"type": "select",
"name": "Scout-Children"
},
{"type": "select",
"name": "Scout-Default Payment Type"
},
{"type": "select",
"name": "Scout-Default Payment Term"
},
{"type": "select",
"name": "Scout-Payment Types"
},
{"type": "select",
"name": "Scout-Accepted Currencies"
},
{"type": "select",
"name": "Scout-Accept All Currencies"
},
{"type": "select",
"name": "Scout-Address Country"
},
{"type": "select",
"name": "Scout-Address State / Province"
},
{"type": "select",
"name": "Scout-Address Usage"
},
{"type": "text",
"name": "Scout-Address Postal Code"
},
{"type": "select",
"name": "Scout-Bank Account Type"
},
{"type": "select",
"name": "Scout-Bank Account Country"
},
{"type": "text",
"name": "Scout-Bank Account Nickname"
},
{"type": "select",
"name": "Scout-Bank Account Payment Types"
},
{"type": "select",
"name": "Scout-Phone Device Type"
},
{"type": "select",
"name": "Scout-International Calling Code"
},
{"type": "text",
"name": "Scout-Phone Number"
},
{"type": "select",
"name": "Scout-Tax Country"
},
{"type": "select",
"name": "Scout-Tax ID Type"
},
{"type": "string",
"name": "Field #27"
}
]
}
}
}

Supplier Report Schema

Returns the supplier report schema.

Authorizations:

(api_keyuser_tokenuser_email)

Responses

Request samples

Curl

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" \
     -H "Accept: application/vnd.api+json,application/vnd.api+json; com.workdayspend.api.version=2019-01-01"
     "https://api.us.workdayspend.com/supplier_reports/schema"

Response samples

Content type

application/vnd.api+json

{"data": {"id": "supplier_schemas",
"type": "supplier_schemas",
"attributes": {"fields": [{"type": "text",
"name": "Scout-Supplier ID"
},
{"type": "text",
"name": "Scout-Supplier Name"
},
{"type": "text",
"name": "Scout-Website"
},
{"type": "text",
"name": "Scout-Supplier Description"
},
{"type": "select",
"name": "Scout-Tags"
},
{"type": "text",
"name": "Scout-External ID"
},
{"type": "select",
"name": "Scout-Workday Supplier Status"
},
{"type": "select",
"name": "Scout-Supplier Status"
},
{"type": "select",
"name": "Scout-Segmentation"
},
{"type": "select",
"name": "Scout-Supplier Risk"
},
{"type": "text",
"name": "Scout-Segmentation Notes"
},
{"type": "select",
"name": "Scout-Supplier Category"
},
{"type": "select",
"name": "Scout-Supplier Groups"
},
{"type": "date",
"name": "Scout-Created Date"
},
{"type": "date",
"name": "Scout-Last Updated Date"
},
{"type": "integer",
"name": "Scout-# of Events"
},
{"type": "select",
"name": "Scout-Events List"
},
{"type": "select",
"name": "Scout-Event Type List"
},
{"type": "integer",
"name": "Scout-# of Sourcing Owners (Events)"
},
{"type": "select",
"name": "Scout-Sourcing Owner List (Events)"
},
{"type": "integer",
"name": "Scout-# of Contacts"
},
{"type": "text",
"name": "Scout-Contact(s)"
},
{"type": "text",
"name": "Scout-Contact Email"
},
{"type": "text",
"name": "Scout-Contact Title"
},
{"type": "text",
"name": "Scout-Contact Phone"
},
{"type": "select",
"name": "Scout-Contact International Calling Code"
},
{"type": "select",
"name": "Scout-Contact Types"
},
{"type": "text",
"name": "Scout-Contact Notes"
},
{"type": "text",
"name": "Scout-Last Login"
},
{"type": "integer",
"name": "Scout-# of RSVP Yes"
},
{"type": "integer",
"name": "Scout-# of RSVP No"
},
{"type": "integer",
"name": "Scout-# of Bids Submitted"
},
{"type": "integer",
"name": "Scout-# of Awarded Bids"
},
{"type": "text",
"name": "Scout-Awarded Event List"
},
{"type": "select",
"name": "Scout-Sanction List Screening Status"
},
{"type": "date",
"name": "Scout-Sanction List Screening Date"
},
{"type": "select",
"name": "Scout-Parent"
},
{"type": "select",
"name": "Scout-Children"
},
{"type": "select",
"name": "Scout-Default Payment Type"
},
{"type": "select",
"name": "Scout-Default Payment Term"
},
{"type": "select",
"name": "Scout-Payment Types"
},
{"type": "select",
"name": "Scout-Accepted Currencies"
},
{"type": "select",
"name": "Scout-Accept All Currencies"
},
{"type": "select",
"name": "Scout-Address Country"
},
{"type": "select",
"name": "Scout-Address State / Province"
},
{"type": "select",
"name": "Scout-Address Usage"
},
{"type": "text",
"name": "Scout-Address Postal Code"
},
{"type": "select",
"name": "Scout-Bank Account Type"
},
{"type": "select",
"name": "Scout-Bank Account Country"
},
{"type": "text",
"name": "Scout-Bank Account Nickname"
},
{"type": "select",
"name": "Scout-Bank Account Payment Types"
},
{"type": "select",
"name": "Scout-Phone Device Type"
},
{"type": "select",
"name": "Scout-International Calling Code"
},
{"type": "text",
"name": "Scout-Phone Number"
},
{"type": "select",
"name": "Scout-Tax Country"
},
{"type": "select",
"name": "Scout-Tax ID Type"
},
{"type": "string",
"name": "Field #27"
}
]
}
}
}

Supplier Review Reports

This report returns a list of Supplier Review report entries.

Supplier Review Report Entries

Returns a list of supplier review entries.

Authorizations:

(api_keyuser_tokenuser_email)

Responses

Request samples

Curl

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" \
     -H "Accept: application/vnd.api+json,application/vnd.api+json; com.workdayspend.api.version=2019-01-01"
     "https://api.us.workdayspend.com/supplier_review_reports/entries"

Response samples

Content type

application/vnd.api+json

{"data": [{"id": "1",
"type": "supplier_review_report_entries",
"attributes": {"Scout-Supplier ID": 1,
"Scout-Supplier Name": "Beula Hirthe's General Store",
"Scout-Category": null,
"Scout-Sourcing Owner": null,
"Scout-Review Form Title": "Performance review event",
"Scout-Review Status": null,
"Scout-Decision": null,
"Scout-Risk Score": null,
"Scout-Reviewers": null,
"Scout-Reviewed On Date": null,
"Scout-Avg. # of Days per Reviewer": null,
"Scout-# Of Days To Review": null,
"Scout-Valid Until Date": null,
"Scout-Remind Before Date": null,
"Scout-Remind": null,
"Scout-Published Date": null,
"Scout-Response Submitted Date": null,
"Scout-# of Days for Supplier to Respond": null,
"Scout-Supplier Response Status": null,
"Scout-Supplier Contact Email": null,
"Scout-Executive Summary": "Executive summary 1",
"Custom string field name": null
}
},
{"id": "2",
"type": "supplier_review_report_entries",
"attributes": {"Scout-Supplier ID": 2,
"Scout-Supplier Name": "Dong Ortiz's General Store",
"Scout-Category": null,
"Scout-Sourcing Owner": null,
"Scout-Review Form Title": "Performance review event",
"Scout-Review Status": null,
"Scout-Decision": null,
"Scout-Risk Score": null,
"Scout-Reviewers": null,
"Scout-Reviewed On Date": null,
"Scout-Avg. # of Days per Reviewer": null,
"Scout-# Of Days To Review": null,
"Scout-Valid Until Date": null,
"Scout-Remind Before Date": null,
"Scout-Remind": null,
"Scout-Published Date": null,
"Scout-Response Submitted Date": null,
"Scout-# of Days for Supplier to Respond": null,
"Scout-Supplier Response Status": null,
"Scout-Supplier Contact Email": null,
"Scout-Executive Summary": "Executive summary 2",
"Custom string field name": "Custom string field value"
}
},
{"id": "3",
"type": "supplier_review_report_entries",
"attributes": {"Scout-Supplier ID": 3,
"Scout-Supplier Name": "Nicki Cremin's General Store",
"Scout-Category": null,
"Scout-Sourcing Owner": null,
"Scout-Review Form Title": "Performance review event",
"Scout-Review Status": null,
"Scout-Decision": null,
"Scout-Risk Score": null,
"Scout-Reviewers": null,
"Scout-Reviewed On Date": null,
"Scout-Avg. # of Days per Reviewer": null,
"Scout-# Of Days To Review": null,
"Scout-Valid Until Date": null,
"Scout-Remind Before Date": null,
"Scout-Remind": null,
"Scout-Published Date": null,
"Scout-Response Submitted Date": null,
"Scout-# of Days for Supplier to Respond": null,
"Scout-Supplier Response Status": null,
"Scout-Supplier Contact Email": null,
"Scout-Executive Summary": "Executive summary 3",
"Custom string field name": null
}
}
],
"links": {"prev": null,
"next": null
}
}

Supplier Review Report Schema

Returns the supplier review report schema.

Authorizations:

(api_keyuser_tokenuser_email)

Responses

Request samples

Curl

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" \
     -H "Accept: application/vnd.api+json,application/vnd.api+json; com.workdayspend.api.version=2019-01-01"
     "https://api.us.workdayspend.com/supplier_review_reports/schema"

Response samples

Content type

application/vnd.api+json

{"data": {"id": "supplier_review_schemas",
"type": "supplier_review_schemas",
"attributes": {"fields": [{"type": "text",
"name": "Scout-Supplier ID"
},
{"type": "text",
"name": "Scout-Supplier Name"
},
{"type": "select",
"name": "Scout-Category"
},
{"type": "select",
"name": "Scout-Sourcing Owner"
},
{"type": "select",
"name": "Scout-Review Form Title"
},
{"type": "select",
"name": "Scout-Review Status"
},
{"type": "select",
"name": "Scout-Decision"
},
{"type": "select",
"name": "Scout-Risk Score"
},
{"type": "select",
"name": "Scout-Reviewers"
},
{"type": "date",
"name": "Scout-Reviewed On Date"
},
{"type": "integer",
"name": "Scout-Avg. # of Days per Reviewer"
},
{"type": "integer",
"name": "Scout-# Of Days To Review"
},
{"type": "date",
"name": "Scout-Valid Until Date"
},
{"type": "date",
"name": "Scout-Remind Before Date"
},
{"type": "select",
"name": "Scout-Remind"
},
{"type": "date",
"name": "Scout-Published Date"
},
{"type": "date",
"name": "Scout-Response Submitted Date"
},
{"type": "integer",
"name": "Scout-# of Days for Supplier to Respond"
},
{"type": "select",
"name": "Scout-Supplier Response Status"
},
{"type": "text",
"name": "Scout-Supplier Contact Email"
},
{"type": "text",
"name": "Scout-Executive Summary"
},
{"type": "string",
"name": "Field #25"
}
]
}
}
}

Suppliers

This report returns a list of Suppliers.

All suppliers

Returns a list of all suppliers.

Query Params

Param
`include`	Include supplier contacts with `include=contacts`
`sort`	Sort the suppliers. Supported values: `name`, `-name`, `created_at`, `-created_at`.

Authorizations:

(api_keyuser_tokenuser_email)

Responses

Request samples

Curl

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" \
     -H "Accept: application/vnd.api+json,application/vnd.api+json; com.workdayspend.api.version=2018-04-01"
     "https://api.us.workdayspend.com/suppliers"

Response samples

Content type

application/vnd.api+json

{"data": [{"id": "3",
"type": "suppliers",
"attributes": {"name": "Hubschrauber LLC"
},
"relationships": {"contacts": {"data": [{"id": "3",
"type": "supplier_contacts"
}
]
}
}
},
{"id": "1",
"type": "suppliers",
"attributes": {"name": "Schnappi Group"
},
"relationships": {"contacts": {"data": [ ]
}
}
},
{"id": "2",
"type": "suppliers",
"attributes": {"name": "Trippy Cow Inc"
},
"relationships": {"contacts": {"data": [{"id": "2",
"type": "supplier_contacts"
},
{"id": "1",
"type": "supplier_contacts"
}
]
}
}
}
],
"links": {"prev": null,
"next": null
}
}

Single supplier

Returns a single supplier.

You can optionally include the following query parameter to include supplier contacts in the response:

suppliers/1?include=contacts

Authorizations:

(api_keyuser_tokenuser_email)

path Parameters

supplier_id

required

integer

Example: 1

Unique Supplier identifier.

Responses

Request samples

Curl

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" \
     -H "Accept: application/vnd.api+json,application/vnd.api+json; com.workdayspend.api.version=2018-04-01"
     "https://api.us.workdayspend.com/suppliers/{supplier_id}"

Response samples

Content type

application/vnd.api+json

{"data": {"id": "177",
"type": "suppliers",
"attributes": {"name": "Hubschrauber LLC",
"custom_fields": [{"name": "Country of incorporation",
"value": "France"
},
{"name": "Supplier options",
"value": ["Option #1",
"Option #2"
]
},
{"name": "Foundation year",
"value": 2015
},
{"name": "Logo",
"value": [{"title": "The logo file",
"file_type": "img",
"url": "/downloads/1"
}
]
}
]
},
"relationships": {"contacts": {"data": [{"id": "59",
"type": "supplier_contacts"
}
]
}
}
}
}