Skip to main content

OData Entities: Purchasing

Columns in the OData purchase order, receipt, shipping method, and vendor entities.

Each entity below lists its OData feed entity set name and its columns, whether a value is required, a description, and the entity it relates to. For the terms used in these articles (tools, materials, assets, uniquely-tracked, and quantity-tracked), see Document Conventions in the ToolWatch OData API Overview.


PurchaseOrderHeader

OData feed entity set: rc.PurchaseOrderHeader

Column

Required

Description

Relates to

PurchaseOrderId

Yes

-

-

PONumber

Yes

-

-

Vendor

Yes

-

-

VendorId

Yes

-

-

VendorNotes

No

-

-

DestinationEntity

Yes

-

-

DestinationEntityId

Yes

-

-

DestinationEntityNotes

No

-

-

CostCenter

No

-

-

CostCenterId

No

-

-

CostCode

No

-

-

CostCodeId

No

-

-

IsToolwatchBilled

Yes

-

-

OrderedBy

Yes

-

-

OrderedByEntityId

Yes

-

-

Requisition

No

-

-

ShippingMethod

No

-

-

ShippingMethodId

No

-

-

OrderDate

Yes

-

-

ExpectedDeliveryDate

Yes

-

-

DocumentNumber

No

-

-

Notes

No

-

-

StatusId

Yes

-

-

PrimaryReceivingEntityId

No

-

-

ShippingCharges

No

-

-

TaxCharges

No

-

-

ShippingCostCodeId

No

-

-

TaxCostCodeId

No

-

-

CreatedByEntityId

Yes

The user that created the record.

Entities

CreatedBy

Yes

The name of the user that created the record.

-

CreatedOnDate

Yes

-

-

ModifiedByEntityId

Yes

The user that last modified the record.

Entities

ModifiedBy

Yes

The name of the user that last modified the record.

-

ModifiedOnDate

Yes

-

-

IsDeleted

Yes

Indicates if this record has been deleted.

-

StockpointId

No

-

-


PurchaseOrderLines

OData feed entity set: rc.PurchaseOrderLines

Column

Required

Description

Relates to

LineId

Yes

-

-

PurchaseOrderId

Yes

-

-

ModelId

No

-

-

ItemNumber

No

-

-

Description

Yes

-

-

SKU

No

-

-

QuantityOrdered

Yes

-

-

QuantityReceived

Yes

-

-

QuantityCancelled

Yes

-

-

CostCenter

No

-

-

CostCenterId

No

-

-

CostCode

No

-

-

CostCodeId

No

-

-

IsToBeBilled

Yes

-

-

UnitOfMeasure

No

-

-

Cost

No

-

-

ItemType

No

-

-

CreatedByEntityId

Yes

The user that created the record.

Entities

CreatedBy

Yes

The name of the user that created the record.

-

CreatedOnDate

Yes

-

-

ModifiedByEntityId

Yes

The user that last modified the record.

Entities

ModifiedBy

Yes

The name of the user that last modified the record.

-

ModifiedOnDate

Yes

-

-

ReceiptHeaderId

No

-

-

ModelNumber

No

-

-

Model

No

-

-

ModelDescription

No

-

-

ReplacementCost

No

-

-

ManufacturerDescription

No

-

-


ReceiptHeaders

OData feed entity set: rc.ReceiptHeaders

Column

Required

Description

Relates to

ReceiptHeaderId

Yes

-

-

ReceiptNumber

Yes

-

-

PONumber

Yes

-

-

PurchaseOrderId

Yes

-

-

ReceivedBy

Yes

-

-

ReceivedByEntityId

Yes

-

-

ReceivedDate

Yes

-

-

ReveivedAt

Yes

-

-

ReceivedAtEntityId

Yes

-

-

Notes

No

-

-

CreatedBy

Yes

The name of the user that created the record.

-

CreatedById

Yes

The user that created the record.

Entities

CreatedOn

Yes

When the record was created.

-

ModifiedBy

Yes

The name of the user that last modified the record.

-

ModifiedById

Yes

The user that last modified the record.

Entities

ModifiedOn

Yes

When the record was last modified.

-


ReceiptLines

OData feed entity set: rc.ReceiptLines

Column

Required

Description

Relates to

ReceiptLineId

Yes

-

-

ReceiptNumber

Yes

-

-

ReceiptHeaderId

Yes

-

-

ReceivedDate

Yes

-

-

PONumber

Yes

-

-

PurchaseOrderId

Yes

-

-

QuantityReceived

Yes

-

-

ActualPrice

Yes

-

-

PurchaseOrderLineId

Yes

-

-

ItemNumber

No

-

-

PurchaseOrderLineDescription

Yes

-

-


ShippingMethods

OData feed entity set: rc.ShippingMethods

Column

Required

Description

Relates to

ShippingMethodId

Yes

The unique ID of this shipping method.

-

ShippingMethodNumber

Yes

A shorthand string used to refer to this shipping method.

-

Description

Yes

A brief phrase describing this shipping method.

-

CreatedByEntityId

Yes

The user that created the shipping method.

Entities

CreatedBy

Yes

The name of the user that created the record.

-

CreatedOnDate

Yes

When the service request was created.

-

ModifiedByEntityId

Yes

The user that last modified the shipping method.

Entities

ModifiedBy

Yes

The name of the user that last modified the record.

-

ModifiedOnDate

Yes

When the shipping method was last modified.

-

IsDeleted

Yes

Indicates if this record has been deleted

-

IsInactive

Yes

Indicates if this record has been inactivated

-


Vendors

OData feed entity set: rc.Vendors

Column

Required

Description

Relates to

VendorId

Yes

Unique Id of this vendor

-

VendorNumber

Yes

A shorthand string used to refer to this vendor

-

Name

Yes

Vendor Name

-

Address

No

-

-

Address2

No

-

-

City

No

-

-

State

No

-

-

Zip

No

-

-

Country

No

-

-

Contact

No

-

-

Email

No

-

-

Url

No

-

-

Phone

No

-

-

Fax

No

-

-

Phone2

No

-

-

AccountNumber

No

-

-

ShippingMethodId

No

-

ShippingMethodId

VariancePercent

No

-

-

Notes

No

-

-

Inactive

Yes

Has the vendor been inactivated (0 - No, 1 - Yes).

-

Deleted

Yes

Has the vendor been deleted (0 - No, 1 - Yes).

-

CreatedById

Yes

The user that created the vendor.

Entities

CreatedOn

Yes

When the vendor was created.

-

ModifiedById

Yes

The user that last modified the vendor.

Entities

ModifiedOn

Yes

When the vendor was last modified.

-

Did this answer your question?