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.
Parameter | Description | Optional/Required |
---|---|---|
SMSID | The SMSID returned in the original CreateInvoice call. | Required |
Status | The status that the invoice should be changed to. Ex: Cancelled | Required |
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.
{
"SMSID":"485835",
"Status":"Cancelled"
}
curl --location 'https://rest.everyware.com/api/Default/UpdateInvoiceStatus' \
--header 'Authorization: Basic [xxx]' \
--header 'Content-Type: application/json' \
--data-raw ' {
"SMSID":"485835",
"Status":"Cancelled"
}'
{
"IsSuccess": true,
"Message": "The invoice status has been successfully updated.",
"Data": null,
"OrderNumber": null,
"SMSID": null
}
Example Cancelled Invoice Page View
Updated 9 months ago
What’s Next