Everyware DocsAPI Base URL
All documentation

Send Invoice

Access Endpoint URL: https://rest.everyware.com/InvoicingOnly/SendInvoice [POST]

Summary

You can use the SendInvoice method to place a non-Everyware invoice into our database, where it will be queued for later delivery via message.

Inbound Parameters

Parameters should be passed in a single JSON-body object.

Parameter Name Description Optional/Required
MasterSiteExternalID The ID, in an external system, that is associated with the master site. Required
SiteExternalID The ID, in an external system, that is associated with the site. Required
CutomerExternalID The ID, in an external system, that is associated with the customer. Optional
StatementID The ID associated with the billing statement. Optional
RecordType Accepts values of "New", "Update", or "Cancel" Optional
Balance The balance remaining to be paid on the invoice. Optional
LocationDescription A string that describes the location of the site generating the invoice. Optional
FirstName The first name of the customer to whom the invoice is being sent. Optional
LastName The last name of the customer to whom the invoice is being sent. Optional
PhoneNumber1 The primary phone number (10-digits max, no formatting) of the customer to whom the invoice is being sent. 
    Example: 3055551212
  </td><td>
    Optional
  </td></tr><tr><td>
    PhoneNumber2
  </td><td>
    The secondary phone number (10-digits max, no formatting) of the customer to whom the invoice is being sent.  

    Example: 3055551212
  </td><td>
    Optional
  </td></tr><tr><td>
    EmailAddress
  </td><td>
    The email address of the customer to whom the invoice is being sent.  

    Example: [xxx@xxxx.xxx](mailto:xxx@xxxx.xxx)
  </td><td>
    Optional
  </td></tr><tr><td>
    TextURL
  </td><td>
    The link to the text used by the company generating the external invoice. Used for tracking.
  </td><td>
    Optional
  </td></tr><tr><td>
    EmailURL
  </td><td>
    The link to the email used by the company generating the external invoice. Used for tracking.
  </td><td>
    Optional
  </td></tr><tr><td>
    LogoURL
  </td><td>
    The link to the logo of the company generating the external invoice.
  </td><td>
    Optional
  </td></tr><tr><td>
    DueDate
  </td><td>
    The due date for the invoice to be paid.
  </td><td>
    Optional
  </td></tr><tr><td>
    HexadecimalColorCode
  </td><td>
    The hexadecimal code for the color that the background of the invoice will be set to.  

    Example: #ffffff
  </td><td>
    Optional
  </td></tr><tr><td>
    SMSOverrideMessage
  </td><td>
    Text that overrides the message template that the account defaults to, if so desired.
  </td><td>
    Optional
  </td></tr><tr><td>
    EmailAdditionalBody
  </td><td>
    Additional text for email invoices can be established here.
  </td><td>
    Optional
  </td></tr></tbody></table>

Sample Code

{
	"MasterSiteExternalID": "092934728",
  "SiteExternalID": "847377273",
  "CustomerExternalID: "",
	"StatementID": "",
  "RecordType": "New",
  "CadenceType": "",
  "Balance": "20.00",
  "LocationDescription": "",
  "FirstName": "John",
  "LastName": "Smith",
	"PhoneNumber1": "3055551212",
  "PhoneNumber2": "",
  "EmailAddress": "",
  "TextURL": "",
  "EmailURL": "",
  "LogoURL": "",
  "DueDate": "",
  "HexadecimalColorCode": "",
  "SMSOverrideMessage": "",
  "EmailAdditionalBody": ""
}

curl --location 'https://rest.everyware.com/InvoicingOnly/SendInvoice' \
--header 'Authorization: Basic [xxx]' \
--header 'Content-Type: application/json' \
--data-raw '{
	"MasterSiteExternalID": "092934728",
  "SiteExternalID": "847377273",
  "CustomerExternalID: "",
	"StatementID": "",
  "RecordType": "New",
  "CadenceType": "",
  "Balance": "20.00",
  "LocationDescription": "",
  "FirstName": "John",
  "LastName": "Smith",
	"PhoneNumber1": "3055551212",
  "PhoneNumber2": "",
  "EmailAddress": "",
  "TextURL": "",
  "EmailURL": "",
  "LogoURL": "",
  "DueDate": "",
  "HexadecimalColorCode": "",
  "SMSOverrideMessage": "",
  "EmailAdditionalBody": ""
}'

{
	"OrderNumber": null,
  "SMSID": null,
	"IsSuccess": true,
  "Message": "Invoice has successfully been added to the system.",
  "Data": null
}