Fulcrumpro Inventory Event API

openapi: 3.2.0
info:
  title: Fulcrum Public Inventory Event API
  version: v1
servers:
- url: https://api.fulcrumpro.com
tags:
- name: Inventory Event
paths:
  /api/inventory-events/{inventoryEventId}:
    get:
      tags:
      - Inventory Event
      summary: Get a specific inventory event
      operationId: GetInventoryEvent
      parameters:
      - name: inventoryEventId
        in: path
        required: true
        schema:
          maxLength: 24
          minLength: 24
          type: string
      responses:
        '200':
          description: The inventory event for the given id
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InventoryEventsInventoryEventDto'
            application/problem+json:
              schema:
                $ref: '#/components/schemas/InventoryEventsInventoryEventDto'
        '404':
          description: Inventory event did not exist, or the caller may not see it
      x-c4-exposed: true
      x-c4-required-permissions:
      - ItemsAndInventory-Items-View Inventory
  /api/inventory-events/list:
    post:
      tags:
      - Inventory Event
      summary: Find inventory events based on search parameters
      operationId: ListInventoryEvent
      parameters:
      - name: Sort.Field
        in: query
        description: Sort field
        schema:
          minLength: 1
          type: string
      - name: Sort.Dir
        in: query
        description: Sort direction
        schema:
          $ref: '#/components/schemas/CommonEnumSortDirectionEnum'
      - name: Skip
        in: query
        description: 'Number of records to skip. Defaults to 0. Combine with FulcrumProduct.PublicApi.Dto.Common.PagingDto.Take to page

          through a result set larger than one page.'
        schema:
          minimum: 0
          type: integer
          format: int32
      - name: Take
        in: query
        description: 'Number of records to return. Validation accepts 0 through 5000, but `0` is not a

          page size and what an endpoint does with it varies, so send a value from 1 to 5000.


          Two cases differ. A request that supplies paging but leaves this field out takes this

          field''s default of <b>50</b>. A request that supplies no paging at all is

          endpoint-specific — some define their own fallback — so it does not reliably mean any

          particular number of records. Either way the response says nothing about records it

          did not return, so send this explicitly whenever the size of the answer matters.

          Endpoints returning a paged envelope report `totalCount` and `hasNextPage`

          alongside the records; endpoints returning a bare array report neither, so page those

          with FulcrumProduct.PublicApi.Dto.Common.PagingDto.Skip until a page comes back shorter than the value requested.'
        schema:
          maximum: 5000
          minimum: 0
          type: integer
          format: int32
      requestBody:
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/InventoryEventRequestFindParameters'
          application/json:
            schema:
              $ref: '#/components/schemas/InventoryEventRequestFindParameters'
          text/json:
            schema:
              $ref: '#/components/schemas/InventoryEventRequestFindParameters'
          application/*+json:
            schema:
              $ref: '#/components/schemas/InventoryEventRequestFindParameters'
      responses:
        '200':
          description: List of inventory events matching the filters
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DtoPagedResultDtoInventoryEventsInventoryEventDto'
            application/problem+json:
              schema:
                $ref: '#/components/schemas/DtoPagedResultDtoInventoryEventsInventoryEventDto'
      x-c4-exposed: true
      x-c4-required-permissions:
      - ItemsAndInventory-Items-View Inventory
components:
  schemas:
    InventoryEventSecondaryType:
      enum:
      - pick
      - receive
      - override
      - revert
      - deposit
      - create
      - consume
      - ship
      - sold
      - transferOut
      - transferIn
      - found
      - expired
      - damaged
      - lost
      - returnVendor
      - returnStock
      - receivedNoPo
      - returnIncrease
      - returnDecrease
      - otherIncrease
      - otherDecrease
      - scrap
      - waste
      - transferredFromSalesOrder
      - overrideItemValue
      - transferFromLot
      - transferToLot
      - stockAdjustmentIncrease
      - stockAdjustmentDecrease
      - stockTake
      type: string
      description: Secondary, verbose description for an event.
    CommonEnumSortDirectionEnum:
      enum:
      - ascending
      - descending
      type: string
      description: Specify sorting direction.
    DtoInventoryEventsInventoryEventChangeDetails:
      required:
      - quantity
      - transactionId
      type: object
      properties:
        transactionId:
          maxLength: 24
          minLength: 24
          type: string
          description: The resulting "transaction" id. Please reference /api/inventory-transactions endpoint.
        quantity:
          type: number
          description: Quantity
          format: double
        quantityChangeType:
          $ref: '#/components/schemas/V2InventoryRestResourcesTransactionChangeType'
        laborValue:
          $ref: '#/components/schemas/CommonCostDto'
        machineValue:
          $ref: '#/components/schemas/CommonCostDto'
        outsideProcessingValue:
          $ref: '#/components/schemas/CommonCostDto'
        materialValue:
          $ref: '#/components/schemas/CommonCostDto'
        totalValue:
          $ref: '#/components/schemas/CommonCostDto'
        netValueChange:
          $ref: '#/components/schemas/CommonCostDto'
      additionalProperties: false
      description: Inventory event change information.
    InventoryEventRequestFindParameters:
      type: object
      properties:
        createdBeforeUtc:
          type:
          - string
          - 'null'
          description: Filters events created before (exclusive) this parameter in UTC time. If no time component is passed, midnight UTC will be used.
          format: date-time
        createdAfterUtc:
          type:
          - string
          - 'null'
          description: Filters events created after (exclusive) this parameter in UTC time. If no time component is passed, midnight UTC will be used.
          format: date-time
        types:
          minItems: 1
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/InventoryEventType'
          description: Inventory event type(s).
        secondaryTypes:
          minItems: 1
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/InventoryEventSecondaryType'
          description: Inventory event secondary type(s).
        sourceTypes:
          minItems: 1
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/InventoryEnumEventSourceType'
          description: Inventory event source type(s).
        itemIds:
          minItems: 1
          type:
          - array
          - 'null'
          items:
            type: string
          description: Item id. Please reference /api/items endpoint.
        itemToMakeIds:
          minItems: 1
          type:
          - array
          - 'null'
          items:
            type: string
          description: Item id. Please reference /api/items endpoint.
        reservedForTypes:
          minItems: 1
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/DomainCommonEntityType'
          description: Inventory reservation types.
        reservedForIds:
          minItems: 1
          type:
          - array
          - 'null'
          items:
            type: string
          description: Inventory reservation ids.
        inventoryEventIds:
          minItems: 1
          type:
          - array
          - 'null'
          items:
            type: string
          description: Inventory event ids.
        actionDateFrom:
          type:
          - string
          - 'null'
          description: 'Filter to events whose action date falls on or after this date, as a whole day in the shop''s

            timezone. Any time component is ignored.'
          format: date-time
        actionDateTo:
          type:
          - string
          - 'null'
          description: 'Filter to events whose action date falls on or before this date, as a whole day in the shop''s

            timezone, so an event actioned later that same shop day still matches.'
          format: date-time
      additionalProperties: false
      description: Parameters used for searching/finding inventory.
    InventoryEventType:
      enum:
      - pick
      - receive
      - revert
      - adjustment
      - setItemValue
      - eventOverride
      type: string
      description: Primary inventory event type.
    V2InventoryRestResourcesTransactionChangeType:
      enum:
      - increase
      - decrease
      - static
      type: string
    DomainCommonEntityType:
      enum:
      - job
      - salesOrder
      - shipment
      - shipmentLineItem
      - invoice
      - invoiceLineItem
      - customer
      - customerAddress
      - item
      - receivingInspection
      - failedInspection
      type: string
    CommonCostDto:
      required:
      - perUnit
      - total
      type: object
      properties:
        total:
          minimum: 0
          type: number
          description: Total
          format: double
        perUnit:
          minimum: 0
          type: number
          description: Cost per unit
          format: double
      additionalProperties: false
      description: Cost information
    InventoryEnumEventSourceType:
      enum:
      - purchaseOrder
      - job
      - shipment
      - shipmentLineItem
      - shipping
      - receiving
      - item
      - workOrder
      - salesOrder
      - jobOperation
      - workOrderOperation
      - fulfillment
      - itemToMakeMaterialRemnant
      - poRcvValueAdj
      type: string
      description: Indicator for the initial source of the event.
    InventoryEventsInventoryEventDto:
      required:
      - id
      - quantity
      - type
      type: object
      properties:
        id:
          maxLength: 36
          minLength: 36
          type: string
          description: Id
        actionDate:
          type:
          - string
          - 'null'
          description: The date of the action.
          format: date-time
        type:
          $ref: '#/components/schemas/InventoryEventType'
        secondaryType:
          $ref: '#/components/schemas/InventoryEventSecondaryType'
        sourceType:
          $ref: '#/components/schemas/InventoryEnumEventSourceType'
        sourceName:
          type:
          - string
          - 'null'
          description: Source name.
        sourceEntityId:
          type:
          - string
          - 'null'
          description: Source entity id
        sourceRelatedType:
          $ref: '#/components/schemas/InventoryEnumEventSourceType'
        sourceRelatedEntityId:
          type:
          - string
          - 'null'
          description: Related source entity id
        sourceItemToMakeId:
          type:
          - string
          - 'null'
          description: Source item to make id. Please reference /api/jobs/{jobId}/items-to-make endpoint.
        itemId:
          maxLength: 24
          minLength: 24
          type:
          - string
          - 'null'
          description: Item id key identifier. Please reference /api/items endpoint.
        itemToMakeId:
          maxLength: 36
          minLength: 36
          type:
          - string
          - 'null'
          description: Item to make id key identifier. Please reference /api/jobs/{jobId}/items-to-make endpoint.
        quantity:
          minimum: 0
          type: number
          description: Quantity.
          format: double
        laborValue:
          $ref: '#/components/schemas/CommonCostDto'
        machineValue:
          $ref: '#/components/schemas/CommonCostDto'
        outsideProcessingValue:
          $ref: '#/components/schemas/CommonCostDto'
        materialValue:
          $ref: '#/components/schemas/CommonCostDto'
        totalValue:
          $ref: '#/components/schemas/CommonCostDto'
        reservedForId:
          maxLength: 36
          minLength: 24
          type:
          - string
          - 'null'
          description: This is the id for the underlying entity that this inventory is reserved for.
        reservedForType:
          $ref: '#/components/schemas/DomainCommonEntityType'
        lotId:
          maxLength: 24
          minLength: 24
          type:
          - string
          - 'null'
          description: The lot this inventory is allocated to. Please reference /api/inventory-lots endpoint.
        locationId:
          maxLength: 24
          minLength: 24
          type:
          - string
          - 'null'
          description: The location this inventory is allocated to. Please reference /api/locations endpoint.
        revertInventoryEventId:
          maxLength: 24
          minLength: 24
          type:
          - string
          - 'null'
          description: If the event is intended to "revert" a previous transaction, this value contains the original event.
        note:
          maxLength: 2000
          minLength: 1
          type:
          - string
          - 'null'
          description: A note associated to this event.
        resultEffects:
          $ref: '#/components/schemas/DtoInventoryEventsInventoryEventChangeDetails'
        details:
          $ref: '#/components/schemas/InventoryEventDetailsDto'
      additionalProperties: false
      description: An inventory event
    CommonExternalReferenceDto:
      required:
      - externalId
      type: object
      properties:
        type:
          maxLength: 50
          minLength: 0
          type:
          - string
          - 'null'
          description: Specifies the type of this identifier.
        externalId:
          maxLength: 500
          minLength: 0
          type: string
          description: The external identifier
        displayId:
          maxLength: 500
          minLength: 0
          type:
          - string
          - 'null'
          description: 'The id/number that a human sees. For a quote, this might be ''Q1000''.  If this is null, the display

            will fall back to the ExternalId'
        status:
          type:
          - string
          - 'null'
          description: A status for the external reference
        url:
          type:
          - string
          - 'null'
          description: An external url for the reference
        modifiedUtc:
          type:
          - string
          - 'null'
          description: Date the external reference was modified
          format: date-time
        lastSyncedUtc:
          type:
          - string
          - 'null'
          description: 'Date the external system last successfully synced this reference. Set by integrations

            on successful sync only; null means never synced or that the sync timestamp isn''t

            maintained by the integration.'
          format: date-time
      additionalProperties: false
      description: The external reference for entities that implement FulcrumProduct.Domain.Common.IHasExternalReferences
    DtoPagedResultDtoInventoryEventsInventoryEventDto:
      required:
      - data
      - hasNextPage
      - hasPreviousPage
      - page
      - pageSize
      - totalCount
      - totalPages
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/InventoryEventsInventoryEventDto'
          description: The data
        page:
          type: integer
          description: The 1-indexed page
          format: int32
          readOnly: true
        pageSize:
          type: integer
          description: The page size
          format: int32
          readOnly: true
        totalCount:
          type: integer
          description: The total count of records
          format: int32
        totalPages:
          type: integer
          description: The total pages
          format: int32
          readOnly: true
        hasPreviousPage:
          type: boolean
          description: True if there is a previous page
          readOnly: true
        hasNextPage:
          type: boolean
          description: True if there is a next page
          readOnly: true
      additionalProperties: false
      description: Paged result
    InventoryEventDetailsDto:
      type: object
      properties:
        externalReferences:
          type:
          - object
          - 'null'
          additionalProperties:
            $ref: '#/components/schemas/CommonExternalReferenceDto'
          description: External references associated with this entity.
      additionalProperties: false
      description: 'Inventory event details.

        Additional metadata for Inventory Events.'
  securitySchemes:
    bearer:
      type: http
      description: Your API bearer token generated in System Data > Advanced > Public API Setup
      scheme: bearer
      bearerFormat: JWT
x-tagGroups:
- name: Accounting Code
  tags:
  - Accounting Code
- name: Alert
  tags:
  - Alert
- name: Attachment
  tags:
  - Attachment
  - Attachment Certification
- name: Auth
  tags:
  - Auth
- name: CAPAs
  tags:
  - CAPAs
- name: Change Order
  tags:
  - Change Order
- name: Chart Of Accounts
  tags:
  - Chart Of Accounts
- name: Company Info
  tags:
  - Company Info
- name: Custom Field
  tags:
  - Custom Field
- name: Customer
  tags:
  - Customer
  - Customer Address
  - Customer Contact
- name: Customer Tier
  tags:
  - Customer Tier
- name: Department
  tags:
  - Department
- name: Department Shift
  tags:
  - Department Shift
- name: Equipment
  tags:
  - Equipment
- name: Equipment Downtime
  tags:
  - Equipment Downtime
- name: Gauge Code
  tags:
  - Gauge Code
- name: Grade Code
  tags:
  - Grade Code
- name: InProcessTrackingFieldType
  tags:
  - InProcessTrackingFieldType
- name: Inventory
  tags:
  - Inventory
- name: Inventory Event
  tags:
  - Inventory Event
  - Inventory Event Details
- name: Inventory Lot
  tags:
  - Inventory Lot
- name: Inventory Transactions
  tags:
  - Inventory Transactions
- name: Invoice
  tags:
  - Invoice
  - Invoice Deposit Adjustment Line Item
  - Invoice Deposit Line Item
  - Invoice Discount Line Item
  - Invoice Fee Line Item
  - Invoice Line Item
  - Invoice Note
  - Invoice Part Line Item
  - Invoice Refund Line Item
  - Invoice Shipping Charge Line Item
  - Invoice Tax Line Item
- name: Item
  tags:
  - Item
  - Item Custom Fields
  - Item Customer
  - Item Material Vendor
  - Item PriceBreaks
  - Item Routing
  - Item Vendor
- name: Item Category
  tags:
  - Item Category
- name: Item Class
  tags:
  - Item Class
- name: Item Tag
  tags:
  - Item Tag
- name: Job
  tags:
  - Job
  - Job Custom Fields
  - Job Full Routing
  - Job Part Line Item Full Routing
  - Job Item To Make
  - Job Item To Make Operation
  - Job Message
  - Job Operation
- name: Job Tracking Timers
  tags:
  - Job Tracking Timers
- name: Location
  tags:
  - Location
- name: Material
  tags:
  - Material
  - Material Vendor
- name: Material Code
  tags:
  - Material Code
- name: NCRs
  tags:
  - NCRs
- name: Nesting
  tags:
  - Nesting
- name: Note
  tags:
  - Note
- name: Operation
  tags:
  - Operation
- name: Payment Term
  tags:
  - Payment Term
- name: Purchase Order
  tags:
  - Purchase Order
  - Purchase Order Custom Fields
  - Purchase Order Discount Line Item
  - Purchase Order Fee Line Item
  - Purchase Order Line Item
  - Purchase Order Outside Processing Line Item
  - Purchase Order Part Line Item
  - Purchase Order Tax Line Item
  - Purchase Order Vendor Credit Line Item
- name: Quote
  tags:
  - Quote
  - Quote Custom Fields
  - Quote Discount Line Item
  - Quote Fee Line Item
  - Quote Part Line Item
  - Quote Part Line Item Custom Fields
  - Quote Part Line Item Full Routing
  - Quote Tax Line Item
- name: Receiving
  tags:
  - Receiving Receipt
  - Receiving Receipt Line Item
- name: Refund Reason Code
  tags:
  - Refund Reason Code
- name: Reporting
  tags:
  - Reporting
- name: Sales Order
  tags:
  - Sales Order
  - Sales Order Blanket Line Item
  - Sales Order Custom Fields
  - Sales Order Discount Line Item
  - Sales Order Fee Line Item
  - Sales Order Line Item
  - Sales Order Part Line Item
  - Sales Order Part Line Item Custom Fields
  - Sales Order Part Line Item Full Routing
  - Sales Order Refund Line Item
  - Sales Order Shipping Charge Line Item
  - Sales Order Tax Line Item
- name: ScrapReport
  tags:
  - ScrapReport
- name: Settings
  tags:
  - Settings
- name: Shape Code
  tags:
  - Shape Code
- name: Shipment Line Items (V3)
  tags:
  - Shipment Line Items (V3)
- name: Shipment
  tags:
  - Shipment Custom Fields
- name: Shipments
  tags:
  - Shipments
- name: Shipping Method
  tags:
  - Shipping Method
- name: Tag
  tags:
  - Tag
- name: Task
  tags:
  - Task
- name: Tax Rate
  tags:
  - Tax Rate
- name: Time Clock Timers
  tags:
  - Time Clock Timers
- name: Timer
  tags:
  - Timer
- name: Tool
  tags:
  - Tool
- name: Tool Calibration
  tags:
  - Tool Calibration
- name: User
  tags:
  - User
  - User Status
- name: Vendor
  tags:
  - Vendor
  - Vendor Address
  - Vendor Contact
- name: Work Order
  tags:
  - Work Order
- name: WorkCenter
  tags:
  - WorkCenter
x-provenance:
  method: harvested
  publisher: Fulcrumpro
  source: https://api.fulcrumpro.com/swagger/v1/swagger.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)