Creating an Invoice Batch

    If left blank, Everyware will generate a number for you.  

    (Formerly named InvoiceID)
  </td><td>
    OPTIONAL\
    If left blank, Everyware will generate a number for you.
  </td></tr><tr><td>
    StatementDate
  </td><td>
    The date the of the billing statement.  

    If left blank, will auto populate with date the invoice is sent/generated by email or text via Everyware.
  </td><td>
    OPTIONAL
  </td></tr><tr><td>
    BillToName
  </td><td>
    The customer/contact first and last name who is being billed
  </td><td>
    OPTIONAL
  </td></tr><tr><td>
    BillToAddress1
  </td><td>
    The first line of the billing address for the customer/contact being billed
  </td><td>
    OPTIONAL
  </td></tr><tr><td>
    BillToAddress2
  </td><td>
    The second line of the billing address for the customer/contact being billed
  </td><td>
    OPTIONAL
  </td></tr><tr><td>
    BillToCity
  </td><td>
    The city for the billing address for the customer/contact being billed.
  </td><td>
    OPTIONAL
  </td></tr><tr><td>
    BillToState
  </td><td>
    The state for the billing address for the customer/contact being billed. \*Should be two letters, Texas = “TX”
  </td><td>
    OPTIONAL
  </td></tr><tr><td>
    BillToZip
  </td><td>
    The zip or postal code for the billing address for the customer/contact being billed.
  </td><td>
    REQUIRED
  </td></tr><tr><td>
    BillToCellPhone
  </td><td>
    Mobile phone number of customer, provided in 10 digit format: 3055551212.  

    **Must be a valid mobile number or the transaction will be declined**
  </td><td>
    REQUIRED
  </td></tr><tr><td>
    BillToEmailAddress
  </td><td>
    Email address where you want the customer to recieve Pay by Email invoices.
  </td><td>
    OPTIONAL
  </td></tr><tr><td>
    BusinessAddress1
  </td><td>
    Address Line 1 for business sending the invoice. This will appear at the bottom of the payment receipt.
  </td><td>
    REQUIRED
  </td></tr><tr><td>
    BusinessAddress2
  </td><td>
    Address Line 2 for business sending the invoice. This will appear at the bottom of the payment receipt.
  </td><td>
    REQUIRED
  </td></tr><tr><td>
    BusinessCity
  </td><td>
    City for business sending the invoice. This will appear at the bottom of the payment receipt.
  </td><td>
    REQUIRED
  </td></tr><tr><td>
    BusinessState
  </td><td>
    State for business sending the invoice. \*Should be two letters, Texas = “TX”. This will appear at the bottom of the payment. receipt.
  </td><td>
    REQUIRED
  </td></tr><tr><td>
    BusinessPostalCode
  </td><td>
    Zip or postal code for business sending the invoice. This will appear at the bottom of the payment receipt.
  </td><td>
    REQUIRED
  </td></tr><tr><td>
    BusinessPhone
  </td><td>
    Main phone number (landline or mobile) for business sending the invoice, provided in 10 digit format: 3055551212.  

    This will appear at the bottom of the emailed payment receipts and in the Business Profile.
  </td><td>
    REQUIRED
  </td></tr><tr><td>
    BusinessEmail
  </td><td>
    Email Address for business sending the invoice.  

    This is also the address receipts will appear to come from after customers make payments.
  </td><td>
    REQUIRED
  </td></tr><tr><td>
    Subtotal
  </td><td>
    Dollar amount for subtotal of all LineItems to not including Taxes and Fees.
  </td><td>
    REQUIRED
  </td></tr><tr><td>
    ConvenienceFee
  </td><td>
    Dollar amount for an optional Convenience Fee. A fee for which settings can be adjusted in the Everyware portal.  

    If left blank or $0.00, line item will not appear.
  </td><td>
    OPTIONAL
  </td></tr><tr><td>
    DeliveryFee
  </td><td>
    Dollar amount for optional Delivery Fee line item. A fee  type which can be activated and adjusted in the Everyware portal.  

    If left blank or $0.00, line item will not appear.
  </td><td>
    OPTIONAL
  </td></tr><tr><td>
    CustomFee1
  </td><td>
    Dollar amount for optional Custom Fee 1 line item. A fee  type which can be activated, labeled, and adjusted in the Everyware portal.  

    If left blank or $0.00, line item will not appear.
  </td><td>
    OPTIONAL
  </td></tr><tr><td>
    CustomFee2
  </td><td>
    Dollar amount for optional Custom Fee 2 line item . A fee  type which can be activated, labeled, and adjusted in the Everyware portal.  

    If left blank or $0.00, line item will not appear.
  </td><td>
    OPTIONAL
  </td></tr><tr><td>
    Tax
  </td><td>
    Dollar amount for Taxes to be charged. Tax settings can be adjusted in the Everyware portal.  

    If left blank or $0.00, line item will not appear.
  </td><td>
    OPTIONAL
  </td></tr><tr><td>
    TotalAmountDue
  </td><td>
    Enter dollar amount owed after Subtotal, Taxes, and Fees are calculated.
  </td><td>
    REQUIRED
  </td></tr><tr><td>
    Tip
  </td><td>
    True or False. Enter True if you want to allow the customer to add a tip upon payment. If left blank, the Tip option will be left off.
  </td><td>
    OPTIONAL
  </td></tr><tr><td>
    ScheduleDate
  </td><td>
    The date for the invoice link to be generated and (if to be sent by SMS) sent to the customer/contact. If left blank, the Pay by Text message with the invoice link will go out the same day, instantly.
  </td><td>
    OPTIONAL
  </td></tr><tr><td>
    ExpirationDate
  </td><td>
    Date the billing invoice expires. If unpaid before the ExpirationDate, the invoice will show in Pending Payments Report in Everyware. If customer attempts to pay after ExpirationDate, they will see an error message saying the invoice link has expired.
  </td><td>
    OPTIONAL
  </td></tr><tr><td>
    BatchID
  </td><td>
    Unique billing batch identifier for groups of invoices sent that need to be identified together.
  </td><td>
    OPTIONAL
  </td></tr><tr><td>
    SendSMSInvoice
  </td><td>
    True or False. If True, a text message with the invoice link will be sent.  

    If False, a link will be generated and show under Pending Payments and the you can send it by other means.
  </td><td>
    REQUIRED
  </td></tr><tr><td>
    IsPartialPayment
  </td><td>
    True or False. If True, the customer will be allowed to make a partial payment.  

    Note: If any Fees are also included partial payments will not be allowed.  

    Note: Site Settings for the account must also toggle on/off "Allow Partial Payments" to show the option if set to True.
  </td><td>
    REQUIRED
  </td></tr><tr><td>
    ExternalID
  </td><td>
    A unique identifier for the invoice you provide, which Everyware will store.
  </td><td>
    OPTIONAL
  </td></tr><tr><td>
    PreviousSMSID
  </td><td>
    Enter the unique SMSID from one CreateInvoice response to redirect from that SMS to a future invoice SMS. See Sample B below for more.
  </td><td>
    OPTIONAL
  </td></tr></tbody></table>

