Invoices Data Mapper Export

👍

Setting up an Invoices Data Mapper enables you to export your Invoice data on a routine basis.

You can export all the data for each invoice manually through Bulk Actions on the Invoices Grid.

Setting up your Invoice Data Mapper

A Data Mapper is made up of two parts, the Connection the file is sent through and the Data Mapper which configures the export file.

📘

Click here for a the Data Mapper setup guide.

Invoice Report CSV Export Example

Here are some examples of the fields you would use to build your Invoice Report:

CSV ColumnZoey Value
Invoice StatusStatus (status)
Invoice #Increment Id (increment_id)
Order #[Order] Increment Id (increment_id)
Order Total[Order] Base Grand Total (base_grand_total)
Invoice SubtotalInvoice Base Subtotal (bill_base_subtotal)
Invoice DiscountInvoice Base Discount: Negative (bill_base_discount_negative)
Invoice Total DueInvoice Base Amount Due (bill_base_amount_due)
Invoice Total PaidInvoice Base Amount Paid (bill_base_amount_paid)
Invoice Due DateDue Date (due_date)
Payment TypePayment Method (payment_method)
Payment AmountInvoice Base Amount Paid (bill_base_amount_paid)
Payment Dates[Order] Payment Dates (payment_dates)
Shipment Dates[Order] Shipment Dates (shipment_dates)
Sales Rep[Order] Sales Rep Names (sales_rep_names)
Account Name[Order] [Account] Name (name)
Order Date[Order] [Customer] Create In (store_id | 2)

Invoice Data Mapper Fields

Below is a table of the Invoice fields and values you'll use to create your Invoice Export Data Mapper.

📘

You can export custom Attribute Values with your Invoices.

Search for them in the drop-down to add them to the Data Mapper Field Mappings.

🚧

Order and Customer fields are also available to be exported with your Invoices.

In the Zoey Value drop-down you'll find values that start with [Order] which have Order data.

Values without a label like [Order] or [Customer] will contain Invoice Data.

You can copy and paste the invoice fields below into your Data Mapper!

CSV ColumnZoey Value
Invoice NumberIncrement Id (increment_id)
Order Number[Order] Increment Id (increment_id)
Invoice IDInvoice Id (invoice_id)
Invoice Created AtCreated At (created_at)
Invoice Created byCreated By (created_by)
Invoice Net TermsInvoice Terms (_bill_netterm_term_)
Invoice Due DateDue Date (due_date)
Allowed Payment MethodsAllowed Payment Methods (allowed_payment_methods)
Invoice Payment MethodPayment Method (payment_method)
Invoice Is Paid?Is Paid (is_paid)
Invoice is Past Due?Is Past Due (is_past_due)
Invoice Is Void?Is Void (is_void)
Invoice Is Due On Receipt?Is Due On Receipt (is_due_on_receipt)
Invoice Is Marked As Paid?Is Marked As Paid (is_marked_as_paid)
Invoice Due Date is Custom?Is Custom Due Date (is_custom_due_date)
Invoice Paid By Custom Payment Method?Is Custom Payment Method (is_custom_payment_method)

Single Invoice Totals

📘

Base amounts will be displayed in the Order's Base Currency

If you allow customers to checkout in multiple different currencies, use values with the Base distinction to display the amount in the order's currency.

CSV ColumnZoey Value
Invoice SubtotalInvoice Subtotal (_bill_subtotal_)
Invoice Shipping AmountInvoice Shipping (_bill_shipping_)
Invoice Discount Amount (-)Invoice Discount (_bill_discount_)
Invoice Payment SurchargeInvoice Payment Surcharge (_bill_payment_surcharge_)
Invoice Tax AmountInvoice Tax (_bill_tax_)
Net Term Discount (Paid Early)Invoice Net Term Discount (_bill_net_term_discount_)
Net Term Late Fee (Paid Late)Invoice Net Term Late Fee (_bill_net_term_late_fee_)
Total Amount InvoicedTotal (total)

Combined Invoice Totals

The Invoice Totals are combined totals for all of the Invoices on an Order. You can print or email a Statement to show these totals to your customer. The Invoice Totals are displayed within each Order through the Zoey Admin.

Invoice Totals can be exported through the Order, Order Items, Invoice, and Invoice Items data mappers.

[Invoice Totals] Amount Due
[Invoice Totals] Base Amount Due
[Invoice Totals] Amount Past Due
[Invoice Totals] Base Amount Past Due
[Invoice Totals] Amount Paid
[Invoice Totals] Base Amount Paid
[Invoice Totals] Amount Refunded
[Invoice Totals] Base Amount Refunded
[Invoice Totals] Grand Total
[Invoice Totals] Base Grand Total

Advanced Filters

You can choose to export Invoices based on their:

  • Created At
  • Due Date
  • Invoice State
  • Invoice Status
  • Invoice Payment Method