Parts

Queryable, Introduced in version 2.18

GET https://localhost:8001/sv/001.1/api/v1/Inventory/Parts

Represents a part.

GUID

6B6B98DA-21A0-4CA4-9B88-21631C6EA572

Required permission

Show part

Properties

Name Type Summary Introduced in
Id Int64 The business key identifier of the part.
PartNumber String The human readable identifier of the part.

  • Not nullable
  • Max length is 20
  • Unique
Description String The translated description of the part.
ExtraDescription String The translated extra description of the part.
CompanyId Int64 The business key identifier of the company that the part is defined for.
Length Decimal? The physical length of the part in metres.
Width Decimal? The physical width of the part in metres.
Height Decimal? The physical height of the part in metres.
PackagingType Int32 The packaging type that the part specifies.

  • Unspecified: 0
  • OuterPackaging: 1
  • EurPallets: 2
  • InnerPackaging: 3
  • CoverPackaging: 4
PackageVolumeConsistsOf Int32 Specifies how package volume of the part has been specified.

  • SurroundingPackagingVolume: 0
  • PackagingVolumeAndPartVolume: 1
PackageTypeId Int64? The business key identifier of the package type specified by the part.

References PackageTypes
PackageType PackageTypes The package type specified by the part.

  • Expandable
PartPlanningInformations PartPlanningInformation[] A collection of part planning information for the part.

  • Expandable
UseRandomLocationStorage Boolean Specifies if the part employs random location storage.
ShowFictiousStructureOnOrderRegistration Boolean Specifies if the part should show its fictitious structure when registering
orders.
TraceabilityMode Int32 The traceability mode that is employed by the part.

  • None: 0
  • Batch: 1
  • Individual: 2
  • IndividualOnlyWithdrawal: 4
UseBestBeforeDate Boolean Specifies whether or not best before date applies to the part.
 Introduced in version 2.40
DaysToAddToBestBeforeDate Int32? Days to use when best before date is active.
 Introduced in version 2.40
SuggestBestBeforeDate Int32 Specifies whether or not a best before date should be suggested for the part.

  • No: 0
  • AddDays: 1
  • ShortestFromReportedMaterial: 2
 Introduced in version 2.40
ManageStockBalance Boolean Specifies if stock balance management is enabled for the part.
StandardPrice Decimal The standard price of the part.
StandardPriceCurrencyId Int64 The business key identifier of the currency that the standard price is
specified in.

References Currencies
FutureStandardPrice Decimal? The future standard price of the part.
FutureStandardPriceCurrencyId Int64? The business key identifier of the currency that the future standard price
is specified in.

References Currencies
PostCalculatedAveragePrice Decimal? The post calculated average price of the part.
PostCalculatedAveragePriceCurrencyId Int64? The business key identifier of the currency that the post calculated average price
is specified in.

References Currencies
Type Int32 The part type.

  • Purchased: 0
  • Manufactured: 1
  • Fictitious: 2
  • Service: 5
  • Subcontract: 6
ProductGroupId Int64 The business key identifier of the product group that the part belongs to.
ProductGroup ProductGroups The product group that the part belongs to.

  • Expandable
WeightPerUnit Decimal? The weight of the part per unit in kilograms.
StatisticalGoodsCodeId Int64? The business key identifier of the statistical goods code that the part is
organized under.

References a StatisticalGoodsCodes
StatisticalGoodsCode StatisticalGoodsCodes The statistical goods code that the part is organized under.

  • Expandable
StatisticalGoodsValue Decimal? The statistical goods value of the part.
CountryOfOriginId Int64? The business key identifier of the part's country of origin.

References Countries
CountryOfOrigin Countries The part's country of origin.

  • Expandable
PartCodeId Int64? The business key identifier of the part's part code.

References PartCodes
PartCode PartCodes The part's part code.

  • Expandable
CategoryString String The category of the part.
StorageOverheadMarkupId Int64 The business key identifier of the storage overhead markup of the part.

References StorageOverheadMarkups
StorageOverheadMarkup StorageOverheadMarkups The storage overhead markup of the part.

  • Expandable
SalesOverheadMarkupId Int64 The business key identifier of the sales overhead markup of the part.

References SalesOverheadMarkups
SalesOverheadMarkup SalesOverheadMarkups The sales overhead markup of the part.

  • Expandable
ProfitMarkupId Int64 The business key identifier of the part's profit markup.

References ProfitMarkups
ProfitMarkup ProfitMarkups The part's profit markup.

  • Expandable
VolumePerUnit Decimal? The volume per unit of the part in cubic metres.
AveragePrice Decimal? The average price of the part.
AveragePriceCurrencyId Int64? The business key identifier of the currency that the part's average price
is specified in.

