BYOBI Data Dictionary - Purchase Orders & Order Lines

Abigail Briggs Updated by Abigail Briggs

This guides aims to provide an understanding of the Purchase Orders data set available via the Purchasing BYOBI solution. This solution is agnostic of any third-party reporting tool.

The Purchase orders data is made up of two data tables

  • Purchase Orders: this table includes all of your organisations Purchase Orders. The data is header level, it does not include line level
  • Order Items: this table includes the line level details of every Purchase order

Purchase Orders

Every purchase order raised in Purchase is stored in this table. The order stored in the table is added at the time of order creation.

Field Name

Type

Description

BILLING_ADDRESS_ID

NUMBER

Unique ID for the billing address associated with the order. This is a foreign key that links to the primary key in the Billing Address table, where full address details are stored.

BUYER_COMPANY_ID

NUMBER

Unique ID for the buying organisation associated with the order. This field serves as a primary reference key for the organisation in the system. Although end users will typically only see data for their own organisation, this ID is used to link orders to the correct buyer in the database.

BUYER_COMPANY_NAME

VARCHAR

Company or Business Unit of where the requestor was assigned to at the time of placing the order

BUYER_FOOTER_TEXT

VARCHAR

Text which is configured in Purchasing and applied to every order

BUYER_FINAL_TEXT

VARCHAR

Text which is configured in Purchasing and applied to every order

BUYER_HEADER_TEXT

VARCHAR

Text which is configured in Purchasing and applied to every order

BUYER_VAT_NUMBER

VARCHAR

VAT number is configured in Purchasing and applied to every order

CUSTOMER_REF

VARCHAR

The name of the Buyer organisation

LAST_UPDATED_TIME

TIMESTAMP

ORDER_ATTENTION_NAME

VARCHAR

Attention name on the Purchase Order

ORDER_STATUS

VARCHAR

Status of the order

PURCHASE_ORDER_DATE

TIMESTAMP

Purchase Order Date

PURCHASE_ORDER_ID

NUMBER

Primary key of the Purchase Orders table. (This will be used as the foreign key in tables such as the Order_items tables).

PURCHASE_ORDER_NUMBER

VARCHAR

Customer Purchase Order reference number

REQUESTOR_EMAIL

VARCHAR

Email of the user who placed the order

REQUESTOR ID

NUMBER

Unique ID of the user who requested by the order (Generated by Purchasing). This is the foreign key that links with the users table

REQUESTOR NAME

VARCHAR

Name of the user who requested the order

REQUESTOR_PHONE_NUMBER

VARCHAR

Phone number on the Purchase Order

SALES_ORDER_REFERENCE_ID

NUMBER

Internal sales order reference

SENT_TO_SUPPLIER_DATE

TIMESTAMP

Date purchase order is issued to supplier

SHIPPING_ADDRESS_ID

NUMBER

Unique ID for the shipping address associated with the order. This is a foreign key that links to the primary key in the Shipping Address table, where full address details are stored.

SUPPLIER_COMMENTS

VARCHAR

Comments added by the supplier at header level

SUPPLIER_EXTERNAL_ID

VARCHAR

Buyers Finance/ERP ID for the Supplier

SUPPLIER_ID

NUMBER

The unique ID of the Supplier (Generated by Purchasing)

SUPPLIER_NAME

VARCHAR

Name of the supplier (In Purchasing) which is stored at the time of order placed

UPDATED_AT

TIMESTAMP

Purchase Order Items

Every purchase order raised in Purchase is stored in this table with the associated line items that are added to the order. The order lines stored in the table is added at the time of order creation. For example the part number, unit price etc are added in this table. If you did want to view live catalogue data, you can link us the part number with the items table in BYOBI. (Items table is a future data set).

Field name

Data Type

Description

ATTENTION_TO

VARCHAR

Attention to name on order

BUYER_COMPANY_ID

VARCHAR

Unique ID of the Buyer organisation (Generated by Purchasing)

BUYER_ORDER_LINE_COMMENTS

VARCHAR

Line level comments added by the requestor on the order

CATALOGUE_ITEM_ID

