List inventory materials
Lists inventory materials for a company. Returns company-specific materials if configured, otherwise returns reference materials. Supports filtering by active status and custom-only mode.
path Parameters
companyIdThe unique identifier of the company
query Parameters
activeFilter by active status (only applies to company-specific materials)
customonlyIf true, only return company-specific materials. If false (default), return reference materials when no company materials exist.
List inventory materials › Responses
List of inventory materials retrieved successfully
Create company inventory materials
Creates one or more company inventory materials. All companyId values will be set to match the route parameter.
path Parameters
companyIdThe unique identifier of the company
Create company inventory materials › Request Body
companyInventoryMaterialIdcompanyIdinventoryMaterialIdcategoryvalueactiveCreate company inventory materials › Responses
Materials created successfully
companyInventoryMaterialIdcompanyIdinventoryMaterialIdcategoryvalueactiveUpdate company inventory materials
Updates one or more company inventory materials. All companyId values will be validated to match the route parameter.
path Parameters
companyIdThe unique identifier of the company
Update company inventory materials › Request Body
companyInventoryMaterialIdcompanyIdinventoryMaterialIdcategoryvalueactiveUpdate company inventory materials › Responses
Materials updated successfully
companyInventoryMaterialIdcompanyIdinventoryMaterialIdcategoryvalueactiveList inventory types
Lists inventory types for a company. Returns company-specific types if configured, otherwise returns reference types. Supports filtering by active status and custom-only mode.
path Parameters
companyIdThe unique identifier of the company
query Parameters
activeFilter by active status (only applies to company-specific types)
customonlyIf true, only return company-specific types. If false (default), return reference types when no company types exist.
List inventory types › Responses
List of inventory types retrieved successfully
Create company inventory types
Creates one or more company inventory types. All companyId values will be set to match the route parameter.
path Parameters
companyIdThe unique identifier of the company
Create company inventory types › Request Body
companyInventoryTypeIdcompanyIdinventoryTypeIdcategoryvalueactiveCreate company inventory types › Responses
Types created successfully
companyInventoryTypeIdcompanyIdinventoryTypeIdcategoryvalueactiveUpdate company inventory types
Updates one or more company inventory types. All companyId values will be validated to match the route parameter.
path Parameters
companyIdThe unique identifier of the company
Update company inventory types › Request Body
companyInventoryTypeIdcompanyIdinventoryTypeIdcategoryvalueactiveUpdate company inventory types › Responses
Types updated successfully
companyInventoryTypeIdcompanyIdinventoryTypeIdcategoryvalueactivePopulate company inventory materials
Populates company-specific inventory materials from the reference table. Can only be called once per company.
path Parameters
companyIdThe unique identifier of the company
Populate company inventory materials › Responses
Materials populated successfully
companyInventoryMaterialIdcompanyIdinventoryMaterialIdcategoryvalueactivePopulate company inventory types
Populates company-specific inventory types from the reference table. Can only be called once per company.
path Parameters
companyIdThe unique identifier of the company
Populate company inventory types › Responses
Types populated successfully
companyInventoryTypeIdcompanyIdinventoryTypeIdcategoryvalueactiveList stock locations
Lists stock locations for a company. Returns company-specific locations if configured, otherwise returns reference locations. Supports filtering by active status and custom-only mode.
path Parameters
companyIdThe unique identifier of the company
query Parameters
activeFilter by active status (only applies to company-specific locations)
customonlyIf true, only return company-specific locations. If false (default), return reference locations when no company locations exist.
List stock locations › Responses
List of stock locations retrieved successfully
Create company stock locations
Creates one or more company stock locations. All companyId values will be set to match the route parameter.
path Parameters
companyIdThe unique identifier of the company
Create company stock locations › Request Body
companyStockLocationIdcompanyIdstockLocationIdcategoryvalueactiveCreate company stock locations › Responses
Stock locations created successfully
companyStockLocationIdcompanyIdstockLocationIdcategoryvalueactiveUpdate company stock locations
Updates one or more company stock locations. All companyId values will be validated to match the route parameter.
path Parameters
companyIdThe unique identifier of the company
Update company stock locations › Request Body
companyStockLocationIdcompanyIdstockLocationIdcategoryvalueactiveUpdate company stock locations › Responses
Stock locations updated successfully
companyStockLocationIdcompanyIdstockLocationIdcategoryvalueactivePopulate company stock locations
Populates company-specific stock locations from the reference table. Can only be called once per company.
path Parameters
companyIdThe unique identifier of the company
Populate company stock locations › Responses
Locations populated successfully
companyStockLocationIdcompanyIdstockLocationIdcategoryvalueactive