Sales

Use the REST API to interact with Sales/Invoices

Create a new sale/invoice

Create a new sale/invoice

post

/sales

Authorizations

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_emailstring

Contact Email Address

Example: [e-mail]

contact_phonestring

Lead Phone Number

Example: 03 1234 5678

contact_mobilestring

Lead Mobile Number

Example: 0411 111 111

segmentstring

Business Segment

Example: New Customers

line_itemsarray

Line Items (JSON String)

Header parameters

Acceptstringrequired

Setting to application/json is recommended

Example: application/json

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api2.engineroom.com.au/public/sales?date=2023-01-01&total_amount=2023-01-01&contact_name=John+Smith' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Accept: application/json'

201

400

201

{
  "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": "[e-mail]",
      "mobile": "0412123123"
    },
    "business": {
      "id": "cb50eb42-22b3-4df4-bbcd-efcd9694f3f8",
      "name": "Acme Co"
    }
  }
}

Sale created successfully