Skip to content
Contact us
  • There are no suggestions because the search field is empty.

Report Writer Data Dictionary (2)

Field definitions for the report bases from the Report Center - Part 2

Report Data Dictionary (2)

Definitions for fields in report bases in the Report Builder.

Reports:
Allocation Offering
Payment Detail
Sales Tax by State
TPI Report
Will Call Report

Don't see the report you're looking for? Check Report Writer Data Dictionary (1) or Report Writer Data Dictionary (3)

Allocation Offering

Address | Address listed for primary address in member record.

  • Address 2
  • Address 2 listed for primary address in member record.
  • AllocationEndDate
  • Allocation end date listed in allocation record.
  • AllocationName
  • Name of Allocation assigned to member (one line for each allocation assigned to member).
  • AllocationStartDate
  • Allocation start date listed in allocation record
  • City
  • City listed for primary address in member record.
  • Company
  • Company listed for primary address in member record.
  • Email
  • Email listed for primary address in member record.
  • FirstName
  • First name listed for primary address in member record.
  • HasAllocationRemaining?
  • This indicates that the member does or does not have any bottles remaining in this allocation. (yes/no)
  • HasPurchased?
  • This indicates whether the member has purchased from the specific allocation. (yes/no)
  • IsAllocationActive?
  • Is allocation marked as active in allocation record? (yes/no)
  • LastName
  • Last name listed for primary address in member record.
  • Phone
  • Phone number listed for primary address in member record.
  • ShippingAddress
  • Address listed for shipping address in member record
  • ShippingAddress2
  • Address 2 listed for shipping address in member record
  • ShippingAddress2
  • Address 2 listed for shipping address in member record.
  • ShippingCity
  • City listed for shipping address in member record
  • ShippingCompany
  • Company listed for shipping address in member record
  • ShippingEmail
  • Email listed for shipping address in member record
  • ShippingFirstName
  • First name listed for shipping address in member record
  • ShippingLast Name
  • Last name listed for shipping address in member record
  • ShippingPhone
  • Phone number listed for shipping address in member record
  • ShippingState
  • State listed for shipping address in member record
  • ShippingZip
  • Zip code listed for shipping address in member record
  • State
  • State listed for primary address in member record.
  • ZipCode
  • Zip code listed for primary address in member record.


Payment Detail

BillEmail | Email listed for billing address on General tab of member record.

  • BillFirstName
  • First name listed for billing address on General tab of member record.
  • BillLastName
  • Last name listed for billing address on General tab of member record.
  • CreditCardType
  • Type of credit card used for the order (Visa, Master Card, etc.)
  • DateCompleted
  • Date the order was completed
  • IsRefunded?
  • Has the order been refunded? (yes/no)
  • IsVoided?
  • Has the order been voided? (yes/no)
  • OrderNumber
  • Order number
  • OrderTotal
  • Order total (subtotal + tax + freight + handling). This is the amount the member was charged.
  • OrderType
  • Order type (Club, Admin, Allocation, etc.)
  • PaymentType
  • Type of payment (credit card, cash, check, etc.)


Sales Tax by State

TaxFree? | This pulls from the "Is Taxable" flag in the product profile. "NO" indicates that this product IS NOT "tax free" aka taxable. Most products are going to be taxable, the exception would be things like line item shipping or food products.

  • ShippingZipCode
  • Order shipping zip code
  • ShippingProvince
  • Order shipping province
  • ShippingCountry
  • Order shipping country
  • Refunded?
  • Has the order been refunded? (yes/no)
  • RefundDate
  • Date refund was created
  • RefundAmount
  • Amount refunded
  • OrderType
  • Order type (Store, Admin, POS, etc.)
  • OrderTotal
  • Order total (Subtotal + Tax + Shipping; the amount charged)
  • OrderTaxableHandling
  • Amount of taxable handling charged on the order
  • OrderSubtotal
  • Order subtotal (sum of all products in order after discounts but before taxes or shipping)
  • OrderShipping
  • Shipping charged on the order
  • NetOrderTotal
  • Order total less refunds
  • BillingProvince
  • Order billing province
  • BillingCountry
  • Order billing country
  • OrderDateCompleted
  • Date order was created
  • OrderNumber
  • Order number
  • OrderNumberPrefix
  • Order number prefix (RMS, RSV)
  • OrderTaxes
  • Taxes charged on order
  • RefundOrderNumber
  • Refund order number (-R1, -R2, etc)
  • ShippingState
  • Order shipping state
  • OrderStatus
  • Order status (Complete, Pending, Cancelled, etc)


TPI Report

