Skip to main content
API docs by Redocly

FulcrumProduct.PublicApi (1.0)

Download OpenAPI specification:Download

Accounting Code

Get an accounting code.

path Parameters
id
required
string = 24 characters

Responses

Response samples

Content type
{
  • "id": "stringstringstringstring",
  • "name": "string"
}

Find accounting codes based on search parameters.

query Parameters
Sort.Field
string non-empty

Sort field

Sort.Dir
string (CommonEnumSortDirectionEnum)
Enum: "ascending" "descending"

Sort direction

Skip
integer <int32> >= 0

Number of records to skip.

Take
integer <int32> [ 0 .. 1000 ]

Number of records to return (maximum)

Request Body schema:
name
string or null [ 1 .. 200 ] characters

Filter accounting codes based on their name.

ids
Array of strings or null

Filter accounting codes based on matching ids.

Responses

Request samples

Content type
{
  • "name": "string",
  • "ids": [
    ]
}

Response samples

Content type
[
  • {
    }
]

Attachment

Create an attachment

Request Body schema: multipart/form-data
File
required
string <binary>

The file itself

Detail.Owner.Type
string (CommonEnumOwnerTypeEnum)
Enum: "salesOrder" "salesOrderPartLineItem" "quote" "quotePartLineItem" "purchaseOrder" "purchaseOrderPartLineItem" "invoice" "workOrderOperation" "operation" "inventoryLot" "item" "job"

Owner types

Detail.Owner.Id
string [ 24 .. 36 ] characters

The primary owner id of this attachment.

Detail.Description
string [ 1 .. 200 ] characters

File description

Detail.AttachmentType
string (CommonEnumAttachmentTypeEnum)
Enum: "standard" "externalAccessDocument" "certification"

Attachment types

Detail.IsNoteAttachment
required
boolean

Indicates whether this attachment is bound to a note.

Detail.Parent.Type
string (CommonEnumOwnerTypeEnum)
Enum: "salesOrder" "salesOrderPartLineItem" "quote" "quotePartLineItem" "purchaseOrder" "purchaseOrderPartLineItem" "invoice" "workOrderOperation" "operation" "inventoryLot" "item" "job"

Owner types

Detail.Parent.Id
string [ 24 .. 36 ] characters

The primary owner id of this attachment.

object

Metadata to associate to the attachment.

Responses

Response samples

Content type
{
  • "id": "string"
}

Create an attachment based on a remote data endpoint.

Request Body schema:
required
object (AttachmentOwnerDto)

Attachment owner

fileName
required
string [ 1 .. 200 ] characters

File name

accessUrl
required
string <uri> non-empty

File access url

token
string or null

Optional token that may be required for access the AccessUrl

Responses

Request samples

Content type
{
  • "owner": {
    },
  • "fileName": "string",
  • "accessUrl": "http://example.com",
  • "token": "string"
}

Response samples

Content type
{
  • "id": "string"
}

Delete a specific attachment

path Parameters
attachmentId
required
string = 24 characters

Responses

Get a specific attachment

path Parameters
attachmentId
required
string = 24 characters

Responses

Response samples

Content type
{
  • "id": "stringstringstringstring",
  • "owner": {
    },
  • "name": "string",
  • "description": "string",
  • "type": "standard",
  • "format": "undefined",
  • "size": 0,
  • "fileId": "string"
}

Download a specific attachment

path Parameters
attachmentId
required
string = 24 characters
query Parameters
fileName
string

Responses

Download attachment(s) for a given filter in ZIP format

query Parameters
fileName
string
Request Body schema:
object (AttachmentOwnerDto)

Attachment owner

attachmentIds
Array of strings or null [ 1 .. 500 ] items

Filter to attachments whose ids are in the list.

formats
Array of strings or null (CommonEnumAttachmentMediaFormatEnum) [ 1 .. 500 ] items
Enum: "undefined" "cad" "document" "image" "video"

Allows for filtering based on specific attachment format types.

Responses

Request samples

Content type
{
  • "owner": {
    },
  • "attachmentIds": [
    ],
  • "formats": [
    ]
}

Find attachments based on search parameters.

query Parameters
Sort.Field
string non-empty

Sort field

Sort.Dir
string (CommonEnumSortDirectionEnum)
Enum: "ascending" "descending"

Sort direction

Skip
integer <int32> >= 0

Number of records to skip.

Take
integer <int32> [ 0 .. 1000 ]

Number of records to return (maximum)

Request Body schema:
object (AttachmentOwnerDto)

Attachment owner

attachmentIds
Array of strings or null [ 1 .. 500 ] items

Filter to attachments whose ids are in the list.

formats
Array of strings or null (CommonEnumAttachmentMediaFormatEnum) [ 1 .. 500 ] items
Enum: "undefined" "cad" "document" "image" "video"

Allows for filtering based on specific attachment format types.

Responses

Request samples

Content type
{
  • "owner": {
    },
  • "attachmentIds": [
    ],
  • "formats": [
    ]
}

Response samples

Content type
[
  • {
    }
]

Auth

Get details about a token used to authenticate the request

Responses

Response samples

Content type
{
  • "revocationId": "stringstringstringstring",
  • "name": "string",
  • "domain": "string"
}

Company Info

Get info for a specific company.

path Parameters
companyId
required
string = 24 characters

Responses

Response samples

Content type
{
  • "id": "stringstringstringstring",
  • "isPrimary": true,
  • "name": "string",
  • "shipToAddress": {
    },
  • "remitToAddress": {
    },
  • "websiteUrl": "http://example.com",
  • "phoneNumber": "string",
  • "faxNumber": "string",
  • "email": "[email protected]"
}

Find company information based on search parameters.

query Parameters
Sort.Field
string non-empty

Sort field

Sort.Dir
string (CommonEnumSortDirectionEnum)
Enum: "ascending" "descending"

Sort direction

Skip
integer <int32> >= 0

Number of records to skip.

Take
integer <int32> [ 0 .. 1000 ]

Number of records to return (maximum)

Request Body schema:
isPrimary
boolean or null

Filter on primary company info

Responses

Request samples

Content type
{
  • "isPrimary": true
}

Response samples

Content type
[
  • {
    }
]

Customer

Create a new customer

Request Body schema:
name
required
string [ 1 .. 200 ] characters

The name to give the customer. Must be unique to all active customers.

customerCode
string or null non-empty

Unique identifier for this customer

currencyCode
string or null non-empty

Currency code/denomination associated to this customer. If not provided, default to the primary currency code for the organization.

creditLimit
number or null <double> >= 0

Credit limit

paymentTermsId
string or null = 24 characters

Payment terms.

salesPersonId
string or null = 24 characters

Payment terms.

url
string or null <uri>

The Customer's website

isTaxable
boolean or null

Whether or not this customer is taxable on Sales Orders and Quotes

taxRateIds
Array of strings or null

A list of tax codes to be automatically added to new SalesOrders for the customer when AutoAddTaxLineItems process setting is enabled.

object or null

Arbitrary key-value-pair like data that can be used to later on search for the customer

notes
string or null

Notes associated to the customer.

Responses

Request samples

Content type
{
  • "name": "string",
  • "customerCode": "string",
  • "currencyCode": "string",
  • "creditLimit": 0,
  • "paymentTermsId": "stringstringstringstring",
  • "salesPersonId": "stringstringstringstring",
  • "url": "http://example.com",
  • "isTaxable": true,
  • "taxRateIds": [
    ],
  • "externalReferences": {
    },
  • "notes": "string"
}

Response samples

Content type
{
  • "id": "string"
}

Delete a specific customer

path Parameters
customerId
required
string = 24 characters

Responses

Get a specific customer

path Parameters
customerId
required
string = 24 characters

Responses

Response samples

Content type
{
  • "id": "stringstringstringstring",
  • "name": "string",
  • "customerCode": "string",
  • "currencyCode": "string",
  • "url": "http://example.com",
  • "creditLimit": 0,
  • "paymentTermsId": "stringstringstringstring",
  • "salesPersonId": "stringstringstringstring",
  • "isTaxable": true,
  • "taxRateIds": [
    ],
  • "externalReferences": {
    },
  • "customFields": {
    },
  • "notes": "string"
}

Partially update a customer

path Parameters
customerId
required
string = 24 characters
Request Body schema: application/json-patch+json
Array
op
string
value
string
path
string

Responses

Request samples

Content type
application/json-patch+json
[
  • {
    }
]

Response samples

Content type
{
  • "id": "stringstringstringstring",
  • "name": "string",
  • "customerCode": "string",
  • "currencyCode": "string",
  • "url": "http://example.com",
  • "creditLimit": 0,
  • "paymentTermsId": "stringstringstringstring",
  • "salesPersonId": "stringstringstringstring",
  • "isTaxable": true,
  • "taxRateIds": [
    ],
  • "externalReferences": {
    },
  • "customFields": {
    },
  • "notes": "string"
}

Update a specific customer

path Parameters
customerId
required
string = 24 characters
Request Body schema:
name
required
string [ 1 .. 200 ] characters

The name to give the customer. Must be unique to all active customers.

customerCode
string or null non-empty

Unique identifier for this customer

currencyCode
string or null non-empty

Currency code/denomination associated to this customer. If not provided, default to the primary currency code for the organization.

url
string or null <uri>

The Customer's website

creditLimit
number or null <double> >= 0

Credit limit

paymentTermsId
string or null = 24 characters

Payment terms identifier. Please reference /api/payment-terms endpoint.

salesPersonId
string or null = 24 characters

Sales person identifier. Please reference /api/users endpoint.

isTaxable
boolean or null

Whether or not this customer is taxable on Sales Orders and Quotes

taxRateIds
Array of strings or null

A list of tax codes to be automatically added to new SalesOrders for the customer when AutoAddTaxLineItems process setting is enabled.

object or null

Arbitrary key-value-pair like data that can be used to later on search for this line item.

notes
string or null

Notes associated to the customer.

Responses

Request samples

Content type
{
  • "name": "string",
  • "customerCode": "string",
  • "currencyCode": "string",
  • "url": "http://example.com",
  • "creditLimit": 0,
  • "paymentTermsId": "stringstringstringstring",
  • "salesPersonId": "stringstringstringstring",
  • "isTaxable": true,
  • "taxRateIds": [
    ],
  • "externalReferences": {
    },
  • "notes": "string"
}

Response samples

Content type
{
  • "id": "stringstringstringstring",
  • "name": "string",
  • "customerCode": "string",
  • "currencyCode": "string",
  • "url": "http://example.com",
  • "creditLimit": 0,
  • "paymentTermsId": "stringstringstringstring",
  • "salesPersonId": "stringstringstringstring",
  • "isTaxable": true,
  • "taxRateIds": [
    ],
  • "externalReferences": {
    },
  • "customFields": {
    },
  • "notes": "string"
}

Find customers based on search parameters.

query Parameters
Sort.Field
string non-empty

Sort field

Sort.Dir
string (CommonEnumSortDirectionEnum)
Enum: "ascending" "descending"

Sort direction

Skip
integer <int32> >= 0

Number of records to skip.

Take
integer <int32> [ 0 .. 1000 ]

Number of records to return (maximum)

Request Body schema:
name
string or null [ 1 .. 200 ] characters

Filter to customers who's name contains the given string

customerCode
string or null non-empty

Unique identifier for this customer.

object (CommonExternalReferenceFindDto)

Search parameter for identifier record(s) via their external identifiers.

Responses

Request samples

Content type
{
  • "name": "string",
  • "customerCode": "string",
  • "externalReference": {
    }
}

Response samples

Content type
[
  • {
    }
]

Customer Address

Create a new customer address

path Parameters
customerId
required
string = 24 characters
Request Body schema:
name
string or null [ 1 .. 200 ] characters

