Creating an Invoice

Access Endpoint URL: https://rest.everyware.com/api/Default/CreateInvoice[POST]

The CreateInvoice method generates an invoice with one or multiple line items that you can send via text 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

Inbound Parameters

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

Parameter Name	Description	Required/Not
LineItems	CollectionofLineItems (See individual Line Item parameters below)	REQUIRED
BusinessName	Name of business billing the customer. Appears at the top of the invoice and email receipt.	REQUIRED
BusinessId	Optional ID Everyware can store for the business charging the customer.	OPTIONAL
AccountNumber	Optional customer/business account number to be stored by Everyware.	OPTIONAL
AccountNumber2	Optional customer/business account number to be stored by Everyware.	OPTIONAL
OrderNumber	This 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.
StatementDate	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.	OPTIONAL
BillToName	The customer first and last name who is being billed	OPTIONAL
BillToAddress1	The first line of the billing address for the customer/contact being billed	OPTIONAL
BillToAddress2	The second line of the billing address for the customer/contact being billed	OPTIONAL
BillToCity	The city for the billing address for the customer/contact being billed.	OPTIONAL
BillToState	The state for the billing address for the customer/contact being billed. *Should be two letters, Texas = “TX”	OPTIONAL
BillToZip	The zip or postal code for the billing address for the customer/contact being billed.	REQUIRED
BillToCellPhone	Mobile phone number of customer, provided in 10 digit format: 3055551212. Must be a valid mobile number or the transaction will be declined	REQUIRED
BillToEmailAddress	Email address where you want the customer to receive Pay by Email invoices.	OPTIONAL
BusinessAddress1	Address Line 1 for business sending the invoice. This will appear at the bottom of the payment receipt.	REQUIRED
BusinessAddress2	Address Line 2 for business sending the invoice. This will appear at the bottom of the payment receipt.	OPTIONAL
BusinessCity	City for business sending the invoice. This will appear at the bottom of the payment receipt.	REQUIRED
BusinessState	State for business sending the invoice. *Should be two letters, Texas = “TX”. This will appear at the bottom of the payment. receipt.	REQUIRED
BusinessPostalCode	Zip or postal code for business sending the invoice. This will appear at the bottom of the payment receipt.	REQUIRED
BusinessPhone	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.	OPTIONAL
BusinessEmail	Email Address for business sending the invoice, which appears on the the payment receipt and in the From line of email receipts, if enabled.	OPTIONAL
Subtotal	Dollar amount for subtotal of all LineItems to not including Taxes and Fees.	REQUIRED
ConvenienceFee	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.	OPTIONAL
DeliveryFee	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.	OPTIONAL
CustomFee1	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.	OPTIONAL
CustomFee2	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.	OPTIONAL
Tax	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.	OPTIONAL
TotalAmountDue	Enter dollar amount owed after Subtotal, Taxes, and Fees are calculated.	REQUIRED
Tip	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.	OPTIONAL
ScheduledDate	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.	OPTIONAL
ExpirationDate	Date 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
BatchId	Unique 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
SendSMSInvoice	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.	REQUIRED
IsPartialPayment	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.	REQUIRED
BillToExternalId	A unique identifier for the invoice you provide, which Everyware will store.	OPTIONAL
PreviousSMSId	Enter 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 Name	LineItemParameter Description	Required/Not
Description	Name of line item, the product or service you’re charging for. It will appear on the receipt.	REQUIRED
Quantity	Number of Items *	REQUIRED
AmountEach	Price per item*	REQUIRED
Subtotal	Total amount charged for line item before taxes and fees*	REQUIRED

Sample 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": "12345",
    "ExternalID":"",
    "Subtotal": "1.00",
    "TotalAmountDue": "1.00",
    "SendSMSInvoice": true,
    "SendEmailInvoice": true,
    "IsPartialPayment": false,
    "BillToCellPhone": "5125551212",
    "BillToName": "John Doe",
    "BillToAddress1": "100 Test Street",
    "BillToAddress2": "",
    "BillToCity": "Austin",
    "BillToState": "TX",
    "BillToZip": "78701",
    "ScheduledDate": "10-13-2021",
    "ExpirationDate": "12-31-2021",
    "DueDate": "10-31-2021"
}

curl --location 'https://rest.everyware.com/api/Default/CreateInvoice' \
--header 'Authorization: Basic [xxx]' \
--header 'Content-Type: application/json' \
--data-raw ' {

   "BusinessName": "Hello Sunshine Automotive",
    "LineItems": [
        {
            "Description": "Automotive Sample Line Item",
            "Quantity": 1,
            "AmountEach": "1.00",
            "Total": "1.00"
        }
    ],
    "OrderNumber": "12345",
    "ExternalID":"",
    "Subtotal": "1.00",
    "TotalAmountDue": "1.00",
    "SendSMSInvoice": true,
    "SendEmailInvoice": true,
    "IsPartialPayment": false,
    "BillToCellPhone": "5125551212",
    "BillToName": "John Doe",
    "BillToAddress1": "100 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": ""
}

Sample 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.

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.
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"
}