OrderNumber | Order Number

  • Datecompleted
  • Date order was completed
  • ProductSKU
  • Product SKU
  • ProductName
  • Product Name
  • Quantity
  • Quantity of bottles or cases
  • U/M
  • Stands for "unit of measure". It corresponds to the bottle size for wine and the unit size for non-wine items.
  • Price
  • Price per unit
  • SubTotal
  • Order subtotal (total of products in order before tax, freight, handling)
  • CartStatus
  • Order status (Completed, Pending, Quarantined, etc.)
  • Taxable?
  • This field is ALWAYS hardcoded to = "NO".

    Note: Quickbooks deals with this field     differently than the admin panel.
  • TenderType
  • Type of payment (credit card, cash, check, etc.)
  • CardType
  • Type of credit card (Visa, Master Card, etc.)
  • ShippingType
  • Shipping type selected for order
  • BillFullName
  • Order billing first and last name
  • BillFirstName
  • Order billing first name
  • BillLastName
  • Order billing last name
  • BillAddress
  • Order billing address
  • BillCity
  • Order billing city
  • BillState
  • Order billing state
  • BillZipCode
  • Order billing zip code
  • ShipFullName
  • Order shipping first and last name
  • ShipFirstName
  • Order shipping first name
  • ShipLastName
  • Order shipping last name
  • ShipAddress
  • Order shipping address
  • ShipCity
  • Order shipping city
  • ShipState
  • Order shipping state
  • ShipZipCode
  • Order shipping zip code
  • ActiveClubMember
  • Is this member active in a club? (yes/no)
  • CustomerNumber
  • Customer number as listed in 'Member No.' field of member profile
  • OrderType
  • Order type (Club, Admin, Allocation,etc.)
  • LineItem
  • 1=product, 2=sales tax, 3=freight, 4=handling


Will Call Report

TenderType | Payment type (credit card, check, invoice, etc.)

  • ShipCode
  • Lists shipping option's CODE and TYPE (as designated in the Shipping Type). Code corresponds to
    the ShipCompliant code for that particular carrier type.
  • RefundReason
  • If a Refund, lists the Refund Reason selected at the time the refund was created.*
  • RefundedBy
  • Lists the admin user who created the refund
  • Refunded?
  • Was the order refunded? (yes/no)
  • RefundDate
  • Date refund was created
  • OrderNotes
  • Notes added to the order by the member (or admin user, if OMS order) at the time the order was created. These notes can be found on the Summary page of the order. These are not the system notes added to the 'Notes' Tab of the order.
  • CustomOrderCheckBoxChecked?
  • Is the custom order checkbox checked? (yes/no)**
  • CreditCardType
  • Type of credit card used on the order (Visa, Master Card, etc.)
  • ClubLevel
  • Lists the club level IF the order is a club order.
  • ClubBatchNumber
  • Lists the club batch number IF the order is a club order.
  • ClubBatch
  • Lists the club batch name IF the order is a club order
  • BillingZipCode
  • Order billing zip code
  • BillingState
  • Order billing state
  • BillingBirthdate
  • Order billing birthdate
  • BillingAddress2
  • Order billing address 2
  • BillingAddress
  • Order billing address
  • Billing City
  • Order billing city
  • BillingCompany
  • Order billing company
  • BillingEmail
  • Order billing email
  • BillingFirstName
  • Order billing first name
  • BillingLastName
  • Order billing first name
  • BillingPhone
  • Order billing phone
  • OrderDateCompleted
  • Date order was completed
  • OrderNumber
  • Order number
  • OrderNumberPrefix
  • Order number prefix (RMS)
  • OrderStatus
  • Order status (Complete, Pending, Quarantined, etc.)
  • OrderTotal
  • Order total (Subtotal + Tax + Shipping; the amount charged)
  • OrderType
  • Order type (Store, Admin, POS, etc.)
  • WillCallPickedUp?
  • Was this order picked up? (as indicated by the 'Picked Up' checkbox on the order Summary tab) (yes/no)
  • RefundOrderNumber
  • Refund order number (-R1, -R2, etc; this indicates that it is the first refund against an order (R1), the second (R2), etc. )
  • WillCall?
  • Is this a Will Call order? (yes/no)
  • WillCallLocation
  • Lists the Will Call option's COMPANY (as designated in the Shipping Type)
  • Notes:
  • *Refund Reasons can be created by going to Settings>>Return/Refund Reasons in the admin panel.
  • **The custom order check box can be enabled under the Settings icon in the admin panel and will add a checkbox to the Summary tab of orders similar to the 'Picked Up?' checkbox that appears for Will Call orders, except it will appear on all orders.