Crunchtime Information Systems Electronic Invoice Service API

openapi: 3.2.0
info:
  description: Swagger documentation supporting mobile development of Crunchtime.
  version: '2.99'
  title: Inventory & Labor Electronic Invoice 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: Electronic Invoice Service
  description: The Electronic Invoice service enables you to upload e-invoice data into Crunchtime.
paths:
  /electronicinvoice/v1/saveElectronicInvoice:
    post:
      tags:
      - Electronic Invoice Service
      summary: saveElectronicInvoice
      description: Uploads e-invoice data for vendor orders.
      operationId: saveElectronicInvoiceUsingPOST
      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/ElectronicInvoiceDetailsList'
        description: electronicInvoiceDetails
        required: true
      responses:
        '200':
          description: Success
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ElectronicInvoiceDetailsList'
            application/json:
              schema:
                $ref: '#/components/schemas/ElectronicInvoiceDetailsList'
        '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
        '404':
          description: electronic invoice not found
          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: Service Unavailable
          content:
            '*/*':
              schema:
                type: string
            application/json:
              schema:
                type: string
        '504':
          description: Timeout
          content:
            '*/*':
              schema:
                type: string
            application/json:
              schema:
                type: string
components:
  schemas:
    ElectronicInvoiceDetailsList:
      type: object
      properties:
        electronicInvoiceDetails:
          type: array
          items:
            $ref: '#/components/schemas/ElectronicInvoiceDetails'
        locationCode:
          type: string
      title: ElectronicInvoiceDetailsList
      description: ElectronicInvoiceDetailsList description
    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
    ElectronicInvoiceDetailsDto:
      type: object
      required:
      - vendorProductNumber
      properties:
        catchWeightInd:
          type: string
          example: Y
          description: Indicates whether the “Invoice Quantity” and “Invoice Price” are in Vendor Units (‘N’) or Inventory Units (‘Y’). If left blank, will be interpreted as ‘N’.
        creditValue:
          type: string
          example: 18
          description: Value of any credit that should be applied to the Extended Value of the line item to adjust the Invoice Price.
        extendedValue:
          type: string
          example: 9999.9999
          description: The Total Invoice Value of the line item. Should be equal to [(Invoice Quantity x Invoice Price) + Tax Value].
        invoicePrice:
          type: string
          example: 9999.9999
          description: The vendor's Invoice Price for the product line item.
        invoiceQuantity:
          type: string
          example: 9999.9999
          description: The vendor's Invoice Quantity for the product line item.
        lotNumber:
          type: string
          example: 165R-13593
          description: The Lot Number associated with the product.
        manufacturerNumber:
          type: string
          example: MAN123
          description: The Manufacturer's Number for the product.
        productBrand:
          type: string
          example: Nestle
          description: The manufacturer's Brand for the product.
        splitIndicator:
          type: string
          example: Y
          description: Indicates a Split Unit or Substitute Vendor Product ('Y' or 'N') as defined on the Vendor Bids screen.
        subsIndicator:
          type: string
          example: Y
          description: Indicates whether the Vendor Product on the original order has been substituted ('Y' or 'N') with a different vendor product.
        subsPackageConversion:
          type: string
          example: 1
          description: The Vendor's Conversion for the substitute product. This is the number of Inventory Units in 1 Substitute Vendor Product Unit.
        subsProductName:
          type: string
          example: FUEL CHARGE - FOOD_EM
          description: The Vendor's Product Name for the substitute product.
        subsProductNumber:
          type: string
          example: 20342
          description: The Vendor's Product Number for the substitute product.
        subsProductPackageType:
          type: string
          example: CASE
          description: The Vendor's Package Type/Unit for the substitute product.
        taxValue:
          type: string
          example: 0.2
          description: The line item Tax Value for the product.
        traceabilityCode:
          type: string
          example: BFCA179A152023213
          description: The Traceability Code for the product.
        traceabilityCodeSource:
          type: string
          example: FoodTraceability, Inc. 123 Main Street Anytown, PA 12345 (222) 123-4567
          description: The Traceability Code Source for the product.
        vendorPortalId:
          type: string
          description: The Vendor Portal ID.
        vendorProductNumber:
          type: string
          description: The Vendor's Product Number for the product line item.
      title: ElectronicInvoiceDetailsDto
      description: ElectronicInvoiceDetailsDto description
    ElectronicInvoiceDetails:
      type: object
      properties:
        electronicInvoiceDetailRowList:
          type: array
          items:
            $ref: '#/components/schemas/ElectronicInvoiceDetailsDto'
        electronicInvoiceHeaderDetails:
          $ref: '#/components/schemas/ElectronicInvoiceHeaderDto'
      title: ElectronicInvoiceDetails
      description: ElectronicInvoiceDetails description
    ElectronicInvoiceHeaderDto:
      type: object
      required:
      - expectedDeliveryDate
      - invoiceDate
      - locationCode
      - vendorCode
      properties:
        expectedDeliveryDate:
          type: string
          example: MM/dd/yyyy
          description: The Expected Delivery Date for the order.
        invoiceDate:
          type: string
          example: 12/13/2024
          description: The vendor's Invoice Date for the order.
        invoiceValue:
          type: string
          example: 1.12
          description: The Total Invoice Value for the order.
        locationCode:
          type: string
          example: '000011'
          description: The Code for the Location associated with the order.
        misc1Amount:
          type: string
          example: 1122
          description: The amount of the Misc. 1 charge for the order.
        misc1GlDescription:
          type: string
          example: Misc1
          description: The GL account associated with the Misc. 1 charge for the order.
        misc2Amount:
          type: string
          example: 2
          description: The amount of the Misc. 2 charge for the order.
        misc2GlDescription:
          type: string
          example: Misc2
          description: The GL account associated with the Misc. 2 charge for the order.
        shippingAmount:
          type: string
          example: 2
          description: The amount of the Freight/Shipping charge for the order.
        shippingGlDescription:
          type: string
          example: 5200
          description: The GL account associated with the Freight/Shipping charge for the order.
        taxAmount:
          type: string
          example: 2
          description: The amount of the Tax charged for the order.
        taxGlDescription:
          type: string
          example: Tax
          description: The GL account associated with the Tax charged for the order.
        transactionNumber:
          type: string
          example: vo-10050
          description: The Transaction Number for the order. Only required if updating an existing vendor order.
        vendorCode:
          type: string
          example: vendorCode
          description: The Code for the vendor associated with the order.
        vendorInvoiceNumber:
          type: string
          example: 91
          description: The vendor's Invoice Number for the order.
      title: ElectronicInvoiceHeaderDto
      description: ElectronicInvoiceHeaderDto description
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