Sales
Use the REST API to interact with Sales/Invoices
Create a new sale/invoice
Authorizations
Query parameters
datestringRequiredExample:
Date the sale was made
2023-01-01
total_amountstringRequiredExample:
Total sale amount
2023-01-01
contact_namestringRequiredExample:
Contact Name
John Smith
contact_phonestringOptionalExample:
Lead Phone Number
03 1234 5678
contact_mobilestringOptionalExample:
Lead Mobile Number
0411 111 111
segmentstringOptionalExample:
Business Segment
New Customers
line_itemsarrayOptional
Line Items (JSON String)
Header parameters
AcceptstringRequiredExample:
Setting to application/json
is recommended
application/json
Responses
201
Sale created successfully
application/json
400
Invalid input
post
POST /public/sales HTTP/1.1
Host: api2.engineroom.com.au
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: application/json
{
"message": "Sale created successfully.",
"data": {
"id": "b0a00e1a-7748-4c68-acd1-36bc74ec0b7b",
"date": "2023-01-30",
"total_amount": 1000,
"segment": "New Customers",
"contact": {
"id": "cb50eb42-22b3-4df4-bbcd-efcd9694f3f8",
"name": "Bob Smith",
"email": "[email protected]",
"mobile": "0412123123"
},
"business": {
"id": "cb50eb42-22b3-4df4-bbcd-efcd9694f3f8",
"name": "Acme Co"
}
}
}
Last updated