Scout RFP (Workday Strategic Sourcing) supplier_companies API

openapi: 3.2.0
info:
  title: Workday Strategic Sourcing attachments Supplier Companies API
  version: '1.0'
  description: '<span id="section/Authentication/api_key" data-section-id="section/Authentication/api_key"></span>

    <span id="section/Authentication/user_token" data-section-id="section/Authentication/user_token"></span>

    <span id="section/Authentication/user_email" data-section-id="section/Authentication/user_email"></span>

    '
servers:
- url: https://api.us.workdayspend.com/services/attachments/v1
  description: Production Server
- url: https://api.sandbox.us.workdayspend.com/services/attachments/v1
  description: Sandbox Server
security:
- api_key: []
  user_token: []
  user_email: []
tags:
- name: supplier_companies
  x-displayName: Supplier Companies
  description: 'Use the supplier companies API to create, update, and query the suppliers in Workday Strategic Sourcing.


    ## Supplier Company Object


    <SchemaDefinition schemaRef="#/components/schemas/SupplierCompany" exampleRef="#/components/examples/SupplierCompany" showReadOnly={true} showWriteOnly={true} />




    ## Supplier Classification Value Object


    <SchemaDefinition schemaRef="#/components/schemas/SupplierClassificationValue" exampleRef="#/components/examples/SupplierClassificationValue" showReadOnly={true} showWriteOnly={true} />


    ## Supplier Classification Field Value Object


    <SchemaDefinition schemaRef="#/components/schemas/SupplierClassificationFieldValue" exampleRef="#/components/examples/SupplierClassificationFieldValue" showReadOnly={true} showWriteOnly={true} />

    '
