Updating an Invoice Status

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

You can use the UpdateInvoiceStatus method to update the status of an invoice URL to "Cancelled", so that the customer cannot access it.

Inbound Parameters

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

SMSIDThe SMSID returned in the original CreateInvoice call.Required
StatusThe status that the invoice should be changed to.

Ex: Cancelled

Code Sample

Ex: Customer paid for their purchase offline after being texted an invoice link. To avoid the customer accidentally opening the link and paying the invoice again, change its status to Cancelled.

curl --location 'https://rest.everyware.com/api/Default/UpdateInvoiceStatus' \
--header 'Authorization: Basic [xxx]' \
--header 'Content-Type: application/json' \
--data-raw ' {
    "IsSuccess": true,
    "Message": "The invoice status has been successfully updated.",
    "Data": null,
    "OrderNumber": null,
    "SMSID": null

Example Cancelled Invoice Page View


If UpdateInvoiceStatus is used to change an invoice status to Cancelled, pay by text invoice link will open to "No Longer Active" page with instruction to call or text the business.

What’s Next