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

Responses

Request samples

Content type
{
  • "itemIds": [
    ],
  • "dateRange": {
    }
}

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
}

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
}

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
}

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