paths:
  /supplier_companies:
    get:
      tags:
      - supplier_companies
      description: Returns a list of supplier companies for the specified criteria.
      operationId: List Supplier Companies
      summary: List Supplier Companies
      parameters:
      - name: filter
        in: query
        description: 'Filter supplier companies by multiple criteria. Only one filter per attribute is supported.

          For best performance, we recommend 5 or less filters.

          '
        schema:
          $ref: '#/components/schemas/SupplierCompanyInputFilter'
      - name: include
        in: query
        schema:
          $ref: '#/components/schemas/SupplierCompanyRelatedResources'
        description: 'To reduce the number of HTTP requests, related resources can be requested along with the

          requested primary resources. Such responses are called "compound documents". In a compound

          document, all included resources will be represented as an array of resource objects in a

          top-level `included` member.


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

          the list of available relationships.




          ```

          /supplier_companies?include=payment_types,default_payment_type

          ```


          In the response, relationships will be represented as normal linkage objects (containing

          `id` and `type`), and full related resource details will be presented in the `included`

          section as resource objects (with `attributes`, `links`, and potentially `relationships`).

          '
      - name: page
        in: query
        description: 'Customize pagination results with `size`.

          '
        schema:
          $ref: '#/components/schemas/PageInput'
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                allOf:
                - type: object
                  properties:
                    data:
                      type: array
                      items:
                        $ref: '#/components/schemas/SupplierCompany'
                    included:
                      $ref: '#/components/schemas/SupplierCompanyIncludedResources'
                - $ref: '#/components/schemas/Pagination'
              examples:
                default response:
                  $ref: '#/components/examples/index_response'
                compound document:
                  $ref: '#/components/examples/index_compound_response'
        '400':
          description: Bad Request
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
              examples:
                include_not_supported:
                  summary: '''include'' parameter is not supported'
                  description: 'Returns error due to unsupported [parameter `include`](https://jsonapi.org/format/#fetching-includes).

                    '
                  value:
                    errors:
                    - detail: '''include'' parameter does not support following values: ["comments"]'
                sort_not_supported:
                  summary: '''sort'' parameter is not supported'
                  description: 'Returns error due to unsupported [parameter `sort`](https://jsonapi.org/format/#fetching-sorting).

                    '
                  value:
                    errors:
                    - detail: '''sort'' parameter is not supported'
        '401':
          description: Unauthorized
      x-codeSamples:
      - label: Curl
        source: "curl -H \"X-Api-Key: ${COMPANY_KEY}\" \\\n     -H \"X-User-Token: ${USER_TOKEN}\" \\\n     -H \"X-User-Email: ${USER_EMAIL}\" \\\n     -H \"Content-Type: application/vnd.api+json\" \\\n     \"https://api.us.workdayspend.com/services/suppliers/v1/supplier_companies\"\n"
    post:
      tags:
      - supplier_companies
      description: "Create a supplier company with given attributes, relationships, and related complex resources.\n\nWhen creating a supplier company with relationships, keep in mind that there are two kinds of\nrelationships: linked resources and composite resources.\n\n## Linked Resources\n\nThese are normal relationship resources managed outside of primary resource (supplier company).\nFor example, payment currencies exist on their own, and can be assigned to one or many supplier\ncompanies, contracts, etc. These resources usually have their own API management endpoints.\n\nAll related objects should exist prior to being linked to the supplier company. They can be\nreferenced by Workday Strategic Sourcing identifier, or by external ID; in the latter case, the relationship\nname is used with prefix `external_`. For example, a payment currency with Workday Strategic Sourcing ID `\"1\"` and\nexternal ID `\"C$EUR\"` can be used to initialize `default_payment_currency`:\n\n```json\n{\n  \"default_payment_currency\": {\n    \"data\" {\n      \"id\": \"1\",\n      \"type\": \"payment_currencies\"\n    }\n  }\n}\n```\n\n```json\n{\n  \"external_default_payment_currency\": {\n    \"data\" {\n      \"id\": \"C$EUR\",\n      \"type\": \"payment_currencies\"\n    }\n  }\n}\n```\n\nWhen `external_` prefix is applied to a \"many\" relationship, like `external_payment_currencies`,\nall of the identifiers will be treated as external IDs.\n\n\n"
      operationId: Create a Supplier Company
      summary: Create a Supplier Company
      parameters:
      - name: include
        in: query
        schema:
          $ref: '#/components/schemas/SupplierCompanyRelatedResources'
        description: 'Use the `include` parameter to request related resources along with the primary resource.

          (see "List Supplier Companies" for more details).

          '
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  $ref: '#/components/schemas/SupplierCompanyCreate'
            examples:
              simple request:
                $ref: '#/components/examples/create_request'
      responses:
        '201':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/SupplierCompany'
              examples:
                default response:
                  $ref: '#/components/examples/create_response'
                compound response:
                  $ref: '#/components/examples/create_compound_response'
        '401':
          description: Unauthorized
      x-codeSamples:
      - label: Curl
        source: "curl -H \"X-Api-Key: ${COMPANY_KEY}\" \\\n     -H \"X-User-Token: ${USER_TOKEN}\" \\\n     -H \"X-User-Email: ${USER_EMAIL}\" \\\n     -H \"Content-Type: application/vnd.api+json\" \\\n     -X POST \\\n     -d '{\"data\":{\"type\":\"supplier_companies\",\"attributes\":{\"name\":\"My Supplier\"}}}' \\\n     \"https://api.us.workdayspend.com/services/suppliers/v1/supplier_companies\"\n"
  /supplier_companies/{id}:
    get:
      tags:
      - supplier_companies
      description: 'Retrieves the details of an existing supplier company. You need to supply the unique supplier

        company identifier that was returned upon supplier company creation.

        '
      operationId: Get a Supplier Company
      summary: Get a Supplier Company
      parameters:
      - name: id
        in: path
        description: Unique Supplier Company identifier.
        required: true
        schema:
          type: integer
        example: 1
      - name: include
        in: query
        schema:
          $ref: '#/components/schemas/SupplierCompanyRelatedResources'
        description: 'Use the `include` parameter to request related resources along with the primary resource.

          (see "List Supplier Companies" for more details).

          '
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/SupplierCompany'
              examples:
                success:
                  $ref: '#/components/examples/show_response'
        '401':
          description: Unauthorized
        '404':
          description: Not Found
      x-codeSamples:
      - label: Curl
        source: "curl -H \"X-Api-Key: ${COMPANY_KEY}\" \\\n     -H \"X-User-Token: ${USER_TOKEN}\" \\\n     -H \"X-User-Email: ${USER_EMAIL}\" \\\n     -H \"Content-Type: application/vnd.api+json\" \\\n     \"https://api.us.workdayspend.com/services/suppliers/v1/supplier_companies/1\"\n"
    patch:
      tags:
      - supplier_companies
      description: 'Updates the details of an existing supplier company. You need to supply the unique supplier

        company identifier that was returned upon supplier company creation.


        Please note, that request body must include an `id` attribute with the value of your supplier

        unique identifier (the same one you passed in the URL).


        ## Linked Resources


        When updating relationships on a supplier company resource, keep in mind the whole relationship

        will be replaced the new values. For example, if a supplier company has currencies with IDs

        `"1"` and `"2"`, and in update request payload `payment_currencies` relationship is specified

        with ID `"3"`, the only payment currency associated after the request succeeded will be `"3"`.



        '
      operationId: Update a Supplier Company
      summary: Update a Supplier Company
      parameters:
      - name: id
        in: path
        description: Unique Supplier Company identifier.
        required: true
        schema:
          type: integer
        example: 1
      - name: include
        in: query
        schema:
          $ref: '#/components/schemas/SupplierCompanyRelatedResources'
        description: 'Use the `include` parameter to request related resources along with the primary resource.

          (see "List Supplier Companies" for more details).

          '
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  $ref: '#/components/schemas/SupplierCompanyUpdate'
            examples:
              simple request:
                $ref: '#/components/examples/update_request'
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/SupplierCompany'
              examples:
                default response:
                  $ref: '#/components/examples/update_response'
                compound response:
                  $ref: '#/components/examples/update_compound_response'
        '401':
          description: Unauthorized
        '404':
          description: Not Found
        '409':
          description: Conflict
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
              examples:
                invalid_type:
                  summary: Missing or invalid 'type' specified, expected 'supplier_companies'
                  description: 'Returns error due to invalid `type` parameter.

                    '
                  value:
                    errors:
                    - detail: Missing or invalid 'type' specified, expected 'supplier_companies'
      x-codeSamples:
      - label: Curl
        source: "curl -H \"X-Api-Key: ${COMPANY_KEY}\" \\\n     -H \"X-User-Token: ${USER_TOKEN}\" \\\n     -H \"X-User-Email: ${USER_EMAIL}\" \\\n     -H \"Content-Type: application/vnd.api+json\" \\\n     -X PATCH \\\n     -d '{\"data\":{\"type\":\"supplier_companies\",\"id\":\"1\",\"attributes\":{\"segmentation_status\": \"out_of_compliance\"}}}' \\\n     \"https://api.us.workdayspend.com/services/suppliers/v1/supplier_companies/1\"\n"
    delete:
      tags:
      - supplier_companies
      description: 'Deletes a supplier company. You need to supply the unique supplier

        company identifier that was returned upon supplier company creation.

        '
      operationId: Delete a Supplier Company
      summary: Delete a Supplier Company
      parameters:
      - name: id
        in: path
        description: Unique Supplier Company identifier.
        required: true
        schema:
          type: integer
        example: 1
      responses:
        '204':
          description: OK
        '401':
          description: Unauthorized
        '404':
          description: Not Found
      x-codeSamples:
      - label: Curl
        source: "curl -H \"X-Api-Key: ${COMPANY_KEY}\" \\\n     -H \"X-User-Token: ${USER_TOKEN}\" \\\n     -H \"X-User-Email: ${USER_EMAIL}\" \\\n     -H \"Content-Type: application/vnd.api+json\" \\\n     -X DELETE \\\n     \"https://api.us.workdayspend.com/services/suppliers/v1/supplier_companies/1\"\n"
  /supplier_companies/{external_id}/external_id:
    get:
      tags:
      - supplier_companies
      description: 'Retrieves the details of an existing supplier company. You need to supply the unique supplier

        company external identifier (the one you used when created the supplier company).

        '
      operationId: Get a Supplier Company by External ID
      summary: Get a Supplier Company by External ID
      parameters:
      - name: external_id
        in: path
        description: Supplier company external identifier.
        required: true
        schema:
          type: string
        example: 1234-5678-abcd-efgh
      - name: include
        in: query
        schema:
          $ref: '#/components/schemas/SupplierCompanyRelatedResources'
        description: 'Use the `include` parameter to request related resources along with the primary resource.

          (see "List Supplier Companies" for more details).

          '
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/SupplierCompany'
              examples:
                success:
                  $ref: '#/components/examples/external_show_response'
        '401':
          description: Unauthorized
        '404':
          description: Not Found
      x-codeSamples:
      - label: Curl
        source: "curl -H \"X-Api-Key: ${COMPANY_KEY}\" \\\n     -H \"X-User-Token: ${USER_TOKEN}\" \\\n     -H \"X-User-Email: ${USER_EMAIL}\" \\\n     -H \"Content-Type: application/vnd.api+json\" \\\n     \"https://api.us.workdayspend.com/services/suppliers/v1/supplier_companies/SUP-1234/external_id\"\n"
    patch:
      tags:
      - supplier_companies
      description: 'Updates the details of an existing supplier company. You need to supply the unique supplier

        company external identifier (the one you used when created the supplier company).


        Please note, that request body must include an `id` attribute with the value of your supplier

        external identifier (the same one you passed in the URL).

        '
      operationId: Update a Supplier Company by External ID
      summary: Update a Supplier Company by External ID
      parameters:
      - name: external_id
        in: path
        description: Supplier company external identifier.
        required: true
        schema:
          type: string
        example: 1234-5678-abcd-efgh
      - name: include
        in: query
        schema:
          $ref: '#/components/schemas/SupplierCompanyRelatedResources'
        description: 'Use the `include` parameter to request related resources along with the primary resource.

          (see "List Supplier Companies" for more details).

          '
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  $ref: '#/components/schemas/SupplierCompanyUpdate'
            examples:
              success:
                $ref: '#/components/examples/external_update_request'
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/SupplierCompany'
              examples:
                success:
                  $ref: '#/components/examples/external_update_response'
        '401':
          description: Unauthorized
        '404':
          description: Not Found
      x-codeSamples:
      - label: Curl
        source: "curl -H \"X-Api-Key: ${COMPANY_KEY}\" \\\n     -H \"X-User-Token: ${USER_TOKEN}\" \\\n     -H \"X-User-Email: ${USER_EMAIL}\" \\\n     -H \"Content-Type: application/vnd.api+json\" \\\n     -X PATCH \\\n     -d '{\"data\":{\"type\":\"supplier_companies\",\"id\":\"SUP-1234\",attributes\":{\"segmentation_status\": \"out_of_compliance\"}}}' \\\n     \"https://api.us.workdayspend.com/services/suppliers/v1/supplier_companies/SUP-1234/external_id\"\n"
    delete:
      tags:
      - supplier_companies
      description: 'Deletes a supplier company. You need to supply the unique supplier

        company external identifier (the one you used when created the supplier company).

        '
      operationId: Delete a Supplier Company by External ID
      summary: Delete a Supplier Company by External ID
      parameters:
      - name: external_id
        in: path
        description: Supplier company external identifier.
        required: true
        schema:
          type: string
        example: 1234-5678-abcd-efgh
      responses:
        '204':
          description: OK
        '401':
          description: Unauthorized
        '404':
          description: Not Found
      x-codeSamples:
      - label: Curl
        source: "curl -H \"X-Api-Key: ${COMPANY_KEY}\" \\\n     -H \"X-User-Token: ${USER_TOKEN}\" \\\n     -H \"X-User-Email: ${USER_EMAIL}\" \\\n     -H \"Content-Type: application/vnd.api+json\" \\\n     -X DELETE \\\n     \"https://api.us.workdayspend.com/services/suppliers/v1/supplier_companies/SUP-1234/external_id\"\n"
  /supplier_companies/describe:
    get:
      tags:
      - supplier_companies
      description: Returns a list of fields for the supplier company object.
      operationId: Describe Supplier Company object
      summary: Describe Supplier Company object
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                allOf:
                - type: object
                  properties:
                    data:
                      type: array
                      items:
                        $ref: '#/components/schemas/SupplierCompanyFieldModel'
              examples:
                success:
                  $ref: '#/components/examples/describe_response'
        '401':
          description: Unauthorized
      x-codeSamples:
      - label: Curl
        source: "curl -H \"X-Api-Key: ${COMPANY_KEY}\" \\\n     -H \"X-User-Token: ${USER_TOKEN}\" \\\n     -H \"X-User-Email: ${USER_EMAIL}\" \\\n     -H \"Content-Type: application/vnd.api+json\" \\\n     \"https://api.us.workdayspend.com/services/suppliers/v1/supplier_companies/describe\"\n"
