Fulcrumpro Customer API

openapi: 3.2.0
info:
  title: Fulcrum Public Customer API
  version: v1
servers:
- url: https://api.fulcrumpro.com
tags:
- name: Customer
paths:
  /api/customers:
    post:
      tags:
      - Customer
      summary: Create a new customer
      operationId: CreateCustomer
      requestBody:
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/CustomerCreateDto'
          application/json:
            schema:
              $ref: '#/components/schemas/CustomerCreateDto'
          text/json:
            schema:
              $ref: '#/components/schemas/CustomerCreateDto'
          application/*+json:
            schema:
              $ref: '#/components/schemas/CustomerCreateDto'
        required: true
      responses:
        '200':
          description: Customer created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreatedResponseDto'
            application/problem+json:
              schema:
                $ref: '#/components/schemas/CreatedResponseDto'
        '400':
          description: Validation issues with input
      x-c4-exposed: true
      x-c4-mutation: true
      x-c4-required-permissions:
      - Customer-Customers-Edit Customer
  /api/customers/{customerId}:
    delete:
      tags:
      - Customer
      summary: Delete a specific customer
      operationId: DeleteCustomer
      parameters:
      - name: customerId
        in: path
        required: true
        schema:
          maxLength: 24
          minLength: 24
          type: string
      responses:
        '200':
          description: Success
        '204':
          description: Customer did not exist
    get:
      tags:
      - Customer
      summary: Get a specific customer
      operationId: GetCustomer
      parameters:
      - name: customerId
        in: path
        required: true
        schema:
          maxLength: 24
          minLength: 24
          type: string
      responses:
        '200':
          description: The customer for the given id
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomerDto'
            application/problem+json:
              schema:
                $ref: '#/components/schemas/CustomerDto'
        '404':
          description: Customer did not exist
      x-c4-exposed: true
      x-c4-required-permissions:
      - Customer-Customers-View Customer
    patch:
      tags:
      - Customer
      summary: Partially update a customer
      operationId: PatchCustomer
      parameters:
      - name: customerId
        in: path
        required: true
        schema:
          maxLength: 24
          minLength: 24
          type: string
      requestBody:
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/JsonPatchDocument'
      responses:
        '200':
          description: Customer item
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomerDto'
            application/problem+json:
              schema:
                $ref: '#/components/schemas/CustomerDto'
        '400':
          description: The patch could not be applied — the patch document is malformed (an unknown path, an unsupported operation, or a value the target field cannot hold), the patched name failed validation, or the patched customerTierId names no customer tier
        '404':
          description: Customer did not exist
      x-c4-exposed: true
      x-c4-mutation: true
      x-c4-required-permissions:
      - Customer-Customers-Edit Customer
    put:
      tags:
      - Customer
      summary: Update a specific customer
      operationId: UpdateCustomer
      parameters:
      - name: customerId
        in: path
        required: true
        schema:
          maxLength: 24
          minLength: 24
          type: string
      requestBody:
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/CustomerUpdateDto'
          application/json:
            schema:
              $ref: '#/components/schemas/CustomerUpdateDto'
          text/json:
            schema:
              $ref: '#/components/schemas/CustomerUpdateDto'
          application/*+json:
            schema:
              $ref: '#/components/schemas/CustomerUpdateDto'
        required: true
      responses:
        '200':
          description: The customer for the given id
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomerDto'
            application/problem+json:
              schema:
                $ref: '#/components/schemas/CustomerDto'
        '404':
          description: Customer did not exist
  /api/customers/list:
    post:
      tags:
      - Customer
      summary: Find customers based on search parameters
      operationId: ListCustomer
      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/CustomerRequestFindParameters'
          application/json:
            schema:
              $ref: '#/components/schemas/CustomerRequestFindParameters'
          text/json:
            schema:
              $ref: '#/components/schemas/CustomerRequestFindParameters'
          application/*+json:
            schema:
              $ref: '#/components/schemas/CustomerRequestFindParameters'
      responses:
        '200':
          description: List of customers matching the filters
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CustomerDto'
            application/problem+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CustomerDto'
      x-c4-exposed: true
      x-c4-required-permissions:
      - Customer-Customers-View Customer
components:
  schemas:
    CustomerDto:
      required:
      - hasCustomerPortal
      - id
      - name
      type: object
      properties:
        id:
          maxLength: 24
          minLength: 24
          type: string
          description: Id
        name:
          maxLength: 200
          minLength: 1
          type: string
          description: The name to give the customer. Must be unique to all active customers.
        customerCode:
          minLength: 1
          type:
          - string
          - 'null'
          description: Unique identifier for this customer
        currencyCode:
          minLength: 1
          type:
          - string
          - 'null'
          description: 'Currency code/denomination associated to this customer.

            If not provided, default to the primary currency code for the organization.'
        url:
          type:
          - string
          - 'null'
          description: The Customer's website
          format: uri
        creditLimit:
          minimum: 0
          type:
          - number
          - 'null'
          description: Credit limit
          format: double
        paymentTermsId:
          maxLength: 24
          minLength: 24
          type:
          - string
          - 'null'
          description: Payment terms identifier. Please reference /api/payment-terms endpoint.
        paymentTerms:
          $ref: '#/components/schemas/CommonReferenceDto'
        salesPersonId:
          maxLength: 24
          minLength: 24
          type:
          - string
          - 'null'
          description: Sales person identifier. Please reference /api/users endpoint.
        isTaxable:
          type: boolean
          description: Whether or not this customer is taxable on Sales Orders and Quotes
        taxRateIds:
          type:
          - array
          - 'null'
          items:
            type: string
          description: A list of tax codes to be automatically added to new SalesOrders for the customer when AutoAddTaxLineItems process setting is enabled.
        externalReferences:
          type:
          - object
          - 'null'
          additionalProperties:
            $ref: '#/components/schemas/CommonExternalReferenceDto'
          description: External references associated with this entity.
        customFields:
          type:
          - object
          - 'null'
          additionalProperties: {}
          description: Custom fields that have been defined on this entity.
        notes:
          maxLength: 2000
          minLength: 1
          type:
          - string
          - 'null'
          description: Notes associated to the customer.
        hasCustomerPortal:
          type: boolean
          description: Indicates if this customer is set up to use the customer portal.
        customerTierId:
          maxLength: 24
          minLength: 24
          type:
          - string
          - 'null'
          description: Customer tier identifier. Please reference /api/customer-tiers endpoint.
        customerTierName:
          type:
          - string
          - 'null'
          description: Customer tier name.
        customerTypeId:
          maxLength: 24
          minLength: 24
          type:
          - string
          - 'null'
          description: Customer type identifier. Read-only; assigned in the app.
        customerTypeName:
          type:
          - string
          - 'null'
          description: Customer type name. Read-only; assigned in the app.
      additionalProperties: false
      description: A customer
    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.
    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.
    CustomerCreateDto:
      required:
      - name
      type: object
      properties:
        name:
          maxLength: 200
          minLength: 1
          type: string
          description: The name to give the customer. Must be unique to all active customers.
        customerCode:
          minLength: 1
          type:
          - string
          - 'null'
          description: Unique identifier for this customer
        currencyCode:
          minLength: 1
          type:
          - string
          - 'null'
          description: 'Currency code/denomination associated to this customer.

            If not provided, default to the primary currency code for the organization.'
        creditLimit:
          minimum: 0
          type:
          - number
          - 'null'
          description: Credit limit
          format: double
        paymentTermsId:
          maxLength: 24
          minLength: 24
          type:
          - string
          - 'null'
          description: Payment terms.
        salesPersonId:
          maxLength: 24
          minLength: 24
          type:
          - string
          - 'null'
          description: Payment terms.
        customerTierId:
          maxLength: 24
          minLength: 24
          type:
          - string
          - 'null'
          description: 'Customer tier identifier. Please reference the /api/customer-tiers endpoints.

            If not provided, the customer is created without a tier.'
        url:
          type:
          - string
          - 'null'
          description: The Customer's website
          format: uri
        isTaxable:
          type:
          - boolean
          - 'null'
          description: Whether or not this customer is taxable on Sales Orders and Quotes
        taxRateIds:
          type:
          - array
          - 'null'
          items:
            type: string
          description: A list of tax codes to be automatically added to new SalesOrders for the customer when AutoAddTaxLineItems process setting is enabled.
        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 the customer
        customFields:
          type:
          - object
          - 'null'
          additionalProperties: {}
          description: Custom fields that have been defined on this entity.
        notes:
          type:
          - string
          - 'null'
          description: Notes associated to the customer.
        hasCustomerPortal:
          type:
          - boolean
          - 'null'
          description: Indicates if this customer is set up to use the customer portal.
      additionalProperties: false
      description: Details of customer to be created
    JsonPatchOperation:
      type: object
      properties:
        op:
          type: string
        value: {}
        path:
          type: string
        from:
          type: string
          description: Source path — present for move/copy operations, absent otherwise.
    JsonPatchDocument:
      type: array
      items:
        $ref: '#/components/schemas/JsonPatchOperation'
      description: Array of operations to perform
    CustomerUpdateDto:
      required:
      - name
      type: object
      properties:
        name:
          maxLength: 200
          minLength: 1
          type: string
          description: The name to give the customer. Must be unique to all active customers.
        customerCode:
          minLength: 1
          type:
          - string
          - 'null'
          description: Unique identifier for this customer
        currencyCode:
          minLength: 1
          type:
          - string
          - 'null'
          description: 'Currency code/denomination associated to this customer.

            If not provided, default to the primary currency code for the organization.'
        url:
          type:
          - string
          - 'null'
          description: The Customer's website
          format: uri
        creditLimit:
          minimum: 0
          type:
          - number
          - 'null'
          description: Credit limit
          format: double
        paymentTermsId:
          maxLength: 24
          minLength: 24
          type:
          - string
          - 'null'
          description: Payment terms identifier. Please reference /api/payment-terms endpoint.
        salesPersonId:
          maxLength: 24
          minLength: 24
          type:
          - string
          - 'null'
          description: Sales person identifier. Please reference /api/users endpoint.
        customerTierId:
          maxLength: 24
          minLength: 24
          type:
          - string
          - 'null'
          description: 'Customer tier identifier. Please reference the /api/customer-tiers endpoints.

            If not provided or null, the customer''s tier is left unchanged. To remove the tier,

            PATCH the customer with a `remove` operation on `/customerTierId`.'
        isTaxable:
          type:
          - boolean
          - 'null'
          description: Whether or not this customer is taxable on Sales Orders and Quotes
        taxRateIds:
          type:
          - array
          - 'null'
          items:
            type: string
          description: A list of tax codes to be automatically added to new SalesOrders for the customer when AutoAddTaxLineItems process setting is enabled.
        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.
        customFields:
          type:
          - object
          - 'null'
          additionalProperties: {}
          description: Custom fields that have been defined on this entity.
        notes:
          type:
          - string
          - 'null'
          description: Notes associated to the customer.
        hasCustomerPortal:
          type:
          - boolean
          - 'null'
          description: Indicates if this customer is set up to use the customer portal.
      additionalProperties: false
      description: Details of customer to be updated
    CreatedResponseDto:
      required:
      - id
      type: object
      properties:
        id:
          minLength: 1
          type: string
          description: The id of the created record
      additionalProperties: false
      description: Response for a created record
    CustomerRequestFindParameters:
      type: object
      properties:
        name:
          maxLength: 200
          minLength: 1
          type:
          - string
          - 'null'
          description: Filter to customers who's name contains the given string
        customerCode:
          minLength: 1
          type:
          - string
          - 'null'
          description: Unique identifier for this customer.
        email:
          minLength: 1
          type:
          - string
          - 'null'
          description: The email of the customer
        modifiedAfterUtc:
          type:
          - string
          - 'null'
          description: Filter to customer records modified after the given datetime (in UTC)
          format: date-time
        externalReference:
          $ref: '#/components/schemas/CommonExternalReferenceFindDto'
      additionalProperties: false
      description: Parameters used for searching/finding customers.
    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
  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)