Inbound Parameters - Per Line Item

CreateInvoice Sample Code

1. Results in a single line item invoice, showing an everyware auto-generated invoice # (ordernumber), does not allow partial payment, is sent by email and text, with an expiration date.

{
    "BusinessName": "Hello Sunshine Automotive",
    "LineItems": [
        {
            "Description": "Automotive Sample Line Item",
            "Quantity": 1,
            "AmountEach": "1.00",
            "Total": "1.00"
        }
    ],
    "OrderNumber": "",
    "ExternalID":"",
    "Subtotal": "1.00",
    "TotalAmountDue": "1.00",
    "SendSMSInvoice": true,
    "SendEmailInvoice": true,
    "IsPartialPayment": false,
    "BillToCellPhone": "000-000-0000",
    "BillToName": "FirstName LastName",
    "BillToAddress1": "930 Test Street",
    "BillToAddress2": "",
    "BillToCity": "Austin",
    "BillToState": "TX",
    "BillToZip": "78701",
    "ScheduledDate": "10-13-2021",
    "ExpirationDate": "12-31-2021",
    "DueDate": "10-31-2021",
    "BatchID": ""
}

{
    "IsSuccess": true,
    "Message": "Your Pay By Email invoice has been successfully created.",
    "Data": "Do you want to use the card ending in 0483 for $1.00? Enter yes or no. https://pay.everyware.com/B930E609",
    "OrderNumber": ""
}