References Currencies
LastPurchasePrice Decimal? The last purchase price of the part.
LastPurchasePriceCurrencyId Int64? The business key identifier of the part's last purchase price.

References Currencies
AveragePriceTimestamp DateTimeOffset? The timestamp of the part's average price.
PurchaseLabelType Int32 The type of transport label that is used for the part when purchasing.

  • None: 0
  • Transport: 1
  • Label: 2
  • SmallLabel: 3
  • MultiLabel: 4
  • SelectAtPrintout: 5
CurrentAlloyId Int64? The business key identifier of the current part alloy.

References Alloys
CurrentAlloy Alloys The part's current alloy.

  • Expandable
PurchaseQuantityPerPackage Decimal? The quantity per package of the part when purchasing.
IsPackaging Boolean Specifies if the part is used for packaging.
Status Int32 The status of the part.

  • Quote: 1
  • Prototype: 2
  • New: 3
  • Normal: 4
  • NewRevision: 5
  • PhasingOut: 6
  • Expired: 9
  • Inactive: 99
PurchaseAndManufactureOnProject Int32 Specifies if the part is purchased and manufactured on a project.

  • No: 0
  • Yes: 1
  • PickFromStockFirst: 2
ServiceType Int32 The service type of the part.

  • Unspecified: 0
  • Freight: 1
  • AlloyCost: 2
QuantityPerPackage Decimal? The quantity per package of the part.
PackagingWeightPerPackage Decimal? The packaging weight per package.
PackagingPartId Int64? The business key identifier of the packaging part used for this part.

References Parts
PackagingPart Parts The packaging part used for this part.

  • Expandable
LoadingMetersPerUnit Decimal? The loading metres per unit.
PackingReference String The packing reference of the part.
Gs1Code String The GS1 code of the part.

  • Max length is 35
VatRateId Int64? The business key identifier of the part's VAT rate.

References VatRates
VatRate VatRates The part's VAT rate.
LastSalesPrice Decimal? The last sales price of the part.
LastSalesPriceCurrencyId Int64? The business key identifier of the currency that the last sales price was
specified in.

References Currencies
TransportCost Decimal? The transport cost of the part.
SerialNumberGeneration Int32 The serial number generation method of the part.

  • Never: 0
  • CustomerOrderRegistration: 1
  • ManufacturingOrderRegistration: 2
  • DeliveryReporting: 3
SerialNumberGenerationSource Int32 The serial number generation source of the part.

  • NumberSeries: 0
  • Manual: 1
GoodsType String The goods type of the part.

  • Max length is 35
LeadTimeToCustomer TimeSpan? The lead time to the customer for the part.
QuantityForLeadtimeToCustomer Decimal? The quantity for the lead time to the customer for the part.
SalesLabelType Int32 The type of transport label to use for the part when selling.

  • None: 0
  • Transport: 1
  • Label: 2
  • SmallLabel: 3
  • MultiLabel: 4
  • SelectAtPrintout: 5
DefaultCustomerOrderWarehouseId Int64? The business key identifier of the default customer order warehouse to use
for the part.

References Warehouses
ManufacturingLabelType Int32 The type of transport label to use for the part when manufacturing.

  • None: 0
  • Transport: 1
  • Label: 2
  • SmallLabel: 3
  • MultiLabel: 4
  • SelectAtPrintout: 5
PreparerId Int64? The business key identifier of the person that prepares the part.

References Persons
Preparer Persons The person that prepares the part.

  • Expandable
GoodsTypeId Int64? The business key identifier of the goods type of the part.

References GoodsTypes
ExpGoodsType GoodsTypes The goods type of the part.

  • Expandable
CalculatedQuantity Decimal The calculated quantity of the part.
Alias String The part alias.

  • Max length is 20
BlockedById Int64? The business key identifier of the application user that blocked the entity.
BlockedBy ApplicationUsers The application user that blocked the part.

  • Expandable
BlockedStatus Int32 The block status of the entity.

  • None: 0
  • Message: 1
  • Blocked: 2
BlockedContextType Int32 Specifies which contexts the block applies for.

  • None: 0
  • RegisterManufacturingOrder: 1
  • RegisterPurchaseOrder: 2
  • RegisterCustomerOrder: 4
  • ReportManufacturingOrder: 8
  • ReportPurchaseOrder: 16
  • ReportCustomerOrder: 32
  • WithdrawalManufacturingOrder: 64
  • Preparation: 128
  • ConfigurationSelection: 256
  • RegisterAgreement: 512
  • RegisterBlanketOrderPurchase: 1024
  • RegisterBlanketOrderSales: 2048

  • Bitmask
BlockMessageId Int64? The business key identifier of the entity block message comment.

