Sales

Use the REST API to interact with Sales/Invoices

Create a new sale/invoice

post

Create a new sale/invoice

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

datestringRequired

Date the sale was made

Example: 2023-01-01

total_amountstringRequired

Total sale amount

Example: 2023-01-01

contact_namestringRequired

Contact Name

Example: John Smith

contact_emailstringOptional

Contact Email Address

Example: [email protected]

contact_phonestringOptional

Lead Phone Number

Example: 03 1234 5678

contact_mobilestringOptional

Lead Mobile Number

Example: 0411 111 111

segmentstringOptional

Business Segment

Example: New Customers

line_itemsarrayOptional

Line Items (JSON String)

Header parameters

AcceptstringRequired

Setting to application/json is recommended

Example: application/json

Responses

201

Sale created successfully

application/json

400

Invalid input

post

/sales

HTTPcURLJavaScriptPython

POST /public/sales?date=2023-01-01&total_amount=2023-01-01&contact_name=John+Smith 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"
    }
  }
}