Crunchtime Information Systems Uda Service API

openapi: 3.2.0
info:
  description: Swagger documentation supporting mobile development of Crunchtime.
  version: '2.99'
  title: Inventory & Labor Uda Service API
  termsOfService: http://springfox.io
  contact:
    name: Crunchtime Development Team
    url: http://www.crunchtime.com
    email: apiquestions@crunchtime.com
  license:
    name: Apache License Version 2.0
    url: https://github.com/springfox/springfox/blob/master/LICENSE
servers:
- url: //webservices-test.net-chef.com
tags:
- name: Uda Service
  description: The User Defined Attributes (UDA) Service allows for the retrieval of the location and vendor User-Defined Attributes (UDAs). Location UDAs can be configured at the corporate level or specific to a particular location.
paths:
  /uda/v1/locations/list:
    get:
      tags:
      - Uda Service
      summary: Get getUdaLocations
      description: Retrieve a list of Uda locations.
      operationId: getUdaLocationsUsingGET
      parameters:
      - name: activeFlag
        in: query
        description: Use `true` to retrieve active UDA locations.
        required: false
        schema:
          type: boolean
      - name: authenticationtoken
        in: header
        description: Secure token for API authentication.
        required: true
        schema:
          type: string
      - name: corporate
        in: query
        description: Use `true` to retrieve Corporate UDAs.
        required: false
        schema:
          type: boolean
      - name: locationCode
        in: query
        description: The Code that identifies the Location in Crunchtime.
        required: false
        schema:
          type: string
      - name: minutesSinceUpdate
        in: query
        description: The number of minutes since a record was last updated. Use to set how far back to search..
        required: false
        schema:
          type: integer
          format: int32
      - name: password
        in: header
        description: Password for the Crunchtime Application User.
        required: true
        schema:
          type: string
      - name: sitename
        in: header
        description: Crunchtime site identifier. (test or production)
        required: true
        schema:
          type: string
      - name: userid
        in: header
        description: User ID for the Crunchtime Application User.
        required: true
        schema:
          type: string
      - name: X-B3-TraceId
        in: header
        description: Optional trace identifier for troubleshooting.
        required: false
        schema:
          type: string
      - name: includeNull
        in: query
        description: Specify 'true' to output null data elements.
        required: false
        allowEmptyValue: true
        schema:
          type: boolean
      responses:
        '200':
          description: Success
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/BaseLocationDto'
            application/json:
              schema:
                $ref: '#/components/schemas/BaseLocationDto'
        '400':
          description: Validation Error
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ObjectError'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ObjectError'
        '401':
          description: Authorization
          content:
            '*/*':
              schema:
                type: string
            application/json:
              schema:
                type: string
        '429':
          description: Too Many Requests
          content:
            '*/*':
              schema:
                type: string
            application/json:
              schema:
                type: string
        '500':
          description: Unexpected Error
          content:
            '*/*':
              schema:
                type: string
            application/json:
              schema:
                type: string
        '503':
          description: System under maintenance
          content:
            '*/*':
              schema:
                type: string
            application/json:
              schema:
                type: string
        '504':
          description: Timeout
          content:
            '*/*':
              schema:
                type: string
            application/json:
              schema:
                type: string
  /uda/v1/vendors/list:
    get:
      tags:
      - Uda Service
      summary: Get getUdaVendors
      description: Retrieve a list of UDA vendors.
      operationId: getUdaVendorsUsingGET
      parameters:
      - name: activeFlag
        in: header
        description: Use `true` to retrieve active UDA vendors.
        required: false
        schema:
          type: boolean
      - name: authenticationtoken
        in: header
        description: Secure token for API authentication.
        required: true
        schema:
          type: string
      - name: minutesSinceUpdate
        in: query
        description: The number of minutes since a vendor record was last updated. Use to set how far back to search.
        required: false
        schema:
          type: integer
          format: int32
      - name: password
        in: header
        description: Password for the Crunchtime Application User.
        required: true
        schema:
          type: string
      - name: sitename
        in: header
        description: Crunchtime site identifier. (test or production)
        required: true
        schema:
          type: string
      - name: userid
        in: header
        description: User ID for the Crunchtime Application User.
        required: true
        schema:
          type: string
      - name: X-B3-TraceId
        in: header
        description: Optional trace identifier for troubleshooting.
        required: false
        schema:
          type: string
      - name: includeNull
        in: query
        description: Specify 'true' to output null data elements.
        required: false
        allowEmptyValue: true
        schema:
          type: boolean
      responses:
        '200':
          description: Success
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/BaseVendorDto'
            application/json:
              schema:
                $ref: '#/components/schemas/BaseVendorDto'
        '400':
          description: Validation Error
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ObjectError'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ObjectError'
        '401':
          description: Authorization
          content:
            '*/*':
              schema:
                type: string
            application/json:
              schema:
                type: string
        '429':
          description: Too Many Requests
          content:
            '*/*':
              schema:
                type: string
            application/json:
              schema:
                type: string
        '500':
          description: Unexpected Error
          content:
            '*/*':
              schema:
                type: string
            application/json:
              schema:
                type: string
        '503':
          description: System under maintenance
          content:
            '*/*':
              schema:
                type: string
            application/json:
              schema:
                type: string
        '504':
          description: Timeout
          content:
            '*/*':
              schema:
                type: string
            application/json:
              schema:
                type: string