References Comments.
BlockMessage Comments The block message of the part.

  • Expandable
BlockedFromDate DateTimeOffset? The date when the entity starts being blocked.
BlockedToDate DateTimeOffset? The date when the entity stops being blocked.
ReceivingInspectionType Int32 Specifies when reception inspection of the type occurs.

  • None: 0
  • Always: 1
  • VariableInspection: 2
StandardUnitId Int64 The business key identifier of the standard unit of the part.

References Units
StandardPartUnitUsageId Int64 The business key identifier of the standard part unit usage.

References PartUnitUsages
StandardPartUnitUsage PartUnitUsages The standard part unit usage.

  • Expandable
PartUnitUsages PartUnitUsages[] A collection of part unit usages for the part.

References PartUnitUsages

  • Expandable
 Introduced in version 2.32
CommentId Int64? The business key identifier of the part comment.

References Comments
Comment Comments The part comment.

  • Expandable
ActiveRevisionId Int64? The business key identifier of the part's active revision.

References Revisions
ActiveRevision Revisions The active revision of the part.

  • Expandable
LatestCalculationId Int64? The business key identifier of the latest part calculation.

References PartCalculation
ReceivingInstructionId Int64? The business key identifier of the receiving instruction of the part.

References Comments
ReceivingInstruction Comments The receiving instruction of the part.

  • Expandable
PurchaseCommentId Int64? The business key identifier of the part's purchase comment.

References Comments
PurchaseComment Comments The purchase comment of the part.

  • Expandable
PickingInstructionId Int64? The business key identifier of the part's picking instruction.

References Comments
PickingInstruction Comments The picking instruction of the part.

  • Expandable
SalesCommentId Int64? The business key identifier of the part's sales comment.

References Comments
SalesComment Comments The sales comment of the part.

  • Expandable
ManufacturingCommentId Int64? The business key identifier of the part's manufacturing comment.

References Comments
ManufacturingComment Comments The manufacturing comment of the part.

  • Expandable
PreparationId Int64? The business key identifier of the part's preparation.

References Preparations
ExtraFields ExtraFields[] A collection of extra field values for the part.

  • Expandable
CustomerPartLinks CustomerPartLinks[] A collection of customer part links for the part.

  • Expandable
SupplierPartLinks SupplierPartLinks[] A collection of supplier part links for the part.

  • Expandable
Revisions Revisions[] A collection of revisions that belong to the part.

  • Expandable
Drawings Drawings[] A collection of drawings that belong to the part.

  • Expandable
PartLocations PartLocations[] A collection of locations that belong to the part.

  • Expandable
 Introduced in version 2.28
HyperLinks HyperLinks[] A collection of hyperlinks that belong to the part.

  • Expandable
 Introduced in version 2.55
PartActivities PartActivities[] A collection of activities that belong to the part.

  • Expandable
 Introduced in version 22.7
ConfigurationTemplateId Int64? The business key identifier of the part configuration template that the
part uses for part configuration.

References PartConfigurationTemplate
 Introduced in version 2.33
ConfigurationTemplate PartConfigurationTemplates The part configuration template that the part uses for part configuration.

  • Expandable
 Introduced in version 22.3
OtherIdentities PartOtherIdentities[] The "other" identities of the part.

  • Expandable
 Introduced in version 2.47
Notes BusinessContactNoteHistories[] Rows of business contact notes.

  • Expandable
 Introduced in version 2.55
ConfigurationSelectionDescription String The selected configuration description of the part.
 Introduced in version 2.55
OrderQuantityId Int64? The business key identifier of order quantity.

 Introduced in version 22.6
OrderQuantity OrderQuantityTemplates Order quantity template that holds the partial quantities, that acts as a default for the order equivalent order quantities.

  • Expandable
 Introduced in version 22.6
ProjectId Int64? The business key identifier of the project that the part belongs to.

 Introduced in version 22.7
PartTemplateId Int64? The business key identifier of the part template.

 Introduced in version 23.1
PartTemplate PartTemplates A part template information for the part.

  • Expandable
 Introduced in version 23.1
IsFixedWeight Boolean Information whether the part has a fixed weight.
 Introduced in version 23.2
MaterialValidationSetting Int32 The settings for serial number linked to which operation.

  • ActualOperation: 0
  • AnyOperation: 1

  • Bitmask
 Introduced in version 24.5
AutomaticReportingMode Int32 The automatic reporting mode that the part applies.

  • PickingLocation: 1
  • Cleared: 2
  • BufferLocation: 4
  • Project: 8

  • Bitmask
 Introduced in version 24.6

Example