components:
  schemas:
    SupplierCategoryBase:
      title: Field
      type: object
      required:
      - type
      - id
      properties:
        type:
          $ref: '#/components/schemas/SupplierCategoryType'
        id:
          $ref: '#/components/schemas/SupplierCategoryId'
    AttachmentId:
      type: integer
      description: Attachment identifier string.
      example: 1
    SupplierCompany:
      allOf:
      - $ref: '#/components/schemas/SupplierCompanyBase'
      - type: object
        properties:
          attributes:
            $ref: '#/components/schemas/SupplierCompanyAttributes'
          relationships:
            $ref: '#/components/schemas/SupplierCompanyRelationship'
          links:
            $ref: '#/components/schemas/ResourceLinks'
    SupplierClassificationValueType:
      type: string
      description: Object type, should always be `supplier_classification_values`.
      example: supplier_classification_values
    SupplierCompanyCreate:
      type: object
      required:
      - type
      properties:
        type:
          $ref: '#/components/schemas/SupplierCompanyType'
        attributes:
          $ref: '#/components/schemas/SupplierCompanyAttributes'
        relationships:
          $ref: '#/components/schemas/SupplierCompanyMutationRelationship'
    PaymentTerm:
      allOf:
      - $ref: '#/components/schemas/PaymentTermBase'
      - type: object
        properties:
          attributes:
            $ref: '#/components/schemas/PaymentTermAttributes'
    CustomFieldURL:
      title: URL
      allOf:
      - $ref: '#/components/schemas/CustomFieldBase'
      - type: object
        properties:
          value:
            type: string
            format: url
            description: URL string.
    SupplierGroupAttributes:
      type: object
      description: Supplier group attributes.
      required:
      - name
      properties:
        name:
          type: string
          maxLength: 255
          description: Supplier group name.
        external_id:
          type: string
          maxLength: 255
          description: Supplier group external identifier.
    OpenApiEnum:
      type: string
      enum:
      - string
      - number
      - integer
      - boolean
      - array
      - object
      description: OpenAPI data type.
      example: string
    ResourceLinks:
      type: object
      description: List of related links.
      allOf:
      - $ref: '#/components/schemas/SelfLink'
    DescribeFieldBase:
      title: DescribeFieldModel
      type: object
      required:
      - type
      - id
      properties:
        type:
          $ref: '#/components/schemas/DescribeFieldType'
        id:
          $ref: '#/components/schemas/DescribeFieldId'
    PaymentTermBase:
      title: Field
      type: object
      required:
      - type
      - id
      properties:
        type:
          $ref: '#/components/schemas/PaymentTermType'
        id:
          $ref: '#/components/schemas/PaymentTermId'
    SupplierCompanyFieldModel:
      allOf:
      - type: object
        properties:
          type:
            type: string
            description: Object type, should always be `supplier_company_fields`.
            example: supplier_company_fields
      - $ref: '#/components/schemas/DescribeFieldModel'
    PaymentTypeType:
      type: string
      description: Object type, should always be `payment_types`.
      example: payment_types
    SupplierCategoryType:
      type: string
      description: Object type, should always be `supplier_categories`.
      example: supplier_categories
    SupplierCategoryId:
      type: integer
      description: Supplier category identifier string.
      example: 1
    NextPageLink:
      type: object
      properties:
        next:
          type:
          - string
          - 'null'
          format: url
          description: Link to the next results page.
    CustomFieldLookup:
      title: Lookup
      allOf:
      - $ref: '#/components/schemas/CustomFieldBase'
      - type: object
        properties:
          value:
            type: string
            description: A value from a customer-provided lookup data source.
    SupplierClassificationValueRelationship:
      type: object
      description: Supplier classification value relationships.
      properties:
        supplier_classification_field_values:
          type: object
          description: Supplier classification field values.
          properties:
            data:
              type: array
              items:
                $ref: '#/components/schemas/SupplierClassificationFieldValueBase'
    CustomFieldDate:
      title: Date
      allOf:
      - $ref: '#/components/schemas/CustomFieldBase'
      - type: object
        properties:
          value:
            type: string
            format: date
            description: A date value.
    Errors:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
    CustomFieldDecimal:
      title: Decimal
      allOf:
      - $ref: '#/components/schemas/CustomFieldBase'
      - type: object
        properties:
          value:
            type: string
            format: decimal
            description: A decimal value represented as a number with floating point.
    SupplierCompanyUpdate:
      type: object
      required:
      - type
      - id
      properties:
        type:
          $ref: '#/components/schemas/SupplierCompanyType'
        id:
          $ref: '#/components/schemas/SupplierCompanyId'
        attributes:
          $ref: '#/components/schemas/SupplierCompanyAttributes'
        relationships:
          $ref: '#/components/schemas/SupplierCompanyMutationRelationship'
    DescribeFieldModel:
      allOf:
      - $ref: '#/components/schemas/DescribeFieldBase'
      - type: object
        properties:
          attributes:
            $ref: '#/components/schemas/DescribeFieldAttributes'
    SupplierCompanyRelationship:
      type: object
      description: Supplier company relationships.
      properties:
        supplier_category:
          type: object
          description: Supplier category assigned to the supplier company.
          properties:
            data:
              $ref: '#/components/schemas/SupplierCategoryBase'
        supplier_groups:
          type: object
          description: Supplier groups assigned to the supplier company.
          properties:
            data:
              type: array
              items:
                $ref: '#/components/schemas/SupplierGroupBase'
        default_payment_term:
          type: object
          description: Default payment term for the supplier company.
          properties:
            data:
              $ref: '#/components/schemas/PaymentTermBase'
        payment_types:
          type: object
          description: Payment types accepted by the supplier company.
          properties:
            data:
              type: array
              items:
                $ref: '#/components/schemas/PaymentTypeBase'
        default_payment_type:
          type: object
          description: Default payment type for the supplier company.
          properties:
            data:
              $ref: '#/components/schemas/PaymentTypeBase'
        payment_currencies:
          type: object
          description: Payment currencies accepted by the supplier company.
          properties:
            data:
              type: array
              items:
                $ref: '#/components/schemas/PaymentCurrencyBase'
        default_payment_currency:
          type: object
          description: Default payment currency for the supplier company.
          properties:
            data:
              $ref: '#/components/schemas/PaymentCurrencyBase'
        attachments:
          type: array
          description: Supplier company list of attachments.
          items:
            $ref: '#/components/schemas/AttachmentBase'
        supplier_classification_values:
          type: array
          description: List of supplier classification values
          items:
            $ref: '#/components/schemas/SupplierClassificationValueBase'
    CustomFieldBase:
      type: object
      properties:
        name:
          type: string
          description: Custom field name.
          example: My Custom Field
    CustomFieldRelated:
      title: Related
      allOf:
      - $ref: '#/components/schemas/CustomFieldBase'
      - type: object
        properties:
          value:
            type: string
            description: A value related to the lookup custom field value, retrieved from the same data source object.
    CustomFieldSingleSelect:
      title: Single Select
      allOf:
      - $ref: '#/components/schemas/CustomFieldBase'
      - type: object
        properties:
          value:
            type: string
            description: A single value from a predefined list of possible options.
    PrevPageLink:
      type: object
      properties:
        prev:
          type:
          - string
          - 'null'
          format: url
          description: Link to the previous results page.
          deprecated: true
    DescribeFieldType:
      type: string
      description: Object type, should always be `describe_fields`.
      example: describe_fields
    CustomField:
      oneOf:
      - $ref: '#/components/schemas/CustomFieldCheckbox'
      - $ref: '#/components/schemas/CustomFieldShortText'
      - $ref: '#/components/schemas/CustomFieldParagraph'
      - $ref: '#/components/schemas/CustomFieldDate'
      - $ref: '#/components/schemas/CustomFieldInteger'
      - $ref: '#/components/schemas/CustomFieldCurrency'
      - $ref: '#/components/schemas/CustomFieldDecimal'
      - $ref: '#/components/schemas/CustomFieldSingleSelect'
      - $ref: '#/components/schemas/CustomFieldMultipleSelect'
      - $ref: '#/components/schemas/CustomFieldURL'
      - $ref: '#/components/schemas/CustomFieldLookup'
      - $ref: '#/components/schemas/CustomFieldRelated'
    Pagination:
      type: object
      properties:
        meta:
          type: object
          description: Result set metadata.
          properties:
            count:
              type: integer
              description: Number of pages in the result set.
        links:
          $ref: '#/components/schemas/PaginationLinks'
    SupplierCompanyRelatedResources:
      allOf:
      - type: string
        enum:
        - attachments
        - supplier_category
        - supplier_groups
        - default_payment_term
        - payment_types
        - default_payment_type
        - payment_currencies
        - default_payment_currency
        - supplier_classification_values
    AttachmentType:
      type: string
      description: Object type, should always be `attachments`.
      example: attachments
    SupplierCompanyMutationRelationship:
      allOf:
      - $ref: '#/components/schemas/SupplierCompanyRelationship'
      - type: object
        properties:
          external_supplier_category:
            type: object
            description: Supplier category assigned to th

# --- truncated at 32 KB (104 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/scoutrfp/refs/heads/main/openapi/scoutrfp-supplier-companies-api-openapi.yml