Table of Contents

BYOBI Data Dictionary - Invoice

Abigail Briggs Updated by Abigail Briggs

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

The invoice orders data is made up of two data tables

  • Invoices: this table includes all of your organisations Invoices. The data is header level, it does not include line level
  • Invoice Lines: this table includes the line level details of every invoice

Linking up with Order Data

In the Order_items table below, we provide the Purchase order number. However, if you wish to link the invoice line data with the order line data you can use the following keys to create a relationship in PowerBI

Invoice_Lines: ORDER_LINE_ID

Order_Items: ORDER_ITEM_ID

Invoices

This data table includes header level information for invoices.

Field Name

Data Type

Description

BILL_ADDRESS_CITY

VARCHAR

BILL_ADDRESS_COUNTRY

VARCHAR

BILL_ADDRESS_COUNTY

VARCHAR

BILL_ADDRESS_NAME

VARCHAR

Name associated with the billing address

BILL_ADDRESS_POSTCODE

VARCHAR

BILL_ADDRESS_STREET_1

VARCHAR

BILL_ADDRESS_STREET_2

VARCHAR

BILL_EMAIL

VARCHAR

BILL_FAX

VARCHAR

BILL_PHONE

VARCHAR

BUYER_ADDRESS_CITY

VARCHAR

BUYER_ADDRESS_COUNTRY

VARCHAR

BUYER_ADDRESS_COUNTY

VARCHAR

BUYER_ADDRESS_NAME

VARCHAR

Name of the buyer or receiving entity

BUYER_ADDRESS_POSTCODE

VARCHAR

BUYER_ADDRESS_STREET_1

VARCHAR

BUYER_ADDRESS_STREET_2

VARCHAR

BUYER_EMAIL

VARCHAR

Email address of the buyer

BUYER_FAX

VARCHAR

BUYER_ID

NUMERIC

Unique ID of the Company or Business unit the invoice has been raised for 

BUYER_PHONE

VARCHAR

CURRENCY

VARCHAR

Currency of invoice

DATE_CREATED

TIMESTAMP

Date the invoice record was created in the system

DATE_OF_INVOICE

TIMESTAMP

Date of invoice

DUE_AMOUNT

NUMERIC

Total amount to be paid

GROSS_AMOUNT

NUMERIC

Total amount including taxes

INVOICE_STATUS

NUMERIC

Current status of the invoice (e.g., Released To Buyer, Sent to Buyer, Rejected)

INVOICE_TYPE

NUMERIC

CURRENTLY IN PROGRESS - Type of invoice (e.g., Full invoice, Partial Invoice, credit note)

ISSUER_ADDRESS_CITY

VARCHAR

ISSUER_ADDRESS_COUNTRY

VARCHAR

ISSUER_ADDRESS_COUNTY

VARCHAR

ISSUER_ADDRESS_NAME

VARCHAR

Name of the supplier or issuing entity

ISSUER_ADDRESS_POSTCODE

VARCHAR

ISSUER_ADDRESS_STREET_1

VARCHAR

ISSUER_ADDRESS_STREET_2

VARCHAR

ISSUER_EMAIL

VARCHAR

ISSUER_PHONE

VARCHAR

NET_AMOUNT

NUMERIC

Total amount excluding taxes

NVOICE_ID

NUMERIC

Unique identifier for the invoice record (Primary key)

REJECTION_REASON

VARCHAR

Reason the invoice was rejected (if applicable)

REMIT_ADDRESS_CITY

VARCHAR

REMIT_ADDRESS_COUNTRY

VARCHAR

REMIT_ADDRESS_COUNTY

VARCHAR

REMIT_ADDRESS_NAME

VARCHAR

Name associated with the remittance address (where payments are sent)

REMIT_ADDRESS_POSTCODE

VARCHAR

REMIT_ADDRESS_STREET_1

VARCHAR

REMIT_ADDRESS_STREET_2

VARCHAR

REMIT_EMAIL

VARCHAR

REMIT_FAX

VARCHAR

REMIT_PHONE

VARCHAR

SHIPPING_AMOUNT

NUMERIC

SUBTOTAL_AMOUNT

NUMERIC

Total amount before taxes

SUPPLIER_ID

NUMERIC

Unique identifier of the supplier issuing the invoice

SUPPLIER_INVOICE_NUMBER

VARCHAR

