API Reference

Update / cancel / mark-paid an invoice

put
https://api.ordermentum.com/v1/invoices/

Invoices are not hard-deleted. Update fields, cancel by setting status to cancelled, or mark paid with { "orderId": "<id>", "type": "markAsPaid" }.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

Resource id.

Body Params

Update invoice fields, or perform an action via type. To mark an invoice as paid, send { "orderId": "<id>", "type": "markAsPaid" }.

date-time
string

Set to cancelled to cancel the invoice.

string
enum

Action to perform on the invoice.

Allowed:
uuid

Required when type is markAsPaid.

Responses

Updated 29 minutes ago

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 29 minutes ago