CreateInvoice

The CreateInvoice method generates an invoice with one or multiple line items that you can send via SMS or Email to the customer's specified mobile number and/or email address. Upon payment, the customer may also receive a text thank you note and/or email receipt.

🚧

Calculate Dollar Amounts First

Note: Dollar amounts must be calculated before entering. This API is not programmed to calculate amounts, only to display them on invoices as directed.

🚧

Partial Payments

Note: If additional fees are required, outside the normal purchase total, then partial payments are not permitted. Everyware supports partial payments, however the full balances due must be calculated and maintained by the individual business.

πŸ‘

Fee & Tax Settings

Note: Fee and tax settings are editable in the Everyware portal, but not through this API.

πŸ‘

Amount Formatting

For any dollar amount fields, format without dollar signs.

Ex: β€œ5.00” = 5

Access URL: https://rest.everyware.com/api/Default/CreateInvoice

Inbound Parameters

See Below - Enter individual line items into LineItem. Enter string of line items into LineItems.

Parameter NameDescriptionRequired/Not
LineItemsCollectionofLineItems (See individual Line Item parameters below)REQUIRED
BusinessNameName of business billing the customer. Appears at the top of the invoice and email receipt.REQUIRED
BusinessIdOptional ID Everyware can store for the business charging the customer. Does not appear on invoice.OPTIONAL
AccountNumberOptional customer/business account number to be store by Everyware.OPTIONAL
AccountNumber2Optional customer/business account number to be store by Everyware.OPTIONAL
OrderNumberThis is the unique identifier used to reference the invoice. It appears on the invoice and in the Payments Report in Everyware.

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

(Formerly named InvoiceID)
OPTIONAL
If left blank, Everyware will generate a number for you.
StatementDateThe 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.
OPTIONAL
BillToNameThe customer first and last name who is being billedOPTIONAL
BillToAddress1The first line of the billing address for the customer/contact being billedOPTIONAL
BillToAddress2The second line of the billing address for the customer/contact being billedOPTIONAL
BillToCityThe city for the billing address for the customer/contact being billed.OPTIONAL
BillToStateThe state for the billing address for the customer/contact being billed. *Should be two letters, Texas = β€œTX”OPTIONAL
BillToZipThe zip or postal code for the billing address for the customer/contact being billed.REQUIRED
BillToCellPhoneMobile phone number of customer, provided in 10 digit format: 3055551212.

Must be a valid mobile number or the transaction will be declined
REQUIRED
BillToEmailAddressEmail address where you want the customer to receive Pay by Email invoices.OPTIONAL
BusinessAddress1Address Line 1 for business sending the invoice. This will appear at the bottom of the payment receipt.REQUIRED
BusinessAddress2Address Line 2 for business sending the invoice. This will appear at the bottom of the payment receipt.OPTIONAL
BusinessCityCity for business sending the invoice. This will appear at the bottom of the payment receipt.REQUIRED
BusinessStateState for business sending the invoice. *Should be two letters, Texas = β€œTX”. This will appear at the bottom of the payment. receipt.REQUIRED
BusinessPostalCodeZip or postal code for business sending the invoice. This will appear at the bottom of the payment receipt.REQUIRED
BusinessPhoneMain 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.
REQUIRED
BusinessEmailEmail Address for business sending the invoice.

This is also the address receipts will appear to come from after customers make payments.
REQUIRED
SubtotalDollar amount for subtotal of all LineItems to not including Taxes and Fees.REQUIRED
ConvenienceFeeDollar 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.
OPTIONAL
DeliveryFeeDollar 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.
OPTIONAL
CustomFee1Dollar 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.
OPTIONAL
CustomFee2Dollar 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.
OPTIONAL
TaxDollar 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.
OPTIONAL
TotalAmountDueEnter dollar amount owed after Subtotal, Taxes, and Fees are calculated.REQUIRED
TipTrue 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.OPTIONAL
ScheduledDateThe 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.OPTIONAL
ExpirationDateDate the invoice link expires.

If a customer clicks the invoice link after it expires they'll see a message saying the invoice has expired and to contact the merchant.
OPTIONAL
BatchIdUnique external billing batch identifier for groups of invoices sent that need to be identified together. Everyware will also generate an Everyware BatchId which will appear in your response and in the portal Batch Report table.OPTIONAL
SendSMSInvoiceTrue 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.
REQUIRED
IsPartialPaymentTrue 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.
REQUIRED
ExternalIdA unique identifier for the invoice you provide, which Everyware will store.OPTIONAL
PreviousSMSIdEnter the unique SMSId from one CreateInvoice response to redirect from that SMS to a future invoice SMS. See Sample B below for more.OPTIONAL

