REST API for building integrations directly into a Fulcrum manufacturing site — quotes, sales orders, jobs, scheduling, inventory, purchasing, and invoicing.
{
"openapi": "3.0.4",
"info": {
"title": "Fulcrum PublicAPI",
"version": "v1"
},
"servers": [
{
"url": "https://api.fulcrumpro.com"
}
],
"paths": {
"/api/accounting-codes": {
"post": {
"tags": [
"Accounting Code"
],
"summary": "Create an accounting code",
"operationId": "CreateAccountingCode",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TagCreateBaseDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TagCreateBaseDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TagCreateBaseDto"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TagCreateBaseDto"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Accounting code created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreatedResponseDto"
}
},
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/CreatedResponseDto"
}
}
}
}
},
"x-c4-mutation": true,
"x-c4-required-permissions": [
"System-System Data-Manage System Data"
]
}
},
"/api/accounting-codes/{id}": {
"get": {
"tags": [
"Accounting Code"
],
"summary": "Get an accounting code.",
"operationId": "GetAccountingCode",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"maxLength": 24,
"minLength": 24,
"type": "string"
}
}
],
"responses": {
"200": {
"description": "The accounting code for the given id",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TagDto"
}
},
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/TagDto"
}
}
}
},
"404": {
"description": "Accounting code did not exist"
}
}
}
},
"/api/accounting-codes/list": {
"post": {
"tags": [
"Accounting Code"
],
"summary": "Find accounting codes based on search parameters.",
"operationId": "ListAccountingCode",
"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.",
"schema": {
"minimum": 0,
"type": "integer",
"format": "int32"
}
},
{
"name": "Take",
"in": "query",
"description": "Number of records to return (maximum)",
"schema": {
"maximum": 5000,
"minimum": 0,
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TagRequestFindParametersBase"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TagRequestFindParametersBase"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TagRequestFindParametersBase"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TagRequestFindParametersBase"
}
}
}
},
"responses": {
"200": {
"description": "List of accounting codes matching the filters",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TagDto"
}
}
},
"application/problem+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TagDto"
}
}
}
}
}
}
}
},
"/api/attachments": {
"post": {
"tags": [
"Attachment"
],
"summary": "Create an attachment",
"operationId": "CreateAttachment",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"required": [
"Detail.IsNoteAttachment",
"File"
],
"type": "object",
"properties": {
"File": {
"type": "string",
"description": "The file itself",
"format": "binary"
},
"Detail.Owner.Type": {
"$ref": "#/components/schemas/CommonEnumOwnerTypeCreateEnum"
},
"Detail.Owner.Id": {
"maxLength": 36,
"minLength": 24,
"type": "string",
"description": "The primary owner id of this attachment."
},
"Detail.Description": {
"maxLength": 200,
"minLength": 1,
"type": "string",
"description": "File description"
},
"Detail.IsNoteAttachment": {
"type": "boolean",
"description": "Indicates whether this attachment is bound to a note."
},
"Detail.Parent.Type": {
"$ref": "#/components/schemas/CommonEnumOwnerTypeCreateEnum"
},
"Detail.Parent.Id": {
"maxLength": 36,
"minLength": 24,
"type": "string",
"description": "The primary owner id of this attachment."
},
"Detail.Metadata": {
"type": "object",
"additionalProperties": {
"type": "string",
"nullable": true
},
"description": "Metadata to associate to the attachment."
}
}
},
"encoding": {
"File": {
"style": "form"
},
"Detail.Owner.Type": {
"style": "form"
},
"Detail.Owner.Id": {
"style": "form"
},
"Detail.Description": {
"style": "form"
},
"Detail.IsNoteAttachment": {
"style": "form"
},
"Detail.Parent.Type": {
"style": "form"
},
"Detail.Parent.Id": {
"style": "form"
},
"Detail.Metadata": {
"style": "form"
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreatedResponseDto"
}
},
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/CreatedResponseDto"
}
}
}
}
}
}
},
"/api/attachments/remote": {
"post": {
"tags": [
"Attachment"
],
"summary": "Create an attachment based on a remote data endpoint.",
"operationId": "CreateRemoteAttachment",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/AttachmentRemoteCreateDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/AttachmentRemoteCreateDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/AttachmentRemoteCreateDto"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/AttachmentRemoteCreateDto"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreatedResponseDto"
}
},
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/CreatedResponseDto"
}
}
}
}
}
}
},
"/api/attachments/{attachmentId}": {
"delete": {
"tags": [
"Attachment"
],
"summary": "Delete a specific attachment",
"operationId": "DeleteAttachment",
"parameters": [
{
"name": "attachmentId",
"in": "path",
"required": true,
"schema": {
"maxLength": 24,
"minLength": 24,
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"204": {
"description": "Attachment did not exist"
},
"410": {
"description": "Attachment record had an invalid Id value"
}
}
},
"get": {
"tags": [
"Attachment"
],
"summary": "Get a specific attachment",
"operationId": "GetAttachment",
"parameters": [
{
"name": "attachmentId",
"in": "path",
"required": true,
"schema": {
"maxLength": 24,
"minLength": 24,
"type": "string"
}
}
],
"responses": {
"200": {
"description": "The attachment for the given id",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AttachmentDto"
}
},
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/AttachmentDto"
}
}
}
},
"404": {
"description": "Attachment did not exist"
}
}
}
},
"/api/attachments/{attachmentId}/download": {
"get": {
"tags": [
"Attachment"
],
"summary": "Download a specific attachment",
"operationId": "DownloadAttachment",
"parameters": [
{
"name": "attachmentId",
"in": "path",
"required": true,
"schema": {
"maxLength": 24,
"minLength": 24,
"type": "string"
}
},
{
"name": "fileName",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "The attachment for the given id"
},
"404": {
"description": "Attachment did not exist"
}
}
}
},
"/api/attachments/download": {
"post": {
"tags": [
"Attachment"
],
"summary": "Download attachment(s) for a given filter in ZIP format",
"operationId": "DownloadAttachments",
"parameters": [
{
"name": "fileName",
"in": "query",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/AttachmentRequestFindParameters"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/AttachmentRequestFindParameters"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/AttachmentRequestFindParameters"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/AttachmentRequestFindParameters"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "The attachments for the given filter"
},
"400": {
"description": "File extension not supported"
},
"404": {
"description": "No attachments exist"
}
}
}
},
"/api/attachments/list": {
"post": {
"tags": [
"Attachment"
],
"summary": "Find attachments based on search parameters.",
"operationId": "ListAttachment",
"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.",
"schema": {
"minimum": 0,
"type": "integer",
"format": "int32"
}
},
{
"name": "Take",
"in": "query",
"description": "Number of records to return (maximum)",
"schema": {
"maximum": 5000,
"minimum": 0,
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/AttachmentRequestFindParameters"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/AttachmentRequestFindParameters"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/AttachmentRequestFindParameters"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/AttachmentRequestFindParameters"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "List of attachments matching the filters",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AttachmentDto"
}
}
},
"application/problem+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AttachmentDto"
}
}
}
}
}
}
}
},
"/api/attachments/certification": {
"post": {
"tags": [
"Attachment Certification"
],
"summary": "Create a certification attachment",
"operationId": "CreateCertificationAttachment",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"required": [
"File"
],
"type": "object",
"properties": {
"File": {
"type": "string",
"description": "The file itself",
"format": "binary"
},
"Detail.Owner.Type": {
"$ref": "#/components/schemas/CommonEnumOwnerTypeCertificationEnum"
},
"Detail.Owner.Id": {
"maxLength": 36,
"minLength": 24,
"type": "string",
"description": "The primary owner id of this attachment."
},
"Detail.Description": {
"maxLength": 200,
"minLength": 1,
"type": "string",
"description": "File description"
},
"Detail.Metadata": {
"type": "object",
"additionalProperties": {
"type": "string",
"nullable": true
},
"description": "Metadata to associate to the attachment."
},
"Detail.LotId": {
"maxLength": 24,
"minLength": 24,
"type": "string",
"description": "Lot id."
}
}
},
"encoding": {
"File": {
"style": "form"
},
"Detail.Owner.Type": {
"style": "form"
},
"Detail.Owner.Id": {
"style": "form"
},
"Detail.Description": {
"style": "form"
},
"Detail.Metadata": {
"style": "form"
},
"Detail.LotId": {
"style": "form"
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreatedResponseDto"
}
},
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/CreatedResponseDto"
}
}
}
}
}
}
},
"/api/auth/validate": {
"get": {
"tags": [
"Auth"
],
"summary": "Get details about a token used to authenticate the request",
"operationId": "GetValidate",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AuthValidateResultDto"
}
},
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/AuthValidateResultDto"
}
}
}
}
}
}
},
"/api/capas/{capaId}": {
"get": {
"tags": [
"CAPAs"
],
"summary": "Get a specific CAPA by id.",
"operationId": "GetCapa",
"parameters": [
{
"name": "capaId",
"in": "path",
"required": true,
"schema": {
"maxLength": 24,
"minLength": 24,
"type": "string"
}
}
],
"responses": {
"200": {
"description": "The CAPA for the given id.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CAPACapaDto"
}
},
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/CAPACapaDto"
}
}
}
},
"404": {
"description": "A CAPA with that id does not exist."
}
},
"x-c4-required-permissions": [
"Quality-CAPA-View CAPA"
]
}
},
"/api/capas/list": {
"post": {
"tags": [
"CAPAs"
],
"summary": "Finds CAPAs based on search parameters",
"operationId": "ListCAPA",
"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.",
"schema": {
"minimum": 0,
"type": "integer",
"format": "int32"
}
},
{
"name": "Take",
"in": "query",
"description": "Number of records to return (maximum)",
"schema": {
"maximum": 5000,
"minimum": 0,
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/CAPARequestCapaListParameters"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CAPARequestCapaListParameters"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CAPARequestCapaListParameters"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/CAPARequestCapaListParameters"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DtoPagedResultDtoCAPACapaDto"
}
},
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/DtoPagedResultDtoCAPACapaDto"
}
}
}
}
},
"x-c4-required-permissions": [
"Quality-CAPA-View CAPA"
]
}
},
"/api/chart-of-accounts/{id}": {
"get": {
"tags": [
"Chart Of Accounts"
],
"summary": "Get an account class.",
"operationId": "GetChartOfAccounts",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"maxLength": 24,
"minLength": 24,
"type": "string"
}
}
],
"responses": {
"200": {
"description": "The account for the given id",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TagDto"
}
},
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/TagDto"
}
}
}
},
"404": {
"description": "Account did not exist"
}
}
}
},
"/api/chart-of-accounts/list": {
"post": {
"tags": [
"Chart Of Accounts"
],
"summary": "Find accounts based on search parameters.",
"operationId": "ListChartOfAccounts",
"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.",
"schema": {
"minimum": 0,
"type": "integer",
"format": "int32"
}
},
{
"name": "Take",
"in": "query",
"description": "Number of records to return (maximum)",
"schema": {
"maximum": 5000,
"minimum": 0,
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TagRequestFindParametersBase"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TagRequestFindParametersBase"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TagRequestFindParametersBase"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TagRequestFindParametersBase"
}
}
}
},
"responses": {
"200": {
"description": "List of accounts matching the filters",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TagDto"
}
}
},
"application/problem+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TagDto"
}
}
}
}
}
}
}
},
"/api/companies/{companyId}": {
"get": {
"tags": [
"Company Info"
],
"summary": "Get info for a specific company.",
"operationId": "GetCompanyInfo",
"parameters": [
{
"name": "companyId",
"in": "path",
"required": true,
"schema": {
"maxLength": 24,
"minLength": 24,
"type": "string"
}
}
],
"responses": {
"200": {
"description": "The info for the given company id",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CompanyInfoDto"
}
},
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/CompanyInfoDto"
}
}
}
},
"404": {
"description": "Company did not exist"
}
}
}
},
"/api/companies/list": {
"post": {
"tags": [
"Company Info"
],
"summary": "Find company information based on search parameters.",
"operationId": "ListCompanyInfo",
"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.",
"schema": {
"minimum": 0,
"type": "integer",
"format": "int32"
}
},
{
"name": "Take",
"in": "query",
"description": "Number of records to return (maximum)",
"schema": {
"maximum": 5000,
"minimum": 0,
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/CompanyInfoRequestFindParameters"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CompanyInfoRequestFindParameters"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CompanyInfoRequestFindParameters"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/CompanyInfoRequestFindParameters"
}
}
}
},
"responses": {
"200": {
"description": "List of company information sets matching the filters",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CompanyInfoDto"
}
}
},
"application/problem+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CompanyInfoDto"
}
}
}
}
}
}
}
},
"/api/custom-fields/{id}": {
"get": {
"tags": [
"Custom Field"
],
"summary": "Get a custom field.",
"operationId": "GetCustomField",
"parameters": [
{
# --- truncated at 32 KB (1534 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/fulcrumpro/refs/heads/main/openapi/fulcrumpro-openapi-original.json