VARCHAR

Unique ID for the item in the catalogue. (Foreign key to the Catalogue Items table)

CREATED_BY

VARCHAR

Name of requestor

CURRENCY_CODE

VARCHAR

Currency on order line

CUSTOMER_REF

VARCHAR

Name of organisation in Purchasing

DELIVERED_QUANTITY

VARCHAR

Quantity delivered (will only be applicable where the supplier has marked the order as shipped in the supplier portal)

EXPECTED_DELIVERY_DATE

VARCHAR

User requested delivery date

EXTERNAL_LINE_NUMBER

VARCHAR

Line number provided by customer finance system for Purchase order

ITEM_CATEGORY

VARCHAR

Catalogue or Off Catalogue

ITEM_CATEGORY_NAME

VARCHAR

Purchasing Category Name

ITEM_SUPERDOMAIN_NAME

VARCHAR

Purchasing Superdomain name

ITEM_UNSPSC_CODE

VARCHAR

UNSPSC code

LINE_TAX_ID

VARCHAR

Unique ID generated by Purchasing. Foreign key which links with the id in the Line_tax table to retrieve the tax details

LINE_TOTAL_AMOUNT

VARCHAR

Total amount on the order line

LINE_TYPE_DESCRIPTION

VARCHAR

Line type description (Catalogue, Free Format, Punchout, Oligo or eServices)

LINE_TYPE_ID

VARCHAR

Unique ID for Line Type. Foreign key which links with Line_type table

LIST_PRICE

VARCHAR

The list price of the item at the time of the purchase

MANUFACTURER_NAME

VARCHAR

Suppliers manufacturer name

MANUFACTURER_PART_NUMBER

VARCHAR

Suppliers manufacturer part number

OLIGO_ITEM_ID

VARCHAR

Unique ID for the Oligo created by the user. Foreign key to the Oligos data table

ORDER_ITEM_ID

VARCHAR

Primary key for the order line

ORDER_LINE_DESCRIPTION

VARCHAR

Description on the order line

ORDER__LINE_STATUS

VARCHAR

Status of order line

ORDERED_QUANTITY

VARCHAR

Quantity ordered on the line

PART_NUMBER

VARCHAR

Part number on the order (Suppliers part number or added by the requestor for free text orders)

PRICE_UNIT

VARCHAR

Price Unit

PURCHASE_ORDER_DATE

TIMESTAMP

Purchase order date

PURCHASE_ORDER_ID

VARCHAR

Unique ID for Purchase Order. This field is a foreign key that links each order item to its parent purchase order in the Purchase Orders table (Purchase Order ID).

PURCHASE_ORDER_NUMBER

VARCHAR

Customer Purchase order reference number

PURCHASE_PRICE

VARCHAR

The price on the order to the supplier

REQUESTOR_ID

VARCHAR

Unique ID of the requestor. Foreign key to the users data table

REQUESTOR_NAME

VARCHAR

Purchasing unique ID for each user

RFQ_ITEM_ID

VARCHAR

Unique ID of the RFQ created. Foreign key to the RFQ table

SALES_ORDER_REFERENCE_ID

VARCHAR

Internal sales order reference ID (Generated by Purchasing)

SALES_TAX_AMOUNTS

VARCHAR

Tax amount on order line

SALES_TAX_PERCENTAGES

VARCHAR

Tax percentage on order line

SELLER_USER_ID

VARCHAR

SELLING_PRICE

VARCHAR

The selling price of the item at the time of purchase

SUPPLIER_COMMENTS

VARCHAR

Comments added by the supplier

SUPPLIER_FILE_PATH

VARCHAR

File path of attachment added by a supplier

SUPPLIER_ID

VARCHAR

The unique ID of the Supplier (Generated by Purchasing)

SUPPLIER_NAME

VARCHAR

Name of the supplier in Purchasing. Stored at the time of order placed

TAX_CODE

VARCHAR

UNIT_OF_MEASURE

VARCHAR

Unit of measure (EA, Pack etc)

UPDATED_AT

TIMESTAMP

How did we do?

Contact