API Reference

Create a new invoice (manual only)

post
https://app.ordermentum.com/v2/invoices
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

Invoice display number e.g. "OMI001"

uuid
required

Static String for the supplier entity. Found after the /supplier in the URL

orderIds
array of uuids
required
length ≥ 1

The order.id comes from the incoming request into the partner system. They must store and send back. If multiple, all orders must be for the same retailer

orderIds*
date-time
required

This should be in UTC time. e.g. "2023-04-14T04:53:19.717Z"

date-time
required
float
required

Total cost of line items, excl freight and tax

float
required

Freight cost, excl tax

float
required

Card/payment method surcharge

float
required

total_cost + total_freight

float
required

Total tax amount (line items and freight)

float

Amount credited

float
required

(subtotal + total_gst + surcharge ) - credits

lineItems
array of objects
required
length ≥ 1
lineItems*
string
required
string
required
integer
required
≥ 1
float
required
float
float
boolean
Defaults to false
float
required
float
required
float
required
string
Defaults to unit
uuid
string
boolean
Defaults to false
Responses

400

Invalid data, check response message

403

This call required invoice-create privileges to the supplier

default

Error message

Updated about 1 year ago

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

Updated about 1 year ago