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	Optional
PhoneNumber2	The secondary phone number (10-digits max, no formatting) of the customer to whom the invoice is being sent. Example: 3055551212	Optional
EmailAddress	The email address of the customer to whom the invoice is being sent. Example: [email protected]	Optional
TextURL	The link to the text used by the company generating the external invoice. Used for tracking.	Optional
EmailURL	The link to the email used by the company generating the external invoice. Used for tracking.	Optional
LogoURL	The link to the logo of the company generating the external invoice.	Optional
DueDate	The due date for the invoice to be paid.	Optional
HexadecimalColorCode	The hexadecimal code for the color that the background of the invoice will be set to. Example: #ffffff	Optional
SMSOverrideMessage	Text that overrides the message template that the account defaults to, if so desired.	Optional
EmailAdditionalBody	Additional text for email invoices can be established here.	Optional

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
}