Sign in

v1

latestOpenAPI 3.0.0Apache License Version 2.02026-07-24163274903.6 KB
Vendor Service

getAllVendorsV1

Retrieves a list of all vendors.

get/vendor/v1/getAllVendors

Query parameters

activeFlagboolean

Active vendors.

minutesSinceUpdateinteger

The number of minutes since a vendor record was last updated. Use to set how far back to search.

includeNullboolean

Specify 'true' to output null data elements.

Headers

authenticationtokenstring required

Secure token for API authentication.

passwordstring required

Password for the Crunchtime Application User.

sitenamestring required

Crunchtime site identifier. (test or production)

useridstring required

User ID for the Crunchtime Application User.

X-B3-TraceIdstring

Optional trace identifier for troubleshooting.

Response

Success

accrualFlagstring

"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.

allowDuplicateInvoicesFlagstring

"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.

allowDuplicatePoNumberFlagstring

"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.

allowPbiFlagstring

"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.

allowSimpleReceiptFlagstring

"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.

altAddress1string

"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.

altAddress2string

"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.

altCityNamestring

"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.

altFaxstring

"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.

altPhonestring

"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.

altStateShortNamestring

"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.

altZipstring

"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.

autoProcessNewBidFileFlagstring

"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.

autoReconcileEinvoiceFlagstring

"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.

batchIdinteger
certificateExpireDatestring date-time

"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.

certificateNumberstring

"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.

codFlagstring

"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.

countryCodestring

"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.

countryNamestring

"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.

createNewBidProductsFlagstring

"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.

currencyCodestring required

"Base Currency" Code from Vendor setup screen

electronicInvoiceFlagstring

"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.

exportCodestring

"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.

haccpCertifiedFlagstring

"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.

internalFlagstring

"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.

priceIncludesTaxstring

"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.

supplyAccountNumberstring

"Account #" from Vendor setup screen. If the field value is null, the previously saved value will remain. To erase it, please enter '#DELETE' value.

supplyActivestring

"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.

supplyAddress1string required

"Address 1" from Vendor setup screen

supplyAddress2string

"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'CT Xchange' | 'E-Mail Excel File' | 'E-Mail PDF' | 'E-Mail Text' | 'Fax' | 'Phone'

"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.

supplyCityNamestring required

"City" from Vendor setup screen

supplyCodestring required

Vendor "Code" from Vendor setup screen

supplyEmailstring

"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.

supplyFaxstring

"Fax" from Vendor setup screen. If the field value is null, the previously saved value will remain. To erase it, please enter '#DELETE' value.

supplyIntranetstring

"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.

supplyLeadPeriodobject

"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.

supplyNamestring required

Vendor "Name" from Vendor setup screen

supplyOrderPathstring

"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.

supplyPhonestring

"Phone" from Vendor setup screen. If the field value is null, the previously saved value will remain. To erase it, please enter '#DELETE' value.

supplySalesmanFaxstring

"Fax" from Vendor Contact Info. If the field value is null, the previously saved value will remain. To erase it, please enter '#DELETE' value.

supplySalesmanFullNamestring

"Name" from Vendor Contact Info. If the field value is null, the previously saved value will remain. To erase it, please enter '#DELETE' value.

supplySalesmanHomePhonestring

"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.

supplySalesmanPhonestring

"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.

supplySalesmanTitlestring

"Title" from Vendor Contact Info. If the field value is null, the previously saved value will remain. To erase it, please enter '#DELETE' value.

supplySatellitestring

"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.

supplyStateShortNamestring

"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.

supplyStateFullNamestring

"State/Province Name" from Vendor setup screen.

supplyTermsstring

"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'ALNT' | 'AMPH' | 'COI' | 'CTVP' | 'DCLO' | 'DLA' | 'DTLH' | 'FPRO' | 'MS90' | 'N/A' | 'PFG' | 'PFGC' | 'SAVL' | 'STND' | 'SYSC'

"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.

supplyTransmitPath'E-Mail Excel' | 'E-Mail PDF' | 'E-Mail PDF - Custom' | 'E-Mail Text' | 'FTP' | 'Fax' | 'Phone' | 'Secure FTP' | 'Web Services'

"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.

supplyWebAddressstring

"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.

supplyZipstring

"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.

taxIdstring

"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.

updateBidsVarianceFromLastobject

"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.

voFaxstring

"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.

Example response

[
  {
    "accrualFlag": "Y",
    "allowDuplicateInvoicesFlag": "N",
    "allowDuplicatePoNumberFlag": "N",
    "allowPbiFlag": "Y",
    "allowSimpleReceiptFlag": "Y",
    "altAddress1": "123 Central Avenue",
    "altAddress2": "Suite 1",
    "altCityName": "Rockville",
    "altStateShortName": "MD",
    "autoProcessNewBidFileFlag": "Y",
    "autoReconcileEinvoiceFlag": "Y",
    "codFlag": "Y",
    "countryCode": "US",
    "countryName": "UNITED STATES",
    "createNewBidProductsFlag": "N",
    "currencyCode": "AFA",
    "electronicInvoiceFlag": "N",
    "haccpCertifiedFlag": "N",
    "internalFlag": "Y",
    "priceIncludesTax": "Y",
    "supplyActive": "N",
    "supplyBidPath": "Fax",
    "supplyCode": "000222",
    "supplyEmail": "w@Q.co",
    "supplyName": "My Supply Company",
    "supplyOrderPath": "12ww",
    "supplyPhone": "123-456-7890",
    "supplySalesmanFullName": "John",
    "supplySalesmanTitle": "Doe",
    "supplySatellite": "11@gmail.com",
    "supplyStateShortName": "MA",
    "supplyStateFullName": "Massachusetts",
    "supplyTerms": "Terms",
    "supplyTransmitMethod": "STND",
    "supplyTransmitPath": "PHONE",
    "supplyWebAddress": "abc@def.com",
    "taxId": "Tax ID",
    "vendorUdaDetails": [
      {
        "supplyCode": "627",
        "udaCode": "PAYMENT_TYPE",
        "udaDescription": "Mode of payment accepted by vendor",
        "dataType": "CHAR",
        "udaType": "VENDOR",
        "udaGroup": "USERDEFINED",
        "requiredFlag": "N",
        "udaValue": "charge card",
        "replicatedFlag": "N",
        "lastTouchDate": "06/04/2025"
      }
    ]
  }
]