Name of the address (Bob's Shipping, Primary, Reno Warehouse, etc).

address1
required
string [ 1 .. 200 ] characters

Primary address line.

address2
string or null [ 1 .. 200 ] characters

Second address line.

address3
string or null [ 1 .. 200 ] characters

Third address line.

city
required
string [ 1 .. 200 ] characters

Address city

stateProvince
string or null [ 1 .. 200 ] characters

Address state/province.

postalCode
required
string [ 1 .. 200 ] characters

Postal/zip code.

country
string or null [ 1 .. 200 ] characters

Country identifier.

shippingLeadTime
integer or null <int32> >= 0

Lead time for shipping contents.

primaryBilling
boolean

Signifies if this is a primary billing address.

primaryShipping
boolean

Signifies if this is a primary billing address.

email
string or null <email>

Email address

phone
string or null

Associated phone number

fax
string or null

Associated fax number

notes
string or null

General notes associated to this customer address

Responses

Request samples

Content type
{
  • "name": "string",
  • "address1": "string",
  • "address2": "string",
  • "address3": "string",
  • "city": "string",
  • "stateProvince": "string",
  • "postalCode": "string",
  • "country": "string",
  • "shippingLeadTime": 0,
  • "primaryBilling": true,
  • "primaryShipping": true,
  • "email": "[email protected]",
  • "phone": "string",
  • "fax": "string",
  • "notes": "string"
}

Response samples

Content type
{
  • "id": "string"
}

Delete a specific customer address

path Parameters
customerId
required
string = 24 characters
customerAddressId
required
string = 36 characters

Responses

Get a specific customer address

path Parameters
customerId
required
string = 24 characters
customerAddressId
required
string = 36 characters

Responses

Response samples

Content type
{
  • "name": "string",
  • "address1": "string",
  • "address2": "string",
  • "address3": "string",
  • "city": "string",
  • "stateProvince": "string",
  • "postalCode": "string",
  • "country": "string",
  • "shippingLeadTime": 0,
  • "primaryBilling": true,
  • "primaryShipping": true,
  • "id": "stringstringstringstringstringstring",
  • "email": "[email protected]",
  • "phone": "string",
  • "fax": "string",
  • "notes": "string"
}

Update a specific customer address

path Parameters
customerId
required
string = 24 characters
customerAddressId
required
string = 36 characters
Request Body schema:
name
string or null [ 1 .. 200 ] characters

Name of the address (Bob's Shipping, Primary, Reno Warehouse, etc).

address1
required
string [ 1 .. 200 ] characters

Primary address line.

address2
string or null [ 1 .. 200 ] characters

Second address line.

address3
string or null [ 1 .. 200 ] characters

Third address line.

city
required
string [ 1 .. 200 ] characters

Address city

stateProvince
string or null [ 1 .. 200 ] characters

Address state/province.

postalCode
required
string [ 1 .. 200 ] characters

Postal/zip code.

country
string or null [ 1 .. 200 ] characters

Country identifier.

shippingLeadTime
integer or null <int32> >= 0

Lead time for shipping contents.

primaryBilling
boolean

Signifies if this is a primary billing address.

primaryShipping
boolean

Signifies if this is a primary billing address.

email
string or null <email>

Email address

phone
string or null

Associated phone number

fax
string or null

Associated fax number

notes
string or null

General notes associated to this customer address

Responses

Request samples

Content type
{
  • "name": "string",
  • "address1": "string",
  • "address2": "string",
  • "address3": "string",
  • "city": "string",
  • "stateProvince": "string",
  • "postalCode": "string",
  • "country": "string",
  • "shippingLeadTime": 0,
  • "primaryBilling": true,
  • "primaryShipping": true,
  • "email": "[email protected]",
  • "phone": "string",
  • "fax": "string",
  • "notes": "string"
}

Get a list of addresses for a customer

path Parameters
customerId
required
string = 24 characters

Responses

Response samples

Content type
[
  • {
    }
]

Customer Contact

Create a new customer contact

path Parameters
customerId
required
string = 24 characters
Request Body schema:
firstName
required
string [ 1 .. 200 ] characters

First name

lastName
string or null [ 1 .. 200 ] characters

Last name

position
string or null [ 1 .. 200 ] characters

Position / Job Title

phone
string or null

Phone number

cellPhone
string or null

Cellphone number

email
string or null <email>

Email address

Responses

Request samples

Content type
{
  • "firstName": "string",
  • "lastName": "string",
  • "position": "string",
  • "phone": "string",
  • "cellPhone": "string",
  • "email": "[email protected]"
}

Response samples

Content type
{
  • "id": "string"
}

Delete a specific customer contact

path Parameters
customerId
required
string = 24 characters

The id of the customer to modify contacts for

contactId
required
string = 36 characters

The id of the customer contact.

Responses

Get a specific customer contact

path Parameters
customerId
required
string = 24 characters

The id of the customer to modify contacts for

contactId
required
string = 36 characters

The id of the customer contact.

Responses

Response samples

Content type
{
  • "id": "stringstringstringstringstringstring",
  • "firstName": "string",
  • "lastName": "string",
  • "position": "string",
  • "cellPhone": "string",
  • "phone": "string",
  • "email": "[email protected]"
}

Update a specific customer contact

path Parameters
customerId
required
string = 24 characters

The id of the customer to modify contacts for

contactId
required
string = 36 characters

The id of the customer contact.

Request Body schema:

The new data to apply to the given index

firstName
required
string [ 1 .. 200 ] characters

First name

lastName
string or null [ 1 .. 200 ] characters

Last name

position
string or null [ 1 .. 200 ] characters

Position / Job Title

phone
string or null

Phone number

cellPhone
string or null

Cellphone number

email
string or null <email>

Email address

Responses

Request samples

Content type
{
  • "firstName": "string",
  • "lastName": "string",
  • "position": "string",
  • "phone": "string",
  • "cellPhone": "string",
  • "email": "[email protected]"
}

Get a list of contacts for a customer

path Parameters
customerId
required
string = 24 characters

Responses

Response samples

Content type
[
  • {
    }
]

Department

Get a department.

path Parameters
id
required
string = 24 characters

Responses

Response samples

Content type
{
  • "id": "stringstringstringstring",
  • "name": "string",
  • "deleted": true,
  • "workCenters": [
    ]
}

Find departments based on search parameters.

query Parameters
Sort.Field
string non-empty

Sort field

Sort.Dir
string (CommonEnumSortDirectionEnum)
Enum: "ascending" "descending"

Sort direction

Skip
integer <int32> >= 0

Number of records to skip.

Take
integer <int32> [ 0 .. 1000 ]

Number of records to return (maximum)

Request Body schema:
ids
Array of strings or null

Filter departments based on matching ids.

name
string or null [ 1 .. 200 ] characters

Filter departments based on their name.

Responses

Request samples

Content type
{
  • "ids": [
    ],
  • "name": "string"
}

Response samples

Content type
[
  • {
    }
]

Equipment

Get a piece of equipment.

path Parameters
id
required
string = 24 characters

Responses

Response samples

Content type
{
  • "id": "stringstringstringstring",
  • "name": "string",
  • "description": "string",
  • "workCenterId": "stringstringstringstring",
  • "manufacturer": "string",
  • "modelNumber": "string",
  • "serialNumber": "string",
  • "canRunUnattended": true,
  • "unlimitedCapacity": true,
  • "status": "good",
  • "notes": "string",
  • "deleted": true
}

Find equipment based on search parameters.

query Parameters
Sort.Field
string non-empty

Sort field

Sort.Dir
string (CommonEnumSortDirectionEnum)
Enum: "ascending" "descending"

Sort direction

Skip
integer <int32> >= 0

Number of records to skip.

Take
integer <int32> [ 0 .. 1000 ]

Number of records to return (maximum)

Request Body schema:
ids
Array of strings or null

Filter equipment based on matching ids.

name
string or null [ 1 .. 200 ] characters

Filter equipment based on their name.

Responses

Request samples

Content type
{
  • "ids": [
    ],
  • "name": "string"
}

Response samples

Content type
[
  • {
    }
]

Gauge Code

Get a gauge code.

path Parameters
id
required
string = 24 characters

Responses

Response samples

Content type
{
  • "id": "stringstringstringstring",
  • "name": "string"
}

Find gauge codes based on search parameters.

query Parameters
Sort.Field
string non-empty

Sort field

Sort.Dir
string (CommonEnumSortDirectionEnum)
Enum: "ascending" "descending"

Sort direction

Skip
integer <int32> >= 0

Number of records to skip.

Take
integer <int32> [ 0 .. 1000 ]

Number of records to return (maximum)

Request Body schema:
name
string or null [ 1 .. 200 ] characters

Filter gauge codes based on their name.

ids
Array of strings or null

Filter gauge codes based on matching ids.

Responses

Request samples

Content type
{
  • "name": "string",
  • "ids": [
    ]
}

Response samples

Content type
[
  • {
    }
]

Grade Code

Get a grade code.

path Parameters
id
required
string = 24 characters

Responses

Response samples

Content type
{
  • "id": "stringstringstringstring",
  • "name": "string"
}

Find grade codes based on search parameters.

query Parameters
Sort.Field
string non-empty

Sort field

Sort.Dir
string (CommonEnumSortDirectionEnum)
Enum: "ascending" "descending"

Sort direction

Skip
integer <int32> >= 0

Number of records to skip.

Take
integer <int32> [ 0 .. 1000 ]

Number of records to return (maximum)

Request Body schema:
name
string or null [ 1 .. 200 ] characters

Filter grade codes based on their name.

ids
Array of strings or null

Filter grade codes based on matching ids.

Responses

Request samples

Content type
{
  • "name": "string",
  • "ids": [
    ]
}

Response samples

Content type
[
  • {
    }
]

Inventory

Find inventory based on search parameters.

query Parameters
Sort.Field
string non-empty

Sort field

Sort.Dir
string (CommonEnumSortDirectionEnum)
Enum: "ascending" "descending"

Sort direction

Skip
integer <int32> >= 0

Number of records to skip.

Take
integer <int32> [ 0 .. 1000 ]

Number of records to return (maximum)

Request Body schema:
lotIds
Array of strings or null

Filter inventory based on lot ids.

itemIds
Array of strings or null

Filter inventory based on item ids.

locationIds
Array of strings or null

Filter inventory based on location ids.

Responses

Request samples

Content type
{
  • "lotIds": [
    ],
  • "itemIds": [
    ],
  • "locationIds": [
    ]
}

Response samples

Content type
[
  • {
    }
]

Returns on hand counts by item. Excludes reserved inventory counts by default, but can be included by passing in the ```includeReservec``` query parameter. NOTE: If the response does not contain and item identifier, it means there is no quantity on hand.

query Parameters
includeReserved
boolean
Default: false

Whether to included reserved inventory into the counts

Responses

Response samples

Content type
{
  • "property1": 0,
  • "property2": 0
}

Override an inventory's quantity.

Request Body schema:

The parameters for the request

itemId
required
string = 24 characters

Item identifier.

quantity
required
number <double>

The quantity to set the item's inventory level to.

lotId
string or null

The lot identifier to apply this override to

locationId
string or null

The location identifier to apply this override to. null signifies no location.

note
string or null

The note to add to the override transaction.

Responses

Request samples

Content type
{
  • "itemId": "stringstringstringstring",
  • "quantity": 0,
  • "lotId": "string",
  • "locationId": "string",
  • "note": "string"
}

Pick inventory against a specific item.

Request Body schema:
itemId
required
string = 24 characters

Item identifier. Please reference /api/items endpoint.

secondaryType
required
string (InventoryPickEventSecondaryType)
Enum: "pick" "consume" "scrap" "stockAdjustmentDecrease" "otherDecrease"

Secondary event type specifically for picking.

quantity
required
number <double>

Quantity of the item to pick.

locationId
string or null = 24 characters

Location id that inventory is picked from. Please reference /api/locations endpoint

lotId
string or null = 24 characters

Lot identifier for this block of inventory. Please reference /api/inventory-lots endpoint

note
string or null [ 1 .. 2000 ] characters

Notes associated to this transaction.

Responses

Request samples

Content type
{
  • "itemId": "stringstringstringstring",
  • "secondaryType": "pick",
  • "quantity": 0,
  • "locationId": "stringstringstringstring",
  • "lotId": "stringstringstringstring",
  • "note": "string"
}

Receive inventory for a specific item.

Request Body schema:
itemId
required
string = 24 characters

Item identifier. Please reference /api/items endpoint.

secondaryType
required
string (InventoryReceiveEventSecondaryType)
Enum: "receive" "found" "stockAdjustmentIncrease" "otherIncrease"

Secondary event type specifically for receiving.

quantity
required
number <double>

Quantity of the item to receive.

locationId
string or null = 24 characters

Location id that inventory is received into. Please reference /api/locations endpoint

lotId
string or null = 24 characters

Lot identifier for this block of inventory. Please reference /api/inventory-lots endpoint

note
string or null [ 1 .. 2000 ] characters

Notes associated to this transaction.

Responses

Request samples

Content type
{
  • "itemId": "stringstringstringstring",
  • "secondaryType": "receive",
  • "quantity": 0,
  • "locationId": "stringstringstringstring",
  • "lotId": "stringstringstringstring",
  • "note": "string"
}

Inventory Lot

Create a new inventory lot.

Request Body schema:
name
string or null [ 1 .. 200 ] characters

The name of the lot. It is not guaranteed to be unique inventory-wide, but only within an item.

itemId
required
string = 24 characters

The item id that is associated to this lot. Please reference /api/items endpoint.

expirationDate
string or null <date-time>

The date that this lot is supposed to expire.

Responses

Request samples

Content type
{
  • "name": "string",
  • "itemId": "stringstringstringstring",
  • "expirationDate": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "id": "string"
}

Get an inventory lot.

path Parameters
id
required
string = 24 characters

Responses

Response samples

Content type
{
  • "id": "stringstringstringstring",
  • "name": "string",
  • "itemId": "stringstringstringstring",
  • "quantity": 0,
  • "system": true,
  • "custom": true,
  • "expirationDate": "2019-08-24T14:15:22Z"
}

Find inventory lots based on search parameters.

query Parameters
Sort.Field
string non-empty

Sort field

Sort.Dir
string (CommonEnumSortDirectionEnum)
Enum: "ascending" "descending"

Sort direction

Skip
integer <int32> >= 0

Number of records to skip.

Take
integer <int32> [ 0 .. 1000 ]

Number of records to return (maximum)

Request Body schema:
name
string or null [ 1 .. 200 ] characters

Filter lots based on their name.

itemIds
Array of strings or null

Item ids to match. Please reference /api/items endpoint.

system
boolean or null

Filter by whether the lot is considered a system-generated lot.

Responses

Request samples

Content type
{
  • "name": "string",
  • "itemIds": [
    ],
  • "system": true
}

Response samples

Content type
[
  • {
    }
]

Inventory Transactions

Finds inventory transactions based on search parameters

query Parameters
Sort.Field
string non-empty

Sort field

Sort.Dir
string (CommonEnumSortDirectionEnum)
Enum: "ascending" "descending"

Sort direction

Skip
integer <int32> >= 0

Number of records to skip.

Take
integer <int32> [ 0 .. 1000 ]

Number of records to return (maximum)

Request Body schema:
itemIds
Array of strings or null

Filter inventory transactions based on item identifiers.

object (DtoCommonDateRangeFilter)

Date range used for filters

sourceType
string (V2InventoryDataEventSourceType)
Enum: "purchaseOrder" "job" "shipment" "shipmentLineItem" "shipping" "receiving" "item" "workOrder" "salesOrder" "jobOperation" "workOrderOperation" "fulfillment" "itemToMakeMaterialRemnant"
relatedEntityType
string (V2InventoryDataEventSourceType)
Enum: "purchaseOrder" "job" "shipment" "shipmentLineItem" "shipping" "receiving" "item" "workOrder" "salesOrder" "jobOperation" "workOrderOperation" "fulfillment" "itemToMakeMaterialRemnant"
relatedEntityId
string or null

The transaction's related entity identifier

Responses

Request samples

Content type
{
  • "itemIds": [
    ],
  • "dateRange": {
    },
  • "sourceType": "purchaseOrder",
  • "relatedEntityType": "purchaseOrder",
  • "relatedEntityId": "string"
}

Response samples

Content type
{
  • "data": [
    ],
  • "page": 0,
  • "pageSize": 0,
  • "totalCount": 0,
  • "totalPages": 0,
  • "hasPreviousPage": true,
  • "hasNextPage": true
}

Invoice

Get a specific invoice

path Parameters
invoiceId
required
string = 24 characters

Responses

Response samples

Content type
{
  • "id": "stringstringstringstring",
  • "number": 0,
  • "issueDate": "2019-08-24T14:15:22Z",
  • "status": "new",
  • "externalReferences": {
    },
  • "customerId": "stringstringstringstring",
  • "paymentTermsId": "stringstringstringstring",
  • "companyInfoId": "stringstringstringstring",
  • "salesOrderId": "stringstringstringstring",
  • "customerPONumber": "string",
  • "dueDate": "2019-08-24T14:15:22Z",
  • "total": 0,
  • "subtotal": 0,
  • "notesToCustomer": "string",
  • "billingAddress": {
    },
  • "customFields": {
    },
  • "deleted": true
}

Partially update an invoice

path Parameters
invoiceId
required
string = 24 characters
Request Body schema: application/json-patch+json
Array
op
string
value
string
path
string

Responses

Request samples

Content type
application/json-patch+json
[
  • {
    }
]

Response samples

Content type
{
  • "id": "stringstringstringstring",
  • "number": 0,
  • "issueDate": "2019-08-24T14:15:22Z",
  • "status": "new",
  • "externalReferences": {
    },
  • "customerId": "stringstringstringstring",
  • "paymentTermsId": "stringstringstringstring",
  • "companyInfoId": "stringstringstringstring",
  • "salesOrderId": "stringstringstringstring",
  • "customerPONumber": "string",
  • "dueDate": "2019-08-24T14:15:22Z",
  • "total": 0,
  • "subtotal": 0,
  • "notesToCustomer": "string",
  • "billingAddress": {
    },
  • "customFields": {
    },
  • "deleted": true
}

Update an invoice

path Parameters
invoiceId
required
string = 24 characters
Request Body schema:
object or null

Arbitrary key-value-pair like data that can be used to later on search for this line item.

additional property
object (CommonExternalReferenceDto)

The external reference for entities that implement FulcrumProduct.Domain.Common.IHasExternalReferences

type
string or null [ 0 .. 50 ] characters

Specifies the type of this identifier.

externalId
required
string [ 0 .. 500 ] characters

The external identifier

displayId
string or null [ 0 .. 500 ] characters

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
string or null

A status for the external reference

url
string or null

An external url for the reference

modifiedUtc
string or null <date-time>

Date the external reference was modified

Responses

Request samples

Content type
{
  • "externalReferences": {
    }
}

Response samples

Content type
{
  • "id": "stringstringstringstring",
  • "number": 0,
  • "issueDate": "2019-08-24T14:15:22Z",
  • "status": "new",
  • "externalReferences": {
    },
  • "customerId": "stringstringstringstring",
  • "paymentTermsId": "stringstringstringstring",
  • "companyInfoId": "stringstringstringstring",
  • "salesOrderId": "stringstringstringstring",
  • "customerPONumber": "string",
  • "dueDate": "2019-08-24T14:15:22Z",
  • "total": 0,
  • "subtotal": 0,
  • "notesToCustomer": "string",
  • "billingAddress": {
    },
  • "customFields": {
    },
  • "deleted": true
}

Find invoices based on search parameters.

query Parameters
Sort.Field
string non-empty

Sort field

Sort.Dir
string (CommonEnumSortDirectionEnum)
Enum: "ascending" "descending"

Sort direction

Skip
integer <int32> >= 0

Number of records to skip.

Take
integer <int32> [ 0 .. 1000 ]

Number of records to return (maximum)

Request Body schema:
numbers
Array of integers or null <int32> [ 1 .. 500 ] items

Filter invoices to only given numbers

object (CommonExternalReferenceFindDto)

Search parameter for identifier record(s) via their external identifiers.

status
string (InvoiceStatusEnum)
Enum: "new" "needsApproval" "approved" "issued" "paid"

Invoice status

Responses

Request samples

Content type
{
  • "numbers": [
    ],
  • "externalReference": {
    },
  • "status": "new"
}

Response samples

Content type
[
  • {
    }
]

Update an invoice status

path Parameters
invoiceId
required
string = 24 characters
Request Body schema:
status
required
string (InvoiceStatusEnum)
Enum: "new" "needsApproval" "approved" "issued" "paid"

Invoice status

paidDate
string or null <date-time>

The date that the invoice was paid.

Responses

Request samples

Content type
{
  • "status": "new",
  • "paidDate": "2019-08-24T14:15:22Z"
}

Invoice Deposit Adjustment Line Item

Get a specific deposit adjustment line item for an invoice

path Parameters
invoiceId
required
string = 24 characters
lineItemId
required
string = 36 characters

Responses

Response samples

Content type
{
  • "id": "stringstringstringstringstringstring",
  • "name": "string",
  • "description": "string",
  • "price": 0,
  • "accountingCodeId": "stringstringstringstring",
  • "externalReferences": {
    },
  • "salesOrderLineItemId": "stringstringstringstringstringstring"
}

Get a list of deposit adjustment lines items for an invoice

path Parameters
invoiceId
required
string = 24 characters

Responses

Response samples

Content type
[
  • {
    }
]

Invoice Deposit Line Item

Get a specific deposit line item for an invoice

path Parameters
invoiceId
required
string = 24 characters
lineItemId
required
string = 36 characters

Responses

Response samples

Content type
{
  • "id": "stringstringstringstringstringstring",
  • "name": "string",
  • "description": "string",
  • "amount": 0,
  • "accountingCodeId": "stringstringstringstring",
  • "externalReferences": {
    },
  • "salesOrderLineItemId": "stringstringstringstringstringstring"
}

Get a list of deposit lines items for an invoice

path Parameters
invoiceId
required
string = 24 characters

Responses

Response samples

Content type
[
  • {
    }
]

Invoice Discount Line Item

Get the discount line item for an invoice

path Parameters
invoiceId
required
string = 24 characters

Responses

Response samples

Content type
{
  • "id": "stringstringstringstringstringstring",
  • "name": "string",
  • "description": "string",
  • "isPercentage": true,
  • "amount": 0,
  • "externalReferences": {
    }
}

Invoice Fee Line Item

Get a specific fee line item for an invoice

path Parameters
invoiceId
required
string = 24 characters
lineItemId
required
string = 36 characters

Responses

Response samples

Content type
{
  • "id": "stringstringstringstringstringstring",
  • "name": "string",
  • "description": "string",
  • "quantity": 0,
  • "price": 0,
  • "unitOfMeasure": "notApplicable",
  • "accountingCodeId": "stringstringstringstring",
  • "isTaxable": true,
  • "overrideTaxRate": true,
  • "taxCodeId": "stringstringstringstring",
  • "taxRate": 0,
  • "externalReferences": {
    },
  • "salesOrderLineItemId": "stringstringstringstringstringstring"
}

Partially update a specific fee line item for a purchase order

path Parameters
invoiceId
required
string = 24 characters
lineItemId
required
string = 36 characters
Request Body schema: application/json-patch+json
Array
op
string
value
string
path
string

Responses

Request samples

Content type
application/json-patch+json
[
  • {
    }
]

Response samples

Content type
{
  • "id": "stringstringstringstringstringstring",
  • "name": "string",
  • "description": "string",
  • "quantity": 0,
  • "price": 0,
  • "unitOfMeasure": "notApplicable",
  • "accountingCodeId": "stringstringstringstring",
  • "isTaxable": true,
  • "overrideTaxRate": true,
  • "taxCodeId": "stringstringstringstring",
  • "taxRate": 0,
  • "externalReferences": {
    },
  • "salesOrderLineItemId": "stringstringstringstringstringstring"
}

Update a specific fee line item for an invoice

path Parameters
invoiceId
required
string = 24 characters
lineItemId
required
string = 36 characters
Request Body schema:
object or null

Arbitrary key-value-pair like data that can be used to later on search for this line item.

additional property
object (CommonExternalReferenceDto)

The external reference for entities that implement FulcrumProduct.Domain.Common.IHasExternalReferences

type
string or null [ 0 .. 50 ] characters

Specifies the type of this identifier.

externalId
required
string [ 0 .. 500 ] characters

The external identifier

displayId
string or null [ 0 .. 500 ] characters

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
string or null

A status for the external reference

url
string or null

An external url for the reference

modifiedUtc
string or null <date-time>

Date the external reference was modified

Responses

Request samples

Content type
{
  • "externalReferences": {
    }
}

Response samples

Content type
{
  • "id": "stringstringstringstringstringstring",
  • "name": "string",
  • "description": "string",
  • "quantity": 0,
  • "price": 0,
  • "unitOfMeasure": "notApplicable",
  • "accountingCodeId": "stringstringstringstring",
  • "isTaxable": true,
  • "overrideTaxRate": true,
  • "taxCodeId": "stringstringstringstring",
  • "taxRate": 0,
  • "externalReferences": {
    },
  • "salesOrderLineItemId": "stringstringstringstringstringstring"
}

Get a list of fee lines items for an invoice

path Parameters
invoiceId
required
string = 24 characters

Responses

Response samples

Content type
[
  • {
    }
]

Invoice Line Item

Get a specific line item for an invoice of generic type

path Parameters
invoiceId
required
string = 24 characters
lineItemId
required
string = 36 characters

Responses

Response samples

Content type
{
  • "id": "stringstringstringstringstringstring",
  • "type": "part",
  • "quantity": 0,
  • "price": 0,
  • "discountedPrice": 0,
  • "subtotal": 0,
  • "discountedSubtotal": 0,
  • "name": "string",
  • "description": "string",
  • "accountingCodeId": "stringstringstringstring",
  • "taxCodeId": "stringstringstringstring",
  • "salesOrderLineItemId": "stringstringstringstringstringstring",
  • "externalReferences": {
    },
  • "isTaxable": true
}

Get a list of lines items for an invoice, regardless of type

path Parameters
invoiceId
required
string = 24 characters

Responses

Response samples

Content type
[
  • {
    }
]

Invoice Note

TO BE REMOVED 08/18/2023 - Get a list of notes for an invoice Deprecated

Use root /note API instead

path Parameters
invoiceId
required
string = 24 characters

Responses

Response samples

Content type
[
  • {
    }
]

Invoice Part Line Item

Get a specific part line item for an invoice

path Parameters
invoiceId
required
string = 24 characters
lineItemId
required
string = 36 characters

Responses

Response samples

Content type
{
  • "id": "stringstringstringstringstringstring",
  • "name": "string",
  • "quantity": 0,
  • "price": 0,
  • "discountedPrice": 0,
  • "overrideTaxRate": true,
  • "isTaxable": true,
  • "taxCodeId": "stringstringstringstring",
  • "taxRate": 0,
  • "itemId": "stringstringstringstring",
  • "description": "string",
  • "externalReferences": {
    },
  • "accountingCodeId": "stringstringstringstring",
  • "salesOrderLineItemId": "stringstringstringstringstringstring",
  • "subTotal": 0,
  • "preDiscountSubTotal": 0,
  • "isPercentageDiscount": true,
  • "discountAmount": 0,
  • "customerPartNumber": "string",
  • "customerPartDescription": "string"
}

Partially update a specific part line item for an invoice

path Parameters
invoiceId
required
string = 24 characters
lineItemId
required
string = 36 characters
Request Body schema: application/json-patch+json
Array
op
string
value
string
path
string

Responses

Request samples

Content type
application/json-patch+json
[
  • {
    }
]

Response samples

Content type
{
  • "id": "stringstringstringstringstringstring",
  • "name": "string",
  • "quantity": 0,
  • "price": 0,
  • "discountedPrice": 0,
  • "overrideTaxRate": true,
  • "isTaxable": true,
  • "taxCodeId": "stringstringstringstring",
  • "taxRate": 0,
  • "itemId": "stringstringstringstring",
  • "description": "string",
  • "externalReferences": {
    },
  • "accountingCodeId": "stringstringstringstring",
  • "salesOrderLineItemId": "stringstringstringstringstringstring",
  • "subTotal": 0,
  • "preDiscountSubTotal": 0,
  • "isPercentageDiscount": true,
  • "discountAmount": 0,
  • "customerPartNumber": "string",
  • "customerPartDescription": "string"
}

Update a specific part line item for an invoice

path Parameters
invoiceId
required
string = 24 characters
lineItemId
required
string = 36 characters
Request Body schema:
object or null

Arbitrary key-value-pair like data that can be used to later on search for this line item.

additional property
object (CommonExternalReferenceDto)

The external reference for entities that implement FulcrumProduct.Domain.Common.IHasExternalReferences

type
string or null [ 0 .. 50 ] characters

Specifies the type of this identifier.

externalId
required
string [ 0 .. 500 ] characters

The external identifier

displayId
string or null [ 0 .. 500 ] characters

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
string or null

A status for the external reference

url
string or null

An external url for the reference

modifiedUtc
string or null <date-time>

Date the external reference was modified

Responses

Request samples

Content type
{
  • "externalReferences": {
    }
}

Response samples

Content type
{
  • "id": "stringstringstringstringstringstring",
  • "name": "string",
  • "quantity": 0,
  • "price": 0,
  • "discountedPrice": 0,
  • "overrideTaxRate": true,
  • "isTaxable": true,
  • "taxCodeId": "stringstringstringstring",
  • "taxRate": 0,
  • "itemId": "stringstringstringstring",
  • "description": "string",
  • "externalReferences": {
    },
  • "accountingCodeId": "stringstringstringstring",
  • "salesOrderLineItemId": "stringstringstringstringstringstring",
  • "subTotal": 0,
  • "preDiscountSubTotal": 0,
  • "isPercentageDiscount": true,
  • "discountAmount": 0,
  • "customerPartNumber": "string",
  • "customerPartDescription": "string"
}

Get a list of part lines items for an invoice

path Parameters
invoiceId
required
string = 24 characters

Responses

Response samples

Content type
[
  • {
    }
]

Invoice Refund Line Item

Get a specific refund line item for an invoice

path Parameters
invoiceId
required
string = 24 characters
lineItemId
required
string = 36 characters

Responses

Response samples

Content type
{
  • "id": "stringstringstringstringstringstring",
  • "quantity": 0,
  • "price": 0,
  • "itemId": "stringstringstringstring",
  • "name": "string",
  • "description": "string",
  • "externalReferences": {
    },
  • "salesOrderLineItemId": "stringstringstringstringstringstring",
  • "accountingCodeId": "stringstringstringstring"
}

Partially update a specific refund line item for a purchase order

path Parameters
invoiceId
required
string = 24 characters
lineItemId
required
string = 36 characters
Request Body schema: application/json-patch+json
Array
op
string
value
string
path
string

Responses

Request samples

Content type
application/json-patch+json
[
  • {
    }
]

Response samples

Content type
{
  • "id": "stringstringstringstringstringstring",
  • "quantity": 0,
  • "price": 0,
  • "itemId": "stringstringstringstring",
  • "name": "string",
  • "description": "string",
  • "externalReferences": {
    },
  • "salesOrderLineItemId": "stringstringstringstringstringstring",
  • "accountingCodeId": "stringstringstringstring"
}

Update a specific refund line item for an invoice

path Parameters
invoiceId
required
string = 24 characters
lineItemId
required
string = 36 characters
Request Body schema:
object or null

Arbitrary key-value-pair like data that can be used to later on search for this line item.

additional property
object (CommonExternalReferenceDto)

The external reference for entities that implement FulcrumProduct.Domain.Common.IHasExternalReferences

type
string or null [ 0 .. 50 ] characters

Specifies the type of this identifier.

externalId
required
string [ 0 .. 500 ] characters

The external identifier

displayId
string or null [ 0 .. 500 ] characters

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
string or null

A status for the external reference

url
string or null

An external url for the reference

modifiedUtc
string or null <date-time>

Date the external reference was modified

Responses

Request samples

Content type
{
  • "externalReferences": {
    }
}

Response samples

Content type
{
  • "id": "stringstringstringstringstringstring",
  • "quantity": 0,
  • "price": 0,
  • "itemId": "stringstringstringstring",
  • "name": "string",
  • "description": "string",
  • "externalReferences": {
    },
  • "salesOrderLineItemId": "stringstringstringstringstringstring",
  • "accountingCodeId": "stringstringstringstring"
}

Get a list of refund lines items for an invoice

path Parameters
invoiceId
required
string = 24 characters

Responses

Response samples

Content type
[
  • {
    }
]

Invoice Shipping Charge Line Item

Get the shipping charge line item for an invoice

path Parameters
invoiceId
required
string = 24 characters

Responses

Response samples

Content type
{
  • "id": "stringstringstringstringstringstring",
  • "name": "string",
  • "description": "string",
  • "amount": 0,
  • "isTaxable": true,
  • "overrideTaxRate": true,
  • "taxCodeId": "stringstringstringstring",
  • "taxRate": 0,
  • "externalReferences": {
    },
  • "salesOrderLineItemId": "stringstringstringstringstringstring"
}

Invoice Tax Line Item

Get a specific tax line item for an invoice

path Parameters
invoiceId
required
string = 24 characters
lineItemId
required
string = 36 characters

Responses

Response samples

Content type
{
  • "id": "stringstringstringstringstringstring",
  • "description": "string",
  • "taxCodeId": "stringstringstringstring",
  • "taxRate": 0,
  • "avalaraOptions": {
    },
  • "externalReferences": {
    },
  • "price": 0,
  • "salesOrderLineItemId": "stringstringstringstringstringstring",
  • "taxCodeEditable": true
}

Get a list of tax lines items for an invoice

path Parameters
invoiceId
required
string = 24 characters

Responses

Response samples

Content type
[
  • {
    }
]

Item

Add a revision to an item

path Parameters
itemId
required
string = 24 characters
Request Body schema:
revision
required
string [ 1 .. 200 ] characters

The revision to be created.

archiveSourceItem
boolean or null

Indicate whether we should archive the source item. This will default to false.

Responses

Request samples

Content type
{
  • "revision": "string",
  • "archiveSourceItem": true
}

Response samples

Content type
{
  • "id": "string"
}

Create a new item

Request Body schema:
number
required
string [ 1 .. 200 ] characters

The name to give the item. Must be unique to all active items.

description
required
string [ 1 .. 2000 ] characters

The verbose description to give the item.

revision
string or null [ 1 .. 200 ] characters

Revision name

itemOrigin
required
string (DomainItemsAndInventoryItemOrigin)
Enum: "make" "buy" "makeOrBuy" "customerSupplied" "kit" "none"
unitTypeName
required
string non-empty

The unit of measure type, ex: Pieces, Volume, Weight, Area

unitOfMeasureName
required
string non-empty

The unit of measure name. Options available depend on the selected UnitTypeName. For Pieces, you might have a UOM of Piece, Set or Case. For Volume options include Liter, Milliliter, etc.

isSellable
boolean

Define if this item is able to be sold/sellable.

accountingCodeId
string or null = 24 characters

Accounting code key identifier. Please reference /api/accounting-codes endpoint.

accountingCode2Id
string or null = 24 characters

Accounting code key identifier. Please reference /api/accounting-codes endpoint.

materialCodeId
string or null = 24 characters

Item material code key identifier. Please reference /api/material-codes endpoint.

gradeId
string or null = 24 characters

Item grade code key identifier. Please reference /api/grade-codes endpoint.

shapeId
string or null = 24 characters

Item shape code key identifier. Please reference /api/shape-codes endpoint.

gaugeId
string or null = 24 characters

Item gauge code key identifier. Please reference /api/gauge-codes endpoint.

width
number or null <double> >= 0

Item width

height
number or null <double> >= 0

Item height

length
number or null <double> >= 0

Item length

minimumStockOnHand
number or null <double> >= 0

Item minimum stock on hand.

minimumProductionQuantity
number or null <double> >= 0

Item minimum production quantity for a manufacturing run.

internalNotes
string or null [ 1 .. 2000 ] characters

Internal item notes.

Array of objects or null (CommonUnitOfMeasureConversionDto)

Unit of measure conversions for sellable items.

isTaxable
boolean or null

Whether or not this item is taxable (default)

Responses

Request samples

Content type
{
  • "number": "string",
  • "description": "string",
  • "revision": "string",
  • "itemOrigin": "make",
  • "unitTypeName": "string",
  • "unitOfMeasureName": "string",
  • "isSellable": true,
  • "accountingCodeId": "stringstringstringstring",
  • "accountingCode2Id": "stringstringstringstring",
  • "materialCodeId": "stringstringstringstring",
  • "gradeId": "stringstringstringstring",
  • "shapeId": "stringstringstringstring",
  • "gaugeId": "stringstringstringstring",
  • "width": 0,
  • "height": 0,
  • "length": 0,
  • "minimumStockOnHand": 0,
  • "minimumProductionQuantity": 0,
  • "internalNotes": "string",
  • "salesUnitOfMeasureConversions": [
    ],
  • "isTaxable": true
}

Response samples

Content type
{
  • "id": "string"
}

Get a specific item

path Parameters
itemId
required
string = 24 characters

Responses

Response samples

Content type
{
  • "id": "stringstringstringstring",
  • "number": "string",
  • "description": "string",
  • "revision": {
    },
  • "barCodeNumber": "string",
  • "isSellable": true,
  • "itemOrigin": "make",
  • "unitTypeName": "string",
  • "unitOfMeasureName": "string",
  • "isArchived": true,
  • "accountingCodeId": "stringstringstringstring",
  • "accountingCode2Id": "stringstringstringstring",
  • "materialCodeId": "stringstringstringstring",
  • "gradeId": "stringstringstringstring",
  • "shapeId": "stringstringstringstring",
  • "gaugeId": "stringstringstringstring",
  • "categoryId": "string",
  • "width": 0,
  • "height": 0,
  • "length": 0,
  • "minimumStockOnHand": 0,
  • "minimumProductionQuantity": 0,
  • "customFields": {
    },
  • "tags": [
    ],
  • "internalNotes": "string",
  • "salesUnitOfMeasureConversions": [
    ],
  • "externalReferences": {
    },
  • "isTaxable": true
}

Update a specific item

path Parameters
itemId
required
string = 24 characters
Request Body schema:
description
string or null [ 1 .. 2000 ] characters

Item description.

accountingCodeId
string or null = 24 characters

Accounting code key identifier. Please reference /api/accounting-codes endpoint.

accountingCode2Id
string or null = 24 characters

Accounting code key identifier. Please reference /api/accounting-codes endpoint.

materialCodeId
string or null = 24 characters

Item material code key identifier. Please reference /api/material-codes endpoint.

gradeId
string or null = 24 characters

Item grade code key identifier. Please reference /api/grade-codes endpoint.

shapeId
string or null = 24 characters

Item shape code key identifier. Please reference /api/shape-codes endpoint.

gaugeId
string or null = 24 characters

Item gauge code key identifier. Please reference /api/gauge-codes endpoint.

width
number or null <double> >= 0

Item width

height
number or null <double> >= 0

Item height

length
number or null <double> >= 0

Item length

minimumStockOnHand
number or null <double> >= 0

Item minimum stock on hand.

minimumProductionQuantity
number or null <double> >= 0

Item minimum production quantity for a manufacturing run.

internalNotes
string or null [ 1 .. 2000 ] characters

Internal item notes.

Array of objects or null (CommonUnitOfMeasureConversionDto)

Unit of measure conversions for sellable items.

isTaxable
boolean or null

Whether or not this item is taxable (default)

Responses

Request samples

Content type
{
  • "description": "string",
  • "accountingCodeId": "stringstringstringstring",
  • "accountingCode2Id": "stringstringstringstring",
  • "materialCodeId": "stringstringstringstring",
  • "gradeId": "stringstringstringstring",
  • "shapeId": "stringstringstringstring",
  • "gaugeId": "stringstringstringstring",
  • "width": 0,
  • "height": 0,
  • "length": 0,
  • "minimumStockOnHand": 0,
  • "minimumProductionQuantity": 0,
  • "internalNotes": "string",
  • "salesUnitOfMeasureConversions": [
    ],
  • "isTaxable": true
}

Response samples

Content type
{
  • "id": "stringstringstringstring",
  • "number": "string",
  • "description": "string",
  • "revision": {
    },
  • "barCodeNumber": "string",
  • "isSellable": true,
  • "itemOrigin": "make",
  • "unitTypeName": "string",
  • "unitOfMeasureName": "string",
  • "isArchived": true,
  • "accountingCodeId": "stringstringstringstring",
  • "accountingCode2Id": "stringstringstringstring",
  • "materialCodeId": "stringstringstringstring",
  • "gradeId": "stringstringstringstring",
  • "shapeId": "stringstringstringstring",
  • "gaugeId": "stringstringstringstring",
  • "categoryId": "string",
  • "width": 0,
  • "height": 0,
  • "length": 0,
  • "minimumStockOnHand": 0,
  • "minimumProductionQuantity": 0,
  • "customFields": {
    },
  • "tags": [
    ],
  • "internalNotes": "string",
  • "salesUnitOfMeasureConversions": [
    ],
  • "externalReferences": {
    },
  • "isTaxable": true
}

TO BE REMOVED 11/02/2023 - Find items based on search parameters. Deprecated

Use V2 which includes a list of number filters

query Parameters
Sort.Field
string non-empty

Sort field

Sort.Dir
string (CommonEnumSortDirectionEnum)
Enum: "ascending" "descending"

Sort direction

Skip
integer <int32> >= 0

Number of records to skip.

Take
integer <int32> [ 0 .. 1000 ]

Number of records to return (maximum)

Request Body schema:
number
string or null [ 1 .. 200 ] characters

Filter to items who's number contains the given string

revision
string or null [ 1 .. 200 ] characters

Filter to items who's revision matches the given string

object (CommonCustomFieldSearchDto)

Custom field associated to an entity.

latestRevision
boolean

Indicate whether we want the latest revision(s) of the items.

itemIds
Array of strings or null

Filter to items whose ids are in the list

descriptionFilter
string or null

Filter items by description. Use (escaped) double-quotes to filter by exact phrase, e.g., \"search phrase\". Prepend search term with "-" to exclude

isArchived
boolean or null

Include or exclude archived items

Responses

Request samples

Content type
{
  • "number": "string",
  • "revision": "string",
  • "customField": {
    },
  • "latestRevision": true,
  • "itemIds": [
    ],
  • "descriptionFilter": "string",
  • "isArchived": true
}

Response samples

Content type
[
  • {
    }
]

Find items based on search parameters.

query Parameters
Sort.Field
string non-empty

Sort field

Sort.Dir
string (CommonEnumSortDirectionEnum)
Enum: "ascending" "descending"

Sort direction

Skip
integer <int32> >= 0

Number of records to skip.

Take
integer <int32> [ 0 .. 1000 ]

Number of records to return (maximum)

Request Body schema:
Array of objects or null (ItemNumberFilter) <= 50 items

Filter items based on numbers

object (CommonCustomFieldSearchDto)

Custom field associated to an entity.

Array of objects or null (CommonCustomFieldSearchDto) <= 50 items

Filter items based on custom fields Note: these will be OR'd with each other and are not additive in filtering.

latestRevision
boolean

Indicate whether we want the latest revision(s) of the items.

itemIds
Array of strings or null <= 50 items

Filter to items whose ids are in the list

descriptionFilter
string or null

Filter items by description. Use (escaped) double-quotes to filter by exact phrase, e.g., \"search phrase\". Prepend search term with "-" to exclude

isArchived
boolean or null

Include or exclude archived items

includeUsageData
boolean

If set to true, data on where the item is being used will be included in the results

includeVendorData
boolean

If set to true, vendor details about the item will be included in the results

Responses

Request samples

Content type
{
  • "numbers": [
    ],
  • "customField": {
    },
  • "customFields": [
    ],
  • "latestRevision": true,
  • "itemIds": [
    ],
  • "descriptionFilter": "string",
  • "isArchived": true,
  • "includeUsageData": true,
  • "includeVendorData": true
}

Response samples

Content type
[
  • {
    }
]

TO BE REMOVED 10/13/2023 - Pick inventory against a specific item. Deprecated

Use /inventory/pick API instead

path Parameters
itemId
required
string = 24 characters
Request Body schema:
secondaryType
required
string (InventoryEventSecondaryType)
Enum: "pick" "receive" "override" "revert" "deposit" "create" "consume" "ship" "sold" "transferOut" "transferIn" "found" "expired" "damaged" "lost" "returnVendor" "returnStock" "receivedNoPo" "returnIncrease" "returnDecrease" "otherIncrease" "otherDecrease" "scrap" "waste" "transferredFromSalesOrder" "overrideItemValue" "transferFromLot" "transferToLot" "stockAdjustmentIncrease" "stockAdjustmentDecrease" "stockTake"

Secondary, verbose description for an event.

lotId
string or null = 24 characters

Lot identifier for this block of inventory.

locationId
string or null = 24 characters

Location id that inventory is placed into.

quantity
number or null <double> >= 0

Location id that inventory is placed into.

actionDate
string or null <date-time>

The moment in time where this inventory event action occurs. If not provided, this will default to the current date/time.

source
string (InventoryEnumEventSourceType)
Enum: "purchaseOrder" "job" "shipment" "shipping" "receiving" "item" "workOrder" "salesOrder" "jobOperation" "workOrderOperation"

Indicator for the initial source of the event.

url
string or null <uri>

The source url of the event.

relatedSource
string (InventoryEnumEventSourceType)
Enum: "purchaseOrder" "job" "shipment" "shipping" "receiving" "item" "workOrder" "salesOrder" "jobOperation" "workOrderOperation"

Indicator for the initial source of the event.

relatedEntityId
string or null

Entity id for tying this event back to a related entity.

note
string or null

Notes associated to this transaction.

Responses

Request samples

Content type
{
  • "secondaryType": "pick",
  • "lotId": "stringstringstringstring",
  • "locationId": "stringstringstringstring",
  • "quantity": 0,
  • "actionDate": "2019-08-24T14:15:22Z",
  • "source": "purchaseOrder",
  • "url": "http://example.com",
  • "relatedSource": "purchaseOrder",
  • "relatedEntityId": "string",
  • "note": "string"
}

TO BE REMOVED 10/13/2023 - Receive inventory against a specific item. Deprecated

Use /inventory/receive API instead

path Parameters
itemId
required
string = 24 characters
Request Body schema:
secondaryType
required
string (InventoryEventSecondaryType)
Enum: "pick" "receive" "override" "revert" "deposit" "create" "consume" "ship" "sold" "transferOut" "transferIn" "found" "expired" "damaged" "lost" "returnVendor" "returnStock" "receivedNoPo" "returnIncrease" "returnDecrease" "otherIncrease" "otherDecrease" "scrap" "waste" "transferredFromSalesOrder" "overrideItemValue" "transferFromLot" "transferToLot" "stockAdjustmentIncrease" "stockAdjustmentDecrease" "stockTake"

Secondary, verbose description for an event.

lotId
string or null = 24 characters

Lot identifier for this block of inventory.

locationId
string or null = 24 characters

Location id that inventory is placed into.

quantity
number or null <double> >= 0

Location id that inventory is placed into.

actionDate
string or null <date-time>

The moment in time where this inventory event action occurs. If not provided, this will default to the current date/time.

source
string (InventoryEnumEventSourceType)
Enum: "purchaseOrder" "job" "shipment" "shipping" "receiving" "item" "workOrder" "salesOrder" "jobOperation" "workOrderOperation"

Indicator for the initial source of the event.

url
string or null <uri>

The source url of the event.

relatedSource
string (InventoryEnumEventSourceType)
Enum: "purchaseOrder" "job" "shipment" "shipping" "receiving" "item" "workOrder" "salesOrder" "jobOperation" "workOrderOperation"

Indicator for the initial source of the event.

relatedEntityId
string or null

Entity id for tying this event back to a related entity.

note
string or null

Notes associated to this transaction.

Responses

Request samples

Content type
{
  • "secondaryType": "pick",
  • "lotId": "stringstringstringstring",
  • "locationId": "stringstringstringstring",
  • "quantity": 0,
  • "actionDate": "2019-08-24T14:15:22Z",
  • "source": "purchaseOrder",
  • "url": "http://example.com",
  • "relatedSource": "purchaseOrder",
  • "relatedEntityId": "string",
  • "note": "string"
}

Item Custom Fields

Update (selectively) custom fields on an item.

path Parameters
itemId
required
string = 24 characters

The Item identifier

Request Body schema:

The custom fields to update

object

The custom fields

property name*
additional property
any

Responses

Request samples

Content type
{
  • "customFields": {
    }
}

Response samples

Content type
{
  • "customFields": {
    }
}

Update (selectively) custom fields on an item.

path Parameters
itemId
required
string = 24 characters

The Item identifier

Request Body schema:

The custom fields to update

object

The custom fields

property name*
additional property
any

Responses

Request samples

Content type
{
  • "customFields": {
    }
}

Response samples

Content type
{
  • "customFields": {
    }
}

Item Routing

Get a specific item routing input item

path Parameters
itemId
required
string = 24 characters

Responses

Response samples

Content type
{
  • "allowContinuousFlow": true
}

Update a specific item's routing

path Parameters
itemId
required
string = 24 characters
Request Body schema:
allowContinuousFlow
boolean or null

Allow an operation to start before previous operations in the routing end

Responses

Request samples

Content type
{
  • "allowContinuousFlow": true
}

Adds an input item to an item's routing

path Parameters
itemId
required
string = 24 characters
Request Body schema:
itemId
required
string = 24 characters

The item id to be added. Please reference /api/items endpoint.

valueTypeUnits
required
number <double>

Measurement unit depending on FulcrumProduct.PublicApi.Dto.Item.Routing.InputItemCreateDto.ValueType

valueType
required
string (CommonEnumInputItemValueTypeEnum)
Enum: "creates" "requires"

Specifies how a routing input item quantity is measured.

Responses

Request samples

Content type
{
  • "itemId": "stringstringstringstring",
  • "valueTypeUnits": 0,
  • "valueType": "creates"
}

Response samples

Content type
{
  • "id": "string"
}

Add multiple input items to an item's routing

path Parameters
itemId
required
string = 24 characters
Request Body schema:
required
Array of objects (ItemRoutingInputItemCreateDto)

The input items to add to an item.

Array
itemId
required
string = 24 characters

The item id to be added. Please reference /api/items endpoint.

valueTypeUnits
required
number <double>

Measurement unit depending on FulcrumProduct.PublicApi.Dto.Item.Routing.InputItemCreateDto.ValueType

valueType
required
string (CommonEnumInputItemValueTypeEnum)
Enum: "creates" "requires"

Specifies how a routing input item quantity is measured.

Responses

Request samples

Content type
{
  • "lineItems": [
    ]
}

Response samples

Content type
{
  • "ids": [
    ]
}

Deletes an input item from an item's routing

path Parameters
itemId
required
string = 24 characters
inputItemId
required
string = 36 characters

Responses

Get a specific item routing input item

path Parameters
itemId
required
string = 24 characters
inputItemId
required
string = 36 characters

Responses

Response samples

Content type
{
  • "id": "stringstringstringstringstringstring",
  • "itemId": "stringstringstringstring",
  • "number": "string",
  • "revision": "string",
  • "description": "string",
  • "valueTypeUnits": 0,
  • "valueType": "creates"
}

Update an input item for a specific item's routing

path Parameters
itemId
required
string = 24 characters
inputItemId
required
string = 36 characters
Request Body schema:
valueTypeUnits
required
number <double>

Measurement unit depending on FulcrumProduct.PublicApi.Dto.Item.Routing.InputItemUpdateDto.ValueType

valueType
string (CommonEnumInputItemValueTypeEnum)
Enum: "creates" "requires"

Specifies how a routing input item quantity is measured.

Responses

Request samples

Content type
{
  • "valueTypeUnits": 0,
  • "valueType": "creates"
}

Lists the input items for an item's routing

path Parameters
itemId
required
string = 24 characters
query Parameters
skip
integer <int32> >= 0
Default: 0
take
integer <int32> [ 0 .. 1000 ]
Default: 50
Request Body schema:
number
string or null [ 1 .. 200 ] characters

Filter to items who's number contains the given string

Responses

Request samples

Content type
{
  • "number": "string"
}

Response samples

Content type
[
  • {
    }
]

Adds an input material to an item's routing

path Parameters
itemId
required
string
Request Body schema:
materialId
required
string non-empty

The material id to be added. Please reference /api/materials endpoint.

costing
required
string (CommonEnumMaterialRequirementCostingEnum)
Enum: "fullCost" "usageBased"

Specifies the costing of the material.

Array of objects or null (ItemRoutingInputMaterialNestingCreateDto)

Nestings associated to this material indicating bounding box dimensions and production quantities.

Responses

Request samples

Content type
{
  • "materialId": "string",
  • "costing": "fullCost",
  • "nestings": [
    ]
}

Response samples

Content type
{
  • "id": "string"
}

Deletes an input material from an item's routing

path Parameters
itemId
required
string = 24 characters
materialId
required
string <uuid>

Responses

Lists the input materials for an item's routing

path Parameters
itemId
required
string = 24 characters

Responses

Response samples

Content type
[
  • {
    }
]

Adds an input material nesting to an item's routing material

path Parameters
itemId
required
string
materialId
required
string <uuid>
Request Body schema:
d2
required
number <double>

Length

d3
required
number <double>

For Sheets, the Width

produces
required
integer <int32>

The quantity produced, given the bounding box dimensions (D2 x D3).

useForEstimatedCosting
boolean

Indicates if this nesting record will be used for estimated costing. NOTE: Only one nesting record for a material can have this value set to true.

Responses

Request samples

Content type
{
  • "d2": 0,
  • "d3": 0,
  • "produces": 0,
  • "useForEstimatedCosting": true
}

Response samples

Content type
{
  • "id": "string"
}

Removes an input material nesting on an item's routing material

path Parameters
itemId
required
string
materialId
required
string <uuid>
nestingId
required
string <uuid>

Responses

Bulk reorganize routing operations for a specific item.

path Parameters
itemId
required
string = 24 characters
Request Body schema:
Array
systemOperationId
required
string = 24 characters

System Operation Id

order
integer or null <int32> >= 0

The order of this operation. Operations with the same order are expected to run in parallel

object (ItemRoutingOutsideProcessingOperationDto)

Defines outside processing fields

object (ItemRoutingNormalOperationDto)

Defines non-outside-processing fields

leadDays
integer or null <int32> >= 0

Lead days. Will default to zero if not provided.

unattended
boolean or null

If true, the run portion of this step is unattended by an operator.

instructions
string or null [ 1 .. 2000 ] characters

Operation instructions. Will default to the instructions defined on the operation when not provided.

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
{
  • "ids": [
    ]
}

Create a routing operation for a specific item

path Parameters
itemId
required
string = 24 characters
Request Body schema:
systemOperationId
required
string = 24 characters

System Operation Id

order
integer or null <int32> >= 0

The order of this operation. Operations with the same order are expected to run in parallel

object (ItemRoutingOutsideProcessingOperationDto)

Defines outside processing fields

object (ItemRoutingNormalOperationDto)

Defines non-outside-processing fields

leadDays
integer or null <int32> >= 0

Lead days. Will default to zero if not provided.

unattended
boolean or null

If true, the run portion of this step is unattended by an operator.

instructions
string or null [ 1 .. 2000 ] characters

Operation instructions. Will default to the instructions defined on the operation when not provided.

Responses

Request samples

Content type
{
  • "systemOperationId": "stringstringstringstring",
  • "order": 0,
  • "outsideProcessingOperation": {
    },
  • "operation": {
    },
  • "leadDays": 0,
  • "unattended": true,
  • "instructions": "string"
}

Response samples

Content type
{
  • "id": "string"
}

Delete a specific item routing operation

path Parameters
itemId
required
string = 24 characters
operationId
required
string = 36 characters

Responses

Get a specific item routing operation

path Parameters
itemId
required
string = 24 characters
operationId
required
string = 36 characters

Responses

Response samples

Content type
{
  • "id": "stringstringstringstringstringstring",
  • "name": "string",
  • "systemOperationId": "stringstringstringstring",
  • "order": 0,
  • "isOutsideProcessing": true,
  • "outsideProcessingOperation": {
    },
  • "operation": {
    },
  • "leadDays": 0,
  • "unattended": true
}

Update a routing operation for a specific item

path Parameters
itemId
required
string = 24 characters
operationId
required
string = 36 characters
Request Body schema:
order
integer or null <int32> >= 0

The order of this operation. Operations with the same order are expected to run in parallel

object (ItemRoutingOutsideProcessingOperationDto)

Defines outside processing fields

object (ItemRoutingNormalOperationDto)

Defines non-outside-processing fields

leadDays
integer or null <int32> >= 0

Lead days. Will default to zero if not provided.

unattended
boolean or null

If true, the run portion of this step is unattended by an operator.

Responses

Request samples

Content type
{
  • "order": 0,
  • "outsideProcessingOperation": {
    },
  • "operation": {
    },
  • "leadDays": 0,
  • "unattended": true
}

Adds an operation item to an item's routing

path Parameters
itemId
required
string = 24 characters
operationId
required
string = 36 characters
Request Body schema:
itemId
required
string = 24 characters

The item id to be added. Please reference /api/items endpoint.

valueTypeUnits
required
number <double>

Measurement unit depending on FulcrumProduct.PublicApi.Dto.Item.Routing.InputItemCreateDto.ValueType

valueType
required
string (CommonEnumInputItemValueTypeEnum)
Enum: "creates" "requires"

Specifies how a routing input item quantity is measured.

Responses

Request samples

Content type
{
  • "itemId": "stringstringstringstring",
  • "valueTypeUnits": 0,
  • "valueType": "creates"
}

Response samples

Content type
{
  • "id": "string"
}

Deletes an operation item from an item's routing

path Parameters
itemId
required
string = 24 characters
operationId
required
string = 36 characters
operationItemId
required
string = 36 characters

Responses

Get a specific item routing operation item

path Parameters
itemId
required
string = 24 characters
operationId
required
string = 36 characters
operationItemId
required
string = 36 characters

Responses

Response samples

Content type
{
  • "id": "stringstringstringstringstringstring",
  • "itemId": "stringstringstringstring",
  • "number": "string",
  • "revision": "string",
  • "description": "string",
  • "valueTypeUnits": 0,
  • "valueType": "creates"
}

Update an operation item for a specific item's routing

path Parameters
itemId
required
string = 24 characters
operationId
required
string = 36 characters
operationItemId
required
string = 36 characters
Request Body schema:
valueTypeUnits
required
number <double>

Measurement unit depending on FulcrumProduct.PublicApi.Dto.Item.Routing.InputItemUpdateDto.ValueType

valueType
string (CommonEnumInputItemValueTypeEnum)
Enum: "creates" "requires"

Specifies how a routing input item quantity is measured.

Responses

Request samples

Content type
{
  • "valueTypeUnits": 0,
  • "valueType": "creates"
}

Lists the operation items for an item's routing

path Parameters
itemId
required
string = 24 characters
operationId
required
string = 36 characters
query Parameters
skip
integer <int32> >= 0
Default: 0
take
integer <int32> [ 0 .. 1000 ]
Default: 50
Request Body schema:
number
string or null [ 1 .. 200 ] characters

Filter to items who's number contains the given string

Responses

Request samples

Content type
{
  • "number": "string"
}

Response samples

Content type
[
  • {
    }
]

Lists the operations for an item's routing

path Parameters
itemId
required
string = 24 characters
query Parameters
skip
integer <int32> >= 0
Default: 0
take
integer <int32> [ 0 .. 1000 ]
Default: 50
Request Body schema:
name
string or null [ 1 .. 200 ] characters

Filter to operations who's name contains the given string

Responses

Request samples

Content type
{
  • "name": "string"
}

Response samples

Content type
[
  • {
    }
]

Item Vendor

Create a new item vendor

path Parameters
itemId
required
string = 24 characters
Request Body schema:
vendorId
required
string = 24 characters

Vendor id associated to this entity. Please reference /api/vendors endpoint.

vendorItemNumber
string or null [ 1 .. 200 ] characters

The item number for this vendor.

vendorItemName
string or null [ 1 .. 200 ] characters

The item name for this vendor.

price
number or null <double> >= 0

The price of this item for this vendor.

isPrimary
boolean

Signifies if this is the primary vendor for this item.

leadTimeInDays
integer or null <int32>

Lead time for this vendor.

Responses

Request samples

Content type
{
  • "vendorId": "stringstringstringstring",
  • "vendorItemNumber": "string",
  • "vendorItemName": "string",
  • "price": 0,
  • "isPrimary": true,
  • "leadTimeInDays": 0
}

Response samples

Content type
{
  • "id": "string"
}

Update a specific item vendor

path Parameters
itemId
required
string = 24 characters

The id of the item to modify vendors for

itemVendorId
required
string = 36 characters

The id of the item vendor.

Request Body schema:

The new data to apply to the given vendor detail

vendorItemNumber
string or null [ 1 .. 200 ] characters

The item number for this vendor.

vendorItemName
string or null [ 1 .. 200 ] characters

The item name for this vendor.

price
number or null <double> >= 0

The price of this item for this vendor.

isPrimary
boolean

Signifies if this is the primary vendor for this item.

leadTimeInDays
integer or null <int32>

Lead time for this vendor.

Responses

Request samples

Content type
{
  • "vendorItemNumber": "string",
  • "vendorItemName": "string",
  • "price": 0,
  • "isPrimary": true,
  • "leadTimeInDays": 0
}

Get a list of vendors for an item

path Parameters
itemId
required
string = 24 characters

Responses

Response samples

Content type
[
  • {
    }
]

Item Category

Get an item category

path Parameters
id
required
string = 24 characters

Responses

Response samples

Content type
{
  • "id": "stringstringstringstring",
  • "name": "string"
}

Find item categories based on search parameters.

query Parameters
Sort.Field
string non-empty

Sort field

Sort.Dir
string (CommonEnumSortDirectionEnum)
Enum: "ascending" "descending"

Sort direction

Skip
integer <int32> >= 0

Number of records to skip.

Take
integer <int32> [ 0 .. 1000 ]

Number of records to return (maximum)

Request Body schema:
name
string or null [ 1 .. 200 ] characters

Filter item categories based on their name.

ids
Array of strings or null

Filter item categories based on matching ids.

Responses

Request samples

Content type
{
  • "name": "string",
  • "ids": [
    ]
}

Response samples

Content type
[
  • {
    }
]

Item Tags

Find item tags based on search parameters

query Parameters
Sort.Field
string non-empty

Sort field

Sort.Dir
string (CommonEnumSortDirectionEnum)
Enum: "ascending" "descending"

Sort direction

Skip
integer <int32> >= 0

Number of records to skip.

Take
integer <int32> [ 0 .. 1000 ]

Number of records to return (maximum)

Request Body schema:

The search parameters

name
string or null [ 1 .. 200 ] characters

Filter item tags by name.

ids
Array of strings or null

Filter item tags by identifiers.

Responses

Request samples

Content type
{
  • "name": "string",
  • "ids": [
    ]
}

Response samples

Content type
{
  • "data": [
    ],
  • "page": 0,
  • "pageSize": 0,
  • "totalCount": 0,
  • "totalPages": 0,
  • "hasPreviousPage": true,
  • "hasNextPage": true
}

Job

Cancel a specific job

path Parameters
jobId
required
string = 24 characters

Responses

Create a new job

Request Body schema:
nameOfJob
string or null

Name of the job to create. If omitted, the default naming convention will be used

customerId
string or null = 24 characters

The id of the customer to be created

autoSchedule
boolean or null

Auto Schedule job. Defaults to FALSE if omitted.

note
string or null [ 1 .. 2000 ] characters

Note to customer. This will appear on PDFs.

priority
string (JobPriorityEnum)
Enum: "low" "moderate" "high"

Job priority

productionDueDate
string or null <date-time>

The date that the production of items on the job needs to be completed by.

quantityToMake
required
number <double>

Quantity to make

salesOrderId
string or null = 24 characters

Sales Order Id the job is created for. If used, ItemToMakeId will be ignored.

salesOrderLineItemId
string or null = 36 characters

Sales Order Line Item Id the job is created for. If used, ItemToMakeId will be ignored.

salesOrderLineItemNameOverride
string or null

Sales Order Line Item - Name Override

itemToMakeId
string or null = 24 characters

Id of the item to make. If SalesOrderId/SalesOrderLineItemId is set then ItemToMakeId will be ignored

Responses

Request samples

Content type
{
  • "nameOfJob": "string",
  • "customerId": "stringstringstringstring",
  • "autoSchedule": true,
  • "note": "string",
  • "priority": "low",
  • "productionDueDate": "2019-08-24T14:15:22Z",
  • "quantityToMake": 0,
  • "salesOrderId": "stringstringstringstring",
  • "salesOrderLineItemId": "stringstringstringstringstringstring",
  • "salesOrderLineItemNameOverride": "string",
  • "itemToMakeId": "stringstringstringstring"
}

Response samples

Content type
{
  • "id": "string"
}

Get a specific job

path Parameters
jobId
required
string = 24 characters

Responses

Response samples

Content type
{
  • "id": "stringstringstringstring",
  • "number": 0,
  • "name": "string",
  • "status": "draft",
  • "priority": "low",
  • "parentItemId": "stringstringstringstring",
  • "quantityToMake": 0,
  • "productionDueDate": "2019-08-24T14:15:22Z",
  • "salesOrderId": "stringstringstringstring",
  • "salesOrderLineItemId": "stringstringstringstringstringstring",
  • "createdUtc": "2019-08-24T14:15:22Z",
  • "customFields": {
    },
  • "originalScheduledStartUtc": "2019-08-24T14:15:22Z",
  • "originalScheduledEndUtc": "2019-08-24T14:15:22Z",
  • "scheduledStartUtc": "2019-08-24T14:15:22Z",
  • "scheduledEndUtc": "2019-08-24T14:15:22Z",
  • "completedOnUtc": "2019-08-24T14:15:22Z",
  • "cancelledOnUtc": "2019-08-24T14:15:22Z",
  • "revenue": 0
}

Partially update a job

path Parameters
jobId
required
string = 24 characters
Request Body schema: application/json-patch+json
Array
op
string
value
string
path
string

Responses

Request samples

Content type
application/json-patch+json
[
  • {
    }
]

Response samples

Content type
{
  • "id": "stringstringstringstring",
  • "number": 0,
  • "name": "string",
  • "status": "draft",
  • "priority": "low",
  • "parentItemId": "stringstringstringstring",
  • "quantityToMake": 0,
  • "productionDueDate": "2019-08-24T14:15:22Z",
  • "salesOrderId": "stringstringstringstring",
  • "salesOrderLineItemId": "stringstringstringstringstringstring",
  • "createdUtc": "2019-08-24T14:15:22Z",
  • "customFields": {
    },
  • "originalScheduledStartUtc": "2019-08-24T14:15:22Z",
  • "originalScheduledEndUtc": "2019-08-24T14:15:22Z",
  • "scheduledStartUtc": "2019-08-24T14:15:22Z",
  • "scheduledEndUtc": "2019-08-24T14:15:22Z",
  • "completedOnUtc": "2019-08-24T14:15:22Z",
  • "cancelledOnUtc": "2019-08-24T14:15:22Z",
  • "revenue": 0
}

Update an job

path Parameters
jobId
required
string = 24 characters
Request Body schema:
name
string or null

The name of the job

priority
string (JobPriorityEnum)
Enum: "low" "moderate" "high"

Job priority

quantityToMake
number or null <double>

The quantity the job should make

productionDueDate
string or null <date-time>

The production due date

notes
string or null

The internal notes

Responses

Request samples

Content type
{
  • "name": "string",
  • "priority": "low",
  • "quantityToMake": 0,
  • "productionDueDate": "2019-08-24T14:15:22Z",
  • "notes": "string"
}

Response samples

Content type
{
  • "id": "stringstringstringstring",
  • "number": 0,
  • "name": "string",
  • "status": "draft",
  • "priority": "low",
  • "parentItemId": "stringstringstringstring",
  • "quantityToMake": 0,
  • "productionDueDate": "2019-08-24T14:15:22Z",
  • "salesOrderId": "stringstringstringstring",
  • "salesOrderLineItemId": "stringstringstringstringstringstring",
  • "createdUtc": "2019-08-24T14:15:22Z",
  • "customFields": {
    },
  • "originalScheduledStartUtc": "2019-08-24T14:15:22Z",
  • "originalScheduledEndUtc": "2019-08-24T14:15:22Z",
  • "scheduledStartUtc": "2019-08-24T14:15:22Z",
  • "scheduledEndUtc": "2019-08-24T14:15:22Z",
  • "completedOnUtc": "2019-08-24T14:15:22Z",
  • "cancelledOnUtc": "2019-08-24T14:15:22Z",
  • "revenue": 0
}

Get a specific job's tracking information

path Parameters
jobId
required
string = 24 characters

Responses

Response samples

Content type
{
  • "id": "stringstringstringstring",
  • "number": 0,
  • "name": "string",
  • "status": "draft",
  • "priority": "low",
  • "parentItemId": "stringstringstringstring",
  • "quantityToMake": 0,
  • "productionDueDate": "2019-08-24T14:15:22Z",
  • "salesOrderId": "stringstringstringstring",
  • "salesOrderLineItemId": "stringstringstringstringstringstring",
  • "createdUtc": "2019-08-24T14:15:22Z",
  • "customFields": {
    },
  • "originalScheduledStartUtc": "2019-08-24T14:15:22Z",
  • "originalScheduledEndUtc": "2019-08-24T14:15:22Z",
  • "scheduledStartUtc": "2019-08-24T14:15:22Z",
  • "scheduledEndUtc": "2019-08-24T14:15:22Z",
  • "completedOnUtc": "2019-08-24T14:15:22Z",
  • "cancelledOnUtc": "2019-08-24T14:15:22Z",
  • "revenue": 0,
  • "currentOperations": [
    ],
  • "nextOperations": [
    ],
  • "estimatedSetupTimeInSeconds": 0,
  • "estimatedRunTimeInSeconds": 0,
  • "estimatedLaborTimeInSeconds": 0,
  • "estimatedMachineTimeInSeconds": 0,
  • "elapsedSetupTimeInSeconds": 0,
  • "elapsedRunTimeInSeconds": 0,
  • "elapsedLaborTimeInSeconds": 0,
  • "elapsedMachineTimeInSeconds": 0
}

Find jobs based on search parameters.

query Parameters
Sort.Field
string non-empty

Sort field

Sort.Dir
string (CommonEnumSortDirectionEnum)
Enum: "ascending" "descending"

Sort direction

Skip
integer <int32> >= 0

Number of records to skip.

Take
integer <int32> [ 0 .. 1000 ]

Number of records to return (maximum)

Request Body schema:
jobIds
Array of strings or null [ 1 .. 500 ] items

Filter to jobs whose ids are in the list

numbers
Array of integers or null <int32> [ 1 .. 500 ] items

Filter jobs to only given numbers

jobNames
Array of strings or null [ 1 .. 500 ] items

Filter jobs to only given names

status
string (JobStatusEnum)
Enum: "draft" "needsReview" "approved" "engineering" "scheduled" "inProgress" "complete" "cancelled" "hold"

Job status

statuses
Array of strings or null (JobStatusEnum)
Enum: "draft" "needsReview" "approved" "engineering" "scheduled" "inProgress" "complete" "cancelled" "hold"

Filter jobs to match the given statuses

parentItemId
string or null

Filter jobs based on the id of the parent item they produce

hasIncompleteOperations
boolean or null

Filters jobs to have those that have at least 1 incomplete operation. Note that this will filter out jobs that haven't been approved yet because they technically have no operations on them until approved.

salesOrderId
string or null = 24 characters

Filters for jobs that are for this sales order id. Please reference /api/sales-orders endpoint.

createdBeforeUtc
string or null <date-time>

Filters jobs created before (exclusive) this parameter in UTC time. If not time component is passed, midnight UTC will be used.

createdAfterUtc
string or null <date-time>

Filters jobs created after (exclusive) this parameter in UTC time. If not time component is passed, midnight UTC will be used.

Responses

Request samples

Content type
{
  • "jobIds": [
    ],
  • "numbers": [
    ],
  • "jobNames": [
    ],
  • "status": "draft",
  • "statuses": [
    ],
  • "parentItemId": "string",
  • "hasIncompleteOperations": true,
  • "salesOrderId": "stringstringstringstring",
  • "createdBeforeUtc": "2019-08-24T14:15:22Z",
  • "createdAfterUtc": "2019-08-24T14:15:22Z"
}

Response samples

Content type
[
  • {
    }
]

Update a job status

path Parameters
jobId
required
string = 24 characters
Request Body schema:
status
required
string (JobStatusEnum)
Enum: "draft" "needsReview" "approved" "engineering" "scheduled" "inProgress" "complete" "cancelled" "hold"

Job status

createPOs
boolean or null

Create Purchase Orders for the Job. Required for the following statuses: Engineering, Approved

isInitialDataImport
boolean or null

The job will be created as Complete. No inventory transactions. This is should mostly be used when importing jobs from legacy systems. Required for the following statuses: Complete

Responses

Request samples

Content type
{
  • "status": "draft",
  • "createPOs": true,
  • "isInitialDataImport": true
}

Job Custom Fields

Update (selectively) custom fields on a job

path Parameters
jobId
required
string = 24 characters

The job identifier

Request Body schema:

The custom fields to update

object

The custom fields

property name*
additional property
any

Responses

Request samples

Content type
{
  • "customFields": {
    }
}

Response samples

Content type
{
  • "customFields": {
    }
}

Update (selectively) custom fields on a job

path Parameters
jobId
required
string = 24 characters

The job identifier

Request Body schema:

The custom fields to update

object

The custom fields

property name*
additional property
any

Responses

Request samples

Content type
{
  • "customFields": {
    }
}

Response samples

Content type
{
  • "customFields": {
    }
}

Job Item To Make

Get a specific item to make on a job

path Parameters
jobId
required
string = 24 characters
itemToMakeId
required
string = 36 characters

Responses

Response samples

Content type
{
  • "id": "stringstringstringstringstringstring",
  • "itemId": "stringstringstringstring",
  • "quantityToMake": 0,
  • "isCustom": true,
  • "status": "new",
  • "quantityMade": 0,
  • "depth": 0
}

Get a list of items to make on a job

path Parameters
jobId
required
string = 24 characters

Responses

Response samples

Content type
[
  • {
    }
]

Job Item To Make Operation

Get a specific operation for an item to make on a job

path Parameters
jobId
required
string = 24 characters
itemToMakeId
required
string = 36 characters
operationId
required
string = 36 characters

Responses

Response samples

Content type
{
  • "id": "stringstringstringstringstringstring",
  • "status": "pending",
  • "order": 0,
  • "systemOperationId": "stringstringstringstring",
  • "isOutsideProcessing": true,
  • "originalScheduledStartUtc": "2019-08-24T14:15:22Z",
  • "originalScheduledEndUtc": "2019-08-24T14:15:22Z",
  • "scheduledStartUtc": "2019-08-24T14:15:22Z",
  • "scheduledEndUtc": "2019-08-24T14:15:22Z",
  • "completedOnUtc": "2019-08-24T14:15:22Z",
  • "completedById": "string",
  • "scheduledEquipmentId": "string",
  • "customFields": {
    },
  • "instructions": "string",
  • "name": "string",
  • "leadTimeInDays": 0,
  • "associatedPurchaseOrderIds": [
    ]
}

Get a specific operation for an item to make on a job

path Parameters
jobId
required
string = 24 characters
itemToMakeId
required
string = 36 characters
operationId
required
string = 36 characters
Request Body schema:
object or null

The custom fields to update on the operation object

property name*
additional property
any

Responses

Request samples

Content type
{
  • "customFields": {
    }
}

Get a list of operations for an item to make on a job

path Parameters
jobId
required
string = 24 characters
itemToMakeId
required
string = 36 characters

Responses

Response samples

Content type
[
  • {
    }
]

Pick a specific item for a specific item to make on a job.

path Parameters
jobId
required
string = 24 characters
itemToMakeId
required
string = 36 characters
operationId
required
string = 36 characters
Request Body schema:
itemId
required
string = 24 characters

The identifier of the item to be picked. Please reference api/items endpoint

quantity
required
number <double>

Quantity of the item to pick.

locationId
string or null

ID of the location to pick from. If not set or set to an empty string, will pick from inventory not assigned to a location. Cannot be set if FulcrumProduct.PublicApi.Dto.Job.ItemToMake.OperationPickInventoryDto.UseDefaultLocation is set to true.

useDefaultLocation
boolean

If set to true, inventory will be picked from the default location for the item. If set to true, FulcrumProduct.PublicApi.Dto.Job.ItemToMake.OperationPickInventoryDto.LocationId cannot be set. If the item does not have a default location set and this is set to true, will pick from inventory not assigned to a location.

lotId
string or null

The ID of the lot to pick from.

Responses

Request samples

Content type
{
  • "itemId": "stringstringstringstring",
  • "quantity": 0,
  • "locationId": "string",
  • "useDefaultLocation": true,
  • "lotId": "string"
}

Job Operation

Get a list of operations for a job

path Parameters
jobId
required
string = 24 characters

Responses

Response samples

Content type
[
  • {
    }
]

Job Tracking Timers

Finds job tracking timers based on search parameters

query Parameters
Sort.Field
string non-empty

Sort field

Sort.Dir
string (CommonEnumSortDirectionEnum)
Enum: "ascending" "descending"

Sort direction

Skip
integer <int32> >= 0

Number of records to skip.

Take
integer <int32> [ 0 .. 1000 ]

Number of records to return (maximum)

Request Body schema:

The search parameters

userId
string or null

Filter timers based on who started it

jobId
string or null

Filter timers based on job

runningTimersOnly
boolean or null

Filter to only running timers

Responses

Request samples

Content type
{
  • "userId": "string",
  • "jobId": "string",
  • "runningTimersOnly": true
}

Response samples

Content type
{
  • "data": [
    ],
  • "page": 0,
  • "pageSize": 0,
  • "totalCount": 0,
  • "totalPages": 0,
  • "hasPreviousPage": true,
  • "hasNextPage": true
}

Starts a job tracking timer.

Request Body schema:
userId
string or null = 24 characters

The user identifier to associate the timer to. If not supplied, will use the user assigned to the api key used for authorization

jobId
required
string non-empty

The job identifier

itemToMakeId
required
string = 36 characters

The item to make identifier

operationId
required
string = 36 characters

The operation identifier

type
required
string (DomainTimeTrackingTimer_Type)
Enum: "setup" "run" "clockIn" "break" "labor" "machine"

Responses

Request samples

Content type
{
  • "userId": "stringstringstringstring",
  • "jobId": "string",
  • "itemToMakeId": "stringstringstringstringstringstring",
  • "operationId": "stringstringstringstringstringstring",
  • "type": "setup"
}

Stops a job tracking timer

Request Body schema:
userId
string or null = 24 characters

The user identifier to associate the timer to. If not supplied, will use the user assigned to the api key used for authorization

timerId
required
string = 24 characters

The timer identifier

Responses

Request samples

Content type
{
  • "userId": "stringstringstringstring",
  • "timerId": "stringstringstringstring"
}

Location

Delete a specific location

path Parameters
locationId
required
string = 24 characters

Responses

Get a location.

path Parameters
id
required
string = 24 characters

Responses

Response samples

Content type
{
  • "id": "stringstringstringstring",
  • "name": "string",
  • "description": "string",
  • "barcode": "string"
}

Find locations based on search parameters.

query Parameters
Sort.Field
string non-empty

Sort field

Sort.Dir
string (CommonEnumSortDirectionEnum)
Enum: "ascending" "descending"

Sort direction

Skip
integer <int32> >= 0

Number of records to skip.

Take
integer <int32> [ 0 .. 1000 ]

Number of records to return (maximum)

Request Body schema:
name
string or null [ 1 .. 200 ] characters

Filter locations based on their name.

Responses

Request samples

Content type
{
  • "name": "string"
}

Response samples

Content type
[
  • {
    }
]

Material

Activate materials based on ids

Request Body schema:
materialIds
required
Array of strings

Material ids to activate.

Responses

Request samples

Content type
{
  • "materialIds": [
    ]
}

Response samples

Content type
[
  • {
    }
]

Get a material.

path Parameters
id
required
string non-empty

Responses

Response samples

Content type
{
  • "id": "string",
  • "active": true,
  • "name": "string",
  • "form": "sheet",
  • "materialReferenceId": "string",
  • "materialReferenceName": "string",
  • "grade": "string",
  • "dimension": "string",
  • "vendors": [
    ],
  • "modifications": {
    },
  • "temper": "string"
}

Find materials based on search parameters.

query Parameters
Sort.Field
string non-empty

Sort field

Sort.Dir
string (CommonEnumSortDirectionEnum)
Enum: "ascending" "descending"

Sort direction

Skip
integer <int32> >= 0

Number of records to skip.

Take
integer <int32> [ 0 .. 1000 ]

Number of records to return (maximum)

Request Body schema:
ids
Array of strings or null

Filter materials based on matching ids.

materials
Array of strings or null

Material names.

grades
Array of strings or null

Grades.

forms
Array of strings or null (CommonEnumMaterialFormEnum)
Value: "sheet"

Material forms.

displayDimensions
Array of strings or null

A list of dimension display values to include

active
boolean or null

Indicate whether to specifically only pull active materials. If left null, all rows are included.

temper
Array of strings or null

A list of tempers

Responses

Request samples

Content type
{
  • "ids": [
    ],
  • "materials": [
    ],
  • "grades": [
    ],
  • "forms": [
    ],
  • "displayDimensions": [
    ],
  • "active": true,
  • "temper": [
    ]
}

Response samples

Content type
[
  • {
    }
]

Material Code

Get a material code.

path Parameters
id
required
string = 24 characters

Responses

Response samples

Content type
{
  • "id": "stringstringstringstring",
  • "name": "string"
}

Find material codes based on search parameters.

query Parameters
Sort.Field
string non-empty

Sort field

Sort.Dir
string (CommonEnumSortDirectionEnum)
Enum: "ascending" "descending"

Sort direction

Skip
integer <int32> >= 0

Number of records to skip.

Take
integer <int32> [ 0 .. 1000 ]

Number of records to return (maximum)

Request Body schema:
name
string or null [ 1 .. 200 ] characters

Filter material codes based on their name.

ids
Array of strings or null

Filter material codes based on matching ids.

Responses

Request samples

Content type
{
  • "name": "string",
  • "ids": [
    ]
}

Response samples

Content type
[
  • {
    }
]

NCRs

Finds NCRs based on search parameters

query Parameters
Sort.Field
string non-empty

Sort field

Sort.Dir
string (CommonEnumSortDirectionEnum)
Enum: "ascending" "descending"

Sort direction

Skip
integer <int32> >= 0

Number of records to skip.

Take
integer <int32> [ 0 .. 1000 ]

Number of records to return (maximum)

Request Body schema:
status
string or null

Filter NCRs by a specific status Accepted Values: Closed, Hold, New, Quality Review, Engineering Review

type
string or null

Filter NCRs by a specific type Accepted Values: Customer Complaint, Quality, Quantity, Return, Warranty

cause
string or null

Filter NCRs by a specific cause Accepted Values: Equipment, Human, Customer, Vendor, Material, Fixturing, Process, Other

reason
string or null

Filter NCRs by a specific reason Accepted Values: Inspection, Quantity, Material, Orientation, Process, Other

createdUtc
string or null <date-time>

Filter NCRs created after a certain date

Responses

Request samples

Content type
{
  • "status": "string",
  • "type": "string",
  • "cause": "string",
  • "reason": "string",
  • "createdUtc": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "data": [
    ],
  • "page": 0,
  • "pageSize": 0,
  • "totalCount": 0,
  • "totalPages": 0,
  • "hasPreviousPage": true,
  • "hasNextPage": true
}

Note

Create a new note on a parent document

Request Body schema:
parentId
required
string [ 24 .. 36 ] characters

Unique identifier of the object to which the note is attached Can be 24 or 36 characters, depending on parent type

parentType
required
string (NoteTypeEnum)
Enum: "salesOrder" "purchaseOrder" "quote" "invoice"

Note parent document type

body
required
string [ 1 .. 2000 ] characters

Note text

mentions
Array of strings or null

User Ids to tag in the note. Please reference /api/users endpoints.

Responses

Request samples

Content type
{
  • "parentId": "stringstringstringstring",
  • "parentType": "salesOrder",
  • "body": "string",
  • "mentions": [
    ]
}

Response samples

Content type
{
  • "id": "string"
}

Get a specific note

path Parameters
noteId
required
string = 36 characters

Responses

Response samples

Content type
{
  • "id": "stringstringstringstringstringstring",
  • "parentId": "stringstringstringstring",
  • "parentType": "salesOrder",
  • "body": "string",
  • "mentions": [
    ]
}

Find notes based on search parameters.

Request Body schema:
parentType
required
string (NoteTypeEnum)
Enum: "salesOrder" "purchaseOrder" "quote" "invoice"

Note parent document type

parentId
required
string [ 24 .. 36 ] characters

Filter notes by parent Id. Either 24 or 36 characters, depending on parent type

Responses

Request samples

Content type
{
  • "parentType": "salesOrder",
  • "parentId": "stringstringstringstring"
}

Response samples

Content type
[
  • {
    }
]

Operation

Create a new operation

Request Body schema:
name
required
string [ 1 .. 200 ] characters

The name of operation.

description
required
string [ 1 .. 200 ] characters

The description of the operation.

isOutsideProcessing
boolean

Specifies whether this is an outside processing operation.

object (ItemRoutingOperationTime)

Operation time and type

object (ItemRoutingOperationTime)

Operation time and type

object (ItemRoutingOperationTime)

Operation time and type

machineTimeTrackingEnabled
boolean

Specifies whether machine tracking is enabled.

object (ItemRoutingOperationTime)

Operation time and type

defaultVendorId
string or null = 24 characters

Default vendor id that will be used for this operation. Please reference /api/vendors endpoint.

vendors
Array of strings or null

Available vendors.

leadDays
integer or null <int32> >= 0

Lead days.

instructions
string or null [ 1 .. 2000 ] characters

Instructions.

accountingCodeId
string or null = 24 characters

Accounting code key identifier. Please reference /api/accounting-codes endpoint.

Responses

Request samples

Content type
{
  • "name": "string",
  • "description": "string",
  • "isOutsideProcessing": true,
  • "setupTime": {
    },
  • "laborTime": {
    },
  • "machineTime": {
    },
  • "machineTimeTrackingEnabled": true,
  • "outsideProcessingTime": {
    },
  • "defaultVendorId": "stringstringstringstring",
  • "vendors": [
    ],
  • "leadDays": 0,
  • "instructions": "string",
  • "accountingCodeId": "stringstringstringstring"
}

Response samples

Content type
{
  • "id": "string"
}

Get an operation.

path Parameters
id
required
string = 24 characters

Responses

Response samples

Content type
{
  • "id": "stringstringstringstring",
  • "name": "string",
  • "description": "string",
  • "setupTime": {
    },
  • "laborTime": {
    },
  • "machineTimeTrackingEnabled": true,
  • "machineTime": {
    },
  • "isOutsideProcessing": true,
  • "outsideProcessingTime": {
    },
  • "unattended": true,
  • "defaultVendorId": "stringstringstringstring",
  • "leadDays": 0,
  • "accountingCodeId": "stringstringstringstring"
}

Find operations based on search parameters.

query Parameters
Sort.Field
string non-empty

Sort field

Sort.Dir
string (CommonEnumSortDirectionEnum)
Enum: "ascending" "descending"

Sort direction

Skip
integer <int32> >= 0

Number of records to skip.

Take
integer <int32> [ 0 .. 1000 ]

Number of records to return (maximum)

Request Body schema:
name
string or null [ 1 .. 200 ] characters

Filter operations based on their name.

Responses

Request samples

Content type
{
  • "name": "string"
}

Response samples

Content type
[
  • {
    }
]

Payment Term

Create a new payment term

Request Body schema:
name
required
string [ 1 .. 200 ] characters

Identifying name. Must be unique.

dueDays
required
integer <int32> >= 0

Due days.

Responses

Request samples

Content type
{
  • "name": "string",
  • "dueDays": 0
}

Response samples

Content type
{
  • "id": "string"
}

Get a payment term.

path Parameters
id
required
string = 24 characters

Responses

Response samples

Content type
{
  • "id": "stringstringstringstring",
  • "name": "string",
  • "dueDays": 0
}

Find payment terms based on search parameters.

query Parameters
Sort.Field
string non-empty

Sort field

Sort.Dir
string (CommonEnumSortDirectionEnum)
Enum: "ascending" "descending"

Sort direction

Skip
integer <int32> >= 0

Number of records to skip.

Take
integer <int32> [ 0 .. 1000 ]

Number of records to return (maximum)

Request Body schema:
name
string or null [ 1 .. 200 ] characters

Filter payment terms based on their name.

Responses

Request samples

Content type
{
  • "name": "string"
}

Response samples

Content type
[
  • {
    }
]

Purchase Order

Create a new draft purchase order

Request Body schema:
vendorId
required
string = 24 characters

Vendor Id

type
required
string (PurchaseOrderTypeEnum)
Enum: "standard" "outsideProcessing" "vendorCredit"

Purchase order type

contactId
string or null = 36 characters

Vendor Contact Id; defaults to the Id of the first contact belonging to the input vendor

companyInfoId
string or null = 24 characters

Company Information Id; defaults to primary company info Id

currencyCode
string or null

Currency code override; defaults to vendor currency code override, then the company's primary currency code

object or null

External references associated with this entity.

expectedReceiveDate
string or null <date-time>

PO Expected receipt date

Responses

Request samples

Content type
{
  • "vendorId": "stringstringstringstring",
  • "type": "standard",
  • "contactId": "stringstringstringstringstringstring",
  • "companyInfoId": "stringstringstringstring",
  • "currencyCode": "string",
  • "externalReferences": {
    },
  • "expectedReceiveDate": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "id": "stringstringstringstring",
  • "number": 0,
  • "issueDate": "2019-08-24T14:15:22Z",
  • "orderDate": "2019-08-24T14:15:22Z",
  • "expectedReceiveDate": "2019-08-24T14:15:22Z",
  • "vendorId": "stringstringstringstring",
  • "contactId": "stringstringstringstring",
  • "paymentTermsId": "stringstringstringstring",
  • "type": "standard",
  • "status": "draft",
  • "receivingStatus": "notReceived",
  • "vendorCredit": 0,
  • "discount": 0,
  • "subTotal": 0,
  • "total": 0,
  • "companyInfoId": "stringstringstringstring",
  • "vendorNote": "string",
  • "notes": [
    ],
  • "externalReferences": {
    },
  • "customFields": {
    },
  • "deleted": true,
  • "currencyCode": "string",
  • "vendorOrderNumber": "string"
}

Delete a specific purchase order

path Parameters
purchaseOrderId
required
string = 24 characters

Responses

Get a specific purchase order

path Parameters
purchaseOrderId
required
string = 24 characters

Responses

Response samples

Content type
{
  • "id": "stringstringstringstring",
  • "number": 0,
  • "issueDate": "2019-08-24T14:15:22Z",
  • "orderDate": "2019-08-24T14:15:22Z",
  • "expectedReceiveDate": "2019-08-24T14:15:22Z",
  • "vendorId": "stringstringstringstring",
  • "contactId": "stringstringstringstring",
  • "paymentTermsId": "stringstringstringstring",
  • "type": "standard",
  • "status": "draft",
  • "receivingStatus": "notReceived",
  • "vendorCredit": 0,
  • "discount": 0,
  • "subTotal": 0,
  • "total": 0,
  • "companyInfoId": "stringstringstringstring",
  • "vendorNote": "string",
  • "notes": [
    ],
  • "externalReferences": {
    },
  • "customFields": {
    },
  • "deleted": true,
  • "currencyCode": "string",
  • "vendorOrderNumber": "string"
}

Partially update a purchase order

path Parameters
purchaseOrderId
required
string = 24 characters
Request Body schema: application/json-patch+json
Array
op
string
value
string
path
string

Responses

Request samples

Content type
application/json-patch+json
[
  • {
    }
]

Response samples

Content type
{
  • "id": "stringstringstringstring",
  • "number": 0,
  • "issueDate": "2019-08-24T14:15:22Z",
  • "orderDate": "2019-08-24T14:15:22Z",
  • "expectedReceiveDate": "2019-08-24T14:15:22Z",
  • "vendorId": "stringstringstringstring",
  • "contactId": "stringstringstringstring",
  • "paymentTermsId": "stringstringstringstring",
  • "type": "standard",
  • "status": "draft",
  • "receivingStatus": "notReceived",
  • "vendorCredit": 0,
  • "discount": 0,
  • "subTotal": 0,
  • "total": 0,
  • "companyInfoId": "stringstringstringstring",
  • "vendorNote": "string",
  • "notes": [
    ],
  • "externalReferences": {
    },
  • "customFields": {
    },
  • "deleted": true,
  • "currencyCode": "string",
  • "vendorOrderNumber": "string"
}

Update a purchase order

path Parameters
purchaseOrderId
required
string = 24 characters
Request Body schema:
object or null

Arbitrary key-value-pair like data that can be used to later on search for this line item.

additional property
object (CommonExternalReferenceDto)

The external reference for entities that implement FulcrumProduct.Domain.Common.IHasExternalReferences

type
string or null [ 0 .. 50 ] characters

Specifies the type of this identifier.

externalId
required
string [ 0 .. 500 ] characters

The external identifier

displayId
string or null [ 0 .. 500 ] characters

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
string or null

A status for the external reference

url
string or null

An external url for the reference

modifiedUtc
string or null <date-time>

Date the external reference was modified

Responses

Request samples

Content type
{
  • "externalReferences": {
    }
}

Response samples

Content type
{
  • "id": "stringstringstringstring",
  • "number": 0,
  • "issueDate": "2019-08-24T14:15:22Z",
  • "orderDate": "2019-08-24T14:15:22Z",
  • "expectedReceiveDate": "2019-08-24T14:15:22Z",
  • "vendorId": "stringstringstringstring",
  • "contactId": "stringstringstringstring",
  • "paymentTermsId": "stringstringstringstring",
  • "type": "standard",
  • "status": "draft",
  • "receivingStatus": "notReceived",
  • "vendorCredit": 0,
  • "discount": 0,
  • "subTotal": 0,
  • "total": 0,
  • "companyInfoId": "stringstringstringstring",
  • "vendorNote": "string",
  • "notes": [
    ],
  • "externalReferences": {
    },
  • "customFields": {
    },
  • "deleted": true,
  • "currencyCode": "string",
  • "vendorOrderNumber": "string"
}

Find purchase orders based on search parameters.

query Parameters
Sort.Field
string non-empty

Sort field

Sort.Dir
string (CommonEnumSortDirectionEnum)
Enum: "ascending" "descending"

Sort direction

Skip
integer <int32> >= 0

Number of records to skip.

Take
integer <int32> [ 0 .. 1000 ]

Number of records to return (maximum)

Request Body schema:
numbers
Array of integers or null <int32> [ 1 .. 500 ] items

Filter purchase orders to only given numbers

status
string (PurchaseOrderStatusEnum)
Enum: "draft" "needsApproval" "approved" "ordered" "paid" "cancelled"

Purchase order status

receivingStatus
string (PurchaseOrderReceivingStatusEnum)
Enum: "notReceived" "partiallyReceived" "received"

Purchase order receipt status

object (CommonExternalReferenceFindDto)

Search parameter for identifier record(s) via their external identifiers.

includeReceiptData
boolean

If set to true, receipt data will be included in the results

Responses

Request samples

Content type
{
  • "numbers": [
    ],
  • "status": "draft",
  • "receivingStatus": "notReceived",
  • "externalReference": {
    },
  • "includeReceiptData": true
}

Response samples

Content type
[
  • {
    }
]

Update a purchase order status

path Parameters
purchaseOrderId
required
string = 24 characters
Request Body schema:
status
required
string (PurchaseOrderStatusEnum)
Enum: "draft" "needsApproval" "approved" "ordered" "paid" "cancelled"

Purchase order status

paidDate
string or null <date-time>

The date that the purchase order was paid. Should be provided in UTC. Will default to current date/time if not provided when applicable.

Responses

Request samples

Content type
{
  • "status": "draft",
  • "paidDate": "2019-08-24T14:15:22Z"
}

Purchase Order Custom Fields

Update (selectively) custom fields on a purchase order

path Parameters
id
required
string = 24 characters

The purchase order identifier

Request Body schema:

The custom fields to update

object

The custom fields

property name*
additional property
any

Responses

Request samples

Content type
{
  • "customFields": {
    }
}

Response samples

Content type
{
  • "customFields": {
    }
}

Update (selectively) custom fields on a purchase order

path Parameters
id
required
string = 24 characters

The purchase order identifier

Request Body schema:

The custom fields to update

object

The custom fields

property name*
additional property
any

Responses

Request samples

Content type
{
  • "customFields": {
    }
}

Response samples

Content type
{
  • "customFields": {
    }
}

Purchase Order Discount Line Item

Get the discount line item for a purchase order

path Parameters
purchaseOrderId
required
string = 24 characters

Responses

Response samples

Content type
{
  • "id": "stringstringstringstringstringstring",
  • "name": "string",
  • "description": "string",
  • "isPercentage": true,
  • "amount": 0,
  • "externalReferences": {
    }
}

Purchase Order Fee Line Item

Create a fee line item on a purchase order

path Parameters
purchaseOrderId
required
string = 24 characters
Request Body schema:
name
string or null [ 1 .. 200 ] characters

Verbose name for this entity.

description
string or null [ 1 .. 200 ] characters

Verbose description for this entity.

quantity
number or null <double> >= 0

The line item quantity. Required for receivable line items.

price
required
number <double> >= 0

The line item unit price.

isReceivable
boolean or null

Dictate if this fee is receivable. If not provided, defaults to false.

accountingCodeId
string or null = 24 characters

Accounting code key identifier. Please reference /api/accounting-codes endpoint.

unitOfMeasure
string (CommonEnumLineItemUomEnum)
Enum: "notApplicable" "piece" "linearFeet" "hour" "yard"

Line item unit of measure.

isTaxable
boolean or null

Dictate if this fee is taxable. If not provided, defaults to false.

taxCodeId
string or null = 24 characters

Tax code key identifier. Please reference /api/tax-rates endpoint.

taxRate
number or null <double> >= 0

Tax code to use for this entity. If a FulcrumProduct.PublicApi.Dto.PurchaseOrder.FeeLineItem.FeeLineItemCreateDto.TaxCodeId is provided, the provided FulcrumProduct.PublicApi.Dto.PurchaseOrder.FeeLineItem.FeeLineItemCreateDto.TaxRate will supercede the defined tax rate.

object or null

Arbitrary key-value-pair like data that can be used to later on search for this line item.

Responses

Request samples

Content type
{
  • "name": "string",
  • "description": "string",
  • "quantity": 0,
  • "price": 0,
  • "isReceivable": true,
  • "accountingCodeId": "stringstringstringstring",
  • "unitOfMeasure": "notApplicable",
  • "isTaxable": true,
  • "taxCodeId": "stringstringstringstring",
  • "taxRate": 0,
  • "externalReferences": {
    }
}

Response samples

Content type
{
  • "id": "string"
}

Delete a fee line item on a purchase order

path Parameters
purchaseOrderId
required
string = 24 characters
lineItemId
required
string = 36 characters

Responses

Get a specific fee line item for a purchase order

path Parameters
purchaseOrderId
required
string = 24 characters
lineItemId
required
string = 36 characters

Responses

Response samples

Content type
{
  • "id": "stringstringstringstringstringstring",
  • "name": "string",
  • "description": "string",
  • "quantity": 0,
  • "price": 0,
  • "unitOfMeasure": "notApplicable",
  • "accountingCodeId": "stringstringstringstring",
  • "isTaxable": true,
  • "isReceivable": true,
  • "overrideTaxRate": true,
  • "taxCodeId": "stringstringstringstring",
  • "taxRate": 0,
  • "externalReferences": {
    }
}

Partially update a specific fee line item for a purchase order

path Parameters
purchaseOrderId
required
string = 24 characters
lineItemId
required
string = 36 characters
Request Body schema: application/json-patch+json
Array
op
string
value
string
path
string

Responses

Request samples

Content type
application/json-patch+json
[
  • {
    }
]

Response samples

Content type
{
  • "id": "stringstringstringstringstringstring",
  • "name": "string",
  • "description": "string",
  • "quantity": 0,
  • "price": 0,
  • "unitOfMeasure": "notApplicable",
  • "accountingCodeId": "stringstringstringstring",
  • "isTaxable": true,
  • "isReceivable": true,
  • "overrideTaxRate": true,
  • "taxCodeId": "stringstringstringstring",
  • "taxRate": 0,
  • "externalReferences": {
    }
}

Update a specific fee line item for a purchase order

path Parameters
purchaseOrderId
required
string = 24 characters
lineItemId
required
string = 36 characters
Request Body schema:
name
string or null [ 1 .. 200 ] characters

Verbose name for this entity.

description
string or null [ 1 .. 200 ] characters

Verbose description for this entity.

quantity
number or null <double> >= 0

The line item quantity. Required for receivable line items.

price
required
number <double> >= 0

The line item price.

accountingCodeId
string or null = 24 characters

Accounting code key identifier. Please reference /api/accounting-codes endpoint.

unitOfMeasure
string (CommonEnumLineItemUomEnum)
Enum: "notApplicable" "piece" "linearFeet" "hour" "yard"

Line item unit of measure.

isReceivable
boolean or null

Dictate if this fee is receivable. If not provided, defaults to false.

isTaxable
boolean or null

Dictate if this fee is taxable. If not provided, defaults to false.

taxCodeId
string or null = 24 characters

Tax code key identifier. Please reference /api/tax-rates endpoint.

taxRate
number or null <double> >= 0

Tax code to use for this entity. If a FulcrumProduct.PublicApi.Dto.PurchaseOrder.FeeLineItem.FeeLineItemUpdateDto.TaxCodeId is provided, the provided FulcrumProduct.PublicApi.Dto.PurchaseOrder.FeeLineItem.FeeLineItemUpdateDto.TaxRate will supercede the defined tax rate.

object or null

Arbitrary key-value-pair like data that can be used to later on search for this line item.

Responses

Request samples

Content type
{
  • "name": "string",
  • "description": "string",
  • "quantity": 0,
  • "price": 0,
  • "accountingCodeId": "stringstringstringstring",
  • "unitOfMeasure": "notApplicable",
  • "isReceivable": true,
  • "isTaxable": true,
  • "taxCodeId": "stringstringstringstring",
  • "taxRate": 0,
  • "externalReferences": {
    }
}

Response samples

Content type
{
  • "id": "stringstringstringstringstringstring",
  • "name": "string",
  • "description": "string",
  • "quantity": 0,
  • "price": 0,
  • "unitOfMeasure": "notApplicable",
  • "accountingCodeId": "stringstringstringstring",
  • "isTaxable": true,
  • "isReceivable": true,
  • "overrideTaxRate": true,
  • "taxCodeId": "stringstringstringstring",
  • "taxRate": 0,
  • "externalReferences": {
    }
}

Get a list of fee lines items for a purchase order

path Parameters
purchaseOrderId
required
string = 24 characters

Responses

Response samples

Content type
[
  • {
    }
]

Purchase Order Line Item

Get a specific line item for a purchase order of generic type

path Parameters
purchaseOrderId
required
string = 24 characters
lineItemId
required
string = 36 characters

Responses

Response samples

Content type
{
  • "id": "stringstringstringstringstringstring",
  • "type": "part",
  • "price": 0,
  • "discountedPrice": 0,
  • "name": "string",
  • "description": "string",
  • "quantity": 0,
  • "externalReferences": {
    },
  • "accountingCodeId": "stringstringstringstring",
  • "taxCodeId": "stringstringstringstring",
  • "isTaxable": true,
  • "lineItemId": "string",
  • "expectedReceiveDate": "2019-08-24T14:15:22Z",
  • "subTotal": 0,
  • "preDiscountSubTotal": 0,
  • "isPercentageDiscount": true,
  • "discountAmount": 0
}

Get a list of lines items for a purchase order, regardless of type

path Parameters
purchaseOrderId
required
string = 24 characters

Responses

Response samples

Content type
[
  • {
    }
]

Purchase Order Outside Processing Line Item

Create an outside processing line item on a purchase order

path Parameters
purchaseOrderId
required
string = 24 characters
Request Body schema:
jobId
required
string = 24 characters

Job id associated with this line item.

operationId
required
string = 36 characters

Operation id associated with this line item.

quantity
number or null <double> >= 0

The line item quantity. If not provided, defaults to Job operation QuantityToMake

price
number or null <double> >= 0

The line item unit price. If not provided, defaults to price data stored on Job operation.

Responses

Request samples

Content type
{
  • "jobId": "stringstringstringstring",
  • "operationId": "stringstringstringstringstringstring",
  • "quantity": 0,
  • "price": 0
}

Response samples

Content type
{
  • "id": "string"
}

Delete an outside processing line item on a purchase order

path Parameters
purchaseOrderId
required
string = 24 characters
lineItemId
required
string = 36 characters

Responses

Get a specific outside processing line item for a purchase order

path Parameters
purchaseOrderId
required
string = 24 characters
lineItemId
required
string = 36 characters

Responses

Response samples

Content type
{
  • "id": "stringstringstringstringstringstring",
  • "name": "string",
  • "quantity": 0,
  • "price": 0,
  • "jobId": "stringstringstringstring",
  • "operationId": "stringstringstringstringstringstring",
  • "itemId": "stringstringstringstring",
  • "isTaxable": true,
  • "accountingCodeId": "stringstringstringstring",
  • "description": "string",
  • "receivedStatus": "open",
  • "externalReferences": {
    }
}

Partially update a specific outside processing line item for a purchase order

path Parameters
purchaseOrderId
required
string = 24 characters
lineItemId
required
string = 36 characters
Request Body schema: application/json-patch+json
Array
op
string
value
string
path
string

Responses

Request samples

Content type
application/json-patch+json
[
  • {
    }
]

Response samples

Content type
{
  • "id": "stringstringstringstringstringstring",
  • "name": "string",
  • "quantity": 0,
  • "price": 0,
  • "jobId": "stringstringstringstring",
  • "operationId": "stringstringstringstringstringstring",
  • "itemId": "stringstringstringstring",
  • "isTaxable": true,
  • "accountingCodeId": "stringstringstringstring",
  • "description": "string",
  • "receivedStatus": "open",
  • "externalReferences": {
    }
}

Update a specific outside processing line item for a purchase order

path Parameters
purchaseOrderId
required
string = 24 characters
lineItemId
required
string = 36 characters
Request Body schema:
quantity
number or null <double> >= 0

The line item quantity

price
number or null <double> >= 0

The line item price.

object or null

Arbitrary key-value-pair like data that can be used to later on search for this line item.

Responses

Request samples

Content type
{
  • "quantity": 0,
  • "price": 0,
  • "externalReferences": {
    }
}

Response samples

Content type
{
  • "id": "stringstringstringstringstringstring",
  • "name": "string",
  • "quantity": 0,
  • "price": 0,
  • "jobId": "stringstringstringstring",
  • "operationId": "stringstringstringstringstringstring",
  • "itemId": "stringstringstringstring",
  • "isTaxable": true,
  • "accountingCodeId": "stringstringstringstring",
  • "description": "string",
  • "receivedStatus": "open",
  • "externalReferences": {
    }
}

Get a list of outside processing lines items for a purchase order

path Parameters
purchaseOrderId
required
string = 24 characters

Responses

Response samples

Content type
[
  • {
    }
]

Purchase Order Part Line Item

Create a part line item on a purchase order

path Parameters
purchaseOrderId
required
string = 24 characters
Request Body schema:
itemId
required
string = 24 characters

Item id associated with this line item.

quantity
number <double> >= 0

The line item quantity

price
number or null <double> >= 0

The line item unit price. Defaults to item's vendor price, if not provided.

isTaxExempt
boolean or null

Dictate if this line item is tax exempt. Defaults to item details, if not provided.

expectedReceiveDate
string or null <date-time>

Expected receipt date for this line item.

Responses

Request samples

Content type
{
  • "itemId": "stringstringstringstring",
  • "quantity": 0,
  • "price": 0,
  • "isTaxExempt": true,
  • "expectedReceiveDate": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "id": "string"
}

Delete a part line item on a purchase order

path Parameters
purchaseOrderId
required
string = 24 characters
lineItemId
required
string = 36 characters

Responses

Get a specific part line item for a purchase order

path Parameters
purchaseOrderId
required
string = 24 characters
lineItemId
required
string = 36 characters

Responses

Response samples

Content type
{
  • "id": "stringstringstringstringstringstring",
  • "name": "string",
  • "quantity": 0,
  • "price": 0,
  • "discountedPrice": 0,
  • "itemId": "stringstringstringstring",
  • "isTaxable": true,
  • "overrideTaxRate": true,
  • "description": "string",
  • "accountingCodeId": "stringstringstringstring",
  • "receivedStatus": "open",
  • "convertedQuantity": 0,
  • "subTotal": 0,
  • "preDiscountSubTotal": 0,
  • "expectedReceiveDate": "2019-08-24T14:15:22Z",
  • "notes": "string",
  • "externalReferences": {
    },
  • "customFieldData": {
    },
  • "isPercentageDiscount": true,
  • "discountAmount": 0,
  • "vendorPartNumber": "string",
  • "vendorPartDescription": "string"
}

Partially update a specific part line item for a purchase order

path Parameters
purchaseOrderId
required
string = 24 characters
lineItemId
required
string = 36 characters
Request Body schema: application/json-patch+json
Array
op
string
value
string
path
string

Responses

Request samples

Content type
application/json-patch+json
[
  • {
    }
]

Response samples

Content type
{
  • "id": "stringstringstringstringstringstring",
  • "name": "string",
  • "quantity": 0,
  • "price": 0,
  • "discountedPrice": 0,
  • "itemId": "stringstringstringstring",
  • "isTaxable": true,
  • "overrideTaxRate": true,
  • "description": "string",
  • "accountingCodeId": "stringstringstringstring",
  • "receivedStatus": "open",
  • "convertedQuantity": 0,
  • "subTotal": 0,
  • "preDiscountSubTotal": 0,
  • "expectedReceiveDate": "2019-08-24T14:15:22Z",
  • "notes": "string",
  • "externalReferences": {
    },
  • "customFieldData": {
    },
  • "isPercentageDiscount": true,
  • "discountAmount": 0,
  • "vendorPartNumber": "string",
  • "vendorPartDescription": "string"
}

Update a specific part line item for a purchase order

path Parameters
purchaseOrderId
required
string = 24 characters
lineItemId
required
string = 36 characters
Request Body schema:
quantity
required
number <double> >= 0

The line item quantity

price
number or null <double> >= 0

The line item unit price. Defaults to item's vendor price, if not provided.

isTaxExempt
boolean or null

Override tax exempt status of the part line item, if present.

object or null

Arbitrary key-value-pair like data that can be used to later on search for this line item.

Responses

Request samples

Content type
{
  • "quantity": 0,
  • "price": 0,
  • "isTaxExempt": true,
  • "externalReferences": {
    }
}

Response samples

Content type
{
  • "id": "stringstringstringstringstringstring",
  • "name": "string",
  • "quantity": 0,
  • "price": 0,
  • "discountedPrice": 0,
  • "itemId": "stringstringstringstring",
  • "isTaxable": true,
  • "overrideTaxRate": true,
  • "description": "string",
  • "accountingCodeId": "stringstringstringstring",
  • "receivedStatus": "open",
  • "convertedQuantity": 0,
  • "subTotal": 0,
  • "preDiscountSubTotal": 0,
  • "expectedReceiveDate": "2019-08-24T14:15:22Z",
  • "notes": "string",
  • "externalReferences": {
    },
  • "customFieldData": {
    },
  • "isPercentageDiscount": true,
  • "discountAmount": 0,
  • "vendorPartNumber": "string",
  • "vendorPartDescription": "string"
}

Get a list of part line items for a purchase order

path Parameters
purchaseOrderId
required
string = 24 characters

Responses

Response samples

Content type
[
  • {
    }
]

Purchase Order Tax Line Item

Get a specific tax line item for a purchase order

path Parameters
purchaseOrderId
required
string = 24 characters
lineItemId
required
string = 36 characters

Responses

Response samples

Content type
{
  • "id": "stringstringstringstringstringstring",
  • "description": "string",
  • "taxCodeId": "stringstringstringstring",
  • "code": "string",
  • "taxRate": 0,
  • "externalReferences": {
    },
  • "price": 0,
  • "taxCodeEditable": true
}

Get a list of tax lines items for a purchase order

path Parameters
purchaseOrderId
required
string = 24 characters

Responses

Response samples

Content type
[
  • {
    }
]

Purchase Order Vendor Credit Line Item

Get a specific vendor credit line item for a purchase order

path Parameters
purchaseOrderId
required
string = 24 characters
lineItemId
required
string = 36 characters

Responses

Response samples

Content type
{
  • "id": "stringstringstringstringstringstring",
  • "name": "string",
  • "quantity": 0,
  • "vendorCredit": 0,
  • "itemId": "stringstringstringstring",
  • "purchaseOrderId": "stringstringstringstringstringstring",
  • "lineItemId": "stringstringstringstringstringstring",
  • "description": "string",
  • "externalReferences": {
    },
  • "accountingCodeId": "stringstringstringstring"
}

Partially update a specific vendor credit line item for a purchase order

path Parameters
purchaseOrderId
required
string = 24 characters
lineItemId
required
string = 36 characters
Request Body schema: application/json-patch+json
Array
op
string
value
string
path
string

Responses

Request samples

Content type
application/json-patch+json
[
  • {
    }
]

Response samples

Content type
{
  • "id": "stringstringstringstringstringstring",
  • "name": "string",
  • "quantity": 0,
  • "vendorCredit": 0,
  • "itemId": "stringstringstringstring",
  • "purchaseOrderId": "stringstringstringstringstringstring",
  • "lineItemId": "stringstringstringstringstringstring",
  • "description": "string",
  • "externalReferences": {
    },
  • "accountingCodeId": "stringstringstringstring"
}

Update a specific vendor credit line item for a purchase order

path Parameters
purchaseOrderId
required
string = 24 characters
lineItemId
required
string = 36 characters
Request Body schema:
object or null

Arbitrary key-value-pair like data that can be used to later on search for this line item.

additional property
object (CommonExternalReferenceDto)

The external reference for entities that implement FulcrumProduct.Domain.Common.IHasExternalReferences

type
string or null [ 0 .. 50 ] characters

Specifies the type of this identifier.

externalId
required
string [ 0 .. 500 ] characters

The external identifier

displayId
string or null [ 0 .. 500 ] characters

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
string or null

A status for the external reference

url
string or null

An external url for the reference

modifiedUtc
string or null <date-time>

Date the external reference was modified

Responses

Request samples

Content type
{
  • "externalReferences": {
    }
}

Response samples

Content type
{
  • "id": "stringstringstringstringstringstring",
  • "name": "string",
  • "quantity": 0,
  • "vendorCredit": 0,
  • "itemId": "stringstringstringstring",
  • "purchaseOrderId": "stringstringstringstringstringstring",
  • "lineItemId": "stringstringstringstringstringstring",
  • "description": "string",
  • "externalReferences": {
    },
  • "accountingCodeId": "stringstringstringstring"
}

Get a list of vendor credit line items for a specific purchase order

path Parameters
purchaseOrderId
required
string = 24 characters

Responses

Response samples

Content type
[
  • {
    }
]

Quote

Convert a quote to a sales order

path Parameters
quoteId
required
string = 24 characters

Responses

Response samples

Content type
{
  • "id": "string"
}

Create a new draft quote

Request Body schema:
customerId
required
string = 24 characters

The id of the customer to be created

object (CommonAddressCreateDto)

Address with additional context

object (CustomerContactCreateDto)

A customer contact

object or null

Arbitrary key-value-pair like data that can be used to later on search for the Quote

salesPersonId
string or null = 24 characters

Sales Person identifier. Please reference /api/users endpoint. If not provided, the salesperson defined on the customer will be used.

object (FulcrumProDomainReference)
opportunity
string or null

CRM Opportunity identifier.

Responses

Request samples

Content type
{
  • "customerId": "stringstringstringstring",
  • "billingAddress": {
    },
  • "contact": {
    },
  • "externalReferences": {
    },
  • "salesPersonId": "stringstringstringstring",
  • "crmOpportunity": {
    },
  • "opportunity": "string"
}

Response samples

Content type
{
  • "id": "string"
}

Delete a specific Quote

path Parameters
quoteId
required
string = 24 characters

Responses

Get a specific Quote

path Parameters
quoteId
required
string = 24 characters

Responses

Response samples

Content type
{
  • "id": "stringstringstringstring",
  • "number": 0,
  • "customerId": "stringstringstringstring",
  • "quotedDate": "2019-08-24T14:15:22Z",
  • "status": "open",
  • "externalReferences": {
    },
  • "totalInPrimaryCurrency": 0,
  • "currencyInfo": {
    },
  • "customFields": {
    }
}

Update a quote

path Parameters
quoteId
required
string = 24 characters
Request Body schema:
object (CommonAddressCreateDto)

Address with additional context

object or null

Arbitrary key-value-pair like data that can be used to later on search for the Quote

opportunity
string or null

CRM Opportunity identifier.

Responses

Request samples

Content type
{
  • "billingAddress": {
    },
  • "externalReferences": {
    },
  • "opportunity": "string"
}

Response samples

Content type
{
  • "id": "stringstringstringstring",
  • "number": 0,
  • "customerId": "stringstringstringstring",
  • "quotedDate": "2019-08-24T14:15:22Z",
  • "status": "open",
  • "externalReferences": {
    },
  • "totalInPrimaryCurrency": 0,
  • "currencyInfo": {
    },
  • "customFields": {
    }
}

Find quotes based on search parameters.

query Parameters
Sort.Field
string non-empty

Sort field

Sort.Dir
string (CommonEnumSortDirectionEnum)
Enum: "ascending" "descending"

Sort direction

Skip
integer <int32> >= 0

Number of records to skip.

Take
integer <int32> [ 0 .. 1000 ]

Number of records to return (maximum)

Request Body schema:
numbers
Array of integers or null <int32> [ 1 .. 500 ] items

Filter quotes to only given numbers

object (CommonExternalReferenceFindDto)

Search parameter for identifier record(s) via their external identifiers.

status
string (DtoQuotesStatus)
Enum: "open" "draft" "needsApproval" "approved" "sent" "won" "lost"

Quotes status

Responses

Request samples

Content type
{
  • "numbers": [
    ],
  • "externalReference": {
    },
  • "status": "open"
}

Response samples

Content type
[
  • {
    }
]

Update a quote status

path Parameters
quoteId
required
string = 24 characters
Request Body schema:
status
required
string (DtoQuoteUpdateQuotesStatus)
Enum: "draft" "needsApproval" "approved" "sent" "won" "lost"

Statuses you can update a quote too

Responses

Request samples

Content type
{
  • "status": "draft"
}

Quote Custom Fields

Update (selectively) custom fields on a quote

path Parameters
id
required
string = 24 characters

The quote identifier

Request Body schema:

The custom fields to update

object

The custom fields

property name*
additional property
any

Responses

Request samples

Content type
{
  • "customFields": {
    }
}

Response samples

Content type
{
  • "customFields": {
    }
}

Update (selectively) custom fields on a quote

path Parameters
id
required
string = 24 characters

The quote identifier

Request Body schema:

The custom fields to update

object

The custom fields

property name*
additional property
any

Responses

Request samples

Content type
{
  • "customFields": {
    }
}

Response samples

Content type
{
  • "customFields": {
    }
}

Quote Discount Line Item

Delete the discount line item for a Quote

path Parameters
quoteId
required
string = 24 characters

Responses

Get the discount line item for a quote

path Parameters
quoteId
required
string = 24 characters

Responses

Response samples

Content type
{
  • "id": "stringstringstringstringstringstring",
  • "name": "string",
  • "description": "string",
  • "isPercentage": true,
  • "amount": 0
}

Update the discount line item for a quote

path Parameters
quoteId
required
string = 24 characters
Request Body schema:
name
required
string [ 1 .. 200 ] characters

The name of the discount line.

description
string or null [ 1 .. 2000 ] characters

The description of the discount line.

isPercentage
required
boolean

Indicates whether "Amount" value is percentage based or an absolute amount.

amount
required
number <double> >= 0

The amount of the discount.

Responses

Request samples

Content type
{
  • "name": "string",
  • "description": "string",
  • "isPercentage": true,
  • "amount": 0
}

Response samples

Content type
{
  • "id": "stringstringstringstringstringstring",
  • "name": "string",
  • "description": "string",
  • "isPercentage": true,
  • "amount": 0
}

Quote Fee Line Item

Create a fee line item on a Quote

path Parameters
quoteId
required
string = 24 characters
Request Body schema:
name
string or null [ 1 .. 200 ] characters

Verbose name for this entity.

description
string or null [ 1 .. 2000 ] characters

Verbose description for this entity.

quantity
number or null <double> >= 0

The line item quantity

price
required
number <double> >= 0

The line item price.

accountingCodeId
string or null = 24 characters

Accounting code key identifier. Please reference /api/accounting-codes endpoint.

unitOfMeasure
string (CommonEnumLineItemUomEnum)
Enum: "notApplicable" "piece" "linearFeet" "hour" "yard"

Line item unit of measure.

isTaxable
boolean or null

Dictate if this fee is taxable.

taxCodeId
string or null = 24 characters

Tax code key identifier.

taxRate
number or null <double> >= 0

Tax code to use for this entity. If a FulcrumProduct.PublicApi.Dto.Quote.FeeLineItem.QuoteFeeLineItemCreateDto.TaxCodeId is provided, the provided FulcrumProduct.PublicApi.Dto.Quote.FeeLineItem.QuoteFeeLineItemCreateDto.TaxRate will supercede the defined tax rate.

object or null

Arbitrary key-value-pair like data that can be used to later on search for this line item.

Responses

Request samples

Content type
{
  • "name": "string",
  • "description": "string",
  • "quantity": 0,
  • "price": 0,
  • "accountingCodeId": "stringstringstringstring",
  • "unitOfMeasure": "notApplicable",
  • "isTaxable": true,
  • "taxCodeId": "stringstringstringstring",
  • "taxRate": 0,
  • "externalReferences": {
    }
}

Response samples

Content type
{
  • "id": "string"
}

Delete a specific fee line item for a Quote

path Parameters
quoteId
required
string = 24 characters
lineItemId
required
string = 36 characters

Responses

Get a specific fee line item for a Quote

path Parameters
quoteId
required
string = 24 characters
lineItemId
required
string = 36 characters

Responses

Response samples

Content type
{
  • "id": "stringstringstringstringstringstring",
  • "name": "string",
  • "description": "string",
  • "quantity": 0,
  • "price": 0,
  • "unitOfMeasure": "notApplicable",
  • "isTaxable": true,
  • "overrideTaxRate": true,
  • "taxCodeId": "stringstringstringstring",
  • "taxRate": 0
}

Update a specific fee line item for a Quote

path Parameters
quoteId
required
string = 24 characters
lineItemId
required
string = 36 characters
Request Body schema:
name
string or null [ 1 .. 200 ] characters

Verbose name for this entity.

description
string or null [ 1 .. 2000 ] characters

Verbose description for this entity.

quantity
number or null <double> >= 0

The line item quantity

price
required
number <double> >= 0

The line item price.

accountingCodeId
string or null = 24 characters

Accounting code key identifier. Please reference /api/accounting-codes endpoint.

unitOfMeasure
string (CommonEnumLineItemUomEnum)
Enum: "notApplicable" "piece" "linearFeet" "hour" "yard"

Line item unit of measure.

isTaxable
boolean or null

Dictate if this fee is taxable.

taxCodeId
string or null = 24 characters

Tax code key identifier. Please reference /api/tax-rates endpoint

taxRate
number or null <double> >= 0

Tax code to use for this entity. If a FulcrumProduct.PublicApi.Dto.Quote.FeeLineItem.QuoteFeeLineItemUpdateDto.TaxCodeId is provided, the provided FulcrumProduct.PublicApi.Dto.Quote.FeeLineItem.QuoteFeeLineItemUpdateDto.TaxRate will supercede the defined tax rate.

object or null

Arbitrary key-value-pair like data that can be used to later on search for this line item.

Responses

Request samples

Content type
{
  • "name": "string",
  • "description": "string",
  • "quantity": 0,
  • "price": 0,
  • "accountingCodeId": "stringstringstringstring",
  • "unitOfMeasure": "notApplicable",
  • "isTaxable": true,
  • "taxCodeId": "stringstringstringstring",
  • "taxRate": 0,
  • "externalReferences": {
    }
}

Response samples

Content type
{
  • "id": "stringstringstringstringstringstring",
  • "name": "string",
  • "description": "string",
  • "quantity": 0,
  • "price": 0,
  • "unitOfMeasure": "notApplicable",
  • "isTaxable": true,
  • "overrideTaxRate": true,
  • "taxCodeId": "stringstringstringstring",
  • "taxRate": 0
}

Get a list of fee lines items for a Quote

path Parameters
quoteId
required
string = 24 characters

Responses

Response samples

Content type
[
  • {
    }
]

Quote Part Line Item

Create a part line item on a Quote

path Parameters
quoteId
required
string = 24 characters
Request Body schema:
itemId
required
string = 24 characters

Item id associated with this line item.

quantity
number <double> >= 0

The line item quantity

price
number <double> >= 0

The line item price.

description
string or null [ 1 .. 2000 ] characters

The part line item description. Defaults to the item's description if none specified.

internalNotes
string or null [ 1 .. 2000 ] characters

The line item internal notes

itemNotes
string or null [ 1 .. 2000 ] characters

The line item notes.

isTaxable
boolean or null

Dictate if this line item is taxable.

taxCodeId
string or null = 24 characters

Tax code key identifier. Please reference /api/tax-rates endpoint.

taxRate
number or null <double> >= 0

Tax rate to use for this entity. If a FulcrumProduct.PublicApi.Dto.Quote.PartLineItem.QuotePartLineItemCreateDto.TaxCodeId is provided, the provided FulcrumProduct.PublicApi.Dto.Quote.PartLineItem.QuotePartLineItemCreateDto.TaxRate will supercede the defined tax rate.

object or null

Arbitrary key-value-pair like data that can be used to later on search for this line item.

isPercentageDiscount
boolean or null

Indicates whether FulcrumProduct.PublicApi.Dto.Quote.PartLineItem.QuotePartLineItemCreateDto.DiscountAmount discount is percentage based (else, it's an absolute amount).

discountAmount
number or null <double>

The amount of the discount.

accountingCodeId
string or null = 24 characters

Accounting code key identifier. Please reference /api/accounting-codes endpoint.

Responses

Request samples

Content type
{
  • "itemId": "stringstringstringstring",
  • "quantity": 0,
  • "price": 0,
  • "description": "string",
  • "internalNotes": "string",
  • "itemNotes": "string",
  • "isTaxable": true,
  • "taxCodeId": "stringstringstringstring",
  • "taxRate": 0,
  • "externalReferences": {
    },
  • "isPercentageDiscount": true,
  • "discountAmount": 0,
  • "accountingCodeId": "stringstringstringstring"
}

Response samples

Content type
{
  • "id": "string"
}

Create one or more part line items on a quote

path Parameters
quoteId
required
string = 24 characters
Request Body schema:
required
Array of objects (QuotePartLineItemCreateDto)

The line items to add to a sales order.

Array
itemId
required
string = 24 characters

Item id associated with this line item.

quantity
number <double> >= 0

The line item quantity

price
number <double> >= 0

The line item price.

description
string or null [ 1 .. 2000 ] characters

The part line item description. Defaults to the item's description if none specified.

internalNotes
string or null [ 1 .. 2000 ] characters

The line item internal notes

itemNotes
string or null [ 1 .. 2000 ] characters

The line item notes.

isTaxable
boolean or null

Dictate if this line item is taxable.

taxCodeId
string or null = 24 characters

Tax code key identifier. Please reference /api/tax-rates endpoint.

taxRate
number or null <double> >= 0

Tax rate to use for this entity. If a FulcrumProduct.PublicApi.Dto.Quote.PartLineItem.QuotePartLineItemCreateDto.TaxCodeId is provided, the provided FulcrumProduct.PublicApi.Dto.Quote.PartLineItem.QuotePartLineItemCreateDto.TaxRate will supercede the defined tax rate.

object or null

Arbitrary key-value-pair like data that can be used to later on search for this line item.

isPercentageDiscount
boolean or null

Indicates whether FulcrumProduct.PublicApi.Dto.Quote.PartLineItem.QuotePartLineItemCreateDto.DiscountAmount discount is percentage based (else, it's an absolute amount).

discountAmount
number or null <double>

The amount of the discount.

accountingCodeId
string or null = 24 characters

Accounting code key identifier. Please reference /api/accounting-codes endpoint.

Responses

Request samples

Content type
{
  • "lineItems": [
    ]
}

Response samples

Content type
{
  • "ids": [
    ]
}

Delete a specific part line item for a Quote

path Parameters
quoteId
required
string = 24 characters
lineItemId
required
string = 36 characters

Responses

Get a specific part line item for a Quote

path Parameters
quoteId
required
string = 24 characters
lineItemId
required
string = 36 characters

Responses

Response samples

Content type
{
  • "id": "stringstringstringstringstringstring",
  • "quantity": 0,
  • "price": 0,
  • "discountedPrice": 0,
  • "itemId": "stringstringstringstring",
  • "description": "string",
  • "isTaxable": true,
  • "taxCodeId": "stringstringstringstring",
  • "taxRate": 0,
  • "overrideTaxRate": true,
  • "externalReferences": {
    },
  • "isPercentageDiscount": true,
  • "discountAmount": 0,
  • "subTotal": 0,
  • "preDiscountSubTotal": 0,
  • "customFields": {
    }
}

Update a specific part line item for a Quote

path Parameters
quoteId
required
string = 24 characters
lineItemId
required
string = 36 characters
Request Body schema:
quantity
number <double> >= 0

The line item quantity

price
number <double> >= 0

The line item price.

description
string or null [ 1 .. 2000 ] characters

The part line item description. Defaults to the item's description if none specified.

internalNotes
string or null [ 1 .. 2000 ] characters

The line item internal notes

itemNotes
string or null [ 1 .. 2000 ] characters

The line item notes.

isTaxable
boolean or null

Dictate if this line item is taxable.

taxCodeId
string or null = 24 characters

Tax code key identifier. Please reference /api/tax-rates endpoint.

taxRate
number or null <double> >= 0

Tax rate to use for this entity. If a FulcrumProduct.PublicApi.Dto.Quote.PartLineItem.QuotePartLineItemUpdateDto.TaxCodeId is provided, the provided FulcrumProduct.PublicApi.Dto.Quote.PartLineItem.QuotePartLineItemUpdateDto.TaxRate will supercede the defined tax rate.

object or null

Arbitrary key-value-pair like data that can be used to later on search for this line item.

isPercentageDiscount
boolean or null

Indicates whether FulcrumProduct.PublicApi.Dto.Quote.PartLineItem.QuotePartLineItemUpdateDto.DiscountAmount discount is percentage based (else, it's an absolute amount).

discountAmount
number or null <double>

The amount of the discount.

accountingCodeId
string or null = 24 characters

Accounting code key identifier. Please reference /api/accounting-codes endpoint.

Responses

Request samples

Content type
{
  • "quantity": 0,
  • "price": 0,
  • "description": "string",
  • "internalNotes": "string",
  • "itemNotes": "string",
  • "isTaxable": true,
  • "taxCodeId": "stringstringstringstring",
  • "taxRate": 0,
  • "externalReferences": {
    },
  • "isPercentageDiscount": true,
  • "discountAmount": 0,
  • "accountingCodeId": "stringstringstringstring"
}

Response samples

Content type
{
  • "id": "stringstringstringstringstringstring",
  • "quantity": 0,
  • "price": 0,
  • "discountedPrice": 0,
  • "itemId": "stringstringstringstring",
  • "description": "string",
  • "isTaxable": true,
  • "taxCodeId": "stringstringstringstring",
  • "taxRate": 0,
  • "overrideTaxRate": true,
  • "externalReferences": {
    },
  • "isPercentageDiscount": true,
  • "discountAmount": 0,
  • "subTotal": 0,
  • "preDiscountSubTotal": 0,
  • "customFields": {
    }
}

Get a list of part lines items for a Quote

path Parameters
quoteId
required
string = 24 characters

Responses

Response samples

Content type
[
  • {
    }
]

Quote Part Line Item Custom Fields

Update (selectively) custom fields on a line item

path Parameters
quoteId
required
string = 24 characters

The quote identifier that contains the line item

lineItemId
required
string = 36 characters

The line item identifier that contains the custom fields you want to update.

Request Body schema:

The custom fields to update

object

The custom fields

property name*
additional property
any

Responses

Request samples

Content type
{
  • "customFields": {
    }
}

Response samples

Content type
{
  • "customFields": {
    }
}

Update (selectively) custom fields on a line item

path Parameters
quoteId
required
string = 24 characters

The quote identifier that contains the line item

lineItemId
required
string = 36 characters

The line item identifier that contains the custom fields you want to update.

Request Body schema:

The custom fields to update

object

The custom fields

property name*
additional property
any

Responses

Request samples

Content type
{
  • "customFields": {
    }
}

Response samples

Content type
{
  • "customFields": {
    }
}

Quote Tax Line Item

Create a tax line item on a Quote

path Parameters
quoteId
required
string = 24 characters
Request Body schema:
description
string or null [ 1 .. 2000 ] characters

Verbose description for this entity.

taxCodeId
string or null = 24 characters

Tax code key identifier. Please reference /api/tax-rates endpoint. If FulcrumProduct.PublicApi.Dto.Quote.TaxLineItem.QuoteTaxLineItemCreateDto.AvalaraOptions is provided, FulcrumProduct.PublicApi.Dto.Quote.TaxLineItem.QuoteTaxLineItemCreateDto.TaxCodeId will be ignored.

taxRate
number or null <double> >= 0

Tax rate to use for this entity. If a FulcrumProduct.PublicApi.Dto.Quote.TaxLineItem.QuoteTaxLineItemCreateDto.TaxCodeId is provided, the provided FulcrumProduct.PublicApi.Dto.Quote.TaxLineItem.QuoteTaxLineItemCreateDto.TaxRate will supercede the defined tax rate.

object (QuoteTaxLineItemAvalaraOptions)

Options for use with Avalara (if enabled).

Responses

Request samples

Content type
{
  • "description": "string",
  • "taxCodeId": "stringstringstringstring",
  • "taxRate": 0,
  • "avalaraOptions": {
    }
}

Response samples

Content type
{
  • "id": "string"
}

Delete a specific tax line item for a Quote

path Parameters
quoteId
required
string = 24 characters
lineItemId
required
string = 36 characters

Responses

Get a specific tax line item for a Quote

path Parameters
quoteId
required
string = 24 characters
lineItemId
required
string = 36 characters

Responses

Response samples

Content type
{
  • "id": "stringstringstringstringstringstring",
  • "description": "string",
  • "taxCodeId": "stringstringstringstring",
  • "taxRate": 0,
  • "avalaraOptions": {
    }
}

Update a specific tax line item for a Quote

path Parameters
quoteId
required
string = 24 characters
lineItemId
required
string = 36 characters
Request Body schema:
description
string or null [ 1 .. 2000 ] characters

Verbose description for this entity.

taxCodeId
string or null = 24 characters

Tax code key identifier. Please reference /api/tax-rates endpoint. If FulcrumProduct.PublicApi.Dto.Quote.TaxLineItem.QuoteTaxLineItemUpdateDto.AvalaraOptions is provided, FulcrumProduct.PublicApi.Dto.Quote.TaxLineItem.QuoteTaxLineItemUpdateDto.TaxCodeId will be ignored.

taxRate
number or null <double> >= 0

Tax rate to use for this entity. If a FulcrumProduct.PublicApi.Dto.Quote.TaxLineItem.QuoteTaxLineItemUpdateDto.TaxCodeId is provided, the provided FulcrumProduct.PublicApi.Dto.Quote.TaxLineItem.QuoteTaxLineItemUpdateDto.TaxRate will supercede the defined tax rate.

object (QuoteTaxLineItemAvalaraOptions)

Options for use with Avalara (if enabled).

Responses

Request samples

Content type
{
  • "description": "string",
  • "taxCodeId": "stringstringstringstring",
  • "taxRate": 0,
  • "avalaraOptions": {
    }
}

Response samples

Content type
{
  • "id": "stringstringstringstringstringstring",
  • "description": "string",
  • "taxCodeId": "stringstringstringstring",
  • "taxRate": 0,
  • "avalaraOptions": {
    }
}

Get a list of tax lines items for a Quote

path Parameters
quoteId
required
string = 24 characters

Responses

Response samples

Content type
[
  • {
    }
]

Receiving Receipt

Create a receipt for a specific purchase or sales order

Request Body schema:
orderType
required
string (CommonEnumOrderType)
Enum: "purchaseOrder" "salesOrder"

Order type enum

orderId
required
string = 24 characters

Id of parent order to which this receipt belongs

required
Array of objects (ReceivingLineItemReceiptLineItemCreateDto)

Line items

Responses

Request samples

Content type
{
  • "orderType": "purchaseOrder",
  • "orderId": "stringstringstringstring",
  • "lines": [
    ]
}

Response samples

Content type
{
  • "id": "stringstringstringstringstringstring",
  • "receivedBy": "string",
  • "number": 0,
  • "date": "2019-08-24T14:15:22Z",
  • "orderType": "purchaseOrder",
  • "orderId": "stringstringstringstring",
  • "externalReferences": {
    },
  • "lines": [
    ],
  • "customFields": {
    },
  • "invoiceNumber": "string"
}

Get a specific receipt on a purchase or sales order

path Parameters
receiptId
required
string = 36 characters

Responses

Response samples

Content type
{
  • "id": "stringstringstringstringstringstring",
  • "receivedBy": "string",
  • "number": 0,
  • "date": "2019-08-24T14:15:22Z",
  • "orderType": "purchaseOrder",
  • "orderId": "stringstringstringstring",
  • "externalReferences": {
    },
  • "lines": [
    ],
  • "customFields": {
    },
  • "invoiceNumber": "string"
}

Partially update a specific receipt for a purchase or sales order

path Parameters
receiptId
required
string = 36 characters
Request Body schema: application/json-patch+json
Array
op
string
value
string
path
string

Responses

Request samples

Content type
application/json-patch+json
[
  • {
    }
]

Response samples

Content type
{
  • "id": "stringstringstringstringstringstring",
  • "receivedBy": "string",
  • "number": 0,
  • "date": "2019-08-24T14:15:22Z",
  • "orderType": "purchaseOrder",
  • "orderId": "stringstringstringstring",
  • "externalReferences": {
    },
  • "lines": [
    ],
  • "customFields": {
    },
  • "invoiceNumber": "string"
}

Update a specific receipt for a purchase or sales order

path Parameters
receiptId
required
string = 36 characters
Request Body schema:
receivedBy
required
string = 24 characters

Id of the user who received the item(s)

date
string or null <date-time>

Received date override. If not provided, receipt date will default to the date the object was initially created.

object or null

Arbitrary key-value-pair like data that can be used to later on search for this receipt object.

Responses

Request samples

Content type
{
  • "receivedBy": "stringstringstringstring",
  • "date": "2019-08-24T14:15:22Z",
  • "externalReferences": {
    }
}

Response samples

Content type
{
  • "id": "stringstringstringstringstringstring",
  • "receivedBy": "string",
  • "number": 0,
  • "date": "2019-08-24T14:15:22Z",
  • "orderType": "purchaseOrder",
  • "orderId": "stringstringstringstring",
  • "externalReferences": {
    },
  • "lines": [
    ],
  • "customFields": {
    },
  • "invoiceNumber": "string"
}

Get a list of receipts for purchase and sales orders

query Parameters
Sort.Field
string non-empty

Sort field

Sort.Dir
string (CommonEnumSortDirectionEnum)
Enum: "ascending" "descending"

Sort direction

Skip
integer <int32> >= 0

Number of records to skip.

Take
integer <int32> [ 0 .. 1000 ]

Number of records to return (maximum)

Request Body schema:
salesOrderIds
Array of strings or null

Include receipts for specific sales order ids

purchaseOrderIds
Array of strings or null

Include receipts for specific purchase order ids

receiptIds
Array of strings or null

Include receipts with specific ids

includeReceiptLines
boolean

If set to true, receipt line items will be included in the results

object (CommonExternalReferenceFindDto)

Search parameter for identifier record(s) via their external identifiers.

Responses

Request samples

Content type
{
  • "salesOrderIds": [
    ],
  • "purchaseOrderIds": [
    ],
  • "receiptIds": [
    ],
  • "includeReceiptLines": true,
  • "externalReference": {
    }
}

Response samples

Content type
[
  • {
    }
]

Receiving Receipt Line Item

Get a specific line item for a receipt on a purchase or sales order

path Parameters
receiptId
required
string = 36 characters

The receiving id

lineId
required
string [ 24 .. 36 ] characters

This will match on the line item id (from the purchase order or sales order) or the line id of the specific receiving

Responses

Response samples

Content type
{
  • "id": "stringstringstringstringstringstring",
  • "lineItemId": "stringstringstringstringstringstring",
  • "fullyReceived": true,
  • "rolledBack": true,
  • "quantityReceived": 0,
  • "unitOfMeasureMultiplier": 0,
  • "convertedQuantityReceived": 0,
  • "externalReferences": {
    }
}

Partially update a specific receipt for a purchase or sales order

path Parameters
receiptId
required
string = 36 characters
lineId
required
string [ 24 .. 36 ] characters
Request Body schema: application/json-patch+json
Array
op
string
value
string
path
string

Responses

Request samples

Content type
application/json-patch+json
[
  • {
    }
]

Response samples

Content type
{
  • "id": "stringstringstringstringstringstring",
  • "lineItemId": "stringstringstringstringstringstring",
  • "fullyReceived": true,
  • "rolledBack": true,
  • "quantityReceived": 0,
  • "unitOfMeasureMultiplier": 0,
  • "convertedQuantityReceived": 0,
  • "externalReferences": {
    }
}

Roll back a specific line item for a receipt on a purchase or sales order

path Parameters
receiptId
required
string = 36 characters

The receiving id

lineId
required
string [ 24 .. 36 ] characters

This will match on the line item id (from the purchase order or sales order) or the line id of the specific receiving

Responses

Update a specific receipt line item for a purchase or sales order receiving

path Parameters
receiptId
required
string = 36 characters
lineId
required
string [ 24 .. 36 ] characters
Request Body schema:
object or null

Arbitrary key-value-pair like data that can be used to later on search for this receipt line item object.

additional property
object (CommonExternalReferenceDto)

The external reference for entities that implement FulcrumProduct.Domain.Common.IHasExternalReferences

type
string or null [ 0 .. 50 ] characters

Specifies the type of this identifier.

externalId
required
string [ 0 .. 500 ] characters

The external identifier

displayId
string or null [ 0 .. 500 ] characters

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
string or null

A status for the external reference

url
string or null

An external url for the reference

modifiedUtc
string or null <date-time>

Date the external reference was modified

Responses

Request samples

Content type
{
  • "externalReferences": {
    }
}

Response samples

Content type
{
  • "id": "stringstringstringstringstringstring",
  • "lineItemId": "stringstringstringstringstringstring",
  • "fullyReceived": true,
  • "rolledBack": true,
  • "quantityReceived": 0,
  • "unitOfMeasureMultiplier": 0,
  • "convertedQuantityReceived": 0,
  • "externalReferences": {
    }
}

List line items for a receipt on a purchase or sales order

path Parameters
receiptId
required
string = 36 characters

Responses

Response samples

Content type
[
  • {
    }
]

Refund Reason Code

Get a refund code.

path Parameters
id
required
string = 24 characters

Responses

Response samples

Content type
{
  • "id": "stringstringstringstring",
  • "name": "string"
}

Find refund reason codes based on search parameters.

query Parameters
Sort.Field
string non-empty

Sort field

Sort.Dir
string (CommonEnumSortDirectionEnum)
Enum: "ascending" "descending"

Sort direction

Skip
integer <int32> >= 0

Number of records to skip.

Take
integer <int32> [ 0 .. 1000 ]

Number of records to return (maximum)

Request Body schema:
name
string or null [ 1 .. 200 ] characters

Filter refund reason codes based on their name.

ids
Array of strings or null

Filter refund reason codes based on matching ids.

Responses

Request samples

Content type
{
  • "name": "string",
  • "ids": [
    ]
}

Response samples

Content type
[
  • {
    }
]

Sales Order

Create a new draft sales order

Request Body schema:
customerId
required
string = 24 characters

The id of the customer to be created

orderedDate
string or null <date-time>

The ordered date of the sales order. If no supplied, will default to current UTC timestamp.

customerPoNumber
string or null [ 1 .. 200 ] characters

Optional customer supplied purchase order number

object (CommonAddressCreateDto)

Address with additional context

object (CommonAddressCreateDto)

Address with additional context

object (CustomerContactCreateDto)

A customer contact

object or null

Arbitrary key-value-pair like data that can be used to later on search for the Sales Order

externalQuoteUrl
string or null

A reference URL that points to an external quote entity.

dueDate
string or null <date-time>

The due date of the sales order. This indicates the expected date of completion.

paymentTermsId
string or null = 24 characters

Payment terms key identifier. Please reference /api/payment-terms endpoint.

salesPersonId
string or null = 24 characters

Sales Person identifier. Please reference /api/users endpoint. If not provided, the salesperson defined on the customer will be used.

publicNote
string or null [ 1 .. 2000 ] characters

Note to customer. This will appear on PDFs.

priority
string (SalesOrderPriority)
Enum: "low" "moderate" "high"

Priority of the sales order

companyId
string or null = 24 characters

Company identifier. Please reference /api/companies endpoint. If not provided, the primary company will be used (if available).

productionDueDate
string or null <date-time>

The date that the production of items on the sales order needs to be completed by.

shippingMethodId
string or null = 24 characters

Shipping method identifier. Please reference /api/shipping-methods endpoint.

Responses

Request samples

Content type
{
  • "customerId": "stringstringstringstring",
  • "orderedDate": "2019-08-24T14:15:22Z",
  • "customerPoNumber": "string",
  • "shippingAddress": {
    },
  • "billingAddress": {
    },
  • "contact": {
    },
  • "externalReferences": {
    },
  • "externalQuoteUrl": "string",
  • "dueDate": "2019-08-24T14:15:22Z",
  • "paymentTermsId": "stringstringstringstring",
  • "salesPersonId": "stringstringstringstring",
  • "publicNote": "string",
  • "priority": "low",
  • "companyId": "stringstringstringstring",
  • "productionDueDate": "2019-08-24T14:15:22Z",
  • "shippingMethodId": "stringstringstringstring"
}

Response samples

Content type
{
  • "id": "string"
}

Delete a specific sales order

path Parameters
salesOrderId
required
string = 24 characters

Responses

Get a specific sales order

path Parameters
salesOrderId
required
string = 24 characters

Responses

Response samples

Content type
{
  • "id": "stringstringstringstring",
  • "number": 0,
  • "orderedDate": "2019-08-24T14:15:22Z",
  • "status": "draft",
  • "customerPoNumber": "string",
  • "externalReferences": {
    },
  • "externalQuoteUrl": "string",
  • "customerId": "stringstringstringstring",
  • "deliveryDueDate": "2019-08-24T14:15:22Z",
  • "billingAddress": {
    },
  • "paymentTermsId": "stringstringstringstring",
  • "discount": 0,
  • "subtotal": 0,
  • "salesPersonId": "stringstringstringstring",
  • "publicNote": "string",
  • "customFields": {
    },
  • "deleted": true,
  • "priority": "low",
  • "companyId": "stringstringstringstring",
  • "createdUtc": "2019-08-24T14:15:22Z"
}

Partially update an SalesOrder

path Parameters
salesOrderId
required
string = 24 characters
Request Body schema: application/json-patch+json
Array
op
string
value
string
path
string

Responses

Request samples

Content type
application/json-patch+json
[
  • {
    }
]

Response samples

Content type
{
  • "id": "stringstringstringstring",
  • "number": 0,
  • "orderedDate": "2019-08-24T14:15:22Z",
  • "status": "draft",
  • "customerPoNumber": "string",
  • "externalReferences": {
    },
  • "externalQuoteUrl": "string",
  • "customerId": "stringstringstringstring",
  • "deliveryDueDate": "2019-08-24T14:15:22Z",
  • "billingAddress": {
    },
  • "paymentTermsId": "stringstringstringstring",
  • "discount": 0,
  • "subtotal": 0,
  • "salesPersonId": "stringstringstringstring",
  • "publicNote": "string",
  • "customFields": {
    },
  • "deleted": true,
  • "priority": "low",
  • "companyId": "stringstringstringstring",
  • "createdUtc": "2019-08-24T14:15:22Z"
}

Update an SalesOrder

path Parameters
salesOrderId
required
string = 24 characters
Request Body schema:
object or null

Arbitrary key-value-pair like data that can be used to later on search for this line item.

customerPoNumber
string or null [ 1 .. 200 ] characters

CustomerPoNumber

priority
string (SalesOrderPriority)
Enum: "low" "moderate" "high"

Priority of the sales order

deliveryDueDate
string or null <date-time>

The date the SO needs to be delivered to the customer. Note: this does not affect individual line update delivery dates.

Responses

Request samples

Content type
{
  • "externalReferences": {
    },
  • "customerPoNumber": "string",
  • "priority": "low",
  • "deliveryDueDate": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "id": "stringstringstringstring",
  • "number": 0,
  • "orderedDate": "2019-08-24T14:15:22Z",
  • "status": "draft",
  • "customerPoNumber": "string",
  • "externalReferences": {
    },
  • "externalQuoteUrl": "string",
  • "customerId": "stringstringstringstring",
  • "deliveryDueDate": "2019-08-24T14:15:22Z",
  • "billingAddress": {
    },
  • "paymentTermsId": "stringstringstringstring",
  • "discount": 0,
  • "subtotal": 0,
  • "salesPersonId": "stringstringstringstring",
  • "publicNote": "string",
  • "customFields": {
    },
  • "deleted": true,
  • "priority": "low",
  • "companyId": "stringstringstringstring",
  • "createdUtc": "2019-08-24T14:15:22Z"
}

Find sales orders based on search parameters.

query Parameters
Sort.Field
string non-empty

Sort field

Sort.Dir
string (CommonEnumSortDirectionEnum)
Enum: "ascending" "descending"

Sort direction

Skip
integer <int32> >= 0

Number of records to skip.

Take
integer <int32> [ 0 .. 1000 ]

Number of records to return (maximum)

Request Body schema:
numbers
Array of integers or null <int32> [ 1 .. 500 ] items

Filter sales orders to only given numbers

object (CommonExternalReferenceFindDto)

Search parameter for identifier record(s) via their external identifiers.

status
string (SalesOrderStatus)
Enum: "draft" "needsApproval" "approved" "inProgress" "complete"

Sales order status

externalQuoteUrls
Array of strings or null

Filter sales orders to those matching an external quote URL.

createdFromQuoteId
string or null

Filter sales orders created from the specific quote

Responses

Request samples

Content type
{
  • "numbers": [
    ],
  • "externalReference": {
    },
  • "status": "draft",
  • "externalQuoteUrls": [
    ],
  • "createdFromQuoteId": "string"
}

Response samples

Content type
[
  • {
    }
]

Update a sales order status

path Parameters
salesOrderId
required
string = 24 characters
Request Body schema:
status
required
string (SalesOrderStatus)
Enum: "draft" "needsApproval" "approved" "inProgress" "complete"

Sales order status

Responses

Request samples

Content type
{
  • "status": "draft"
}

Sales Order Blanket Line Item

Get a list of blanket lines items for a sales order

path Parameters
salesOrderId
required
string = 24 characters

Responses

Response samples

Content type
[
  • {
    }
]

Partially update a specific blanket line item for a purchase order

path Parameters
salesOrderId
required
string = 24 characters
lineItemId
required
string = 36 characters
Request Body schema: application/json-patch+json
Array
op
string
value
string
path
string

Responses

Request samples

Content type
application/json-patch+json
[
  • {
    }
]

Response samples

Content type
{
  • "id": "stringstringstringstringstringstring",
  • "name": "string",
  • "quantity": 0,
  • "price": 0,
  • "discountedPrice": 0,
  • "dueDate": "2019-08-24T14:15:22Z",
  • "isTaxable": true,
  • "overrideTaxRate": true,
  • "taxCodeId": "stringstringstringstring",
  • "taxRate": 0,
  • "itemId": "stringstringstringstring",
  • "description": "string",
  • "accountingCodeId": "stringstringstringstring",
  • "internalNotes": "string",
  • "externalReferences": {
    },
  • "isPercentageDiscount": true,
  • "discountAmount": 0,
  • "links": [],
  • "customFields": {
    },
  • "parentLineId": "stringstringstringstringstringstring",
  • "subTotal": 0,
  • "preDiscountSubTotal": 0,
  • "customerPartNumber": "string",
  • "customerPartDescription": "string",
  • "children": [
    ]
}

Update a specific blanket line item for a sales order

path Parameters
salesOrderId
required
string = 24 characters
lineItemId
required
string = 36 characters
Request Body schema:
object or null

Arbitrary key-value-pair like data that can be used to later on search for this line item.

additional property
object (CommonExternalReferenceDto)

The external reference for entities that implement FulcrumProduct.Domain.Common.IHasExternalReferences

type
string or null [ 0 .. 50 ] characters

Specifies the type of this identifier.

externalId
required
string [ 0 .. 500 ] characters

The external identifier

displayId
string or null [ 0 .. 500 ] characters

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
string or null

A status for the external reference

url
string or null

An external url for the reference

modifiedUtc
string or null <date-time>

Date the external reference was modified

Responses

Request samples

Content type
{
  • "externalReferences": {
    }
}

Response samples

Content type
{
  • "id": "stringstringstringstringstringstring",
  • "name": "string",
  • "quantity": 0,
  • "price": 0,
  • "discountedPrice": 0,
  • "dueDate": "2019-08-24T14:15:22Z",
  • "isTaxable": true,
  • "overrideTaxRate": true,
  • "taxCodeId": "stringstringstringstring",
  • "taxRate": 0,
  • "itemId": "stringstringstringstring",
  • "description": "string",
  • "accountingCodeId": "stringstringstringstring",
  • "internalNotes": "string",
  • "externalReferences": {
    },
  • "isPercentageDiscount": true,
  • "discountAmount": 0,
  • "links": [],
  • "customFields": {
    },
  • "parentLineId": "stringstringstringstringstringstring",
  • "subTotal": 0,
  • "preDiscountSubTotal": 0,
  • "customerPartNumber": "string",
  • "customerPartDescription": "string",
  • "children": [
    ]
}

Get a specific blanket line item for a sales order

path Parameters
salesOrderId
required
string = 24 characters
lineItemId
required
string = 36 characters

Responses

Response samples

Content type
{
  • "id": "stringstringstringstringstringstring",
  • "name": "string",
  • "quantity": 0,
  • "price": 0,
  • "discountedPrice": 0,
  • "dueDate": "2019-08-24T14:15:22Z",
  • "isTaxable": true,
  • "overrideTaxRate": true,
  • "taxCodeId": "stringstringstringstring",
  • "taxRate": 0,
  • "itemId": "stringstringstringstring",
  • "description": "string",
  • "accountingCodeId": "stringstringstringstring",
  • "internalNotes": "string",
  • "externalReferences": {
    },
  • "isPercentageDiscount": true,
  • "discountAmount": 0,
  • "links": [],
  • "customFields": {
    },
  • "parentLineId": "stringstringstringstringstringstring",
  • "subTotal": 0,
  • "preDiscountSubTotal": 0,
  • "customerPartNumber": "string",
  • "customerPartDescription": "string",
  • "children": [
    ]
}

Sales Order Custom Fields

Update (selectively) custom fields on a sales order

path Parameters
id
required
string = 24 characters

The sales order identifier

Request Body schema:

The custom fields to update

object

The custom fields

property name*
additional property
any

Responses

Request samples

Content type
{
  • "customFields": {
    }
}

Response samples

Content type
{
  • "customFields": {
    }
}

Update (selectively) custom fields on a sales order

path Parameters
id
required
string = 24 characters

The sales order identifier

Request Body schema:

The custom fields to update

object

The custom fields

property name*
additional property
any

Responses

Request samples

Content type
{
  • "customFields": {
    }
}

Response samples

Content type
{
  • "customFields": {
    }
}

Sales Order Discount Line Item

Get the discount line item for a sales order

path Parameters
salesOrderId
required
string = 24 characters

Responses

Response samples

Content type
{
  • "id": "stringstringstringstringstringstring",
  • "name": "string",
  • "description": "string",
  • "isPercentage": true,
  • "amount": 0,
  • "externalReferences": {
    },
  • "absoluteAmount": 0
}

Update the discount line item for a sales order

path Parameters
salesOrderId
required
string = 24 characters
Request Body schema:
name
required
string [ 1 .. 200 ] characters

The name of the discount line.

description
string or null [ 1 .. 200 ] characters

The description of the discount line.

isPercentage
required
boolean

Indicates whether "Amount" value is percentage based or an absolute amount.

amount
required
number <double> >= 0

The amount of the discount.

object or null

Arbitrary key-value-pair like data that can be used to later on search for this line item.

Responses

Request samples

Content type
{
  • "name": "string",
  • "description": "string",
  • "isPercentage": true,
  • "amount": 0,
  • "externalReferences": {
    }
}

Response samples

Content type
{
  • "id": "stringstringstringstringstringstring",
  • "name": "string",
  • "description": "string",
  • "isPercentage": true,
  • "amount": 0,
  • "externalReferences": {
    },
  • "absoluteAmount": 0
}

Delete the discount line item for a sales order

path Parameters
salesOrderId
required
string = 24 characters

Responses

Sales Order Fee Line Item

Delete a specific fee line item for a sales order

path Parameters
salesOrderId
required
string = 24 characters
lineItemId
required
string = 36 characters

Responses

Get a specific fee line item for a sales order

path Parameters
salesOrderId
required
string = 24 characters
lineItemId
required
string = 36 characters

Responses

Response samples

Content type
{
  • "id": "stringstringstringstringstringstring",
  • "name": "string",
  • "description": "string",
  • "quantity": 0,
  • "price": 0,
  • "unitOfMeasure": "notApplicable",
  • "accountingCodeId": "stringstringstringstring",
  • "isTaxable": true,
  • "overrideTaxRate": true,
  • "taxCodeId": "stringstringstringstring",
  • "taxRate": 0,
  • "externalReferences": {
    }
}

Partially update a specific fee line item for a purchase order

path Parameters
salesOrderId
required
string = 24 characters
lineItemId
required
string = 36 characters
Request Body schema: application/json-patch+json
Array
op
string
value
string
path
string

Responses

Request samples

Content type
application/json-patch+json
[
  • {
    }
]

Response samples

Content type
{
  • "id": "stringstringstringstringstringstring",
  • "name": "string",
  • "description": "string",
  • "quantity": 0,
  • "price": 0,
  • "unitOfMeasure": "notApplicable",
  • "accountingCodeId": "stringstringstringstring",
  • "isTaxable": true,
  • "overrideTaxRate": true,
  • "taxCodeId": "stringstringstringstring",
  • "taxRate": 0,
  • "externalReferences": {
    }
}

Update a specific fee line item for a sales order

path Parameters
salesOrderId
required
string = 24 characters
lineItemId
required
string = 36 characters
Request Body schema:
name
string or null [ 1 .. 200 ] characters

Verbose name for this entity.

description
string or null [ 1 .. 200 ] characters

Verbose description for this entity.

quantity
number or null <double> >= 0

The line item quantity

price
required
number <double> >= 0

The line item price.

accountingCodeId
string or null = 24 characters

Accounting code key identifier. Please reference /api/accounting-codes endpoint.

isTaxable
boolean or null

Dictate if this fee is taxable.

taxCodeId
string or null = 24 characters

Tax code key identifier.

taxRate
number or null <double> >= 0

Tax code to use for this entity. If a FulcrumProduct.PublicApi.Dto.SalesOrder.FeeLineItem.FeeLineItemUpdateDto.TaxCodeId is provided, the provided FulcrumProduct.PublicApi.Dto.SalesOrder.FeeLineItem.FeeLineItemUpdateDto.TaxRate will supercede the defined tax rate.

object or null

Arbitrary key-value-pair like data that can be used to later on search for this line item.

Responses

Request samples

Content type
{
  • "name": "string",
  • "description": "string",
  • "quantity": 0,
  • "price": 0,
  • "accountingCodeId": "stringstringstringstring",
  • "isTaxable": true,
  • "taxCodeId": "stringstringstringstring",
  • "taxRate": 0,
  • "externalReferences": {
    }
}

Response samples

Content type
{
  • "id": "stringstringstringstringstringstring",
  • "name": "string",
  • "description": "string",
  • "quantity": 0,
  • "price": 0,
  • "unitOfMeasure": "notApplicable",
  • "accountingCodeId": "stringstringstringstring",
  • "isTaxable": true,
  • "overrideTaxRate": true,
  • "taxCodeId": "stringstringstringstring",
  • "taxRate": 0,
  • "externalReferences": {
    }
}

Create a fee line item on a sales order

path Parameters
salesOrderId
required
string = 24 characters
Request Body schema:
name
string or null [ 1 .. 200 ] characters

Verbose name for this entity.

description
string or null [ 1 .. 200 ] characters

Verbose description for this entity. If this value is not provided and the name matches a defined "default fee", the description on the "default fee" will be used.

quantity
number or null <double> >= 0

The line item quantity

price
required
number <double> >= 0

The line item price.

accountingCodeId
string or null = 24 characters

Accounting code key identifier. Please reference /api/accounting-codes endpoint. If this value is not provided and the name matches a defined "default fee", the accounting code on the "default fee" will be used.

isTaxable
boolean or null

Dictate if this fee is taxable.

taxCodeId
string or null = 24 characters

Tax code key identifier.

taxRate
number or null <double> >= 0

Tax code to use for this entity. If a FulcrumProduct.PublicApi.Dto.SalesOrder.FeeLineItem.FeeLineItemCreateDto.TaxCodeId is provided, the provided FulcrumProduct.PublicApi.Dto.SalesOrder.FeeLineItem.FeeLineItemCreateDto.TaxRate will supercede the defined tax rate.

object or null

Arbitrary key-value-pair like data that can be used to later on search for this line item.

Responses

Request samples

Content type
{
  • "name": "string",
  • "description": "string",
  • "quantity": 0,
  • "price": 0,
  • "accountingCodeId": "stringstringstringstring",
  • "isTaxable": true,
  • "taxCodeId": "stringstringstringstring",
  • "taxRate": 0,
  • "externalReferences": {
    }
}

Response samples

Content type
{
  • "id": "string"
}

Get a list of fee lines items for a sales order

path Parameters
salesOrderId
required
string = 24 characters

Responses

Response samples

Content type
[
  • {
    }
]

Sales Order Line Item

Get a specific line item for a sales order of generic type

path Parameters
salesOrderId
required
string = 24 characters
lineItemId
required
string = 36 characters

Responses

Response samples

Content type
{
  • "id": "stringstringstringstringstringstring",
  • "lineItemId": "string",
  • "type": "part",
  • "price": 0,
  • "discountedPrice": 0,
  • "name": "string",
  • "description": "string",
  • "quantity": 0,
  • "externalReferences": {
    },
  • "accountingCodeId": "stringstringstringstring",
  • "isTaxable": true,
  • "subTotal": 0,
  • "preDiscountSubTotal": 0,
  • "isPercentageDiscount": true,
  • "discountAmount": 0,
  • "customFields": {
    }
}

Get a list of lines items for a sales order, regardless of type

path Parameters
salesOrderId
required
string = 24 characters

Responses

Response samples

Content type
[
  • {
    }
]

Sales Order Part Line Item

Create a part line item on a sales order

path Parameters
salesOrderId
required
string = 24 characters
Request Body schema:
itemId
required
string = 24 characters

Item id associated with this line item.

quantity
number <double> >= 0

The line item quantity

price
number or null <double> >= 0

The line item price. Note, if a price break exists for the item being added (vendor price breaks, item price breaks, etc), this value will be ignored as it is quantity-driven based on the price breaks that do/will exist. If this value is not provided and no price breaks exist, the default will be 0.

isTaxable
boolean or null

Dictate if this line item is taxable.

taxCodeId
string or null = 24 characters

Tax code key identifier. Please reference /api/tax-rates endpoint.

taxRate
number or null <double> >= 0

Tax rate to use for this entity. If a FulcrumProduct.PublicApi.Dto.SalesOrder.PartLineItem.PartLineItemCreateDto.TaxCodeId is provided, the provided FulcrumProduct.PublicApi.Dto.SalesOrder.PartLineItem.PartLineItemCreateDto.TaxRate will supercede the defined tax rate.

description
string or null [ 1 .. 2000 ] characters

The part line item description. Defaults to the item's description if none specified.

internalNotes
string or null [ 1 .. 2000 ] characters

The line item internal notes

itemNotes
string or null [ 1 .. 2000 ] characters

The line item notes (visible in job tracking).

object or null

Arbitrary key-value-pair like data that can be used to later on search for this line item.

isPercentageDiscount
boolean or null

Indicates whether FulcrumProduct.PublicApi.Dto.SalesOrder.PartLineItem.PartLineItemCreateDto.DiscountAmount discount is percentage based (else, it's an absolute amount).

discountAmount
number or null <double>

The amount of the discount.

Array of objects or null (CommonUrlDto)

A list of links/urls to associated with the line item.

deliveryDate
string or null <date-time>

The delivery date for the line item

unitOfMeasureName
string or null

The unit of measure to apply. If left blank, the default unit of measure for the item will be applied.

accountingCodeId
string or null = 24 characters

Accounting code key identifier. Please reference /api/accounting-codes endpoint. If this value is not provided and the name matches a defined "default fee", the accounting code on the "default fee" will be used.

Responses

Request samples

Content type
{
  • "itemId": "stringstringstringstring",
  • "quantity": 0,
  • "price": 0,
  • "isTaxable": true,
  • "taxCodeId": "stringstringstringstring",
  • "taxRate": 0,
  • "description": "string",
  • "internalNotes": "string",
  • "itemNotes": "string",
  • "externalReferences": {
    },
  • "isPercentageDiscount": true,
  • "discountAmount": 0,
  • "links": [],
  • "deliveryDate": "2019-08-24T14:15:22Z",
  • "unitOfMeasureName": "string",
  • "accountingCodeId": "stringstringstringstring"
}

Response samples

Content type
{
  • "id": "string"
}

Create one or more part line items on a sales order

path Parameters
salesOrderId
required
string = 24 characters
Request Body schema:
required
Array of objects (SalesOrderPartLineItemCreateDto)

The line items to add to a sales order.

Array
itemId
required
string = 24 characters

Item id associated with this line item.

quantity
number <double> >= 0

The line item quantity

price
number or null <double> >= 0

The line item price. Note, if a price break exists for the item being added (vendor price breaks, item price breaks, etc), this value will be ignored as it is quantity-driven based on the price breaks that do/will exist. If this value is not provided and no price breaks exist, the default will be 0.

isTaxable
boolean or null

Dictate if this line item is taxable.

taxCodeId
string or null = 24 characters

Tax code key identifier. Please reference /api/tax-rates endpoint.

taxRate
number or null <double> >= 0

Tax rate to use for this entity. If a FulcrumProduct.PublicApi.Dto.SalesOrder.PartLineItem.PartLineItemCreateDto.TaxCodeId is provided, the provided FulcrumProduct.PublicApi.Dto.SalesOrder.PartLineItem.PartLineItemCreateDto.TaxRate will supercede the defined tax rate.

description
string or null [ 1 .. 2000 ] characters

The part line item description. Defaults to the item's description if none specified.

internalNotes
string or null [ 1 .. 2000 ] characters

The line item internal notes

itemNotes
string or null [ 1 .. 2000 ] characters

The line item notes (visible in job tracking).

object or null

Arbitrary key-value-pair like data that can be used to later on search for this line item.

isPercentageDiscount
boolean or null

Indicates whether FulcrumProduct.PublicApi.Dto.SalesOrder.PartLineItem.PartLineItemCreateDto.DiscountAmount discount is percentage based (else, it's an absolute amount).

discountAmount
number or null <double>

The amount of the discount.

Array of objects or null (CommonUrlDto)

A list of links/urls to associated with the line item.

deliveryDate
string or null <date-time>

The delivery date for the line item

unitOfMeasureName
string or null

The unit of measure to apply. If left blank, the default unit of measure for the item will be applied.

accountingCodeId
string or null = 24 characters

Accounting code key identifier. Please reference /api/accounting-codes endpoint. If this value is not provided and the name matches a defined "default fee", the accounting code on the "default fee" will be used.

Responses

Request samples

Content type
{
  • "lineItems": [
    ]
}

Response samples

Content type
{
  • "ids": [
    ]
}

Get a specific part line item for a sales order

path Parameters
salesOrderId
required
string = 24 characters
lineItemId
required
string = 36 characters

Responses

Response samples

Content type
{
  • "id": "stringstringstringstringstringstring",
  • "name": "string",
  • "quantity": 0,
  • "price": 0,
  • "discountedPrice": 0,
  • "dueDate": "2019-08-24T14:15:22Z",
  • "isTaxable": true,
  • "overrideTaxRate": true,
  • "taxCodeId": "stringstringstringstring",
  • "taxRate": 0,
  • "itemId": "stringstringstringstring",
  • "description": "string",
  • "accountingCodeId": "stringstringstringstring",
  • "internalNotes": "string",
  • "externalReferences": {
    },
  • "isPercentageDiscount": true,
  • "discountAmount": 0,
  • "links": [],
  • "customFields": {
    },
  • "parentLineId": "stringstringstringstringstringstring",
  • "subTotal": 0,
  • "preDiscountSubTotal": 0,
  • "customerPartNumber": "string",
  • "customerPartDescription": "string"
}

Partially update a specific part line item for an salesOrder

path Parameters
salesOrderId
required
string = 24 characters
lineItemId
required
string = 36 characters
Request Body schema: application/json-patch+json
Array
op
string
value
string
path
string

Responses

Request samples

Content type
application/json-patch+json
[
  • {
    }
]

Response samples

Content type
{
  • "id": "stringstringstringstringstringstring",
  • "name": "string",
  • "quantity": 0,
  • "price": 0,
  • "discountedPrice": 0,
  • "dueDate": "2019-08-24T14:15:22Z",
  • "isTaxable": true,
  • "overrideTaxRate": true,
  • "taxCodeId": "stringstringstringstring",
  • "taxRate": 0,
  • "itemId": "stringstringstringstring",
  • "description": "string",
  • "accountingCodeId": "stringstringstringstring",
  • "internalNotes": "string",
  • "externalReferences": {
    },
  • "isPercentageDiscount": true,
  • "discountAmount": 0,
  • "links": [],
  • "customFields": {
    },
  • "parentLineId": "stringstringstringstringstringstring",
  • "subTotal": 0,
  • "preDiscountSubTotal": 0,
  • "customerPartNumber": "string",
  • "customerPartDescription": "string"
}

Update a specific part line item for a sales order

path Parameters
salesOrderId
required
string = 24 characters
lineItemId
required
string = 36 characters
Request Body schema:
quantity
number <double> >= 0

The line item quantity

price
number or null <double> >= 0

The line item price. Note, if a price break exists for the item being added (vendor price breaks, item price breaks, etc), this value will be ignored as it is quantity-driven based on the price breaks that do/will exist. If this value is not provided and no price breaks exist, the default will be 0.

isTaxable
boolean or null

Dictate if this line item is taxable.

taxCodeId
string or null = 24 characters

Tax code key identifier. Please reference /api/tax-rates endpoint.

taxRate
number or null <double> >= 0

Tax rate to use for this entity. If a FulcrumProduct.PublicApi.Dto.SalesOrder.PartLineItem.PartLineItemUpdateDto.TaxCodeId is provided, the provided FulcrumProduct.PublicApi.Dto.SalesOrder.PartLineItem.PartLineItemUpdateDto.TaxRate will supercede the defined tax rate.

description
string or null [ 1 .. 2000 ] characters

The part line item description. Defaults to the item's description if none specified.

internalNotes
string or null [ 1 .. 2000 ] characters

The line item internal notes. Aka production notes.

itemNotes
string or null [ 1 .. 2000 ] characters

The line item notes (visible in job tracking).

object or null

Arbitrary key-value-pair like data that can be used to later on search for this line item.

isPercentageDiscount
boolean or null

Indicates whether FulcrumProduct.PublicApi.Dto.SalesOrder.PartLineItem.PartLineItemUpdateDto.DiscountAmount discount is percentage based (else, it's an absolute amount).

discountAmount
number or null <double>

The amount of the discount.

Array of objects or null (CommonUrlDto)

List of links associated with the line item.

deliveryDate
string or null <date-time>

The Delivery Date for the line item.

unitOfMeasureName
string or null

The unit of measure to apply. If left blank, the existing unit of measure on the line item will be retained.

accountingCodeId
string or null = 24 characters

Accounting code key identifier. Please reference /api/accounting-codes endpoint. If this value is not provided and the name matches a defined "default fee", the accounting code on the "default fee" will be used.

Responses

Request samples

Content type
{
  • "quantity": 0,
  • "price": 0,
  • "isTaxable": true,
  • "taxCodeId": "stringstringstringstring",
  • "taxRate": 0,
  • "description": "string",
  • "internalNotes": "string",
  • "itemNotes": "string",
  • "externalReferences": {
    },
  • "isPercentageDiscount": true,
  • "discountAmount": 0,
  • "links": [],
  • "deliveryDate": "2019-08-24T14:15:22Z",
  • "unitOfMeasureName": "string",
  • "accountingCodeId": "stringstringstringstring"
}

Response samples

Content type
{
  • "id": "stringstringstringstringstringstring",
  • "name": "string",
  • "quantity": 0,
  • "price": 0,
  • "discountedPrice": 0,
  • "dueDate": "2019-08-24T14:15:22Z",
  • "isTaxable": true,
  • "overrideTaxRate": true,
  • "taxCodeId": "stringstringstringstring",
  • "taxRate": 0,
  • "itemId": "stringstringstringstring",
  • "description": "string",
  • "accountingCodeId": "stringstringstringstring",
  • "internalNotes": "string",
  • "externalReferences": {
    },
  • "isPercentageDiscount": true,
  • "discountAmount": 0,
  • "links": [],
  • "customFields": {
    },
  • "parentLineId": "stringstringstringstringstringstring",
  • "subTotal": 0,
  • "preDiscountSubTotal": 0,
  • "customerPartNumber": "string",
  • "customerPartDescription": "string"
}

Delete a specific part line item for a sales order

path Parameters
salesOrderId
required
string = 24 characters
lineItemId
required
string = 36 characters

Responses

Get a list of part lines items for a sales order

path Parameters
salesOrderId
required
string = 24 characters

Responses

Response samples

Content type
[
  • {
    }
]

Sales Order Part Line Item Custom Fields

Update (selectively) custom fields on a line item

path Parameters
salesOrderId
required
string = 24 characters

The sales order identifier that contains the line item

lineItemId
required
string = 36 characters

The line item identifier that contains the custom fields you want to update.

Request Body schema:

The custom fields to update

object

The custom fields

property name*
additional property
any

Responses

Request samples

Content type
{
  • "customFields": {
    }
}

Response samples

Content type
{
  • "customFields": {
    }
}

Update (selectively) custom fields on a line item

path Parameters
salesOrderId
required
string = 24 characters

The sales order identifier that contains the line item

lineItemId
required
string = 36 characters

The line item identifier that contains the custom fields you want to update.

Request Body schema:

The custom fields to update

object

The custom fields

property name*
additional property
any

Responses

Request samples

Content type
{
  • "customFields": {
    }
}

Response samples

Content type
{
  • "customFields": {
    }
}

Sales Order Refund Line Item

Create a refund line item on a sales order

path Parameters
salesOrderId
required
string = 24 characters
Request Body schema:
description
string or null [ 1 .. 2000 ] characters

The refund line item description. Defaults to the item's description if none specified.

refundedLineId
required
string = 36 characters

The related, original line id that was refunded.

refundQuantity
required
number <double> >= 0

The quantity to be refunded.

refundAmount
required
number <double> >= 0

The refund amount.

accountingCodeId
string or null = 24 characters

Accounting code key identifier. Please reference /api/accounting-codes endpoint.

refundReasonCodeId
string or null = 24 characters

Refund reason code key identifier. Please reference /api/refund-reason-codes endpoint.

isReturn
boolean or null

Indicate if a return is expected.

returnQuantity
number or null <double>

The quantity to be returned.

object or null

Arbitrary key-value-pair like data that can be used to later on search for this line item.

Responses

Request samples

Content type
{
  • "description": "string",
  • "refundedLineId": "stringstringstringstringstringstring",
  • "refundQuantity": 0,
  • "refundAmount": 0,
  • "accountingCodeId": "stringstringstringstring",
  • "refundReasonCodeId": "stringstringstringstring",
  • "isReturn": true,
  • "returnQuantity": 0,
  • "externalReferences": {
    }
}

Response samples

Content type
{
  • "id": "string"
}

Delete a specific refund line item for a sales order

path Parameters
salesOrderId
required
string = 24 characters
lineId
required
string = 36 characters

Responses

Get a list of refund lines items for a sales order

path Parameters
salesOrderId
required
string = 24 characters

Responses

Response samples

Content type
[
  • {
    }
]

Update a specific refund line item for a sales order

path Parameters
salesOrderId
required
string = 24 characters
lineItemId
required
string
query Parameters
lineId
required
string = 36 characters
Request Body schema:
description
string or null [ 1 .. 2000 ] characters

The refund line item description.

refundQuantity
required
number <double> >= 0

The quantity to be refunded.

refundAmount
required
number <double> >= 0

The refund amount.

accountingCodeId
string or null = 24 characters

Accounting code key identifier. Please reference /api/accounting-codes endpoint.

refundReasonCodeId
string or null = 24 characters

Refund reason code key identifier. Please reference /api/refund-reason-codes endpoint.

isReturn
boolean or null

Indicate if a return is expected.

returnQuantity
number or null <double> >= 0

The quantity to be returned.

object or null

Arbitrary key-value-pair like data that can be used to later on search for this line item.

Responses

Request samples

Content type
{
  • "description": "string",
  • "refundQuantity": 0,
  • "refundAmount": 0,
  • "accountingCodeId": "stringstringstringstring",
  • "refundReasonCodeId": "stringstringstringstring",
  • "isReturn": true,
  • "returnQuantity": 0,
  • "externalReferences": {
    }
}

Response samples

Content type
{
  • "id": "stringstringstringstringstringstring",
  • "refundedLineId": "stringstringstringstringstringstring",
  • "name": "string",
  • "description": "string",
  • "refundQuantity": 0,
  • "refundAmount": 0,
  • "accountingCodeId": "stringstringstringstring",
  • "refundReasonCodeId": "stringstringstringstring",
  • "isReturn": true,
  • "returnQuantity": 0,
  • "externalReferences": {
    }
}

Sales Order Shipping Charge Line Item

Get a specific line item for a sales order of generic type

path Parameters
salesOrderId
required
string = 24 characters

Responses

Response samples

Content type
{
  • "id": "stringstringstringstringstringstring",
  • "name": "string",
  • "description": "string",
  • "amount": 0,
  • "overrideTaxRate": true,
  • "isTaxable": true,
  • "taxCodeId": "stringstringstringstring",
  • "taxRate": 0,
  • "externalReferences": {
    },
  • "salesOrderLineItemId": "stringstringstringstringstringstring"
}

Sales Order Tax Line Item

Create a tax line item on a sales order

path Parameters
salesOrderId
required
string = 24 characters
Request Body schema:
description
string or null [ 1 .. 200 ] characters

Verbose description for this entity.

taxCodeId
string or null = 24 characters

Tax code key identifier. Please reference /api/tax-rates endpoint. If FulcrumProduct.PublicApi.Dto.SalesOrder.TaxLineItem.TaxLineItemCreateDto.AvalaraOptions is provided, FulcrumProduct.PublicApi.Dto.SalesOrder.TaxLineItem.TaxLineItemCreateDto.TaxCodeId will be ignored.

taxRate
number or null <double> >= 0

Tax rate to use for this entity. If a FulcrumProduct.PublicApi.Dto.SalesOrder.TaxLineItem.TaxLineItemCreateDto.TaxCodeId is provided, the provided FulcrumProduct.PublicApi.Dto.SalesOrder.TaxLineItem.TaxLineItemCreateDto.TaxRate will supercede the defined tax rate.

object (SalesOrderTaxLineItemAvalaraOptions)

Options for use with Avalara (if enabled).

object or null

Arbitrary key-value-pair like data that can be used to later on search for this line item.

Responses

Request samples

Content type
{
  • "description": "string",
  • "taxCodeId": "stringstringstringstring",
  • "taxRate": 0,
  • "avalaraOptions": {
    },
  • "externalReferences": {
    }
}

Response samples

Content type
{
  • "id": "string"
}

Delete a specific tax line item for a sales order

path Parameters
salesOrderId
required
string = 24 characters
lineItemId
required
string = 36 characters

Responses

Get a specific tax line item for a sales order

path Parameters
salesOrderId
required
string = 24 characters
lineItemId
required
string = 36 characters

Responses

Response samples

Content type
{
  • "id": "stringstringstringstringstringstring",
  • "description": "string",
  • "taxCodeId": "stringstringstringstring",
  • "taxRate": 0,
  • "avalaraOptions": {
    },
  • "externalReferences": {
    },
  • "price": 0
}

Update a specific tax line item for a sales order

path Parameters
salesOrderId
required
string = 24 characters
lineItemId
required
string = 36 characters
Request Body schema:
description
string or null [ 1 .. 200 ] characters

Verbose description for this entity.

taxCodeId
string or null = 24 characters

Tax code key identifier. Please reference /api/tax-rates endpoint. If FulcrumProduct.PublicApi.Dto.SalesOrder.TaxLineItem.TaxLineItemUpdateDto.AvalaraOptions is provided, FulcrumProduct.PublicApi.Dto.SalesOrder.TaxLineItem.TaxLineItemUpdateDto.TaxCodeId will be ignored.

taxRate
number or null <double> >= 0

Tax rate to use for this entity. If a FulcrumProduct.PublicApi.Dto.SalesOrder.TaxLineItem.TaxLineItemUpdateDto.TaxCodeId is provided, the provided FulcrumProduct.PublicApi.Dto.SalesOrder.TaxLineItem.TaxLineItemUpdateDto.TaxRate will supercede the defined tax rate.

object (SalesOrderTaxLineItemAvalaraOptions)

Options for use with Avalara (if enabled).

object or null

Arbitrary key-value-pair like data that can be used to later on search for this line item.

Responses

Request samples

Content type
{
  • "description": "string",
  • "taxCodeId": "stringstringstringstring",
  • "taxRate": 0,
  • "avalaraOptions": {
    },
  • "externalReferences": {
    }
}

Response samples

Content type
{
  • "id": "stringstringstringstringstringstring",
  • "description": "string",
  • "taxCodeId": "stringstringstringstring",
  • "taxRate": 0,
  • "avalaraOptions": {
    },
  • "externalReferences": {
    },
  • "price": 0
}

Get a list of tax lines items for a sales order

path Parameters
salesOrderId
required
string = 24 characters

Responses

Response samples

Content type
[
  • {
    }
]

Shape Code

Get a shape code.

path Parameters
id
required
string = 24 characters

Responses

Response samples

Content type
{
  • "id": "stringstringstringstring",
  • "name": "string"
}

Find shape codes based on search parameters.

query Parameters
Sort.Field
string non-empty

Sort field

Sort.Dir
string (CommonEnumSortDirectionEnum)
Enum: "ascending" "descending"

Sort direction

Skip
integer <int32> >= 0

Number of records to skip.

Take
integer <int32> [ 0 .. 1000 ]

Number of records to return (maximum)

Request Body schema:
name
string or null [ 1 .. 200 ] characters

Filter shape codes based on their name.

ids
Array of strings or null

Filter shape codes based on matching ids.

Responses

Request samples

Content type
{
  • "name": "string",
  • "ids": [
    ]
}

Response samples

Content type
[
  • {
    }
]

Shipment Line Items (V3)

Search for shipment line items based on parameters.

query Parameters
Sort.Field
string non-empty

Sort field

Sort.Dir
string (CommonEnumSortDirectionEnum)
Enum: "ascending" "descending"

Sort direction

Skip
integer <int32> >= 0

Number of records to skip.

Take
integer <int32> [ 0 .. 1000 ]

Number of records to return (maximum)

Request Body schema:

The search parameters

packingStatus
string (ShippingDataPackingStatus)
Enum: "notPacked" "partiallyPacked" "fullyPacked" "overPacked"
itemId
string or null

Filter shipment line items based on item identifier.

shipmentId
string or null

Filter shipment line items based on shipment identifier.

salesOrderLineItemIds
Array of strings or null

Filter shipment line items based on sales order line item(s) identifier.

purchaseOrderLineItemIds
Array of strings or null

Filter shipment line items based on purchase order line item identifier.

shipmentType
string (ShippingDataShipmentType)
Enum: "unknown" "standard" "outsideProcessing"

Responses

Request samples

Content type
{
  • "packingStatus": "notPacked",
  • "itemId": "string",
  • "shipmentId": "string",
  • "salesOrderLineItemIds": [
    ],
  • "purchaseOrderLineItemIds": [
    ],
  • "shipmentType": "unknown"
}

Response samples

Content type
{
  • "data": [
    ],
  • "page": 0,
  • "pageSize": 0,
  • "totalCount": 0,
  • "totalPages": 0,
  • "hasPreviousPage": true,
  • "hasNextPage": true
}

Shipments

Finds shipments based on search parameters

query Parameters
Sort.Field
string non-empty

Sort field

Sort.Dir
string (CommonEnumSortDirectionEnum)
Enum: "ascending" "descending"

Sort direction

Skip
integer <int32> >= 0

Number of records to skip.

Take
integer <int32> [ 0 .. 1000 ]

Number of records to return (maximum)

Request Body schema:
shipmentStatus
string (ShippingDataShipmentStatus)
Enum: "pending" "open" "shipped" "cancelled"
packingStatus
string (ShippingDataPackingStatus)
Enum: "notPacked" "partiallyPacked" "fullyPacked" "overPacked"
salesOrderId
string or null

Filter shipments by sales order identifier

purchaseOrderId
string or null

Filter shipments by purchase order identifier

shipmentType
string (ShippingDataShipmentType)
Enum: "unknown" "standard" "outsideProcessing"

Responses

Request samples

Content type
{
  • "shipmentStatus": "pending",
  • "packingStatus": "notPacked",
  • "salesOrderId": "string",
  • "purchaseOrderId": "string",
  • "shipmentType": "unknown"
}

Response samples

Content type
{
  • "data": [
    ],
  • "page": 0,
  • "pageSize": 0,
  • "totalCount": 0,
  • "totalPages": 0,
  • "hasPreviousPage": true,
  • "hasNextPage": true
}

Partially update a Shipment

path Parameters
shipmentId
required
string = 24 characters
Request Body schema: application/json-patch+json
Array
op
string
value
string
path
string

Responses

Request samples

Content type
application/json-patch+json
[
  • {
    }
]

Response samples

Content type
{
  • "id": "stringstringstringstring",
  • "number": 0,
  • "name": "string",
  • "status": "pending",
  • "packingStatus": "notPacked",
  • "trackingNumber": "string",
  • "shipByDate": "2019-08-24T14:15:22Z",
  • "shippedDate": "2019-08-24T14:15:22Z",
  • "shippedDateOverride": "2019-08-24T14:15:22Z",
  • "notes": "string",
  • "displayNotesToCustomer": true,
  • "shippingMethod": {
    },
  • "shippingAccount": {
    },
  • "shippingCost": 0,
  • "shippingCharge": 0,
  • "externalReferences": {
    },
  • "address": {
    }
}

Update a specific shipment

path Parameters
shipmentId
required
string = 24 characters
Request Body schema:
shipByDate
string or null <date-time>

Ship by date.

notes
string or null [ 1 .. 2000 ] characters

Shipment notes.

displayNotesToCustomer
boolean

Whether or not to display the shipment notes on the pack list.

trackingNumber
string or null

The tracking number for the shipment.

shippingMethodId
string or null

The shipping method identifier

shippedDate
string or null <date-time>

The shipped date

shippedDateOverride
string or null <date-time>

The override of the shipped date (used for changing the date of a shipment after it's been created)

shippingCost
number or null <double>

The shipment's cost

Responses

Request samples

Content type
{
  • "shipByDate": "2019-08-24T14:15:22Z",
  • "notes": "string",
  • "displayNotesToCustomer": true,
  • "trackingNumber": "string",
  • "shippingMethodId": "string",
  • "shippedDate": "2019-08-24T14:15:22Z",
  • "shippedDateOverride": "2019-08-24T14:15:22Z",
  • "shippingCost": 0
}

Response samples

Content type
{
  • "id": "stringstringstringstring",
  • "number": 0,
  • "name": "string",
  • "status": "pending",
  • "packingStatus": "notPacked",
  • "trackingNumber": "string",
  • "shipByDate": "2019-08-24T14:15:22Z",
  • "shippedDate": "2019-08-24T14:15:22Z",
  • "shippedDateOverride": "2019-08-24T14:15:22Z",
  • "notes": "string",
  • "displayNotesToCustomer": true,
  • "shippingMethod": {
    },
  • "shippingAccount": {
    },
  • "shippingCost": 0,
  • "shippingCharge": 0,
  • "externalReferences": {
    },
  • "address": {
    }
}

Shipping

Find shipping batches based on search parameters

query Parameters
Sort.Field
string non-empty

Sort field

Sort.Dir
string (CommonEnumSortDirectionEnum)
Enum: "ascending" "descending"

Sort direction

Skip
integer <int32> >= 0

Number of records to skip.

Take
integer <int32> [ 0 .. 1000 ]

Number of records to return (maximum)

Request Body schema:
orderType
string (CommonEnumOrderType)
Enum: "purchaseOrder" "salesOrder"

Order type enum

orderIds
Array of strings or null

Include shipments for specific sales/purchase order ids

statuses
Array of strings or null (DtoShippingShipmentBatchStatus)
Enum: "open" "ready" "partiallyReady" "partiallyShipped" "shipped"

Include shipments that are in a given status(s)

object (DtoCommonDateRangeFilter)

Date range used for filters

Responses

Request samples

Content type
{
  • "orderType": "purchaseOrder",
  • "orderIds": [
    ],
  • "statuses": [
    ],
  • "shipByDate": {
    }
}

Response samples

Content type
[
  • {
    }
]

Shipping Shipment

Create a shipment

path Parameters
batchId
required
string = 36 characters
Request Body schema:
orderType
string (CommonEnumOrderType)
Enum: "purchaseOrder" "salesOrder"

Order type enum

orderId
required
string = 24 characters

Order id. Please reference /api/sales-orders endpoint.

required
Array of objects (ShippingShipmentLineItemCreateDto)

Line items affected.

object or null

Arbitrary key-value-pair like data that can be used to later on search for the Shipment

trackingNumber
string or null

Tracking number associated to the shipment.

account
string or null = 24 characters

The customer shipping account

Responses

Request samples

Content type
{
  • "orderType": "purchaseOrder",
  • "orderId": "stringstringstringstring",
  • "lineItems": [
    ],
  • "externalReferences": {
    },
  • "trackingNumber": "string",
  • "account": "stringstringstringstring"
}

Response samples

Content type
{
  • "id": "string"
}

Rollback an entire shipment.

path Parameters
batchId
required
string = 36 characters
shipmentId
required
string = 36 characters

Responses

Shipping Method

Get a shipping method.

path Parameters
id
required
string = 24 characters

Responses

Response samples

Content type
{
  • "id": "stringstringstringstring",
  • "name": "string"
}

Find shipping methods based on search parameters.

query Parameters
Sort.Field
string non-empty

Sort field

Sort.Dir
string (CommonEnumSortDirectionEnum)
Enum: "ascending" "descending"

Sort direction

Skip
integer <int32> >= 0

Number of records to skip.

Take
integer <int32> [ 0 .. 1000 ]

Number of records to return (maximum)

Request Body schema:
name
string or null [ 1 .. 200 ] characters

Filter shipping methods based on their name.

ids
Array of strings or null

Filter shipping methods based on matching ids.

Responses

Request samples

Content type
{
  • "name": "string",
  • "ids": [
    ]
}

Response samples

Content type
[
  • {
    }
]

Tax Rate

Get a tax rate.

path Parameters
id
required
string = 24 characters

Responses

Response samples

Content type
{
  • "id": "stringstringstringstring",
  • "code": "string",
  • "provider": "avalaraOrder",
  • "rate": 0
}

Find tax rates based on search parameters.

query Parameters
Sort.Field
string non-empty

Sort field

Sort.Dir
string (CommonEnumSortDirectionEnum)
Enum: "ascending" "descending"

Sort direction

Skip
integer <int32> >= 0

Number of records to skip.

Take
integer <int32> [ 0 .. 1000 ]

Number of records to return (maximum)

Request Body schema:
code
string or null [ 1 .. 200 ] characters

Filter tax rates based on their code.

ids
Array of strings or null

Filter tax rates based on matching ids.

Responses

Request samples

Content type
{
  • "code": "string",
  • "ids": [
    ]
}

Response samples

Content type
[
  • {
    }
]

User

Get a specific user

path Parameters
userId
required
string = 24 characters

Responses

Response samples

Content type
{
  • "id": "stringstringstringstring",
  • "employeeId": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "emailAddress": "[email protected]",
  • "phoneNumber": "string",
  • "roles": [
    ]
}

Find users based on search parameters.

query Parameters
Sort.Field
string non-empty

Sort field

Sort.Dir
string (CommonEnumSortDirectionEnum)
Enum: "ascending" "descending"

Sort direction

Skip
integer <int32> >= 0

Number of records to skip.

Take
integer <int32> [ 0 .. 1000 ]

Number of records to return (maximum)

Request Body schema:
firstName
string or null [ 1 .. 200 ] characters

Filter users based on their first name.

lastName
string or null [ 1 .. 200 ] characters

Filter users based on their last name.

emailAddress
string or null

Email address

phoneNumber
string or null

Phone number

roles
Array of strings or null

Filter users to those with any of the provided roles.

omniSearch
string or null

Search for users based on a string that should match any of the user's first name, last name, email address, phone number or roles.

Responses

Request samples

Content type
{
  • "firstName": "string",
  • "lastName": "string",
  • "emailAddress": "string",
  • "phoneNumber": "string",
  • "roles": [
    ],
  • "omniSearch": "string"
}

Response samples

Content type
[
  • {
    }
]

User Status

Gets a status object for a user that displays various timer metrics (jobs/ops clocked into, whether on break, etc)

path Parameters
userId
required
string = 24 characters

The user identifier

Responses

Response samples

Content type
{
  • "firstName": "string",
  • "lastName": "string",
  • "isOnBreak": true,
  • "breakStartAtUtc": "2019-08-24T14:15:22Z",
  • "elapsedBreakTimeInSeconds": 0,
  • "isClockedIn": true,
  • "clockedInAtUtc": "2019-08-24T14:15:22Z",
  • "elapsedClockedInTimeInSeconds": 0,
  • "jobs": [
    ]
}

Gets a list of user status objects based on parameters

Request Body schema:

The filter parameters

userIds
Array of strings

The user identifiers

Responses

Request samples

Content type
{
  • "userIds": [
    ]
}

Response samples

Content type
[
  • {
    }
]

Vendor

Create a new vendor

Request Body schema:
name
required
string [ 1 .. 200 ] characters

The name to give the entity. Must be unique to all active vendors.

paymentTermsId
string or null = 24 characters

Payment terms key identifier. Please reference /api/payment-terms endpoint.

vendorCode
string or null non-empty

Unique identifier for this vendor.

notes
string or null [ 1 .. 2000 ] characters

General notes associated to this vendor

object or null

Arbitrary key-value-pair like data that can be used to later on search for the vendor

Responses

Request samples

Content type
{
  • "name": "string",
  • "paymentTermsId": "stringstringstringstring",
  • "vendorCode": "string",
  • "notes": "string",
  • "externalReferences": {
    }
}

Response samples

Content type
{
  • "id": "string"
}

Partially update a vendor

path Parameters
vendorId
required
string = 24 characters
Request Body schema: application/json-patch+json
Array
op
string
value
string
path
string

Responses

Request samples

Content type
application/json-patch+json
[
  • {
    }
]

Response samples

Content type
{
  • "id": "stringstringstringstring",
  • "name": "string",
  • "vendorCode": "string",
  • "paymentTermsId": "stringstringstringstring",
  • "notes": "string",
  • "externalReferences": {
    },
  • "customFields": {
    }
}

Update a specific vendor

path Parameters
vendorId
required
string = 24 characters
Request Body schema:
name
required
string [ 1 .. 200 ] characters

The name to give the entity. Must be unique to all active vendors.

paymentTermsId
string or null = 24 characters

Payment terms key identifier. Please reference /api/payment-terms endpoint.

vendorCode
string or null non-empty

Unique identifier for this vendor.

object or null

Arbitrary key-value-pair like data that can be used to later on search for this line item.

Responses

Request samples

Content type
{
  • "name": "string",
  • "paymentTermsId": "stringstringstringstring",
  • "vendorCode": "string",
  • "externalReferences": {
    }
}

Response samples

Content type
{
  • "id": "stringstringstringstring",
  • "name": "string",
  • "vendorCode": "string",
  • "paymentTermsId": "stringstringstringstring",
  • "notes": "string",
  • "externalReferences": {
    },
  • "customFields": {
    }
}

Get a vendor.

path Parameters
id
required
string = 24 characters

Responses

Response samples

Content type
{
  • "id": "stringstringstringstring",
  • "name": "string",
  • "vendorCode": "string",
  • "paymentTermsId": "stringstringstringstring",
  • "notes": "string",
  • "externalReferences": {
    },
  • "customFields": {
    }
}

Find vendors based on search parameters.

query Parameters
Sort.Field
string non-empty

Sort field

Sort.Dir
string (CommonEnumSortDirectionEnum)
Enum: "ascending" "descending"

Sort direction

Skip
integer <int32> >= 0

Number of records to skip.

Take
integer <int32> [ 0 .. 1000 ]

Number of records to return (maximum)

Request Body schema:
name
string or null [ 1 .. 200 ] characters

Filter to vendors who's name contains the given string

vendorCode
string or null non-empty

Unique identifier for this vendor.

object (CommonExternalReferenceFindDto)

Search parameter for identifier record(s) via their external identifiers.

Responses

Request samples

Content type
{
  • "name": "string",
  • "vendorCode": "string",
  • "externalReference": {
    }
}

Response samples

Content type
[
  • {
    }
]

Vendor Address

Create a new vendor address

path Parameters
vendorId
required
string = 24 characters
Request Body schema:
name
string or null [ 1 .. 200 ] characters

Name of the address (Bob's Shipping, Primary, Reno Warehouse, etc).

address1
required
string [ 1 .. 200 ] characters

Primary address line.

address2
string or null [ 1 .. 200 ] characters

Second address line.

address3
string or null [ 1 .. 200 ] characters

Third address line.

city
required
string [ 1 .. 200 ] characters

Address city

stateProvince
string or null [ 1 .. 200 ] characters

Address state/province.

postalCode
required
string [ 1 .. 200 ] characters

Postal/zip code.

country
string or null [ 1 .. 200 ] characters

Country identifier.

shippingLeadTime
integer or null <int32> >= 0

Lead time for shipping contents.

primaryBilling
boolean

Signifies if this is a primary billing address.

primaryShipping
boolean

Signifies if this is a primary billing address.

email
string or null <email>

Email address

phone
string or null

Associated phone number

fax
string or null

Associated fax number

notes
string or null

General notes associated to this customer address

Responses

Request samples

Content type
{
  • "name": "string",
  • "address1": "string",
  • "address2": "string",
  • "address3": "string",
  • "city": "string",
  • "stateProvince": "string",
  • "postalCode": "string",
  • "country": "string",
  • "shippingLeadTime": 0,
  • "primaryBilling": true,
  • "primaryShipping": true,
  • "email": "[email protected]",
  • "phone": "string",
  • "fax": "string",
  • "notes": "string"
}

Response samples

Content type
{
  • "id": "string"
}

Delete a specific vendor address

path Parameters
vendorId
required
string = 24 characters
vendorAddressId
required
string = 36 characters

Responses

Get a specific vendor address

path Parameters
vendorId
required
string = 24 characters
vendorAddressId
required
string = 36 characters

Responses

Response samples

Content type
{
  • "name": "string",
  • "address1": "string",
  • "address2": "string",
  • "address3": "string",
  • "city": "string",
  • "stateProvince": "string",
  • "postalCode": "string",
  • "country": "string",
  • "shippingLeadTime": 0,
  • "primaryBilling": true,
  • "primaryShipping": true,
  • "id": "stringstringstringstringstringstring",
  • "email": "[email protected]",
  • "phone": "string",
  • "fax": "string",
  • "notes": "string"
}

Update a specific vendor address

path Parameters
vendorId
required
string = 24 characters
vendorAddressId
required
string = 36 characters
Request Body schema:
name
string or null [ 1 .. 200 ] characters

Name of the address (Bob's Shipping, Primary, Reno Warehouse, etc).

address1
required
string [ 1 .. 200 ] characters

Primary address line.

address2
string or null [ 1 .. 200 ] characters

Second address line.

address3
string or null [ 1 .. 200 ] characters

Third address line.

city
required
string [ 1 .. 200 ] characters

Address city

stateProvince
string or null [ 1 .. 200 ] characters

Address state/province.

postalCode
required
string [ 1 .. 200 ] characters

Postal/zip code.

country
string or null [ 1 .. 200 ] characters

Country identifier.

shippingLeadTime
integer or null <int32> >= 0

Lead time for shipping contents.

primaryBilling
boolean

Signifies if this is a primary billing address.

primaryShipping
boolean

Signifies if this is a primary billing address.

email
string or null <email>

Email address

phone
string or null

Associated phone number

fax
string or null

Associated fax number

notes
string or null

General notes associated to this customer address

Responses

Request samples

Content type
{
  • "name": "string",
  • "address1": "string",
  • "address2": "string",
  • "address3": "string",
  • "city": "string",
  • "stateProvince": "string",
  • "postalCode": "string",
  • "country": "string",
  • "shippingLeadTime": 0,
  • "primaryBilling": true,
  • "primaryShipping": true,
  • "email": "[email protected]",
  • "phone": "string",
  • "fax": "string",
  • "notes": "string"
}

Get a list of addresses for a vendor

path Parameters
vendorId
required
string = 24 characters

Responses

Response samples

Content type
[
  • {
    }
]

Vendor Contact

Create a new vendor contact

path Parameters
vendorId
required
string = 24 characters
Request Body schema:
firstName
required
string [ 1 .. 200 ] characters

First name

lastName
string or null [ 1 .. 200 ] characters

Last name

position
string or null [ 1 .. 200 ] characters

Position / Job Title

phone
string or null

Phone number

cellPhone
string or null

Cellphone number

email
string or null <email>

Email address

fax
string or null

Fax number

Responses

Request samples

Content type
{
  • "firstName": "string",
  • "lastName": "string",
  • "position": "string",
  • "phone": "string",
  • "cellPhone": "string",
  • "email": "[email protected]",
  • "fax": "string"
}

Response samples

Content type
{
  • "id": "string"
}

Delete a specific customer contact

path Parameters
vendorId
required
string = 24 characters

The id of the vendor to modify contacts for

contactId
required
string = 36 characters

The id of the vendor contact.

Responses

Get a specific vendor contact

path Parameters
vendorId
required
string = 24 characters

The id of the vendor to modify contacts for

contactId
required
string = 36 characters

The id of the vendor contact.

Responses

Response samples

Content type
{
  • "id": "stringstringstringstringstringstring",
  • "firstName": "string",
  • "lastName": "string",
  • "position": "string",
  • "cellPhone": "string",
  • "phone": "string",
  • "email": "[email protected]",
  • "fax": "string"
}

Update a specific vendor contact

path Parameters
vendorId
required
string = 24 characters

The id of the vendor to modify contacts for

contactId
required
string = 36 characters

The id of the vendor contact.

Request Body schema:

The new data to apply to the given contact

firstName
required
string [ 1 .. 200 ] characters

First name

lastName
string or null [ 1 .. 200 ] characters

Last name

position
string or null [ 1 .. 200 ] characters

Position / Job Title

phone
string or null

Phone number

cellPhone
string or null

Cellphone number

email
string or null <email>

Email address

fax
string or null

Fax number

Responses

Request samples

Content type
{
  • "firstName": "string",
  • "lastName": "string",
  • "position": "string",
  • "phone": "string",
  • "cellPhone": "string",
  • "email": "[email protected]",
  • "fax": "string"
}

Get a list of contacts for a vendor

path Parameters
vendorId
required
string = 24 characters

Responses

Response samples

Content type
[
  • {
    }
]

WorkCenter

Get a workcenter.

path Parameters
id
required
string = 24 characters

Responses

Response samples

Content type
{
  • "id": "stringstringstringstring",
  • "name": "string",
  • "departmentId": "stringstringstringstring",
  • "setupRate": 0,
  • "runRate": 0,
  • "laborRate": 0,
  • "overheadRate": 0,
  • "machineRate": 0,
  • "deleted": true,
  • "equipment": [
    ]
}

Find workcenters based on search parameters.

query Parameters
Sort.Field
string non-empty

Sort field

Sort.Dir
string (CommonEnumSortDirectionEnum)
Enum: "ascending" "descending"

Sort direction

Skip
integer <int32> >= 0

Number of records to skip.

Take
integer <int32> [ 0 .. 1000 ]

Number of records to return (maximum)

Request Body schema:
ids
Array of strings or null

Filter workcenters based on matching ids.

name
string or null [ 1 .. 200 ] characters

Filter workcenters based on their name.

Responses

Request samples

Content type
{
  • "ids": [
    ],
  • "name": "string"
}

Response samples

Content type
[
  • {
    }
]