components:
  schemas:
    BaseVendorUdaDetailDto:
      type: object
      properties:
        dataType:
          type: string
        lastTouchDate:
          type: string
          format: date-time
        replicatedFlag:
          type: string
        requiredFlag:
          type: string
        supplyCode:
          type: string
        supplyId:
          type: integer
          format: int64
        udaCode:
          type: string
        udaDescription:
          type: string
        udaGroup:
          type: string
        udaType:
          type: string
        udaValue:
          type: string
      title: BaseVendorUdaDetailDto
    BaseVendorDto:
      type: object
      properties:
        supplyCode:
          type: string
        supplyId:
          type: integer
          format: int64
        supplyName:
          type: string
        vendorUdaDetails:
          type: array
          items:
            $ref: '#/components/schemas/BaseVendorUdaDetailDto'
      title: BaseVendorDto
    BaseLocationUdaDetailDto:
      type: object
      properties:
        dataType:
          type: string
        lastTouchDate:
          type: string
          format: date-time
        locationCode:
          type: string
        locationId:
          type: integer
          format: int64
        prefix:
          type: string
        replicatedFlag:
          type: boolean
        requiredFlag:
          type: string
        udaCode:
          type: string
        udaDescription:
          type: string
        udaGroup:
          type: string
        udaType:
          type: string
        udaValue:
          type: string
      title: BaseLocationUdaDetailDto
    ObjectError:
      type: object
      properties:
        arguments:
          type: array
          items:
            type: object
        code:
          type: string
        codes:
          type: array
          items:
            type: string
        defaultMessage:
          type: string
        objectName:
          type: string
      title: ObjectError
    BaseLocationDto:
      type: object
      properties:
        locationCode:
          type: string
        locationId:
          type: integer
          format: int64
        locationName:
          type: string
        locationUdaDetails:
          type: array
          items:
            $ref: '#/components/schemas/BaseLocationUdaDetailDto'
      title: BaseLocationDto
externalDocs:
  description: Crunchtime Developer Hub
  url: https://developer.crunchtime.com/
