Fulcrumpro Receiving Receipt API

openapi: 3.2.0
info:
  title: Fulcrum Public Receiving Receipt API
  version: v1
servers:
- url: https://api.fulcrumpro.com
tags:
- name: Receiving Receipt
paths:
  /api/receiving/receipts:
    post:
      tags:
      - Receiving Receipt
      summary: Create a receipt for a specific purchase or sales order
      operationId: CreateReceipt
      requestBody:
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/ReceivingReceiptCreateDto'
          application/json:
            schema:
              $ref: '#/components/schemas/ReceivingReceiptCreateDto'
          text/json:
            schema:
              $ref: '#/components/schemas/ReceivingReceiptCreateDto'
          application/*+json:
            schema:
              $ref: '#/components/schemas/ReceivingReceiptCreateDto'
        required: true
      responses:
        '200':
          description: Receipt created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReceivingReceiptDto'
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ReceivingReceiptDto'
        '404':
          description: Receipt was not created
      x-c4-exposed: true
      x-c4-mutation: true
      x-c4-required-permissions:
      - Receiving-Receiving-Edit Receiving
  /api/receiving/receipts/{receiptId}:
    get:
      tags:
      - Receiving Receipt
      summary: Get a specific receipt on a purchase or sales order
      operationId: GetReceipt
      parameters:
      - name: receiptId
        in: path
        required: true
        schema:
          maxLength: 36
          minLength: 36
          type: string
      responses:
        '200':
          description: Receipt
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReceivingReceiptDto'
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ReceivingReceiptDto'
        '404':
          description: Receipt did not exist
      x-c4-exposed: true
      x-c4-required-permissions:
      - Receiving-Receiving-View Receiving
    patch:
      tags:
      - Receiving Receipt
      summary: Partially update a specific receipt for a purchase or sales order
      operationId: PatchReceipt
      parameters:
      - name: receiptId
        in: path
        required: true
        schema:
          maxLength: 36
          minLength: 36
          type: string
      requestBody:
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/JsonPatchDocument'
      responses:
        '200':
          description: Receipt
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReceivingReceiptDto'
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ReceivingReceiptDto'
        '400':
          description: The patch document is malformed — an unknown path, an unsupported operation, or a value the target field cannot hold
        '404':
          description: Receipt did not exist
      x-c4-exposed: true
      x-c4-mutation: true
      x-c4-required-permissions:
      - Receiving-Receiving-Edit Receiving
    put:
      tags:
      - Receiving Receipt
      summary: Update a specific receipt for a purchase or sales order
      operationId: UpdateReceipt
      parameters:
      - name: receiptId
        in: path
        required: true
        schema:
          maxLength: 36
          minLength: 36
          type: string
      requestBody:
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/ReceivingReceiptUpdateDto'
          application/json:
            schema:
              $ref: '#/components/schemas/ReceivingReceiptUpdateDto'
          text/json:
            schema:
              $ref: '#/components/schemas/ReceivingReceiptUpdateDto'
          application/*+json:
            schema:
              $ref: '#/components/schemas/ReceivingReceiptUpdateDto'
        required: true
      responses:
        '200':
          description: Receipt
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReceivingReceiptDto'
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ReceivingReceiptDto'
        '404':
          description: Receipt did not exist
  /api/receiving/receipts/list:
    post:
      tags:
      - Receiving Receipt
      summary: Get a list of receipts for purchase and sales orders
      operationId: ListReceipt
      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/ReceivingRequestListFindParameters'
          application/json:
            schema:
              $ref: '#/components/schemas/ReceivingRequestListFindParameters'
          text/json:
            schema:
              $ref: '#/components/schemas/ReceivingRequestListFindParameters'
          application/*+json:
            schema:
              $ref: '#/components/schemas/ReceivingRequestListFindParameters'
      responses:
        '200':
          description: List of receipts
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ReceivingReceiptDto'
            application/problem+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ReceivingReceiptDto'
      x-c4-exposed: true
      x-c4-required-permissions:
      - Receiving-Receiving-View Receiving
components:
  schemas:
    CommonEnumOrderType:
      enum:
      - purchaseOrder
      - salesOrder
      type: string
      description: Order type enum
    CommonEnumSortDirectionEnum:
      enum:
      - ascending
      - descending
      type: string
      description: Specify sorting direction.
    CommonExternalReferenceFindDto:
      required:
      - key
      type: object
      properties:
        key:
          maxLength: 50
          minLength: 1
          type: string
          description: Specifies the group name (key) that this external reference originates from (e.g. an external application name)
        type:
          maxLength: 50
          minLength: 0
          type:
          - string
          - 'null'
          description: Arbitrary sub-key that can be used to qualify the value
        externalId:
          maxLength: 500
          minLength: 0
          type:
          - string
          - 'null'
          description: The external identifier
      additionalProperties: false
      description: Search parameter for identifier record(s) via their external identifiers.
    ReceivingReceiptUpdateDto:
      required:
      - receivedBy
      type: object
      properties:
        receivedBy:
          maxLength: 24
          minLength: 24
          type: string
          description: Id of the user who received the item(s)
        date:
          type:
          - string
          - 'null'
          description: 'Received date override.  If not provided,

            receipt date will default to the date the object was initially created.'
          format: date-time
        externalReferences:
          type:
          - object
          - 'null'
          additionalProperties:
            $ref: '#/components/schemas/CommonExternalReferenceDto'
          description: Arbitrary key-value-pair like data that can be used to later on search for this receipt object.
      additionalProperties: false
      description: Represents a receiving object on a purchase order
    ReceivingRequestListFindParameters:
      type: object
      properties:
        salesOrderIds:
          type:
          - array
          - 'null'
          items:
            type: string
          description: Include receipts for specific sales order ids
        purchaseOrderIds:
          type:
          - array
          - 'null'
          items:
            type: string
          description: Include receipts for specific purchase order ids
        receiptIds:
          type:
          - array
          - 'null'
          items:
            type: string
          description: Include receipts with specific ids
        includeReceiptLines:
          type: boolean
          description: If set to true, receipt line items will be included in the results
        externalReference:
          $ref: '#/components/schemas/CommonExternalReferenceFindDto'
        receivedDateFrom:
          type:
          - string
          - 'null'
          description: 'Inclusive lower bound on the receipt''s effective received date, which is its received-date

            override when one is set and its recorded received date otherwise. A whole day in the shop''s

            timezone; any time of day supplied is ignored.'
          format: date-time
        receivedDateTo:
          type:
          - string
          - 'null'
          description: 'Inclusive upper bound on that same effective received date. A whole day in the shop''s

            timezone; any time of day supplied is ignored.'
          format: date-time
      additionalProperties: false
      description: Parameters used for searching/finding receipts.
    ReceivingReceiptDto:
      required:
      - id
      type: object
      properties:
        id:
          maxLength: 36
          minLength: 36
          type: string
          description: Unique id associated to this entity.
        receivedBy:
          maxLength: 200
          minLength: 1
          type:
          - string
          - 'null'
          description: Id of the user who received the item(s)
          readOnly: true
        number:
          type:
          - number
          - 'null'
          description: Number
          format: double
        date:
          type:
          - string
          - 'null'
          description: Received date
          format: date-time
        dateOriginal:
          type:
          - string
          - 'null'
          description: Original received date
          format: date-time
        dateOverride:
          type:
          - string
          - 'null'
          description: Override received date
          format: date-time
        accountingHeldUtc:
          type:
          - string
          - 'null'
          description: 'Set while the receipt''s accounting events are withheld because it contains material held

            for incoming inspection (tenant invoice timing = after-inspection). Held receipts are

            excluded from the receipt list until their inspections resolve; cleared when the deferred

            events fire.'
          format: date-time
        orderType:
          $ref: '#/components/schemas/CommonEnumOrderType'
        orderId:
          maxLength: 24
          minLength: 24
          type:
          - string
          - 'null'
          description: Id of parent order to which this receipt belongs
        externalReferences:
          type:
          - object
          - 'null'
          additionalProperties:
            $ref: '#/components/schemas/CommonExternalReferenceDto'
          description: Arbitrary key-value-pair like data that can be used to later on search for this receipt object.
        lines:
          type: array
          items:
            $ref: '#/components/schemas/ReceivingLineItemReceiptLineItemDto'
          description: Receipt Line item data.
        customFields:
          type:
          - object
          - 'null'
          additionalProperties: {}
          description: Custom fields that have been defined on this entity.
        invoiceNumber:
          maxLength: 200
          minLength: 1
          type:
          - string
          - 'null'
          description: The vendor invoice invoice number associated to the receipt.
      additionalProperties: false
      description: Represents a receiving object
    JsonPatchOperation:
      type: object
      properties:
        op:
          type: string
        value: {}
        path:
          type: string
        from:
          type: string
          description: Source path — present for move/copy operations, absent otherwise.
    ReceivingLineItemReceiptLineItemDto:
      required:
      - fullyReceived
      - id
      - lineItemId
      - rolledBack
      type: object
      properties:
        id:
          maxLength: 36
          minLength: 36
          type: string
          description: Unique id associated to this entity.
        lineItemId:
          maxLength: 36
          minLength: 36
          type: string
          description: Id of the purchase order line item corresponding to this update
        fullyReceived:
          type: boolean
          description: Indicates whether the entire quantity of this line item have been received
        rolledBack:
          type: boolean
          description: Indicates whether this update is active.
        quantityReceived:
          type:
          - number
          - 'null'
          description: Quantity of the associated item that has been received on this update in the specified unit of measure (non-cumulative)
          format: double
        unitOfMeasureMultiplier:
          type: number
          description: 'If the receipt has a different unit of measure than the item is stored in fulcrum, you would use this multiplier with the QuantityReceived to get the amount you received into

            Fulcrum.'
          format: double
        convertedQuantityReceived:
          type: number
          description: Quantity of the associated item that has been received in Fulcrum's unit of measure
          format: double
          readOnly: true
        externalReferences:
          type:
          - object
          - 'null'
          additionalProperties:
            $ref: '#/components/schemas/CommonExternalReferenceDto'
          description: Arbitrary key-value-pair like data that can be used to later on search for this line item.
        unitPrice:
          type:
          - number
          - 'null'
          description: 'Price of the purchase order line received against, per Fulcrum''s unit of measure, so it

            multiplies directly with `convertedQuantityReceived`. Null means there is no price,

            not a price of zero. Supplied only by the receipts list endpoint.'
          format: double
        lineItemType:
          $ref: '#/components/schemas/PurchaseOrderLineItemTypeEnum'
        itemId:
          maxLength: 24
          minLength: 24
          type:
          - string
          - 'null'
          description: 'Id of the item on the purchase order line received against: the part for a part line, the item

            being processed for an outside processing line. Null on a fee line, on an outside processing line

            with no item, on a sales order receipt and on a line that no longer resolves. Supplied only by the receipts list endpoint.'
        unitCost:
          type:
          - number
          - 'null'
          description: 'Cost per unit in Fulcrum''s unit of measure, in the primary currency, excluding tax and landed cost: the

            billed unit price when a billed subtotal is entered, otherwise the line''s price after its own discount, at

            the PO''s exchange rate.

            Together with `unitTax` and `landedCost`, the tax and landed cost Fulcrum applies when it

            revalues a receipt, the line is valued at

            `convertedQuantityReceived × (unitCost + unitTax) + landedCost`, or

            `convertedQuantityReceived × unitCost + landedCost` excluding tax.

            On an outside processing line this is the value job cost uses. On a part line the inventory transaction

            can differ: a receipt entered after the bill is valued at the purchase order price, a bill changed after

            the inventory adjustment cutoff does not revalue older receipts, on a discounted line with no billed

            subtotal inventory holds the price before the discount, and on a line that is not taxable but has an

            overridden tax rate receiving adds that tax until the receipt is revalued. Rolled-back lines are populated

            as well; skip them. Null on a fee line, on a sales order receipt and on a line that no longer resolves.

            Supplied only by the receipts list endpoint.'
          format: double
        unitTax:
          type:
          - number
          - 'null'
          description: 'Tax per unit in Fulcrum''s unit of measure, in the primary currency, that Fulcrum applies to this line

            when it revalues a receipt; zero when the line is not taxed. See `unitCost` for how the three

            values combine. Null where `unitCost` is null. Supplied only by the receipts list endpoint.'
          format: double
        landedCost:
          type:
          - number
          - 'null'
          description: 'Total landed cost allocated to this receipt line (not per unit), in the primary currency; zero when none

            is allocated. Null where `unitCost` is null. Supplied only by the receipts list endpoint.'
          format: double
      additionalProperties: false
      description: Represents a line item on a receipt for a purchase or sales order
    PurchaseOrderLineItemTypeEnum:
      enum:
      - part
      - outsideProcessing
      - tax
      - discount
      - fee
      - vendorCredit
      type: string
      description: Purchase order line item type
    JsonPatchDocument:
      type: array
      items:
        $ref: '#/components/schemas/JsonPatchOperation'
      description: Array of operations to perform
    ReceivingLineItemReceiptLineItemCreateDto:
      required:
      - lineItemId
      - quantityReceived
      type: object
      properties:
        lineItemId:
          maxLength: 36
          minLength: 36
          type: string
          description: Id of the line item corresponding to this receiving.
        quantityReceived:
          type: number
          description: Quantity of the associated item that has been received (non-cumulative).
          format: double
        lotNumber:
          type:
          - string
          - 'null'
          description: Lot number to receive the item into.
        locationId:
          type:
          - string
          - 'null'
          description: Location to receive the item into. Please reference /api/locations endpoint.
        expirationDate:
          type:
          - string
          - 'null'
          description: Expiration date indicating when this receiving is good until.
          format: date-time
        fullyReceived:
          type:
          - boolean
          - 'null'
          description: Indicate if this is fully received.
      additionalProperties: false
      description: Represents creating a receiving object on a purchase order
    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
    ReceivingReceiptCreateDto:
      required:
      - lines
      - orderId
      - orderType
      type: object
      properties:
        orderType:
          $ref: '#/components/schemas/CommonEnumOrderType'
        orderId:
          maxLength: 24
          minLength: 24
          type: string
          description: Id of parent order to which this receipt belongs
        lines:
          minItems: 1
          type: array
          items:
            $ref: '#/components/schemas/ReceivingLineItemReceiptLineItemCreateDto'
          description: Line items
      additionalProperties: false
      description: Represents creating a receiving object on an entity
  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)