{
  "Id": 0,
  "PartNumber": null,
  "Description": null,
  "ExtraDescription": null,
  "CompanyId": 0,
  "Length": null,
  "Width": null,
  "Height": null,
  "PackagingType": 0,
  "PackageVolumeConsistsOf": 0,
  "PackageTypeId": null,
  "PackageType": null,
  "PartPlanningInformations": null,
  "UseRandomLocationStorage": false,
  "ShowFictiousStructureOnOrderRegistration": false,
  "TraceabilityMode": 0,
  "UseBestBeforeDate": false,
  "DaysToAddToBestBeforeDate": null,
  "SuggestBestBeforeDate": 0,
  "ManageStockBalance": false,
  "StandardPrice": 0.0,
  "StandardPriceCurrencyId": 0,
  "FutureStandardPrice": null,
  "FutureStandardPriceCurrencyId": null,
  "PostCalculatedAveragePrice": null,
  "PostCalculatedAveragePriceCurrencyId": null,
  "Type": 0,
  "ProductGroupId": 0,
  "ProductGroup": null,
  "WeightPerUnit": null,
  "StatisticalGoodsCodeId": null,
  "StatisticalGoodsCode": null,
  "StatisticalGoodsValue": null,
  "CountryOfOriginId": null,
  "CountryOfOrigin": null,
  "PartCodeId": null,
  "PartCode": null,
  "CategoryString": null,
  "StorageOverheadMarkupId": 0,
  "StorageOverheadMarkup": null,
  "SalesOverheadMarkupId": 0,
  "SalesOverheadMarkup": null,
  "ProfitMarkupId": 0,
  "ProfitMarkup": null,
  "VolumePerUnit": null,
  "AveragePrice": null,
  "AveragePriceCurrencyId": null,
  "LastPurchasePrice": null,
  "LastPurchasePriceCurrencyId": null,
  "AveragePriceTimestamp": null,
  "PurchaseLabelType": 0,
  "CurrentAlloyId": null,
  "CurrentAlloy": null,
  "PurchaseQuantityPerPackage": null,
  "IsPackaging": false,
  "Status": 0,
  "PurchaseAndManufactureOnProject": 0,
  "ServiceType": 0,
  "QuantityPerPackage": null,
  "PackagingWeightPerPackage": null,
  "PackagingPartId": null,
  "PackagingPart": null,
  "LoadingMetersPerUnit": null,
  "PackingReference": null,
  "Gs1Code": null,
  "VatRateId": null,
  "VatRate": null,
  "LastSalesPrice": null,
  "LastSalesPriceCurrencyId": null,
  "TransportCost": null,
  "SerialNumberGeneration": 0,
  "SerialNumberGenerationSource": 0,
  "GoodsType": null,
  "LeadTimeToCustomer": null,
  "QuantityForLeadtimeToCustomer": null,
  "SalesLabelType": 0,
  "DefaultCustomerOrderWarehouseId": null,
  "ManufacturingLabelType": 0,
  "PreparerId": null,
  "Preparer": null,
  "GoodsTypeId": null,
  "ExpGoodsType": null,
  "CalculatedQuantity": 0.0,
  "Alias": null,
  "BlockedById": null,
  "BlockedBy": null,
  "BlockedStatus": 0,
  "BlockedContextType": 0,
  "BlockMessageId": null,
  "BlockMessage": null,
  "BlockedFromDate": null,
  "BlockedToDate": null,
  "ReceivingInspectionType": 0,
  "StandardUnitId": 0,
  "StandardPartUnitUsageId": 0,
  "StandardPartUnitUsage": null,
  "PartUnitUsages": null,
  "CommentId": null,
  "Comment": null,
  "ActiveRevisionId": null,
  "ActiveRevision": null,
  "LatestCalculationId": null,
  "ReceivingInstructionId": null,
  "ReceivingInstruction": null,
  "PurchaseCommentId": null,
  "PurchaseComment": null,
  "PickingInstructionId": null,
  "PickingInstruction": null,
  "SalesCommentId": null,
  "SalesComment": null,
  "ManufacturingCommentId": null,
  "ManufacturingComment": null,
  "PreparationId": null,
  "ExtraFields": null,
  "CustomerPartLinks": null,
  "SupplierPartLinks": null,
  "Revisions": null,
  "Drawings": null,
  "PartLocations": null,
  "HyperLinks": null,
  "PartActivities": null,
  "ConfigurationTemplateId": null,
  "ConfigurationTemplate": null,
  "OtherIdentities": null,
  "Notes": null,
  "ConfigurationSelectionDescription": null,
  "OrderQuantityId": null,
  "OrderQuantity": null,
  "ProjectId": null,
  "PartTemplateId": null,
  "PartTemplate": null,
  "IsFixedWeight": false,
  "MaterialValidationSetting": 0,
  "AutomaticReportingMode": 0
}