openapi: 3.2.0 info: title: Crunchtime Vendor Service API 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 termsOfService: http://springfox.io version: '1.0' description: 'Operations tagged Vendor Service across 2 of this provider''s published API definitions: crunchtime-cruise-platform-openapi.yml, crunchtime-inventory-labor-openapi.yml. Each path carries the servers of the definition it was published in.' servers: - url: //webservices-test.net-chef.com tags: - name: Vendor Service description: The Vendor Service is used to create/review records of all Vendors that can be used to record expenses in Crunchtime. Typically, a third-party system is the system of record for Vendors and vendor data is posted to Crunchtime. Once created, additional configuration is required within Enterprise Manager to ensure stores can place and receive Vendor Orders or record Simple Receipt and Purchase by Invoice (PBI) transactions. paths: /cruise/vendor/v1/getAllVendors: get: tags: - Vendor Service summary: getAllVendorsV1 description: Retrieves a list of all vendors. operationId: getAllVendorsV1UsingGET parameters: - name: activeFlag in: query description: Active 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: type: array items: $ref: '#/components/schemas/VendorGetDto' application/json: schema: type: array items: $ref: '#/components/schemas/VendorGetDto' '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 servers: - url: //webservices-test.net-chef.com /cruise/vendor/v1/saveVendor: post: tags: - Vendor Service summary: saveVendor description: 'Create a new vendor entry. Update vendor details.' operationId: saveVendorV1UsingPOST parameters: - name: authenticationtoken in: header description: Secure token for API authentication. required: true schema: type: string - 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 requestBody: content: application/json: schema: $ref: '#/components/schemas/VendorDetails' '*/*': schema: $ref: '#/components/schemas/VendorDetails' description: vendorDetails required: true responses: '200': description: Success content: '*/*': schema: type: object application/json: schema: type: object '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: $ref: '#/components/schemas/VendorDto' application/json: schema: $ref: '#/components/schemas/VendorDto' '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 servers: - url: //webservices-test.net-chef.com /vendor/v1/getAllVendors: get: tags: - Vendor Service summary: getAllVendorsV1 description: Retrieves a list of all vendors. operationId: getVendorV1GetAllVendors parameters: - name: activeFlag in: query description: Active 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: type: array items: $ref: '#/components/schemas/VendorGetDto' application/json: schema: type: array items: $ref: '#/components/schemas/VendorGetDto' '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 x-operation-id-source: normalized x-operation-id-original: getAllVendorsV1UsingGET servers: - url: //webservices-test.net-chef.com /vendor/v1/saveVendor: post: tags: - Vendor Service summary: saveVendor description: 'Create a new vendor entry. Update vendor details.' operationId: postVendorV1SaveVendor parameters: - name: authenticationtoken in: header description: Secure token for API authentication. required: true schema: type: string - 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 requestBody: content: application/json: schema: $ref: '#/components/schemas/VendorDetails' '*/*': schema: $ref: '#/components/schemas/VendorDetails' description: vendorDetails required: true responses: '200': description: Success content: '*/*': schema: type: object application/json: schema: type: object '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: $ref: '#/components/schemas/VendorDto' application/json: schema: $ref: '#/components/schemas/VendorDto' '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 x-operation-id-source: normalized x-operation-id-original: saveVendorV1UsingPOST servers: - url: //webservices-test.net-chef.com components: schemas: VendorDetails: type: object properties: vendors: type: array items: $ref: '#/components/schemas/VendorDto' title: VendorDetails description: VendorDetails description VendorDto: type: object required: - currencyCode - supplyAddress1 - supplyCityName - supplyCode - supplyName properties: accrualFlag: type: string example: Y description: '"Accrual" flag from Vendor setup screen. If the field value is null, the previously saved value will remain. To erase it, please enter ''#DELETE'' value.' allowDuplicateInvoicesFlag: type: string example: N description: '"Allow Duplicate Invoice Numbers" flag from Vendor Pricing Rules. If the field value is null, the previously saved value will remain. To erase it, please enter ''#DELETE'' value.' allowDuplicatePoNumberFlag: type: string example: N description: '"Allow Duplicate Purchase Order Numbers" flag from Vendor Pricing Rules. If the field value is null, the previously saved value will remain. To erase it, please enter ''#DELETE'' value.' allowPbiFlag: type: string example: Y description: '"Allow PBI" flag from Vendor setup screen. If the field value is null, the previously saved value will remain. To erase it, please enter ''#DELETE'' value.' allowSimpleReceiptFlag: type: string example: Y description: '"Allow Simple Receipt" flag from Vendor setup screen. If the field value is null, the previously saved value will remain. To erase it, please enter ''#DELETE'' value.' altAddress1: type: string example: 123 Central Avenue description: '"Alt Address 1" from Vendor setup screen. If the field value is null, the previously saved value will remain. To erase it, please enter ''#DELETE'' value.' altAddress2: type: string example: Suite 1 description: '"Alt Address 2" from Vendor setup screen. If the field value is null, the previously saved value will remain. To erase it, please enter ''#DELETE'' value.' altCityName: type: string example: Rockville description: '"Alt City" from Vendor setup screen. If the field value is null, the previously saved value will remain. To erase it, please enter ''#DELETE'' value.' altFax: type: string example: 123 description: '"Alt Fax" from Vendor setup screen. Required if Bid Mode is 4 (Fax). (Not required if it is null or any other option). If the field value is null, the previously saved value will remain. To erase it, please enter ''#DELETE'' value.' altPhone: type: string example: 1234567890 description: '"Alt Phone" from Vendor setup screen. If the field value is null, the previously saved value will remain. To erase it, please enter ''#DELETE'' value.' altStateShortName: type: string example: MD description: '"Alt State/Province" (Abbreviation) from Vendor setup screen. If the field value is null, the previously saved value will remain. To erase it, please enter ''#DELETE'' value.' altZip: type: string example: 53454 description: '"Alt Zip" from Vendor setup screen. If the field value is null, the previously saved value will remain. To erase it, please enter ''#DELETE'' value.' autoProcessNewBidFileFlag: type: string example: Y description: '"Automatically Process New Vendor Bid Files" flag from Vendor Pricing Rules. If the field value is null, the previously saved value will remain. To erase it, please enter ''#DELETE'' value.' autoReconcileEinvoiceFlag: type: string example: Y description: '"E-Invoices Will be Auto-Reconciled Upon Import" flag from Vendor Pricing Rules. If the field value is null, the previously saved value will remain. To erase it, please enter ''#DELETE'' value.' batchId: type: integer format: int64 certificateExpireDate: type: string format: date-time example: 1544590800000 description: '"Certificate Expire Date" from Vendor setup screen. If the field value is null, the previously saved value will remain. To erase it, please enter ''#DELETE'' value.' certificateNumber: type: string example: 123 description: '"Certificate Number" from Vendor setup screen. If the field value is null, the previously saved value will remain. To erase it, please enter ''#DELETE'' value.' codFlag: type: string example: Y description: '"COD" flag from Vendor setup screen. If the field value is null, the previously saved value will remain. To erase it, please enter ''#DELETE'' value.' countryCode: type: string example: US description: '"Country Code" from Vendor setup screen. If the field value is null, the previously saved value will remain. To erase it, please enter ''#DELETE'' value.' countryName: type: string example: UNITED STATES description: '"Country Name" from Vendor setup screen. If the field value is null, the previously saved value will remain. To erase it, please enter ''#DELETE'' value.' createNewBidProductsFlag: type: string example: N description: '"Allow Auto-Bid Processing to Create New Vendor Bid Products" flag from Vendor Pricing Rules. If the field value is null, the previously saved value will remain. To erase it, please enter ''#DELETE'' value.' currencyCode: type: string example: AFA description: '"Base Currency" Code from Vendor setup screen' electronicInvoiceFlag: type: string example: N description: '"Electronic Invoice Required" flag from Vendor setup screen. If the field value is null, the previously saved value will remain. To erase it, please enter ''#DELETE'' value.' exportCode: type: string description: '"Export Code" from Vendor setup screen. If the field value is null, the previously saved value will remain. To erase it, please enter ''#DELETE'' value.' haccpCertifiedFlag: type: string example: N description: '"HACCP" flag from Vendor setup screen. If the field value is null, the previously saved value will remain. To erase it, please enter ''#DELETE'' value.' internalFlag: type: string example: Y description: '"Internal" flag from Vendor setup screen. If the field value is null, the previously saved value will remain. To erase it, please enter ''#DELETE'' value.' priceIncludesTax: type: string example: Y description: '"Prices Include Tax" flag from Vendor setup screen. If the field value is null, the previously saved value will remain. To erase it, please enter ''#DELETE'' value.' supplyAccountNumber: type: string description: '"Account #" from Vendor setup screen. If the field value is null, the previously saved value will remain. To erase it, please enter ''#DELETE'' value.' supplyActive: type: string example: N description: '"Active" flag from Vendor setup screen. If the field value is null, the previously saved value will remain. To erase it, please enter ''#DELETE'' value.' supplyAddress1: type: string description: '"Address 1" from Vendor setup screen' supplyAddress2: type: string description: '"Address 2" from Vendor setup screen. If the field value is null, the previously saved value will remain. To erase it, please enter ''#DELETE'' value.' supplyBidPath: type: string example: Fax description: '"Bid Mode" from Vendor setup screen. If the field value is null, the previously saved value will remain. To erase it, please enter ''#DELETE'' value.' enum: - CT Xchange - E-Mail Excel File - E-Mail PDF - E-Mail Text - Fax - Phone supplyCityName: type: string description: '"City" from Vendor setup screen' supplyCode: type: string example: '000222' description: Vendor "Code" from Vendor setup screen supplyEmail: type: string example: w@Q.co description: '"Vendor E-Mail" from Vendor setup screen. If the field value is null, the previously saved value will remain. To erase it, please enter ''#DELETE'' value.' supplyFax: type: string example: 1234567890 description: '"Fax" from Vendor setup screen. If the field value is null, the previously saved value will remain. To erase it, please enter ''#DELETE'' value.' supplyIntranet: type: string example: 1 description: '"Intranet Number" from Vendor setup screen. If the field value is null, the previously saved value will remain. To erase it, please enter ''#DELETE'' value.' supplyLeadPeriod: type: object example: 999999 description: '"Lead Period" from Vendor setup screen. If the field value is null, the previously saved value will remain. To erase it, please enter ''#DELETE'' value.' supplyName: type: string example: My Supply Company description: Vendor "Name" from Vendor setup screen supplyOrderPath: type: string example: 12ww description: '"Order Path" from Vendor setup screen. If the field value is null, the previously saved value will remain. To erase it, please enter ''#DELETE'' value.' supplyPhone: type: string example: 123-456-7890 description: '"Phone" from Vendor setup screen. If the field value is null, the previously saved value will remain. To erase it, please enter ''#DELETE'' value.' supplySalesmanFax: type: string example: 76768788787 description: '"Fax" from Vendor Contact Info. If the field value is null, the previously saved value will remain. To erase it, please enter ''#DELETE'' value.' supplySalesmanFullName: type: string example: John description: '"Name" from Vendor Contact Info. If the field value is null, the previously saved value will remain. To erase it, please enter ''#DELETE'' value.' supplySalesmanHomePhone: type: string example: 57576878 description: '"Home Phone" from Vendor Contact Info. If the field value is null, the previously saved value will remain. To erase it, please enter ''#DELETE'' value.' supplySalesmanPhone: type: string example: 675543453 description: '"Business Phone" from Vendor Contact Info. If the field value is null, the previously saved value will remain. To erase it, please enter ''#DELETE'' value.' supplySalesmanTitle: type: string example: Doe description: '"Title" from Vendor Contact Info. If the field value is null, the previously saved value will remain. To erase it, please enter ''#DELETE'' value.' supplySatellite: type: string example: 11@gmail.com description: '"VO E-mail" from Vendor setup screen. Required if Bid Mode is 1 (E-Mail PDF), 2 (E-Mail Text), 3 (E-Mail Excel) or 9 (E-Mail PDF - Custom) (any of the E-Mail options). (Not required if it is null or any other option). If the field value is null, the previously saved value will remain. To erase it, please enter ''#DELETE'' value.' supplyStateShortName: type: string example: MA description: '"State/Province" (Abbreviation) from Vendor setup screen. If the field value is null, the previously saved value will remain. To erase it, please enter ''#DELETE'' value.' supplyTerms: type: string example: Terms description: '"Terms" from Vendor setup screen. If the field value is null, the previously saved value will remain. To erase it, please enter ''#DELETE'' value.' supplyTransmitMethod: type: string example: COI description: '"Interface" from Vendor setup screen. Required if VO Mode is FTP (5) or Web Services (8), but the system will use the default value of "STANDARD", if it is not provided or is not a valid value (1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11). If the field value is null, the previously saved value will remain. To erase it, please enter ''#DELETE'' value.' enum: - ALNT - AMPH - COI - CTVP - DCLO - DLA - DTLH - FPRO - MS90 - N/A - PFG - PFGC - SAVL - STND - SYSC supplyTransmitPath: type: string example: PHONE description: '"VO Mode" from Vendor setup screen. If the field value is null, the previously saved value will remain. To erase it, please enter ''#DELETE'' value.' enum: - E-Mail Excel - E-Mail PDF - E-Mail PDF - Custom - E-Mail Text - FTP - Fax - Phone - Secure FTP - Web Services supplyWebAddress: type: string example: abc@def.com description: '"URL" from Vendor setup screen. Required if VO Mode is 5 (FTP) or 6 (Secure FTP) or Interface is US Foods (1). (Not required if it is null or any other option). If the field value is null, the previously saved value will remain. To erase it, please enter ''#DELETE'' value.' supplyZip: type: string example: 1223 description: '"Zip" Code from Vendor setup screen. If the field value is null, the previously saved value will remain. To erase it, please enter ''#DELETE'' value.' taxId: type: string example: Tax ID description: '"Tax ID" from Vendor setup screen. If the field value is null, the previously saved value will remain. To erase it, please enter ''#DELETE'' value.' updateBidsVarianceFromLast: type: object example: 1 description: '"Do Not Allow Auto-Bid Processing to Update Vendor Bids When Variance from Last Bid > x %" from Vendor Pricing Rules. If the field value is null, the previously saved value will remain. To erase it, please enter ''#DELETE'' value.' voFax: type: string example: 1292348059 description: '"VO Fax" from Vendor setup screen. Required if VO Mode is 4 (Fax). (Not required if it is null or any other option). If the field value is null, the previously saved value will remain. To erase it, please enter ''#DELETE'' value.' title: VendorDto vendorUdaDetail: type: object properties: supplyCode: type: string description: Vendor "Code" from Vendor setup screen. example: '627' udaCode: type: string description: '"Code" from Vendor UDA tab.' example: PAYMENT_TYPE udaDescription: type: string description: '"Description" from Vendor UDA tab.' example: Mode of payment accepted by vendor dataType: type: string description: UDA Data Type example: CHAR udaType: type: string description: UDA Type example: VENDOR udaGroup: type: string description: '"Group" from Vendor UDA tab.' example: USERDEFINED requiredFlag: type: string description: UDA Required flag example: N udaValue: type: string description: '"Value" from Vendor UDA tab.' example: charge card replicatedFlag: type: string description: UDA Replicated flag, from Vendor setup screen. example: N lastTouchDate: type: string format: date-time description: Last Touch Date from the vendor record. example: 06/04/2025 title: vendorUdaDetail VendorGetDto: type: object required: - currencyCode - supplyAddress1 - supplyCityName - supplyCode - supplyName properties: accrualFlag: type: string example: Y description: '"Accrual" flag from Vendor setup screen. If the field value is null, the previously saved value will remain. To erase it, please enter ''#DELETE'' value.' allowDuplicateInvoicesFlag: type: string example: N description: '"Allow Duplicate Invoice Numbers" flag from Vendor Pricing Rules. If the field value is null, the previously saved value will remain. To erase it, please enter ''#DELETE'' value.' allowDuplicatePoNumberFlag: type: string example: N description: '"Allow Duplicate Purchase Order Numbers" flag from Vendor Pricing Rules. If the field value is null, the previously saved value will remain. To erase it, please enter ''#DELETE'' value.' allowPbiFlag: type: string example: Y description: '"Allow PBI" flag from Vendor setup screen. If the field value is null, the previously saved value will remain. To erase it, please enter ''#DELETE'' value.' allowSimpleReceiptFlag: type: string example: Y description: '"Allow Simple Receipt" flag from Vendor setup screen. If the field value is null, the previously saved value will remain. To erase it, please enter ''#DELETE'' value.' altAddress1: type: string example: 123 Central Avenue description: '"Alt Address 1" from Vendor setup screen. If the field value is null, the previously saved value will remain. To erase it, please enter ''#DELETE'' value.' altAddress2: type: string example: Suite 1 description: '"Alt Address 2" from Vendor setup screen. If the field value is null, the previously saved value will remain. To erase it, please enter ''#DELETE'' value.' altCityName: type: string example: Rockville description: '"Alt City" from Vendor setup screen. If the field value is null, the previously saved value will remain. To erase it, please enter ''#DELETE'' value.' altFax: type: string example: 123 description: '"Alt Fax" from Vendor setup screen. Required if Bid Mode is 4 (Fax). (Not required if it is null or any other option). If the field value is null, the previously saved value will remain. To erase it, please enter ''#DELETE'' value.' altPhone: type: string example: 1234567890 description: '"Alt Phone" from Vendor setup screen. If the field value is null, the previously saved value will remain. To erase it, please enter ''#DELETE'' value.' altStateShortName: type: string example: MD description: '"Alt State/Province" (Abbreviation) from Vendor setup screen. If the field value is null, the previously saved value will remain. To erase it, please enter ''#DELETE'' value.' altZip: type: string example: 53454 description: '"Alt Zip" from Vendor setup screen. If the field value is null, the previously saved value will remain. To erase it, please enter ''#DELETE'' value.' autoProcessNewBidFileFlag: type: string example: Y description: '"Automatically Process New Vendor Bid Files" flag from Vendor Pricing Rules. If the field value is null, the previously saved value will remain. To erase it, please enter ''#DELETE'' value.' autoReconcileEinvoiceFlag: type: string example: Y description: '"E-Invoices Will be Auto-Reconciled Upon Import" flag from Vendor Pricing Rules. If the field value is null, the previously saved value will remain. To erase it, please enter ''#DELETE'' value.' batchId: type: integer format: int64 certificateExpireDate: type: string format: date-time example: 1544590800000 description: '"Certificate Expire Date" from Vendor setup screen. If the field value is null, the previously saved value will remain. To erase it, please enter ''#DELETE'' value.' certificateNumber: type: string example: 123 description: '"Certificate Number" from Vendor setup screen. If the field value is null, the previously saved value will remain. To erase it, please enter ''#DELETE'' value.' codFlag: type: string example: Y description: '"COD" flag from Vendor setup screen. If the field value is null, the previously saved value will remain. To erase it, please enter ''#DELETE'' value.' countryCode: type: string example: US description: '"Country Code" from Vendor setup screen. If the field value is null, the previously saved value will remain. To erase it, please enter ''#DELETE'' value.' countryName: type: string example: UNITED STATES description: '"Country Name" from Vendor setup screen. If the field value is null, the previously saved value will remain. To erase it, please enter ''#DELETE'' value.' createNewBidProductsFlag: type: string example: N description: '"Allow Auto-Bid Processing to Create New Vendor Bid Products" flag from Vendor Pricing Rules. If the field value is null, the previously saved value will remain. To erase it, please enter ''#DELETE'' value.' currencyCode: type: string example: AFA description: '"Base Currency" Code from Vendor setup screen' electronicInvoiceFlag: type: string example: N description: '"Electronic Invoice Required" flag from Vendor setup screen. If the field value is null, the previously saved value will remain. To erase it, please enter ''#DELETE'' value.' exportCode: type: string description: '"Export Code" from Vendor setup screen. If the field value is null, the previously saved value will remain. To erase it, please enter ''#DELETE'' value.' haccpCertifiedFlag: type: string example: N description: '"HACCP" flag from Vendor setup screen. If the field value is null, the previously saved value will remain. To erase it, please enter ''#DELETE'' value.' internalFlag: type: string example: Y description: '"Internal" flag from Vendor setup screen. If the field value is null, the previously saved value will remain. To erase it, please enter ''#DELETE'' value.' priceIncludesTax: type: string example: Y description: '"Prices Include Tax" flag from Vendor setup screen. If the field value is null, the previously saved value will remain. To erase it, please enter ''#DELETE'' value.' supplyAccountNumber: type: string description: '"Account #" from Vendor setup screen. If the field value is null, the previously saved value will remain. To erase it, please enter ''#DELETE'' value.' supplyActive: type: string example: N description: '"Active" flag from Vendor setup screen. If the field value is null, the previously saved value will remain. To erase it, please enter ''#DELETE'' value.' supplyAddress1: type: string description: '"Address 1" from Vendor setup screen' supplyAddress2: type: string description: '"Address 2" from Vendor setup screen. If the field value is null, the previously saved value will remain. To erase it, please enter ''#DELETE'' value.' supplyBidPath: type: string example: Fax description: '"Bid Mode" from Vendor setup screen. If the field value is null, the previously saved value will remain. To erase it, please enter ''#DELETE'' value.' enum: - CT Xchange - E-Mail Excel File - E-Mail PDF - E-Mail Text - Fax - Phone supplyCityName: type: string description: '"City" from Vendor setup screen' supplyCode: type: string example: '000222' description: Vendor "Code" from Vendor setup screen supplyEmail: type: string example: w@Q.co description: '"Vendor E-Mail" from Vendor setup screen. If the field value is null, the previously saved value will remain. To erase it, please enter ''#DELETE'' value.' supplyFax: type: string example: 1234567890 description: '"Fax" from Vendor setup screen. If the field value is null, the previously saved value will remain. To erase it, please enter ''#DELETE'' value.' supplyIntranet: type: string example: 1 description: '"Intranet Number" from Vendor setup screen. If the field value is null, the previously saved value will remain. To erase it, please enter ''#DELETE'' value.' supplyLeadPeriod: type: object example: 999999 description: '"Lead Period" from Vendor setup screen. If the field value is null, the previously saved value will remain. To erase it, please enter ''#DELETE'' value.' supplyName: type: string example: My Supply Company description: Vendor "Name" from Vendor setup screen supplyOrderPath: type: string example: 12ww description: '"Order Path" from Vendor setup screen. If the field value is null, the previously saved value will remain. To erase it, please enter ''#DELETE'' value.' supplyPhone: type: string example: 123-456-7890 description: '"Phone" from Vendor setup screen. If the field value is null, the previously saved value will remain. To erase it, please enter ''#DELETE'' value.' supplySalesmanFax: type: string example: 76768788787 description: '"Fax" from Vendor Contact Info. If the field value is null, the previously saved value will remain. To erase it, please enter ''#DELETE'' value.' supplySalesmanFullName: type: string example: John description: '"Name" from Vendor Contact Info. If the field value is null, the previously saved value will remain. To erase it, please enter ''#DELETE'' value.' supplySalesmanHomePhone: type: string example: 57576878 description: '"Home Phone" from Vendor Contact Info. If the field value is null, the previously saved value will remain. To erase it, please enter ''#DELETE'' value.' supplySalesmanPhone: type: string example: 675543453 description: '"Business Phone" from Vendor Contact Info. If the field value is null, the previously saved value will remain. To erase it, please enter ''#DELETE'' value.' supplySalesmanTitle: type: string example: Doe description: '"Title" from Vendor Contact Info. If the field value is null, the previously saved value will remain. To erase it, please enter ''#DELETE'' value.' supplySatellite: type: string example: 11@gmail.com description: '"VO E-mail" from Vendor setup screen. Required if Bid Mode is 1 (E-Mail PDF), 2 (E-Mail Text), 3 (E-Mail Excel) or 9 (E-Mail PDF - Custom) (any of the E-Mail options). (Not required if it is null or any other option). If the field value is null, the previously saved value will remain. To erase it, please enter ''#DELETE'' value.' supplyStateShortName: type: string example: MA description: '"State/Province Abbreviation" from Vendor setup screen. If the field value is null, the previously saved value will remain. To erase it, please enter ''#DELETE'' value.' supplyStateFullName: type: string example: Massachusetts description: '"State/Province Name" from Vendor setup screen.' supplyTerms: type: string example: Terms description: '"Terms" from Vendor setup screen. If the field value is null, the previously saved value will remain. To erase it, please enter ''#DELETE'' value.' supplyTransmitMethod: type: string example: STND description: '"Interface" from Vendor setup screen. Required if VO Mode is FTP (5) or Web Services (8), but the system will use the default value of "STANDARD", if it is not provided or is not a valid value (1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11). If the field value is null, the previously saved value will remain. To erase it, please enter ''#DELETE'' value.' enum: - ALNT - AMPH - COI - CTVP - DCLO - DLA - DTLH - FPRO - MS90 - N/A - PFG - PFGC - SAVL - STND - SYSC supplyTransmitPath: type: string example: PHONE description: '"VO Mode" from Vendor setup screen. If the field value is null, the previously saved value will remain. To erase it, please enter ''#DELETE'' value.' enum: - E-Mail Excel - E-Mail PDF - E-Mail PDF - Custom - E-Mail Text - FTP - Fax - Phone - Secure FTP - Web Services supplyWebAddress: type: string example: abc@def.com description: '"URL" from Vendor setup screen. Required if VO Mode is 5 (FTP) or 6 (Secure FTP) or Interface is US Foods (1). (Not required if it is null or any other option). If the field value is null, the previously saved value will remain. To erase it, please enter ''#DELETE'' value.' supplyZip: type: string example: 1223 description: '"Zip" Code from Vendor setup screen. If the field value is null, the previously saved value will remain. To erase it, please enter ''#DELETE'' value.' taxId: type: string example: Tax ID description: '"Tax ID" from Vendor setup screen. If the field value is null, the previously saved value will remain. To erase it, please enter ''#DELETE'' value.' updateBidsVarianceFromLast: type: object example: 1 description: '"Do Not Allow Auto-Bid Processing to Update Vendor Bids When Variance from Last Bid > x %" from Vendor Pricing Rules. If the field value is null, the previously saved value will remain. To erase it, please enter ''#DELETE'' value.' voFax: type: string example: 1292348059 description: '"VO Fax" from Vendor setup screen. Required if VO Mode is 4 (Fax). (Not required if it is null or any other option). If the field value is null, the previously saved value will remain. To erase it, please enter ''#DELETE'' value.' vendorUdaDetails: type: array items: $ref: '#/components/schemas/vendorUdaDetail' title: VendorGetDto 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 x-refined-from: - crunchtime-cruise-platform-openapi.yml - crunchtime-inventory-labor-openapi.yml 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-1.md - https://developer.crunchtime.com/reference/getallapplicationusersv1usingget-1.md - https://developer.crunchtime.com/reference/getallcompanyproductsenhancedv1usingget-1.md - https://developer.crunchtime.com/reference/getallcurrencyratiov1usingget_1.md - https://developer.crunchtime.com/reference/getallcustomerrecordsv1usingget-1.md - https://developer.crunchtime.com/reference/getallgeneralledgersv1usingget-1.md - https://developer.crunchtime.com/reference/getallinventoryadjustmentv1usingget-1.md - https://developer.crunchtime.com/reference/getallinventoryvalueadjustmentv1usingget-1.md - https://developer.crunchtime.com/reference/getalllocationproductpricingv1usingget-1.md - https://developer.crunchtime.com/reference/getalllocationsv1usingget-1.md - https://developer.crunchtime.com/reference/getallphysicalinventorystandardusingget-1.md - https://developer.crunchtime.com/reference/getallprojectedconsumptionv1usingget-1.md - https://developer.crunchtime.com/reference/getallrecipesenhancedv1usingget_1.md - https://developer.crunchtime.com/reference/getallscheduledexportsv1usingget-1.md - https://developer.crunchtime.com/reference/getallvendorlocationv1usingget-1.md - https://developer.crunchtime.com/reference/getallvendorsv1usingget-1.md - https://developer.crunchtime.com/reference/getapplicationusersbypagev1usingget-1.md - https://developer.crunchtime.com/reference/getcompanyproductsenhancedbypagev1usingget-1.md - https://developer.crunchtime.com/reference/getcurrencyratiobypagev1usingget_1.md - https://developer.crunchtime.com/reference/getcustomerrecordsbypagev1usingget-1.md - https://developer.crunchtime.com/reference/gethierarchiesv1usingget.md - https://developer.crunchtime.com/reference/gethierarchydetailsv1usingget.md - https://developer.crunchtime.com/reference/getinventoryadjustmentbypagev1usingget-1.md - https://developer.crunchtime.com/reference/getinventoryvalueadjustmentbypagev1usingget-1.md - https://developer.crunchtime.com/reference/getlocationproductpricingbypagev1usingget-1.md - https://developer.crunchtime.com/reference/getlocationsbypagev1usingget-1.md - https://developer.crunchtime.com/reference/getphysicalinventorystandardbypagev1usingget-1.md - https://developer.crunchtime.com/reference/getprojectedconsumptionbypagev1usingget-1.md - https://developer.crunchtime.com/reference/getrecipesenhancedbypagev1usingget_1.md - https://developer.crunchtime.com/reference/getvendorlocationbypagev1usingget-1.md - https://developer.crunchtime.com/reference/markscheduledexportsv1usingput-1.md - https://developer.crunchtime.com/reference/saveapplicationusersv1usingpost-1.md - https://developer.crunchtime.com/reference/savecompanyproductenhancedv1usingpost-1.md - https://developer.crunchtime.com/reference/savecurrencyratiousingpost_1.md - https://developer.crunchtime.com/reference/savecustomerrecordsusingpost-1.md - https://developer.crunchtime.com/reference/savegeneralledgerv1usingpost-1.md - https://developer.crunchtime.com/reference/savehierarchyv1usingpost.md - https://developer.crunchtime.com/reference/saveinventoryadjustmentusingpost-1.md - https://developer.crunchtime.com/reference/saveinventoryvalueadjustmentusingpost-1.md - https://developer.crunchtime.com/reference/savelocationproductpricingusingpost-1.md - https://developer.crunchtime.com/reference/savelocationv1usingpost-1.md - https://developer.crunchtime.com/reference/savephysicalinventorystandardusingpost-1.md - https://developer.crunchtime.com/reference/saveprojectedconsumptionusingpost-1.md - https://developer.crunchtime.com/reference/saverecipesusingpost_1.md - https://developer.crunchtime.com/reference/savevendorlocationv1usingpost-1.md - https://developer.crunchtime.com/reference/savevendorv1usingpost-1.md merge: pages: 46 deduped: 167 conflicts_kept_first: 0