Invoice number/reference provided by the supplier

SUPPLIER_VAT_NUMBER

VARCHAR

Invoice Lines

This includes the line level details for each invoice raised. An automatic relationship has been set up with the above Invoice table so that you can extract both invoices and invoice lines data

Field Name

Data Type

Description

CURRENCY

VARCHAR

Currency on the invoice

CUSTOMER_REF

NUMERIC

Customer unique reference 

GROSS_AMOUNT

NUMERIC

Line Gross amount 

INVOICE_ID

NUMERIC

Unique identifier of the parent invoice to which this line belongs (Foreign key to the invoice table)

INVOICE_LINE_NUMBER

NUMERIC

Sequential number identifying the line within the invoice (For XML invoices line number is specified by the supplier, for PO Flip invoices specified by the order of the lines on the invoice)

INVOICE_LINES_ID

NUMERIC

Unique identifier for the invoice line record (Primary Key)

ITEM_DESCRIPTION

VARCHAR

Description of the goods or services provided (Specified by the supplier on XML invoices)

LINKED_LINE_ID

NUMERIC

NET_AMOUNT

NUMERIC

Line net amount

ORDER_LINE_ID

NUMERIC

Unique identifier for the associated purchase order line (Foreign key to the ORDER_ITEM_ID in the order_items table

ORDER_LINE_NUMBER

VARCHAR

PO_ID

NUMERIC

Internal system purchase order identifier (Foreign key to the Purchase Orders table)

PURCHASE_ORDER_NUM

VARCHAR

External purchase order number associated with the invoice line

QUANTITY

NUMERIC

Number of units invoiced for this line item

SUBTOTAL_AMOUNT

NUMERIC

Line sub-total amount 

SUPPLIER_COMMENTS

VARCHAR

SUPPLIER_PART_NUMBER

VARCHAR

Supplier’s reference or part number for the item

TAX_AMOUNT

NUMERIC

Line tax amount

TAX_CODE

VARCHAR

Line Tax code (Tax code is taken from the Purchase order for PO Flip Invoices. For XML, it relies on supplier sending it). 

TAX_RATE

NUMERIC

Tax rate i.e. the percentage

UNIT_OF_MEASURE

VARCHAR

Unit of measure for the item 

UNIT_PRICE

NUMERIC

Price per unit of the item or service

Invoice Errors

This table provides a list of errors where the invoice has been rejected.

Field Name

Data Type

Description

CUSTOMER_REF

VARCHAR

Customer reference name

ERROR_KEY

NUMERIC

Error on invoice for example Incorrect total. This can be used in combination with the PROPERTY_NAME which identifies which field the error is associated with on the invoice

INVOICE_ERRORS_ID

NUMERIC

Unique ID for the error

INVOICE_ID

VARCHAR

ID of the invoice which links with the invoice ID in the INVOICES and INVOICES_LINES tables

ORGANISATION_REF

VARCHAR

Customer reference name

PROPERTY NAME

VARCHAR

Field/property that the error is associated with, for example Gross total, or Invoicelines[0].netamount

Invoice Tax Details

This table provides the summary level tax information of an invoice

Field Name

Data Type

Description

CURRENCY

VARCHAR

Currency on the invoice

CUSTOMER_REF

VARCHAR

Customer reference name

INVOICE_ID

NUMERIC

ID of the invoice which links with the invoice ID in the INVOICES and INVOICES_LINES tables

INVOICE_TAX_DETAILS_ID

NUMERIC

Unique ID for the tax details associated with each invoice

ORGANISATION_REF

VARCHAR

Customer reference name

PERCENTAGE_RATE

NUMERIC

Percentage rate for Tax i.e. 0% or 20% shown as numerical value 0 or 20.0

SHIPPING_TAX

NUMERIC

N/A

TAX_AMOUNT

NUMERIC

Tax Amount at summary level of the invoice

TAX_CODE

VARCHAR

Tax code on the invoice. In many cases unlikely to be populated as the supplier will provide just the tax amount and percentage rate

TAXABLE_AMOUNT

NUMERIC

The amount on the invoice which is taxable 

How did we do?

BYOBI Data Dictionary - Purchase Orders & Order Lines
means we never load the third-party hCaptcha script once Cap is on, and the server (contact.go) likewise skips the hCaptcha check when Cap is active. }}

Contact