Fulcrumpro

Fulcrumpro NCRs API

The NCRs API from Fulcrumpro — 2 operation(s) for ncrs.

GitHub OpenAPI
Business capability
Non-Conformance Management BC-720.40

Operations 3

POST /api/ncrs Open a new NCR in status New. #
GET /api/ncrs/{ncrId} Get a specific NCR by id #
POST /api/ncrs/list Finds NCRs based on search parameters #

Documentation

📖
Documentation
https://developers.fulcrumpro.com/docs
📖
APIReference
https://developers.fulcrumpro.com/api-schema
📖
GettingStarted
https://developers.fulcrumpro.com/docs

Specifications

⚙
OpenAPI
https://artifacts.apis.io/fulcrumpro/openapi/fulcrumpro-ncrs-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/fulcrumpro:fulcrumpro-ncrs-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

fulcrumpro-ncrs-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Fulcrum Public NCRs API
  version: v1
servers:
- url: https://api.fulcrumpro.com
tags:
- name: NCRs
paths:
  /api/ncrs:
    post:
      tags:
      - NCRs
      summary: Open a new NCR in status New.
      operationId: CreateNcr
      requestBody:
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/NCRRequestNcrCreateDto'
          application/json:
            schema:
              $ref: '#/components/schemas/NCRRequestNcrCreateDto'
          text/json:
            schema:
              $ref: '#/components/schemas/NCRRequestNcrCreateDto'
          application/*+json:
            schema:
              $ref: '#/components/schemas/NCRRequestNcrCreateDto'
        required: true
      responses:
        '200':
          description: The created NCR
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NCRNcrDto'
            application/problem+json:
              schema:
                $ref: '#/components/schemas/NCRNcrDto'
        '400':
          description: Validation issues with input
        '404':
          description: The job or item does not exist
      x-c4-exposed: true
      x-c4-mutation: true
      x-c4-required-permissions:
      - Quality-NCR-Create NCR
  /api/ncrs/{ncrId}:
    get:
      tags:
      - NCRs
      summary: Get a specific NCR by id
      operationId: GetNcr
      parameters:
      - name: ncrId
        in: path
        required: true
        schema:
          maxLength: 24
          minLength: 24
          type: string
      responses:
        '200':
          description: The NCR for the given id.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NCRNcrDto'
            application/problem+json:
              schema:
                $ref: '#/components/schemas/NCRNcrDto'
        '404':
          description: An NCR with that id does not exist.
      x-c4-exposed: true
      x-c4-required-permissions:
      - Quality-NCR-View NCR
  /api/ncrs/list:
    post:
      tags:
      - NCRs
      summary: Finds NCRs based on search parameters
      operationId: ListNCR
      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/NCRRequestNcrListParameters'
          application/json:
            schema:
              $ref: '#/components/schemas/NCRRequestNcrListParameters'
          text/json:
            schema:
              $ref: '#/components/schemas/NCRRequestNcrListParameters'
          application/*+json:
            schema:
              $ref: '#/components/schemas/NCRRequestNcrListParameters'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DtoPagedResultDtoNCRNcrDto'
            application/problem+json:
              schema:
                $ref: '#/components/schemas/DtoPagedResultDtoNCRNcrDto'
      x-c4-exposed: true
      x-c4-required-permissions:
      - Quality-NCR-View NCR
components:
  schemas:
    CommonImpactDto:
      required:
      - id
      type: object
      properties:
        id:
          type: string
          description: The ID for this object.
          format: uuid
        operation:
          $ref: '#/components/schemas/CommonReferenceDto'
        workCenter:
          $ref: '#/components/schemas/CommonReferenceDto'
        scheduledEquipment:
          $ref: '#/components/schemas/CommonReferenceDto'
        job:
          $ref: '#/components/schemas/CommonReferenceDto'
        salesOrder:
          $ref: '#/components/schemas/CommonReferenceDto'
        quantityImpacted:
          type:
          - number
          - 'null'
          description: Quantity Impacted
          format: double
        incrementalCost:
          type:
          - number
          - 'null'
          description: Incremental Cost
          format: double
      additionalProperties: false
      description: Impact Dto.
    CommonReferenceDto:
      type: object
      properties:
        id:
          maxLength: 24
          minLength: 24
          type:
          - string
          - 'null'
          description: Unique Id associated to the referenced object
        name:
          maxLength: 200
          minLength: 1
          type:
          - string
          - 'null'
          description: Descriptive name associated to the object
      additionalProperties: false
      description: Represents a reference to a document in a DB collection
    CommonEnumSortDirectionEnum:
      enum:
      - ascending
      - descending
      type: string
      description: Specify sorting direction.
    DtoPagedResultDtoNCRNcrDto:
      required:
      - data
      - hasNextPage
      - hasPreviousPage
      - page
      - pageSize
      - totalCount
      - totalPages
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/NCRNcrDto'
          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
    NCRRequestNcrListParameters:
      type: object
      properties:
        status:
          type:
          - string
          - 'null'
          description: 'Filter NCRs by a specific status

            Accepted Values:

            Closed, Hold, New, Quality Review, Engineering Review'
        type:
          type:
          - string
          - 'null'
          description: Filter NCRs by a specific type. Available values are configured per tenant in Quality settings (NCR dropdowns).
        cause:
          type:
          - string
          - 'null'
          description: Filter NCRs by a specific cause. Available values are configured per tenant in Quality settings (NCR dropdowns).
        reason:
          type:
          - string
          - 'null'
          description: Filter NCRs by a specific reason. Available values are configured per tenant in Quality settings (NCR dropdowns).
        createdUtc:
          type:
          - string
          - 'null'
          description: 'Filter NCRs created on or after this instant, time of day included. Combines with

            FulcrumProduct.PublicApi.Controllers.NCRs.Request.NcrListParameters.CreatedFrom when both are sent.'
          format: date-time
        createdFrom:
          type:
          - string
          - 'null'
          description: 'Filter to NCRs created on or after this date, as a whole day in the shop''s timezone. Any time

            component is ignored.'
          format: date-time
        createdTo:
          type:
          - string
          - 'null'
          description: 'Filter to NCRs created on or before this date, as a whole day in the shop''s timezone, so

            an NCR created later that same shop day still matches.'
          format: date-time
      additionalProperties: false
      description: Parameters used for searching NCRs
    NCRRequestNcrCreateDto:
      required:
      - detail
      - type
      type: object
      properties:
        title:
          maxLength: 500
          minLength: 0
          type:
          - string
          - 'null'
          description: Short title for the NCR
        type:
          maxLength: 200
          minLength: 1
          type: string
          description: The NCR type, one of the shop's configured NCR types (for example Quality, Quantity, Customer Complaint, Return, Warranty)
        detail:
          maxLength: 2000
          minLength: 1
          type: string
          description: 'What was found: the required description of the non-conformance'
        cause:
          maxLength: 200
          minLength: 0
          type:
          - string
          - 'null'
          description: The cause, one of the shop's configured NCR causes
        reason:
          maxLength: 200
          minLength: 0
          type:
          - string
          - 'null'
          description: The reason, one of the shop's configured NCR reasons
        disposition:
          maxLength: 100
          minLength: 0
          type:
          - string
          - 'null'
          description: 'Disposition, when already decided. One of: Acceptable - Customer, Acceptable - Engineer, Conforming,

            Hold, Return To Customer, Return To Vendor, Return To Fulcrum, Rework, Remake/Replace, Scrap - Customer'
        jobId:
          maxLength: 24
          minLength: 24
          type:
          - string
          - 'null'
          description: The affected job's id. The job's customer and sales order are recorded on the impact from the job
        itemId:
          maxLength: 24
          minLength: 24
          type:
          - string
          - 'null'
          description: The affected item's id. Defaults to the job's parent item when only a job is given
        quantityImpacted:
          minimum: 0
          type:
          - number
          - 'null'
          description: How many units are affected. Requires jobId or itemId. Zero or greater
          format: double
        quantityImpactedDisposition:
          maxLength: 50
          minLength: 0
          type:
          - string
          - 'null'
          description: Whether the impacted quantity is All, Partial, or Unknown. Defaults to Partial
      additionalProperties: false
      description: 'Request body for opening an NCR. The NCR is created in status New; the quality team classifies

        and works it in the app. An affected job and/or item become the NCR''s single impact.'
    NCRNcrDto:
      required:
      - cause
      - detail
      - id
      - number
      - type
      type: object
      properties:
        id:
          maxLength: 24
          minLength: 24
          type: string
          description: Unique id associated to this entity.
        number:
          minimum: 0
          type: integer
          description: Number
          format: int32
        type:
          minLength: 1
          type: string
          description: NCR Type
        cause:
          minLength: 1
          type: string
          description: Cause
        detail:
          maxLength: 2000
          minLength: 1
          type: string
          description: Detail - required notes on the NCR
        departmentId:
          maxLength: 24
          minLength: 24
          type:
          - string
          - 'null'
          description: Department key identifier. Please reference /api/departments endpoint.
        department:
          $ref: '#/components/schemas/CommonReferenceDto'
        vendorId:
          maxLength: 24
          minLength: 24
          type:
          - string
          - 'null'
          description: Vendor key identifier. Please reference /api/vendors endpoint.
        vendor:
          $ref: '#/components/schemas/CommonReferenceDto'
        workCenters:
          type:
          - string
          - 'null'
          description: The work centers assigned to this NCR.
          readOnly: true
        scheduledEquipment:
          type:
          - string
          - 'null'
          description: Affected Equipment
          readOnly: true
        reason:
          type:
          - string
          - 'null'
          description: Reason
        operator:
          $ref: '#/components/schemas/CommonReferenceDto'
        status:
          type:
          - string
          - 'null'
          description: NCR Status
        quantityImpacted:
          type:
          - number
          - 'null'
          description: Quantity Impacted
          format: double
          readOnly: true
        incrementalCost:
          type:
          - number
          - 'null'
          description: Incremental Cost
          format: double
          readOnly: true
        createdUtc:
          type:
          - string
          - 'null'
          description: Created Date
          format: date-time
        completedUtc:
          type:
          - string
          - 'null'
          description: Completed Date
          format: date-time
        jobIds:
          type: array
          items:
            type: string
          description: Impacted Job IDs
          readOnly: true
        customFields:
          type:
          - object
          - 'null'
          additionalProperties: {}
          description: Custom fields that have been defined on this entity.
        completedBy:
          $ref: '#/components/schemas/CommonReferenceDto'
        analyzedBy:
          $ref: '#/components/schemas/CommonReferenceDto'
        impacts:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CommonImpactDto'
          description: Impact information.
      additionalProperties: false
      description: Represents an NCR
  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)