x-provenance:
  method: searched
  source: https://developer.crunchtime.com/reference
  harvested: '2026-10-14'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://developer.crunchtime.com/reference/downloadscheduledexportsv1usingget.md
  - https://developer.crunchtime.com/reference/downloadscheduledexportsv2usingget.md
  - https://developer.crunchtime.com/reference/get15minutessalesforecastbypagev1usingget.md
  - https://developer.crunchtime.com/reference/get15minutessalesforecastv1usingget.md
  - https://developer.crunchtime.com/reference/get_commissaryorder-v1-getcommissaryordersbypage.md
  - https://developer.crunchtime.com/reference/get_customerorderenhanced-v1-getcustomerorderenhancedbypage.md
  - https://developer.crunchtime.com/reference/getallapplicationusersv1usingget.md
  - https://developer.crunchtime.com/reference/getallbudgetv1usingget.md
  - https://developer.crunchtime.com/reference/getallcategoryv1usingget.md
  - https://developer.crunchtime.com/reference/getallcheckmenumixrecordsv1usingget.md
  - https://developer.crunchtime.com/reference/getallcommissaryordersv1usingget.md
  - https://developer.crunchtime.com/reference/getallcompanyproductsenhancedv1usingget.md
  - https://developer.crunchtime.com/reference/getallconfirmreceiptstandardv1usingget.md
  - https://developer.crunchtime.com/reference/getallcurrencyratiov1usingget.md
  - https://developer.crunchtime.com/reference/getallcustomerorderenhancedv1usingget.md
  - https://developer.crunchtime.com/reference/getallcustomerrecordsv1usingget.md
  - https://developer.crunchtime.com/reference/getalldailyprepsv1usingget.md
  - https://developer.crunchtime.com/reference/getallgeneralledgersv1usingget.md
  - https://developer.crunchtime.com/reference/getallinventoryadjustmentv1usingget.md
  - https://developer.crunchtime.com/reference/getallinventorylocationtransfersv1usingget.md
  - https://developer.crunchtime.com/reference/getallinventoryvalueadjustmentv1usingget.md
  - https://developer.crunchtime.com/reference/getalllocationproductpricingv1usingget.md
  - https://developer.crunchtime.com/reference/getalllocationsv1usingget.md
  - https://developer.crunchtime.com/reference/getallnutritionv1usingget.md
  - https://developer.crunchtime.com/reference/getallpackagetypesv2usingget.md
  - https://developer.crunchtime.com/reference/getallpbisbypagev2usingget.md
  - https://developer.crunchtime.com/reference/getallpbisv2usingget.md
  - https://developer.crunchtime.com/reference/getallphysicalinventorystandardusingget.md
  - https://developer.crunchtime.com/reference/getallprojectedconsumptionv1usingget.md
  - https://developer.crunchtime.com/reference/getallpurchaseordersv1usingget.md
  - https://developer.crunchtime.com/reference/getallrecipelocationv1usingget.md
  - https://developer.crunchtime.com/reference/getallrecipesenhancedv2usingget.md
  - https://developer.crunchtime.com/reference/getallsalesmixrecordsv1usingget.md
  - https://developer.crunchtime.com/reference/getallscheduledexportsv1usingget.md
  - https://developer.crunchtime.com/reference/getallstoragelocationv1usingget.md
  - https://developer.crunchtime.com/reference/getallsupplementalwagerecordsv1usingget.md
  - https://developer.crunchtime.com/reference/getalltimeclockenhancedrecordsv1usingget.md
  - https://developer.crunchtime.com/reference/getallvendorlocationv1usingget.md
  - https://developer.crunchtime.com/reference/getallvendorpaymentv1usingget.md
  - https://developer.crunchtime.com/reference/getallvendorproductpricingv1usingget.md
  - https://developer.crunchtime.com/reference/getallvendorsv1usingget.md
  - https://developer.crunchtime.com/reference/getapplicationusersbypagev1usingget.md
  - https://developer.crunchtime.com/reference/getattachmentsbypagev1usingget.md
  - https://developer.crunchtime.com/reference/getattachmentsbypagev2.md
  - https://developer.crunchtime.com/reference/getbudgetbypagev1usingget.md
  - https://developer.crunchtime.com/reference/getcategorybypagev1usingget.md
  - https://developer.crunchtime.com/reference/getcheckmenumixrecordsbypagev1usingget.md
  - https://developer.crunchtime.com/reference/getcompanyproductsenhancedbypagev1usingget.md
  - https://developer.crunchtime.com/reference/getconfirmreceiptstandardbypagev1usingget.md
  - https://developer.crunchtime.com/reference/getcurrencyratiobypagev1usingget.md
  - https://developer.crunchtime.com/reference/getcurrentinventorybypagev1usingget.md
  - https://developer.crunchtime.com/reference/getcustomerrecordsbypagev1usingget.md
  - https://developer.crunchtime.com/reference/getdailyprepsbypagev1usingget.md
  - https://developer.crunchtime.com/reference/getdailysalesforecastbypagev1usingget.md
  - https://developer.crunchtime.com/reference/getdailysalesforecastv1usingget.md
  - https://developer.crunchtime.com/reference/getemployeenumbersv1usingget.md
  - https://developer.crunchtime.com/reference/getemployeesbypagev1usingget.md
  - https://developer.crunchtime.com/reference/getemployeev1usingget.md
  - https://developer.crunchtime.com/reference/gethierarchiesv2usingget.md
  - https://developer.crunchtime.com/reference/gethierarchydetailsv2usingget.md
  - https://developer.crunchtime.com/reference/gethourlysalesforecastbypagev1usingget.md
  - https://developer.crunchtime.com/reference/gethourlysalesforecastv1usingget.md
  - https://developer.crunchtime.com/reference/getinventoryadjustmentbypagev1usingget.md
  - https://developer.crunchtime.com/reference/getinventorylocationtransfersbypagev1usingget.md
  - https://developer.crunchtime.com/reference/getinventoryvalueadjustmentbypagev1usingget.md
  - https://developer.crunchtime.com/reference/getlocationproductpricingbypagev1usingget.md
  - https://developer.crunchtime.com/reference/getlocationsbypagev1usingget.md
  - https://developer.crunchtime.com/reference/getnutritionbypagev1usingget.md
  - https://developer.crunchtime.com/reference/getpackagetypesbypagev2usingget.md
  - https://developer.crunchtime.com/reference/getphysicalinventorystandardbypagev1usingget.md
  - https://developer.crunchtime.com/reference/getprojectedconsumptionbypagev1usingget.md
  - https://developer.crunchtime.com/reference/getpurchaseordersbypagev1usingget.md
  - https://developer.crunchtime.com/reference/getrecipelocationbypagev1usingget.md
  - https://developer.crunchtime.com/reference/getrecipesenhancedbypagev2usingget.md
  - https://developer.crunchtime.com/reference/getsalesmixrecordsbypagev1usingget.md
  - https://developer.crunchtime.com/reference/getschedulesv1usingget.md
  - https://developer.crunchtime.com/reference/getstoragelocationbypagev1usingget.md
  - https://developer.crunchtime.com/reference/getsupplementalwagerecordsbypageusingget.md
  - https://developer.crunchtime.com/reference/gettimeclockenhancedrecordsbypagev1usingget.md
  - https://developer.crunchtime.com/reference/getudalocationsusingget.md
  - https://developer.crunchtime.com/reference/getudavendorsusingget.md
  - https://developer.crunchtime.com/reference/getvendorlocationbypagev1usingget.md
  - https://developer.crunchtime.com/reference/getvendorpaymentbypagev1usingget.md
  - https://developer.crunchtime.com/reference/getvendorproductpricingbypagev1usingget.md
  - https://developer.crunchtime.com/reference/markscheduledexportsv1usingput.md
  - https://developer.crunchtime.com/reference/save15minutessalesforecastusingpost.md
  - https://developer.crunchtime.com/reference/saveapplicationusersv1usingpost.md
  - https://developer.crunchtime.com/reference/savebudgetusingpost.md
  - https://developer.crunchtime.com/reference/savecategoryusingpost.md
  - https://developer.crunchtime.com/reference/savecheckmenumixrecordsv1usingpost.md
  - https://developer.crunchtime.com/reference/savecompanyproductenhancedv1usingpost.md
  - https://developer.crunchtime.com/reference/saveconfirmreceiptstandardusingpost.md
  - https://developer.crunchtime.com/reference/savecurrencyratiousingpost.md
  - https://developer.crunchtime.com/reference/savecustomerorderenhancedusingpost.md
  - https://developer.crunchtime.com/reference/savecustomerrecordsusingpost.md
  - https://developer.crunchtime.com/reference/savedailyprepsusingpost.md
  - https://developer.crunchtime.com/reference/savedailysalesforecastusingpost.md
  - https://developer.crunchtime.com/reference/saveelectronicinvoiceusingpost.md
  - https://developer.crunchtime.com/reference/saveemployeev1usingpost.md
  - https://developer.crunchtime.com/reference/savegeneralledgerv1usingpost.md
  - https://developer.crunchtime.com/reference/savehierarchyv2usingpost.md
  - https://developer.crunchtime.com/reference/savehourlysalesforecastusingpost.md
  - https://developer.crunchtime.com/reference/saveinventoryadjustmentusingpost.md
  - https://developer.crunchtime.com/reference/saveinventoryvalueadjustmentusingpost.md
  - https://developer.crunchtime.com/reference/savelocationproductpricingusingpost.md
  - https://developer.crunchtime.com/reference/savelocationv1usingpost.md
  - https://developer.crunchtime.com/reference/savenutritionusingpost.md
  - https://developer.crunchtime.com/reference/savepackagetypesv2usingpost.md
  - https://developer.crunchtime.com/reference/savepbiv2usingpost.md
  - https://developer.crunchtime.com/reference/savephysicalinventorystandardusingpost.md
  - https://developer.crunchtime.com/reference/saveprojectedconsumptionusingpost.md
  - https://developer.crunchtime.com/reference/savepurchaseordersusingpost.md
  - https://developer.crunchtime.com/reference/saverecipelocationusingpost.md
  - https://developer.crunchtime.com/reference/saverecipesv2usingpost.md
  - https://developer.crunchtime.com/reference/savesalesmixrecordusingpost.md
  - https://developer.crunchtime.com/reference/savestoragelocationusingpost.md
  - https://developer.crunchtime.com/reference/savesupplementalwagerecordsusingpost.md
  - https://developer.crunchtime.com/reference/savetimeclockenhancedrecordsusingpost.md
  - https://developer.crunchtime.com/reference/savevendorlocationv1usingpost.md
  - https://developer.crunchtime.com/reference/savevendorpaymentusingpost.md
  - https://developer.crunchtime.com/reference/savevendorv1usingpost.md
  - https://developer.crunchtime.com/reference/validateuserusingpost.md
  merge:
    pages: 122
    deduped: 334
    conflicts_kept_first: 0