Crunchtime General Ledger Service API

openapi: 3.2.0
info:
  title: Crunchtime General Ledger 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 General Ledger 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: General Ledger Service
  description: The General Ledger services allows the Crunchtime applications to be aligned with the company’s accounting and bookkeeping systems. General Ledger codes and descriptions are associated with P&L groupings and substructures.
paths:
  /cruise/generalledger/v1/getAllGeneralLedgers:
    get:
      tags:
      - General Ledger Service
      summary: getAllGeneralLedgersV1
      description: Retrieve all general ledger entry details.
      operationId: getAllGeneralLedgersV1UsingGET
      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
      - 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/GeneralLedgerDto'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/GeneralLedgerDto'
        '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/generalledger/v1/saveGeneralLedger:
    post:
      tags:
      - General Ledger Service
      summary: saveGeneralLedgerV1
      description: 'Create a new general ledger entry.

        Update a general ledger entry.'
      operationId: saveGeneralLedgerV1UsingPOST
      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/GeneralLedgerDetails'
        description: generalLedgerDetails
        required: true
      responses:
        '200':
          description: Success
          content:
            '*/*':
              schema:
                type: object
            application/json:
              schema:
                type: object
        '207':
          description: Partial Success
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/GeneralLedgerDto'
            application/json:
              schema:
                $ref: '#/components/schemas/GeneralLedgerDto'
        '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
  /generalledger/v1/getAllGeneralLedgers:
    get:
      tags:
      - General Ledger Service
      summary: getAllGeneralLedgersV1
      description: Retrieve all general ledger entry details.
      operationId: getGeneralledgerV1GetAllGeneralLedgers
      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
      - 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/GeneralLedgerDto'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/GeneralLedgerDto'
        '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: getAllGeneralLedgersV1UsingGET
    servers:
    - url: //webservices-test.net-chef.com
  /generalledger/v1/saveGeneralLedger:
    post:
      tags:
      - General Ledger Service
      summary: saveGeneralLedgerV1
      description: 'Create a new general ledger entry.

        Update a general ledger entry.'
      operationId: postGeneralledgerV1SaveGeneralLedger
      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/GeneralLedgerDetails'
        description: generalLedgerDetails
        required: true
      responses:
        '200':
          description: Success
          content:
            '*/*':
              schema:
                type: object
            application/json:
              schema:
                type: object
        '207':
          description: Partial Success
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/GeneralLedgerDto'
            application/json:
              schema:
                $ref: '#/components/schemas/GeneralLedgerDto'
        '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: saveGeneralLedgerV1UsingPOST
    servers:
    - url: //webservices-test.net-chef.com
components:
  schemas:
    GeneralLedgerDetails:
      type: object
      properties:
        generalLedgers:
          type: array
          items:
            $ref: '#/components/schemas/GeneralLedgerDto'
      title: GeneralLedgerDetails
    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
    GeneralLedgerDto:
      type: object
      required:
      - allocatedExpenses
      - glDescription
      - glNumber
      - glSubstructure
      - pbiFlag
      - plGrouping
      - voFlag
      properties:
        active:
          type: boolean
        allocatedExpenses:
          type: boolean
          example: false
          description: '"allocatedExpenses" from GeneralLedger setup screen.'
        batchId:
          type: integer
          format: int64
        glDescription:
          type: string
          example: '#44444'
          description: '"glDescription" from GeneralLedger setup screen'
        glForReport:
          type: boolean
        glNumber:
          type: string
          example: 123456
          description: '"glNumber" from GeneralLedger setup screen'
        glNumberForCGS:
          type: string
          example: 123456
          description: '"glNumberForCGS" from GeneralLedger setup screen.  Cost of Goods GL Code.'
        glNumberForSales:
          type: string
          example: 123456
          description: '"glNumberForSales" from GeneralLedger setup screen.  Sales GL Code.'
        glSubstructure:
          type: string
          example: Cost of Goods
          description: '"glSubstructure" from GeneralLedger setup screen'
        pbiFlag:
          type: boolean
          example: false
          description: '"pbiFlag" from GeneralLedger setup screen.'
        plGrouping:
          type: string
          example: CGS
          description: '"plGrouping" from GeneralLedger setup screen'
        replicated:
          type: boolean
        voFlag:
          type: boolean
          example: false
          description: '"voFlag" from GeneralLedger setup screen.'
      title: GeneralLedgerDto
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