Inbound Parameters - Per Line Item

LineItem Parameter NameLineItemParameter DescriptionRequired/Not
DescriptionName of line item, the product or service you’re charging for. It will appear on the receipt.REQUIRED
QuantityNumber of Items *REQUIRED
AmountEachPrice per item*REQUIRED
SubtotalTotal amount charged for line item before taxes and fees*REQUIRED

CreateInvoice Use Case 1: Create and Send an Invoice

For merchants who want to send an invoice by text and email containing a single line item, which does not allow for partial payment, and includes an invoice 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",
}
{
    "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": ""
}

CreateInvoice Use Case 2: Send & Accept Partial Payment on an Invoice

For merchants who need to send an invoice, allow the customer to make a partial payment toward the total amount due, and later when the customer clicks the original invoice link, they are redirect to an updated invoice displaying the remaining amount due.

  1. The first CreateInvoice call results in an invoice for 3 line items that is texted and emailed to the customer. The invoice will allow for a partial payment.

  2. After the customer pays a partial amount toward the total due on the first invoice, use the first invoice's SMSID in the second call's PreviousSMSID parameter.

{
    "BusinessName": "Hello Sunshine Inc",
    "LineItems": [
        {
            "Description": "January Bill $1.00 ",
            "Quantity": "1",
            "AmountEach": "1.00",
            "Total": "1.00"
        },
        {
            "Description": "Feb Bill",
            "Quantity": "1",
            "AmountEach": "1.00",
            "Total": "1.00"
        },
        {
            "Description": "March Bill",
            "Quantity": "1",
            "AmountEach": "1.00",
            "Total": "1.00"
        }
    ],
    "Subtotal": "3.00",
    "TotalAmountDue": "3.00",
    "SendSMSInvoice": true,
    "SendEmailInvoice": true,
    "IsPartialPayment": true,
    "OrderNumber": "11112021",
    "BillToName": "Whit Testing",
    "BilltoExternalID": "Test",
    "BillToCellPhone": "5555555555",
    "BillToEmailAddress": "[email protected]",
    "ScheduledDate": "11-11-2021",
    "ExpirationDate": "12-01-2021",
    "DueDate": "11-30-2021",
    "BusinessEmail": "[email protected]",
    "BillToAddress1": "701 Brazos St",
    "BusinessPhone": "5555555555",
    "BillToAddress2": "",
    "BillToCity": "Austin",
    "BillToState": "TX",
    "BillToZip": "78701",
    "PreviousSMSID":""
}
{
    "IsSuccess": true,
    "Message": "Your Pay By Email invoice has been successfully created.",
    "Data": "Do you want to use the card ending in 2159 for $3.00? Enter yes or no. https://mdpaybill.net/6C492AD6",
    "OrderNumber": "11112021",
    "SMSID": "479038"
}
{
    "BusinessName": "Hello Sunshine Inc",
    "LineItems": [
        {
            "Description": "PAID January Bill $1.00 ",
            "Quantity": "1",
            "AmountEach": "0.00",
            "Total": "0.00"
        },
        {
            "Description": "Feb Bill",
            "Quantity": "1",
            "AmountEach": "1.00",
            "Total": "1.00"
        },
        {
            "Description": "March Bill",
            "Quantity": "1",
            "AmountEach": "1.00",
            "Total": "1.00"
        }
    ],
    "Subtotal": "2.00",
    "TotalAmountDue": "2.00",
    "SendSMSInvoice": false,
    "SendEmailInvoice": false,
    "IsPartialPayment": false,
    "OrderNumber": "11112021",
    "BillToName": "Whit Testing",
    "BilltoExternalID": "Test",
    "BillToCellPhone": "5555555555",
    "BillToEmailAddress": "[email protected]",
    "ScheduledDate": "11-11-2021",
    "ExpirationDate": "12-01-2021",
    "DueDate": "11-30-2021",
    "BusinessEmail": "[email protected]",
    "BillToAddress1": "701 Brazos St",
    "BusinessPhone": "5555555555",
    "BillToAddress2": "",
    "BillToCity": "Austin",
    "BillToState": "TX",
    "BillToZip": "78701",
    "PreviousSMSID":"479038"
  
}
{
    "IsSuccess": true,
    "Message": "Your Pay By Text invoice has been successfully created.",
    "Data": "https://mdpaybill.net/E83CF150",
    "OrderNumber": "11112021",
    "SMSID": "479040"
}