event

string

The event received by the webhook (e.g., “OrderInvoiced”).

eventType

string

The type of event received by the webhook (e.g., “OrderInvoiced”).

webhookDetails

array

The object describing the webhook details.

webhookDetails[].apiKey

string

The API key or “secret” for the registered webhook.

webhookDetails[].webhookUrl

string

The URL of the registered webhook.

webhookDetails[].domain

string

The event domain of the registered webhook.

webhookDetails[].registeredEvents

array

The customer-provided purchase order number of the invoiced order.

data

object

The object containing the invoice data.

data.storeFront

string

The storefront where the order was invoiced (e.g., “abc”, “lw”).

data.invoiceNumber

string

The unique invoice number for the invoice.

data.invoiceDate

string

The date the order was invoiced.

data.orderNumber

string

The order number of the invoiced order.

data.orderName

string

The order or job name of the invoiced order.

data.orderDate

string

The date the invoiced order was placed.

data.purchaseOrderNumber

string

The customer-provided purchase order number of the invoiced order.

data.salesType

string

The sales type for the order.

data.salesRep

object

The object describing the sales representative info for the order.

data.salesRep.userId

string

The unique user ID of the sales representative (null if not assigned).

data.salesRep.fullName

string

The full name of the sales representative.

data.soldTo

object

The object describing the customer Sold-To account.

data.soldTo.number

string

The Sold-To account number.

data.soldTo.name

string

The Sold-To account name.

data.soldTo.addressLine1

string

The Sold-To account address line 1.

data.soldTo.addressLine2

string

The Sold-To account address line 2.

data.soldTo.addressLine3

string

The Sold-To account address line 3.

data.soldTo.city

string

The Sold-To account city.

data.soldTo.state

string

The Sold-To account state.

data.soldTo.country

string

The Sold-To account country.

data.soldTo.postal

string

The Sold-To account postal code.

data.billTo

object

The object describing the customer Bill-To account.

data.billTo.number

string

The Bill-To account number.

data.billTo.name

string

The Bill-To account name.

data.billTo.addressLine1

string

The Bill-To account address line 1.

data.billTo.addressLine2

string

The Bill-To account address line 2.

data.billTo.addressLine3

string

The Bill-To account address line 3.

data.billTo.city

string

The Bill-To account city.

data.billTo.state

string

The Bill-To account state.

data.billTo.country

string

The Bill-To account country.

data.billTo.postal

string

The Bill-To account postal code.

data.shipTo

object

The object describing the customer Ship-To account.

data.shipTo.number

string

The Ship-To account number.

data.shipTo.name

string

The Ship-To account name.

data.shipTo.addressLine1

string

The Ship-To account address line 1.

data.shipTo.addressLine2

string

The Ship-To account address line 2.

data.shipTo.addressLine3

string

The Ship-To account address line 3.

data.shipTo.city

string

The Ship-To account city.

data.shipTo.state

string

The Ship-To account state.

data.shipTo.country

string

The Ship-To account country.

data.shipTo.postal

string

The Ship-To account postal code.

data.branch

object

The object describing the ABC Supply branch.

data.branch.number

string

The ABC Supply branch number.

data.branch.name

string

The ABC Supply branch name.

data.branch.addressLine1

string

The ABC Supply branch address line 1.

data.branch.addressLine2

string

The ABC Supply branch address line 2.

data.branch.city

string

The ABC Supply branch city.

data.branch.state

string

The ABC Supply branch state.

data.branch.country

string

The ABC Supply branch country.

data.branch.postal

string

The ABC Supply branch postal code.

data.branch.phone

string

The ABC Supply branch phone number.

data.shipment

object

The object describing the shipment details.

data.shipment.shipmentDate

string

The date the order was shipped.

data.shipment.delivery

string

The object describing the delivery details of the shipment.

data.shipment.delivery.name

string

The shipment delivery name.

data.shipment.delivery.addressLine1

string

The shipment delivery address line 1.

data.shipment.delivery.addressLine2

string

The shipment delivery address line 2.

data.shipment.delivery.addressLine3

string

The shipment delivery address line 3.

data.shipment.delivery.city

string

The shipment delivery city.

data.shipment.delivery.state

string

The shipment delivery state.

data.shipment.delivery.country

string

The shipment delivery country.

data.shipment.delivery.postal

string

The shipment delivery postal code.

data.subTotal

float

The subtotal for the invoice.

data.taxAmount

flaot

The tax amount for the invoice.

data.total

float

The total for the invoice.

data.lines

array

The list of line items included in the invoice.

data.lines[].id

number

The line item id.

data.lines[].itemNumber

string

The item number for the line item.

data.lines[].itemType

string

The item type of the line item.

data.lines[].isDimensional

boolean

A boolean stating whether or not the item is a dimensional item.

data.lines[].itemDescription

string

The item description of the line item.

data.lines[].orderedQty

object

The object containing the ordered quantity details for the line item.

data.lines[].orderedQty.value

integer

The ordered quantity value of the line item.

data.lines[].orderedQty.uom

string

The ordered quantity unit of measure of the line item.

data.lines[].shippedQty

object

The object containing the shipped quantity details for the line item.

data.lines[].shippedQty.value

integer

The shipped quantity value of the line item.

data.lines[].shippedQty.uom

string

The shipped quantity unit of measure of the line item.

data.lines[].priceQty

object

The object containing the price quantity details for the line item.

data.lines[].priceQty.value

integer

The price quantity value of the line item.

data.lines[].priceQty.uom

string

The price quantity unit of measure of the line item.

data.lines[].priceQty.priceConversionFactor

float

The price quantity price conversion factor of the line item.

data.lines[].pricePerUnitAmount

float

The price per unit amount of the line item.

data.lines[].extendedPriceAmount

float

The extended price amount of the line item.

isCreditMemo

boolean

A boolean stating whether or not the invoice is a credit memo.

isRebill

boolean

A boolean stating whether or not the invoice is a rebill for a shipment.

originalInvoiceReference

string

The original invoice number if the order is a credit memo or rebill.

creditRebillReason

string

The provided reason for a rebill invoice, if applicable.